Merge pull request #891 from CenterForOpenScience/feature/fair-signposting

Feature/fair signposting

Author: adlius

src/app/app.routes.server.ts

@@ -137,6 +137,10 @@ export const serverRoutes: ServerRoute[] = [
     path: ':id/overview',
     renderMode: RenderMode.Server,
   },
+  {
+    path: ':id/metadata/:recordId',
+    renderMode: RenderMode.Server,
+  },
   {
     path: ':id/files/**',
     renderMode: RenderMode.Server,

src/app/core/services/osf-config.service.ts

@@ -43,20 +43,24 @@ export class OSFConfigService {
    * On the server, this is skipped as config is only needed in the browser.
    */
   async load(): Promise<void> {
-    if (!this.config && isPlatformBrowser(this.platformId)) {
+    if (this.config) return;
+
+    if (isPlatformBrowser(this.platformId)) {
       this.config = await lastValueFrom<ConfigModel>(
         this.http.get<ConfigModel>('/assets/config/config.json').pipe(
           shareReplay(1),
           catchError(() => of({} as ConfigModel))
         )
       );
+    } else {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      this.config = ((globalThis as any).__SSR_CONFIG__ ?? {}) as ConfigModel;
+    }
 
-      // Apply every key from config to environment
-      for (const [key, value] of Object.entries(this.config)) {
-        // eslint-disable-next-line
-        // @ts-ignore
-        this.environment[key] = value;
-      }
+    for (const [key, value] of Object.entries(this.config)) {
+      // eslint-disable-next-line
+      // @ts-ignore
+      this.environment[key] = value;
     }
   }
 }

src/app/features/files/pages/file-detail/file-detail.component.spec.ts

@@ -41,8 +41,8 @@ describe('FileDetailComponent', () => {
     } as unknown as jest.Mocked<DataciteService>;
 
     const mockRoute: Partial<ActivatedRoute> = {
-      params: of({ providerId: 'osf', preprintId: 'p1' }),
-      queryParams: of({ providerId: 'osf', preprintId: 'p1' }),
+      params: of({ providerId: 'osf', fileGuid: 'file-1' }),
+      queryParams: of({ providerId: 'osf', fileGuid: 'file-1' }),
     };
     (MOCK_STORE.selectSignal as jest.Mock).mockImplementation((selector) => {
       switch (selector) {
@@ -79,6 +79,7 @@ describe('FileDetailComponent', () => {
     }).compileComponents();
     fixture = TestBed.createComponent(FileDetailComponent);
     component = fixture.componentInstance;
+    document.head.innerHTML = '';
     fixture.detectChanges();
   });
 
@@ -95,4 +96,15 @@ describe('FileDetailComponent', () => {
   it('should call dataciteService.logIdentifiableView on start  ', () => {
     expect(dataciteService.logIdentifiableView).toHaveBeenCalledWith(component.fileMetadata$);
   });
+
+  it('should add signposting tags during SSR', () => {
+    fixture.detectChanges();
+
+    const linkTags = Array.from(document.head.querySelectorAll('link[rel="linkset"]'));
+    expect(linkTags.length).toBe(2);
+    expect(linkTags[0].getAttribute('href')).toBe('http://localhost:4200/metadata/file-1/?format=linkset');
+    expect(linkTags[0].getAttribute('type')).toBe('application/linkset');
+    expect(linkTags[1].getAttribute('href')).toBe('http://localhost:4200/metadata/file-1/?format=linkset-json');
+    expect(linkTags[1].getAttribute('type')).toBe('application/linkset+json');
+  });
 });

src/app/features/files/pages/file-detail/file-detail.component.ts

@@ -19,6 +19,8 @@ import {
   effect,
   HostBinding,
   inject,
+  OnDestroy,
+  OnInit,
   signal,
 } from '@angular/core';
 import { takeUntilDestroyed, toObservable } from '@angular/core/rxjs-interop';
@@ -47,6 +49,7 @@ import { pathJoin } from '@osf/shared/helpers/path-join.helper';
 import { CustomConfirmationService } from '@osf/shared/services/custom-confirmation.service';
 import { DataciteService } from '@osf/shared/services/datacite/datacite.service';
 import { MetaTagsService } from '@osf/shared/services/meta-tags.service';
+import { SignpostingService } from '@osf/shared/services/signposting.service';
 import { ToastService } from '@osf/shared/services/toast.service';
 import { ViewOnlyLinkHelperService } from '@osf/shared/services/view-only-link-helper.service';
 import { FileDetailsModel } from '@shared/models/files/file.model';
@@ -94,7 +97,7 @@ import {
   changeDetection: ChangeDetectionStrategy.OnPush,
   providers: [DatePipe],
 })
-export class FileDetailComponent {
+export class FileDetailComponent implements OnInit, OnDestroy {
   @HostBinding('class') classes = 'flex flex-column flex-1 w-full h-full';
 
   readonly store = inject(Store);
@@ -111,6 +114,7 @@ export class FileDetailComponent {
   private readonly translateService = inject(TranslateService);
   private readonly environment = inject(ENVIRONMENT);
   private readonly clipboard = inject(Clipboard);
+  private readonly signpostingService = inject(SignpostingService);
 
   readonly dataciteService = inject(DataciteService);
 
@@ -284,6 +288,16 @@ export class FileDetailComponent {
     this.dataciteService.logIdentifiableView(this.fileMetadata$).pipe(takeUntilDestroyed(this.destroyRef)).subscribe();
   }
 
+  ngOnInit(): void {
+    this.signpostingService.addSignposting(this.fileGuid);
+  }
+
+  ngOnDestroy(): void {
+    if (this.fileGuid) {
+      this.signpostingService.removeSignpostingLinkTags();
+    }
+  }
+
   getIframeLink(version: string) {
     const url = this.getMfrUrlWithVersion(version);
     if (url) {

src/app/features/metadata/metadata.component.ts

@@ -11,6 +11,7 @@ import {
   DestroyRef,
   effect,
   inject,
+  OnDestroy,
   OnInit,
   signal,
 } from '@angular/core';
@@ -24,6 +25,7 @@ import { MetadataResourceEnum } from '@osf/shared/enums/metadata-resource.enum';
 import { ResourceType } from '@osf/shared/enums/resource-type.enum';
 import { CustomConfirmationService } from '@osf/shared/services/custom-confirmation.service';
 import { CustomDialogService } from '@osf/shared/services/custom-dialog.service';
+import { SignpostingService } from '@osf/shared/services/signposting.service';
 import { ToastService } from '@osf/shared/services/toast.service';
 import { CollectionsSelectors, GetProjectSubmissions } from '@osf/shared/stores/collections';
 import {
@@ -117,14 +119,15 @@ import {
   styleUrl: './metadata.component.scss',
   changeDetection: ChangeDetectionStrategy.OnPush,
 })
-export class MetadataComponent implements OnInit {
+export class MetadataComponent implements OnInit, OnDestroy {
   private readonly activeRoute = inject(ActivatedRoute);
   private readonly router = inject(Router);
   private readonly destroyRef = inject(DestroyRef);
   private readonly customDialogService = inject(CustomDialogService);
   private readonly toastService = inject(ToastService);
   private readonly customConfirmationService = inject(CustomConfirmationService);
   private readonly environment = inject(ENVIRONMENT);
+  private readonly signpostingService = inject(SignpostingService);
 
   private resourceId = '';
 
@@ -264,12 +267,18 @@ export class MetadataComponent implements OnInit {
       this.actions.getCedarTemplates();
       this.actions.fetchSelectedSubjects(this.resourceId, this.resourceType());
 
+      this.signpostingService.addMetadataSignposting(this.resourceId);
+
       if (this.isProjectType()) {
         this.actions.getProjectSubmissions(this.resourceId);
       }
     }
   }
 
+  ngOnDestroy(): void {
+    this.signpostingService.removeSignpostingLinkTags();
+  }
+
   onTabChange(tabId: string | number): void {
     const tab = this.tabs().find((x) => x.id === tabId.toString());
 

src/app/features/preprints/pages/preprint-details/preprint-details.component.spec.ts

@@ -466,6 +466,7 @@ describe('PreprintDetailsComponent SSR Tests', () => {
     store = TestBed.inject(Store);
     fixture = TestBed.createComponent(PreprintDetailsComponent);
     component = fixture.componentInstance;
+    document.head.innerHTML = '';
   });
 
   it('should render PreprintDetailsComponent server-side without errors', () => {
@@ -475,6 +476,17 @@ describe('PreprintDetailsComponent SSR Tests', () => {
     expect(component).toBeTruthy();
   });
 
+  it('should add signposting tags during SSR', () => {
+    fixture.detectChanges();
+
+    const linkTags = Array.from(document.head.querySelectorAll('link[rel="linkset"]'));
+    expect(linkTags.length).toBe(2);
+    expect(linkTags[0].getAttribute('href')).toBe('http://localhost:4200/metadata/preprint-1/?format=linkset');
+    expect(linkTags[0].getAttribute('type')).toBe('application/linkset');
+    expect(linkTags[1].getAttribute('href')).toBe('http://localhost:4200/metadata/preprint-1/?format=linkset-json');
+    expect(linkTags[1].getAttribute('type')).toBe('application/linkset+json');
+  });
+
   it('should not access browser-only APIs during SSR', () => {
     const platformId = TestBed.inject(PLATFORM_ID);
     expect(platformId).toBe('server');

src/app/features/preprints/pages/preprint-details/preprint-details.component.ts

@@ -35,6 +35,7 @@ import { FixSpecialCharPipe } from '@osf/shared/pipes/fix-special-char.pipe';
 import { CustomDialogService } from '@osf/shared/services/custom-dialog.service';
 import { DataciteService } from '@osf/shared/services/datacite/datacite.service';
 import { MetaTagsService } from '@osf/shared/services/meta-tags.service';
+import { SignpostingService } from '@osf/shared/services/signposting.service';
 import { ToastService } from '@osf/shared/services/toast.service';
 import { ContributorsSelectors } from '@osf/shared/stores/contributors';
 
@@ -104,6 +105,7 @@ export class PreprintDetailsComponent implements OnInit, OnDestroy {
   private readonly prerenderReady = inject(PrerenderReadyService);
   private readonly platformId = inject(PLATFORM_ID);
   private readonly isBrowser = isPlatformBrowser(this.platformId);
+  private readonly signpostingService = inject(SignpostingService);
 
   private readonly environment = inject(ENVIRONMENT);
 
@@ -304,6 +306,8 @@ export class PreprintDetailsComponent implements OnInit, OnDestroy {
     this.actions.getPreprintProviderById(this.providerId());
     this.fetchPreprint(this.preprintId());
 
+    this.signpostingService.addSignposting(this.preprintId());
+
     this.dataciteService.logIdentifiableView(this.preprint$).pipe(takeUntilDestroyed(this.destroyRef)).subscribe();
   }
 
@@ -313,6 +317,8 @@ export class PreprintDetailsComponent implements OnInit, OnDestroy {
       this.actions.clearCurrentProvider();
     }
 
+    this.signpostingService.removeSignpostingLinkTags();
+
     this.helpScoutService.unsetResourceType();
   }
 

src/app/features/project/overview/project-overview.component.spec.ts

@@ -262,6 +262,7 @@ describe('ProjectOverviewComponent SSR Tests', () => {
     store = TestBed.inject(Store);
     fixture = TestBed.createComponent(ProjectOverviewComponent);
     component = fixture.componentInstance;
+    document.head.innerHTML = '';
   });
 
   it('should render ProjectOverviewComponent server-side without errors', () => {
@@ -285,6 +286,17 @@ describe('ProjectOverviewComponent SSR Tests', () => {
     expect(component).toBeTruthy();
   });
 
+  it('should add signposting tags during SSR', () => {
+    fixture.detectChanges();
+
+    const linkTags = Array.from(document.head.querySelectorAll('link[rel="linkset"]'));
+    expect(linkTags.length).toBe(2);
+    expect(linkTags[0].getAttribute('href')).toBe('http://localhost:4200/metadata/project-123/?format=linkset');
+    expect(linkTags[0].getAttribute('type')).toBe('application/linkset');
+    expect(linkTags[1].getAttribute('href')).toBe('http://localhost:4200/metadata/project-123/?format=linkset-json');
+    expect(linkTags[1].getAttribute('type')).toBe('application/linkset+json');
+  });
+
   it('should not call browser-only actions in ngOnDestroy during SSR', () => {
     const dispatchSpy = jest.spyOn(store, 'dispatch');
 

src/app/features/project/overview/project-overview.component.ts

@@ -16,6 +16,7 @@ import {
   effect,
   HostBinding,
   inject,
+  OnDestroy,
   OnInit,
   PLATFORM_ID,
 } from '@angular/core';
@@ -35,6 +36,7 @@ import { ViewOnlyLinkMessageComponent } from '@osf/shared/components/view-only-l
 import { Mode } from '@osf/shared/enums/mode.enum';
 import { ResourceType } from '@osf/shared/enums/resource-type.enum';
 import { CustomDialogService } from '@osf/shared/services/custom-dialog.service';
+import { SignpostingService } from '@osf/shared/services/signposting.service';
 import { ToastService } from '@osf/shared/services/toast.service';
 import { ViewOnlyLinkHelperService } from '@osf/shared/services/view-only-link-helper.service';
 import {
@@ -93,7 +95,7 @@ import {
   ],
   changeDetection: ChangeDetectionStrategy.OnPush,
 })
-export class ProjectOverviewComponent implements OnInit {
+export class ProjectOverviewComponent implements OnInit, OnDestroy {
   @HostBinding('class') classes = 'flex flex-1 flex-column w-full h-full';
 
   private readonly route = inject(ActivatedRoute);
@@ -104,6 +106,7 @@ export class ProjectOverviewComponent implements OnInit {
   private readonly customDialogService = inject(CustomDialogService);
   private readonly platformId = inject(PLATFORM_ID);
   private readonly isBrowser = isPlatformBrowser(this.platformId);
+  private readonly signpostingService = inject(SignpostingService);
 
   submissions = select(CollectionsModerationSelectors.getCollectionSubmissions);
   collectionProvider = select(CollectionsSelectors.getCollectionProvider);
@@ -193,9 +196,14 @@ export class ProjectOverviewComponent implements OnInit {
       this.actions.getBookmarksId();
       this.actions.getComponents(projectId);
       this.actions.getLinkedProjects(projectId);
+      this.signpostingService.addSignposting(projectId);
     }
   }
 
+  ngOnDestroy(): void {
+    this.signpostingService.removeSignpostingLinkTags();
+  }
+
   handleOpenMakeDecisionDialog() {
     this.customDialogService
       .open(MakeDecisionDialogComponent, {

src/app/features/registry/pages/registry-overview/registry-overview.component.spec.ts

@@ -629,6 +629,7 @@ describe('RegistryOverviewComponent', () => {
       }).compileComponents();
       fixture = TestBed.createComponent(RegistryOverviewComponent);
       component = fixture.componentInstance;
+      document.head.innerHTML = '';
     });
 
     it('should render server-side without errors', () => {
@@ -638,6 +639,16 @@ describe('RegistryOverviewComponent', () => {
       expect(component).toBeTruthy();
     });
 
+    it('should add signposting tags during SSR', () => {
+      fixture.detectChanges();
+      const linkTags = Array.from(document.head.querySelectorAll('link[rel="linkset"]'));
+      expect(linkTags.length).toBe(2);
+      expect(linkTags[0].getAttribute('href')).toBe('http://localhost:4200/metadata/registry-1/?format=linkset');
+      expect(linkTags[0].getAttribute('type')).toBe('application/linkset');
+      expect(linkTags[1].getAttribute('href')).toBe('http://localhost:4200/metadata/registry-1/?format=linkset-json');
+      expect(linkTags[1].getAttribute('type')).toBe('application/linkset+json');
+    });
+
     it('should not access browser-only APIs during SSR', () => {
       const platformId = TestBed.inject(PLATFORM_ID);
       expect(platformId).toBe('server');