113169: Renamed the service in charge of adding metadata head tags to you HTML to HeadTagService & made its methods protected to make it easier to override them

Author: alexandrevryghem

src/app/app.component.spec.ts

@@ -9,11 +9,11 @@ import { TranslateLoader, TranslateModule } from '@ngx-translate/core';
 import { AppComponent } from './app.component';
 import { HostWindowState } from './shared/search/host-window.reducer';
 import { HostWindowResizeAction } from './shared/host-window.actions';
-import { MetadataService } from './core/metadata/metadata.service';
+import { HeadTagService } from './core/metadata/head-tag.service';
 
 import { NativeWindowRef, NativeWindowService } from './core/services/window.service';
 import { TranslateLoaderMock } from './shared/mocks/translate-loader.mock';
-import { MetadataServiceMock } from './shared/mocks/metadata-service.mock';
+import { HeadTagServiceMock } from './shared/mocks/head-tag-service.mock';
 import { AngularticsProviderMock } from './shared/mocks/angulartics-provider.service.mock';
 import { AuthServiceMock } from './shared/mocks/auth.service.mock';
 import { AuthService } from './core/auth/auth.service';
@@ -71,7 +71,7 @@ describe('App component', () => {
       declarations: [AppComponent], // declare the test component
       providers: [
         { provide: NativeWindowService, useValue: new NativeWindowRef() },
-        { provide: MetadataService, useValue: new MetadataServiceMock() },
+        { provide: HeadTagService, useValue: new HeadTagServiceMock() },
         { provide: Angulartics2DSpace, useValue: new AngularticsProviderMock() },
         { provide: AuthService, useValue: new AuthServiceMock() },
         { provide: Router, useValue: new RouterMock() },

src/app/community-page/community-page.component.ts

@@ -3,14 +3,10 @@ import { ChangeDetectionStrategy, Component, OnInit } from '@angular/core';
 import { ActivatedRoute, Router } from '@angular/router';
 
 import { Observable } from 'rxjs';
-import { CommunityDataService } from '../core/data/community-data.service';
 import { RemoteData } from '../core/data/remote-data';
 import { Bitstream } from '../core/shared/bitstream.model';
 
 import { Community } from '../core/shared/community.model';
-
-import { MetadataService } from '../core/metadata/metadata.service';
-
 import { fadeInOut } from '../shared/animations/fade';
 import { hasValue } from '../shared/empty.util';
 import { getAllSucceededRemoteDataPayload} from '../core/shared/operators';
@@ -53,8 +49,6 @@ export class CommunityPageComponent implements OnInit {
   communityPageRoute$: Observable<string>;
 
   constructor(
-    private communityDataService: CommunityDataService,
-    private metadata: MetadataService,
     private route: ActivatedRoute,
     private router: Router,
     private authService: AuthService,

src/app/core/core.module.ts

@@ -64,7 +64,7 @@ import { Group } from './eperson/models/group.model';
 import { JsonPatchOperationsBuilder } from './json-patch/builder/json-patch-operations-builder';
 import { MetadataField } from './metadata/metadata-field.model';
 import { MetadataSchema } from './metadata/metadata-schema.model';
-import { MetadataService } from './metadata/metadata.service';
+import { HeadTagService } from './metadata/head-tag.service';
 import { RegistryService } from './registry/registry.service';
 import { RoleService } from './roles/role.service';
 import { FeedbackDataService } from './feedback/feedback-data.service';
@@ -218,7 +218,7 @@ const PROVIDERS = [
   HALEndpointService,
   HostWindowService,
   ItemDataService,
-  MetadataService,
+  HeadTagService,
   ObjectCacheService,
   PaginationComponentOptions,
   ResourcePolicyDataService,

…p/core/metadata/metadata.service.spec.ts …p/core/metadata/head-tag.service.spec.tssrc/app/core/metadata/metadata.service.spec.ts renamed to src/app/core/metadata/head-tag.service.spec.ts src/app/core/metadata/metadata.service.spec.ts renamed to src/app/core/metadata/head-tag.service.spec.ts

@@ -19,7 +19,7 @@ import { PaginatedList } from '../data/paginated-list.model';
 import { Bitstream } from '../shared/bitstream.model';
 import { MetadataValue } from '../shared/metadata.models';
 
-import { MetadataService } from './metadata.service';
+import { HeadTagService } from './head-tag.service';
 import { RootDataService } from '../data/root-data.service';
 import { Bundle } from '../shared/bundle.model';
 import { createPaginatedList } from '../../shared/testing/utils.test';
@@ -31,8 +31,8 @@ import { AddMetaTagAction, ClearMetaTagAction } from './meta-tag.actions';
 import { AuthorizationDataService } from '../data/feature-authorization/authorization-data.service';
 import { AppConfig } from '../../../config/app-config.interface';
 
-describe('MetadataService', () => {
-  let metadataService: MetadataService;
+describe('HeadTagService', () => {
+  let headTagService: HeadTagService;
 
   let meta: Meta;
 
@@ -41,7 +41,6 @@ describe('MetadataService', () => {
   let dsoNameService: DSONameService;
 
   let bundleDataService;
-  let bitstreamDataService;
   let rootService: RootDataService;
   let translateService: TranslateService;
   let hardRedirectService: HardRedirectService;
@@ -59,9 +58,6 @@ describe('MetadataService', () => {
     rootService = jasmine.createSpyObj({
       findRoot: createSuccessfulRemoteDataObject$({ dspaceVersion: 'mock-dspace-version' })
     });
-    bitstreamDataService = jasmine.createSpyObj({
-      findListByHref: createSuccessfulRemoteDataObject$(createPaginatedList([MockBitstream3])),
-    });
     bundleDataService = jasmine.createSpyObj({
       findByItemAndName: mockBundleRD$([MockBitstream3])
     });
@@ -102,15 +98,13 @@ describe('MetadataService', () => {
       }
     } as any;
 
-    metadataService = new MetadataService(
+    headTagService = new HeadTagService(
       router,
       translateService,
       meta,
       title,
       dsoNameService,
       bundleDataService,
-      bitstreamDataService,
-      undefined,
       rootService,
       store,
       hardRedirectService,
@@ -120,7 +114,7 @@ describe('MetadataService', () => {
   });
 
   it('items page should set meta tags', fakeAsync(() => {
-    (metadataService as any).processRouteChange({
+    (headTagService as any).processRouteChange({
       data: {
         value: {
           dso: createSuccessfulRemoteDataObject(ItemMock),
@@ -147,7 +141,7 @@ describe('MetadataService', () => {
   }));
 
   it('items page should set meta tags as published Thesis', fakeAsync(() => {
-    (metadataService as any).processRouteChange({
+    (headTagService as any).processRouteChange({
       data: {
         value: {
           dso: createSuccessfulRemoteDataObject(mockPublisher(mockType(ItemMock, 'Thesis'))),
@@ -166,7 +160,7 @@ describe('MetadataService', () => {
   }));
 
   it('items page should set meta tags as published Technical Report', fakeAsync(() => {
-    (metadataService as any).processRouteChange({
+    (headTagService as any).processRouteChange({
       data: {
         value: {
           dso: createSuccessfulRemoteDataObject(mockPublisher(mockType(ItemMock, 'Technical Report'))),
@@ -182,7 +176,7 @@ describe('MetadataService', () => {
 
   it('route titles should overwrite dso titles', fakeAsync(() => {
     (translateService.get as jasmine.Spy).and.returnValues(of('DSpace :: '), of('Translated Route Title'));
-    (metadataService as any).processRouteChange({
+    (headTagService as any).processRouteChange({
       data: {
         value: {
           dso: createSuccessfulRemoteDataObject(ItemMock),
@@ -198,7 +192,7 @@ describe('MetadataService', () => {
 
   it('other navigation should add title and description', fakeAsync(() => {
     (translateService.get as jasmine.Spy).and.returnValues(of('DSpace :: '), of('Dummy Title'), of('This is a dummy item component for testing!'));
-    (metadataService as any).processRouteChange({
+    (headTagService as any).processRouteChange({
       data: {
         value: {
           title: 'Dummy Title',
@@ -220,14 +214,14 @@ describe('MetadataService', () => {
 
   describe(`listenForRouteChange`, () => {
     it(`should call processRouteChange`, fakeAsync(() => {
-      spyOn(metadataService as any, 'processRouteChange').and.callFake(() => undefined);
-      metadataService.listenForRouteChange();
+      spyOn(headTagService as any, 'processRouteChange').and.callFake(() => undefined);
+      headTagService.listenForRouteChange();
       tick();
-      expect((metadataService as any).processRouteChange).toHaveBeenCalled();
+      expect((headTagService as any).processRouteChange).toHaveBeenCalled();
     }));
     it(`should add Generator`, fakeAsync(() => {
-      spyOn(metadataService as any, 'processRouteChange').and.callFake(() => undefined);
-      metadataService.listenForRouteChange();
+      spyOn(headTagService as any, 'processRouteChange').and.callFake(() => undefined);
+      headTagService.listenForRouteChange();
       tick();
       expect(meta.addTag).toHaveBeenCalledWith({
         name: 'Generator',
@@ -238,7 +232,7 @@ describe('MetadataService', () => {
 
   describe('citation_abstract_html_url', () => {
     it('should use dc.identifier.uri if available', fakeAsync(() => {
-      (metadataService as any).processRouteChange({
+      (headTagService as any).processRouteChange({
         data: {
           value: {
             dso: createSuccessfulRemoteDataObject(mockUri(ItemMock, 'https://ddg.gg')),
@@ -253,7 +247,7 @@ describe('MetadataService', () => {
     }));
 
     it('should use current route as fallback', fakeAsync(() => {
-      (metadataService as any).processRouteChange({
+      (headTagService as any).processRouteChange({
         data: {
           value: {
             dso: createSuccessfulRemoteDataObject(mockUri(ItemMock)),
@@ -270,7 +264,7 @@ describe('MetadataService', () => {
 
   describe('citation_*_institution / citation_publisher', () => {
     it('should use citation_dissertation_institution tag for dissertations', fakeAsync(() => {
-      (metadataService as any).processRouteChange({
+      (headTagService as any).processRouteChange({
         data: {
           value: {
             dso: createSuccessfulRemoteDataObject(mockPublisher(mockType(ItemMock, 'Thesis'))),
@@ -287,7 +281,7 @@ describe('MetadataService', () => {
     }));
 
     it('should use citation_tech_report_institution tag for tech reports', fakeAsync(() => {
-      (metadataService as any).processRouteChange({
+      (headTagService as any).processRouteChange({
         data: {
           value: {
             dso: createSuccessfulRemoteDataObject(mockPublisher(mockType(ItemMock, 'Technical Report'))),
@@ -304,7 +298,7 @@ describe('MetadataService', () => {
     }));
 
     it('should use citation_publisher for other item types', fakeAsync(() => {
-      (metadataService as any).processRouteChange({
+      (headTagService as any).processRouteChange({
         data: {
           value: {
             dso: createSuccessfulRemoteDataObject(mockPublisher(mockType(ItemMock, 'Some Other Type'))),
@@ -325,7 +319,7 @@ describe('MetadataService', () => {
     it('should link to primary Bitstream URL regardless of format', fakeAsync(() => {
       (bundleDataService.findByItemAndName as jasmine.Spy).and.returnValue(mockBundleRD$([], MockBitstream3));
 
-      (metadataService as any).processRouteChange({
+      (headTagService as any).processRouteChange({
         data: {
           value: {
             dso: createSuccessfulRemoteDataObject(ItemMock),
@@ -344,7 +338,7 @@ describe('MetadataService', () => {
         (bundleDataService.findByItemAndName as jasmine.Spy).and.returnValue(mockBundleRD$([MockBitstream3]));
         (authorizationService.isAuthorized as jasmine.Spy).and.returnValue(observableOf(false));
 
-        (metadataService as any).processRouteChange({
+        (headTagService as any).processRouteChange({
           data: {
             value: {
               dso: createSuccessfulRemoteDataObject(ItemMock),
@@ -361,7 +355,7 @@ describe('MetadataService', () => {
       it('should link to first and only Bitstream regardless of format', fakeAsync(() => {
         (bundleDataService.findByItemAndName as jasmine.Spy).and.returnValue(mockBundleRD$([MockBitstream3]));
 
-        (metadataService as any).processRouteChange({
+        (headTagService as any).processRouteChange({
           data: {
             value: {
               dso: createSuccessfulRemoteDataObject(ItemMock),
@@ -381,13 +375,10 @@ describe('MetadataService', () => {
         beforeEach(() => {
           bitstreams = [MockBitstream2, MockBitstream3, MockBitstream1];
           (bundleDataService.findByItemAndName as jasmine.Spy).and.returnValue(mockBundleRD$(bitstreams));
-          (bitstreamDataService.findListByHref as jasmine.Spy).and.returnValues(
-            ...mockBitstreamPages$(bitstreams).map(bp => createSuccessfulRemoteDataObject$(bp)),
-          );
         });
 
         it('should link to first Bitstream with allowed format', fakeAsync(() => {
-          (metadataService as any).processRouteChange({
+          (headTagService as any).processRouteChange({
             data: {
               value: {
                 dso: createSuccessfulRemoteDataObject(ItemMock),
@@ -412,13 +403,10 @@ describe('MetadataService', () => {
     beforeEach(() => {
       bitstreams = [MockBitstream1, MockBitstream3, MockBitstream2];
       (bundleDataService.findByItemAndName as jasmine.Spy).and.returnValue(mockBundleRD$(bitstreams));
-      (bitstreamDataService.findListByHref as jasmine.Spy).and.returnValues(
-        ...mockBitstreamPages$(bitstreams).map(bp => createSuccessfulRemoteDataObject$(bp)),
-      );
     });
 
     it(`shouldn't add a citation_pdf_url meta tag`, fakeAsync(() => {
-      (metadataService as any).processRouteChange({
+      (headTagService as any).processRouteChange({
         data: {
           value: {
             dso: createSuccessfulRemoteDataObject(ItemMock),
@@ -437,7 +425,7 @@ describe('MetadataService', () => {
 
   describe('tagstore', () => {
     beforeEach(fakeAsync(() => {
-      (metadataService as any).processRouteChange({
+      (headTagService as any).processRouteChange({
         data: {
           value: {
             dso: createSuccessfulRemoteDataObject(ItemMock),