inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[AAE-11695] move version compatibility directive and service (#8038)

Browse Source 
* [AAE-11695] move version compatibility directive

* [AAE-11695] remove spare readme section
This commit is contained in:
Kasia Biernat
2022-12-12 11:19:31 +01:00
committed by GitHub
parent 8425831c5d
commit 5edc1186a4
24 changed files with 122 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
lib/core/src/lib/core.module.ts
View File

@@ -58,8 +58,6 @@ import { ExtensionsModule } from '@alfresco/adf-extensions';
import { directionalityConfigFactory } from './services/directionality-config-factory';
import { DirectionalityConfigService } from './services/directionality-config.service';
import { SearchTextModule } from './search-text/search-text-input.module';
import { versionCompatibilityFactory } from './services/version-compatibility-factory';
import { VersionCompatibilityService } from './services/version-compatibility.service';
import { AlfrescoJsClientsModule } from '@alfresco/adf-core/api';
import { AuthenticationInterceptor, Authentication } from '@alfresco/adf-core/auth';
import { LegacyApiClientModule } from './api-factories/legacy-api-client.module';
@@ -171,12 +169,6 @@ export class CoreModule {
deps: [DirectionalityConfigService],
multi: true
},
{
provide: APP_INITIALIZER,
useFactory: versionCompatibilityFactory,
deps: [VersionCompatibilityService],
multi: true
},
{ provide: HTTP_INTERCEPTORS, useClass: AuthenticationInterceptor, multi: true },
{ provide: Authentication, useClass: AuthenticationService },
{

3
lib/core/src/lib/directives/directive.module.ts
View File

@@ -23,7 +23,6 @@ import { HighlightDirective } from './highlight.directive';
import { LogoutDirective } from './logout.directive';
import { UploadDirective } from './upload.directive';
import { NodeDownloadDirective } from './node-download.directive';
import { VersionCompatibilityDirective } from './version-compatibility.directive';
import { TooltipCardDirective } from './tooltip-card/tooltip-card.directive';
import { OverlayModule } from '@angular/cdk/overlay';
import { TooltipCardComponent } from './tooltip-card/tooltip-card.component';
@@ -40,7 +39,6 @@ import { InfiniteSelectScrollDirective } from './infinite-select-scroll.directiv
LogoutDirective,
NodeDownloadDirective,
UploadDirective,
VersionCompatibilityDirective,
TooltipCardDirective,
TooltipCardComponent,
InfiniteSelectScrollDirective
@@ -50,7 +48,6 @@ import { InfiniteSelectScrollDirective } from './infinite-select-scroll.directiv
LogoutDirective,
NodeDownloadDirective,
UploadDirective,
VersionCompatibilityDirective,
TooltipCardDirective,
InfiniteSelectScrollDirective
]

1
lib/core/src/lib/directives/public-api.ts
View File

@@ -19,7 +19,6 @@ export * from './highlight.directive';
export * from './logout.directive';
export * from './node-download.directive';
export * from './upload.directive';
export * from './version-compatibility.directive';
export * from './tooltip-card/tooltip-card.directive';
export * from './infinite-select-scroll.directive';

95
lib/core/src/lib/directives/version-compatibility.directive.spec.ts
View File

@@ -1,95 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Component } from '@angular/core';
import { By } from '@angular/platform-browser';
import { TranslateModule } from '@ngx-translate/core';
import { TestBed, ComponentFixture } from '@angular/core/testing';
import { setupTestBed } from '../testing/setup-test-bed';
import { CoreTestingModule } from '../testing/core.testing.module';
import { VersionCompatibilityService } from '../services/version-compatibility.service';
import { VersionInfo } from '@alfresco/js-api';
@Component({
template: `
<div *adf-acs-version="'8'" class="hidden-content-1">
My hidden content 1
</div>
<div *adf-acs-version="'7.1'" class="hidden-content-2">
My hidden content 2
</div>
<div *adf-acs-version="'7.0.2'" class="hidden-content-3">
My hidden content 3
</div>
<div *adf-acs-version="'6.1.5'" class="visible-content-1">
My visible content 1
</div>
<div *adf-acs-version="'6.1'" class="visible-content-2">
My visible content 2
</div>
<div *adf-acs-version="'6'" class="visible-content-3">
My visible content 3
</div>
`
})
class TestComponent { }
describe('VersionCompatibilityDirective', () => {
let fixture: ComponentFixture<TestComponent>;
let versionCompatibilityService: VersionCompatibilityService;
const acsResponceMock = new VersionInfo({
display: '7.0.1',
major: '7',
minor: '0',
patch: '1'
});
setupTestBed({
imports: [
TranslateModule.forRoot(),
CoreTestingModule
],
declarations: [TestComponent]
});
beforeEach(() => {
fixture = TestBed.createComponent(TestComponent);
versionCompatibilityService = TestBed.inject(VersionCompatibilityService);
spyOn(versionCompatibilityService, 'getAcsVersion').and.returnValue(acsResponceMock);
});
it('should display component when the version is supported', () => {
fixture.detectChanges();
const element1 = fixture.debugElement.query(By.css('[class="visible-content-1"]'));
const element2 = fixture.debugElement.query(By.css('[class="visible-content-2"]'));
const element3 = fixture.debugElement.query(By.css('[class="visible-content-3"]'));
expect(element1).toBeDefined();
expect(element2).toBeDefined();
expect(element3).toBeDefined();
});
it('should hide component when the version is not supported', () => {
fixture.detectChanges();
const element1 = fixture.debugElement.query(By.css('[class="hidden-content-1"]'));
const element2 = fixture.debugElement.query(By.css('[class="hidden-content-2"]'));
const element3 = fixture.debugElement.query(By.css('[class="hidden-content-3"]'));
expect(element1).toBeNull();
expect(element2).toBeNull();
expect(element3).toBeNull();
});
});

