From 4dfa9b6d533f505bc2196745418b24f43342d12b Mon Sep 17 00:00:00 2001 From: arditdomi <32884230+arditdomi@users.noreply.github.com> Date: Mon, 16 Nov 2020 14:37:17 +0000 Subject: [PATCH] [ACA-4123] Unify APS and Cloud event emitters for filters (#6331) * Experimental solution * Unify event emitters for aps and cloud filters * Update emitter descriptions * Fix/Add unit tests * Unit tests part 2 * Update documentation, put mock objects into separate mock files and remove them from test files * rename tests * align demo-shell with the new changes * fix aps demo shell --- .../cloud/cloud-filters-demo.component.html | 6 +- .../process-service.component.html | 5 +- .../process-filters-cloud.component.md | 3 +- .../task-filters-cloud.component.md | 3 +- .../components/process-filters.component.md | 4 +- .../components/task-filters.component.md | 3 +- .../process-filters-cloud.component.html | 4 +- .../process-filters-cloud.component.spec.ts | 56 ++---- .../process-filters-cloud.component.ts | 24 ++- .../mock/process-filters-cloud.mock.ts | 169 ++++++++++++++++ .../process-filter-cloud.service.spec.ts | 184 +----------------- .../base-task-filters-cloud.component.html | 4 +- ...rvice-task-filters-cloud.component.spec.ts | 31 ++- .../service-task-filters-cloud.component.ts | 22 ++- .../task-filters-cloud.component.spec.ts | 31 ++- .../task-filters-cloud.component.ts | 22 ++- .../mock/task-filters-cloud.mock.ts | 6 +- .../lib/mock/process/process-filters.mock.ts | 51 +++++ .../lib/mock/process/process.service.mock.ts | 18 -- .../src/lib/mock/public-api.ts | 2 + .../src/lib/mock/task/task-filters.mock.ts | 103 ++++++++++ .../lib/mock/task/tasklist-service.mock.ts | 69 +------ .../process-filters.component.spec.ts | 51 +++-- .../components/process-filters.component.ts | 10 +- .../services/process-filter.service.spec.ts | 6 +- .../components/task-filters.component.html | 4 +- .../components/task-filters.component.spec.ts | 80 ++++---- .../components/task-filters.component.ts | 22 ++- .../services/task-filter.service.spec.ts | 9 +- .../services/tasklist.service.spec.ts | 4 +- 30 files changed, 561 insertions(+), 445 deletions(-) create mode 100644 lib/process-services-cloud/src/lib/process/process-filters/mock/process-filters-cloud.mock.ts create mode 100644 lib/process-services/src/lib/mock/process/process-filters.mock.ts create mode 100644 lib/process-services/src/lib/mock/task/task-filters.mock.ts diff --git a/demo-shell/src/app/components/cloud/cloud-filters-demo.component.html b/demo-shell/src/app/components/cloud/cloud-filters-demo.component.html index 79ead49bfb..3e3887d1b4 100644 --- a/demo-shell/src/app/components/cloud/cloud-filters-demo.component.html +++ b/demo-shell/src/app/components/cloud/cloud-filters-demo.component.html @@ -10,7 +10,8 @@ [appName]="appName" [showIcons]="true" [filterParam]="currentTaskFilter$ | async" - (filterClick)="onTaskFilterSelected($event)"> + (filterClicked)="onTaskFilterSelected($event)" + (filterSelected)="onTaskFilterSelected($event)"> @@ -25,7 +26,8 @@ [appName]="appName" [showIcons]="true" [filterParam]="currentProcessFilter$ | async" - (filterClick)="onProcessFilterSelected($event)"> + (filterClicked)="onProcessFilterSelected($event)" + (filterSelected)="onProcessFilterSelected($event)"> diff --git a/demo-shell/src/app/components/process-service/process-service.component.html b/demo-shell/src/app/components/process-service/process-service.component.html index 2f4b6bdd6c..8338b6328d 100644 --- a/demo-shell/src/app/components/process-service/process-service.component.html +++ b/demo-shell/src/app/components/process-service/process-service.component.html @@ -27,7 +27,8 @@ @@ -145,7 +146,7 @@ [appId]="appId" [filterParam]="filterSelected" [showIcon]="showProcessFilterIcon" - (filterClick)="onProcessFilterChange($event)" + (filterClicked)="onProcessFilterChange($event)" (filterSelected)="onProcessFilterChange($event)" (success)="onSuccessProcessFilterList()"> diff --git a/docs/process-services-cloud/components/process-filters-cloud.component.md b/docs/process-services-cloud/components/process-filters-cloud.component.md index efb731a308..49b5920bbd 100644 --- a/docs/process-services-cloud/components/process-filters-cloud.component.md +++ b/docs/process-services-cloud/components/process-filters-cloud.component.md @@ -33,7 +33,8 @@ Lists all available process filters and allows to select a filter. | Name | Type | Description | | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when any error occurs while loading the filters | -| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is selected/clicked | +| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is being selected based on the filterParam input. | +| filterClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts)`>` | Emitted when a filter is being clicked from the UI. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when filters are loaded successfully | ## See also diff --git a/docs/process-services-cloud/components/task-filters-cloud.component.md b/docs/process-services-cloud/components/task-filters-cloud.component.md index b0916aecfb..9400e6463c 100644 --- a/docs/process-services-cloud/components/task-filters-cloud.component.md +++ b/docs/process-services-cloud/components/task-filters-cloud.component.md @@ -30,7 +30,8 @@ Shows all available filters. | Name | Type | Description | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during loading. | -| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter in the list is clicked. | +| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter is being selected based on the filterParam input. | +| filterClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts)`>` | Emitted when a filter is being clicked from the UI. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list is loaded. | ## Details diff --git a/docs/process-services/components/process-filters.component.md b/docs/process-services/components/process-filters.component.md index 37a762ba37..76c15814ea 100644 --- a/docs/process-services/components/process-filters.component.md +++ b/docs/process-services/components/process-filters.component.md @@ -44,8 +44,8 @@ Collection of criteria used to filter process instances, which may be customized | Name | Type | Description | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserProcessInstanceFilterRepresentation.md)`>` | Emitted when the user selects a filter from the list. | -| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`>` | Emitted when a process filter is selected. | +| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserProcessInstanceFilterRepresentation.md)`>` | Emitted when a filter is being selected based on the filterParam input. | +| filterClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/UserProcessInstanceFilterRepresentation.md)`>` | Emitted when a filter is being clicked from the UI. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`[]>` | Emitted when the list of filters has been successfully loaded from the server. | ## Details diff --git a/docs/process-services/components/task-filters.component.md b/docs/process-services/components/task-filters.component.md index e17801e302..6439adfd12 100644 --- a/docs/process-services/components/task-filters.component.md +++ b/docs/process-services/components/task-filters.component.md @@ -31,7 +31,8 @@ Shows all available filters. | Name | Type | Description | | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs during loading. | -| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when a filter in the list is clicked. | +| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when a filter is being selected based on the filterParam input. | +| filterClicked | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`FilterRepresentationModel`](../../../lib/process-services/src/lib/task-list/models/filter.model.ts)`>` | Emitted when a filter is being clicked from the UI. | | success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the list is loaded. | ## Details diff --git a/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.html b/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.html index fac11ad834..715bf0efec 100644 --- a/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.html +++ b/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.html @@ -1,7 +1,7 @@
-
- \ No newline at end of file + diff --git a/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.spec.ts b/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.spec.ts index 3cf3ab17ff..3ba0c4b05f 100644 --- a/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.spec.ts +++ b/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.spec.ts @@ -19,7 +19,6 @@ import { SimpleChange } from '@angular/core'; import { ComponentFixture, TestBed, async } from '@angular/core/testing'; import { setupTestBed } from '@alfresco/adf-core'; import { from, Observable } from 'rxjs'; -import { ProcessFilterCloudModel } from '../models/process-filter-cloud.model'; import { ProcessFilterCloudService } from '../services/process-filter-cloud.service'; import { ProcessFiltersCloudComponent } from './process-filters-cloud.component'; import { By } from '@angular/platform-browser'; @@ -28,43 +27,20 @@ import { ProcessFiltersCloudModule } from '../process-filters-cloud.module'; import { PROCESS_FILTERS_SERVICE_TOKEN } from '../../../services/cloud-token.service'; import { LocalPreferenceCloudService } from '../../../services/local-preference-cloud.service'; import { TranslateModule } from '@ngx-translate/core'; +import { mockProcessFilters } from '../mock/process-filters-cloud.mock'; describe('ProcessFiltersCloudComponent', () => { let processFilterService: ProcessFilterCloudService; - const fakeGlobalFilter = [ - new ProcessFilterCloudModel({ - name: 'FakeAllProcesses', - key: 'FakeAllProcesses', - icon: 'adjust', - id: '10', - status: '' - }), - new ProcessFilterCloudModel({ - name: 'FakeRunningProcesses', - key: 'FakeRunningProcesses', - icon: 'inbox', - id: '11', - status: 'RUNNING' - }), - new ProcessFilterCloudModel({ - name: 'FakeCompletedProcesses', - key: 'completed-processes', - icon: 'done', - id: '12', - status: 'COMPLETED' - }) - ]; - const fakeGlobalFilterObservable = new Observable(function(observer) { - observer.next(fakeGlobalFilter); + observer.next(mockProcessFilters); observer.complete(); }); const fakeGlobalFilterPromise = new Promise(function (resolve) { - resolve(fakeGlobalFilter); + resolve(mockProcessFilters); }); const mockErrorFilterList = { @@ -197,7 +173,7 @@ describe('ProcessFiltersCloudComponent', () => { const appName = 'my-app-1'; const change = new SimpleChange(null, appName, true); - component.filterClick.subscribe((res) => { + component.filterSelected.subscribe((res) => { expect(res).toBeDefined(); expect(component.currentFilter).toBeDefined(); expect(component.currentFilter.name).toEqual('FakeRunningProcesses'); @@ -217,7 +193,7 @@ describe('ProcessFiltersCloudComponent', () => { fixture.detectChanges(); - component.filterClick.subscribe((res) => { + component.filterSelected.subscribe((res) => { expect(res).toBeDefined(); expect(component.currentFilter).toBeDefined(); expect(component.currentFilter.name).toEqual('FakeCompletedProcesses'); @@ -236,7 +212,7 @@ describe('ProcessFiltersCloudComponent', () => { const change = new SimpleChange(null, appName, true); fixture.detectChanges(); - component.filterClick.subscribe((res) => { + component.filterSelected.subscribe((res) => { expect(res).toBeDefined(); expect(component.currentFilter).toBeDefined(); expect(component.currentFilter.name).toEqual('FakeCompletedProcesses'); @@ -255,7 +231,7 @@ describe('ProcessFiltersCloudComponent', () => { const change = new SimpleChange(null, appName, true); fixture.detectChanges(); - component.filterClick.subscribe((res) => { + component.filterSelected.subscribe((res) => { expect(res).toBeDefined(); expect(component.currentFilter).toBeDefined(); expect(component.currentFilter.name).toEqual('FakeCompletedProcesses'); @@ -265,7 +241,7 @@ describe('ProcessFiltersCloudComponent', () => { component.ngOnChanges({ 'appName': change }); }); - it('should emit an event when a filter is selected', (done) => { + it('should filterClicked emit when a filter is clicked from the UI', (done) => { spyOn(processFilterService, 'getProcessFilters').and.returnValue(fakeGlobalFilterObservable); component.filterParam = { id: '10' }; @@ -275,14 +251,14 @@ describe('ProcessFiltersCloudComponent', () => { component.ngOnChanges({ 'appName': change }); fixture.detectChanges(); - component.filterClick.subscribe((res) => { + component.filterClicked.subscribe((res) => { expect(res).toBeDefined(); expect(component.currentFilter).toBeDefined(); expect(component.currentFilter.name).toEqual('FakeAllProcesses'); done(); }); - const filterButton = fixture.debugElement.nativeElement.querySelector(`[data-automation-id="${fakeGlobalFilter[0].key}_filter"]`); + const filterButton = fixture.debugElement.nativeElement.querySelector(`[data-automation-id="${mockProcessFilters[0].key}_filter"]`); filterButton.click(); }); @@ -318,14 +294,14 @@ describe('ProcessFiltersCloudComponent', () => { }); it('should change current filter when filterParam (name) changes', () => { - component.filters = fakeGlobalFilter; + component.filters = mockProcessFilters; component.currentFilter = null; fixture.whenStable().then(() => { - expect(component.currentFilter.name).toEqual(fakeGlobalFilter[2].name); + expect(component.currentFilter.name).toEqual(mockProcessFilters[2].name); }); - const change = new SimpleChange(null, { name: fakeGlobalFilter[2].name }, true); + const change = new SimpleChange(null, { name: mockProcessFilters[2].name }, true); component.ngOnChanges({ 'filterParam': change }); }); @@ -340,11 +316,11 @@ describe('ProcessFiltersCloudComponent', () => { }); it('should return the current filter after one is selected', () => { - const filter = fakeGlobalFilter[1]; - component.filters = fakeGlobalFilter; + const filter = mockProcessFilters[1]; + component.filters = mockProcessFilters; expect(component.currentFilter).toBeUndefined(); - component.selectFilter( {id: filter.id}); + component.selectFilter({ id: filter.id }); expect(component.getCurrentFilter()).toBe(filter); }); }); diff --git a/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts b/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts index 6b679ace60..fc3d5683cf 100644 --- a/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts @@ -42,9 +42,13 @@ export class ProcessFiltersCloudComponent implements OnInit, OnChanges, OnDestro @Input() showIcons: boolean = false; - /** Emitted when a filter is selected/clicked */ + /** Emitted when a filter is being selected based on the filterParam input. */ @Output() - filterClick = new EventEmitter(); + filterSelected = new EventEmitter(); + + /** Emitted when a filter is being clicked from the UI. */ + @Output() + filterClicked = new EventEmitter(); /** Emitted when filters are loaded successfully */ @Output() @@ -126,12 +130,12 @@ export class ProcessFiltersCloudComponent implements OnInit, OnChanges, OnDestro } /** - * Select and emit the given filter + * Selects and emits the given filter */ public selectFilterAndEmit(newParamFilter: FilterParamsModel) { if (newParamFilter) { this.selectFilter(newParamFilter); - this.filterClick.emit(this.currentFilter); + this.filterSelected.emit(this.currentFilter); } else { this.currentFilter = undefined; } @@ -144,6 +148,18 @@ export class ProcessFiltersCloudComponent implements OnInit, OnChanges, OnDestro this.selectFilterAndEmit( {id: id}); } + /** + * Selects and emits the clicked filter + */ + public onFilterClick(filter: ProcessFilterCloudModel) { + if (filter) { + this.selectFilter(filter); + this.filterClicked.emit(this.currentFilter); + } else { + this.currentFilter = undefined; + } + } + /** * Select as default process filter the first in the list */ diff --git a/lib/process-services-cloud/src/lib/process/process-filters/mock/process-filters-cloud.mock.ts b/lib/process-services-cloud/src/lib/process/process-filters/mock/process-filters-cloud.mock.ts new file mode 100644 index 0000000000..7ace303ffb --- /dev/null +++ b/lib/process-services-cloud/src/lib/process/process-filters/mock/process-filters-cloud.mock.ts @@ -0,0 +1,169 @@ +/*! + * @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 { ProcessFilterCloudModel } from '../models/process-filter-cloud.model'; +import { DateCloudFilterType } from '../../../../..'; + +export const fakeProcessCloudFilters = [ + { + name: 'MOCK_PROCESS_NAME_1', + id: '1', + key: 'all-mock-process', + icon: 'adjust', + appName: 'mock-appName', + sort: 'startDate', + status: 'MOCK_ALL', + order: 'DESC' + }, + { + name: 'MOCK_PROCESS_NAME_2', + id: '2', + key: 'run-mock-process', + icon: 'adjust', + appName: 'mock-appName', + sort: 'startDate', + status: 'MOCK-RUNNING', + order: 'DESC' + }, + { + name: 'MOCK_PROCESS_NAME_3', + id: '3', + key: 'complete-mock-process', + icon: 'adjust', + appName: 'mock-appName', + sort: 'startDate', + status: 'MOCK-COMPLETED', + order: 'DESC' + } +]; + +export const mockProcessFilters = [ + new ProcessFilterCloudModel({ + name: 'FakeAllProcesses', + key: 'FakeAllProcesses', + icon: 'adjust', + id: '10', + status: '' + }), + new ProcessFilterCloudModel({ + name: 'FakeRunningProcesses', + key: 'FakeRunningProcesses', + icon: 'inbox', + id: '11', + status: 'RUNNING' + }), + new ProcessFilterCloudModel({ + name: 'FakeCompletedProcesses', + key: 'completed-processes', + icon: 'done', + id: '12', + status: 'COMPLETED' + }) +]; + +export const fakeProcessFilter: ProcessFilterCloudModel = new ProcessFilterCloudModel({ + name: 'MOCK_PROCESS_NAME_1', + id: '1', + key: 'all-mock-process', + icon: 'adjust', + appName: 'mock-appName', + sort: 'startDate', + status: 'MOCK_ALL', + order: 'DESC', + index: 2, + processName: 'process-name', + processDefinitionName: 'process-def-name', + processInstanceId: 'processinstanceid', + initiator: 'mockuser', + processDefinitionId: 'processDefid', + processDefinitionKey: 'processDefKey', + lastModified: null, + lastModifiedTo: null, + lastModifiedFrom: null, + completedDateType: DateCloudFilterType.NO_DATE, + startedDateType: DateCloudFilterType.NO_DATE, + _completedFrom: null, + _completedTo: null, + startedDate: null, + _startFrom: null, + _startTo: null +}); + +export const fakeProcessCloudFilterEntries = { + list: { + entries: [ + { + entry: { + key: 'process-filters-mock-appName-mock-username', + value: JSON.stringify(fakeProcessCloudFilters) + } + }, + { + entry: fakeProcessCloudFilters[1] + }, + { + entry: fakeProcessCloudFilters[2] + } + ], + pagination: { + skipCount: 0, + maxItems: 100, + count: 3, + hasMoreItems: false, + totalItems: 3 + } + } +}; + +export const fakeEmptyProcessCloudFilterEntries = { + list: { + entries: [], + pagination: { + skipCount: 0, + maxItems: 100, + count: 0, + hasMoreItems: false, + totalItems: 0 + } + } +}; + +export const fakeProcessCloudFilterWithDifferentEntries = { + list: { + entries: [ + { + entry: { + key: 'my-mock-key-1', + value: 'my-mock-value-2' + } + }, + { + entry: { + key: 'my-mock-key-2', + value: 'my-mock-key-2' + } + } + ], + pagination: { + skipCount: 0, + maxItems: 100, + count: 4, + hasMoreItems: false, + totalItems: 2 + } + } +}; diff --git a/lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.spec.ts b/lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.spec.ts index c4ca7758b3..134257d2c1 100644 --- a/lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.spec.ts +++ b/lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.spec.ts @@ -23,8 +23,7 @@ import { PROCESS_FILTERS_SERVICE_TOKEN } from '../../../services/cloud-token.ser import { LocalPreferenceCloudService } from '../../../services/local-preference-cloud.service'; import { ProcessServiceCloudTestingModule } from '../../../testing/process-service-cloud.testing.module'; import { TranslateModule } from '@ngx-translate/core'; -import { ProcessFilterCloudModel } from '../models/process-filter-cloud.model'; -import { DateCloudFilterType } from '../../../models/date-cloud-filter.model'; +import { fakeEmptyProcessCloudFilterEntries, fakeProcessCloudFilterEntries, fakeProcessCloudFilters, fakeProcessCloudFilterWithDifferentEntries, fakeProcessFilter } from '../mock/process-filters-cloud.mock'; describe('ProcessFilterCloudService', () => { let service: ProcessFilterCloudService; @@ -41,187 +40,6 @@ describe('ProcessFilterCloudService', () => { email: 'fakeIdentity@email.com' }; - const fakeProcessFilter: ProcessFilterCloudModel = new ProcessFilterCloudModel({ - name: 'MOCK_PROCESS_NAME_1', - id: '1', - key: 'all-mock-process', - icon: 'adjust', - appName: 'mock-appName', - sort: 'startDate', - status: 'MOCK_ALL', - order: 'DESC', - index: 2, - processName: 'process-name', - processDefinitionName: 'process-def-name', - processInstanceId: 'processinstanceid', - initiator: 'mockuser', - processDefinitionId: 'processDefid', - processDefinitionKey: 'processDefKey', - lastModified: null, - lastModifiedTo: null, - lastModifiedFrom: null, - completedDateType: DateCloudFilterType.NO_DATE, - startedDateType: DateCloudFilterType.NO_DATE, - _completedFrom: null, - _completedTo: null, - startedDate: null, - _startFrom: null, - _startTo: null - }); - - const fakeProcessCloudFilterEntries = { - list: { - entries: [ - { - entry: { - key: 'process-filters-mock-appName-mock-username', - value: JSON.stringify([ - { - name: 'MOCK_PROCESS_NAME_1', - id: '1', - key: 'all-mock-process', - icon: 'adjust', - appName: 'mock-appName', - sort: 'startDate', - status: 'MOCK_ALL', - order: 'DESC' - }, - { - name: 'MOCK_PROCESS_NAME_2', - id: '2', - key: 'run-mock-process', - icon: 'adjust', - appName: 'mock-appName', - sort: 'startDate', - status: 'MOCK-RUNNING', - order: 'DESC' - }, - { - name: 'MOCK_PROCESS_NAME_3', - id: '3', - key: 'complete-mock-process', - icon: 'adjust', - appName: 'mock-appName', - sort: 'startDate', - status: 'MOCK-COMPLETED', - order: 'DESC' - } - ]) - } - }, - { - entry: { - key: 'mock-key-2', - value: { - name: 'MOCK_PROCESS_NAME_2', - id: '2', - key: 'run-mock-process', - icon: 'adjust', - appName: 'mock-appName', - sort: 'startDate', - status: 'MOCK-RUNNING', - order: 'DESC' - } - } - }, - { - entry: { - key: 'mock-key-3', - value: { - name: 'MOCK_PROCESS_NAME_3', - id: '3', - key: 'complete-mock-process', - icon: 'adjust', - appName: 'mock-appName', - sort: 'startDate', - status: 'MOCK-COMPLETED', - order: 'DESC' - } - } - } - ], - pagination: { - skipCount: 0, - maxItems: 100, - count: 3, - hasMoreItems: false, - totalItems: 3 - } - } - }; - - const fakeEmptyProcessCloudFilterEntries = { - list: { - entries: [], - pagination: { - skipCount: 0, - maxItems: 100, - count: 0, - hasMoreItems: false, - totalItems: 0 - } - } - }; - - const fakeProcessCloudFilterWithDifferentEntries = { - list: { - entries: [ - { - entry: { - key: 'my-mock-key-1', - value: 'my-mock-value-2' - } - }, - { - entry: { - key: 'my-mock-key-2', - value: 'my-mock-key-2' - } - } - ], - pagination: { - skipCount: 0, - maxItems: 100, - count: 4, - hasMoreItems: false, - totalItems: 2 - } - } - }; - - const fakeProcessCloudFilters = [ - { - name: 'MOCK_PROCESS_NAME_1', - id: '1', - key: 'all-mock-process', - icon: 'adjust', - appName: 'mock-appName', - sort: 'startDate', - status: 'MOCK_ALL', - order: 'DESC' - }, - { - name: 'MOCK_PROCESS_NAME_2', - id: '2', - key: 'run-mock-process', - icon: 'adjust', - appName: 'mock-appName', - sort: 'startDate', - status: 'MOCK-RUNNING', - order: 'DESC' - }, - { - name: 'MOCK_PROCESS_NAME_3', - id: '3', - key: 'complete-mock-process', - icon: 'adjust', - appName: 'mock-appName', - sort: 'startDate', - status: 'MOCK-COMPLETED', - order: 'DESC' - } - ]; - setupTestBed({ imports: [ TranslateModule.forRoot(), diff --git a/lib/process-services-cloud/src/lib/task/task-filters/components/base-task-filters-cloud.component.html b/lib/process-services-cloud/src/lib/task/task-filters/components/base-task-filters-cloud.component.html index 125ed957b9..88e36c2e36 100644 --- a/lib/process-services-cloud/src/lib/task/task-filters/components/base-task-filters-cloud.component.html +++ b/lib/process-services-cloud/src/lib/task/task-filters/components/base-task-filters-cloud.component.html @@ -1,6 +1,6 @@
-
- \ No newline at end of file + diff --git a/lib/process-services-cloud/src/lib/task/task-filters/components/service-task-filters-cloud.component.spec.ts b/lib/process-services-cloud/src/lib/task/task-filters/components/service-task-filters-cloud.component.spec.ts index 4b01c8d912..4c20e80ed4 100644 --- a/lib/process-services-cloud/src/lib/task/task-filters/components/service-task-filters-cloud.component.spec.ts +++ b/lib/process-services-cloud/src/lib/task/task-filters/components/service-task-filters-cloud.component.spec.ts @@ -254,22 +254,35 @@ describe('ServiceTaskFiltersCloudComponent', () => { })); - it('should emit an event when a filter is selected', async(() => { + it('should emit the selected filter based on the filterParam input', async () => { spyOn(serviceTaskFilterCloudService, 'getTaskListFilters').and.returnValue(fakeGlobalFilterObservable); + spyOn(component.filterSelected, 'emit'); - component.filterParam = { id: '12' }; + const filterParam = { id: '10' }; + const change = new SimpleChange(null, filterParam, true); + component.filterParam = filterParam; - const appName = 'my-app-1'; - const change = new SimpleChange(null, appName, true); - component.ngOnChanges({ 'appName': change }); + component.ngOnChanges({ 'filterParam': change }); + fixture.detectChanges(); + + expect(component.filterSelected.emit).toHaveBeenCalledWith(fakeGlobalServiceFilters[0]); + }); + + it('should filterClicked emit when a filter is clicked from the UI', async () => { + spyOn(serviceTaskFilterCloudService, 'getTaskListFilters').and.returnValue(fakeGlobalFilterObservable); + spyOn(component.filterClicked, 'emit'); fixture.detectChanges(); - spyOn(component, 'selectFilterAndEmit').and.stub(); - const filterButton = fixture.debugElement.nativeElement.querySelector(`[data-automation-id="${fakeGlobalServiceFilters[1].key}_filter"]`); + await fixture.whenStable(); + const filterButton = fixture.debugElement.nativeElement.querySelector(`[data-automation-id="${fakeGlobalServiceFilters[0].key}_filter"]`); filterButton.click(); - expect(component.selectFilterAndEmit).toHaveBeenCalledWith(fakeGlobalServiceFilters[1]); - })); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(component.filterClicked.emit).toHaveBeenCalledWith(fakeGlobalServiceFilters[0]); + }); it('should reset the filter when the param is undefined', async(() => { spyOn(serviceTaskFilterCloudService, 'getTaskListFilters').and.returnValue(fakeGlobalFilterObservable); diff --git a/lib/process-services-cloud/src/lib/task/task-filters/components/service-task-filters-cloud.component.ts b/lib/process-services-cloud/src/lib/task/task-filters/components/service-task-filters-cloud.component.ts index 6fd69f07b2..1f43425367 100644 --- a/lib/process-services-cloud/src/lib/task/task-filters/components/service-task-filters-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/task/task-filters/components/service-task-filters-cloud.component.ts @@ -30,9 +30,13 @@ import { ServiceTaskFilterCloudService } from '../services/service-task-filter-c }) export class ServiceTaskFiltersCloudComponent extends BaseTaskFiltersCloudComponent implements OnInit, OnChanges { - /** Emitted when a filter in the list is clicked. */ + /** Emitted when a filter is being selected based on the filterParam input. */ @Output() - filterClick = new EventEmitter(); + filterSelected = new EventEmitter(); + + /** Emitted when a filter is being clicked from the UI. */ + @Output() + filterClicked = new EventEmitter(); filters$: Observable; filters: ServiceTaskFilterCloudModel[] = []; @@ -91,7 +95,19 @@ export class ServiceTaskFiltersCloudComponent extends BaseTaskFiltersCloudCompon public selectFilterAndEmit(newParamFilter: FilterParamsModel) { if (newParamFilter) { this.selectFilter(newParamFilter); - this.filterClick.emit(this.currentFilter); + this.filterSelected.emit(this.currentFilter); + } else { + this.currentFilter = undefined; + } + } + + /** + * Selects and emits the clicked filter. + */ + public onFilterClick(filter: FilterParamsModel) { + if (filter) { + this.selectFilter(filter); + this.filterClicked.emit(this.currentFilter); } else { this.currentFilter = undefined; } diff --git a/lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.spec.ts b/lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.spec.ts index eee31ec0cf..6900a14316 100644 --- a/lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.spec.ts +++ b/lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.spec.ts @@ -254,22 +254,35 @@ describe('TaskFiltersCloudComponent', () => { })); - it('should emit an event when a filter is selected', async(() => { + it('should emit the selected filter based on the filterParam input', async(() => { spyOn(taskFilterService, 'getTaskListFilters').and.returnValue(fakeGlobalFilterObservable); + spyOn(component.filterSelected, 'emit'); - component.filterParam = { id: '12' }; + const filterParam = { id: '10' }; + const change = new SimpleChange(null, filterParam, true); + component.filterParam = filterParam; - const appName = 'my-app-1'; - const change = new SimpleChange(null, appName, true); - component.ngOnChanges({ 'appName': change }); + component.ngOnChanges({ 'filterParam': change }); + fixture.detectChanges(); + + expect(component.filterSelected.emit).toHaveBeenCalledWith(fakeGlobalFilter[0]); + })); + + it('should filterClicked emit when a filter is clicked from the UI', async () => { + spyOn(taskFilterService, 'getTaskListFilters').and.returnValue(fakeGlobalFilterObservable); + spyOn(component.filterClicked, 'emit'); fixture.detectChanges(); - spyOn(component, 'selectFilterAndEmit').and.stub(); - const filterButton = fixture.debugElement.nativeElement.querySelector(`[data-automation-id="${fakeGlobalFilter[1].key}_filter"]`); + await fixture.whenStable(); + const filterButton = fixture.debugElement.nativeElement.querySelector(`[data-automation-id="${fakeGlobalFilter[0].key}_filter"]`); filterButton.click(); - expect(component.selectFilterAndEmit).toHaveBeenCalledWith(fakeGlobalFilter[1]); - })); + + fixture.detectChanges(); + await fixture.whenStable(); + + expect(component.filterClicked.emit).toHaveBeenCalledWith(fakeGlobalFilter[0]); + }); it('should reset the filter when the param is undefined', async(() => { spyOn(taskFilterService, 'getTaskListFilters').and.returnValue(fakeGlobalFilterObservable); diff --git a/lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts b/lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts index 46386163d2..eec4fe45dd 100644 --- a/lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts @@ -29,9 +29,13 @@ import { BaseTaskFiltersCloudComponent } from './base-task-filters-cloud.compone styleUrls: ['base-task-filters-cloud.component.scss'] }) export class TaskFiltersCloudComponent extends BaseTaskFiltersCloudComponent implements OnInit, OnChanges { - /** Emitted when a filter in the list is clicked. */ + /** Emitted when a filter is being selected based on the filterParam input. */ @Output() - filterClick = new EventEmitter(); + filterSelected = new EventEmitter(); + + /** Emitted when a filter is being clicked from the UI. */ + @Output() + filterClicked = new EventEmitter(); filters$: Observable; filters: TaskFilterCloudModel[] = []; @@ -90,7 +94,19 @@ export class TaskFiltersCloudComponent extends BaseTaskFiltersCloudComponent imp public selectFilterAndEmit(newParamFilter: FilterParamsModel) { if (newParamFilter) { this.selectFilter(newParamFilter); - this.filterClick.emit(this.currentFilter); + this.filterSelected.emit(this.currentFilter); + } else { + this.currentFilter = undefined; + } + } + + /** + * Selects and emits the clicked filter. + */ + public onFilterClick(filter: FilterParamsModel) { + if (filter) { + this.selectFilter(filter); + this.filterClicked.emit(this.currentFilter); } else { this.currentFilter = undefined; } diff --git a/lib/process-services-cloud/src/lib/task/task-filters/mock/task-filters-cloud.mock.ts b/lib/process-services-cloud/src/lib/task/task-filters/mock/task-filters-cloud.mock.ts index c5523049df..eb073819d5 100644 --- a/lib/process-services-cloud/src/lib/task/task-filters/mock/task-filters-cloud.mock.ts +++ b/lib/process-services-cloud/src/lib/task/task-filters/mock/task-filters-cloud.mock.ts @@ -22,7 +22,7 @@ export const fakeGlobalFilter = [ name: 'FakeInvolvedTasks', key: 'fake-involved-tasks', icon: 'adjust', - id: 10, + id: '10', status: 'open', assignee: 'fake-involved' }), @@ -30,7 +30,7 @@ export const fakeGlobalFilter = [ name: 'FakeMyTasks1', key: 'fake-my-tast1', icon: 'done', - id: 11, + id: '11', status: 'open', assignee: 'fake-assignee' }), @@ -38,7 +38,7 @@ export const fakeGlobalFilter = [ name: 'FakeMyTasks2', key: 'fake-my-tast2', icon: 'inbox', - id: 12, + id: '12', status: 'open', assignee: 'fake-assignee' }) diff --git a/lib/process-services/src/lib/mock/process/process-filters.mock.ts b/lib/process-services/src/lib/mock/process/process-filters.mock.ts new file mode 100644 index 0000000000..d69a2caec9 --- /dev/null +++ b/lib/process-services/src/lib/mock/process/process-filters.mock.ts @@ -0,0 +1,51 @@ +/*! + * @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 { FilterProcessRepresentationModel } from '../../process-list/models/filter-process.model'; + +export let fakeProcessFilters = [ + new FilterProcessRepresentationModel({ + id: 10, + name: 'FakeCompleted', + icon: 'glyphicon-th', + filter: { state: 'open', assignment: 'fake-involved' } + }), + new FilterProcessRepresentationModel({ + id: 20, + name: 'FakeAll', + icon: 'glyphicon-random', + filter: { state: 'open', assignment: 'fake-assignee' } + }), + new FilterProcessRepresentationModel({ + id: 30, + name: 'Running', + icon: 'glyphicon-ok-sign', + filter: { state: 'open', assignment: 'fake-running' } + }) +]; + +export let fakeProcessFiltersResponse = { + size: 1, total: 1, start: 0, + data: [new FilterProcessRepresentationModel({ + 'name': 'Running', + 'appId': '22', + 'id': 333, + 'recent': true, + 'icon': 'glyphicon-random', + 'filter': { 'sort': 'created-desc', 'name': '', 'state': 'running' } + })] +}; diff --git a/lib/process-services/src/lib/mock/process/process.service.mock.ts b/lib/process-services/src/lib/mock/process/process.service.mock.ts index bb33926084..deae277a40 100644 --- a/lib/process-services/src/lib/mock/process/process.service.mock.ts +++ b/lib/process-services/src/lib/mock/process/process.service.mock.ts @@ -16,26 +16,8 @@ */ import { AppDefinitionRepresentationModel, TaskDetailsModel } from '../../task-list'; -import { FilterProcessRepresentationModel } from '../../process-list/models/filter-process.model'; import { ProcessDefinitionRepresentation } from '../../process-list/models/process-definition.model'; -export let fakeProcessFilters = { - size: 1, total: 1, start: 0, - data: [new FilterProcessRepresentationModel({ - 'name': 'Running', - 'appId': '22', - 'id': 333, - 'recent': true, - 'icon': 'glyphicon-random', - 'filter': { 'sort': 'created-desc', 'name': '', 'state': 'running' } - })] -}; - -export let fakeEmptyFilters = { - size: 0, total: 0, start: 0, - data: [] -}; - export let mockError = { message: null, messageKey: 'GENERAL.ERROR.FORBIDDEN' diff --git a/lib/process-services/src/lib/mock/public-api.ts b/lib/process-services/src/lib/mock/public-api.ts index 12a4e19c8f..c3c406af86 100644 --- a/lib/process-services/src/lib/mock/public-api.ts +++ b/lib/process-services/src/lib/mock/public-api.ts @@ -26,3 +26,5 @@ export * from './task/task-details.mock'; export * from './task/task-details.component.mock'; export * from './task/task-list.mock'; export * from './task/tasklist-service.mock'; +export * from './process/process-filters.mock'; +export * from './task/task-filters.mock'; diff --git a/lib/process-services/src/lib/mock/task/task-filters.mock.ts b/lib/process-services/src/lib/mock/task/task-filters.mock.ts new file mode 100644 index 0000000000..9834836ece --- /dev/null +++ b/lib/process-services/src/lib/mock/task/task-filters.mock.ts @@ -0,0 +1,103 @@ +/*! + * @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 { AppDefinitionRepresentationModel, FilterRepresentationModel } from '../../task-list/models/filter.model'; + +export let fakeFiltersResponse = { + size: 2, total: 2, start: 0, + data: [ + new AppDefinitionRepresentationModel( + { + id: 1, name: 'FakeInvolvedTasks', recent: false, icon: 'glyphicon-align-left', + filter: { sort: 'created-desc', name: '', state: 'open', assignment: 'fake-involved' } + } + ), + { + id: 2, name: 'FakeMyTasks', recent: false, icon: 'glyphicon-align-left', + filter: { sort: 'created-desc', name: '', state: 'open', assignment: 'fake-assignee' } + } + ] +}; + +export let fakeTaskFilters = [ + new FilterRepresentationModel({ + name: 'FakeInvolvedTasks', + icon: 'glyphicon-align-left', + id: 10, + filter: { state: 'open', assignment: 'fake-involved' } + }), + new FilterRepresentationModel({ + name: 'FakeMyTasks1', + icon: 'glyphicon-ok-sign', + id: 11, + filter: { state: 'open', assignment: 'fake-assignee' } + }), + new FilterRepresentationModel({ + name: 'FakeMyTasks2', + icon: 'glyphicon-inbox', + id: 12, + filter: { state: 'open', assignment: 'fake-assignee' } + }) +]; + +export let fakeAppFilter = { + size: 1, total: 1, start: 0, + data: [ + { + id: 1, name: 'FakeInvolvedTasks', recent: false, icon: 'glyphicon-align-left', + filter: { sort: 'created-desc', name: '', state: 'open', assignment: 'fake-involved' } + } + ] +}; + +export let fakeFilter = { + sort: 'created-desc', text: '', state: 'open', assignment: 'fake-assignee' +}; + +export let fakeRepresentationFilter1: FilterRepresentationModel = new FilterRepresentationModel({ + appId: 1, + name: 'CONTAIN FILTER', + recent: true, + icon: 'glyphicon-align-left', + filter: { + processDefinitionId: null, + processDefinitionKey: null, + name: null, + state: 'open', + sort: 'created-desc', + assignment: 'involved', + dueAfter: null, + dueBefore: null + } +}); + +export let fakeRepresentationFilter2: FilterRepresentationModel = new FilterRepresentationModel({ + appId: 2, + name: 'NO TASK FILTER', + recent: false, + icon: 'glyphicon-inbox', + filter: { + processDefinitionId: null, + processDefinitionKey: null, + name: null, + state: 'open', + sort: 'created-desc', + assignment: 'assignee', + dueAfter: null, + dueBefore: null + } +}); diff --git a/lib/process-services/src/lib/mock/task/tasklist-service.mock.ts b/lib/process-services/src/lib/mock/task/tasklist-service.mock.ts index bdd98108ae..5dc13dc37d 100644 --- a/lib/process-services/src/lib/mock/task/tasklist-service.mock.ts +++ b/lib/process-services/src/lib/mock/task/tasklist-service.mock.ts @@ -15,36 +15,7 @@ * limitations under the License. */ -import { - AppDefinitionRepresentationModel, - FilterRepresentationModel -} from '../../task-list/models/filter.model'; - -export let fakeFilters = { - size: 2, total: 2, start: 0, - data: [ - new AppDefinitionRepresentationModel( - { - id: 1, name: 'FakeInvolvedTasks', recent: false, icon: 'glyphicon-align-left', - filter: { sort: 'created-desc', name: '', state: 'open', assignment: 'fake-involved' } - } - ), - { - id: 2, name: 'FakeMyTasks', recent: false, icon: 'glyphicon-align-left', - filter: { sort: 'created-desc', name: '', state: 'open', assignment: 'fake-assignee' } - } - ] -}; - -export let fakeAppFilter = { - size: 1, total: 1, start: 0, - data: [ - { - id: 1, name: 'FakeInvolvedTasks', recent: false, icon: 'glyphicon-align-left', - filter: { sort: 'created-desc', name: '', state: 'open', assignment: 'fake-involved' } - } - ] -}; +import { fakeAppFilter } from './task-filters.mock'; export let fakeApps = { size: 2, total: 2, start: 0, @@ -60,10 +31,6 @@ export let fakeApps = { ] }; -export let fakeFilter = { - sort: 'created-desc', text: '', state: 'open', assignment: 'fake-assignee' -}; - export let fakeUser1 = { id: 1, email: 'fake-email@dom.com', firstName: 'firstName', lastName: 'lastName' }; export let fakeUser2 = { id: 1001, email: 'some-one@somegroup.com', firstName: 'some', lastName: 'one' }; @@ -142,40 +109,6 @@ export let fakeTasksChecklist = { ] }; -export let fakeRepresentationFilter1: FilterRepresentationModel = new FilterRepresentationModel({ - appId: 1, - name: 'CONTAIN FILTER', - recent: true, - icon: 'glyphicon-align-left', - filter: { - processDefinitionId: null, - processDefinitionKey: null, - name: null, - state: 'open', - sort: 'created-desc', - assignment: 'involved', - dueAfter: null, - dueBefore: null - } -}); - -export let fakeRepresentationFilter2: FilterRepresentationModel = new FilterRepresentationModel({ - appId: 2, - name: 'NO TASK FILTER', - recent: false, - icon: 'glyphicon-inbox', - filter: { - processDefinitionId: null, - processDefinitionKey: null, - name: null, - state: 'open', - sort: 'created-desc', - assignment: 'assignee', - dueAfter: null, - dueBefore: null - } -}); - export let fakeAppPromise = new Promise(function (resolve) { resolve(fakeAppFilter); }); diff --git a/lib/process-services/src/lib/process-list/components/process-filters.component.spec.ts b/lib/process-services/src/lib/process-list/components/process-filters.component.spec.ts index 55848caa4a..4fec2a0f54 100644 --- a/lib/process-services/src/lib/process-list/components/process-filters.component.spec.ts +++ b/lib/process-services/src/lib/process-list/components/process-filters.component.spec.ts @@ -23,7 +23,7 @@ import { ProcessFilterService } from '../services/process-filter.service'; import { ProcessFiltersComponent } from './process-filters.component'; import { ComponentFixture, TestBed } from '@angular/core/testing'; import { By } from '@angular/platform-browser'; -import { fakeProcessFilters } from '../../mock'; +import { fakeProcessFilters } from '../../mock/process/process-filters.mock'; import { ProcessTestingModule } from '../../testing/process.testing.module'; import { TranslateModule } from '@ngx-translate/core'; @@ -47,28 +47,7 @@ describe('ProcessFiltersComponent', () => { beforeEach(() => { fixture = TestBed.createComponent(ProcessFiltersComponent); filterList = fixture.componentInstance; - - fakeGlobalFilterPromise = Promise.resolve([ - new FilterProcessRepresentationModel({ - id: 10, - name: 'FakeCompleted', - icon: 'glyphicon-th', - filter: { state: 'open', assignment: 'fake-involved' } - }), - new FilterProcessRepresentationModel({ - id: 20, - name: 'FakeAll', - icon: 'glyphicon-random', - filter: { state: 'open', assignment: 'fake-assignee' } - }), - new FilterProcessRepresentationModel({ - id: 30, - name: 'Running', - icon: 'glyphicon-ok-sign', - filter: { state: 'open', assignment: 'fake-running' } - }) - ]); - + fakeGlobalFilterPromise = Promise.resolve(fakeProcessFilters); processFilterService = TestBed.inject(ProcessFilterService); appsProcessService = TestBed.inject(AppsProcessService); }); @@ -113,7 +92,7 @@ describe('ProcessFiltersComponent', () => { fixture.detectChanges(); }); - it('should emit an event when a filter is selected', (done) => { + it('should emit the selected filter based on the filterParam input', (done) => { spyOn(processFilterService, 'getProcessFilters').and.returnValue(from(fakeGlobalFilterPromise)); filterList.filterParam = new FilterProcessRepresentationModel({ id: 10 }); const appId = '1'; @@ -130,15 +109,33 @@ describe('ProcessFiltersComponent', () => { fixture.detectChanges(); }); + it('should filterClicked emit when a filter is clicked from the UI', async () => { + filterList.filters = fakeProcessFilters; + spyOn(filterList.filterClicked, 'emit'); + + fixture.detectChanges(); + await fixture.whenStable(); + + const filterButton = fixture.debugElement.nativeElement.querySelector(`[data-automation-id="${fakeProcessFilters[0].name}_filter"]`); + filterButton.click(); + + expect(filterList.filterClicked.emit).toHaveBeenCalledWith(fakeProcessFilters[0]); + }); + it('should reset selection when filterParam is a filter that does not exist', async () => { spyOn(processFilterService, 'getProcessFilters').and.returnValue(from(fakeGlobalFilterPromise)); - filterList.currentFilter = fakeProcessFilters.data[0]; - filterList.filterParam = new FilterProcessRepresentationModel({ name: 'non-existing-filter' }); + + const nonExistingFilterParam = { name: 'non-existing-filter' }; const appId = '1'; const change = new SimpleChange(null, appId, true); + + filterList.currentFilter = nonExistingFilterParam; + filterList.filterParam = new FilterProcessRepresentationModel(nonExistingFilterParam); + filterList.ngOnChanges({ 'appId': change }); fixture.detectChanges(); await fixture.whenStable(); + expect(filterList.currentFilter).toBe(undefined); }); @@ -199,7 +196,7 @@ describe('ProcessFiltersComponent', () => { filter: { state: 'open', assignment: 'fake-involved' } }); - filterList.filterClick.subscribe((filter: FilterProcessRepresentationModel) => { + filterList.filterClicked.subscribe((filter: FilterProcessRepresentationModel) => { expect(filter).toBeDefined(); expect(filter).toEqual(currentFilter); expect(filterList.currentFilter).toEqual(currentFilter); diff --git a/lib/process-services/src/lib/process-list/components/process-filters.component.ts b/lib/process-services/src/lib/process-list/components/process-filters.component.ts index 19cda3b08c..767b40977a 100644 --- a/lib/process-services/src/lib/process-list/components/process-filters.component.ts +++ b/lib/process-services/src/lib/process-list/components/process-filters.component.ts @@ -36,9 +36,9 @@ export class ProcessFiltersComponent implements OnInit, OnChanges { @Input() filterParam: FilterProcessRepresentationModel; - /** Emitted when the user selects a filter from the list. */ + /** Emitted when a filter is being clicked from the UI. */ @Output() - filterClick: EventEmitter = new EventEmitter(); + filterClicked: EventEmitter = new EventEmitter(); /** Emitted when the list of filters has been successfully loaded from the server. */ @Output() @@ -60,9 +60,9 @@ export class ProcessFiltersComponent implements OnInit, OnChanges { @Input() showIcon: boolean = true; - /** Emitted when a process filter is selected. */ + /** Emitted when a filter is being selected based on the filterParam input. */ @Output() - filterSelected: EventEmitter = new EventEmitter(); + filterSelected: EventEmitter = new EventEmitter(); filter$: Observable; @@ -149,7 +149,7 @@ export class ProcessFiltersComponent implements OnInit, OnChanges { selectFilter(filter: ProcessInstanceFilterRepresentation) { this.currentFilter = filter; this.active = true; - this.filterClick.emit(filter); + this.filterClicked.emit(filter); } /** diff --git a/lib/process-services/src/lib/process-list/services/process-filter.service.spec.ts b/lib/process-services/src/lib/process-list/services/process-filter.service.spec.ts index e43761cbaf..fda301a781 100644 --- a/lib/process-services/src/lib/process-list/services/process-filter.service.spec.ts +++ b/lib/process-services/src/lib/process-list/services/process-filter.service.spec.ts @@ -16,7 +16,7 @@ */ import { async } from '@angular/core/testing'; -import { mockError, fakeProcessFilters } from '../../mock'; +import { mockError, fakeProcessFiltersResponse } from '../../mock'; import { FilterProcessRepresentationModel } from '../models/filter-process.model'; import { ProcessFilterService } from './process-filter.service'; import { AlfrescoApiServiceMock, AlfrescoApiService, AppConfigService, @@ -50,7 +50,7 @@ describe('Process filter', () => { beforeEach(() => { getFilters = spyOn(alfrescoApi.activiti.userFiltersApi, 'getUserProcessInstanceFilters') .and - .returnValue(Promise.resolve(fakeProcessFilters)); + .returnValue(Promise.resolve(fakeProcessFiltersResponse)); jasmine.Ajax.install(); }); @@ -164,7 +164,7 @@ describe('Process filter', () => { .callFake((processfilter: FilterProcessRepresentationModel) => Promise.resolve(processfilter)); }); - const filter = fakeProcessFilters.data[0]; + const filter = fakeProcessFiltersResponse.data[0]; it('should call the API to create the filter', () => { service.addProcessFilter(filter); diff --git a/lib/process-services/src/lib/task-list/components/task-filters.component.html b/lib/process-services/src/lib/task-list/components/task-filters.component.html index 6309dfd62c..a93215239e 100644 --- a/lib/process-services/src/lib/task-list/components/task-filters.component.html +++ b/lib/process-services/src/lib/task-list/components/task-filters.component.html @@ -1,5 +1,5 @@
- -
\ No newline at end of file + diff --git a/lib/process-services/src/lib/task-list/components/task-filters.component.spec.ts b/lib/process-services/src/lib/task-list/components/task-filters.component.spec.ts index 58d51871d9..d316ebb073 100644 --- a/lib/process-services/src/lib/task-list/components/task-filters.component.spec.ts +++ b/lib/process-services/src/lib/task-list/components/task-filters.component.spec.ts @@ -26,6 +26,7 @@ import { TaskFiltersComponent } from './task-filters.component'; import { ProcessTestingModule } from '../../testing/process.testing.module'; import { By } from '@angular/platform-browser'; import { TranslateModule } from '@ngx-translate/core'; +import { fakeTaskFilters } from '../../mock/task/task-filters.mock'; describe('TaskFiltersComponent', () => { @@ -33,28 +34,8 @@ describe('TaskFiltersComponent', () => { let taskFilterService: TaskFilterService; let appsProcessService: AppsProcessService; - const fakeGlobalFilter = []; - fakeGlobalFilter.push(new FilterRepresentationModel({ - name: 'FakeInvolvedTasks', - icon: 'glyphicon-align-left', - id: 10, - filter: { state: 'open', assignment: 'fake-involved' } - })); - fakeGlobalFilter.push(new FilterRepresentationModel({ - name: 'FakeMyTasks1', - icon: 'glyphicon-ok-sign', - id: 11, - filter: { state: 'open', assignment: 'fake-assignee' } - })); - fakeGlobalFilter.push(new FilterRepresentationModel({ - name: 'FakeMyTasks2', - icon: 'glyphicon-inbox', - id: 12, - filter: { state: 'open', assignment: 'fake-assignee' } - })); - const fakeGlobalFilterPromise = new Promise(function (resolve) { - resolve(fakeGlobalFilter); + resolve(fakeTaskFilters); }); const fakeGlobalEmptyFilter = { @@ -217,17 +198,31 @@ describe('TaskFiltersComponent', () => { }); }); - it('should emit an event when a filter is selected', (done) => { - const currentFilter = fakeGlobalFilter[0]; - component.filters = fakeGlobalFilter; - component.filterClick.subscribe((filter: FilterRepresentationModel) => { - expect(filter).toBeDefined(); - expect(filter).toEqual(currentFilter); - expect(component.currentFilter).toEqual(currentFilter); - done(); - }); + it('should emit the selected filter based on the filterParam input', () => { + spyOn(component.filterSelected, 'emit'); + component.filters = fakeTaskFilters; - component.selectFilterAndEmit(currentFilter); + const filterParam = new FilterParamsModel({ id: 10 }); + const change = new SimpleChange(null, filterParam, true); + component.filterParam = filterParam; + + component.ngOnChanges({ 'filterParam': change }); + fixture.detectChanges(); + + expect(component.filterSelected.emit).toHaveBeenCalledWith(fakeTaskFilters[0]); + }); + + it('should filterClicked emit when a filter is clicked from the UI', async () => { + component.filters = fakeTaskFilters; + spyOn(component.filterClicked, 'emit'); + + fixture.detectChanges(); + await fixture.whenStable(); + + const filterButton = fixture.debugElement.nativeElement.querySelector(`[data-automation-id="${fakeTaskFilters[0].name}_filter"]`); + filterButton.click(); + + expect(component.filterClicked.emit).toHaveBeenCalledWith(fakeTaskFilters[0]); }); it('should reload filters by appId on binding changes', () => { @@ -251,25 +246,25 @@ describe('TaskFiltersComponent', () => { }); it('should change current filter when filterParam (id) changes', async () => { - component.filters = fakeGlobalFilter; + component.filters = fakeTaskFilters; component.currentFilter = null; fixture.whenStable().then(() => { - expect(component.currentFilter.id).toEqual(fakeGlobalFilter[2].id); + expect(component.currentFilter.id).toEqual(fakeTaskFilters[2].id); }); - const change = new SimpleChange(null, { id: fakeGlobalFilter[2].id }, true); + const change = new SimpleChange(null, { id: fakeTaskFilters[2].id }, true); component.ngOnChanges({ 'filterParam': change }); }); it('should change current filter when filterParam (name) changes', async () => { - component.filters = fakeGlobalFilter; + component.filters = fakeTaskFilters; component.currentFilter = null; fixture.whenStable().then(() => { - expect(component.currentFilter.name).toEqual(fakeGlobalFilter[2].name); + expect(component.currentFilter.name).toEqual(fakeTaskFilters[2].name); }); - const change = new SimpleChange(null, { name: fakeGlobalFilter[2].name }, true); + const change = new SimpleChange(null, { name: fakeTaskFilters[2].name }, true); component.ngOnChanges({ 'filterParam': change }); }); @@ -284,12 +279,11 @@ describe('TaskFiltersComponent', () => { }); it('should return the current filter after one is selected', () => { - const filter = fakeGlobalFilter[1]; - component.filters = fakeGlobalFilter; + component.filters = fakeTaskFilters; expect(component.currentFilter).toBeUndefined(); - component.selectFilter(filter); - expect(component.getCurrentFilter()).toBe(filter); + component.selectFilter(fakeTaskFilters[1]); + expect(component.getCurrentFilter()).toBe(fakeTaskFilters[1]); }); it('should load default list when app id is null', () => { @@ -306,7 +300,7 @@ describe('TaskFiltersComponent', () => { name: 'FakeMyTasks', filter: { state: 'open', assignment: 'fake-assignee' } }); - component.filters = fakeGlobalFilter; + component.filters = fakeTaskFilters; component.currentFilter = filter; spyOn(taskListService, 'isTaskRelatedToFilter').and.returnValue(of(null)); component.selectFilterWithTask('111'); @@ -348,7 +342,7 @@ describe('TaskFiltersComponent', () => { it('should reset selection when filterParam is a filter that does not exist', async () => { spyOn(taskFilterService, 'getTaskListFilters').and.returnValue(from(fakeGlobalFilterPromise)); - component.currentFilter = fakeGlobalFilter[0]; + component.currentFilter = fakeTaskFilters[0]; component.filterParam = new FilterRepresentationModel( {name: 'non-existing-filter'}); const appId = '1'; const change = new SimpleChange(null, appId, true); diff --git a/lib/process-services/src/lib/task-list/components/task-filters.component.ts b/lib/process-services/src/lib/task-list/components/task-filters.component.ts index f38998a479..d0c68221c6 100644 --- a/lib/process-services/src/lib/task-list/components/task-filters.component.ts +++ b/lib/process-services/src/lib/task-list/components/task-filters.component.ts @@ -36,9 +36,13 @@ export class TaskFiltersComponent implements OnInit, OnChanges { @Input() filterParam: FilterParamsModel; - /** Emitted when a filter in the list is clicked. */ + /** Emitted when a filter is being clicked from the UI. */ @Output() - filterClick: EventEmitter = new EventEmitter(); + filterClicked: EventEmitter = new EventEmitter(); + + /** Emitted when a filter is being selected based on the filterParam input. */ + @Output() + filterSelected: EventEmitter = new EventEmitter(); /** Emitted when the list is loaded. */ @Output() @@ -86,7 +90,7 @@ export class TaskFiltersComponent implements OnInit, OnChanges { } else if (appId && appId.currentValue !== appId.previousValue) { this.getFiltersByAppId(appId.currentValue); } else if (filter && filter.currentValue !== filter.previousValue) { - this.selectFilter(filter.currentValue); + this.selectFilterAndEmit(filter.currentValue); } } @@ -170,7 +174,15 @@ export class TaskFiltersComponent implements OnInit, OnChanges { public selectFilterAndEmit(newFilter: FilterParamsModel) { this.selectFilter(newFilter); - this.filterClick.emit(this.currentFilter); + this.filterSelected.emit(this.currentFilter); + } + + /** + * Selects and emits the clicked filter. + */ + onFilterClick(filter: FilterParamsModel) { + this.selectFilter(filter); + this.filterClicked.emit(this.currentFilter); } /** @@ -189,7 +201,7 @@ export class TaskFiltersComponent implements OnInit, OnChanges { () => { if (filteredFilterList.length > 0) { this.selectFilter(filteredFilterList[0]); - this.filterClick.emit(this.currentFilter); + this.filterSelected.emit(this.currentFilter); } }); } diff --git a/lib/process-services/src/lib/task-list/services/task-filter.service.spec.ts b/lib/process-services/src/lib/task-list/services/task-filter.service.spec.ts index ab593d38a6..559b5b0d65 100644 --- a/lib/process-services/src/lib/task-list/services/task-filter.service.spec.ts +++ b/lib/process-services/src/lib/task-list/services/task-filter.service.spec.ts @@ -16,7 +16,8 @@ */ import { async } from '@angular/core/testing'; -import { fakeAppFilter, fakeAppPromise, fakeFilters } from '../../mock'; +import { fakeAppPromise } from '../../mock'; +import { fakeFiltersResponse, fakeAppFilter } from '../../mock/task/task-filters.mock'; import { FilterRepresentationModel } from '../models/filter.model'; import { TaskFilterService } from './task-filter.service'; import { AlfrescoApiServiceMock, LogService, AppConfigService, setupTestBed, CoreModule, StorageService } from '@alfresco/adf-core'; @@ -58,7 +59,7 @@ describe('Activiti Task filter Service', () => { jasmine.Ajax.requests.mostRecent().respondWith({ 'status': 200, contentType: 'application/json', - responseText: JSON.stringify(fakeFilters) + responseText: JSON.stringify(fakeFiltersResponse) }); }); @@ -76,7 +77,7 @@ describe('Activiti Task filter Service', () => { jasmine.Ajax.requests.mostRecent().respondWith({ 'status': 200, contentType: 'application/json', - responseText: JSON.stringify(fakeFilters) + responseText: JSON.stringify(fakeFiltersResponse) }); }); @@ -95,7 +96,7 @@ describe('Activiti Task filter Service', () => { jasmine.Ajax.requests.mostRecent().respondWith({ 'status': 200, contentType: 'application/json', - responseText: JSON.stringify(fakeFilters) + responseText: JSON.stringify(fakeFiltersResponse) }); }); diff --git a/lib/process-services/src/lib/task-list/services/tasklist.service.spec.ts b/lib/process-services/src/lib/task-list/services/tasklist.service.spec.ts index 1ae6a6c3d5..e03fc82c0e 100644 --- a/lib/process-services/src/lib/task-list/services/tasklist.service.spec.ts +++ b/lib/process-services/src/lib/task-list/services/tasklist.service.spec.ts @@ -20,11 +20,8 @@ import { UserProcessModel, setupTestBed, CoreModule, StorageService, AlfrescoApi import { of } from 'rxjs'; import { fakeCompletedTaskList, - fakeFilter, fakeFormList, fakeOpenTaskList, - fakeRepresentationFilter1, - fakeRepresentationFilter2, fakeTaskDetails, fakeTaskList, fakeTasksChecklist, @@ -32,6 +29,7 @@ import { fakeUser2, secondFakeTaskList } from '../../mock'; +import { fakeRepresentationFilter1, fakeRepresentationFilter2, fakeFilter } from '../../mock/task/task-filters.mock'; import { FilterRepresentationModel, TaskQueryRequestRepresentationModel } from '../models/filter.model'; import { TaskDetailsModel } from '../models/task-details.model'; import { TaskListService } from './tasklist.service';