alfresco-content-app/projects/aca-shared/src/lib/services/app.extension.service.spec.ts
2024-05-09 15:57:15 +02:00

1848 lines
49 KiB
TypeScript

/*!
* Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Alfresco Example Content Application
*
* This file is part of the Alfresco Example Content Application.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* The Alfresco Example Content Application is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* The Alfresco Example Content Application is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* from Hyland Software. If not, see <http://www.gnu.org/licenses/>.
*/
import { TestBed } from '@angular/core/testing';
import { initialState, LibTestingModule } from '../testing/lib-testing-module';
import { AppExtensionService } from './app.extension.service';
import { Action, Store } from '@ngrx/store';
import { AppStore } from '@alfresco/aca-shared/store';
import {
ContentActionType,
ExtensionConfig,
ExtensionLoaderService,
ExtensionService,
filterEnabled,
mergeArrays,
NavBarGroupRef,
reduceEmptyMenus,
reduceSeparators,
sortByOrder
} from '@alfresco/adf-extensions';
import { AppConfigService, AuthModule, LogService } from '@alfresco/adf-core';
import { provideMockStore } from '@ngrx/store/testing';
import { hasQuickShareEnabled } from '@alfresco/aca-shared/rules';
import { MatIconRegistry } from '@angular/material/icon';
import { DomSanitizer } from '@angular/platform-browser';
import { NodeEntry } from '@alfresco/js-api';
describe('AppExtensionService', () => {
let service: AppExtensionService;
let store: Store<AppStore>;
let extensions: ExtensionService;
let appConfigService: AppConfigService;
let logService: LogService;
let iconRegistry: MatIconRegistry;
let sanitizer: DomSanitizer;
let loader: ExtensionLoaderService;
beforeEach(() => {
TestBed.configureTestingModule({
imports: [LibTestingModule, AuthModule.forRoot()],
providers: [provideMockStore({ initialState })]
});
iconRegistry = TestBed.inject(MatIconRegistry);
sanitizer = TestBed.inject(DomSanitizer);
appConfigService = TestBed.inject(AppConfigService);
store = TestBed.inject(Store);
service = TestBed.inject(AppExtensionService);
service.repository.status.isQuickShareEnabled = true;
extensions = TestBed.inject(ExtensionService);
logService = TestBed.inject(LogService);
loader = TestBed.inject(ExtensionLoaderService);
});
const applyConfig = (config: ExtensionConfig, selection?: boolean) => {
extensions.setup(config);
service.setup(config);
if (selection) {
service.selection = {
isEmpty: false,
count: 1,
libraries: null,
nodes: null
};
}
};
describe('configs', () => {
it('should log an error during setup', async () => {
spyOn(extensions, 'load').and.returnValue(Promise.resolve(null));
spyOn(logService, 'error').and.stub();
await service.load();
expect(service.config).toBeNull();
expect(logService.error).toHaveBeenCalledWith('Extension configuration not found');
});
it('should load content metadata presets', () => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
'content-metadata-presets': [
{
id: 'app.content.metadata.kitten-images',
'kitten-images': {
id: 'app.content.metadata.kittenAspect',
'custom:aspect': '*',
'exif:exif': ['exif:pixelXDimension', 'exif:pixelYDimension']
}
}
]
}
});
expect(service.contentMetadata).toBeDefined();
});
it('should merge two arrays based on [id] keys', () => {
const left = [
{
name: 'item0'
},
{
id: '#1',
name: 'item1'
},
{
id: '#2',
name: 'item2'
}
];
const right = [
{
name: 'extra-1'
},
{
id: '#2',
name: 'custom2',
tag: 'extra tag'
}
];
const result = mergeArrays(left, right);
expect(result).toEqual([
{
id: '#1',
name: 'item1'
},
{
id: '#2',
name: 'custom2',
tag: 'extra tag'
},
{
name: 'item0'
},
{
name: 'extra-1'
}
]);
});
});
describe('documentList', () => {
beforeEach(() => {
extensions.setEvaluators({
notVisible: () => false,
visible: () => true
});
});
it('should support column orders', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
documentList: {
files: [
{
id: 'app.files.thumbnail',
key: '$thumbnail',
type: 'image',
order: 10
},
{
id: 'app.files.name',
key: 'name',
title: 'APP.DOCUMENT_LIST.COLUMNS.NAME',
type: 'text',
order: 20
},
{
id: 'app.files.securityMarks',
key: 'securityMarks',
title: 'GOVERNANCE.SECURITY_MARKS.COLUMNS.NAME',
type: 'text',
order: 55,
rules: {
visible: 'visible'
}
}
],
libraries: [
{
id: 'app.libraries.thumbnail',
key: '$thumbnail',
type: 'image',
order: 20
},
{
id: 'app.libraries.name',
key: 'title',
title: 'APP.DOCUMENT_LIST.COLUMNS.NAME',
type: 'text',
order: 10
}
]
}
}
});
const { libraries } = service.documentListPresets;
const files = service.filesDocumentListPreset$;
files.subscribe((columns) => {
expect(columns.length).toBe(3);
expect(columns[0].id).toBe('app.files.thumbnail');
expect(columns[1].id).toBe('app.files.name');
expect(columns[2].id).toBe('app.files.securityMarks');
done();
});
expect(libraries.length).toBe(2);
expect(libraries[0].id).toBe('app.libraries.name');
expect(libraries[1].id).toBe('app.libraries.thumbnail');
});
it('should ignore column if visibility in rules is false', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
documentList: {
files: [
{
id: 'app.files.thumbnail',
key: '$thumbnail',
type: 'image',
order: 10
},
{
id: 'app.files.name',
key: 'name',
title: 'APP.DOCUMENT_LIST.COLUMNS.NAME',
type: 'text',
order: 20
},
{
id: 'app.files.securityMarks',
key: 'securityMarks',
title: 'GOVERNANCE.SECURITY_MARKS.COLUMNS.NAME',
type: 'text',
order: 55,
rules: {
visible: 'notVisible'
}
}
]
}
}
});
const files = service.filesDocumentListPreset$;
files.subscribe((columns) => {
expect(columns.length).toBe(2);
expect(columns[0].id).toBe('app.files.thumbnail');
expect(columns[1].id).toBe('app.files.name');
done();
});
});
});
describe('actions', () => {
beforeEach(() => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
actions: [
{
id: 'aca:actions/create-folder',
type: 'CREATE_FOLDER',
payload: 'folder-name'
}
]
});
});
it('should load actions from the config', () => {
expect(extensions.actions.length).toBe(1);
});
it('should find action by id', () => {
const action = extensions.getActionById('aca:actions/create-folder');
expect(action).toBeTruthy();
expect(action.type).toBe('CREATE_FOLDER');
expect(action.payload).toBe('folder-name');
});
it('should not find action by id', () => {
const action = extensions.getActionById('missing');
expect(action).toBeFalsy();
});
it('should run the action via store', () => {
spyOn(store, 'dispatch').and.stub();
service.runActionById('aca:actions/create-folder');
expect(store.dispatch).toHaveBeenCalledWith({
type: 'CREATE_FOLDER',
payload: 'folder-name',
configuration: undefined
} as Action);
});
it('should still invoke store if action is missing', () => {
spyOn(store, 'dispatch').and.stub();
service.runActionById('missing');
expect(store.dispatch).toHaveBeenCalled();
});
});
describe('expressions', () => {
it('should eval static value', () => {
const value = extensions.runExpression('hello world');
expect(value).toBe('hello world');
});
it('should eval string as an expression', () => {
const value = extensions.runExpression('$( "hello world" )');
expect(value).toBe('hello world');
});
it('should eval expression with no context', () => {
const value = extensions.runExpression('$( 1 + 1 )');
expect(value).toBe(2);
});
it('should eval expression with context', () => {
const context = {
a: 'hey',
b: 'there'
};
const expression = '$( context.a + " " + context.b + "!" )';
const value = extensions.runExpression(expression, context);
expect(value).toBe('hey there!');
});
});
describe('auth guards', () => {
let guard1;
let guard2;
beforeEach(() => {
guard1 = {};
guard2 = {};
extensions.authGuards['guard1'] = guard1;
extensions.authGuards['guard2'] = guard2;
});
it('should fetch auth guards by ids', () => {
const guards = extensions.getAuthGuards(['guard2', 'guard1']);
expect(guards.length).toBe(2);
expect(guards[0]).toEqual(guard1);
expect(guards[1]).toEqual(guard2);
});
it('should not fetch auth guards for missing ids', () => {
const guards = extensions.getAuthGuards(null);
expect(guards).toEqual([]);
});
it('should fetch only known guards', () => {
const guards = extensions.getAuthGuards(['missing', 'guard1']);
expect(guards.length).toBe(1);
expect(guards[0]).toEqual(guard1);
});
});
describe('content actions', () => {
it('should load content actions from the config', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
toolbar: [
{
id: 'aca:toolbar/separator-1',
order: 1,
type: ContentActionType.default,
title: 'action1'
},
{
id: 'aca:toolbar/separator-2',
order: 2,
type: ContentActionType.default,
title: 'action2'
}
]
}
});
service.getAllowedToolbarActions().subscribe((actions) => {
expect(actions.length).toBe(2);
done();
});
});
it('should sort content actions by order', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
toolbar: [
{
id: 'aca:toolbar/separator-2',
order: 2,
type: ContentActionType.default,
title: 'action2'
},
{
id: 'aca:toolbar/separator-1',
order: 1,
type: ContentActionType.default,
title: 'action1'
}
]
}
});
service.getAllowedToolbarActions().subscribe((actions) => {
expect(actions.length).toBe(2);
expect(actions[0].id).toBe('aca:toolbar/separator-1');
expect(actions[1].id).toBe('aca:toolbar/separator-2');
done();
});
});
});
describe('open with', () => {
it('should load [open with] actions for the viewer', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
viewer: {
openWith: [
{
disabled: false,
id: 'aca:viewer/action1',
order: 100,
icon: 'build',
title: 'Snackbar',
type: ContentActionType.default,
actions: {
click: 'aca:actions/info'
}
}
]
}
}
});
service.getOpenWithActions().subscribe((actions) => {
expect(actions.length).toBe(1);
done();
});
});
it('should load only enabled [open with] actions for the viewer', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
viewer: {
openWith: [
{
id: 'aca:viewer/action2',
order: 200,
icon: 'build',
title: 'Snackbar',
type: ContentActionType.default,
actions: {
click: 'aca:actions/info'
}
},
{
disabled: true,
id: 'aca:viewer/action1',
order: 100,
icon: 'build',
title: 'Snackbar',
type: ContentActionType.default,
actions: {
click: 'aca:actions/info'
}
}
]
}
}
});
service.getOpenWithActions().subscribe((actions) => {
expect(actions.length).toBe(1);
expect(actions[0].id).toBe('aca:viewer/action2');
done();
});
});
it('should sort [open with] actions by order', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
viewer: {
openWith: [
{
id: 'aca:viewer/action2',
order: 200,
icon: 'build',
title: 'Snackbar',
type: ContentActionType.default,
actions: {
click: 'aca:actions/info'
}
},
{
id: 'aca:viewer/action1',
order: 100,
icon: 'build',
title: 'Snackbar',
type: ContentActionType.default,
actions: {
click: 'aca:actions/info'
}
}
]
}
}
});
service.getOpenWithActions().subscribe((actions) => {
expect(actions.length).toBe(2);
expect(actions[0].id).toBe('aca:viewer/action1');
expect(actions[1].id).toBe('aca:viewer/action2');
done();
});
});
});
describe('create', () => {
it('should load [create] actions from config', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
create: [
{
id: 'aca:create/folder',
order: 100,
icon: 'create_new_folder',
title: 'ext: Create Folder',
type: ContentActionType.default
}
]
}
});
service.getCreateActions().subscribe((actions) => {
expect(actions.length).toBe(1);
done();
});
});
it('should sort [create] actions by order', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
create: [
{
id: 'aca:create/folder',
order: 100,
icon: 'create_new_folder',
title: 'ext: Create Folder',
type: ContentActionType.default
},
{
id: 'aca:create/folder-2',
order: 10,
icon: 'create_new_folder',
title: 'ext: Create Folder',
type: ContentActionType.default
}
]
}
});
service.getCreateActions().subscribe((actions) => {
expect(actions.length).toBe(2);
expect(actions[0].id).toBe('aca:create/folder-2');
expect(actions[1].id).toBe('aca:create/folder');
done();
});
});
});
describe('sorting', () => {
it('should sort by provided order', () => {
const sorted = [
{ id: '1', order: 10 },
{ id: '2', order: 1 },
{ id: '3', order: 5 }
].sort(sortByOrder);
expect(sorted[0].id).toBe('2');
expect(sorted[1].id).toBe('3');
expect(sorted[2].id).toBe('1');
});
it('should use implicit order', () => {
const sorted = [{ id: '3' }, { id: '2' }, { id: '1', order: 1 }].sort(sortByOrder);
expect(sorted[0].id).toBe('1');
expect(sorted[1].id).toBe('3');
expect(sorted[2].id).toBe('2');
});
});
describe('filtering', () => {
it('should filter out disabled items', () => {
const items = [{ id: 1, disabled: true }, { id: 2 }, { id: 3, disabled: true }].filter(filterEnabled);
expect(items.length).toBe(1);
expect(items[0].id).toBe(2);
});
it('should filter out all disabled items', () => {
const items: any[] = [
{ id: '1', disabled: true },
{
id: '2',
someItems: [{ id: '21', disabled: true }, { id: '22', disabled: false }, { id: '23' }],
someObjectProp: {
innerItems: [{ id: '24' }, { id: '25', disabled: true }]
}
},
{ id: 3, disabled: true }
];
const result = service.filterDisabled(items);
expect(result.length).toBe(1);
expect(result[0].id).toBe('2');
expect(result[0].someItems.length).toBe(2);
expect(result[0].someItems[0].id).toBe('22');
expect(result[0].someItems[1].id).toBe('23');
expect(result[0].someObjectProp).not.toBeNull();
expect(result[0].someObjectProp.innerItems.length).toBe(1);
expect(result[0].someObjectProp.innerItems[0].id).toBe('24');
});
});
it('should reduce duplicate separators', () => {
const actions = [
{ id: '1', type: ContentActionType.button },
{ id: '2', type: ContentActionType.separator },
{ id: '3', type: ContentActionType.separator },
{ id: '4', type: ContentActionType.separator },
{ id: '5', type: ContentActionType.button }
];
const result = actions.reduce(reduceSeparators, []);
expect(result.length).toBe(3);
expect(result[0].id).toBe('1');
expect(result[1].id).toBe('2');
expect(result[2].id).toBe('5');
});
it('should trim trailing separators', () => {
const actions = [
{ id: '1', type: ContentActionType.button },
{ id: '2', type: ContentActionType.separator }
];
const result = actions.reduce(reduceSeparators, []);
expect(result.length).toBe(1);
expect(result[0].id).toBe('1');
});
it('should reduce empty menus', () => {
const actions = [
{ id: '1', type: ContentActionType.button },
{
id: '2',
type: ContentActionType.menu
},
{
id: '3',
type: ContentActionType.menu,
children: [{ id: '3-1', type: ContentActionType.button }]
}
];
const result = actions.reduce(reduceEmptyMenus, []);
expect(result.length).toBe(2);
expect(result[0].id).toBe('1');
expect(result[1].id).toBe('3');
});
describe('getApplicationNavigation', () => {
beforeEach(() => {
extensions.setEvaluators({
notVisible: () => false,
isVisible: () => true
});
});
it('should create navigation data', () => {
const navigation = service.getApplicationNavigation([
{ items: [{ route: 'route1' }, { route: 'route2' }] },
{ items: [{ children: [{ route: 'route3' }] }] }
]);
expect(navigation).toEqual([
{
items: [
{ route: 'route1', url: '/route1' },
{ route: 'route2', url: '/route2' }
]
},
{
items: [{ children: [{ route: 'route3', url: '/route3' }] }]
}
] as NavBarGroupRef[]);
});
it('should filter out disabled items', () => {
const navigation = service.getApplicationNavigation([
{ items: [{ route: 'route1' }, { route: 'route2', disabled: true }] },
{ items: [{ children: [{ route: 'route3', disabled: true }] }] }
]);
expect(navigation).toEqual([{ items: [{ route: 'route1', url: '/route1' }] }, { items: [{ children: [] }] }] as NavBarGroupRef[]);
});
it('should filter out items based on rule', () => {
const navigation = service.getApplicationNavigation([
{
id: 'groupId',
items: [
{
id: 'itemId',
route: 'route1',
rules: { visible: 'notVisible' }
}
]
}
]);
expect(navigation).toEqual([{ id: 'groupId', items: [] }]);
});
it('should filter out group based on rule', () => {
const navigation = service.getApplicationNavigation([
{
id: 'group1',
rules: {
visible: 'notVisible'
},
items: [
{
id: 'item1',
route: 'route1'
}
]
},
{
id: 'group2',
items: []
}
]);
expect(navigation).toEqual([{ id: 'group2', items: [] }]);
});
});
describe('getSharedLinkViewerToolbarActions', () => {
it('should get shared link viewer actions', (done) => {
const actions = [
{
id: 'id',
type: ContentActionType.button,
icon: 'icon',
actions: {
click: 'click'
}
}
];
const expectedActions = [
{
id: 'id',
type: ContentActionType.button,
icon: 'icon',
actions: {
click: 'click'
},
disabled: false
}
];
applyConfig(
{
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
viewer: {
shared: {
toolbarActions: actions
}
}
}
},
true
);
service.getSharedLinkViewerToolbarActions().subscribe((sharedLinkViewerToolbarActions) => {
expect(sharedLinkViewerToolbarActions).toEqual(expectedActions);
done();
});
});
});
describe('withCredentials', () => {
it('should set `withCredentials` to true from app configuration', () => {
appConfigService.config = {
auth: { withCredentials: true }
};
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0'
});
expect(service.withCredentials).toBe(true);
});
it('should set `withCredentials` to false from app configuration', () => {
appConfigService.config = {
auth: { withCredentials: false }
};
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0'
});
expect(service.withCredentials).toBe(false);
});
it('should set `withCredentials` to false as default value if no app configuration', () => {
appConfigService.config = {};
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0'
});
expect(service.withCredentials).toBe(false);
});
});
describe('getHeaderActions', () => {
it('should load user actions from the config', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
header: [
{
id: 'header.action.separator.1',
order: 1,
type: ContentActionType.default
},
{
id: 'header.action.separator.2',
order: 2,
type: ContentActionType.default
}
]
}
});
service.getHeaderActions().subscribe((headerActions) => {
expect(headerActions.length).toBe(2);
done();
});
});
it('should sort header actions by order', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
header: [
{
id: 'header.action.1',
order: 2,
type: ContentActionType.button
},
{
id: 'header.action.2',
order: 1,
type: ContentActionType.button
}
]
}
});
service.getHeaderActions().subscribe((headerActions) => {
expect(headerActions.length).toBe(2);
expect(headerActions[0].id).toBe('header.action.2');
expect(headerActions[1].id).toBe('header.action.1');
done();
});
});
it('should sort header menu children actions by order', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
header: [
{
id: 'header.action.1',
order: 1,
type: ContentActionType.menu,
children: [
{
id: 'header.action.1',
order: 2,
type: ContentActionType.button
},
{
id: 'header.action.2',
order: 1,
type: ContentActionType.button
}
]
}
]
}
});
service.getHeaderActions().subscribe((headerActions) => {
expect(headerActions.length).toBe(1);
expect(headerActions[0].children[0].id).toBe('header.action.2');
expect(headerActions[0].children[1].id).toBe('header.action.1');
done();
});
});
});
describe('search', () => {
let config: ExtensionConfig;
beforeEach(() => {
extensions.setEvaluators({
visible: () => true,
notVisible: () => false
});
config = {
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
search: [
{
id: 'app.search',
order: 100,
name: 'default',
default: true,
filterWithContains: true,
'app:fields': ['cm:name', 'cm:title', 'cm:description', 'TEXT', 'TAG'],
include: ['path', 'allowableOperations', 'properties'],
categories: [
{
id: 'size',
name: 'SEARCH.CATEGORIES.SIZE',
enabled: true
}
]
},
{
id: 'app.search-1',
order: 200,
name: 'search extension 1',
rules: {
visible: 'visible'
},
default: false
},
{
id: 'app.search-2',
order: 200,
name: 'search extension 2',
disabled: true
},
{
id: 'app.search-3',
order: 300,
name: 'search extension 3',
rules: {
visible: 'notVisible'
}
}
]
}
};
});
it('should load the search extension', () => {
applyConfig(config);
expect(service.search.length).toBe(2);
expect(service.search[0].id).toBe('app.search');
expect(service.search[1].id).toBe('app.search-1');
});
it('should not load the disabled search extension', () => {
applyConfig(config);
expect(service.search.find(({ id }) => id === 'app.search-2')).toBe(undefined, 'disabled configuration shown in the result');
});
it('should not load the not visible search extension', () => {
applyConfig(config);
expect(service.search.find(({ id }) => id === 'app.search-3')).toBe(undefined, 'not visible configuration shown in the result');
});
it('should contain category if it has no rules field', () => {
applyConfig(config);
const search = service.search[0];
expect(search.categories.length).toBe(1);
expect(search.categories[0].id).toBe('size');
});
it('should contain category if it has no visible field in rules', () => {
config.features.search[0].categories[0].rules = {};
applyConfig(config);
const search = service.search[0];
expect(search.categories.length).toBe(1);
expect(search.categories[0].id).toBe('size');
});
it('should contain category if it has visible field and extensions.evaluateRule returns true', () => {
spyOn(extensions, 'evaluateRule').and.returnValue(true);
const visible = 'test';
config.features.search[0].categories[0].rules = { visible };
applyConfig(config);
const search = service.search[0];
expect(extensions.evaluateRule).toHaveBeenCalledWith(visible, service);
expect(search.categories.length).toBe(1);
expect(search.categories[0].id).toBe('size');
});
it('should not contain category if it has visible field and extensions.evaluateRule returns false', () => {
spyOn(extensions, 'evaluateRule').and.returnValue(false);
const visible = 'test';
config.features.search[0].categories[0].rules = { visible };
applyConfig(config);
const search = service.search[0];
expect(extensions.evaluateRule).toHaveBeenCalledWith(visible, service);
expect(search.categories.length).toBe(0);
});
});
describe('rules', () => {
it('should evaluate rule', () => {
extensions.setEvaluators({
rule1: () => true
});
expect(service.evaluateRule('rule1')).toBeTrue();
});
it('should not evaluate missing rule and return [false] by default', () => {
expect(service.evaluateRule('missing')).toBeFalse();
});
it('should confirm the rule is defined', () => {
extensions.setEvaluators({
rule1: () => true
});
expect(service.isRuleDefined('rule1')).toBeTrue();
});
it('should not confirm the rule is defined', () => {
expect(service.isRuleDefined(null)).toBeFalse();
expect(service.isRuleDefined('')).toBeFalse();
expect(service.isRuleDefined('missing')).toBeFalse();
});
it('should allow node preview', () => {
extensions.setEvaluators({
'app.canPreview': () => true
});
service.viewerRules.canPreview = 'app.canPreview';
expect(service.canPreviewNode(null)).toBeTrue();
});
it('should allow node preview with no rules', () => {
service.viewerRules = {};
expect(service.canPreviewNode(null)).toBeTrue();
});
it('should not allow node preview', () => {
extensions.setEvaluators({
'app.canPreview': () => false
});
service.viewerRules.canPreview = 'app.canPreview';
expect(service.canPreviewNode(null)).toBeFalse();
});
it('should allow viewer navigation', () => {
extensions.setEvaluators({
'app.allowNavigation': () => true
});
service.viewerRules.showNavigation = 'app.allowNavigation';
expect(service.canShowViewerNavigation(null)).toBeTrue();
});
it('should allow viewer navigation with no rules', () => {
service.viewerRules.showNavigation = null;
expect(service.canShowViewerNavigation(null)).toBeTrue();
});
it('should not allow viewer navigation', () => {
extensions.setEvaluators({
'app.allowNavigation': () => false
});
service.viewerRules.showNavigation = 'app.allowNavigation';
expect(service.canShowViewerNavigation(null)).toBeFalse();
});
it('should confirm the viewer extension is disabled explicitly', () => {
const extension = {
disabled: true
};
expect(service.isViewerExtensionDisabled(extension)).toBeTrue();
});
it('should confirm the viewer extension is disabled via rules', () => {
extensions.setEvaluators({
'viewer.disabled': () => true
});
const extension = {
disabled: false,
rules: {
disabled: 'viewer.disabled'
}
};
expect(service.isViewerExtensionDisabled(extension)).toBeTrue();
});
it('should confirm viewer extension is not disabled by default', () => {
expect(service.isViewerExtensionDisabled({})).toBeFalse();
});
});
describe('rule disable', () => {
beforeEach(() => {
extensions.setEvaluators({
isEnabled: () => true,
isDisabled: () => false
});
});
const actions = [
{
id: 'id1',
type: ContentActionType.button,
icon: 'icon1',
actions: {
click: 'click'
},
rules: {
enabled: 'isDisabled'
}
},
{
id: 'id2',
type: ContentActionType.button,
icon: 'icon2',
actions: {
click: 'click'
},
rules: {
enabled: 'isEnabled'
}
}
];
const expectedActionsWithChildren = [
{
id: 'id1',
type: ContentActionType.button,
icon: 'icon1',
actions: {
click: 'click'
},
rules: {
enabled: 'isDisabled'
},
disabled: true,
children: []
},
{
id: 'id2',
type: ContentActionType.button,
icon: 'icon2',
actions: {
click: 'click'
},
rules: {
enabled: 'isEnabled'
},
disabled: false,
children: []
}
];
const expectedActionsWithoutChildren = [
{
id: 'id1',
type: ContentActionType.button,
icon: 'icon1',
actions: {
click: 'click'
},
rules: {
enabled: 'isDisabled'
},
disabled: true
},
{
id: 'id2',
type: ContentActionType.button,
icon: 'icon2',
actions: {
click: 'click'
},
rules: {
enabled: 'isEnabled'
},
disabled: false
}
];
it('should set the action disabled for create actions', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
create: actions
}
});
service.getCreateActions().subscribe((createActions) => {
expect(createActions).toEqual(expectedActionsWithChildren);
done();
});
});
it('should set the action disabled for sidebar actions', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
sidebar: {
toolbar: actions
}
}
});
service.getAllowedSidebarActions().subscribe((serviceActions) => {
expect(serviceActions).toEqual(expectedActionsWithoutChildren);
done();
});
});
it('should set the action disabled for toolbar actions', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
toolbar: actions
}
});
service.getAllowedToolbarActions().subscribe((serviceActions) => {
expect(serviceActions).toEqual(expectedActionsWithoutChildren);
done();
});
});
it('should set the action disabled for viewer toolbar actions', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
viewer: { toolbarActions: actions }
}
});
service.getViewerToolbarActions().subscribe((serviceActions) => {
expect(serviceActions).toEqual(expectedActionsWithoutChildren);
done();
});
});
it('should set the action disabled for shared link viewer toolbar actions', (done) => {
applyConfig(
{
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
viewer: {
shared: {
toolbarActions: actions
}
}
}
},
true
);
service.getSharedLinkViewerToolbarActions().subscribe((serviceActions) => {
expect(serviceActions).toEqual(expectedActionsWithoutChildren);
done();
});
});
it('should set the action disabled for header actions', (done) => {
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
header: actions
}
});
service.getHeaderActions().subscribe((serviceActions) => {
expect(serviceActions).toEqual(expectedActionsWithoutChildren);
done();
});
});
it('should set the action disabled for context menu actions', (done) => {
applyConfig(
{
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
contextMenu: actions
}
},
true
);
service.getAllowedContextMenuActions().subscribe((serviceActions) => {
expect(serviceActions).toEqual(expectedActionsWithoutChildren);
done();
});
});
});
describe('quick share', () => {
let config: ExtensionConfig;
beforeEach(() => {
const actions = [
{
id: 'id1',
type: ContentActionType.button,
icon: 'icon1',
actions: {
click: 'click'
},
rules: {
visible: 'repository.isQuickShareEnabled'
}
}
];
config = {
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
contextMenu: [...actions],
toolbar: [...actions],
viewer: {
toolbarActions: [...actions]
},
sidebar: {
toolbar: [...actions]
}
}
};
applyConfig(config, true);
extensions.setEvaluators({
'repository.isQuickShareEnabled': hasQuickShareEnabled
});
});
it('should display context menu action if quick share is enabled', (done) => {
service.repository.status.isQuickShareEnabled = true;
service.getAllowedContextMenuActions().subscribe((actions) => {
expect(actions.length).toEqual(1);
done();
});
});
it('should hide context menu action if quick share is disabled', (done) => {
service.repository.status.isQuickShareEnabled = false;
service.getAllowedContextMenuActions().subscribe((actions) => {
expect(actions.length).toEqual(0);
done();
});
});
it('should display toolbar action if quick share is enabled', (done) => {
service.repository.status.isQuickShareEnabled = true;
service.getAllowedToolbarActions().subscribe((actions) => {
expect(actions.length).toEqual(1);
done();
});
});
it('should hide toolbar action if quick share is disabled', (done) => {
service.repository.status.isQuickShareEnabled = false;
service.getAllowedToolbarActions().subscribe((actions) => {
expect(actions.length).toEqual(0);
done();
});
});
it('should display viewer toolbar action if quick share is enabled', (done) => {
service.repository.status.isQuickShareEnabled = true;
service.getViewerToolbarActions().subscribe((actions) => {
expect(actions.length).toEqual(1);
done();
});
});
it('should hide viewer toolbar action if quick share is disabled', (done) => {
service.repository.status.isQuickShareEnabled = false;
service.getViewerToolbarActions().subscribe((actions) => {
expect(actions.length).toEqual(0);
done();
});
});
it('should display sidebar action if quick share is enabled', (done) => {
service.repository.status.isQuickShareEnabled = true;
service.getAllowedSidebarActions().subscribe((actions) => {
expect(actions.length).toEqual(1);
done();
});
});
it('should hide sidebar action if quick share is disabled', (done) => {
service.repository.status.isQuickShareEnabled = false;
service.getAllowedSidebarActions().subscribe((actions) => {
expect(actions.length).toEqual(0);
done();
});
});
});
describe('custom icons', () => {
it('should register custom icons', () => {
spyOn(iconRegistry, 'addSvgIconInNamespace').and.stub();
const rawUrl = './assets/images/ft_ic_ms_excel.svg';
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
icons: [
{
id: 'adf:excel_thumbnail',
value: rawUrl
}
]
}
});
const url = sanitizer.bypassSecurityTrustResourceUrl(rawUrl);
expect(iconRegistry.addSvgIconInNamespace).toHaveBeenCalledWith('adf', 'excel_thumbnail', url);
});
it('should warn if icon has no url path', () => {
const warn = spyOn(logService, 'warn').and.stub();
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
icons: [
{
id: 'adf:excel_thumbnail'
}
]
}
});
expect(warn).toHaveBeenCalledWith('Missing icon value for "adf:excel_thumbnail".');
});
it('should warn if icon has incorrect format', () => {
const warn = spyOn(logService, 'warn').and.stub();
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
icons: [
{
id: 'incorrect.format',
value: './assets/images/ft_ic_ms_excel.svg'
}
]
}
});
expect(warn).toHaveBeenCalledWith(`Incorrect icon id format.`);
});
});
it('should resolve main action', (done) => {
extensions.setEvaluators({
'action.enabled': () => true
});
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
mainAction: {
id: 'action-id',
title: 'action-title',
type: 'button',
rules: {
visible: 'action.enabled'
}
}
}
});
service.getMainAction().subscribe((action) => {
expect(action.id).toEqual('action-id');
done();
});
});
it('should get badges from config', (done) => {
extensions.setEvaluators({
'action.enabled': () => true
});
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
badges: [
{
id: 'action1-id',
icon: 'warning',
tooltip: 'test tooltip',
type: 'custom',
rules: {
visible: 'action.enabled'
}
},
{
id: 'action2-id',
icon: 'settings',
tooltip: 'test tooltip2',
type: 'custom',
rules: {
visible: 'action.enabled'
}
}
]
}
});
const node: NodeEntry = {
entry: {
id: 'testId',
name: 'testName',
nodeType: 'test',
isFile: true,
isFolder: false,
modifiedAt: undefined,
createdAt: undefined,
modifiedByUser: undefined,
createdByUser: undefined
}
};
service.getBadges(node).subscribe((badges) => {
expect(badges.length).toBe(2);
expect(badges[0].id).toEqual('action1-id');
expect(badges[1].id).toEqual('action2-id');
done();
});
});
it('should get custom metadata panels from config', (done) => {
extensions.setEvaluators({
'action.enabled': () => true
});
applyConfig({
$id: 'test',
$name: 'test',
$version: '1.0.0',
$license: 'MIT',
$vendor: 'Good company',
$runtime: '1.5.0',
features: {
customMetadataPanels: [
{
id: 'panel1-id',
title: 'testTitle',
component: 'testComponent1',
rules: {
visible: 'action.enabled'
}
},
{
id: 'panel2-id',
title: 'testTitle2',
component: 'testComponent2',
rules: {
visible: 'action.enabled'
}
}
]
}
});
const node: NodeEntry = {
entry: {
id: 'testId',
name: 'testName',
nodeType: 'test',
isFile: true,
isFolder: false,
modifiedAt: undefined,
createdAt: undefined,
modifiedByUser: undefined,
createdByUser: undefined
}
};
service.getCustomMetadataPanels(node).subscribe((panels) => {
expect(panels.length).toBe(2);
expect(panels[0].id).toEqual('panel1-id');
expect(panels[1].id).toEqual('panel2-id');
done();
});
});
it('should update sidebar actions correctly', () => {
spyOn(loader, 'getContentActions').and.callThrough();
service.updateSidebarActions();
expect(loader.getContentActions).toHaveBeenCalledWith(service.config, 'features.sidebar.toolbar');
});
});