fix: Association decorators should not raise errors

This pull request creates a new association injector that can be used to inject options into the baw-api.service.ts - Add injectable BawApiOptions object to the baw-api.service - Add missing PageInfo tests to annotation search page - Fix a bug where the associations would throw errors (e.g. the audio recording list page if not logged in) - Fix TypeScript typing for ServiceToken.kind Fixes: #1967
QutEcoacoustics · Nov 11, 2024 · 8909001 · 8909001
1 parent acac43f
commit 8909001
Show file tree

Hide file tree

Showing 93 changed files with 767 additions and 381 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,7 @@
+#! this file should only be used as a last resort to exclude files from pettier
+# you should always prefer to use // prettier-ignore to exluce individual lines
+
+# we ignore the service token file from pettier so that we can one-line all of
+# the service tokens
+# this makes it much more readable as each service token has its ownn line
+src/app/services/baw-api/ServiceTokens.ts
diff --git a/src/app/app.module.ts b/src/app/app.module.ts
@@ -1,4 +1,5 @@
 import {
+  ApplicationRef,
   CUSTOM_ELEMENTS_SCHEMA,
   DoBootstrap,
   NgModule,
@@ -114,7 +115,7 @@ export const appImports = [
   schemas: [CUSTOM_ELEMENTS_SCHEMA],
 })
 export class AppModule implements DoBootstrap {
-  public ngDoBootstrap(app: any): void {
+  public ngDoBootstrap(app: ApplicationRef): void {
     app.bootstrap(AppComponent);
   }
 }
diff --git a/src/app/components/admin/all-uploads/all-uploads.component.spec.ts b/src/app/components/admin/all-uploads/all-uploads.component.spec.ts
@@ -6,7 +6,6 @@ import { ToastrService } from "ngx-toastr";
 import { ConfirmationComponent } from "@components/harvest/components/modal/confirmation.component";
 import { LoadingComponent } from "@shared/loading/loading.component";
 import { UserLinkComponent } from "@shared/user-link/user-link/user-link.component";
-import { Injector } from "@angular/core";
 import { SHALLOW_HARVEST } from "@baw-api/ServiceTokens";
 import { Harvest } from "@models/Harvest";
 import { Project } from "@models/Project";
@@ -16,6 +15,7 @@ import { User } from "@models/User";
 import { generateUser } from "@test/fakes/User";
 import { ShallowHarvestsService } from "@baw-api/harvest/harvest.service";
 import { generateHarvest } from "@test/fakes/Harvest";
+import { ASSOCIATION_INJECTOR } from "@services/association-injector/association-injector.tokens";
 import { AllUploadsComponent } from "./all-uploads.component";
 
 // the functionality that the project names are shown in the harvest list
@@ -38,7 +38,7 @@ describe("AllUploadsComponent", () => {
 
     spectator = createComponent({ detectChanges: false });
 
-    const injector = spectator.inject(Injector);
+    const injector = spectator.inject(ASSOCIATION_INJECTOR);
     fakeHarvest["injector"] = injector;
 
     fakeHarvestApi = spectator.inject(SHALLOW_HARVEST.token);

diff --git a/src/app/components/admin/analysis-jobs/details/details.component.spec.ts b/src/app/components/admin/analysis-jobs/details/details.component.spec.ts
@@ -1,4 +1,3 @@
-import { Injector } from "@angular/core";
 import { ActivatedRoute } from "@angular/router";
 import { RouterTestingModule } from "@angular/router/testing";
 import { MockBawApiModule } from "@baw-api/baw-apiMock.module";
@@ -21,10 +20,12 @@ import { assertPageInfo } from "@test/helpers/pageRoute";
 import { mockActivatedRoute } from "@test/helpers/testbed";
 import { Subject } from "rxjs";
 import { PageTitleStrategy } from "src/app/app.component";
+import { ASSOCIATION_INJECTOR } from "@services/association-injector/association-injector.tokens";
+import { AssociationInjector } from "@models/ImplementsInjector";
 import { AdminAnalysisJobComponent } from "./details.component";
 
 describe("AdminAnalysisJobComponent", () => {
-  let injector: Injector;
+  let injector: AssociationInjector;
   let spec: Spectator<AdminAnalysisJobComponent>;
   const createComponent = createComponentFactory({
     component: AdminAnalysisJobComponent,
@@ -54,7 +55,7 @@ describe("AdminAnalysisJobComponent", () => {
       ],
     });
 
-    injector = spec.inject(Injector);
+    injector = spec.inject(ASSOCIATION_INJECTOR);
     const accountsApi = spec.inject(ACCOUNT.token);
     const scriptsApi = spec.inject(SCRIPT.token);
     const savedSearchesApi = spec.inject(SAVED_SEARCH.token);

diff --git a/src/app/components/admin/orphan/details/details.component.spec.ts b/src/app/components/admin/orphan/details/details.component.spec.ts
@@ -1,4 +1,3 @@
-import { Injector } from "@angular/core";
 import { ComponentFixture, TestBed } from "@angular/core/testing";
 import { ActivatedRoute } from "@angular/router";
 import { RouterTestingModule } from "@angular/router/testing";
@@ -21,12 +20,14 @@ import { assertPageInfo } from "@test/helpers/pageRoute";
 import { mockActivatedRoute } from "@test/helpers/testbed";
 import { Subject } from "rxjs";
 import { appLibraryImports } from "src/app/app.module";
+import { AssociationInjector } from "@models/ImplementsInjector";
+import { ASSOCIATION_INJECTOR } from "@services/association-injector/association-injector.tokens";
 import { AdminOrphanComponent } from "./details.component";
 
 describe("AdminOrphanComponent", () => {
   let component: AdminOrphanComponent;
   let fixture: ComponentFixture<AdminOrphanComponent>;
-  let injector: Injector;
+  let injector: AssociationInjector;
 
   function configureTestingModule(model: Site, error?: BawApiError) {
     TestBed.configureTestingModule({
@@ -48,7 +49,7 @@ describe("AdminOrphanComponent", () => {
     }).compileComponents();
 
     fixture = TestBed.createComponent(AdminOrphanComponent);
-    injector = TestBed.inject(Injector);
+    injector = TestBed.inject(ASSOCIATION_INJECTOR);
     const accountsApi = TestBed.inject(
       ACCOUNT.token
     ) as SpyObject<AccountsService>;

diff --git a/src/app/components/admin/scripts/details/details.component.spec.ts b/src/app/components/admin/scripts/details/details.component.spec.ts
@@ -1,4 +1,3 @@
-import { Injector } from "@angular/core";
 import { ComponentFixture, TestBed } from "@angular/core/testing";
 import { ActivatedRoute } from "@angular/router";
 import { RouterTestingModule } from "@angular/router/testing";
@@ -22,12 +21,14 @@ import { assertPageInfo } from "@test/helpers/pageRoute";
 import { mockActivatedRoute } from "@test/helpers/testbed";
 import { Subject } from "rxjs";
 import { appLibraryImports } from "src/app/app.module";
+import { ASSOCIATION_INJECTOR } from "@services/association-injector/association-injector.tokens";
+import { AssociationInjector } from "@models/ImplementsInjector";
 import { AdminScriptComponent } from "./details.component";
 
 describe("ScriptComponent", () => {
   let component: AdminScriptComponent;
   let fixture: ComponentFixture<AdminScriptComponent>;
-  let injector: Injector;
+  let injector: AssociationInjector;
 
   function configureTestingModule(model: Script, error?: BawApiError) {
     TestBed.configureTestingModule({
@@ -50,7 +51,7 @@ describe("ScriptComponent", () => {
     }).compileComponents();
 
     fixture = TestBed.createComponent(AdminScriptComponent);
-    injector = TestBed.inject(Injector);
+    injector = TestBed.inject(ASSOCIATION_INJECTOR);
     const accountsApi = TestBed.inject(
       ACCOUNT.token
     ) as SpyObject<AccountsService>;

diff --git a/...ts/annotations/components/annotation-search-form/annotation-search-form.component.spec.ts b/...ts/annotations/components/annotation-search-form/annotation-search-form.component.spec.ts
@@ -6,7 +6,6 @@ import {
 import { SharedModule } from "@shared/shared.module";
 import { MockBawApiModule } from "@baw-api/baw-apiMock.module";
 import { AnnotationSearchParameters } from "@components/annotations/pages/annotationSearchParameters";
-import { Injector, INJECTOR } from "@angular/core";
 import { Project } from "@models/Project";
 import { generateProject } from "@test/fakes/Project";
 import { TagsService } from "@baw-api/tag/tags.service";
@@ -30,11 +29,13 @@ import { Params } from "@angular/router";
 import { AudioRecordingsService } from "@baw-api/audio-recording/audio-recordings.service";
 import { AudioRecording } from "@models/AudioRecording";
 import { generateAudioRecording } from "@test/fakes/AudioRecording";
+import { AssociationInjector } from "@models/ImplementsInjector";
+import { ASSOCIATION_INJECTOR } from "@services/association-injector/association-injector.tokens";
 import { AnnotationSearchFormComponent } from "./annotation-search-form.component";
 
 describe("AnnotationSearchFormComponent", () => {
   let spectator: Spectator<AnnotationSearchFormComponent>;
-  let injector: SpyObject<Injector>;
+  let injector: SpyObject<AssociationInjector>;
 
   let tagsApiSpy: SpyObject<TagsService>;
   let sitesApiSpy: SpyObject<ShallowSitesService>;
@@ -55,7 +56,7 @@ describe("AnnotationSearchFormComponent", () => {
   function setup(params: Params = {}): void {
     spectator = createComponent({ detectChanges: false });
 
-    injector = spectator.inject(INJECTOR);
+    injector = spectator.inject(ASSOCIATION_INJECTOR);
     tagsApiSpy = spectator.inject(TAG.token);
     sitesApiSpy = spectator.inject(SHALLOW_SITE.token);
     recordingsApiSpy = spectator.inject(AUDIO_RECORDING.token);

diff --git a/src/app/components/annotations/pages/annotationSearchParameters.ts b/src/app/components/annotations/pages/annotationSearchParameters.ts
@@ -1,4 +1,3 @@
-import { Injector } from "@angular/core";
 import { Params } from "@angular/router";
 import { Filters, InnerFilter } from "@baw-api/baw-api.service";
 import {
@@ -27,7 +26,7 @@ import { hasMany } from "@models/AssociationDecorators";
 import { AudioEvent } from "@models/AudioEvent";
 import { AudioRecording } from "@models/AudioRecording";
 import { IParameterModel } from "@models/data/parametersModel";
-import { ImplementsInjector } from "@models/ImplementsInjector";
+import { AssociationInjector, HasAssociationInjector } from "@models/ImplementsInjector";
 import { Project } from "@models/Project";
 import { Region } from "@models/Region";
 import { Site } from "@models/Site";
@@ -99,12 +98,12 @@ export class AnnotationSearchParameters
   extends AbstractData
   implements
     IAnnotationSearchParameters,
-    ImplementsInjector,
+    HasAssociationInjector,
     IParameterModel<AudioEvent>
 {
   public constructor(
     protected queryStringParameters: Params = {},
-    public injector?: Injector
+    public injector?: AssociationInjector
   ) {
     const deserializedObject: IAnnotationSearchParameters =
       deserializeParamsToObject<IAnnotationSearchParameters>(

diff --git a/src/app/components/annotations/pages/search/search.component.spec.ts b/src/app/components/annotations/pages/search/search.component.spec.ts
@@ -1,7 +1,7 @@
 import { createRoutingFactory, Spectator, SpyObject } from "@ngneat/spectator";
 import { Params } from "@angular/router";
 import { of } from "rxjs";
-import { CUSTOM_ELEMENTS_SCHEMA, INJECTOR, Injector } from "@angular/core";
+import { CUSTOM_ELEMENTS_SCHEMA } from "@angular/core";
 import { modelData } from "@test/helpers/faker";
 import {
   MEDIA,
@@ -34,14 +34,17 @@ import { generateAudioRecording } from "@test/fakes/AudioRecording";
 import { ShallowSitesService } from "@baw-api/site/sites.service";
 import { patchSharedArrayBuffer } from "src/patches/tests/testPatches";
 import { testAsset } from "@test/helpers/karma";
+import { assertPageInfo } from "@test/helpers/pageRoute";
+import { AssociationInjector } from "@models/ImplementsInjector";
+import { ASSOCIATION_INJECTOR } from "@services/association-injector/association-injector.tokens";
 import { AnnotationSearchParameters } from "../annotationSearchParameters";
 import { AnnotationSearchComponent } from "./search.component";
 
 describe("AnnotationSearchComponent", () => {
   const responsePageSize = 24;
 
   let spectator: Spectator<AnnotationSearchComponent>;
-  let injector: Injector;
+  let injector: AssociationInjector;
 
   let audioEventsApiSpy: SpyObject<ShallowAudioEventsService>;
   let mediaServiceSpy: SpyObject<MediaService>;
@@ -59,6 +62,12 @@ describe("AnnotationSearchComponent", () => {
   const createComponent = createRoutingFactory({
     component: AnnotationSearchComponent,
     imports: [MockBawApiModule, SharedModule, RouterTestingModule],
+    providers: [
+      {
+        provide: AnnotationService,
+        useValue: { show: () => mockAnnotationResponse },
+      },
+    ],
     schemas: [CUSTOM_ELEMENTS_SCHEMA],
   });
 
@@ -70,16 +79,10 @@ describe("AnnotationSearchComponent", () => {
         regionId: routeRegion.id,
         siteId: routeSite.id,
       },
-      providers: [
-        {
-          provide: AnnotationService,
-          useValue: { show: () => mockAnnotationResponse },
-        },
-      ],
       queryParams: queryParameters,
     });
 
-    injector = spectator.inject(INJECTOR);
+    injector = spectator.inject(ASSOCIATION_INJECTOR);
     mediaServiceSpy = spectator.inject(MEDIA.token);
     mediaServiceSpy.createMediaUrl = jasmine.createSpy("createMediaUrl") as any;
     mediaServiceSpy.createMediaUrl.and.returnValue(testAsset("example.flac"));
@@ -149,6 +152,8 @@ describe("AnnotationSearchComponent", () => {
     setup();
   }));
 
+  assertPageInfo(AnnotationSearchComponent, "Search Annotations");
+
   it("should create", () => {
     expect(spectator.component).toBeInstanceOf(AnnotationSearchComponent);
   });

diff --git a/src/app/components/annotations/pages/search/search.component.ts b/src/app/components/annotations/pages/search/search.component.ts
@@ -1,7 +1,7 @@
 import {
   Component,
   ElementRef,
-  Injector,
+  Inject,
   OnInit,
   ViewChild,
 } from "@angular/core";
@@ -28,6 +28,8 @@ import { firstValueFrom } from "rxjs";
 import { Region } from "@models/Region";
 import { Project } from "@models/Project";
 import { Site } from "@models/Site";
+import { ASSOCIATION_INJECTOR } from "@services/association-injector/association-injector.tokens";
+import { AssociationInjector } from "@models/ImplementsInjector";
 import { AnnotationSearchParameters } from "../annotationSearchParameters";
 
 const projectKey = "project";
@@ -51,7 +53,7 @@ class AnnotationSearchComponent
     protected config: NgbPaginationConfig,
     protected modals: NgbModal,
     protected annotationService: AnnotationService,
-    private injector: Injector
+    @Inject(ASSOCIATION_INJECTOR) private injector: AssociationInjector
   ) {
     super(
       router,

diff --git a/src/app/components/annotations/pages/verification/verification.component.spec.ts b/src/app/components/annotations/pages/verification/verification.component.spec.ts
@@ -22,7 +22,7 @@ import {
   SHALLOW_SITE,
   TAG,
 } from "@baw-api/ServiceTokens";
-import { CUSTOM_ELEMENTS_SCHEMA, INJECTOR, Injector } from "@angular/core";
+import { CUSTOM_ELEMENTS_SCHEMA } from "@angular/core";
 import { TagsService } from "@baw-api/tag/tags.service";
 import { VerificationGridComponent } from "@ecoacoustics/web-components/@types/components/verification-grid/verification-grid";
 import { VerificationHelpDialogComponent } from "@ecoacoustics/web-components/@types/components/verification-grid/help-dialog";
@@ -57,12 +57,14 @@ import { detectChanges } from "@test/helpers/changes";
 import { nodeModule, testAsset } from "@test/helpers/karma";
 import { patchSharedArrayBuffer } from "src/patches/tests/testPatches";
 import { ProgressWarningComponent } from "@components/annotations/components/modals/progress-warning/progress-warning.component";
+import { AssociationInjector } from "@models/ImplementsInjector";
+import { ASSOCIATION_INJECTOR } from "@services/association-injector/association-injector.tokens";
 import { AnnotationSearchParameters } from "../annotationSearchParameters";
 import { VerificationComponent } from "./verification.component";
 
 describe("VerificationComponent", () => {
   let spectator: SpectatorRouting<VerificationComponent>;
-  let injector: SpyObject<Injector>;
+  let injector: SpyObject<AssociationInjector>;
 
   let mockAudioEventsApi: SpyObject<ShallowAudioEventsService>;
   let mediaServiceSpy: SpyObject<MediaService>;
@@ -115,7 +117,7 @@ describe("VerificationComponent", () => {
       queryParams: queryParameters,
     });
 
-    injector = spectator.inject(INJECTOR);
+    injector = spectator.inject(ASSOCIATION_INJECTOR);
 
     mediaServiceSpy = spectator.inject(MEDIA.token);
     mediaServiceSpy.createMediaUrl = jasmine.createSpy("createMediaUrl") as any;

diff --git a/src/app/components/annotations/pages/verification/verification.component.ts b/src/app/components/annotations/pages/verification/verification.component.ts
@@ -2,7 +2,7 @@ import {
   AfterViewInit,
   Component,
   ElementRef,
-  Injector,
+  Inject,
   OnInit,
   ViewChild,
 } from "@angular/core";
@@ -40,6 +40,8 @@ import { ShallowAudioEventsService } from "@baw-api/audio-event/audio-events.ser
 import { AudioEvent } from "@models/AudioEvent";
 import { PageFetcherContext } from "@ecoacoustics/web-components/@types/services/gridPageFetcher";
 import { annotationResolvers, AnnotationService } from "@services/models/annotation.service";
+import { AssociationInjector } from "@models/ImplementsInjector";
+import { ASSOCIATION_INJECTOR } from "@services/association-injector/association-injector.tokens";
 import { AnnotationSearchParameters } from "../annotationSearchParameters";
 
 // TODO: using extends here makes the interface loosely typed
@@ -75,7 +77,7 @@ class VerificationComponent
     private route: ActivatedRoute,
     private router: Router,
     private location: Location,
-    private injector: Injector
+    @Inject(ASSOCIATION_INJECTOR) private injector: AssociationInjector
   ) {
     super();
   }

diff --git a/...pp/components/audio-recordings/components/download-table/download-table.component.spec.ts b/...pp/components/audio-recordings/components/download-table/download-table.component.spec.ts
@@ -1,4 +1,3 @@
-import { Injector } from "@angular/core";
 import { RouterTestingModule } from "@angular/router/testing";
 import { AudioRecordingsService } from "@baw-api/audio-recording/audio-recordings.service";
 import { Filters } from "@baw-api/baw-api.service";
@@ -18,12 +17,14 @@ import { generateSite } from "@test/fakes/Site";
 import { nStepObservable } from "@test/helpers/general";
 import { assertSpinner } from "@test/helpers/html";
 import { BehaviorSubject, Subject } from "rxjs";
+import { AssociationInjector } from "@models/ImplementsInjector";
+import { ASSOCIATION_INJECTOR } from "@services/association-injector/association-injector.tokens";
 import { DownloadTableComponent } from "./download-table.component";
 
 describe("DownloadTableComponent", () => {
   let defaultSite: Site;
   let defaultRecording: AudioRecording;
-  let injector: Injector;
+  let injector: AssociationInjector;
   let siteApi: SpyObject<ShallowSitesService>;
   let recordingApi: SpyObject<AudioRecordingsService>;
   let spec: Spectator<DownloadTableComponent>;
@@ -55,7 +56,9 @@ describe("DownloadTableComponent", () => {
     spec = createComponent({ detectChanges: false, props: { filters$ } });
     recordingApi = spec.inject(AudioRecordingsService);
     siteApi = spec.inject(SHALLOW_SITE.token);
-    injector = spec.inject(Injector);
+    injector = spec.inject(ASSOCIATION_INJECTOR);
+    // injector = spec.inject(Injector as any);
+    // console.log("service", injector.get(ToastrService));
     defaultRecording = new AudioRecording(generateAudioRecording(), injector);
     defaultSite = new Site(generateSite(), injector);
   }