[ADF-4590] TaskCloud - refractor StartTask (#4761)

* [ADF-4590] - refractor task-cloud service

* [ADF-4590] - change unit tests

* [ADF-4590] - fix unit tests

* [ADF-4590] - add return type, remove unnecesary unit test

* [ADF-4590] - fix lint

* [ADF-4590] - PR changes
This commit is contained in:
Silviu Popa 2019-07-13 18:24:16 +03:00 committed by Eugenio Romano
parent 5703c45ad8
commit 6cedc59fdf
8 changed files with 85 additions and 112 deletions

View File

@ -19,8 +19,9 @@ import { Injectable } from '@angular/core';
import { AlfrescoApiService, LogService, AppConfigService, IdentityUserService } from '@alfresco/adf-core'; import { AlfrescoApiService, LogService, AppConfigService, IdentityUserService } from '@alfresco/adf-core';
import { from, throwError, Observable } from 'rxjs'; import { from, throwError, Observable } from 'rxjs';
import { catchError, map } from 'rxjs/operators'; import { catchError, map } from 'rxjs/operators';
import { TaskDetailsCloudModel } from '../start-task/models/task-details-cloud.model'; import { TaskDetailsCloudModel, StartTaskCloudResponseModel } from '../start-task/models/task-details-cloud.model';
import { BaseCloudService } from '../../services/base-cloud.service'; import { BaseCloudService } from '../../services/base-cloud.service';
import { StartTaskCloudRequestModel } from '../start-task/models/start-task-cloud-request.model';
@Injectable({ @Injectable({
providedIn: 'root' providedIn: 'root'
@ -189,6 +190,32 @@ export class TaskCloudService extends BaseCloudService {
} }
} }
/**
* Creates a new standalone task.
* @param taskDetails Details of the task to create
* @returns Details of the newly created task
*/
createNewTask(startTaskRequest: StartTaskCloudRequestModel, appName: string): Observable<TaskDetailsCloudModel> {
const queryUrl = this.buildCreateTaskUrl(appName);
const bodyParam = JSON.stringify(this.buildRequestBody(startTaskRequest));
const pathParams = {}, queryParams = {}, headerParams = {},
formParams = {}, contentTypes = ['application/json'], accepts = ['application/json'];
return from(
this.apiService
.getInstance()
.oauth2Auth.callCustomApi(
queryUrl, 'POST', pathParams, queryParams,
headerParams, formParams, bodyParam,
contentTypes, accepts, null, null)
).pipe(
map((response: StartTaskCloudResponseModel) => {
return new TaskDetailsCloudModel(response.entry);
}),
catchError((err) => this.handleError(err))
);
}
/** /**
* Updates the details (name, description, due date) for a task. * Updates the details (name, description, due date) for a task.
* @param appName Name of the app * @param appName Name of the app
@ -228,6 +255,15 @@ export class TaskCloudService extends BaseCloudService {
return `${this.getBasePath(appName)}/rb/v1/tasks/${taskId}/complete`; return `${this.getBasePath(appName)}/rb/v1/tasks/${taskId}/complete`;
} }
private buildCreateTaskUrl(appName: string): string {
this.contextRoot = this.appConfigService.get('bpmHost');
return `${this.getBasePath(appName)}/rb/v1/tasks`;
}
private buildRequestBody(startTaskRequest: StartTaskCloudRequestModel) {
return new StartTaskCloudRequestModel(startTaskRequest);
}
private handleError(error: any) { private handleError(error: any) {
this.logService.error(error); this.logService.error(error);
return throwError(error || 'Server error'); return throwError(error || 'Server error');

View File

@ -25,32 +25,39 @@ import {
UserPreferencesService, UserPreferencesService,
IdentityUserModel IdentityUserModel
} from '@alfresco/adf-core'; } from '@alfresco/adf-core';
import { StartTaskCloudService } from '../services/start-task-cloud.service';
import { StartTaskCloudComponent } from './start-task-cloud.component'; import { StartTaskCloudComponent } from './start-task-cloud.component';
import { of, throwError } from 'rxjs'; import { of, throwError } from 'rxjs';
import { taskDetailsMock } from '../mock/task-details.mock'; import { taskDetailsMock } from '../mock/task-details.mock';
import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
import { ProcessServiceCloudTestingModule } from './../../../testing/process-service-cloud.testing.module'; import { ProcessServiceCloudTestingModule } from './../../../testing/process-service-cloud.testing.module';
import { StartTaskCloudTestingModule } from '../testing/start-task-cloud.testing.module'; import { StartTaskCloudTestingModule } from '../testing/start-task-cloud.testing.module';
import { TaskDetailsCloudModel } from '../models/task-details-cloud.model';
import { FormDefinitionSelectorCloudService } from '../../../form/services/form-definition-selector-cloud.service'; import { FormDefinitionSelectorCloudService } from '../../../form/services/form-definition-selector-cloud.service';
import { TaskCloudService } from '../../services/task-cloud.service';
import { StartTaskCloudRequestModel } from '../models/start-task-cloud-request.model';
describe('StartTaskCloudComponent', () => { describe('StartTaskCloudComponent', () => {
let component: StartTaskCloudComponent; let component: StartTaskCloudComponent;
let fixture: ComponentFixture<StartTaskCloudComponent>; let fixture: ComponentFixture<StartTaskCloudComponent>;
let service: StartTaskCloudService; let service: TaskCloudService;
let identityService: IdentityUserService; let identityService: IdentityUserService;
let formDefinitionSelectorCloudService: FormDefinitionSelectorCloudService; let formDefinitionSelectorCloudService: FormDefinitionSelectorCloudService;
let element: HTMLElement; let element: HTMLElement;
let createNewTaskSpy: jasmine.Spy; let createNewTaskSpy: jasmine.Spy;
let alfrescoApiService: AlfrescoApiService;
const mock = {
oauth2Auth: {
callCustomApi: () => Promise.resolve(taskDetailsMock)
}
};
const mockUser = new IdentityUserModel({username: 'currentUser', firstName: 'Test', lastName: 'User', email: 'currentUser@test.com'}); const mockUser = new IdentityUserModel({username: 'currentUser', firstName: 'Test', lastName: 'User', email: 'currentUser@test.com'});
setupTestBed({ setupTestBed({
imports: [ProcessServiceCloudTestingModule, StartTaskCloudTestingModule], imports: [ProcessServiceCloudTestingModule, StartTaskCloudTestingModule],
providers: [ providers: [
StartTaskCloudService, TaskCloudService,
AlfrescoApiService, AlfrescoApiService,
AppConfigService, AppConfigService,
LogService, LogService,
@ -61,14 +68,16 @@ describe('StartTaskCloudComponent', () => {
schemas: [ CUSTOM_ELEMENTS_SCHEMA ] schemas: [ CUSTOM_ELEMENTS_SCHEMA ]
}); });
beforeEach(async(() => { beforeEach(async (() => {
fixture = TestBed.createComponent(StartTaskCloudComponent); fixture = TestBed.createComponent(StartTaskCloudComponent);
component = fixture.componentInstance; component = fixture.componentInstance;
element = fixture.nativeElement; element = fixture.nativeElement;
service = TestBed.get(StartTaskCloudService); service = TestBed.get(TaskCloudService);
identityService = TestBed.get(IdentityUserService); identityService = TestBed.get(IdentityUserService);
alfrescoApiService = TestBed.get(AlfrescoApiService);
formDefinitionSelectorCloudService = TestBed.get(FormDefinitionSelectorCloudService); formDefinitionSelectorCloudService = TestBed.get(FormDefinitionSelectorCloudService);
spyOn(alfrescoApiService, 'getInstance').and.returnValue(mock);
createNewTaskSpy = spyOn(service, 'createNewTask').and.returnValue(of(taskDetailsMock)); createNewTaskSpy = spyOn(service, 'createNewTask').and.returnValue(of(taskDetailsMock));
spyOn(identityService, 'getCurrentUserInfo').and.returnValue(mockUser); spyOn(identityService, 'getCurrentUserInfo').and.returnValue(mockUser);
spyOn(formDefinitionSelectorCloudService, 'getForms').and.returnValue(of([])); spyOn(formDefinitionSelectorCloudService, 'getForms').and.returnValue(of([]));
@ -129,8 +138,9 @@ describe('StartTaskCloudComponent', () => {
expect(successSpy).not.toHaveBeenCalled(); expect(successSpy).not.toHaveBeenCalled();
}); });
it('should assign task to the logged in user when invalid assignee is selected', async(() => { it('should not start task to the logged in user when invalid assignee is selected', (done) => {
component.taskForm.controls['name'].setValue('fakeName'); component.taskForm.controls['name'].setValue('fakeName');
component.appName = 'fakeAppName';
fixture.detectChanges(); fixture.detectChanges();
const assigneeInput = <HTMLElement> element.querySelector('input.adf-cloud-input'); const assigneeInput = <HTMLElement> element.querySelector('input.adf-cloud-input');
assigneeInput.nodeValue = 'a'; assigneeInput.nodeValue = 'a';
@ -139,22 +149,25 @@ describe('StartTaskCloudComponent', () => {
createTaskButton.click(); createTaskButton.click();
fixture.detectChanges(); fixture.detectChanges();
fixture.whenStable().then(() => { fixture.whenStable().then(() => {
const taskRequest = new TaskDetailsCloudModel({ name: 'fakeName', assignee: 'currentUser', candidateGroups: []}); const taskRequest = new StartTaskCloudRequestModel({ name: 'fakeName', assignee: 'currentUser', candidateGroups: []});
expect(createNewTaskSpy).toHaveBeenCalledWith(taskRequest); expect(createNewTaskSpy).toHaveBeenCalledWith(taskRequest, 'fakeAppName');
done();
}); });
})); });
it('should assign task to the logged in user when assignee is not selected', async(() => { it('should not start task to the logged in user when assignee is not selected', (done) => {
component.taskForm.controls['name'].setValue('fakeName'); component.taskForm.controls['name'].setValue('fakeName');
component.appName = 'fakeAppName';
fixture.detectChanges(); fixture.detectChanges();
const createTaskButton = <HTMLElement> element.querySelector('#button-start'); const createTaskButton = <HTMLElement> element.querySelector('#button-start');
createTaskButton.click(); createTaskButton.click();
fixture.detectChanges(); fixture.detectChanges();
fixture.whenStable().then(() => { fixture.whenStable().then(() => {
const taskRequest = new TaskDetailsCloudModel({ name: 'fakeName', assignee: 'currentUser', candidateGroups: []}); const taskRequest = new StartTaskCloudRequestModel({ name: 'fakeName', assignee: 'currentUser', candidateGroups: []});
expect(createNewTaskSpy).toHaveBeenCalledWith(taskRequest); expect(createNewTaskSpy).toHaveBeenCalledWith(taskRequest, 'fakeAppName');
done();
}); });
})); });
}); });
it('should select logged in user as assignee by default', () => { it('should select logged in user as assignee by default', () => {
@ -198,9 +211,14 @@ describe('StartTaskCloudComponent', () => {
component.taskForm.controls['name'].setValue('fakeName'); component.taskForm.controls['name'].setValue('fakeName');
const errorSpy = spyOn(component.error, 'emit'); const errorSpy = spyOn(component.error, 'emit');
createNewTaskSpy.and.returnValue(throwError({})); createNewTaskSpy.and.returnValue(throwError({}));
const createTaskButton = <HTMLElement> element.querySelector('#button-start'); component.appName = 'fakeAppName';
fixture.detectChanges(); fixture.detectChanges();
const assigneeInput = <HTMLElement> element.querySelector('input.adf-cloud-input');
assigneeInput.nodeValue = 'a';
fixture.detectChanges();
const createTaskButton = <HTMLElement> element.querySelector('#button-start');
createTaskButton.click(); createTaskButton.click();
fixture.detectChanges();
expect(errorSpy).toHaveBeenCalled(); expect(errorSpy).toHaveBeenCalled();
}); });

View File

@ -21,8 +21,6 @@ import moment from 'moment-es6';
import { Moment } from 'moment'; import { Moment } from 'moment';
import { Observable, Subscription } from 'rxjs'; import { Observable, Subscription } from 'rxjs';
import { FormBuilder, AbstractControl, Validators, FormGroup, FormControl } from '@angular/forms'; import { FormBuilder, AbstractControl, Validators, FormGroup, FormControl } from '@angular/forms';
import { StartTaskCloudService } from '../services/start-task-cloud.service';
import { TaskDetailsCloudModel } from '../models/task-details-cloud.model';
import { import {
LogService, LogService,
UserPreferencesService, UserPreferencesService,
@ -32,6 +30,8 @@ import {
} from '@alfresco/adf-core'; } from '@alfresco/adf-core';
import { PeopleCloudComponent } from './people-cloud/people-cloud.component'; import { PeopleCloudComponent } from './people-cloud/people-cloud.component';
import { GroupCloudComponent } from '../../../../lib/group/components/group-cloud.component'; import { GroupCloudComponent } from '../../../../lib/group/components/group-cloud.component';
import { TaskCloudService } from '../../services/task-cloud.service';
import { StartTaskCloudRequestModel } from '../models/start-task-cloud-request.model';
@Component({ @Component({
selector: 'adf-cloud-start-task', selector: 'adf-cloud-start-task',
@ -105,7 +105,7 @@ export class StartTaskCloudComponent implements OnInit, OnDestroy {
private localeSub: Subscription; private localeSub: Subscription;
private createTaskSub: Subscription; private createTaskSub: Subscription;
constructor(private taskService: StartTaskCloudService, constructor(private taskService: TaskCloudService,
private dateAdapter: DateAdapter<Moment>, private dateAdapter: DateAdapter<Moment>,
private userPreferencesService: UserPreferencesService, private userPreferencesService: UserPreferencesService,
private formBuilder: FormBuilder, private formBuilder: FormBuilder,
@ -153,17 +153,16 @@ export class StartTaskCloudComponent implements OnInit, OnDestroy {
public saveTask() { public saveTask() {
this.submitted = true; this.submitted = true;
const newTask = Object.assign(this.taskForm.value); const newTask = Object.assign(this.taskForm.value);
newTask.appName = this.appName;
newTask.dueDate = this.dueDate; newTask.dueDate = this.dueDate;
newTask.assignee = this.assigneeName; newTask.assignee = this.assigneeName;
newTask.formKey = this.formKey; newTask.formKey = this.formKey;
newTask.candidateGroups = this.candidateGroupNames; newTask.candidateGroups = this.candidateGroupNames;
this.createNewTask(new TaskDetailsCloudModel(newTask)); this.createNewTask(new StartTaskCloudRequestModel(newTask));
} }
private createNewTask(newTask: TaskDetailsCloudModel) { private createNewTask(newTask: StartTaskCloudRequestModel) {
this.createTaskSub = this.taskService.createNewTask(newTask) this.createTaskSub = this.taskService.createNewTask(newTask, this.appName)
.subscribe( .subscribe(
(res: any) => { (res: any) => {
this.submitted = false; this.submitted = false;

View File

@ -15,6 +15,6 @@
* limitations under the License. * limitations under the License.
*/ */
import { TaskDetailsCloudModel } from '../models/task-details-cloud.model'; import { StartTaskCloudRequestModel } from '../models/start-task-cloud-request.model';
export let taskDetailsMock = new TaskDetailsCloudModel({ assignee: 'fake-assigne', name: 'fake-name' }); export let taskDetailsMock = new StartTaskCloudRequestModel({ assignee: 'fake-assigne', name: 'fake-name' });

View File

@ -16,7 +16,6 @@
*/ */
export * from './models/task-details-cloud.model'; export * from './models/task-details-cloud.model';
export * from './services/start-task-cloud.service';
export * from './components/start-task-cloud.component'; export * from './components/start-task-cloud.component';
export * from './components/people-cloud/people-cloud.component'; export * from './components/people-cloud/people-cloud.component';
export * from './start-task-cloud.module'; export * from './start-task-cloud.module';

View File

@ -18,7 +18,6 @@
import { TestBed } from '@angular/core/testing'; import { TestBed } from '@angular/core/testing';
import { setupTestBed } from '@alfresco/adf-core'; import { setupTestBed } from '@alfresco/adf-core';
import { StartTaskCloudService } from './start-task-cloud.service';
import { StartTaskCloudTestingModule } from '../testing/start-task-cloud.testing.module'; import { StartTaskCloudTestingModule } from '../testing/start-task-cloud.testing.module';
import { of, throwError } from 'rxjs'; import { of, throwError } from 'rxjs';
import { taskDetailsMock } from '../mock/task-details.mock'; import { taskDetailsMock } from '../mock/task-details.mock';
@ -30,23 +29,25 @@ import {
LogService, LogService,
StorageService StorageService
} from '@alfresco/adf-core'; } from '@alfresco/adf-core';
import { TaskCloudService } from '../../services/task-cloud.service';
describe('StartTaskCloudService', () => { describe('StartTaskCloudService', () => {
let service: StartTaskCloudService; let service: TaskCloudService;
const fakeAppName: string = 'fake-app';
setupTestBed({ setupTestBed({
imports: [StartTaskCloudTestingModule], imports: [StartTaskCloudTestingModule],
providers: [StartTaskCloudService, AlfrescoApiService, AppConfigService, LogService, StorageService] providers: [TaskCloudService, AlfrescoApiService, AppConfigService, LogService, StorageService]
}); });
beforeEach(() => { beforeEach(() => {
service = TestBed.get(StartTaskCloudService); service = TestBed.get(TaskCloudService);
}); });
it('should able to create a new task ', (done) => { it('should able to create a new task ', (done) => {
spyOn(service, 'createNewTask').and.returnValue(of({id: 'fake-id', name: 'fake-name'})); spyOn(service, 'createNewTask').and.returnValue(of({id: 'fake-id', name: 'fake-name'}));
service.createNewTask(taskDetailsMock).subscribe( service.createNewTask(taskDetailsMock, fakeAppName).subscribe(
(res: TaskDetailsCloudModel) => { (res: TaskDetailsCloudModel) => {
expect(res).toBeDefined(); expect(res).toBeDefined();
expect(res.id).toEqual('fake-id'); expect(res.id).toEqual('fake-id');
@ -63,7 +64,7 @@ describe('StartTaskCloudService', () => {
}); });
spyOn(service, 'createNewTask').and.returnValue(throwError(errorResponse)); spyOn(service, 'createNewTask').and.returnValue(throwError(errorResponse));
service.createNewTask(taskDetailsMock) service.createNewTask(taskDetailsMock, fakeAppName)
.subscribe( .subscribe(
() => { () => {
fail('expected an error, not applications'); fail('expected an error, not applications');

View File

@ -1,78 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Injectable } from '@angular/core';
import {
AlfrescoApiService,
AppConfigService,
LogService
} from '@alfresco/adf-core';
import { from, Observable, throwError } from 'rxjs';
import { StartTaskCloudRequestModel } from '../models/start-task-cloud-request.model';
import { TaskDetailsCloudModel, StartTaskCloudResponseModel } from '../models/task-details-cloud.model';
import { map, catchError } from 'rxjs/operators';
import { BaseCloudService } from '../../../services/base-cloud.service';
@Injectable()
export class StartTaskCloudService extends BaseCloudService {
constructor(
private apiService: AlfrescoApiService,
private appConfigService: AppConfigService,
private logService: LogService
) { super(); }
/**
* Creates a new standalone task.
* @param taskDetails Details of the task to create
* @returns Details of the newly created task
*/
createNewTask(taskDetails: TaskDetailsCloudModel): Observable<TaskDetailsCloudModel> {
const queryUrl = this.buildCreateTaskUrl(taskDetails.appName);
const bodyParam = JSON.stringify(this.buildRequestBody(taskDetails));
const pathParams = {}, queryParams = {}, headerParams = {},
formParams = {}, contentTypes = ['application/json'], accepts = ['application/json'];
return from(
this.apiService
.getInstance()
.oauth2Auth.callCustomApi(
queryUrl, 'POST', pathParams, queryParams,
headerParams, formParams, bodyParam,
contentTypes, accepts, null, null)
).pipe(
map((response: StartTaskCloudResponseModel) => {
return new TaskDetailsCloudModel(response.entry);
}),
catchError((err) => this.handleError(err))
);
}
private buildCreateTaskUrl(appName: string): any {
this.contextRoot = this.appConfigService.get('bpmHost');
return `${this.getBasePath(appName)}/rb/v1/tasks`;
}
private buildRequestBody(taskDetails: any) {
return new StartTaskCloudRequestModel(taskDetails);
}
private handleError(error: any) {
this.logService.error(error);
return throwError(error || 'Server error');
}
}

View File

@ -21,7 +21,6 @@ import { FlexLayoutModule } from '@angular/flex-layout';
import { MaterialModule } from '../../material.module'; import { MaterialModule } from '../../material.module';
import { TemplateModule, PipeModule, CoreModule } from '@alfresco/adf-core'; import { TemplateModule, PipeModule, CoreModule } from '@alfresco/adf-core';
import { StartTaskCloudComponent } from './components/start-task-cloud.component'; import { StartTaskCloudComponent } from './components/start-task-cloud.component';
import { StartTaskCloudService } from './services/start-task-cloud.service';
import { FormsModule, ReactiveFormsModule } from '@angular/forms'; import { FormsModule, ReactiveFormsModule } from '@angular/forms';
import { PeopleCloudComponent } from './components/people-cloud/people-cloud.component'; import { PeopleCloudComponent } from './components/people-cloud/people-cloud.component';
import { GroupCloudModule } from '../../group/group-cloud.module'; import { GroupCloudModule } from '../../group/group-cloud.module';
@ -43,7 +42,6 @@ import { FormCloudModule } from '../../form/form-cloud.module';
], ],
declarations: [StartTaskCloudComponent, PeopleCloudComponent], declarations: [StartTaskCloudComponent, PeopleCloudComponent],
providers: [ providers: [
StartTaskCloudService,
TaskCloudService TaskCloudService
], ],
exports: [ exports: [