SF-3532 Dispose realtime docs when no longer in use

Author: Nateowami

src/SIL.XForge.Scripture/ClientApp/e2e/workflows/community-checking.ts

@@ -174,6 +174,7 @@ async function joinAsChecker(
     // Give time for the last answer to be saved
     await page.waitForTimeout(500);
   } catch (e) {
+    if (preset.pauseOnFailure) await page.pause();
     console.error('Error running tests for checker ' + userNumber);
     console.error(e);
     await screenshot(

src/SIL.XForge.Scripture/ClientApp/src/app/app-routing.module.ts

@@ -14,6 +14,7 @@ import { ServalAdminAuthGuard } from './serval-administration/serval-admin-auth.
 import { ServalAdministrationComponent } from './serval-administration/serval-administration.component';
 import { ServalProjectComponent } from './serval-administration/serval-project.component';
 import { SettingsComponent } from './settings/settings.component';
+import { BlankPageComponent } from './shared/blank-page/blank-page.component';
 import { PageNotFoundComponent } from './shared/page-not-found/page-not-found.component';
 import { SettingsAuthGuard, SyncAuthGuard } from './shared/project-router.guard';
 import { SyncComponent } from './sync/sync.component';
@@ -33,6 +34,7 @@ const routes: Routes = [
   { path: 'serval-administration/:projectId', component: ServalProjectComponent, canActivate: [ServalAdminAuthGuard] },
   { path: 'serval-administration', component: ServalAdministrationComponent, canActivate: [ServalAdminAuthGuard] },
   { path: 'system-administration', component: SystemAdministrationComponent, canActivate: [SystemAdminAuthGuard] },
+  { path: 'blank-page', component: BlankPageComponent },
   { path: '**', component: PageNotFoundComponent }
 ];
 

src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts

@@ -24,6 +24,7 @@ import { FileService } from 'xforge-common/file.service';
 import { I18nService } from 'xforge-common/i18n.service';
 import { LocationService } from 'xforge-common/location.service';
 import { Breakpoint, MediaBreakpointService } from 'xforge-common/media-breakpoints/media-breakpoint.service';
+import { DocSubscription } from 'xforge-common/models/realtime-doc';
 import { UserDoc } from 'xforge-common/models/user-doc';
 import { NoticeService } from 'xforge-common/notice.service';
 import { OnlineStatusService } from 'xforge-common/online-status.service';
@@ -283,7 +284,8 @@ export class AppComponent extends DataLoadingComponent implements OnInit, OnDest
         this.userService.setCurrentProjectId(this.currentUserDoc!, this._selectedProjectDoc.id);
         this.projectUserConfigDoc = await this.projectService.getUserConfig(
           this._selectedProjectDoc.id,
-          this.currentUserDoc!.id
+          this.currentUserDoc!.id,
+          new DocSubscription('AppComponent', this.destroyRef)
         );
         if (this.selectedProjectDeleteSub != null) {
           this.selectedProjectDeleteSub.unsubscribe();

src/SIL.XForge.Scripture/ClientApp/src/app/app.component.ts

@@ -1,7 +1,7 @@
 import { OverlayContainer } from '@angular/cdk/overlay';
 import { DatePipe } from '@angular/common';
 import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http';
-import { APP_ID, ErrorHandler, NgModule, inject, provideAppInitializer } from '@angular/core';
+import { APP_ID, ErrorHandler, inject, NgModule, provideAppInitializer } from '@angular/core';
 import { MatRipple } from '@angular/material/core';
 import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
 import { ServiceWorkerModule } from '@angular/service-worker';
@@ -37,6 +37,7 @@ import { ProjectComponent } from './project/project.component';
 import { ScriptureChooserDialogComponent } from './scripture-chooser-dialog/scripture-chooser-dialog.component';
 import { DeleteProjectDialogComponent } from './settings/delete-project-dialog/delete-project-dialog.component';
 import { SettingsComponent } from './settings/settings.component';
+import { CacheService } from './shared/cache-service/cache.service';
 import { GlobalNoticesComponent } from './shared/global-notices/global-notices.component';
 import { SharedModule } from './shared/shared.module';
 import { TextNoteDialogComponent } from './shared/text/text-note-dialog/text-note-dialog.component';
@@ -46,6 +47,11 @@ import { LynxInsightsModule } from './translate/editor/lynx/insights/lynx-insigh
 import { TranslateModule } from './translate/translate.module';
 import { UsersModule } from './users/users.module';
 
+/** Initialization function for any services that need to be run but are not depended on by any component. */
+function initializeGlobalServicesFactory(_cacheService: CacheService): () => Promise<any> {
+  return () => Promise.resolve();
+}
+
 @NgModule({
   declarations: [
     AppComponent,
@@ -97,6 +103,10 @@ import { UsersModule } from './users/users.module';
     { provide: ErrorHandler, useClass: ExceptionHandlingService },
     { provide: OverlayContainer, useClass: InAppRootOverlayContainer },
     provideHttpClient(withInterceptorsFromDi()),
+    provideAppInitializer(() => {
+      const initializerFn = initializeGlobalServicesFactory(inject(CacheService));
+      return initializerFn();
+    }),
     provideAppInitializer(() => {
       const initializerFn = preloadEnglishTranslations(inject(TranslocoService));
       return initializerFn();

src/SIL.XForge.Scripture/ClientApp/src/app/app.module.ts

@@ -368,18 +368,18 @@ describe('ChapterAudioDialogComponent', () => {
     expect(result.timingData[1].to).toEqual(1.296);
   }));
 
-  it('will not save or upload if there is no audio', fakeAsync(() => {
+  it('will not save or upload if there is no audio', fakeAsync(async () => {
     env.component.prepareTimingFileUpload(env.timingFile);
-    env.component.save();
+    await env.component.save();
     env.fixture.detectChanges();
 
     expect(env.numberOfTimesDialogClosed).toEqual(0);
     expect(env.wrapperAudio.classList.contains('invalid')).toBe(true);
   }));
 
-  it('will not save or upload if there is no timing data', fakeAsync(() => {
+  it('will not save or upload if there is no timing data', fakeAsync(async () => {
     env.component.audioUpdate(env.audioFile);
-    env.component.save();
+    await env.component.save();
     env.fixture.detectChanges();
 
     expect(env.numberOfTimesDialogClosed).toEqual(0);
@@ -478,15 +478,15 @@ describe('ChapterAudioDialogComponent', () => {
     expect(env.wrapperTiming.classList.contains('valid')).toBe(true);
   }));
 
-  it('will not try to save dialog if offline', fakeAsync(() => {
+  it('will not try to save dialog if offline', fakeAsync(async () => {
     env.onlineStatus = false;
     env.component.audioUpdate(env.audioFile);
     tick();
     env.component.prepareTimingFileUpload(env.timingFile);
     tick();
 
     // SUT
-    env.component.save();
+    await env.component.save();
     tick();
     env.fixture.detectChanges();
     flush();