48
lib/core/src/lib/directives/version-compatibility.directive.ts
View File

@@ -1,48 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Directive, Input, ViewContainerRef, TemplateRef } from '@angular/core';
import { VersionCompatibilityService } from '../services/version-compatibility.service';
import { take } from 'rxjs/operators';
@Directive({
selector: '[adf-acs-version]'
})
export class VersionCompatibilityDirective {
/** Minimum version required for component to work correctly . */
@Input('adf-acs-version')
set version(requiredVersion: string) {
this.validateAcsVersion(requiredVersion);
}
constructor(
private templateRef: TemplateRef<any>,
private viewContainer: ViewContainerRef,
private versionCompatibilityService: VersionCompatibilityService
) {
}
private validateAcsVersion(requiredVersion: string) {
this.versionCompatibilityService.acsVersionInitialized$.pipe(take(1)).subscribe(() => {
this.viewContainer.clear();
if (requiredVersion && this.versionCompatibilityService.isVersionSupported(requiredVersion)) {
this.viewContainer.createEmbeddedView(this.templateRef);
}
});
}
}

1
lib/core/src/lib/services/public-api.ts
View File

@@ -61,7 +61,6 @@ export * from './ecm-user.service';
export * from './identity-user.service';
export * from './identity-group.service';
export * from './identity-role.service';
export * from './version-compatibility.service';
export * from './auth-bearer.interceptor';
export * from './oauth2.service';
export * from './language.service';

23
lib/core/src/lib/services/version-compatibility-factory.ts
View File

@@ -1,23 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { VersionCompatibilityService } from './version-compatibility.service';
// eslint-disable-next-line prefer-arrow/prefer-arrow-functions
export function versionCompatibilityFactory(versionCompatibilityService: VersionCompatibilityService) {
return () => versionCompatibilityService;
}

83
lib/core/src/lib/services/version-compatibility.service.spec.ts
View File

