From 78bccbe47a46b49b100356756b8822cd10e25ae1 Mon Sep 17 00:00:00 2001 From: Nathaniel Paulus Date: Wed, 6 Aug 2025 16:06:18 -0400 Subject: [PATCH 01/42] Dispose realtime docs when no longer in use --- .../e2e/workflows/community-checking.ts | 1 + .../ClientApp/src/app/app-routing.module.ts | 2 + .../ClientApp/src/app/app.component.spec.ts | 46 ++- .../ClientApp/src/app/app.component.ts | 4 +- .../ClientApp/src/app/app.module.ts | 12 + .../checking-overview.component.spec.ts | 40 ++- .../checking-overview.component.ts | 12 +- .../checking-comments.stories.ts | 6 +- .../checking/checking-questions.service.ts | 25 +- .../checking-text.component.spec.ts | 14 +- .../checking/checking.component.spec.ts | 237 ++++++++------- .../checking/checking/checking.component.ts | 9 +- .../checking/checking/resume-base.service.ts | 7 +- .../checking/resume-checking.service.spec.ts | 6 +- .../checking/resume-translate.service.spec.ts | 6 +- .../import-questions-dialog.component.spec.ts | 12 +- .../import-questions-dialog.component.ts | 9 +- .../question-dialog.component.spec.ts | 27 +- .../question-dialog.service.spec.ts | 27 +- .../question-dialog.service.ts | 18 +- .../connect-project.component.spec.ts | 19 +- .../connect-project.component.ts | 6 +- .../app/core/models/note-thread-doc.spec.ts | 3 +- .../app/core/models/sf-project-base-doc.ts | 35 +-- .../src/app/core/permissions.service.spec.ts | 15 +- .../src/app/core/permissions.service.ts | 24 +- .../src/app/core/sf-project.service.ts | 64 ++-- .../src/app/core/text-doc.service.spec.ts | 17 +- .../src/app/core/text-doc.service.ts | 17 +- .../app/core/translation-engine.service.ts | 11 +- .../event-metrics-auth.guard.spec.ts | 4 +- .../event-metrics/event-metrics-auth.guard.ts | 7 +- .../src/app/navigation/navigation.stories.ts | 4 +- .../src/app/project/project.component.spec.ts | 5 +- .../src/app/project/project.component.ts | 9 +- .../draft-jobs.component.ts | 11 +- .../serval-administration.service.ts | 7 +- .../app/settings/settings.component.spec.ts | 4 +- .../src/app/settings/settings.component.ts | 5 +- .../blank-page/blank-page.component.html | 1 + .../blank-page/blank-page.component.scss | 0 .../shared/blank-page/blank-page.component.ts | 10 + .../cache-service/cache.service.spec.ts | 256 ++++++++-------- .../app/shared/cache-service/cache.service.ts | 53 ++-- .../diagnostic-overlay.component.html | 180 ++++++++--- .../diagnostic-overlay.component.scss | 44 ++- .../diagnostic-overlay.component.ts | 31 +- .../progress-service/progress.service.spec.ts | 66 ++-- .../progress-service/progress.service.ts | 29 +- .../src/app/shared/project-router.guard.ts | 72 +++-- .../share/share-control.component.spec.ts | 11 +- .../shared/share/share-control.component.ts | 3 +- .../share/share-dialog.component.spec.ts | 11 +- .../shared/share/share-dialog.component.ts | 3 +- .../app/shared/text/text.component.spec.ts | 27 +- .../src/app/shared/text/text.component.ts | 12 +- .../sync-progress.component.spec.ts | 33 +- .../sync-progress/sync-progress.component.ts | 6 +- .../src/app/sync/sync.component.spec.ts | 27 +- .../ClientApp/src/app/sync/sync.component.ts | 6 +- .../text-chooser-dialog.component.spec.ts | 3 +- .../biblical-term-dialog.component.spec.ts | 12 +- .../biblical-terms.component.spec.ts | 42 ++- .../biblical-terms.component.ts | 29 +- .../draft-apply-dialog.component.spec.ts | 2 +- .../draft-apply-dialog.component.ts | 11 +- .../draft-history-entry.component.spec.ts | 12 +- .../draft-history-entry.component.ts | 34 ++- .../draft-preview-books.component.spec.ts | 6 +- .../draft-preview-books.component.ts | 16 +- .../draft-sources.service.spec.ts | 10 +- .../draft-generation/draft-sources.service.ts | 14 +- .../draft-sources.component.spec.ts | 3 +- .../training-data.service.spec.ts | 10 +- .../training-data/training-data.service.ts | 26 +- .../editor-draft/editor-draft.component.ts | 5 +- .../editor-history.component.spec.ts | 4 +- .../editor-history.component.ts | 6 +- .../history-chooser.component.spec.ts | 4 +- .../history-chooser.component.ts | 20 +- .../editor-resource.component.spec.ts | 16 +- .../editor-resource.component.ts | 6 +- .../translate/editor/editor.component.spec.ts | 89 +++--- .../app/translate/editor/editor.component.ts | 39 ++- .../lynx-insights-panel.component.spec.ts | 2 +- .../lynx-insights-panel.component.ts | 39 +-- .../insights/lynx-workspace.service.spec.ts | 13 +- .../lynx/insights/lynx-workspace.service.ts | 13 +- .../note-dialog/note-dialog.component.spec.ts | 20 +- .../note-dialog/note-dialog.component.ts | 46 ++- ...gestions-settings-dialog.component.spec.ts | 281 ++++++++++++++++++ .../editor-tab-add-request.service.spec.ts | 12 +- .../tabs/editor-tab-add-request.service.ts | 11 +- ...-tab-add-resource-dialog.component.spec.ts | 4 +- ...ditor-tab-add-resource-dialog.component.ts | 15 +- .../editor-tab-persistence.service.spec.ts | 10 +- .../tabs/editor-tab-persistence.service.ts | 16 +- .../editor/translate-metrics-session.spec.ts | 12 +- .../training-progress.component.ts | 6 +- .../translate-overview.component.spec.ts | 17 +- .../translate-overview.component.ts | 6 +- .../collaborators.component.spec.ts | 25 +- .../collaborators/collaborators.component.ts | 12 +- .../roles-and-permissions-dialog.component.ts | 15 +- .../roles-and-permissions-dialog.spec.ts | 10 +- ...ivated-project-user-config.service.spec.ts | 12 +- .../activated-project-user-config.service.ts | 16 +- .../activated-project.service.ts | 22 +- .../src/xforge-common/file.service.spec.ts | 5 +- .../src/xforge-common/file.service.ts | 4 +- .../realtime-doc-lifecycle-monitor.spec.ts | 132 ++++++++ .../models/realtime-doc-lifecycle-monitor.ts | 98 ++++++ .../src/xforge-common/models/realtime-doc.ts | 79 ++++- .../xforge-common/models/realtime-query.ts | 22 +- .../xforge-common/owner/owner.component.ts | 11 +- .../src/xforge-common/project.service.ts | 19 +- .../src/xforge-common/realtime.service.ts | 118 ++++++-- .../xforge-common/user-projects.service.ts | 5 +- .../src/xforge-common/user.service.ts | 21 +- .../src/xforge-common/util/rxjs-util.ts | 9 +- src/SIL.XForge.Scripture/Startup.cs | 1 + 121 files changed, 2349 insertions(+), 897 deletions(-) create mode 100644 src/SIL.XForge.Scripture/ClientApp/src/app/shared/blank-page/blank-page.component.html create mode 100644 src/SIL.XForge.Scripture/ClientApp/src/app/shared/blank-page/blank-page.component.scss create mode 100644 src/SIL.XForge.Scripture/ClientApp/src/app/shared/blank-page/blank-page.component.ts create mode 100644 src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/suggestions-settings-dialog.component.spec.ts create mode 100644 src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-doc-lifecycle-monitor.spec.ts create mode 100644 src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-doc-lifecycle-monitor.ts diff --git a/src/SIL.XForge.Scripture/ClientApp/e2e/workflows/community-checking.ts b/src/SIL.XForge.Scripture/ClientApp/e2e/workflows/community-checking.ts index 912233e4bfa..5e88d0d4b4b 100644 --- a/src/SIL.XForge.Scripture/ClientApp/e2e/workflows/community-checking.ts +++ b/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) { + await page.pause(); console.error('Error running tests for checker ' + userNumber); console.error(e); await screenshot( diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/app-routing.module.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/app-routing.module.ts index 0db19784b17..7bec83b866d 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/app-routing.module.ts +++ b/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 } ]; diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts index 9f6146eb60a..1c755072d33 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts @@ -25,6 +25,7 @@ import { ExternalUrlService } from 'xforge-common/external-url.service'; import { FileService } from 'xforge-common/file.service'; import { I18nService } from 'xforge-common/i18n.service'; import { LocationService } from 'xforge-common/location.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'; @@ -698,11 +699,12 @@ class TestEnvironment { this.addProjectUserConfig('project01', 'user03'); this.addProjectUserConfig('project01', 'user04'); - when(mockedSFProjectService.getProfile(anything())).thenCall(projectId => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, projectId) + when(mockedSFProjectService.getProfile(anything(), anything())).thenCall((projectId, subscription) => + this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, projectId, subscription) ); - when(mockedSFProjectService.getUserConfig(anything(), anything())).thenCall((projectId, userId) => - this.realtimeService.subscribe(SFProjectUserConfigDoc.COLLECTION, `${projectId}:${userId}`) + when(mockedSFProjectService.getUserConfig(anything(), anything(), anything())).thenCall( + (projectId, userId, subscriber) => + this.realtimeService.subscribe(SFProjectUserConfigDoc.COLLECTION, `${projectId}:${userId}`, subscriber) ); when(mockedLocationService.pathname).thenReturn('/projects/project01/checking'); @@ -813,12 +815,14 @@ class TestEnvironment { } get currentUserDoc(): UserDoc { - return this.realtimeService.get(UserDoc.COLLECTION, 'user01'); + return this.realtimeService.get(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')); } setCurrentUser(userId: string): void { when(mockedUserService.currentUserId).thenReturn(userId); - when(mockedUserService.getCurrentUser()).thenCall(() => this.realtimeService.subscribe(UserDoc.COLLECTION, userId)); + when(mockedUserService.getCurrentUser()).thenCall(() => + this.realtimeService.subscribe(UserDoc.COLLECTION, userId, new DocSubscription('spec')) + ); } triggerLogin(): void { @@ -886,33 +890,53 @@ class TestEnvironment { when(mockedUserService.currentProjectId(anything())).thenReturn(undefined); } this.ngZone.run(() => { - const projectDoc = this.realtimeService.get(SFProjectProfileDoc.COLLECTION, projectId); + const projectDoc = this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + projectId, + new DocSubscription('spec') + ); projectDoc.delete(); }); this.wait(); } removeUserFromProject(projectId: string): void { - const projectDoc = this.realtimeService.get(SFProjectProfileDoc.COLLECTION, projectId); + const projectDoc = this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + projectId, + new DocSubscription('spec') + ); projectDoc.submitJson0Op(op => op.unset(p => p.userRoles['user01']), false); this.wait(); } updatePreTranslate(projectId: string): void { - const projectDoc = this.realtimeService.get(SFProjectProfileDoc.COLLECTION, projectId); + const projectDoc = this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + projectId, + new DocSubscription('spec') + ); projectDoc.submitJson0Op(op => op.set(p => p.translateConfig.preTranslate, true), false); this.wait(); } addUserToProject(projectId: string): void { - const projectDoc = this.realtimeService.get(SFProjectProfileDoc.COLLECTION, projectId); + const projectDoc = this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + projectId, + new DocSubscription('spec') + ); projectDoc.submitJson0Op(op => op.set(p => p.userRoles['user01'], SFProjectRole.CommunityChecker), false); this.currentUserDoc.submitJson0Op(op => op.add(u => u.sites['sf'].projects, 'project04'), false); this.wait(); } changeUserRole(projectId: string, userId: string, role: SFProjectRole): void { - const projectDoc = this.realtimeService.get(SFProjectProfileDoc.COLLECTION, projectId); + const projectDoc = this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + projectId, + new DocSubscription('spec') + ); projectDoc.submitJson0Op(op => op.set(p => p.userRoles[userId], role), false); this.wait(); } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.ts index 07c16da9fa3..cc617a1f2de 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.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'; @@ -282,7 +283,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(); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/app.module.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/app.module.ts index ce2fc9e637b..85b8d961676 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/app.module.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/app.module.ts @@ -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 { + return () => Promise.resolve(); +} + @NgModule({ declarations: [ AppComponent, @@ -97,6 +103,12 @@ import { UsersModule } from './users/users.module'; { provide: ErrorHandler, useClass: ExceptionHandlingService }, { provide: OverlayContainer, useClass: InAppRootOverlayContainer }, provideHttpClient(withInterceptorsFromDi()), + { + provide: APP_INITIALIZER, + useFactory: initializeGlobalServicesFactory, + deps: [CacheService], + multi: true + }, { provide: APP_INITIALIZER, useFactory: preloadEnglishTranslations, diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts index fe0dfe40144..97e6ee3d088 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts @@ -29,6 +29,7 @@ import { VerseRefData } from 'realtime-server/lib/esm/scriptureforge/models/vers import { of } from 'rxjs'; import { anything, mock, resetCalls, verify, when } from 'ts-mockito'; import { DialogService } from 'xforge-common/dialog.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { noopDestroyRef } from 'xforge-common/realtime.service'; @@ -420,7 +421,8 @@ describe('CheckingOverviewComponent', () => { const env = new TestEnvironment(); const questionDoc: QuestionDoc = env.realtimeService.get( QuestionDoc.COLLECTION, - getQuestionDocId('project01', 'q7Id') + getQuestionDocId('project01', 'q7Id'), + new DocSubscription('spec') ); await questionDoc.submitJson0Op(op => { op.set(d => d.isArchived, false); @@ -973,18 +975,26 @@ class TestEnvironment { when(mockedActivatedRoute.params).thenReturn(of({ projectId: 'project01' })); when(mockedQuestionDialogService.questionDialog(anything())).thenResolve(); when(mockedDialogService.confirm(anything(), anything())).thenResolve(true); - when(mockedProjectService.getProfile(anything())).thenCall(id => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id) + when(mockedProjectService.getProfile(anything(), anything())).thenCall((id, subscription) => + this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id, subscription) ); - when(mockedProjectService.getUserConfig(anything(), anything())).thenCall((id, userId) => - this.realtimeService.subscribe(SFProjectUserConfigDoc.COLLECTION, getSFProjectUserConfigDocId(id, userId)) + when(mockedProjectService.getUserConfig(anything(), anything(), anything())).thenCall((id, userId, subscriber) => + this.realtimeService.subscribe( + SFProjectUserConfigDoc.COLLECTION, + getSFProjectUserConfigDocId(id, userId), + subscriber + ) ); when(mockedQuestionsService.queryQuestions('project01', anything(), anything())).thenCall(() => this.realtimeService.subscribeQuery(QuestionDoc.COLLECTION, {}, noopDestroyRef) ); when(mockedProjectService.onlineDeleteAudioTimingData(anything(), anything(), anything())).thenCall( (projectId, book, chapter) => { - const projectDoc = this.realtimeService.get(SFProjectProfileDoc.COLLECTION, projectId); + const projectDoc = this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + projectId, + new DocSubscription('spec') + ); const textIndex: number = projectDoc.data!.texts.findIndex(t => t.bookNum === book); const chapterIndex: number = projectDoc.data!.texts[textIndex].chapters.findIndex(c => c.number === chapter); projectDoc.submitJson0Op(op => op.set(p => p.texts[textIndex].chapters[chapterIndex].hasAudio, false), false); @@ -1154,7 +1164,11 @@ class TestEnvironment { } setSeeOtherUserResponses(isEnabled: boolean): void { - const projectDoc = this.realtimeService.get(SFProjectProfileDoc.COLLECTION, 'project01'); + const projectDoc = this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + 'project01', + new DocSubscription('spec') + ); projectDoc.submitJson0Op( op => op.set(p => p.checkingConfig.usersSeeEachOthersResponses, isEnabled), false @@ -1164,7 +1178,11 @@ class TestEnvironment { setCheckingEnabled(isEnabled: boolean): void { this.ngZone.run(() => { - const projectDoc = this.realtimeService.get(SFProjectProfileDoc.COLLECTION, 'project01'); + const projectDoc = this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + 'project01', + new DocSubscription('spec') + ); projectDoc.submitJson0Op(op => op.set(p => p.checkingConfig.checkingEnabled, isEnabled), false); }); this.waitForProjectDocChanges(); @@ -1224,7 +1242,11 @@ class TestEnvironment { ], permissions: {} }; - const projectDoc = this.realtimeService.get(SFProjectProfileDoc.COLLECTION, 'project01'); + const projectDoc = this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + 'project01', + new DocSubscription('spec') + ); const index: number = projectDoc.data!.texts.length - 1; projectDoc.submitJson0Op(op => op.insert(p => p.texts, index, text), false); this.addQuestion({ diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.ts index 36f28d63220..cb05826a685 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.ts @@ -13,6 +13,7 @@ import { DataLoadingComponent } from 'xforge-common/data-loading-component'; import { DialogService } from 'xforge-common/dialog.service'; import { I18nService } from 'xforge-common/i18n.service'; import { L10nNumberPipe } from 'xforge-common/l10n-number.pipe'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeQuery } from 'xforge-common/models/realtime-query'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; @@ -181,7 +182,10 @@ export class CheckingOverviewComponent extends DataLoadingComponent implements O const projectId$ = this.activatedRoute.params.pipe( tap(params => { this.loadingStarted(); - projectDocPromise = this.projectService.getProfile(params['projectId']); + projectDocPromise = this.projectService.getProfile( + params['projectId'], + new DocSubscription('CheckingOverviewComponent', this.destroyRef) + ); }), map(params => params['projectId'] as string) ); @@ -190,7 +194,11 @@ export class CheckingOverviewComponent extends DataLoadingComponent implements O this.projectId = projectId; try { this.projectDoc = await projectDocPromise; - this.projectUserConfigDoc = await this.projectService.getUserConfig(projectId, this.userService.currentUserId); + this.projectUserConfigDoc = await this.projectService.getUserConfig( + projectId, + this.userService.currentUserId, + new DocSubscription('CheckingOverviewComponent', this.destroyRef) + ); this.questionsQuery?.dispose(); this.questionsQuery = await this.checkingQuestionsService.queryQuestions( projectId, diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking-answers/checking-comments/checking-comments.stories.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking-answers/checking-comments/checking-comments.stories.ts index d7fa30b6fe3..610d1456fc0 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking-answers/checking-comments/checking-comments.stories.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking-answers/checking-comments/checking-comments.stories.ts @@ -4,7 +4,7 @@ import { expect, within } from '@storybook/test'; import { createTestUserProfile } from 'realtime-server/lib/esm/common/models/user-test-data'; import { Comment } from 'realtime-server/lib/esm/scriptureforge/models/comment'; import { createTestProject } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-test-data'; -import { instance, mock, when } from 'ts-mockito'; +import { anything, instance, mock, when } from 'ts-mockito'; import { DialogService } from 'xforge-common/dialog.service'; import { I18nStoryModule } from 'xforge-common/i18n-story.module'; import { UserProfileDoc } from 'xforge-common/models/user-profile-doc'; @@ -17,11 +17,11 @@ import { CheckingCommentsComponent } from './checking-comments.component'; const mockedDialogService = mock(DialogService); const mockedUserService = mock(UserService); when(mockedUserService.currentUserId).thenReturn('user01'); -when(mockedUserService.getProfile('user01')).thenResolve({ +when(mockedUserService.getProfile('user01', anything())).thenResolve({ id: 'user01', data: createTestUserProfile({}, 1) } as UserProfileDoc); -when(mockedUserService.getProfile('user02')).thenResolve({ +when(mockedUserService.getProfile('user02', anything())).thenResolve({ id: 'user02', data: createTestUserProfile({}, 2) } as UserProfileDoc); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking-questions.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking-questions.service.ts index 18b946ffa0b..1556a8a23e8 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking-questions.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking-questions.service.ts @@ -6,6 +6,7 @@ import { VerseRefData } from 'realtime-server/lib/esm/scriptureforge/models/vers import { Subject } from 'rxjs'; import { FileService } from 'xforge-common/file.service'; import { FileType } from 'xforge-common/models/file-offline-data'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeQuery } from 'xforge-common/models/realtime-query'; import { ComparisonOperator, QueryParameters, Sort } from 'xforge-common/query-parameters'; import { RealtimeService } from 'xforge-common/realtime.service'; @@ -74,7 +75,12 @@ export class CheckingQuestionsService { queryParams.$sort = this.getQuestionSortParams('ascending'); } - return this.realtimeService.subscribeQuery(QuestionDoc.COLLECTION, queryParams, destroyRef); + return this.realtimeService.subscribeQuery( + QuestionDoc.COLLECTION, + 'query_questions ' + JSON.stringify(options), + queryParams, + destroyRef + ); } /** @@ -144,7 +150,12 @@ export class CheckingQuestionsService { $sort: this.getQuestionSortParams(prevOrNext === 'next' ? 'ascending' : 'descending') }; - return this.realtimeService.subscribeQuery(QuestionDoc.COLLECTION, queryParams, destroyRef); + return this.realtimeService.subscribeQuery( + QuestionDoc.COLLECTION, + 'query_adjacent_questions', + queryParams, + destroyRef + ); } async queryFirstUnansweredQuestion( @@ -166,12 +177,18 @@ export class CheckingQuestionsService { $sort: this.getQuestionSortParams('ascending'), $limit: 1 }; - return this.realtimeService.subscribeQuery(QuestionDoc.COLLECTION, queryParams, destroyRef); + return this.realtimeService.subscribeQuery( + QuestionDoc.COLLECTION, + 'query_first_unanswered_question', + queryParams, + destroyRef + ); } async createQuestion( id: string, question: Question, + subscriber: DocSubscription, audioFileName?: string, audioBlob?: Blob ): Promise { @@ -202,7 +219,7 @@ export class CheckingQuestionsService { }); return this.realtimeService - .create(QuestionDoc.COLLECTION, docId, question) + .create(QuestionDoc.COLLECTION, docId, question, subscriber) .then((questionDoc: QuestionDoc) => { this.afterQuestionCreated$.next(questionDoc); return questionDoc; diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking-text/checking-text.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking-text/checking-text.component.spec.ts index f51d96a4e4d..739cc23016e 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking-text/checking-text.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking-text/checking-text.component.spec.ts @@ -8,6 +8,7 @@ import { createTestProjectProfile } from 'realtime-server/lib/esm/scriptureforge import * as RichText from 'rich-text'; import { anything, mock, when } from 'ts-mockito'; import { DialogService } from 'xforge-common/dialog.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserDoc } from 'xforge-common/models/user-doc'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { TestOnlineStatusModule } from 'xforge-common/test-online-status.module'; @@ -207,14 +208,17 @@ class TestEnvironment { } }) }); - when(mockedSFProjectService.getProfile('project01')).thenCall(() => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, 'project01') + when(mockedSFProjectService.getProfile('project01', anything())).thenCall(() => + this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, 'project01', new DocSubscription('spec')) ); - when(mockedSFProjectService.getText(anything())).thenCall(id => - this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString()) + when(mockedSFProjectService.getProfile('project01', anything())).thenCall((id, subscription) => + this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id, subscription) + ); + when(mockedSFProjectService.getText(anything(), anything())).thenCall((id, subscriber) => + this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString(), subscriber) ); when(mockedUserService.getCurrentUser()).thenCall(() => - this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01') + this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')) ); this.fixture = TestBed.createComponent(CheckingTextComponent); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts index ad5cf30fe0a..057510f3acb 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts @@ -40,6 +40,7 @@ import { anyString, anything, instance, mock, reset, resetCalls, spy, verify, wh import { DialogService } from 'xforge-common/dialog.service'; import { FileService } from 'xforge-common/file.service'; import { createStorageFileData, FileOfflineData, FileType } from 'xforge-common/models/file-offline-data'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeQuery } from 'xforge-common/models/realtime-query'; import { Snapshot } from 'xforge-common/models/snapshot'; import { UserDoc } from 'xforge-common/models/user-doc'; @@ -193,7 +194,7 @@ describe('CheckingComponent', () => { env.component.checkSliderPosition({ sizes: ['*', 20] }); env.waitForSliderUpdate(); expect(env.component.splitComponent?.getVisibleAreaSizes()[1]).toBeGreaterThan(1); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -227,6 +228,7 @@ describe('CheckingComponent', () => { tick(env.questionReadTimer); const nextQuestion = env.currentQuestion; expect(nextQuestion).toEqual(2); + flush(1000); })); it('can navigate using previous button', fakeAsync(() => { @@ -236,6 +238,7 @@ describe('CheckingComponent', () => { tick(env.questionReadTimer); const nextQuestion = env.currentQuestion; expect(nextQuestion).toEqual(1); + flush(1000); })); it('prev/next disabled state based on existence of prev/next question', fakeAsync(() => { @@ -312,7 +315,7 @@ describe('CheckingComponent', () => { env.waitForAudioPlayer(); discardPeriodicTasks(); - flush(); + flush(1000); })); }); @@ -329,7 +332,7 @@ describe('CheckingComponent', () => { env.fixture.detectChanges(); tick(); expect(getAdjacentQuestionSpy).toHaveBeenCalledWith(undefined, 'next'); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -338,21 +341,21 @@ describe('CheckingComponent', () => { env.clickButton(env.addQuestionButton); verify(mockedQuestionDialogService.questionDialog(anything())).once(); expect().nothing(); - flush(); + flush(1000); discardPeriodicTasks(); })); it('hides add question button for community checker', fakeAsync(() => { const env = new TestEnvironment({ user: CHECKER_USER }); expect(env.addQuestionButton).toBeNull(); - flush(); + flush(1000); discardPeriodicTasks(); })); it('hides add audio button for community checker', fakeAsync(() => { const env = new TestEnvironment({ user: CHECKER_USER }); expect(env.addAudioButton).toBeNull(); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -360,7 +363,7 @@ describe('CheckingComponent', () => { const env = new TestEnvironment({ user: ADMIN_USER }); expect(env.addAudioButton).not.toBeNull(); expect(env.addQuestionButton).not.toBeNull(); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -369,7 +372,7 @@ describe('CheckingComponent', () => { env.fixture.detectChanges(); expect(env.addAudioButton).not.toBeNull(); expect(env.addQuestionButton).toBeNull(); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -378,7 +381,7 @@ describe('CheckingComponent', () => { env.fixture.detectChanges(); expect(env.addAudioButton).toBeNull(); expect(env.addQuestionButton).not.toBeNull(); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -396,6 +399,7 @@ describe('CheckingComponent', () => { expect(env.component.projectDoc).toBeUndefined(); expect(env.component.questionDocs.length).toEqual(0); env.waitForSliderUpdate(); + flush(1000); })); it('responds to remote community checking disabled when checker', fakeAsync(() => { @@ -407,6 +411,7 @@ describe('CheckingComponent', () => { env.setCheckingEnabled(false); expect(env.component.projectDoc).toBeUndefined(); env.waitForSliderUpdate(); + flush(1000); })); it('responds to remote community checking disabled when observer', fakeAsync(() => { @@ -417,6 +422,7 @@ describe('CheckingComponent', () => { expect(env.component.projectDoc).toBeUndefined(); expect(env.component.questionDocs.length).toEqual(0); env.waitForSliderUpdate(); + flush(1000); })); }); @@ -475,7 +481,7 @@ describe('CheckingComponent', () => { // Question 5 has been stored as the question to start at, but route book/chapter is forced to MAT 1, // so active question must be from MAT 1 expect(env.component.questionsList!.activeQuestionDoc!.data!.dataId).toBe('q16Id'); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -490,7 +496,7 @@ describe('CheckingComponent', () => { env.setBookChapter('JHN', 2); env.fixture.detectChanges(); expect(env.component.questionsList!.activeQuestionDoc!.data!.dataId).toBe('q15Id'); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -510,7 +516,7 @@ describe('CheckingComponent', () => { env.fixture.detectChanges(); expect(env.component.questionsList!.activeQuestionDoc).toBe(undefined); expect(env.component.chapter).toEqual(3); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -536,7 +542,7 @@ describe('CheckingComponent', () => { env.fixture.detectChanges(); expect(question.classes['question-answered']).toBe(true); tick(); - flush(); + flush(1000); })); it('question shows answers icon and total', fakeAsync(() => { @@ -547,6 +553,7 @@ describe('CheckingComponent', () => { env.fixture.detectChanges(); expect(env.getUnread(question)).toEqual(0); env.waitForAudioPlayer(); + flush(1000); })); it('allows admin to archive a question', fakeAsync(async () => { @@ -569,6 +576,7 @@ describe('CheckingComponent', () => { expect(env.component.questionDocs.length).toEqual(13); expect(env.component.questionVerseRefs.length).toEqual(13); expect(env.component.questionsList!.activeQuestionDoc!.id).toBe('project01:q3Id'); + flush(1000); })); it('opens a dialog when edit question is clicked', fakeAsync(() => { @@ -594,6 +602,7 @@ describe('CheckingComponent', () => { mockedFileService.findOrUpdateCache(FileType.Audio, QuestionDoc.COLLECTION, questionId, 'audioFile.mp3') ).times(3); expect().nothing(); + flush(1000); })); it('removes audio player when question audio deleted', fakeAsync(() => { @@ -620,7 +629,7 @@ describe('CheckingComponent', () => { verify(mockedFileService.findOrUpdateCache(FileType.Audio, QuestionDoc.COLLECTION, questionId, undefined)).times( 3 ); - flush(); + flush(1000); })); it('uploads audio then updates audio url', fakeAsync(() => { @@ -649,7 +658,7 @@ describe('CheckingComponent', () => { expect(env.component.answersPanel?.getFileSource(questionDoc.data?.audioUrl)).toBeDefined(); verify(mockedFileService.findOrUpdateCache(FileType.Audio, 'questions', questionId, 'anAudioFile.mp3')).once(); env.waitForAudioPlayer(); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -664,6 +673,7 @@ describe('CheckingComponent', () => { env.clickButton(env.editQuestionButton); verify(mockedDialogService.confirm(anything(), anything())).twice(); verify(mockedQuestionDialogService.questionDialog(anything())).once(); + flush(1000); expect().nothing(); })); @@ -693,6 +703,7 @@ describe('CheckingComponent', () => { expect(env.segmentHasQuestion(1, 5)).toBe(true); expect(env.component.questionVerseRefs.some(verseRef => verseRef.equals(new VerseRef('JHN 1:5')))).toBe(true); env.waitForQuestionTimersToComplete(); + flush(1000); })); it('records audio for question when button clicked', fakeAsync(() => { @@ -717,7 +728,7 @@ describe('CheckingComponent', () => { anything() ) ).once(); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -725,6 +736,7 @@ describe('CheckingComponent', () => { const env = new TestEnvironment({ user: ADMIN_USER }); env.selectQuestion(15); expect(env.recordQuestionButton).toBeNull(); + flush(1000); })); it('unread answers badge is only visible when the setting is ON to see other answers', fakeAsync(() => { @@ -732,7 +744,7 @@ describe('CheckingComponent', () => { expect(env.getUnread(env.questions[5])).toEqual(1); env.setSeeOtherUserResponses(false); expect(env.getUnread(env.questions[5])).toEqual(0); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -742,7 +754,7 @@ describe('CheckingComponent', () => { expect(env.getUnread(env.questions[6])).toEqual(0); env.setSeeOtherUserResponses(false); expect(env.getUnread(env.questions[6])).toEqual(0); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -825,7 +837,7 @@ describe('CheckingComponent', () => { verify( mockedFileService.findOrUpdateCache(FileType.Audio, QuestionDoc.COLLECTION, 'q2Id', 'filename2.mp3') ).times(5); - flush(); + flush(1000); })); it('question added to another book changes the route to that book and activates the question', fakeAsync(() => { @@ -847,6 +859,7 @@ describe('CheckingComponent', () => { expect(env.location.path()).toEqual('/projects/project01/checking/MAT/1?scope=book'); env.activateQuestion('q1Id'); expect(env.location.path()).toEqual('/projects/project01/checking/JHN/1?scope=book'); + flush(1000); })); it('admin can see appropriate filter options', fakeAsync(() => { @@ -865,7 +878,7 @@ describe('CheckingComponent', () => { expect(env.component.questionFilters.has(QuestionFilter.CurrentUserHasNotAnswered)) .withContext('CurrentUserHasNotAnswered') .toEqual(false); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -885,7 +898,7 @@ describe('CheckingComponent', () => { expect(env.component.questionFilters.has(QuestionFilter.CurrentUserHasNotAnswered)) .withContext('CurrentUserHasNotAnswered') .toEqual(true); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -918,6 +931,7 @@ describe('CheckingComponent', () => { .withContext(env.component.appliedQuestionFilterKey ?? '') .toEqual(`(${expectedVisibleQuestionTotal})`); }); + flush(1000); })); it('show no questions message for filter', fakeAsync(() => { @@ -931,6 +945,7 @@ describe('CheckingComponent', () => { env.setQuestionFilter(QuestionFilter.StatusExport); expect(env.questions.length).toEqual(0); expect(env.noQuestionsFound).not.toBeNull(); + flush(1000); })); it('should update question summary when filtered', fakeAsync(() => { @@ -949,7 +964,7 @@ describe('CheckingComponent', () => { expect(env.questions.length).toEqual(10); // The first question after filter has now been read expect(env.component.summary.unread).toEqual(9); - flush(); + flush(1000); })); it('should reset filtering after a new question is added', fakeAsync(() => { @@ -971,6 +986,7 @@ describe('CheckingComponent', () => { expect(env.component.activeQuestionFilter).toEqual(QuestionFilter.None); expect(env.questions.length).toEqual(14); env.waitForQuestionTimersToComplete(); + flush(1000); })); it('should not reset scope after a user changes chapter', fakeAsync(() => { @@ -987,6 +1003,7 @@ describe('CheckingComponent', () => { env.fixture.detectChanges(); expect(env.component.activeQuestionScope).toEqual('chapter'); env.waitForQuestionTimersToComplete(); + flush(1000); })); it('should not reset scope after a user changes book', fakeAsync(() => { @@ -1003,6 +1020,7 @@ describe('CheckingComponent', () => { env.fixture.detectChanges(); expect(env.component.activeQuestionScope).toEqual('book'); env.waitForQuestionTimersToComplete(); + flush(1000); })); it('can narrow questions scope', fakeAsync(() => { @@ -1022,7 +1040,7 @@ describe('CheckingComponent', () => { env.fixture.detectChanges(); expect(env.questions.length).toEqual(14); tick(); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1043,7 +1061,7 @@ describe('CheckingComponent', () => { env.fixture.detectChanges(); expect(env.questions.length).toEqual(16); tick(); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1054,7 +1072,7 @@ describe('CheckingComponent', () => { }); expect(env.questions.length).toBeGreaterThan(0); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1077,6 +1095,7 @@ describe('CheckingComponent', () => { expect(spyUpdateQuestionRefs).toHaveBeenCalledTimes(1); // Called at least once or more depending on if another question replaces the archived question expect(spyRefreshSummary).toHaveBeenCalled(); + flush(1000); })); describe('Question Filter', () => { @@ -1097,7 +1116,7 @@ describe('CheckingComponent', () => { const filtered = env.component['filterQuestions']([questionRemaining, questionExcluded]); expect(filtered.length).toBe(1); expect(filtered[0]).toBe(questionRemaining); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1123,7 +1142,7 @@ describe('CheckingComponent', () => { const filtered = env.component['filterQuestions']([questionRemaining, questionExcluded]); expect(filtered.length).toBe(1); expect(filtered[0]).toBe(questionRemaining); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1149,7 +1168,7 @@ describe('CheckingComponent', () => { const filtered = env.component['filterQuestions']([questionRemaining, questionExcluded]); expect(filtered.length).toBe(1); expect(filtered[0]).toBe(questionRemaining); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1175,7 +1194,7 @@ describe('CheckingComponent', () => { const filtered = env.component['filterQuestions']([questionRemaining, questionExcluded]); expect(filtered.length).toBe(1); expect(filtered[0]).toBe(questionRemaining); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1211,7 +1230,7 @@ describe('CheckingComponent', () => { filtered = env.component['filterQuestions']([questionRemainingNoneStatus, questionExcluded]); expect(filtered.length).toBe(1); expect(filtered[0]).toBe(questionRemainingNoneStatus); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1237,7 +1256,7 @@ describe('CheckingComponent', () => { const filtered = env.component['filterQuestions']([questionRemaining, questionExcluded]); expect(filtered.length).toBe(1); expect(filtered[0]).toBe(questionRemaining); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1263,7 +1282,7 @@ describe('CheckingComponent', () => { const filtered = env.component['filterQuestions']([questionRemaining, questionExcluded]); expect(filtered.length).toBe(1); expect(filtered[0]).toBe(questionRemaining); - flush(); + flush(1000); discardPeriodicTasks(); })); }); @@ -1273,7 +1292,7 @@ describe('CheckingComponent', () => { it('answer panel is initiated and shows the first question', fakeAsync(() => { const env = new TestEnvironment({ user: CHECKER_USER }); expect(env.answerPanel).not.toBeNull(); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1286,7 +1305,7 @@ describe('CheckingComponent', () => { expect(env.answers.length).toEqual(1); expect(env.getAnswerText(0)).toBe('Answer question 2'); expect(env.component.summary.answered).toEqual(3); - flush(); + flush(1000); })); it('opens edit display name dialog if answering a question for the first time', fakeAsync(() => { @@ -1296,7 +1315,7 @@ describe('CheckingComponent', () => { verify(mockedUserService.editDisplayName(true)).once(); expect(env.answers.length).toEqual(1); expect(env.getAnswerText(0)).toBe('Answering question 2 should pop up a dialog'); - flush(); + flush(1000); })); it('does not open edit display name dialog if offline', fakeAsync(() => { @@ -1312,7 +1331,7 @@ describe('CheckingComponent', () => { verify(mockedUserService.editDisplayName(anything())).never(); expect(env.answers.length).toEqual(1); expect(env.getAnswerText(0)).toBe('Answering question 2 offline'); - flush(); + flush(1000); })); it('inserts newer answer above older answers', fakeAsync(() => { @@ -1322,7 +1341,7 @@ describe('CheckingComponent', () => { expect(env.answers.length).toEqual(2); expect(env.getAnswerText(0)).toBe('Just added answer'); expect(env.getAnswerText(1)).toBe('Answer 7 on question'); - flush(); + flush(1000); })); it('saves the last visited question', fakeAsync(() => { @@ -1364,7 +1383,7 @@ describe('CheckingComponent', () => { env.waitForSliderUpdate(); expect(env.yourAnswerField).toBeNull(); expect(env.addAnswerButton).not.toBeNull(); - flush(); + flush(1000); })); it('does not save the answer when storage quota exceeded', fakeAsync(() => { @@ -1401,7 +1420,7 @@ describe('CheckingComponent', () => { const questionDoc = env.component.questionsList!.activeQuestionDoc!; expect(questionDoc.data!.answers.length).toEqual(0); expect(env.saveAnswerButton).not.toBeNull(); - flush(); + flush(1000); })); it('check answering validation', fakeAsync(() => { @@ -1411,7 +1430,7 @@ describe('CheckingComponent', () => { env.clickButton(env.saveAnswerButton); env.waitForSliderUpdate(); expect(env.answerFormErrors[0].classes['visible']).toBe(true); - flush(); + flush(1000); })); it('can edit a new answer', fakeAsync(() => { @@ -1429,7 +1448,7 @@ describe('CheckingComponent', () => { expect(env.getAnswer(myAnswerIndex).classes['attention']).toBe(true); expect(env.getAnswer(otherAnswerIndex).classes['attention']).toBeUndefined(); expect(env.getAnswerText(0)).toBe('Edited question 7 answer'); - flush(); + flush(1000); })); it('can edit an existing answer', fakeAsync(() => { @@ -1467,7 +1486,7 @@ describe('CheckingComponent', () => { .toBeUndefined(); expect(env.getAnswer(otherAnswerIndex).classes['attention']).toBeUndefined(); expect(env.getAnswerText(myAnswerIndex)).withContext('should not have been changed').toEqual('Edited answer'); - flush(); + flush(1000); })); it('highlights remotely edited answer', fakeAsync(() => { @@ -1480,7 +1499,7 @@ describe('CheckingComponent', () => { env.simulateRemoteEditAnswer(otherAnswerIndex, 'Question 9 edited answer'); expect(env.getAnswer(otherAnswerIndex).classes['attention']).toBe(true); expect(env.getAnswerText(otherAnswerIndex)).toBe('Question 9 edited answer'); - flush(); + flush(1000); })); it('does not highlight upon sync', fakeAsync(() => { @@ -1493,7 +1512,7 @@ describe('CheckingComponent', () => { env.simulateSync(answerIndex); expect(env.getAnswer(answerIndex).classes['attention']).toBeUndefined(); expect(env.getAnswerText(answerIndex)).toBe('Answer 1 on question'); - flush(); + flush(1000); })); it('still shows answers as read after canceling an edit', fakeAsync(() => { @@ -1511,7 +1530,7 @@ describe('CheckingComponent', () => { expect(env.getAnswer(myAnswerIndex).classes['attention']).toBeUndefined(); expect(env.getAnswer(otherAnswerIndex).classes['attention']).toBeUndefined(); expect(env.getAnswerText(0)).toEqual('Answer question 7'); - flush(); + flush(1000); })); it('only my answer is highlighted after I add an answer', fakeAsync(() => { @@ -1523,7 +1542,7 @@ describe('CheckingComponent', () => { const otherAnswerIndex = 1; expect(env.getAnswer(myAnswerIndex).classes['attention']).toBe(true); expect(env.getAnswer(otherAnswerIndex).classes['attention']).toBeUndefined(); - flush(); + flush(1000); })); it('can remove audio from answer', fakeAsync(() => { @@ -1539,7 +1558,7 @@ describe('CheckingComponent', () => { mockedFileService.deleteFile(FileType.Audio, 'project01', QuestionDoc.COLLECTION, 'a6Id', CHECKER_USER.id) ).once(); expect().nothing(); - flush(); + flush(1000); })); it('saves audio answer offline and plays from cache', fakeAsync(() => { @@ -1571,7 +1590,7 @@ describe('CheckingComponent', () => { expect(newAnswer.audioUrl).toEqual('blob://audio'); expect(env.component.answersPanel?.getFileSource(newAnswer.audioUrl)).toBeDefined(); verify(mockedFileService.findOrUpdateCache(FileType.Audio, 'questions', anything(), 'blob://audio')).once(); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1587,7 +1606,7 @@ describe('CheckingComponent', () => { resolveUpload$.next(); env.waitForSliderUpdate(); expect(question.data!.answers.length).toEqual(1); - flush(); + flush(1000); })); it('can delete an answer', fakeAsync(() => { @@ -1600,7 +1619,7 @@ describe('CheckingComponent', () => { verify( mockedFileService.deleteFile(FileType.Audio, 'project01', QuestionDoc.COLLECTION, 'a6Id', CHECKER_USER.id) ).once(); - flush(); + flush(1000); })); it('can delete correct answer after changing chapters', fakeAsync(() => { @@ -1611,7 +1630,7 @@ describe('CheckingComponent', () => { env.clickButton(env.answerDeleteButton(0)); env.waitForSliderUpdate(); expect(env.answers.length).toEqual(0); - flush(); + flush(1000); })); it('answers reset when changing questions', fakeAsync(() => { @@ -1621,6 +1640,7 @@ describe('CheckingComponent', () => { expect(env.answers.length).toEqual(1); env.selectQuestion(1); expect(env.answers.length).toEqual(0); + flush(1000); })); it("checker user can like and unlike another's answer", fakeAsync(() => { @@ -1637,7 +1657,7 @@ describe('CheckingComponent', () => { env.waitForSliderUpdate(); expect(env.getLikeTotal(1)).toBe(0); expect(env.likeButtons[1].classes.like).toBeUndefined(); - flush(); + flush(1000); })); it('cannot like your own answer', fakeAsync(() => { @@ -1649,7 +1669,7 @@ describe('CheckingComponent', () => { env.waitForSliderUpdate(); expect(env.getLikeTotal(0)).toBe(0); verify(mockedNoticeService.show('You cannot like your own answer.')).once(); - flush(); + flush(1000); })); it('observer cannot like an answer', fakeAsync(() => { @@ -1682,7 +1702,7 @@ describe('CheckingComponent', () => { expect(env.getLikeTotal(1)).toBe(0); expect(env.likeButtons[0].classes.like).toBeUndefined(); expect(env.likeButtons[1].classes.like).toBeUndefined(); - flush(); + flush(1000); })); it('hides the like icon if see other users responses is disabled', fakeAsync(() => { @@ -1703,7 +1723,7 @@ describe('CheckingComponent', () => { expect(env.answers.length).toBe(0); env.answerQuestion('Answer from checker'); expect(env.answers.length).toBe(2); - flush(); + flush(1000); })); it('checker can only see their answers when the setting is OFF to see other answers', fakeAsync(() => { @@ -1715,7 +1735,7 @@ describe('CheckingComponent', () => { expect(env.answers.length).toBe(0); env.answerQuestion('Answer from checker'); expect(env.answers.length).toBe(1); - flush(); + flush(1000); })); it('can add scripture to an answer', fakeAsync(() => { @@ -1736,7 +1756,7 @@ describe('CheckingComponent', () => { expect(env.scriptureText).toBe('John 2:2-5'); env.clickButton(env.saveAnswerButton); expect(env.getAnswerScriptureText(0)).toBe('…The selected text(John 2:2-5)'); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1748,7 +1768,7 @@ describe('CheckingComponent', () => { env.waitForSliderUpdate(); env.clickButton(env.clearScriptureButton); expect(env.selectVersesButton).not.toBeNull(); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1765,6 +1785,7 @@ describe('CheckingComponent', () => { expect(env.getAnswerEditButton(0)).toBeNull(); env.selectQuestion(7); expect(env.getAnswerEditButton(0)).not.toBeNull(); + flush(1000); })); it('new remote answers from other users are not displayed until requested', fakeAsync(() => { @@ -1860,7 +1881,7 @@ describe('CheckingComponent', () => { env.simulateNewRemoteAnswer('remoteAnswerId123'); // The total answers header comes back. expect(env.totalAnswersMessageCount).toEqual(1); - flush(); + flush(1000); })); it("new remote answers and banner don't show, if user has not yet answered the question", fakeAsync(() => { @@ -1885,7 +1906,7 @@ describe('CheckingComponent', () => { expect(env.showUnreadAnswersButton).toBeNull(); expect(env.answers.length).toEqual(3); expect(env.component.answersPanel!.answers.length).toEqual(3); - flush(); + flush(1000); })); it('show-remote-answer banner disappears if user deletes their answer', fakeAsync(() => { @@ -1933,7 +1954,7 @@ describe('CheckingComponent', () => { expect(env.showUnreadAnswersButton).not.toBeNull(); expect(env.unreadAnswersBannerCount).toEqual(1); expect(env.totalAnswersMessageCount).toEqual(4); - flush(); + flush(1000); })); it('show-remote-answer banner disappears if the un-shown remote answer is deleted', fakeAsync(() => { @@ -1955,7 +1976,7 @@ describe('CheckingComponent', () => { expect(env.answers.length).toEqual(2); expect(env.component.answersPanel!.answers.length).toEqual(2); expect(env.totalAnswersMessageCount).toEqual(2); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -1983,7 +2004,7 @@ describe('CheckingComponent', () => { expect(env.answers.length).toEqual(2); expect(env.totalAnswersMessageCount).toEqual(3); expect(env.unreadAnswersBannerCount).toEqual(1); - flush(); + flush(1000); })); it('show-remote-answer banner not shown to user if see-others-answers is disabled', fakeAsync(() => { @@ -2002,7 +2023,7 @@ describe('CheckingComponent', () => { expect(env.totalAnswersMessageText).toEqual('Your answer'); // Banner is not shown expect(env.showUnreadAnswersButton).toBeNull(); - flush(); + flush(1000); })); it('show-remote-answer banner still shown to proj admin if see-others-answers is disabled', fakeAsync(() => { @@ -2020,7 +2041,7 @@ describe('CheckingComponent', () => { expect(env.totalAnswersMessageCount).toEqual(2); // Banner is shown expect(env.showUnreadAnswersButton).not.toBeNull(); - flush(); + flush(1000); })); describe('Comments', () => { @@ -2031,7 +2052,7 @@ describe('CheckingComponent', () => { env.commentOnAnswer(0, 'Response to answer'); env.waitForSliderUpdate(); expect(env.getAnswerComments(0).length).toBe(1); - flush(); + flush(1000); })); it('can edit comment on an answer', fakeAsync(() => { @@ -2051,7 +2072,7 @@ describe('CheckingComponent', () => { expect(env.getAnswerCommentText(0, 0)).toBe('Edited comment'); expect(env.getAnswerCommentText(0, 1)).toBe('Second comment to answer'); expect(env.getAnswerComments(0).length).toBe(2); - flush(); + flush(1000); })); it('can delete comment on an answer', fakeAsync(() => { @@ -2064,7 +2085,7 @@ describe('CheckingComponent', () => { env.clickButton(env.getDeleteCommentButton(0, 0)); env.waitForSliderUpdate(); expect(env.getAnswerComments(0).length).toBe(0); - flush(); + flush(1000); })); it('can record audio for a comment', fakeAsync(() => { @@ -2079,6 +2100,7 @@ describe('CheckingComponent', () => { env.waitForSliderUpdate(); expect(env.getAnswerCommentAudio(0, 0)).not.toBeNull(); expect(env.getAnswerCommentText(0, 0)).toBe(''); + flush(1000); })); it('can remove audio from a comment', fakeAsync(() => { @@ -2099,6 +2121,7 @@ describe('CheckingComponent', () => { verify( mockedFileService.deleteFile(FileType.Audio, 'project01', QuestionDoc.COLLECTION, anything(), anything()) ).once(); + flush(1000); })); it('will delete comment audio when comment is deleted', fakeAsync(() => { @@ -2119,7 +2142,7 @@ describe('CheckingComponent', () => { verify( mockedFileService.deleteFile(FileType.Audio, 'project01', QuestionDoc.COLLECTION, anything(), anything()) ).once(); - flush(); + flush(1000); })); it('comments only appear on the relevant answer', fakeAsync(() => { @@ -2138,6 +2161,7 @@ describe('CheckingComponent', () => { expect(env.getAnswerCommentText(0, 0)).toBe('Third comment'); env.selectQuestion(1); expect(env.getAnswerCommentText(0, 0)).toBe('First comment'); + flush(1000); })); it('comments display show more button', fakeAsync(() => { @@ -2158,7 +2182,7 @@ describe('CheckingComponent', () => { expect(env.getAnswerComments(0).length).toBe(4); expect(env.getShowAllCommentsButton(0)).toBeFalsy(); expect(env.getAddCommentButton(0)).toBeTruthy(); - flush(); + flush(1000); })); it('comments unread only mark as read when the show more button is clicked', fakeAsync(() => { @@ -2171,7 +2195,7 @@ describe('CheckingComponent', () => { env.clickButton(env.getShowAllCommentsButton(0)); env.waitForSliderUpdate(); expect(env.getUnread(question)).toEqual(0); - flush(); + flush(1000); })); it('displays comments in real-time', fakeAsync(() => { @@ -2188,7 +2212,7 @@ describe('CheckingComponent', () => { tick(); expect(env.getAnswerComments(0).length).toEqual(1); expect(env.component.projectUserConfigDoc!.data!.commentRefsRead.includes(commentId)).toBe(true); - flush(); + flush(1000); })); it('does not mark third comment read if fourth comment also added', fakeAsync(() => { @@ -2210,7 +2234,7 @@ describe('CheckingComponent', () => { env.clickButton(env.getShowAllCommentsButton(0)); expect(env.component.projectUserConfigDoc!.data!.commentRefsRead.length).toEqual(3); expect(env.getAnswerComments(0).length).toEqual(4); - flush(); + flush(1000); })); it('observer cannot comment on an answer', fakeAsync(() => { @@ -2227,6 +2251,7 @@ describe('CheckingComponent', () => { env.selectQuestion(8); expect(env.getAnswerComments(0).length).toEqual(2); expect(env.getEditCommentButton(0, 0)).toBeNull(); + flush(1000); })); }); @@ -2250,7 +2275,7 @@ describe('CheckingComponent', () => { verify(questionDoc!.updateAnswerFileCache()).once(); expect().nothing(); tick(); - flush(); + flush(1000); })); it('update answer audio cache on remote update to question', fakeAsync(() => { @@ -2262,7 +2287,7 @@ describe('CheckingComponent', () => { verify(questionDoc!.updateAnswerFileCache()).times(2); expect().nothing(); tick(); - flush(); + flush(1000); })); it('update answer audio cache on remote removal of an answer', fakeAsync(() => { @@ -2274,7 +2299,7 @@ describe('CheckingComponent', () => { verify(questionDoc!.updateAnswerFileCache()).times(2); expect().nothing(); tick(); - flush(); + flush(1000); })); it('only admins can change answer export status', fakeAsync(() => { @@ -2291,6 +2316,7 @@ describe('CheckingComponent', () => { } env.waitForAudioPlayer(); }); + flush(1000); })); it('can mark answer ready for export', fakeAsync(() => { @@ -2303,7 +2329,7 @@ describe('CheckingComponent', () => { expect(env.getExportAnswerButton(buttonIndex).classes['status-exportable']).toBe(true); const questionDoc = env.component.questionsList!.activeQuestionDoc!; expect(questionDoc.data!.answers[0].status).toEqual(AnswerStatus.Exportable); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -2317,7 +2343,7 @@ describe('CheckingComponent', () => { expect(env.getResolveAnswerButton(buttonIndex).classes['status-resolved']).toBe(true); const questionDoc = env.component.questionsList!.activeQuestionDoc!; expect(questionDoc.data!.answers[0].status).toEqual(AnswerStatus.Resolved); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -2346,7 +2372,7 @@ describe('CheckingComponent', () => { expect(env.getExportAnswerButton(buttonIndex).classes['status-exportable']).toBeUndefined(); questionDoc = env.component.questionsList!.activeQuestionDoc!; expect(questionDoc.data!.answers[0].status).toEqual(AnswerStatus.None); - flush(); + flush(1000); discardPeriodicTasks(); })); }); @@ -2371,6 +2397,7 @@ describe('CheckingComponent', () => { tick(env.questionReadTimer); env.fixture.detectChanges(); expect(env.currentQuestion).toBe(4); + flush(1000); })); it('quill editor element lang attribute is set from project language', fakeAsync(() => { @@ -2378,7 +2405,7 @@ describe('CheckingComponent', () => { env.waitForAudioPlayer(); const quillElementLang = env.quillEditorElement.getAttribute('lang'); expect(quillElementLang).toEqual(TestEnvironment.project01WritingSystemTag); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -2387,7 +2414,7 @@ describe('CheckingComponent', () => { const segment = env.quillEditor.querySelector('usx-segment[data-segment=verse_1_1]')!; expect(segment.hasAttribute('data-question-count')).toBe(true); expect(segment.getAttribute('data-question-count')).toBe('13'); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -2413,7 +2440,7 @@ describe('CheckingComponent', () => { expect(segment.classList.contains('question-segment')).toBe(true); expect(segment.classList.contains('highlight-segment')).toBe(true); tick(); - flush(); + flush(1000); })); it('is not hidden when project setting did not specify to hide it', fakeAsync(() => { @@ -2430,7 +2457,7 @@ describe('CheckingComponent', () => { .withContext('Scripture text should be shown since the project is set not to hide it') .toBe(false); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -2450,7 +2477,7 @@ describe('CheckingComponent', () => { .withContext('Scripture text should be hidden when project setting') .toBe(true); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -2496,7 +2523,7 @@ describe('CheckingComponent', () => { .withContext('Scripture text should not be hidden') .toBe(false); - flush(); + flush(1000); discardPeriodicTasks(); })); }); @@ -2512,7 +2539,7 @@ describe('CheckingComponent', () => { env.fixture.detectChanges(); expect(env.component.showScriptureAudioPlayer).toBe(true); - flush(); + flush(1000); expect(env.audioCheckingWarning).toBeNull(); expect(env.questionNoAudioWarning).toBeNull(); discardPeriodicTasks(); @@ -2529,7 +2556,7 @@ describe('CheckingComponent', () => { env.fixture.detectChanges(); expect(env.component.showScriptureAudioPlayer).toBe(false); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -2541,7 +2568,7 @@ describe('CheckingComponent', () => { verify(audio.stop()).once(); expect(env.component).toBeDefined(); - flush(); + flush(1000); discardPeriodicTasks(); })); @@ -2553,7 +2580,7 @@ describe('CheckingComponent', () => { verify(audio.stop()).once(); expect(env.component).toBeDefined(); - flush(); + flush(1000); })); it('pauses chapter audio when adding a question', fakeAsync(() => { @@ -2581,6 +2608,7 @@ describe('CheckingComponent', () => { verify(audio.pause()).once(); expect(env.component).toBeDefined(); + flush(1000); })); it('hides chapter audio if chapter audio is absent', fakeAsync(() => { @@ -2592,7 +2620,7 @@ describe('CheckingComponent', () => { env.component.chapter = 99; env.fixture.detectChanges(); - flush(); + flush(1000); expect(env.component.showScriptureAudioPlayer).toBe(false); discardPeriodicTasks(); @@ -2607,7 +2635,7 @@ describe('CheckingComponent', () => { env.component.chapter = 2; env.fixture.detectChanges(); - flush(); + flush(1000); expect(env.component.showScriptureAudioPlayer).toBe(true); discardPeriodicTasks(); @@ -3296,7 +3324,11 @@ class TestEnvironment { } getQuestionDoc(dataId: string): QuestionDoc { - return this.realtimeService.get(QuestionDoc.COLLECTION, getQuestionDocId('project01', dataId)); + return this.realtimeService.get( + QuestionDoc.COLLECTION, + getQuestionDocId('project01', dataId), + new DocSubscription('spec') + ); } getQuestionText(question: DebugElement): string { @@ -3553,8 +3585,8 @@ class TestEnvironment { } ]); - when(mockedProjectService.getProfile(anything())).thenCall(id => - this.realtimeService.subscribe(SFProjectDoc.COLLECTION, id) + when(mockedProjectService.getProfile(anything(), anything())).thenCall((id, subscriber) => + this.realtimeService.subscribe(SFProjectDoc.COLLECTION, id, subscriber) ); when(mockedProjectService.isProjectAdmin(anything(), anything())).thenResolve( user.role === SFProjectRole.ParatextAdministrator @@ -3586,8 +3618,12 @@ class TestEnvironment { data: this.consultantProjectUserConfig } ]); - when(mockedProjectService.getUserConfig(anything(), anything())).thenCall((id, userId) => - this.realtimeService.subscribe(SFProjectUserConfigDoc.COLLECTION, getSFProjectUserConfigDocId(id, userId)) + when(mockedProjectService.getUserConfig(anything(), anything(), anything())).thenCall((id, userId, subscriber) => + this.realtimeService.subscribe( + SFProjectUserConfigDoc.COLLECTION, + getSFProjectUserConfigDocId(id, userId), + subscriber + ) ); this.realtimeService.addSnapshots(TextDoc.COLLECTION, [ @@ -3617,8 +3653,8 @@ class TestEnvironment { type: RichText.type.name } ]); - when(mockedProjectService.getText(anything())).thenCall(id => - this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString()) + when(mockedProjectService.getText(anything(), anything())).thenCall((id, subscriber) => + this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString(), subscriber) ); when(mockedActivatedRoute.params).thenReturn(this.params$); when(mockedActivatedRoute.queryParams).thenReturn(this.queryParams$); @@ -3631,7 +3667,7 @@ class TestEnvironment { } ]); when(mockedUserService.getCurrentUser()).thenCall(() => - this.realtimeService.subscribe(UserDoc.COLLECTION, user.id) + this.realtimeService.subscribe(UserDoc.COLLECTION, user.id, new DocSubscription('spec')) ); this.realtimeService.addSnapshots(UserProfileDoc.COLLECTION, [ @@ -3652,9 +3688,6 @@ class TestEnvironment { data: CONSULTANT_USER.user } ]); - when(mockedUserService.getProfile(anything())).thenCall(id => - this.realtimeService.subscribe(UserProfileDoc.COLLECTION, id) - ); when(mockedDialogService.openMatDialog(TextChooserDialogComponent, anything())).thenReturn( instance(this.mockedTextChooserDialogComponent) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.ts index 3253405710c..2f352c69f94 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.ts @@ -20,6 +20,7 @@ import { DataLoadingComponent } from 'xforge-common/data-loading-component'; import { I18nService } from 'xforge-common/i18n.service'; import { Breakpoint, MediaBreakpointService } from 'xforge-common/media-breakpoints/media-breakpoint.service'; import { FileType } from 'xforge-common/models/file-offline-data'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeQuery } from 'xforge-common/models/realtime-query'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; @@ -500,7 +501,10 @@ export class CheckingComponent extends DataLoadingComponent implements OnInit, A // Do once unless project changes if (routeProjectId !== prevProjectId) { - this.projectDoc = await this.projectService.getProfile(routeProjectId); + this.projectDoc = await this.projectService.getProfile( + routeProjectId, + new DocSubscription('CheckingComponent', this.destroyRef) + ); if (!this.projectDoc?.isLoaded) { return; @@ -519,7 +523,8 @@ export class CheckingComponent extends DataLoadingComponent implements OnInit, A this.projectUserConfigDoc = await this.projectService.getUserConfig( routeProjectId, - this.userService.currentUserId + this.userService.currentUserId, + new DocSubscription('CheckingComponent', this.destroyRef) ); // Subscribe to the projectDoc now that it is defined diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/resume-base.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/resume-base.service.ts index 96b358ebf67..7ee966eddd3 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/resume-base.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/resume-base.service.ts @@ -4,6 +4,7 @@ import { NavigationEnd, Params, Router } from '@angular/router'; import { Canon } from '@sillsdev/scripture'; import { BehaviorSubject, distinctUntilChanged, filter, map, merge, Observable, of, shareReplay } from 'rxjs'; import { ActivatedProjectService } from 'xforge-common/activated-project.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { UserService } from 'xforge-common/user.service'; import { filterNullish, quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; @@ -85,7 +86,11 @@ export abstract class ResumeBaseService { private async updateProjectUserConfig(projectId: string | undefined): Promise { this.projectUserConfigDoc = undefined; if (projectId != null) { - this.projectUserConfigDoc = await this.projectService.getUserConfig(projectId, this.userService.currentUserId); + this.projectUserConfigDoc = await this.projectService.getUserConfig( + projectId, + this.userService.currentUserId, + new DocSubscription('ResumeBaseService', this.destroyRef) + ); this.projectUserConfigDoc$.next(this.projectUserConfigDoc); } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/resume-checking.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/resume-checking.service.spec.ts index 07029ddc564..f4c7d9e1150 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/resume-checking.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/resume-checking.service.spec.ts @@ -67,7 +67,7 @@ describe('ResumeCheckingService', () => { when(mockRouter.events).thenReturn(routerEvents$); when(mockUserService.currentUserId).thenReturn('user01'); - when(mockProjectService.getUserConfig(anything(), anything())).thenResolve({ + when(mockProjectService.getUserConfig(anything(), anything(), anything())).thenResolve({ changes$: of([]) as Observable, data: {} as SFProjectUserConfig } as SFProjectUserConfigDoc); @@ -96,7 +96,7 @@ describe('ResumeCheckingService', () => { }); it('should create link using last location if it is present', fakeAsync(async () => { - when(mockProjectService.getUserConfig(anything(), anything())).thenResolve({ + when(mockProjectService.getUserConfig(anything(), anything(), anything())).thenResolve({ changes$: of([]) as Observable, data: { selectedBookNum: 40, selectedChapterNum: 2 } as SFProjectUserConfig } as SFProjectUserConfigDoc); @@ -115,7 +115,7 @@ describe('ResumeCheckingService', () => { })); it('should create link using first unanswered question if last location is invalid', fakeAsync(async () => { - when(mockProjectService.getUserConfig(anything(), anything())).thenResolve({ + when(mockProjectService.getUserConfig(anything(), anything(), anything())).thenResolve({ changes$: of([]) as Observable, data: { selectedBookNum: 5, selectedChapterNum: 2 } as SFProjectUserConfig } as SFProjectUserConfigDoc); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/resume-translate.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/resume-translate.service.spec.ts index b6328996cc8..555c2d30351 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/resume-translate.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/resume-translate.service.spec.ts @@ -67,7 +67,7 @@ describe('ResumeTranslateService', () => { when(mockedProjectDoc.data).thenReturn({ texts: [{ bookNum: 40, chapters: [{ number: 1 } as Chapter, { number: 2 } as Chapter] } as TextInfo] } as SFProject); - when(mockProjectService.getUserConfig(anything(), anything())).thenResolve({ + when(mockProjectService.getUserConfig(anything(), anything(), anything())).thenResolve({ changes$: of([]) as Observable, data: { selectedTask: 'checking', selectedBookNum: 40, selectedChapterNum: 2 } as SFProjectUserConfig } as SFProjectUserConfigDoc); @@ -94,7 +94,7 @@ describe('ResumeTranslateService', () => { })); it('should create link using first book if last location is invalid', fakeAsync(async () => { - when(mockProjectService.getUserConfig(anything(), anything())).thenResolve({ + when(mockProjectService.getUserConfig(anything(), anything(), anything())).thenResolve({ changes$: of([]) as Observable, data: { selectedTask: 'checking', selectedBookNum: 6, selectedChapterNum: 2 } as SFProjectUserConfig } as SFProjectUserConfigDoc); @@ -114,7 +114,7 @@ describe('ResumeTranslateService', () => { })); it('should create link using first book if no user config exists', fakeAsync(async () => { - when(mockProjectService.getUserConfig(anything(), anything())).thenResolve({ + when(mockProjectService.getUserConfig(anything(), anything(), anything())).thenResolve({ changes$: of([]) as Observable } as SFProjectUserConfigDoc); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/import-questions-dialog/import-questions-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/import-questions-dialog/import-questions-dialog.component.spec.ts index d6ed5c2900a..c209cc5d08e 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/import-questions-dialog/import-questions-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/import-questions-dialog/import-questions-dialog.component.spec.ts @@ -234,7 +234,7 @@ describe('ImportQuestionsDialogComponent', () => { env.click(env.importFromTransceleratorButton); env.selectQuestion(env.tableRows[0]); env.click(env.importSelectedQuestionsButton); - verify(mockedQuestionsService.createQuestion('project01', anything(), undefined, undefined)).once(); + verify(mockedQuestionsService.createQuestion('project01', anything(), anything(), undefined, undefined)).once(); const question = capture(mockedQuestionsService.createQuestion).last()[1]; expect(question.projectRef).toBe('project01'); expect(question.text).toBe('Transcelerator question 1:1'); @@ -252,7 +252,7 @@ describe('ImportQuestionsDialogComponent', () => { env.click(env.importFromTransceleratorButton); env.selectQuestion(env.tableRows[1]); env.click(env.importSelectedQuestionsButton); - verify(mockedQuestionsService.createQuestion('project01', anything(), undefined, undefined)).once(); + verify(mockedQuestionsService.createQuestion('project01', anything(), anything(), undefined, undefined)).once(); const question = capture(mockedQuestionsService.createQuestion).last()[1]; expect(question.verseRef).toEqual({ bookNum: 40, @@ -292,13 +292,13 @@ describe('ImportQuestionsDialogComponent', () => { expect(env.importSelectedQuestionsButton.textContent).toContain('1'); env.click(env.importSelectedQuestionsButton); - verify(mockedQuestionsService.createQuestion('project01', anything(), undefined, undefined)).once(); + verify(mockedQuestionsService.createQuestion('project01', anything(), anything(), undefined, undefined)).once(); })); it('allows canceling the import of questions', fakeAsync(() => { const env = new TestEnvironment(); env.click(env.importFromTransceleratorButton); - when(mockedQuestionsService.createQuestion('project01', anything(), undefined, undefined)).thenCall( + when(mockedQuestionsService.createQuestion('project01', anything(), anything(), undefined, undefined)).thenCall( () => new Promise(resolve => setTimeout(resolve, 5000)) ); expect(env.tableRows.length).toBe(2); @@ -310,12 +310,12 @@ describe('ImportQuestionsDialogComponent', () => { env.importSelectedQuestionsButton.click(); tick(4000); - verify(mockedQuestionsService.createQuestion('project01', anything(), undefined, undefined)).once(); + verify(mockedQuestionsService.createQuestion('project01', anything(), anything(), undefined, undefined)).once(); // cancel while the first question is still being imported env.cancelButton.click(); tick(12000); - verify(mockedQuestionsService.createQuestion('project01', anything(), undefined, undefined)).once(); + verify(mockedQuestionsService.createQuestion('project01', anything(), anything(), undefined, undefined)).once(); })); it('can import from a CSV file', fakeAsync(() => { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/import-questions-dialog/import-questions-dialog.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/import-questions-dialog/import-questions-dialog.component.ts index 823079d5429..327068eb28a 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/import-questions-dialog/import-questions-dialog.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/import-questions-dialog/import-questions-dialog.component.ts @@ -11,6 +11,7 @@ import { CsvService } from 'xforge-common/csv-service.service'; import { DialogService } from 'xforge-common/dialog.service'; import { ExternalUrlService } from 'xforge-common/external-url.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeQuery } from 'xforge-common/models/realtime-query'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { RetryingRequest } from 'xforge-common/retrying-request.service'; @@ -349,7 +350,13 @@ export class ImportQuestionsDialogComponent implements OnDestroy { transceleratorQuestionId: listItem.question.id }; await this.zone.runOutsideAngular(() => - this.checkingQuestionsService.createQuestion(this.data.projectId, newQuestion, undefined, undefined) + this.checkingQuestionsService.createQuestion( + this.data.projectId, + newQuestion, + new DocSubscription('ImportQuestionsDialogComponent', this.destroyRef), + undefined, + undefined + ) ); } else if (this.questionsDiffer(listItem)) { await listItem.sfVersionOfQuestion.submitJson0Op(op => diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts index 707818e2b03..1057338b770 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts @@ -24,6 +24,7 @@ import { BugsnagService } from 'xforge-common/bugsnag.service'; import { DialogService } from 'xforge-common/dialog.service'; import { FileService } from 'xforge-common/file.service'; import { createStorageFileData, FileType } from 'xforge-common/models/file-offline-data'; +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'; @@ -413,7 +414,7 @@ describe('QuestionDialogComponent', () => { tick(500); const textDocId = new TextDocId('project01', 42, 1, 'target'); expect(env.component.textDocId!.toString()).toBe(textDocId.toString()); - verify(mockedProjectService.getText(deepEqual(textDocId))).once(); + verify(mockedProjectService.getText(deepEqual(textDocId), anything())).once(); expect(env.isSegmentHighlighted('1')).toBe(true); expect(env.isSegmentHighlighted('2')).toBe(false); })); @@ -436,7 +437,7 @@ describe('QuestionDialogComponent', () => { tick(EDITOR_READY_TIMEOUT); env.fixture.detectChanges(); expect(env.component.textDocId!.toString()).toBe(textDocId.toString()); - verify(mockedProjectService.getText(deepEqual(textDocId))).once(); + verify(mockedProjectService.getText(deepEqual(textDocId), anything())).once(); expect(env.component.selection!.toString()).toEqual('LUK 1:3'); expect(env.component.textAndAudio?.input?.audioUrl).toBeDefined(); })); @@ -604,7 +605,11 @@ class TestEnvironment { id: questionId, data: question }); - questionDoc = this.realtimeService.get(QuestionDoc.COLLECTION, questionId); + questionDoc = this.realtimeService.get( + QuestionDoc.COLLECTION, + questionId, + new DocSubscription('spec') + ); questionDoc.onlineFetch(); } const textsByBookId = { @@ -634,7 +639,11 @@ class TestEnvironment { id: 'project01', data: createTestProjectProfile({ texts: Object.values(textsByBookId) }) }); - const projectDoc = this.realtimeService.get(SFProjectProfileDoc.COLLECTION, 'project01'); + const projectDoc = this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + 'project01', + new DocSubscription('spec') + ); const config: MatDialogConfig = { data: { questionDoc, @@ -672,17 +681,17 @@ class TestEnvironment { this.addTextDoc(new TextDocId('project01', 40, 1)); this.addTextDoc(new TextDocId('project01', 42, 1)); this.addEmptyTextDoc(43); - when(mockedProjectService.getText(anything())).thenCall(id => - this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString()) + when(mockedProjectService.getText(anything(), anything())).thenCall(id => + this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString(), new DocSubscription('spec')) ); - when(mockedProjectService.getProfile(anything())).thenCall(id => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id.toString()) + when(mockedProjectService.getProfile(anything(), anything())).thenCall(id => + this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id.toString(), new DocSubscription('spec')) ); when(mockedFileService.findOrUpdateCache(FileType.Audio, anything(), 'question01', anything())).thenResolve( createStorageFileData(QuestionDoc.COLLECTION, 'question01', 'test-audio-short.mp3', getAudioBlob()) ); when(mockedUserService.getCurrentUser()).thenCall(() => - this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01') + this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')) ); this.fixture.detectChanges(); } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts index 2baef174b86..578dd76b959 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts @@ -16,6 +16,7 @@ import { anything, instance, mock, verify, when } from 'ts-mockito'; import { DialogService } from 'xforge-common/dialog.service'; import { FileService } from 'xforge-common/file.service'; import { FileType } from 'xforge-common/models/file-offline-data'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; import { TestRealtimeService } from 'xforge-common/test-realtime.service'; @@ -59,7 +60,7 @@ describe('QuestionDialogService', () => { }; when(env.mockedDialogRef.afterClosed()).thenReturn(of(result)); await env.service.questionDialog(env.getQuestionDialogData()); - verify(mockedQuestionsService.createQuestion(env.PROJECT01, anything(), undefined, undefined)).once(); + verify(mockedQuestionsService.createQuestion(env.PROJECT01, anything(), anything(), undefined, undefined)).once(); expect().nothing(); }); @@ -67,7 +68,7 @@ describe('QuestionDialogService', () => { const env = new TestEnvironment(); when(env.mockedDialogRef.afterClosed()).thenReturn(of('close')); await env.service.questionDialog(env.getQuestionDialogData()); - verify(mockedQuestionsService.createQuestion(env.PROJECT01, anything())).never(); + verify(mockedQuestionsService.createQuestion(env.PROJECT01, anything(), anything())).never(); expect().nothing(); }); @@ -81,7 +82,7 @@ describe('QuestionDialogService', () => { when(env.mockedDialogRef.afterClosed()).thenReturn(of(result)); env.updateUserRole(SFProjectRole.CommunityChecker); await env.service.questionDialog(env.getQuestionDialogData()); - verify(mockedQuestionsService.createQuestion(env.PROJECT01, anything())).never(); + verify(mockedQuestionsService.createQuestion(env.PROJECT01, anything(), anything())).never(); verify(mockedNoticeService.show('question_dialog.add_question_denied')).once(); expect().nothing(); }); @@ -95,7 +96,9 @@ describe('QuestionDialogService', () => { }; when(env.mockedDialogRef.afterClosed()).thenReturn(of(result)); await env.service.questionDialog(env.getQuestionDialogData()); - verify(mockedQuestionsService.createQuestion(env.PROJECT01, anything(), 'someFileName.mp3', anything())).once(); + verify( + mockedQuestionsService.createQuestion(env.PROJECT01, anything(), anything(), 'someFileName.mp3', anything()) + ).once(); expect().nothing(); }); @@ -197,13 +200,14 @@ class TestEnvironment { }); this.projectProfileDoc = this.realtimeService.get( SFProjectProfileDoc.COLLECTION, - this.PROJECT01 + this.PROJECT01, + new DocSubscription('spec') ); when(mockedDialogService.openMatDialog(anything(), anything())).thenReturn(instance(this.mockedDialogRef)); when(mockedUserService.currentUserId).thenReturn(this.adminUser.id); - when(mockedProjectService.getProfile(anything())).thenCall(id => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id) + when(mockedProjectService.getProfile(anything(), anything())).thenCall(id => + this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id, new DocSubscription('spec')) ); } @@ -212,7 +216,11 @@ class TestEnvironment { id: getQuestionDocId(this.PROJECT01, question.dataId), data: question }); - return this.realtimeService.get(QUESTIONS_COLLECTION, getQuestionDocId(this.PROJECT01, question.dataId)); + return this.realtimeService.get( + QUESTIONS_COLLECTION, + getQuestionDocId(this.PROJECT01, question.dataId), + new DocSubscription('spec') + ); } getNewQuestion(audioUrl?: string): Question { @@ -243,7 +251,8 @@ class TestEnvironment { updateUserRole(role: string): void { const projectProfileDoc = this.realtimeService.get( SFProjectProfileDoc.COLLECTION, - this.PROJECT01 + this.PROJECT01, + new DocSubscription('spec') ); const userRole = projectProfileDoc.data!.userRoles; userRole[this.adminUser.id] = role; diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.ts index 18da420a539..72ec05a941c 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.ts @@ -1,4 +1,4 @@ -import { Injectable } from '@angular/core'; +import { DestroyRef, Injectable } from '@angular/core'; import { MatDialogConfig, MatDialogRef } from '@angular/material/dialog'; import { TranslocoService } from '@ngneat/transloco'; import { Operation } from 'realtime-server/lib/esm/common/models/project-rights'; @@ -8,6 +8,7 @@ import { fromVerseRef } from 'realtime-server/lib/esm/scriptureforge/models/vers import { lastValueFrom } from 'rxjs'; import { DialogService } from 'xforge-common/dialog.service'; import { FileType } from 'xforge-common/models/file-offline-data'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { UserService } from 'xforge-common/user.service'; import { objectId } from 'xforge-common/utils'; @@ -26,7 +27,8 @@ export class QuestionDialogService { private readonly checkingQuestionsService: CheckingQuestionsService, private readonly userService: UserService, private readonly noticeService: NoticeService, - private readonly transloco: TranslocoService + private readonly transloco: TranslocoService, + private readonly destroyRef: DestroyRef ) {} /** Opens a question dialog that can be used to add a new question or edit an existing question. */ @@ -98,6 +100,7 @@ export class QuestionDialogService { return await this.checkingQuestionsService.createQuestion( config.projectId, newQuestion, + new DocSubscription('QuestionDialogService.questionDialog', this.destroyRef), result.audio.fileName, result.audio.blob ); @@ -105,11 +108,14 @@ export class QuestionDialogService { private async canCreateAndEditQuestions(projectId: string): Promise { const userId = this.userService.currentUserId; - const project = (await this.projectService.getProfile(projectId)).data; - return ( + const docSubscription = new DocSubscription('QuestionDialogService.canCreateAndEditQuestions'); + const project = (await this.projectService.getProfile(projectId, docSubscription)).data; + const result = project != null && SF_PROJECT_RIGHTS.hasRight(project, userId, SFProjectDomain.Questions, Operation.Create) && - SF_PROJECT_RIGHTS.hasRight(project, userId, SFProjectDomain.Questions, Operation.Edit) - ); + SF_PROJECT_RIGHTS.hasRight(project, userId, SFProjectDomain.Questions, Operation.Edit); + + docSubscription.unsubscribe(); + return result; } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts index f8fea478f22..0cf14d12029 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts @@ -10,6 +10,7 @@ import { createTestProject } from 'realtime-server/lib/esm/scriptureforge/models import { anything, deepEqual, mock, resetCalls, verify, when } from 'ts-mockito'; import { AuthService } from 'xforge-common/auth.service'; import { CommandError, CommandErrorCode } from 'xforge-common/command.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { TestOnlineStatusModule } from 'xforge-common/test-online-status.module'; @@ -377,11 +378,11 @@ class TestEnvironment { }, paratextUsers: [{ sfUserId: 'user01', username: 'ptuser01', opaqueUserId: 'opaqueuser01' }] }); - this.realtimeService.create(SFProjectDoc.COLLECTION, 'project01', newProject); + this.realtimeService.create(SFProjectDoc.COLLECTION, 'project01', newProject, new DocSubscription('spec')); return Promise.resolve('project01'); }); - when(mockedSFProjectService.get('project01')).thenCall(() => - this.realtimeService.subscribe(SFProjectDoc.COLLECTION, 'project01') + when(mockedSFProjectService.subscribe('project01', anything())).thenCall(() => + this.realtimeService.subscribe(SFProjectDoc.COLLECTION, 'project01', new DocSubscription('spec')) ); if (params.paratextId === undefined) { when(mockedRouter.getCurrentNavigation()).thenReturn({ extras: {} } as any); @@ -484,14 +485,22 @@ class TestEnvironment { } setQueuedCount(): void { - const projectDoc = this.realtimeService.get(SFProjectDoc.COLLECTION, 'project01'); + const projectDoc = this.realtimeService.get( + SFProjectDoc.COLLECTION, + 'project01', + new DocSubscription('spec') + ); projectDoc.submitJson0Op(op => op.set(p => p.sync.queuedCount, 1), false); tick(); this.fixture.detectChanges(); } emitSyncComplete(): void { - const projectDoc = this.realtimeService.get(SFProjectDoc.COLLECTION, 'project01'); + const projectDoc = this.realtimeService.get( + SFProjectDoc.COLLECTION, + 'project01', + new DocSubscription('spec') + ); projectDoc.submitJson0Op(op => { op.set(p => p.sync.queuedCount, 0); op.set(p => p.sync.lastSyncSuccessful!, true); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.ts index c2c75edca21..166d76c3b79 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.ts @@ -6,6 +6,7 @@ import { TranslocoService } from '@ngneat/transloco'; import { AuthService } from 'xforge-common/auth.service'; import { DataLoadingComponent } from 'xforge-common/data-loading-component'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; @@ -161,7 +162,10 @@ export class ConnectProjectComponent extends DataLoadingComponent implements OnI this.populateProjectList(); return; } - this.projectDoc = await this.projectService.get(projectId); + this.projectDoc = await this.projectService.subscribe( + projectId, + new DocSubscription('ConnectProjectComponent', this.destroyRef) + ); } updateStatus(inProgress: boolean): void { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/models/note-thread-doc.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/models/note-thread-doc.spec.ts index 88f2c96f5b2..410581cbdfb 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/core/models/note-thread-doc.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/core/models/note-thread-doc.spec.ts @@ -10,6 +10,7 @@ import { NoteType } from 'realtime-server/lib/esm/scriptureforge/models/note-thread'; import { SFProjectRole } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-role'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; import { TestRealtimeService } from 'xforge-common/test-realtime.service'; import { configureTestingModule } from 'xforge-common/test-utils'; @@ -264,7 +265,7 @@ class TestEnvironment { id: threadId, data: thread }); - return this.realtimeService.subscribe(NoteThreadDoc.COLLECTION, threadId); + return this.realtimeService.subscribe(NoteThreadDoc.COLLECTION, threadId, new DocSubscription('spec')); } private getNoteThread(notes: Note[]): NoteThread { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/models/sf-project-base-doc.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/models/sf-project-base-doc.ts index a601cd01c38..49c9ed90539 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/core/models/sf-project-base-doc.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/core/models/sf-project-base-doc.ts @@ -1,10 +1,8 @@ import { SFProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project'; -import { TEXTS_COLLECTION } from 'realtime-server/lib/esm/scriptureforge/models/text-data'; import { ProjectDoc } from 'xforge-common/models/project-doc'; -import { RealtimeDoc } from 'xforge-common/models/realtime-doc'; import { QuestionDoc } from './question-doc'; import { SFProjectUserConfigDoc } from './sf-project-user-config-doc'; -import { TextDoc, TextDocId } from './text-doc'; +import { TextDoc } from './text-doc'; export abstract class SFProjectBaseDoc extends ProjectDoc { get taskNames(): string[] { @@ -18,23 +16,6 @@ export abstract class SFProjectBaseDoc extends Proje return names; } - loadTextDocs(bookNum?: number): Promise { - const texts: Promise[] = []; - for (const textDocId of this.getTextDocs(bookNum)) { - texts.push(this.realtimeService.subscribe(TEXTS_COLLECTION, textDocId.toString())); - } - return Promise.all(texts); - } - - async unLoadTextDocs(bookNum?: number): Promise { - for (const textDocId of this.getTextDocs(bookNum)) { - if (this.realtimeService.isSet(TEXTS_COLLECTION, textDocId.toString())) { - const doc = this.realtimeService.get(TEXTS_COLLECTION, textDocId.toString()); - await doc.dispose(); - } - } - } - protected async onDelete(): Promise { await super.onDelete(); await this.deleteProjectDocs(SFProjectUserConfigDoc.COLLECTION); @@ -42,20 +23,6 @@ export abstract class SFProjectBaseDoc extends Proje await this.deleteProjectDocs(QuestionDoc.COLLECTION); } - private getTextDocs(bookNum?: number): TextDocId[] { - const texts: TextDocId[] = []; - if (this.data != null) { - for (const text of this.data.texts) { - if (bookNum == null || bookNum === text.bookNum) { - for (const chapter of text.chapters) { - texts.push(new TextDocId(this.id, text.bookNum, chapter.number, 'target')); - } - } - } - } - return texts; - } - private async deleteProjectDocs(collection: string): Promise { const tasks: Promise[] = []; for (const id of await this.realtimeService.offlineStore.getAllIds(collection)) { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts index c0d76fe05a7..eadc0ce5bb4 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts @@ -8,6 +8,7 @@ import { isParatextRole, SFProjectRole } from 'realtime-server/lib/esm/scripture import { createTestProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-test-data'; import { TextInfoPermission } from 'realtime-server/lib/esm/scriptureforge/models/text-info-permission'; import { anything, instance, mock, verify, when } from 'ts-mockito'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserDoc } from 'xforge-common/models/user-doc'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; import { TestRealtimeService } from 'xforge-common/test-realtime.service'; @@ -159,7 +160,7 @@ describe('PermissionsService', () => { expect(await env.service.userHasParatextRoleOnProject('project01')).toBe(true); env.setCurrentUser('other'); expect(await env.service.userHasParatextRoleOnProject('project01')).toBe(false); - verify(mockedProjectService.getProfile('project01')).twice(); + verify(mockedProjectService.getProfile('project01', anything())).twice(); })); describe('canSync', () => { @@ -250,12 +251,8 @@ class TestEnvironment { constructor(readonly checkingEnabled = true) { this.service = TestBed.inject(PermissionsService); - when(mockedProjectService.getProfile(anything())).thenCall(id => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id) - ); - - when(mockedProjectService.get(anything())).thenCall(id => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id) + when(mockedProjectService.getProfile(anything(), anything())).thenCall(id => + this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id, new DocSubscription('spec')) ); this.setProjectProfile(); @@ -303,7 +300,9 @@ class TestEnvironment { setCurrentUser(userId: string = 'user01'): void { when(mockedUserService.currentUserId).thenReturn(userId); - when(mockedUserService.getCurrentUser()).thenCall(() => this.realtimeService.subscribe(UserDoc.COLLECTION, userId)); + when(mockedUserService.getCurrentUser()).thenCall(() => + this.realtimeService.subscribe(UserDoc.COLLECTION, userId, new DocSubscription('spec')) + ); } setupUserData(userId: string = 'user01', projects: string[] = ['project01']): void { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.ts index c024ca8b5b8..5e2cf6948c0 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.ts @@ -4,7 +4,10 @@ import { SF_PROJECT_RIGHTS, SFProjectDomain } from 'realtime-server/lib/esm/scri import { isParatextRole, SFProjectRole } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-role'; import { Chapter } from 'realtime-server/lib/esm/scriptureforge/models/text-info'; import { TextInfoPermission } from 'realtime-server/lib/esm/scriptureforge/models/text-info-permission'; +import { firstValueFrom } from 'rxjs'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserDoc } from 'xforge-common/models/user-doc'; +import { SFUserProjectsService } from 'xforge-common/user-projects.service'; import { UserService } from 'xforge-common/user.service'; import { environment } from '../../environments/environment'; import { SFProjectProfileDoc } from './models/sf-project-profile-doc'; @@ -21,7 +24,8 @@ import { SFProjectService } from './sf-project.service'; export class PermissionsService { constructor( private readonly userService: UserService, - private readonly projectService: SFProjectService + private readonly projectService: SFProjectService, + private readonly userProjectsService: SFUserProjectsService ) {} canAccessCommunityChecking(project: SFProjectProfileDoc, userId?: string): boolean { @@ -49,22 +53,24 @@ export class PermissionsService { async isUserOnProject(projectId: string): Promise { const currentUserDoc = await this.userService.getCurrentUser(); - return currentUserDoc?.data?.sites[environment.siteId].projects.includes(projectId) ?? false; + const result = currentUserDoc?.data?.sites[environment.siteId].projects.includes(projectId) ?? false; + return result; } async userHasParatextRoleOnProject(projectId: string): Promise { + const docSubscription = new DocSubscription('PermissionsService.userHasParatextRoleOnProject'); const currentUserDoc: UserDoc = await this.userService.getCurrentUser(); - const projectDoc: SFProjectProfileDoc = await this.projectService.getProfile(projectId); - return isParatextRole(projectDoc.data?.userRoles[currentUserDoc.id] ?? SFProjectRole.None); + const projectDoc: SFProjectProfileDoc = await this.projectService.getProfile(projectId, docSubscription); + const result = isParatextRole(projectDoc.data?.userRoles[currentUserDoc.id] ?? SFProjectRole.None); + docSubscription.unsubscribe(); + return result; } async canAccessText(textDocId: TextDocId): Promise { // Get the project doc, if the user is on that project - let projectDoc: SFProjectProfileDoc | undefined; - if (textDocId.projectId != null) { - const isUserOnProject = await this.isUserOnProject(textDocId.projectId); - projectDoc = isUserOnProject ? await this.projectService.getProfile(textDocId.projectId) : undefined; - } + const projectDoc = (await firstValueFrom(this.userProjectsService.projectDocs$))?.find( + projectDoc => projectDoc.id === textDocId.projectId + ); // Ensure the user has project level permission to view the text if ( diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/sf-project.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/sf-project.service.ts index f980699cc89..9d859d30889 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/core/sf-project.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/core/sf-project.service.ts @@ -17,6 +17,7 @@ import { DraftUsfmConfig } from 'realtime-server/lib/esm/scriptureforge/models/t import { Subject } from 'rxjs'; import { CommandService } from 'xforge-common/command.service'; import { LocationService } from 'xforge-common/location.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeQuery } from 'xforge-common/models/realtime-query'; import { ProjectService } from 'xforge-common/project.service'; import { QueryParameters, QueryResults } from 'xforge-common/query-parameters'; @@ -48,9 +49,10 @@ export class SFProjectService extends ProjectService { realtimeService: RealtimeService, commandService: CommandService, private readonly locationService: LocationService, - protected readonly retryingRequestService: RetryingRequestService + protected readonly retryingRequestService: RetryingRequestService, + destroyRef: DestroyRef ) { - super(realtimeService, commandService, retryingRequestService, SF_PROJECT_ROLES); + super(realtimeService, commandService, retryingRequestService, SF_PROJECT_ROLES, destroyRef); } static hasDraft(project: SFProjectProfile): boolean { @@ -74,24 +76,30 @@ export class SFProjectService extends ProjectService { * Returns the SF project if the user has a role that allows access (i.e. a paratext role), * otherwise returns undefined. */ - async tryGetForRole(id: string, role: string): Promise { + async tryGetForRole(id: string, role: string, subscriber: DocSubscription): Promise { if (SF_PROJECT_RIGHTS.roleHasRight(role, SFProjectDomain.Project, Operation.View)) { - return await this.get(id); + return await this.subscribe(id, subscriber); } return undefined; } /** Returns the project profile with the project data that all project members can access. */ - getProfile(id: string): Promise { - return this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id); + getProfile(id: string, docSubscription: DocSubscription): Promise { + return this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id, docSubscription); } - getUserConfig(id: string, userId: string): Promise { - return this.realtimeService.subscribe(SFProjectUserConfigDoc.COLLECTION, getSFProjectUserConfigDocId(id, userId)); + getUserConfig(id: string, userId: string, subscriber: DocSubscription): Promise { + return this.realtimeService.subscribe( + SFProjectUserConfigDoc.COLLECTION, + getSFProjectUserConfigDocId(id, userId), + subscriber + ); } async isProjectAdmin(projectId: string, userId: string): Promise { - const projectDoc = await this.getProfile(projectId); + const docSubscription = new DocSubscription('SFProjectService.isProjectAdmin'); + const projectDoc = await this.getProfile(projectId, docSubscription); + docSubscription.unsubscribe(); return ( projectDoc != null && projectDoc.data != null && @@ -110,21 +118,25 @@ export class SFProjectService extends ProjectService { return this.onlineInvoke('addTranslateMetrics', { projectId: id, metrics }); } - getText(textId: TextDocId | string): Promise { - return this.realtimeService.subscribe(TextDoc.COLLECTION, textId instanceof TextDocId ? textId.toString() : textId); + getText(textId: TextDocId | string, subscriber: DocSubscription): Promise { + return this.realtimeService.subscribe( + TextDoc.COLLECTION, + textId instanceof TextDocId ? textId.toString() : textId, + subscriber + ); } - getNoteThread(threadDataId: string): Promise { - return this.realtimeService.subscribe(NoteThreadDoc.COLLECTION, threadDataId); + getNoteThread(threadDataId: string, subscriber: DocSubscription): Promise { + return this.realtimeService.subscribe(NoteThreadDoc.COLLECTION, threadDataId, subscriber); } - getBiblicalTerm(biblicalTermId: string): Promise { - return this.realtimeService.subscribe(BiblicalTermDoc.COLLECTION, biblicalTermId); + getBiblicalTerm(biblicalTermId: string, subscriber: DocSubscription): Promise { + return this.realtimeService.subscribe(BiblicalTermDoc.COLLECTION, biblicalTermId, subscriber); } - async createNoteThread(projectId: string, noteThread: NoteThread): Promise { + async createNoteThread(projectId: string, noteThread: NoteThread, subscriber: DocSubscription): Promise { const docId: string = getNoteThreadDocId(projectId, noteThread.dataId); - await this.realtimeService.create(NoteThreadDoc.COLLECTION, docId, noteThread); + await this.realtimeService.create(NoteThreadDoc.COLLECTION, docId, noteThread, subscriber); } generateSharingUrl(shareKey: string, localeCode?: string): string { @@ -147,21 +159,26 @@ export class SFProjectService extends ProjectService { [obj().pathStr(t => t.verseRef.bookNum)]: bookNum, [obj().pathStr(t => t.verseRef.chapterNum)]: chapterNum }; - return this.realtimeService.subscribeQuery(NoteThreadDoc.COLLECTION, queryParams, destroyRef); + return this.realtimeService.subscribeQuery(NoteThreadDoc.COLLECTION, 'query_note_threads', queryParams, destroyRef); } queryAudioText(sfProjectId: string, destroyRef: DestroyRef): Promise> { const queryParams: QueryParameters = { [obj().pathStr(t => t.projectRef)]: sfProjectId }; - return this.realtimeService.subscribeQuery(TextAudioDoc.COLLECTION, queryParams, destroyRef); + return this.realtimeService.subscribeQuery(TextAudioDoc.COLLECTION, 'query_audio_text', queryParams, destroyRef); } queryBiblicalTerms(sfProjectId: string, destroyRef: DestroyRef): Promise> { const queryParams: QueryParameters = { [obj().pathStr(t => t.projectRef)]: sfProjectId }; - return this.realtimeService.subscribeQuery(BiblicalTermDoc.COLLECTION, queryParams, destroyRef); + return this.realtimeService.subscribeQuery( + BiblicalTermDoc.COLLECTION, + 'query_biblical_terms', + queryParams, + destroyRef + ); } queryBiblicalTermNoteThreads(sfProjectId: string, destroyRef: DestroyRef): Promise> { @@ -169,7 +186,12 @@ export class SFProjectService extends ProjectService { [obj().pathStr(t => t.projectRef)]: sfProjectId, [obj().pathStr(t => t.biblicalTermId)]: { $ne: null } }; - return this.realtimeService.subscribeQuery(NoteThreadDoc.COLLECTION, parameters, destroyRef); + return this.realtimeService.subscribeQuery( + NoteThreadDoc.COLLECTION, + 'query_biblical_term_note_threads', + parameters, + destroyRef + ); } onlineSync(id: string): Promise { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.spec.ts index 89fd8dbb415..f408cb87a2f 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.spec.ts @@ -6,7 +6,8 @@ import { TextData } from 'realtime-server/lib/esm/scriptureforge/models/text-dat import { Chapter, TextInfo } from 'realtime-server/lib/esm/scriptureforge/models/text-info'; import { TextInfoPermission } from 'realtime-server/lib/esm/scriptureforge/models/text-info-permission'; import * as RichText from 'rich-text'; -import { mock, when } from 'ts-mockito'; +import { anything, mock, when } from 'ts-mockito'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; import { TestRealtimeService } from 'xforge-common/test-realtime.service'; import { configureTestingModule } from 'xforge-common/test-utils'; @@ -187,7 +188,7 @@ describe('TextDocService', () => { it('should throw error if text doc already exists', fakeAsync(() => { const env = new TestEnvironment(); expect(() => { - env.textDocService.createTextDoc(env.textDocId, getTextDoc(env.textDocId)); + env.textDocService.createTextDoc(env.textDocId, new DocSubscription('spec'), getTextDoc(env.textDocId)); tick(); }).toThrowError(); })); @@ -195,7 +196,11 @@ describe('TextDocService', () => { it('creates the text doc if it does not already exist', fakeAsync(async () => { const env = new TestEnvironment(); const textDocId = new TextDocId('project01', 40, 2); - const textDoc = await env.textDocService.createTextDoc(textDocId, getTextDoc(textDocId)); + const textDoc = await env.textDocService.createTextDoc( + textDocId, + new DocSubscription('spec'), + getTextDoc(textDocId) + ); tick(); expect(textDoc.data).toBeDefined(); @@ -459,13 +464,13 @@ class TestEnvironment { type: RichText.type.name }); - when(mockProjectService.getText(this.textDocId)).thenCall(id => - this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString()) + when(mockProjectService.getText(this.textDocId, anything())).thenCall(id => + this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString(), new DocSubscription('spec')) ); when(mockUserService.currentUserId).thenReturn('user01'); } getTextDoc(textId: TextDocId): TextDoc { - return this.realtimeService.get(TextDoc.COLLECTION, textId.toString()); + return this.realtimeService.get(TextDoc.COLLECTION, textId.toString(), new DocSubscription('spec')); } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.ts index 2a56ec96d90..bc6b53c97c9 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.ts @@ -1,4 +1,4 @@ -import { Injectable } from '@angular/core'; +import { DestroyRef, Injectable } from '@angular/core'; import { Delta } from 'quill'; import { Operation } from 'realtime-server/lib/esm/common/models/project-rights'; import { SFProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project'; @@ -8,6 +8,7 @@ import { Chapter, TextInfo } from 'realtime-server/lib/esm/scriptureforge/models import { TextInfoPermission } from 'realtime-server/lib/esm/scriptureforge/models/text-info-permission'; import { type } from 'rich-text'; import { Observable, Subject } from 'rxjs'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeService } from 'xforge-common/realtime.service'; import { UserService } from 'xforge-common/user.service'; import { TextDoc, TextDocId, TextDocSource } from './models/text-doc'; @@ -22,7 +23,8 @@ export class TextDocService { constructor( private readonly projectService: SFProjectService, private readonly userService: UserService, - private readonly realtimeService: RealtimeService + private readonly realtimeService: RealtimeService, + private readonly destroyRef: DestroyRef ) {} /** @@ -32,7 +34,10 @@ export class TextDocService { * @param {TextDocSource} source The source of the op. This is sent to the server. */ async overwrite(textDocId: TextDocId, newDelta: Delta, source: TextDocSource): Promise { - const textDoc: TextDoc = await this.projectService.getText(textDocId); + const textDoc: TextDoc = await this.projectService.getText( + textDocId, + new DocSubscription('TextDocService', this.destroyRef) + ); if (textDoc.data?.ops == null) { throw new Error(`No TextDoc data for ${textDocId}`); @@ -81,15 +86,15 @@ export class TextDocService { ); } - async createTextDoc(textDocId: TextDocId, data?: TextData): Promise { - let textDoc: TextDoc = await this.projectService.getText(textDocId); + async createTextDoc(textDocId: TextDocId, subscriber: DocSubscription, data?: TextData): Promise { + let textDoc: TextDoc = await this.projectService.getText(textDocId, subscriber); if (textDoc?.data != null) { throw new Error(`Text Doc already exists for ${textDocId}`); } data ??= { ops: [] }; - textDoc = await this.realtimeService.create(TextDoc.COLLECTION, textDocId.toString(), data, type.uri); + textDoc = await this.realtimeService.create(TextDoc.COLLECTION, textDocId.toString(), data, subscriber, type.uri); return textDoc; } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/translation-engine.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/translation-engine.service.ts index d44f47843e0..d7b268a2f3c 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/core/translation-engine.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/core/translation-engine.service.ts @@ -9,6 +9,7 @@ import { getTextDocId } from 'realtime-server/lib/esm/scriptureforge/models/text import { Observable } from 'rxjs'; import { filter, share } from 'rxjs/operators'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { OfflineData, OfflineStore } from 'xforge-common/offline-store'; import { OnlineStatusService } from 'xforge-common/online-status.service'; @@ -140,7 +141,10 @@ export class TranslationEngineService { segment: string, checksum?: number ): Promise { - const targetDoc = await this.projectService.getText(getTextDocId(projectRef, bookNum, chapterNum, 'target')); + const targetDoc = await this.projectService.getText( + getTextDocId(projectRef, bookNum, chapterNum, 'target'), + new DocSubscription('TranslationEngineService', this.destroyRef) + ); const targetText = targetDoc.getSegmentText(segment); if (targetText === '') { return; @@ -152,7 +156,10 @@ export class TranslationEngineService { } } - const sourceDoc = await this.projectService.getText(getTextDocId(sourceProjectRef, bookNum, chapterNum, 'source')); + const sourceDoc = await this.projectService.getText( + getTextDocId(sourceProjectRef, bookNum, chapterNum, 'source'), + new DocSubscription('TranslationEngineService', this.destroyRef) + ); const sourceText = sourceDoc.getSegmentText(segment); if (sourceText === '') { return; diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/event-metrics/event-metrics-auth.guard.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/event-metrics/event-metrics-auth.guard.spec.ts index 26614f16907..6929aa98025 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/event-metrics/event-metrics-auth.guard.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/event-metrics/event-metrics-auth.guard.spec.ts @@ -91,12 +91,12 @@ describe('EventMetricsAuthGuard', () => { when(mockedAuthService.currentUserRoles).thenReturn([role]); when(mockedUserService.currentUserId).thenReturn(user01); - when(mockedProjectService.getProfile(project01)).thenReturn( + when(mockedProjectService.getProfile(project01, anything())).thenReturn( Promise.resolve({ data: createTestProjectProfile({ userRoles: { user01: SFProjectRole.ParatextAdministrator } }) } as SFProjectProfileDoc) ); - when(mockedProjectService.getProfile(project02)).thenReturn( + when(mockedProjectService.getProfile(project02, anything())).thenReturn( Promise.resolve({ data: createTestProjectProfile() } as SFProjectProfileDoc) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/event-metrics/event-metrics-auth.guard.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/event-metrics/event-metrics-auth.guard.ts index 5d63b1977bb..2ae1b4d9f0c 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/event-metrics/event-metrics-auth.guard.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/event-metrics/event-metrics-auth.guard.ts @@ -1,4 +1,4 @@ -import { Injectable } from '@angular/core'; +import { DestroyRef, Injectable } from '@angular/core'; import { SystemRole } from 'realtime-server/lib/esm/common/models/system-role'; import { SFProjectRole } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-role'; import { AuthGuard } from 'xforge-common/auth.guard'; @@ -16,9 +16,10 @@ export class EventMetricsAuthGuard extends RouterGuard { readonly authGuard: AuthGuard, private readonly authService: AuthService, readonly projectService: SFProjectService, - private readonly userService: UserService + private readonly userService: UserService, + destroyRef: DestroyRef ) { - super(authGuard, projectService); + super(authGuard, projectService, destroyRef); } check(projectDoc: SFProjectProfileDoc): boolean { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/navigation/navigation.stories.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/navigation/navigation.stories.ts index 946c9c98f61..5e7687117cd 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/navigation/navigation.stories.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/navigation/navigation.stories.ts @@ -72,8 +72,8 @@ function setUpMocks(args: StoryState): void { const realtimeService: TestRealtimeService = TestBed.inject(TestRealtimeService); realtimeService.addSnapshot(SFProjectProfileDoc.COLLECTION, { id: projectId, data: project }); - when(mockedSFProjectService.getProfile(anything())).thenCall(id => - realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id) + when(mockedSFProjectService.getProfile(anything(), anything())).thenCall((id, subscription) => + realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id, subscription) ); testActivatedProjectService = TestActivatedProjectService.withProjectId(projectId); } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.spec.ts index 2deb03407cd..69b0468eeb4 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.spec.ts @@ -16,6 +16,7 @@ import { createTestProjectUserConfig } from 'realtime-server/lib/esm/scripturefo import { of } from 'rxjs'; import { anything, deepEqual, mock, verify, when } from 'ts-mockito'; import { DialogService } from 'xforge-common/dialog.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserDoc } from 'xforge-common/models/user-doc'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; import { TestRealtimeService } from 'xforge-common/test-realtime.service'; @@ -190,7 +191,7 @@ class TestEnvironment { when(mockedUserService.currentUserId).thenReturn('user01'); when(mockedUserService.currentProjectId(anything())).thenReturn('project1'); when(mockedUserService.getCurrentUser()).thenCall(() => - this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01') + this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')) ); when(mockedTranslocoService.translate(anything())).thenReturn('The project link is invalid.'); const snapshot = new ActivatedRouteSnapshot(); @@ -276,7 +277,7 @@ class TestEnvironment { addUserToProject(projectIdSuffix: number): void { this.setProjectData({ memberProjectIdSuffixes: [projectIdSuffix] }); - const userDoc: UserDoc = this.realtimeService.get(UserDoc.COLLECTION, 'user01'); + const userDoc: UserDoc = this.realtimeService.get(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')); userDoc.submitJson0Op(op => op.set(u => u.sites, { sf: { projects: [`project${projectIdSuffix}`] } }), false); tick(); } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.ts index 1559caa739b..52cb91b63fb 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.ts @@ -6,6 +6,7 @@ import { SFProjectUserConfig } from 'realtime-server/lib/esm/scriptureforge/mode import { lastValueFrom, Observable } from 'rxjs'; import { distinctUntilChanged, filter, first, map } from 'rxjs/operators'; import { DataLoadingComponent } from 'xforge-common/data-loading-component'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { UserService } from 'xforge-common/user.service'; import { quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; @@ -73,8 +74,12 @@ export class ProjectComponent extends DataLoadingComponent implements OnInit { try { const [projectUserConfigDoc, projectDoc] = await Promise.all([ - this.projectService.getUserConfig(projectId, this.userService.currentUserId), - this.projectService.getProfile(projectId) + this.projectService.getUserConfig( + projectId, + this.userService.currentUserId, + new DocSubscription('ProjectComponent', this.destroyRef) + ), + this.projectService.getProfile(projectId, new DocSubscription('ProjectComponent', this.destroyRef)) ]); const projectUserConfig = projectUserConfigDoc.data; diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/draft-jobs.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/draft-jobs.component.ts index 0fd62259329..5a57ca8d751 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/draft-jobs.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/draft-jobs.component.ts @@ -12,6 +12,7 @@ import { OnlineStatusService } from 'xforge-common/online-status.service'; import { OwnerComponent } from 'xforge-common/owner/owner.component'; import { UICommonModule } from 'xforge-common/ui-common.module'; import { quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; +import { DocSubscription } from '../../xforge-common/models/realtime-doc'; import { SFProjectService } from '../core/sf-project.service'; import { EventMetric } from '../event-metrics/event-metric'; import { NoticeComponent } from '../shared/notice/notice.component'; @@ -151,7 +152,10 @@ export class DraftJobsComponent extends DataLoadingComponent implements OnInit { this.filteredProjectName = projectFilterId ?? ''; if (projectFilterId) { try { - const projectDoc = await this.servalAdministrationService.get(projectFilterId); + const projectDoc = await this.servalAdministrationService.subscribe( + projectFilterId, + new DocSubscription('DraftJobsComponent', this.destroyRef) + ); this.filteredProjectName = projectDoc?.data != null ? projectLabel(projectDoc.data) : projectFilterId; } catch (error) { // We can filter for a now-deleted project, so an error here is not unexpected and fully supported @@ -696,7 +700,10 @@ export class DraftJobsComponent extends DataLoadingComponent implements OnInit { // Fetch project data for each unique project ID for (const projectId of projectIds) { - const projectDoc = await this.servalAdministrationService.get(projectId); + const projectDoc = await this.servalAdministrationService.subscribe( + projectId, + new DocSubscription('DraftJobsComponent') + ); if (projectDoc?.data != null) { this.projectNames.set(projectId, projectLabel(projectDoc.data)); this.projectShortNames.set(projectId, projectDoc.data.shortName || null); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-administration.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-administration.service.ts index 36e3131a935..e427e6c319d 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-administration.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-administration.service.ts @@ -1,5 +1,5 @@ import { HttpClient } from '@angular/common/http'; -import { Injectable } from '@angular/core'; +import { DestroyRef, Injectable } from '@angular/core'; import { SFProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project'; import { Observable } from 'rxjs'; import { CommandService } from 'xforge-common/command.service'; @@ -20,9 +20,10 @@ export class ServalAdministrationService extends ProjectService - this.realtimeService.subscribe(SFProjectDoc.COLLECTION, 'project01') + when(mockedSFProjectService.subscribe('project01', anything())).thenCall((id, subscription) => + this.realtimeService.subscribe(SFProjectDoc.COLLECTION, 'project01', subscription) ); this.testOnlineStatusService.setIsOnline(hasConnection); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/settings/settings.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/settings/settings.component.ts index 88e32c26d8f..7b8b94757bc 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/settings/settings.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/settings/settings.component.ts @@ -18,6 +18,7 @@ import { DialogService } from 'xforge-common/dialog.service'; import { ExternalUrlService } from 'xforge-common/external-url.service'; import { I18nService, TextAroundTemplate } from 'xforge-common/i18n.service'; import { ElementState } from 'xforge-common/models/element-state'; +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'; @@ -206,7 +207,9 @@ export class SettingsComponent extends DataLoadingComponent implements OnInit { firstValueFrom(this.paratextService.getParatextUsername()).then((username: string | undefined) => { if (username != null) this.paratextUsername = username; }), - this.projectService.get(projectId).then(projectDoc => (this.projectDoc = projectDoc)) + this.projectService + .subscribe(projectId, new DocSubscription('SettingsComponent', this.destroyRef)) + .then(projectDoc => (this.projectDoc = projectDoc)) ]).then(() => { if (this.projectDoc != null) { this.updateSettingsInfo(); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/blank-page/blank-page.component.html b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/blank-page/blank-page.component.html new file mode 100644 index 00000000000..e69ed87be65 --- /dev/null +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/blank-page/blank-page.component.html @@ -0,0 +1 @@ +

This component is intentionally blank in order to test application behavior when no data should be loaded.

diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/blank-page/blank-page.component.scss b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/blank-page/blank-page.component.scss new file mode 100644 index 00000000000..e69de29bb2d diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/blank-page/blank-page.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/blank-page/blank-page.component.ts new file mode 100644 index 00000000000..4402274610d --- /dev/null +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/blank-page/blank-page.component.ts @@ -0,0 +1,10 @@ +import { Component } from '@angular/core'; + +@Component({ + selector: 'app-blank-page', + standalone: true, + template: `

+ This component is intentionally blank in order to test application behavior when almost no data should be loaded. +

` +}) +export class BlankPageComponent {} diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/cache-service/cache.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/cache-service/cache.service.spec.ts index 03b96618de4..bcf38b06e77 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/cache-service/cache.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/cache-service/cache.service.spec.ts @@ -1,128 +1,128 @@ -import { NgZone } from '@angular/core'; -import { fakeAsync, flush, TestBed, tick } from '@angular/core/testing'; -import { createTestProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-test-data'; -import { Chapter, TextInfo } from 'realtime-server/lib/esm/scriptureforge/models/text-info'; -import { anything, deepEqual, instance, mock, verify, when } from 'ts-mockito'; -import { configureTestingModule } from 'xforge-common/test-utils'; -import { SFProjectProfileDoc } from '../../core/models/sf-project-profile-doc'; -import { TextDocId } from '../../core/models/text-doc'; -import { PermissionsService } from '../../core/permissions.service'; -import { SFProjectService } from '../../core/sf-project.service'; -import { CacheService } from './cache.service'; - -const mockedProjectService = mock(SFProjectService); -const mockedProjectDoc = mock(SFProjectProfileDoc); -const mockedPermissionService = mock(PermissionsService); - -describe('cache service', () => { - configureTestingModule(() => ({ - providers: [ - { provide: SFProjectService, useMock: mockedProjectService }, - { provide: PermissionsService, useMock: mockedPermissionService } - ] - })); - describe('load all texts', () => { - it('does not get texts from project service if no permission', fakeAsync(async () => { - const env = new TestEnvironment(); - when(mockedPermissionService.canAccessText(anything())).thenResolve(false); - await env.service.cache(env.projectDoc); - env.wait(); - - verify(mockedProjectService.getText(anything())).times(0); - - flush(); - expect(true).toBeTruthy(); - })); - - it('gets all texts from project service', fakeAsync(async () => { - const env = new TestEnvironment(); - await env.service.cache(env.projectDoc); - env.wait(); - - verify(mockedProjectService.getText(anything())).times(200 * 100 * 2); - - flush(); - expect(true).toBeTruthy(); - })); - - it('stops the current operation if cache is called again', fakeAsync(async () => { - const env = new TestEnvironment(); - - const mockProject = mock(SFProjectProfileDoc); - when(mockProject.id).thenReturn('new project'); - const data = createTestProjectProfile({ - texts: env.createTexts() - }); - when(mockProject.data).thenReturn(data); - - env.service.cache(env.projectDoc); - await env.service.cache(instance(mockProject)); - env.wait(); - - verify( - mockedProjectService.getText(deepEqual(new TextDocId('new project', anything(), anything(), 'target'))) - ).times(200 * 100); - - //verify at least some books were not gotten - verify(mockedProjectService.getText(anything())).atMost(200 * 100 * 2 - 1); - - flush(); - expect(true).toBeTruthy(); - })); - - it('gets the source texts if they are present and the user can access', fakeAsync(async () => { - const env = new TestEnvironment(); - when(mockedPermissionService.canAccessText(deepEqual(new TextDocId('sourceId', 0, 0, 'target')))).thenResolve( - false - ); //remove access for one source doc - - await env.service.cache(env.projectDoc); - env.wait(); - - //verify all sources and targets were gotten except the inaccessible one - verify(mockedProjectService.getText(anything())).times(200 * 100 * 2 - 1); - - flush(); - expect(true).toBeTruthy(); - })); - }); -}); - -class TestEnvironment { - readonly ngZone: NgZone = TestBed.inject(NgZone); - readonly service: CacheService; - readonly projectDoc: SFProjectProfileDoc = instance(mockedProjectDoc); - - constructor() { - this.service = TestBed.inject(CacheService); - - const data = createTestProjectProfile({ - texts: this.createTexts(), - translateConfig: { - source: { - projectRef: 'sourceId' - } - } - }); - - when(mockedProjectDoc.data).thenReturn(data); - when(mockedPermissionService.canAccessText(anything())).thenResolve(true); - } - - createTexts(): TextInfo[] { - const texts: TextInfo[] = []; - for (let book = 0; book < 200; book++) { - const chapters: Chapter[] = []; - for (let chapter = 0; chapter < 100; chapter++) { - chapters.push({ isValid: true, lastVerse: 1, number: chapter, permissions: {}, hasAudio: false }); - } - texts.push({ bookNum: book, chapters: chapters, hasSource: true, permissions: {} }); - } - return texts; - } - - async wait(ms: number = 200): Promise { - await new Promise(resolve => this.ngZone.runOutsideAngular(() => setTimeout(resolve, ms))); - tick(); - } -} +// import { NgZone } from '@angular/core'; +// import { fakeAsync, flush, TestBed, tick } from '@angular/core/testing'; +// import { createTestProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-test-data'; +// import { Chapter, TextInfo } from 'realtime-server/lib/esm/scriptureforge/models/text-info'; +// import { anything, deepEqual, instance, mock, verify, when } from 'ts-mockito'; +// import { configureTestingModule } from 'xforge-common/test-utils'; +// import { SFProjectProfileDoc } from '../../core/models/sf-project-profile-doc'; +// import { TextDocId } from '../../core/models/text-doc'; +// import { PermissionsService } from '../../core/permissions.service'; +// import { SFProjectService } from '../../core/sf-project.service'; +// import { CacheService } from './cache.service'; + +// const mockedProjectService = mock(SFProjectService); +// const mockedProjectDoc = mock(SFProjectProfileDoc); +// const mockedPermissionService = mock(PermissionsService); + +// describe('cache service', () => { +// configureTestingModule(() => ({ +// providers: [ +// { provide: SFProjectService, useMock: mockedProjectService }, +// { provide: PermissionsService, useMock: mockedPermissionService } +// ] +// })); +// describe('load all texts', () => { +// it('does not get texts from project service if no permission', fakeAsync(async () => { +// const env = new TestEnvironment(); +// when(mockedPermissionService.canAccessText(anything())).thenResolve(false); +// await env.service.cache(env.projectDoc); +// env.wait(); + +// verify(mockedProjectService.subscribeText(anything())).times(0); + +// flush(); +// expect(true).toBeTruthy(); +// })); + +// it('gets all texts from project service', fakeAsync(async () => { +// const env = new TestEnvironment(); +// await env.service.cache(env.projectDoc); +// env.wait(); + +// verify(mockedProjectService.subscribeText(anything())).times(200 * 100 * 2); + +// flush(); +// expect(true).toBeTruthy(); +// })); + +// it('stops the current operation if cache is called again', fakeAsync(async () => { +// const env = new TestEnvironment(); + +// const mockProject = mock(SFProjectProfileDoc); +// when(mockProject.id).thenReturn('new project'); +// const data = createTestProjectProfile({ +// texts: env.createTexts() +// }); +// when(mockProject.data).thenReturn(data); + +// env.service.cache(env.projectDoc); +// await env.service.cache(instance(mockProject)); +// env.wait(); + +// verify( +// mockedProjectService.subscribeText(deepEqual(new TextDocId('new project', anything(), anything(), 'target'))) +// ).times(200 * 100); + +// //verify at least some books were not gotten +// verify(mockedProjectService.subscribeText(anything())).atMost(200 * 100 * 2 - 1); + +// flush(); +// expect(true).toBeTruthy(); +// })); + +// it('gets the source texts if they are present and the user can access', fakeAsync(async () => { +// const env = new TestEnvironment(); +// when(mockedPermissionService.canAccessText(deepEqual(new TextDocId('sourceId', 0, 0, 'target')))).thenResolve( +// false +// ); //remove access for one source doc + +// await env.service.cache(env.projectDoc); +// env.wait(); + +// //verify all sources and targets were gotten except the inaccessible one +// verify(mockedProjectService.subscribeText(anything())).times(200 * 100 * 2 - 1); + +// flush(); +// expect(true).toBeTruthy(); +// })); +// }); +// }); + +// class TestEnvironment { +// readonly ngZone: NgZone = TestBed.inject(NgZone); +// readonly service: CacheService; +// readonly projectDoc: SFProjectProfileDoc = instance(mockedProjectDoc); + +// constructor() { +// this.service = TestBed.inject(CacheService); + +// const data = createTestProjectProfile({ +// texts: this.createTexts(), +// translateConfig: { +// source: { +// projectRef: 'sourceId' +// } +// } +// }); + +// when(mockedProjectDoc.data).thenReturn(data); +// when(mockedPermissionService.canAccessText(anything())).thenResolve(true); +// } + +// createTexts(): TextInfo[] { +// const texts: TextInfo[] = []; +// for (let book = 0; book < 200; book++) { +// const chapters: Chapter[] = []; +// for (let chapter = 0; chapter < 100; chapter++) { +// chapters.push({ isValid: true, lastVerse: 1, number: chapter, permissions: {}, hasAudio: false }); +// } +// texts.push({ bookNum: book, chapters: chapters, hasSource: true, permissions: {} }); +// } +// return texts; +// } + +// async wait(ms: number = 200): Promise { +// await new Promise(resolve => this.ngZone.runOutsideAngular(() => setTimeout(resolve, ms))); +// tick(); +// } +// } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/cache-service/cache.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/cache-service/cache.service.ts index df43233b79e..7f9bd6848fb 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/cache-service/cache.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/cache-service/cache.service.ts @@ -1,45 +1,64 @@ -import { EventEmitter, Injectable } from '@angular/core'; +import { DestroyRef, Injectable } from '@angular/core'; +import { takeUntilDestroyed } from '@angular/core/rxjs-interop'; +import { ActivatedProjectService } from 'xforge-common/activated-project.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { SFProjectProfileDoc } from '../../core/models/sf-project-profile-doc'; -import { TextDocId } from '../../core/models/text-doc'; +import { TextDoc, TextDocId } from '../../core/models/text-doc'; import { PermissionsService } from '../../core/permissions.service'; import { SFProjectService } from '../../core/sf-project.service'; +// In production this should be true, but when testing doc cleanup it may be useful to set to false an observe behavior +const KEEP_PRIOR_PROJECT_CACHED_UNTIL_NEW_PROJECT_ACTIVATED = true; + @Injectable({ providedIn: 'root' }) export class CacheService { - private abortCurrent: EventEmitter = new EventEmitter(); + private subscribedTexts: TextDoc[] = []; + private docSubscription?: DocSubscription; + constructor( private readonly projectService: SFProjectService, - private readonly permissionsService: PermissionsService - ) {} + private readonly permissionsService: PermissionsService, + private readonly currentProject: ActivatedProjectService, + private readonly destroyRef: DestroyRef + ) { + currentProject.projectId$.pipe(takeUntilDestroyed(destroyRef)).subscribe(async projectId => { + if (projectId == null && KEEP_PRIOR_PROJECT_CACHED_UNTIL_NEW_PROJECT_ACTIVATED) return; + + this.uncache(); + if (projectId != null) { + this.docSubscription = new DocSubscription('CacheService'); + const project = await this.projectService.getProfile(projectId, this.docSubscription); + await this.loadAllChapters(project, this.docSubscription); + } + }); - async cache(project: SFProjectProfileDoc): Promise { - this.abortCurrent.emit(); - await this.loadAllChapters(project); + this.destroyRef.onDestroy(() => { + this.uncache(); + }); } - private async loadAllChapters(project: SFProjectProfileDoc): Promise { - let abort = false; - const sub = this.abortCurrent.subscribe(() => (abort = true)); + private uncache(): void { + this.docSubscription?.unsubscribe(); + this.subscribedTexts = []; + } + private async loadAllChapters(project: SFProjectProfileDoc, docSubscription: DocSubscription): Promise { if (project?.data != null) { const sourceId = project.data.translateConfig.source?.projectRef; for (const text of project.data.texts) { for (const chapter of text.chapters) { - if (abort) { - sub.unsubscribe(); - return; - } + if (this.currentProject.projectId != null && this.currentProject.projectId !== project.id) return; const textDocId = new TextDocId(project.id, text.bookNum, chapter.number, 'target'); if (await this.permissionsService.canAccessText(textDocId)) { - await this.projectService.getText(textDocId); + this.subscribedTexts.push(await this.projectService.getText(textDocId, docSubscription)); } if (text.hasSource && sourceId != null) { const sourceTextDocId = new TextDocId(sourceId, text.bookNum, chapter.number, 'target'); if (await this.permissionsService.canAccessText(sourceTextDocId)) { - await this.projectService.getText(sourceTextDocId); + this.subscribedTexts.push(await this.projectService.getText(sourceTextDocId, docSubscription)); } } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/diagnostic-overlay/diagnostic-overlay.component.html b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/diagnostic-overlay/diagnostic-overlay.component.html index ad1731335bc..3d4e463b047 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/diagnostic-overlay/diagnostic-overlay.component.html +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/diagnostic-overlay/diagnostic-overlay.component.html @@ -1,3 +1,5 @@ +{{ digestCycleCounter }} +
@if (isExpanded) { @@ -15,44 +17,148 @@

Developer Diagnostics

@if (isExpanded) { -

{{ totalDocsCount | l10nNumber }} documents tracked by realtime service

- - - - - - - - - - - @for (docType of docCountsByCollection | keyvalue; track docType.key) { - - - - - - - } - -
CollectionDocsSubscribersQueries
{{ docType.key }}{{ docType.value.docs | l10nNumber }}{{ docType.value.subscribers | l10nNumber }}{{ docType.value.queries | l10nNumber }}
+
+
+ Realtime server + Doc recreates + Loading + Digest cycles +
+
+ @if (tab === 0) { +

{{ totalDocsCount | l10nNumber }} documents tracked by realtime service

+ + + + + + + + + + + @for (docType of docCountsByCollection | keyvalue; track docType.key) { + + + + + + + } + +
CollectionDocsSubscribersActive Subs
{{ docType.key }}{{ docType.value.docs | l10nNumber }}{{ docType.value.subscribers | l10nNumber }}{{ docType.value.activeDocSubscriptionsCount | l10nNumber }}
+ +

Realtime doc subscribers

+ + + + + + + + + + + @for (collection of subscriberCountsByContext | keyvalue; track collection.key) { + @for (doc of collection.value | keyvalue; track doc.key; let first = $first; let count = $count) { + + @if (first) { + + } + + + + + } + } + +
CollectionContextSubsActive
{{ collection.key }}{{ doc.key }}{{ doc.value.all | l10nNumber }}{{ doc.value.active | l10nNumber }}
+ +

Realtime queries

+ + + + + + + + + @for (docType of queriesByCollection | keyvalue; track docType.key) { + + + + + } + +
CollectionQueries
{{ docType.key }}{{ docType.value | l10nNumber }}
+

Blank page

-

Components affecting loading indicator

- - - - - - - - - @for (component of noticeService.loadingCountsByCallerId | keyvalue; track component.key) { - - - - + Go to blank page (for testing subscriber cleanup) + } @else if (tab === 1) { +

Doc recreates

+

Note: Monitoring is not started until the developer diagnostics is opened.

+

+ +

+

+ +

+

+ Docs that have been recreated with {{ recreateTimeThreshold | l10nNumber }}ms of being destroyed, at least + {{ recreateCountThreshold | l10nNumber }} times: +

+
ComponentCount
{{ component.key }}{{ component.value | l10nNumber }}
+ + + + + + + + @for ( + doc of docLifecycleMonitor.getThrashingDocuments(recreateTimeThreshold, recreateCountThreshold) + | keyvalue; + track doc.key + ) { + + + + + } + +
Doc IDRecreates
{{ doc.key }} + @for (recreate of doc.value; track $index) { +
{{ recreate.creatorName }}: {{ recreate.recreateDuration | l10nNumber }}ms
+ } +
+ } @else if (tab === 2) { +

Components affecting loading indicator

+ + + + + + + + + @for (component of noticeService.loadingCountsByCallerId | keyvalue; track component.key) { + + + + + } + +
ComponentCount
{{ component.key }}{{ component.value | l10nNumber }}
+ } @else if (tab === 3) { +

Digest cycles:

+ } - - +
+
}
diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/diagnostic-overlay/diagnostic-overlay.component.scss b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/diagnostic-overlay/diagnostic-overlay.component.scss index 38f73fb3203..9aa0587231e 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/diagnostic-overlay/diagnostic-overlay.component.scss +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/diagnostic-overlay/diagnostic-overlay.component.scss @@ -11,7 +11,7 @@ $table-border-color: #404040; color: $foreground-color; font-size: 12px; - overflow-y: auto; + max-height: calc(100vh - 56px); } .header button { @@ -19,9 +19,9 @@ $table-border-color: #404040; } .wrapper:not(.collapsed) { - padding: 4px 12px; - width: 25vw; - min-width: 300px; + display: flex; + flex-direction: column; + max-height: 100%; } .wrapper.collapsed { @@ -70,7 +70,7 @@ h3 { align-items: center; h2 { - margin: 0; + margin: 0 0 0 2em; flex-grow: 1; } } @@ -78,3 +78,37 @@ h3 { .collapsed .header { flex-direction: column; } + +.nav-and-content-wrapper { + display: flex; + gap: 8px; + overflow: hidden; +} + +.tab-content { + overflow: auto; + padding-bottom: 1em; +} + +.nav-wrapper { + writing-mode: vertical-rl; + display: flex; + + > * { + padding: 1em 0.6em; + cursor: pointer; + background-color: #3b3b3f; + + &:hover { + background-color: #4f4f53; + } + } + + .active { + border-block-start: 2px solid $foreground-color; + } +} + +a { + color: $foreground-color; +} diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/diagnostic-overlay/diagnostic-overlay.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/diagnostic-overlay/diagnostic-overlay.component.ts index 6d72de70456..ddce403a0b6 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/diagnostic-overlay/diagnostic-overlay.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/diagnostic-overlay/diagnostic-overlay.component.ts @@ -2,7 +2,9 @@ import { OverlayModule } from '@angular/cdk/overlay'; import { CommonModule } from '@angular/common'; import { Component } from '@angular/core'; import { DiagnosticOverlayService } from 'xforge-common/diagnostic-overlay.service'; +import { L10nNumberPipe } from 'xforge-common/l10n-number.pipe'; import { LocalSettingsService } from 'xforge-common/local-settings.service'; +import { RealtimeDocLifecycleMonitorService } from 'xforge-common/models/realtime-doc-lifecycle-monitor'; import { NoticeService } from 'xforge-common/notice.service'; import { RealtimeService } from 'xforge-common/realtime.service'; import { UICommonModule } from 'xforge-common/ui-common.module'; @@ -27,26 +29,51 @@ const diagnosticOverlayCollapsedKey = 'DIAGNOSTIC_OVERLAY_COLLAPSED'; export class DiagnosticOverlayComponent { isExpanded: boolean = true; isOpen: boolean = true; + tab = 0; + digestCycles = 0; + + recreateTimeThreshold: number = 250; + recreateCountThreshold: number = 1; constructor( private readonly realtimeService: RealtimeService, private readonly diagnosticOverlayService: DiagnosticOverlayService, readonly noticeService: NoticeService, - private readonly localSettings: LocalSettingsService + public readonly docLifecycleMonitor: RealtimeDocLifecycleMonitorService, + private readonly localSettings: LocalSettingsService, + private readonly l10nNumber: L10nNumberPipe ) { + docLifecycleMonitor.setMonitoringEnabled(true); if (this.localSettings.get(diagnosticOverlayCollapsedKey) === false) { this.isExpanded = false; } } - get docCountsByCollection(): { [key: string]: { docs: number; subscribers: number; queries: number } } { + get docCountsByCollection(): { + [key: string]: { docs: number; subscribers: number; activeDocSubscriptionsCount: number }; + } { return this.realtimeService.docsCountByCollection; } + get queriesByCollection(): { [key: string]: number } { + return this.realtimeService.queriesByCollection; + } + + get subscriberCountsByContext(): { [key: string]: { [key: string]: { all: number; active: number } } } { + return this.realtimeService.subscriberCountsByContext; + } + get totalDocsCount(): number { return this.realtimeService.totalDocCount; } + get digestCycleCounter(): string { + this.digestCycles++; + const displayElement = document.getElementById('digest-cycles'); + if (displayElement) displayElement.textContent = this.l10nNumber.transform(this.digestCycles); + return ''; + } + toggle(): void { this.isExpanded = !this.isExpanded; this.localSettings.set(diagnosticOverlayCollapsedKey, this.isExpanded); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/progress-service/progress.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/progress-service/progress.service.spec.ts index 70f21c5a95c..ef9089187f4 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/progress-service/progress.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/progress-service/progress.service.spec.ts @@ -82,28 +82,32 @@ describe('progress service', () => { it('updates total progress when chapter content changes', fakeAsync(async () => { const env = new TestEnvironment(); const changeEvent = new BehaviorSubject({}); - when(mockSFProjectService.getText(deepEqual(new TextDocId('project01', 1, 2, 'target')))).thenCall(() => { - return { - getSegmentCount: () => { - return { translated: 12, blank: 2 }; - }, - getNonEmptyVerses: () => env.createVerses(12), - changes$: changeEvent - }; - }); + when(mockSFProjectService.getText(deepEqual(new TextDocId('project01', 1, 2, 'target')), anything())).thenCall( + () => { + return { + getSegmentCount: () => { + return { translated: 12, blank: 2 }; + }, + getNonEmptyVerses: () => env.createVerses(12), + changes$: changeEvent + }; + } + ); tick(); // mock a change - when(mockSFProjectService.getText(deepEqual(new TextDocId('project01', 1, 2, 'target')))).thenCall(() => { - return { - getSegmentCount: () => { - return { translated: 13, blank: 1 }; - }, - getNonEmptyVerses: () => env.createVerses(13), - changes$: changeEvent - }; - }); + when(mockSFProjectService.getText(deepEqual(new TextDocId('project01', 1, 2, 'target')), anything())).thenCall( + () => { + return { + getSegmentCount: () => { + return { translated: 13, blank: 1 }; + }, + getNonEmptyVerses: () => env.createVerses(13), + changes$: changeEvent + }; + } + ); const originalProgress = env.service.overallProgress.translated; tick(1000); // wait for the throttle time @@ -206,14 +210,14 @@ class TestEnvironment { when(mockProjectService.changes$).thenReturn(this.project$); when(mockPermissionService.canAccessText(anything())).thenResolve(true); - when(mockSFProjectService.getProfile('project01')).thenResolve({ + when(mockSFProjectService.getProfile('project01', anything())).thenResolve({ data, id: 'project01', remoteChanges$: new BehaviorSubject([]) } as unknown as SFProjectProfileDoc); // set up blank project - when(mockSFProjectService.getProfile('project02')).thenResolve({ + when(mockSFProjectService.getProfile('project02', anything())).thenResolve({ data, id: 'project02', remoteChanges$: new BehaviorSubject([]) @@ -234,17 +238,17 @@ class TestEnvironment { const blank = blankSegments >= 5 ? 5 : blankSegments; blankSegments -= blank; - when(mockSFProjectService.getText(deepEqual(new TextDocId(projectId, book, chapter, 'target')))).thenCall( - () => { - return { - getSegmentCount: () => { - return { translated, blank }; - }, - getNonEmptyVerses: () => this.createVerses(translated), - changes$: of({} as TextData) - }; - } - ); + when( + mockSFProjectService.getText(deepEqual(new TextDocId(projectId, book, chapter, 'target')), anything()) + ).thenCall(() => { + return { + getSegmentCount: () => { + return { translated, blank }; + }, + getNonEmptyVerses: () => this.createVerses(translated), + changes$: of({} as TextData) + }; + }); } } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/progress-service/progress.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/progress-service/progress.service.ts index f5a8680310d..6a91e373939 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/progress-service/progress.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/progress-service/progress.service.ts @@ -4,6 +4,7 @@ import { TextInfo } from 'realtime-server/lib/esm/scriptureforge/models/text-inf import { asyncScheduler, merge, startWith, Subscription, tap, throttleTime } from 'rxjs'; import { ActivatedProjectService } from 'xforge-common/activated-project.service'; import { DataLoadingComponent } from 'xforge-common/data-loading-component'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { filterNullish, quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; @@ -202,15 +203,11 @@ export class ProgressService extends DataLoadingComponent implements OnDestroy { .pipe( startWith(this.activatedProject.projectDoc), filterNullish(), - tap(async project => { - this.initialize(project.id); - }), + tap(async project => this.initialize(project.id)), throttleTime(1000, asyncScheduler, { leading: false, trailing: true }), quietTakeUntilDestroyed(this.destroyRef) ) - .subscribe(project => { - this.initialize(project.id); - }); + .subscribe(project => this.initialize(project.id)); } get texts(): TextProgress[] { @@ -228,7 +225,10 @@ export class ProgressService extends DataLoadingComponent implements OnDestroy { private async initialize(projectId: string): Promise { this._canTrainSuggestions = false; - this._projectDoc = await this.projectService.getProfile(projectId); + this._projectDoc = await this.projectService.getProfile( + projectId, + new DocSubscription('ProgressService', this.destroyRef) + ); // If we are offline, just update the progress with what we have if (!this.onlineStatusService.isOnline) { @@ -239,7 +239,9 @@ export class ProgressService extends DataLoadingComponent implements OnDestroy { for (const book of this._projectDoc.data!.texts) { for (const chapter of book.chapters) { const textDocId = new TextDocId(this._projectDoc.id, book.bookNum, chapter.number, 'target'); - chapterDocPromises.push(this.projectService.getText(textDocId)); + chapterDocPromises.push( + this.projectService.getText(textDocId, new DocSubscription('ProgressService', this.destroyRef)) + ); } } @@ -280,7 +282,8 @@ export class ProgressService extends DataLoadingComponent implements OnDestroy { let numTranslatedSegments: number = 0; for (const chapter of book.text.chapters) { const textDocId = new TextDocId(project.id, book.text.bookNum, chapter.number, 'target'); - const chapterText: TextDoc = await this.projectService.getText(textDocId); + const docSubscriptionForSource = new DocSubscription('ProgressService'); + const chapterText: TextDoc = await this.projectService.getText(textDocId, docSubscriptionForSource); // Calculate Segment Count const { translated, blank } = chapterText.getSegmentCount(); @@ -301,8 +304,13 @@ export class ProgressService extends DataLoadingComponent implements OnDestroy { // Only retrieve the source text if the user has permission let sourceNonEmptyVerses: string[] = []; if (await this.permissionsService.canAccessText(sourceTextDocId)) { - const sourceChapterText: TextDoc = await this.projectService.getText(sourceTextDocId); + const docSubscriptionForTarget = new DocSubscription('ProgressService'); + const sourceChapterText: TextDoc = await this.projectService.getText( + sourceTextDocId, + docSubscriptionForTarget + ); sourceNonEmptyVerses = sourceChapterText.getNonEmptyVerses(); + docSubscriptionForTarget.unsubscribe(); } // Get the intersect of the source and target arrays of non-empty verses @@ -314,6 +322,7 @@ export class ProgressService extends DataLoadingComponent implements OnDestroy { this._canTrainSuggestions = true; } } + docSubscriptionForSource.unsubscribe(); } // Add the book to the overall progress diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/project-router.guard.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/project-router.guard.ts index f370324d882..72949d453ae 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/project-router.guard.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/project-router.guard.ts @@ -1,4 +1,4 @@ -import { Injectable } from '@angular/core'; +import { DestroyRef, Injectable } from '@angular/core'; import { ActivatedRouteSnapshot, CanDeactivate, Router, RouterStateSnapshot } from '@angular/router'; import { Operation } from 'realtime-server/lib/esm/common/models/project-rights'; import { SF_PROJECT_RIGHTS, SFProjectDomain } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-rights'; @@ -6,6 +6,7 @@ import { SFProjectRole } from 'realtime-server/lib/esm/scriptureforge/models/sf- import { from, Observable, of } from 'rxjs'; import { map, switchMap } from 'rxjs/operators'; import { AuthGuard } from 'xforge-common/auth.guard'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserService } from 'xforge-common/user.service'; import { SFProjectProfileDoc } from '../core/models/sf-project-profile-doc'; import { PermissionsService } from '../core/permissions.service'; @@ -14,7 +15,8 @@ import { SFProjectService } from '../core/sf-project.service'; export abstract class RouterGuard { constructor( protected readonly authGuard: AuthGuard, - protected readonly projectService: SFProjectService + protected readonly projectService: SFProjectService, + protected readonly destroyRef: DestroyRef ) {} canActivate(next: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable { @@ -26,7 +28,9 @@ export abstract class RouterGuard { return this.authGuard.allowTransition().pipe( switchMap(isLoggedIn => { if (isLoggedIn) { - return from(this.projectService.getProfile(projectId)).pipe(map(projectDoc => this.check(projectDoc))); + return from( + this.projectService.getProfile(projectId, new DocSubscription('ProjectRouterGuard', this.destroyRef)) + ).pipe(map(projectDoc => this.check(projectDoc))); } return of(false); }) @@ -36,16 +40,15 @@ export abstract class RouterGuard { abstract check(project: SFProjectProfileDoc): boolean; } -@Injectable({ - providedIn: 'root' -}) +@Injectable({ providedIn: 'root' }) export class SettingsAuthGuard extends RouterGuard { constructor( authGuard: AuthGuard, projectService: SFProjectService, - private userService: UserService + private userService: UserService, + destroyRef: DestroyRef ) { - super(authGuard, projectService); + super(authGuard, projectService, destroyRef); } check(projectDoc: SFProjectProfileDoc): boolean { @@ -56,16 +59,15 @@ export class SettingsAuthGuard extends RouterGuard { } } -@Injectable({ - providedIn: 'root' -}) +@Injectable({ providedIn: 'root' }) export class UsersAuthGuard extends RouterGuard { constructor( authGuard: AuthGuard, projectService: SFProjectService, - private userService: UserService + private userService: UserService, + destroyRef: DestroyRef ) { - super(authGuard, projectService); + super(authGuard, projectService, destroyRef); } check(projectDoc: SFProjectProfileDoc): boolean { @@ -76,16 +78,15 @@ export class UsersAuthGuard extends RouterGuard { } } -@Injectable({ - providedIn: 'root' -}) +@Injectable({ providedIn: 'root' }) export class SyncAuthGuard extends RouterGuard { constructor( authGuard: AuthGuard, projectService: SFProjectService, - private userService: UserService + private userService: UserService, + destroyRef: DestroyRef ) { - super(authGuard, projectService); + super(authGuard, projectService, destroyRef); } check(projectDoc: SFProjectProfileDoc): boolean { @@ -99,16 +100,15 @@ export class SyncAuthGuard extends RouterGuard { } } -@Injectable({ - providedIn: 'root' -}) +@Injectable({ providedIn: 'root' }) export class NmtDraftAuthGuard extends RouterGuard { constructor( authGuard: AuthGuard, projectService: SFProjectService, - private userService: UserService + private userService: UserService, + destroyRef: DestroyRef ) { - super(authGuard, projectService); + super(authGuard, projectService, destroyRef); } check(projectDoc: SFProjectProfileDoc): boolean { @@ -125,17 +125,16 @@ export class NmtDraftAuthGuard extends RouterGuard { } } -@Injectable({ - providedIn: 'root' -}) +@Injectable({ providedIn: 'root' }) export class CheckingAuthGuard extends RouterGuard { constructor( authGuard: AuthGuard, projectService: SFProjectService, private router: Router, - private readonly permissions: PermissionsService + private readonly permissions: PermissionsService, + destroyRef: DestroyRef ) { - super(authGuard, projectService); + super(authGuard, projectService, destroyRef); } check(projectDoc: SFProjectProfileDoc): boolean { @@ -147,17 +146,16 @@ export class CheckingAuthGuard extends RouterGuard { } } -@Injectable({ - providedIn: 'root' -}) +@Injectable({ providedIn: 'root' }) export class TranslateAuthGuard extends RouterGuard { constructor( authGuard: AuthGuard, projectService: SFProjectService, private router: Router, - private readonly permissions: PermissionsService + private readonly permissions: PermissionsService, + destroyRef: DestroyRef ) { - super(authGuard, projectService); + super(authGuard, projectService, destroyRef); } check(projectDoc: SFProjectProfileDoc): boolean { @@ -173,12 +171,10 @@ export interface ConfirmOnLeave { confirmLeave(): Promise; } -@Injectable({ - providedIn: 'root' -}) +@Injectable({ providedIn: 'root' }) export class DraftNavigationAuthGuard extends RouterGuard implements CanDeactivate { - constructor(authGuard: AuthGuard, projectService: SFProjectService) { - super(authGuard, projectService); + constructor(authGuard: AuthGuard, projectService: SFProjectService, destroyRef: DestroyRef) { + super(authGuard, projectService, destroyRef); } async canDeactivate(component: ConfirmOnLeave): Promise { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.spec.ts index dc10c1e90b6..1220e0793c1 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.spec.ts @@ -9,6 +9,7 @@ import { SF_PROJECT_RIGHTS, SFProjectDomain } from 'realtime-server/lib/esm/scri import { SFProjectRole } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-role'; import { anything, capture, mock, verify, when } from 'ts-mockito'; import { CommandError, CommandErrorCode } from 'xforge-common/command.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { TestOnlineStatusModule } from 'xforge-common/test-online-status.module'; @@ -319,8 +320,8 @@ class TestEnvironment { } } }); - when(mockedProjectService.getProfile(anything())).thenCall(projectId => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, projectId) + when(mockedProjectService.getProfile(anything(), anything())).thenCall((projectId, subscription) => + this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, projectId, subscription) ); when(mockedUserService.currentUserId).thenReturn(args.userId!); when(mockedProjectService.onlineGetLinkSharingKey(args.projectId!, anything(), anything(), anything())).thenResolve( @@ -419,7 +420,11 @@ class TestEnvironment { } updateCheckingProperties(config: CheckingConfig): Promise { - const projectDoc: SFProjectProfileDoc = this.realtimeService.get(SFProjectProfileDoc.COLLECTION, 'project01'); + const projectDoc: SFProjectProfileDoc = this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + 'project01', + new DocSubscription('spec') + ); return projectDoc.submitJson0Op(op => op.set(p => p.checkingConfig, config)); } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.ts index bbb3cabcece..6e080a6e174 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.ts @@ -15,6 +15,7 @@ import { SFProjectRole } from 'realtime-server/lib/esm/scriptureforge/models/sf- import { BehaviorSubject, combineLatest } from 'rxjs'; import { CommandError } from 'xforge-common/command.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { UserService } from 'xforge-common/user.service'; @@ -70,7 +71,7 @@ export class ShareControlComponent extends ShareBaseComponent { } if (this.projectDoc == null || projectId !== this._projectId) { [this.projectDoc, this.isProjectAdmin] = await Promise.all([ - this.projectService.getProfile(projectId), + this.projectService.getProfile(projectId, new DocSubscription('ShareControlComponent', this.destroyRef)), this.projectService.isProjectAdmin(projectId, this.userService.currentUserId) ]); this.roleControl.setValue(this.defaultShareRole ?? null); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts index 5cbbec58e4c..4f70c4bbfa3 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts @@ -10,6 +10,7 @@ import { firstValueFrom } from 'rxjs'; import { anything, instance, mock, verify, when } from 'ts-mockito'; import { NAVIGATOR } from 'xforge-common/browser-globals'; import { Locale } from 'xforge-common/models/i18n-locale'; +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'; @@ -405,8 +406,8 @@ class TestEnvironment { return Promise.resolve(undefined); } } as Clipboard); - when(mockedProjectService.getProfile(anything())).thenCall(projectId => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, projectId) + when(mockedProjectService.getProfile(anything(), anything())).thenCall((projectId, subscription) => + this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, projectId, subscription) ); when(mockedUserService.currentUserId).thenReturn(userId); when(mockedUserService.getCurrentUser()).thenResolve({ data: createTestUser() } as UserDoc); @@ -493,7 +494,11 @@ class TestEnvironment { } disableCheckingSharing(): void { - const projectDoc: SFProjectProfileDoc = this.realtimeService.get(SFProjectProfileDoc.COLLECTION, 'project01'); + const projectDoc: SFProjectProfileDoc = this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + 'project01', + new DocSubscription('spec') + ); projectDoc.submitJson0Op( op => op.set(p => p.checkingConfig, { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.ts index cf7a7b41855..9928dc9d9b7 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.ts @@ -6,6 +6,7 @@ import { SFProjectRole } from 'realtime-server/lib/esm/scriptureforge/models/sf- import { NAVIGATOR } from 'xforge-common/browser-globals'; import { I18nService } from 'xforge-common/i18n.service'; import { Locale } from 'xforge-common/models/i18n-locale'; +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'; @@ -64,7 +65,7 @@ export class ShareDialogComponent extends ShareBaseComponent { super(userService); this.projectId = this.data.projectId; Promise.all([ - this.projectService.getProfile(this.projectId), + this.projectService.getProfile(this.projectId, new DocSubscription('ShareDialogComponent', this.destroyRef)), this.projectService.isProjectAdmin(this.projectId, this.userService.currentUserId) ]).then(value => { this.projectDoc = value[0]; diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts index a9a98d08991..3da9f63745a 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts @@ -16,6 +16,7 @@ import { LocalPresence } from 'sharedb/lib/sharedb'; import { anything, instance, mock, verify, when } from 'ts-mockito'; import { DialogService } from 'xforge-common/dialog.service'; import { MockConsole } from 'xforge-common/mock-console'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserDoc } from 'xforge-common/models/user-doc'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { TestOnlineStatusModule } from 'xforge-common/test-online-status.module'; @@ -149,7 +150,7 @@ describe('TextComponent', () => { data: createTestUser({}, 2) }); when(mockedUserService.getCurrentUser()).thenCall(() => - env.realtimeService.subscribe(UserDoc.COLLECTION, 'user02') + env.realtimeService.subscribe(UserDoc.COLLECTION, 'user02', new DocSubscription('spec')) ); }; const env2: TestEnvironment = new TestEnvironment({ callback }); @@ -214,7 +215,7 @@ describe('TextComponent', () => { let textDocBeingGotten: TextDoc = {} as TextDoc; instance(mockedProjectService) - .getText(textDocIdWithEmpty.toString()) + .getText(textDocIdWithEmpty.toString(), new DocSubscription('spec')) .then((value: TextDoc) => { textDocBeingGotten = value; }); @@ -223,7 +224,7 @@ describe('TextComponent', () => { Object.defineProperty(textDocBeingGotten, 'data', { get: () => undefined }); - when(mockedProjectService.getText(textDocIdWithEmpty)).thenResolve(textDocBeingGotten); + when(mockedProjectService.getText(textDocIdWithEmpty, anything())).thenResolve(textDocBeingGotten); // The user goes to a location that has an 'empty' textdoc. The placeholder indicates empty. env.id = textDocIdWithEmpty; @@ -602,7 +603,7 @@ describe('TextComponent', () => { data: createTestUser({ displayName: '', sites: { sf: { projects: ['project01'] } } }, 2) }); when(mockedUserService.getCurrentUser()).thenCall(() => - env.realtimeService.subscribe(UserDoc.COLLECTION, 'user02') + env.realtimeService.subscribe(UserDoc.COLLECTION, 'user02', new DocSubscription('spec')) ); }; const env: TestEnvironment = new TestEnvironment({ callback }); @@ -1520,7 +1521,7 @@ describe('TextComponent', () => { it('should throw error if profile data is null', fakeAsync(() => { const env: TestEnvironment = new TestEnvironment(); - when(mockedProjectService.getProfile(anything())).thenResolve({ + when(mockedProjectService.getProfile(anything(), anything())).thenResolve({ data: null } as unknown as SFProjectProfileDoc); env.fixture.detectChanges(); @@ -1811,14 +1812,14 @@ class TestEnvironment { ) }); - when(mockedProjectService.getText(anything())).thenCall(id => - this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString()) + when(mockedProjectService.getText(anything(), anything())).thenCall(id => + this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString(), new DocSubscription('spec')) ); - when(mockedProjectService.getProfile(anything())).thenCall(() => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, 'project01') + when(mockedProjectService.getProfile(anything(), anything())).thenCall(() => + this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, 'project01', new DocSubscription('spec')) ); when(mockedUserService.getCurrentUser()).thenCall(() => - this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01') + this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')) ); if (callback != null) { @@ -1894,7 +1895,7 @@ class TestEnvironment { } getUserDoc(userId: string): UserDoc { - return this.realtimeService.get(UserDoc.COLLECTION, userId); + return this.realtimeService.get(UserDoc.COLLECTION, userId, new DocSubscription('spec')); } getSegment(segmentRef: string): HTMLElement | null { @@ -2059,12 +2060,12 @@ class TestEnvironment { let resolver: (_: TextDoc) => void = _ => {}; let textDocBeingGotten: TextDoc = {} as TextDoc; instance(mockedProjectService) - .getText(textDocId.toString()) + .getText(textDocId.toString(), new DocSubscription('spec')) .then((value: TextDoc) => { textDocBeingGotten = value; }); tick(); - when(mockedProjectService.getText(textDocId)).thenReturn( + when(mockedProjectService.getText(textDocId, anything())).thenReturn( new Promise(resolve => { // (Don't resolve until we manually cause it.) resolver = resolve; diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.ts index cc953d041ce..2b1d5b5b570 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.ts @@ -26,6 +26,7 @@ import tinyColor from 'tinycolor2'; import { WINDOW } from 'xforge-common/browser-globals'; import { DialogService } from 'xforge-common/dialog.service'; import { LocaleDirection } from 'xforge-common/models/i18n-locale'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserDoc } from 'xforge-common/models/user-doc'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { UserService } from 'xforge-common/user.service'; @@ -1075,7 +1076,10 @@ export class TextComponent implements AfterViewInit, OnDestroy { this.loadingState = 'permission-denied'; return false; } - const profile: SFProjectProfileDoc = await this.projectService.getProfile(this.projectId); + const profile: SFProjectProfileDoc = await this.projectService.getProfile( + this.projectId, + new DocSubscription('TextComponent', this.destroyRef) + ); if (profile.data == null) throw new Error('Failed to fetch project profile.'); if ( profile.data.texts.some( @@ -1160,7 +1164,7 @@ export class TextComponent implements AfterViewInit, OnDestroy { // the text in IndexedDB, we will unfortunately briefly show that a book is unavailable offline, before it loads. // But if getText does not return, then we are showing a good message. this.loadingState = 'offline-or-loading'; - const textDoc = await this.projectService.getText(this._id); + const textDoc = await this.projectService.getText(this._id, new DocSubscription('TextComponent', this.destroyRef)); this.loadingState = 'loading'; this.viewModel.bind(this._id, textDoc, this.subscribeToUpdates); if (this.viewModel.isEmpty) this.loadingState = 'empty-viewModel'; @@ -1945,7 +1949,9 @@ export class TextComponent implements AfterViewInit, OnDestroy { if (!this.userProjects?.includes(this.projectId)) { return; } - const project = (await this.projectService.getProfile(this.projectId)).data; + const project = ( + await this.projectService.getProfile(this.projectId, new DocSubscription('TextComponent', this.destroyRef)) + ).data; if (project == null) { return; } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts index edb6fc597b7..8546b38885d 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts @@ -6,6 +6,7 @@ import { createTestProject } from 'realtime-server/lib/esm/scriptureforge/models import { firstValueFrom } from 'rxjs'; import { anything, mock, verify, when } from 'ts-mockito'; import { ErrorReportingService } from 'xforge-common/error-reporting.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { TestOnlineStatusModule } from 'xforge-common/test-online-status.module'; import { TestOnlineStatusService } from 'xforge-common/test-online-status.service'; @@ -44,7 +45,7 @@ describe('SyncProgressComponent', () => { it('does not initialize if projectDoc is undefined', fakeAsync(async () => { const env = new TestEnvironment({ userId: 'user01' }); expect(env.host.projectDoc).toBeUndefined(); - verify(mockedProjectService.get('sourceProject02')).never(); + verify(mockedProjectService.subscribe('sourceProject02', anything())).never(); expect(await env.getMode()).toBe('indeterminate'); })); @@ -52,7 +53,7 @@ describe('SyncProgressComponent', () => { const env = new TestEnvironment({ userId: 'user01' }); env.setupProjectDoc(); env.onlineStatus = false; - verify(mockedProjectService.get('sourceProject02')).never(); + verify(mockedProjectService.subscribe('sourceProject02', anything())).never(); expect(await env.getMode()).toBe('indeterminate'); })); @@ -115,7 +116,7 @@ describe('SyncProgressComponent', () => { env.setupProjectDoc(); env.updateSyncProgress(0, 'testProject01'); env.updateSyncProgress(0, 'sourceProject02'); - verify(mockedProjectService.get('sourceProject02')).never(); + verify(mockedProjectService.subscribe('sourceProject02', anything())).never(); env.emitSyncComplete(true, 'sourceProject02'); env.updateSyncProgress(0.5, 'testProject01'); expect(await env.getPercent()).toEqual(50); @@ -128,7 +129,7 @@ describe('SyncProgressComponent', () => { when(mockedProjectService.onlineGetProjectRole('sourceProject02')).thenReject(new Error('504: Gateway Timeout')); env.setupProjectDoc(); verify(mockedProjectService.onlineGetProjectRole('sourceProject02')).once(); - verify(mockedProjectService.get('sourceProject02')).never(); + verify(mockedProjectService.subscribe('sourceProject02', anything())).never(); verify(mockedErrorReportingService.silentError(anything(), anything())).once(); expect(env.progressBar).not.toBeNull(); expect(env.syncStatus).not.toBeNull(); @@ -146,7 +147,7 @@ class HostComponent { constructor(private readonly projectService: SFProjectService) {} setProjectDoc(): void { - this.projectService.get('testProject01').then(doc => (this.projectDoc = doc)); + this.projectService.subscribe('testProject01', new DocSubscription('spec')).then(doc => (this.projectDoc = doc)); } } @@ -209,11 +210,11 @@ class TestEnvironment { ) }); } - when(mockedProjectService.get('testProject01')).thenCall(() => - this.realtimeService.subscribe(SFProjectDoc.COLLECTION, 'testProject01') + when(mockedProjectService.subscribe('testProject01', anything())).thenCall(() => + this.realtimeService.subscribe(SFProjectDoc.COLLECTION, 'testProject01', new DocSubscription('spec')) ); - when(mockedProjectService.get('sourceProject02')).thenCall(() => - this.realtimeService.subscribe(SFProjectDoc.COLLECTION, 'sourceProject02') + when(mockedProjectService.subscribe('sourceProject02', anything())).thenCall(() => + this.realtimeService.subscribe(SFProjectDoc.COLLECTION, 'sourceProject02', new DocSubscription('spec')) ); when(mockedProjectService.onlineGetProjectRole('sourceProject02')).thenResolve(this.userRoleSource[args.userId]); @@ -239,7 +240,11 @@ class TestEnvironment { } updateSyncProgress(percentCompleted: number, projectId: string): void { - const projectDoc = this.realtimeService.get(SFProjectDoc.COLLECTION, projectId); + const projectDoc = this.realtimeService.get( + SFProjectDoc.COLLECTION, + projectId, + new DocSubscription('spec') + ); projectDoc.submitJson0Op(ops => { ops.set(p => p.sync.queuedCount, 1); }, false); @@ -251,7 +256,11 @@ class TestEnvironment { emitSyncComplete(successful: boolean, projectId: string): void { this.host.syncProgress['updateProgressState'](projectId, new ProgressState(1)); - const projectDoc = this.realtimeService.get(SFProjectDoc.COLLECTION, projectId); + const projectDoc = this.realtimeService.get( + SFProjectDoc.COLLECTION, + projectId, + new DocSubscription('spec') + ); projectDoc.submitJson0Op(ops => { ops.set(p => p.sync.queuedCount, 0); ops.set(p => p.sync.lastSyncSuccessful, successful); @@ -273,7 +282,7 @@ class TestEnvironment { this.updateSyncProgress(0, 'testProject01'); this.updateSyncProgress(0, 'sourceProject02'); verify(mockedProjectService.onlineGetProjectRole('sourceProject02')).once(); - verify(mockedProjectService.get('sourceProject02')).once(); + verify(mockedProjectService.subscribe('sourceProject02', anything())).once(); expect(this.progressBar).not.toBeNull(); expect(await this.getMode()).toBe('indeterminate'); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.ts index 930e11ccf01..6706a52a99e 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.ts @@ -5,6 +5,7 @@ import { isParatextRole } from 'realtime-server/lib/esm/scriptureforge/models/sf import { BehaviorSubject, map, merge, Observable } from 'rxjs'; import { ErrorReportingService } from 'xforge-common/error-reporting.service'; import { FeatureFlagService } from 'xforge-common/feature-flags/feature-flag.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; import { SFProjectDoc } from '../../core/models/sf-project-doc'; @@ -108,7 +109,10 @@ export class SyncProgressComponent { const role: string = await this.projectService.onlineGetProjectRole(sourceProjectId); // Only show progress for the source project when the user has sync if (isParatextRole(role)) { - this.sourceProjectDoc = await this.projectService.get(sourceProjectId); + this.sourceProjectDoc = await this.projectService.subscribe( + sourceProjectId, + new DocSubscription('SyncProgressComponent', this.destroyRef) + ); // Subscribe to SignalR notifications for the source project await this.projectNotificationService.subscribeToProject(this.sourceProjectDoc.id); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts index 5e8ee71fcf7..e8bed98052c 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts @@ -12,6 +12,7 @@ import { AuthService } from 'xforge-common/auth.service'; import { BugsnagService } from 'xforge-common/bugsnag.service'; import { CommandError, CommandErrorCode } from 'xforge-common/command.service'; import { DialogService } from 'xforge-common/dialog.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { TestOnlineStatusModule } from 'xforge-common/test-online-status.module'; @@ -110,7 +111,7 @@ describe('SyncComponent', () => { it('should sync project when the button is clicked', fakeAsync(() => { const env = new TestEnvironment(); const previousLastSyncDate = env.component.lastSyncDate; - verify(mockedProjectService.get(env.projectId)).once(); + verify(mockedProjectService.subscribe(env.projectId, anything())).once(); env.clickElement(env.syncButton); @@ -140,7 +141,7 @@ describe('SyncComponent', () => { it('should report error if sync has a problem', fakeAsync(() => { const env = new TestEnvironment(); - verify(mockedProjectService.get(env.projectId)).once(); + verify(mockedProjectService.subscribe(env.projectId, anything())).once(); env.clickElement(env.syncButton); verify(mockedProjectService.onlineSync(env.projectId)).once(); expect(env.component.syncActive).toBe(true); @@ -157,7 +158,7 @@ describe('SyncComponent', () => { it('should report user permissions error if sync failed for that reason', fakeAsync(() => { const env = new TestEnvironment({ lastSyncErrorCode: -1, lastSyncWasSuccessful: false }); - verify(mockedProjectService.get(env.projectId)).once(); + verify(mockedProjectService.subscribe(env.projectId, anything())).once(); env.clickElement(env.syncButton); verify(mockedProjectService.onlineSync(env.projectId)).once(); expect(env.component.syncActive).toBe(true); @@ -228,7 +229,7 @@ describe('SyncComponent', () => { it('should not report if sync was cancelled', fakeAsync(() => { const env = new TestEnvironment(); const previousLastSyncDate = env.component.lastSyncDate; - verify(mockedProjectService.get(env.projectId)).once(); + verify(mockedProjectService.subscribe(env.projectId, anything())).once(); env.clickElement(env.syncButton); verify(mockedProjectService.onlineSync(env.projectId)).once(); expect(env.component.syncActive).toBe(true); @@ -246,7 +247,7 @@ describe('SyncComponent', () => { it('should report success if sync was cancelled but had finished', fakeAsync(() => { const env = new TestEnvironment(); - verify(mockedProjectService.get(env.projectId)).once(); + verify(mockedProjectService.subscribe(env.projectId, anything())).once(); env.clickElement(env.syncButton); verify(mockedProjectService.onlineSync(env.projectId)).once(); expect(env.component.syncActive).toBe(true); @@ -315,8 +316,8 @@ class TestEnvironment { }) }); - when(mockedProjectService.get(anyString())).thenCall(projectId => - this.realtimeService.subscribe(SFProjectDoc.COLLECTION, projectId) + when(mockedProjectService.subscribe(anyString(), anything())).thenCall(projectId => + this.realtimeService.subscribe(SFProjectDoc.COLLECTION, projectId, new DocSubscription('spec')) ); this.fixture = TestBed.createComponent(SyncComponent); @@ -386,13 +387,21 @@ class TestEnvironment { } setQueuedCount(projectId: string): void { - const projectDoc = this.realtimeService.get(SFProjectDoc.COLLECTION, projectId); + const projectDoc = this.realtimeService.get( + SFProjectDoc.COLLECTION, + projectId, + new DocSubscription('spec') + ); projectDoc.submitJson0Op(op => op.set(p => p.sync.queuedCount, 1), false); this.fixture.detectChanges(); } emitSyncComplete(successful: boolean, projectId: string): void { - const projectDoc = this.realtimeService.get(SFProjectDoc.COLLECTION, projectId); + const projectDoc = this.realtimeService.get( + SFProjectDoc.COLLECTION, + projectId, + new DocSubscription('spec') + ); projectDoc.submitJson0Op(ops => { ops.set(p => p.sync.queuedCount, 0); ops.set(p => p.sync.lastSyncSuccessful!, successful); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.ts index 3ab9acd6899..567ee2ac458 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.ts @@ -8,6 +8,7 @@ import { CommandErrorCode } from 'xforge-common/command.service'; import { DataLoadingComponent } from 'xforge-common/data-loading-component'; import { DialogService } from 'xforge-common/dialog.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; @@ -167,7 +168,10 @@ export class SyncComponent extends DataLoadingComponent implements OnInit { ); projectId$.pipe(quietTakeUntilDestroyed(this.destroyRef)).subscribe(async projectId => { - this.projectDoc = await this.projectService.get(projectId); + this.projectDoc = await this.projectService.subscribe( + projectId, + new DocSubscription('SyncComponent', this.destroyRef) + ); this.checkSyncStatus(); this.loadingFinished(); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/text-chooser-dialog/text-chooser-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/text-chooser-dialog/text-chooser-dialog.component.spec.ts index 1a19d2529f0..0595f6bb336 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/text-chooser-dialog/text-chooser-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/text-chooser-dialog/text-chooser-dialog.component.spec.ts @@ -15,6 +15,7 @@ import * as RichText from 'rich-text'; import { firstValueFrom, of } from 'rxjs'; import { anything, instance, mock, spy, when } from 'ts-mockito'; import { DOCUMENT } from 'xforge-common/browser-globals'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserDoc } from 'xforge-common/models/user-doc'; import { TestOnlineStatusModule } from 'xforge-common/test-online-status.module'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; @@ -459,7 +460,7 @@ class TestEnvironment { const chooserDialogResult = new VerseRef('LUK', '1', '2'); when(this.mockedScriptureChooserMatDialogRef.afterClosed()).thenReturn(of(chooserDialogResult)); when(mockedUserService.getCurrentUser()).thenCall(() => - this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01') + this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')) ); this.fixture.detectChanges(); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts index d50fcd7e5c8..9fc234c3e62 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts @@ -15,6 +15,7 @@ import { } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-user-config'; import { mock, when } from 'ts-mockito'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; import { TestRealtimeService } from 'xforge-common/test-realtime.service'; import { @@ -238,18 +239,23 @@ class TestEnvironment { } getBiblicalTermDoc(id: string): BiblicalTermDoc { - return this.realtimeService.get(BiblicalTermDoc.COLLECTION, id); + return this.realtimeService.get(BiblicalTermDoc.COLLECTION, id, new DocSubscription('spec')); } getProjectDoc(id: string): SFProjectProfileDoc { - return this.realtimeService.get(SFProjectProfileDoc.COLLECTION, id); + return this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + id, + new DocSubscription('spec') + ); } openDialog(biblicalTermId: string, userId: string = 'user01'): void { this.realtimeService .subscribe( SF_PROJECT_USER_CONFIGS_COLLECTION, - getSFProjectUserConfigDocId('project01', userId) + getSFProjectUserConfigDocId('project01', userId), + new DocSubscription('spec') ) .then(projectUserConfigDoc => { const biblicalTermDoc = this.getBiblicalTermDoc(biblicalTermId); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts index 3cdcad0c3f2..2e36294e0ed 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts @@ -27,6 +27,7 @@ import { anything, capture, instance, mock, verify, when } from 'ts-mockito'; import { GenericDialogComponent, GenericDialogOptions } from 'xforge-common/generic-dialog/generic-dialog.component'; import { I18nService } from 'xforge-common/i18n.service'; import { Locale } from 'xforge-common/models/i18n-locale'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { QueryParameters } from 'xforge-common/query-parameters'; import { noopDestroyRef } from 'xforge-common/realtime.service'; @@ -317,7 +318,7 @@ describe('BiblicalTermsComponent', () => { const biblicalTerm = env.getBiblicalTermDoc(projectId, biblicalTermId); const verseData: VerseRefData = fromVerseRef(new VerseRef(biblicalTerm.data!.references[0])); - verify(mockedProjectService.createNoteThread(projectId, anything())).once(); + verify(mockedProjectService.createNoteThread(projectId, anything(), anything())).once(); const [, noteThread] = capture(mockedProjectService.createNoteThread).last(); expect(noteThread.verseRef).toEqual(verseData); expect(noteThread.originalSelectedText).toEqual(''); @@ -479,17 +480,22 @@ class TestEnvironment { }; return this.realtimeService.subscribeQuery(NoteThreadDoc.COLLECTION, parameters, noopDestroyRef); }); - when(mockedProjectService.getBiblicalTerm(anything())).thenCall(id => - this.realtimeService.subscribe(BiblicalTermDoc.COLLECTION, id) + when(mockedProjectService.getBiblicalTerm(anything(), anything())).thenCall((id, subscriber) => + this.realtimeService.subscribe(BiblicalTermDoc.COLLECTION, id, subscriber) ); - when(mockedProjectService.getNoteThread(anything())).thenCall(id => - this.realtimeService.subscribe(NoteThreadDoc.COLLECTION, id) + when(mockedProjectService.getNoteThread(anything(), anything())).thenCall((id, subscriber) => + this.realtimeService.subscribe(NoteThreadDoc.COLLECTION, id, subscriber) ); - when(mockedProjectService.getUserConfig(anything(), anything())).thenCall((projectId, userId) => - this.realtimeService.get(SFProjectUserConfigDoc.COLLECTION, getSFProjectUserConfigDocId(projectId, userId)) + when(mockedProjectService.getUserConfig(anything(), anything(), anything())).thenCall( + (projectId, userId, subscriber) => + this.realtimeService.subscribe( + SFProjectUserConfigDoc.COLLECTION, + getSFProjectUserConfigDocId(projectId, userId), + subscriber + ) ); - when(mockedProjectService.getProfile(anything())).thenCall(sfProjectId => - this.realtimeService.get(SFProjectProfileDoc.COLLECTION, sfProjectId) + when(mockedProjectService.getProfile(anything(), anything())).thenCall((sfProjectId, subscriber) => + this.realtimeService.get(SFProjectProfileDoc.COLLECTION, sfProjectId, subscriber) ); when(mockedMatDialog.open(GenericDialogComponent, anything())).thenReturn(instance(this.mockedDialogRef)); when(this.mockedDialogRef.afterClosed()).thenReturn(of()); @@ -549,16 +555,28 @@ class TestEnvironment { } getBiblicalTermDoc(projectId: string, dataId: string): BiblicalTermDoc { - return this.realtimeService.get(BiblicalTermDoc.COLLECTION, getBiblicalTermDocId(projectId, dataId)); + return this.realtimeService.get( + BiblicalTermDoc.COLLECTION, + getBiblicalTermDocId(projectId, dataId), + new DocSubscription('spec') + ); } getNoteThreadDoc(projectId: string, threadId: string): NoteThreadDoc { - return this.realtimeService.get(NoteThreadDoc.COLLECTION, getNoteThreadDocId(projectId, threadId)); + return this.realtimeService.get( + NoteThreadDoc.COLLECTION, + getNoteThreadDocId(projectId, threadId), + new DocSubscription('spec') + ); } getProjectUserConfigDoc(projectId: string, userId: string): SFProjectUserConfigDoc { const id: string = getSFProjectUserConfigDocId(projectId, userId); - return this.realtimeService.get(SFProjectUserConfigDoc.COLLECTION, id); + return this.realtimeService.get( + SFProjectUserConfigDoc.COLLECTION, + id, + new DocSubscription('spec') + ); } setLanguage(language: string): void { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.ts index da3cf44a9c3..3a74c165c84 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.ts @@ -21,6 +21,7 @@ import { filter } from 'rxjs/operators'; import { DataLoadingComponent } from 'xforge-common/data-loading-component'; import { DialogService } from 'xforge-common/dialog.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeQuery } from 'xforge-common/models/realtime-query'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; @@ -314,8 +315,15 @@ export class BiblicalTermsComponent extends DataLoadingComponent implements OnDe quietTakeUntilDestroyed(this.destroyRef) ) .subscribe(async projectId => { - this.projectDoc = await this.projectService.getProfile(projectId); - this.projectUserConfigDoc = await this.projectService.getUserConfig(projectId, this.userService.currentUserId); + this.projectDoc = await this.projectService.getProfile( + projectId, + new DocSubscription('BiblicalTermsComponent', this.destroyRef) + ); + this.projectUserConfigDoc = await this.projectService.getUserConfig( + projectId, + this.userService.currentUserId, + new DocSubscription('BiblicalTermsComponent', this.destroyRef) + ); // Subscribe to any project, book, chapter, verse, locale, biblical term, or note changes this.loadingStarted(); @@ -383,7 +391,10 @@ export class BiblicalTermsComponent extends DataLoadingComponent implements OnDe } async editRendering(id: string): Promise { - const biblicalTermDoc = await this.projectService.getBiblicalTerm(getBiblicalTermDocId(this._projectId!, id)); + const biblicalTermDoc = await this.projectService.getBiblicalTerm( + getBiblicalTermDocId(this._projectId!, id), + new DocSubscription('BiblicalTermsComponent', this.destroyRef) + ); this.dialogService.openMatDialog(BiblicalTermDialogComponent, { data: { biblicalTermDoc, projectDoc: this.projectDoc, projectUserConfigDoc: this.projectUserConfigDoc }, width: '560px' @@ -536,7 +547,8 @@ export class BiblicalTermsComponent extends DataLoadingComponent implements OnDe return; } const biblicalTermDoc = await this.projectService.getBiblicalTerm( - getBiblicalTermDocId(this._projectId!, params.biblicalTermId) + getBiblicalTermDocId(this._projectId!, params.biblicalTermId), + new DocSubscription('BiblicalTermsComponent', this.destroyRef) ); if (biblicalTermDoc?.data == null) { return; @@ -597,11 +609,16 @@ export class BiblicalTermsComponent extends DataLoadingComponent implements OnDe transliteration: biblicalTermDoc.data.transliteration } }; - await this.projectService.createNoteThread(this._projectId, noteThread); + await this.projectService.createNoteThread( + this._projectId, + noteThread, + new DocSubscription('BiblicalTermsComponent', this.destroyRef) + ); } else { // updated the existing note const threadDoc: NoteThreadDoc = await this.projectService.getNoteThread( - getNoteThreadDocId(this._projectId, params.threadDataId) + getNoteThreadDocId(this._projectId, params.threadDataId), + new DocSubscription('BiblicalTermsComponent', this.destroyRef) ); const noteIndex: number = threadDoc.data!.notes.findIndex(n => n.dataId === params.dataId); if (noteIndex >= 0) { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-apply-dialog/draft-apply-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-apply-dialog/draft-apply-dialog.component.spec.ts index cc50834085d..ef1c0ec0332 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-apply-dialog/draft-apply-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-apply-dialog/draft-apply-dialog.component.spec.ts @@ -343,7 +343,7 @@ class TestEnvironment { const mockedTextDoc = { getNonEmptyVerses: (): string[] => ['verse_1_1', 'verse_1_2', 'verse_1_3'] } as TextDoc; - when(mockedProjectService.getText(anything())).thenResolve(mockedTextDoc); + when(mockedProjectService.getText(anything(), anything())).thenResolve(mockedTextDoc); when(mockedTextDocService.userHasGeneralEditRight(anything())).thenReturn(true); } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-apply-dialog/draft-apply-dialog.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-apply-dialog/draft-apply-dialog.component.ts index 940edb5c999..3f73428810b 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-apply-dialog/draft-apply-dialog.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-apply-dialog/draft-apply-dialog.component.ts @@ -1,5 +1,5 @@ import { CommonModule } from '@angular/common'; -import { Component, Inject, OnInit, ViewChild } from '@angular/core'; +import { Component, DestroyRef, Inject, OnInit, ViewChild } from '@angular/core'; import { FormControl, FormGroup, Validators } from '@angular/forms'; import { MAT_DIALOG_DATA, MatDialogRef } from '@angular/material/dialog'; import { TranslocoModule } from '@ngneat/transloco'; @@ -8,6 +8,7 @@ import { Chapter, TextInfo } from 'realtime-server/lib/esm/scriptureforge/models import { TextInfoPermission } from 'realtime-server/lib/esm/scriptureforge/models/text-info-permission'; import { BehaviorSubject, map } from 'rxjs'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { UICommonModule } from 'xforge-common/ui-common.module'; import { SFUserProjectsService } from 'xforge-common/user-projects.service'; @@ -83,7 +84,8 @@ export class DraftApplyDialogComponent implements OnInit { private readonly textDocService: TextDocService, readonly i18n: I18nService, private readonly userService: UserService, - private readonly onlineStatusService: OnlineStatusService + private readonly onlineStatusService: OnlineStatusService, + private readonly destroyRef: DestroyRef ) { this.targetProject$.pipe(filterNullish()).subscribe(async project => { const chapters: number = await this.chaptersWithTextAsync(project); @@ -227,7 +229,10 @@ export class DraftApplyDialogComponent implements OnInit { } private async isNotEmpty(textDocId: TextDocId): Promise { - const textDoc: TextDoc = await this.projectService.getText(textDocId); + const textDoc: TextDoc = await this.projectService.getText( + textDocId, + new DocSubscription('DraftApplyDialogComponent', this.destroyRef) + ); return textDoc.getNonEmptyVerses().length > 0; } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-history-list/draft-history-entry/draft-history-entry.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-history-list/draft-history-entry/draft-history-entry.component.spec.ts index 16cc4fbe7c6..b4d93222a3b 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-history-list/draft-history-entry/draft-history-entry.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-history-list/draft-history-entry/draft-history-entry.component.spec.ts @@ -183,11 +183,11 @@ describe('DraftHistoryEntryComponent', () => { const targetProjectDoc = { id: 'project01' } as SFProjectProfileDoc; - when(mockedSFProjectService.getProfile('project01')).thenResolve(targetProjectDoc); + when(mockedSFProjectService.getProfile('project01', anything())).thenResolve(targetProjectDoc); const sourceProjectDoc = { id: 'project02' } as SFProjectProfileDoc; - when(mockedSFProjectService.getProfile('project02')).thenResolve(sourceProjectDoc); + when(mockedSFProjectService.getProfile('project02', anything())).thenResolve(sourceProjectDoc); const entry = { engine: { id: 'project01' @@ -230,7 +230,7 @@ describe('DraftHistoryEntryComponent', () => { when(mockedI18nService.formatAndLocalizeScriptureRange('GEN')).thenReturn('Genesis'); when(mockedI18nService.formatAndLocalizeScriptureRange('EXO')).thenReturn('Exodus'); const userDoc = { id: 'sf-user-id', data: undefined } as UserProfileDoc; - when(mockedUserService.getProfile(anything())).thenResolve(userDoc); + when(mockedUserService.getProfile(anything(), anything())).thenResolve(userDoc); const targetProjectDoc = { id: 'project01', data: createTestProjectProfile({ shortName: 'tar', writingSystem: { tag: 'en' } }) @@ -395,18 +395,18 @@ describe('DraftHistoryEntryComponent', () => { id: 'sf-user-id', data: createTestUserProfile({ displayName: user }) } as UserProfileDoc; - when(mockedUserService.getProfile('sf-user-id')).thenResolve(userDoc); + when(mockedUserService.getProfile('sf-user-id', anything())).thenResolve(userDoc); const targetProjectDoc = { id: 'project01', data: createTestProjectProfile({ shortName: 'tar', writingSystem: { tag: 'en' } }) } as SFProjectProfileDoc; - when(mockedSFProjectService.getProfile('project01')).thenResolve(targetProjectDoc); + when(mockedSFProjectService.getProfile('project01', anything())).thenResolve(targetProjectDoc); when(mockedActivatedProjectService.changes$).thenReturn(of(targetProjectDoc)); const sourceProjectDoc = { id: 'project02', data: createTestProjectProfile({ shortName: 'src', writingSystem: { tag: 'fr' } }) } as SFProjectProfileDoc; - when(mockedSFProjectService.getProfile('project02')).thenResolve(sourceProjectDoc); + when(mockedSFProjectService.getProfile('project02', anything())).thenResolve(sourceProjectDoc); const entry = { engine: { id: 'project01' diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-history-list/draft-history-entry/draft-history-entry.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-history-list/draft-history-entry/draft-history-entry.component.ts index 9c54da42079..f63b4d2c996 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-history-list/draft-history-entry/draft-history-entry.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-history-list/draft-history-entry/draft-history-entry.component.ts @@ -9,6 +9,7 @@ import { TranslocoModule } from '@ngneat/transloco'; import { ActivatedProjectService } from 'xforge-common/activated-project.service'; import { FeatureFlagService } from 'xforge-common/feature-flags/feature-flag.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeQuery } from 'xforge-common/models/realtime-query'; import { UserService } from 'xforge-common/user.service'; import { SFProjectProfileDoc } from '../../../../core/models/sf-project-profile-doc'; @@ -72,11 +73,16 @@ export class DraftHistoryEntryComponent { // Get the user who requested the build this._buildRequestedByUserName = undefined; if (this._entry?.additionalInfo?.requestedByUserId != null) { - this.userService.getProfile(this._entry.additionalInfo.requestedByUserId).then(user => { - if (user.data != null) { - this._buildRequestedByUserName = user.data.displayName; - } - }); + this.userService + .getProfile( + this._entry.additionalInfo.requestedByUserId, + new DocSubscription('DraftHistoryEntry', this.destroyRef) + ) + .then(user => { + if (user.data != null) { + this._buildRequestedByUserName = user.data.displayName; + } + }); } // Clear the data for the table @@ -91,14 +97,23 @@ export class DraftHistoryEntryComponent { // The engine ID is the target project ID let target: SFProjectProfileDoc | undefined = undefined; if (this._entry?.engine.id != null) { - target = await this.projectService.getProfile(this._entry.engine.id); + target = await this.projectService.getProfile( + this._entry.engine.id, + new DocSubscription('DraftHistoryEntry', this.destroyRef) + ); } // Get the target language, if it is not already set this._targetLanguage ??= target?.data?.writingSystem.tag; // Get the source project, if it is configured - const source = r.projectId === '' ? undefined : await this.projectService.getProfile(r.projectId); + const source = + r.projectId === '' + ? undefined + : await this.projectService.getProfile( + r.projectId, + new DocSubscription('DraftHistoryEntry', this.destroyRef) + ); // Get the source language, if it is not already set this._sourceLanguage ??= source?.data?.writingSystem.tag; @@ -131,7 +146,10 @@ export class DraftHistoryEntryComponent { const source = r.projectId === '' || r.projectId === value?.engine?.id ? undefined - : await this.projectService.getProfile(r.projectId); + : await this.projectService.getProfile( + r.projectId, + new DocSubscription('DraftHistoryEntry', this.destroyRef) + ); const sourceShortName = source?.data?.shortName; if (sourceShortName != null) this._translationSources.push(sourceShortName); }) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-preview-books/draft-preview-books.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-preview-books/draft-preview-books.component.spec.ts index d94394f518f..e594ea0cbfd 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-preview-books/draft-preview-books.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-preview-books/draft-preview-books.component.spec.ts @@ -255,7 +255,7 @@ describe('DraftPreviewBooks', () => { { bookNum: 1, chapters: [{ number: 1, lastVerse: 0 }], permissions: { user01: TextInfoPermission.Write } } ] }); - when(mockedProjectService.getProfile(projectEmptyBook)).thenResolve({ + when(mockedProjectService.getProfile(projectEmptyBook, anything())).thenResolve({ id: projectEmptyBook, data: projectWithChaptersMissing } as SFProjectProfileDoc); @@ -265,7 +265,7 @@ describe('DraftPreviewBooks', () => { verify(mockedDialogService.openMatDialog(DraftApplyDialogComponent, anything())).once(); verify(mockedProjectService.onlineAddChapters(projectEmptyBook, anything(), anything())).once(); // needs to create 2 texts - verify(mockedTextService.createTextDoc(anything())).twice(); + verify(mockedTextService.createTextDoc(anything(), anything())).twice(); verify(mockedDraftHandlingService.getAndApplyDraftAsync(anything(), anything(), anything(), anything())).times( env.booksWithDrafts[0].chaptersWithDrafts.length ); @@ -457,7 +457,7 @@ class TestEnvironment { ).thenResolve(); when(mockedActivatedProjectService.projectId).thenReturn('project01'); when(mockedUserService.currentUserId).thenReturn('user01'); - when(mockedProjectService.getProfile(anything())).thenResolve(this.mockProjectDoc); + when(mockedProjectService.getProfile(anything(), anything())).thenResolve(this.mockProjectDoc); this.fixture = TestBed.createComponent(DraftPreviewBooksComponent); this.component = this.fixture.componentInstance; this.component.build = build; diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-preview-books/draft-preview-books.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-preview-books/draft-preview-books.component.ts index 0e8962f9e6f..f287fcc55f1 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-preview-books/draft-preview-books.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-preview-books/draft-preview-books.component.ts @@ -1,5 +1,5 @@ import { CommonModule } from '@angular/common'; -import { Component, Input } from '@angular/core'; +import { Component, DestroyRef, Input } from '@angular/core'; import { MatDialogRef } from '@angular/material/dialog'; import { Router, RouterModule } from '@angular/router'; import { TranslocoModule } from '@ngneat/transloco'; @@ -11,6 +11,7 @@ import { BehaviorSubject, firstValueFrom, map, Observable, tap } from 'rxjs'; import { ActivatedProjectService } from 'xforge-common/activated-project.service'; import { DialogService } from 'xforge-common/dialog.service'; import { ErrorReportingService } from 'xforge-common/error-reporting.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UICommonModule } from 'xforge-common/ui-common.module'; import { UserService } from 'xforge-common/user.service'; import { filterNullish } from 'xforge-common/util/rxjs-util'; @@ -109,7 +110,8 @@ export class DraftPreviewBooksComponent { private readonly dialogService: DialogService, private readonly textDocService: TextDocService, private readonly errorReportingService: ErrorReportingService, - private readonly router: Router + private readonly router: Router, + private readonly destroyRef: DestroyRef ) {} get numChaptersApplied(): number { @@ -135,7 +137,10 @@ export class DraftPreviewBooksComponent { return; } - const projectDoc: SFProjectProfileDoc = await this.projectService.getProfile(result.projectId); + const projectDoc: SFProjectProfileDoc = await this.projectService.getProfile( + result.projectId, + new DocSubscription('DraftPreviewBooksComponent', this.destroyRef) + ); const projectTextInfo: TextInfo = projectDoc.data?.texts.find( t => t.bookNum === bookWithDraft.bookNumber && t.chapters )!; @@ -146,7 +151,10 @@ export class DraftPreviewBooksComponent { await this.projectService.onlineAddChapters(result.projectId, bookWithDraft.bookNumber, missingChapters); for (const chapter of missingChapters) { const textDocId = new TextDocId(result.projectId, bookWithDraft.bookNumber, chapter); - await this.textDocService.createTextDoc(textDocId); + await this.textDocService.createTextDoc( + textDocId, + new DocSubscription('DraftPreviewBooksComponent', this.destroyRef) + ); } } await this.applyBookDraftAsync(bookWithDraft, result.projectId); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources.service.spec.ts index 38558917b5b..883b9869f1b 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources.service.spec.ts @@ -2,7 +2,7 @@ import { TestBed } from '@angular/core/testing'; import { createTestUser } from 'realtime-server/lib/esm/common/models/user-test-data'; import { createTestProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-test-data'; import { BehaviorSubject } from 'rxjs'; -import { mock, when } from 'ts-mockito'; +import { anything, mock, when } from 'ts-mockito'; import { ActivatedProjectService } from 'xforge-common/activated-project.service'; import { UserDoc } from 'xforge-common/models/user-doc'; import { configureTestingModule } from 'xforge-common/test-utils'; @@ -212,16 +212,16 @@ describe('DraftSourcesService', () => { data: targetProject } as SFProjectProfileDoc) ); - when(mockProjectService.getProfile('source_project')).thenResolve({ + when(mockProjectService.getProfile('source_project', anything())).thenResolve({ data: sourceProject } as SFProjectProfileDoc); - when(mockProjectService.getProfile('alternate_source_project')).thenResolve({ + when(mockProjectService.getProfile('alternate_source_project', anything())).thenResolve({ data: alternateSourceProject } as SFProjectProfileDoc); - when(mockProjectService.getProfile('alternate_training_source_project')).thenResolve({ + when(mockProjectService.getProfile('alternate_training_source_project', anything())).thenResolve({ data: alternateTrainingSourceProject } as SFProjectProfileDoc); - when(mockProjectService.getProfile('additional_training_source_project')).thenResolve({ + when(mockProjectService.getProfile('additional_training_source_project', anything())).thenResolve({ data: additionalTrainingSourceProject } as SFProjectProfileDoc); when(mockUserService.getCurrentUser()).thenResolve({ diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources.service.ts index 8d5b010a415..c76149fa306 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources.service.ts @@ -1,9 +1,10 @@ -import { Injectable } from '@angular/core'; +import { DestroyRef, Injectable } from '@angular/core'; import { SFProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project'; import { TranslateSource } from 'realtime-server/lib/esm/scriptureforge/models/translate-config'; import { asyncScheduler, combineLatest, defer, from, Observable } from 'rxjs'; import { switchMap, throttleTime } from 'rxjs/operators'; import { ActivatedProjectService } from 'xforge-common/activated-project.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserDoc } from 'xforge-common/models/user-doc'; import { UserService } from 'xforge-common/user.service'; import { environment } from '../../../environments/environment'; @@ -30,14 +31,16 @@ export interface DraftSourcesAsArrays { providedIn: 'root' }) export class DraftSourcesService { - private readonly currentUser$: Observable = defer(() => from(this.userService.getCurrentUser())); - /** Duration to throttle large amounts of incoming project changes. 100 is a guess for what may be useful. */ + private readonly currentUser$: Observable = defer(() => + from(this.userService.getCurrentUser()) + ); /** Duration to throttle large amounts of incoming project changes. 100 is a guess for what may be useful. */ private readonly projectChangeThrottlingMs = 100; constructor( private readonly activatedProject: ActivatedProjectService, private readonly projectService: SFProjectService, - private readonly userService: UserService + private readonly userService: UserService, + private readonly destroyRef: DestroyRef ) {} /** @@ -86,6 +89,7 @@ export class DraftSourcesService { source: TranslateSource | SFProjectProfile, currentProjectDoc: SFProjectProfileDoc ): Promise { + const docSubscription = new DocSubscription('DraftSources', this.destroyRef); const currentUser = await this.userService.getCurrentUser(); const projectId = hasStringProp(source, 'projectRef') ? source.projectRef : currentProjectDoc.id; @@ -94,7 +98,7 @@ export class DraftSourcesService { let project: SFProjectProfile | undefined; if (source === currentProjectDoc?.data) project = currentProjectDoc.data; else if (currentUser.data?.sites[environment.siteId].projects?.includes(projectId)) { - project = (await this.projectService.getProfile(projectId)).data; + project = (await this.projectService.getProfile(projectId, docSubscription)).data; } if (project != null) { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.spec.ts index 6edd9c3d36d..6b9dc4cd7c6 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.spec.ts @@ -17,6 +17,7 @@ import { ErrorReportingService } from 'xforge-common/error-reporting.service'; import { FileService } from 'xforge-common/file.service'; import { I18nService } from 'xforge-common/i18n.service'; import { FileType } from 'xforge-common/models/file-offline-data'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeQuery } from 'xforge-common/models/realtime-query'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; @@ -750,7 +751,7 @@ class TestEnvironment { .map(o => { // Run it into and out of realtime service so it has fields like `remoteChanges$`. this.realtimeService.addSnapshot(SFProjectDoc.COLLECTION, o); - return this.realtimeService.get(SFProjectDoc.COLLECTION, o.id); + return this.realtimeService.get(SFProjectDoc.COLLECTION, o.id, new DocSubscription('spec')); }) .filter(hasData) .map(o => ({ diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/training-data/training-data.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/training-data/training-data.service.spec.ts index c5c426880e8..14efabe7f80 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/training-data/training-data.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/training-data/training-data.service.spec.ts @@ -3,6 +3,7 @@ import { getTrainingDataId, TrainingData } from 'realtime-server/lib/esm/scriptu import { anything, mock, verify } from 'ts-mockito'; import { FileService } from 'xforge-common/file.service'; import { FileType } from 'xforge-common/models/file-offline-data'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeQuery } from 'xforge-common/models/realtime-query'; import { Snapshot } from 'xforge-common/models/snapshot'; import { noopDestroyRef } from 'xforge-common/realtime.service'; @@ -70,7 +71,8 @@ describe('TrainingDataService', () => { const trainingDataDoc = realtimeService.get( TrainingDataDoc.COLLECTION, - getTrainingDataId('project01', 'data03') + getTrainingDataId('project01', 'data03'), + new DocSubscription('spec') ); expect(trainingDataDoc.data).toEqual(newTrainingData); })); @@ -79,7 +81,8 @@ describe('TrainingDataService', () => { // Verify the document exists const existingTrainingDataDoc = realtimeService.get( TrainingDataDoc.COLLECTION, - getTrainingDataId('project01', 'data01') + getTrainingDataId('project01', 'data01'), + new DocSubscription('spec') ); expect(existingTrainingDataDoc.data?.dataId).toBe('data01'); expect(existingTrainingDataDoc.data?.projectRef).toBe('project01'); @@ -99,7 +102,8 @@ describe('TrainingDataService', () => { const trainingDataDoc = realtimeService.get( TrainingDataDoc.COLLECTION, - getTrainingDataId('project01', 'data01') + getTrainingDataId('project01', 'data01'), + new DocSubscription('spec') ); expect(trainingDataDoc.data).toBeUndefined(); verify( diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/training-data/training-data.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/training-data/training-data.service.ts index a343b73b357..2f66303b699 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/training-data/training-data.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/training-data/training-data.service.ts @@ -2,6 +2,7 @@ import { DestroyRef, Injectable } from '@angular/core'; import { obj } from 'realtime-server/lib/esm/common/utils/obj-path'; import { getTrainingDataId, TrainingData } from 'realtime-server/lib/esm/scriptureforge/models/training-data'; import { FileType } from 'xforge-common/models/file-offline-data'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeQuery } from 'xforge-common/models/realtime-query'; import { QueryParameters } from 'xforge-common/query-parameters'; import { RealtimeService } from 'xforge-common/realtime.service'; @@ -11,17 +12,29 @@ import { TrainingDataDoc } from '../../../core/models/training-data-doc'; providedIn: 'root' }) export class TrainingDataService { - constructor(private readonly realtimeService: RealtimeService) {} + constructor( + private readonly realtimeService: RealtimeService, + private readonly destroyRef: DestroyRef + ) {} async createTrainingDataAsync(trainingData: TrainingData): Promise { const docId: string = getTrainingDataId(trainingData.projectRef, trainingData.dataId); - await this.realtimeService.create(TrainingDataDoc.COLLECTION, docId, trainingData); + await this.realtimeService.create( + TrainingDataDoc.COLLECTION, + docId, + trainingData, + new DocSubscription('TrainingDataService', this.destroyRef) + ); } async deleteTrainingDataAsync(trainingData: TrainingData): Promise { // Get the training data document const docId: string = getTrainingDataId(trainingData.projectRef, trainingData.dataId); - const trainingDataDoc = this.realtimeService.get(TrainingDataDoc.COLLECTION, docId); + const trainingDataDoc = await this.realtimeService.get( + TrainingDataDoc.COLLECTION, + docId, + new DocSubscription('TrainingDataService', this.destroyRef) + ); if (!trainingDataDoc.isLoaded) return; // Delete the training data file and document @@ -33,6 +46,11 @@ export class TrainingDataService { const queryParams: QueryParameters = { [obj().pathStr(t => t.projectRef)]: projectId }; - return this.realtimeService.subscribeQuery(TrainingDataDoc.COLLECTION, queryParams, destroyRef); + return this.realtimeService.subscribeQuery( + TrainingDataDoc.COLLECTION, + 'query_training_data', + queryParams, + destroyRef + ); } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-draft/editor-draft.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-draft/editor-draft.component.ts index 0ce7a81f7de..7148a709bed 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-draft/editor-draft.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-draft/editor-draft.component.ts @@ -31,6 +31,7 @@ import { ErrorReportingService } from 'xforge-common/error-reporting.service'; import { FeatureFlagService } from 'xforge-common/feature-flags/feature-flag.service'; import { FontService } from 'xforge-common/font.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { filterNullish, quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; @@ -338,7 +339,9 @@ export class EditorDraftComponent implements AfterViewInit, OnChanges { } private getTargetOps(): Observable { - return from(this.projectService.getText(this.textDocId!)).pipe( + return from( + this.projectService.getText(this.textDocId!, new DocSubscription('EditorDraftComponent', this.destroyRef)) + ).pipe( switchMap(textDoc => textDoc.changes$.pipe( startWith(undefined), diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/editor-history.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/editor-history.component.spec.ts index ad737648288..58ff685c200 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/editor-history.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/editor-history.component.spec.ts @@ -82,7 +82,7 @@ describe('EditorHistoryComponent', () => { editor: mockEditor }); - when(mockSFProjectService.getText(anything())).thenReturn(Promise.resolve(textDoc)); + when(mockSFProjectService.getText(anything(), anything())).thenReturn(Promise.resolve(textDoc)); component.historyChooser = mockHistoryChooserComponent; component.snapshotText = mockTextComponent; @@ -113,7 +113,7 @@ describe('EditorHistoryComponent', () => { editor: mockEditor }); - when(mockSFProjectService.getText(anything())).thenReturn(Promise.resolve(textDoc)); + when(mockSFProjectService.getText(anything(), anything())).thenReturn(Promise.resolve(textDoc)); component.historyChooser = mockHistoryChooserComponent; component.snapshotText = mockTextComponent; diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/editor-history.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/editor-history.component.ts index e89e898cabb..57cbe6e3dc3 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/editor-history.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/editor-history.component.ts @@ -13,6 +13,7 @@ import { Delta } from 'quill'; import { combineLatest, startWith, tap } from 'rxjs'; import { FontService } from 'xforge-common/font.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; import { SFProjectProfileDoc } from '../../../core/models/sf-project-profile-doc'; @@ -95,7 +96,10 @@ export class EditorHistoryComponent implements OnChanges, OnInit, AfterViewInit // Show the diff, if requested if (showDiff && this.diffText?.id != null) { - const textDoc: TextDoc = await this.projectService.getText(this.diffText.id); + const textDoc: TextDoc = await this.projectService.getText( + this.diffText.id, + new DocSubscription('EditorHistoryComponent', this.destroyRef) + ); const targetContents: Delta = new Delta(textDoc.data?.ops); const diff = this.editorHistoryService.processDiff(snapshotContents, targetContents); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/history-chooser/history-chooser.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/history-chooser/history-chooser.component.spec.ts index 444f85d76dc..bd83323b6fb 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/history-chooser/history-chooser.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/history-chooser/history-chooser.component.spec.ts @@ -284,8 +284,8 @@ describe('HistoryChooserComponent', () => { v: 1, isValid: this.isSnapshotValid }); - when(mockedProjectService.getProfile('project01')).thenCall(() => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, 'project01') + when(mockedProjectService.getProfile('project01', anything())).thenCall((id, subscriber) => + this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id, subscriber) ); when(mockedTextDocService.canRestore(anything(), 40, 1)).thenReturn(true); } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/history-chooser/history-chooser.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/history-chooser/history-chooser.component.ts index a02b667fdee..c9c743b5573 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/history-chooser/history-chooser.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-history/history-chooser/history-chooser.component.ts @@ -1,4 +1,13 @@ -import { AfterViewInit, Component, EventEmitter, Input, OnChanges, Output, SimpleChanges } from '@angular/core'; +import { + AfterViewInit, + Component, + DestroyRef, + EventEmitter, + Input, + OnChanges, + Output, + SimpleChanges +} from '@angular/core'; import { MatSelectChange } from '@angular/material/select'; import { Canon } from '@sillsdev/scripture'; import { Delta } from 'quill'; @@ -18,6 +27,7 @@ import { isNetworkError } from 'xforge-common/command.service'; import { DialogService } from 'xforge-common/dialog.service'; import { ErrorReportingService } from 'xforge-common/error-reporting.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { Snapshot } from 'xforge-common/models/snapshot'; import { TextSnapshot } from 'xforge-common/models/textsnapshot'; import { NoticeService } from 'xforge-common/notice.service'; @@ -71,7 +81,8 @@ export class HistoryChooserComponent implements AfterViewInit, OnChanges { private readonly projectService: SFProjectService, private readonly textDocService: TextDocService, private readonly errorReportingService: ErrorReportingService, - private readonly i18n: I18nService + private readonly i18n: I18nService, + private readonly destroyRef: DestroyRef ) {} get canRestoreSnapshot(): boolean { @@ -113,7 +124,10 @@ export class HistoryChooserComponent implements AfterViewInit, OnChanges { if (isOnline && this.projectId != null && this.bookNum != null && this.chapter != null) { this.loading$.next(true); try { - this.projectDoc = await this.projectService.getProfile(this.projectId); + this.projectDoc = await this.projectService.getProfile( + this.projectId, + new DocSubscription('HistoryChooserComponent', this.destroyRef) + ); if (this.historyRevisions.length === 0) { this.historyRevisions = (await this.paratextService.getRevisions(this.projectId, this.bookId, this.chapter)) ?? []; diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-resource/editor-resource.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-resource/editor-resource.component.spec.ts index f71cf5ac524..c1469c2c40f 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-resource/editor-resource.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-resource/editor-resource.component.spec.ts @@ -47,17 +47,17 @@ describe('EditorResourceComponent', () => { component['initProjectDetails'](); component.resourceText.editorCreated.next(); - verify(mockSFProjectService.getProfile(anything())).never(); + verify(mockSFProjectService.getProfile(anything(), anything())).never(); component.projectId = 'test'; component.bookNum = undefined; component.inputChanged$.next(); - verify(mockSFProjectService.getProfile(anything())).never(); + verify(mockSFProjectService.getProfile(anything(), anything())).never(); component.bookNum = 1; component.chapter = undefined; component.inputChanged$.next(); - verify(mockSFProjectService.getProfile(anything())).never(); + verify(mockSFProjectService.getProfile(anything(), anything())).never(); }); it('should init when projectId, bookNum, and chapter are defined', fakeAsync(() => { @@ -65,11 +65,11 @@ describe('EditorResourceComponent', () => { component.projectId = projectId; component.bookNum = 1; component.chapter = 1; - when(mockSFProjectService.getProfile(projectId)).thenReturn(Promise.resolve(projectDoc)); + when(mockSFProjectService.getProfile(projectId, anything())).thenReturn(Promise.resolve(projectDoc)); component['initProjectDetails'](); component.resourceText.editorCreated.next(); tick(); - verify(mockSFProjectService.getProfile(projectId)).once(); + verify(mockSFProjectService.getProfile(projectId, anything())).once(); verify(mockFontService.getFontFamilyFromProject(projectDoc)).once(); })); @@ -82,7 +82,7 @@ describe('EditorResourceComponent', () => { id: projectId, data: createTestProjectProfile({ isRightToLeft: true }) } as SFProjectProfileDoc; - when(mockSFProjectService.getProfile(projectId)).thenReturn(Promise.resolve(rtlProjectDoc)); + when(mockSFProjectService.getProfile(projectId, anything())).thenReturn(Promise.resolve(rtlProjectDoc)); component['initProjectDetails'](); component.resourceText.editorCreated.next(); tick(); @@ -98,7 +98,7 @@ describe('EditorResourceComponent', () => { id: projectId, data: createTestProjectProfile({ copyrightBanner: 'Test copyright', copyrightNotice: 'Test notice' }) } as SFProjectProfileDoc; - when(mockSFProjectService.getProfile(projectId)).thenReturn(Promise.resolve(projectNoticeDoc)); + when(mockSFProjectService.getProfile(projectId, anything())).thenReturn(Promise.resolve(projectNoticeDoc)); component['initProjectDetails'](); component.resourceText.editorCreated.next(); tick(); @@ -112,7 +112,7 @@ describe('EditorResourceComponent', () => { component.projectId = projectId; component.bookNum = 1; component.chapter = 1; - when(mockSFProjectService.getProfile(projectId)).thenReturn(Promise.resolve(projectDoc)); + when(mockSFProjectService.getProfile(projectId, anything())).thenReturn(Promise.resolve(projectDoc)); component['initProjectDetails'](); component.resourceText.editorCreated.next(); tick(); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-resource/editor-resource.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-resource/editor-resource.component.ts index bfc6e0a82eb..31c6e07dbfe 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-resource/editor-resource.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor-resource/editor-resource.component.ts @@ -1,6 +1,7 @@ import { AfterViewInit, Component, DestroyRef, Input, OnChanges, ViewChild } from '@angular/core'; import { combineLatest, EMPTY, startWith, Subject, switchMap } from 'rxjs'; import { FontService } from 'xforge-common/font.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; import { SFProjectProfileDoc } from '../../../core/models/sf-project-profile-doc'; import { SFProjectService } from '../../../core/sf-project.service'; @@ -52,7 +53,10 @@ export class EditorResourceComponent implements AfterViewInit, OnChanges { return EMPTY; } - return this.projectService.getProfile(this.projectId); + return this.projectService.getProfile( + this.projectId, + new DocSubscription('EditorResourceComponent', this.destroyRef) + ); }) ) .subscribe((projectDoc: SFProjectProfileDoc) => { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts index 6ce9b82ba5a..c05b4be133e 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts @@ -63,13 +63,14 @@ import { fromVerseRef } from 'realtime-server/lib/esm/scriptureforge/models/vers import * as RichText from 'rich-text'; import { DeltaOperation, StringMap } from 'rich-text'; import { BehaviorSubject, defer, firstValueFrom, Observable, of, Subject, take } from 'rxjs'; -import { anything, capture, deepEqual, instance, mock, resetCalls, verify, when } from 'ts-mockito'; +import { anyString, anything, capture, deepEqual, instance, mock, resetCalls, verify, when } from 'ts-mockito'; import { ActivatedProjectService } from 'xforge-common/activated-project.service'; import { AuthService } from 'xforge-common/auth.service'; import { CONSOLE } from 'xforge-common/browser-globals'; import { BugsnagService } from 'xforge-common/bugsnag.service'; import { createTestFeatureFlag, FeatureFlagService } from 'xforge-common/feature-flags/feature-flag.service'; import { GenericDialogComponent, GenericDialogOptions } from 'xforge-common/generic-dialog/generic-dialog.component'; +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'; @@ -353,7 +354,7 @@ describe('EditorComponent', () => { const env = new TestEnvironment(); const sourceId = new TextDocId('project02', 40, 1); let resolve: (value: TextDoc | PromiseLike) => void; - when(mockedSFProjectService.getText(deepEqual(sourceId))).thenReturn(new Promise(r => (resolve = r))); + when(mockedSFProjectService.getText(deepEqual(sourceId), anything())).thenReturn(new Promise(r => (resolve = r))); env.setProjectUserConfig({ selectedBookNum: 40, selectedChapterNum: 1, selectedSegment: 'verse_1_2' }); env.wait(); expect(env.component.target!.segmentRef).toBe('verse_1_2'); @@ -1262,7 +1263,7 @@ describe('EditorComponent', () => { })); it('user has no resource access', fakeAsync(() => { - when(mockedSFProjectService.getProfile('resource01')).thenResolve({ + when(mockedSFProjectService.getProfile('resource01', anything())).thenResolve({ id: 'resource01', data: createTestProjectProfile() } as SFProjectProfileDoc); @@ -1286,7 +1287,7 @@ describe('EditorComponent', () => { env.setProjectUserConfig(); env.routeWithParams({ projectId: 'project01', bookId: 'ACT' }); env.wait(); - verify(mockedSFProjectService.get('resource01')).never(); + verify(mockedSFProjectService.subscribe('resource01', anything())).never(); expect(env.bookName).toEqual('Acts'); expect(env.component.chapter).toBe(1); expect(env.component.sourceLabel).toEqual('SRC'); @@ -2925,7 +2926,7 @@ describe('EditorComponent', () => { const content: string = 'content in the thread'; env.mockNoteDialogRef.close({ noteContent: content }); env.wait(); - verify(mockedSFProjectService.createNoteThread(projectId, anything())).once(); + verify(mockedSFProjectService.createNoteThread(projectId, anything(), anything())).once(); const [, noteThread] = capture(mockedSFProjectService.createNoteThread).last(); let noteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc(projectId, noteThread.dataId); expect(noteThreadDoc.data!.notes[0].content).toEqual(content); @@ -2971,7 +2972,7 @@ describe('EditorComponent', () => { const promise = new Promise(resolve => { subject.subscribe(() => resolve(textDoc)); }); - when(mockedSFProjectService.getText(anything())).thenReturn(promise); + when(mockedSFProjectService.getText(anything(), anything())).thenReturn(promise); env.wait(); env.insertNoteFab.nativeElement.click(); env.wait(); @@ -3005,7 +3006,7 @@ describe('EditorComponent', () => { const noteVerseRef: VerseRef = (config as MatDialogConfig).data!.verseRef; expect(noteVerseRef.toString()).toEqual('MAT 1:4'); - verify(mockedSFProjectService.createNoteThread(projectId, anything())).once(); + verify(mockedSFProjectService.createNoteThread(projectId, anything(), anything())).once(); const [, noteThread] = capture(mockedSFProjectService.createNoteThread).last(); expect(noteThread.verseRef).toEqual(fromVerseRef(noteVerseRef)); expect(noteThread.publishedToSF).toBe(true); @@ -3747,7 +3748,7 @@ describe('EditorComponent', () => { })); it('user has no resource access', fakeAsync(() => { - when(mockedSFProjectService.getProfile('resource01')).thenResolve({ + when(mockedSFProjectService.getProfile('resource01', anything())).thenResolve({ id: 'resource01', data: createTestProjectProfile() } as SFProjectProfileDoc); @@ -3771,7 +3772,7 @@ describe('EditorComponent', () => { env.setProjectUserConfig(); env.routeWithParams({ projectId: 'project01', bookId: 'ACT' }); env.wait(); - verify(mockedSFProjectService.get('resource01')).never(); + verify(mockedSFProjectService.subscribe('resource01', anything())).never(); expect(env.bookName).toEqual('Acts'); expect(env.component.chapter).toBe(1); expect(env.component.sourceLabel).toEqual('SRC'); @@ -4047,7 +4048,7 @@ describe('EditorComponent', () => { it('should exclude deleted resource tabs (tabs that have "projectDoc" but not "projectDoc.data")', fakeAsync(async () => { const absentProjectId = 'absentProjectId'; - when(mockedSFProjectService.getProfile(absentProjectId)).thenResolve({ + when(mockedSFProjectService.getProfile(absentProjectId, anything())).thenResolve({ data: undefined } as SFProjectProfileDoc); const env = new TestEnvironment(); @@ -4776,29 +4777,30 @@ class TestEnvironment { when(this.mockedRemoteTranslationEngine.trainSegment(anything(), anything(), anything())).thenResolve(); when(this.mockedRemoteTranslationEngine.listenForTrainingStatus()).thenReturn(defer(() => this.trainingProgress$)); when(mockedSFProjectService.onlineAddTranslateMetrics('project01', anything())).thenResolve(); - when(mockedSFProjectService.getProfile('project01')).thenCall(() => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, 'project01') + when(mockedSFProjectService.getProfile(anyString(), anything())).thenCall((id, subscriber) => + this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id, subscriber) ); - when(mockedSFProjectService.getProfile('project02')).thenCall(() => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, 'project02') + when(mockedSFProjectService.tryGetForRole('project01', anything(), anything())).thenCall((id, role, subscriber) => + isParatextRole(role) ? this.realtimeService.subscribe(SFProjectDoc.COLLECTION, id, subscriber) : undefined ); - when(mockedSFProjectService.tryGetForRole('project01', anything())).thenCall((id, role) => - isParatextRole(role) ? this.realtimeService.subscribe(SFProjectDoc.COLLECTION, id) : undefined - ); - when(mockedSFProjectService.getUserConfig('project01', anything())).thenCall((_projectId, userId) => - this.realtimeService.subscribe( - SFProjectUserConfigDoc.COLLECTION, - getSFProjectUserConfigDocId('project01', userId) - ) + when(mockedSFProjectService.getUserConfig('project01', anything(), anything())).thenCall( + (_projectId, userId, subscriber) => + this.realtimeService.subscribe( + SFProjectUserConfigDoc.COLLECTION, + getSFProjectUserConfigDocId('project01', userId), + subscriber + ) ); - when(mockedSFProjectService.getUserConfig('project02', anything())).thenCall((_projectId, userId) => - this.realtimeService.subscribe( - SFProjectUserConfigDoc.COLLECTION, - getSFProjectUserConfigDocId('project02', userId) - ) + when(mockedSFProjectService.getUserConfig('project02', anything(), anything())).thenCall( + (_projectId, userId, subscriber) => + this.realtimeService.subscribe( + SFProjectUserConfigDoc.COLLECTION, + getSFProjectUserConfigDocId('project02', userId), + subscriber + ) ); - when(mockedSFProjectService.getText(anything())).thenCall(id => - this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString()) + when(mockedSFProjectService.getText(anything(), anything())).thenCall((id, subscriber) => + this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString(), subscriber) ); when(mockedSFProjectService.isProjectAdmin('project01', 'user04')).thenResolve(true); when(mockedSFProjectService.queryNoteThreads(anything(), anything(), anything(), anything())).thenCall( @@ -4833,12 +4835,13 @@ class TestEnvironment { noopDestroyRef ) ); - when(mockedSFProjectService.createNoteThread(anything(), anything())).thenCall( - (projectId: string, noteThread: NoteThread) => { + when(mockedSFProjectService.createNoteThread(anything(), anything(), anything())).thenCall( + (projectId: string, noteThread: NoteThread, subscription) => { this.realtimeService.create( NoteThreadDoc.COLLECTION, getNoteThreadDocId(projectId, noteThread.dataId), - noteThread + noteThread, + subscription ); tick(); } @@ -4857,7 +4860,7 @@ class TestEnvironment { when(this.mockedDialogRef.afterClosed()).thenReturn(of()); this.breakpointObserver.matchedResult = false; - when(mockedSFProjectService.getNoteThread(anything())).thenCall((id: string) => { + when(mockedSFProjectService.getNoteThread(anything(), anything())).thenCall((id: string) => { const [projectId, threadId] = id.split(':'); return this.getNoteThreadDoc(projectId, threadId); }); @@ -5044,7 +5047,7 @@ class TestEnvironment { deleteText(textId: string): void { this.ngZone.run(() => { - const textDoc = this.realtimeService.get(TextDoc.COLLECTION, textId); + const textDoc = this.realtimeService.get(TextDoc.COLLECTION, textId, new DocSubscription('spec')); textDoc.delete(); }); this.wait(); @@ -5052,7 +5055,9 @@ class TestEnvironment { setCurrentUser(userId: string): void { when(mockedUserService.currentUserId).thenReturn(userId); - when(mockedUserService.getCurrentUser()).thenCall(() => this.realtimeService.subscribe(UserDoc.COLLECTION, userId)); + when(mockedUserService.getCurrentUser()).thenCall(() => + this.realtimeService.subscribe(UserDoc.COLLECTION, userId, new DocSubscription('spec')) + ); } setParatextReviewerUser(): void { @@ -5196,12 +5201,17 @@ class TestEnvironment { getProjectUserConfigDoc(userId: string = 'user01'): SFProjectUserConfigDoc { return this.realtimeService.get( SFProjectUserConfigDoc.COLLECTION, - getSFProjectUserConfigDocId('project01', userId) + getSFProjectUserConfigDocId('project01', userId), + new DocSubscription('spec') ); } getProjectDoc(projectId: string): SFProjectProfileDoc { - return this.realtimeService.get(SFProjectProfileDoc.COLLECTION, projectId); + return this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + projectId, + new DocSubscription('spec') + ); } getSegmentElement(segmentRef: string): HTMLElement | null { @@ -5209,12 +5219,12 @@ class TestEnvironment { } getTextDoc(textId: TextDocId): TextDoc { - return this.realtimeService.get(TextDoc.COLLECTION, textId.toString()); + return this.realtimeService.get(TextDoc.COLLECTION, textId.toString(), new DocSubscription('spec')); } getNoteThreadDoc(projectId: string, threadDataId: string): NoteThreadDoc { const docId: string = projectId + ':' + threadDataId; - return this.realtimeService.get(NoteThreadDoc.COLLECTION, docId); + return this.realtimeService.get(NoteThreadDoc.COLLECTION, docId, new DocSubscription('spec')); } getNoteThreadIconElement(segmentRef: string, threadDataId: string): HTMLElement | null { @@ -5411,6 +5421,7 @@ class TestEnvironment { this.wait(); this.component.metricsSession?.dispose(); this.waitForPresenceTimer(); + flush(); } addTextDoc(id: TextDocId, textType: TextType = 'target', corrupt: boolean = false, tooLong: boolean = false): void { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.ts index 8ae52a7f703..8f207bbe180 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.ts @@ -89,6 +89,7 @@ import { FontService } from 'xforge-common/font.service'; import { I18nService } from 'xforge-common/i18n.service'; import { Breakpoint, MediaBreakpointService } from 'xforge-common/media-breakpoints/media-breakpoint.service'; import { LocaleDirection } from 'xforge-common/models/i18n-locale'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeQuery } from 'xforge-common/models/realtime-query'; import { UserDoc } from 'xforge-common/models/user-doc'; import { NoticeService } from 'xforge-common/notice.service'; @@ -739,11 +740,18 @@ export class EditorComponent extends DataLoadingComponent implements OnDestroy, const prevProjectId = this.projectDoc == null ? '' : this.projectDoc.id; if (projectId !== prevProjectId) { - this.projectDoc = await this.projectService.getProfile(projectId); + this.projectDoc = await this.projectService.getProfile( + projectId, + new DocSubscription('EditorComponent', this.destroyRef) + ); const userRole: string | undefined = this.userRole; if (userRole != null) { - const projectDoc: SFProjectDoc | undefined = await this.projectService.tryGetForRole(projectId, userRole); + const projectDoc: SFProjectDoc | undefined = await this.projectService.tryGetForRole( + projectId, + userRole, + new DocSubscription('EditorComponent', this.destroyRef) + ); if (projectDoc?.data?.paratextUsers != null) { this.paratextUsers = projectDoc.data.paratextUsers; } @@ -752,7 +760,8 @@ export class EditorComponent extends DataLoadingComponent implements OnDestroy, this.isParatextUserRole = isParatextRole(this.userRole); this.projectUserConfigDoc = await this.projectService.getUserConfig( projectId, - this.userService.currentUserId + this.userService.currentUserId, + new DocSubscription('EditorComponent', this.destroyRef) ); this.initLynxFeatureStates(this.projectUserConfigDoc); @@ -1273,7 +1282,10 @@ export class EditorComponent extends DataLoadingComponent implements OnDestroy, persistedTabs.map(async tabData => { let projectDoc: SFProjectProfileDoc | undefined = undefined; if (tabData.projectId != null) { - projectDoc = await this.projectService.getProfile(tabData.projectId); + projectDoc = await this.projectService.getProfile( + tabData.projectId, + new DocSubscription('EditorComponent', this.destroyRef) + ); } return { @@ -1428,10 +1440,15 @@ export class EditorComponent extends DataLoadingComponent implements OnDestroy, status: NoteStatus.Todo, publishedToSF: true }; - await this.projectService.createNoteThread(this.projectId, noteThread); + await this.projectService.createNoteThread( + this.projectId, + noteThread, + new DocSubscription('EditorComponent', this.destroyRef) + ); } else { const threadDoc: NoteThreadDoc = await this.projectService.getNoteThread( - getNoteThreadDocId(this.projectId, params.threadDataId) + getNoteThreadDocId(this.projectId, params.threadDataId), + new DocSubscription('EditorComponent', this.destroyRef) ); const noteIndex: number = threadDoc.data!.notes.findIndex(n => n.dataId === params.dataId); if (noteIndex >= 0) { @@ -1728,7 +1745,10 @@ export class EditorComponent extends DataLoadingComponent implements OnDestroy, this.target.id = targetId; this.setSegment(); - const textDoc = await this.projectService.getText(targetId); + const textDoc = await this.projectService.getText( + targetId, + new DocSubscription('EditorComponent', this.destroyRef) + ); if (this.onTargetDeleteSub != null) { this.onTargetDeleteSub.unsubscribe(); @@ -1983,7 +2003,10 @@ export class EditorComponent extends DataLoadingComponent implements OnDestroy, // Only get the project doc if the user is on the project to avoid an error. if (this.sourceProjectId == null) return undefined; if (this.currentUser?.sites[environment.siteId].projects.includes(this.sourceProjectId) !== true) return undefined; - return await this.projectService.getProfile(this.sourceProjectId); + return await this.projectService.getProfile( + this.sourceProjectId, + new DocSubscription('EditorComponent', this.destroyRef) + ); } private async loadNoteThreadDocs(sfProjectId: string, bookNum: number, chapterNum: number): Promise { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-insights-panel/lynx-insights-panel.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-insights-panel/lynx-insights-panel.component.spec.ts index 8e952512cc0..358ba097b57 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-insights-panel/lynx-insights-panel.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-insights-panel/lynx-insights-panel.component.spec.ts @@ -888,7 +888,7 @@ class TestEnvironment { when(mockTextDoc.data).thenReturn(mockTextDocData); // This is the critical fix - ensure getText returns a Promise, not null - when(mockSFProjectService.getText(anything())).thenReturn(Promise.resolve(instance(mockTextDoc))); + when(mockSFProjectService.getText(anything(), anything())).thenReturn(Promise.resolve(instance(mockTextDoc))); when(mockTextDoc.getSegmentText(anything())).thenReturn('Sample text content for testing'); when(mockRouter.navigate(anything(), anything())).thenReturn(Promise.resolve(true)); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-insights-panel/lynx-insights-panel.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-insights-panel/lynx-insights-panel.component.ts index 8f7a137a43f..6e65f421683 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-insights-panel/lynx-insights-panel.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-insights-panel/lynx-insights-panel.component.ts @@ -16,6 +16,7 @@ import { asapScheduler, combineLatest, debounceTime, map, tap } from 'rxjs'; import { ActivatedBookChapterService, RouteBookChapter } from 'xforge-common/activated-book-chapter.service'; import { ActivatedProjectService } from 'xforge-common/activated-project.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; import { isWhitespace } from 'xforge-common/util/string-util'; import { SFProjectService } from '../../../../../core/sf-project.service'; @@ -836,29 +837,31 @@ export class LynxInsightsPanelComponent implements AfterViewInit { } // Create and cache the promise for loading the document - return this.projectService.getText(insight.textDocId).then(textDoc => { - const textDocData: TextData | undefined = textDoc.data; + return this.projectService + .getText(insight.textDocId, new DocSubscription('LynxInsightsPanelComponent', this.destroyRef)) + .then(textDoc => { + const textDocData: TextData | undefined = textDoc.data; - if (textDocData != null) { - this.textDocDataCache.set(textDocIdStr, textDocData); + if (textDocData != null) { + this.textDocDataCache.set(textDocIdStr, textDocData); - if (textDocData.ops != null) { - this.textDocSegments.set(textDocIdStr, this.editorSegmentService.parseSegments(textDocData.ops)); + if (textDocData.ops != null) { + this.textDocSegments.set(textDocIdStr, this.editorSegmentService.parseSegments(textDocData.ops)); + } } - } - // On text edits, update cached text doc data and segment map for text doc - textDoc.changes$.pipe(quietTakeUntilDestroyed(this.destroyRef)).subscribe((changes: TextData) => { - if (changes?.ops != null) { - const prevDocOps: DeltaOperation[] | undefined = this.textDocDataCache.get(textDocIdStr)?.ops; - const newTextDocData: TextData = new Delta(prevDocOps).compose(new Delta(changes.ops)); - this.textDocDataCache.set(textDocIdStr, newTextDocData); - this.textDocSegments.set(textDocIdStr, this.editorSegmentService.parseSegments(newTextDocData.ops ?? [])); - } - }); + // On text edits, update cached text doc data and segment map for text doc + textDoc.changes$.pipe(quietTakeUntilDestroyed(this.destroyRef)).subscribe((changes: TextData) => { + if (changes?.ops != null) { + const prevDocOps: DeltaOperation[] | undefined = this.textDocDataCache.get(textDocIdStr)?.ops; + const newTextDocData: TextData = new Delta(prevDocOps).compose(new Delta(changes.ops)); + this.textDocDataCache.set(textDocIdStr, newTextDocData); + this.textDocSegments.set(textDocIdStr, this.editorSegmentService.parseSegments(newTextDocData.ops ?? [])); + } + }); - return this.textDocDataCache.get(textDocIdStr); - }); + return this.textDocDataCache.get(textDocIdStr); + }); } /** diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts index ba169193049..4df0288da17 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts @@ -13,6 +13,7 @@ import { ActivatedBookChapterService, RouteBookChapter } from 'xforge-common/act import { ActivatedProjectService } from 'xforge-common/activated-project.service'; import { I18nService } from 'xforge-common/i18n.service'; import { Locale } from 'xforge-common/models/i18n-locale'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeService } from 'xforge-common/realtime.service'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; import { TestRealtimeService } from 'xforge-common/test-realtime.service'; @@ -154,9 +155,9 @@ describe('LynxWorkspaceService', () => { init(): void { this.realtimeService = TestBed.inject(RealtimeService as any); - when(mockProjectService.getText(anything())).thenCall(textDocId => { + when(mockProjectService.getText(anything(), anything())).thenCall(textDocId => { const id = typeof textDocId === 'string' ? textDocId : textDocId.toString(); - const existingDoc = this.realtimeService.get(TextDoc.COLLECTION, id); + const existingDoc = this.realtimeService.get(TextDoc.COLLECTION, id, new DocSubscription('spec')); return Promise.resolve(existingDoc || this.createTextDoc()); }); @@ -186,7 +187,7 @@ describe('LynxWorkspaceService', () => { data: delta }); - return this.realtimeService.get(TextDoc.COLLECTION, id); + return this.realtimeService.get(TextDoc.COLLECTION, id, new DocSubscription('spec')); } createMockProjectDoc(id: string = PROJECT_ID, lynxConfig?: LynxConfig): SFProjectProfileDoc { @@ -210,7 +211,11 @@ describe('LynxWorkspaceService', () => { data: projectData }); - return this.realtimeService.get(SFProjectProfileDoc.COLLECTION, id); + return this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + id, + new DocSubscription('spec') + ); } createMockScriptureDeltaDoc(): any { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.ts index 8b534e48d09..5e6db3a2809 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.ts @@ -36,6 +36,7 @@ import { v4 as uuidv4 } from 'uuid'; import { ActivatedBookChapterService, RouteBookChapter } from 'xforge-common/activated-book-chapter.service'; import { ActivatedProjectService } from 'xforge-common/activated-project.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; import { SFProjectProfileDoc } from '../../../../core/models/sf-project-profile-doc'; import { TextDocId } from '../../../../core/models/text-doc'; @@ -428,7 +429,10 @@ export class LynxWorkspaceService { this.textDocId = textDocId; if (this.textDocId != null && shouldOpenDoc) { const uri: string = this.textDocId.toString(); - const textDoc = await this.projectService.getText(this.textDocId); + const textDoc = await this.projectService.getText( + this.textDocId, + new DocSubscription('LynxWorkspaceService', this.destroyRef) + ); await this.documentManager.fireOpened(uri, { format: 'scripture-delta', version: textDoc.adapter.version, @@ -491,14 +495,17 @@ export class LynxWorkspaceService { export class TextDocReader implements DocumentReader { public textDocIds: Set = new Set(); - constructor(private readonly projectService: SFProjectService) {} + constructor( + private readonly projectService: SFProjectService, + private readonly destroyRef: DestroyRef + ) {} keys(): Promise { return Promise.resolve([...this.textDocIds]); } async read(uri: string): Promise> { - const textDoc = await this.projectService.getText(uri); + const textDoc = await this.projectService.getText(uri, new DocSubscription('TextDocReader', this.destroyRef)); return { format: 'scripture-delta', content: textDoc.data as Delta, diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts index 979a9e09733..f80d6a92e6a 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts @@ -38,10 +38,11 @@ import * as RichText from 'rich-text'; import { firstValueFrom } from 'rxjs'; import { anything, mock, verify, when } from 'ts-mockito'; import { DialogService } from 'xforge-common/dialog.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserProfileDoc } from 'xforge-common/models/user-profile-doc'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; import { TestRealtimeService } from 'xforge-common/test-realtime.service'; -import { ChildViewContainerComponent, configureTestingModule, matDialogCloseDelay } from 'xforge-common/test-utils'; +import { ChildViewContainerComponent, configureTestingModule } from 'xforge-common/test-utils'; import { UserService } from 'xforge-common/user.service'; import { BiblicalTermDoc } from '../../../core/models/biblical-term-doc'; import { NoteThreadDoc } from '../../../core/models/note-thread-doc'; @@ -73,6 +74,7 @@ describe('NoteDialogComponent', () => { if (env.dialogContentArea != null) { env.closeDialog(); } + flush(); })); it('show selected text and toggle visibility of related segment', fakeAsync(() => { @@ -1028,8 +1030,8 @@ class TestEnvironment { when(mockedUserService.currentUserId).thenReturn(currentUserId); firstValueFrom(this.dialogRef.afterClosed()).then(result => (this.dialogResult = result)); - when(mockedUserService.getProfile(anything())).thenCall(id => - this.realtimeService.subscribe(UserProfileDoc.COLLECTION, id) + when(mockedUserService.getProfile(anything(), anything())).thenCall((id, subscriber) => + this.realtimeService.get(UserProfileDoc.COLLECTION, id, subscriber) ); when(mockedDialogService.confirm(anything(), anything())).thenResolve(true); @@ -1098,7 +1100,7 @@ class TestEnvironment { closeDialog(): void { this.overlayContainerElement.query(By.css('.close-button')).nativeElement.click(); - tick(matDialogCloseDelay); + flush(); } clickEditNote(): void { @@ -1121,12 +1123,16 @@ class TestEnvironment { getNoteThreadDoc(threadDataId: string): NoteThreadDoc { const id: string = getNoteThreadDocId(TestEnvironment.PROJECT01, threadDataId); - return this.realtimeService.get(NoteThreadDoc.COLLECTION, id); + return this.realtimeService.get(NoteThreadDoc.COLLECTION, id, new DocSubscription('spec')); } getProjectUserConfigDoc(projectId: string, userId: string): SFProjectUserConfigDoc { const id: string = getSFProjectUserConfigDocId(projectId, userId); - return this.realtimeService.get(SFProjectUserConfigDoc.COLLECTION, id); + return this.realtimeService.get( + SFProjectUserConfigDoc.COLLECTION, + id, + new DocSubscription('spec') + ); } getNoteContent(noteNumber: number): string { @@ -1149,7 +1155,7 @@ class TestEnvironment { submit(): void { this.saveButton.nativeElement.click(); - tick(matDialogCloseDelay); + flush(); } toggleSegmentButton(): void { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.ts index c82e42d697c..eba81c75a92 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.ts @@ -1,4 +1,4 @@ -import { Component, Inject, OnInit } from '@angular/core'; +import { Component, DestroyRef, Inject, OnInit } from '@angular/core'; import { FormControl, FormGroup, Validators } from '@angular/forms'; import { MAT_DIALOG_DATA, MatDialogRef } from '@angular/material/dialog'; import { VerseRef } from '@sillsdev/scripture'; @@ -18,6 +18,7 @@ import { isParatextRole } from 'realtime-server/lib/esm/scriptureforge/models/sf import { toVerseRef } from 'realtime-server/lib/esm/scriptureforge/models/verse-ref-data'; import { DialogService } from 'xforge-common/dialog.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserProfileDoc } from 'xforge-common/models/user-profile-doc'; import { UserService } from 'xforge-common/user.service'; import { BiblicalTermDoc } from '../../../core/models/biblical-term-doc'; @@ -86,28 +87,45 @@ export class NoteDialogComponent implements OnInit { private readonly i18n: I18nService, private readonly projectService: SFProjectService, private readonly userService: UserService, - private readonly dialogService: DialogService + private readonly dialogService: DialogService, + private readonly destroyRef: DestroyRef ) {} async ngOnInit(): Promise { // This can be refactored so the asynchronous calls are done in parallel if (this.threadDataId == null) { - this.textDoc = await this.projectService.getText(this.textDocId); + this.textDoc = await this.projectService.getText( + this.textDocId, + new DocSubscription('NoteDialogComponent', this.destroyRef) + ); } else { - this.threadDoc = await this.projectService.getNoteThread(this.projectId + ':' + this.threadDataId); - this.textDoc = await this.projectService.getText(this.textDocId); + this.threadDoc = await this.projectService.getNoteThread( + this.projectId + ':' + this.threadDataId, + new DocSubscription('NoteDialogComponent', this.destroyRef) + ); + this.textDoc = await this.projectService.getText( + this.textDocId, + new DocSubscription('NoteDialogComponent', this.destroyRef) + ); } if (this.biblicalTermId != null) { - this.biblicalTermDoc = await this.projectService.getBiblicalTerm(this.projectId + ':' + this.biblicalTermId); + this.biblicalTermDoc = await this.projectService.getBiblicalTerm( + this.projectId + ':' + this.biblicalTermId, + new DocSubscription('NoteDialogComponent', this.destroyRef) + ); } - this.projectProfileDoc = await this.projectService.getProfile(this.projectId); + this.projectProfileDoc = await this.projectService.getProfile( + this.projectId, + new DocSubscription('NoteDialogComponent', this.destroyRef) + ); this.userRole = this.projectProfileDoc?.data?.userRoles[this.userService.currentUserId]; if (this.userRole != null) { const projectDoc: SFProjectDoc | undefined = await this.projectService.tryGetForRole( this.projectId, - this.userRole + this.userRole, + new DocSubscription('NoteDialogComponent', this.destroyRef) ); if (this.threadDoc != null && projectDoc != null && projectDoc.data?.paratextUsers != null) { this.paratextProjectUsers = projectDoc.data.paratextUsers; @@ -444,7 +462,10 @@ export class NoteDialogComponent implements OnInit { */ private async getNoteUserNameAsync(note: Note): Promise { // Get the owner. This is often the project admin if the sync user is not in SF - const ownerDoc: UserProfileDoc = await this.userService.getProfile(note.ownerRef); + const ownerDoc: UserProfileDoc = await this.userService.getProfile( + note.ownerRef, + new DocSubscription('NoteDialogComponent', this.destroyRef) + ); // Get the sync user, if we have a syncUserRef for the note const syncUser: ParatextUserProfile | undefined = @@ -467,7 +488,12 @@ export class NoteDialogComponent implements OnInit { // The note was created in Paratext, so see if we have a profile for the sync user const syncUserProfile: UserProfileDoc | undefined = - syncUser.sfUserId == null ? undefined : await this.userService.getProfile(syncUser.sfUserId); + syncUser.sfUserId == null + ? undefined + : await this.userService.getProfile( + syncUser.sfUserId, + new DocSubscription('NoteDialogComponent', this.destroyRef) + ); return this.userService.currentUserId === syncUserProfile?.id ? this.i18n.translateStatic('checking.me') // "Me", i.e. the current user : (syncUserProfile?.data?.displayName ?? syncUser.username); // Another user, or fallback to the sync user diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/suggestions-settings-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/suggestions-settings-dialog.component.spec.ts new file mode 100644 index 00000000000..71cbe0636c8 --- /dev/null +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/suggestions-settings-dialog.component.spec.ts @@ -0,0 +1,281 @@ +import { DebugElement, NgModule } from '@angular/core'; +import { ComponentFixture, fakeAsync, flush, TestBed, tick } from '@angular/core/testing'; +import { MatDialog, MatDialogConfig } from '@angular/material/dialog'; +import { MatSelect } from '@angular/material/select'; +import { MatSlider } from '@angular/material/slider'; +import { By } from '@angular/platform-browser'; +import { NoopAnimationsModule } from '@angular/platform-browser/animations'; +import { cloneDeep } from 'lodash-es'; +import { SFProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project'; +import { SFProjectRole } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-role'; +import { createTestProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-test-data'; +import { + getSFProjectUserConfigDocId, + SF_PROJECT_USER_CONFIGS_COLLECTION, + SFProjectUserConfig +} from 'realtime-server/lib/esm/scriptureforge/models/sf-project-user-config'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; +import { OnlineStatusService } from 'xforge-common/online-status.service'; +import { TestOnlineStatusModule } from 'xforge-common/test-online-status.module'; +import { TestOnlineStatusService } from 'xforge-common/test-online-status.service'; +import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; +import { TestRealtimeService } from 'xforge-common/test-realtime.service'; +import { + ChildViewContainerComponent, + configureTestingModule, + matDialogCloseDelay, + TestTranslocoModule +} from 'xforge-common/test-utils'; +import { UICommonModule } from 'xforge-common/ui-common.module'; +import { SFProjectProfileDoc } from '../../core/models/sf-project-profile-doc'; +import { SFProjectUserConfigDoc } from '../../core/models/sf-project-user-config-doc'; +import { SF_TYPE_REGISTRY } from '../../core/models/sf-type-registry'; +import { + CONFIDENCE_THRESHOLD_TIMEOUT, + SuggestionsSettingsDialogComponent, + SuggestionsSettingsDialogData +} from './suggestions-settings-dialog.component'; + +describe('SuggestionsSettingsDialogComponent', () => { + configureTestingModule(() => ({ + imports: [ + DialogTestModule, + NoopAnimationsModule, + TestOnlineStatusModule.forRoot(), + TestRealtimeModule.forRoot(SF_TYPE_REGISTRY) + ], + providers: [{ provide: OnlineStatusService, useClass: TestOnlineStatusService }] + })); + + it('update confidence threshold', fakeAsync(() => { + const env = new TestEnvironment(); + env.openDialog(); + expect(env.component!.confidenceThreshold).toEqual(50); + + env.updateConfidenceThresholdSlider(60); + expect(env.component!.confidenceThreshold).toEqual(60); + const userConfigDoc = env.getProjectUserConfigDoc(); + expect(userConfigDoc.data!.confidenceThreshold).toEqual(0.6); + env.closeDialog(); + })); + + it('update suggestions enabled', fakeAsync(() => { + const env = new TestEnvironment(); + env.openDialog(); + expect(env.component!.translationSuggestionsUserEnabled).toBe(true); + + env.clickSwitch(env.suggestionsEnabledSwitch); + expect(env.component!.translationSuggestionsUserEnabled).toBe(false); + const userConfigDoc = env.getProjectUserConfigDoc(); + expect(userConfigDoc.data!.translationSuggestionsEnabled).toBe(false); + env.closeDialog(); + })); + + it('update num suggestions', fakeAsync(() => { + const env = new TestEnvironment(); + env.openDialog(); + expect(env.component!.numSuggestions).toEqual('1'); + + env.changeSelectValue(env.numSuggestionsSelect, 2); + expect(env.component!.numSuggestions).toEqual('2'); + const userConfigDoc = env.getProjectUserConfigDoc(); + expect(userConfigDoc.data!.numSuggestions).toEqual(2); + env.closeDialog(); + })); + + it('shows correct confidence threshold even when suggestions disabled', fakeAsync(() => { + const env = new TestEnvironment({ translationSuggestionsEnabled: false }); + env.openDialog(); + expect(env.component?.confidenceThreshold).toEqual(50); + env.closeDialog(); + })); + + it('disables settings when offline', fakeAsync(() => { + const env = new TestEnvironment(); + env.openDialog(); + + expect(env.offlineText).toBeNull(); + expect(env.suggestionsEnabledCheckbox.disabled).toBe(false); + expect(env.confidenceThresholdSlider.disabled).toBe(false); + expect(env.numSuggestionsSelect.disabled).toBe(false); + + env.isOnline = false; + + expect(env.offlineText).not.toBeNull(); + expect(env.suggestionsEnabledCheckbox.disabled).toBe(true); + expect(env.confidenceThresholdSlider.disabled).toBe(true); + expect(env.numSuggestionsSelect.disabled).toBe(true); + env.closeDialog(); + })); + + it('the suggestions toggle is switched on when the dialog opens while offline', fakeAsync(() => { + const env = new TestEnvironment(); + env.isOnline = false; + env.openDialog(); + + expect(env.suggestionsEnabledCheckbox.disabled).toBe(true); + expect(env.isSwitchChecked(env.suggestionsEnabledCheckbox)).toBe(true); + env.closeDialog(); + })); +}); + +@NgModule({ + imports: [UICommonModule, TestTranslocoModule], + declarations: [SuggestionsSettingsDialogComponent] +}) +class DialogTestModule {} + +interface TestEnvironmentConstructorArgs { + translationSuggestionsEnabled?: boolean; +} + +class TestEnvironment { + readonly fixture: ComponentFixture; + component?: SuggestionsSettingsDialogComponent; + readonly testOnlineStatusService: TestOnlineStatusService = TestBed.inject( + OnlineStatusService + ) as TestOnlineStatusService; + + private readonly realtimeService: TestRealtimeService = TestBed.inject(TestRealtimeService); + + constructor({ translationSuggestionsEnabled = true }: TestEnvironmentConstructorArgs = {}) { + this.setProjectUserConfig({ + confidenceThreshold: 0.5, + translationSuggestionsEnabled, + numSuggestions: 1 + }); + + this.fixture = TestBed.createComponent(ChildViewContainerComponent); + } + + get overlayContainerElement(): HTMLElement { + return this.fixture.nativeElement.parentElement.querySelector('.cdk-overlay-container'); + } + + get confidenceThresholdSlider(): MatSlider { + return this.fixture.debugElement.query(By.css('#confidence-threshold-slider')).componentInstance; + } + + get suggestionsEnabledSwitch(): HTMLElement { + return this.overlayContainerElement.querySelector('#suggestions-enabled-switch') as HTMLElement; + } + + get suggestionsEnabledCheckbox(): HTMLInputElement { + return this.suggestionsEnabledSwitch.querySelector('button[role=switch]') as HTMLInputElement; + } + + get numSuggestionsSelect(): MatSelect { + return this.fixture.debugElement.query(By.css('#num-suggestions-select')).componentInstance; + } + + get offlineText(): DebugElement { + return this.fixture.debugElement.query(By.css('.offline-text')); + } + + get closeButton(): HTMLElement { + return this.overlayContainerElement.querySelector('button[mat-dialog-close]') as HTMLElement; + } + + set isOnline(value: boolean) { + this.testOnlineStatusService.setIsOnline(value); + this.wait(); + } + + closeDialog(): void { + this.click(this.closeButton); + tick(matDialogCloseDelay); + } + + openDialog(): void { + this.realtimeService + .subscribe( + SF_PROJECT_USER_CONFIGS_COLLECTION, + getSFProjectUserConfigDocId('project01', 'user01'), + new DocSubscription('spec') + ) + .then(projectUserConfigDoc => { + const viewContainerRef = this.fixture.componentInstance.childViewContainer; + const projectDoc = this.getProjectProfileDoc(); + const config: MatDialogConfig = { + data: { projectDoc, projectUserConfigDoc }, + viewContainerRef + }; + const dialogRef = TestBed.inject(MatDialog).open(SuggestionsSettingsDialogComponent, config); + this.component = dialogRef.componentInstance; + }); + this.wait(); + } + + updateConfidenceThresholdSlider(value: number): void { + this.component!.confidenceThreshold = value; + tick(CONFIDENCE_THRESHOLD_TIMEOUT); + this.fixture.detectChanges(); + } + + setProjectUserConfig(userConfig: Partial = {}): void { + const user1Config = cloneDeep(userConfig) as SFProjectUserConfig; + user1Config.ownerRef = 'user01'; + this.realtimeService.addSnapshot(SFProjectUserConfigDoc.COLLECTION, { + id: getSFProjectUserConfigDocId('project01', user1Config.ownerRef), + data: user1Config + }); + this.realtimeService.addSnapshot(SFProjectProfileDoc.COLLECTION, { + id: 'project01', + data: createTestProjectProfile({ + translateConfig: { + translationSuggestionsEnabled: user1Config.translationSuggestionsEnabled + }, + userRoles: { user01: SFProjectRole.ParatextTranslator } + }) + }); + } + + getProjectProfileDoc(): SFProjectProfileDoc { + return this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + 'project01', + new DocSubscription('spec') + ); + } + + getProjectUserConfigDoc(): SFProjectUserConfigDoc { + return this.realtimeService.get( + SFProjectUserConfigDoc.COLLECTION, + getSFProjectUserConfigDocId('project01', 'user01'), + new DocSubscription('spec') + ); + } + + isSwitchChecked(switchButton: HTMLElement): boolean { + return switchButton.classList.contains('mdc-switch--checked'); + } + + clickSwitch(element: HTMLElement): void { + const button = element.querySelector('button[role=switch]') as HTMLInputElement; + this.click(button); + } + + click(element: HTMLElement): void { + element.click(); + flush(); + this.fixture.detectChanges(); + tick(); + } + + changeSelectValue(matSelect: MatSelect, option: number): void { + matSelect.value = option; + this.fixture.detectChanges(); + tick(); + } + + wait(): void { + this.fixture.detectChanges(); + tick(); + this.fixture.detectChanges(); + // open dialog animation + tick(166); + this.fixture.detectChanges(); + tick(); + this.fixture.detectChanges(); + } +} diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-request.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-request.service.spec.ts index 5c652a8f28a..7b22c8b61db 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-request.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-request.service.spec.ts @@ -2,6 +2,7 @@ import { createTestProject } from 'realtime-server/lib/esm/scriptureforge/models import { of } from 'rxjs'; import { anything, instance, mock, verify, when } from 'ts-mockito'; import { DialogService } from 'xforge-common/dialog.service'; +import { noopDestroyRef } from 'xforge-common/realtime.service'; import { SFProjectDoc } from '../../../core/models/sf-project-doc'; import { PermissionsService } from '../../../core/permissions.service'; import { SFProjectService } from '../../../core/sf-project.service'; @@ -25,7 +26,8 @@ describe('EditorTabAddRequestService', () => { instance(dialogService), instance(projectService), instance(permissionsService), - instance(tabStateService) + instance(tabStateService), + noopDestroyRef ); }); @@ -67,8 +69,8 @@ describe('EditorTabAddRequestService', () => { const projectDoc2 = createTestProjectDoc(2); when(tabStateService.tabs$).thenReturn(of([{ projectId: projectDoc1.id }, {}, { projectId: projectDoc2.id }])); - when(projectService.get(projectDoc1.id)).thenResolve(projectDoc1); - when(projectService.get(projectDoc2.id)).thenResolve(projectDoc2); + when(projectService.subscribe(projectDoc1.id, anything())).thenResolve(projectDoc1); + when(projectService.subscribe(projectDoc2.id, anything())).thenResolve(projectDoc2); when(permissionsService.isUserOnProject(anything())).thenResolve(true); service['getParatextIdsForOpenTabs']().subscribe(result => { @@ -82,13 +84,13 @@ describe('EditorTabAddRequestService', () => { const projectDoc2 = createTestProjectDoc(2); when(tabStateService.tabs$).thenReturn(of([{ projectId: projectDoc1.id }, {}, { projectId: projectDoc2.id }])); - when(projectService.get(projectDoc1.id)).thenResolve(projectDoc1); + when(projectService.subscribe(projectDoc1.id, anything())).thenResolve(projectDoc1); when(permissionsService.isUserOnProject(anything())).thenResolve(true); when(permissionsService.isUserOnProject(projectDoc2.id)).thenResolve(false); service['getParatextIdsForOpenTabs']().subscribe(result => { expect(result).toEqual([projectDoc1.data!.paratextId]); - verify(projectService.get(projectDoc2.id)).never(); + verify(projectService.subscribe(projectDoc2.id, anything())).never(); done(); }); }); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-request.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-request.service.ts index 1dd71af371a..83e1bfa8860 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-request.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-request.service.ts @@ -1,7 +1,8 @@ -import { Injectable } from '@angular/core'; +import { DestroyRef, Injectable } from '@angular/core'; import { EditorTabGroupType, EditorTabType } from 'realtime-server/lib/esm/scriptureforge/models/editor-tab'; import { map, Observable, of, switchMap, take } from 'rxjs'; import { DialogService } from 'xforge-common/dialog.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { filterNullish } from 'xforge-common/util/rxjs-util'; import { SFProjectDoc } from '../../../core/models/sf-project-doc'; import { PermissionsService } from '../../../core/permissions.service'; @@ -22,7 +23,8 @@ export class EditorTabAddRequestService implements TabAddRequestService + private readonly tabState: TabStateService, + private readonly destroyRef: DestroyRef ) {} handleTabAddRequest(tabType: EditorTabType): Observable | never> { @@ -48,7 +50,10 @@ export class EditorTabAddRequestService implements TabAddRequestService tab.projectId != null && (await this.permissionsService.isUserOnProject(tab.projectId)) - ? this.projectService.get(tab.projectId) + ? this.projectService.subscribe( + tab.projectId, + new DocSubscription('EditorTabAddRequestService', this.destroyRef) + ) : undefined ) ) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-resource-dialog/editor-tab-add-resource-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-resource-dialog/editor-tab-add-resource-dialog.component.spec.ts index cd1613d4b88..cc9cd1f4f7b 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-resource-dialog/editor-tab-add-resource-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-resource-dialog/editor-tab-add-resource-dialog.component.spec.ts @@ -252,7 +252,9 @@ class TestEnvironment { when(mockSFProjectService.onlineCreateResourceProject(this.paratextId)).thenCall(() => Promise.resolve(this.testProjectDoc.id) ); - when(mockSFProjectService.get(this.projectId)).thenCall(() => Promise.resolve(this.testProjectDoc)); + when(mockSFProjectService.subscribe(this.projectId, anything())).thenCall(() => + Promise.resolve(this.testProjectDoc) + ); when(mockSFProjectService.onlineSync(this.projectId)).thenReturn(Promise.resolve()); this.fixture = TestBed.createComponent(EditorTabAddResourceDialogComponent); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-resource-dialog/editor-tab-add-resource-dialog.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-resource-dialog/editor-tab-add-resource-dialog.component.ts index 9b392db0833..0bf28a3270a 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-resource-dialog/editor-tab-add-resource-dialog.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-add-resource-dialog/editor-tab-add-resource-dialog.component.ts @@ -2,6 +2,7 @@ import { Component, DestroyRef, Inject, OnInit } from '@angular/core'; import { FormControl, FormGroup, Validators } from '@angular/forms'; import { MAT_DIALOG_DATA, MatDialogRef } from '@angular/material/dialog'; import { map, repeat, take, timer } from 'rxjs'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; import { ParatextProject } from '../../../../core/models/paratext-project'; @@ -86,14 +87,24 @@ export class EditorTabAddResourceDialogComponent implements OnInit { await this.projectService.onlineAddCurrentUser(project.projectId); } this.selectedProjectDoc = - project?.projectId != null ? await this.projectService.get(project.projectId) : undefined; + project?.projectId != null + ? await this.projectService.subscribe( + project.projectId, + new DocSubscription('EditorTabAddResourceDialogComponent', this.destroyRef) + ) + : undefined; } else { // Load the project or resource, creating it if it is not present const projectId: string | undefined = this.appOnline ? await this.projectService.onlineCreateResourceProject(paratextId) : undefined; this.selectedProjectDoc = - projectId != null && this.appOnline ? await this.projectService.get(projectId) : undefined; + projectId != null && this.appOnline + ? await this.projectService.subscribe( + projectId, + new DocSubscription('EditorTabAddResourceDialogComponent', this.destroyRef) + ) + : undefined; } if (this.selectedProjectDoc != null) { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-persistence.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-persistence.service.spec.ts index 5367e4b667d..670340b3ca8 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-persistence.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-persistence.service.spec.ts @@ -3,8 +3,9 @@ import { cloneDeep } from 'lodash-es'; import { EditorTabPersistData } from 'realtime-server/lib/esm/scriptureforge/models/editor-tab-persist-data'; import { createTestProjectUserConfig } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-user-config-test-data'; import { of, Subject } from 'rxjs'; -import { instance, mock, when } from 'ts-mockito'; +import { anything, instance, mock, when } from 'ts-mockito'; import { ActivatedProjectService } from 'xforge-common/activated-project.service'; +import { noopDestroyRef } from 'xforge-common/realtime.service'; import { UserService } from 'xforge-common/user.service'; import { SFProjectUserConfigDoc } from '../../../core/models/sf-project-user-config-doc'; import { SFProjectService } from '../../../core/sf-project.service'; @@ -81,12 +82,15 @@ class TestEnvironment { when(this.mockActivatedProjectService.projectId$).thenReturn(of('project01')); when(this.mockUserService.currentUserId).thenReturn('user01'); - when(this.mockProjectService.getUserConfig('project01', 'user01')).thenReturn(Promise.resolve(this.pucDoc)); + when(this.mockProjectService.getUserConfig('project01', 'user01', anything())).thenReturn( + Promise.resolve(this.pucDoc) + ); this.service = new EditorTabPersistenceService( instance(this.mockActivatedProjectService), instance(this.mockUserService), - instance(this.mockProjectService) + instance(this.mockProjectService), + noopDestroyRef ); } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-persistence.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-persistence.service.ts index 36d323572e3..90967793779 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-persistence.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/tabs/editor-tab-persistence.service.ts @@ -1,10 +1,11 @@ -import { Injectable } from '@angular/core'; +import { DestroyRef, Injectable } from '@angular/core'; import { isEqual, isUndefined, omitBy } from 'lodash-es'; import { editorTabTypes } from 'realtime-server/lib/esm/scriptureforge/models/editor-tab'; import { EditorTabPersistData } from 'realtime-server/lib/esm/scriptureforge/models/editor-tab-persist-data'; -import { Observable, Subject, Subscription, combineLatest, firstValueFrom, of, startWith, switchMap, tap } from 'rxjs'; +import { combineLatest, firstValueFrom, Observable, of, startWith, Subject, Subscription, switchMap, tap } from 'rxjs'; import { distinctUntilChanged, finalize, shareReplay } from 'rxjs/operators'; import { ActivatedProjectService } from 'xforge-common/activated-project.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserService } from 'xforge-common/user.service'; import { filterNullish } from 'xforge-common/util/rxjs-util'; import { SFProjectUserConfigDoc } from '../../../core/models/sf-project-user-config-doc'; @@ -27,7 +28,8 @@ export class EditorTabPersistenceService { constructor( private readonly activatedProject: ActivatedProjectService, private readonly userService: UserService, - private readonly projectService: SFProjectService + private readonly projectService: SFProjectService, + private readonly destroyRef: DestroyRef ) {} /** @@ -56,7 +58,13 @@ export class EditorTabPersistenceService { this.activatedProject.projectId$.pipe(filterNullish()), pucChanged$.pipe(startWith(undefined)) ]).pipe( - switchMap(([projectId]) => this.projectService.getUserConfig(projectId, this.userService.currentUserId)), + switchMap(([projectId]) => + this.projectService.getUserConfig( + projectId, + this.userService.currentUserId, + new DocSubscription('EditorTabPersistenceService', this.destroyRef) + ) + ), tap(pucDoc => { pucChangesSub?.unsubscribe(); pucChangesSub = pucDoc.changes$.subscribe(() => { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translate-metrics-session.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translate-metrics-session.spec.ts index fb2121d3280..ba4eb55b525 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translate-metrics-session.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translate-metrics-session.spec.ts @@ -9,6 +9,7 @@ import * as RichText from 'rich-text'; import { anything, deepEqual, instance, mock, objectContaining, resetCalls, verify, when } from 'ts-mockito'; import { CommandError, CommandErrorCode } from 'xforge-common/command.service'; import { ErrorReportingService } from 'xforge-common/error-reporting.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserDoc } from 'xforge-common/models/user-doc'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { TestOnlineStatusModule } from 'xforge-common/test-online-status.module'; @@ -470,15 +471,14 @@ class TestEnvironment { }) }); - when(mockedSFProjectService.getText(anything())).thenCall(id => - this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString()) + when(mockedSFProjectService.getText(anything(), anything())).thenCall((id, subscriber) => + this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString(), subscriber) ); - when(mockedSFProjectService.onlineAddTranslateMetrics('project01', anything())).thenResolve(); - when(mockedSFProjectService.getProfile(anything())).thenCall(id => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id.toString()) + when(mockedSFProjectService.getProfile(anything(), anything())).thenCall((id, subscriber) => + this.realtimeService.get(SFProjectProfileDoc.COLLECTION, id.toString(), subscriber) ); when(mockedUserService.getCurrentUser()).thenCall(() => - this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01') + this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')) ); this.sourceFixture = TestBed.createComponent(TextComponent); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/training-progress/training-progress.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/training-progress/training-progress.component.ts index 423cf83b349..5dbcd1be102 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/training-progress/training-progress.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/training-progress/training-progress.component.ts @@ -4,6 +4,7 @@ import { SF_PROJECT_RIGHTS, SFProjectDomain } from 'realtime-server/lib/esm/scri import { BehaviorSubject, Subscription, timer } from 'rxjs'; import { filter, repeat, retry, tap } from 'rxjs/operators'; import { DataLoadingComponent } from 'xforge-common/data-loading-component'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { UserService } from 'xforge-common/user.service'; import { quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; @@ -58,7 +59,10 @@ export class TrainingProgressComponent extends DataLoadingComponent implements O if (this.projectDoc == null || projectId !== this._projectId) { this.loadingStarted(); try { - this.projectDoc = await this.projectService.getProfile(projectId); + this.projectDoc = await this.projectService.getProfile( + projectId, + new DocSubscription('TrainingProgressComponent', this.destroyRef) + ); this.setupTranslationEngine(); } finally { this.loadingFinished(); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts index 9e58737f2f8..4ff11b8aeeb 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts @@ -18,6 +18,7 @@ import * as RichText from 'rich-text'; import { defer, of, Subject } from 'rxjs'; import { anything, instance, mock, verify, when } from 'ts-mockito'; import { AuthService } from 'xforge-common/auth.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'; @@ -334,7 +335,9 @@ class TestEnvironment { setCurrentUser(userId: string = 'user01'): void { when(mockedUserService.currentUserId).thenReturn(userId); - when(mockedUserService.getCurrentUser()).thenCall(() => this.realtimeService.subscribe(UserDoc.COLLECTION, userId)); + when(mockedUserService.getCurrentUser()).thenCall(() => + this.realtimeService.subscribe(UserDoc.COLLECTION, userId, new DocSubscription('spec')) + ); } wait(): void { @@ -548,13 +551,21 @@ class TestEnvironment { const delta = new Delta(); delta.insert(`chapter ${chapter}, verse 22.`, { segment: `verse_${chapter}_22` }); - const textDoc = this.realtimeService.get(TextDoc.COLLECTION, getTextDocId('project01', bookNum, chapter)); + const textDoc = this.realtimeService.get( + TextDoc.COLLECTION, + getTextDocId('project01', bookNum, chapter), + new DocSubscription('spec') + ); textDoc.submit({ ops: delta.ops }); this.waitForProjectDocChanges(); } simulateTranslateSuggestionsEnabled(enabled: boolean = true): void { - const projectDoc: SFProjectProfileDoc = this.realtimeService.get(SFProjectProfileDoc.COLLECTION, 'project01'); + const projectDoc: SFProjectProfileDoc = this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + 'project01', + new DocSubscription('spec') + ); projectDoc.submitJson0Op( op => op.set(p => p.translateConfig.translationSuggestionsEnabled, enabled), false diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.ts index 966cf27b68e..723bdd12ecd 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.ts @@ -13,6 +13,7 @@ import { filter, map, repeat, retry, tap, throttleTime } from 'rxjs/operators'; import { AuthService } from 'xforge-common/auth.service'; import { DataLoadingComponent } from 'xforge-common/data-loading-component'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { UserService } from 'xforge-common/user.service'; @@ -97,7 +98,10 @@ export class TranslateOverviewComponent extends DataLoadingComponent implements quietTakeUntilDestroyed(this.destroyRef) ) .subscribe(async projectId => { - this.projectDoc = await this.projectService.getProfile(projectId); + this.projectDoc = await this.projectService.getProfile( + projectId, + new DocSubscription('TranslateOverviewComponent', this.destroyRef) + ); // Update the overview now if we are online, or when we are next online this.onlineStatusService.online.then(async () => { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts index 06d4ed2d777..942cfe47683 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts @@ -18,6 +18,7 @@ import { AvatarComponent } from 'xforge-common/avatar/avatar.component'; import { CommandError, CommandErrorCode } from 'xforge-common/command.service'; import { DialogService } from 'xforge-common/dialog.service'; import { NONE_ROLE, ProjectRoleInfo } from 'xforge-common/models/project-role-info'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserProfileDoc } from 'xforge-common/models/user-profile-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; @@ -423,22 +424,26 @@ class TestEnvironment { when(mockedProjectService.onlineInvite(this.project01Id, anything(), anything(), anything())).thenResolve(); when(mockedProjectService.onlineInvitedUsers(this.project01Id)).thenResolve([]); when(mockedNoticeService.show(anything())).thenResolve(); - when(mockedUserService.getProfile(anything())).thenCall(userId => - this.realtimeService.subscribe(UserProfileDoc.COLLECTION, userId) + when(mockedUserService.getProfile(anything(), anything())).thenCall((userId, subscription) => + this.realtimeService.get(UserProfileDoc.COLLECTION, userId, subscription) ); when(mockedUserService.currentUserId).thenReturn('user01'); - when(mockedProjectService.get(anything())).thenCall(projectId => - this.realtimeService.subscribe(SFProjectDoc.COLLECTION, projectId) + when(mockedProjectService.subscribe(anything(), anything())).thenCall((projectId, subscription) => + this.realtimeService.subscribe(SFProjectDoc.COLLECTION, projectId, subscription) ); - when(mockedProjectService.getProfile(anything())).thenCall(projectId => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, projectId) + when(mockedProjectService.getProfile(anything(), anything())).thenCall((projectId, subscriber) => + this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, projectId, subscriber) ); when( mockedProjectService.onlineGetLinkSharingKey(this.project01Id, anything(), anything(), anything()) ).thenResolve('linkSharingKey01'); when(mockedProjectService.onlineSetUserProjectPermissions(this.project01Id, 'user02', anything())).thenCall( (projectId: string, userId: string, permissions: string[]) => { - const projectDoc: SFProjectDoc = this.realtimeService.get(SFProjectDoc.COLLECTION, projectId); + const projectDoc: SFProjectDoc = this.realtimeService.get( + SFProjectDoc.COLLECTION, + projectId, + new DocSubscription('spec') + ); return projectDoc.submitJson0Op(op => op.set(p => p.userPermissions[userId], permissions)); } ); @@ -577,7 +582,11 @@ class TestEnvironment { } updateCheckingProperties(config: CheckingConfig): Promise { - const projectDoc: SFProjectDoc = this.realtimeService.get(SFProjectDoc.COLLECTION, this.project01Id); + const projectDoc: SFProjectDoc = this.realtimeService.get( + SFProjectDoc.COLLECTION, + this.project01Id, + new DocSubscription('spec') + ); return projectDoc.submitJson0Op(op => { op.set(p => p.checkingConfig, config); }); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.ts index e548b42d5fe..7456f7a9eed 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.ts @@ -9,6 +9,7 @@ import { DataLoadingComponent } from 'xforge-common/data-loading-component'; import { DialogService } from 'xforge-common/dialog.service'; import { ExternalUrlService } from 'xforge-common/external-url.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { NoticeService } from 'xforge-common/notice.service'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { UserService } from 'xforge-common/user.service'; @@ -141,7 +142,10 @@ export class CollaboratorsComponent extends DataLoadingComponent implements OnIn ) .subscribe(async projectId => { this.loadingStarted(); - this.projectDoc = await this.projectService.get(projectId); + this.projectDoc = await this.projectService.subscribe( + projectId, + new DocSubscription('CollaboratorsComponent', this.destroyRef) + ); this.loadUsers(); // TODO Clean up the use of nested subscribe() this.projectDoc.remoteChanges$.pipe(quietTakeUntilDestroyed(this.destroyRef)).subscribe(async () => { @@ -234,7 +238,11 @@ export class CollaboratorsComponent extends DataLoadingComponent implements OnIn } const userIds = Object.keys(project.userRoles); - const userProfiles = await Promise.all(userIds.map(userId => this.userService.getProfile(userId))); + const userProfiles = await Promise.all( + userIds.map(userId => + this.userService.getProfile(userId, new DocSubscription('CollaboratorsComponent', this.destroyRef)) + ) + ); const userRows: Row[] = []; for (const [index, userId] of userIds.entries()) { const userProfile = userProfiles[index]; diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/users/roles-and-permissions/roles-and-permissions-dialog.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/users/roles-and-permissions/roles-and-permissions-dialog.component.ts index 8c45ca58c2e..250eb38aeb1 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/users/roles-and-permissions/roles-and-permissions-dialog.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/users/roles-and-permissions/roles-and-permissions-dialog.component.ts @@ -9,6 +9,7 @@ import { isParatextRole, SFProjectRole } from 'realtime-server/lib/esm/scripture import { Subscription } from 'rxjs'; import { ExternalUrlService } from 'xforge-common/external-url.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; import { SFProjectDoc } from '../../core/models/sf-project-doc'; @@ -49,7 +50,14 @@ export class RolesAndPermissionsDialogComponent implements OnInit { ) {} async ngOnInit(): Promise { - this.projectDoc = await this.projectService.get(this.data.projectId); + this.onlineService.onlineStatus$.subscribe(isOnline => { + isOnline ? this.form.enable() : this.form.disable(); + }); + + this.projectDoc = await this.projectService.subscribe( + this.data.projectId, + new DocSubscription('RolesAndPermissionsDialogComponent', this.destroyRef) + ); this.onlineSubscription?.unsubscribe(); this.onlineSubscription = this.onlineService.onlineStatus$ @@ -92,7 +100,10 @@ export class RolesAndPermissionsDialogComponent implements OnInit { const selectedRole = this.roles.value; await this.projectService.onlineUpdateUserRole(this.data.projectId, this.data.userId, selectedRole); - this.projectDoc = await this.projectService.get(this.data.projectId); + this.projectDoc = await this.projectService.subscribe( + this.data.projectId, + new DocSubscription('RolesAndPermissionsDialogComponent', this.destroyRef) + ); const permissions = new Set((this.projectDoc?.data?.userPermissions ?? {})[this.data.userId] ?? []); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/users/roles-and-permissions/roles-and-permissions-dialog.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/users/roles-and-permissions/roles-and-permissions-dialog.spec.ts index c47eff69395..f93e3b8e0be 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/users/roles-and-permissions/roles-and-permissions-dialog.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/users/roles-and-permissions/roles-and-permissions-dialog.spec.ts @@ -21,6 +21,7 @@ import { BehaviorSubject } from 'rxjs'; import { anything, deepEqual, mock, verify, when } from 'ts-mockito'; import { ExternalUrlService } from 'xforge-common/external-url.service'; import { I18nService } from 'xforge-common/i18n.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { OnlineStatusService } from 'xforge-common/online-status.service'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; import { TestRealtimeService } from 'xforge-common/test-realtime.service'; @@ -161,7 +162,7 @@ describe('RolesAndPermissionsComponent', () => { //prep for role change when(mockedProjectService.onlineUpdateUserRole(anything(), anything(), anything())).thenCall((p, u, r) => { rolesByUser[u] = r; - const projectDoc: SFProjectDoc = env.realtimeService.get(SFProjectDoc.COLLECTION, p); + const projectDoc: SFProjectDoc = env.realtimeService.get(SFProjectDoc.COLLECTION, p, new DocSubscription('spec')); projectDoc.submitJson0Op(op => { op.set(p => p.userRoles, rolesByUser); op.set(p => p.userPermissions, { @@ -215,8 +216,8 @@ class TestEnvironment { constructor() { when(mockedOnlineStatusService.onlineStatus$).thenReturn(this.isOnline$.asObservable()); - when(mockedProjectService.get(anything())).thenCall(projectId => - this.realtimeService.subscribe(SFProjectDoc.COLLECTION, projectId) + when(mockedProjectService.subscribe(anything(), anything())).thenCall((projectId, subscription) => + this.realtimeService.subscribe(SFProjectDoc.COLLECTION, projectId, subscription) ); this.fixture = TestBed.createComponent(ChildViewContainerComponent); @@ -243,7 +244,8 @@ class TestEnvironment { this.realtimeService .subscribe( SF_PROJECT_USER_CONFIGS_COLLECTION, - getSFProjectUserConfigDocId('project01', userId) + getSFProjectUserConfigDocId('project01', userId), + new DocSubscription('spec') ) .then(() => { const config: MatDialogConfig = { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/activated-project-user-config.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/activated-project-user-config.service.spec.ts index 37603443091..e099a97e010 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/activated-project-user-config.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/activated-project-user-config.service.spec.ts @@ -2,7 +2,7 @@ import { fakeAsync, TestBed, tick } from '@angular/core/testing'; import { SFProjectUserConfig } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-user-config'; import { createTestProjectUserConfig } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-user-config-test-data'; import { BehaviorSubject, Subject } from 'rxjs'; -import { mock, when } from 'ts-mockito'; +import { anything, mock, when } from 'ts-mockito'; import { configureTestingModule } from 'xforge-common/test-utils'; import { SFProjectUserConfigDoc } from '../app/core/models/sf-project-user-config-doc'; import { SFProjectService } from '../app/core/sf-project.service'; @@ -73,7 +73,7 @@ describe('ActivatedProjectUserConfigService', () => { it('should emit project user config when project becomes active', fakeAsync(() => { const { doc, config } = createTestDoc(PROJECT_ID); - when(mockedProjectService.getUserConfig(PROJECT_ID, USER_ID)).thenResolve(doc); + when(mockedProjectService.getUserConfig(PROJECT_ID, USER_ID, anything())).thenResolve(doc); let emittedDoc: SFProjectUserConfigDoc | undefined; let emittedConfig: SFProjectUserConfig | undefined; @@ -89,7 +89,7 @@ describe('ActivatedProjectUserConfigService', () => { it('should emit updated project user config when config changes', fakeAsync(() => { const { doc, changesSubject } = createTestDoc(PROJECT_ID); - when(mockedProjectService.getUserConfig(PROJECT_ID, USER_ID)).thenResolve(doc); + when(mockedProjectService.getUserConfig(PROJECT_ID, USER_ID, anything())).thenResolve(doc); projectIdSubject.next(PROJECT_ID); tick(); @@ -115,8 +115,8 @@ describe('ActivatedProjectUserConfigService', () => { const project1 = createTestDoc(PROJECT_ID); const project2 = createTestDoc(PROJECT_ID_2); - when(mockedProjectService.getUserConfig(PROJECT_ID, USER_ID)).thenResolve(project1.doc); - when(mockedProjectService.getUserConfig(PROJECT_ID_2, USER_ID)).thenResolve(project2.doc); + when(mockedProjectService.getUserConfig(PROJECT_ID, USER_ID, anything())).thenResolve(project1.doc); + when(mockedProjectService.getUserConfig(PROJECT_ID_2, USER_ID, anything())).thenResolve(project2.doc); let currentDoc: SFProjectUserConfigDoc | undefined; service.projectUserConfigDoc$.subscribe(doc => (currentDoc = doc)); @@ -131,7 +131,7 @@ describe('ActivatedProjectUserConfigService', () => { })); it('should handle case where project user config is not available', fakeAsync(() => { - when(mockedProjectService.getUserConfig('missing-project', USER_ID)).thenResolve(undefined as any); + when(mockedProjectService.getUserConfig('missing-project', USER_ID, anything())).thenResolve(undefined as any); let doc: SFProjectUserConfigDoc | undefined; service.projectUserConfigDoc$.subscribe(d => (doc = d)); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/activated-project-user-config.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/activated-project-user-config.service.ts index 368da533a2b..36cb8f60ec6 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/activated-project-user-config.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/activated-project-user-config.service.ts @@ -1,9 +1,10 @@ -import { Injectable } from '@angular/core'; +import { DestroyRef, Injectable } from '@angular/core'; import { SFProjectUserConfig } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-user-config'; -import { Observable, map, of, shareReplay, startWith, switchMap } from 'rxjs'; +import { map, Observable, of, shareReplay, startWith, switchMap } from 'rxjs'; import { SFProjectUserConfigDoc } from '../app/core/models/sf-project-user-config-doc'; import { SFProjectService } from '../app/core/sf-project.service'; import { ActivatedProjectService } from './activated-project.service'; +import { DocSubscription } from './models/realtime-doc'; import { UserService } from './user.service'; @Injectable({ @@ -13,7 +14,13 @@ export class ActivatedProjectUserConfigService { readonly projectUserConfigDoc$: Observable = this.activatedProject.projectId$.pipe( switchMap(projectId => - projectId != null ? this.projectService.getUserConfig(projectId, this.userService.currentUserId) : of(undefined) + projectId != null + ? this.projectService.getUserConfig( + projectId, + this.userService.currentUserId, + new DocSubscription('ActivatedProjectUserConfigService', this.destroyRef) + ) + : of(undefined) ), switchMap( projectUserConfigDoc => @@ -33,6 +40,7 @@ export class ActivatedProjectUserConfigService { constructor( private readonly activatedProject: ActivatedProjectService, private readonly projectService: SFProjectService, - private readonly userService: UserService + private readonly userService: UserService, + private readonly destroyRef: DestroyRef ) {} } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/activated-project.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/activated-project.service.ts index 1e03fc72e67..44f6e3b6a89 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/activated-project.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/activated-project.service.ts @@ -4,11 +4,10 @@ import { ActivationEnd, Router } from '@angular/router'; import ObjectID from 'bson-objectid'; import { BehaviorSubject, Observable, of } from 'rxjs'; import { filter, map, startWith, switchMap } from 'rxjs/operators'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { quietTakeUntilDestroyed } from 'xforge-common/util/rxjs-util'; import { SFProjectProfileDoc } from '../app/core/models/sf-project-profile-doc'; -import { PermissionsService } from '../app/core/permissions.service'; import { SFProjectService } from '../app/core/sf-project.service'; -import { CacheService } from '../app/shared/cache-service/cache.service'; import { noopDestroyRef } from './realtime.service'; interface IActiveProjectIdService { /** SF project id */ @@ -56,7 +55,6 @@ export class ActivatedProjectService { constructor( private readonly projectService: SFProjectService, - private readonly cacheService: CacheService, @Inject(ActiveProjectIdService) activeProjectIdService: IActiveProjectIdService, private destroyRef: DestroyRef ) { @@ -87,9 +85,6 @@ export class ActivatedProjectService { private set projectDoc(projectDoc: SFProjectProfileDoc | undefined) { if (this.projectDoc !== projectDoc) { this._projectDoc$.next(projectDoc); - if (this.projectDoc !== undefined) { - this.cacheService.cache(this.projectDoc); - } } } @@ -112,7 +107,10 @@ export class ActivatedProjectService { return; } this.projectId = projectId; - const projectDoc: SFProjectProfileDoc = await this.projectService.getProfile(projectId); + const projectDoc: SFProjectProfileDoc = await this.projectService.getProfile( + projectId, + new DocSubscription('ActivatedProjectService', this.destroyRef) + ); // Make sure the project ID is still the same before updating the project document if (this.projectId === projectId) { this.projectDoc = projectDoc; @@ -129,19 +127,13 @@ export class TestActiveProjectIdService implements IActiveProjectIdService { export class TestActivatedProjectService extends ActivatedProjectService { constructor( projectService: SFProjectService, - cacheService: CacheService, @Inject(ActiveProjectIdService) activeProjectIdService: IActiveProjectIdService ) { - super(projectService, cacheService, activeProjectIdService, noopDestroyRef); + super(projectService, activeProjectIdService, noopDestroyRef); } static withProjectId(projectId: string): TestActivatedProjectService { const projectService = TestBed.inject(SFProjectService); - const permissionsService = TestBed.inject(PermissionsService); - return new TestActivatedProjectService( - projectService, - new CacheService(projectService, permissionsService), - new TestActiveProjectIdService(projectId) - ); + return new TestActivatedProjectService(projectService, new TestActiveProjectIdService(projectId)); } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/file.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/file.service.spec.ts index c70c0534bb1..a86e446618c 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/file.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/file.service.spec.ts @@ -11,6 +11,7 @@ import { DialogService } from './dialog.service'; import { FileService, formatFileSource } from './file.service'; import { createDeletionFileData, createStorageFileData, FileOfflineData, FileType } from './models/file-offline-data'; import { ProjectDataDoc } from './models/project-data-doc'; +import { DocSubscription } from './models/realtime-doc'; import { OnlineStatusService } from './online-status.service'; import { TestOnlineStatusModule } from './test-online-status.module'; import { TestOnlineStatusService } from './test-online-status.service'; @@ -306,7 +307,9 @@ class TestEnvironment { id: this.dataId, data: { dataId: this.dataId, projectRef: this.projectId, ownerRef: this.userId } }); - this.realtimeService.subscribe(TestDataDoc.COLLECTION, this.dataId).then(d => (this.doc = d)); + this.realtimeService + .subscribe(TestDataDoc.COLLECTION, this.dataId, new DocSubscription('spec')) + .then(d => (this.doc = d)); tick(); } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/file.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/file.service.ts index f30811c06fa..1c67d93b64c 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/file.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/file.service.ts @@ -14,6 +14,7 @@ import { FileType } from './models/file-offline-data'; import { ProjectDataDoc } from './models/project-data-doc'; +import { DocSubscription } from './models/realtime-doc'; import { OfflineStore } from './offline-store'; import { OnlineStatusService } from './online-status.service'; import { RealtimeService } from './realtime.service'; @@ -279,7 +280,8 @@ export class FileService { // The file has not been uploaded to the server const doc = await this.realtimeService.onlineFetch( fileData.dataCollection, - fileData.realtimeDocRef! + fileData.realtimeDocRef!, + new DocSubscription('FileService', this.destroyRef) ); if (doc.isLoaded) { const url = await doc.uploadFile(fileType, fileData.id, fileData.blob!, fileData.filename!); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-doc-lifecycle-monitor.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-doc-lifecycle-monitor.spec.ts new file mode 100644 index 00000000000..f4b2a4483c4 --- /dev/null +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-doc-lifecycle-monitor.spec.ts @@ -0,0 +1,132 @@ +import { RealtimeDocLifecycleMonitorService } from './realtime-doc-lifecycle-monitor'; + +describe('RealtimeDocLifecycleMonitorService', () => { + let service: RealtimeDocLifecycleMonitorService; + + beforeEach(() => { + service = new RealtimeDocLifecycleMonitorService(); + jasmine.clock().install(); + }); + + afterEach(() => { + jasmine.clock().uninstall(); + }); + + it('should not record events when monitoring is disabled', () => { + service.setMonitoringEnabled(false); + service.docCreated('doc1', 'userA'); + service.docDestroyed('doc1'); + expect(service.createdTimestamps['doc1']).toBeUndefined(); + expect(service.destroyedTimestamps['doc1']).toBeUndefined(); + }); + + it('should record created and destroyed timestamps when monitoring is enabled', () => { + service.setMonitoringEnabled(true); + jasmine.clock().mockDate(new Date(1000)); + service.docCreated('doc1', 'userA'); + jasmine.clock().mockDate(new Date(2000)); + service.docDestroyed('doc1'); + expect(service.createdTimestamps['doc1'][0].timestamp).toBe(1000); + expect(service.createdTimestamps['doc1'][0].creatorName).toBe('userA'); + expect(service.destroyedTimestamps['doc1'][0]).toBe(2000); + }); + + it('should match created and destroyed events in recreates', () => { + service.setMonitoringEnabled(true); + jasmine.clock().mockDate(new Date(1000)); + service.docCreated('doc1', 'userA'); + jasmine.clock().mockDate(new Date(2000)); + service.docDestroyed('doc1'); + jasmine.clock().mockDate(new Date(3000)); + service.docCreated('doc1', 'userB'); + jasmine.clock().mockDate(new Date(4000)); + service.docDestroyed('doc1'); + jasmine.clock().mockDate(new Date(5000)); + service.docCreated('doc1', 'userC'); + const recreates = service.getDocumentRecreates('doc1'); + expect(recreates.length).toBe(2); + expect(recreates[0]).toEqual({ destroyed: 2000, created: 3000, creatorName: 'userB' }); + expect(recreates[1]).toEqual({ destroyed: 4000, created: 5000, creatorName: 'userC' }); + }); + + it('should detect thrashing documents', () => { + service.setMonitoringEnabled(true); + jasmine.clock().mockDate(new Date(1000)); + service.docCreated('doc1', 'userA'); + jasmine.clock().mockDate(new Date(2000)); + service.docDestroyed('doc1'); + jasmine.clock().mockDate(new Date(2100)); + service.docCreated('doc1', 'userB'); + jasmine.clock().mockDate(new Date(2200)); + service.docDestroyed('doc1'); + jasmine.clock().mockDate(new Date(2250)); + service.docCreated('doc1', 'userC'); + jasmine.clock().mockDate(new Date(2300)); + service.docDestroyed('doc1'); + // Thrashing threshold: 200ms, must thrash at least twice + const thrashing = service.getThrashingDocuments(200, 2); + expect(thrashing['doc1'].length).toBeGreaterThanOrEqual(2); + expect(thrashing['doc1'][0].creatorName).toBe('userB'); + expect(thrashing['doc1'][1].creatorName).toBe('userC'); + expect(thrashing['doc1'][0].recreateDuration).toBe(100); + expect(thrashing['doc1'][1].recreateDuration).toBe(50); + }); + + it('should not detect thrashing if recreate durations exceed threshold', () => { + service.setMonitoringEnabled(true); + jasmine.clock().mockDate(new Date(1000)); + service.docCreated('doc2', 'userA'); + jasmine.clock().mockDate(new Date(2000)); + service.docDestroyed('doc2'); + jasmine.clock().mockDate(new Date(3000)); + service.docCreated('doc2', 'userB'); + jasmine.clock().mockDate(new Date(4000)); + service.docDestroyed('doc2'); + const thrashing = service.getThrashingDocuments(500, 2); + expect(thrashing['doc2']).toBeUndefined(); + }); + + it('should handle destroyed events without matching created events', () => { + service.setMonitoringEnabled(true); + jasmine.clock().mockDate(new Date(1000)); + service.docDestroyed('doc3'); + jasmine.clock().mockDate(new Date(2000)); + service.docCreated('doc3', 'userA'); + const recreates = service.getDocumentRecreates('doc3'); + expect(recreates.length).toBe(1); + expect(recreates[0].destroyed).toBe(1000); + expect(recreates[0].created).toBe(2000); + expect(recreates[0].creatorName).toBe('userA'); + }); + + it('should return all recreates for all documents', () => { + service.setMonitoringEnabled(true); + jasmine.clock().mockDate(new Date(1000)); + service.docCreated('docA', 'userA'); + jasmine.clock().mockDate(new Date(2000)); + service.docDestroyed('docA'); + jasmine.clock().mockDate(new Date(3000)); + service.docCreated('docB', 'userB'); + jasmine.clock().mockDate(new Date(4000)); + service.docDestroyed('docB'); + jasmine.clock().mockDate(new Date(5000)); + service.docCreated('docA', 'userC'); + const all = service.getAllDocumentRecreates(); + expect(Object.keys(all)).toContain('docA'); + expect(Object.keys(all).length).toBe(2); + expect(all['docA'][0].creatorName).toBe('userC'); + expect(all['docB'].length).toBe(0); + }); + + it('should not match destroyed events after created events', () => { + service.setMonitoringEnabled(true); + jasmine.clock().mockDate(new Date(1000)); + service.docCreated('docX', 'userA'); + jasmine.clock().mockDate(new Date(2000)); + service.docCreated('docX', 'userB'); + jasmine.clock().mockDate(new Date(3000)); + service.docDestroyed('docX'); + const recreates = service.getDocumentRecreates('docX'); + expect(recreates.length).toBe(0); + }); +}); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-doc-lifecycle-monitor.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-doc-lifecycle-monitor.ts new file mode 100644 index 00000000000..98665ec6e4e --- /dev/null +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-doc-lifecycle-monitor.ts @@ -0,0 +1,98 @@ +import { Injectable } from '@angular/core'; + +/** + * This class helps monitor the lifecyle of realtime documents and detect situations where documents are rapidly + * destroyed and then recreated. + */ +@Injectable({ providedIn: 'root' }) +export class RealtimeDocLifecycleMonitorService { + monitoringEnabled: boolean = false; + + setMonitoringEnabled(enabled: boolean): void { + this.monitoringEnabled = enabled; + } + + createdTimestamps: { + [id: string]: { + timestamp: number; + creatorName: string; + }[]; + } = {}; + + destroyedTimestamps: { + [id: string]: number[]; + } = {}; + + docCreated(id: string, creatorName: string): void { + if (this.monitoringEnabled) { + this.createdTimestamps[id] ??= []; + this.createdTimestamps[id].push({ timestamp: Date.now(), creatorName }); + } + } + + docDestroyed(id: string): void { + if (this.monitoringEnabled) { + this.destroyedTimestamps[id] ??= []; + this.destroyedTimestamps[id].push(Date.now()); + } + } + + /** + * Finds instances where a document is destroyed and then recreated within a short time period. + * @param timeThreshold The maximum time in milliseconds between destruction and recreation to consider it thrashing. + * @param times The minimum number of times the document must be recreated within the time threshold to be considered + * thrashing (the recreates do not all have to occur within the time threshold, but each recreate must be within the + * threshold of the previous destroy to be counted). + * @return An object where the keys are document IDs and the values are arrays of the time differences between + * destruction and recreation. + */ + getThrashingDocuments( + timeThreshold: number, + times: number + ): { + [id: string]: { + creatorName: string; + recreateDuration: number; + }[]; + } { + const thrashingDocs: { [id: string]: { creatorName: string; recreateDuration: number }[] } = {}; + for (const id of Object.keys(this.createdTimestamps)) { + const recreates = this.getDocumentRecreates(id); + const recreateTimes: { creatorName: string; recreateDuration: number }[] = []; + for (const recreate of recreates) { + const recreateDuration = recreate.created - recreate.destroyed; + if (recreateDuration <= timeThreshold) { + recreateTimes.push({ creatorName: recreate.creatorName, recreateDuration }); + } + } + if (recreateTimes.length >= times) { + thrashingDocs[id] = recreateTimes; + } + } + return thrashingDocs; + } + + getAllDocumentRecreates(): { [id: string]: { created: number; destroyed: number; creatorName: string }[] } { + const recreates: { [id: string]: { created: number; destroyed: number; creatorName: string }[] } = {}; + for (const id of Object.keys(this.createdTimestamps)) { + recreates[id] = this.getDocumentRecreates(id); + } + return recreates; + } + + getDocumentRecreates(id: string): { destroyed: number; created: number; creatorName: string }[] { + const created = this.createdTimestamps[id] ?? []; + const destroyed = this.destroyedTimestamps[id] ?? []; + const recreates: { created: number; destroyed: number; creatorName: string }[] = []; + for (let i = 0; i < created.length; i++) { + const createdTime = created[i].timestamp; + // Since monitoring is not always enabled, the timestamp for the prior destruction may not be at the same index + // or exist at all + const destroyedTime = destroyed.filter(timestamp => timestamp <= createdTime).pop(); + if (destroyedTime != null) { + recreates.push({ created: createdTime, destroyed: destroyedTime, creatorName: created[i].creatorName }); + } + } + return recreates; + } +} diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-doc.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-doc.ts index e6e7415bca3..a90b766a7d3 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-doc.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-doc.ts @@ -1,8 +1,10 @@ -import { merge, Observable, Subject, Subscription } from 'rxjs'; +import { DestroyRef } from '@angular/core'; +import { BehaviorSubject, merge, Observable, Subject, Subscription } from 'rxjs'; import { Presence } from 'sharedb/lib/sharedb'; import { RealtimeService } from 'xforge-common/realtime.service'; import { PresenceData } from '../../app/shared/text/text.component'; import { RealtimeDocAdapter } from '../realtime-remote-store'; +import { isNG0911Error } from '../util/rxjs-util'; import { RealtimeOfflineData } from './realtime-offline-data'; import { Snapshot } from './snapshot'; @@ -15,6 +17,50 @@ export interface RealtimeDocConstructor { new (realtimeService: RealtimeService, adapter: RealtimeDocAdapter): RealtimeDoc; } +/** + * Represents information about the subscriber to a realtime document. + * + * This includes: + * - The context in which the subscription was created (e.g. component name). This is used for debugging purposes. + * - A flag indicating whether the subscriber has unsubscribed. + * + * In the future this class may be changed to contain a DestroyRef, callback, or some other way of signaling that the + * subscriber has unsubscribed. + */ +export class DocSubscription { + isUnsubscribed$ = new BehaviorSubject(false); + + /** + * Creates a new DocSubscription. + * @param callerContext A description of the context in which the subscription was created (e.g. component name). + */ + constructor( + readonly callerContext: string, + destroyRef?: DestroyRef | Observable + ) { + if (destroyRef == null) return; + try { + if ('onDestroy' in destroyRef) destroyRef.onDestroy(() => this.complete()); + else destroyRef.subscribe(() => this.complete()); + } catch (error) { + if (!isNG0911Error(error)) throw error; + } + } + + private complete(): void { + this.isUnsubscribed$.next(true); + this.isUnsubscribed$.complete(); + } + + /** + * Marks the subscriber as no longer needing the document(s) subscribed to. This is an alternative to providing a + * DestroyRef or Observable to the constructor. + */ + unsubscribe(): void { + this.complete(); + } +} + /** * This is the base class for all real-time data models. This class manages the interaction between offline storage of * the data and access to the real-time backend. @@ -34,6 +80,8 @@ export abstract class RealtimeDoc { private subscribeQueryCount: number = 0; private loadOfflineDataPromise?: Promise; + docSubscriptions = new Set(); + constructor( protected readonly realtimeService: RealtimeService, public readonly adapter: RealtimeDocAdapter @@ -176,6 +224,7 @@ export abstract class RealtimeDoc { * @returns {Promise} Resolves when the data has been successfully disposed. */ async dispose(): Promise { + this.realtimeService.onDocDisposeStarted(this); if (this.subscribePromise != null) { await this.subscribePromise; } @@ -184,6 +233,34 @@ export abstract class RealtimeDoc { await this.adapter.destroy(); this.subscribedState = false; await this.realtimeService.onLocalDocDispose(this); + this.realtimeService.onDocDisposeFinished(this); + } + + addSubscriber(docSubscription: DocSubscription): void { + this.docSubscriptions.add(docSubscription); + + docSubscription.isUnsubscribed$.subscribe(isUnsubscribed => { + if (!isUnsubscribed) return; + + this.docSubscriptions.delete(docSubscription); + + if (this.activeDocSubscriptionsCount === 0) { + console.log(`No active subscribers for ${this.collection}:${this.id}. Disposing.`); + this.dispose(); + } + }); + } + + get docSubscriptionsCount(): number { + return this.docSubscriptions.size; + } + + get activeDocSubscriptionsCount(): number { + let count = 0; + for (const docSubscription of this.docSubscriptions) { + if (!docSubscription.isUnsubscribed$.getValue()) count++; + } + return count; } protected prepareDataForStore(data: T): any { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-query.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-query.ts index 200544f59ad..eb4dc96f033 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-query.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/models/realtime-query.ts @@ -1,6 +1,7 @@ import arrayDiff, { InsertDiff, MoveDiff, RemoveDiff } from 'arraydiff'; import { BehaviorSubject, Observable, Subject, Subscription } from 'rxjs'; import { takeUntil } from 'rxjs/operators'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { RealtimeQueryAdapter } from '../realtime-remote-store'; import { RealtimeService } from '../realtime.service'; import { RealtimeDoc } from './realtime-doc'; @@ -24,7 +25,8 @@ export class RealtimeQuery { constructor( private readonly realtimeService: RealtimeService, - public readonly adapter: RealtimeQueryAdapter + public readonly adapter: RealtimeQueryAdapter, + public readonly name: string ) { this.adapter.ready$.pipe(takeUntil(this.unsubscribe$)).subscribe(() => this.onReady()); this.adapter.remoteChanges$ @@ -143,7 +145,11 @@ export class RealtimeQuery { await this.onChange(true, this.adapter.docIds, this.adapter.count, this.adapter.unpagedCount); this._ready$.next(true); } else { - this._docs = this.adapter.docIds.map(id => this.realtimeService.get(this.collection, id)); + this._docs = await Promise.all( + this.adapter.docIds.map(id => + this.realtimeService.get(this.collection, id, new DocSubscription('RealtimeQuery', this.unsubscribe$)) + ) + ); this._count = this.adapter.count; this._unpagedCount = this.adapter.unpagedCount; } @@ -197,10 +203,16 @@ export class RealtimeQuery { } private async onInsert(index: number, docIds: string[]): Promise { + // if (this.name === 'query_questions {"bookNum":1,"chapterNum":1,"sort":true,"activeOnly":true}') debugger; + console.log(`Inserting ${docIds.length} docs into query ${this.name}`); const newDocs: T[] = []; const promises: Promise[] = []; for (const docId of docIds) { - const newDoc = this.realtimeService.get(this.collection, docId); + const newDoc = await this.realtimeService.get( + this.collection, + docId, + new DocSubscription('RealtimeQuery', this.unsubscribe$) + ); promises.push(newDoc.onAddedToSubscribeQuery()); newDocs.push(newDoc); const docSubscription = newDoc.remoteChanges$.subscribe(() => { @@ -214,6 +226,10 @@ export class RealtimeQuery { } private onRemove(index: number, docIds: string[]): void { + if (docIds.length === 30) { + debugger; + } + console.log(`Removing ${docIds.length} docs from query ${this.name}`); const removedDocs = this._docs.splice(index, docIds.length); for (const doc of removedDocs) { doc.onRemovedFromSubscribeQuery(); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/owner/owner.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/owner/owner.component.ts index 2bbec91ce1b..66046afbd4e 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/owner/owner.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/owner/owner.component.ts @@ -1,7 +1,8 @@ import { CommonModule } from '@angular/common'; -import { Component, Input, OnInit } from '@angular/core'; +import { Component, DestroyRef, Input, OnInit } from '@angular/core'; import { TranslocoService } from '@ngneat/transloco'; import { UserProfile } from 'realtime-server/lib/esm/common/models/user'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { AvatarComponent } from '../avatar/avatar.component'; import { I18nService } from '../i18n.service'; import { UserProfileDoc } from '../models/user-profile-doc'; @@ -25,7 +26,8 @@ export class OwnerComponent implements OnInit { constructor( private readonly userService: UserService, readonly i18n: I18nService, - private readonly translocoService: TranslocoService + private readonly translocoService: TranslocoService, + private readonly destroyRef: DestroyRef ) {} get date(): Date { @@ -47,7 +49,10 @@ export class OwnerComponent implements OnInit { async ngOnInit(): Promise { if (this.ownerRef != null) { - this.ownerDoc = await this.userService.getProfile(this.ownerRef); + this.ownerDoc = await this.userService.getProfile( + this.ownerRef, + new DocSubscription('OwnerComponent', this.destroyRef) + ); } } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/project.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/project.service.ts index baa2621328d..e4ff1d1b355 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/project.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/project.service.ts @@ -1,3 +1,4 @@ +import { DestroyRef } from '@angular/core'; import { escapeRegExp, merge } from 'lodash-es'; import { Project } from 'realtime-server/lib/esm/common/models/project'; import { ProjectRole } from 'realtime-server/lib/esm/common/models/project-role'; @@ -6,6 +7,7 @@ import { debounceTime, distinctUntilChanged, switchMap } from 'rxjs/operators'; import { CommandService } from './command.service'; import { ProjectDoc } from './models/project-doc'; import { NONE_ROLE, ProjectRoleInfo } from './models/project-role-info'; +import { DocSubscription } from './models/realtime-doc'; import { RealtimeQuery } from './models/realtime-query'; import { QueryFilter, QueryParameters } from './query-parameters'; import { RealtimeService } from './realtime.service'; @@ -22,7 +24,8 @@ export abstract class ProjectService< protected readonly realtimeService: RealtimeService, protected readonly commandService: CommandService, protected readonly retryingRequestService: RetryingRequestService, - roles: ProjectRoleInfo[] + roles: ProjectRoleInfo[], + protected readonly destroyRef: DestroyRef ) { this.roles = new Map(); this.roles.set(NONE_ROLE.role, NONE_ROLE); @@ -33,8 +36,8 @@ export abstract class ProjectService< protected abstract get collection(): string; - get(id: string): Promise { - return this.realtimeService.subscribe(this.collection, id); + subscribe(id: string, subscriber: DocSubscription): Promise { + return this.realtimeService.subscribe(this.collection, id, subscriber); } onlineQuery( @@ -53,7 +56,11 @@ export abstract class ProjectService< $or: termMatchProperties.map(prop => ({ [prop]: { $regex: term, $options: 'i' } })) }; } - return this.realtimeService.onlineQuery(this.collection, merge(filters, queryParameters)); + return this.realtimeService.onlineQuery( + this.collection, + 'query_projects_a', + merge(filters, queryParameters) + ); }) ); } @@ -62,7 +69,9 @@ export abstract class ProjectService< if (projectIds.length === 0) { return []; } - const results = await this.realtimeService.onlineQuery(this.collection, { _id: { $in: projectIds } }); + const results = await this.realtimeService.onlineQuery(this.collection, 'query_projects_b', { + _id: { $in: projectIds } + }); return results.docs as TDoc[]; } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/realtime.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/realtime.service.ts index c48a141ad21..2c20f7d6918 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/realtime.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/realtime.service.ts @@ -1,8 +1,9 @@ import { DestroyRef, Injectable, Optional } from '@angular/core'; -import { filter, race, take, timer } from 'rxjs'; +import { filter, lastValueFrom, race, Subject, take, timer } from 'rxjs'; import { AppError } from 'xforge-common/exception-handling.service'; import { FileService } from './file.service'; -import { RealtimeDoc } from './models/realtime-doc'; +import { DocSubscription, RealtimeDoc } from './models/realtime-doc'; +import { RealtimeDocLifecycleMonitorService } from './models/realtime-doc-lifecycle-monitor'; import { RealtimeQuery } from './models/realtime-query'; import { OfflineStore } from './offline-store'; import { QueryParameters } from './query-parameters'; @@ -13,6 +14,10 @@ function getDocKey(collection: string, id: string): string { return `${collection}:${id}`; } +export function getCollectionFromId(id: string): string { + return id.split(':')[0]; +} + /** * A no-op DestroyRef that is not associated with any component. * This may be useful to satisfy a subscribe query in testing or if a query is not associated with a component. @@ -31,10 +36,12 @@ export const noopDestroyRef: DestroyRef = { }) export class RealtimeService { protected readonly docs = new Map(); + protected readonly disposingDocIds = new Map>(); protected readonly subscribeQueries = new Map>(); constructor( private readonly typeRegistry: TypeRegistry, + public readonly docLifecycleMonitor: RealtimeDocLifecycleMonitorService, public readonly remoteStore: RealtimeRemoteStore, public readonly offlineStore: OfflineStore, @Optional() public readonly fileService?: FileService @@ -55,24 +62,59 @@ export class RealtimeService { return this.docs.size; } - get docsCountByCollection(): { [key: string]: { docs: number; subscribers: number; queries: number } } { - const countsByCollection: { [key: string]: { docs: number; subscribers: number; queries: number } } = {}; + get queriesByCollection(): { [key: string]: number } { + const queriesByCollection: { [key: string]: number } = {}; + for (const [collection, queries] of this.subscribeQueries.entries()) { + queriesByCollection[collection] = queries.size; + } + return queriesByCollection; + } + + get docsCountByCollection(): { + [key: string]: { docs: number; subscribers: number; activeDocSubscriptionsCount: number }; + } { + const countsByCollection: { + [key: string]: { docs: number; subscribers: number; activeDocSubscriptionsCount: number }; + } = {}; for (const [id, doc] of this.docs.entries()) { - const collection = id.split(':')[0]; - countsByCollection[collection] ??= { docs: 0, subscribers: 0, queries: 0 }; + const collection = getCollectionFromId(id); + countsByCollection[collection] ??= { docs: 0, subscribers: 0, activeDocSubscriptionsCount: 0 }; countsByCollection[collection].docs++; - countsByCollection[collection].subscribers += doc.subscriberCount; - } - for (const [collection, queries] of this.subscribeQueries.entries()) { - countsByCollection[collection] ??= { docs: 0, subscribers: 0, queries: 0 }; - countsByCollection[collection].queries += queries.size; + countsByCollection[collection].subscribers += doc.docSubscriptionsCount; + countsByCollection[collection].activeDocSubscriptionsCount += doc.activeDocSubscriptionsCount; } return countsByCollection; } - get(collection: string, id: string): T { + get subscriberCountsByContext(): { [key: string]: { [key: string]: { all: number; active: number } } } { + const countsByContext: { [key: string]: { [key: string]: { all: number; active: number } } } = {}; + for (const [id, doc] of this.docs.entries()) { + const collection = getCollectionFromId(id); + countsByContext[collection] ??= {}; + for (const subscriber of doc.docSubscriptions) { + countsByContext[collection][subscriber.callerContext] ??= { all: 0, active: 0 }; + countsByContext[collection][subscriber.callerContext].all++; + if (!subscriber.isUnsubscribed$.getValue()) { + countsByContext[collection][subscriber.callerContext].active++; + } + } + } + return countsByContext; + } + + async get(collection: string, id: string, subscriber: DocSubscription): Promise { const key = getDocKey(collection, id); let doc = this.docs.get(key); + + // Handle documents that currently exist but are in the process of being disposed. + if (doc != null && this.disposingDocIds.has(doc.id)) { + console.log(`Waiting for document ${key} to be disposed before recreating it.`); + await lastValueFrom(this.disposingDocIds.get(doc.id)!); + // Recursively call this method so if multiple callers are waiting for the same document to be disposed, they will + // all get the same instance. + return await this.get(collection, id, subscriber); + } + if (doc == null) { const RealtimeDocType = this.typeRegistry.getDocType(collection); if (RealtimeDocType == null) { @@ -86,12 +128,15 @@ export class RealtimeService { }); } this.docs.set(key, doc); + this.docLifecycleMonitor.docCreated(getDocKey(collection, id), subscriber.callerContext); } + doc.addSubscriber(subscriber); + return doc as T; } - createQuery(collection: string, parameters: QueryParameters): RealtimeQuery { - return new RealtimeQuery(this, this.remoteStore.createQueryAdapter(collection, parameters)); + createQuery(collection: string, name: string, parameters: QueryParameters): RealtimeQuery { + return new RealtimeQuery(this, this.remoteStore.createQueryAdapter(collection, parameters), name); } isSet(collection: string, id: string): boolean { @@ -105,14 +150,14 @@ export class RealtimeService { * @param {string} id The id. * @returns {Promise} The real-time doc. */ - async subscribe(collection: string, id: string): Promise { - const doc = this.get(collection, id); + async subscribe(collection: string, id: string, subscriber: DocSubscription): Promise { + const doc = await this.get(collection, id, subscriber); await doc.subscribe(); return doc; } - async onlineFetch(collection: string, id: string): Promise { - const doc = this.get(collection, id); + async onlineFetch(collection: string, id: string, subscriber: DocSubscription): Promise { + const doc = await this.get(collection, id, subscriber); await doc.onlineFetch(); return doc; } @@ -125,8 +170,14 @@ export class RealtimeService { * @param {*} data The initial data. * @returns {Promise} The newly created real-time doc. */ - async create(collection: string, id: string, data: any, type?: string): Promise { - const doc = this.get(collection, id); + async create( + collection: string, + id: string, + data: any, + subscriber: DocSubscription, + type?: string + ): Promise { + const doc = await this.get(collection, id, subscriber); await doc.create(data, type); return doc; } @@ -143,10 +194,11 @@ export class RealtimeService { */ async subscribeQuery( collection: string, + name: string, parameters: QueryParameters, destroyRef: DestroyRef ): Promise> { - const query = this.createQuery(collection, parameters); + const query = this.createQuery(collection, name, parameters); return this.manageQuery( query.subscribe().then(() => query), destroyRef @@ -161,8 +213,12 @@ export class RealtimeService { * See https://github.com/share/sharedb-mongo#queries. * @returns {Promise>} The query. */ - async onlineQuery(collection: string, parameters: QueryParameters): Promise> { - const query = this.createQuery(collection, parameters); + async onlineQuery( + collection: string, + name: string, + parameters: QueryParameters + ): Promise> { + const query = this.createQuery(collection, name, parameters); await query.fetch(); return query; } @@ -194,10 +250,24 @@ export class RealtimeService { } } + onDocDisposeStarted(doc: RealtimeDoc): void { + this.disposingDocIds.set(doc.id, new Subject()); + this.docLifecycleMonitor.docDestroyed(getDocKey(doc.collection, doc.id)); + this.docs.delete(getDocKey(doc.collection, doc.id)); + } + async onLocalDocDispose(doc: RealtimeDoc): Promise { if (this.isSet(doc.collection, doc.id)) { await this.offlineStore.delete(doc.collection, doc.id); - this.docs.delete(getDocKey(doc.collection, doc.id)); + } + } + + onDocDisposeFinished(doc: RealtimeDoc): void { + const disposingDocId = this.disposingDocIds.get(doc.id); + if (disposingDocId != null) { + disposingDocId.next(); + disposingDocId.complete(); + this.disposingDocIds.delete(doc.id); } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/user-projects.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/user-projects.service.ts index 99f6f3c1141..f7eaf014f93 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/user-projects.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/user-projects.service.ts @@ -6,6 +6,7 @@ import { SFProjectService } from '../app/core/sf-project.service'; import { compareProjectsForSorting } from '../app/shared/utils'; import { environment } from '../environments/environment'; import { AuthService, LoginResult } from './auth.service'; +import { DocSubscription } from './models/realtime-doc'; import { UserDoc } from './models/user-doc'; import { UserService } from './user.service'; /** Service that maintains an up-to-date set of SF project docs that the current user has access to. */ @@ -62,7 +63,9 @@ export class SFUserProjectsService { const docFetchPromises: Promise[] = []; for (const id of currentProjectIds) { if (!this.projectDocs.has(id)) { - docFetchPromises.push(this.projectService.getProfile(id)); + docFetchPromises.push( + this.projectService.getProfile(id, new DocSubscription('SFUserProjectsService', this.destroyRef)) + ); } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/user.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/user.service.ts index 95a5a9950c5..5db1d8cd5c3 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/user.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/user.service.ts @@ -1,4 +1,4 @@ -import { Injectable } from '@angular/core'; +import { DestroyRef, Injectable } from '@angular/core'; import { MatDialogRef } from '@angular/material/dialog'; import { translate } from '@ngneat/transloco'; import { escapeRegExp, merge } from 'lodash-es'; @@ -12,6 +12,7 @@ import { CommandService } from './command.service'; import { DialogService } from './dialog.service'; import { EditNameDialogComponent, EditNameDialogResult } from './edit-name-dialog/edit-name-dialog.component'; import { LocalSettingsService } from './local-settings.service'; +import { DocSubscription } from './models/realtime-doc'; import { RealtimeQuery } from './models/realtime-query'; import { UserDoc } from './models/user-doc'; import { UserProfileDoc } from './models/user-profile-doc'; @@ -31,6 +32,7 @@ export const CURRENT_PROJECT_ID_SETTING = 'current_project_id'; export class UserService { // TODO: if/when we enable another xForge site, remove this and get the component to provide the site info private siteId: string = environment.siteId; + private userDocSubscription = new DocSubscription('UserService', this.destroyRef); constructor( private readonly realtimeService: RealtimeService, @@ -38,7 +40,8 @@ export class UserService { private readonly commandService: CommandService, private readonly localSettings: LocalSettingsService, private readonly dialogService: DialogService, - private readonly noticeService: NoticeService + private readonly noticeService: NoticeService, + private readonly destroyRef: DestroyRef ) {} get currentUserId(): string { @@ -65,15 +68,15 @@ export class UserService { /** Get currently-logged in user. */ getCurrentUser(): Promise { - return this.get(this.currentUserId); + return this.get(this.currentUserId, this.userDocSubscription); } - get(id: string): Promise { - return this.realtimeService.subscribe(UserDoc.COLLECTION, id); + get(id: string, subscriber: DocSubscription): Promise { + return this.realtimeService.subscribe(UserDoc.COLLECTION, id, subscriber); } - getProfile(id: string): Promise { - return this.realtimeService.subscribe(UserProfileDoc.COLLECTION, id); + getProfile(id: string, subscriber: DocSubscription): Promise { + return this.realtimeService.subscribe(UserProfileDoc.COLLECTION, id, subscriber); } async onlineDelete(id: string): Promise { @@ -100,7 +103,9 @@ export class UserService { ] }; } - return from(this.realtimeService.onlineQuery(UserDoc.COLLECTION, merge(filters, queryParameters))); + return from( + this.realtimeService.onlineQuery(UserDoc.COLLECTION, 'query_users', merge(filters, queryParameters)) + ); }) ); } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/util/rxjs-util.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/util/rxjs-util.ts index a6466a71977..ce5f123b046 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/util/rxjs-util.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/util/rxjs-util.ts @@ -13,6 +13,10 @@ export function filterNullish(): OperatorFunction { return filter((value): value is T => value != null); } +export function isNG0911Error(error: unknown): boolean { + return hasStringProp(error, 'message') && error.message.includes('NG0911'); +} + /** * Like `takeUntilDestroyed`, but catches and logs NG0911 errors (unless `options.logWarnings` is false). */ @@ -26,11 +30,10 @@ export function quietTakeUntilDestroyed( try { return destroyRef.onDestroy(callback); } catch (error) { - const isNG0911 = hasStringProp(error, 'message') && error.message.includes('NG0911'); - if (isNG0911 && options.logWarnings) { + if (isNG0911Error(error) && options.logWarnings) { console.warn('NG0911 error caught and ignored. Original stack: ', stack); } - if (!isNG0911) throw error; + if (!isNG0911Error(error)) throw error; callback(); return () => {}; } diff --git a/src/SIL.XForge.Scripture/Startup.cs b/src/SIL.XForge.Scripture/Startup.cs index d8cb271c78b..a0cbd357cd6 100644 --- a/src/SIL.XForge.Scripture/Startup.cs +++ b/src/SIL.XForge.Scripture/Startup.cs @@ -73,6 +73,7 @@ public class Startup "join", "serval-administration", "system-administration", + "blank-page", "favicon.ico", "assets", ]; From d9aed6c0e41e550e1f04c1f9d2a69594b2c52a13 Mon Sep 17 00:00:00 2001 From: MarkS Date: Thu, 28 Aug 2025 15:39:28 -0600 Subject: [PATCH 02/42] await realtimeService.get --- .../ClientApp/src/app/app.component.spec.ts | 23 +++++++++++-------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts index 1c755072d33..d5c000a935d 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts @@ -814,8 +814,8 @@ class TestEnvironment { return this.getElement('#sf-logo-button'); } - get currentUserDoc(): UserDoc { - return this.realtimeService.get(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')); + async getCurrentUserDoc(): Promise { + return await this.realtimeService.get(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')); } setCurrentUser(userId: string): void { @@ -885,12 +885,12 @@ class TestEnvironment { flush(70); } - deleteProject(projectId: string, isLocal: boolean): void { + async deleteProject(projectId: string, isLocal: boolean): Promise { if (isLocal) { when(mockedUserService.currentProjectId(anything())).thenReturn(undefined); } - this.ngZone.run(() => { - const projectDoc = this.realtimeService.get( + await this.ngZone.run(async () => { + const projectDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, projectId, new DocSubscription('spec') @@ -900,8 +900,8 @@ class TestEnvironment { this.wait(); } - removeUserFromProject(projectId: string): void { - const projectDoc = this.realtimeService.get( + async removeUserFromProject(projectId: string): Promise { + const projectDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, projectId, new DocSubscription('spec') @@ -920,14 +920,17 @@ class TestEnvironment { this.wait(); } - addUserToProject(projectId: string): void { - const projectDoc = this.realtimeService.get( + async addUserToProject(projectId: string): Promise { + const projectDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, projectId, new DocSubscription('spec') ); projectDoc.submitJson0Op(op => op.set(p => p.userRoles['user01'], SFProjectRole.CommunityChecker), false); - this.currentUserDoc.submitJson0Op(op => op.add(u => u.sites['sf'].projects, 'project04'), false); + (await this.getCurrentUserDoc()).submitJson0Op( + op => op.add(u => u.sites['sf'].projects, 'project04'), + false + ); this.wait(); } From f1174992c7d2d6483aa48abcd53e076453e3dc7c Mon Sep 17 00:00:00 2001 From: MarkS Date: Thu, 28 Aug 2025 15:53:58 -0600 Subject: [PATCH 03/42] await realtimeService.get --- .../ClientApp/src/app/app.component.spec.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts index d5c000a935d..5913e3fb451 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts @@ -910,8 +910,8 @@ class TestEnvironment { this.wait(); } - updatePreTranslate(projectId: string): void { - const projectDoc = this.realtimeService.get( + async updatePreTranslate(projectId: string): Promise { + const projectDoc: SFProjectProfileDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, projectId, new DocSubscription('spec') @@ -934,8 +934,8 @@ class TestEnvironment { this.wait(); } - changeUserRole(projectId: string, userId: string, role: SFProjectRole): void { - const projectDoc = this.realtimeService.get( + async changeUserRole(projectId: string, userId: string, role: SFProjectRole): Promise { + const projectDoc: SFProjectProfileDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, projectId, new DocSubscription('spec') From fc3e0ee39fcc9b1dfbb22acef6e00ada1a7327f9 Mon Sep 17 00:00:00 2001 From: MarkS Date: Thu, 28 Aug 2025 15:56:57 -0600 Subject: [PATCH 04/42] add name arg to realtimeService.subscribeQuery --- .../src/app/translate/editor/editor.component.spec.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts index c05b4be133e..c3d9b7cd227 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts @@ -4807,6 +4807,7 @@ class TestEnvironment { (id, bookNum, chapterNum, _) => this.realtimeService.subscribeQuery( NoteThreadDoc.COLLECTION, + 'spec', { [obj().pathStr(t => t.projectRef)]: id, [obj().pathStr(t => t.status)]: NoteStatus.Todo, @@ -4819,6 +4820,7 @@ class TestEnvironment { when(mockedSFProjectService.queryBiblicalTermNoteThreads(anything(), anything())).thenCall(id => this.realtimeService.subscribeQuery( NoteThreadDoc.COLLECTION, + 'spec', { [obj().pathStr(t => t.projectRef)]: id, [obj().pathStr(t => t.biblicalTermId)]: { $ne: null } @@ -4829,6 +4831,7 @@ class TestEnvironment { when(mockedSFProjectService.queryBiblicalTerms(anything(), anything())).thenCall(id => this.realtimeService.subscribeQuery( BiblicalTermDoc.COLLECTION, + 'spec', { [obj().pathStr(t => t.projectRef)]: id }, @@ -5069,6 +5072,7 @@ class TestEnvironment { (id, bookNum, chapterNum, _) => this.realtimeService.subscribeQuery( NoteThreadDoc.COLLECTION, + 'spec', { [obj().pathStr(t => t.publishedToSF)]: userId === 'user05', [obj().pathStr(t => t.status)]: NoteStatus.Todo, From ea6bf2c4dc02cc8a5f7550557f989c8a0030e25c Mon Sep 17 00:00:00 2001 From: MarkS Date: Thu, 28 Aug 2025 16:48:01 -0600 Subject: [PATCH 05/42] await --- .../translate/editor/editor.component.spec.ts | 255 +++++++++--------- 1 file changed, 130 insertions(+), 125 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts index c3d9b7cd227..e76c6b80c32 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts @@ -239,7 +239,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('remote user config should not change segment', fakeAsync(() => { + it('remote user config should not change segment', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig({ selectedBookNum: 40, @@ -250,7 +250,8 @@ describe('EditorComponent', () => { env.wait(); expect(env.component.target!.segmentRef).toEqual('verse_2_1'); - env.getProjectUserConfigDoc().submitJson0Op(op => op.set(puc => puc.selectedSegment, 'verse_2_2'), false); + const projectUserConfigDoc: SFProjectUserConfigDoc = await env.getProjectUserConfigDoc(); + projectUserConfigDoc.submitJson0Op(op => op.set(puc => puc.selectedSegment, 'verse_2_2'), false); env.wait(); expect(env.component.target!.segmentRef).toEqual('verse_2_1'); @@ -370,7 +371,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('select non-blank segment', fakeAsync(() => { + it('select non-blank segment', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig({ selectedBookNum: 40, selectedChapterNum: 1, selectedSegment: 'verse_1_1' }); env.wait(); @@ -387,14 +388,14 @@ describe('EditorComponent', () => { // The selection gets adjusted to come after the note icon embed. expect(selection!.index).toBe(range!.index + 1); expect(selection!.length).toBe(0); - expect(env.getProjectUserConfigDoc().data!.selectedSegment).toBe('verse_1_3'); + expect((await env.getProjectUserConfigDoc()).data!.selectedSegment).toBe('verse_1_3'); verify(env.mockedRemoteTranslationEngine.getWordGraph(anything())).once(); expect(env.component.showSuggestions).toBe(false); env.dispose(); })); - it('select blank segment', fakeAsync(() => { + it('select blank segment', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig({ selectedBookNum: 40, selectedChapterNum: 1, selectedSegment: 'verse_1_1' }); env.wait(); @@ -408,7 +409,7 @@ describe('EditorComponent', () => { const selection = env.targetEditor.getSelection(); expect(selection!.index).toBe(33); expect(selection!.length).toBe(0); - expect(env.getProjectUserConfigDoc().data!.selectedSegment).toBe('verse_1_2'); + expect((await env.getProjectUserConfigDoc()).data!.selectedSegment).toBe('verse_1_2'); verify(env.mockedRemoteTranslationEngine.getWordGraph(anything())).once(); expect(env.component.showSuggestions).toBe(true); expect(env.component.suggestions[0].words).toEqual(['target']); @@ -947,7 +948,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('selected segment checksum unset on server', fakeAsync(() => { + it('selected segment checksum unset on server', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig({ selectedBookNum: 40, @@ -960,7 +961,7 @@ describe('EditorComponent', () => { expect(env.component.target!.segmentRef).toBe('verse_1_1'); expect(env.component.target!.segment!.initialChecksum).toBe(0); - env.getProjectUserConfigDoc().submitJson0Op(op => op.unset(puc => puc.selectedSegmentChecksum!), false); + (await env.getProjectUserConfigDoc()).submitJson0Op(op => op.unset(puc => puc.selectedSegmentChecksum!), false); env.wait(); expect(env.component.target!.segmentRef).toBe('verse_1_1'); expect(env.component.target!.segment!.initialChecksum).not.toBe(0); @@ -1204,7 +1205,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('user cannot edit a text if their permissions change', fakeAsync(() => { + it('user cannot edit a text if their permissions change', fakeAsync(async () => { const env = new TestEnvironment(); env.setupProject(); env.setProjectUserConfig(); @@ -1212,7 +1213,7 @@ describe('EditorComponent', () => { const userId: string = 'user01'; const projectId: string = 'project01'; - let projectDoc = env.getProjectDoc(projectId); + let projectDoc = await env.getProjectDoc(projectId); expect(projectDoc.data?.userRoles[userId]).toBe(SFProjectRole.ParatextTranslator); expect(env.bookName).toEqual('Matthew'); expect(env.component.canEdit).toBe(true); @@ -1230,7 +1231,7 @@ describe('EditorComponent', () => { env.wait(); resetCalls(env.mockedRemoteTranslationEngine); - projectDoc = env.getProjectDoc(projectId); + projectDoc = await env.getProjectDoc(projectId); expect(projectDoc.data?.userRoles[userId]).toBe(SFProjectRole.Viewer); expect(env.bookName).toEqual('Matthew'); expect(env.component.canEdit).toBe(false); @@ -1492,7 +1493,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('ensure inserting in a blank segment only produces required delta ops', fakeAsync(() => { + it('ensure inserting in a blank segment only produces required delta ops', fakeAsync(async () => { const env = new TestEnvironment(); env.wait(); @@ -1532,7 +1533,7 @@ describe('EditorComponent', () => { { retain: 1 } ]; expect(textChangeOps).toEqual(expectedOps); - const textDoc: TextDoc = env.getTextDoc(new TextDocId('project01', 40, 1)); + const textDoc: TextDoc = await env.getTextDoc(new TextDocId('project01', 40, 1)); const attributes: StringMap = textDoc.data!.ops![5].attributes!; expect(Object.keys(attributes)).toEqual(['segment']); env.dispose(); @@ -1614,7 +1615,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('handles text doc updates with note embed offset', fakeAsync(() => { + it('handles text doc updates with note embed offset', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig({ selectedBookNum: 40, selectedChapterNum: 1, selectedSegment: 'verse_1_2' }); env.wait(); @@ -1633,7 +1634,7 @@ describe('EditorComponent', () => { segment: 'verse_1_2', 'highlight-segment': true }); - const textDoc: TextDoc = env.getTextDoc(new TextDocId('project01', 40, 1)); + const textDoc: TextDoc = await env.getTextDoc(new TextDocId('project01', 40, 1)); const textOps = textDoc.data!.ops!; expect(textOps[2].insert!['verse']['number']).toBe('1'); expect(textOps[3].insert).toBe('target: chapter 1, verse 1.'); @@ -1672,22 +1673,22 @@ describe('EditorComponent', () => { env.dispose(); })); - it('uses note thread text anchor as anchor', fakeAsync(() => { + it('uses note thread text anchor as anchor', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); - let doc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid01'); + let doc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); const noteStart1 = env.component.target!.getSegmentRange('verse_1_1')!.index + doc.data!.position.start; - doc = env.getNoteThreadDoc('project01', 'dataid02'); + doc = await env.getNoteThreadDoc('project01', 'dataid02'); const noteStart2 = env.component.target!.getSegmentRange('verse_1_3')!.index + doc.data!.position.start; - doc = env.getNoteThreadDoc('project01', 'dataid03'); + doc = await env.getNoteThreadDoc('project01', 'dataid03'); // Add 1 for the one previous embed in the segment const noteStart3 = env.component.target!.getSegmentRange('verse_1_3')!.index + doc.data!.position.start + 1; - doc = env.getNoteThreadDoc('project01', 'dataid04'); + doc = await env.getNoteThreadDoc('project01', 'dataid04'); // Add 2 for the two previous embeds const noteStart4 = env.component.target!.getSegmentRange('verse_1_3')!.index + doc.data!.position.start + 2; - doc = env.getNoteThreadDoc('project01', 'dataid05'); + doc = await env.getNoteThreadDoc('project01', 'dataid05'); const noteStart5 = env.component.target!.getSegmentRange('verse_1_4')!.index + doc.data!.position.start; // positions are 11, 34, 55, 56, 94 const expected = [noteStart1, noteStart2, noteStart3, noteStart4, noteStart5]; @@ -1695,7 +1696,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('note position correctly accounts for footnote symbols', fakeAsync(() => { + it('note position correctly accounts for footnote symbols', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); @@ -1706,7 +1707,7 @@ describe('EditorComponent', () => { expect(contents.ops![1].insert).toEqual({ note: { caller: '*' } }); const note2Position = env.getNoteThreadEditorPosition('dataid02'); expect(range.index).toEqual(note2Position); - const noteThreadDoc3 = env.getNoteThreadDoc('project01', 'dataid03'); + const noteThreadDoc3 = await env.getNoteThreadDoc('project01', 'dataid03'); const noteThread3StartPosition = 20; expect(noteThreadDoc3.data!.position).toEqual({ start: noteThread3StartPosition, length: 7 }); const note3Position = env.getNoteThreadEditorPosition('dataid03'); @@ -1729,7 +1730,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('shows reattached note in updated location', fakeAsync(() => { + it('shows reattached note in updated location', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); // active position of thread04 when reattached to verse 4 @@ -1741,7 +1742,7 @@ describe('EditorComponent', () => { env.wait(); const range: Range = env.component.target!.getSegmentRange('verse_1_4')!; const note4Position: number = env.getNoteThreadEditorPosition('dataid04'); - const note4Doc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid04')!; + const note4Doc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid04')!; const note4Anchor: TextAnchor = note4Doc.data!.position; expect(note4Anchor).toEqual(position); expect(note4Position).toEqual(range.index + position.start); @@ -1750,7 +1751,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('shows an invalid reattached note in original location', fakeAsync(() => { + it('shows an invalid reattached note in original location', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); // invalid reattachment string @@ -1760,7 +1761,7 @@ describe('EditorComponent', () => { env.wait(); const range: Range = env.component.target!.getSegmentRange('verse_1_3')!; const note4Position: number = env.getNoteThreadEditorPosition('dataid04'); - const note4Doc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid04')!; + const note4Doc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid04')!; expect(note4Position).toEqual(range.index + 1); // The note thread is on verse 3 expect(note4Doc.data!.verseRef.verseNum).toEqual(3); @@ -1790,7 +1791,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('highlights note icons when new content is unread', fakeAsync(() => { + it('highlights note icons when new content is unread', fakeAsync(async () => { const env = new TestEnvironment(); env.setCurrentUser('user02'); env.setProjectUserConfig({ noteRefsRead: ['thread01_note0', 'thread02_note0'] }); @@ -1802,14 +1803,14 @@ describe('EditorComponent', () => { expect(env.isNoteIconHighlighted('dataid04')).toBe(true); expect(env.isNoteIconHighlighted('dataid05')).toBe(true); - let puc: SFProjectUserConfigDoc = env.getProjectUserConfigDoc('user01'); + let puc: SFProjectUserConfigDoc = await env.getProjectUserConfigDoc('user01'); expect(puc.data!.noteRefsRead).not.toContain('thread01_note1'); expect(puc.data!.noteRefsRead).not.toContain('thread01_note2'); let iconElement: HTMLElement = env.getNoteThreadIconElement('verse_1_1', 'dataid01')!; iconElement.click(); env.wait(); - puc = env.getProjectUserConfigDoc('user02'); + puc = await env.getProjectUserConfigDoc('user02'); expect(puc.data!.noteRefsRead).toContain('thread01_note1'); expect(puc.data!.noteRefsRead).toContain('thread01_note2'); expect(env.isNoteIconHighlighted('dataid01')).toBe(false); @@ -1818,19 +1819,19 @@ describe('EditorComponent', () => { iconElement = env.getNoteThreadIconElement('verse_1_3', 'dataid02')!; iconElement.click(); env.wait(); - puc = env.getProjectUserConfigDoc('user02'); + puc = await env.getProjectUserConfigDoc('user02'); expect(puc.data!.noteRefsRead).toContain('thread02_note0'); expect(puc.data!.noteRefsRead.filter(ref => ref === 'thread02_note0').length).toEqual(1); expect(env.isNoteIconHighlighted('dataid02')).toBe(false); env.dispose(); })); - it('should update note position when inserting text', fakeAsync(() => { + it('should update note position when inserting text', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig({ selectedBookNum: 40, selectedChapterNum: 1, selectedSegment: 'verse_1_1' }); env.wait(); - let noteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid01'); + let noteThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); expect(noteThreadDoc.data!.position).toEqual({ start: 8, length: 9 }); // edit before start position @@ -1853,7 +1854,7 @@ describe('EditorComponent', () => { expect(noteThreadDoc.data!.position).toEqual({ start: length * 2 + 8, length: 9 + length }); // edit immediately after verse note - noteThreadDoc = env.getNoteThreadDoc('project01', 'dataid02'); + noteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid02'); notePosition = env.getNoteThreadEditorPosition('dataid02'); expect(noteThreadDoc.data!.position).toEqual({ start: 0, length: 0 }); env.targetEditor.setSelection(notePosition, 0, 'user'); @@ -1864,12 +1865,12 @@ describe('EditorComponent', () => { env.dispose(); })); - it('should update note position when deleting text', fakeAsync(() => { + it('should update note position when deleting text', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); - const noteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid01'); + const noteThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); expect(noteThreadDoc.data!.position).toEqual({ start: 8, length: 9 }); // delete text before note @@ -1895,14 +1896,14 @@ describe('EditorComponent', () => { env.dispose(); })); - it('does not try to update positions with an unchanged value', fakeAsync(() => { + it('does not try to update positions with an unchanged value', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig({ selectedBookNum: 40, selectedChapterNum: 1, selectedSegment: 'verse_1_1' }); env.wait(); const priorThreadId = 'dataid02'; - const priorThreadDoc: NoteThreadDoc = env.getNoteThreadDoc('project01', priorThreadId); - const laterThreadDoc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid04'); + const priorThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc('project01', priorThreadId); + const laterThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid04'); const origPriorThreadDocAnchorStart: number = priorThreadDoc.data!.position.start; const origPriorThreadDocAnchorLength: number = priorThreadDoc.data!.position.length; const origLaterThreadDocAnchorStart: number = laterThreadDoc.data!.position.start; @@ -1938,7 +1939,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('re-embeds a note icon when a user deletes it', fakeAsync(() => { + it('re-embeds a note icon when a user deletes it', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); @@ -1948,12 +1949,12 @@ describe('EditorComponent', () => { env.targetEditor.setSelection(11, 1, 'user'); env.deleteCharacters(); expect(Array.from(env.component.target!.embeddedElements.values())).toEqual([11, 34, 55, 56, 94]); - const textDoc = env.getTextDoc(new TextDocId('project01', 40, 1)); + const textDoc = await env.getTextDoc(new TextDocId('project01', 40, 1)); expect(textDoc.data!.ops![3].insert).toBe('target: chapter 1, verse 1.'); // replace icon and characters with new text env.targetEditor.setSelection(9, 5, 'user'); - const noteThreadDoc = env.getNoteThreadDoc('project01', 'dataid01'); + const noteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); expect(noteThreadDoc.data!.position).toEqual({ start: 8, length: 9 }); env.typeCharacters('t'); // 4 characters deleted and 1 character inserted @@ -1997,7 +1998,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('handles deleting parts of two notes text anchors', fakeAsync(() => { + it('handles deleting parts of two notes text anchors', fakeAsync(async () => { const env = new TestEnvironment(); env.addParatextNoteThread(6, 'MAT 1:1', 'verse', { start: 19, length: 5 }, ['user01']); env.setProjectUserConfig(); @@ -2006,22 +2007,22 @@ describe('EditorComponent', () => { // 1 target: $chapter|-> 1, $ve<-|rse 1. env.targetEditor.setSelection(19, 7, 'user'); env.deleteCharacters(); - const note1 = env.getNoteThreadDoc('project01', 'dataid01'); + const note1 = await env.getNoteThreadDoc('project01', 'dataid01'); expect(note1.data!.position).toEqual({ start: 8, length: 7 }); - const note2 = env.getNoteThreadDoc('project01', 'dataid06'); + const note2 = await env.getNoteThreadDoc('project01', 'dataid06'); expect(note2.data!.position).toEqual({ start: 15, length: 3 }); - const textDoc = env.getTextDoc(new TextDocId('project01', 40, 1)); + const textDoc = await env.getTextDoc(new TextDocId('project01', 40, 1)); expect(textDoc.data!.ops![3].insert).toEqual('target: chapterrse 1.'); env.dispose(); })); - it('updates notes anchors in subsequent verse segments', fakeAsync(() => { + it('updates notes anchors in subsequent verse segments', fakeAsync(async () => { const env = new TestEnvironment(); env.addParatextNoteThread(6, 'MAT 1:4', 'chapter 1', { start: 8, length: 9 }, ['user01']); env.setProjectUserConfig(); env.wait(); - const noteThreadDoc = env.getNoteThreadDoc('project01', 'dataid05'); + const noteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid05'); expect(noteThreadDoc.data!.position).toEqual({ start: 28, length: 9 }); env.targetEditor.setSelection(86, 0, 'user'); const text = ' new text '; @@ -2031,12 +2032,12 @@ describe('EditorComponent', () => { env.dispose(); })); - it('should update note position if deleting across position end boundary', fakeAsync(() => { + it('should update note position if deleting across position end boundary', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); - const noteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid01'); + const noteThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); expect(noteThreadDoc.data!.position).toEqual({ start: 8, length: 9 }); // delete text that spans across the end boundary const notePosition = env.getNoteThreadEditorPosition('dataid01'); @@ -2053,14 +2054,14 @@ describe('EditorComponent', () => { env.dispose(); })); - it('handles insert at the last character position', fakeAsync(() => { + it('handles insert at the last character position', fakeAsync(async () => { const env = new TestEnvironment(); env.addParatextNoteThread(6, 'MAT 1:1', '1', { start: 16, length: 1 }, ['user01']); env.addParatextNoteThread(7, 'MAT 1:3', '.', { start: 27, length: 1 }, ['user01']); env.setProjectUserConfig(); env.wait(); - const thread1Doc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid01'); + const thread1Doc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); const thread1Position = env.getNoteThreadEditorPosition('dataid01'); expect(thread1Doc.data!.position).toEqual({ start: 8, length: 9 }); @@ -2080,24 +2081,24 @@ describe('EditorComponent', () => { expect(thread1Doc.data!.position).toEqual({ start: 8, length: 10 }); // insert in an adjacent text anchor should not be included in the previous note - const noteThread3Doc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid03'); + const noteThread3Doc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid03'); expect(noteThread3Doc.data!.position).toEqual({ start: 20, length: 7 }); const index = env.getNoteThreadEditorPosition('dataid07'); env.targetEditor.setSelection(index + 1, 0, 'user'); env.typeCharacters('c'); expect(noteThread3Doc.data!.position).toEqual({ start: 20, length: 7 }); - const noteThread7Doc: NoteThreadDoc = env.getNoteThreadDoc('project01', `dataid07`); + const noteThread7Doc: NoteThreadDoc = await env.getNoteThreadDoc('project01', `dataid07`); expect(noteThread7Doc.data!.position).toEqual({ start: 27, length: 1 + 'c'.length }); env.dispose(); })); - it('should default a note to the beginning if all text is deleted', fakeAsync(() => { + it('should default a note to the beginning if all text is deleted', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); - let noteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid01'); + let noteThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); expect(noteThreadDoc.data!.position).toEqual({ start: 8, length: 9 }); // delete the entire text anchor @@ -2108,7 +2109,7 @@ describe('EditorComponent', () => { expect(noteThreadDoc.data!.position).toEqual({ start: 0, length: 0 }); // delete text that includes the entire text anchor - noteThreadDoc = env.getNoteThreadDoc('project01', 'dataid03'); + noteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid03'); expect(noteThreadDoc.data!.position).toEqual({ start: 20, length: 7 }); notePosition = env.getNoteThreadEditorPosition('dataid03'); length = 8; @@ -2118,18 +2119,18 @@ describe('EditorComponent', () => { env.dispose(); })); - it('should update paratext notes position after editing verse with multiple notes', fakeAsync(() => { + it('should update paratext notes position after editing verse with multiple notes', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig({ selectedBookNum: 40, selectedChapterNum: 1, selectedSegment: 'verse_1_1' }); env.wait(); - const thread3Doc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid03'); + const thread3Doc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid03'); const thread3AnchorLength = 7; const thread4AnchorLength = 5; expect(thread3Doc.data!.position).toEqual({ start: 20, length: thread3AnchorLength }); - const otherNoteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid04'); + const otherNoteThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid04'); expect(otherNoteThreadDoc.data!.position).toEqual({ start: 20, length: thread4AnchorLength }); - const verseNoteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid02'); + const verseNoteThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid02'); expect(verseNoteThreadDoc.data!.position).toEqual({ start: 0, length: 0 }); // edit before paratext note let thread3Position = env.getNoteThreadEditorPosition('dataid03'); @@ -2196,12 +2197,12 @@ describe('EditorComponent', () => { env.dispose(); })); - it('update note thread anchors when multiple edits within a verse', fakeAsync(() => { + it('update note thread anchors when multiple edits within a verse', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); - const noteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid01'); + const noteThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); const origNoteAnchor: TextAnchor = { start: 8, length: 9 }; expect(noteThreadDoc.data!.position).toEqual(origNoteAnchor); @@ -2236,7 +2237,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('updates note anchor for non-verse segments', fakeAsync(() => { + it('updates note anchor for non-verse segments', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); const origThread06Pos: TextAnchor = { start: 38, length: 7 }; @@ -2248,7 +2249,7 @@ describe('EditorComponent', () => { const range: Range = env.component.target!.getSegmentRange('s_2')!; const notePosition: number = env.getNoteThreadEditorPosition('dataid06'); expect(range.index + textBeforeNote.length).toEqual(notePosition); - const thread06Doc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid06'); + const thread06Doc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid06'); let textAnchor: TextAnchor = thread06Doc.data!.position; expect(textAnchor).toEqual(origThread06Pos); @@ -2275,11 +2276,11 @@ describe('EditorComponent', () => { env.dispose(); })); - it('note belongs to a segment after a blank', fakeAsync(() => { + it('note belongs to a segment after a blank', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); - const noteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid05'); + const noteThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid05'); expect(noteThreadDoc.data!.position).toEqual({ start: 28, length: 9 }); let verse4p1Index = env.component.target!.getSegmentRange('verse_1_4/p_1')!.index; expect(env.getNoteThreadEditorPosition('dataid05')).toEqual(verse4p1Index); @@ -2319,11 +2320,11 @@ describe('EditorComponent', () => { env.dispose(); })); - it('remote edits correctly applied to editor', fakeAsync(() => { + it('remote edits correctly applied to editor', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); - const noteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid01'); + const noteThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); expect(noteThreadDoc.data!.position).toEqual({ start: 8, length: 9 }); // The remote user inserts text after the thread01 note @@ -2338,7 +2339,7 @@ describe('EditorComponent', () => { ); // $ represents a note thread embed // target: $chap|ter 1, verse 1. - const textDoc: TextDoc = env.getTextDoc(new TextDocId('project01', 40, 1)); + const textDoc: TextDoc = await env.getTextDoc(new TextDocId('project01', 40, 1)); const insertDelta: Delta = new Delta(); (insertDelta as any).push({ retain: remoteEditTextPos } as DeltaOperation); (insertDelta as any).push({ insert: 'abc' } as DeltaOperation); @@ -2361,7 +2362,7 @@ describe('EditorComponent', () => { noteCountBeforePosition = 2; remoteEditPositionAfterNote = 5; remoteEditTextPos = env.getRemoteEditPosition(notePosition, remoteEditPositionAfterNote, noteCountBeforePosition); - const originalNotePosInVerse: number = env.getNoteThreadDoc('project01', 'dataid03').data!.position.start; + const originalNotePosInVerse: number = (await env.getNoteThreadDoc('project01', 'dataid03')).data!.position.start; // $*targ|->et: cha<-|pter 1, $$verse 3. // ------- 7 characters get replaced locally by the text 'defgh' const selectionLength: number = 'et: cha'.length; @@ -2389,8 +2390,12 @@ describe('EditorComponent', () => { // SUT 3 env.wait(); expect(env.component.target!.getSegmentText('verse_1_3')).toEqual('targdefghpter ' + 'erse 3.'); - expect(env.getNoteThreadDoc('project01', 'dataid03').data!.position.start).toEqual(originalNotePosInVerse); - expect(env.getNoteThreadDoc('project01', 'dataid04').data!.position.start).toEqual(originalNotePosInVerse); + expect((await env.getNoteThreadDoc('project01', 'dataid03')).data!.position.start).toEqual( + originalNotePosInVerse + ); + expect((await env.getNoteThreadDoc('project01', 'dataid04')).data!.position.start).toEqual( + originalNotePosInVerse + ); const verse3Index: number = env.component.target!.getSegmentRange('verse_1_3')!.index; // The note is re-embedded at the position in the note thread doc. // Applying remote changes must not affect text anchors @@ -2401,13 +2406,13 @@ describe('EditorComponent', () => { env.dispose(); })); - it('remote edits do not affect note thread text anchors', fakeAsync(() => { + it('remote edits do not affect note thread text anchors', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); - const noteThread1Doc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid01'); - const noteThread4Doc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid04'); + const noteThread1Doc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); + const noteThread4Doc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid04'); const originalNoteThread1TextPos: TextAnchor = noteThread1Doc.data!.position; const originalNoteThread4TextPos: TextAnchor = noteThread4Doc.data!.position; expect(originalNoteThread1TextPos).toEqual({ start: 8, length: 9 }); @@ -2428,7 +2433,7 @@ describe('EditorComponent', () => { let insert = 'abc'; let deltaOps: DeltaOperation[] = [{ retain: remoteEditTextPos }, { insert: insert }]; const inSegmentDelta = new Delta(deltaOps); - const textDoc: TextDoc = env.getTextDoc(new TextDocId('project01', 40, 1)); + const textDoc: TextDoc = await env.getTextDoc(new TextDocId('project01', 40, 1)); textDoc.submit(inSegmentDelta); // SUT 1 @@ -2461,7 +2466,7 @@ describe('EditorComponent', () => { deltaOps = [{ retain: remoteEditTextPos }, { insert: insert }]; const insertDelta = new Delta(deltaOps); textDoc.submit(insertDelta); - const note1Doc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid01'); + const note1Doc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); const anchor: TextAnchor = { start: 8 + insert.length, length: 12 }; note1Doc.submitJson0Op(op => op.set(nt => nt.position, anchor)); @@ -2518,7 +2523,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('remote edits next to note on verse applied correctly', fakeAsync(() => { + it('remote edits next to note on verse applied correctly', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); @@ -2538,7 +2543,7 @@ describe('EditorComponent', () => { ); const insert: string = 'abc'; const deltaOps: DeltaOperation[] = [{ retain: remoteEditTextPos }, { insert: insert }]; - const textDoc: TextDoc = env.getTextDoc(new TextDocId('project01', 40, 1)); + const textDoc: TextDoc = await env.getTextDoc(new TextDocId('project01', 40, 1)); textDoc.submit(new Delta(deltaOps)); env.wait(); @@ -2553,7 +2558,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('undo delete-a-note-icon removes the duplicate recreated icon', fakeAsync(() => { + it('undo delete-a-note-icon removes the duplicate recreated icon', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); const noteThread6Anchor: TextAnchor = { start: 19, length: 5 }; @@ -2561,10 +2566,10 @@ describe('EditorComponent', () => { env.wait(); // undo deleting just the note - const noteThread1: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid01'); + const noteThread1: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); const noteThread1Anchor: TextAnchor = { start: 8, length: 9 }; expect(noteThread1.data!.position).toEqual(noteThread1Anchor); - const textDoc: TextDoc = env.getTextDoc(new TextDocId('project01', 40, 1)); + const textDoc: TextDoc = await env.getTextDoc(new TextDocId('project01', 40, 1)); expect(textDoc.data!.ops![3].insert).toEqual('target: chapter 1, verse 1.'); const note1Position: number = env.getNoteThreadEditorPosition('dataid01'); // target: |->$<-|chapter 1, $verse 1. @@ -2611,7 +2616,7 @@ describe('EditorComponent', () => { // undo deleting a second note in verse does not affect first note const note6Position: number = env.getNoteThreadEditorPosition('dataid06'); - const noteThread6: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid06'); + const noteThread6: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid06'); deleteLength = 3; const text = 'abc'; // target: $chapter 1, |->$ve<-|rse 1. @@ -2626,8 +2631,8 @@ describe('EditorComponent', () => { expect(textDoc.data!.ops![3].insert).toEqual('target: chapter 1, verse 1.'); // undo deleting multiple notes - const noteThread3: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid03'); - const noteThread4: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid04'); + const noteThread3: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid03'); + const noteThread4: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid04'); const noteThread3Anchor: TextAnchor = { start: 20, length: 7 }; const noteThread4Anchor: TextAnchor = { start: 20, length: 5 }; expect(noteThread3.data!.position).toEqual(noteThread3Anchor); @@ -2653,7 +2658,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('note icon is changed after remote update', fakeAsync(() => { + it('note icon is changed after remote update', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); @@ -2671,7 +2676,7 @@ describe('EditorComponent', () => { ); // Update the last note on the thread as that is the icon displayed - const noteThread: NoteThreadDoc = env.getNoteThreadDoc(projectId, threadDataId); + const noteThread: NoteThreadDoc = await env.getNoteThreadDoc(projectId, threadDataId); const index: number = noteThread.data!.notes.length - 1; const note: Note = noteThread.data!.notes[index]; note.tagId = 2; @@ -2916,7 +2921,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('can edit a note with xml reserved symbols as note content', fakeAsync(() => { + it('can edit a note with xml reserved symbols as note content', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); @@ -2928,7 +2933,7 @@ describe('EditorComponent', () => { env.wait(); verify(mockedSFProjectService.createNoteThread(projectId, anything(), anything())).once(); const [, noteThread] = capture(mockedSFProjectService.createNoteThread).last(); - let noteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc(projectId, noteThread.dataId); + let noteThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc(projectId, noteThread.dataId); expect(noteThreadDoc.data!.notes[0].content).toEqual(content); const iconElement: HTMLElement = env.getNoteThreadIconElementAtIndex('verse_1_2', 0)!; @@ -2937,7 +2942,7 @@ describe('EditorComponent', () => { env.mockNoteDialogRef.close({ noteDataId: noteThread.notes[0].dataId, noteContent: editedContent }); env.wait(); verify(mockedMatDialog.open(NoteDialogComponent, anything())).twice(); - noteThreadDoc = env.getNoteThreadDoc(projectId, noteThread.dataId); + noteThreadDoc = await env.getNoteThreadDoc(projectId, noteThread.dataId); expect(noteThreadDoc.data!.notes[0].content).toEqual(XmlUtils.encodeForXml(editedContent)); env.dispose(); })); @@ -2963,11 +2968,11 @@ describe('EditorComponent', () => { env.dispose(); })); - it('cannot insert a note when editor content unavailable', fakeAsync(() => { + it('cannot insert a note when editor content unavailable', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.onlineStatus = false; - const textDoc: TextDoc = env.getTextDoc(new TextDocId('project01', 40, 1)); + const textDoc: TextDoc = await env.getTextDoc(new TextDocId('project01', 40, 1)); const subject: Subject = new Subject(); const promise = new Promise(resolve => { subject.subscribe(() => resolve(textDoc)); @@ -3019,14 +3024,14 @@ describe('EditorComponent', () => { env.dispose(); })); - it('allows adding a note to an existing thread', fakeAsync(() => { + it('allows adding a note to an existing thread', fakeAsync(async () => { const projectId: string = 'project01'; const threadDataId: string = 'dataid04'; const threadId: string = 'thread04'; const segmentRef: string = 'verse_1_3'; const env = new TestEnvironment(); const content: string = 'content in the thread'; - let noteThread: NoteThreadDoc = env.getNoteThreadDoc(projectId, threadDataId); + let noteThread: NoteThreadDoc = await env.getNoteThreadDoc(projectId, threadDataId); expect(noteThread.data!.notes.length).toEqual(1); env.setProjectUserConfig(); @@ -3038,7 +3043,7 @@ describe('EditorComponent', () => { expect((noteDialogData!.data as NoteDialogData).threadDataId).toEqual(threadDataId); env.mockNoteDialogRef.close({ noteContent: content }); env.wait(); - noteThread = env.getNoteThreadDoc(projectId, threadDataId); + noteThread = await env.getNoteThreadDoc(projectId, threadDataId); expect(noteThread.data!.notes.length).toEqual(2); expect(noteThread.data!.notes[1].threadId).toEqual(threadId); expect(noteThread.data!.notes[1].content).toEqual(content); @@ -3046,12 +3051,12 @@ describe('EditorComponent', () => { env.dispose(); })); - it('allows resolving a note', fakeAsync(() => { + it('allows resolving a note', fakeAsync(async () => { const projectId: string = 'project01'; const threadDataId: string = 'dataid01'; const content: string = 'This thread is resolved.'; const env = new TestEnvironment(); - let noteThread: NoteThreadDoc = env.getNoteThreadDoc(projectId, threadDataId); + let noteThread: NoteThreadDoc = await env.getNoteThreadDoc(projectId, threadDataId); expect(noteThread.data!.notes.length).toEqual(3); env.setProjectUserConfig(); @@ -3061,7 +3066,7 @@ describe('EditorComponent', () => { verify(mockedMatDialog.open(NoteDialogComponent, anything())).once(); env.mockNoteDialogRef.close({ noteContent: content, status: NoteStatus.Resolved }); env.wait(); - noteThread = env.getNoteThreadDoc(projectId, threadDataId); + noteThread = await env.getNoteThreadDoc(projectId, threadDataId); expect(noteThread.data!.notes.length).toEqual(4); expect(noteThread.data!.notes[3].content).toEqual(content); expect(noteThread.data!.notes[3].status).toEqual(NoteStatus.Resolved); @@ -3077,7 +3082,7 @@ describe('EditorComponent', () => { const threadDataId: string = 'dataid01'; const content: string = 'This thread is resolved.'; const env = new TestEnvironment(); - let noteThread: NoteThreadDoc = env.getNoteThreadDoc(projectId, threadDataId); + let noteThread: NoteThreadDoc = await env.getNoteThreadDoc(projectId, threadDataId); expect(noteThread.data!.notes.length).toEqual(3); // Mark the note as editable await noteThread.submitJson0Op(op => op.set(nt => nt.notes[0].editable, true)); @@ -3088,7 +3093,7 @@ describe('EditorComponent', () => { verify(mockedMatDialog.open(NoteDialogComponent, anything())).once(); env.mockNoteDialogRef.close({ noteContent: content, status: NoteStatus.Resolved, noteDataId: 'thread01_note0' }); env.wait(); - noteThread = env.getNoteThreadDoc(projectId, threadDataId); + noteThread = await env.getNoteThreadDoc(projectId, threadDataId); expect(noteThread.data!.notes.length).toEqual(3); expect(noteThread.data!.notes[0].content).toEqual(content); expect(noteThread.data!.notes[0].status).toEqual(NoteStatus.Resolved); @@ -3099,13 +3104,13 @@ describe('EditorComponent', () => { env.dispose(); })); - it('does not allow editing and resolving a non-editable note', fakeAsync(() => { + it('does not allow editing and resolving a non-editable note', fakeAsync(async () => { const projectId: string = 'project01'; const threadDataId: string = 'dataid01'; const content: string = 'This thread is resolved.'; const env = new TestEnvironment(); const dialogMessage = spyOn((env.component as any).dialogService, 'message').and.stub(); - let noteThread: NoteThreadDoc = env.getNoteThreadDoc(projectId, threadDataId); + let noteThread: NoteThreadDoc = await env.getNoteThreadDoc(projectId, threadDataId); expect(noteThread.data!.notes.length).toEqual(3); env.setProjectUserConfig(); env.wait(); @@ -3114,7 +3119,7 @@ describe('EditorComponent', () => { verify(mockedMatDialog.open(NoteDialogComponent, anything())).once(); env.mockNoteDialogRef.close({ noteContent: content, status: NoteStatus.Resolved, noteDataId: 'thread01_note0' }); env.wait(); - noteThread = env.getNoteThreadDoc(projectId, threadDataId); + noteThread = await env.getNoteThreadDoc(projectId, threadDataId); expect(noteThread.data!.notes.length).toEqual(3); expect(dialogMessage).toHaveBeenCalledTimes(1); env.dispose(); @@ -3390,7 +3395,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('should remove note thread icon from editor when thread is deleted', fakeAsync(() => { + it('should remove note thread icon from editor when thread is deleted', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); @@ -3406,7 +3411,7 @@ describe('EditorComponent', () => { // notes respond to edits after note icon removed const note1position: number = env.getNoteThreadEditorPosition('dataid01'); env.targetEditor.setSelection(note1position + 2, 'user'); - const noteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc('project01', 'dataid01'); + const noteThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); const originalPos: TextAnchor = { start: 8, length: 9 }; expect(noteThreadDoc.data!.position).toEqual(originalPos); env.typeCharacters('t'); @@ -3963,9 +3968,9 @@ describe('EditorComponent', () => { }); describe('initEditorTabs', () => { - it('should add source tab when source is defined and viewable', fakeAsync(() => { + it('should add source tab when source is defined and viewable', fakeAsync(async () => { const env = new TestEnvironment(); - const projectDoc = env.getProjectDoc('project01'); + const projectDoc = await env.getProjectDoc('project01'); const spyCreateTab = spyOn(env.tabFactory, 'createTab').and.callThrough(); env.wait(); expect(spyCreateTab).toHaveBeenCalledWith('project-source', { @@ -3976,10 +3981,10 @@ describe('EditorComponent', () => { discardPeriodicTasks(); })); - it('should not add source tab when source is defined but not viewable', fakeAsync(() => { + it('should not add source tab when source is defined but not viewable', fakeAsync(async () => { const env = new TestEnvironment(); when(mockedPermissionsService.isUserOnProject('project02')).thenResolve(false); - const projectDoc = env.getProjectDoc('project01'); + const projectDoc = await env.getProjectDoc('project01'); const spyCreateTab = spyOn(env.tabFactory, 'createTab').and.callThrough(); env.wait(); expect(spyCreateTab).not.toHaveBeenCalledWith('project-source', { @@ -4000,9 +4005,9 @@ describe('EditorComponent', () => { discardPeriodicTasks(); })); - it('should add target tab', fakeAsync(() => { + it('should add target tab', fakeAsync(async () => { const env = new TestEnvironment(); - const projectDoc = env.getProjectDoc('project01'); + const projectDoc = await env.getProjectDoc('project01'); const spyCreateTab = spyOn(env.tabFactory, 'createTab').and.callThrough(); env.wait(); expect(spyCreateTab).toHaveBeenCalledWith('project-target', { @@ -4310,7 +4315,7 @@ describe('EditorComponent', () => { const tooltipHarness = await env.harnessLoader.getHarness( MatTooltipHarness.with({ selector: '#source-text-area .tab-header-content' }) ); - const sourceProjectDoc = env.getProjectDoc('project02'); + const sourceProjectDoc = await env.getProjectDoc('project02'); env.wait(); await tooltipHarness.show(); expect(await tooltipHarness.getTooltipText()).toBe(sourceProjectDoc.data?.translateConfig.source?.name!); @@ -4324,7 +4329,7 @@ describe('EditorComponent', () => { MatTooltipHarness.with({ selector: '#target-text-area .tab-header-content' }) ); - const targetProjectDoc = env.getProjectDoc('project01'); + const targetProjectDoc = await env.getProjectDoc('project01'); env.wait(); await tooltipHarness.show(); expect(await tooltipHarness.getTooltipText()).toBe(targetProjectDoc.data?.name!); @@ -5048,9 +5053,9 @@ class TestEnvironment { this.wait(); } - deleteText(textId: string): void { - this.ngZone.run(() => { - const textDoc = this.realtimeService.get(TextDoc.COLLECTION, textId, new DocSubscription('spec')); + async deleteText(textId: string): Promise { + await this.ngZone.run(async () => { + const textDoc = await this.realtimeService.get(TextDoc.COLLECTION, textId, new DocSubscription('spec')); textDoc.delete(); }); this.wait(); @@ -5202,16 +5207,16 @@ class TestEnvironment { spyOn((this.component as any).dialogService.matDialog, 'open').and.returnValue(mockDialogRef); } - getProjectUserConfigDoc(userId: string = 'user01'): SFProjectUserConfigDoc { - return this.realtimeService.get( + async getProjectUserConfigDoc(userId: string = 'user01'): Promise { + return await this.realtimeService.get( SFProjectUserConfigDoc.COLLECTION, getSFProjectUserConfigDocId('project01', userId), new DocSubscription('spec') ); } - getProjectDoc(projectId: string): SFProjectProfileDoc { - return this.realtimeService.get( + async getProjectDoc(projectId: string): Promise { + return await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, projectId, new DocSubscription('spec') @@ -5222,13 +5227,13 @@ class TestEnvironment { return this.targetEditor.container.querySelector('usx-segment[data-segment="' + segmentRef + '"]'); } - getTextDoc(textId: TextDocId): TextDoc { - return this.realtimeService.get(TextDoc.COLLECTION, textId.toString(), new DocSubscription('spec')); + async getTextDoc(textId: TextDocId): Promise { + return await this.realtimeService.get(TextDoc.COLLECTION, textId.toString(), new DocSubscription('spec')); } - getNoteThreadDoc(projectId: string, threadDataId: string): NoteThreadDoc { + async getNoteThreadDoc(projectId: string, threadDataId: string): Promise { const docId: string = projectId + ':' + threadDataId; - return this.realtimeService.get(NoteThreadDoc.COLLECTION, docId, new DocSubscription('spec')); + return await this.realtimeService.get(NoteThreadDoc.COLLECTION, docId, new DocSubscription('spec')); } getNoteThreadIconElement(segmentRef: string, threadDataId: string): HTMLElement | null { From 046650fd8fbcf90586375d05477025d75d58861a Mon Sep 17 00:00:00 2001 From: MarkS Date: Thu, 28 Aug 2025 16:49:34 -0600 Subject: [PATCH 06/42] await --- .../translate/editor/editor.component.spec.ts | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts index e76c6b80c32..21751f4253e 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts @@ -5266,8 +5266,8 @@ class TestEnvironment { return thread!.classList.contains('note-thread-highlight'); } - setDataInSync(projectId: string, isInSync: boolean, source?: any): void { - const projectDoc: SFProjectProfileDoc = this.getProjectDoc(projectId); + async setDataInSync(projectId: string, isInSync: boolean, source?: any): Promise { + const projectDoc: SFProjectProfileDoc = await this.getProjectDoc(projectId); projectDoc.submitJson0Op(op => op.set(p => p.sync.dataInSync!, isInSync), source); tick(); this.fixture.detectChanges(); @@ -5283,8 +5283,8 @@ class TestEnvironment { this.fixture.detectChanges(); } - updateFontSize(projectId: string, size: number): void { - const projectDoc: SFProjectProfileDoc = this.getProjectDoc(projectId); + async updateFontSize(projectId: string, size: number): Promise { + const projectDoc: SFProjectProfileDoc = await this.getProjectDoc(projectId); projectDoc.submitJson0Op(op => op.set(p => p.defaultFontSize, size), false); tick(); this.fixture.detectChanges(); @@ -5325,8 +5325,8 @@ class TestEnvironment { this.wait(); } - changeUserRole(projectId: string, userId: string, role: SFProjectRole): void { - const projectDoc: SFProjectProfileDoc = this.getProjectDoc(projectId); + async changeUserRole(projectId: string, userId: string, role: SFProjectRole): Promise { + const projectDoc: SFProjectProfileDoc = await this.getProjectDoc(projectId); const userRoles = cloneDeep(this.userRolesOnProject); userRoles[userId] = role; projectDoc.submitJson0Op(op => op.set(p => p.userRoles, userRoles), false); @@ -5550,14 +5550,14 @@ class TestEnvironment { }); } - reattachNote( + async reattachNote( projectId: string, threadDataId: string, verseStr: string, position?: TextAnchor, doNotParseReattachedVerseStr: boolean = false - ): void { - const noteThreadDoc: NoteThreadDoc = this.getNoteThreadDoc(projectId, threadDataId); + ): Promise { + const noteThreadDoc: NoteThreadDoc = await this.getNoteThreadDoc(projectId, threadDataId); const template: Note = noteThreadDoc.data!.notes[0]; let reattached: string; if (doNotParseReattachedVerseStr || position == null) { @@ -5596,8 +5596,8 @@ class TestEnvironment { }); } - convertToConflictNote(projectId: string, threadDataId: string): void { - const noteThreadDoc: NoteThreadDoc = this.getNoteThreadDoc(projectId, threadDataId); + async convertToConflictNote(projectId: string, threadDataId: string): Promise { + const noteThreadDoc: NoteThreadDoc = await this.getNoteThreadDoc(projectId, threadDataId); noteThreadDoc.submitJson0Op(op => { op.set(nt => nt.notes[0].conflictType, NoteConflictType.VerseTextConflict); op.set(nt => nt.notes[0].type, NoteType.Conflict); @@ -5614,18 +5614,18 @@ class TestEnvironment { return noteEmbedCount; } - resolveNote(projectId: string, threadId: string): void { - const noteDoc: NoteThreadDoc = this.getNoteThreadDoc(projectId, threadId); + async resolveNote(projectId: string, threadId: string): Promise { + const noteDoc: NoteThreadDoc = await this.getNoteThreadDoc(projectId, threadId); noteDoc.submitJson0Op(op => op.set(n => n.status, NoteStatus.Resolved)); this.realtimeService.updateQueryAdaptersRemote(); this.wait(); } - deleteMostRecentNote(projectId: string, segmentRef: string, threadId: string): void { + async deleteMostRecentNote(projectId: string, segmentRef: string, threadId: string): Promise { const noteThreadIconElem: HTMLElement = this.getNoteThreadIconElement(segmentRef, threadId)!; noteThreadIconElem.click(); this.wait(); - const noteDoc: NoteThreadDoc = this.getNoteThreadDoc(projectId, threadId); + const noteDoc: NoteThreadDoc = await this.getNoteThreadDoc(projectId, threadId); noteDoc.submitJson0Op(op => op.set(d => d.notes[0].deleted, true)); this.mockNoteDialogRef.close({ deleted: true }); this.realtimeService.updateQueryAdaptersRemote(); From 1c770330e10039480eba9c226493248c08158d3d Mon Sep 17 00:00:00 2001 From: MarkS Date: Thu, 28 Aug 2025 16:53:27 -0600 Subject: [PATCH 07/42] onlineQuery name --- .../system-administration/sa-users.component.spec.ts | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/system-administration/sa-users.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/system-administration/sa-users.component.spec.ts index 7b7dc49c87d..94369e066ea 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/system-administration/sa-users.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/system-administration/sa-users.component.spec.ts @@ -179,12 +179,14 @@ class TestEnvironment { const filters: QueryFilter = { [obj().pathStr(u => u.name)]: { $regex: `.*${escapeRegExp(term)}.*`, $options: 'i' } }; - return from(this.realtimeService.onlineQuery(UserDoc.COLLECTION, merge(filters, queryParameters))); + return from( + this.realtimeService.onlineQuery(UserDoc.COLLECTION, 'spec', merge(filters, queryParameters)) + ); }) ) ); when(mockedProjectService.onlineGetMany(anything())).thenCall(async () => { - const query = await this.realtimeService.onlineQuery(TestProjectDoc.COLLECTION, {}); + const query = await this.realtimeService.onlineQuery(TestProjectDoc.COLLECTION, 'spec', {}); return query.docs; }); when(mockedUserService.currentUserId).thenReturn('user01'); From c0452937600b8123ad18dac20d6f45addf8d1319 Mon Sep 17 00:00:00 2001 From: MarkS Date: Thu, 28 Aug 2025 17:02:40 -0600 Subject: [PATCH 08/42] await, name --- .../insights/lynx-workspace.service.spec.ts | 10 ++--- .../note-dialog/note-dialog.component.spec.ts | 40 +++++++++---------- .../translate-overview.component.spec.ts | 4 +- .../collaborators.component.spec.ts | 8 ++-- .../roles-and-permissions-dialog.spec.ts | 8 +++- .../sa-projects.component.spec.ts | 1 + 6 files changed, 38 insertions(+), 33 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts index 4df0288da17..bd76594c138 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts @@ -176,7 +176,7 @@ describe('LynxWorkspaceService', () => { resetCalls(mockProjectService); } - createTextDoc(chapter: number = CHAPTER_NUM, content: Delta | string = TEST_CONTENT): TextDoc { + async createTextDoc(chapter: number = CHAPTER_NUM, content: Delta | string = TEST_CONTENT): Promise { const textDocId = new TextDocId(PROJECT_ID, BOOK_NUM, chapter); const id = textDocId.toString(); const delta = typeof content === 'string' ? new Delta().insert(content) : content; @@ -187,10 +187,10 @@ describe('LynxWorkspaceService', () => { data: delta }); - return this.realtimeService.get(TextDoc.COLLECTION, id, new DocSubscription('spec')); + return await this.realtimeService.get(TextDoc.COLLECTION, id, new DocSubscription('spec')); } - createMockProjectDoc(id: string = PROJECT_ID, lynxConfig?: LynxConfig): SFProjectProfileDoc { + createMockProjectDoc(id: string = PROJECT_ID, lynxConfig?: LynxConfig): Promise { const projectData = createTestProjectProfile({ texts: [ { @@ -211,7 +211,7 @@ describe('LynxWorkspaceService', () => { data: projectData }); - return this.realtimeService.get( + return await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, id, new DocSubscription('spec') @@ -272,7 +272,7 @@ describe('LynxWorkspaceService', () => { tick(); } - triggerProjectChange(id: string, lynxConfig?: LynxConfig): void { + async triggerProjectChange(id: string, lynxConfig?: LynxConfig): Promise { this.projectDocTestSubject$.next(this.createMockProjectDoc(id, lynxConfig)); tick(); } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts index f80d6a92e6a..f6d1b1224a1 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts @@ -346,10 +346,10 @@ describe('NoteDialogComponent', () => { expect(env.saveButton).toBeNull(); })); - it('does not save if empty note added to an existing thread', fakeAsync(() => { + it('does not save if empty note added to an existing thread', fakeAsync(async () => { env = new TestEnvironment({ noteThread: TestEnvironment.getNoteThread() }); expect(env.noteInputElement).toBeTruthy(); - const noteThread: NoteThreadDoc = env.getNoteThreadDoc('dataid01'); + const noteThread: NoteThreadDoc = await env.getNoteThreadDoc('dataid01'); expect(noteThread.data!.notes.length).toEqual(5); env.submit(); expect(noteThread.data!.notes.length).toEqual(5); @@ -365,11 +365,11 @@ describe('NoteDialogComponent', () => { expect(env.dialogResult).toEqual({ noteContent: content, noteDataId: undefined }); })); - it('allows user to edit the last note in the thread', fakeAsync(() => { + it('allows user to edit the last note in the thread', fakeAsync(async () => { env = new TestEnvironment({ noteThread: TestEnvironment.getNoteThread(undefined, undefined, true) }); // note03 is marked as deleted expect(env.notes.length).toEqual(4); - const noteThread: NoteThreadDoc = env.getNoteThreadDoc('dataid01'); + const noteThread: NoteThreadDoc = await env.getNoteThreadDoc('dataid01'); expect(noteThread.data!.notes[4].content).toEqual('note05'); const noteNumbers = [1, 2, 3]; noteNumbers.forEach(n => expect(env.noteHasEditActions(n)).toBe(false)); @@ -385,11 +385,11 @@ describe('NoteDialogComponent', () => { expect(env.dialogResult).toEqual({ noteContent: content, noteDataId: 'note05' }); })); - it('allows user to resolve the last note in the thread', fakeAsync(() => { + it('allows user to resolve the last note in the thread', fakeAsync(async () => { env = new TestEnvironment({ noteThread: TestEnvironment.getNoteThread(undefined, undefined, true) }); // note03 is marked as deleted expect(env.notes.length).toEqual(4); - const noteThread: NoteThreadDoc = env.getNoteThreadDoc('dataid01'); + const noteThread: NoteThreadDoc = await env.getNoteThreadDoc('dataid01'); expect(noteThread.data!.notes[4].content).toEqual('note05'); const noteNumbers = [1, 2, 3]; noteNumbers.forEach(n => expect(env.noteHasEditActions(n)).toBe(false)); @@ -406,21 +406,21 @@ describe('NoteDialogComponent', () => { expect(env.dialogResult).toEqual({ noteContent: content, noteDataId: 'note05', status: NoteStatus.Resolved }); })); - it('does not allow user to edit the last note in the thread if it is not editable', fakeAsync(() => { + it('does not allow user to edit the last note in the thread if it is not editable', fakeAsync(async () => { env = new TestEnvironment({ noteThread: TestEnvironment.getNoteThread() }); // note03 is marked as deleted expect(env.notes.length).toEqual(4); - const noteThread: NoteThreadDoc = env.getNoteThreadDoc('dataid01'); + const noteThread: NoteThreadDoc = await env.getNoteThreadDoc('dataid01'); expect(noteThread.data!.notes[4].content).toEqual('note05'); const noteNumbers = [1, 2, 3, 4]; noteNumbers.forEach(n => expect(env.noteHasEditActions(n)).toBe(false)); })); - it('allows user to delete the last note in the thread', fakeAsync(() => { + it('allows user to delete the last note in the thread', fakeAsync(async () => { env = new TestEnvironment({ noteThread: TestEnvironment.getNoteThread(undefined, undefined, true) }); // note03 is marked as deleted expect(env.notes.length).toEqual(4); - const noteThread: NoteThreadDoc = env.getNoteThreadDoc('dataid01'); + const noteThread: NoteThreadDoc = await env.getNoteThreadDoc('dataid01'); expect(noteThread.data!.notes.length).toEqual(5); expect(env.noteHasEditActions(3)).toBe(false); expect(env.noteHasEditActions(4)).toBe(true); @@ -449,10 +449,10 @@ describe('NoteDialogComponent', () => { expect(env.notes.length).toEqual(4); })); - it('deletes the thread if the last note is deleted', fakeAsync(() => { + it('deletes the thread if the last note is deleted', fakeAsync(async () => { env = new TestEnvironment({ noteThread: TestEnvironment.defaultNoteThread }); expect(env.notes.length).toEqual(1); - const noteThread: NoteThreadDoc = env.getNoteThreadDoc('dataid01'); + const noteThread: NoteThreadDoc = await env.getNoteThreadDoc('dataid01'); expect(noteThread.data).toBeTruthy(); expect(env.noteHasEditActions(1)).toBe(true); env.clickDeleteNote(); @@ -461,7 +461,7 @@ describe('NoteDialogComponent', () => { expect(noteThread.data!.notes[0].deleted).toBe(true); })); - it('deletes the thread if the deleted note is the only active note', fakeAsync(() => { + it('deletes the thread if the deleted note is the only active note', fakeAsync(async () => { const noteThread: NoteThread = cloneDeep(TestEnvironment.defaultNoteThread); const note: Note = { dataId: 'note02', @@ -478,7 +478,7 @@ describe('NoteDialogComponent', () => { noteThread.notes.push(note); env = new TestEnvironment({ noteThread }); expect(env.notes.length).toEqual(1); - const threadDoc: NoteThreadDoc = env.getNoteThreadDoc('dataid01'); + const threadDoc: NoteThreadDoc = await env.getNoteThreadDoc('dataid01'); expect(threadDoc).toBeTruthy(); expect(env.noteHasEditActions(1)).toBe(true); env.clickDeleteNote(); @@ -589,7 +589,7 @@ describe('NoteDialogComponent', () => { expect(env.dialogResult).toEqual({ noteContent: content, noteDataId: undefined }); })); - it('allows adding a note to an existing biblical term note thread', fakeAsync(() => { + it('allows adding a note to an existing biblical term note thread', fakeAsync(async () => { const biblicalTerm = TestEnvironment.defaultBiblicalTerm; const noteThread = TestEnvironment.getNoteThread(); noteThread.biblicalTermId = biblicalTerm.dataId; @@ -601,7 +601,7 @@ describe('NoteDialogComponent', () => { }; env = new TestEnvironment({ noteThread, biblicalTerm }); - const noteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc('dataid01'); + const noteThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc('dataid01'); expect(noteThreadDoc.data!.notes.length).toEqual(5); expect(noteThreadDoc.data!.extraHeadingInfo).not.toBeNull(); expect(env.verseRef).toEqual('Biblical Term'); @@ -1121,14 +1121,14 @@ class TestEnvironment { this.fixture.detectChanges(); } - getNoteThreadDoc(threadDataId: string): NoteThreadDoc { + async getNoteThreadDoc(threadDataId: string): Promise { const id: string = getNoteThreadDocId(TestEnvironment.PROJECT01, threadDataId); - return this.realtimeService.get(NoteThreadDoc.COLLECTION, id, new DocSubscription('spec')); + return await this.realtimeService.get(NoteThreadDoc.COLLECTION, id, new DocSubscription('spec')); } - getProjectUserConfigDoc(projectId: string, userId: string): SFProjectUserConfigDoc { + async getProjectUserConfigDoc(projectId: string, userId: string): Promise { const id: string = getSFProjectUserConfigDocId(projectId, userId); - return this.realtimeService.get( + return await this.realtimeService.get( SFProjectUserConfigDoc.COLLECTION, id, new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts index 4ff11b8aeeb..c21a6a24fb6 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts @@ -547,11 +547,11 @@ class TestEnvironment { this.fixture.detectChanges(); } - addVerse(bookNum: number, chapter: number): void { + async addVerse(bookNum: number, chapter: number): Promise { const delta = new Delta(); delta.insert(`chapter ${chapter}, verse 22.`, { segment: `verse_${chapter}_22` }); - const textDoc = this.realtimeService.get( + const textDoc = await this.realtimeService.get( TextDoc.COLLECTION, getTextDocId('project01', bookNum, chapter), new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts index 942cfe47683..1aa763c6470 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts @@ -438,8 +438,8 @@ class TestEnvironment { mockedProjectService.onlineGetLinkSharingKey(this.project01Id, anything(), anything(), anything()) ).thenResolve('linkSharingKey01'); when(mockedProjectService.onlineSetUserProjectPermissions(this.project01Id, 'user02', anything())).thenCall( - (projectId: string, userId: string, permissions: string[]) => { - const projectDoc: SFProjectDoc = this.realtimeService.get( + async (projectId: string, userId: string, permissions: string[]) => { + const projectDoc: SFProjectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, projectId, new DocSubscription('spec') @@ -581,8 +581,8 @@ class TestEnvironment { this.setupThisProjectData(this.project01Id, this.createProject(userRoles)); } - updateCheckingProperties(config: CheckingConfig): Promise { - const projectDoc: SFProjectDoc = this.realtimeService.get( + async updateCheckingProperties(config: CheckingConfig): Promise { + const projectDoc: SFProjectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, this.project01Id, new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/users/roles-and-permissions/roles-and-permissions-dialog.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/users/roles-and-permissions/roles-and-permissions-dialog.spec.ts index f93e3b8e0be..715607b002c 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/users/roles-and-permissions/roles-and-permissions-dialog.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/users/roles-and-permissions/roles-and-permissions-dialog.spec.ts @@ -160,9 +160,13 @@ describe('RolesAndPermissionsComponent', () => { env.openDialog('ptTranslator'); //prep for role change - when(mockedProjectService.onlineUpdateUserRole(anything(), anything(), anything())).thenCall((p, u, r) => { + when(mockedProjectService.onlineUpdateUserRole(anything(), anything(), anything())).thenCall(async (p, u, r) => { rolesByUser[u] = r; - const projectDoc: SFProjectDoc = env.realtimeService.get(SFProjectDoc.COLLECTION, p, new DocSubscription('spec')); + const projectDoc: SFProjectDoc = await env.realtimeService.get( + SFProjectDoc.COLLECTION, + p, + new DocSubscription('spec') + ); projectDoc.submitJson0Op(op => { op.set(p => p.userRoles, rolesByUser); op.set(p => p.userPermissions, { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/system-administration/sa-projects.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/system-administration/sa-projects.component.spec.ts index 41251483ebb..93b7beba49f 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/system-administration/sa-projects.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/system-administration/sa-projects.component.spec.ts @@ -253,6 +253,7 @@ class TestEnvironment { return from( this.realtimeService.onlineQuery( TestProjectDoc.COLLECTION, + 'spec', merge(filters, queryParameters) ) ); From 82fbfc48f62cc44e35019efe89d8ff37075e78a5 Mon Sep 17 00:00:00 2001 From: MarkS Date: Thu, 28 Aug 2025 17:04:25 -0600 Subject: [PATCH 09/42] await --- ...gestions-settings-dialog.component.spec.ts | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/suggestions-settings-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/suggestions-settings-dialog.component.spec.ts index 71cbe0636c8..8aa3e5037d7 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/suggestions-settings-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/suggestions-settings-dialog.component.spec.ts @@ -47,38 +47,38 @@ describe('SuggestionsSettingsDialogComponent', () => { providers: [{ provide: OnlineStatusService, useClass: TestOnlineStatusService }] })); - it('update confidence threshold', fakeAsync(() => { + it('update confidence threshold', fakeAsync(async () => { const env = new TestEnvironment(); env.openDialog(); expect(env.component!.confidenceThreshold).toEqual(50); env.updateConfidenceThresholdSlider(60); expect(env.component!.confidenceThreshold).toEqual(60); - const userConfigDoc = env.getProjectUserConfigDoc(); + const userConfigDoc = await env.getProjectUserConfigDoc(); expect(userConfigDoc.data!.confidenceThreshold).toEqual(0.6); env.closeDialog(); })); - it('update suggestions enabled', fakeAsync(() => { + it('update suggestions enabled', fakeAsync(async () => { const env = new TestEnvironment(); env.openDialog(); expect(env.component!.translationSuggestionsUserEnabled).toBe(true); env.clickSwitch(env.suggestionsEnabledSwitch); expect(env.component!.translationSuggestionsUserEnabled).toBe(false); - const userConfigDoc = env.getProjectUserConfigDoc(); + const userConfigDoc = await env.getProjectUserConfigDoc(); expect(userConfigDoc.data!.translationSuggestionsEnabled).toBe(false); env.closeDialog(); })); - it('update num suggestions', fakeAsync(() => { + it('update num suggestions', fakeAsync(async () => { const env = new TestEnvironment(); env.openDialog(); expect(env.component!.numSuggestions).toEqual('1'); env.changeSelectValue(env.numSuggestionsSelect, 2); expect(env.component!.numSuggestions).toEqual('2'); - const userConfigDoc = env.getProjectUserConfigDoc(); + const userConfigDoc = await env.getProjectUserConfigDoc(); expect(userConfigDoc.data!.numSuggestions).toEqual(2); env.closeDialog(); })); @@ -193,9 +193,9 @@ class TestEnvironment { getSFProjectUserConfigDocId('project01', 'user01'), new DocSubscription('spec') ) - .then(projectUserConfigDoc => { + .then(async projectUserConfigDoc => { const viewContainerRef = this.fixture.componentInstance.childViewContainer; - const projectDoc = this.getProjectProfileDoc(); + const projectDoc = await this.getProjectProfileDoc(); const config: MatDialogConfig = { data: { projectDoc, projectUserConfigDoc }, viewContainerRef @@ -230,16 +230,16 @@ class TestEnvironment { }); } - getProjectProfileDoc(): SFProjectProfileDoc { - return this.realtimeService.get( + async getProjectProfileDoc(): Promise { + return await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, 'project01', new DocSubscription('spec') ); } - getProjectUserConfigDoc(): SFProjectUserConfigDoc { - return this.realtimeService.get( + async getProjectUserConfigDoc(): Promise { + return await this.realtimeService.get( SFProjectUserConfigDoc.COLLECTION, getSFProjectUserConfigDocId('project01', 'user01'), new DocSubscription('spec') From ea590bffe5ae2cdc29144c9b733dda0f2e70e687 Mon Sep 17 00:00:00 2001 From: MarkS Date: Thu, 28 Aug 2025 17:11:18 -0600 Subject: [PATCH 10/42] await realtimeService.get --- .../checking-overview.component.spec.ts | 8 ++++---- .../app/checking/checking/checking.component.spec.ts | 2 +- .../question-dialog/question-dialog.component.spec.ts | 4 ++-- .../question-dialog/question-dialog.service.spec.ts | 6 +++--- .../connect-project/connect-project.component.spec.ts | 4 ++-- .../ClientApp/src/app/core/text-doc.service.spec.ts | 2 +- .../src/app/project/project.component.spec.ts | 2 +- .../app/shared/share/share-control.component.spec.ts | 2 +- .../app/shared/share/share-dialog.component.spec.ts | 2 +- .../src/app/shared/text/text.component.spec.ts | 2 +- .../sync-progress/sync-progress.component.spec.ts | 4 ++-- .../ClientApp/src/app/sync/sync.component.spec.ts | 4 ++-- .../biblical-term-dialog.component.spec.ts | 4 ++-- .../biblical-terms/biblical-terms.component.spec.ts | 11 ++++++----- .../draft-sources/draft-sources.component.spec.ts | 4 ++-- .../lynx/insights/lynx-workspace.service.spec.ts | 6 +++++- .../editor/note-dialog/note-dialog.component.spec.ts | 4 ++-- .../editor/translate-metrics-session.spec.ts | 4 ++-- .../translate-overview.component.spec.ts | 2 +- .../collaborators/collaborators.component.spec.ts | 4 ++-- 20 files changed, 43 insertions(+), 38 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts index 97e6ee3d088..4b9fefe9ae7 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts @@ -990,7 +990,7 @@ class TestEnvironment { ); when(mockedProjectService.onlineDeleteAudioTimingData(anything(), anything(), anything())).thenCall( (projectId, book, chapter) => { - const projectDoc = this.realtimeService.get( + const projectDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, projectId, new DocSubscription('spec') @@ -1164,7 +1164,7 @@ class TestEnvironment { } setSeeOtherUserResponses(isEnabled: boolean): void { - const projectDoc = this.realtimeService.get( + const projectDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, 'project01', new DocSubscription('spec') @@ -1178,7 +1178,7 @@ class TestEnvironment { setCheckingEnabled(isEnabled: boolean): void { this.ngZone.run(() => { - const projectDoc = this.realtimeService.get( + const projectDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, 'project01', new DocSubscription('spec') @@ -1242,7 +1242,7 @@ class TestEnvironment { ], permissions: {} }; - const projectDoc = this.realtimeService.get( + const projectDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, 'project01', new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts index 057510f3acb..677d144c07d 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts @@ -3324,7 +3324,7 @@ class TestEnvironment { } getQuestionDoc(dataId: string): QuestionDoc { - return this.realtimeService.get( + return await this.realtimeService.get( QuestionDoc.COLLECTION, getQuestionDocId('project01', dataId), new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts index 1057338b770..ef04e3509d5 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts @@ -605,7 +605,7 @@ class TestEnvironment { id: questionId, data: question }); - questionDoc = this.realtimeService.get( + questionDoc = await this.realtimeService.get( QuestionDoc.COLLECTION, questionId, new DocSubscription('spec') @@ -639,7 +639,7 @@ class TestEnvironment { id: 'project01', data: createTestProjectProfile({ texts: Object.values(textsByBookId) }) }); - const projectDoc = this.realtimeService.get( + const projectDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, 'project01', new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts index 578dd76b959..4dc21b824a7 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts @@ -198,7 +198,7 @@ class TestEnvironment { id: this.PROJECT01, data: this.testProjectProfile }); - this.projectProfileDoc = this.realtimeService.get( + this.projectProfileDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, this.PROJECT01, new DocSubscription('spec') @@ -216,7 +216,7 @@ class TestEnvironment { id: getQuestionDocId(this.PROJECT01, question.dataId), data: question }); - return this.realtimeService.get( + return await this.realtimeService.get( QUESTIONS_COLLECTION, getQuestionDocId(this.PROJECT01, question.dataId), new DocSubscription('spec') @@ -249,7 +249,7 @@ class TestEnvironment { } updateUserRole(role: string): void { - const projectProfileDoc = this.realtimeService.get( + const projectProfileDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, this.PROJECT01, new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts index 0cf14d12029..7fccdde2ba8 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts @@ -485,7 +485,7 @@ class TestEnvironment { } setQueuedCount(): void { - const projectDoc = this.realtimeService.get( + const projectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, 'project01', new DocSubscription('spec') @@ -496,7 +496,7 @@ class TestEnvironment { } emitSyncComplete(): void { - const projectDoc = this.realtimeService.get( + const projectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, 'project01', new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.spec.ts index f408cb87a2f..cce03a15be1 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.spec.ts @@ -471,6 +471,6 @@ class TestEnvironment { } getTextDoc(textId: TextDocId): TextDoc { - return this.realtimeService.get(TextDoc.COLLECTION, textId.toString(), new DocSubscription('spec')); + return await this.realtimeService.get(TextDoc.COLLECTION, textId.toString(), new DocSubscription('spec')); } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.spec.ts index 69b0468eeb4..5e840a38d5b 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.spec.ts @@ -277,7 +277,7 @@ class TestEnvironment { addUserToProject(projectIdSuffix: number): void { this.setProjectData({ memberProjectIdSuffixes: [projectIdSuffix] }); - const userDoc: UserDoc = this.realtimeService.get(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')); + const userDoc: UserDoc = await this.realtimeService.get(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')); userDoc.submitJson0Op(op => op.set(u => u.sites, { sf: { projects: [`project${projectIdSuffix}`] } }), false); tick(); } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.spec.ts index 1220e0793c1..a2bd942d1a9 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.spec.ts @@ -420,7 +420,7 @@ class TestEnvironment { } updateCheckingProperties(config: CheckingConfig): Promise { - const projectDoc: SFProjectProfileDoc = this.realtimeService.get( + const projectDoc: SFProjectProfileDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, 'project01', new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts index 4f70c4bbfa3..0a61d41af70 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts @@ -494,7 +494,7 @@ class TestEnvironment { } disableCheckingSharing(): void { - const projectDoc: SFProjectProfileDoc = this.realtimeService.get( + const projectDoc: SFProjectProfileDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, 'project01', new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts index 3da9f63745a..050fd21efae 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts @@ -1895,7 +1895,7 @@ class TestEnvironment { } getUserDoc(userId: string): UserDoc { - return this.realtimeService.get(UserDoc.COLLECTION, userId, new DocSubscription('spec')); + return await this.realtimeService.get(UserDoc.COLLECTION, userId, new DocSubscription('spec')); } getSegment(segmentRef: string): HTMLElement | null { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts index 8546b38885d..2a9da213840 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts @@ -240,7 +240,7 @@ class TestEnvironment { } updateSyncProgress(percentCompleted: number, projectId: string): void { - const projectDoc = this.realtimeService.get( + const projectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, projectId, new DocSubscription('spec') @@ -256,7 +256,7 @@ class TestEnvironment { emitSyncComplete(successful: boolean, projectId: string): void { this.host.syncProgress['updateProgressState'](projectId, new ProgressState(1)); - const projectDoc = this.realtimeService.get( + const projectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, projectId, new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts index e8bed98052c..1f82f36bd0e 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts @@ -387,7 +387,7 @@ class TestEnvironment { } setQueuedCount(projectId: string): void { - const projectDoc = this.realtimeService.get( + const projectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, projectId, new DocSubscription('spec') @@ -397,7 +397,7 @@ class TestEnvironment { } emitSyncComplete(successful: boolean, projectId: string): void { - const projectDoc = this.realtimeService.get( + const projectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, projectId, new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts index 9fc234c3e62..30dfcdd863f 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts @@ -239,11 +239,11 @@ class TestEnvironment { } getBiblicalTermDoc(id: string): BiblicalTermDoc { - return this.realtimeService.get(BiblicalTermDoc.COLLECTION, id, new DocSubscription('spec')); + return await this.realtimeService.get(BiblicalTermDoc.COLLECTION, id, new DocSubscription('spec')); } getProjectDoc(id: string): SFProjectProfileDoc { - return this.realtimeService.get( + return await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, id, new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts index 2e36294e0ed..c1f357e1569 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts @@ -494,8 +494,9 @@ class TestEnvironment { subscriber ) ); - when(mockedProjectService.getProfile(anything(), anything())).thenCall((sfProjectId, subscriber) => - this.realtimeService.get(SFProjectProfileDoc.COLLECTION, sfProjectId, subscriber) + when(mockedProjectService.getProfile(anything(), anything())).thenCall( + (sfProjectId, subscriber) => + await this.realtimeService.get(SFProjectProfileDoc.COLLECTION, sfProjectId, subscriber) ); when(mockedMatDialog.open(GenericDialogComponent, anything())).thenReturn(instance(this.mockedDialogRef)); when(this.mockedDialogRef.afterClosed()).thenReturn(of()); @@ -555,7 +556,7 @@ class TestEnvironment { } getBiblicalTermDoc(projectId: string, dataId: string): BiblicalTermDoc { - return this.realtimeService.get( + return await this.realtimeService.get( BiblicalTermDoc.COLLECTION, getBiblicalTermDocId(projectId, dataId), new DocSubscription('spec') @@ -563,7 +564,7 @@ class TestEnvironment { } getNoteThreadDoc(projectId: string, threadId: string): NoteThreadDoc { - return this.realtimeService.get( + return await this.realtimeService.get( NoteThreadDoc.COLLECTION, getNoteThreadDocId(projectId, threadId), new DocSubscription('spec') @@ -572,7 +573,7 @@ class TestEnvironment { getProjectUserConfigDoc(projectId: string, userId: string): SFProjectUserConfigDoc { const id: string = getSFProjectUserConfigDocId(projectId, userId); - return this.realtimeService.get( + return await this.realtimeService.get( SFProjectUserConfigDoc.COLLECTION, id, new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.spec.ts index 6b9dc4cd7c6..fdfd0e4400e 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.spec.ts @@ -748,10 +748,10 @@ class TestEnvironment { ) }) as SFProjectDoc ) - .map(o => { + .map(async o => { // Run it into and out of realtime service so it has fields like `remoteChanges$`. this.realtimeService.addSnapshot(SFProjectDoc.COLLECTION, o); - return this.realtimeService.get(SFProjectDoc.COLLECTION, o.id, new DocSubscription('spec')); + return await this.realtimeService.get(SFProjectDoc.COLLECTION, o.id, new DocSubscription('spec')); }) .filter(hasData) .map(o => ({ diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts index bd76594c138..4ff475e9307 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts @@ -157,7 +157,11 @@ describe('LynxWorkspaceService', () => { when(mockProjectService.getText(anything(), anything())).thenCall(textDocId => { const id = typeof textDocId === 'string' ? textDocId : textDocId.toString(); - const existingDoc = this.realtimeService.get(TextDoc.COLLECTION, id, new DocSubscription('spec')); + const existingDoc = await this.realtimeService.get( + TextDoc.COLLECTION, + id, + new DocSubscription('spec') + ); return Promise.resolve(existingDoc || this.createTextDoc()); }); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts index f6d1b1224a1..0dec535fb78 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts @@ -1030,8 +1030,8 @@ class TestEnvironment { when(mockedUserService.currentUserId).thenReturn(currentUserId); firstValueFrom(this.dialogRef.afterClosed()).then(result => (this.dialogResult = result)); - when(mockedUserService.getProfile(anything(), anything())).thenCall((id, subscriber) => - this.realtimeService.get(UserProfileDoc.COLLECTION, id, subscriber) + when(mockedUserService.getProfile(anything(), anything())).thenCall( + (id, subscriber) => await this.realtimeService.get(UserProfileDoc.COLLECTION, id, subscriber) ); when(mockedDialogService.confirm(anything(), anything())).thenResolve(true); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translate-metrics-session.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translate-metrics-session.spec.ts index ba4eb55b525..40035e359f6 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translate-metrics-session.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translate-metrics-session.spec.ts @@ -474,8 +474,8 @@ class TestEnvironment { when(mockedSFProjectService.getText(anything(), anything())).thenCall((id, subscriber) => this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString(), subscriber) ); - when(mockedSFProjectService.getProfile(anything(), anything())).thenCall((id, subscriber) => - this.realtimeService.get(SFProjectProfileDoc.COLLECTION, id.toString(), subscriber) + when(mockedSFProjectService.getProfile(anything(), anything())).thenCall( + (id, subscriber) => await this.realtimeService.get(SFProjectProfileDoc.COLLECTION, id.toString(), subscriber) ); when(mockedUserService.getCurrentUser()).thenCall(() => this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts index c21a6a24fb6..efb0a376dc3 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts @@ -561,7 +561,7 @@ class TestEnvironment { } simulateTranslateSuggestionsEnabled(enabled: boolean = true): void { - const projectDoc: SFProjectProfileDoc = this.realtimeService.get( + const projectDoc: SFProjectProfileDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, 'project01', new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts index 1aa763c6470..84836038b96 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts @@ -424,8 +424,8 @@ class TestEnvironment { when(mockedProjectService.onlineInvite(this.project01Id, anything(), anything(), anything())).thenResolve(); when(mockedProjectService.onlineInvitedUsers(this.project01Id)).thenResolve([]); when(mockedNoticeService.show(anything())).thenResolve(); - when(mockedUserService.getProfile(anything(), anything())).thenCall((userId, subscription) => - this.realtimeService.get(UserProfileDoc.COLLECTION, userId, subscription) + when(mockedUserService.getProfile(anything(), anything())).thenCall( + (userId, subscription) => await this.realtimeService.get(UserProfileDoc.COLLECTION, userId, subscription) ); when(mockedUserService.currentUserId).thenReturn('user01'); when(mockedProjectService.subscribe(anything(), anything())).thenCall((projectId, subscription) => From f17e7a883286d30204778ff95080ccee5a913c47 Mon Sep 17 00:00:00 2001 From: MarkS Date: Thu, 28 Aug 2025 17:13:15 -0600 Subject: [PATCH 11/42] async --- .../editor/lynx/insights/lynx-workspace.service.spec.ts | 2 +- .../translate/editor/note-dialog/note-dialog.component.spec.ts | 2 +- .../translate-overview/translate-overview.component.spec.ts | 2 +- .../src/app/users/collaborators/collaborators.component.spec.ts | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts index 4ff475e9307..9b44208bb99 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts @@ -155,7 +155,7 @@ describe('LynxWorkspaceService', () => { init(): void { this.realtimeService = TestBed.inject(RealtimeService as any); - when(mockProjectService.getText(anything(), anything())).thenCall(textDocId => { + when(mockProjectService.getText(anything(), anything())).thenCall(async textDocId => { const id = typeof textDocId === 'string' ? textDocId : textDocId.toString(); const existingDoc = await this.realtimeService.get( TextDoc.COLLECTION, diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts index 0dec535fb78..e04dc92ba4b 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/note-dialog/note-dialog.component.spec.ts @@ -1031,7 +1031,7 @@ class TestEnvironment { firstValueFrom(this.dialogRef.afterClosed()).then(result => (this.dialogResult = result)); when(mockedUserService.getProfile(anything(), anything())).thenCall( - (id, subscriber) => await this.realtimeService.get(UserProfileDoc.COLLECTION, id, subscriber) + async (id, subscriber) => await this.realtimeService.get(UserProfileDoc.COLLECTION, id, subscriber) ); when(mockedDialogService.confirm(anything(), anything())).thenResolve(true); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts index efb0a376dc3..f6288f2fd98 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts @@ -560,7 +560,7 @@ class TestEnvironment { this.waitForProjectDocChanges(); } - simulateTranslateSuggestionsEnabled(enabled: boolean = true): void { + async simulateTranslateSuggestionsEnabled(enabled: boolean = true): Promise { const projectDoc: SFProjectProfileDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, 'project01', diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts index 84836038b96..026b1d8b71a 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/users/collaborators/collaborators.component.spec.ts @@ -425,7 +425,7 @@ class TestEnvironment { when(mockedProjectService.onlineInvitedUsers(this.project01Id)).thenResolve([]); when(mockedNoticeService.show(anything())).thenResolve(); when(mockedUserService.getProfile(anything(), anything())).thenCall( - (userId, subscription) => await this.realtimeService.get(UserProfileDoc.COLLECTION, userId, subscription) + async (userId, subscription) => await this.realtimeService.get(UserProfileDoc.COLLECTION, userId, subscription) ); when(mockedUserService.currentUserId).thenReturn('user01'); when(mockedProjectService.subscribe(anything(), anything())).thenCall((projectId, subscription) => From 137768487b9c2a108836d867f78c0b418a48e52b Mon Sep 17 00:00:00 2001 From: MarkS Date: Fri, 29 Aug 2025 15:06:55 -0600 Subject: [PATCH 12/42] rm old suppressImplicitAnyIndexErrors --- scripts/db_tools/tsconfig.json | 18 +++++------------- .../ClientApp/tsconfig.json | 1 - 2 files changed, 5 insertions(+), 14 deletions(-) diff --git a/scripts/db_tools/tsconfig.json b/scripts/db_tools/tsconfig.json index fbf74a844f2..83b5679d534 100644 --- a/scripts/db_tools/tsconfig.json +++ b/scripts/db_tools/tsconfig.json @@ -4,7 +4,6 @@ "compilerOptions": { "module": "commonjs" } - }, "compilerOptions": { "baseUrl": "./", @@ -23,24 +22,17 @@ "module": "ES2020", "allowSyntheticDefaultImports": true, "allowJs": true, - "lib": [ - "es2018", - "dom" - ], + "lib": ["es2018", "dom"], "emitDecoratorMetadata": true, - "suppressImplicitAnyIndexErrors": true, "esModuleInterop": true, - "typeRoots": ["node_modules/@types", "../../src/RealtimeServer/typings", - ], + "typeRoots": ["node_modules/@types", "../../src/RealtimeServer/typings"], "resolveJsonModule": true, "paths": { - "xforge-common/*": [ - "../../src/SIL.XForge.Scripture/ClientApp/src/xforge-common/*" - ], - "*": [ "../../src/RealtimeServer/typings/*"] + "xforge-common/*": ["../../src/SIL.XForge.Scripture/ClientApp/src/xforge-common/*"], + "*": ["../../src/RealtimeServer/typings/*"] }, "inlineSourceMap": false, "inlineSources": true, - "noEmit": false, + "noEmit": false } } diff --git a/src/SIL.XForge.Scripture/ClientApp/tsconfig.json b/src/SIL.XForge.Scripture/ClientApp/tsconfig.json index 61e4d241782..3c6be058ea2 100644 --- a/src/SIL.XForge.Scripture/ClientApp/tsconfig.json +++ b/src/SIL.XForge.Scripture/ClientApp/tsconfig.json @@ -17,7 +17,6 @@ "target": "ES2022", "module": "es2020", "lib": ["es2019", "dom", "dom.iterable"], - "suppressImplicitAnyIndexErrors": true, "ignoreDeprecations": "5.0", "esModuleInterop": true, "typeRoots": ["node_modules/@types"], From a23fb932b8097e5ae906db720967eed1510dfd03 Mon Sep 17 00:00:00 2001 From: MarkS Date: Fri, 29 Aug 2025 15:07:26 -0600 Subject: [PATCH 13/42] await, 'spec' --- .../checking-overview.component.spec.ts | 18 ++++++++++-------- .../serval-projects.component.spec.ts | 1 + .../app/settings/settings.component.spec.ts | 4 ++-- .../share/share-control.component.spec.ts | 2 +- .../share/share-dialog.component.spec.ts | 2 +- .../src/app/shared/text/text.component.spec.ts | 2 +- .../sync-progress.component.spec.ts | 4 ++-- .../src/app/sync/sync.component.spec.ts | 4 ++-- .../biblical-term-dialog.component.spec.ts | 4 ++-- .../training-data.service.spec.ts | 6 +++--- .../editor/translate-metrics-session.spec.ts | 3 ++- 11 files changed, 27 insertions(+), 23 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts index 4b9fefe9ae7..9ba9cbd7262 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts @@ -306,7 +306,9 @@ describe('CheckingOverviewComponent', () => { const env = new TestEnvironment(); const delayPromise = new Promise(resolve => setTimeout(resolve, 10 * 1000)); when(mockedQuestionsService.queryQuestions(anything(), anything(), anything())).thenReturn( - delayPromise.then(() => env.realtimeService.subscribeQuery(QuestionDoc.COLLECTION, {}, noopDestroyRef)) + delayPromise.then( + async () => await env.realtimeService.subscribeQuery(QuestionDoc.COLLECTION, 'spec', {}, noopDestroyRef) + ) ); env.waitForQuestions(); @@ -419,7 +421,7 @@ describe('CheckingOverviewComponent', () => { it('should not display loading if user is offline', fakeAsync(async () => { const env = new TestEnvironment(); - const questionDoc: QuestionDoc = env.realtimeService.get( + const questionDoc: QuestionDoc = await env.realtimeService.get( QuestionDoc.COLLECTION, getQuestionDocId('project01', 'q7Id'), new DocSubscription('spec') @@ -985,11 +987,11 @@ class TestEnvironment { subscriber ) ); - when(mockedQuestionsService.queryQuestions('project01', anything(), anything())).thenCall(() => - this.realtimeService.subscribeQuery(QuestionDoc.COLLECTION, {}, noopDestroyRef) + when(mockedQuestionsService.queryQuestions('project01', anything(), anything())).thenCall( + async () => await this.realtimeService.subscribeQuery(QuestionDoc.COLLECTION, 'spec', {}, noopDestroyRef) ); when(mockedProjectService.onlineDeleteAudioTimingData(anything(), anything(), anything())).thenCall( - (projectId, book, chapter) => { + async (projectId, book, chapter) => { const projectDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, projectId, @@ -1163,7 +1165,7 @@ class TestEnvironment { this.waitForProjectDocChanges(); } - setSeeOtherUserResponses(isEnabled: boolean): void { + async setSeeOtherUserResponses(isEnabled: boolean): Promise { const projectDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, 'project01', @@ -1177,7 +1179,7 @@ class TestEnvironment { } setCheckingEnabled(isEnabled: boolean): void { - this.ngZone.run(() => { + this.ngZone.run(async () => { const projectDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, 'project01', @@ -1232,7 +1234,7 @@ class TestEnvironment { }); } - private addChapterAudio(): void { + private async addChapterAudio(): Promise { const text: TextInfo = { bookNum: 43, hasSource: false, diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-projects.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-projects.component.spec.ts index 7bd2507f94e..7bf5e65e658 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-projects.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/serval-administration/serval-projects.component.spec.ts @@ -131,6 +131,7 @@ class TestEnvironment { return from( this.realtimeService.onlineQuery( TestProjectDoc.COLLECTION, + 'spec', merge(filters, queryParameters) ) ); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/settings/settings.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/settings/settings.component.spec.ts index 585b3ec5d1b..1b1330c2c3b 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/settings/settings.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/settings/settings.component.spec.ts @@ -937,11 +937,11 @@ class TestEnvironment { } ]); - when(mockedSFProjectService.queryAudioText(anything(), anything())).thenCall(sfProjectId => { + when(mockedSFProjectService.queryAudioText(anything(), anything())).thenCall(async sfProjectId => { const queryParams: QueryParameters = { [obj().pathStr(t => t.projectRef)]: sfProjectId }; - return this.realtimeService.subscribeQuery(TextAudioDoc.COLLECTION, queryParams, noopDestroyRef); + return await this.realtimeService.subscribeQuery(TextAudioDoc.COLLECTION, 'spec', queryParams, noopDestroyRef); }); this.fixture = TestBed.createComponent(SettingsComponent); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.spec.ts index a2bd942d1a9..dfbac688776 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-control.component.spec.ts @@ -419,7 +419,7 @@ class TestEnvironment { this.wait(); } - updateCheckingProperties(config: CheckingConfig): Promise { + async updateCheckingProperties(config: CheckingConfig): Promise { const projectDoc: SFProjectProfileDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, 'project01', diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts index 0a61d41af70..d2daec67183 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts @@ -493,7 +493,7 @@ class TestEnvironment { tick(); } - disableCheckingSharing(): void { + async disableCheckingSharing(): Promise { const projectDoc: SFProjectProfileDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, 'project01', diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts index 050fd21efae..cada4bb00cf 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts @@ -1894,7 +1894,7 @@ class TestEnvironment { this.fixture.detectChanges(); } - getUserDoc(userId: string): UserDoc { + async getUserDoc(userId: string): Promise { return await this.realtimeService.get(UserDoc.COLLECTION, userId, new DocSubscription('spec')); } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts index 2a9da213840..2d4751693a7 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts @@ -239,7 +239,7 @@ class TestEnvironment { this.fixture.detectChanges(); } - updateSyncProgress(percentCompleted: number, projectId: string): void { + async updateSyncProgress(percentCompleted: number, projectId: string): Promise { const projectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, projectId, @@ -254,7 +254,7 @@ class TestEnvironment { tick(); } - emitSyncComplete(successful: boolean, projectId: string): void { + async emitSyncComplete(successful: boolean, projectId: string): Promise { this.host.syncProgress['updateProgressState'](projectId, new ProgressState(1)); const projectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts index 1f82f36bd0e..552026b7852 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts @@ -386,7 +386,7 @@ class TestEnvironment { tick(); } - setQueuedCount(projectId: string): void { + async setQueuedCount(projectId: string): Promise { const projectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, projectId, @@ -396,7 +396,7 @@ class TestEnvironment { this.fixture.detectChanges(); } - emitSyncComplete(successful: boolean, projectId: string): void { + async emitSyncComplete(successful: boolean, projectId: string): Promise { const projectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, projectId, diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts index 30dfcdd863f..d991ca6623c 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts @@ -238,11 +238,11 @@ class TestEnvironment { tick(matDialogCloseDelay); } - getBiblicalTermDoc(id: string): BiblicalTermDoc { + async getBiblicalTermDoc(id: string): Promise { return await this.realtimeService.get(BiblicalTermDoc.COLLECTION, id, new DocSubscription('spec')); } - getProjectDoc(id: string): SFProjectProfileDoc { + async getProjectDoc(id: string): Promise { return await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, id, diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/training-data/training-data.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/training-data/training-data.service.spec.ts index 14efabe7f80..fe097771d54 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/training-data/training-data.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/training-data/training-data.service.spec.ts @@ -69,7 +69,7 @@ describe('TrainingDataService', () => { await trainingDataService.createTrainingDataAsync(newTrainingData); tick(); - const trainingDataDoc = realtimeService.get( + const trainingDataDoc = await realtimeService.get( TrainingDataDoc.COLLECTION, getTrainingDataId('project01', 'data03'), new DocSubscription('spec') @@ -79,7 +79,7 @@ describe('TrainingDataService', () => { it('should delete a training data doc', fakeAsync(async () => { // Verify the document exists - const existingTrainingDataDoc = realtimeService.get( + const existingTrainingDataDoc = await realtimeService.get( TrainingDataDoc.COLLECTION, getTrainingDataId('project01', 'data01'), new DocSubscription('spec') @@ -100,7 +100,7 @@ describe('TrainingDataService', () => { await trainingDataService.deleteTrainingDataAsync(trainingDataToDelete); tick(); - const trainingDataDoc = realtimeService.get( + const trainingDataDoc = await realtimeService.get( TrainingDataDoc.COLLECTION, getTrainingDataId('project01', 'data01'), new DocSubscription('spec') diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translate-metrics-session.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translate-metrics-session.spec.ts index 40035e359f6..72fb97b6bd1 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translate-metrics-session.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translate-metrics-session.spec.ts @@ -475,7 +475,8 @@ class TestEnvironment { this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString(), subscriber) ); when(mockedSFProjectService.getProfile(anything(), anything())).thenCall( - (id, subscriber) => await this.realtimeService.get(SFProjectProfileDoc.COLLECTION, id.toString(), subscriber) + async (id, subscriber) => + await this.realtimeService.get(SFProjectProfileDoc.COLLECTION, id.toString(), subscriber) ); when(mockedUserService.getCurrentUser()).thenCall(() => this.realtimeService.subscribe(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')) From 5f752d318d19dbf6139aa84578dd3ebe6a1749e1 Mon Sep 17 00:00:00 2001 From: MarkS Date: Fri, 29 Aug 2025 15:07:38 -0600 Subject: [PATCH 14/42] await, 'spec' --- .../biblical-terms/biblical-terms.component.spec.ts | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts index c1f357e1569..2df39ccb271 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts @@ -471,14 +471,14 @@ class TestEnvironment { const parameters: QueryParameters = { [obj().pathStr(t => t.projectRef)]: sfProjectId }; - return this.realtimeService.subscribeQuery(BiblicalTermDoc.COLLECTION, parameters, noopDestroyRef); + return this.realtimeService.subscribeQuery(BiblicalTermDoc.COLLECTION, 'spec', parameters, noopDestroyRef); }); when(mockedProjectService.queryBiblicalTermNoteThreads(anything(), anything())).thenCall(sfProjectId => { const parameters: QueryParameters = { [obj().pathStr(t => t.projectRef)]: sfProjectId, [obj().pathStr(t => t.biblicalTermId)]: { $ne: null } }; - return this.realtimeService.subscribeQuery(NoteThreadDoc.COLLECTION, parameters, noopDestroyRef); + return this.realtimeService.subscribeQuery(NoteThreadDoc.COLLECTION, 'spec', parameters, noopDestroyRef); }); when(mockedProjectService.getBiblicalTerm(anything(), anything())).thenCall((id, subscriber) => this.realtimeService.subscribe(BiblicalTermDoc.COLLECTION, id, subscriber) @@ -495,7 +495,7 @@ class TestEnvironment { ) ); when(mockedProjectService.getProfile(anything(), anything())).thenCall( - (sfProjectId, subscriber) => + async (sfProjectId, subscriber) => await this.realtimeService.get(SFProjectProfileDoc.COLLECTION, sfProjectId, subscriber) ); when(mockedMatDialog.open(GenericDialogComponent, anything())).thenReturn(instance(this.mockedDialogRef)); @@ -555,7 +555,7 @@ class TestEnvironment { this.fixture.detectChanges(); } - getBiblicalTermDoc(projectId: string, dataId: string): BiblicalTermDoc { + async getBiblicalTermDoc(projectId: string, dataId: string): Promise { return await this.realtimeService.get( BiblicalTermDoc.COLLECTION, getBiblicalTermDocId(projectId, dataId), @@ -563,7 +563,7 @@ class TestEnvironment { ); } - getNoteThreadDoc(projectId: string, threadId: string): NoteThreadDoc { + async getNoteThreadDoc(projectId: string, threadId: string): Promise { return await this.realtimeService.get( NoteThreadDoc.COLLECTION, getNoteThreadDocId(projectId, threadId), @@ -571,7 +571,7 @@ class TestEnvironment { ); } - getProjectUserConfigDoc(projectId: string, userId: string): SFProjectUserConfigDoc { + async getProjectUserConfigDoc(projectId: string, userId: string): Promise { const id: string = getSFProjectUserConfigDocId(projectId, userId); return await this.realtimeService.get( SFProjectUserConfigDoc.COLLECTION, From 0ef431ebaf265c4ab3589cb69dd6684699a18646 Mon Sep 17 00:00:00 2001 From: MarkS Date: Fri, 29 Aug 2025 15:28:30 -0600 Subject: [PATCH 15/42] async --- .../checking/checking.component.spec.ts | 50 +++++++++---------- .../connect-project.component.spec.ts | 4 +- .../src/app/core/text-doc.service.spec.ts | 14 +++--- .../src/app/project/project.component.spec.ts | 5 +- .../app/shared/text/text.component.spec.ts | 4 +- .../biblical-term-dialog.component.spec.ts | 14 +++--- .../biblical-terms.component.spec.ts | 40 ++++++++------- 7 files changed, 67 insertions(+), 64 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts index 677d144c07d..662003aa721 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts @@ -605,7 +605,7 @@ describe('CheckingComponent', () => { flush(1000); })); - it('removes audio player when question audio deleted', fakeAsync(() => { + it('removes audio player when question audio deleted', fakeAsync(async () => { const env = new TestEnvironment({ user: ADMIN_USER, projectBookRoute: 'JHN', @@ -613,7 +613,7 @@ describe('CheckingComponent', () => { questionScope: 'chapter' }); const questionId = 'q15Id'; - const questionDoc = cloneDeep(env.getQuestionDoc(questionId)); + const questionDoc = cloneDeep(await env.getQuestionDoc(questionId)); questionDoc.submitJson0Op(op => { op.unset(qd => qd.audioUrl!); }); @@ -632,7 +632,7 @@ describe('CheckingComponent', () => { flush(1000); })); - it('uploads audio then updates audio url', fakeAsync(() => { + it('uploads audio then updates audio url', fakeAsync(async () => { const env = new TestEnvironment({ user: ADMIN_USER, projectBookRoute: 'JHN', @@ -642,7 +642,7 @@ describe('CheckingComponent', () => { }); env.selectQuestion(14); const questionId = 'q14Id'; - const questionDoc = cloneDeep(env.getQuestionDoc(questionId)); + const questionDoc = cloneDeep(await env.getQuestionDoc(questionId)); expect(env.component.answersPanel?.getFileSource(questionDoc.data?.audioUrl)).toBeUndefined(); questionDoc.submitJson0Op(op => { op.set(qd => qd.audioUrl!, 'anAudioFile.mp3'); @@ -967,7 +967,7 @@ describe('CheckingComponent', () => { flush(1000); })); - it('should reset filtering after a new question is added', fakeAsync(() => { + it('should reset filtering after a new question is added', fakeAsync(async () => { const env = new TestEnvironment({ user: ADMIN_USER, projectBookRoute: 'JHN', @@ -979,7 +979,7 @@ describe('CheckingComponent', () => { expect(env.questions.length).toEqual(1); // Technically this is an existing question returned but the test is to confirm the filter reset - const questionDoc = env.getQuestionDoc('q5Id'); + const questionDoc = await env.getQuestionDoc('q5Id'); when(mockedQuestionDialogService.questionDialog(anything())).thenResolve(questionDoc); env.clickButton(env.addQuestionButton); verify(mockedQuestionDialogService.questionDialog(anything())).once(); @@ -1099,13 +1099,13 @@ describe('CheckingComponent', () => { })); describe('Question Filter', () => { - it('should filter out answered questions - "NoAnswers"', fakeAsync(() => { + it('should filter out answered questions - "NoAnswers"', fakeAsync(async () => { const env = new TestEnvironment({ user: ADMIN_USER }); env.component.activeQuestionFilter = QuestionFilter.NoAnswers; - const questionRemaining = env.getQuestionDoc('q1Id'); + const questionRemaining = await env.getQuestionDoc('q1Id'); const questionExcluded = { data: {}, getAnswers: (_?: string) => { @@ -1594,13 +1594,13 @@ describe('CheckingComponent', () => { discardPeriodicTasks(); })); - it('saves the answer to the correct question when active question changed', fakeAsync(() => { + it('saves the answer to the correct question when active question changed', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); const resolveUpload$: Subject = env.resolveFileUploadSubject('uploadedFile.mp3'); env.selectQuestion(1); env.answerQuestion('Answer with audio', 'audioFile.mp3'); expect(env.answers.length).toEqual(0); - const question = env.getQuestionDoc('q1Id'); + const question = await env.getQuestionDoc('q1Id'); expect(env.saveAnswerButton).not.toBeNull(); env.selectQuestion(2); resolveUpload$.next(); @@ -2255,18 +2255,18 @@ describe('CheckingComponent', () => { })); }); - it('update answer audio cache when activating a question', fakeAsync(() => { + it('update answer audio cache when activating a question', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); - const questionDoc = spy(env.getQuestionDoc('q5Id')); + const questionDoc = spy(await env.getQuestionDoc('q5Id')); verify(questionDoc!.updateAnswerFileCache()).never(); env.selectQuestion(5); verify(questionDoc!.updateAnswerFileCache()).once(); expect().nothing(); })); - it('update answer audio cache after save', fakeAsync(() => { + it('update answer audio cache after save', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); - const questionDoc = spy(env.getQuestionDoc('q6Id')); + const questionDoc = spy(await env.getQuestionDoc('q6Id')); env.selectQuestion(6); env.clickButton(env.getAnswerEditButton(0)); env.waitForSliderUpdate(); @@ -2278,9 +2278,9 @@ describe('CheckingComponent', () => { flush(1000); })); - it('update answer audio cache on remote update to question', fakeAsync(() => { + it('update answer audio cache on remote update to question', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); - const questionDoc = spy(env.getQuestionDoc('q6Id')); + const questionDoc = spy(await env.getQuestionDoc('q6Id')); env.selectQuestion(6); verify(questionDoc!.updateAnswerFileCache()).times(1); env.simulateRemoteEditAnswer(0, 'Question 6 edited answer'); @@ -2290,9 +2290,9 @@ describe('CheckingComponent', () => { flush(1000); })); - it('update answer audio cache on remote removal of an answer', fakeAsync(() => { + it('update answer audio cache on remote removal of an answer', fakeAsync(async () => { const env = new TestEnvironment({ user: ADMIN_USER }); - const questionDoc = spy(env.getQuestionDoc('q6Id')); + const questionDoc = spy(await env.getQuestionDoc('q6Id')); env.selectQuestion(6); verify(questionDoc!.updateAnswerFileCache()).times(1); env.simulateRemoteDeleteAnswer('q6Id', 0); @@ -3165,8 +3165,8 @@ class TestEnvironment { }); } - activateQuestion(dataId: string): void { - const questionDoc = this.getQuestionDoc(dataId); + async activateQuestion(dataId: string): Promise { + const questionDoc = await this.getQuestionDoc(dataId); this.ngZone.run(() => this.component.questionsList!.activateQuestion(questionDoc)); tick(); this.waitForQuestionTimersToComplete(); @@ -3323,7 +3323,7 @@ class TestEnvironment { return this.getAnswerComments(answerIndex)[commentIndex].query(By.css('.comment-edit')); } - getQuestionDoc(dataId: string): QuestionDoc { + async getQuestionDoc(dataId: string): Promise { return await this.realtimeService.get( QuestionDoc.COLLECTION, getQuestionDocId('project01', dataId), @@ -3519,9 +3519,9 @@ class TestEnvironment { tick(); } - simulateRemoteEditQuestionAudio(filename?: string, questionId?: string): void { + async simulateRemoteEditQuestionAudio(filename?: string, questionId?: string): Promise { const questionDoc = - questionId != null ? this.getQuestionDoc(questionId) : this.component.questionsList!.activeQuestionDoc!; + questionId != null ? await this.getQuestionDoc(questionId) : this.component.questionsList!.activeQuestionDoc!; questionDoc.submitJson0Op(op => { if (filename != null) { op.set(q => q.audioUrl!, filename); @@ -3533,8 +3533,8 @@ class TestEnvironment { this.fixture.detectChanges(); } - simulateRemoteDeleteAnswer(questionId: string, answerIndex: number): void { - const questionDoc = this.getQuestionDoc(questionId); + async simulateRemoteDeleteAnswer(questionId: string, answerIndex: number): Promise { + const questionDoc = await this.getQuestionDoc(questionId); questionDoc.submitJson0Op(op => op.set(q => q.answers[answerIndex].deleted, true), false); tick(this.questionReadTimer); this.fixture.detectChanges(); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts index 7fccdde2ba8..4707271c739 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts @@ -484,7 +484,7 @@ class TestEnvironment { return element.nativeElement.querySelector('input') as HTMLInputElement; } - setQueuedCount(): void { + async setQueuedCount(): Promise { const projectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, 'project01', @@ -495,7 +495,7 @@ class TestEnvironment { this.fixture.detectChanges(); } - emitSyncComplete(): void { + async emitSyncComplete(): Promise { const projectDoc = await this.realtimeService.get( SFProjectDoc.COLLECTION, 'project01', diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.spec.ts index cce03a15be1..d80b190ddcf 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.spec.ts @@ -30,19 +30,19 @@ describe('TextDocService', () => { ] })); - it('should overwrite text doc', fakeAsync(() => { + it('should overwrite text doc', fakeAsync(async () => { const env = new TestEnvironment(); const newDelta: Delta = getCombinedVerseTextDoc(env.textDocId) as Delta; env.textDocService.overwrite(env.textDocId, newDelta, 'Editor'); tick(); - expect(env.getTextDoc(env.textDocId).data?.ops).toEqual(newDelta.ops); + expect((await env.getTextDoc(env.textDocId)).data?.ops).toEqual(newDelta.ops); })); - it('should emit diff', fakeAsync(() => { + it('should emit diff', fakeAsync(async () => { const env = new TestEnvironment(); - const origDelta: Delta = env.getTextDoc(env.textDocId).data as Delta; + const origDelta: Delta = (await env.getTextDoc(env.textDocId)).data as Delta; const newDelta: Delta = getPoetryVerseTextDoc(env.textDocId) as Delta; const diff: Delta = origDelta.diff(newDelta); @@ -54,11 +54,11 @@ describe('TextDocService', () => { tick(); })); - it('should submit the source', fakeAsync(() => { + it('should submit the source', fakeAsync(async () => { const env = new TestEnvironment(); const newDelta: Delta = getPoetryVerseTextDoc(env.textDocId) as Delta; - const textDoc = env.getTextDoc(env.textDocId); + const textDoc = await env.getTextDoc(env.textDocId); textDoc.adapter.changes$.subscribe(() => { // overwrite() resets submitSource to false, so we check it when the op is submitted expect(textDoc.adapter.submitSource).toBe(true); @@ -470,7 +470,7 @@ class TestEnvironment { when(mockUserService.currentUserId).thenReturn('user01'); } - getTextDoc(textId: TextDocId): TextDoc { + async getTextDoc(textId: TextDocId): Promise { return await this.realtimeService.get(TextDoc.COLLECTION, textId.toString(), new DocSubscription('spec')); } } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.spec.ts index 5e840a38d5b..9b6569cf843 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/project/project.component.spec.ts @@ -1,6 +1,6 @@ import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'; import { provideHttpClientTesting } from '@angular/common/http/testing'; -import { ComponentFixture, fakeAsync, TestBed, tick } from '@angular/core/testing'; +import { ComponentFixture, fakeAsync, flushMicrotasks, TestBed, tick } from '@angular/core/testing'; import { ActivatedRoute, ActivatedRouteSnapshot, Router } from '@angular/router'; import { TranslocoService } from '@ngneat/transloco'; import { User } from 'realtime-server/lib/esm/common/models/user'; @@ -176,6 +176,7 @@ describe('ProjectComponent', () => { verify(mockedRouter.navigate(anything(), anything())).never(); env.addUserToProject(1); + flushMicrotasks(); verify(mockedRouter.navigate(deepEqual(['projects', 'project1', 'translate', 'MAT']), anything())).once(); expect().nothing(); })); @@ -275,7 +276,7 @@ class TestEnvironment { }); } - addUserToProject(projectIdSuffix: number): void { + async addUserToProject(projectIdSuffix: number): Promise { this.setProjectData({ memberProjectIdSuffixes: [projectIdSuffix] }); const userDoc: UserDoc = await this.realtimeService.get(UserDoc.COLLECTION, 'user01', new DocSubscription('spec')); userDoc.submitJson0Op(op => op.set(u => u.sites, { sf: { projects: [`project${projectIdSuffix}`] } }), false); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts index cada4bb00cf..494cdb921e2 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.spec.ts @@ -753,14 +753,14 @@ describe('TextComponent', () => { expect(presenceChannelReceiveSpy).toHaveBeenCalledTimes(1); })); - it('should update presence if the user data changes', fakeAsync(() => { + it('should update presence if the user data changes', fakeAsync(async () => { const updatedAvatarUrl: string = 'https://example.com/avatar-updated.png'; const env: TestEnvironment = new TestEnvironment(); env.fixture.detectChanges(); env.id = new TextDocId('project01', 40, 1); env.waitForEditor(); const presenceChannelSubmit = spyOn(env.localPresenceChannel, 'submit'); - const userDoc: UserDoc = env.getUserDoc('user01'); + const userDoc: UserDoc = await env.getUserDoc('user01'); expect(userDoc.data?.avatarUrl).not.toEqual(updatedAvatarUrl); userDoc.submitJson0Op(op => op.set(u => u.avatarUrl, updatedAvatarUrl)); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts index d991ca6623c..88c6c77f9cf 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts @@ -115,7 +115,7 @@ describe('BiblicalTermDialogComponent', () => { env.closeDialog(); })); - it('should save changes to the biblical term', fakeAsync(() => { + it('should save changes to the biblical term', fakeAsync(async () => { const env = new TestEnvironment(); env.setupProjectData('en'); env.wait(); @@ -125,12 +125,12 @@ describe('BiblicalTermDialogComponent', () => { env.setTextFieldValue(env.description, 'updatedDescription'); env.click(env.submitButton); env.wait(); - const biblicalTerm = env.getBiblicalTermDoc('id01'); + const biblicalTerm = await env.getBiblicalTermDoc('id01'); expect(biblicalTerm.data?.renderings).toEqual(['updatedRendering', 'secondRendering', 'thirdRendering']); expect(biblicalTerm.data?.description).toBe('updatedDescription'); })); - it('should remove empty lines from renderings', fakeAsync(() => { + it('should remove empty lines from renderings', fakeAsync(async () => { const env = new TestEnvironment(); env.setupProjectData('en'); env.wait(); @@ -140,7 +140,7 @@ describe('BiblicalTermDialogComponent', () => { env.setTextFieldValue(env.description, ''); env.click(env.submitButton); env.wait(); - const biblicalTerm = env.getBiblicalTermDoc('id01'); + const biblicalTerm = await env.getBiblicalTermDoc('id01'); expect(biblicalTerm.data?.renderings).toEqual([]); expect(biblicalTerm.data?.description).toBe(''); })); @@ -257,9 +257,9 @@ class TestEnvironment { getSFProjectUserConfigDocId('project01', userId), new DocSubscription('spec') ) - .then(projectUserConfigDoc => { - const biblicalTermDoc = this.getBiblicalTermDoc(biblicalTermId); - const projectDoc = this.getProjectDoc('project01'); + .then(async projectUserConfigDoc => { + const biblicalTermDoc = await this.getBiblicalTermDoc(biblicalTermId); + const projectDoc = await this.getProjectDoc('project01'); const viewContainerRef = this.fixture.componentInstance.childViewContainer; const config: MatDialogConfig = { data: { biblicalTermDoc, projectDoc, projectUserConfigDoc }, diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts index 2df39ccb271..9f2ade6028f 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-terms.component.spec.ts @@ -128,7 +128,7 @@ describe('BiblicalTermsComponent', () => { expect((env.biblicalTermsCategory[0] as HTMLElement).innerText).toBe('category03_en'); })); - it('should filter biblical terms by category', fakeAsync(() => { + it('should filter biblical terms by category', fakeAsync(async () => { const env = new TestEnvironment('project01', 1, 1, '1'); env.setupProjectData('en'); env.wait(); @@ -139,12 +139,12 @@ describe('BiblicalTermsComponent', () => { expect(env.biblicalTermsTerm.length).toBe(1); expect((env.biblicalTermsTerm[0] as HTMLElement).innerText).toBe('termId04'); expect((env.biblicalTermsCategory[0] as HTMLElement).innerText).toBe('category04_en'); - const projectUserConfig = env.getProjectUserConfigDoc('project01', 'user01').data; + const projectUserConfig = (await env.getProjectUserConfigDoc('project01', 'user01')).data; expect(projectUserConfig?.selectedBiblicalTermsFilter).toBe('current_book'); expect(projectUserConfig?.selectedBiblicalTermsCategory).toBe('category04_en'); })); - it('should filter biblical terms by book', fakeAsync(() => { + it('should filter biblical terms by book', fakeAsync(async () => { const env = new TestEnvironment('project01', 1, 1, '1'); env.setupProjectData('en'); env.wait(); @@ -157,10 +157,12 @@ describe('BiblicalTermsComponent', () => { expect((env.biblicalTermsCategory[1] as HTMLElement).innerText).toBe('category04_en'); expect((env.biblicalTermsTerm[2] as HTMLElement).innerText).toBe('termId05'); expect((env.biblicalTermsCategory[2] as HTMLElement).innerText).toBe('category05_en'); - expect(env.getProjectUserConfigDoc('project01', 'user01').data?.selectedBiblicalTermsFilter).toBe('current_book'); + expect((await env.getProjectUserConfigDoc('project01', 'user01')).data?.selectedBiblicalTermsFilter).toBe( + 'current_book' + ); })); - it('should filter biblical terms by chapter', fakeAsync(() => { + it('should filter biblical terms by chapter', fakeAsync(async () => { const env = new TestEnvironment('project01', 1, 1, '1'); env.setupProjectData('en'); env.wait(); @@ -171,7 +173,7 @@ describe('BiblicalTermsComponent', () => { expect((env.biblicalTermsCategory[0] as HTMLElement).innerText).toBe('category01_en'); expect((env.biblicalTermsTerm[1] as HTMLElement).innerText).toBe('termId04'); expect((env.biblicalTermsCategory[1] as HTMLElement).innerText).toBe('category04_en'); - expect(env.getProjectUserConfigDoc('project01', 'user01').data?.selectedBiblicalTermsFilter).toBe( + expect((await env.getProjectUserConfigDoc('project01', 'user01')).data?.selectedBiblicalTermsFilter).toBe( 'current_chapter' ); })); @@ -298,7 +300,7 @@ describe('BiblicalTermsComponent', () => { expect((env.biblicalTermsTerm[0] as HTMLElement).innerText).toBe('transliteration01'); })); - it('can save a new note thread for a biblical term', fakeAsync(() => { + it('can save a new note thread for a biblical term', fakeAsync(async () => { const projectId = 'project01'; const env = new TestEnvironment(projectId, 2, 2, '2'); env.setupProjectData('en'); @@ -316,7 +318,7 @@ describe('BiblicalTermsComponent', () => { const biblicalTermId: string = (config as MatDialogConfig).data!.biblicalTermId; expect(biblicalTermId.toString()).toEqual('dataId02'); - const biblicalTerm = env.getBiblicalTermDoc(projectId, biblicalTermId); + const biblicalTerm = await env.getBiblicalTermDoc(projectId, biblicalTermId); const verseData: VerseRefData = fromVerseRef(new VerseRef(biblicalTerm.data!.references[0])); verify(mockedProjectService.createNoteThread(projectId, anything(), anything())).once(); const [, noteThread] = capture(mockedProjectService.createNoteThread).last(); @@ -326,11 +328,11 @@ describe('BiblicalTermsComponent', () => { expect(noteThread.notes[0].ownerRef).toEqual('user01'); expect(noteThread.notes[0].content).toEqual(XmlUtils.encodeForXml(noteContent)); expect(noteThread.notes[0].tagId).toEqual(BIBLICAL_TERM_TAG_ID); - const projectUserConfigDoc: SFProjectUserConfigDoc = env.getProjectUserConfigDoc('project01', 'user01'); + const projectUserConfigDoc: SFProjectUserConfigDoc = await env.getProjectUserConfigDoc('project01', 'user01'); expect(projectUserConfigDoc.data!.noteRefsRead).not.toContain(noteThread.notes[0].dataId); })); - it('can save a note for an existing biblical term', fakeAsync(() => { + it('can save a note for an existing biblical term', fakeAsync(async () => { const projectId = 'project01'; const noteDataId = 'dataId01'; const env = new TestEnvironment(projectId, 1, 1); @@ -349,20 +351,20 @@ describe('BiblicalTermsComponent', () => { const biblicalTermId: string = (config as MatDialogConfig).data!.biblicalTermId; expect(biblicalTermId.toString()).toEqual(noteDataId); - const biblicalTerm = env.getBiblicalTermDoc(projectId, biblicalTermId); + const biblicalTerm = await env.getBiblicalTermDoc(projectId, biblicalTermId); const verseData: VerseRefData = fromVerseRef(new VerseRef(biblicalTerm.data!.references[0])); - const noteThread = env.getNoteThreadDoc(projectId, 'threadId01').data!; + const noteThread = (await env.getNoteThreadDoc(projectId, 'threadId01')).data!; expect(noteThread.verseRef).toEqual(verseData); expect(noteThread.originalSelectedText).toEqual(''); expect(noteThread.publishedToSF).toBe(true); expect(noteThread.notes[1].ownerRef).toEqual('user01'); expect(noteThread.notes[1].content).toEqual(noteContent); expect(noteThread.notes[1].tagId).toEqual(BIBLICAL_TERM_TAG_ID); - const projectUserConfigDoc: SFProjectUserConfigDoc = env.getProjectUserConfigDoc('project01', 'user01'); + const projectUserConfigDoc: SFProjectUserConfigDoc = await env.getProjectUserConfigDoc('project01', 'user01'); expect(projectUserConfigDoc.data!.noteRefsRead).toContain(noteThread.notes[1].dataId); })); - it('can resolve a note for a biblical term', fakeAsync(() => { + it('can resolve a note for a biblical term', fakeAsync(async () => { const projectId = 'project01'; const env = new TestEnvironment(projectId, 1, 1); env.setupProjectData('en'); @@ -375,7 +377,7 @@ describe('BiblicalTermsComponent', () => { env.wait(); verify(mockedMatDialog.open(NoteDialogComponent, anything())).once(); - const noteThread: NoteThread = env.getNoteThreadDoc(projectId, 'threadId01').data!; + const noteThread: NoteThread = (await env.getNoteThreadDoc(projectId, 'threadId01')).data!; expect(noteThread.status).toBe(NoteStatus.Resolved); expect(noteThread.notes[1].content).toBeUndefined(); expect(noteThread.notes[1].status).toBe(NoteStatus.Resolved); @@ -389,7 +391,7 @@ describe('BiblicalTermsComponent', () => { env.wait(); // Make the note editable - const noteThreadDoc: NoteThreadDoc = env.getNoteThreadDoc(projectId, 'threadId01'); + const noteThreadDoc: NoteThreadDoc = await env.getNoteThreadDoc(projectId, 'threadId01'); await noteThreadDoc.submitJson0Op(op => op.set(nt => nt.notes[0].editable, true)); // SUT @@ -399,13 +401,13 @@ describe('BiblicalTermsComponent', () => { env.wait(); verify(mockedMatDialog.open(NoteDialogComponent, anything())).once(); - const noteThread: NoteThread = env.getNoteThreadDoc(projectId, 'threadId01').data!; + const noteThread: NoteThread = (await env.getNoteThreadDoc(projectId, 'threadId01')).data!; expect(noteThread.status).toBe(NoteStatus.Resolved); expect(noteThread.notes[0].content).toBe(newContent); expect(noteThread.notes[0].status).toBe(NoteStatus.Resolved); })); - it('cannot resolve a non-editable note for a biblical term', fakeAsync(() => { + it('cannot resolve a non-editable note for a biblical term', fakeAsync(async () => { const projectId = 'project01'; const env = new TestEnvironment(projectId, 1, 1); env.setupProjectData('en'); @@ -421,7 +423,7 @@ describe('BiblicalTermsComponent', () => { env.wait(); verify(mockedMatDialog.open(NoteDialogComponent, anything())).once(); - const noteThread: NoteThread = env.getNoteThreadDoc(projectId, 'threadId01').data!; + const noteThread: NoteThread = (await env.getNoteThreadDoc(projectId, 'threadId01')).data!; expect(noteThread.status).toEqual(NoteStatus.Todo); expect(noteThread.notes.length).toBe(1); expect(dialogMessage).toHaveBeenCalledTimes(1); From 61ee224b6539d967ddcd8dfde5bfa612ac127bb2 Mon Sep 17 00:00:00 2001 From: MarkS Date: Fri, 29 Aug 2025 16:21:19 -0600 Subject: [PATCH 16/42] await --- .../question-dialog/question-dialog.service.spec.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts index 4dc21b824a7..1d597677326 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts @@ -110,7 +110,7 @@ describe('QuestionDialogService', () => { audio: {} }; when(env.mockedDialogRef.afterClosed()).thenReturn(of(result)); - const questionDoc = env.addQuestion(env.getNewQuestion()); + const questionDoc = await env.addQuestion(env.getNewQuestion()); expect(questionDoc!.data!.text).toBe('question to be edited'); await env.service.questionDialog(env.getQuestionDialogData(questionDoc)); expect(questionDoc!.data!.text).toBe('question edited'); @@ -136,7 +136,7 @@ describe('QuestionDialogService', () => { anything() ) ).thenResolve(undefined); - const questionDoc = env.addQuestion(env.getNewQuestion()); + const questionDoc = await env.addQuestion(env.getNewQuestion()); const editedQuestion = await env.service.questionDialog(env.getQuestionDialogData(questionDoc)); expect(editedQuestion).toBeUndefined(); }); @@ -150,7 +150,7 @@ describe('QuestionDialogService', () => { }; when(env.mockedDialogRef.afterClosed()).thenReturn(of(result)); const audioUrl = 'anAudioFile.mp3'; - const questionDoc = env.addQuestion(env.getNewQuestion(audioUrl)); + const questionDoc = await env.addQuestion(env.getNewQuestion(audioUrl)); expect(questionDoc!.data!.audioUrl).toBe(audioUrl); await env.service.questionDialog(env.getQuestionDialogData(questionDoc)); expect(questionDoc!.data!.audioUrl).toBeUndefined(); @@ -211,7 +211,7 @@ class TestEnvironment { ); } - addQuestion(question: Question): QuestionDoc { + async addQuestion(question: Question): Promise { this.realtimeService.addSnapshot(QUESTIONS_COLLECTION, { id: getQuestionDocId(this.PROJECT01, question.dataId), data: question @@ -248,7 +248,7 @@ class TestEnvironment { }; } - updateUserRole(role: string): void { + async updateUserRole(role: string): Promise { const projectProfileDoc = await this.realtimeService.get( SFProjectProfileDoc.COLLECTION, this.PROJECT01, From f58daf865c8de3b63a172f79a961048647fe38bb Mon Sep 17 00:00:00 2001 From: MarkS Date: Tue, 9 Sep 2025 16:13:18 -0600 Subject: [PATCH 17/42] question-dialog specs: await --- .../question-dialog.component.spec.ts | 122 ++++++++++++------ .../question-dialog.service.spec.ts | 23 +++- 2 files changed, 100 insertions(+), 45 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts index ef04e3509d5..2204ffca397 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts @@ -91,22 +91,25 @@ describe('QuestionDialogComponent', () => { flush(); })); - it('should allow user to cancel', fakeAsync(() => { + it('should allow user to cancel', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); env.clickElement(env.cancelButton); flush(); expect(env.afterCloseCallback).toHaveBeenCalledWith('close'); })); - it('should not allow Save without required fields', fakeAsync(() => { + it('should not allow Save without required fields', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); env.clickElement(env.saveButton); flush(); expect(env.afterCloseCallback).not.toHaveBeenCalled(); })); - it('should show error text for required fields', fakeAsync(() => { + it('should show error text for required fields', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); expect(env.errorText[0].classes['visible']).not.toBeDefined(); env.component.scriptureStart.markAsTouched(); @@ -119,8 +122,9 @@ describe('QuestionDialogComponent', () => { expect(env.errorText[0].classes['visible']).toBe(true); })); - it('does not accept just whitespace for a question', fakeAsync(() => { + it('does not accept just whitespace for a question', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); env.inputValue(env.questionInput, ''); @@ -139,8 +143,9 @@ describe('QuestionDialogComponent', () => { expect(env.component.textAndAudio?.text.errors!.invalid).toBeDefined(); })); - it('should validate verse fields', fakeAsync(() => { + it('should validate verse fields', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); expect(env.component.versesForm.valid).toBe(false); expect(env.component.scriptureStart.valid).toBe(false); @@ -179,8 +184,9 @@ describe('QuestionDialogComponent', () => { expect(env.component.scriptureEnd.errors!.verseRange).toBe(true); })); - it('should produce error', fakeAsync(() => { + it('should produce error', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); const invalidVerses = [ 'MAT 1', @@ -206,16 +212,18 @@ describe('QuestionDialogComponent', () => { } })); - it('should set default verse and text direction when provided', fakeAsync(() => { + it('should set default verse and text direction when provided', fakeAsync(async () => { const verseRef: VerseRef = new VerseRef('LUK 1:1'); - env = new TestEnvironment(undefined, verseRef, true); + env = new TestEnvironment(); + await env.init(undefined, verseRef, true); flush(); expect(env.component.scriptureStart.value).toBe('LUK 1:1'); expect(env.component.isTextRightToLeft).toBe(true); })); - it('should validate matching book and chapter', fakeAsync(() => { + it('should validate matching book and chapter', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); env.component.scriptureStart.setValue('MAT 1:2'); expect(env.component.scriptureStart.valid).toBe(true); @@ -234,8 +242,9 @@ describe('QuestionDialogComponent', () => { expect(env.component.versesForm.errors).toBeNull(); })); - it('should validate start verse is before or same as end verse', fakeAsync(() => { + it('should validate start verse is before or same as end verse', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); env.component.scriptureStart.setValue('MAT 1:2'); expect(env.component.scriptureStart.valid).toBe(true); @@ -254,8 +263,9 @@ describe('QuestionDialogComponent', () => { expect(env.component.versesForm.errors).toBeNull(); })); - it('opens reference chooser, uses result', fakeAsync(() => { + it('opens reference chooser, uses result', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); env.component.scriptureStart.setValue('MAT 3:4'); expect(env.component.scriptureStart.value).not.toEqual('LUK 1:2'); @@ -270,8 +280,9 @@ describe('QuestionDialogComponent', () => { })); // Needed for validation error messages to appear - it('control marked as touched+dirty after reference chooser', fakeAsync(() => { + it('control marked as touched+dirty after reference chooser', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); // scriptureStart control starts off untouched+undirty and changes env.component.scriptureStart.setValue('MAT 3:4'); @@ -294,8 +305,9 @@ describe('QuestionDialogComponent', () => { expect(env.component.scriptureEnd.dirty).toBe(true); })); - it('control marked as touched after reference chooser closed', fakeAsync(() => { + it('control marked as touched after reference chooser closed', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); when(env.mockedScriptureChooserMatDialogRef.afterOpened()).thenReturn(of()); when(env.mockedScriptureChooserMatDialogRef.afterClosed()).thenReturn(of('close')); flush(); @@ -310,8 +322,9 @@ describe('QuestionDialogComponent', () => { expect(env.component.scriptureStart.dirty).toBe(false); })); - it('passes start reference to end-reference chooser', fakeAsync(() => { + it('passes start reference to end-reference chooser', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); expect(env.component.scriptureEnd.enabled).toBe(false); env.component.scriptureStart.setValue('LUK 1:1'); @@ -333,8 +346,9 @@ describe('QuestionDialogComponent', () => { expect(env.component.scriptureEnd.value).toEqual('LUK 1:2'); })); - it('does not pass start reference as range start when opening start-reference chooser', fakeAsync(() => { + it('does not pass start reference as range start when opening start-reference chooser', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); env.component.scriptureStart.setValue('LUK 1:1'); @@ -351,8 +365,9 @@ describe('QuestionDialogComponent', () => { expect(env.component.scriptureStart.value).toEqual('LUK 1:2'); })); - it('disables end-reference if start-reference is invalid', fakeAsync(() => { + it('disables end-reference if start-reference is invalid', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); tick(EDITOR_READY_TIMEOUT); env.inputValue(env.scriptureStartInput, 'LUK 1:1'); @@ -364,16 +379,18 @@ describe('QuestionDialogComponent', () => { expect(env.component.scriptureEnd.disabled).toBe(false); })); - it('does not enable end-reference until start-reference is changed', fakeAsync(() => { + it('does not enable end-reference until start-reference is changed', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); expect(env.component.scriptureEnd.disabled).toBe(true); env.inputValue(env.scriptureStartInput, 'LUK 1:1'); expect(env.component.scriptureEnd.disabled).toBe(false); })); - it('allows a question without text if audio is provided', fakeAsync(() => { + it('allows a question without text if audio is provided', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); env.inputValue(env.questionInput, ''); env.clickElement(env.saveButton); @@ -390,8 +407,9 @@ describe('QuestionDialogComponent', () => { expect(env.component.textAndAudio?.text.errors!.invalid).not.toBeNull(); })); - it('should not save with no text and audio permission is denied', fakeAsync(() => { + it('should not save with no text and audio permission is denied', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); env.inputValue(env.questionInput, ''); env.clickElement(env.saveButton); @@ -403,8 +421,9 @@ describe('QuestionDialogComponent', () => { expect(env.component.textAndAudio?.text.errors!.invalid).not.toBeNull(); })); - it('display quill editor', fakeAsync(() => { + it('display quill editor', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); expect(env.quillEditor).not.toBeNull(); expect(env.component.textDocId).toBeUndefined(); @@ -419,8 +438,9 @@ describe('QuestionDialogComponent', () => { expect(env.isSegmentHighlighted('2')).toBe(false); })); - it('retrieves scripture text on editing a question', fakeAsync(() => { - env = new TestEnvironment({ + it('retrieves scripture text on editing a question', fakeAsync(async () => { + env = new TestEnvironment(); + await env.init({ dataId: 'question01', ownerRef: 'user01', projectRef: 'project01', @@ -442,8 +462,9 @@ describe('QuestionDialogComponent', () => { expect(env.component.textAndAudio?.input?.audioUrl).toBeDefined(); })); - it('displays error editing end reference to different book', fakeAsync(() => { - env = new TestEnvironment({ + it('displays error editing end reference to different book', fakeAsync(async () => { + env = new TestEnvironment(); + await env.init({ dataId: 'question01', ownerRef: 'user01', projectRef: 'project01', @@ -466,8 +487,9 @@ describe('QuestionDialogComponent', () => { expect(env.scriptureEndValidationMsg.textContent).toContain('Must be the same book and chapter'); })); - it('displays error editing start reference to a different book', fakeAsync(() => { - env = new TestEnvironment({ + it('displays error editing start reference to a different book', fakeAsync(async () => { + env = new TestEnvironment(); + await env.init({ dataId: 'question01', ownerRef: 'user01', projectRef: 'project01', @@ -487,8 +509,9 @@ describe('QuestionDialogComponent', () => { expect(env.scriptureEndValidationMsg.textContent).toContain('Must be the same book and chapter'); })); - it('generate correct verse ref when start and end mismatch only by case or insignificant zero', fakeAsync(() => { + it('generate correct verse ref when start and end mismatch only by case or insignificant zero', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); env.component.scriptureStart.setValue('LUK 1:1'); env.component.scriptureEnd.setValue('luk 1:1'); @@ -501,8 +524,9 @@ describe('QuestionDialogComponent', () => { expect(env.component.selection!.toString()).toEqual('LUK 1:1'); })); - it('should handle invalid start reference when end reference exists', fakeAsync(() => { + it('should handle invalid start reference when end reference exists', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); env.component.scriptureStart.setValue('nonsense'); env.component.scriptureEnd.setValue('LUK 1:1'); @@ -511,8 +535,9 @@ describe('QuestionDialogComponent', () => { }).not.toThrow(); })); - it('should not highlight range if chapter or book differ', fakeAsync(() => { + it('should not highlight range if chapter or book differ', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); env.component.scriptureStart.setValue('MAT 1:1'); env.component.scriptureEnd.setValue('LUK 1:2'); @@ -522,8 +547,9 @@ describe('QuestionDialogComponent', () => { expect(env.isSegmentHighlighted('1')).toBe(false); })); - it('should clear highlight when starting ref is cleared', fakeAsync(() => { + it('should clear highlight when starting ref is cleared', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); env.component.scriptureStart.setValue('LUK 1:1'); tick(500); @@ -548,8 +574,9 @@ describe('QuestionDialogComponent', () => { expect(env.isSegmentHighlighted('1')).toBe(true); })); - it('should clear highlight when end ref is invalid', fakeAsync(() => { + it('should clear highlight when end ref is invalid', fakeAsync(async () => { env = new TestEnvironment(); + await env.init(); flush(); env.component.scriptureStart.setValue('LUK 1:1'); env.component.scriptureEnd.setValue('LUK 1:2'); @@ -585,18 +612,21 @@ describe('QuestionDialogComponent', () => { class DialogTestModule {} class TestEnvironment { - readonly fixture: ComponentFixture; - readonly component: QuestionDialogComponent; - readonly dialogRef: MatDialogRef; - readonly afterCloseCallback: jasmine.Spy; - readonly dialogServiceSpy: DialogService; + fixture: ComponentFixture; + _component: QuestionDialogComponent | undefined; + dialogRef: MatDialogRef | undefined; + afterCloseCallback: jasmine.Spy | undefined; + _dialogServiceSpy: DialogService | undefined; readonly mockedScriptureChooserMatDialogRef = mock(MatDialogRef); private readonly realtimeService: TestRealtimeService = TestBed.inject(TestRealtimeService); - constructor(question?: Question, defaultVerseRef?: VerseRef, isRtl: boolean = false) { + constructor() { this.fixture = TestBed.createComponent(ChildViewContainerComponent); + } + + async init(question?: Question, defaultVerseRef?: VerseRef, isRtl: boolean = false): Promise { const viewContainerRef = this.fixture.componentInstance.childViewContainer; let questionDoc: QuestionDoc | undefined; if (question != null) { @@ -669,10 +699,10 @@ class TestEnvironment { this.dialogRef = TestBed.inject(MatDialog).open(QuestionDialogComponent, config); this.afterCloseCallback = jasmine.createSpy('afterClose callback'); this.dialogRef.afterClosed().subscribe(this.afterCloseCallback); - this.component = this.dialogRef.componentInstance; + this._component = this.dialogRef.componentInstance; // Set up dialog mocking after it's already used above (without mocking) in creating the component. - this.dialogServiceSpy = spy(this.component.dialogService); + this._dialogServiceSpy = spy(this.component.dialogService); when(this.dialogServiceSpy.openMatDialog(anything(), anything())).thenReturn( instance(this.mockedScriptureChooserMatDialogRef) ); @@ -696,6 +726,20 @@ class TestEnvironment { this.fixture.detectChanges(); } + get component(): QuestionDialogComponent { + if (this._component == null) { + throw new Error('Uninitialized'); + } + return this._component; + } + + get dialogServiceSpy(): DialogService { + if (this._dialogServiceSpy == null) { + throw new Error('Uninitialized'); + } + return this._dialogServiceSpy; + } + get overlayContainerElement(): HTMLElement { return this.fixture.nativeElement.parentElement.querySelector('.cdk-overlay-container'); } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts index 1d597677326..5bace6330ee 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.service.spec.ts @@ -53,6 +53,7 @@ describe('QuestionDialogService', () => { it('should add a question', async () => { const env = new TestEnvironment(); + await env.init(); const result: QuestionDialogResult = { text: 'question added', verseRef: new VerseRef('MAT 1:3'), @@ -66,6 +67,7 @@ describe('QuestionDialogService', () => { it('should not add a question if cancelled', async () => { const env = new TestEnvironment(); + await env.init(); when(env.mockedDialogRef.afterClosed()).thenReturn(of('close')); await env.service.questionDialog(env.getQuestionDialogData()); verify(mockedQuestionsService.createQuestion(env.PROJECT01, anything(), anything())).never(); @@ -74,6 +76,7 @@ describe('QuestionDialogService', () => { it('should not create question if user does not have permission', async () => { const env = new TestEnvironment(); + await env.init(); const result: QuestionDialogResult = { text: 'This question is added just as user role is changed', verseRef: new VerseRef('MAT 1:3'), @@ -89,6 +92,7 @@ describe('QuestionDialogService', () => { it('uploads audio when provided', async () => { const env = new TestEnvironment(); + await env.init(); const result: QuestionDialogResult = { text: 'question added', verseRef: new VerseRef('MAT 1:3'), @@ -104,6 +108,7 @@ describe('QuestionDialogService', () => { it('edits a question', async () => { const env = new TestEnvironment(); + await env.init(); const result: QuestionDialogResult = { text: 'question edited', verseRef: new VerseRef('MAT 1:3'), @@ -118,6 +123,7 @@ describe('QuestionDialogService', () => { it('discards changes if failed to upload or store the audio', async () => { const env = new TestEnvironment(); + await env.init(); const result: QuestionDialogResult = { text: 'question added', verseRef: new VerseRef('MAT 1:3'), @@ -143,6 +149,7 @@ describe('QuestionDialogService', () => { it('removes audio if audio deleted', async () => { const env = new TestEnvironment(); + await env.init(); const result: QuestionDialogResult = { text: 'question edited', verseRef: new VerseRef('MAT 1:3'), @@ -169,7 +176,7 @@ class TestEnvironment { readonly service: QuestionDialogService; readonly mockedDialogRef = mock>(MatDialogRef); textsByBookId: TextsByBookId; - projectProfileDoc: SFProjectProfileDoc; + projectProfileDoc: SFProjectProfileDoc | undefined; matthewText: TextInfo = { bookNum: 40, hasSource: false, @@ -198,11 +205,6 @@ class TestEnvironment { id: this.PROJECT01, data: this.testProjectProfile }); - this.projectProfileDoc = await this.realtimeService.get( - SFProjectProfileDoc.COLLECTION, - this.PROJECT01, - new DocSubscription('spec') - ); when(mockedDialogService.openMatDialog(anything(), anything())).thenReturn(instance(this.mockedDialogRef)); when(mockedUserService.currentUserId).thenReturn(this.adminUser.id); @@ -211,6 +213,14 @@ class TestEnvironment { ); } + async init(): Promise { + this.projectProfileDoc = await this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + this.PROJECT01, + new DocSubscription('spec') + ); + } + async addQuestion(question: Question): Promise { this.realtimeService.addSnapshot(QUESTIONS_COLLECTION, { id: getQuestionDocId(this.PROJECT01, question.dataId), @@ -240,6 +250,7 @@ class TestEnvironment { } getQuestionDialogData(questionDoc?: QuestionDoc): QuestionDialogData { + if (this.projectProfileDoc == null) throw new Error('uninitialized'); return { questionDoc, projectDoc: this.projectProfileDoc, From 0836da74cdd1df692c9a985cd16b0bce9597331b Mon Sep 17 00:00:00 2001 From: MarkS Date: Tue, 9 Sep 2025 16:46:40 -0600 Subject: [PATCH 18/42] Question dialog spec private --- .../question-dialog/question-dialog.component.spec.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts index 2204ffca397..01b3818c4ea 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts @@ -613,10 +613,10 @@ class DialogTestModule {} class TestEnvironment { fixture: ComponentFixture; - _component: QuestionDialogComponent | undefined; + private _component: QuestionDialogComponent | undefined; dialogRef: MatDialogRef | undefined; afterCloseCallback: jasmine.Spy | undefined; - _dialogServiceSpy: DialogService | undefined; + private _dialogServiceSpy: DialogService | undefined; readonly mockedScriptureChooserMatDialogRef = mock(MatDialogRef); From 3e82f5594f12349a1abd168011fed8321d74afc2 Mon Sep 17 00:00:00 2001 From: MarkS Date: Tue, 9 Sep 2025 16:47:14 -0600 Subject: [PATCH 19/42] draft sources component spec await --- .../draft-sources.component.spec.ts | 180 +++++++++++------- 1 file changed, 110 insertions(+), 70 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.spec.ts index fdfd0e4400e..11b6bb2ce63 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.spec.ts @@ -1,6 +1,6 @@ import { OverlayContainer } from '@angular/cdk/overlay'; import { DebugElement } from '@angular/core'; -import { ComponentFixture, fakeAsync, TestBed, tick } from '@angular/core/testing'; +import { ComponentFixture, fakeAsync, flush, TestBed, tick } from '@angular/core/testing'; import { By } from '@angular/platform-browser'; import { NoopAnimationsModule } from '@angular/platform-browser/animations'; import { SFProject } from 'realtime-server/lib/esm/scriptureforge/models/sf-project'; @@ -106,23 +106,28 @@ describe('DraftSourcesComponent', () => { overlayContainer.ngOnDestroy(); }); - it('loads projects and resources on init', fakeAsync(() => { + it('loads projects and resources on init', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); verify(mockedParatextService.getProjects()).once(); verify(mockedParatextService.getResources()).once(); expect(env.component.projects).toBeDefined(); expect(env.component.resources).toBeDefined(); })); - it('suppresses network errors', fakeAsync(() => { - const env = new TestEnvironment({ projectLoadSuccessful: false }); - tick(); + it('suppresses network errors', fakeAsync(async () => { + const env = new TestEnvironment(); + await env.init({ projectLoadSuccessful: false }); + flush(); env.fixture.detectChanges(); expect(env.component.projects).toBeUndefined(); })); - it('loads projects and resources when returning online', fakeAsync(() => { - const env = new TestEnvironment({ isOnline: false }); + it('loads projects and resources when returning online', fakeAsync(async () => { + const env = new TestEnvironment(); + await env.init({ isOnline: false }); + flush(); verify(mockedParatextService.getProjects()).never(); verify(mockedParatextService.getResources()).never(); expect(env.component.projects).toBeUndefined(); @@ -139,9 +144,10 @@ describe('DraftSourcesComponent', () => { })); describe('save', () => { - it('should save the settings', fakeAsync(() => { + it('should save the settings', fakeAsync(async () => { const env = new TestEnvironment(); - tick(); + await env.init(); + flush(); env.fixture.detectChanges(); expect(env.component['changesMade']).toBe(false); env.clickLanguageCodesConfirmationCheckbox(); @@ -177,9 +183,10 @@ describe('DraftSourcesComponent', () => { expect(actualSettingsChangeRequest).toEqual(expectedSettingsChangeRequest); })); - it('clearing second training source works', fakeAsync(() => { + it('clearing second training source works', fakeAsync(async () => { const env = new TestEnvironment(); - tick(); + await env.init(); + flush(); env.fixture.detectChanges(); env.clickLanguageCodesConfirmationCheckbox(); expect(env.component['changesMade']).toBe(false); @@ -221,9 +228,10 @@ describe('DraftSourcesComponent', () => { expect(actualSettingsChangeRequest).toEqual(expectedSettingsChangeRequest); })); - it('clearing first training source works', fakeAsync(() => { + it('clearing first training source works', fakeAsync(async () => { const env = new TestEnvironment(); - tick(); + await env.init(); + flush(); env.fixture.detectChanges(); expect(env.component['changesMade']).toBe(false); env.clickLanguageCodesConfirmationCheckbox(); @@ -263,9 +271,10 @@ describe('DraftSourcesComponent', () => { expect(actualSettingsChangeRequest).toEqual(expectedSettingsChangeRequest); })); - it('fails to save and sync', fakeAsync(() => { + it('fails to save and sync', fakeAsync(async () => { const env = new TestEnvironment(); - tick(); + await env.init(); + flush(); env.fixture.detectChanges(); env.clickLanguageCodesConfirmationCheckbox(); @@ -287,9 +296,10 @@ describe('DraftSourcesComponent', () => { verify(mockedSFProjectService.onlineUpdateSettings(env.activatedProjectDoc.id, anything())).once(); })); - it('can edit second source after first is cleared', fakeAsync(() => { + it('can edit second source after first is cleared', fakeAsync(async () => { const env = new TestEnvironment(); - tick(); + await env.init(); + flush(); env.fixture.detectChanges(); env.clickLanguageCodesConfirmationCheckbox(); @@ -307,9 +317,10 @@ describe('DraftSourcesComponent', () => { expect(env.component.trainingSources.length).toEqual(2); })); - it('saves the selected training files', fakeAsync(() => { + it('saves the selected training files', fakeAsync(async () => { const env = new TestEnvironment(); - tick(); + await env.init(); + flush(); env.fixture.detectChanges(); env.clickLanguageCodesConfirmationCheckbox(); @@ -337,9 +348,10 @@ describe('DraftSourcesComponent', () => { expect(actualSettingsChangeRequest).toEqual(expectedSettingsChangeRequest); })); - it('creates training data for added files', fakeAsync(() => { + it('creates training data for added files', fakeAsync(async () => { const env = new TestEnvironment(); - tick(); + await env.init(); + flush(); env.fixture.detectChanges(); env.clickLanguageCodesConfirmationCheckbox(); @@ -356,9 +368,10 @@ describe('DraftSourcesComponent', () => { verify(mockTrainingDataService.createTrainingDataAsync(newFile)).once(); })); - it('deletes training data for removed files', fakeAsync(() => { + it('deletes training data for removed files', fakeAsync(async () => { const env = new TestEnvironment(); - tick(); + await env.init(); + flush(); env.fixture.detectChanges(); env.clickLanguageCodesConfirmationCheckbox(); @@ -382,9 +395,10 @@ describe('DraftSourcesComponent', () => { verify(mockTrainingDataService.createTrainingDataAsync(anything())).never(); })); - it('deletes added files on discard from confirmLeave', fakeAsync(() => { + it('deletes added files on discard from confirmLeave', fakeAsync(async () => { const env = new TestEnvironment(); - tick(); + await env.init(); + flush(); env.fixture.detectChanges(); env.clickLanguageCodesConfirmationCheckbox(); when(mockedDialogService.confirm(anything(), anything(), anything())).thenResolve(true); @@ -427,9 +441,10 @@ describe('DraftSourcesComponent', () => { verify(mockTrainingDataService.deleteTrainingDataAsync(anything())).never(); })); - it('preserves unsaved training file changes when query updates', fakeAsync(() => { + it('preserves unsaved training file changes when query updates', fakeAsync(async () => { const env = new TestEnvironment(); - tick(); + await env.init(); + flush(); env.fixture.detectChanges(); const initialFile1 = { dataId: 'file1' } as TrainingData; @@ -675,8 +690,10 @@ describe('DraftSourcesComponent', () => { }); }); - it('should disable save and sync button and display offline message when offline', fakeAsync(() => { + it('should disable save and sync button and display offline message when offline', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.testOnlineStatusService.setIsOnline(false); env.fixture.detectChanges(); tick(); @@ -688,8 +705,10 @@ describe('DraftSourcesComponent', () => { expect(saveButton.attributes.disabled).toBe('true'); })); - it('should enable save & sync button and not display offline message when online', fakeAsync(() => { + it('should enable save & sync button and not display offline message when online', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.testOnlineStatusService.setIsOnline(true); env.fixture.detectChanges(); tick(); @@ -704,55 +723,61 @@ describe('DraftSourcesComponent', () => { }); class TestEnvironment { - readonly component: DraftSourcesComponent; - readonly fixture: ComponentFixture; - readonly realtimeService: TestRealtimeService; - readonly activatedProjectDoc: WithData; - readonly testOnlineStatusService: TestOnlineStatusService = TestBed.inject( - OnlineStatusService - ) as TestOnlineStatusService; - + private _component: DraftSourcesComponent | undefined; + private _fixture: ComponentFixture | undefined; + realtimeService: TestRealtimeService; + private _activatedProjectDoc: WithData | undefined; + testOnlineStatusService: TestOnlineStatusService = TestBed.inject(OnlineStatusService) as TestOnlineStatusService; private projectsLoaded$: Subject = new Subject(); - constructor( + constructor() { + this.realtimeService = TestBed.inject(TestRealtimeService); + } + + async init( args: { isOnline?: boolean; projectLoadSuccessful?: boolean } = { isOnline: true, projectLoadSuccessful: true } - ) { + ): Promise { const userSFProjectsAndResourcesCount: number = 6; const userNonSFProjectsCount: number = 3; const userNonSFResourcesCount: number = 3; - this.realtimeService = TestBed.inject(TestRealtimeService); - // Make some projects and resources, already on SF, that the user has access to. These will be available as a // variety of types. - const projects: MultiTypeProjectDescription[] = Array.from( - { length: userSFProjectsAndResourcesCount }, - (_, i) => - ({ - id: `sf-id-${i}`, - data: createTestProject( - { - paratextId: `pt-id-${i}`, - resourceConfig: - i < userSFProjectsAndResourcesCount / 2 - ? undefined - : { - createdTimestamp: new Date(), - manifestChecksum: '1234', - permissionsChecksum: '2345', - revision: 1 - } - }, - i - ) - }) as SFProjectDoc + const projects: MultiTypeProjectDescription[] = ( + await Promise.all( + Array.from( + { length: userSFProjectsAndResourcesCount }, + (_, i) => + ({ + id: `sf-id-${i}`, + data: createTestProject( + { + paratextId: `pt-id-${i}`, + resourceConfig: + i < userSFProjectsAndResourcesCount / 2 + ? undefined + : { + createdTimestamp: new Date(), + manifestChecksum: '1234', + permissionsChecksum: '2345', + revision: 1 + } + }, + i + ) + }) as SFProjectDoc + ).map(async o => { + // Run it into and out of realtime service so it has fields like `remoteChanges$`. + this.realtimeService.addSnapshot(SFProjectDoc.COLLECTION, o); + return await this.realtimeService.get( + SFProjectDoc.COLLECTION, + o.id, + new DocSubscription('spec') + ); + }) + ) ) - .map(async o => { - // Run it into and out of realtime service so it has fields like `remoteChanges$`. - this.realtimeService.addSnapshot(SFProjectDoc.COLLECTION, o); - return await this.realtimeService.get(SFProjectDoc.COLLECTION, o.id, new DocSubscription('spec')); - }) .filter(hasData) .map(o => ({ sfProjectDoc: o, @@ -828,7 +853,7 @@ class TestEnvironment { .map(o => o.translateSource) .filter(notNull); - this.activatedProjectDoc = usersProjectsAndResourcesOnSF[0]; + this._activatedProjectDoc = usersProjectsAndResourcesOnSF[0]; // Now that various projects and resources are defined with known SF project ids, and as various needed types, write // the sf project 0's translate config values. @@ -871,8 +896,8 @@ class TestEnvironment { ); when(mockTrainingDataQuery.docs).thenReturn([]); - this.fixture = TestBed.createComponent(DraftSourcesComponent); - this.component = this.fixture.componentInstance; + this._fixture = TestBed.createComponent(DraftSourcesComponent); + this._component = this.fixture.componentInstance; this.fixture.detectChanges(); tick(); @@ -883,6 +908,21 @@ class TestEnvironment { this.fixture.detectChanges(); } + get component(): DraftSourcesComponent { + if (this._component == null) throw new Error('Uninitialized'); + return this._component; + } + + get fixture(): ComponentFixture { + if (this._fixture == null) throw new Error('Uninitialized'); + return this._fixture; + } + + get activatedProjectDoc(): WithData { + if (this._activatedProjectDoc == null) throw new Error('Uninitialized'); + return this._activatedProjectDoc; + } + clickLanguageCodesConfirmationCheckbox(): void { const languageCodesConfirmationComponent: DebugElement = this.fixture.debugElement.query( By.css('app-language-codes-confirmation') From 7f3ab4f8d40d06b7963831f59e761765479060fb Mon Sep 17 00:00:00 2001 From: MarkS Date: Wed, 10 Sep 2025 14:32:39 -0600 Subject: [PATCH 20/42] fix tests in sync-progress.component --- .../sync-progress.component.spec.ts | 44 +++++++++---------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts index 2d4751693a7..8b036735eaa 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts @@ -62,11 +62,11 @@ describe('SyncProgressComponent', () => { const env = new TestEnvironment({ userId: 'user01', sourceProject: 'invalid_source' }); env.setupProjectDoc(); verify(mockedProjectService.onlineGetProjectRole('invalid_source')).once(); - env.updateSyncProgress(0.5, 'testProject01'); + await env.updateSyncProgress(0.5, 'testProject01'); expect(env.host.inProgress).toBe(true); expect(await env.getPercent()).toEqual(50); expect(env.syncStatus).not.toBeNull(); - env.emitSyncComplete(true, 'testProject01'); + await env.emitSyncComplete(true, 'testProject01'); expect(env.host.inProgress).toBe(false); })); @@ -74,39 +74,39 @@ describe('SyncProgressComponent', () => { const env = new TestEnvironment({ userId: 'user01' }); env.setupProjectDoc(); // Simulate sync starting - env.updateSyncProgress(0, 'testProject01'); + await env.updateSyncProgress(0, 'testProject01'); expect(env.progressBar).not.toBeNull(); expect(await env.getMode()).toBe('indeterminate'); verify(mockedProjectService.onlineGetProjectRole('sourceProject02')).never(); // Simulate sync in progress - env.updateSyncProgress(0.5, 'testProject01'); + await env.updateSyncProgress(0.5, 'testProject01'); expect(await env.getMode()).toBe('determinate'); expect(env.syncStatus).not.toBeNull(); // Simulate sync completed - env.emitSyncComplete(true, 'testProject01'); + await env.emitSyncComplete(true, 'testProject01'); tick(); })); - it('show progress as source and target combined', fakeAsync(() => { + it('show progress as source and target combined', fakeAsync(async () => { const env = new TestEnvironment({ userId: 'user01', sourceProject: 'sourceProject02', translationSuggestionsEnabled: true }); env.setupProjectDoc(); - env.checkCombinedProgress(); + await env.checkCombinedProgress(); expect(env.syncStatus).not.toBeNull(); tick(); })); - it('show source and target progress combined when translation suggestions disabled', fakeAsync(() => { + it('show source and target progress combined when translation suggestions disabled', fakeAsync(async () => { const env = new TestEnvironment({ userId: 'user01', sourceProject: 'sourceProject02', translationSuggestionsEnabled: false }); env.setupProjectDoc(); - env.checkCombinedProgress(); + await env.checkCombinedProgress(); expect(env.syncStatus).not.toBeNull(); tick(); })); @@ -114,14 +114,14 @@ describe('SyncProgressComponent', () => { it('does not access source project if user does not have a paratext role', fakeAsync(async () => { const env = new TestEnvironment({ userId: 'user02', sourceProject: 'sourceProject02' }); env.setupProjectDoc(); - env.updateSyncProgress(0, 'testProject01'); - env.updateSyncProgress(0, 'sourceProject02'); + await env.updateSyncProgress(0, 'testProject01'); + await env.updateSyncProgress(0, 'sourceProject02'); verify(mockedProjectService.subscribe('sourceProject02', anything())).never(); - env.emitSyncComplete(true, 'sourceProject02'); - env.updateSyncProgress(0.5, 'testProject01'); + await env.emitSyncComplete(true, 'sourceProject02'); + await env.updateSyncProgress(0.5, 'testProject01'); expect(await env.getPercent()).toEqual(50); expect(env.syncStatus).not.toBeNull(); - env.emitSyncComplete(true, 'testProject01'); + await env.emitSyncComplete(true, 'testProject01'); })); it('does not throw error if get project role times out', fakeAsync(() => { @@ -279,29 +279,29 @@ class TestEnvironment { } async checkCombinedProgress(): Promise { - this.updateSyncProgress(0, 'testProject01'); - this.updateSyncProgress(0, 'sourceProject02'); + await this.updateSyncProgress(0, 'testProject01'); + await this.updateSyncProgress(0, 'sourceProject02'); verify(mockedProjectService.onlineGetProjectRole('sourceProject02')).once(); verify(mockedProjectService.subscribe('sourceProject02', anything())).once(); expect(this.progressBar).not.toBeNull(); expect(await this.getMode()).toBe('indeterminate'); - this.updateSyncProgress(0.8, 'sourceProject02'); + await this.updateSyncProgress(0.8, 'sourceProject02'); expect(await this.getPercent()).toEqual(40); expect(await this.getMode()).toBe('determinate'); - this.emitSyncComplete(true, 'sourceProject02'); + await this.emitSyncComplete(true, 'sourceProject02'); expect(await this.getPercent()).toEqual(50); expect(await this.getMode()).toBe('determinate'); - this.updateSyncProgress(0.8, 'testProject01'); + await this.updateSyncProgress(0.8, 'testProject01'); expect(await this.getPercent()).toEqual(90); - this.emitSyncComplete(true, 'testProject01'); + await this.emitSyncComplete(true, 'testProject01'); } async getMode(): Promise { - return firstValueFrom(this.host.syncProgress.syncProgressMode$); + return await firstValueFrom(this.host.syncProgress.syncProgressMode$); } async getPercent(): Promise { - return firstValueFrom(this.host.syncProgress.syncProgressPercent$); + return await firstValueFrom(this.host.syncProgress.syncProgressPercent$); } } From 23aa14ad1254d2033e9e97d2900ed35a78153581 Mon Sep 17 00:00:00 2001 From: MarkS Date: Wed, 10 Sep 2025 14:48:29 -0600 Subject: [PATCH 21/42] fix tests in checking-overview.component --- .../checking-overview.component.spec.ts | 174 +++++++++++++----- 1 file changed, 125 insertions(+), 49 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts index 9ba9cbd7262..a3e39457264 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking-overview/checking-overview.component.spec.ts @@ -78,8 +78,10 @@ describe('CheckingOverviewComponent', () => { })); describe('Add Question', () => { - it('should display "No question" message', fakeAsync(() => { - const env = new TestEnvironment(false); + it('should display "No question" message', fakeAsync(async () => { + const env = new TestEnvironment(); + await env.init(false); + flush(); env.fixture.detectChanges(); expect(env.loadingQuestionsLabel).not.toBeNull(); expect(env.noQuestionsLabel).toBeNull(); @@ -88,8 +90,10 @@ describe('CheckingOverviewComponent', () => { expect(env.noQuestionsLabel).not.toBeNull(); })); - it('should not display loading if user is offline', fakeAsync(() => { + it('should not display loading if user is offline', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.testOnlineStatusService.setIsOnline(false); tick(); env.fixture.detectChanges(); @@ -98,45 +102,57 @@ describe('CheckingOverviewComponent', () => { env.waitForQuestions(); })); - it('should not display "Add question" button for community checker', fakeAsync(() => { + it('should not display "Add question" button for community checker', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.setCurrentUser(env.checkerUser); env.waitForQuestions(); expect(env.addQuestionButton).toBeNull(); })); - it('should display "Add question" button for project admin', fakeAsync(() => { + it('should display "Add question" button for project admin', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.setCurrentUser(env.adminUser); env.waitForQuestions(); expect(env.addQuestionButton).not.toBeNull(); })); - it('should display "Add question" button for translator with questions permission', fakeAsync(() => { + it('should display "Add question" button for translator with questions permission', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.setCurrentUser(env.translatorUser); env.waitForQuestions(); expect(env.addQuestionButton).not.toBeNull(); })); - it('should not display "Add question" button when loading', fakeAsync(() => { + it('should not display "Add question" button when loading', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.fixture.detectChanges(); expect(env.addQuestionButton).toBeNull(); env.waitForQuestions(); expect(env.addQuestionButton).not.toBeNull(); })); - it('should open dialog when "Add question" button is clicked', fakeAsync(() => { + it('should open dialog when "Add question" button is clicked', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.waitForQuestions(); env.clickElement(env.addQuestionButton); verify(mockedQuestionDialogService.questionDialog(anything())).once(); expect().nothing(); })); - it('should show new question after adding', fakeAsync(() => { + it('should show new question after adding', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); const dateNow = new Date(); const newQuestion: Question = { dataId: 'newQId1', @@ -169,6 +185,8 @@ describe('CheckingOverviewComponent', () => { it('should show new question after local change', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.waitForQuestions(); const dateNow = new Date(); @@ -194,8 +212,10 @@ describe('CheckingOverviewComponent', () => { expect(env.component.getQuestionDocs(new TextDocId('project01', 42, 1)).length).toEqual(numQuestions + 1); })); - it('should show question in canonical order', fakeAsync(() => { + it('should show question in canonical order', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.waitForQuestions(); expect(env.textRows.length).toEqual(2); // Click on Matthew and then Matthew 1 @@ -205,8 +225,10 @@ describe('CheckingOverviewComponent', () => { expect(env.textRows[3].nativeElement.textContent).toContain('v4'); })); - it('should show new question after adding to a project with no questions', fakeAsync(() => { - const env = new TestEnvironment(false); + it('should show new question after adding to a project with no questions', fakeAsync(async () => { + const env = new TestEnvironment(); + await env.init(false); + flush(); const dateNow = new Date(); const newQuestion: Question = { dataId: 'newQId1', @@ -234,8 +256,10 @@ describe('CheckingOverviewComponent', () => { }); describe('Edit Question', () => { - it('should expand/collapse questions in book text', fakeAsync(() => { + it('should expand/collapse questions in book text', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); const id = new TextDocId('project01', 40, 1); env.waitForQuestions(); expect(env.textRows.length).toEqual(2); @@ -255,8 +279,10 @@ describe('CheckingOverviewComponent', () => { expect(env.textRows.length).toEqual(2); })); - it('should open a dialog to edit a question', fakeAsync(() => { + it('should open a dialog to edit a question', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.waitForQuestions(); env.clickExpanderAtRow(0); env.clickExpanderAtRow(1); @@ -268,8 +294,10 @@ describe('CheckingOverviewComponent', () => { verify(mockedQuestionDialogService.questionDialog(anything())).once(); })); - it('should bring up question dialog only if user confirms question answered dialog', fakeAsync(() => { + it('should bring up question dialog only if user confirms question answered dialog', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.waitForQuestions(); env.clickExpanderAtRow(0); env.clickExpanderAtRow(1); @@ -294,16 +322,20 @@ describe('CheckingOverviewComponent', () => { }); describe('Import Questions', () => { - it('should open a dialog to import questions', fakeAsync(() => { + it('should open a dialog to import questions', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.waitForQuestions(); env.clickElement(env.importButton); verify(mockedDialogService.openMatDialog(ImportQuestionsDialogComponent, anything())).once(); expect().nothing(); })); - it('should not show import questions button until list of texts have loaded', fakeAsync(() => { + it('should not show import questions button until list of texts have loaded', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); const delayPromise = new Promise(resolve => setTimeout(resolve, 10 * 1000)); when(mockedQuestionsService.queryQuestions(anything(), anything(), anything())).thenReturn( delayPromise.then( @@ -321,9 +353,11 @@ describe('CheckingOverviewComponent', () => { }); describe('Export Questions', () => { - it('should export questions to CSV', fakeAsync(() => { + it('should export questions to CSV', fakeAsync(async () => { spyOn(saveAs, 'saveAs').and.stub(); const env = new TestEnvironment(); + await env.init(); + flush(); env.waitForQuestions(); env.clickElement(env.exportButton); expect(saveAs).toHaveBeenCalled(); @@ -331,8 +365,10 @@ describe('CheckingOverviewComponent', () => { }); describe('for Reviewer', () => { - it('should display "No question" message', fakeAsync(() => { - const env = new TestEnvironment(false); + it('should display "No question" message', fakeAsync(async () => { + const env = new TestEnvironment(); + await env.init(false); + flush(); env.setCurrentUser(env.checkerUser); env.fixture.detectChanges(); expect(env.loadingQuestionsLabel).not.toBeNull(); @@ -342,24 +378,30 @@ describe('CheckingOverviewComponent', () => { expect(env.noQuestionsLabel).not.toBeNull(); })); - it('should not display progress for project admin', fakeAsync(() => { + it('should not display progress for project admin', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.setCurrentUser(env.adminUser); env.waitForQuestions(); expect(env.overallProgressChart).toBeNull(); expect(env.reviewerQuestionPanel).toBeNull(); })); - it('should display progress', fakeAsync(() => { + it('should display progress', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.setCurrentUser(env.checkerUser); env.waitForQuestions(); expect(env.overallProgressChart).not.toBeNull(); expect(env.reviewerQuestionPanel).not.toBeNull(); })); - it('should calculate the right progress proportions and stats', fakeAsync(() => { + it('should calculate the right progress proportions and stats', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.setCurrentUser(env.checkerUser); env.waitForQuestions(); const [unread, read, answered] = env.component.bookProgress({ @@ -378,8 +420,10 @@ describe('CheckingOverviewComponent', () => { expect(env.component.myLikeCount).toBe(3); })); - it('should calculate the right stats for project admin', fakeAsync(() => { + it('should calculate the right stats for project admin', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.setCurrentUser(env.adminUser); env.waitForQuestions(); // 1 of 7 questions of MAT is archived + 1 in LUK @@ -389,21 +433,25 @@ describe('CheckingOverviewComponent', () => { expect(env.component.myLikeCount).toBe(4); })); - it('should hide like card if see other user responses is disabled', fakeAsync(() => { + it('should hide like card if see other user responses is disabled', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.setCurrentUser(env.checkerUser); env.waitForQuestions(); expect(env.likePanel).not.toBeNull(); - env.setSeeOtherUserResponses(false); + await env.setSeeOtherUserResponses(false); expect(env.likePanel).toBeNull(); - env.setSeeOtherUserResponses(true); + await env.setSeeOtherUserResponses(true); expect(env.likePanel).not.toBeNull(); })); }); describe('Archive Question', () => { - it('should display "No archived question" message', fakeAsync(() => { + it('should display "No archived question" message', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.fixture.detectChanges(); expect(env.loadingArchivedQuestionsLabel).not.toBeNull(); env.waitForQuestions(); @@ -421,6 +469,8 @@ describe('CheckingOverviewComponent', () => { it('should not display loading if user is offline', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); const questionDoc: QuestionDoc = await env.realtimeService.get( QuestionDoc.COLLECTION, getQuestionDocId('project01', 'q7Id'), @@ -439,8 +489,10 @@ describe('CheckingOverviewComponent', () => { env.waitForQuestions(); })); - it('archives and republishes a question', fakeAsync(() => { + it('archives and republishes a question', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.waitForQuestions(); expect(env.textRows.length).toEqual(2); expect(env.textArchivedRows.length).toEqual(1); @@ -467,8 +519,10 @@ describe('CheckingOverviewComponent', () => { discardPeriodicTasks(); })); - it('archives and republishes questions for an entire chapter or book', fakeAsync(() => { + it('archives and republishes questions for an entire chapter or book', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.waitForQuestions(); // VERIFY CORRECT SETUP @@ -544,16 +598,20 @@ describe('CheckingOverviewComponent', () => { }); describe('Chapter Audio', () => { - it('show audio icon on chapter heading', fakeAsync(() => { - const env = new TestEnvironment(true, true); + it('show audio icon on chapter heading', fakeAsync(async () => { + const env = new TestEnvironment(); + await env.init(true, true); + flush(); env.waitForQuestions(); env.clickExpanderAtRow(2); expect(env.checkChapterHasAudio(3)).toBeTrue(); })); - it('chapter with audio has heading visible when no questions ', fakeAsync(() => { - const env = new TestEnvironment(true, true); + it('chapter with audio has heading visible when no questions ', fakeAsync(async () => { + const env = new TestEnvironment(); + await env.init(true, true); + flush(); env.waitForQuestions(); const johnIndex = 2; const johnChapter1Index = 3; @@ -572,8 +630,10 @@ describe('CheckingOverviewComponent', () => { discardPeriodicTasks(); })); - it('click chapter with audio and no questions should not open panel ', fakeAsync(() => { - const env = new TestEnvironment(true, true); + it('click chapter with audio and no questions should not open panel ', fakeAsync(async () => { + const env = new TestEnvironment(); + await env.init(true, true); + flush(); env.waitForQuestions(); const johnIndex = 2; const johnChapter2Index = 4; @@ -585,8 +645,10 @@ describe('CheckingOverviewComponent', () => { expect(env.checkRowIsExpanded(johnChapter2Index)).toBeFalse(); })); - it('hide archive questions on book when only audio is available ', fakeAsync(() => { - const env = new TestEnvironment(true, true); + it('hide archive questions on book when only audio is available ', fakeAsync(async () => { + const env = new TestEnvironment(); + await env.init(true, true); + flush(); env.waitForQuestions(); const johnIndex = 2; @@ -602,8 +664,10 @@ describe('CheckingOverviewComponent', () => { })); }); - it('should handle question in a book that does not exist', fakeAsync(() => { + it('should handle question in a book that does not exist', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.addQuestion({ dataId: 'qMissingBook', projectRef: 'project01', @@ -623,8 +687,10 @@ describe('CheckingOverviewComponent', () => { expect(env.component.questionCount(41, 1)).toEqual(0); })); - it('should display question reference range if present', fakeAsync(() => { + it('should display question reference range if present', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.setCurrentUser(env.adminUser); const verseRefWithRange: VerseRefData = { @@ -681,10 +747,9 @@ interface UserInfo { } class TestEnvironment { - component: CheckingOverviewComponent; - fixture: ComponentFixture; - location: Location; - + private _component: CheckingOverviewComponent | undefined; + private _fixture: ComponentFixture | undefined; + readonly location: Location = TestBed.inject(Location); readonly ngZone: NgZone = TestBed.inject(NgZone); readonly realtimeService: TestRealtimeService = TestBed.inject(TestRealtimeService); readonly testOnlineStatusService: TestOnlineStatusService = TestBed.inject( @@ -745,7 +810,9 @@ class TestEnvironment { private readonly anotherUserId = 'anotherUserId'; - constructor(withQuestionData: boolean = true, withChapterAudioData: boolean = false) { + constructor() {} + + async init(withQuestionData: boolean = true, withChapterAudioData: boolean = false): Promise { if (withQuestionData) { // Question 2 deliberately before question 1 to test sorting this.realtimeService.addSnapshots(QuestionDoc.COLLECTION, [ @@ -971,7 +1038,7 @@ class TestEnvironment { } ]); if (withChapterAudioData) { - this.addChapterAudio(); + await this.addChapterAudio(); } when(mockedActivatedRoute.params).thenReturn(of({ projectId: 'project01' })); @@ -1005,9 +1072,18 @@ class TestEnvironment { this.setCurrentUser(this.adminUser); this.testOnlineStatusService.setIsOnline(true); - this.fixture = TestBed.createComponent(CheckingOverviewComponent); - this.component = this.fixture.componentInstance; - this.location = TestBed.inject(Location); + this._fixture = TestBed.createComponent(CheckingOverviewComponent); + this._component = this.fixture.componentInstance; + } + + get component(): CheckingOverviewComponent { + if (this._component == null) throw new Error('Uninitialized'); + return this._component; + } + + get fixture(): ComponentFixture { + if (this._fixture == null) throw new Error('Uninitialized'); + return this._fixture; } get addQuestionButton(): DebugElement { From d28cfcd6ef9cc9141bddd8dacceef9efbba8b2a8 Mon Sep 17 00:00:00 2001 From: MarkS Date: Wed, 10 Sep 2025 15:00:23 -0600 Subject: [PATCH 22/42] fix tests in lynx-workspace.service --- .../insights/lynx-workspace.service.spec.ts | 142 ++++++++++++------ 1 file changed, 96 insertions(+), 46 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts index 9b44208bb99..efc9f4c2472 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts @@ -1,5 +1,5 @@ import { DestroyRef } from '@angular/core'; -import { fakeAsync, TestBed, tick } from '@angular/core/testing'; +import { fakeAsync, flush, TestBed, tick } from '@angular/core/testing'; import { BrowserModule } from '@angular/platform-browser'; import { DiagnosticsChanged, DiagnosticSeverity, DocumentManager, Position, Workspace } from '@sillsdev/lynx'; import { ScriptureDeltaDocument } from '@sillsdev/lynx-delta'; @@ -61,12 +61,8 @@ describe('LynxWorkspaceService', () => { readonly localeTestSubject$ = new BehaviorSubject(defaultLocale); readonly diagnosticsChangedTestSubject$ = new Subject(); - constructor(autoInit = true) { + constructor() { this.setupMocks(); - - if (autoInit) { - this.init(); - } } setupMocks(): void { @@ -152,7 +148,7 @@ describe('LynxWorkspaceService', () => { }); } - init(): void { + async init(): Promise { this.realtimeService = TestBed.inject(RealtimeService as any); when(mockProjectService.getText(anything(), anything())).thenCall(async textDocId => { @@ -162,14 +158,14 @@ describe('LynxWorkspaceService', () => { id, new DocSubscription('spec') ); - return Promise.resolve(existingDoc || this.createTextDoc()); + return existingDoc ?? (await this.createTextDoc()); }); - this.createTextDoc(CHAPTER_NUM); - this.createTextDoc(CHAPTER_NUM + 1); + await this.createTextDoc(CHAPTER_NUM); + await this.createTextDoc(CHAPTER_NUM + 1); this.service = TestBed.inject(LynxWorkspaceService); - this.service.init(); + await this.service.init(); tick(); } @@ -356,8 +352,10 @@ describe('LynxWorkspaceService', () => { }); describe('Initialization', () => { - it('should update language when locale changes', fakeAsync(() => { + it('should update language when locale changes', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Override the workspace factory for this test to use a plain object with a spy const changeLanguageSpy = jasmine.createSpy('changeLanguage').and.returnValue(Promise.resolve()); @@ -414,28 +412,34 @@ describe('LynxWorkspaceService', () => { }); describe('Project activation', () => { - it('should reset document manager when project is activated', fakeAsync(() => { + it('should reset document manager when project is activated', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.service['projectId'] = 'different-project-id'; resetCalls(mockDocumentManager); - env.triggerProjectChange(PROJECT_ID); + await env.triggerProjectChange(PROJECT_ID); verify(mockDocumentManager.reset()).once(); })); - it('should not reset document manager when project id is unchanged', fakeAsync(() => { + it('should not reset document manager when project id is unchanged', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.service['projectId'] = PROJECT_ID; resetCalls(mockDocumentManager); - env.triggerProjectChange(PROJECT_ID); + await env.triggerProjectChange(PROJECT_ID); verify(mockDocumentManager.reset()).never(); })); - it('should clear insights when project changes', fakeAsync(() => { + it('should clear insights when project changes', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); const insight = env.createTestInsight(); env.addInsightToService(insight); @@ -443,15 +447,17 @@ describe('LynxWorkspaceService', () => { expect(env.service.currentInsights.length).toBeGreaterThan(0); env.service['projectId'] = 'different-id'; - env.triggerProjectChange('new-project'); + await env.triggerProjectChange('new-project'); expect(env.service.currentInsights.length).toBe(0); })); }); describe('Task running status', () => { - it('should emit false when no project is active', fakeAsync(() => { + it('should emit false when no project is active', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); let taskRunning: boolean | undefined; env.service.taskRunningStatus$.subscribe(status => { @@ -462,8 +468,10 @@ describe('LynxWorkspaceService', () => { expect(taskRunning).toBe(false); })); - it('should emit true when project is activated, then false after insights arrive', fakeAsync(() => { + it('should emit true when project is activated, then false after insights arrive', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); const statusValues: boolean[] = []; env.service.taskRunningStatus$.subscribe(status => { @@ -475,12 +483,14 @@ describe('LynxWorkspaceService', () => { expect(statusValues).toEqual([false]); // When project is activated, should emit true (task running) - env.triggerProjectChange(PROJECT_ID); + await env.triggerProjectChange(PROJECT_ID); expect(statusValues).toEqual([false, true, false]); })); - it('should restart loading cycle when different project is activated', fakeAsync(() => { + it('should restart loading cycle when different project is activated', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); const statusValues: boolean[] = []; env.service.taskRunningStatus$.subscribe(status => { @@ -489,22 +499,24 @@ describe('LynxWorkspaceService', () => { // Initial state and first project tick(); - env.triggerProjectChange(PROJECT_ID); + await env.triggerProjectChange(PROJECT_ID); env.setupActiveTextDocId(); tick(); // Allow workspace setup to complete expect(statusValues).toEqual([false, true, false]); // Switch to different project - should restart loading cycle const differentProjectId = 'project02'; - env.triggerProjectChange(differentProjectId); + await env.triggerProjectChange(differentProjectId); env.service['projectId'] = differentProjectId; env.service['textDocId'] = new TextDocId(differentProjectId, BOOK_NUM, CHAPTER_NUM); tick(); // Allow workspace setup to complete expect(statusValues).toEqual([false, true, false, true]); })); - it('should handle empty insights correctly', fakeAsync(() => { + it('should handle empty insights correctly', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); const statusValues: boolean[] = []; env.service.taskRunningStatus$.subscribe(status => { @@ -512,12 +524,14 @@ describe('LynxWorkspaceService', () => { }); tick(); - env.triggerProjectChange(PROJECT_ID); + await env.triggerProjectChange(PROJECT_ID); expect(statusValues).toEqual([false, true, false]); })); - it('should use shareReplay to avoid multiple subscriptions triggering multiple emissions', fakeAsync(() => { + it('should use shareReplay to avoid multiple subscriptions triggering multiple emissions', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); const statusValues1: boolean[] = []; const statusValues2: boolean[] = []; @@ -526,7 +540,7 @@ describe('LynxWorkspaceService', () => { env.service.taskRunningStatus$.subscribe(status => statusValues2.push(status)); tick(); - env.triggerProjectChange(PROJECT_ID); + await env.triggerProjectChange(PROJECT_ID); env.setupActiveTextDocId(); env.triggerDiagnostics(['Test insight']); @@ -537,8 +551,10 @@ describe('LynxWorkspaceService', () => { }); describe('Book chapter activation', () => { - it('should fire document closed event when chapter changes', fakeAsync(() => { + it('should fire document closed event when chapter changes', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Create project with lynx features enabled so documents will be opened const projectDoc = env.createMockProjectDoc(PROJECT_ID, { @@ -567,8 +583,10 @@ describe('LynxWorkspaceService', () => { verify(mockDocumentManager.fireClosed(anything())).once(); })); - it('should open document when chapter is activated', fakeAsync(() => { + it('should open document when chapter is activated', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Create project with lynx features enabled so documents will be opened const projectDoc = env.createMockProjectDoc(PROJECT_ID, { @@ -590,8 +608,10 @@ describe('LynxWorkspaceService', () => { verify(mockDocumentManager.fireOpened(anything(), anything())).once(); })); - it('should update textDocId when chapter changes', fakeAsync(() => { + it('should update textDocId when chapter changes', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Set up project with lynx features enabled so documents will be opened const projectDoc = env.createMockProjectDoc(PROJECT_ID, { @@ -620,8 +640,10 @@ describe('LynxWorkspaceService', () => { }); describe('Insights processing', () => { - it('should process diagnostics into insights', fakeAsync(() => { + it('should process diagnostics into insights', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Set up project with lynx features enabled const projectDoc = env.createMockProjectDoc(PROJECT_ID, { @@ -649,8 +671,10 @@ describe('LynxWorkspaceService', () => { subscription.unsubscribe(); })); - it('should convert diagnostic severity to appropriate insight type', fakeAsync(() => { + it('should convert diagnostic severity to appropriate insight type', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Set up project with lynx features enabled const projectDoc = env.createMockProjectDoc(PROJECT_ID, { @@ -686,8 +710,10 @@ describe('LynxWorkspaceService', () => { subscription.unsubscribe(); })); - it('should maintain insight ids for matching insights', fakeAsync(() => { + it('should maintain insight ids for matching insights', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Set up project with lynx features enabled const projectDoc = env.createMockProjectDoc(PROJECT_ID, { @@ -714,8 +740,10 @@ describe('LynxWorkspaceService', () => { subscription.unsubscribe(); })); - it('should remove insights when empty diagnostics are sent', fakeAsync(() => { + it('should remove insights when empty diagnostics are sent', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Set up project with lynx features enabled const projectDoc = env.createMockProjectDoc(PROJECT_ID, { @@ -746,8 +774,10 @@ describe('LynxWorkspaceService', () => { }); describe('getOnTypeEdits', () => { - it('should return edits for trigger characters', fakeAsync(() => { + it('should return edits for trigger characters', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Set up project with auto-corrections enabled const projectDoc = env.createMockProjectDoc(PROJECT_ID, { @@ -774,8 +804,10 @@ describe('LynxWorkspaceService', () => { expect(result[0].ops).toEqual([{ retain: 5 }, { insert: ' ' }]); })); - it('should handle multiple trigger characters', fakeAsync(() => { + it('should handle multiple trigger characters', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.setCustomWorkspaceMock((workspaceMock: any) => { when(workspaceMock.getOnTypeEdits(anything(), anything(), ',')).thenReturn( @@ -810,8 +842,10 @@ describe('LynxWorkspaceService', () => { expect(result[1].ops).toEqual([{ retain: 6 }, { insert: ' ' }]); })); - it('should handle null document when getting on-type edits', fakeAsync(() => { + it('should handle null document when getting on-type edits', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.service['textDocId'] = new TextDocId(PROJECT_ID, BOOK_NUM, CHAPTER_NUM); when(mockDocumentManager.get(anything())).thenReturn(Promise.resolve(undefined)); const delta = new Delta().insert('Hello,'); @@ -882,8 +916,10 @@ describe('LynxWorkspaceService', () => { }); describe('getActions', () => { - it('should get actions for an insight', fakeAsync(() => { + it('should get actions for an insight', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.setCustomWorkspaceMock((workspaceMock: any) => { when(workspaceMock.getDiagnosticFixes(anything(), anything())).thenReturn( @@ -927,8 +963,10 @@ describe('LynxWorkspaceService', () => { expect(actions[0].ops).toEqual([{ retain: 0 }, { insert: 'corrected' }, { delete: 10 }]); })); - it('should handle null document when getting actions', fakeAsync(() => { + it('should handle null document when getting actions', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); when(mockDocumentManager.get(anything())).thenReturn(Promise.resolve(undefined)); const insight = env.createTestInsight(); let actions: LynxInsightAction[] = []; @@ -941,8 +979,10 @@ describe('LynxWorkspaceService', () => { }); describe('2D Map Structure - Insights by URI and Source', () => { - it('should organize insights by URI and diagnostic source', fakeAsync(() => { + it('should organize insights by URI and diagnostic source', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Set up project with lynx features enabled const projectDoc = env.createMockProjectDoc(PROJECT_ID, { @@ -1012,8 +1052,10 @@ describe('LynxWorkspaceService', () => { subscription.unsubscribe(); })); - it('should preserve insights from different sources when one source is updated', fakeAsync(() => { + it('should preserve insights from different sources when one source is updated', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Set up project with lynx features enabled const projectDoc = env.createMockProjectDoc(PROJECT_ID, { @@ -1098,8 +1140,10 @@ describe('LynxWorkspaceService', () => { subscription.unsubscribe(); })); - it('should reuse insight ids for matching diagnostics within the same source', fakeAsync(() => { + it('should reuse insight ids for matching diagnostics within the same source', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Set up project with lynx features enabled const projectDoc = env.createMockProjectDoc(PROJECT_ID, { @@ -1188,8 +1232,10 @@ describe('LynxWorkspaceService', () => { subscription.unsubscribe(); })); - it('should flatten 2D map correctly when returning insights', fakeAsync(() => { + it('should flatten 2D map correctly when returning insights', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Set up project with lynx features enabled const projectDoc = env.createMockProjectDoc(PROJECT_ID, { @@ -1254,8 +1300,10 @@ describe('LynxWorkspaceService', () => { subscription.unsubscribe(); })); - it('should clear all sources for a URI when empty diagnostics are received', fakeAsync(() => { + it('should clear all sources for a URI when empty diagnostics are received', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); // Set up project with lynx features enabled const projectDoc = env.createMockProjectDoc(PROJECT_ID, { @@ -1314,8 +1362,10 @@ describe('LynxWorkspaceService', () => { subscription.unsubscribe(); })); - it('should maintain consistent currentInsights getter behavior', fakeAsync(() => { + it('should maintain consistent currentInsights getter behavior', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.setupActiveTextDocId(); // Add some insights using the internal 2D map structure From 3c5abe61bc4d25670973188c88ee297d1d8f1754 Mon Sep 17 00:00:00 2001 From: MarkS Date: Wed, 10 Sep 2025 15:04:53 -0600 Subject: [PATCH 23/42] fix tests for sync.component --- .../src/app/sync/sync.component.spec.ts | 33 ++++++++++--------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts index 552026b7852..959a492ef73 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync.component.spec.ts @@ -108,7 +108,7 @@ describe('SyncComponent', () => { expect(env.offlineMessage).toBeNull(); })); - it('should sync project when the button is clicked', fakeAsync(() => { + it('should sync project when the button is clicked', fakeAsync(async () => { const env = new TestEnvironment(); const previousLastSyncDate = env.component.lastSyncDate; verify(mockedProjectService.subscribe(env.projectId, anything())).once(); @@ -121,7 +121,7 @@ describe('SyncComponent', () => { expect(env.cancelButton).not.toBeNull(); expect(env.logInButton).toBeNull(); expect(env.syncButton).toBeNull(); - env.emitSyncComplete(true, env.projectId); + await env.emitSyncComplete(true, env.projectId); expect(env.component.lastSyncDate!.getTime()).toBeGreaterThan(previousLastSyncDate!.getTime()); verify(mockedNoticeService.show('Successfully synchronized Sync Test Project with Paratext.')).once(); })); @@ -139,7 +139,7 @@ describe('SyncComponent', () => { expect(env.component.syncActive).toBe(false); })); - it('should report error if sync has a problem', fakeAsync(() => { + it('should report error if sync has a problem', fakeAsync(async () => { const env = new TestEnvironment(); verify(mockedProjectService.subscribe(env.projectId, anything())).once(); env.clickElement(env.syncButton); @@ -147,16 +147,16 @@ describe('SyncComponent', () => { expect(env.component.syncActive).toBe(true); expect(env.progressBar).not.toBeNull(); // Simulate sync in progress - env.setQueuedCount(env.projectId); + await env.setQueuedCount(env.projectId); // Simulate sync error - env.emitSyncComplete(false, env.projectId); + await env.emitSyncComplete(false, env.projectId); expect(env.component.syncActive).toBe(false); verify(mockedDialogService.message(anything())).once(); })); - it('should report user permissions error if sync failed for that reason', fakeAsync(() => { + it('should report user permissions error if sync failed for that reason', fakeAsync(async () => { const env = new TestEnvironment({ lastSyncErrorCode: -1, lastSyncWasSuccessful: false }); verify(mockedProjectService.subscribe(env.projectId, anything())).once(); env.clickElement(env.syncButton); @@ -164,10 +164,10 @@ describe('SyncComponent', () => { expect(env.component.syncActive).toBe(true); expect(env.progressBar).not.toBeNull(); // Simulate sync in progress - env.setQueuedCount(env.projectId); + await env.setQueuedCount(env.projectId); // Simulate sync error - env.emitSyncComplete(false, env.projectId); + await env.emitSyncComplete(false, env.projectId); expect(env.component.syncActive).toBe(false); expect(env.component.showSyncUserPermissionsFailureMessage).toBe(true); @@ -226,7 +226,7 @@ describe('SyncComponent', () => { expect(env.syncDisabledMessage).toBeNull(); })); - it('should not report if sync was cancelled', fakeAsync(() => { + it('should not report if sync was cancelled', fakeAsync(async () => { const env = new TestEnvironment(); const previousLastSyncDate = env.component.lastSyncDate; verify(mockedProjectService.subscribe(env.projectId, anything())).once(); @@ -234,10 +234,10 @@ describe('SyncComponent', () => { verify(mockedProjectService.onlineSync(env.projectId)).once(); expect(env.component.syncActive).toBe(true); expect(env.progressBar).not.toBeNull(); - env.setQueuedCount(env.projectId); + await env.setQueuedCount(env.projectId); env.clickElement(env.cancelButton); - env.emitSyncComplete(false, env.projectId); + await env.emitSyncComplete(false, env.projectId); expect(env.component.syncActive).toBe(false); expect(env.component.lastSyncDate).toEqual(previousLastSyncDate); @@ -245,7 +245,7 @@ describe('SyncComponent', () => { verify(mockedDialogService.message(anything())).never(); })); - it('should report success if sync was cancelled but had finished', fakeAsync(() => { + it('should report success if sync was cancelled but had finished', fakeAsync(async () => { const env = new TestEnvironment(); verify(mockedProjectService.subscribe(env.projectId, anything())).once(); env.clickElement(env.syncButton); @@ -254,7 +254,7 @@ describe('SyncComponent', () => { expect(env.progressBar).not.toBeNull(); env.clickElement(env.cancelButton); - env.emitSyncComplete(true, env.projectId); + await env.emitSyncComplete(true, env.projectId); verify(mockedNoticeService.show('Successfully synchronized Sync Test Project with Paratext.')).once(); verify(mockedDialogService.message(anything())).never(); @@ -293,7 +293,7 @@ class TestEnvironment { const ptUsername = isParatextAccountConnected ? 'Paratext User01' : ''; when(mockedParatextService.getParatextUsername()).thenReturn(of(ptUsername)); when(mockedProjectService.onlineSync(anything())) - .thenCall(id => this.setQueuedCount(id)) + .thenCall(async id => await this.setQueuedCount(id)) .thenResolve(); when(mockedNoticeService.loadingStarted(anything())).thenCall(() => (this.isLoading = true)); when(mockedNoticeService.loadingFinished(anything())).thenCall(() => (this.isLoading = false)); @@ -316,8 +316,9 @@ class TestEnvironment { }) }); - when(mockedProjectService.subscribe(anyString(), anything())).thenCall(projectId => - this.realtimeService.subscribe(SFProjectDoc.COLLECTION, projectId, new DocSubscription('spec')) + when(mockedProjectService.subscribe(anyString(), anything())).thenCall( + async projectId => + await this.realtimeService.subscribe(SFProjectDoc.COLLECTION, projectId, new DocSubscription('spec')) ); this.fixture = TestBed.createComponent(SyncComponent); From 488fa3fc9b266300922cd4a53b2e69eebe7b7a1c Mon Sep 17 00:00:00 2001 From: MarkS Date: Wed, 10 Sep 2025 15:50:53 -0600 Subject: [PATCH 24/42] fix most of app.component.spec --- .../ClientApp/src/app/app.component.spec.ts | 151 ++++++++++-------- 1 file changed, 86 insertions(+), 65 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts index 5913e3fb451..66061c2be6a 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts @@ -125,9 +125,10 @@ describe('AppComponent', () => { expect(1).toEqual(1); }); - it('navigate to last project', fakeAsync(() => { + it('navigate to last project', fakeAsync(async () => { const env = new TestEnvironment(); - env.navigate(['/projects', 'project01']); + await env.navigate(['/projects', 'project01']); + flush(); env.init(); expect(env.isDrawerVisible).toEqual(true); @@ -150,9 +151,10 @@ describe('AppComponent', () => { tick(); })); - it('navigate to different project', fakeAsync(() => { + it('navigate to different project', fakeAsync(async () => { const env = new TestEnvironment(); - env.navigate(['/projects', 'project02']); + await env.navigate(['/projects', 'project02']); + flush(); env.init(); expect(env.isDrawerVisible).toEqual(true); @@ -170,20 +172,21 @@ describe('AppComponent', () => { discardPeriodicTasks(); })); - it('close menu when navigating to a non-project route', fakeAsync(() => { + it('close menu when navigating to a non-project route', fakeAsync(async () => { const env = new TestEnvironment(); - env.navigate(['/my-account']); + await env.navigate(['/my-account']); + flush(); env.init(); expect(env.isDrawerVisible).toEqual(false); expect(env.component.selectedProjectId).toBeUndefined(); })); - it('drawer disappears as appropriate in small viewport', fakeAsync(() => { + it('drawer disappears as appropriate in small viewport', fakeAsync(async () => { // The user goes to a project. They are using an sm size viewport. const env = new TestEnvironment(); env.breakpointObserver.emitObserveValue(false); - env.navigateFully(['/projects', 'project01']); + await env.navigateFully(['/projects', 'project01']); // (And we are not here calling env.init(), which would open the drawer.) // With a smaller viewport, at a project page, the drawer should not be visible. Although it is in the dom. @@ -227,7 +230,7 @@ describe('AppComponent', () => { expect(env.hamburgerMenuButton).toBeNull(); expect(env.component['isExpanded']).toBe(false); // The user clicks in the My projects component to open another project. - env.navigateFully(['projects', 'project02']); + await env.navigateFully(['projects', 'project02']); // The drawer should not be showing, but is in the dom. expect(env.isDrawerVisible).toBe(false); expect(env.component['isExpanded']).toBe(false); @@ -238,9 +241,10 @@ describe('AppComponent', () => { flush(); })); - it('does not set user locale when stored locale matches the browsing session', fakeAsync(() => { + it('does not set user locale when stored locale matches the browsing session', fakeAsync(async () => { const env = new TestEnvironment(); - env.navigate(['/projects', 'project01']); + await env.navigate(['/projects', 'project01']); + flush(); env.init(); tick(); @@ -248,11 +252,12 @@ describe('AppComponent', () => { verify(mockedAuthService.updateInterfaceLanguage(anything())).never(); })); - it('sets user locale when stored locale does not match the browsing session', fakeAsync(() => { + it('sets user locale when stored locale does not match the browsing session', fakeAsync(async () => { const env = new TestEnvironment(); when(mockedAuthService.isNewlyLoggedIn).thenResolve(true); when(mockedI18nService.localeCode).thenReturn('es'); - env.navigate(['/projects', 'project01']); + await env.navigate(['/projects', 'project01']); + flush(); env.init(); tick(); @@ -265,11 +270,12 @@ describe('AppComponent', () => { verify(mockedI18nService.setLocale('pt-BR')).once(); })); - it('should not set user locale when not newly logged in and stored locale does not match the browsing session', fakeAsync(() => { + it('should not set user locale when not newly logged in and stored locale does not match the browsing session', fakeAsync(async () => { const env = new TestEnvironment(); when(mockedAuthService.isNewlyLoggedIn).thenResolve(false); when(mockedI18nService.localeCode).thenReturn('es'); - env.navigate(['/projects', 'project01']); + await env.navigate(['/projects', 'project01']); + flush(); env.init(); tick(); @@ -277,9 +283,10 @@ describe('AppComponent', () => { verify(mockedI18nService.setLocale('en')).never(); })); - it('set interface language when specifically setting locale', fakeAsync(() => { + it('set interface language when specifically setting locale', fakeAsync(async () => { const env = new TestEnvironment(); - env.navigate(['/projects', 'project01']); + await env.navigate(['/projects', 'project01']); + flush(); env.init(); tick(); @@ -290,15 +297,16 @@ describe('AppComponent', () => { verify(mockedAuthService.updateInterfaceLanguage('pt-BR')).once(); })); - it('response to remote project deletion', fakeAsync(() => { + it('response to remote project deletion', fakeAsync(async () => { const env = new TestEnvironment(); - env.navigate(['/projects', 'project01']); + await env.navigate(['/projects', 'project01']); + flush(); env.init(); expect(env.isDrawerVisible).toEqual(true); expect(env.selectedProjectId).toEqual('project01'); // SUT - env.deleteProject('project01', false); + await env.deleteProject('project01', false); verify(mockedDialogService.message(anything())).once(); verify(mockedUserService.setCurrentProjectId(anything(), undefined)).once(); // Get past setTimeout to navigation @@ -309,88 +317,95 @@ describe('AppComponent', () => { expect(env.location.path()).toEqual('/projects'); })); - it('response to remote project deletion when no project selected', fakeAsync(() => { + it('response to remote project deletion when no project selected', fakeAsync(async () => { // If we are at the My Projects list at /projects, and a project is deleted, we should still be at the /projects // page. Note that one difference between some other project being deleted, vs the _current_ project being deleted, // is that AppComponent listens to the current project for its deletion. const env = new TestEnvironment(); - env.navigate(['/projects']); + await env.navigate(['/projects']); + flush(); env.init(); - env.deleteProject('project01', false); + await env.deleteProject('project01', false); // The drawer is not visible because we will be showing the project list. expect(env.isDrawerVisible).toEqual(false); expect(env.location.path()).toEqual('/projects'); })); - it('response to removed from project', fakeAsync(() => { + it('response to removed from project', fakeAsync(async () => { const env = new TestEnvironment(); - env.navigate(['/projects', 'project01']); + await env.navigate(['/projects', 'project01']); + flush(); env.init(); expect(env.selectedProjectId).toEqual('project01'); - env.removeUserFromProject('project01'); + await env.removeUserFromProject('project01'); verify(mockedDialogService.message(anything())).once(); // Get past setTimeout to navigation tick(); expect(env.location.path()).toEqual('/projects'); })); - it('response to remote project change for serval admin', fakeAsync(() => { + it('response to remote project change for serval admin', fakeAsync(async () => { const env = new TestEnvironment(); env.setCurrentUser('user05'); - env.navigate(['/serval-administration', 'project01']); + await env.navigate(['/serval-administration', 'project01']); + flush(); when(mockedLocationService.pathname).thenReturn('/serval-administration/project01'); env.init(); expect(env.selectedProjectId).toEqual('project01'); - env.updatePreTranslate('project01'); + await env.updatePreTranslate('project01'); verify(mockedDialogService.message(anything())).never(); })); - it('response to remote project change for serval admin viewing event log', fakeAsync(() => { + it('response to remote project change for serval admin viewing event log', fakeAsync(async () => { const env = new TestEnvironment(); env.setCurrentUser('user05'); - env.navigate(['/serval-administration', 'project01']); + await env.navigate(['/serval-administration', 'project01']); + flush(); when(mockedLocationService.pathname).thenReturn('/projects/project01/event-log'); env.init(); expect(env.selectedProjectId).toEqual('project01'); // Simulate an op coming from another source - env.updatePreTranslate('project01'); + await env.updatePreTranslate('project01'); verify(mockedDialogService.message(anything())).never(); })); - it('response to Commenter project role changed', fakeAsync(() => { + it('response to Commenter project role changed', fakeAsync(async () => { const env = new TestEnvironment(); - env.navigate(['/projects', 'project01']); + await env.navigate(['/projects', 'project01']); + flush(); env.setCurrentUser('user04'); env.init(); expect(env.selectedProjectId).toEqual('project01'); when(mockedLocationService.pathname).thenReturn('/projects/project01/translate'); - env.changeUserRole('project01', 'user04', SFProjectRole.CommunityChecker); + await env.changeUserRole('project01', 'user04', SFProjectRole.CommunityChecker); expect(env.location.path()).toEqual('/projects/project01'); env.wait(); discardPeriodicTasks(); })); - it('response to Community Checker project role changed', fakeAsync(() => { + it('response to Community Checker project role changed', fakeAsync(async () => { const env = new TestEnvironment(); - env.navigate(['/projects', 'project01']); + await env.navigate(['/projects', 'project01']); + flush(); env.setCurrentUser('user02'); env.init(); expect(env.selectedProjectId).toEqual('project01'); when(mockedLocationService.pathname).thenReturn('/projects/project01/checking'); - env.changeUserRole('project01', 'user02', SFProjectRole.Viewer); + await env.changeUserRole('project01', 'user02', SFProjectRole.Viewer); expect(env.location.path()).toEqual('/projects/project01'); discardPeriodicTasks(); })); - it('shows banner when update is available', fakeAsync(() => { + it('shows banner when update is available', fakeAsync(async () => { const env = new TestEnvironment(); - env.navigate(['/projects', 'project01']); + await env.navigate(['/projects', 'project01']); + flush(); env.init(); expect(env.refreshButton).toBeNull(); @@ -403,9 +418,10 @@ describe('AppComponent', () => { tick(); })); - it('shows install badge and option when installing is available', fakeAsync(() => { + it('shows install badge and option when installing is available', fakeAsync(async () => { const env = new TestEnvironment(); - env.navigate(['/projects', 'project01']); + await env.navigate(['/projects', 'project01']); + flush(); env.init(); expect(env.installBadge).toBeNull(); @@ -417,9 +433,10 @@ describe('AppComponent', () => { env.showHideUserMenu(); })); - it('hide install badge after avatar menu click', fakeAsync(() => { + it('hide install badge after avatar menu click', fakeAsync(async () => { const env = new TestEnvironment(); - env.navigate(['/projects', 'project01']); + await env.navigate(['/projects', 'project01']); + flush(); env.init(); env.canInstall$.next(true); @@ -487,14 +504,14 @@ describe('AppComponent', () => { })); describe('Community Checking', () => { - it('ensure local storage is cleared when removed from project', fakeAsync(() => { + it('ensure local storage is cleared when removed from project', fakeAsync(async () => { const env = new TestEnvironment(); - env.navigate(['/projects', 'project01']); + await env.navigate(['/projects', 'project01']); + flush(); env.init(); - const projectId = 'project01'; expect(env.selectedProjectId).toEqual(projectId); - env.removeUserFromProject(projectId); + await env.removeUserFromProject(projectId); verify(mockedSFProjectService.localDelete(projectId)).once(); })); @@ -699,20 +716,21 @@ class TestEnvironment { this.addProjectUserConfig('project01', 'user03'); this.addProjectUserConfig('project01', 'user04'); - when(mockedSFProjectService.getProfile(anything(), anything())).thenCall((projectId, subscription) => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, projectId, subscription) + when(mockedSFProjectService.getProfile(anything(), anything())).thenCall( + async (projectId, subscription) => + await this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, projectId, subscription) ); when(mockedSFProjectService.getUserConfig(anything(), anything(), anything())).thenCall( - (projectId, userId, subscriber) => - this.realtimeService.subscribe(SFProjectUserConfigDoc.COLLECTION, `${projectId}:${userId}`, subscriber) + async (projectId, userId, subscriber) => + await this.realtimeService.subscribe(SFProjectUserConfigDoc.COLLECTION, `${projectId}:${userId}`, subscriber) ); when(mockedLocationService.pathname).thenReturn('/projects/project01/checking'); when(mockedAuthService.currentUserRoles).thenReturn([]); when(mockedAuthService.getAccessToken()).thenReturn(Promise.resolve('access_token')); when(mockedAuthService.isLoggedIn).thenCall(() => Promise.resolve(this.loggedInState$.getValue().loggedIn)); - when(mockedAuthService.loggedIn).thenCall(() => - firstValueFrom(this.loggedInState$.pipe(filter((state: any) => state.loggedIn))) + when(mockedAuthService.loggedIn).thenCall( + async () => await firstValueFrom(this.loggedInState$.pipe(filter((state: any) => state.loggedIn))) ); when(mockedAuthService.loggedInState$).thenReturn(this.loggedInState$); if (isLoggedIn) { @@ -820,8 +838,8 @@ class TestEnvironment { setCurrentUser(userId: string): void { when(mockedUserService.currentUserId).thenReturn(userId); - when(mockedUserService.getCurrentUser()).thenCall(() => - this.realtimeService.subscribe(UserDoc.COLLECTION, userId, new DocSubscription('spec')) + when(mockedUserService.getCurrentUser()).thenCall( + async () => await this.realtimeService.subscribe(UserDoc.COLLECTION, userId, new DocSubscription('spec')) ); } @@ -854,12 +872,12 @@ class TestEnvironment { this.wait(); } - navigate(commands: any[]): void { - this.ngZone.run(() => this.router.navigate(commands)).then(); + async navigate(commands: any[]): Promise { + await this.ngZone.run(async () => await this.router.navigate(commands)); } - navigateFully(commands: any[]): void { - this.ngZone.run(() => this.router.navigate(commands)).then(); + async navigateFully(commands: any[]): Promise { + await this.ngZone.run(async () => await this.router.navigate(commands)); flush(); this.fixture.detectChanges(); flush(); @@ -895,7 +913,7 @@ class TestEnvironment { projectId, new DocSubscription('spec') ); - projectDoc.delete(); + await projectDoc.delete(); }); this.wait(); } @@ -906,7 +924,7 @@ class TestEnvironment { projectId, new DocSubscription('spec') ); - projectDoc.submitJson0Op(op => op.unset(p => p.userRoles['user01']), false); + await projectDoc.submitJson0Op(op => op.unset(p => p.userRoles['user01']), false); this.wait(); } @@ -916,7 +934,7 @@ class TestEnvironment { projectId, new DocSubscription('spec') ); - projectDoc.submitJson0Op(op => op.set(p => p.translateConfig.preTranslate, true), false); + await projectDoc.submitJson0Op(op => op.set(p => p.translateConfig.preTranslate, true), false); this.wait(); } @@ -926,7 +944,10 @@ class TestEnvironment { projectId, new DocSubscription('spec') ); - projectDoc.submitJson0Op(op => op.set(p => p.userRoles['user01'], SFProjectRole.CommunityChecker), false); + await projectDoc.submitJson0Op( + op => op.set(p => p.userRoles['user01'], SFProjectRole.CommunityChecker), + false + ); (await this.getCurrentUserDoc()).submitJson0Op( op => op.add(u => u.sites['sf'].projects, 'project04'), false @@ -940,7 +961,7 @@ class TestEnvironment { projectId, new DocSubscription('spec') ); - projectDoc.submitJson0Op(op => op.set(p => p.userRoles[userId], role), false); + await projectDoc.submitJson0Op(op => op.set(p => p.userRoles[userId], role), false); this.wait(); } From 0e2ca241a41117f788b00c4cfd2ad1f1f9000c06 Mon Sep 17 00:00:00 2001 From: MarkS Date: Wed, 10 Sep 2025 15:55:10 -0600 Subject: [PATCH 25/42] adjust permissions service spec --- .../ClientApp/src/app/core/permissions.service.spec.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts index eadc0ce5bb4..e293a6b037f 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts @@ -24,6 +24,7 @@ import { SFProjectService } from './sf-project.service'; const mockedUserService = mock(UserService); const mockedProjectService = mock(SFProjectService); const mockedProjectDoc = mock(SFProjectProfileDoc); + describe('PermissionsService', () => { configureTestingModule(() => ({ imports: [TestRealtimeModule.forRoot(SF_TYPE_REGISTRY)], @@ -251,8 +252,8 @@ class TestEnvironment { constructor(readonly checkingEnabled = true) { this.service = TestBed.inject(PermissionsService); - when(mockedProjectService.getProfile(anything(), anything())).thenCall(id => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id, new DocSubscription('spec')) + when(mockedProjectService.getProfile(anything(), anything())).thenCall( + async id => await this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, id, new DocSubscription('spec')) ); this.setProjectProfile(); @@ -300,8 +301,8 @@ class TestEnvironment { setCurrentUser(userId: string = 'user01'): void { when(mockedUserService.currentUserId).thenReturn(userId); - when(mockedUserService.getCurrentUser()).thenCall(() => - this.realtimeService.subscribe(UserDoc.COLLECTION, userId, new DocSubscription('spec')) + when(mockedUserService.getCurrentUser()).thenCall( + async () => await this.realtimeService.subscribe(UserDoc.COLLECTION, userId, new DocSubscription('spec')) ); } From b61fefd98578efb1ca54064528af1943e9ea6696 Mon Sep 17 00:00:00 2001 From: MarkS Date: Wed, 10 Sep 2025 16:08:00 -0600 Subject: [PATCH 26/42] fix tests in connect-project.component --- .../connect-project.component.spec.ts | 33 ++++++++++--------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts index 4707271c739..6909efd0cd9 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/connect-project/connect-project.component.spec.ts @@ -149,7 +149,7 @@ describe('ConnectProjectComponent', () => { expect(env.component.state).toEqual('offline'); })); - it('should create when non-existent project is selected', fakeAsync(() => { + it('should create when non-existent project is selected', fakeAsync(async () => { const env = new TestEnvironment(); env.setupDefaultProjectData(); env.waitForProjectsResponse(); @@ -166,8 +166,8 @@ describe('ConnectProjectComponent', () => { expect(env.component.state).toEqual('connecting'); expect(env.submitButton).toBeNull(); expect(env.progressBar).not.toBeNull(); - env.setQueuedCount(); - env.emitSyncComplete(); + await env.setQueuedCount(); + await env.emitSyncComplete(); const settings: SFProjectCreateSettings = { paratextId: 'pt01', @@ -178,7 +178,7 @@ describe('ConnectProjectComponent', () => { verify(mockedRouter.navigate(deepEqual(['/projects', 'project01']))).once(); })); - it('should create when no setting is selected', fakeAsync(() => { + it('should create when no setting is selected', fakeAsync(async () => { const env = new TestEnvironment(); env.setupDefaultProjectData(); env.waitForProjectsResponse(); @@ -190,8 +190,8 @@ describe('ConnectProjectComponent', () => { expect(env.component.state).toEqual('connecting'); expect(env.progressBar).not.toBeNull(); - env.setQueuedCount(); - env.emitSyncComplete(); + await env.setQueuedCount(); + await env.emitSyncComplete(); const project: SFProjectCreateSettings = { paratextId: 'pt01', @@ -236,7 +236,7 @@ describe('ConnectProjectComponent', () => { verify(mockedRouter.navigate(deepEqual(['/projects', 'project01']))).never(); })); - it('shows error message when resources fail to load, but still allows selecting a based on project', fakeAsync(() => { + it('shows error message when resources fail to load, but still allows selecting a based on project', fakeAsync(async () => { const env = new TestEnvironment(); env.setupDefaultProjectData(); when(mockedParatextService.getResources()).thenReject(new Error('Failed to fetch resources')); @@ -251,8 +251,8 @@ describe('ConnectProjectComponent', () => { env.clickElement(env.submitButton); expect(env.component.state).toEqual('connecting'); - env.setQueuedCount(); - env.emitSyncComplete(); + await env.setQueuedCount(); + await env.emitSyncComplete(); const settings: SFProjectCreateSettings = { paratextId: 'pt01', @@ -353,7 +353,7 @@ class TestEnvironment { private readonly realtimeService: TestRealtimeService = TestBed.inject(TestRealtimeService); constructor(params: TestEnvironmentParams = { paratextId: null }) { - when(mockedSFProjectService.onlineCreate(anything())).thenCall((settings: SFProjectCreateSettings) => { + when(mockedSFProjectService.onlineCreate(anything())).thenCall(async (settings: SFProjectCreateSettings) => { const newProject: SFProject = createTestProject({ paratextId: settings.paratextId, translateConfig: { @@ -378,11 +378,12 @@ class TestEnvironment { }, paratextUsers: [{ sfUserId: 'user01', username: 'ptuser01', opaqueUserId: 'opaqueuser01' }] }); - this.realtimeService.create(SFProjectDoc.COLLECTION, 'project01', newProject, new DocSubscription('spec')); - return Promise.resolve('project01'); + await this.realtimeService.create(SFProjectDoc.COLLECTION, 'project01', newProject, new DocSubscription('spec')); + return 'project01'; }); - when(mockedSFProjectService.subscribe('project01', anything())).thenCall(() => - this.realtimeService.subscribe(SFProjectDoc.COLLECTION, 'project01', new DocSubscription('spec')) + when(mockedSFProjectService.subscribe('project01', anything())).thenCall( + async () => + await this.realtimeService.subscribe(SFProjectDoc.COLLECTION, 'project01', new DocSubscription('spec')) ); if (params.paratextId === undefined) { when(mockedRouter.getCurrentNavigation()).thenReturn({ extras: {} } as any); @@ -490,7 +491,7 @@ class TestEnvironment { 'project01', new DocSubscription('spec') ); - projectDoc.submitJson0Op(op => op.set(p => p.sync.queuedCount, 1), false); + await projectDoc.submitJson0Op(op => op.set(p => p.sync.queuedCount, 1), false); tick(); this.fixture.detectChanges(); } @@ -501,7 +502,7 @@ class TestEnvironment { 'project01', new DocSubscription('spec') ); - projectDoc.submitJson0Op(op => { + await projectDoc.submitJson0Op(op => { op.set(p => p.sync.queuedCount, 0); op.set(p => p.sync.lastSyncSuccessful!, true); op.set(p => p.sync.dateLastSuccessfulSync!, new Date().toJSON()); From 26cc69891df7df19670d6a180b093b51e25acac4 Mon Sep 17 00:00:00 2001 From: MarkS Date: Wed, 10 Sep 2025 16:46:01 -0600 Subject: [PATCH 27/42] fix most of the tests in editor.component --- .../translate/editor/editor.component.spec.ts | 65 ++++++++++--------- 1 file changed, 33 insertions(+), 32 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts index 21751f4253e..a6dc3dd9517 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts @@ -222,7 +222,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('response to remote text deletion', fakeAsync(() => { + it('response to remote text deletion', fakeAsync(async () => { const env = new TestEnvironment(); flush(); env.routeWithParams({ projectId: 'project02', bookId: 'MAT' }); @@ -232,7 +232,7 @@ describe('EditorComponent', () => { env.setupDialogRef(); const textDocId = new TextDocId('project02', 40, 1, 'target'); - env.deleteText(textDocId.toString()); + await env.deleteText(textDocId.toString()); expect(dialogMessage).toHaveBeenCalledTimes(1); tick(); expect(env.location.path()).toEqual('/projects/project02/translate'); @@ -251,7 +251,7 @@ describe('EditorComponent', () => { expect(env.component.target!.segmentRef).toEqual('verse_2_1'); const projectUserConfigDoc: SFProjectUserConfigDoc = await env.getProjectUserConfigDoc(); - projectUserConfigDoc.submitJson0Op(op => op.set(puc => puc.selectedSegment, 'verse_2_2'), false); + await projectUserConfigDoc.submitJson0Op(op => op.set(puc => puc.selectedSegment, 'verse_2_2'), false); env.wait(); expect(env.component.target!.segmentRef).toEqual('verse_2_1'); @@ -961,7 +961,9 @@ describe('EditorComponent', () => { expect(env.component.target!.segmentRef).toBe('verse_1_1'); expect(env.component.target!.segment!.initialChecksum).toBe(0); - (await env.getProjectUserConfigDoc()).submitJson0Op(op => op.unset(puc => puc.selectedSegmentChecksum!), false); + await ( + await env.getProjectUserConfigDoc() + ).submitJson0Op(op => op.unset(puc => puc.selectedSegmentChecksum!), false); env.wait(); expect(env.component.target!.segmentRef).toBe('verse_1_1'); expect(env.component.target!.segment!.initialChecksum).not.toBe(0); @@ -1140,7 +1142,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('user can edit a chapter with permission', fakeAsync(() => { + it('user can edit a chapter with permission', fakeAsync(async () => { const env = new TestEnvironment(); env.setCurrentUser('user03'); env.setProjectUserConfig({ selectedBookNum: 42, selectedChapterNum: 2 }); @@ -1158,7 +1160,7 @@ describe('EditorComponent', () => { const sourceText = env.sourceTextEditorPlaceholder.getAttribute('data-placeholder'); expect(sourceText).toEqual('This book is empty. Add chapters in Paratext.'); - env.setDataInSync('project01', false); + await env.setDataInSync('project01', false); expect(env.component.canEdit).toBe(false); expect(env.outOfSyncWarning).not.toBeNull(); env.dispose(); @@ -1225,9 +1227,9 @@ describe('EditorComponent', () => { verify(env.mockedRemoteTranslationEngine.getWordGraph(anything())).once(); // Change user role on the project and run a sync to force remote updates - env.changeUserRole(projectId, userId, SFProjectRole.Viewer); - env.setDataInSync(projectId, true, false); - env.setDataInSync(projectId, false, false); + await env.changeUserRole(projectId, userId, SFProjectRole.Viewer); + await env.setDataInSync(projectId, true, false); + await env.setDataInSync(projectId, false, false); env.wait(); resetCalls(env.mockedRemoteTranslationEngine); @@ -1245,7 +1247,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('uses default font size', fakeAsync(() => { + it('uses default font size', fakeAsync(async () => { const env = new TestEnvironment(); env.setupProject({ defaultFontSize: 18 }); env.setProjectUserConfig(); @@ -1255,10 +1257,10 @@ describe('EditorComponent', () => { expect(env.targetTextEditor.style.fontSize).toEqual(18 / ptToRem + 'rem'); expect(env.sourceTextEditor.style.fontSize).toEqual(18 / ptToRem + 'rem'); - env.updateFontSize('project01', 24); + await env.updateFontSize('project01', 24); expect(env.component.fontSize).toEqual(24 / ptToRem + 'rem'); expect(env.targetTextEditor.style.fontSize).toEqual(24 / ptToRem + 'rem'); - env.updateFontSize('project02', 24); + await env.updateFontSize('project02', 24); expect(env.sourceTextEditor.style.fontSize).toEqual(24 / ptToRem + 'rem'); env.dispose(); })); @@ -1736,7 +1738,7 @@ describe('EditorComponent', () => { // active position of thread04 when reattached to verse 4 const position: TextAnchor = { start: 19, length: 5 }; // reattach thread04 from MAT 1:3 to MAT 1:4 - env.reattachNote('project01', 'dataid04', 'MAT 1:4', position); + await env.reattachNote('project01', 'dataid04', 'MAT 1:4', position); // SUT env.wait(); @@ -1755,7 +1757,7 @@ describe('EditorComponent', () => { const env = new TestEnvironment(); env.setProjectUserConfig(); // invalid reattachment string - env.reattachNote('project01', 'dataid04', 'MAT 1:4 invalid note error', undefined, true); + await env.reattachNote('project01', 'dataid04', 'MAT 1:4 invalid note error', undefined, true); // SUT env.wait(); @@ -1768,10 +1770,10 @@ describe('EditorComponent', () => { env.dispose(); })); - it('does not display conflict notes', fakeAsync(() => { + it('does not display conflict notes', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); - env.convertToConflictNote('project01', 'dataid02'); + await env.convertToConflictNote('project01', 'dataid02'); env.wait(); expect(env.getNoteThreadIconElement('verse_1_3', 'dataid02')).toBeNull(); @@ -2468,7 +2470,7 @@ describe('EditorComponent', () => { textDoc.submit(insertDelta); const note1Doc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); const anchor: TextAnchor = { start: 8 + insert.length, length: 12 }; - note1Doc.submitJson0Op(op => op.set(nt => nt.position, anchor)); + await note1Doc.submitJson0Op(op => op.set(nt => nt.position, anchor)); // SUT 3 env.wait(); @@ -2680,7 +2682,7 @@ describe('EditorComponent', () => { const index: number = noteThread.data!.notes.length - 1; const note: Note = noteThread.data!.notes[index]; note.tagId = 2; - noteThread.submitJson0Op(op => op.insert(nt => nt.notes, index, note), false); + await noteThread.submitJson0Op(op => op.insert(nt => nt.notes, index, note), false); verse1Note = verse1Segment.querySelector('display-note') as HTMLElement; expect(verse1Note.getAttribute('style')).toEqual(`--icon-file: url(/assets/icons/TagIcons/${newIconTag}.png);`); env.dispose(); @@ -3379,7 +3381,7 @@ describe('EditorComponent', () => { env.dispose(); })); - it('should remove resolved notes after a remote update', fakeAsync(() => { + it('should remove resolved notes after a remote update', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); @@ -3388,7 +3390,7 @@ describe('EditorComponent', () => { let noteThreadEmbedCount = env.countNoteThreadEmbeds(contents.ops!); expect(noteThreadEmbedCount).toEqual(5); - env.resolveNote('project01', 'dataid01'); + await env.resolveNote('project01', 'dataid01'); contents = env.targetEditor.getContents(); noteThreadEmbedCount = env.countNoteThreadEmbeds(contents.ops!); expect(noteThreadEmbedCount).toEqual(4); @@ -3404,7 +3406,7 @@ describe('EditorComponent', () => { const segmentRef = 'verse_1_3'; let thread2Elem: HTMLElement | null = env.getNoteThreadIconElement(segmentRef, threadId); expect(thread2Elem).not.toBeNull(); - env.deleteMostRecentNote('project01', segmentRef, threadId); + await env.deleteMostRecentNote('project01', segmentRef, threadId); thread2Elem = env.getNoteThreadIconElement(segmentRef, threadId); expect(thread2Elem).toBeNull(); @@ -4207,15 +4209,14 @@ describe('EditorComponent', () => { }); })); - it('should not throw exception on remote change when source is undefined', fakeAsync(() => { + it('should not throw exception on remote change when source is undefined', fakeAsync(async () => { const env = new TestEnvironment(); env.setProjectUserConfig(); env.wait(); env.component.source = undefined; - - expect(() => env.updateFontSize('project01', 24)).not.toThrow(); - + await expectAsync(env.updateFontSize('project01', 24)).not.toBeRejected(); + flush(); env.dispose(); })); }); @@ -5268,7 +5269,7 @@ class TestEnvironment { async setDataInSync(projectId: string, isInSync: boolean, source?: any): Promise { const projectDoc: SFProjectProfileDoc = await this.getProjectDoc(projectId); - projectDoc.submitJson0Op(op => op.set(p => p.sync.dataInSync!, isInSync), source); + await projectDoc.submitJson0Op(op => op.set(p => p.sync.dataInSync!, isInSync), source); tick(); this.fixture.detectChanges(); } @@ -5285,7 +5286,7 @@ class TestEnvironment { async updateFontSize(projectId: string, size: number): Promise { const projectDoc: SFProjectProfileDoc = await this.getProjectDoc(projectId); - projectDoc.submitJson0Op(op => op.set(p => p.defaultFontSize, size), false); + await projectDoc.submitJson0Op(op => op.set(p => p.defaultFontSize, size), false); tick(); this.fixture.detectChanges(); } @@ -5329,7 +5330,7 @@ class TestEnvironment { const projectDoc: SFProjectProfileDoc = await this.getProjectDoc(projectId); const userRoles = cloneDeep(this.userRolesOnProject); userRoles[userId] = role; - projectDoc.submitJson0Op(op => op.set(p => p.userRoles, userRoles), false); + await projectDoc.submitJson0Op(op => op.set(p => p.userRoles, userRoles), false); this.wait(); } @@ -5590,7 +5591,7 @@ class TestEnvironment { reattached }; const index: number = noteThreadDoc.data!.notes.length; - noteThreadDoc.submitJson0Op(op => { + await noteThreadDoc.submitJson0Op(op => { op.set(nt => nt.position, position); op.insert(nt => nt.notes, index, note); }); @@ -5598,7 +5599,7 @@ class TestEnvironment { async convertToConflictNote(projectId: string, threadDataId: string): Promise { const noteThreadDoc: NoteThreadDoc = await this.getNoteThreadDoc(projectId, threadDataId); - noteThreadDoc.submitJson0Op(op => { + await noteThreadDoc.submitJson0Op(op => { op.set(nt => nt.notes[0].conflictType, NoteConflictType.VerseTextConflict); op.set(nt => nt.notes[0].type, NoteType.Conflict); }); @@ -5616,7 +5617,7 @@ class TestEnvironment { async resolveNote(projectId: string, threadId: string): Promise { const noteDoc: NoteThreadDoc = await this.getNoteThreadDoc(projectId, threadId); - noteDoc.submitJson0Op(op => op.set(n => n.status, NoteStatus.Resolved)); + await noteDoc.submitJson0Op(op => op.set(n => n.status, NoteStatus.Resolved)); this.realtimeService.updateQueryAdaptersRemote(); this.wait(); } @@ -5626,7 +5627,7 @@ class TestEnvironment { noteThreadIconElem.click(); this.wait(); const noteDoc: NoteThreadDoc = await this.getNoteThreadDoc(projectId, threadId); - noteDoc.submitJson0Op(op => op.set(d => d.notes[0].deleted, true)); + await noteDoc.submitJson0Op(op => op.set(d => d.notes[0].deleted, true)); this.mockNoteDialogRef.close({ deleted: true }); this.realtimeService.updateQueryAdaptersRemote(); this.wait(); From ac72eed788821e873c57d2c93a3a16c2a3f9efed Mon Sep 17 00:00:00 2001 From: MarkS Date: Fri, 12 Sep 2025 15:23:14 -0600 Subject: [PATCH 28/42] some fixes to share dialog component --- .../shared/share/share-dialog.component.spec.ts | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts index d2daec67183..869442c290b 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts @@ -283,21 +283,21 @@ describe('ShareDialogComponent', () => { expect(env.configLinkUsage).toBeTruthy(); })); - it('should close dialog if project settings change and sharing becomes disabled', fakeAsync(() => { + it('should close dialog if project settings change and sharing becomes disabled', fakeAsync(async () => { env = new TestEnvironment({ userId: TestUsers.CommunityChecker, translateShareEnabled: false }); expect(env.isDialogOpen).toBe(true); - env.disableCheckingSharing(); + await env.disableCheckingSharing(); expect(env.isDialogOpen).toBe(false); })); - it('should remove checking role as an option if remote project settings change', fakeAsync(() => { + it('should remove checking role as an option if remote project settings change', fakeAsync(async () => { env = new TestEnvironment({ userId: TestUsers.Admin }); let roles: SFProjectRole[] = env.component.availableRoles; expect(roles).toContain(SFProjectRole.CommunityChecker); expect(roles).toContain(SFProjectRole.Viewer); expect(env.canChangeLinkUsage).toBe(true); - env.disableCheckingSharing(); + await env.disableCheckingSharing(); roles = env.component.availableRoles; expect(roles).not.toContain(SFProjectRole.CommunityChecker); @@ -406,8 +406,9 @@ class TestEnvironment { return Promise.resolve(undefined); } } as Clipboard); - when(mockedProjectService.getProfile(anything(), anything())).thenCall((projectId, subscription) => - this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, projectId, subscription) + when(mockedProjectService.getProfile(anything(), anything())).thenCall( + async (projectId, subscription) => + await this.realtimeService.subscribe(SFProjectProfileDoc.COLLECTION, projectId, subscription) ); when(mockedUserService.currentUserId).thenReturn(userId); when(mockedUserService.getCurrentUser()).thenResolve({ data: createTestUser() } as UserDoc); @@ -499,7 +500,7 @@ class TestEnvironment { 'project01', new DocSubscription('spec') ); - projectDoc.submitJson0Op( + await projectDoc.submitJson0Op( op => op.set(p => p.checkingConfig, { checkingEnabled: false, From f3d595c193cc5f97bd722afc07e7fa38702a3869 Mon Sep 17 00:00:00 2001 From: MarkS Date: Fri, 12 Sep 2025 15:37:00 -0600 Subject: [PATCH 29/42] share dialog - overlayContainer.ngOnDestroy --- .../src/app/shared/share/share-dialog.component.spec.ts | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts index 869442c290b..ba614e1388c 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts @@ -1,3 +1,4 @@ +import { OverlayContainer } from '@angular/cdk/overlay'; import { DebugElement, NgModule } from '@angular/core'; import { ComponentFixture, fakeAsync, flush, TestBed, tick } from '@angular/core/testing'; import { MatDialog, MatDialogConfig, MatDialogRef } from '@angular/material/dialog'; @@ -50,11 +51,19 @@ describe('ShareDialogComponent', () => { })); let env: TestEnvironment; + let overlayContainer: OverlayContainer; + + beforeEach(() => { + overlayContainer = TestBed.inject(OverlayContainer); + }); + afterEach(fakeAsync(() => { if (env.closeButton != null) { env.clickElement(env.closeButton); } flush(); + // Prevents 'Error: Test did not clean up its overlay container content.' + overlayContainer.ngOnDestroy(); })); it('shows share button when sharing API is supported', fakeAsync(() => { From 5c4bc55c9b22854cf58e8ee3dd31a349a22122f2 Mon Sep 17 00:00:00 2001 From: MarkS Date: Fri, 12 Sep 2025 15:44:45 -0600 Subject: [PATCH 30/42] fix share dialog component tests --- .../src/app/shared/share/share-dialog.component.spec.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts index ba614e1388c..c975cd39c11 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/shared/share/share-dialog.component.spec.ts @@ -352,7 +352,8 @@ interface TestEnvironmentArgs { } @NgModule({ - imports: [TestTranslocoModule] + imports: [TestTranslocoModule], + declarations: [ShareDialogComponent] }) class DialogTestModule {} From 6995543bc1642b762602801408cb8ecf43fa7daa Mon Sep 17 00:00:00 2001 From: MarkS Date: Fri, 12 Sep 2025 15:51:22 -0600 Subject: [PATCH 31/42] fix tests in translate overview component --- .../translate-overview.component.spec.ts | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts index f6288f2fd98..c65ac6cd04d 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/translate-overview/translate-overview.component.spec.ts @@ -118,13 +118,13 @@ describe('TranslateOverviewComponent', () => { discardPeriodicTasks(); })); - it('should start training engine if not initially enabled', fakeAsync(() => { + it('should start training engine if not initially enabled', fakeAsync(async () => { const env = new TestEnvironment({ translationSuggestionsEnabled: false }); env.wait(); verify(env.mockedRemoteTranslationEngine.listenForTrainingStatus()).never(); expect(env.retrainButton).toBeNull(); - env.simulateTranslateSuggestionsEnabled(); + await env.simulateTranslateSuggestionsEnabled(); verify(env.mockedRemoteTranslationEngine.listenForTrainingStatus()).twice(); expect(env.retrainButton).toBeTruthy(); @@ -207,12 +207,12 @@ describe('TranslateOverviewComponent', () => { discardPeriodicTasks(); })); - it('should not create engine if no source text docs', fakeAsync(() => { + it('should not create engine if no source text docs', fakeAsync(async () => { const env = new TestEnvironment({ translationSuggestionsEnabled: false }); when(mockedTranslationEngineService.checkHasSourceBooks(anything())).thenReturn(false); verify(mockedTranslationEngineService.createTranslationEngine(anything())).never(); expect(env.translationSuggestionsInfoMessage).toBeFalsy(); - env.simulateTranslateSuggestionsEnabled(true); + await env.simulateTranslateSuggestionsEnabled(true); verify(mockedTranslationEngineService.createTranslationEngine(anything())).never(); expect(env.translationSuggestionsInfoMessage).toBeTruthy(); env.clickRetrainButton(); @@ -335,8 +335,8 @@ class TestEnvironment { setCurrentUser(userId: string = 'user01'): void { when(mockedUserService.currentUserId).thenReturn(userId); - when(mockedUserService.getCurrentUser()).thenCall(() => - this.realtimeService.subscribe(UserDoc.COLLECTION, userId, new DocSubscription('spec')) + when(mockedUserService.getCurrentUser()).thenCall( + async () => await this.realtimeService.subscribe(UserDoc.COLLECTION, userId, new DocSubscription('spec')) ); } @@ -556,7 +556,7 @@ class TestEnvironment { getTextDocId('project01', bookNum, chapter), new DocSubscription('spec') ); - textDoc.submit({ ops: delta.ops }); + await textDoc.submit({ ops: delta.ops }); this.waitForProjectDocChanges(); } @@ -566,7 +566,7 @@ class TestEnvironment { 'project01', new DocSubscription('spec') ); - projectDoc.submitJson0Op( + await projectDoc.submitJson0Op( op => op.set(p => p.translateConfig.translationSuggestionsEnabled, enabled), false ); From 2c9523d198e3d3af89c7a84968e11cc5d7cbc1b7 Mon Sep 17 00:00:00 2001 From: MarkS Date: Mon, 15 Sep 2025 08:41:06 -0600 Subject: [PATCH 32/42] permissions service tests - fix injection errors about httpclient and transloc --- .../ClientApp/src/app/core/permissions.service.spec.ts | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts index e293a6b037f..b969005b254 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts @@ -1,4 +1,6 @@ -import { fakeAsync, TestBed } from '@angular/core/testing'; +import { provideHttpClient } from '@angular/common/http'; +import { provideHttpClientTesting } from '@angular/common/http/testing'; +import { fakeAsync, flush, TestBed } from '@angular/core/testing'; import { User } from '@bugsnag/js'; import { cloneDeep } from 'lodash-es'; import { createTestUser } from 'realtime-server/lib/esm/common/models/user-test-data'; @@ -12,7 +14,7 @@ import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserDoc } from 'xforge-common/models/user-doc'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; import { TestRealtimeService } from 'xforge-common/test-realtime.service'; -import { configureTestingModule } from 'xforge-common/test-utils'; +import { configureTestingModule, TestTranslocoModule } from 'xforge-common/test-utils'; import { UserService } from 'xforge-common/user.service'; import { SFProjectProfileDoc } from '../core/models/sf-project-profile-doc'; import { SF_TYPE_REGISTRY } from './models/sf-type-registry'; @@ -27,8 +29,10 @@ const mockedProjectDoc = mock(SFProjectProfileDoc); describe('PermissionsService', () => { configureTestingModule(() => ({ - imports: [TestRealtimeModule.forRoot(SF_TYPE_REGISTRY)], + imports: [TestRealtimeModule.forRoot(SF_TYPE_REGISTRY), TestTranslocoModule], providers: [ + provideHttpClient(), + provideHttpClientTesting(), { provide: UserService, useMock: mockedUserService }, { provide: SFProjectService, useMock: mockedProjectService } ] From a786539f72ce001d74705387e46ee2e7e8e8ba2d Mon Sep 17 00:00:00 2001 From: MarkS Date: Mon, 15 Sep 2025 10:00:35 -0600 Subject: [PATCH 33/42] fix permissions service spec by adding mockSFUserProjectsService --- .../src/app/core/permissions.service.spec.ts | 69 +++++++++++-------- 1 file changed, 39 insertions(+), 30 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts index b969005b254..e2d190191fc 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/core/permissions.service.spec.ts @@ -1,6 +1,6 @@ import { provideHttpClient } from '@angular/common/http'; import { provideHttpClientTesting } from '@angular/common/http/testing'; -import { fakeAsync, flush, TestBed } from '@angular/core/testing'; +import { fakeAsync, TestBed } from '@angular/core/testing'; import { User } from '@bugsnag/js'; import { cloneDeep } from 'lodash-es'; import { createTestUser } from 'realtime-server/lib/esm/common/models/user-test-data'; @@ -9,12 +9,14 @@ import { SFProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/ import { isParatextRole, SFProjectRole } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-role'; import { createTestProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-test-data'; import { TextInfoPermission } from 'realtime-server/lib/esm/scriptureforge/models/text-info-permission'; +import { of } from 'rxjs'; import { anything, instance, mock, verify, when } from 'ts-mockito'; import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { UserDoc } from 'xforge-common/models/user-doc'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; import { TestRealtimeService } from 'xforge-common/test-realtime.service'; import { configureTestingModule, TestTranslocoModule } from 'xforge-common/test-utils'; +import { SFUserProjectsService } from 'xforge-common/user-projects.service'; import { UserService } from 'xforge-common/user.service'; import { SFProjectProfileDoc } from '../core/models/sf-project-profile-doc'; import { SF_TYPE_REGISTRY } from './models/sf-type-registry'; @@ -25,6 +27,7 @@ import { SFProjectService } from './sf-project.service'; const mockedUserService = mock(UserService); const mockedProjectService = mock(SFProjectService); +const mockedUserProjectsService = mock(SFUserProjectsService); const mockedProjectDoc = mock(SFProjectProfileDoc); describe('PermissionsService', () => { @@ -34,7 +37,8 @@ describe('PermissionsService', () => { provideHttpClient(), provideHttpClientTesting(), { provide: UserService, useMock: mockedUserService }, - { provide: SFProjectService, useMock: mockedProjectService } + { provide: SFProjectService, useMock: mockedProjectService }, + { provide: SFUserProjectsService, useMock: mockedUserProjectsService } ] })); @@ -270,37 +274,42 @@ class TestEnvironment { const projectId: string = 'project01'; const permission: TextInfoPermission = textPermission ?? TextInfoPermission.Write; - this.realtimeService.addSnapshot(SFProjectProfileDoc.COLLECTION, { - id: projectId, - data: createTestProjectProfile({ - translateConfig: {}, - userRoles: { - user01: SFProjectRole.ParatextTranslator, - user02: SFProjectRole.ParatextConsultant - }, - texts: [ - { - bookNum: 41, - chapters: [ - { - number: 1, - lastVerse: 3, - isValid: true, - permissions: { - user01: permission, - user02: permission + const projectProfileDocs: SFProjectProfileDoc[] = [ + { + id: projectId, + data: createTestProjectProfile({ + translateConfig: {}, + userRoles: { + user01: SFProjectRole.ParatextTranslator, + user02: SFProjectRole.ParatextConsultant + }, + texts: [ + { + bookNum: 41, + chapters: [ + { + number: 1, + lastVerse: 3, + isValid: true, + permissions: { + user01: permission, + user02: permission + } } + ], + hasSource: true, + permissions: { + user01: permission, + user02: permission } - ], - hasSource: true, - permissions: { - user01: permission, - user02: permission } - } - ] - }) - }); + ] + }) + } + ] as SFProjectProfileDoc[]; + + this.realtimeService.addSnapshots(SFProjectProfileDoc.COLLECTION, projectProfileDocs); + when(mockedUserProjectsService.projectDocs$).thenReturn(of(projectProfileDocs)); } setCurrentUser(userId: string = 'user01'): void { From bee03048af62463e4d92b085125561852e248edf Mon Sep 17 00:00:00 2001 From: MarkS Date: Mon, 15 Sep 2025 12:25:37 -0600 Subject: [PATCH 34/42] checking component spec some fixes --- .../checking/checking.component.spec.ts | 49 ++++++++++--------- .../xforge-common/user-projects.service.ts | 1 + 2 files changed, 26 insertions(+), 24 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts index 662003aa721..e3d0eb65320 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts @@ -818,21 +818,21 @@ describe('CheckingComponent', () => { env.waitForAudioPlayer(); })); - it('respond to remote question audio added or removed', fakeAsync(() => { + it('respond to remote question audio added or removed', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(1); expect(env.audioPlayerOnQuestion).toBeNull(); - env.simulateRemoteEditQuestionAudio('filename.mp3'); + await env.simulateRemoteEditQuestionAudio('filename.mp3'); expect(env.audioPlayerOnQuestion).not.toBeNull(); verify(mockedFileService.findOrUpdateCache(FileType.Audio, QuestionDoc.COLLECTION, 'q1Id', 'filename.mp3')).times( 5 ); resetCalls(mockedFileService); - env.simulateRemoteEditQuestionAudio(undefined); + await env.simulateRemoteEditQuestionAudio(undefined); expect(env.audioPlayerOnQuestion).toBeNull(); verify(mockedFileService.findOrUpdateCache(FileType.Audio, QuestionDoc.COLLECTION, 'q1Id', undefined)).times(5); env.selectQuestion(2); - env.simulateRemoteEditQuestionAudio('filename2.mp3'); + await env.simulateRemoteEditQuestionAudio('filename2.mp3'); env.waitForSliderUpdate(); verify( mockedFileService.findOrUpdateCache(FileType.Audio, QuestionDoc.COLLECTION, 'q2Id', 'filename2.mp3') @@ -840,7 +840,7 @@ describe('CheckingComponent', () => { flush(1000); })); - it('question added to another book changes the route to that book and activates the question', fakeAsync(() => { + it('question added to another book changes the route to that book and activates the question', fakeAsync(async () => { const env = new TestEnvironment({ user: ADMIN_USER }); const dateNow = new Date(); const newQuestion: Question = { @@ -855,9 +855,9 @@ describe('CheckingComponent', () => { dateModified: dateNow.toJSON() }; env.insertQuestion(newQuestion); - env.activateQuestion(newQuestion.dataId); + await env.activateQuestion(newQuestion.dataId); expect(env.location.path()).toEqual('/projects/project01/checking/MAT/1?scope=book'); - env.activateQuestion('q1Id'); + await env.activateQuestion('q1Id'); expect(env.location.path()).toEqual('/projects/project01/checking/JHN/1?scope=book'); flush(1000); })); @@ -1386,7 +1386,7 @@ describe('CheckingComponent', () => { flush(1000); })); - it('does not save the answer when storage quota exceeded', fakeAsync(() => { + it('does not save the answer when storage quota exceeded', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); when( mockedFileService.uploadFile( @@ -1415,7 +1415,7 @@ describe('CheckingComponent', () => { blob: getAudioBlob() } }; - env.component.answerAction(answerAction); + await env.component.answerAction(answerAction); env.waitForSliderUpdate(); const questionDoc = env.component.questionsList!.activeQuestionDoc!; expect(questionDoc.data!.answers.length).toEqual(0); @@ -2295,7 +2295,7 @@ describe('CheckingComponent', () => { const questionDoc = spy(await env.getQuestionDoc('q6Id')); env.selectQuestion(6); verify(questionDoc!.updateAnswerFileCache()).times(1); - env.simulateRemoteDeleteAnswer('q6Id', 0); + await env.simulateRemoteDeleteAnswer('q6Id', 0); verify(questionDoc!.updateAnswerFileCache()).times(2); expect().nothing(); tick(); @@ -2641,7 +2641,7 @@ describe('CheckingComponent', () => { discardPeriodicTasks(); })); - it('notifies admin if chapter audio is absent and hide scripture text is enabled', fakeAsync(() => { + it('notifies admin if chapter audio is absent and hide scripture text is enabled', fakeAsync(async () => { const env = new TestEnvironment({ user: ADMIN_USER, projectBookRoute: 'MAT', @@ -2662,7 +2662,7 @@ describe('CheckingComponent', () => { }); }); - env.component.addAudioTimingData(); + await env.component.addAudioTimingData(); env.waitForQuestionTimersToComplete(); env.fixture.detectChanges(); @@ -3585,8 +3585,8 @@ class TestEnvironment { } ]); - when(mockedProjectService.getProfile(anything(), anything())).thenCall((id, subscriber) => - this.realtimeService.subscribe(SFProjectDoc.COLLECTION, id, subscriber) + when(mockedProjectService.getProfile(anything(), anything())).thenCall( + async (id, subscriber) => await this.realtimeService.subscribe(SFProjectDoc.COLLECTION, id, subscriber) ); when(mockedProjectService.isProjectAdmin(anything(), anything())).thenResolve( user.role === SFProjectRole.ParatextAdministrator @@ -3618,12 +3618,13 @@ class TestEnvironment { data: this.consultantProjectUserConfig } ]); - when(mockedProjectService.getUserConfig(anything(), anything(), anything())).thenCall((id, userId, subscriber) => - this.realtimeService.subscribe( - SFProjectUserConfigDoc.COLLECTION, - getSFProjectUserConfigDocId(id, userId), - subscriber - ) + when(mockedProjectService.getUserConfig(anything(), anything(), anything())).thenCall( + async (id, userId, subscriber) => + await this.realtimeService.subscribe( + SFProjectUserConfigDoc.COLLECTION, + getSFProjectUserConfigDocId(id, userId), + subscriber + ) ); this.realtimeService.addSnapshots(TextDoc.COLLECTION, [ @@ -3653,8 +3654,8 @@ class TestEnvironment { type: RichText.type.name } ]); - when(mockedProjectService.getText(anything(), anything())).thenCall((id, subscriber) => - this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString(), subscriber) + when(mockedProjectService.getText(anything(), anything())).thenCall( + async (id, subscriber) => await this.realtimeService.subscribe(TextDoc.COLLECTION, id.toString(), subscriber) ); when(mockedActivatedRoute.params).thenReturn(this.params$); when(mockedActivatedRoute.queryParams).thenReturn(this.queryParams$); @@ -3666,8 +3667,8 @@ class TestEnvironment { data: user.user } ]); - when(mockedUserService.getCurrentUser()).thenCall(() => - this.realtimeService.subscribe(UserDoc.COLLECTION, user.id, new DocSubscription('spec')) + when(mockedUserService.getCurrentUser()).thenCall( + async () => await this.realtimeService.subscribe(UserDoc.COLLECTION, user.id, new DocSubscription('spec')) ); this.realtimeService.addSnapshots(UserProfileDoc.COLLECTION, [ diff --git a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/user-projects.service.ts b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/user-projects.service.ts index f7eaf014f93..6e731a72b1b 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/user-projects.service.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/xforge-common/user-projects.service.ts @@ -9,6 +9,7 @@ import { AuthService, LoginResult } from './auth.service'; import { DocSubscription } from './models/realtime-doc'; import { UserDoc } from './models/user-doc'; import { UserService } from './user.service'; + /** Service that maintains an up-to-date set of SF project docs that the current user has access to. */ @Injectable({ providedIn: 'root' From 344ea9ab8cb3875e9fe1f7922483a04437273e25 Mon Sep 17 00:00:00 2001 From: MarkS Date: Mon, 15 Sep 2025 16:04:40 -0600 Subject: [PATCH 35/42] checking spec await --- .../src/app/checking/checking/checking.component.spec.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts index e3d0eb65320..6000b91e3d6 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts @@ -652,7 +652,7 @@ describe('CheckingComponent', () => { // Simulate going online after the answer is edited resetCalls(mockedFileService); env.onlineStatus = true; - env.fileSyncComplete.next(); + env.fileSyncComplete$.next(); tick(); env.fixture.detectChanges(); expect(env.component.answersPanel?.getFileSource(questionDoc.data?.audioUrl)).toBeDefined(); @@ -2763,7 +2763,7 @@ class TestEnvironment { ) as TestOnlineStatusService; questionReadTimer: number = 2000; - fileSyncComplete: Subject = new Subject(); + fileSyncComplete$: Subject = new Subject(); private readonly params$: BehaviorSubject; private readonly queryParams$: BehaviorSubject; @@ -2842,7 +2842,7 @@ class TestEnvironment { when( mockedFileService.findOrUpdateCache(FileType.Audio, QuestionDoc.COLLECTION, anything(), undefined) ).thenResolve(undefined); - when(mockedFileService.fileSyncComplete$).thenReturn(this.fileSyncComplete); + when(mockedFileService.fileSyncComplete$).thenReturn(this.fileSyncComplete$); const query = mock(RealtimeQuery) as RealtimeQuery; when(query.remoteChanges$).thenReturn(new BehaviorSubject(undefined)); @@ -3535,7 +3535,7 @@ class TestEnvironment { async simulateRemoteDeleteAnswer(questionId: string, answerIndex: number): Promise { const questionDoc = await this.getQuestionDoc(questionId); - questionDoc.submitJson0Op(op => op.set(q => q.answers[answerIndex].deleted, true), false); + await questionDoc.submitJson0Op(op => op.set(q => q.answers[answerIndex].deleted, true), false); tick(this.questionReadTimer); this.fixture.detectChanges(); tick(); From 74b1d68fee37d0c4defd23b3f9ad0e1d34919de5 Mon Sep 17 00:00:00 2001 From: MarkS Date: Mon, 15 Sep 2025 16:51:41 -0600 Subject: [PATCH 36/42] checking component spec await --- .../checking/checking.component.spec.ts | 169 +++++++++--------- 1 file changed, 86 insertions(+), 83 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts index 6000b91e3d6..397e682c6f1 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts @@ -385,7 +385,7 @@ describe('CheckingComponent', () => { discardPeriodicTasks(); })); - it('responds to remote removed from project', fakeAsync(() => { + it('responds to remote removed from project', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER, projectBookRoute: 'JHN', @@ -394,7 +394,7 @@ describe('CheckingComponent', () => { }); env.selectQuestion(1); expect(env.component.questionDocs.length).toEqual(14); - env.component.projectDoc!.submitJson0Op(op => op.unset(p => p.userRoles[CHECKER_USER.id]), false); + await env.component.projectDoc!.submitJson0Op(op => op.unset(p => p.userRoles[CHECKER_USER.id]), false); env.waitForSliderUpdate(); expect(env.component.projectDoc).toBeUndefined(); expect(env.component.questionDocs.length).toEqual(0); @@ -402,23 +402,23 @@ describe('CheckingComponent', () => { flush(1000); })); - it('responds to remote community checking disabled when checker', fakeAsync(() => { + it('responds to remote community checking disabled when checker', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(1); const projectUserConfig = env.component.projectUserConfigDoc!.data!; expect(projectUserConfig.selectedTask).toEqual('checking'); expect(projectUserConfig.selectedQuestionRef).not.toBeNull(); - env.setCheckingEnabled(false); + await env.setCheckingEnabled(false); expect(env.component.projectDoc).toBeUndefined(); env.waitForSliderUpdate(); flush(1000); })); - it('responds to remote community checking disabled when observer', fakeAsync(() => { + it('responds to remote community checking disabled when observer', fakeAsync(async () => { // User with access to translate app should get redirected there const env = new TestEnvironment({ user: OBSERVER_USER, projectBookRoute: 'MAT', projectChapterRoute: 1 }); env.selectQuestion(1); - env.setCheckingEnabled(false); + await env.setCheckingEnabled(false); expect(env.component.projectDoc).toBeUndefined(); expect(env.component.questionDocs.length).toEqual(0); env.waitForSliderUpdate(); @@ -614,7 +614,7 @@ describe('CheckingComponent', () => { }); const questionId = 'q15Id'; const questionDoc = cloneDeep(await env.getQuestionDoc(questionId)); - questionDoc.submitJson0Op(op => { + await questionDoc.submitJson0Op(op => { op.unset(qd => qd.audioUrl!); }); when(mockedQuestionDialogService.questionDialog(anything())).thenResolve(questionDoc); @@ -644,7 +644,7 @@ describe('CheckingComponent', () => { const questionId = 'q14Id'; const questionDoc = cloneDeep(await env.getQuestionDoc(questionId)); expect(env.component.answersPanel?.getFileSource(questionDoc.data?.audioUrl)).toBeUndefined(); - questionDoc.submitJson0Op(op => { + await questionDoc.submitJson0Op(op => { op.set(qd => qd.audioUrl!, 'anAudioFile.mp3'); }); when(mockedQuestionDialogService.questionDialog(anything())).thenResolve(questionDoc); @@ -685,8 +685,8 @@ describe('CheckingComponent', () => { expect(env.isSegmentHighlighted(1, 1)).toBe(true); expect(env.segmentHasQuestion(1, 5)).toBe(false); expect(env.isSegmentHighlighted(1, 5)).toBe(false); - when(mockedQuestionDialogService.questionDialog(anything())).thenCall((config: QuestionDialogData) => { - config.questionDoc!.submitJson0Op(op => + when(mockedQuestionDialogService.questionDialog(anything())).thenCall(async (config: QuestionDialogData) => { + await config.questionDoc!.submitJson0Op(op => op.set(q => q.verseRef, { bookNum: 43, chapterNum: 1, verseNum: 5, verse: '5' }) ); return config.questionDoc; @@ -739,20 +739,20 @@ describe('CheckingComponent', () => { flush(1000); })); - it('unread answers badge is only visible when the setting is ON to see other answers', fakeAsync(() => { + it('unread answers badge is only visible when the setting is ON to see other answers', fakeAsync(async () => { const env = new TestEnvironment({ user: ADMIN_USER }); expect(env.getUnread(env.questions[5])).toEqual(1); - env.setSeeOtherUserResponses(false); + await env.setSeeOtherUserResponses(false); expect(env.getUnread(env.questions[5])).toEqual(0); flush(1000); discardPeriodicTasks(); })); - it('unread answers badge always hidden from community checkers', fakeAsync(() => { + it('unread answers badge always hidden from community checkers', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); // One unread answer and three comments are hidden expect(env.getUnread(env.questions[6])).toEqual(0); - env.setSeeOtherUserResponses(false); + await env.setSeeOtherUserResponses(false); expect(env.getUnread(env.questions[6])).toEqual(0); flush(1000); discardPeriodicTasks(); @@ -1344,12 +1344,12 @@ describe('CheckingComponent', () => { flush(1000); })); - it('saves the last visited question', fakeAsync(() => { + it('saves the last visited question', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); const projectUserConfigDoc = env.component.projectUserConfigDoc!.data!; verify(mockedTranslationEngineService.trainSelectedSegment(anything(), anything())).once(); expect(projectUserConfigDoc.selectedQuestionRef).toBe('project01:q5Id'); - env.component.projectDoc!.submitJson0Op(op => { + await env.component.projectDoc!.submitJson0Op(op => { op.set(p => p.translateConfig.translationSuggestionsEnabled, false); }); env.waitForSliderUpdate(); @@ -1489,27 +1489,27 @@ describe('CheckingComponent', () => { flush(1000); })); - it('highlights remotely edited answer', fakeAsync(() => { + it('highlights remotely edited answer', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(9); const otherAnswerIndex = 1; expect(env.getAnswer(otherAnswerIndex).classes['attention']).toBeUndefined(); expect(env.getAnswerText(otherAnswerIndex)).toBe('Answer 1 on question'); - env.simulateRemoteEditAnswer(otherAnswerIndex, 'Question 9 edited answer'); + await env.simulateRemoteEditAnswer(otherAnswerIndex, 'Question 9 edited answer'); expect(env.getAnswer(otherAnswerIndex).classes['attention']).toBe(true); expect(env.getAnswerText(otherAnswerIndex)).toBe('Question 9 edited answer'); flush(1000); })); - it('does not highlight upon sync', fakeAsync(() => { + it('does not highlight upon sync', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(9); const answerIndex = 1; expect(env.getAnswer(answerIndex).classes['attention']).toBeUndefined(); expect(env.getAnswerText(answerIndex)).toBe('Answer 1 on question'); - env.simulateSync(answerIndex); + await env.simulateSync(answerIndex); expect(env.getAnswer(answerIndex).classes['attention']).toBeUndefined(); expect(env.getAnswerText(answerIndex)).toBe('Answer 1 on question'); flush(1000); @@ -1705,14 +1705,14 @@ describe('CheckingComponent', () => { flush(1000); })); - it('hides the like icon if see other users responses is disabled', fakeAsync(() => { + it('hides the like icon if see other users responses is disabled', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(6); expect(env.answers.length).toEqual(1); expect(env.likeButtons.length).toEqual(1); - env.setSeeOtherUserResponses(false); + await env.setSeeOtherUserResponses(false); expect(env.likeButtons.length).toEqual(0); - env.setSeeOtherUserResponses(true); + await env.setSeeOtherUserResponses(true); expect(env.likeButtons.length).toEqual(1); })); @@ -1726,9 +1726,9 @@ describe('CheckingComponent', () => { flush(1000); })); - it('checker can only see their answers when the setting is OFF to see other answers', fakeAsync(() => { + it('checker can only see their answers when the setting is OFF to see other answers', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); - env.setSeeOtherUserResponses(false); + await env.setSeeOtherUserResponses(false); env.selectQuestion(6); expect(env.answers.length).toBe(1); env.selectQuestion(7); @@ -1788,7 +1788,7 @@ describe('CheckingComponent', () => { flush(1000); })); - it('new remote answers from other users are not displayed until requested', fakeAsync(() => { + it('new remote answers from other users are not displayed until requested', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(7); @@ -1804,7 +1804,7 @@ describe('CheckingComponent', () => { expect(env.showUnreadAnswersButton).toBeNull(); - env.simulateNewRemoteAnswer(); + await env.simulateNewRemoteAnswer(); // The new answer does not show up yet. expect(env.answers.length).toEqual(2); @@ -1826,7 +1826,7 @@ describe('CheckingComponent', () => { expect(env.totalAnswersMessageCount).toEqual(3); })); - it('new remote answers from other users are not displayed to proj admin until requested', fakeAsync(() => { + it('new remote answers from other users are not displayed to proj admin until requested', fakeAsync(async () => { const env = new TestEnvironment({ user: ADMIN_USER }); // Select a question with at least one answer, but with no answers // authored by the project admin since that was hindering this test. @@ -1837,7 +1837,7 @@ describe('CheckingComponent', () => { expect(env.showUnreadAnswersButton).toBeNull(); expect(env.totalAnswersMessageCount).toEqual(1); - env.simulateNewRemoteAnswer(); + await env.simulateNewRemoteAnswer(); // New remote answer is buffered rather than shown immediately. expect(env.answers.length).toEqual(1); @@ -1861,7 +1861,7 @@ describe('CheckingComponent', () => { expect(env.totalAnswersMessageCount).toEqual(2); })); - it('proj admin sees total answer count if >0 answers', fakeAsync(() => { + it('proj admin sees total answer count if >0 answers', fakeAsync(async () => { const env = new TestEnvironment({ user: ADMIN_USER }); // Select a question with at least one answer, but with no answers // authored by the project admin, in case that hinders this test. @@ -1872,19 +1872,19 @@ describe('CheckingComponent', () => { expect(env.showUnreadAnswersButton).toBeNull(); expect(env.totalAnswersMessageCount).toEqual(1); // Delete only answer on question. - env.deleteAnswer('a6Id'); + await env.deleteAnswer('a6Id'); // Total answers header goes away. expect(env.totalAnswersMessageCount).toBeNull(); // A remote answer is added - env.simulateNewRemoteAnswer('remoteAnswerId123'); + await env.simulateNewRemoteAnswer('remoteAnswerId123'); // The total answers header comes back. expect(env.totalAnswersMessageCount).toEqual(1); flush(1000); })); - it("new remote answers and banner don't show, if user has not yet answered the question", fakeAsync(() => { + it("new remote answers and banner don't show, if user has not yet answered the question", fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(7); expect(env.answers.length).withContext('setup (no answers in DOM yet)').toEqual(0); @@ -1892,7 +1892,7 @@ describe('CheckingComponent', () => { expect(env.totalAnswersMessageCount).toBeNull(); // Another user adds an answer, but with no impact on the current user's screen yet. - env.simulateNewRemoteAnswer(); + await env.simulateNewRemoteAnswer(); expect(env.showUnreadAnswersButton).toBeNull(); expect(env.answers.length).withContext('broken unrelated functionality').toEqual(0); // Incoming remote answer should have been absorbed into the set of @@ -1909,7 +1909,7 @@ describe('CheckingComponent', () => { flush(1000); })); - it('show-remote-answer banner disappears if user deletes their answer', fakeAsync(() => { + it('show-remote-answer banner disappears if user deletes their answer', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(7); // User answers a question @@ -1919,7 +1919,7 @@ describe('CheckingComponent', () => { expect(env.showUnreadAnswersButton).toBeNull(); // A remote answer is added, but the current user does not click the banner to show the remote answer. - env.simulateNewRemoteAnswer(); + await env.simulateNewRemoteAnswer(); expect(env.answers.length).toEqual(2); expect(env.component.answersPanel!.answers.length).toEqual(2); expect(env.showUnreadAnswersButton).not.toBeNull(); @@ -1948,7 +1948,7 @@ describe('CheckingComponent', () => { expect(env.totalAnswersMessageCount).toEqual(3); // A remote answer at this point makes the banner show, tho. - env.simulateNewRemoteAnswer('answerId12345', 'another remote answer'); + await env.simulateNewRemoteAnswer('answerId12345', 'another remote answer'); expect(env.answers.length).toEqual(3); expect(env.component.answersPanel!.answers.length).toEqual(3); expect(env.showUnreadAnswersButton).not.toBeNull(); @@ -1957,7 +1957,7 @@ describe('CheckingComponent', () => { flush(1000); })); - it('show-remote-answer banner disappears if the un-shown remote answer is deleted', fakeAsync(() => { + it('show-remote-answer banner disappears if the un-shown remote answer is deleted', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(7); // User answers a question @@ -1968,10 +1968,10 @@ describe('CheckingComponent', () => { expect(env.totalAnswersMessageCount).toEqual(2); // A remote answer is added and then deleted, before the current user clicks the banner to show the remote answer. - env.simulateNewRemoteAnswer('remoteAnswerId123'); + await env.simulateNewRemoteAnswer('remoteAnswerId123'); expect(env.showUnreadAnswersButton).not.toBeNull(); expect(env.totalAnswersMessageCount).toEqual(3); - env.deleteAnswer('remoteAnswerId123'); + await env.deleteAnswer('remoteAnswerId123'); expect(env.showUnreadAnswersButton).toBeNull(); expect(env.answers.length).toEqual(2); expect(env.component.answersPanel!.answers.length).toEqual(2); @@ -1980,7 +1980,7 @@ describe('CheckingComponent', () => { discardPeriodicTasks(); })); - it('show-remote-answer banner not shown if user is editing their answer', fakeAsync(() => { + it('show-remote-answer banner not shown if user is editing their answer', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(7); // User answers a question @@ -1988,7 +1988,7 @@ describe('CheckingComponent', () => { expect(env.showUnreadAnswersButton).withContext('setup').toBeNull(); expect(env.answers.length).withContext('setup').toEqual(2); // A remote answer is added, but the current user does not click the banner to show the remote answer. - env.simulateNewRemoteAnswer(); + await env.simulateNewRemoteAnswer(); expect(env.showUnreadAnswersButton).withContext('setup').not.toBeNull(); // The current user edits their own answer. env.clickButton(env.getAnswerEditButton(0)); @@ -2007,9 +2007,9 @@ describe('CheckingComponent', () => { flush(1000); })); - it('show-remote-answer banner not shown to user if see-others-answers is disabled', fakeAsync(() => { + it('show-remote-answer banner not shown to user if see-others-answers is disabled', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); - env.setSeeOtherUserResponses(false); + await env.setSeeOtherUserResponses(false); expect(env.component.projectDoc!.data!.checkingConfig.usersSeeEachOthersResponses) .withContext('setup') .toBe(false); @@ -2019,16 +2019,16 @@ describe('CheckingComponent', () => { expect(env.totalAnswersMessageText).withContext('setup').toEqual('Your answer'); // A remote answer is added. - env.simulateNewRemoteAnswer(); + await env.simulateNewRemoteAnswer(); expect(env.totalAnswersMessageText).toEqual('Your answer'); // Banner is not shown expect(env.showUnreadAnswersButton).toBeNull(); flush(1000); })); - it('show-remote-answer banner still shown to proj admin if see-others-answers is disabled', fakeAsync(() => { + it('show-remote-answer banner still shown to proj admin if see-others-answers is disabled', fakeAsync(async () => { const env = new TestEnvironment({ user: ADMIN_USER }); - env.setSeeOtherUserResponses(false); + await env.setSeeOtherUserResponses(false); expect(env.component.projectDoc!.data!.checkingConfig.usersSeeEachOthersResponses) .withContext('setup') .toBe(false); @@ -2037,7 +2037,7 @@ describe('CheckingComponent', () => { expect(env.totalAnswersMessageCount).withContext('setup').toEqual(1); // A remote answer is added. - env.simulateNewRemoteAnswer(); + await env.simulateNewRemoteAnswer(); expect(env.totalAnswersMessageCount).toEqual(2); // Banner is shown expect(env.showUnreadAnswersButton).not.toBeNull(); @@ -2198,12 +2198,12 @@ describe('CheckingComponent', () => { flush(1000); })); - it('displays comments in real-time', fakeAsync(() => { + it('displays comments in real-time', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(1); env.answerQuestion('Admin will add a comment to this'); expect(env.getAnswerComments(0).length).toEqual(0); - const commentId: string = env.commentOnAnswerRemotely( + const commentId: string = await env.commentOnAnswerRemotely( 'Comment left by admin', env.component.questionsList!.activeQuestionDoc! ); @@ -2215,16 +2215,16 @@ describe('CheckingComponent', () => { flush(1000); })); - it('does not mark third comment read if fourth comment also added', fakeAsync(() => { + it('does not mark third comment read if fourth comment also added', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(1); env.answerQuestion('Admin will add four comments'); env.commentOnAnswer(0, 'First comment'); const questionDoc: QuestionDoc = clone(env.component.questionsList!.activeQuestionDoc!); env.selectQuestion(2); - env.commentOnAnswerRemotely('Comment #2', questionDoc); - env.commentOnAnswerRemotely('Comment #3', questionDoc); - env.commentOnAnswerRemotely('Comment #4', questionDoc); + await env.commentOnAnswerRemotely('Comment #2', questionDoc); + await env.commentOnAnswerRemotely('Comment #3', questionDoc); + await env.commentOnAnswerRemotely('Comment #4', questionDoc); env.selectQuestion(1); expect(env.component.answersPanel!.answers.length).toEqual(1); expect(env.component.answersPanel!.answers[0].comments.length).toEqual(4); @@ -2283,7 +2283,7 @@ describe('CheckingComponent', () => { const questionDoc = spy(await env.getQuestionDoc('q6Id')); env.selectQuestion(6); verify(questionDoc!.updateAnswerFileCache()).times(1); - env.simulateRemoteEditAnswer(0, 'Question 6 edited answer'); + await env.simulateRemoteEditAnswer(0, 'Question 6 edited answer'); verify(questionDoc!.updateAnswerFileCache()).times(2); expect().nothing(); tick(); @@ -2418,7 +2418,7 @@ describe('CheckingComponent', () => { discardPeriodicTasks(); })); - it('updates question highlight when verse ref changes', fakeAsync(() => { + it('updates question highlight when verse ref changes', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(4); expect(env.getVerse(1, 3)).not.toBeNull(); @@ -2426,7 +2426,7 @@ describe('CheckingComponent', () => { expect(segment.classList.contains('question-segment')).toBe(true); expect(segment.classList.contains('highlight-segment')).toBe(true); expect(fromVerseRef(env.component.activeQuestionVerseRef!).verseNum).toEqual(3); - env.component.questionsList!.activeQuestionDoc!.submitJson0Op(op => { + await env.component.questionsList!.activeQuestionDoc!.submitJson0Op(op => { op.set(qd => qd.verseRef, fromVerseRef(new VerseRef('JHN 1:5'))); }, false); env.waitForSliderUpdate(); @@ -2481,14 +2481,14 @@ describe('CheckingComponent', () => { discardPeriodicTasks(); })); - it('dynamically hides when project setting changes to specify hide text', fakeAsync(() => { + it('dynamically hides when project setting changes to specify hide text', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); // Starts off not hiding text. expect(env.component.projectDoc!.data!.checkingConfig.hideCommunityCheckingText).withContext('setup').toBe(false); // After the page was originally set up, now set project setting to hide community checking text const changeOriginatesLocally: boolean = false; - env.component.projectDoc?.submitJson0Op(op => { + await env.component.projectDoc?.submitJson0Op(op => { op.set(proj => proj.checkingConfig.hideCommunityCheckingText, true); }, changeOriginatesLocally); env.fixture.detectChanges(); @@ -2506,7 +2506,7 @@ describe('CheckingComponent', () => { .toBe(true); // And now set project setting NOT to hide community checking text - env.component.projectDoc?.submitJson0Op(op => { + await env.component.projectDoc?.submitJson0Op(op => { op.set(proj => proj.checkingConfig.hideCommunityCheckingText, false); }, changeOriginatesLocally); env.fixture.detectChanges(); @@ -2647,7 +2647,7 @@ describe('CheckingComponent', () => { projectBookRoute: 'MAT', questionScope: 'book' }); - env.setHideScriptureText(true); + await env.setHideScriptureText(true); expect(env.component.hideChapterText).toBe(true); env.waitForQuestionTimersToComplete(); env.fixture.detectChanges(); @@ -2655,8 +2655,8 @@ describe('CheckingComponent', () => { expect(env.audioCheckingWarning).not.toBeNull(); expect(env.questionNoAudioWarning).not.toBeNull(); - when(mockedChapterAudioDialogService.openDialog(anything())).thenCall(() => { - env.component.projectDoc!.submitJson0Op(op => { + when(mockedChapterAudioDialogService.openDialog(anything())).thenCall(async () => { + await env.component.projectDoc!.submitJson0Op(op => { const matTextIndex: number = env.component.projectDoc!.data!.texts.findIndex(t => t.bookNum === 40); op.set(p => p.texts[matTextIndex].chapters[0].hasAudio, true); }); @@ -2670,13 +2670,13 @@ describe('CheckingComponent', () => { expect(env.questionNoAudioWarning).toBeNull(); })); - it('notifies community checker if chapter audio is absent and hide scripture text is enabled', fakeAsync(() => { + it('notifies community checker if chapter audio is absent and hide scripture text is enabled', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER, projectBookRoute: 'MAT', questionScope: 'book' }); - env.setHideScriptureText(true); + await env.setHideScriptureText(true); expect(env.component.hideChapterText).toBe(true); env.waitForQuestionTimersToComplete(); env.fixture.detectChanges(); @@ -3253,7 +3253,7 @@ class TestEnvironment { this.waitForSliderUpdate(); } - commentOnAnswerRemotely(text: string, questionDoc: QuestionDoc): string { + async commentOnAnswerRemotely(text: string, questionDoc: QuestionDoc): Promise { const commentId: string = objectId(); const date = new Date().toJSON(); const comment: Comment = { @@ -3264,7 +3264,7 @@ class TestEnvironment { dateModified: date, deleted: false }; - questionDoc.submitJson0Op(op => op.insert(q => q.answers[0].comments, 0, comment), false); + await questionDoc.submitJson0Op(op => op.insert(q => q.answers[0].comments, 0, comment), false); return commentId; } @@ -3362,8 +3362,8 @@ class TestEnvironment { return question; } - setSeeOtherUserResponses(isEnabled: boolean): void { - this.component.projectDoc!.submitJson0Op( + async setSeeOtherUserResponses(isEnabled: boolean): Promise { + await this.component.projectDoc!.submitJson0Op( op => op.set(p => p.checkingConfig.usersSeeEachOthersResponses, isEnabled), false ); @@ -3397,9 +3397,9 @@ class TestEnvironment { return segment != null && segment.classList.contains('question-segment'); } - setCheckingEnabled(isEnabled: boolean = true): void { - this.ngZone.run(() => { - this.component.projectDoc!.submitJson0Op( + async setCheckingEnabled(isEnabled: boolean = true): Promise { + await this.ngZone.run(async () => { + await this.component.projectDoc!.submitJson0Op( op => op.set(p => p.checkingConfig.checkingEnabled, isEnabled), false ); @@ -3465,12 +3465,12 @@ class TestEnvironment { } /** Delete answer by id behind the scenes */ - deleteAnswer(answerIdToDelete: string): void { + async deleteAnswer(answerIdToDelete: string): Promise { const questionDoc = this.component.answersPanel!.questionDoc!; const answers = questionDoc.data!.answers; const answerIndex = answers.findIndex(existingAnswer => existingAnswer.dataId === answerIdToDelete); - questionDoc.submitJson0Op(op => op.set(q => q.answers[answerIndex].deleted, true)); + await questionDoc.submitJson0Op(op => op.set(q => q.answers[answerIndex].deleted, true)); this.fixture.detectChanges(); } @@ -3490,12 +3490,15 @@ class TestEnvironment { return audio; } - simulateNewRemoteAnswer(dataId: string = 'newAnswer1', text: string = 'new answer from another user'): void { + async simulateNewRemoteAnswer( + dataId: string = 'newAnswer1', + text: string = 'new answer from another user' + ): Promise { // Another user on another computer adds a new answer. const date = new Date(); date.setDate(date.getDate() - 1); const dateCreated = date.toJSON(); - this.component.answersPanel!.questionDoc!.submitJson0Op( + await this.component.answersPanel!.questionDoc!.submitJson0Op( op => op.insert(q => q.answers, 0, { dataId: dataId, @@ -3522,7 +3525,7 @@ class TestEnvironment { async simulateRemoteEditQuestionAudio(filename?: string, questionId?: string): Promise { const questionDoc = questionId != null ? await this.getQuestionDoc(questionId) : this.component.questionsList!.activeQuestionDoc!; - questionDoc.submitJson0Op(op => { + await questionDoc.submitJson0Op(op => { if (filename != null) { op.set(q => q.audioUrl!, filename); } else { @@ -3541,9 +3544,9 @@ class TestEnvironment { tick(); } - simulateRemoteEditAnswer(index: number, text: string): void { + async simulateRemoteEditAnswer(index: number, text: string): Promise { const questionDoc = this.component.questionsList!.activeQuestionDoc!; - questionDoc.submitJson0Op(op => { + await questionDoc.submitJson0Op(op => { op.set(q => q.answers[index].text!, text); op.set(q => q.answers[index].dateModified, new Date().toJSON()); }, false); @@ -3552,9 +3555,9 @@ class TestEnvironment { tick(); } - simulateSync(index: number): void { + async simulateSync(index: number): Promise { const questionDoc = this.component.questionsList!.activeQuestionDoc!; - questionDoc.submitJson0Op(op => { + await questionDoc.submitJson0Op(op => { op.set(q => (q.answers[index] as any).syncUserRef, objectId()); }, false); tick(this.questionReadTimer); @@ -3562,9 +3565,9 @@ class TestEnvironment { tick(); } - setHideScriptureText(hideScriptureText: boolean): void { + async setHideScriptureText(hideScriptureText: boolean): Promise { const projectDoc: SFProjectProfileDoc = this.component.projectDoc!; - projectDoc.submitJson0Op(op => op.set(p => p.checkingConfig.hideCommunityCheckingText, hideScriptureText)); + await projectDoc.submitJson0Op(op => op.set(p => p.checkingConfig.hideCommunityCheckingText, hideScriptureText)); tick(); this.fixture.detectChanges(); } From 9080214942de89ecba201466abaaca1e5f301087 Mon Sep 17 00:00:00 2001 From: MarkS Date: Mon, 15 Sep 2025 17:06:51 -0600 Subject: [PATCH 37/42] checking component spec await --- .../checking/checking.component.spec.ts | 150 +++++++++--------- 1 file changed, 75 insertions(+), 75 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts index 397e682c6f1..e63375de601 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts @@ -534,10 +534,10 @@ describe('CheckingComponent', () => { expect(question.classes['question-read']).toBe(true); })); - it('question status change to answered', fakeAsync(() => { + it('question status change to answered', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); const question = env.selectQuestion(2); - env.answerQuestion('Answer question 2'); + await env.answerQuestion('Answer question 2'); tick(100); env.fixture.detectChanges(); expect(question.classes['question-answered']).toBe(true); @@ -1296,29 +1296,29 @@ describe('CheckingComponent', () => { discardPeriodicTasks(); })); - it('can answer a question', fakeAsync(() => { + it('can answer a question', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(2); // Checker user already has an answer on question 6 and 9 expect(env.component.summary.answered).toEqual(2); - env.answerQuestion('Answer question 2'); + await env.answerQuestion('Answer question 2'); expect(env.answers.length).toEqual(1); expect(env.getAnswerText(0)).toBe('Answer question 2'); expect(env.component.summary.answered).toEqual(3); flush(1000); })); - it('opens edit display name dialog if answering a question for the first time', fakeAsync(() => { + it('opens edit display name dialog if answering a question for the first time', fakeAsync(async () => { const env = new TestEnvironment({ user: CLEAN_CHECKER_USER }); env.selectQuestion(2); - env.answerQuestion('Answering question 2 should pop up a dialog'); + await env.answerQuestion('Answering question 2 should pop up a dialog'); verify(mockedUserService.editDisplayName(true)).once(); expect(env.answers.length).toEqual(1); expect(env.getAnswerText(0)).toBe('Answering question 2 should pop up a dialog'); flush(1000); })); - it('does not open edit display name dialog if offline', fakeAsync(() => { + it('does not open edit display name dialog if offline', fakeAsync(async () => { const env = new TestEnvironment({ user: CLEAN_CHECKER_USER, projectBookRoute: 'JHN', @@ -1327,17 +1327,17 @@ describe('CheckingComponent', () => { hasConnection: false }); env.selectQuestion(2); - env.answerQuestion('Answering question 2 offline'); + await env.answerQuestion('Answering question 2 offline'); verify(mockedUserService.editDisplayName(anything())).never(); expect(env.answers.length).toEqual(1); expect(env.getAnswerText(0)).toBe('Answering question 2 offline'); flush(1000); })); - it('inserts newer answer above older answers', fakeAsync(() => { + it('inserts newer answer above older answers', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(7); - env.answerQuestion('Just added answer'); + await env.answerQuestion('Just added answer'); expect(env.answers.length).toEqual(2); expect(env.getAnswerText(0)).toBe('Just added answer'); expect(env.getAnswerText(1)).toBe('Answer 7 on question'); @@ -1433,10 +1433,10 @@ describe('CheckingComponent', () => { flush(1000); })); - it('can edit a new answer', fakeAsync(() => { + it('can edit a new answer', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(7); - env.answerQuestion('Answer question 7'); + await env.answerQuestion('Answer question 7'); const myAnswerIndex = 0; const otherAnswerIndex = 1; expect(env.getAnswer(myAnswerIndex).classes['attention']).toBe(true); @@ -1515,10 +1515,10 @@ describe('CheckingComponent', () => { flush(1000); })); - it('still shows answers as read after canceling an edit', fakeAsync(() => { + it('still shows answers as read after canceling an edit', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(7); - env.answerQuestion('Answer question 7'); + await env.answerQuestion('Answer question 7'); const myAnswerIndex = 0; const otherAnswerIndex = 1; expect(env.getAnswer(myAnswerIndex).classes['attention']).toBe(true); @@ -1533,10 +1533,10 @@ describe('CheckingComponent', () => { flush(1000); })); - it('only my answer is highlighted after I add an answer', fakeAsync(() => { + it('only my answer is highlighted after I add an answer', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(7); - env.answerQuestion('My answer'); + await env.answerQuestion('My answer'); expect(env.answers.length).withContext('setup problem').toBeGreaterThan(1); const myAnswerIndex = 0; const otherAnswerIndex = 1; @@ -1545,14 +1545,14 @@ describe('CheckingComponent', () => { flush(1000); })); - it('can remove audio from answer', fakeAsync(() => { + it('can remove audio from answer', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); const data: FileOfflineData = { id: 'a6Id', dataCollection: 'questions', blob: getAudioBlob() }; when(mockedFileService.findOrUpdateCache(FileType.Audio, 'questions', 'a6Id', '/audio.mp3')).thenResolve(data); env.selectQuestion(6); env.clickButton(env.getAnswerEditButton(0)); env.waitForSliderUpdate(); - env.component.answersPanel!.submit({ text: 'Answer 6 on question', audio: { status: 'reset' } }); + await env.component.answersPanel!.submit({ text: 'Answer 6 on question', audio: { status: 'reset' } }); env.waitForSliderUpdate(); verify( mockedFileService.deleteFile(FileType.Audio, 'project01', QuestionDoc.COLLECTION, 'a6Id', CHECKER_USER.id) @@ -1561,7 +1561,7 @@ describe('CheckingComponent', () => { flush(1000); })); - it('saves audio answer offline and plays from cache', fakeAsync(() => { + it('saves audio answer offline and plays from cache', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER, projectBookRoute: 'JHN', @@ -1570,7 +1570,7 @@ describe('CheckingComponent', () => { hasConnection: false }); const resolveUpload$: Subject = env.resolveFileUploadSubject('blob://audio'); - env.answerQuestion('An offline answer', 'audioFile.mp3'); + await env.answerQuestion('An offline answer', 'audioFile.mp3'); resolveUpload$.next(); env.waitForSliderUpdate(); verify( @@ -1598,7 +1598,7 @@ describe('CheckingComponent', () => { const env = new TestEnvironment({ user: CHECKER_USER }); const resolveUpload$: Subject = env.resolveFileUploadSubject('uploadedFile.mp3'); env.selectQuestion(1); - env.answerQuestion('Answer with audio', 'audioFile.mp3'); + await env.answerQuestion('Answer with audio', 'audioFile.mp3'); expect(env.answers.length).toEqual(0); const question = await env.getQuestionDoc('q1Id'); expect(env.saveAnswerButton).not.toBeNull(); @@ -1622,10 +1622,10 @@ describe('CheckingComponent', () => { flush(1000); })); - it('can delete correct answer after changing chapters', fakeAsync(() => { + it('can delete correct answer after changing chapters', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(2); - env.answerQuestion('Answer question 2'); + await env.answerQuestion('Answer question 2'); env.component.chapter!++; env.clickButton(env.answerDeleteButton(0)); env.waitForSliderUpdate(); @@ -1633,20 +1633,20 @@ describe('CheckingComponent', () => { flush(1000); })); - it('answers reset when changing questions', fakeAsync(() => { + it('answers reset when changing questions', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(2); - env.answerQuestion('Answer question 2'); + await env.answerQuestion('Answer question 2'); expect(env.answers.length).toEqual(1); env.selectQuestion(1); expect(env.answers.length).toEqual(0); flush(1000); })); - it("checker user can like and unlike another's answer", fakeAsync(() => { + it("checker user can like and unlike another's answer", fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(7); - env.answerQuestion('Answer question 7'); + await env.answerQuestion('Answer question 7'); expect(env.getAnswerText(1)).toBe('Answer 7 on question'); expect(env.getLikeTotal(1)).toBe(0); env.clickButton(env.likeButtons[1]); @@ -1660,10 +1660,10 @@ describe('CheckingComponent', () => { flush(1000); })); - it('cannot like your own answer', fakeAsync(() => { + it('cannot like your own answer', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(1); - env.answerQuestion('Answer question to be liked'); + await env.answerQuestion('Answer question to be liked'); expect(env.getLikeTotal(0)).toBe(0); env.clickButton(env.likeButtons[0]); env.waitForSliderUpdate(); @@ -1716,12 +1716,12 @@ describe('CheckingComponent', () => { expect(env.likeButtons.length).toEqual(1); })); - it('do not show answers until current user has submitted an answer', fakeAsync(() => { + it('do not show answers until current user has submitted an answer', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); expect(env.getUnread(env.questions[6])).toEqual(0); env.selectQuestion(7); expect(env.answers.length).toBe(0); - env.answerQuestion('Answer from checker'); + await env.answerQuestion('Answer from checker'); expect(env.answers.length).toBe(2); flush(1000); })); @@ -1733,7 +1733,7 @@ describe('CheckingComponent', () => { expect(env.answers.length).toBe(1); env.selectQuestion(7); expect(env.answers.length).toBe(0); - env.answerQuestion('Answer from checker'); + await env.answerQuestion('Answer from checker'); expect(env.answers.length).toBe(1); flush(1000); })); @@ -1793,7 +1793,7 @@ describe('CheckingComponent', () => { env.selectQuestion(7); expect(env.totalAnswersMessageCount).withContext('setup').toBeNull(); - env.answerQuestion('New answer from current user'); + await env.answerQuestion('New answer from current user'); // Answers count as displayed in HTML. expect(env.totalAnswersMessageCount).toEqual(2); @@ -1902,7 +1902,7 @@ describe('CheckingComponent', () => { expect(env.totalAnswersMessageCount).toBeNull(); // Current user adds her answer, and all answers show. - env.answerQuestion('New answer from current user'); + await env.answerQuestion('New answer from current user'); expect(env.showUnreadAnswersButton).toBeNull(); expect(env.answers.length).toEqual(3); expect(env.component.answersPanel!.answers.length).toEqual(3); @@ -1913,7 +1913,7 @@ describe('CheckingComponent', () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(7); // User answers a question - env.answerQuestion('New answer from current user'); + await env.answerQuestion('New answer from current user'); expect(env.answers.length).withContext('setup').toEqual(2); expect(env.component.answersPanel!.answers.length).withContext('setup').toEqual(2); expect(env.showUnreadAnswersButton).toBeNull(); @@ -1941,7 +1941,7 @@ describe('CheckingComponent', () => { expect(env.totalAnswersMessageCount).toBeNull(); // Adding an answer should result in seeing all answers, and no banner. - env.answerQuestion('New/replaced answer from current user'); + await env.answerQuestion('New/replaced answer from current user'); expect(env.answers.length).toEqual(3); expect(env.component.answersPanel!.answers.length).toEqual(3); expect(env.showUnreadAnswersButton).toBeNull(); @@ -1961,7 +1961,7 @@ describe('CheckingComponent', () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(7); // User answers a question - env.answerQuestion('New answer from current user'); + await env.answerQuestion('New answer from current user'); expect(env.answers.length).withContext('setup').toEqual(2); expect(env.component.answersPanel!.answers.length).withContext('setup').toEqual(2); expect(env.showUnreadAnswersButton).toBeNull(); @@ -1984,7 +1984,7 @@ describe('CheckingComponent', () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(7); // User answers a question - env.answerQuestion('New answer from current user'); + await env.answerQuestion('New answer from current user'); expect(env.showUnreadAnswersButton).withContext('setup').toBeNull(); expect(env.answers.length).withContext('setup').toEqual(2); // A remote answer is added, but the current user does not click the banner to show the remote answer. @@ -2015,7 +2015,7 @@ describe('CheckingComponent', () => { .toBe(false); env.selectQuestion(7); // User answers a question - env.answerQuestion('New answer from current user'); + await env.answerQuestion('New answer from current user'); expect(env.totalAnswersMessageText).withContext('setup').toEqual('Your answer'); // A remote answer is added. @@ -2045,24 +2045,24 @@ describe('CheckingComponent', () => { })); describe('Comments', () => { - it('can comment on an answer', fakeAsync(() => { + it('can comment on an answer', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(1); - env.answerQuestion('Answer question to be commented on'); - env.commentOnAnswer(0, 'Response to answer'); + await env.answerQuestion('Answer question to be commented on'); + await env.commentOnAnswer(0, 'Response to answer'); env.waitForSliderUpdate(); expect(env.getAnswerComments(0).length).toBe(1); flush(1000); })); - it('can edit comment on an answer', fakeAsync(() => { + it('can edit comment on an answer', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); // Answer a question in a chapter where chapters previous also have comments env.selectQuestion(14); - env.answerQuestion('Answer question to be commented on'); - env.commentOnAnswer(0, 'Response to answer'); + await env.answerQuestion('Answer question to be commented on'); + await env.commentOnAnswer(0, 'Response to answer'); env.waitForSliderUpdate(); - env.commentOnAnswer(0, 'Second comment to answer'); + await env.commentOnAnswer(0, 'Second comment to answer'); env.waitForSliderUpdate(); env.clickButton(env.getEditCommentButton(0, 0)); expect(env.getYourCommentField(0)).not.toBeNull(); @@ -2075,11 +2075,11 @@ describe('CheckingComponent', () => { flush(1000); })); - it('can delete comment on an answer', fakeAsync(() => { + it('can delete comment on an answer', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(1); - env.answerQuestion('Answer question to be commented on'); - env.commentOnAnswer(0, 'Response to answer'); + await env.answerQuestion('Answer question to be commented on'); + await env.commentOnAnswer(0, 'Response to answer'); env.waitForSliderUpdate(); expect(env.getAnswerComments(0).length).toBe(1); env.clickButton(env.getDeleteCommentButton(0, 0)); @@ -2088,12 +2088,12 @@ describe('CheckingComponent', () => { flush(1000); })); - it('can record audio for a comment', fakeAsync(() => { + it('can record audio for a comment', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(1); - env.answerQuestion('Answer question to be commented on'); + await env.answerQuestion('Answer question to be commented on'); const resolveUpload$: Subject = env.resolveFileUploadSubject('blob://audio'); - env.commentOnAnswer(0, '', 'audioFile.mp3'); + await env.commentOnAnswer(0, '', 'audioFile.mp3'); resolveUpload$.next(); env.waitForSliderUpdate(); expect(env.component.answersPanel!.answers[0].comments[0].audioUrl).toEqual('blob://audio'); @@ -2103,12 +2103,12 @@ describe('CheckingComponent', () => { flush(1000); })); - it('can remove audio from a comment', fakeAsync(() => { + it('can remove audio from a comment', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(1); - env.answerQuestion('Answer question to be commented on'); + await env.answerQuestion('Answer question to be commented on'); const resolveUpload$: Subject = env.resolveFileUploadSubject('blob://audio'); - env.commentOnAnswer(0, 'comment with audio', 'audioFile.mp3'); + await env.commentOnAnswer(0, 'comment with audio', 'audioFile.mp3'); resolveUpload$.next(); env.waitForSliderUpdate(); expect(env.component.answersPanel!.answers[0].comments[0].audioUrl).toEqual('blob://audio'); @@ -2124,12 +2124,12 @@ describe('CheckingComponent', () => { flush(1000); })); - it('will delete comment audio when comment is deleted', fakeAsync(() => { + it('will delete comment audio when comment is deleted', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(1); const resolveUpload$: Subject = env.resolveFileUploadSubject('blob://audio'); - env.answerQuestion('Answer question to be commented on'); - env.commentOnAnswer(0, 'comment with audio', 'audioFile.mp3'); + await env.answerQuestion('Answer question to be commented on'); + await env.commentOnAnswer(0, 'comment with audio', 'audioFile.mp3'); resolveUpload$.next(); env.waitForSliderUpdate(); expect(env.component.answersPanel!.answers[0].comments[0].audioUrl).toEqual('blob://audio'); @@ -2145,17 +2145,17 @@ describe('CheckingComponent', () => { flush(1000); })); - it('comments only appear on the relevant answer', fakeAsync(() => { + it('comments only appear on the relevant answer', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(1); - env.answerQuestion('Answer question to be commented on'); - env.commentOnAnswer(0, 'First comment'); - env.commentOnAnswer(0, 'Second comment'); + await env.answerQuestion('Answer question to be commented on'); + await env.commentOnAnswer(0, 'First comment'); + await env.commentOnAnswer(0, 'Second comment'); env.waitForSliderUpdate(); expect(env.getAnswerComments(0).length).toBe(2); env.selectQuestion(2); - env.answerQuestion('Second answer question to be commented on'); - env.commentOnAnswer(0, 'Third comment'); + await env.answerQuestion('Second answer question to be commented on'); + await env.commentOnAnswer(0, 'Third comment'); env.waitForSliderUpdate(); expect(env.getAnswerComments(0).length).toBe(1); expect(env.getAnswerCommentText(0, 0)).toBe('Third comment'); @@ -2201,9 +2201,9 @@ describe('CheckingComponent', () => { it('displays comments in real-time', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(1); - env.answerQuestion('Admin will add a comment to this'); + await env.answerQuestion('Admin will add a comment to this'); expect(env.getAnswerComments(0).length).toEqual(0); - const commentId: string = await env.commentOnAnswerRemotely( + const commentId: string = await await env.commentOnAnswerRemotely( 'Comment left by admin', env.component.questionsList!.activeQuestionDoc! ); @@ -2218,13 +2218,13 @@ describe('CheckingComponent', () => { it('does not mark third comment read if fourth comment also added', fakeAsync(async () => { const env = new TestEnvironment({ user: CHECKER_USER }); env.selectQuestion(1); - env.answerQuestion('Admin will add four comments'); - env.commentOnAnswer(0, 'First comment'); + await env.answerQuestion('Admin will add four comments'); + await env.commentOnAnswer(0, 'First comment'); const questionDoc: QuestionDoc = clone(env.component.questionsList!.activeQuestionDoc!); env.selectQuestion(2); - await env.commentOnAnswerRemotely('Comment #2', questionDoc); - await env.commentOnAnswerRemotely('Comment #3', questionDoc); - await env.commentOnAnswerRemotely('Comment #4', questionDoc); + await await env.commentOnAnswerRemotely('Comment #2', questionDoc); + await await env.commentOnAnswerRemotely('Comment #3', questionDoc); + await await env.commentOnAnswerRemotely('Comment #4', questionDoc); env.selectQuestion(1); expect(env.component.answersPanel!.answers.length).toEqual(1); expect(env.component.answersPanel!.answers[0].comments.length).toEqual(4); @@ -3206,14 +3206,14 @@ class TestEnvironment { ); } - answerQuestion(answer: string, audioFilename?: string): void { + async answerQuestion(answer: string, audioFilename?: string): Promise { this.clickButton(this.addAnswerButton); const response: CheckingInput = { text: answer }; const audio: AudioAttachment = { status: 'processed', blob: getAudioBlob(), fileName: audioFilename }; if (audioFilename != null) { response.audio = audio; } - this.component.answersPanel?.submit(response); + await this.component.answersPanel?.submit(response); tick(); this.fixture.detectChanges(); this.waitForSliderUpdate(); @@ -3239,7 +3239,7 @@ class TestEnvironment { tick(); } - commentOnAnswer(answerIndex: number, comment: string, audioFilename?: string): void { + async commentOnAnswer(answerIndex: number, comment: string, audioFilename?: string): Promise { this.clickButton(this.getAddCommentButton(answerIndex)); if (this.getYourCommentField(answerIndex) == null) return; this.setTextFieldValue(this.getYourCommentField(answerIndex), comment); @@ -3249,7 +3249,7 @@ class TestEnvironment { } const commentsComponent = this.fixture.debugElement.query(By.css('#answer-comments'))! .componentInstance as CheckingCommentsComponent; - commentsComponent.submit({ text: comment, audio: commentAudio }); + await commentsComponent.submit({ text: comment, audio: commentAudio }); this.waitForSliderUpdate(); } From 61a1e4b7b1c67437abad9b1860161512c1642df4 Mon Sep 17 00:00:00 2001 From: MarkS Date: Tue, 16 Sep 2025 08:13:59 -0600 Subject: [PATCH 38/42] use jasmine spyOn instead of ts-mockito spy for questionDoc simply doing `spy(await env.getQuestionDoc('q6Id'))` with ts-mockito spy results in later errors: > Error: Uncaught (in promise): TypeError: Cannot read properties of undefined (reading 'get') > TypeError: Cannot read properties of undefined (reading 'get') > at Spy.getEmptyMethodStub (node_modules/ts-mockito/lib/Spy.js:41:48) Perhaps more awaiting needed to happen first for something to be populated. Not being able to pin it down, there was instead success in moving to jasmine spyOn. --- .../app/checking/checking/checking.component.spec.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts index e63375de601..ed26034ccb5 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts @@ -2292,13 +2292,13 @@ describe('CheckingComponent', () => { it('update answer audio cache on remote removal of an answer', fakeAsync(async () => { const env = new TestEnvironment({ user: ADMIN_USER }); - const questionDoc = spy(await env.getQuestionDoc('q6Id')); + const questionDoc = await env.getQuestionDoc('q6Id'); + spyOn(questionDoc, 'updateAnswerFileCache').and.callThrough(); env.selectQuestion(6); - verify(questionDoc!.updateAnswerFileCache()).times(1); + expect(questionDoc.updateAnswerFileCache).toHaveBeenCalledTimes(1); + // SUT await env.simulateRemoteDeleteAnswer('q6Id', 0); - verify(questionDoc!.updateAnswerFileCache()).times(2); - expect().nothing(); - tick(); + expect(questionDoc.updateAnswerFileCache).toHaveBeenCalledTimes(2); flush(1000); })); From 3051f0e84fbcff55da2dcc5ffa7bb46493a77a03 Mon Sep 17 00:00:00 2001 From: MarkS Date: Tue, 16 Sep 2025 08:22:37 -0600 Subject: [PATCH 39/42] app componet spec await --- .../ClientApp/src/app/app.component.spec.ts | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts index 66061c2be6a..3a9a309ce98 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/app.component.spec.ts @@ -948,10 +948,9 @@ class TestEnvironment { op => op.set(p => p.userRoles['user01'], SFProjectRole.CommunityChecker), false ); - (await this.getCurrentUserDoc()).submitJson0Op( - op => op.add(u => u.sites['sf'].projects, 'project04'), - false - ); + await ( + await this.getCurrentUserDoc() + ).submitJson0Op(op => op.add(u => u.sites['sf'].projects, 'project04'), false); this.wait(); } From f595b5c3abfac02907cce979355cbfefe720302b Mon Sep 17 00:00:00 2001 From: MarkS Date: Tue, 16 Sep 2025 13:52:52 -0600 Subject: [PATCH 40/42] fix after rebase --- .../biblical-term-dialog.component.spec.ts | 8 ++-- .../draft-history-entry.component.spec.ts | 3 +- .../draft-preview-books.component.ts | 7 ++- .../translate/editor/editor.component.spec.ts | 16 +++---- .../insights/lynx-workspace.service.spec.ts | 44 +++++++++---------- 5 files changed, 42 insertions(+), 36 deletions(-) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts index 88c6c77f9cf..0e75a578030 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/biblical-terms/biblical-term-dialog.component.spec.ts @@ -145,7 +145,7 @@ describe('BiblicalTermDialogComponent', () => { expect(biblicalTerm.data?.description).toBe(''); })); - it('should not save renderings with unbalanced parentheses', fakeAsync(() => { + it('should not save renderings with unbalanced parentheses', fakeAsync(async () => { const env = new TestEnvironment(); env.setupProjectData('en'); env.wait(); @@ -154,12 +154,12 @@ describe('BiblicalTermDialogComponent', () => { env.setTextFieldValue(env.renderings, '('); env.click(env.submitButton); env.wait(); - const biblicalTerm = env.getBiblicalTermDoc('id01'); + const biblicalTerm = await env.getBiblicalTermDoc('id01'); expect(biblicalTerm.data?.renderings).toEqual(['rendering01']); env.closeDialog(); })); - it('should save renderings with balanced parentheses', fakeAsync(() => { + it('should save renderings with balanced parentheses', fakeAsync(async () => { const env = new TestEnvironment(); env.setupProjectData('en'); env.wait(); @@ -168,7 +168,7 @@ describe('BiblicalTermDialogComponent', () => { env.setTextFieldValue(env.renderings, '()'); env.click(env.submitButton); env.wait(); - const biblicalTerm = env.getBiblicalTermDoc('id01'); + const biblicalTerm = await env.getBiblicalTermDoc('id01'); expect(biblicalTerm.data?.renderings).toEqual(['()']); })); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-history-list/draft-history-entry/draft-history-entry.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-history-list/draft-history-entry/draft-history-entry.component.spec.ts index b4d93222a3b..c470b979344 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-history-list/draft-history-entry/draft-history-entry.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-history-list/draft-history-entry/draft-history-entry.component.spec.ts @@ -15,6 +15,7 @@ import { UserProfileDoc } from 'xforge-common/models/user-profile-doc'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; import { configureTestingModule, TestTranslocoModule } from 'xforge-common/test-utils'; import { UserService } from 'xforge-common/user.service'; +import { DocSubscription } from '../../../../../xforge-common/models/realtime-doc'; import { SFProjectProfileDoc } from '../../../../core/models/sf-project-profile-doc'; import { SF_TYPE_REGISTRY } from '../../../../core/models/sf-type-registry'; import { TrainingDataDoc } from '../../../../core/models/training-data-doc'; @@ -235,7 +236,7 @@ describe('DraftHistoryEntryComponent', () => { id: 'project01', data: createTestProjectProfile({ shortName: 'tar', writingSystem: { tag: 'en' } }) } as SFProjectProfileDoc; - when(mockedSFProjectService.getProfile('project01')).thenResolve(targetProjectDoc); + when(mockedSFProjectService.getProfile('project01', new DocSubscription('spec'))).thenResolve(targetProjectDoc); when(mockedActivatedProjectService.changes$).thenReturn(of(targetProjectDoc)); const entry = { additionalInfo: { diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-preview-books/draft-preview-books.component.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-preview-books/draft-preview-books.component.ts index f287fcc55f1..5322033333a 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-preview-books/draft-preview-books.component.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-preview-books/draft-preview-books.component.ts @@ -168,7 +168,12 @@ export class DraftPreviewBooksComponent { this.updateProgress(); const promises: Promise[] = []; - const targetProject = (await this.projectService.getProfile(targetProjectId)).data!; + const targetProject = ( + await this.projectService.getProfile( + targetProjectId, + new DocSubscription('DraftPreviewBooksComponent', this.destroyRef) + ) + ).data!; for (const chapter of bookWithDraft.chaptersWithDrafts) { const draftTextDocId = new TextDocId(this.activatedProjectService.projectId!, bookWithDraft.bookNumber, chapter); const targetTextDocId = new TextDocId(targetProjectId, bookWithDraft.bookNumber, chapter); diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts index a6dc3dd9517..d6d18c99522 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/editor.component.spec.ts @@ -2346,7 +2346,7 @@ describe('EditorComponent', () => { (insertDelta as any).push({ retain: remoteEditTextPos } as DeltaOperation); (insertDelta as any).push({ insert: 'abc' } as DeltaOperation); // Simulate remote changes coming in - textDoc.submit(insertDelta); + await textDoc.submit(insertDelta); // SUT 1 env.wait(); @@ -2372,7 +2372,7 @@ describe('EditorComponent', () => { (insertDeleteDelta as any).push({ retain: remoteEditTextPos } as DeltaOperation); (insertDeleteDelta as any).push({ insert: 'defgh' } as DeltaOperation); (insertDeleteDelta as any).push({ delete: selectionLength } as DeltaOperation); - textDoc.submit(insertDeleteDelta); + await textDoc.submit(insertDeleteDelta); // SUT 2 env.wait(); @@ -2387,7 +2387,7 @@ describe('EditorComponent', () => { (deleteDelta as any).push({ retain: remoteEditTextPos } as DeltaOperation); // the remote edit deletes 4, but locally it is expanded to 6 to include the 2 note embeds (deleteDelta as any).push({ delete: 4 } as DeltaOperation); - textDoc.submit(deleteDelta); + await textDoc.submit(deleteDelta); // SUT 3 env.wait(); @@ -2436,7 +2436,7 @@ describe('EditorComponent', () => { let deltaOps: DeltaOperation[] = [{ retain: remoteEditTextPos }, { insert: insert }]; const inSegmentDelta = new Delta(deltaOps); const textDoc: TextDoc = await env.getTextDoc(new TextDocId('project01', 40, 1)); - textDoc.submit(inSegmentDelta); + await textDoc.submit(inSegmentDelta); // SUT 1 env.wait(); @@ -2451,7 +2451,7 @@ describe('EditorComponent', () => { insert = 'def'; deltaOps = [{ retain: remoteEditTextPos }, { insert: insert }]; const outOfSegmentDelta = new Delta(deltaOps); - textDoc.submit(outOfSegmentDelta); + await textDoc.submit(outOfSegmentDelta); // SUT 2 env.wait(); @@ -2467,7 +2467,7 @@ describe('EditorComponent', () => { insert = 'before'; deltaOps = [{ retain: remoteEditTextPos }, { insert: insert }]; const insertDelta = new Delta(deltaOps); - textDoc.submit(insertDelta); + await textDoc.submit(insertDelta); const note1Doc: NoteThreadDoc = await env.getNoteThreadDoc('project01', 'dataid01'); const anchor: TextAnchor = { start: 8 + insert.length, length: 12 }; await note1Doc.submitJson0Op(op => op.set(nt => nt.position, anchor)); @@ -2490,7 +2490,7 @@ describe('EditorComponent', () => { insert = 'ghi'; deltaOps = [{ retain: remoteEditTextPos }, { insert: insert }]; const insertAfterNoteDelta = new Delta(deltaOps); - textDoc.submit(insertAfterNoteDelta); + await textDoc.submit(insertAfterNoteDelta); // SUT 4 env.wait(); @@ -5057,7 +5057,7 @@ class TestEnvironment { async deleteText(textId: string): Promise { await this.ngZone.run(async () => { const textDoc = await this.realtimeService.get(TextDoc.COLLECTION, textId, new DocSubscription('spec')); - textDoc.delete(); + await textDoc.delete(); }); this.wait(); } diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts index efc9f4c2472..71bc81aa6ef 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts @@ -190,7 +190,7 @@ describe('LynxWorkspaceService', () => { return await this.realtimeService.get(TextDoc.COLLECTION, id, new DocSubscription('spec')); } - createMockProjectDoc(id: string = PROJECT_ID, lynxConfig?: LynxConfig): Promise { + async createMockProjectDoc(id: string = PROJECT_ID, lynxConfig?: LynxConfig): Promise { const projectData = createTestProjectProfile({ texts: [ { @@ -273,7 +273,7 @@ describe('LynxWorkspaceService', () => { } async triggerProjectChange(id: string, lynxConfig?: LynxConfig): Promise { - this.projectDocTestSubject$.next(this.createMockProjectDoc(id, lynxConfig)); + this.projectDocTestSubject$.next(await this.createMockProjectDoc(id, lynxConfig)); tick(); } @@ -384,7 +384,7 @@ describe('LynxWorkspaceService', () => { when(mockWorkspaceFactory.createWorkspace(anything(), anything())).thenReturn(workspaceMock as any); // Set up project and workspace - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: true, assessmentsEnabled: true, punctuationCheckerEnabled: true, @@ -557,7 +557,7 @@ describe('LynxWorkspaceService', () => { flush(); // Create project with lynx features enabled so documents will be opened - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: true, assessmentsEnabled: true, punctuationCheckerEnabled: true, @@ -589,7 +589,7 @@ describe('LynxWorkspaceService', () => { flush(); // Create project with lynx features enabled so documents will be opened - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: true, assessmentsEnabled: true, punctuationCheckerEnabled: true, @@ -614,7 +614,7 @@ describe('LynxWorkspaceService', () => { flush(); // Set up project with lynx features enabled so documents will be opened - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: true, assessmentsEnabled: true, punctuationCheckerEnabled: true, @@ -646,7 +646,7 @@ describe('LynxWorkspaceService', () => { flush(); // Set up project with lynx features enabled - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: false, assessmentsEnabled: true, punctuationCheckerEnabled: true, @@ -677,7 +677,7 @@ describe('LynxWorkspaceService', () => { flush(); // Set up project with lynx features enabled - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: false, assessmentsEnabled: true, punctuationCheckerEnabled: true, @@ -716,7 +716,7 @@ describe('LynxWorkspaceService', () => { flush(); // Set up project with lynx features enabled - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: false, assessmentsEnabled: true, punctuationCheckerEnabled: true, @@ -746,7 +746,7 @@ describe('LynxWorkspaceService', () => { flush(); // Set up project with lynx features enabled - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: false, assessmentsEnabled: true, punctuationCheckerEnabled: true, @@ -780,7 +780,7 @@ describe('LynxWorkspaceService', () => { flush(); // Set up project with auto-corrections enabled - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: true, assessmentsEnabled: false, punctuationCheckerEnabled: true, @@ -819,7 +819,7 @@ describe('LynxWorkspaceService', () => { }); // Set up project with auto-corrections enabled - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: true, assessmentsEnabled: false, punctuationCheckerEnabled: true, @@ -857,12 +857,12 @@ describe('LynxWorkspaceService', () => { expect(result).toEqual([]); })); - it('should return empty array when auto-corrections are disabled', fakeAsync(() => { + it('should return empty array when auto-corrections are disabled', fakeAsync(async () => { const env = new TestEnvironment(); env.service['textDocId'] = new TextDocId(PROJECT_ID, BOOK_NUM, CHAPTER_NUM); // Create project with auto-corrections disabled - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: false, assessmentsEnabled: false, punctuationCheckerEnabled: false, @@ -882,7 +882,7 @@ describe('LynxWorkspaceService', () => { verify(mockWorkspace.getOnTypeEdits(anything(), anything(), anything())).never(); })); - it('should return edits when auto-corrections are enabled', fakeAsync(() => { + it('should return edits when auto-corrections are enabled', fakeAsync(async () => { const env = new TestEnvironment(); env.setCustomWorkspaceMock((workspaceMock: any) => { @@ -892,7 +892,7 @@ describe('LynxWorkspaceService', () => { }); // Create project with auto-corrections enabled - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: true, assessmentsEnabled: false, punctuationCheckerEnabled: true, @@ -940,7 +940,7 @@ describe('LynxWorkspaceService', () => { ); }); - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: true, assessmentsEnabled: true, punctuationCheckerEnabled: true, @@ -985,7 +985,7 @@ describe('LynxWorkspaceService', () => { flush(); // Set up project with lynx features enabled - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: false, assessmentsEnabled: true, punctuationCheckerEnabled: true, @@ -1058,7 +1058,7 @@ describe('LynxWorkspaceService', () => { flush(); // Set up project with lynx features enabled - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: false, assessmentsEnabled: true, punctuationCheckerEnabled: true, @@ -1146,7 +1146,7 @@ describe('LynxWorkspaceService', () => { flush(); // Set up project with lynx features enabled - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: false, assessmentsEnabled: true, punctuationCheckerEnabled: true, @@ -1238,7 +1238,7 @@ describe('LynxWorkspaceService', () => { flush(); // Set up project with lynx features enabled - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: false, assessmentsEnabled: true, punctuationCheckerEnabled: true, @@ -1306,7 +1306,7 @@ describe('LynxWorkspaceService', () => { flush(); // Set up project with lynx features enabled - const projectDoc = env.createMockProjectDoc(PROJECT_ID, { + const projectDoc = await env.createMockProjectDoc(PROJECT_ID, { autoCorrectionsEnabled: false, assessmentsEnabled: true, punctuationCheckerEnabled: true, From 64e02b680a8fdb094fc420b77a555ad0f91b2b8d Mon Sep 17 00:00:00 2001 From: MarkS Date: Tue, 16 Sep 2025 14:03:13 -0600 Subject: [PATCH 41/42] fix lynx tests after rebase --- .../editor/lynx/insights/lynx-workspace.service.spec.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts index 71bc81aa6ef..99b976c3294 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/lynx/insights/lynx-workspace.service.spec.ts @@ -859,6 +859,8 @@ describe('LynxWorkspaceService', () => { it('should return empty array when auto-corrections are disabled', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.service['textDocId'] = new TextDocId(PROJECT_ID, BOOK_NUM, CHAPTER_NUM); // Create project with auto-corrections disabled @@ -884,6 +886,8 @@ describe('LynxWorkspaceService', () => { it('should return edits when auto-corrections are enabled', fakeAsync(async () => { const env = new TestEnvironment(); + await env.init(); + flush(); env.setCustomWorkspaceMock((workspaceMock: any) => { when(workspaceMock.getOnTypeEdits(anything(), anything(), anything())).thenReturn( From 5a61ab3d177f00300b12c64d5fc6849dbf162de1 Mon Sep 17 00:00:00 2001 From: MarkS Date: Wed, 17 Sep 2025 16:16:35 -0600 Subject: [PATCH 42/42] Fix after rebase --- ...gestions-settings-dialog.component.spec.ts | 281 ------------------ ...anslator-settings-dialog.component.spec.ts | 102 ++++--- 2 files changed, 53 insertions(+), 330 deletions(-) delete mode 100644 src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/suggestions-settings-dialog.component.spec.ts diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/suggestions-settings-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/suggestions-settings-dialog.component.spec.ts deleted file mode 100644 index 8aa3e5037d7..00000000000 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/suggestions-settings-dialog.component.spec.ts +++ /dev/null @@ -1,281 +0,0 @@ -import { DebugElement, NgModule } from '@angular/core'; -import { ComponentFixture, fakeAsync, flush, TestBed, tick } from '@angular/core/testing'; -import { MatDialog, MatDialogConfig } from '@angular/material/dialog'; -import { MatSelect } from '@angular/material/select'; -import { MatSlider } from '@angular/material/slider'; -import { By } from '@angular/platform-browser'; -import { NoopAnimationsModule } from '@angular/platform-browser/animations'; -import { cloneDeep } from 'lodash-es'; -import { SFProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project'; -import { SFProjectRole } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-role'; -import { createTestProjectProfile } from 'realtime-server/lib/esm/scriptureforge/models/sf-project-test-data'; -import { - getSFProjectUserConfigDocId, - SF_PROJECT_USER_CONFIGS_COLLECTION, - SFProjectUserConfig -} from 'realtime-server/lib/esm/scriptureforge/models/sf-project-user-config'; -import { DocSubscription } from 'xforge-common/models/realtime-doc'; -import { OnlineStatusService } from 'xforge-common/online-status.service'; -import { TestOnlineStatusModule } from 'xforge-common/test-online-status.module'; -import { TestOnlineStatusService } from 'xforge-common/test-online-status.service'; -import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; -import { TestRealtimeService } from 'xforge-common/test-realtime.service'; -import { - ChildViewContainerComponent, - configureTestingModule, - matDialogCloseDelay, - TestTranslocoModule -} from 'xforge-common/test-utils'; -import { UICommonModule } from 'xforge-common/ui-common.module'; -import { SFProjectProfileDoc } from '../../core/models/sf-project-profile-doc'; -import { SFProjectUserConfigDoc } from '../../core/models/sf-project-user-config-doc'; -import { SF_TYPE_REGISTRY } from '../../core/models/sf-type-registry'; -import { - CONFIDENCE_THRESHOLD_TIMEOUT, - SuggestionsSettingsDialogComponent, - SuggestionsSettingsDialogData -} from './suggestions-settings-dialog.component'; - -describe('SuggestionsSettingsDialogComponent', () => { - configureTestingModule(() => ({ - imports: [ - DialogTestModule, - NoopAnimationsModule, - TestOnlineStatusModule.forRoot(), - TestRealtimeModule.forRoot(SF_TYPE_REGISTRY) - ], - providers: [{ provide: OnlineStatusService, useClass: TestOnlineStatusService }] - })); - - it('update confidence threshold', fakeAsync(async () => { - const env = new TestEnvironment(); - env.openDialog(); - expect(env.component!.confidenceThreshold).toEqual(50); - - env.updateConfidenceThresholdSlider(60); - expect(env.component!.confidenceThreshold).toEqual(60); - const userConfigDoc = await env.getProjectUserConfigDoc(); - expect(userConfigDoc.data!.confidenceThreshold).toEqual(0.6); - env.closeDialog(); - })); - - it('update suggestions enabled', fakeAsync(async () => { - const env = new TestEnvironment(); - env.openDialog(); - expect(env.component!.translationSuggestionsUserEnabled).toBe(true); - - env.clickSwitch(env.suggestionsEnabledSwitch); - expect(env.component!.translationSuggestionsUserEnabled).toBe(false); - const userConfigDoc = await env.getProjectUserConfigDoc(); - expect(userConfigDoc.data!.translationSuggestionsEnabled).toBe(false); - env.closeDialog(); - })); - - it('update num suggestions', fakeAsync(async () => { - const env = new TestEnvironment(); - env.openDialog(); - expect(env.component!.numSuggestions).toEqual('1'); - - env.changeSelectValue(env.numSuggestionsSelect, 2); - expect(env.component!.numSuggestions).toEqual('2'); - const userConfigDoc = await env.getProjectUserConfigDoc(); - expect(userConfigDoc.data!.numSuggestions).toEqual(2); - env.closeDialog(); - })); - - it('shows correct confidence threshold even when suggestions disabled', fakeAsync(() => { - const env = new TestEnvironment({ translationSuggestionsEnabled: false }); - env.openDialog(); - expect(env.component?.confidenceThreshold).toEqual(50); - env.closeDialog(); - })); - - it('disables settings when offline', fakeAsync(() => { - const env = new TestEnvironment(); - env.openDialog(); - - expect(env.offlineText).toBeNull(); - expect(env.suggestionsEnabledCheckbox.disabled).toBe(false); - expect(env.confidenceThresholdSlider.disabled).toBe(false); - expect(env.numSuggestionsSelect.disabled).toBe(false); - - env.isOnline = false; - - expect(env.offlineText).not.toBeNull(); - expect(env.suggestionsEnabledCheckbox.disabled).toBe(true); - expect(env.confidenceThresholdSlider.disabled).toBe(true); - expect(env.numSuggestionsSelect.disabled).toBe(true); - env.closeDialog(); - })); - - it('the suggestions toggle is switched on when the dialog opens while offline', fakeAsync(() => { - const env = new TestEnvironment(); - env.isOnline = false; - env.openDialog(); - - expect(env.suggestionsEnabledCheckbox.disabled).toBe(true); - expect(env.isSwitchChecked(env.suggestionsEnabledCheckbox)).toBe(true); - env.closeDialog(); - })); -}); - -@NgModule({ - imports: [UICommonModule, TestTranslocoModule], - declarations: [SuggestionsSettingsDialogComponent] -}) -class DialogTestModule {} - -interface TestEnvironmentConstructorArgs { - translationSuggestionsEnabled?: boolean; -} - -class TestEnvironment { - readonly fixture: ComponentFixture; - component?: SuggestionsSettingsDialogComponent; - readonly testOnlineStatusService: TestOnlineStatusService = TestBed.inject( - OnlineStatusService - ) as TestOnlineStatusService; - - private readonly realtimeService: TestRealtimeService = TestBed.inject(TestRealtimeService); - - constructor({ translationSuggestionsEnabled = true }: TestEnvironmentConstructorArgs = {}) { - this.setProjectUserConfig({ - confidenceThreshold: 0.5, - translationSuggestionsEnabled, - numSuggestions: 1 - }); - - this.fixture = TestBed.createComponent(ChildViewContainerComponent); - } - - get overlayContainerElement(): HTMLElement { - return this.fixture.nativeElement.parentElement.querySelector('.cdk-overlay-container'); - } - - get confidenceThresholdSlider(): MatSlider { - return this.fixture.debugElement.query(By.css('#confidence-threshold-slider')).componentInstance; - } - - get suggestionsEnabledSwitch(): HTMLElement { - return this.overlayContainerElement.querySelector('#suggestions-enabled-switch') as HTMLElement; - } - - get suggestionsEnabledCheckbox(): HTMLInputElement { - return this.suggestionsEnabledSwitch.querySelector('button[role=switch]') as HTMLInputElement; - } - - get numSuggestionsSelect(): MatSelect { - return this.fixture.debugElement.query(By.css('#num-suggestions-select')).componentInstance; - } - - get offlineText(): DebugElement { - return this.fixture.debugElement.query(By.css('.offline-text')); - } - - get closeButton(): HTMLElement { - return this.overlayContainerElement.querySelector('button[mat-dialog-close]') as HTMLElement; - } - - set isOnline(value: boolean) { - this.testOnlineStatusService.setIsOnline(value); - this.wait(); - } - - closeDialog(): void { - this.click(this.closeButton); - tick(matDialogCloseDelay); - } - - openDialog(): void { - this.realtimeService - .subscribe( - SF_PROJECT_USER_CONFIGS_COLLECTION, - getSFProjectUserConfigDocId('project01', 'user01'), - new DocSubscription('spec') - ) - .then(async projectUserConfigDoc => { - const viewContainerRef = this.fixture.componentInstance.childViewContainer; - const projectDoc = await this.getProjectProfileDoc(); - const config: MatDialogConfig = { - data: { projectDoc, projectUserConfigDoc }, - viewContainerRef - }; - const dialogRef = TestBed.inject(MatDialog).open(SuggestionsSettingsDialogComponent, config); - this.component = dialogRef.componentInstance; - }); - this.wait(); - } - - updateConfidenceThresholdSlider(value: number): void { - this.component!.confidenceThreshold = value; - tick(CONFIDENCE_THRESHOLD_TIMEOUT); - this.fixture.detectChanges(); - } - - setProjectUserConfig(userConfig: Partial = {}): void { - const user1Config = cloneDeep(userConfig) as SFProjectUserConfig; - user1Config.ownerRef = 'user01'; - this.realtimeService.addSnapshot(SFProjectUserConfigDoc.COLLECTION, { - id: getSFProjectUserConfigDocId('project01', user1Config.ownerRef), - data: user1Config - }); - this.realtimeService.addSnapshot(SFProjectProfileDoc.COLLECTION, { - id: 'project01', - data: createTestProjectProfile({ - translateConfig: { - translationSuggestionsEnabled: user1Config.translationSuggestionsEnabled - }, - userRoles: { user01: SFProjectRole.ParatextTranslator } - }) - }); - } - - async getProjectProfileDoc(): Promise { - return await this.realtimeService.get( - SFProjectProfileDoc.COLLECTION, - 'project01', - new DocSubscription('spec') - ); - } - - async getProjectUserConfigDoc(): Promise { - return await this.realtimeService.get( - SFProjectUserConfigDoc.COLLECTION, - getSFProjectUserConfigDocId('project01', 'user01'), - new DocSubscription('spec') - ); - } - - isSwitchChecked(switchButton: HTMLElement): boolean { - return switchButton.classList.contains('mdc-switch--checked'); - } - - clickSwitch(element: HTMLElement): void { - const button = element.querySelector('button[role=switch]') as HTMLInputElement; - this.click(button); - } - - click(element: HTMLElement): void { - element.click(); - flush(); - this.fixture.detectChanges(); - tick(); - } - - changeSelectValue(matSelect: MatSelect, option: number): void { - matSelect.value = option; - this.fixture.detectChanges(); - tick(); - } - - wait(): void { - this.fixture.detectChanges(); - tick(); - this.fixture.detectChanges(); - // open dialog animation - tick(166); - this.fixture.detectChanges(); - tick(); - this.fixture.detectChanges(); - } -} diff --git a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translator-settings-dialog.component.spec.ts b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translator-settings-dialog.component.spec.ts index a1cdf819f4d..66c312ec7f4 100644 --- a/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translator-settings-dialog.component.spec.ts +++ b/src/SIL.XForge.Scripture/ClientApp/src/app/translate/editor/translator-settings-dialog.component.spec.ts @@ -20,6 +20,7 @@ import { createTestProjectUserConfig } from 'realtime-server/lib/esm/scripturefo import { OnlineStatusService } from 'xforge-common/online-status.service'; import { TestOnlineStatusModule } from 'xforge-common/test-online-status.module'; import { TestOnlineStatusService } from 'xforge-common/test-online-status.service'; +import { DocSubscription } from 'xforge-common/models/realtime-doc'; import { TestRealtimeModule } from 'xforge-common/test-realtime.module'; import { TestRealtimeService } from 'xforge-common/test-realtime.service'; import { @@ -50,21 +51,21 @@ describe('TranslatorSettingsDialogComponent', () => { providers: [{ provide: OnlineStatusService, useClass: TestOnlineStatusService }] })); - it('update confidence threshold', fakeAsync(() => { + it('update confidence threshold', fakeAsync(async () => { const env = new TestEnvironment(); - env.openDialog(); + await env.openDialog(); expect(env.component!.confidenceThreshold).toEqual(50); env.updateConfidenceThresholdSlider(60); expect(env.component!.confidenceThreshold).toEqual(60); - const userConfigDoc = env.getProjectUserConfigDoc(); + const userConfigDoc = await env.getProjectUserConfigDoc(); expect(userConfigDoc.data!.confidenceThreshold).toEqual(0.6); env.closeDialog(); })); it('update suggestions enabled', fakeAsync(async () => { const env = new TestEnvironment(); - env.openDialog(); + await env.openDialog(); expect(env.component!.translationSuggestionsUserEnabled).toBe(true); const suggestionsToggle = await env.getSuggestionsEnabledToggle(); @@ -75,33 +76,33 @@ describe('TranslatorSettingsDialogComponent', () => { expect(env.component!.translationSuggestionsUserEnabled).toBe(false); expect(await env.isToggleChecked(suggestionsToggle!)).toBe(false); - const userConfigDoc = env.getProjectUserConfigDoc(); + const userConfigDoc = await env.getProjectUserConfigDoc(); expect(userConfigDoc.data!.translationSuggestionsEnabled).toBe(false); env.closeDialog(); })); - it('update num suggestions', fakeAsync(() => { + it('update num suggestions', fakeAsync(async () => { const env = new TestEnvironment(); - env.openDialog(); + await env.openDialog(); expect(env.component!.numSuggestions).toEqual('1'); env.changeSelectValue(env.numSuggestionsSelect, 2); expect(env.component!.numSuggestions).toEqual('2'); - const userConfigDoc = env.getProjectUserConfigDoc(); + const userConfigDoc = await env.getProjectUserConfigDoc(); expect(userConfigDoc.data!.numSuggestions).toEqual(2); env.closeDialog(); })); - it('shows correct confidence threshold even when suggestions disabled', fakeAsync(() => { + it('shows correct confidence threshold even when suggestions disabled', fakeAsync(async () => { const env = new TestEnvironment({ translationSuggestionsEnabled: false }); - env.openDialog(); + await env.openDialog(); expect(env.component?.confidenceThreshold).toEqual(50); env.closeDialog(); })); - it('disables settings when offline', fakeAsync(() => { + it('disables settings when offline', fakeAsync(async () => { const env = new TestEnvironment(); - env.openDialog(); + await env.openDialog(); expect(env.offlineAppNotice == null).toBeTrue(); expect(env.suggestionsEnabledCheckbox.disabled).toBe(false); @@ -119,7 +120,7 @@ describe('TranslatorSettingsDialogComponent', () => { it('should hide translation suggestions section when project has translation suggestions disabled', fakeAsync(async () => { const env = new TestEnvironment(); - const projectDoc = env.getProjectProfileDoc(); + const projectDoc = await env.getProjectProfileDoc(); env.setupProject({ userConfig: { @@ -131,7 +132,7 @@ describe('TranslatorSettingsDialogComponent', () => { }); env.fixture.detectChanges(); - env.openDialog(); + await env.openDialog(); expect(env.component!.showSuggestionsSettings).toBe(false); expect(env.suggestionsSection == null).toBeTrue(); @@ -140,7 +141,7 @@ describe('TranslatorSettingsDialogComponent', () => { it('should show translation suggestions section when project has translation suggestions enabled', fakeAsync(async () => { const env = new TestEnvironment(); - env.openDialog(); + await env.openDialog(); expect(env.component!.showSuggestionsSettings).toBe(true); expect(env.suggestionsSection == null).toBeFalse(); @@ -150,7 +151,7 @@ describe('TranslatorSettingsDialogComponent', () => { it('the suggestions toggle is switched on when the dialog opens while offline', fakeAsync(async () => { const env = new TestEnvironment(); env.isOnline = false; - env.openDialog(); + await env.openDialog(); const suggestionsToggle = await env.getSuggestionsEnabledToggle(); expect(await env.isToggleDisabled(suggestionsToggle!)).toBe(true); @@ -159,7 +160,7 @@ describe('TranslatorSettingsDialogComponent', () => { })); describe('Lynx Settings', () => { - it('should show Lynx settings when both project features are enabled', fakeAsync(() => { + it('should show Lynx settings when both project features are enabled', fakeAsync(async () => { const env = new TestEnvironment(); env.setupProject({ projectConfig: { @@ -171,7 +172,7 @@ describe('TranslatorSettingsDialogComponent', () => { } } }); - env.openDialog(); + await env.openDialog(); expect(env.lynxSettingsSection == null).toBeFalse(); expect(env.lynxMasterSwitch == null).toBeFalse(); @@ -180,7 +181,7 @@ describe('TranslatorSettingsDialogComponent', () => { env.closeDialog(); })); - it('should hide Lynx settings when project features are disabled', fakeAsync(() => { + it('should hide Lynx settings when project features are disabled', fakeAsync(async () => { const env = new TestEnvironment(); env.setupProject({ projectConfig: { @@ -192,13 +193,13 @@ describe('TranslatorSettingsDialogComponent', () => { } } }); - env.openDialog(); + await env.openDialog(); expect(env.lynxSettingsSection == null).toBeTrue(); env.closeDialog(); })); - it('should show only assessments switch when only assessments is enabled in project', fakeAsync(() => { + it('should show only assessments switch when only assessments is enabled in project', fakeAsync(async () => { const env = new TestEnvironment(); env.setupProject({ projectConfig: { @@ -210,7 +211,7 @@ describe('TranslatorSettingsDialogComponent', () => { } } }); - env.openDialog(); + await env.openDialog(); expect(env.lynxSettingsSection == null).toBeFalse(); expect(env.lynxMasterSwitch == null).toBeFalse(); @@ -219,7 +220,7 @@ describe('TranslatorSettingsDialogComponent', () => { env.closeDialog(); })); - it('should show only auto-corrections switch when only auto-corrections is enabled in project', fakeAsync(() => { + it('should show only auto-corrections switch when only auto-corrections is enabled in project', fakeAsync(async () => { const env = new TestEnvironment(); env.setupProject({ projectConfig: { @@ -231,7 +232,7 @@ describe('TranslatorSettingsDialogComponent', () => { } } }); - env.openDialog(); + await env.openDialog(); expect(env.lynxSettingsSection == null).toBeFalse(); expect(env.lynxMasterSwitch == null).toBeFalse(); @@ -258,7 +259,7 @@ describe('TranslatorSettingsDialogComponent', () => { } } }); - env.openDialog(); + await env.openDialog(); const lynxMasterToggle = await env.getLynxMasterToggle(); expect(lynxMasterToggle).not.toBeNull(); @@ -269,7 +270,7 @@ describe('TranslatorSettingsDialogComponent', () => { expect(env.component!.lynxMasterSwitch.value).toBe(false); expect(await env.isToggleChecked(lynxMasterToggle!)).toBe(false); - const userConfigDoc = env.getProjectUserConfigDoc(); + const userConfigDoc = await env.getProjectUserConfigDoc(); expect(userConfigDoc.data!.lynxInsightState?.autoCorrectionsEnabled).toBe(false); expect(userConfigDoc.data!.lynxInsightState?.assessmentsEnabled).toBe(false); env.closeDialog(); @@ -288,7 +289,7 @@ describe('TranslatorSettingsDialogComponent', () => { } }); env.isOnline = false; - env.openDialog(); + await env.openDialog(); const lynxMasterToggle = await env.getLynxMasterToggle(); const lynxAssessmentsToggle = await env.getLynxAssessmentsToggle(); @@ -405,23 +406,21 @@ class TestEnvironment { tick(matDialogCloseDelay); } - openDialog(): void { - this.realtimeService - .subscribe( - SF_PROJECT_USER_CONFIGS_COLLECTION, - getSFProjectUserConfigDocId('project01', 'user01') - ) - .then(projectUserConfigDoc => { - const viewContainerRef = this.fixture.componentInstance.childViewContainer; - const projectDoc = this.getProjectProfileDoc(); - const config: MatDialogConfig = { - data: { projectDoc, projectUserConfigDoc }, - viewContainerRef - }; - const dialogRef = TestBed.inject(MatDialog).open(TranslatorSettingsDialogComponent, config); - this.component = dialogRef.componentInstance; - this.loader = TestbedHarnessEnvironment.documentRootLoader(this.fixture); - }); + async openDialog(): Promise { + const projectUserConfigDoc = await this.realtimeService.subscribe( + SF_PROJECT_USER_CONFIGS_COLLECTION, + getSFProjectUserConfigDocId('project01', 'user01'), + new DocSubscription('spec') + ); + const viewContainerRef = this.fixture.componentInstance.childViewContainer; + const projectDoc = await this.getProjectProfileDoc(); + const config: MatDialogConfig = { + data: { projectDoc, projectUserConfigDoc }, + viewContainerRef + }; + const dialogRef = TestBed.inject(MatDialog).open(TranslatorSettingsDialogComponent, config); + this.component = dialogRef.componentInstance; + this.loader = TestbedHarnessEnvironment.documentRootLoader(this.fixture); this.wait(); } @@ -485,14 +484,19 @@ class TestEnvironment { }); } - getProjectProfileDoc(): SFProjectProfileDoc { - return this.realtimeService.get(SFProjectProfileDoc.COLLECTION, 'project01'); + async getProjectProfileDoc(): Promise { + return await this.realtimeService.get( + SFProjectProfileDoc.COLLECTION, + 'project01', + new DocSubscription('spec') + ); } - getProjectUserConfigDoc(): SFProjectUserConfigDoc { - return this.realtimeService.get( + async getProjectUserConfigDoc(): Promise { + return await this.realtimeService.get( SFProjectUserConfigDoc.COLLECTION, - getSFProjectUserConfigDocId('project01', 'user01') + getSFProjectUserConfigDocId('project01', 'user01'), + new DocSubscription('spec') ); }