inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-09 18:03:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'develop' into copilot/explain-time-url-authentication

Browse Source
This commit is contained in:
Eugenio Romano
2026-07-03 05:12:15 +02:00
committed by GitHub
parent dae0b077f8 7f57b3936b
commit 28ef893ac2
75 changed files with 3098 additions and 693 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/content-services/src/lib/content-node-selector/content-node-selector-panel/content-node-selector-panel.component-search.spec.ts
+92 -70
View File
@@ -26,7 +26,6 @@ import { DocumentListComponent } from '../../document-list/components/document-l
import { CustomResourcesService } from '../../document-list/services/custom-resources.service';
import { NodeEntryEvent, ShareDataRow } from '../../document-list';
import { SearchQueryBuilderService } from '../../search';
import { mockSearchRequest } from '../../mock/search-query.mock';
import { SitesService } from '../../common/services/sites.service';
import { NodesApiService } from '../../common/services/nodes-api.service';
import { UnitTestingUtils } from '../../../../../core/src/lib/testing/unit-testing-utils';
@@ -161,43 +160,70 @@ describe('ContentNodeSelectorPanelComponent', () => {
});
it('should the user query get updated when the user types in the search input', fakeAsync(() => {
const updateSpy = spyOn(searchQueryBuilderService, 'update');
typeToSearchBox('search-term');
tick(debounceSearch);
fixture.detectChanges();
expect(updateSpy).toHaveBeenCalled();
expect(searchSpy).toHaveBeenCalled();
expect(searchQueryBuilderService.userQuery).toEqual('(search-term*)');
expect(component.searchTerm).toEqual('search-term');
}));
it('should set the query builder search mode to formula when the user types in the search input', fakeAsync(() => {
typeToSearchBox('search-term');
tick(debounceSearch);
fixture.detectChanges();
expect(searchQueryBuilderService.searchMode).toEqual('formula');
}));
it('should add the wildcard suffix to the user query when wildcards are enabled', fakeAsync(() => {
spyOnProperty(searchQueryBuilderService, 'wildcardsEnabled', 'get').and.returnValue(true);
typeToSearchBox('search-term');
tick(debounceSearch);
fixture.detectChanges();
expect(searchQueryBuilderService.userQuery).toEqual('(search-term*)');
}));
it('should NOT add the wildcard suffix to the user query when wildcards are disabled', fakeAsync(() => {
spyOnProperty(searchQueryBuilderService, 'wildcardsEnabled', 'get').and.returnValue(false);
typeToSearchBox('search-term');
tick(debounceSearch);
fixture.detectChanges();
expect(searchQueryBuilderService.userQuery).toEqual('(search-term)');
}));
it('should perform a search when the search request gets updated and it is defined', fakeAsync(() => {
typeToSearchBox('search-term');
tick(debounceSearch);
fixture.detectChanges();
expect(searchSpy).toHaveBeenCalledWith(false, mockSearchRequest);
expect(searchSpy).toHaveBeenCalledWith(false);
}));
it('should NOT perform a search and clear the results when the search request gets updated and it is NOT defined', async () => {
it('should NOT perform a search and clear the results when the search input is empty', fakeAsync(() => {
spyOn(component, 'clearSearch');
searchQueryBuilderService.userQuery = '';
searchQueryBuilderService.update();
typeToSearchBox('');
tick(debounceSearch);
fixture.detectChanges();
await fixture.whenStable();
expect(searchSpy).not.toHaveBeenCalled();
expect(component.clearSearch).toHaveBeenCalled();
});
}));
it('should reset the search term when clicking the clear icon', async () => {
component.searchTerm = 'search-term';
searchQueryBuilderService.userQuery = 'search-term';
spyOn(component, 'clearSearch');
spyOn(component, 'clear').and.callThrough();
fixture.detectChanges();
const clearIcon = getSearchIcon('clear');
@@ -207,7 +233,7 @@ describe('ContentNodeSelectorPanelComponent', () => {
expect(searchQueryBuilderService.userQuery).toEqual('');
expect(component.searchTerm).toEqual('');
expect(component.clearSearch).toHaveBeenCalled();
expect(component.clear).toHaveBeenCalled();
});
it('should load the results by calling the search api on search change', fakeAsync(() => {
@@ -216,22 +242,21 @@ describe('ContentNodeSelectorPanelComponent', () => {
tick(debounceSearch);
fixture.detectChanges();
expect(searchSpy).toHaveBeenCalledWith(false, mockSearchRequest);
expect(searchSpy).toHaveBeenCalledWith(false);
}));
it('should the query include the show files filterQuery', fakeAsync(() => {
spyOn(searchQueryBuilderService, 'addFilterQuery').and.callThrough();
component.showFilesInResult = true;
typeToSearchBox('search-term');
const expectedRequest = mockSearchRequest;
expectedRequest.filterQueries.push({
query: `TYPE:'cm:folder' OR TYPE:'cm:content'`
});
const expectedRequest = `TYPE:'cm:folder' OR TYPE:'cm:content'`;
tick(debounceSearch);
fixture.detectChanges();
expect(searchSpy).toHaveBeenCalledWith(false, expectedRequest);
expect(searchSpy).toHaveBeenCalledWith(false);
expect(searchQueryBuilderService.addFilterQuery).toHaveBeenCalledWith(expectedRequest);
}));
it('should reset the currently chosen node in case of starting a new search', fakeAsync(() => {
@@ -253,6 +278,7 @@ describe('ContentNodeSelectorPanelComponent', () => {
});
it('should perform a search when selecting a site with the correct query', fakeAsync(() => {
spyOn(searchQueryBuilderService, 'addFilterQuery').and.callThrough();
typeToSearchBox('search-term');
tick(debounceSearch);
@@ -261,14 +287,15 @@ describe('ContentNodeSelectorPanelComponent', () => {
component.siteChanged({ entry: { guid: 'namek' } } as SiteEntry);
const expectedRequest = mockSearchRequest;
expectedRequest.filterQueries = [{ query: `ANCESTOR:'workspace://SpacesStore/namek'` }];
const expectedRequest = `ANCESTOR:'workspace://SpacesStore/namek'`;
expect(searchSpy.calls.count()).toBe(2);
expect(searchSpy).toHaveBeenCalledWith(false, expectedRequest);
expect(searchSpy).toHaveBeenCalledWith(false);
expect(searchQueryBuilderService.addFilterQuery).toHaveBeenCalledWith(expectedRequest);
}));
it('should create the query with the right parameters on changing the site selectBox value from a custom dropdown menu', fakeAsync(() => {
spyOn(searchQueryBuilderService, 'addFilterQuery').and.callThrough();
component.dropdownSiteList = { list: { entries: [{ entry: { guid: '-sites-' } }, { entry: { guid: 'namek' } }] } } as SitePaging;
component.documentList.folderNode = { id: 'fakeNodeId', isFolder: true, path: {} } as Node;
fixture.detectChanges();
@@ -281,17 +308,12 @@ describe('ContentNodeSelectorPanelComponent', () => {
component.siteChanged({ entry: { guid: '-sites-' } } as SiteEntry);
const expectedRequest = mockSearchRequest;
expectedRequest.filterQueries = [
{
query: `ANCESTOR:'workspace://SpacesStore/-sites-' OR ANCESTOR:'workspace://SpacesStore/123456testId' OR ANCESTOR:'workspace://SpacesStore/09876543testId'`
}
];
const expectedRequest = `ANCESTOR:'workspace://SpacesStore/-sites-' OR ANCESTOR:'workspace://SpacesStore/123456testId' OR ANCESTOR:'workspace://SpacesStore/09876543testId'`;
expect(searchSpy).toHaveBeenCalled();
expect(searchSpy.calls.count()).toBe(2);
expect(searchSpy).toHaveBeenCalledWith(false, mockSearchRequest);
expect(searchSpy).toHaveBeenCalledWith(false, expectedRequest);
expect(searchSpy).toHaveBeenCalledWith(false);
expect(searchQueryBuilderService.addFilterQuery).toHaveBeenCalledWith(expectedRequest);
}));
it('should get the corresponding node ids on search when a known alias is selected from dropdown', fakeAsync(() => {
@@ -395,7 +417,7 @@ describe('ContentNodeSelectorPanelComponent', () => {
expect(component.clear).toHaveBeenCalled();
}));
it('should clear the search field, nodes and chosenNode when clicking on the X (clear) icon', async () => {
it('should reset the search term and user query when clearing the search', async () => {
component.chosenNode = [entry];
component.nodePaging = {
@@ -404,32 +426,31 @@ describe('ContentNodeSelectorPanelComponent', () => {
}
};
component.searchTerm = 'piccolo';
searchQueryBuilderService.userQuery = 'piccolo';
component.showingSearchResults = true;
component.clear();
expect(component.searchTerm).toBe('');
expect(component.nodePaging).toEqual(null);
expect(component.chosenNode).toBeNull();
expect(component.showingSearchResults).toBeFalsy();
expect(searchQueryBuilderService.userQuery).toBe('');
expect(searchSpy).toHaveBeenCalledWith(false);
});
it('should the query restrict the search to the currentFolderId in case is defined', fakeAsync(() => {
spyOn(searchQueryBuilderService, 'addFilterQuery').and.callThrough();
component.currentFolderId = 'my-root-id';
component.restrictRootToCurrentFolderId = true;
component.ngOnInit();
typeToSearchBox('search-term');
tick(debounceSearch);
const expectedRequest = mockSearchRequest;
expectedRequest.filterQueries = [{ query: `ANCESTOR:'workspace://SpacesStore/my-root-id'` }];
const expectedRequest = `ANCESTOR:'workspace://SpacesStore/my-root-id'`;
expect(searchSpy).toHaveBeenCalledWith(false, expectedRequest);
expect(searchSpy).toHaveBeenCalledWith(false);
expect(searchQueryBuilderService.addFilterQuery).toHaveBeenCalledWith(expectedRequest);
}));
it('should emit showingSearch event with true while searching', async () => {
searchQueryBuilderService.userQuery = 'mock-search-term';
searchQueryBuilderService.update();
spyOn(customResourcesService, 'hasCorrespondingNodeIds').and.returnValue(true);
const showingSearchSpy = spyOn(component.showingSearch, 'emit');
@@ -454,8 +475,7 @@ describe('ContentNodeSelectorPanelComponent', () => {
expect(showingSearchSpy).toHaveBeenCalledWith(false);
}));
it('should emit showingResults event with false when clicking on the X (clear) icon', async () => {
const showingSearchSpy = spyOn(component.showingSearch, 'emit');
it('should re-run the query with an empty user query when clicking on the X (clear) icon', async () => {
component.chosenNode = [entry];
component.nodePaging = {
@@ -464,17 +484,16 @@ describe('ContentNodeSelectorPanelComponent', () => {
}
};
component.searchTerm = 'piccolo';
component.showingSearchResults = true;
searchQueryBuilderService.userQuery = 'piccolo';
component.clear();
expect(component.showingSearchResults).toBe(false);
expect(showingSearchSpy).toHaveBeenCalledWith(false);
expect(component.searchTerm).toBe('');
expect(searchQueryBuilderService.userQuery).toBe('');
expect(searchSpy).toHaveBeenCalledWith(false);
});
it('should emit showingResults event with false if search api fails', async () => {
searchQueryBuilderService.userQuery = 'mock-search-term';
searchQueryBuilderService.update();
getCorrespondingNodeIdsSpy.and.throwError('Failed');
const showingSearchSpy = spyOn(component.showingSearch, 'emit');
await searchQueryBuilderService.execute(true, { query: { query: 'search' } });
@@ -488,15 +507,16 @@ describe('ContentNodeSelectorPanelComponent', () => {
});
it('should the query restrict the search to the site and not to the currentFolderId in case is changed', async () => {
spyOn(searchQueryBuilderService, 'addFilterQuery').and.callThrough();
searchQueryBuilderService.userQuery = 'search-term*';
component.currentFolderId = 'my-root-id';
component.restrictRootToCurrentFolderId = true;
component.siteChanged({ entry: { guid: 'my-site-id' } } as SiteEntry);
const expectedRequest = mockSearchRequest;
expectedRequest.filterQueries = [{ query: `ANCESTOR:'workspace://SpacesStore/my-site-id'` }];
const expectedRequest = `ANCESTOR:'workspace://SpacesStore/my-site-id'`;
expect(searchSpy).toHaveBeenCalledWith(false, expectedRequest);
expect(searchSpy).toHaveBeenCalledWith(false);
expect(searchQueryBuilderService.addFilterQuery).toHaveBeenCalledWith(expectedRequest);
});
it('should restrict the breadcrumb to the currentFolderId in case restrictedRoot is true', async () => {
@@ -563,10 +583,12 @@ describe('ContentNodeSelectorPanelComponent', () => {
expect(searchSpy.calls.count()).toBe(2);
component.clear();
typeToSearchBox('');
tick(debounceSearch);
expect(component.searchTerm).toBe('');
expect(component.folderIdToShow).toBe('namek');
flush();
}));
it('should show the current folder content instead of search results if search was not performed', async () => {
@@ -638,25 +660,23 @@ describe('ContentNodeSelectorPanelComponent', () => {
fixture.detectChanges();
const documentList = testingUtils.getByCSS('[data-automation-id="content-node-selector-document-list"]');
expect(documentList).not.toBeNull();
expect(component.hasValidQuery).toEqual(true);
expect(documentList.componentInstance.currentFolderId).toBeNull();
done();
}, 300);
});
it('should not show the result list when results are returned but there is no search term typed', (done) => {
searchQueryBuilderService.userQuery = '';
searchQueryBuilderService.update();
it('should not run a search nor show the result list when there is no search term typed', fakeAsync(() => {
spyOn(component, 'clearSearch').and.callThrough();
setTimeout(() => {
triggerSearchResults(fakeResultSetPaging);
fixture.detectChanges();
typeToSearchBox('');
tick(debounceSearch);
fixture.detectChanges();
expect(component.hasValidQuery).toEqual(false);
expect(component.showingSearchResults).toEqual(false);
done();
}, 300);
});
expect(searchSpy).not.toHaveBeenCalled();
expect(component.clearSearch).toHaveBeenCalled();
expect(component.showingSearchResults).toEqual(false);
flush();
}));
it('should highlight the results when search was performed in the next timeframe', (done) => {
typeToSearchBox('My');
@@ -673,7 +693,7 @@ describe('ContentNodeSelectorPanelComponent', () => {
}, 300);
});
it('should show the default text instead of result list if search was cleared', (done) => {
it('should reset the search term and re-run an empty query when the clear button is clicked', (done) => {
typeToSearchBox();
setTimeout(() => {
@@ -683,12 +703,13 @@ describe('ContentNodeSelectorPanelComponent', () => {
fixture.whenStable().then(() => {
const clearButton = getSearchIcon('clear');
expect(clearButton).not.toBeNull();
searchSpy.calls.reset();
clearButton.triggerEventHandler('click', {});
fixture.detectChanges();
const documentList = testingUtils.getByCSS('[data-automation-id="content-node-selector-document-list"]');
expect(documentList).not.toBeNull();
expect(documentList.componentInstance.currentFolderId).toBe('cat-girl-nuku-nuku');
expect(component.searchTerm).toBe('');
expect(searchQueryBuilderService.userQuery).toBe('');
expect(searchSpy).toHaveBeenCalledWith(false);
done();
});
}, 300);
@@ -709,20 +730,20 @@ describe('ContentNodeSelectorPanelComponent', () => {
flush();
}));
it('should set the folderIdToShow to the default "currentFolderId" if siteId is undefined', (done) => {
it('should reset the folder to the selected site and fall back to currentFolderId when site is undefined', () => {
component.siteChanged({ entry: { guid: 'Kame-Sennin Muten Roshi' } } as SiteEntry);
component.resetFolderToShow();
fixture.detectChanges();
let documentList = testingUtils.getByCSS('[data-automation-id="content-node-selector-document-list"]');
expect(documentList.componentInstance.currentFolderId).toBe('Kame-Sennin Muten Roshi');
component.siteChanged({ entry: { guid: undefined } } as SiteEntry);
component.resetFolderToShow();
fixture.detectChanges();
documentList = testingUtils.getByCSS('[data-automation-id="content-node-selector-document-list"]');
expect(documentList.componentInstance.currentFolderId).toBe('cat-girl-nuku-nuku');
done();
});
describe('Pagination "Load more" button', () => {
@@ -752,7 +773,7 @@ describe('ContentNodeSelectorPanelComponent', () => {
});
it('should set its loading state to true to perform a new search', async () => {
component.prepareDialogForNewSearch(mockSearchRequest);
component.prepareDialogForNewSearch();
fixture.detectChanges();
await fixture.whenStable();
@@ -764,13 +785,14 @@ describe('ContentNodeSelectorPanelComponent', () => {
expect(paginationLoading).not.toBeNull();
});
it('Should infinite pagination target be null when we use it for search ', fakeAsync(() => {
it('Should keep the document list as infinite pagination target while searching', fakeAsync(() => {
component.showingSearchResults = true;
typeToSearchBox('shenron');
tick(debounceSearch);
fixture.detectChanges();
expect(component.target).toBeNull();
expect(component.target).toEqual(component.documentList);
flush();
}));
it('Should infinite pagination target be present when search finish', () => {
lib/content-services/src/lib/content-node-selector/content-node-selector-panel/content-node-selector-panel.component.spec.ts
-3
View File
@@ -270,7 +270,6 @@ describe('ContentNodeSelectorPanelComponent', () => {
it('should not show the breadcrumb if search was performed as last action', async () => {
searchQueryBuilderService.userQuery = 'mock-search-term';
searchQueryBuilderService.update();
triggerSearchResults(fakeResultSetPaging);
fixture.detectChanges();
@@ -291,7 +290,6 @@ describe('ContentNodeSelectorPanelComponent', () => {
it('should show the breadcrumb in search results for a valid node selection', async () => {
searchQueryBuilderService.userQuery = 'mock-search-term';
searchQueryBuilderService.update();
triggerSearchResults(fakeResultSetPaging);
const chosenNode = new Node({ path: { elements: [{ name: 'one' }] } });
@@ -306,7 +304,6 @@ describe('ContentNodeSelectorPanelComponent', () => {
it('should show the breadcrumb in search results even for an invalid node selection', async () => {
component.isSelectionValid = (node: Node) => node.isFile;
searchQueryBuilderService.userQuery = 'mock-search-term';
searchQueryBuilderService.update();
triggerSearchResults(fakeResultSetPaging);
const chosenNode = new Node({ path: { elements: [{ name: 'fake-path' }] }, isFile: false, isFolder: true });
lib/content-services/src/lib/content-node-selector/content-node-selector-panel/content-node-selector-panel.component.ts
+20 -29
View File
@@ -33,7 +33,7 @@ import {
} from '@alfresco/adf-core';
import { FileUploadCompleteEvent, FileUploadDeleteEvent, NodesApiService, SitesService, UploadService } from '../../common';
import { ReactiveFormsModule, UntypedFormControl } from '@angular/forms';
import { Node, NodeEntry, NodePaging, Pagination, RequestScope, SearchRequest, SiteEntry, SitePaging } from '@alfresco/js-api';
import { Node, NodeEntry, NodePaging, Pagination, RequestScope, SiteEntry, SitePaging } from '@alfresco/js-api';
import { DocumentListComponent } from '../../document-list/components/document-list.component';
import { RowFilter } from '../../document-list/data/row-filter.model';
import { ImageResolver } from '../../document-list/data/image-resolver.model';
@@ -292,7 +292,6 @@ export class ContentNodeSelectorPanelComponent implements OnInit {
folderIdToShow: string | null = null;
breadcrumbFolderTitle: string | null = null;
startSiteGuid: string | null = null;
hasValidQuery: boolean = false;
showHeader = ShowHeaderMode.Never;
@ViewChild(InfinitePaginationComponent, { static: true })
@@ -334,26 +333,16 @@ export class ContentNodeSelectorPanelComponent implements OnInit {
.pipe(debounceTime(this.debounceSearch), takeUntilDestroyed(this.destroyRef))
.subscribe((searchValue: string) => {
this.searchTerm = searchValue;
this.queryBuilderService.userQuery = searchValue.length > 0 ? `${searchValue}*` : searchValue;
this.queryBuilderService.update();
if (this.searchTerm) {
this.executeSearch(searchValue);
} else {
this.resetFolderToShow();
this.clearSearch();
}
});
this.queryBuilderService.updated.pipe(takeUntilDestroyed(this.destroyRef)).subscribe((searchRequest) => {
if (searchRequest) {
this.hasValidQuery = true;
this.prepareDialogForNewSearch(searchRequest);
this.queryBuilderService.execute(false, searchRequest);
} else {
this.hasValidQuery = false;
this.resetFolderToShow();
this.clearSearch();
}
});
this.queryBuilderService.executed.pipe(takeUntilDestroyed(this.destroyRef)).subscribe((results: NodePaging) => {
if (this.hasValidQuery) {
this.showSearchResults(results);
}
this.showSearchResults(results);
});
this.userPreferencesService
@@ -451,7 +440,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit {
this.siteId = chosenSite.entry.guid;
this.setTitleIfCustomSite(chosenSite);
this.siteChange.emit(chosenSite.entry.title);
this.queryBuilderService.update();
this.executeSearch(this.searchTerm);
}
/**
@@ -473,14 +462,8 @@ export class ContentNodeSelectorPanelComponent implements OnInit {
/**
* Prepares the dialog for a new search
*
* @param searchRequest request options
*/
prepareDialogForNewSearch(searchRequest: SearchRequest): void {
this.target = searchRequest ? null : this.documentList;
if (this.target) {
this.infinitePaginationComponent.reset();
}
prepareDialogForNewSearch(): void {
this.folderIdToShow = null;
this.preselectedNodes = [];
this.loadingSearchResults = true;
@@ -494,7 +477,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit {
clear(): void {
this.searchTerm = '';
this.queryBuilderService.userQuery = '';
this.queryBuilderService.update();
this.executeSearch(this.searchTerm);
}
/**
@@ -619,7 +602,7 @@ export class ContentNodeSelectorPanelComponent implements OnInit {
this.queryBuilderService.paging.skipCount = pagination.skipCount;
if (this.searchTerm.length > 0) {
this.queryBuilderService.update();
this.executeSearch(this.searchTerm);
}
}
@@ -696,4 +679,12 @@ export class ContentNodeSelectorPanelComponent implements OnInit {
skipCount: this.DEFAULT_PAGINATION.skipCount
};
}
private executeSearch(searchValue: string): void {
this.prepareDialogForNewSearch();
this.queryBuilderService.searchMode = 'formula';
const wildcardSuffix = this.queryBuilderService.wildcardsEnabled ? '*' : '';
this.queryBuilderService.userQuery = searchValue.length > 0 ? `(${searchValue}${wildcardSuffix})` : searchValue;
this.queryBuilderService.execute(false);
}
}
lib/content-services/src/lib/document-list/components/filter-header/filter-header.component.spec.ts
+35 -3
View File
@@ -23,6 +23,8 @@ import { SimpleChange } from '@angular/core';
import { SearchHeaderQueryBuilderService } from './../../../search/services/search-header-query-builder.service';
import { FilterHeaderComponent } from './filter-header.component';
import { provideRouter } from '@angular/router';
import { SearchCategory } from '@alfresco/adf-content-services';
import { NodePaging } from '@alfresco/js-api';
describe('FilterHeaderComponent', () => {
let fixture: ComponentFixture<FilterHeaderComponent>;
@@ -150,7 +152,7 @@ describe('FilterHeaderComponent', () => {
fixture.detectChanges();
await fixture.whenStable();
expect(Object.keys(queryBuilder.filterRawParams).length).toBe(0);
expect(queryBuilder.filterRawParams['name']).toBeUndefined();
component.value = { name: 'pinocchio' };
const currentFolderNodeIdChange = new SimpleChange('current-node-id', 'next-node-id', true);
@@ -158,11 +160,41 @@ describe('FilterHeaderComponent', () => {
fixture.detectChanges();
await fixture.whenStable();
expect(Object.keys(queryBuilder.filterRawParams).length).toBe(1);
expect(queryBuilder.filterRawParams['name']).toBe('pinocchio');
expect(queryBuilder.queryFragments['name']).toBe('pinocchio');
});
it('should build a wildcard field query fragment for the queryName filter when wildcards are enabled', async () => {
spyOn(queryBuilder, 'setCurrentRootFolderId');
spyOn(queryBuilder, 'isCustomSourceNode').and.returnValue(false);
spyOnProperty(queryBuilder, 'wildcardsEnabled', 'get').and.returnValue(true);
queryBuilder.categories = [{ id: 'queryName', component: { settings: { field: 'cm:name' } } } as SearchCategory];
component.value = { queryName: 'pinocchio' };
const currentFolderNodeIdChange = new SimpleChange('current-node-id', 'next-node-id', true);
component.ngOnChanges({ currentFolderId: currentFolderNodeIdChange });
fixture.detectChanges();
await fixture.whenStable();
expect(queryBuilder.filterRawParams['queryName']).toBe('pinocchio');
expect(queryBuilder.queryFragments['queryName']).toBe(`cm:name:'*pinocchio*'`);
});
it('should build a non-wildcard field query fragment for the queryName filter when wildcards are disabled', async () => {
spyOn(queryBuilder, 'setCurrentRootFolderId');
spyOn(queryBuilder, 'isCustomSourceNode').and.returnValue(false);
spyOnProperty(queryBuilder, 'wildcardsEnabled', 'get').and.returnValue(false);
queryBuilder.categories = [{ id: 'queryName', component: { settings: { field: 'cm:name' } } } as SearchCategory];
component.value = { queryName: 'pinocchio' };
const currentFolderNodeIdChange = new SimpleChange('current-node-id', 'next-node-id', true);
component.ngOnChanges({ currentFolderId: currentFolderNodeIdChange });
fixture.detectChanges();
await fixture.whenStable();
expect(queryBuilder.queryFragments['queryName']).toBe(`cm:name:'pinocchio'`);
});
it('should emit filterSelection when a filter is changed', (done) => {
spyOn(queryBuilder, 'getActiveFilters').and.returnValue([{ key: 'name', value: 'pinocchio' }]);
@@ -193,7 +225,7 @@ describe('FilterHeaderComponent', () => {
it('should emit searchResultsReady when search query builder executes', (done) => {
fixture.detectChanges(); // Initialize component (triggers ngOnInit)
const mockNodePaging: any = { list: { entries: [] } };
const mockNodePaging: NodePaging = { list: { entries: [] } };
component.searchResultsReady.subscribe((nodePaging) => {
expect(nodePaging).toBe(mockNodePaging);
lib/content-services/src/lib/document-list/components/filter-header/filter-header.component.ts
+10 -3
View File
@@ -115,9 +115,16 @@ export class FilterHeaderComponent implements OnInit, OnChanges {
const operator = this.searchFilterQueryBuilder.getOperatorForFilterId(key) || 'OR';
this.searchFilterQueryBuilder.filterRawParams[key] = this.value[key];
this.searchFilterQueryBuilder.queryFragments[key] = Array.isArray(this.value[key])
? this.value[key].join(` ${operator} `)
: this.value[key];
if (key === 'queryName') {
const filterConfig = this.searchFilterQueryBuilder.categories.find((category) => category.id === key);
const wildcardSuffix = this.searchFilterQueryBuilder.wildcardsEnabled ? '*' : '';
this.searchFilterQueryBuilder.queryFragments[key] =
`${filterConfig.component.settings.field}:'${wildcardSuffix}${this.value[key]}${wildcardSuffix}'`;
} else {
this.searchFilterQueryBuilder.queryFragments[key] = Array.isArray(this.value[key])
? this.value[key].join(` ${operator} `)
: this.value[key];
}
});
}
this.searchFilterQueryBuilder.setCurrentRootFolderId(currentFolderId);
lib/content-services/src/lib/search/components/search-check-list/search-check-list.component.spec.ts
+3 -3
View File
@@ -44,7 +44,7 @@ describe('SearchCheckListComponent', () => {
queryFragments: {},
filterRawParams: {},
populateFilters: new ReplaySubject(1),
update: jasmine.createSpy()
execute: jasmine.createSpy('execute')
} as any;
});
@@ -134,7 +134,7 @@ describe('SearchCheckListComponent', () => {
component.reset();
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
expect(component.context.queryFragments[component.id]).toBe('');
expect(component.context.filterRawParams[component.id]).toBeUndefined();
});
@@ -226,7 +226,7 @@ describe('SearchCheckListComponent', () => {
fixture.detectChanges();
expect(component.context.queryFragments[component.id]).toBe('');
expect(component.context.update).not.toHaveBeenCalled();
expect(component.context.execute).not.toHaveBeenCalled();
});
it('should populate filter state when populate filters event has been observed', () => {
lib/content-services/src/lib/search/components/search-check-list/search-check-list.component.ts
+3 -3
View File
@@ -107,7 +107,7 @@ export class SearchCheckListComponent implements SearchWidget, OnInit {
this.clearOptions();
if (this.id && this.context && this.enableChangeUpdate) {
this.updateDisplayValue();
this.context.update();
this.context.execute();
}
}
@@ -128,7 +128,7 @@ export class SearchCheckListComponent implements SearchWidget, OnInit {
if (this.id && this.context) {
this.updateDisplayValue();
if (updateContext) {
this.context.update();
this.context.execute();
}
}
}
@@ -178,7 +178,7 @@ export class SearchCheckListComponent implements SearchWidget, OnInit {
this.context.queryFragments[this.id] = query;
this.updateDisplayValue();
if (updateContext) {
this.context.update();
this.context.execute();
}
}
}
lib/content-services/src/lib/search/components/search-chip-autocomplete-input/search-chip-autocomplete-input.component.spec.ts
+7
View File
@@ -309,6 +309,13 @@ describe('SearchChipAutocompleteInputComponent', () => {
expect(inputChangedSpy).toHaveBeenCalledOnceWith('test-value');
});
it('should not emit input value when input is empty', async () => {
const inputChangedSpy = spyOn(component.inputChanged, 'emit');
enterNewInputValue('');
await fixture.whenStable();
expect(inputChangedSpy).not.toHaveBeenCalled();
});
describe('isOptionSelected', () => {
beforeEach(() => {
component.autocompleteOptions = [{ value: 'option1' }, { value: 'option2' }];
lib/content-services/src/lib/search/components/search-chip-autocomplete-input/search-chip-autocomplete-input.component.ts
+4 -2
View File
@@ -108,8 +108,10 @@ export class SearchChipAutocompleteInputComponent implements OnInit, OnChanges {
takeUntilDestroyed(this.destroyRef)
)
.subscribe((value: string) => {
this.filteredOptions = this.filter(this.autocompleteOptions, value);
this.inputChanged.emit(value);
if (value) {
this.filteredOptions = this.filter(this.autocompleteOptions, value);
this.inputChanged.emit(value);
}
});
this.onReset$?.pipe(takeUntilDestroyed(this.destroyRef)).subscribe(() => this.reset());
this.selectedOptions = this.preselectedOptions ?? [];
lib/content-services/src/lib/search/components/search-date-range-tabbed/search-date-range-tabbed.component.spec.ts
+4 -4
View File
@@ -79,7 +79,7 @@ describe('SearchDateRangeTabbedComponent', () => {
},
filterRawParams: {},
populateFilters: new ReplaySubject(1),
update: jasmine.createSpy('update')
execute: jasmine.createSpy('execute')
} as any;
component.settings = {
hideDefaultAction: false,
@@ -210,7 +210,7 @@ describe('SearchDateRangeTabbedComponent', () => {
expect(component.context.filterRawParams[component.id].modifiedDate).toEqual(anyMockDate);
});
it('should trigger context.update() when values are submitted', () => {
it('should trigger context.execute() when values are submitted', () => {
component.onDateRangedValueChanged(betweenMockData, 'createdDate');
component.onDateRangedValueChanged(inLastMockData, 'modifiedDate');
fixture.detectChanges();
@@ -221,7 +221,7 @@ describe('SearchDateRangeTabbedComponent', () => {
`createdDate:['${formatISO(startOfDay(betweenMockData.betweenStartDate))}' TO '${formatISO(endOfDay(betweenMockData.betweenEndDate))}']` +
` AND modifiedDate:['${formatISO(startOfDay(inLastStartDate))}' TO '${formatISO(endOfToday())}']`;
expect(component.context.queryFragments['dateRange']).toEqual(query);
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
it('should clear values and search filter when widget is reset', (done) => {
@@ -231,7 +231,7 @@ describe('SearchDateRangeTabbedComponent', () => {
expect(component.combinedDisplayValue).toBe('');
expect(component.displayValue$.next).toHaveBeenCalledWith('');
expect(component.context.queryFragments['dateRange']).toEqual('');
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
component.fields.forEach((field) => expect(component.context.filterRawParams[field]).toBeUndefined());
done();
});
lib/content-services/src/lib/search/components/search-date-range-tabbed/search-date-range-tabbed.component.ts
+1 -1
View File
@@ -138,7 +138,7 @@ export class SearchDateRangeTabbedComponent implements SearchWidget, OnInit {
this.context.queryFragments[this.id] = this.combinedQuery;
this.displayValue$.next(this.combinedDisplayValue);
if (this.id && this.context && updateContext) {
this.context.update();
this.context.execute();
}
}
onDateRangedValueChanged(value: Partial<SearchDateRange>, field: string) {
lib/content-services/src/lib/search/components/search-datetime-range/search-datetime-range.component.spec.ts
+4 -4
View File
@@ -46,7 +46,7 @@ describe('SearchDatetimeRangeComponent', () => {
},
filterRawParams: {},
populateFilters: new ReplaySubject(1),
update: jasmine.createSpy('update')
execute: jasmine.createSpy('execute')
} as any;
component.settings = { field: 'cm:created' };
});
@@ -128,7 +128,7 @@ describe('SearchDatetimeRangeComponent', () => {
component.reset();
expect(component.context.queryFragments.createdDatetimeRange).toEqual('');
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
it('should update the query in UTC format when values change', async () => {
@@ -150,7 +150,7 @@ describe('SearchDatetimeRangeComponent', () => {
expect(component.context.queryFragments[component.id]).toEqual(expectedQuery);
expect(component.context.filterRawParams[component.id]).toEqual({ start: expectedFromDate, end: expectedToDate });
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
it('should be able to update the query in UTC format from a GMT format', async () => {
@@ -175,7 +175,7 @@ describe('SearchDatetimeRangeComponent', () => {
expect(startDate).toContain('2021-02-24');
expect(endDate).toContain('2021-02-28');
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
// Verify the query structure is correct without hardcoding exact timezone values
const query = component.context.queryFragments[component.id];
lib/content-services/src/lib/search/components/search-datetime-range/search-datetime-range.component.ts
+2 -2
View File
@@ -171,7 +171,7 @@ export class SearchDatetimeRangeComponent implements SearchWidget, OnInit {
filterParam.end = end;
this.updateDisplayValue();
if (updateContext) {
this.context.update();
this.context.execute();
}
}
}
@@ -242,7 +242,7 @@ export class SearchDatetimeRangeComponent implements SearchWidget, OnInit {
private updateQuery() {
if (this.id && this.context) {
this.updateDisplayValue();
this.context.update();
this.context.execute();
}
}
lib/content-services/src/lib/search/components/search-facet-field/search-facet-field.component.spec.ts
+10 -10
View File
@@ -44,7 +44,7 @@ describe('SearchFacetFieldComponent', () => {
});
it('should update bucket model and query builder on facet toggle', () => {
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
spyOn(queryBuilder, 'addUserFacetBucket').and.callThrough();
const event: any = { checked: true };
@@ -57,12 +57,12 @@ describe('SearchFacetFieldComponent', () => {
expect(bucket.checked).toBeTruthy();
expect(queryBuilder.addUserFacetBucket).toHaveBeenCalledWith(facetField.field, bucket);
expect(queryBuilder.update).toHaveBeenCalled();
expect(queryBuilder.execute).toHaveBeenCalled();
expect(searchFacetFiltersService.updateSelectedBuckets).toHaveBeenCalled();
});
it('should update bucket model and query builder on facet un-toggle', () => {
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
spyOn(queryBuilder, 'removeUserFacetBucket').and.callThrough();
const event: any = { checked: false };
@@ -75,12 +75,12 @@ describe('SearchFacetFieldComponent', () => {
component.onToggleBucket(event, facetField, bucket);
expect(queryBuilder.removeUserFacetBucket).toHaveBeenCalledWith(facetField.field, bucket);
expect(queryBuilder.update).toHaveBeenCalled();
expect(queryBuilder.execute).toHaveBeenCalled();
expect(searchFacetFiltersService.updateSelectedBuckets).toHaveBeenCalled();
});
it('should unselect facet query and update builder', () => {
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
spyOn(queryBuilder, 'removeUserFacetBucket').and.callThrough();
const event: any = { checked: false };
@@ -94,17 +94,17 @@ describe('SearchFacetFieldComponent', () => {
expect(query.checked).toEqual(false);
expect(queryBuilder.removeUserFacetBucket).toHaveBeenCalledWith(facetField.field, query);
expect(queryBuilder.update).toHaveBeenCalled();
expect(queryBuilder.execute).toHaveBeenCalled();
expect(searchFacetFiltersService.updateSelectedBuckets).toHaveBeenCalled();
});
it('should update query builder only when has bucket to unselect', () => {
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
const field: FacetField = { field: 'f1', label: 'f1' };
component.onToggleBucket({ checked: true } as any, field, null);
expect(queryBuilder.update).not.toHaveBeenCalled();
expect(queryBuilder.execute).not.toHaveBeenCalled();
});
it('should allow to to reset selected buckets', () => {
@@ -166,7 +166,7 @@ describe('SearchFacetFieldComponent', () => {
});
it('should update query builder upon resetting buckets', () => {
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
const buckets: FacetFieldBucket[] = [
{ label: 'bucket1', checked: false, count: 1, filterQuery: 'q1' },
@@ -183,6 +183,6 @@ describe('SearchFacetFieldComponent', () => {
fixture.detectChanges();
component.resetSelectedBuckets(field);
expect(queryBuilder.update).toHaveBeenCalled();
expect(queryBuilder.execute).toHaveBeenCalled();
});
});
lib/content-services/src/lib/search/components/search-facet-field/search-facet-field.component.ts
+5 -5
View File
@@ -69,7 +69,7 @@ export class SearchFacetFieldComponent implements FacetWidget {
this.searchFacetFiltersService.updateSelectedBuckets();
if (this.canUpdateOnChange) {
this.updateDisplayValue();
this.queryBuilder.update();
this.queryBuilder.execute();
}
}
}
@@ -81,7 +81,7 @@ export class SearchFacetFieldComponent implements FacetWidget {
this.searchFacetFiltersService.updateSelectedBuckets();
if (this.canUpdateOnChange) {
this.updateDisplayValue();
this.queryBuilder.update();
this.queryBuilder.execute();
}
}
}
@@ -101,7 +101,7 @@ export class SearchFacetFieldComponent implements FacetWidget {
}
this.searchFacetFiltersService.updateSelectedBuckets();
if (this.canUpdateOnChange) {
this.queryBuilder.update();
this.queryBuilder.execute();
}
}
}
@@ -125,11 +125,11 @@ export class SearchFacetFieldComponent implements FacetWidget {
reset(): void {
this.resetSelectedBuckets(this.field);
this.updateDisplayValue();
this.queryBuilder.update();
this.queryBuilder.execute();
}
submitValues(): void {
this.updateDisplayValue();
this.queryBuilder.update();
this.queryBuilder.execute();
}
}
lib/content-services/src/lib/search/components/search-filter-autocomplete-chips/search-filter-autocomplete-chips.component.spec.ts
+3 -3
View File
@@ -47,7 +47,7 @@ describe('SearchFilterAutocompleteChipsComponent', () => {
},
filterRawParams: {},
populateFilters: new ReplaySubject(1),
update: jasmine.createSpy('update')
execute: jasmine.createSpy('execute')
} as any;
component.settings = {
field: 'test',
@@ -102,7 +102,7 @@ describe('SearchFilterAutocompleteChipsComponent', () => {
clearBtn.click();
expect(component.context.queryFragments[component.id]).toBe('');
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
expect(component.selectedOptions).toEqual([]);
expect(component.displayValue$.next).toHaveBeenCalledWith('');
expect(component.context.filterRawParams[component.id]).toBeUndefined();
@@ -116,7 +116,7 @@ describe('SearchFilterAutocompleteChipsComponent', () => {
applyBtn.click();
fixture.detectChanges();
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
expect(component.context.queryFragments[component.id]).toBe('test:"option2" OR test:"option1"');
expect(component.context.filterRawParams[component.id]).toEqual([{ value: 'option2' }, { value: 'option1' }]);
lib/content-services/src/lib/search/components/search-filter-autocomplete-chips/search-filter-autocomplete-chips.component.ts
+1 -2
View File
@@ -111,7 +111,6 @@ export class SearchFilterAutocompleteChipsComponent implements SearchWidget, OnI
this.selectedOptions = selectedOptions;
if (this.enableChangeUpdate) {
this.updateQuery();
this.context.update();
}
}
@@ -160,7 +159,7 @@ export class SearchFilterAutocompleteChipsComponent implements SearchWidget, OnI
}
this.context.queryFragments[this.id] = queryFragments.join(' OR ');
if (updateContext) {
this.context.update();
this.context.execute();
}
}
}
lib/content-services/src/lib/search/components/search-filter-chips/search-facet-chip-tabbed/search-facet-tabbed-content.component.spec.ts
+6 -6
View File
@@ -33,7 +33,7 @@ describe('SearchFacetTabbedContentComponent', () => {
let queryBuilder: SearchQueryBuilderService;
let searchFacetService: SearchFacetFiltersService;
let loader: HarnessLoader;
let queryBuilderUpdateSpy: jasmine.Spy;
let queryBuilderExecuteSpy: jasmine.Spy;
beforeEach(() => {
TestBed.configureTestingModule({
@@ -44,7 +44,7 @@ describe('SearchFacetTabbedContentComponent', () => {
component = fixture.componentInstance;
queryBuilder = TestBed.inject(SearchQueryBuilderService);
searchFacetService = TestBed.inject(SearchFacetFiltersService);
queryBuilderUpdateSpy = spyOn(queryBuilder, 'update').and.stub();
queryBuilderExecuteSpy = spyOn(queryBuilder, 'execute').and.stub();
const facet1: FacetField = { type: 'field', label: 'field', field: 'field', buckets: new SearchFilterList() };
const facet2: FacetField = { type: 'field', label: 'field2', field: 'field2', buckets: new SearchFilterList() };
@@ -185,7 +185,7 @@ describe('SearchFacetTabbedContentComponent', () => {
spyOn(searchFacetService, 'updateSelectedBuckets').and.callThrough();
component.submitValues();
expect(component.submitValues).toHaveBeenCalled();
expect(queryBuilderUpdateSpy).toHaveBeenCalled();
expect(queryBuilderExecuteSpy).toHaveBeenCalled();
expect(component.updateDisplayValue).toHaveBeenCalled();
expect(searchFacetService.updateSelectedBuckets).toHaveBeenCalled();
});
@@ -193,12 +193,12 @@ describe('SearchFacetTabbedContentComponent', () => {
it('should update search query and display value on reset', () => {
spyOn(component, 'updateDisplayValue').and.callThrough();
component.reset();
expect(queryBuilderUpdateSpy).toHaveBeenCalled();
expect(queryBuilderExecuteSpy).toHaveBeenCalled();
expect(component.updateDisplayValue).toHaveBeenCalled();
});
it('should not call queryBuilder.update on options change', () => {
it('should not call queryBuilder.execute on options change', () => {
component.onOptionsChange([{ value: 'test' }], 'field');
expect(queryBuilderUpdateSpy).not.toHaveBeenCalled();
expect(queryBuilderExecuteSpy).not.toHaveBeenCalled();
});
});
lib/content-services/src/lib/search/components/search-filter-chips/search-facet-chip-tabbed/search-facet-tabbed-content.component.ts
+2 -2
View File
@@ -111,14 +111,14 @@ export class SearchFacetTabbedContentComponent implements OnInit, OnChanges, Fac
this.resetSubject$.next();
this.updateUserFacetBuckets();
this.updateDisplayValue();
this.queryBuilder.update();
this.queryBuilder.execute();
}
submitValues() {
this.updateUserFacetBuckets();
this.searchFacetFiltersService.updateSelectedBuckets();
this.updateDisplayValue();
this.queryBuilder.update();
this.queryBuilder.execute();
}
optionComparator(option1: AutocompleteOption, option2: AutocompleteOption): boolean {
lib/content-services/src/lib/search/components/search-filter-chips/search-facet-chip/search-facet-chip.component.spec.ts
+3 -3
View File
@@ -41,7 +41,7 @@ describe('SearchFacetChipComponent', () => {
fixture = TestBed.createComponent(SearchFacetChipComponent);
component = fixture.componentInstance;
queryBuilder = TestBed.inject(SearchQueryBuilderService);
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
component.field = { type: 'field', label: 'f2', field: 'f2', buckets: new SearchFilterList() };
fixture.detectChanges();
@@ -55,7 +55,7 @@ describe('SearchFacetChipComponent', () => {
const applyButton = await menu.getHarness(MatButtonHarness.with({ selector: '#apply-filter-button' }));
await applyButton.click();
expect(queryBuilder.update).toHaveBeenCalled();
expect(queryBuilder.execute).toHaveBeenCalled();
});
it('should update search query on cancel click', async () => {
@@ -65,7 +65,7 @@ describe('SearchFacetChipComponent', () => {
const cancelButton = await menu.getHarness(MatButtonHarness.with({ selector: '#cancel-filter-button' }));
await cancelButton.click();
expect(queryBuilder.update).toHaveBeenCalled();
expect(queryBuilder.execute).toHaveBeenCalled();
});
it('should display arrow down icon and not disable the chip when items are loaded', async () => {
lib/content-services/src/lib/search/components/search-filter-chips/search-filter-chips.component.spec.ts
+6 -6
View File
@@ -223,7 +223,7 @@ describe('SearchFilterChipsComponent', () => {
});
it('should update query builder upon resetting selected queries', async () => {
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
spyOn(queryBuilder, 'removeUserFacetBucket').and.callThrough();
const queryResponse = {
@@ -247,7 +247,7 @@ describe('SearchFilterChipsComponent', () => {
facetField.resetSelectedBuckets(queryResponse);
expect(queryBuilder.removeUserFacetBucket).toHaveBeenCalledTimes(3);
expect(queryBuilder.update).toHaveBeenCalled();
expect(queryBuilder.execute).toHaveBeenCalled();
for (const entry of searchFacetFiltersService.responseFacets[0].buckets.items) {
expect(entry.checked).toEqual(false);
@@ -276,7 +276,7 @@ describe('SearchFilterChipsComponent', () => {
});
it('should be update the search query when name changed', async () => {
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
appConfigService.config.search = searchFilter;
queryBuilder.resetToDefaults();
@@ -290,7 +290,7 @@ describe('SearchFilterChipsComponent', () => {
const inputElement = fixture.debugElement.query(By.css('[data-automation-id="search-field-Name"] input'));
inputElement.triggerEventHandler('change', { target: { value: '*' } });
expect(queryBuilder.update).toHaveBeenCalled();
expect(queryBuilder.execute).toHaveBeenCalled();
queryBuilder.executed.next(mockSearchResult);
@@ -404,7 +404,7 @@ describe('SearchFilterChipsComponent', () => {
queryBuilder.executed.next(mockSearchResult);
fixture.detectChanges();
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
const searchChip = fixture.debugElement.query(By.css(`[data-automation-id="search-filter-chip-Size facet queries"]`));
searchChip.triggerEventHandler('click', { stopPropagation: () => null });
@@ -441,7 +441,7 @@ describe('SearchFilterChipsComponent', () => {
await filteredMenu[0].check();
expect(await filteredMenu[0].getLabelText()).toEqual('Extra Small (10239)');
expect(queryBuilder.update).toHaveBeenCalledTimes(1);
expect(queryBuilder.execute).toHaveBeenCalledTimes(1);
});
});
});
lib/content-services/src/lib/search/components/search-filter-chips/search-widget-chip/search-widget-chip.component.spec.ts
+3 -3
View File
@@ -45,7 +45,7 @@ describe('SearchWidgetChipComponent', () => {
queryBuilder = TestBed.inject(SearchQueryBuilderService);
fixture = TestBed.createComponent(SearchWidgetChipComponent);
component = fixture.componentInstance;
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
component.category = simpleCategories[1];
fixture.detectChanges();
@@ -60,7 +60,7 @@ describe('SearchWidgetChipComponent', () => {
const applyButton = fixture.debugElement.query(By.css('#apply-filter-button'));
applyButton.triggerEventHandler('click', {});
expect(queryBuilder.update).toHaveBeenCalled();
expect(queryBuilder.execute).toHaveBeenCalled();
});
it('should update search query on cancel click', async () => {
@@ -69,7 +69,7 @@ describe('SearchWidgetChipComponent', () => {
const applyButton = fixture.debugElement.query(By.css('#cancel-filter-button'));
applyButton.triggerEventHandler('click', {});
expect(queryBuilder.update).toHaveBeenCalled();
expect(queryBuilder.execute).toHaveBeenCalled();
});
it('should display arrow down icon', async () => {
lib/content-services/src/lib/search/components/search-filter/search-filter.component.spec.ts
+8 -8
View File
@@ -240,7 +240,7 @@ describe('SearchFilterComponent', () => {
});
it('should update query builder upon resetting selected queries', () => {
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
spyOn(queryBuilder, 'removeUserFacetBucket').and.callThrough();
const queryResponse = {
@@ -258,7 +258,7 @@ describe('SearchFilterComponent', () => {
facetField.resetSelectedBuckets(queryResponse);
expect(queryBuilder.removeUserFacetBucket).toHaveBeenCalledTimes(3);
expect(queryBuilder.update).toHaveBeenCalled();
expect(queryBuilder.execute).toHaveBeenCalled();
for (const entry of searchFacetFiltersService.responseFacets[0].buckets.items) {
expect(entry.checked).toEqual(false);
@@ -320,7 +320,7 @@ describe('SearchFilterComponent', () => {
});
it('should be update the search query when name changed', async () => {
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
appConfigService.config.search = searchFilter;
queryBuilder.resetToDefaults();
@@ -333,7 +333,7 @@ describe('SearchFilterComponent', () => {
const inputElement = fixture.debugElement.query(By.css('[data-automation-id="expansion-panel-Name"] input'));
inputElement.triggerEventHandler('change', { target: { value: '*' } });
expect(queryBuilder.update).toHaveBeenCalled();
expect(queryBuilder.execute).toHaveBeenCalled();
queryBuilder.executed.next(mockSearchResult);
fixture.detectChanges();
@@ -441,7 +441,7 @@ describe('SearchFilterComponent', () => {
queryBuilder.executed.next(mockSearchResult);
fixture.detectChanges();
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
const panel = await loader.getHarness(
MatExpansionPanelHarness.with({
@@ -470,7 +470,7 @@ describe('SearchFilterComponent', () => {
expect(labels).toEqual(stepOne);
await checkboxes[0].check();
expect(queryBuilder.update).toHaveBeenCalledTimes(1);
expect(queryBuilder.execute).toHaveBeenCalledTimes(1);
});
it('should preserve the filter state if other fields edited', async () => {
@@ -481,7 +481,7 @@ describe('SearchFilterComponent', () => {
fixture.detectChanges();
queryBuilder.executed.next(mockSearchResult);
fixture.detectChanges();
spyOn(queryBuilder, 'update').and.stub();
spyOn(queryBuilder, 'execute').and.stub();
const inputElement = fixture.debugElement.query(By.css(`${panel1Selector} input`));
inputElement.nativeElement.value = 'my';
@@ -511,7 +511,7 @@ describe('SearchFilterComponent', () => {
const checkedOption = await panel1.getHarness(MatCheckboxHarness.with({ checked: true }));
expect(await checkedOption.getLabelText()).toBe('my1 (806)');
expect(queryBuilder.update).toHaveBeenCalledTimes(2);
expect(queryBuilder.execute).toHaveBeenCalledTimes(2);
});
it('should reset the query fragments when reset All is clicked', () => {
lib/content-services/src/lib/search/components/search-logical-filter/search-logical-filter.component.spec.ts
+7 -7
View File
@@ -38,7 +38,7 @@ describe('SearchLogicalFilterComponent', () => {
},
filterRawParams: {},
populateFilters: new ReplaySubject(1),
update: jasmine.createSpy('update')
execute: jasmine.createSpy('execute')
} as any;
component.settings = { field: 'field1,field2', allowUpdateOnChange: true, hideDefaultAction: false };
fixture.detectChanges();
@@ -136,7 +136,7 @@ describe('SearchLogicalFilterComponent', () => {
spyOn(component.displayValue$, 'next');
component.reset();
expect(component.context.queryFragments[component.id]).toBe('');
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
expect(component.getCurrentValue()).toEqual({ matchAll: '', matchAny: '', exclude: '', matchExact: '' });
expect(component.displayValue$.next).toHaveBeenCalledWith('');
expect(component.context.filterRawParams[component.id]).toEqual(component.getCurrentValue());
@@ -145,7 +145,7 @@ describe('SearchLogicalFilterComponent', () => {
it('should form correct query from match all field', () => {
enterNewPhrase(' test1 test2 ', 0);
component.submitValues();
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
expect(component.context.queryFragments[component.id]).toBe('((field1:"test1" AND field1:"test2") OR (field2:"test1" AND field2:"test2"))');
expect(component.context.filterRawParams[component.id]).toEqual(component.getCurrentValue());
});
@@ -153,7 +153,7 @@ describe('SearchLogicalFilterComponent', () => {
it('should form correct query from match any field', () => {
enterNewPhrase(' test3 test4', 1);
component.submitValues();
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
expect(component.context.queryFragments[component.id]).toBe('((field1:"test3" OR field1:"test4") OR (field2:"test3" OR field2:"test4"))');
expect(component.context.filterRawParams[component.id]).toEqual(component.getCurrentValue());
});
@@ -161,7 +161,7 @@ describe('SearchLogicalFilterComponent', () => {
it('should form correct query from exclude field', () => {
enterNewPhrase('test5 test6 ', 2);
component.submitValues();
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
expect(component.context.queryFragments[component.id]).toBe(
'((NOT field1:"test5" AND NOT field1:"test6") AND (NOT field2:"test5" AND NOT field2:"test6"))'
);
@@ -171,7 +171,7 @@ describe('SearchLogicalFilterComponent', () => {
it('should form correct query from match exact field and trim it', () => {
enterNewPhrase(' test7 test8 ', 3);
component.submitValues();
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
expect(component.context.queryFragments[component.id]).toBe('((field1:"test7 test8") OR (field2:"test7 test8"))');
expect(component.context.filterRawParams[component.id]).toEqual(component.getCurrentValue());
});
@@ -186,7 +186,7 @@ describe('SearchLogicalFilterComponent', () => {
const subQuery2 = '((field1:"test2") OR (field2:"test2"))';
const subQuery3 = '((NOT field1:"test3") AND (NOT field2:"test3"))';
const subQuery4 = '((field1:"test4") OR (field2:"test4"))';
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
expect(component.context.queryFragments[component.id]).toBe(`${subQuery1} AND ${subQuery2} AND ${subQuery4} AND ${subQuery3}`);
expect(component.context.filterRawParams[component.id]).toEqual(component.getCurrentValue());
});
lib/content-services/src/lib/search/components/search-logical-filter/search-logical-filter.component.ts
+2 -2
View File
@@ -128,7 +128,7 @@ export class SearchLogicalFilterComponent implements SearchWidget, OnInit {
});
this.context.queryFragments[this.id] = query;
if (updateContext) {
this.context.update();
this.context.execute();
}
} else {
this.reset(updateContext);
@@ -154,7 +154,7 @@ export class SearchLogicalFilterComponent implements SearchWidget, OnInit {
this.clearSearchInputs();
this.context.filterRawParams[this.id] = this.searchCondition;
if (updateContext) {
this.context.update();
this.context.execute();
}
}
}
lib/content-services/src/lib/search/components/search-number-range/search-number-range.component.spec.ts
+3 -3
View File
@@ -37,7 +37,7 @@ describe('SearchNumberRangeComponent', () => {
},
filterRawParams: {},
populateFilters: new ReplaySubject(1),
update: jasmine.createSpy('update')
execute: jasmine.createSpy('execute')
} as any;
});
@@ -64,7 +64,7 @@ describe('SearchNumberRangeComponent', () => {
component.reset();
expect(component.context.queryFragments.contentSize).toEqual('');
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
expect(component.context.filterRawParams[component.id]).toBeUndefined();
});
@@ -82,7 +82,7 @@ describe('SearchNumberRangeComponent', () => {
const expectedQuery = 'cm:content.size:[10 TO 20]';
expect(component.context.queryFragments[component.id]).toEqual(expectedQuery);
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
expect(component.context.filterRawParams[component.id].from).toEqual('10');
expect(component.context.filterRawParams[component.id].to).toEqual('20');
});
lib/content-services/src/lib/search/components/search-number-range/search-number-range.component.ts
+3 -3
View File
@@ -123,7 +123,7 @@ export class SearchNumberRangeComponent implements SearchWidget, OnInit {
filterParam.from = model.from;
filterParam.to = model.to;
if (updateContext) {
this.context.update();
this.context.execute();
}
}
}
@@ -178,7 +178,7 @@ export class SearchNumberRangeComponent implements SearchWidget, OnInit {
this.context.filterRawParams[this.id] = undefined;
this.updateDisplayValue();
if (this.enableChangeUpdate && updateContext) {
this.context.update();
this.context.execute();
}
}
}
@@ -186,7 +186,7 @@ export class SearchNumberRangeComponent implements SearchWidget, OnInit {
reset(updateContext = true) {
this.clear();
if (this.id && this.context && updateContext) {
this.context.update();
this.context.execute();
}
}
}
lib/content-services/src/lib/search/components/search-properties/search-properties.component.spec.ts
+11 -11
View File
@@ -72,7 +72,7 @@ describe('SearchPropertiesComponent', () => {
},
filterRawParams: {},
populateFilters: new ReplaySubject(1),
update: jasmine.createSpy('update')
execute: jasmine.createSpy('execute')
} as any;
});
@@ -208,7 +208,7 @@ describe('SearchPropertiesComponent', () => {
component.submitValues();
expect(component.displayValue$.next).not.toHaveBeenCalled();
expect(component.context.update).not.toHaveBeenCalled();
expect(component.context.execute).not.toHaveBeenCalled();
});
it('should not search when context is not set', () => {
@@ -227,7 +227,7 @@ describe('SearchPropertiesComponent', () => {
fileExtensions: undefined,
fileSizeCondition: { fileSize: null, fileSizeOperator: FileSizeOperator.AT_LEAST, fileSizeUnit: FileSizeUnit.KB }
});
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
it('should search by at least KB by default when any size is typed', () => {
@@ -246,7 +246,7 @@ describe('SearchPropertiesComponent', () => {
fileSizeUnit: FileSizeUnit.KB
}
});
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
it('should search by at most MB after selecting proper options', () => {
@@ -271,7 +271,7 @@ describe('SearchPropertiesComponent', () => {
fileSizeUnit: FileSizeUnit.MB
}
});
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
it('should search by exactly GB after selecting proper options', () => {
@@ -296,7 +296,7 @@ describe('SearchPropertiesComponent', () => {
fileSizeUnit: FileSizeUnit.GB
}
});
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
it('should search by single file type', () => {
@@ -314,7 +314,7 @@ describe('SearchPropertiesComponent', () => {
fileSizeUnit: FileSizeUnit.KB
}
});
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
it('should search by multiple file types', () => {
@@ -331,7 +331,7 @@ describe('SearchPropertiesComponent', () => {
fileSizeUnit: FileSizeUnit.KB
}
});
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
it('should search by file size and type', () => {
@@ -351,7 +351,7 @@ describe('SearchPropertiesComponent', () => {
fileSizeUnit: FileSizeUnit.KB
}
});
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
});
@@ -439,7 +439,7 @@ describe('SearchPropertiesComponent', () => {
expect(component.context.queryFragments[component.id]).toBe('');
expect(component.context.filterRawParams[component.id]).toBeUndefined();
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
});
@@ -484,7 +484,7 @@ describe('SearchPropertiesComponent', () => {
fileSizeUnit: FileSizeUnit.MB
}
});
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
});
lib/content-services/src/lib/search/components/search-properties/search-properties.component.ts
+2 -2
View File
@@ -206,7 +206,7 @@ export class SearchPropertiesComponent implements OnInit, AfterViewChecked, Sear
this.context.queryFragments[this.id] = '';
this.context.filterRawParams[this.id] = undefined;
if (updateContext) {
this.context.update();
this.context.execute();
}
}
this.reset$.next();
@@ -272,7 +272,7 @@ export class SearchPropertiesComponent implements OnInit, AfterViewChecked, Sear
this.displayValue$.next(displayedValue);
this.context.queryFragments[this.id] = query;
if (updateContext) {
this.context.update();
this.context.execute();
}
}
lib/content-services/src/lib/search/components/search-radio/search-radio.component.spec.ts
+10 -1
View File
@@ -43,7 +43,7 @@ describe('SearchRadioComponent', () => {
},
filterRawParams: {},
populateFilters: new ReplaySubject(1),
update: jasmine.createSpy('update')
execute: jasmine.createSpy('execute')
} as any;
component.settings = { options: sizeOptions } as any;
});
@@ -93,6 +93,15 @@ describe('SearchRadioComponent', () => {
expect(component.context.filterRawParams[component.id]).toBe(sizeOptions[0].value);
});
it('should call context.execute when reset is called', async () => {
const group = await loader.getHarness(MatRadioGroupHarness);
await group.checkRadioButton({ selector: `[data-automation-id="search-radio-${sizeOptions[2].name}"]` });
component.reset();
expect(component.context.execute).toHaveBeenCalled();
});
it('should populate filter state when populate filters event has been observed', async () => {
component.context.filterLoaded = new ReplaySubject(1);
spyOn(component.context.filterLoaded, 'next').and.stub();
lib/content-services/src/lib/search/components/search-radio/search-radio.component.ts
+2 -3
View File
@@ -114,7 +114,7 @@ export class SearchRadioComponent implements SearchWidget, OnInit {
this.setValue(this.value);
this.updateDisplayValue();
if (updateContext) {
this.context.update();
this.context.execute();
}
}
@@ -129,7 +129,6 @@ export class SearchRadioComponent implements SearchWidget, OnInit {
this.context.filterRawParams[this.id] = newValue;
if (this.enableChangeUpdate) {
this.updateDisplayValue();
this.context.update();
}
}
@@ -164,7 +163,7 @@ export class SearchRadioComponent implements SearchWidget, OnInit {
this.setValue(initialValue);
this.updateDisplayValue();
if (updateContext) {
this.context.update();
this.context.execute();
}
}
}
lib/content-services/src/lib/search/components/search-slider/search-slider.component.spec.ts
+4 -4
View File
@@ -36,7 +36,7 @@ describe('SearchSliderComponent', () => {
},
filterRawParams: {},
populateFilters: new ReplaySubject(1),
update: jasmine.createSpy('update')
execute: jasmine.createSpy('execute')
} as any;
component.settings = {
field: 'field1',
@@ -64,7 +64,7 @@ describe('SearchSliderComponent', () => {
component.onChangedHandler();
expect(component.context.queryFragments[component.id]).toEqual('cm:content.size:[0 TO 10]');
expect(component.context.filterRawParams[component.id]).toEqual(10);
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
component.value = 20;
component.onChangedHandler();
@@ -81,7 +81,7 @@ describe('SearchSliderComponent', () => {
expect(component.value).toBe(10);
expect(component.context.queryFragments[component.id]).toBe('');
expect(component.context.filterRawParams[component.id]).toBe(null);
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
it('should reset to 0 if min not provided', () => {
@@ -93,7 +93,7 @@ describe('SearchSliderComponent', () => {
expect(component.value).toBe(0);
expect(component.context.queryFragments['slider']).toBe('');
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
it('should populate filter state when populate filters event has been observed', async () => {
lib/content-services/src/lib/search/components/search-slider/search-slider.component.ts
+1 -1
View File
@@ -135,7 +135,7 @@ export class SearchSliderComponent implements SearchWidget, OnInit {
this.context.queryFragments[this.id] = `${this.settings.field}:[0 TO ${value}]`;
}
if (updateContext) {
this.context.update();
this.context.execute();
}
}
}
lib/content-services/src/lib/search/components/search-text/search-text.component.spec.ts
+68 -8
View File
@@ -22,11 +22,13 @@ import { TestbedHarnessEnvironment } from '@angular/cdk/testing/testbed';
import { MatInputHarness } from '@angular/material/input/testing';
import { MatButtonHarness } from '@angular/material/button/testing';
import { ReplaySubject } from 'rxjs';
import { AppConfigService } from '@alfresco/adf-core';
describe('SearchTextComponent', () => {
let loader: HarnessLoader;
let fixture: ComponentFixture<SearchTextComponent>;
let component: SearchTextComponent;
let appConfig: AppConfigService;
beforeEach(() => {
TestBed.configureTestingModule({
@@ -34,6 +36,7 @@ describe('SearchTextComponent', () => {
});
fixture = TestBed.createComponent(SearchTextComponent);
component = fixture.componentInstance;
appConfig = TestBed.inject(AppConfigService);
component.id = 'text';
component.settings = {
pattern: `cm:name:'(.*?)'`,
@@ -46,7 +49,10 @@ describe('SearchTextComponent', () => {
},
filterRawParams: {},
populateFilters: new ReplaySubject(1),
update: jasmine.createSpy('update')
execute: jasmine.createSpy('execute'),
get wildcardsEnabled(): boolean {
return appConfig.get<boolean>('search-wildcards-enabled', true);
}
} as any;
loader = TestbedHarnessEnvironment.loader(fixture);
@@ -67,7 +73,10 @@ describe('SearchTextComponent', () => {
expect(component.value).toEqual('');
});
it('should update query builder on change', () => {
it('should update query builder on change when change updates are enabled', () => {
component.settings.allowUpdateOnChange = true;
fixture.detectChanges();
component.onChangedHandler({
target: {
value: 'top-secret.doc'
@@ -77,10 +86,27 @@ describe('SearchTextComponent', () => {
expect(component.value).toBe('top-secret.doc');
expect(component.context.queryFragments[component.id]).toBe(`cm:name:'top-secret.doc'`);
expect(component.context.filterRawParams[component.id]).toBe('top-secret.doc');
expect(component.context.update).toHaveBeenCalled();
expect(component.context.execute).toHaveBeenCalled();
});
it('should reset query builder', () => {
it('should not update query builder on change when change updates are disabled', () => {
fixture.detectChanges();
component.onChangedHandler({
target: {
value: 'top-secret.doc'
}
});
expect(component.value).toBe('top-secret.doc');
expect(component.context.queryFragments[component.id]).toBe('');
expect(component.context.execute).not.toHaveBeenCalled();
});
it('should reset query builder when change updates are enabled', () => {
component.settings.allowUpdateOnChange = true;
fixture.detectChanges();
component.onChangedHandler({
target: {
value: 'top-secret.doc'
@@ -125,13 +151,21 @@ describe('SearchTextComponent', () => {
expect(component.context.filterRawParams[component.id]).toBeUndefined();
});
it('should update query with startValue on init, if provided', () => {
it('should set value from startValue on init, if provided', () => {
component.startValue = 'mock-start-value';
fixture.detectChanges();
expect(component.context.queryFragments[component.id]).toBe(`cm:name:'mock-start-value'`);
expect(component.value).toBe('mock-start-value');
expect(component.context.update).toHaveBeenCalled();
});
it('should build the query fragment from the current value when submitted', () => {
component.startValue = 'mock-start-value';
fixture.detectChanges();
component.submitValues();
expect(component.context.queryFragments[component.id]).toBe(`cm:name:'mock-start-value'`);
expect(component.context.execute).toHaveBeenCalled();
});
it('should parse value and set query context as blank, and not call query update, if no start value was provided', () => {
@@ -141,7 +175,7 @@ describe('SearchTextComponent', () => {
expect(component.context.queryFragments[component.id]).toBe('');
expect(component.value).toBe('secret.pdf');
expect(component.context.update).not.toHaveBeenCalled();
expect(component.context.execute).not.toHaveBeenCalled();
});
it('should populate filter state when populate filters event has been observed', async () => {
@@ -157,4 +191,30 @@ describe('SearchTextComponent', () => {
expect(component.context.filterRawParams[component.id]).toBe('secret.pdf');
expect(component.context.filterLoaded.next).toHaveBeenCalled();
});
it('should add the search prefix and suffix to the query fragment when wildcards are enabled', () => {
spyOn(appConfig, 'get').and.callFake((key: string, defaultValue?: any) => (key === 'search-wildcards-enabled' ? true : defaultValue));
component.settings.searchPrefix = '*';
component.settings.searchSuffix = '*';
fixture.detectChanges();
component.onChangedHandler({ target: { value: 'secret' } });
component.submitValues();
expect(component.context.wildcardsEnabled).toBeTrue();
expect(component.context.queryFragments[component.id]).toBe(`cm:name:'*secret*'`);
});
it('should NOT add the search prefix and suffix to the query fragment when wildcards are disabled', () => {
spyOn(appConfig, 'get').and.callFake((key: string, defaultValue?: any) => (key === 'search-wildcards-enabled' ? false : defaultValue));
component.settings.searchPrefix = '*';
component.settings.searchSuffix = '*';
fixture.detectChanges();
component.onChangedHandler({ target: { value: 'secret' } });
component.submitValues();
expect(component.context.wildcardsEnabled).toBeFalse();
expect(component.context.queryFragments[component.id]).toBe(`cm:name:'secret'`);
});
});
lib/content-services/src/lib/search/components/search-text/search-text.component.ts
+4 -5
View File
@@ -48,7 +48,7 @@ export class SearchTextComponent implements SearchWidget, OnInit {
context: SearchQueryBuilderService;
startValue: string;
isActive = false;
enableChangeUpdate = true;
enableChangeUpdate = false;
displayValue$ = new ReplaySubject<string>(1);
private readonly destroyRef = inject(DestroyRef);
@@ -121,7 +121,7 @@ export class SearchTextComponent implements SearchWidget, OnInit {
if (this.context?.queryFragments && this.settings?.field) {
this.context.queryFragments[this.id] = value ? `${this.settings.field}:'${this.getSearchPrefix()}${value}${this.getSearchSuffix()}'` : '';
if (updateContext) {
this.context.update();
this.context.execute();
}
}
}
@@ -141,14 +141,13 @@ export class SearchTextComponent implements SearchWidget, OnInit {
setValue(value: string) {
this.value = value;
this.displayValue$.next(this.value);
this.submitValues();
}
private getSearchPrefix(): string {
return this.settings.searchPrefix ? this.settings.searchPrefix : '';
return this.settings.searchPrefix && this.context.wildcardsEnabled ? this.settings.searchPrefix : '';
}
private getSearchSuffix(): string {
return this.settings.searchSuffix ? this.settings.searchSuffix : '';
return this.settings.searchSuffix && this.context.wildcardsEnabled ? this.settings.searchSuffix : '';
}
}
lib/content-services/src/lib/search/services/base-query-builder.service.spec.ts
+261 -90
View File
@@ -69,6 +69,12 @@ describe('BaseQueryBuilderService', () => {
{ ...mockSearchConfig, id: 'config-3', name: 'Config 3', default: false }
];
const configureAppConfig = (wildcards?: boolean): void => {
(appConfig.get as jasmine.Spy).and.callFake((key: string, defaultValue?: any) =>
key === 'search-wildcards-enabled' ? (wildcards ?? defaultValue) : false
);
};
beforeEach(() => {
TestBed.configureTestingModule({
providers: [
@@ -89,19 +95,218 @@ describe('BaseQueryBuilderService', () => {
});
describe('userQuery', () => {
it('should set userQuery with parentheses', () => {
it('should set userQuery to raw value without wrapping', () => {
service.userQuery = 'test query';
expect(service.userQuery).toBe('(test query)');
expect(service.userQuery).toBe('test query');
});
it('should trim userQuery', () => {
service.userQuery = ' test query ';
expect(service.userQuery).toBe('(test query)');
it('should store userQuery in filterRawParams', () => {
service.userQuery = 'test';
expect(service.filterRawParams['userQuery']).toBe('test');
});
it('should return empty string for null input', () => {
service.userQuery = null;
it('should set parsedQuery when userQuery is set in regular mode', () => {
service.searchMode = 'regular';
service.userQuery = 'hello';
expect(service.parsedQuery).toBe('((cm:name:"hello*"))');
});
it('should set parsedQuery equal to userQuery in formula mode', () => {
service.searchMode = 'formula';
service.userQuery = '(cm:name:"test*")';
expect(service.parsedQuery).toBe('(cm:name:"test*")');
});
it('should clear userQuery and its raw param when set to empty', () => {
configureAppConfig(true);
service.searchMode = 'regular';
service.userQuery = 'something';
service.userQuery = '';
expect(service.userQuery).toBe('');
expect(service.filterRawParams['userQuery']).toBe('');
});
});
describe('parsedQuery', () => {
it('should wrap a single term with field query and parentheses in regular mode', () => {
configureAppConfig(true);
service.searchMode = 'regular';
service.userQuery = 'hello';
expect(service.parsedQuery).toContain('cm:name:"hello*"');
});
it('should join multiple terms with AND in regular mode when no operator present', () => {
configureAppConfig(true);
service.searchMode = 'regular';
service.userQuery = 'hello world';
expect(service.parsedQuery).toContain(' AND ');
});
it('should preserve AND/OR operators in regular mode when present in query', () => {
configureAppConfig(true);
service.searchMode = 'regular';
service.userQuery = 'hello AND world';
expect(service.parsedQuery).toBe('((cm:name:"hello*") AND (cm:name:"world*"))');
});
it('should store parsedQuery in filterRawParams', () => {
configureAppConfig(true);
service.searchMode = 'regular';
service.userQuery = 'hello';
expect(service.filterRawParams['parsedQuery']).toBe(service.parsedQuery);
});
it('should not add wildcard suffix when wildcards are disabled', () => {
configureAppConfig(false);
service.searchMode = 'regular';
service.userQuery = 'hello';
expect(service.parsedQuery).toBe('((cm:name:"hello"))');
});
it('should build the exact single-term parsed query against the default cm:name field', () => {
configureAppConfig(true);
service.searchMode = 'regular';
service.userQuery = 'hello';
expect(service.parsedQuery).toBe('((cm:name:"hello*"))');
});
it('should join each multi-term word with AND wrapped in parentheses', () => {
configureAppConfig(true);
service.searchMode = 'regular';
service.userQuery = 'hello world';
expect(service.parsedQuery).toBe('((cm:name:"hello*") AND (cm:name:"world*"))');
});
it('should keep explicit operators as separators between terms', () => {
configureAppConfig(true);
service.searchMode = 'regular';
service.userQuery = 'hello OR world';
expect(service.parsedQuery).toBe('((cm:name:"hello*") OR (cm:name:"world*"))');
});
it('should parse each term against every configured app:fields entry', () => {
configureAppConfig(true);
service.searchMode = 'regular';
service.config = { id: 'test-config', categories: [], 'app:fields': ['cm:name', 'cm:title'] } as any;
service.userQuery = 'hello';
expect(service.parsedQuery).toBe('((cm:name:"hello*" OR cm:title:"hello*"))');
});
it('should escape double quotes in the user query term', () => {
configureAppConfig(true);
service.searchMode = 'regular';
service.userQuery = 'he"llo';
expect(service.parsedQuery).toBe('((cm:name:"he\\"llo*"))');
});
it('should escape backslashes in the user query term', () => {
configureAppConfig(true);
service.searchMode = 'regular';
service.userQuery = 'he\\llo';
expect(service.parsedQuery).toBe('((cm:name:"he\\\\llo*"))');
});
it('should clear parsedQuery and its raw param when userQuery is set to empty', () => {
configureAppConfig(true);
service.searchMode = 'regular';
service.userQuery = 'hello';
service.userQuery = '';
expect(service.parsedQuery).toBe('');
expect(service.filterRawParams['parsedQuery']).toBe('');
});
});
describe('searchMode', () => {
it('should default to regular mode', () => {
expect(service.searchMode).toBe('regular');
});
it('should store searchMode in filterRawParams', () => {
service.searchMode = 'formula';
expect(service.filterRawParams['searchMode']).toBe('formula');
});
it('should update filterRawParams when changed back to regular', () => {
service.searchMode = 'formula';
service.searchMode = 'regular';
expect(service.filterRawParams['searchMode']).toBe('regular');
});
it('should recompute parsedQuery when switching search mode', () => {
configureAppConfig(true);
service.searchMode = 'formula';
service.userQuery = 'hello';
expect(service.parsedQuery).toBe('hello');
service.searchMode = 'regular';
expect(service.parsedQuery).toBe('((cm:name:"hello*"))');
});
});
describe('wildcardsEnabled', () => {
it('should return true by default', () => {
configureAppConfig();
expect(service.wildcardsEnabled).toBe(true);
});
it('should return false when config disables wildcards', () => {
configureAppConfig(false);
expect(service.wildcardsEnabled).toBe(false);
});
});
describe('isOperator', () => {
it('should return true for AND', () => {
expect(service.isOperator('AND')).toBeTrue();
});
it('should return true for OR', () => {
expect(service.isOperator('OR')).toBeTrue();
});
it('should return true for AND with surrounding spaces', () => {
expect(service.isOperator(' AND ')).toBeTrue();
});
it('should return false for regular word', () => {
expect(service.isOperator('hello')).toBeFalse();
});
it('should return false for empty string', () => {
expect(service.isOperator('')).toBeFalse();
});
it('should return false for null/undefined', () => {
expect(service.isOperator(null)).toBeFalse();
expect(service.isOperator(undefined)).toBeFalse();
});
});
describe('selectedConfigurationId', () => {
it('should store selectedConfigurationId in filterRawParams when set', () => {
(appConfig.get as jasmine.Spy).and.returnValue(mockMultipleConfigs);
service.resetToDefaults();
service.selectedConfigurationId = 'config-2';
expect(service.filterRawParams['selectedConfigurationId']).toBe('config-2');
});
});
describe('encodedQuery', () => {
it('should return encoded query after encodeQuery is called', () => {
service.userQuery = 'test';
service.encodeQuery();
expect(service.encodedQuery).toBeTruthy();
});
it('should return a base64 encoded string of filterRawParams', () => {
service.userQuery = 'test';
service.encodeQuery();
const decoded = new TextDecoder().decode(Uint8Array.from(atob(service.encodedQuery), (char) => char.charCodeAt(0)));
const parsed = JSON.parse(decoded);
expect(parsed['userQuery']).toBe('test');
});
});
@@ -215,15 +420,27 @@ describe('BaseQueryBuilderService', () => {
expect(service.buildQuery()).toBeNull();
});
it('should build query with userQuery', () => {
it('should build query with parsedQuery in regular mode', () => {
configureAppConfig(true);
service.searchMode = 'regular';
service.userQuery = 'test';
const query = service.buildQuery();
expect(query).toBeTruthy();
expect(query.query.query).toBe('(test)');
expect(query.query.query).toContain('cm:name:"test*"');
});
it('should build query using userQuery directly in formula mode', () => {
service.searchMode = 'formula';
service.userQuery = '(cm:name:"test*")';
const query = service.buildQuery();
expect(query).toBeTruthy();
expect(query.query.query).toBe('(cm:name:"test*")');
});
it('should include scope in query when set', () => {
service.searchMode = 'formula';
service.userQuery = 'test';
service.setScope({ locations: 'nodes' });
const query = service.buildQuery();
@@ -233,6 +450,7 @@ describe('BaseQueryBuilderService', () => {
it('should include default includes when none configured', () => {
service.config = { id: 'test-config', categories: [] };
service.searchMode = 'formula';
service.userQuery = 'test';
const query = service.buildQuery();
@@ -241,29 +459,25 @@ describe('BaseQueryBuilderService', () => {
});
});
describe('update', () => {
it('should emit updated event with built query', (done) => {
describe('getFinalQuery', () => {
it('should skip query fragments that are empty match-all objects', () => {
service.searchMode = 'formula';
service.userQuery = 'test';
service.categories = [{ id: 'cat1', name: 'Cat1', enabled: true, expanded: false, component: { selector: 'test', settings: undefined } }];
service.queryFragments['cat1'] = { matchAll: '', matchAny: '', matchExact: '', exclude: '' };
service.updated.subscribe((query) => {
expect(query.query.query).toBe('(test)');
done();
});
service.update();
const query = service.buildQuery();
expect(query.query.query).toBe('test');
});
it('should emit updated event with provided query body', (done) => {
const customQuery = {
query: { query: 'custom query', language: 'afts' }
};
it('should include non-empty query fragments', () => {
service.searchMode = 'formula';
service.userQuery = 'test';
service.categories = [{ id: 'cat1', name: 'Cat1', enabled: true, expanded: false, component: { selector: 'test', settings: undefined } }];
service.queryFragments['cat1'] = 'cm:name:"hello"';
service.updated.subscribe((query) => {
expect(query.query.query).toBe('custom query');
done();
});
service.update(customQuery);
const query = service.buildQuery();
expect(query.query.query).toContain('cm:name:"hello"');
});
});
@@ -450,79 +664,24 @@ describe('BaseQueryBuilderService', () => {
expect(service.execute).toHaveBeenCalled();
});
});
describe('populateFilters and selectedConfiguration restoration', () => {
beforeEach(() => {
(appConfig.get as jasmine.Spy<<T>(key: string, defaultValue?: T) => T>).and.returnValue(mockMultipleConfigs);
service.resetToDefaults();
});
it('should restore selectedConfiguration from populateFilters', (done) => {
it('should not call execute when shouldExecute is false', async () => {
spyOn(router, 'navigate').and.returnValue(Promise.resolve(true));
spyOn(service, 'execute');
service.configUpdated.subscribe((config) => {
expect(config.name).toBe('Config 3');
done();
});
service.updateSelectedConfiguration('config-2', true, false);
service.populateFilters.next({ selectedConfigurationId: 'config-3', someOtherFilter: 'value' });
expect(service.execute).not.toHaveBeenCalled();
});
it('should reset to default configuration when populateFilters has no selectedConfigurationId', (done) => {
it('should not reset search options when resetFilters is false', () => {
spyOn(router, 'navigate').and.returnValue(Promise.resolve(true));
spyOn(service.searchApi, 'search').and.returnValue(Promise.resolve({ list: { entries: [] } } as ResultSetPaging));
service.updateSelectedConfiguration('config-3');
service.queryFragments['someFilter'] = 'some value';
service.updateSelectedConfiguration('config-2', false, false);
setTimeout(() => {
service.configUpdated.subscribe((config) => {
expect(config.name).toBe('Config 1');
done();
});
service.populateFilters.next({ someOtherFilter: 'value' });
}, 0);
});
it('should not change configuration when populateFilters is empty', () => {
spyOn(router, 'navigate').and.returnValue(Promise.resolve(true));
const configUpdatedSpy = jasmine.createSpy('configUpdatedSpy');
service.configUpdated.subscribe(configUpdatedSpy);
configUpdatedSpy.calls.reset();
service.populateFilters.next({});
expect(configUpdatedSpy).not.toHaveBeenCalled();
});
it('should not change configuration when same configuration is already selected', (done) => {
spyOn(router, 'navigate').and.returnValue(Promise.resolve(true));
spyOn(service.searchApi, 'search').and.returnValue(Promise.resolve({ list: { entries: [] } } as ResultSetPaging));
service.updateSelectedConfiguration('config-2');
setTimeout(() => {
const configUpdatedSpy = jasmine.createSpy('configUpdatedSpy');
service.configUpdated.subscribe(configUpdatedSpy);
service.populateFilters.next({ selectedConfigurationId: 'config-2' });
setTimeout(() => {
expect(configUpdatedSpy).not.toHaveBeenCalled();
done();
}, 0);
}, 0);
});
it('should update filterRawParams when restoring configuration from populateFilters', (done) => {
service.configUpdated.subscribe(() => {
expect(service.filterRawParams['selectedConfigurationId']).toBe('config-2');
done();
});
service.populateFilters.next({ selectedConfigurationId: 'config-2' });
expect(service.queryFragments['someFilter']).toBe('some value');
});
});
@@ -577,5 +736,17 @@ describe('BaseQueryBuilderService', () => {
expect(service.categories.length).toBe(1);
expect(service.categories[0].id).toBe('cat1');
});
it('should reset userQuery when resetUserQuery is true (default)', () => {
service.userQuery = 'some query';
service.resetToDefaults(false, true);
expect(service.userQuery).toBe('');
});
it('should preserve userQuery when resetUserQuery is false', () => {
service.userQuery = 'some query';
service.resetToDefaults(false, false);
expect(service.userQuery).toBe('some query');
});
});
});
lib/content-services/src/lib/search/services/base-query-builder.service.ts
+113 -67
View File
@@ -54,9 +54,6 @@ export abstract class BaseQueryBuilderService {
/* Stream that emits the event each time when search filter finishes loading initial value */
filterLoaded = new Subject<void>();
/* Stream that emits the query before search whenever user search */
updated = new Subject<SearchRequest>();
/* Stream that emits the results whenever user search */
executed = new Subject<ResultSetPaging>();
@@ -85,11 +82,13 @@ export abstract class BaseQueryBuilderService {
sorting: SearchSortingDefinition[] = [];
sortingOptions: SearchSortingDefinition[] = [];
private encodedQuery: string;
private _encodedQuery: string;
private scope: RequestScope;
private selectedConfigurationId: string;
private _userQuery = '';
private _selectedConfigurationId: string;
private _queryFragments: { [id: string]: string } = {};
private _parsedQuery: string;
private _userQuery: string;
private _searchMode: 'regular' | 'formula';
private readonly selectedConfigurationKey = 'selectedConfigurationId';
private readonly queryFragmentsHandler: ProxyHandler<{ [key: string]: any }> = {
@@ -111,13 +110,45 @@ export abstract class BaseQueryBuilderService {
this.queryFragmentsUpdate.next(this._queryFragments);
}
get encodedQuery(): string {
return this._encodedQuery;
}
get wildcardsEnabled(): boolean {
return this.appConfig.get<boolean>('search-wildcards-enabled', true);
}
get userQuery(): string {
return this._userQuery;
}
set userQuery(value: string) {
value = (value || '').trim();
this._userQuery = value ? `(${value})` : '';
this._userQuery = value;
this.filterRawParams['userQuery'] = value;
this.setParsedQuery();
}
get parsedQuery(): string {
return this._parsedQuery;
}
get searchMode(): 'regular' | 'formula' {
return this._searchMode;
}
set searchMode(value: 'regular' | 'formula') {
this._searchMode = value;
this.filterRawParams['searchMode'] = value;
this.setParsedQuery();
}
get selectedConfigurationId(): string {
return this._selectedConfigurationId;
}
set selectedConfigurationId(value: string) {
this._selectedConfigurationId = value;
this.filterRawParams[this.selectedConfigurationKey] = value;
}
config: SearchConfiguration = {
@@ -132,17 +163,17 @@ export abstract class BaseQueryBuilderService {
protected readonly appConfig: AppConfigService,
protected readonly alfrescoApiService: AlfrescoApiService
) {
this.searchMode = 'regular';
this.userQuery = '';
this.resetToDefaults();
this._queryFragments = this.createQueryFragmentsProxy({});
this.populateFilters.subscribe((filters) => this.handleSelectedConfigurationChange(filters));
}
public abstract loadConfiguration(): SearchConfiguration | SearchConfiguration[];
public abstract isFilterServiceActive(): boolean;
public resetToDefaults(withNavigate = false) {
public resetToDefaults(withNavigate = false, resetUserQuery = true) {
if (withNavigate) {
this.router.navigate([], {
queryParams: { q: null },
@@ -151,7 +182,7 @@ export abstract class BaseQueryBuilderService {
});
}
const currentConfig = this.getDefaultConfiguration();
this.resetSearchOptions();
this.resetSearchOptions(resetUserQuery);
this.configUpdated.next(currentConfig);
this.searchForms.next(this.getSearchFormDetails());
this.setUpSearchConfiguration(currentConfig);
@@ -170,23 +201,26 @@ export abstract class BaseQueryBuilderService {
return configurations;
}
public updateSelectedConfiguration(id: string): void {
public updateSelectedConfiguration(id: string, resetFilters = true, shouldExecute = true): void {
const currentConfig = this.loadConfiguration();
if (Array.isArray(currentConfig)) {
const selectedConfig = currentConfig.find((config) => config.id === id);
if (selectedConfig) {
if (resetFilters) {
this.resetSearchOptions(false);
}
this.selectedConfigurationId = id;
this.searchForms.next(this.getSearchFormDetails());
this.resetSearchOptions();
this.setUpSearchConfiguration(selectedConfig);
this.filterRawParams[this.selectedConfigurationKey] = id;
this.configUpdated.next(selectedConfig);
this.execute();
if (shouldExecute) {
this.execute(true);
}
}
}
}
private resetSearchOptions(): void {
private resetSearchOptions(resetUserQuery = true): void {
this.categories = [];
this.queryFragments = {};
this.filterQueries = [];
@@ -194,8 +228,10 @@ export abstract class BaseQueryBuilderService {
this.sortingOptions = [];
this.resetUserFacetBucket();
this.scope = null;
this.filterRawParams = {};
this._userQuery = '';
if (resetUserQuery) {
this.userQuery = '';
}
this.resetFilterRawParams(resetUserQuery);
this.populateFilters.next({});
}
@@ -229,6 +265,7 @@ export abstract class BaseQueryBuilderService {
this.categories = (this.config.categories || []).filter((category) => category.enabled);
this.filterQueries = this.config.filterQueries || [];
this.userFacetBuckets = {};
this.userQuery = this.filterRawParams['userQuery'] || '';
if (this.config.sorting) {
this.sorting = this.config.sorting.defaults || [];
this.sortingOptions = this.config.sorting.options || [];
@@ -355,16 +392,6 @@ export abstract class BaseQueryBuilderService {
return this.scope;
}
/**
* Builds the current query and triggers the `updated` event.
*
* @param queryBody query settings
*/
update(queryBody?: SearchRequest): void {
const query = queryBody ? queryBody : this.buildQuery();
this.updated.next(query);
}
/**
* Builds and executes the current query.
*
@@ -552,12 +579,9 @@ export abstract class BaseQueryBuilderService {
protected getFinalQuery(): string {
let query = '';
if (this.userQuery) {
this.filterRawParams['userQuery'] = this.userQuery;
}
this.categories.forEach((facet) => {
const customQuery = this.queryFragments[facet.id];
if (customQuery) {
if (customQuery && JSON.stringify(customQuery) !== JSON.stringify({ matchAll: '', matchAny: '', matchExact: '', exclude: '' })) {
if (query.length > 0) {
query += ' AND ';
}
@@ -565,7 +589,8 @@ export abstract class BaseQueryBuilderService {
}
});
let result = [this.userQuery, query].filter((entry) => entry).join(' AND ');
const parsedQuery = this.searchMode === 'regular' ? this.parsedQuery : this.userQuery;
let result = [parsedQuery, query].filter((entry) => entry).join(' AND ');
if (this.userFacetBuckets) {
Object.keys(this.userFacetBuckets).forEach((key) => {
@@ -626,10 +651,10 @@ export abstract class BaseQueryBuilderService {
*/
encodeQuery() {
try {
this.encodedQuery = btoa(String.fromCharCode(...new TextEncoder().encode(JSON.stringify(this.filterRawParams))));
this._encodedQuery = btoa(String.fromCharCode(...new TextEncoder().encode(JSON.stringify(this.filterRawParams))));
} catch (error) {
console.error('Failed to encode query parameters:', error);
this.encodedQuery = '';
this._encodedQuery = '';
}
}
@@ -640,7 +665,7 @@ export abstract class BaseQueryBuilderService {
this.encodeQuery();
this.router.navigate([], {
relativeTo: this.activatedRoute,
queryParams: { q: this.encodedQuery },
queryParams: { q: this._encodedQuery },
queryParamsHandling: 'merge'
});
}
@@ -653,50 +678,71 @@ export abstract class BaseQueryBuilderService {
*/
async navigateToSearch(query: string, searchUrl: string) {
this.userQuery = query;
this.encodeQuery();
await this.execute();
await this.router.navigate([searchUrl], {
queryParams: { q: this.encodedQuery },
queryParams: { q: this._encodedQuery },
queryParamsHandling: 'merge'
});
}
/**
* Checks if string is an AND or OR operator
*
* @param input string to check if it is an operator
* @returns boolean
*/
isOperator(input: string): boolean {
if (input) {
const operators = ['AND', 'OR'];
return operators.includes(input.trim());
}
return false;
}
private createQueryFragmentsProxy(target: { [key: string]: any }): { [key: string]: any } {
return new Proxy(target, this.queryFragmentsHandler);
}
private setSelectedConfiguration(id: string): void {
const currentConfig = this.loadConfiguration();
if (Array.isArray(currentConfig)) {
const selectedConfig = currentConfig.find((config) => config.id === id);
if (selectedConfig) {
this.selectedConfigurationId = id;
this.searchForms.next(this.getSearchFormDetails());
this.setUpSearchConfiguration(selectedConfig);
this.filterRawParams[this.selectedConfigurationKey] = id;
this.configUpdated.next(selectedConfig);
}
}
}
private handleSelectedConfigurationChange(filters: { [key: string]: string }): void {
if (Object.keys(filters ?? {}).length === 0) {
private setParsedQuery() {
if (!this.userQuery) {
this._parsedQuery = '';
this.filterRawParams['parsedQuery'] = '';
return;
}
const newSelectedConfig = filters?.[this.selectedConfigurationKey];
if (newSelectedConfig) {
if (newSelectedConfig !== this.selectedConfigurationId) {
this.setSelectedConfiguration(newSelectedConfig);
}
if (this.searchMode === 'formula') {
this._parsedQuery = this.userQuery;
} else {
const configurations = this.loadConfiguration();
if (Array.isArray(configurations)) {
const defaultConfig = configurations.find((config) => config.default);
if (defaultConfig && this.selectedConfigurationId !== defaultConfig.id) {
this.setSelectedConfiguration(defaultConfig.id);
}
const words = this.userQuery.split(/\s+/);
if (words.length > 1) {
const separator = words.some(this.isOperator) ? ' ' : ' AND ';
this._parsedQuery = '(' + words.map((term) => (this.isOperator(term) ? term : this.parseTermByFields(term))).join(separator) + ')';
} else {
this._parsedQuery = '(' + this.parseTermByFields(this.userQuery) + ')';
}
}
this.filterRawParams['parsedQuery'] = this._parsedQuery;
}
private parseTermByFields(term: string): string {
const suffix = this.wildcardsEnabled ? '*' : '';
const fields = this.config['app:fields'] || ['cm:name'];
const escapedTerm = this.escapeQueryTerm(term);
return '(' + fields.map((field) => `${field}:"${escapedTerm}${suffix}"`).join(' OR ') + ')';
}
private escapeQueryTerm(term: string): string {
return term.replace(/\\/g, '\\\\').replace(/"/g, '\\"');
}
private resetFilterRawParams(resetUserQuery = true) {
this.filterRawParams = {
userQuery: resetUserQuery ? '' : this.userQuery,
parsedQuery: resetUserQuery ? '' : this.parsedQuery,
searchMode: this.searchMode,
[this.selectedConfigurationKey]: this.selectedConfigurationId,
logic: { matchAll: '', matchAny: '', matchExact: '', exclude: '' }
};
}
}
lib/content-services/src/lib/search/services/search-facet-filters.service.spec.ts
+3 -3
View File
@@ -679,7 +679,7 @@ describe('SearchFacetFiltersService', () => {
it('should reset filters and call resetToDefaults', () => {
const resetToDefaultsSpy = spyOn(queryBuilder, 'resetToDefaults');
const updateSpy = spyOn(queryBuilder, 'update');
const executeSpy = spyOn(queryBuilder, 'execute');
const responseFacets = [{ field: 'field1', label: null }];
const selectedBuckets = [{ field: { field: 'field1', label: null }, bucket: { label: 'bucket1', count: 1, filterQuery: 'q1' } }];
@@ -695,8 +695,8 @@ describe('SearchFacetFiltersService', () => {
searchFacetFiltersService.reset();
expect(resetToDefaultsSpy).toHaveBeenCalled();
expect(updateSpy).toHaveBeenCalled();
expect(resetToDefaultsSpy).toHaveBeenCalledWith(true, false);
expect(executeSpy).toHaveBeenCalled();
expect(searchFacetFiltersService.responseFacets).toEqual([]);
expect(searchFacetFiltersService.selectedBuckets).toEqual([]);
lib/content-services/src/lib/search/services/search-facet-filters.service.ts
+4 -6
View File
@@ -70,8 +70,6 @@ export class SearchFacetFiltersService {
this.responseFacets = null;
});
this.queryBuilder.updated.pipe(takeUntilDestroyed()).subscribe((query) => this.queryBuilder.execute(true, query));
this.queryBuilder.executed.pipe(takeUntilDestroyed()).subscribe((resultSetPaging: ResultSetPaging) => {
this.onDataLoaded(resultSetPaging);
this.searchService.dataLoaded.next(resultSetPaging);
@@ -397,7 +395,7 @@ export class SearchFacetFiltersService {
bucket.checked = false;
this.queryBuilder.removeUserFacetBucket(facetField?.field, bucket);
this.updateSelectedBuckets();
this.queryBuilder.update();
this.queryBuilder.execute();
}
}
@@ -432,7 +430,7 @@ export class SearchFacetFiltersService {
this.updateSelectedBuckets();
}
});
this.queryBuilder.update();
this.queryBuilder.execute();
}
resetQueryFragments() {
@@ -444,7 +442,7 @@ export class SearchFacetFiltersService {
this.responseFacets = [];
this.selectedBuckets = [];
this.tabbedFacet = null;
this.queryBuilder.resetToDefaults(true);
this.queryBuilder.update();
this.queryBuilder.resetToDefaults(true, false);
this.queryBuilder.execute();
}
}
lib/content-services/src/lib/search/services/search-header-query-builder.service.spec.ts
+9 -11
View File
@@ -231,19 +231,17 @@ describe('SearchHeaderQueryBuilderService', () => {
spyOn(router, 'navigate');
spyOn(console, 'error');
const searchUrl = 'search';
builderService.filterRawParams = {
userQuery: '((cm:name:"wąż*" OR cm:title:"wąż*" OR cm:description:"wąż*" OR TEXT:"wąż*" OR TAG:"wąż*"))'
};
builderService.encodeQuery();
const nonLatinQuery = '((cm:name:"wąż*" OR cm:title:"wąż*" OR cm:description:"wąż*" OR TEXT:"wąż*" OR TAG:"wąż*"))';
builderService.searchMode = 'formula';
await builderService.navigateToSearch(nonLatinQuery, searchUrl);
await builderService.navigateToSearch('', searchUrl);
expect(console.error).not.toHaveBeenCalled();
expect(router.navigate).toHaveBeenCalledWith([searchUrl], {
queryParams: {
q: 'eyJ1c2VyUXVlcnkiOiIoKGNtOm5hbWU6XCJ3xIXFvCpcIiBPUiBjbTp0aXRsZTpcInfEhcW8KlwiIE9SIGNtOmRlc2NyaXB0aW9uOlwid8SFxbwqXCIgT1IgVEVYVDpcInfEhcW8KlwiIE9SIFRBRzpcInfEhcW8KlwiKSkifQ=='
},
queryParamsHandling: 'merge'
});
const navigateArgs = (router.navigate as jasmine.Spy).calls.mostRecent().args;
expect(navigateArgs[0]).toEqual([searchUrl]);
expect(navigateArgs[1].queryParamsHandling).toBe('merge');
const decoded = JSON.parse(decodeURIComponent(escape(atob(navigateArgs[1].queryParams.q))));
expect(decoded.userQuery).toBe(nonLatinQuery);
});
});
lib/content-services/src/lib/search/services/search-header-query-builder.service.ts
-5
View File
@@ -21,7 +21,6 @@ import { SearchConfiguration } from '../models/search-configuration.interface';
import { BaseQueryBuilderService } from './base-query-builder.service';
import { SearchCategory } from '../models/search-category.interface';
import { Node } from '@alfresco/js-api';
import { filter } from 'rxjs/operators';
import { Observable } from 'rxjs';
import { SearchSortingDefinition } from '../models/search-sorting-definition.interface';
import { FilterSearch } from '../models/filter-search.interface';
@@ -43,10 +42,6 @@ export class SearchHeaderQueryBuilderService extends BaseQueryBuilderService {
const alfrescoApiService = inject(AlfrescoApiService);
super(appConfig, alfrescoApiService);
this.updated.pipe(filter((query) => !!query)).subscribe(() => {
this.execute();
});
}
public isFilterServiceActive(): boolean {
lib/content-services/src/lib/search/services/search-query-builder.service.spec.ts
+40 -22
View File
@@ -126,16 +126,16 @@ describe('SearchQueryBuilder', () => {
expect(builder.userQuery).toBe('');
});
it('should wrap user query with brackets', () => {
it('should store the user query as the raw value', () => {
const builder = createQueryBuilder();
builder.userQuery = 'my query';
expect(builder.userQuery).toEqual('(my query)');
expect(builder.userQuery).toEqual('my query');
});
it('should trim user query value', () => {
it('should expose the user query through filterRawParams', () => {
const builder = createQueryBuilder();
builder.userQuery = ' something ';
expect(builder.userQuery).toEqual('(something)');
builder.userQuery = 'something';
expect(builder.filterRawParams['userQuery']).toEqual('something');
});
it('should use only enabled categories', () => {
@@ -579,7 +579,8 @@ describe('SearchQueryBuilder', () => {
categories: [{ id: 'cat1', enabled: true } as any]
};
const builder = createQueryBuilder(config);
builder.userQuery = 'my query';
builder.searchMode = 'formula';
builder.userQuery = '(my query)';
builder.queryFragments['cat1'] = 'cm:name:test';
@@ -587,6 +588,21 @@ describe('SearchQueryBuilder', () => {
expect(compiled.query.query).toBe('(my query) AND (cm:name:test)');
});
it('should build final request from the parsed query in regular mode', () => {
const config: SearchConfiguration = {
id: 'test-config',
categories: [{ id: 'cat1', enabled: true } as any]
};
const builder = createQueryBuilder(config);
builder.searchMode = 'regular';
builder.userQuery = 'my query';
builder.queryFragments['cat1'] = 'cm:name:test';
const compiled = builder.buildQuery();
expect(compiled.query.query).toBe(`${builder.parsedQuery} AND (cm:name:test)`);
});
it('should group facet buckets by field', () => {
const field1: FacetField = {
field: 'f1',
@@ -729,12 +745,13 @@ describe('SearchQueryBuilder', () => {
});
});
it('should add user query to filter raw params when query is built', () => {
it('should add user query and parsed query to filter raw params when user query is set', () => {
const builder = createQueryBuilder();
builder.userQuery = 'nuka cola quantum';
builder.buildQuery();
expect(builder.filterRawParams).toEqual({ userQuery: '(nuka cola quantum)' });
expect(builder.filterRawParams['userQuery']).toBe('nuka cola quantum');
expect(builder.filterRawParams['parsedQuery']).toBe(builder.parsedQuery);
});
it('should encode query from filter raw params and update query params on executing query', (done) => {
@@ -754,13 +771,14 @@ describe('SearchQueryBuilder', () => {
it('should encode query from filter raw params and update query params on navigating to search', async () => {
spyOn(router, 'navigate');
service.filterRawParams = { userQuery: '(test query)' };
service.searchMode = 'formula';
await service.navigateToSearch('test query', '/search');
expect(router.navigate).toHaveBeenCalledWith(['/search'], {
queryParams: { q: 'eyJ1c2VyUXVlcnkiOiIodGVzdCBxdWVyeSkifQ==' },
queryParamsHandling: 'merge'
});
const navigateArgs = (router.navigate as jasmine.Spy).calls.mostRecent().args;
expect(navigateArgs[0]).toEqual(['/search']);
expect(navigateArgs[1].queryParamsHandling).toBe('merge');
const decoded = JSON.parse(decodeURIComponent(escape(atob(navigateArgs[1].queryParams.q))));
expect(decoded.userQuery).toBe('test query');
});
describe('Multiple search configuration', () => {
@@ -859,17 +877,17 @@ describe('SearchQueryBuilder', () => {
spyOn(router, 'navigate');
spyOn(console, 'error');
const searchUrl = 'search';
service.filterRawParams = { userQuery: '((cm:name:"wąż*" OR cm:title:"wąż*" OR cm:description:"wąż*" OR TEXT:"wąż*" OR TAG:"wąż*"))' };
service.encodeQuery();
const nonLatinQuery = '((cm:name:"wąż*" OR cm:title:"wąż*" OR cm:description:"wąż*" OR TEXT:"wąż*" OR TAG:"wąż*"))';
service.searchMode = 'formula';
await service.navigateToSearch(nonLatinQuery, searchUrl);
await service.navigateToSearch('', searchUrl);
expect(console.error).not.toHaveBeenCalled();
expect(router.navigate).toHaveBeenCalledWith([searchUrl], {
queryParams: {
q: 'eyJ1c2VyUXVlcnkiOiIoKGNtOm5hbWU6XCJ3xIXFvCpcIiBPUiBjbTp0aXRsZTpcInfEhcW8KlwiIE9SIGNtOmRlc2NyaXB0aW9uOlwid8SFxbwqXCIgT1IgVEVYVDpcInfEhcW8KlwiIE9SIFRBRzpcInfEhcW8KlwiKSkifQ=='
},
queryParamsHandling: 'merge'
});
const navigateArgs = (router.navigate as jasmine.Spy).calls.mostRecent().args;
expect(navigateArgs[0]).toEqual([searchUrl]);
expect(navigateArgs[1].queryParamsHandling).toBe('merge');
const decoded = JSON.parse(decodeURIComponent(escape(atob(navigateArgs[1].queryParams.q))));
expect(decoded.userQuery).toBe(nonLatinQuery);
});
});
lib/core/src/lib/auth/oidc/oidc-authentication.service.spec.ts
+9
View File
@@ -80,6 +80,7 @@ describe('OidcAuthenticationService', () => {
});
service = TestBed.inject(OidcAuthenticationService);
oauthService = TestBed.inject(OAuthService);
mockOAuthService.logOut.calls.reset();
});
it('should be created', () => {
@@ -165,6 +166,14 @@ describe('OidcAuthenticationService', () => {
});
});
describe('reset', () => {
it('should clear local OAuth state without redirecting to the IdP', () => {
service.reset();
expect(oauthService.logOut as jasmine.Spy).toHaveBeenCalledOnceWith(true);
});
});
describe('loggedIn', () => {
it('should return true if has valid tokens', () => {
mockOAuthService.hasValidAccessToken.and.returnValue(true);
lib/core/src/lib/auth/oidc/oidc-authentication.service.ts
+1 -2
View File
@@ -131,8 +131,7 @@ export class OidcAuthenticationService extends BaseAuthenticationService {
}
reset(): void {
const config = this.authConfig.loadAppConfig();
this.auth.updateIDPConfiguration(config);
this.oauthService.logOut(true);
}
isPublicUrl(): boolean {
lib/core/src/lib/auth/public-api.ts
+1
View File
@@ -49,4 +49,5 @@ export * from './models/identity-role.model';
export * from './models/user-access.model';
export * from './models/application-access.model';
export * from './session-timeout/public-api';
export * from './oidc/public-api';
lib/core/src/lib/auth/session-timeout/idle-activity-tracker.spec.ts
+112
View File
@@ -0,0 +1,112 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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 { DOCUMENT } from '@angular/common';
import { NgZone } from '@angular/core';
import { fakeAsync, TestBed, tick } from '@angular/core/testing';
import { ACTIVITY_THROTTLE_MS, IdleActivityTracker } from './idle-activity-tracker';
describe('IdleActivityTracker', () => {
let tracker: IdleActivityTracker;
let doc: Document;
beforeEach(() => {
TestBed.configureTestingModule({ providers: [IdleActivityTracker] });
tracker = TestBed.inject(IdleActivityTracker);
doc = TestBed.inject(DOCUMENT);
});
afterEach(() => tracker.stop());
it('emits on activity$ when a registered DOM event fires after start()', () => {
const spy = jasmine.createSpy('activity');
tracker.activity$.subscribe(spy);
tracker.start();
doc.dispatchEvent(new Event('click'));
expect(spy).toHaveBeenCalledTimes(1);
});
it('throttles a burst of activity events within the throttle window', fakeAsync(() => {
const spy = jasmine.createSpy('activity');
tracker.activity$.subscribe(spy);
tracker.start();
// Leading edge emits immediately, the rest of the burst is throttled.
for (let i = 0; i < 10; i++) {
doc.dispatchEvent(new Event('mousemove'));
}
expect(spy).toHaveBeenCalledTimes(1);
// After the throttle window, activity emits again.
tick(ACTIVITY_THROTTLE_MS);
doc.dispatchEvent(new Event('mousemove'));
expect(spy.calls.count()).toBeGreaterThan(1);
tick(ACTIVITY_THROTTLE_MS);
}));
it('does not emit after stop()', () => {
const spy = jasmine.createSpy('activity');
tracker.activity$.subscribe(spy);
tracker.start();
tracker.stop();
doc.dispatchEvent(new Event('click'));
expect(spy).not.toHaveBeenCalled();
});
it('registers listeners only once across repeated start() calls', () => {
const spy = jasmine.createSpy('activity');
tracker.activity$.subscribe(spy);
tracker.start();
tracker.start();
doc.dispatchEvent(new Event('click'));
expect(spy).toHaveBeenCalledTimes(1);
});
it('is a no-op when stop() is called without a prior start()', () => {
const spy = jasmine.createSpy('activity');
tracker.activity$.subscribe(spy);
expect(() => tracker.stop()).not.toThrow();
doc.dispatchEvent(new Event('click'));
expect(spy).not.toHaveBeenCalled();
});
it('emits the current visibility state on visibilitychange', () => {
const spy = jasmine.createSpy('visibility');
tracker.visibilityChange$.subscribe(spy);
tracker.start();
doc.dispatchEvent(new Event('visibilitychange'));
expect(spy).toHaveBeenCalledWith(doc.visibilityState);
});
it('registers listeners outside the Angular zone', () => {
const ngZone = TestBed.inject(NgZone);
const runOutside = spyOn(ngZone, 'runOutsideAngular').and.callThrough();
tracker.start();
expect(runOutside).toHaveBeenCalled();
});
});
lib/core/src/lib/auth/session-timeout/idle-activity-tracker.ts
+74
View File
@@ -0,0 +1,74 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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 { DOCUMENT } from '@angular/common';
import { Injectable, NgZone, OnDestroy, inject } from '@angular/core';
import { Observable, Subject } from 'rxjs';
import { throttleTime } from 'rxjs/operators';
export const ACTIVITY_EVENTS = ['click', 'keydown', 'mousedown', 'mousemove', 'pointerdown', 'scroll', 'touchstart', 'wheel'] as const;
/** High-frequency activity events (e.g. mousemove, scroll) are throttled to avoid rescheduling the idle timer on every DOM event. */
export const ACTIVITY_THROTTLE_MS = 1000;
@Injectable()
export class IdleActivityTracker implements OnDestroy {
private readonly document = inject(DOCUMENT);
private readonly ngZone = inject(NgZone);
private readonly activitySubject = new Subject<void>();
private readonly visibilitySubject = new Subject<DocumentVisibilityState>();
private isRegistered = false;
readonly activity$: Observable<void> = this.activitySubject
.asObservable()
.pipe(throttleTime(ACTIVITY_THROTTLE_MS, undefined, { leading: true, trailing: true }));
readonly visibilityChange$: Observable<DocumentVisibilityState> = this.visibilitySubject.asObservable();
start(): void {
if (this.isRegistered) {
return;
}
this.ngZone.runOutsideAngular(() => {
ACTIVITY_EVENTS.forEach((eventName) => this.document.addEventListener(eventName, this.handleActivity, { passive: true }));
this.document.addEventListener('visibilitychange', this.handleVisibilityChange);
});
this.isRegistered = true;
}
stop(): void {
if (!this.isRegistered) {
return;
}
ACTIVITY_EVENTS.forEach((eventName) => this.document.removeEventListener(eventName, this.handleActivity));
this.document.removeEventListener('visibilitychange', this.handleVisibilityChange);
this.isRegistered = false;
}
ngOnDestroy(): void {
this.stop();
}
private readonly handleActivity = (): void => {
this.activitySubject.next();
};
private readonly handleVisibilityChange = (): void => {
this.visibilitySubject.next(this.document.visibilityState);
};
}
lib/core/src/lib/auth/session-timeout/provide-session-timeout.spec.ts
+70
View File
@@ -0,0 +1,70 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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 { ApplicationInitStatus } from '@angular/core';
import { TestBed } from '@angular/core/testing';
import { Subject } from 'rxjs';
import { provideSessionTimeout } from './provide-session-timeout';
import { SessionTimeoutService } from './session-timeout.service';
import { AppConfigService } from '../../app-config/app-config.service';
import { AuthenticationService } from '../services/authentication.service';
describe('provideSessionTimeout', () => {
it('registers SessionTimeoutService and runs its start() during app init', async () => {
const startSpy = spyOn(SessionTimeoutService.prototype, 'start');
TestBed.configureTestingModule({
providers: [
provideSessionTimeout(),
{ provide: AppConfigService, useValue: { get: () => ({}), isLoaded: true, onLoad: new Subject() } },
{
provide: AuthenticationService,
useValue: { isLoggedIn: () => false, logout: () => {}, onLogin: new Subject(), onLogout: new Subject() }
}
]
});
await TestBed.inject(ApplicationInitStatus).donePromise;
expect(startSpy).toHaveBeenCalled();
});
it('waits for startWhen to emit true before starting SessionTimeoutService', async () => {
const startWhen$ = new Subject<boolean>();
const startSpy = spyOn(SessionTimeoutService.prototype, 'start');
TestBed.configureTestingModule({
providers: [
provideSessionTimeout({ startWhen: () => startWhen$ }),
{ provide: AppConfigService, useValue: { get: () => ({}), isLoaded: true, onLoad: new Subject() } },
{
provide: AuthenticationService,
useValue: { isLoggedIn: () => false, logout: () => {}, onLogin: new Subject(), onLogout: new Subject() }
}
]
});
await TestBed.inject(ApplicationInitStatus).donePromise;
expect(startSpy).not.toHaveBeenCalled();
startWhen$.next(false);
expect(startSpy).not.toHaveBeenCalled();
startWhen$.next(true);
expect(startSpy).toHaveBeenCalledTimes(1);
startWhen$.next(true);
expect(startSpy).toHaveBeenCalledTimes(1);
});
});
lib/core/src/lib/auth/session-timeout/provide-session-timeout.ts
+53
View File
@@ -0,0 +1,53 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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 { EnvironmentProviders, inject, makeEnvironmentProviders, provideAppInitializer } from '@angular/core';
import { SESSION_TIMEOUT_OPTIONS, SessionTimeoutOptions } from './session-timeout.config';
import { IdleActivityTracker } from './idle-activity-tracker';
import { SessionTimeoutSyncChannel } from './session-timeout-sync-channel';
import { SessionTimeoutService } from './session-timeout.service';
import { filter, take } from 'rxjs/operators';
/**
* Provides the session timeout feature: idle tracking, the countdown dialog and cross-tab sync.
*
* When the countdown dialog is not answered (or the user clicks "Log out"), the normal logout flow
* runs and the user is redirected to the configured IdP/login page.
*
* @param options - Optional overrides that take precedence over the `sessionTimeout` app config block
* @returns Environment providers that register the service and start it during app initialization
*/
export function provideSessionTimeout(options?: SessionTimeoutOptions): EnvironmentProviders {
return makeEnvironmentProviders([
{ provide: SESSION_TIMEOUT_OPTIONS, useValue: options ?? {} },
IdleActivityTracker,
SessionTimeoutSyncChannel,
SessionTimeoutService,
provideAppInitializer(() => {
const sessionTimeoutService = inject(SessionTimeoutService);
const sessionTimeoutOptions = inject(SESSION_TIMEOUT_OPTIONS);
const startWhen$ = sessionTimeoutOptions.startWhen?.();
if (!startWhen$) {
sessionTimeoutService.start();
return;
}
startWhen$.pipe(filter(Boolean), take(1)).subscribe(() => sessionTimeoutService.start());
})
]);
}
lib/core/src/lib/auth/session-timeout/public-api.ts
+23
View File
@@ -0,0 +1,23 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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.
*/
export * from './session-timeout.config';
export * from './idle-activity-tracker';
export * from './session-timeout-sync-channel';
export * from './session-timeout-dialog.component';
export * from './session-timeout.service';
export * from './provide-session-timeout';
lib/core/src/lib/auth/session-timeout/session-timeout-dialog.component.html
+14
View File
@@ -0,0 +1,14 @@
<h2 mat-dialog-title>{{ 'SESSION_TIMEOUT.TITLE' | translate }}</h2>
<mat-dialog-content aria-live="polite">
{{ 'SESSION_TIMEOUT.MESSAGE' | translate: { seconds: remainingSeconds } }}
</mat-dialog-content>
<mat-dialog-actions align="end">
<button mat-button type="button" data-automation-id="session-timeout-dialog__logout-button" (click)="logout()">
{{ 'SESSION_TIMEOUT.LOG_OUT' | translate }}
</button>
<button mat-flat-button color="primary" type="button" data-automation-id="session-timeout-dialog__continue-button" (click)="continueWorking()">
{{ 'SESSION_TIMEOUT.CONTINUE_WORKING' | translate }}
</button>
</mat-dialog-actions>
lib/core/src/lib/auth/session-timeout/session-timeout-dialog.component.scss
+4
View File
@@ -0,0 +1,4 @@
.adf-session-timeout-backdrop {
background-color: rgba(0, 0, 0, 0.45);
backdrop-filter: blur(16px);
}
lib/core/src/lib/auth/session-timeout/session-timeout-dialog.component.spec.ts
+64
View File
@@ -0,0 +1,64 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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 { fakeAsync, TestBed, tick } from '@angular/core/testing';
import { MAT_DIALOG_DATA, MatDialogRef } from '@angular/material/dialog';
import { NoopAnimationsModule } from '@angular/platform-browser/animations';
import { TranslateModule } from '@ngx-translate/core';
import { SessionTimeoutDialogComponent } from './session-timeout-dialog.component';
describe('SessionTimeoutDialogComponent', () => {
const dialogRef = { close: jasmine.createSpy('close') };
beforeEach(() => {
dialogRef.close.calls.reset();
TestBed.configureTestingModule({
imports: [SessionTimeoutDialogComponent, NoopAnimationsModule, TranslateModule.forRoot()],
providers: [
{ provide: MatDialogRef, useValue: dialogRef },
{ provide: MAT_DIALOG_DATA, useValue: { dialogTimeoutMs: 3000 } }
]
});
});
it('initializes remainingSeconds from dialogTimeoutMs', () => {
const fixture = TestBed.createComponent(SessionTimeoutDialogComponent);
expect(fixture.componentInstance.remainingSeconds).toBe(3);
});
it('counts down each second', fakeAsync(() => {
const fixture = TestBed.createComponent(SessionTimeoutDialogComponent);
fixture.detectChanges();
tick(1000);
expect(fixture.componentInstance.remainingSeconds).toBe(2);
tick(1000);
expect(fixture.componentInstance.remainingSeconds).toBe(1);
fixture.destroy();
}));
it('closes with true on continueWorking()', () => {
const fixture = TestBed.createComponent(SessionTimeoutDialogComponent);
fixture.componentInstance.continueWorking();
expect(dialogRef.close).toHaveBeenCalledWith(true);
});
it('closes with false on logout()', () => {
const fixture = TestBed.createComponent(SessionTimeoutDialogComponent);
fixture.componentInstance.logout();
expect(dialogRef.close).toHaveBeenCalledWith(false);
});
});
lib/core/src/lib/auth/session-timeout/session-timeout-dialog.component.ts
+67
View File
@@ -0,0 +1,67 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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 { ChangeDetectionStrategy, ChangeDetectorRef, Component, OnDestroy, ViewEncapsulation, inject } from '@angular/core';
import { MatButtonModule } from '@angular/material/button';
import { MAT_DIALOG_DATA, MatDialogModule, MatDialogRef } from '@angular/material/dialog';
import { TranslatePipe } from '@ngx-translate/core';
export const SESSION_TIMEOUT_BACKDROP_CLASS = 'adf-session-timeout-backdrop';
export interface SessionTimeoutDialogData {
dialogTimeoutMs: number;
}
@Component({
selector: 'adf-session-timeout-dialog',
standalone: true,
imports: [MatButtonModule, MatDialogModule, TranslatePipe],
templateUrl: './session-timeout-dialog.component.html',
styleUrl: './session-timeout-dialog.component.scss',
changeDetection: ChangeDetectionStrategy.OnPush,
encapsulation: ViewEncapsulation.None
})
export class SessionTimeoutDialogComponent implements OnDestroy {
private readonly dialogRef = inject<MatDialogRef<SessionTimeoutDialogComponent, boolean>>(MatDialogRef);
private readonly data = inject<SessionTimeoutDialogData>(MAT_DIALOG_DATA);
private readonly changeDetectorRef = inject(ChangeDetectorRef);
private readonly timeoutEndTime = Date.now() + this.data.dialogTimeoutMs;
private readonly countdownIntervalId = setInterval(() => this.updateRemainingSeconds(), 1000);
remainingSeconds = this.getRemainingSeconds();
ngOnDestroy(): void {
clearInterval(this.countdownIntervalId);
}
continueWorking(): void {
this.dialogRef.close(true);
}
logout(): void {
this.dialogRef.close(false);
}
private updateRemainingSeconds(): void {
this.remainingSeconds = this.getRemainingSeconds();
this.changeDetectorRef.markForCheck();
}
private getRemainingSeconds(): number {
return Math.max(Math.ceil((this.timeoutEndTime - Date.now()) / 1000), 0);
}
}
lib/core/src/lib/auth/session-timeout/session-timeout-sync-channel.spec.ts
+119
View File
@@ -0,0 +1,119 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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 { DOCUMENT } from '@angular/common';
import { TestBed } from '@angular/core/testing';
import { SessionTimeoutSyncChannel } from './session-timeout-sync-channel';
class MockBroadcastChannel {
static instances: MockBroadcastChannel[] = [];
postMessage = jasmine.createSpy('postMessage').and.callFake((message: unknown) => {
MockBroadcastChannel.instances
.filter((instance) => instance !== this && instance.name === this.name)
.forEach((instance) => instance.dispatch(message));
});
close = jasmine.createSpy('close');
private readonly listeners = new Set<(event: MessageEvent<unknown>) => void>();
constructor(public name: string) {
MockBroadcastChannel.instances.push(this);
}
addEventListener(type: string, listener: (event: MessageEvent<unknown>) => void): void {
if (type === 'message') {
this.listeners.add(listener);
}
}
removeEventListener(_type: string, listener: (event: MessageEvent<unknown>) => void): void {
this.listeners.delete(listener);
}
dispatch(data: unknown): void {
this.listeners.forEach((listener) => listener({ data } as MessageEvent<unknown>));
}
}
describe('SessionTimeoutSyncChannel', () => {
let doc: Document;
let original: typeof BroadcastChannel | undefined;
beforeEach(() => {
MockBroadcastChannel.instances = [];
TestBed.configureTestingModule({ providers: [SessionTimeoutSyncChannel] });
doc = TestBed.inject(DOCUMENT);
original = (doc.defaultView as any).BroadcastChannel;
(doc.defaultView as any).BroadcastChannel = MockBroadcastChannel;
});
afterEach(() => {
(doc.defaultView as any).BroadcastChannel = original;
});
it('posts a well-formed event with type, sourceTabId and createdAt', () => {
const channel = TestBed.inject(SessionTimeoutSyncChannel);
channel.open();
channel.post('activity');
const instance = MockBroadcastChannel.instances[0];
expect(instance.postMessage).toHaveBeenCalledTimes(1);
const payload = instance.postMessage.calls.mostRecent().args[0];
expect(payload.type).toBe('activity');
expect(typeof payload.sourceTabId).toBe('string');
expect(typeof payload.createdAt).toBe('number');
});
it('ignores messages originating from its own tab', () => {
const channel = TestBed.inject(SessionTimeoutSyncChannel);
const spy = jasmine.createSpy('messages');
channel.messages$.subscribe(spy);
channel.open();
const instance = MockBroadcastChannel.instances[0];
channel.post('timeout');
instance.dispatch(instance.postMessage.calls.mostRecent().args[0]);
expect(spy).not.toHaveBeenCalled();
});
it('emits validated messages from other tabs', () => {
const channel = TestBed.inject(SessionTimeoutSyncChannel);
const spy = jasmine.createSpy('messages');
channel.messages$.subscribe(spy);
channel.open();
const instance = MockBroadcastChannel.instances[0];
instance.dispatch({ type: 'logout', sourceTabId: 'other-tab', createdAt: 123 });
expect(spy).toHaveBeenCalledWith({ type: 'logout', sourceTabId: 'other-tab', createdAt: 123 });
});
it('drops malformed messages', () => {
const channel = TestBed.inject(SessionTimeoutSyncChannel);
const spy = jasmine.createSpy('messages');
channel.messages$.subscribe(spy);
channel.open();
const instance = MockBroadcastChannel.instances[0];
instance.dispatch({ type: 'nope' });
instance.dispatch(null);
expect(spy).not.toHaveBeenCalled();
});
it('post() does not throw when channel is unavailable', () => {
(doc.defaultView as any).BroadcastChannel = undefined;
const channel = TestBed.inject(SessionTimeoutSyncChannel);
channel.open();
expect(() => channel.post('activity')).not.toThrow();
});
});
lib/core/src/lib/auth/session-timeout/session-timeout-sync-channel.ts
+120
View File
@@ -0,0 +1,120 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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 { DOCUMENT } from '@angular/common';
import { Injectable, OnDestroy, inject } from '@angular/core';
import { Observable, Subject } from 'rxjs';
const SESSION_TIMEOUT_CHANNEL_NAME = 'adf-session-timeout';
export const SESSION_TIMEOUT_SYNC_EVENT_TYPES = ['activity', 'timeout', 'continue', 'logout'] as const;
export type SessionTimeoutSyncEventType = (typeof SESSION_TIMEOUT_SYNC_EVENT_TYPES)[number];
export interface SessionTimeoutSyncEvent {
type: SessionTimeoutSyncEventType;
sourceTabId: string;
createdAt: number;
}
@Injectable()
export class SessionTimeoutSyncChannel implements OnDestroy {
private readonly document = inject(DOCUMENT);
private readonly window = this.document.defaultView;
private readonly tabId = this.createTabId();
private readonly messageSubject = new Subject<SessionTimeoutSyncEvent>();
private channel: BroadcastChannel | undefined;
readonly messages$: Observable<SessionTimeoutSyncEvent> = this.messageSubject.asObservable();
open(): void {
if (this.channel || !this.window?.BroadcastChannel) {
return;
}
this.channel = new this.window.BroadcastChannel(SESSION_TIMEOUT_CHANNEL_NAME);
this.channel.addEventListener('message', this.handleMessage);
}
close(): void {
if (!this.channel) {
return;
}
this.channel.removeEventListener('message', this.handleMessage);
this.channel.close();
this.channel = undefined;
}
post(type: SessionTimeoutSyncEventType): void {
try {
this.channel?.postMessage({
type,
sourceTabId: this.tabId,
createdAt: Date.now()
} satisfies SessionTimeoutSyncEvent);
} catch {
/* empty */
}
}
ngOnDestroy(): void {
this.close();
}
private readonly handleMessage = (event: MessageEvent<unknown>): void => {
const syncEvent = this.parse(event.data);
if (!syncEvent || syncEvent.sourceTabId === this.tabId) {
return;
}
this.messageSubject.next(syncEvent);
};
private parse(value: unknown): SessionTimeoutSyncEvent | undefined {
if (typeof value !== 'object' || value === null) {
return undefined;
}
const syncEvent = value as Partial<SessionTimeoutSyncEvent>;
if (
typeof syncEvent.type === 'string' &&
(SESSION_TIMEOUT_SYNC_EVENT_TYPES as readonly string[]).includes(syncEvent.type) &&
typeof syncEvent.sourceTabId === 'string' &&
typeof syncEvent.createdAt === 'number'
) {
return syncEvent as SessionTimeoutSyncEvent;
}
return undefined;
}
private createTabId(): string {
const crypto = this.window?.crypto;
if (crypto?.randomUUID) {
return crypto.randomUUID();
}
if (crypto?.getRandomValues) {
const buffer = new Uint32Array(4);
crypto.getRandomValues(buffer);
return Array.from(buffer, (value) => value.toString(16)).join('-');
}
return `${Date.now()}-${this.window?.performance?.now?.() ?? 0}`;
}
}
lib/core/src/lib/auth/session-timeout/session-timeout.config.spec.ts
+47
View File
@@ -0,0 +1,47 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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 { normalizeSessionTimeoutOptions, DEFAULT_SESSION_TIMEOUT_OPTIONS } from './session-timeout.config';
describe('normalizeSessionTimeoutOptions', () => {
it('coerces string "true" to boolean enabled', () => {
expect(normalizeSessionTimeoutOptions({ enabled: 'true' }).enabled).toBe(true);
});
it('preserves boolean enabled values', () => {
expect(normalizeSessionTimeoutOptions({ enabled: true }).enabled).toBe(true);
expect(normalizeSessionTimeoutOptions({ enabled: false }).enabled).toBe(false);
});
it('treats non-"true" strings and missing as disabled', () => {
expect(normalizeSessionTimeoutOptions({ enabled: 'false' }).enabled).toBe(false);
expect(normalizeSessionTimeoutOptions({}).enabled).toBe(false);
});
it('parses numeric strings for timeouts', () => {
const result = normalizeSessionTimeoutOptions({ idleTimeoutMs: '1000', dialogTimeoutMs: '2000' });
expect(result.idleTimeoutMs).toBe(1000);
expect(result.dialogTimeoutMs).toBe(2000);
});
it('falls back to defaults for non-positive or invalid numbers', () => {
const result = normalizeSessionTimeoutOptions({ idleTimeoutMs: 0, dialogTimeoutMs: 'abc' });
expect(result.enabled).toBe(DEFAULT_SESSION_TIMEOUT_OPTIONS.enabled);
expect(result.idleTimeoutMs).toBe(DEFAULT_SESSION_TIMEOUT_OPTIONS.idleTimeoutMs);
expect(result.dialogTimeoutMs).toBe(DEFAULT_SESSION_TIMEOUT_OPTIONS.dialogTimeoutMs);
});
});
lib/core/src/lib/auth/session-timeout/session-timeout.config.ts
+63
View File
@@ -0,0 +1,63 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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 { InjectionToken } from '@angular/core';
import { Observable } from 'rxjs';
export const SESSION_TIMEOUT_CONFIG_KEY = 'sessionTimeout';
export interface SessionTimeoutOptions {
enabled?: boolean | string;
idleTimeoutMs?: number | string;
dialogTimeoutMs?: number | string;
startWhen?: () => Observable<boolean>;
}
export interface NormalizedSessionTimeoutOptions {
enabled: boolean;
idleTimeoutMs: number;
dialogTimeoutMs: number;
}
export const DEFAULT_SESSION_TIMEOUT_OPTIONS: NormalizedSessionTimeoutOptions = {
enabled: false,
idleTimeoutMs: 30 * 60 * 1000,
dialogTimeoutMs: 60 * 1000
};
export const SESSION_TIMEOUT_OPTIONS = new InjectionToken<SessionTimeoutOptions>('SESSION_TIMEOUT_OPTIONS');
const toBoolean = (value: boolean | string | undefined): boolean => value === true || value === 'true';
const toPositiveNumber = (value: number | string | undefined, fallback: number): number => {
const parsed = Number(value);
return Number.isFinite(parsed) && parsed > 0 ? parsed : fallback;
};
/**
* Coerces raw session timeout options (which may arrive as strings from app config) into validated values.
*
* @param merged - Raw options merged from defaults, app config and provider input
* @returns Normalized options with a boolean `enabled` flag and positive numeric timeouts
*/
export function normalizeSessionTimeoutOptions(merged: SessionTimeoutOptions): NormalizedSessionTimeoutOptions {
return {
enabled: merged.enabled === undefined ? DEFAULT_SESSION_TIMEOUT_OPTIONS.enabled : toBoolean(merged.enabled),
idleTimeoutMs: toPositiveNumber(merged.idleTimeoutMs, DEFAULT_SESSION_TIMEOUT_OPTIONS.idleTimeoutMs),
dialogTimeoutMs: toPositiveNumber(merged.dialogTimeoutMs, DEFAULT_SESSION_TIMEOUT_OPTIONS.dialogTimeoutMs)
};
}
lib/core/src/lib/auth/session-timeout/session-timeout.service.spec.ts
+537
View File
@@ -0,0 +1,537 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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 { TestBed, fakeAsync, flushMicrotasks, tick } from '@angular/core/testing';
import { Observable, Subject, defer } from 'rxjs';
import { MatDialog } from '@angular/material/dialog';
import { AppConfigService } from '../../app-config/app-config.service';
import { AuthenticationService } from '../services/authentication.service';
import { SessionTimeoutService } from './session-timeout.service';
import { SessionTimeoutOptions, SESSION_TIMEOUT_OPTIONS } from './session-timeout.config';
import { IdleActivityTracker } from './idle-activity-tracker';
import { SessionTimeoutSyncChannel, SessionTimeoutSyncEvent } from './session-timeout-sync-channel';
import { SESSION_TIMEOUT_BACKDROP_CLASS } from './session-timeout-dialog.component';
describe('SessionTimeoutService', () => {
let authService: {
isLoggedIn: jasmine.Spy<() => boolean>;
logout: jasmine.Spy<() => Observable<void>>;
reset: jasmine.Spy<() => void>;
onLogin: Subject<unknown>;
onLogout: Subject<unknown>;
};
let logoutSideEffect: jasmine.Spy;
let appConfigService: {
get: jasmine.Spy<(key: string, fallback: SessionTimeoutOptions) => SessionTimeoutOptions>;
isLoaded: boolean;
onLoad: Subject<unknown>;
};
let dialog: {
open: jasmine.Spy;
};
let tracker: {
start: jasmine.Spy;
stop: jasmine.Spy;
activity$: Subject<void>;
visibilityChange$: Subject<DocumentVisibilityState>;
};
let syncChannel: {
open: jasmine.Spy;
close: jasmine.Spy;
post: jasmine.Spy;
messages$: Subject<SessionTimeoutSyncEvent>;
};
let dialogClosed$: Subject<boolean | undefined>;
let isLoggedIn: boolean;
const configureTestingModule = (sessionTimeoutOptions?: SessionTimeoutOptions, providerOptions?: SessionTimeoutOptions) => {
isLoggedIn = true;
logoutSideEffect = jasmine.createSpy('logoutSideEffect');
authService = {
isLoggedIn: jasmine.createSpy('isLoggedIn').and.callFake(() => isLoggedIn),
logout: jasmine.createSpy('logout').and.callFake(() =>
defer(() => {
logoutSideEffect();
return new Observable<void>((subscriber) => subscriber.complete());
})
),
reset: jasmine.createSpy('reset'),
onLogin: new Subject<unknown>(),
onLogout: new Subject<unknown>()
};
appConfigService = {
get: jasmine.createSpy('get').and.callFake((_key: string, fallback: SessionTimeoutOptions) => sessionTimeoutOptions ?? fallback),
isLoaded: true,
onLoad: new Subject<unknown>()
};
dialogClosed$ = new Subject<boolean | undefined>();
dialog = {
open: jasmine.createSpy('open').and.returnValue({
afterClosed: () => dialogClosed$,
close: (value?: boolean) => {
dialogClosed$.next(value);
dialogClosed$.complete();
}
})
};
tracker = {
start: jasmine.createSpy('start'),
stop: jasmine.createSpy('stop'),
activity$: new Subject<void>(),
visibilityChange$: new Subject<DocumentVisibilityState>()
};
syncChannel = {
open: jasmine.createSpy('open'),
close: jasmine.createSpy('close'),
post: jasmine.createSpy('post'),
messages$: new Subject<SessionTimeoutSyncEvent>()
};
TestBed.configureTestingModule({
providers: [
SessionTimeoutService,
{ provide: SESSION_TIMEOUT_OPTIONS, useValue: providerOptions ?? {} },
{ provide: AuthenticationService, useValue: authService },
{ provide: AppConfigService, useValue: appConfigService },
{ provide: MatDialog, useValue: dialog },
{ provide: IdleActivityTracker, useValue: tracker },
{ provide: SessionTimeoutSyncChannel, useValue: syncChannel }
]
});
};
const startService = ({ emitLoginEvent = true } = {}) => {
const service = TestBed.inject(SessionTimeoutService);
service.start();
if (emitLoginEvent) {
authService.onLogin.next(undefined);
}
return service;
};
afterEach(() => {
TestBed.resetTestingModule();
});
it('should not activate when session timeout is disabled', fakeAsync(() => {
configureTestingModule({ enabled: false, idleTimeoutMs: 1000 });
startService();
tick(1000);
expect(tracker.start).not.toHaveBeenCalled();
expect(syncChannel.open).not.toHaveBeenCalled();
expect(dialog.open).not.toHaveBeenCalled();
expect(authService.logout).not.toHaveBeenCalled();
}));
it('should not activate by default when enabled is not configured', fakeAsync(() => {
configureTestingModule({ idleTimeoutMs: 1000 });
startService();
expect(tracker.start).not.toHaveBeenCalled();
expect(syncChannel.open).not.toHaveBeenCalled();
}));
it('should wait for app config to load before starting', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
appConfigService.isLoaded = false;
startService({ emitLoginEvent: false });
tick(1000);
expect(tracker.start).not.toHaveBeenCalled();
appConfigService.isLoaded = true;
appConfigService.onLoad.next({});
flushMicrotasks();
authService.onLogin.next(undefined);
tick(1000);
expect(tracker.start).toHaveBeenCalledTimes(1);
expect(dialog.open).toHaveBeenCalledTimes(1);
}));
it('should start tracker and open sync channel on login when logged in', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
expect(tracker.start).toHaveBeenCalledTimes(1);
expect(syncChannel.open).toHaveBeenCalledTimes(1);
}));
it('should clear session state when login event fires but user is not logged in', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
isLoggedIn = false;
startService();
tick(1000);
expect(tracker.start).not.toHaveBeenCalled();
expect(dialog.open).not.toHaveBeenCalled();
}));
it('should arm immediately on start when a session is already authenticated', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
// No onLogin event is emitted: the session predates this service.
startService({ emitLoginEvent: false });
expect(tracker.start).toHaveBeenCalledTimes(1);
expect(syncChannel.open).toHaveBeenCalledTimes(1);
tick(1000);
expect(dialog.open).toHaveBeenCalledTimes(1);
}));
it('should not leak handler subscriptions across logout and login cycles', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
expect(tracker.activity$.observers.length).toBe(1);
expect(syncChannel.messages$.observers.length).toBe(1);
authService.onLogout.next({});
flushMicrotasks();
// Logout must tear down the session-scoped subscriptions.
expect(tracker.activity$.observers.length).toBe(0);
expect(syncChannel.messages$.observers.length).toBe(0);
authService.onLogin.next(undefined);
// Re-login arms exactly one fresh set, never two.
expect(tracker.activity$.observers.length).toBe(1);
expect(syncChannel.messages$.observers.length).toBe(1);
}));
it('should not re-arm or duplicate subscriptions when redundant login events fire', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
authService.onLogin.next(undefined);
authService.onLogin.next(undefined);
expect(tracker.start).toHaveBeenCalledTimes(1);
expect(syncChannel.open).toHaveBeenCalledTimes(1);
expect(tracker.activity$.observers.length).toBe(1);
expect(syncChannel.messages$.observers.length).toBe(1);
}));
it('should open dialog after idle timeout with no activity', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
tick(1000);
expect(dialog.open).toHaveBeenCalledTimes(1);
expect(dialog.open).toHaveBeenCalledWith(
jasmine.any(Function),
jasmine.objectContaining({
data: { dialogTimeoutMs: 60000 },
backdropClass: SESSION_TIMEOUT_BACKDROP_CLASS,
disableClose: true,
width: '420px'
})
);
expect(authService.logout).not.toHaveBeenCalled();
}));
it('should reschedule timeout when activity occurs before idle timeout', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
tick(750);
tracker.activity$.next();
tick(750);
expect(dialog.open).not.toHaveBeenCalled();
tick(250);
expect(dialog.open).toHaveBeenCalledTimes(1);
}));
it('should ignore activity while dialog is open', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
tick(1000);
expect(dialog.open).toHaveBeenCalledTimes(1);
tracker.activity$.next();
tick(1000);
expect(dialog.open).toHaveBeenCalledTimes(1);
}));
it('should continue working when dialog is confirmed', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
tick(1000);
dialogClosed$.next(true);
flushMicrotasks();
expect(authService.logout).not.toHaveBeenCalled();
expect(syncChannel.post).toHaveBeenCalledWith('continue');
tick(999);
expect(dialog.open).toHaveBeenCalledTimes(1);
tick(1);
expect(dialog.open).toHaveBeenCalledTimes(2);
}));
it('should run the full logout flow when the dialog auto-closes on timeout', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000, dialogTimeoutMs: 500 });
startService();
tick(1000);
tick(500);
flushMicrotasks();
// An unanswered (timed-out) dialog logs the user out and redirects, same as the explicit "Log out" button.
expect(authService.logout).toHaveBeenCalledTimes(1);
expect(logoutSideEffect).toHaveBeenCalledTimes(1);
expect(authService.reset).not.toHaveBeenCalled();
// Other tabs are told to log out too.
expect(syncChannel.post).toHaveBeenCalledWith('logout');
}));
it('should logout (not redirect) when the user explicitly chooses to log out', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
tick(1000);
dialogClosed$.next(false);
flushMicrotasks();
expect(authService.logout).toHaveBeenCalledTimes(1);
expect(logoutSideEffect).toHaveBeenCalledTimes(1);
}));
it('should logout once when dialog is rejected (idempotent)', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
tick(1000);
dialogClosed$.next(false);
flushMicrotasks();
expect(authService.logout).toHaveBeenCalledTimes(1);
expect(syncChannel.post).toHaveBeenCalledWith('logout');
// Try to logout again
dialogClosed$.next(false);
flushMicrotasks();
expect(authService.logout).toHaveBeenCalledTimes(1);
}));
it('should throttle activity sync posts to one per 1000ms', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 5000 });
startService();
tracker.activity$.next();
tracker.activity$.next();
tracker.activity$.next();
expect(syncChannel.post).toHaveBeenCalledWith('activity');
expect(syncChannel.post).toHaveBeenCalledTimes(1);
tick(999);
tracker.activity$.next();
expect(syncChannel.post).toHaveBeenCalledTimes(1);
tick(1);
tracker.activity$.next();
expect(syncChannel.post).toHaveBeenCalledTimes(2);
}));
it('should continue session when inbound activity message received', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
tick(750);
syncChannel.messages$.next({
type: 'activity',
sourceTabId: 'other-tab',
createdAt: Date.now()
});
tick(750);
expect(dialog.open).not.toHaveBeenCalled();
tick(250);
expect(dialog.open).toHaveBeenCalledTimes(1);
}));
it('should continue session when inbound continue message received', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
tick(1000);
expect(dialog.open).toHaveBeenCalledTimes(1);
// When continue is received, the dialog closes without a value
// We need to complete the dialog observable to avoid the EmptyError
const dialogCloseSpy = jasmine.createSpy('dialogClose');
const mockDialogRef = dialog.open.calls.mostRecent().returnValue;
mockDialogRef.close = dialogCloseSpy;
syncChannel.messages$.next({
type: 'continue',
sourceTabId: 'other-tab',
createdAt: Date.now()
});
expect(dialogCloseSpy).toHaveBeenCalled();
// Session should continue, new timeout scheduled
tick(999);
expect(dialog.open).toHaveBeenCalledTimes(1);
tick(1);
expect(dialog.open).toHaveBeenCalledTimes(2);
}));
it('should open dialog when inbound timeout message received without re-broadcasting', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
const service = startService();
(service as any).lastActivityAt = Date.now() - 500;
syncChannel.messages$.next({
type: 'timeout',
sourceTabId: 'other-tab',
createdAt: Date.now()
});
expect(dialog.open).toHaveBeenCalledTimes(1);
expect(syncChannel.post).not.toHaveBeenCalledWith('timeout');
}));
it('should not open dialog when inbound timeout message is stale', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
const service = startService();
(service as any).lastActivityAt = Date.now();
syncChannel.messages$.next({
type: 'timeout',
sourceTabId: 'other-tab',
createdAt: Date.now() - 1000
});
expect(dialog.open).not.toHaveBeenCalled();
}));
it('should logout when inbound logout message received without re-broadcasting', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
syncChannel.messages$.next({
type: 'logout',
sourceTabId: 'other-tab',
createdAt: Date.now()
});
expect(authService.logout).toHaveBeenCalledTimes(1);
expect(syncChannel.post).not.toHaveBeenCalledWith('logout');
}));
it('should re-evaluate timeout when visibility changes to visible', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
tick(500);
// Simulate elapsed time during hidden state
const service = TestBed.inject(SessionTimeoutService);
(service as any).lastActivityAt = Date.now() - 1001;
tracker.visibilityChange$.next('visible');
flushMicrotasks();
expect(dialog.open).toHaveBeenCalledTimes(1);
}));
it('should clear state and stop tracker on logout event', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
tick(1000);
expect(dialog.open).toHaveBeenCalledTimes(1);
authService.onLogout.next({});
flushMicrotasks();
expect(tracker.stop).toHaveBeenCalledTimes(1);
expect(syncChannel.close).toHaveBeenCalledTimes(1);
}));
it('should tear down resources on ngOnDestroy', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
const service = startService();
tick(1000);
expect(dialog.open).toHaveBeenCalledTimes(1);
service.ngOnDestroy();
expect(tracker.stop).toHaveBeenCalledTimes(1);
expect(syncChannel.close).toHaveBeenCalledTimes(1);
}));
it('should not logout when dialog is closed without explicit choice', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
tick(1000);
dialogClosed$.next(undefined);
flushMicrotasks();
expect(authService.logout).not.toHaveBeenCalled();
}));
it('should use provider options over app config options', fakeAsync(() => {
configureTestingModule({ enabled: false, idleTimeoutMs: 1000 }, { enabled: true, idleTimeoutMs: 500 });
startService();
tick(500);
expect(dialog.open).toHaveBeenCalledTimes(1);
}));
it('should post timeout message when dialog opens', fakeAsync(() => {
configureTestingModule({ enabled: true, idleTimeoutMs: 1000 });
startService();
tick(1000);
expect(syncChannel.post).toHaveBeenCalledWith('timeout');
}));
});
lib/core/src/lib/auth/session-timeout/session-timeout.service.ts
+370
View File
@@ -0,0 +1,370 @@
/*!
* @license
* Copyright © 2005-2025 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* 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, NgZone, OnDestroy, inject } from '@angular/core';
import { MatDialog, MatDialogRef } from '@angular/material/dialog';
import { Subscription } from 'rxjs';
import { take } from 'rxjs/operators';
import { AppConfigService } from '../../app-config/app-config.service';
import { AuthenticationService } from '../services/authentication.service';
import {
SESSION_TIMEOUT_CONFIG_KEY,
SESSION_TIMEOUT_OPTIONS,
SessionTimeoutOptions,
DEFAULT_SESSION_TIMEOUT_OPTIONS,
normalizeSessionTimeoutOptions
} from './session-timeout.config';
import { IdleActivityTracker } from './idle-activity-tracker';
import { SessionTimeoutSyncChannel, SessionTimeoutSyncEvent } from './session-timeout-sync-channel';
import { SessionTimeoutDialogComponent, SessionTimeoutDialogData, SESSION_TIMEOUT_BACKDROP_CLASS } from './session-timeout-dialog.component';
const ACTIVITY_SYNC_THROTTLE_MS = 1000;
@Injectable()
export class SessionTimeoutService implements OnDestroy {
private readonly appConfigService = inject(AppConfigService);
private readonly authService = inject(AuthenticationService);
private readonly dialog = inject(MatDialog);
private readonly ngZone = inject(NgZone);
private readonly providerOptions = inject<SessionTimeoutOptions>(SESSION_TIMEOUT_OPTIONS);
private readonly tracker = inject(IdleActivityTracker);
private readonly syncChannel = inject(SessionTimeoutSyncChannel);
private readonly subscription = new Subscription();
private sessionSubscription: Subscription | undefined;
private timeoutId: ReturnType<typeof setTimeout> | undefined;
private dialogTimeoutId: ReturnType<typeof setTimeout> | undefined;
private dialogRef: MatDialogRef<SessionTimeoutDialogComponent, boolean> | undefined;
private idleTimeoutMs = DEFAULT_SESSION_TIMEOUT_OPTIONS.idleTimeoutMs;
private dialogTimeoutMs = DEFAULT_SESSION_TIMEOUT_OPTIONS.dialogTimeoutMs;
private lastActivityAt = Date.now();
private isStarted = false;
private isSessionActive = false;
private isLoggingOut = false;
private lastActivitySyncAt = 0;
start(): void {
if (this.isStarted) {
return;
}
if (this.appConfigService.isLoaded === false) {
this.appConfigService.onLoad.pipe(take(1)).subscribe(() => {
this.startFromLoadedConfig();
});
return;
}
this.startFromLoadedConfig();
}
ngOnDestroy(): void {
this.clearTimeout();
this.clearDialogTimeout();
this.dialogRef?.close();
this.tracker.stop();
this.syncChannel.close();
this.sessionSubscription?.unsubscribe();
this.subscription.unsubscribe();
}
private startFromLoadedConfig(): void {
if (this.isStarted) {
return;
}
const appConfigOptions = this.appConfigService.get(SESSION_TIMEOUT_CONFIG_KEY, {}) as SessionTimeoutOptions;
const mergedOptions = {
...DEFAULT_SESSION_TIMEOUT_OPTIONS,
...appConfigOptions,
...this.providerOptions
};
const options = normalizeSessionTimeoutOptions(mergedOptions);
if (!options.enabled) {
return;
}
this.idleTimeoutMs = options.idleTimeoutMs;
this.dialogTimeoutMs = options.dialogTimeoutMs;
this.isStarted = true;
this.subscribeToAuthEvents();
if (this.authService.isLoggedIn()) {
this.isSessionActive = true;
this.isLoggingOut = false;
this.activateSessionTimeout();
}
}
private subscribeToAuthEvents(): void {
this.subscription.add(
this.authService.onLogin.subscribe(() => {
const isLoggedIn = this.authService.isLoggedIn();
if (!isLoggedIn) {
this.clearSessionState();
return;
}
this.isSessionActive = true;
this.isLoggingOut = false;
this.activateSessionTimeout();
})
);
this.subscription.add(
this.authService.onLogout.subscribe(() => {
this.clearSessionState();
})
);
}
private activateSessionTimeout(): void {
this.ngZone.runOutsideAngular(() => {
if (!this.canArmSessionTimeout()) {
return;
}
if (this.sessionSubscription) {
this.refreshSession();
return;
}
this.sessionSubscription = new Subscription();
this.tracker.start();
this.syncChannel.open();
this.subscribeToTrackerEvents();
this.subscribeToSyncEvents();
this.refreshSession();
});
}
private subscribeToTrackerEvents(): void {
this.sessionSubscription?.add(
this.tracker.activity$.subscribe(() => {
this.handleActivity();
})
);
this.sessionSubscription?.add(
this.tracker.visibilityChange$.subscribe((state) => {
this.handleVisibilityChange(state);
})
);
}
private subscribeToSyncEvents(): void {
this.sessionSubscription?.add(
this.syncChannel.messages$.subscribe((syncEvent) => {
this.handleSyncEvent(syncEvent);
})
);
}
private handleActivity(): void {
if (this.dialogRef) {
return;
}
this.refreshSession({ shouldNotifyActivity: true });
}
private handleVisibilityChange(state: DocumentVisibilityState): void {
if (state === 'visible') {
this.handleTimeout();
}
}
private handleSyncEvent(syncEvent: SessionTimeoutSyncEvent): void {
if (!this.canArmSessionTimeout() && syncEvent.type !== 'logout') {
return;
}
if (syncEvent.type === 'activity' || syncEvent.type === 'continue') {
this.continueSession();
return;
}
if (syncEvent.type === 'timeout') {
if (syncEvent.createdAt >= this.lastActivityAt) {
this.openContinueWorkingDialog(false);
}
return;
}
this.logout(false);
}
private refreshSession(options?: { shouldNotifyActivity?: boolean }): void {
if (!this.canArmSessionTimeout()) {
return;
}
this.lastActivityAt = Date.now();
if (options?.shouldNotifyActivity === true) {
this.notifyActivity();
}
this.scheduleTimeout();
}
private scheduleTimeout(): void {
this.clearTimeout();
if (!this.canArmSessionTimeout()) {
return;
}
const elapsedMs = Date.now() - this.lastActivityAt;
const remainingMs = Math.max(this.idleTimeoutMs - elapsedMs, 0);
this.timeoutId = setTimeout(() => this.handleTimeout(), remainingMs);
}
private handleTimeout(): void {
if (!this.canArmSessionTimeout()) {
this.clearTimeout();
return;
}
const elapsedMs = Date.now() - this.lastActivityAt;
if (elapsedMs < this.idleTimeoutMs) {
this.scheduleTimeout();
return;
}
this.openContinueWorkingDialog();
}
private openContinueWorkingDialog(shouldNotifyTabs = true): void {
if (this.dialogRef) {
return;
}
if (!this.canArmSessionTimeout()) {
return;
}
this.clearTimeout();
this.dialogRef = this.ngZone.run(() =>
this.dialog.open<SessionTimeoutDialogComponent, SessionTimeoutDialogData, boolean>(SessionTimeoutDialogComponent, {
data: {
dialogTimeoutMs: this.dialogTimeoutMs
},
backdropClass: SESSION_TIMEOUT_BACKDROP_CLASS,
disableClose: true,
width: '420px'
})
);
this.dialogTimeoutId = setTimeout(() => {
this.dialogRef?.close(false);
}, this.dialogTimeoutMs);
if (shouldNotifyTabs) {
this.syncChannel.post('timeout');
}
this.dialogRef
.afterClosed()
.pipe(take(1))
.subscribe((shouldContinueWorking) => {
this.clearDialogTimeout();
this.dialogRef = undefined;
if (shouldContinueWorking === true) {
this.continueSession();
this.syncChannel.post('continue');
return;
}
if (shouldContinueWorking === false) {
this.logout();
}
});
}
private continueSession(): void {
this.closeDialogWithoutAction();
this.refreshSession();
}
private logout(shouldNotifyTabs = true): void {
if (this.isLoggingOut) {
return;
}
this.isSessionActive = false;
this.isLoggingOut = true;
this.clearTimeout();
this.clearDialogTimeout();
if (shouldNotifyTabs) {
this.syncChannel.post('logout');
}
this.ngZone.run(() => this.authService.logout().pipe(take(1)).subscribe());
}
private clearSessionState(): void {
this.isSessionActive = false;
this.dialogRef?.close();
this.clearTimeout();
this.clearDialogTimeout();
this.sessionSubscription?.unsubscribe();
this.sessionSubscription = undefined;
this.tracker.stop();
this.syncChannel.close();
}
private closeDialogWithoutAction(): void {
const dialogRef = this.dialogRef;
if (!dialogRef) {
return;
}
this.dialogRef = undefined;
this.clearDialogTimeout();
dialogRef.close();
}
private canArmSessionTimeout(): boolean {
return this.isSessionActive && !this.isLoggingOut && this.authService.isLoggedIn();
}
private notifyActivity(): void {
const now = Date.now();
if (now - this.lastActivitySyncAt < ACTIVITY_SYNC_THROTTLE_MS) {
return;
}
this.lastActivitySyncAt = now;
this.syncChannel.post('activity');
}
private clearTimeout(): void {
if (this.timeoutId === undefined) {
return;
}
clearTimeout(this.timeoutId);
this.timeoutId = undefined;
}
private clearDialogTimeout(): void {
if (this.dialogTimeoutId === undefined) {
return;
}
clearTimeout(this.dialogTimeoutId);
this.dialogTimeoutId = undefined;
}
}
lib/core/src/lib/i18n/en.json
+6
View File
@@ -667,5 +667,11 @@
"ACTION": "Do you want to proceed?",
"YES_LABEL": "Yes",
"NO_LABEL": "No"
},
"SESSION_TIMEOUT": {
"TITLE": "Are you still working?",
"MESSAGE": "Your session will end in {{seconds}} seconds because there has been no activity.",
"LOG_OUT": "Log out",
"CONTINUE_WORKING": "Continue working"
}
}
lib/process-services/src/lib/form/widgets/people/people.widget.spec.ts
+32 -14
View File
@@ -15,7 +15,7 @@
* limitations under the License.
*/
import { ComponentFixture, TestBed } from '@angular/core/testing';
import { ComponentFixture, fakeAsync, TestBed, tick } from '@angular/core/testing';
import { By } from '@angular/platform-browser';
import { FormFieldTypes, FormFieldModel, FormModel } from '@alfresco/adf-core';
import { Observable, of } from 'rxjs';
@@ -250,6 +250,22 @@ describe('PeopleWidgetComponent', () => {
expect(widget.searchTerm.value).toBe('');
});
it('should call the users API only once when the user types several characters quickly', fakeAsync(() => {
const getWorkflowUsersSpy = spyOn(peopleProcessService, 'getWorkflowUsers').and.returnValue(of([]));
widget.searchTerm.setValue('T');
tick(100);
widget.searchTerm.setValue('Te');
tick(100);
widget.searchTerm.setValue('Tes');
tick(100);
widget.searchTerm.setValue('Test');
tick(300);
expect(getWorkflowUsersSpy).toHaveBeenCalledTimes(1);
expect(getWorkflowUsersSpy).toHaveBeenCalledWith(undefined, 'Test', widget.groupId);
}));
it('should remove user from selectedUsers if user exists', () => {
const users: LightUserRepresentation[] = [
{ id: 1, firstName: 'John', lastName: 'Doe' },
@@ -351,21 +367,21 @@ describe('PeopleWidgetComponent', () => {
expect(element.querySelector('#people-widget-content')).not.toBeNull();
});
it('should show an error message if the user is invalid', async () => {
it('should show an error message if the user is invalid', fakeAsync(() => {
const peopleHTMLElement = element.querySelector<HTMLInputElement>('input');
peopleHTMLElement.focus();
peopleHTMLElement.value = 'K';
peopleHTMLElement.dispatchEvent(new Event('keyup'));
peopleHTMLElement.dispatchEvent(new Event('input'));
tick(300);
fixture.detectChanges();
await fixture.whenStable();
expect(element.querySelector('.adf-error-text')).not.toBeNull();
expect(element.querySelector('.adf-error-text').textContent).toContain('FORM.FIELD.VALIDATOR.INVALID_VALUE');
});
}));
it('should show the people if the typed result match', async () => {
it('should show the people if the typed result match', fakeAsync(() => {
const peopleHTMLElement = element.querySelector<HTMLInputElement>('input');
peopleHTMLElement.focus();
peopleHTMLElement.value = 'T';
@@ -373,13 +389,14 @@ describe('PeopleWidgetComponent', () => {
peopleHTMLElement.dispatchEvent(new Event('input'));
fixture.detectChanges();
await fixture.whenStable();
tick(300);
fixture.detectChanges();
expect(fixture.debugElement.query(By.css('#adf-people-widget-user-0'))).not.toBeNull();
expect(fixture.debugElement.query(By.css('#adf-people-widget-user-1'))).not.toBeNull();
});
}));
it('should hide result list if input is empty', async () => {
it('should hide result list if input is empty', fakeAsync(() => {
const peopleHTMLElement = element.querySelector<HTMLInputElement>('input');
peopleHTMLElement.focus();
peopleHTMLElement.value = '';
@@ -388,14 +405,14 @@ describe('PeopleWidgetComponent', () => {
peopleHTMLElement.dispatchEvent(new Event('input'));
fixture.detectChanges();
await fixture.whenStable();
tick(300);
expect(fixture.debugElement.query(By.css('#adf-people-widget-user-0'))).toBeNull();
});
}));
it('should display two options if we tap one letter', async () => {
it('should display two options if we tap one letter', fakeAsync(() => {
fixture.detectChanges();
await fixture.whenStable();
tick(300);
const peopleHTMLElement = element.querySelector<HTMLInputElement>('input');
peopleHTMLElement.focus();
@@ -404,11 +421,12 @@ describe('PeopleWidgetComponent', () => {
peopleHTMLElement.dispatchEvent(new Event('input'));
fixture.detectChanges();
await fixture.whenStable();
tick(300);
fixture.detectChanges();
expect(fixture.debugElement.query(By.css('#adf-people-widget-user-0'))).not.toBeNull();
expect(fixture.debugElement.query(By.css('#adf-people-widget-user-1'))).not.toBeNull();
});
}));
it('should emit peopleSelected if option is valid', async () => {
const selectEmitSpy = spyOn(widget.peopleSelected, 'emit');
lib/process-services/src/lib/form/widgets/people/people.widget.ts
+2 -1
View File
@@ -23,7 +23,7 @@ import { ReactiveFormsModule, UntypedFormControl } from '@angular/forms';
import { MatChipsModule } from '@angular/material/chips';
import { MatIconModule } from '@angular/material/icon';
import { Observable, of } from 'rxjs';
import { catchError, distinctUntilChanged, map, switchMap } from 'rxjs/operators';
import { catchError, debounceTime, distinctUntilChanged, map, switchMap } from 'rxjs/operators';
import { PeopleProcessService } from '../../../services/people-process.service';
import { LightUserRepresentation } from '@alfresco/js-api';
import { CommonModule } from '@angular/common';
@@ -77,6 +77,7 @@ export class PeopleWidgetComponent extends WidgetComponent implements OnInit {
searchTerms$ = this.searchTerm.valueChanges;
users$: Observable<LightUserRepresentation[]> = this.searchTerms$.pipe(
debounceTime(300),
distinctUntilChanged(),
switchMap((searchTerm) => {
if (!searchTerm) {