@@ -1,83 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { TestBed } from '@angular/core/testing';
import { DiscoveryApiService } from './discovery-api.service';
import { setupTestBed } from '../testing/setup-test-bed';
import { CoreTestingModule } from '../testing/core.testing.module';
import { VersionCompatibilityService } from './version-compatibility.service';
import { BehaviorSubject } from 'rxjs';
import { TranslateModule } from '@ngx-translate/core';
import { RepositoryInfo } from '@alfresco/js-api';
describe('VersionCompatibilityService', () => {
let versionCompatibilityService: VersionCompatibilityService;
let discoveryApiService: DiscoveryApiService;
const mockProductInfo = new BehaviorSubject<RepositoryInfo>(null);
const acsResponceMock = {
version: {
display: '7.0.1',
major: '7',
minor: '0',
patch: '1'
}
};
setupTestBed({
imports: [
TranslateModule.forRoot(),
CoreTestingModule
],
providers: [
{
provide: DiscoveryApiService,
useValue: {
ecmProductInfo$: mockProductInfo
}
}
]
});
beforeEach(async () => {
discoveryApiService = TestBed.inject(DiscoveryApiService);
versionCompatibilityService = TestBed.inject(VersionCompatibilityService);
mockProductInfo.next(acsResponceMock as RepositoryInfo);
versionCompatibilityService = new VersionCompatibilityService(discoveryApiService);
});
it('should get ACS running version', () => {
const acsVersion = versionCompatibilityService.getAcsVersion();
expect(acsVersion).toBeDefined();
expect(acsVersion.display).toBe('7.0.1');
});
it('should validate give version', () => {
expect(versionCompatibilityService.getAcsVersion()).toEqual({ display: '7.0.1', major: '7', minor: '0', patch: '1' } as any);
expect(versionCompatibilityService.isVersionSupported('8.0.0')).toBe(false);
expect(versionCompatibilityService.isVersionSupported('7.0.1')).toBe(true);
expect(versionCompatibilityService.isVersionSupported('7.0.0')).toBe(true);
expect(versionCompatibilityService.isVersionSupported('6.0.0')).toBe(true);
});
it('should emit versionCompatibilityInitialized after retrieving acs version', (done) => {
versionCompatibilityService.acsVersionInitialized$.subscribe(() => {
expect(versionCompatibilityService.getAcsVersion()).toEqual({ display: '7.0.1', major: '7', minor: '0', patch: '1' } as any);
done();
});
});
});

80
lib/core/src/lib/services/version-compatibility.service.ts
View File

@@ -1,80 +0,0 @@
/*!
* @license
* Copyright 2019 Alfresco Software, Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Injectable } from '@angular/core';
import { filter } from 'rxjs/operators';
import { ReplaySubject } from 'rxjs';
import { VersionInfo, RepositoryInfo } from '@alfresco/js-api';
import { DiscoveryApiService } from './discovery-api.service';
@Injectable({
providedIn: 'root'
})
export class VersionCompatibilityService {
private acsVersion: VersionInfo;
acsVersionInitialized$ = new ReplaySubject();
constructor(private discoveryApiService: DiscoveryApiService) {
this.discoveryApiService.ecmProductInfo$
.pipe(filter(acsInfo => !!acsInfo))
.subscribe((acsInfo: RepositoryInfo) => this.initializeAcsVersion(acsInfo.version));
}
private initializeAcsVersion(acsVersion: VersionInfo) {
this.acsVersion = acsVersion;
this.acsVersionInitialized$.next();
}
getAcsVersion(): VersionInfo {
return this.acsVersion;
}
isVersionSupported(requiredVersion: string): boolean {
const parsedRequiredVersion = this.parseVersion(requiredVersion);
const currentVersion = this.getAcsVersion();
let versionSupported = false;
if (currentVersion) {
if (+currentVersion.major > +parsedRequiredVersion.major) {
versionSupported = true;
} else if (currentVersion.major === parsedRequiredVersion.major &&
+currentVersion.minor > +parsedRequiredVersion.minor) {
versionSupported = true;
} else if (currentVersion.major === parsedRequiredVersion.major &&
currentVersion.minor === parsedRequiredVersion.minor &&
+currentVersion.patch >= +parsedRequiredVersion.patch) {
versionSupported = true;
}
}
return versionSupported;
}
private parseVersion(version: string): VersionInfo {
const major = version.split('.')[0];
const minor = version.split('.')[1] || '0';
const patch = version.split('.')[2] || '0';
return {
major,
minor,
patch
} as VersionInfo;
}
}

8
lib/core/src/lib/testing/core.testing.module.ts
View File

@@ -32,8 +32,6 @@ import { CookieServiceMock } from '../mock/cookie.service.mock';
import { HttpClientModule } from '@angular/common/http';
import { directionalityConfigFactory } from '../services/directionality-config-factory';
import { DirectionalityConfigService } from '../services/directionality-config.service';
import { versionCompatibilityFactory } from '../services/version-compatibility-factory';
import { VersionCompatibilityService } from '../services/version-compatibility.service';
@NgModule({
imports: [
@@ -54,12 +52,6 @@ import { VersionCompatibilityService } from '../services/version-compatibility.s
useFactory: directionalityConfigFactory,
deps: [ DirectionalityConfigService ],
multi: true
},
{
provide: APP_INITIALIZER,
useFactory: versionCompatibilityFactory,
deps: [ VersionCompatibilityService ],
multi: true
}
],
exports: [