[ACS-5279] improved plugin handling (#3332)

This commit is contained in:
Denys Vuika
2023-07-12 08:27:28 +01:00
committed by GitHub
parent 1532d65a5b
commit 1963747590
11 changed files with 46 additions and 349 deletions

View File

@@ -1,118 +0,0 @@
/*!
* Copyright © 2005-2023 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 { AppConfigService } from '@alfresco/adf-core';
import { AlfrescoOfficeExtensionService } from './alfresco-office-extension.service';
import { provideMockStore } from '@ngrx/store/testing';
import { initialState, LibTestingModule } from '../testing/lib-testing-module';
import { Subject } from 'rxjs';
describe('AlfrescoOfficeExtensionService', () => {
let appConfig: AppConfigService;
let service: AlfrescoOfficeExtensionService;
let onLoad$: Subject<any>;
const mock = () => {
let storage: { [key: string]: any } = {};
return {
getItem: (key: string) => (key in storage ? storage[key] : null),
setItem: (key: string, value: any) => (storage[key] = value || ''),
removeItem: (key: string) => delete storage[key],
clear: () => (storage = {})
};
};
beforeEach(() => {
TestBed.configureTestingModule({
imports: [LibTestingModule],
providers: [provideMockStore({ initialState })]
});
onLoad$ = new Subject();
appConfig = TestBed.inject(AppConfigService);
appConfig.onLoad = onLoad$;
appConfig.config.aosPlugin = true;
service = TestBed.inject(AlfrescoOfficeExtensionService);
Object.defineProperty(window, 'localStorage', { value: mock() });
});
it('should enable plugin on load', () => {
spyOn(localStorage, 'getItem').and.returnValue(null);
spyOn(localStorage, 'setItem');
onLoad$.next({
plugins: {
aosPlugin: true
}
});
TestBed.inject(AlfrescoOfficeExtensionService);
expect(localStorage.setItem).toHaveBeenCalledWith('aosPlugin', 'true');
});
it('should disable plugin on load', () => {
spyOn(localStorage, 'removeItem');
onLoad$.next({
plugins: {
aosPlugin: false
}
});
TestBed.inject(AlfrescoOfficeExtensionService);
expect(localStorage.removeItem).toHaveBeenCalledWith('aosPlugin');
});
it('Should initialize the localStorage with the item aosPlugin true if not present', () => {
expect(localStorage.getItem('aosPlugin')).toBeNull('The localStorage aosPlugin is not null');
service.enablePlugin();
expect(localStorage.getItem('aosPlugin')).toBe('true');
expect(service.isAosPluginEnabled()).toBe(true);
});
it('Should not change the item aosPlugin value if false', () => {
localStorage.setItem('aosPlugin', 'false');
service.enablePlugin();
expect(localStorage.getItem('aosPlugin')).toBe('false');
expect(service.isAosPluginEnabled()).toBe(false);
});
it('Should not change the item aosPlugin value if true', () => {
localStorage.setItem('aosPlugin', 'true');
service.enablePlugin();
expect(localStorage.getItem('aosPlugin')).toBe('true');
expect(service.isAosPluginEnabled()).toBe(true);
});
it('Should change the item aosPlugin disabled', () => {
localStorage.setItem('aosPlugin', 'true');
service.disablePlugin();
expect(localStorage.getItem('aosPlugin')).toBeNull();
expect(service.isAosPluginEnabled()).toBe(false);
});
});

View File

@@ -1,61 +0,0 @@
/*!
* Copyright © 2005-2023 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 { Injectable } from '@angular/core';
import { AppConfigService } from '@alfresco/adf-core';
import { map, take } from 'rxjs/operators';
@Injectable({
providedIn: 'root'
})
export class AlfrescoOfficeExtensionService {
constructor(private appConfigService: AppConfigService) {
this.appConfigService.onLoad
.pipe(
take(1),
map((appConfig) => appConfig.plugins && appConfig.plugins.aosPlugin)
)
.subscribe((aosPlugin) => {
if (aosPlugin) {
this.enablePlugin();
} else {
this.disablePlugin();
}
});
}
enablePlugin() {
if (localStorage && localStorage.getItem('aosPlugin') === null) {
localStorage.setItem('aosPlugin', 'true');
}
}
disablePlugin() {
localStorage.removeItem('aosPlugin');
}
isAosPluginEnabled() {
return localStorage && localStorage.getItem('aosPlugin') === 'true';
}
}

View File

@@ -23,7 +23,7 @@
*/
import { Inject, Injectable, OnDestroy } from '@angular/core';
import { AuthenticationService, AppConfigService, AlfrescoApiService, PageTitleService, UserPreferencesService } from '@alfresco/adf-core';
import { AuthenticationService, AppConfigService, AlfrescoApiService, PageTitleService } from '@alfresco/adf-core';
import { Observable, BehaviorSubject, Subject } from 'rxjs';
import { GroupService, SearchQueryBuilderService, SharedLinksApiService, UploadService, FileUploadErrorEvent } from '@alfresco/adf-content-services';
import { OverlayContainer } from '@angular/cdk/overlay';
@@ -55,16 +55,12 @@ import { AcaMobileAppSwitcherService } from './aca-mobile-app-switcher.service';
// After moving shell to ADF to core, AppService will implement ShellAppService
export class AppService implements OnDestroy {
private ready: BehaviorSubject<boolean>;
ready$: Observable<boolean>;
pageHeading$: Observable<string>;
appNavNarMode$: Subject<'collapsed' | 'expanded'> = new BehaviorSubject('expanded');
toggleAppNavBar$ = new Subject();
hideSidenavConditions = ['/preview/'];
minimizeSidenavConditions = ['search'];
onDestroy$ = new Subject<boolean>();
/**
@@ -76,7 +72,6 @@ export class AppService implements OnDestroy {
}
constructor(
public preferencesService: UserPreferencesService,
private authenticationService: AuthenticationService,
private store: Store<AppStore>,
private router: Router,

View File

@@ -58,7 +58,6 @@ export * from './lib/services/node-permission.service';
export * from './lib/services/app.extension.service';
export * from './lib/services/router.extension.service';
export * from './lib/services/app-hook.service';
export * from './lib/services/alfresco-office-extension.service';
export * from './lib/services/aca-file-auto-download.service';
export * from './lib/utils/node.utils';