Fix what ain't broke. Apply await patterns in other spec files

Author: marksvc

src/SIL.XForge.Scripture/ClientApp/src/app/checking/chapter-audio-dialog/chapter-audio-dialog.component.spec.ts

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

src/SIL.XForge.Scripture/ClientApp/src/app/my-projects/my-projects.component.spec.ts

@@ -104,13 +104,13 @@ describe('MyProjectsComponent', () => {
     expect(env.router.url).toEqual('/projects/sf-cbntt');
   }));
 
-  it('user cannot join a project while offline', fakeAsync(() => {
+  it('user cannot join a project while offline', fakeAsync(async () => {
     const env = new TestEnvironment();
     env.waitUntilLoaded();
     env.onlineStatus = false;
     expect(env.messageOffline).not.toBeNull();
     expect(env.buttonForUnconnectedProject('pt-connButNotThisUser').nativeElement.disabled).toBe(true);
-    env.component.joinProject('sf-cbntt');
+    await env.component.joinProject('sf-cbntt');
     tick();
     env.fixture.detectChanges();
     verify(mockedNoticeService.show(anything())).once();

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

@@ -64,7 +64,7 @@ describe('TextComponent', () => {
     mockedConsole.reset();
   });
 
-  it('shows proper placeholder messages for situations', fakeAsync(() => {
+  it('shows proper placeholder messages for situations', fakeAsync(async () => {
     // Suppose a user comes to a page with a text component, which has no content to show. The placeholder will be a
     // 'no-content' indication, or that specified as a placeholder Input. Here we will not specify the placeholder
     // input.
@@ -85,7 +85,7 @@ describe('TextComponent', () => {
 
     // The user goes to a location. The id input is set to a particular location. The text component is now expected to
     // have content, so the placeholder should be 'loading'.
-    env.runWithDelayedGetText(env.matTextDocId, () => {
+    await env.runWithDelayedGetText(env.matTextDocId, () => {
       env.id = env.matTextDocId;
       env.waitForEditor();
       expect(env.component.placeholder).toEqual('text.loading');
@@ -95,7 +95,7 @@ describe('TextComponent', () => {
     // why they can't see the content if and while it has not loaded yet.
     env.onlineStatus = false;
     env.waitForEditor();
-    env.runWithDelayedGetText(env.lukTextDocId, () => {
+    await env.runWithDelayedGetText(env.lukTextDocId, () => {
       env.id = env.lukTextDocId;
       env.waitForEditor();
       expect(env.component.placeholder).toEqual('text.not_available_offline');
@@ -107,7 +107,7 @@ describe('TextComponent', () => {
     });
 
     // The user goes to a location that the project does not have. The placeholder should indicate 'no-content'.
-    env.runWithDelayedGetText(env.notPresentTextDocId, () => {
+    await env.runWithDelayedGetText(env.notPresentTextDocId, () => {
       env.id = env.notPresentTextDocId;
       env.waitForEditor();
       expect(env.component.placeholder).toEqual('text.book_does_not_exist');
@@ -119,7 +119,7 @@ describe('TextComponent', () => {
     env.waitForEditor();
     env.onlineStatus = false;
     env.waitForEditor();
-    env.runWithDelayedGetText(env.notPresentTextDocId, () => {
+    await env.runWithDelayedGetText(env.notPresentTextDocId, () => {
       env.id = env.notPresentTextDocId;
       env.waitForEditor();
       expect(env.component.placeholder).toEqual('text.book_does_not_exist');
@@ -160,7 +160,7 @@ describe('TextComponent', () => {
     expect(env2.component.placeholder).toEqual('text.permission_denied');
   }));
 
-  it('placeholder uses specified placeholder input', fakeAsync(() => {
+  it('placeholder uses specified placeholder input', fakeAsync(async () => {
     // TextComponent allows a placeholder to be specified to override the default no-content message.
 
     // Suppose a user comes to a page with a text component, which has no content to show. The placeholder will be the
@@ -182,14 +182,14 @@ describe('TextComponent', () => {
 
     // The user goes to a location. The id input is set to a particular location. The text component is now expected to
     // have content, so the placeholder should be 'loading'.
-    env.runWithDelayedGetText(env.matTextDocId, () => {
+    await env.runWithDelayedGetText(env.matTextDocId, () => {
       env.id = env.matTextDocId;
       env.waitForEditor();
       expect(env.component.placeholder).toEqual('text.loading');
     });
 
     // The user goes to a location that the project does not have. The placeholder should indicate 'no-content'.
-    env.runWithDelayedGetText(env.notPresentTextDocId, () => {
+    await env.runWithDelayedGetText(env.notPresentTextDocId, () => {
       env.id = env.notPresentTextDocId;
       env.waitForEditor();
       expect(env.component.placeholder).toEqual('my custom no-content message');
@@ -202,7 +202,7 @@ describe('TextComponent', () => {
     expect(env.component.placeholder).toEqual('my custom no-content message');
   }));
 
-  it('shows book is empty placeholder messages', fakeAsync(() => {
+  it('shows book is empty placeholder messages', fakeAsync(async () => {
     // Suppose the user navigates to a text location. We fetch the text, but some aspect of the received TextDoc
     // indicates that it is considered "empty". The placeholder will indicate this.
 
@@ -213,12 +213,10 @@ describe('TextComponent', () => {
 
     const textDocIdWithEmpty: TextDocId = env.matTextDocId;
 
-    let textDocBeingGotten: TextDoc = {} as TextDoc;
-    instance(mockedProjectService)
-      .getText(textDocIdWithEmpty.toString(), new DocSubscription('spec'))
-      .then((value: TextDoc) => {
-        textDocBeingGotten = value;
-      });
+    const textDocBeingGotten: TextDoc = await instance(mockedProjectService).getText(
+      textDocIdWithEmpty.toString(),
+      new DocSubscription('spec')
+    );
     tick();
     // The textdoc will have an undefined data field.
     Object.defineProperty(textDocBeingGotten, 'data', {
@@ -1459,48 +1457,39 @@ describe('TextComponent', () => {
     expect(wasLoaded).toBeUndefined();
   }));
 
-  it('knows if project has book with chapter', fakeAsync(() => {
+  it('knows if project has book with chapter', fakeAsync(async () => {
     const env: TestEnvironment = new TestEnvironment();
     env.fixture.detectChanges();
     env.id = new TextDocId('project01', 40, 1);
     tick();
     env.fixture.detectChanges();
 
-    let result: boolean | undefined;
-    env.component.projectHasText().then(res => {
-      result = res;
-    });
+    const result: boolean = await env.component.projectHasText();
     tick();
     expect(result).toBe(true);
   }));
 
-  it('knows if project does not have chapter', fakeAsync(() => {
+  it('knows if project does not have chapter', fakeAsync(async () => {
     const env: TestEnvironment = new TestEnvironment();
     env.fixture.detectChanges();
     env.id = new TextDocId('project01', 40, 99); // Non-existent chapter
     tick();
     env.fixture.detectChanges();
 
-    let result: boolean | undefined;
-    env.component.projectHasText().then(res => {
-      result = res;
-    });
+    const result: boolean = await env.component.projectHasText();
     tick();
 
     expect(result).toBe(false);
   }));
 
-  it('knows if project does not have book', fakeAsync(() => {
+  it('knows if project does not have book', fakeAsync(async () => {
     const env: TestEnvironment = new TestEnvironment();
     env.fixture.detectChanges();
     env.id = new TextDocId('project01', 3, 1); // Non-existent book
     tick();
     env.fixture.detectChanges();
 
-    let result: boolean | undefined;
-    env.component.projectHasText().then(res => {
-      result = res;
-    });
+    const result: boolean = await env.component.projectHasText();
     tick();
 
     expect(result).toBe(false);
@@ -2061,14 +2050,12 @@ class TestEnvironment {
 
   /** Run the specified code while waiting for getText() to resolve. This allows the placeholder to be examined while
    * waiting for getText(), rather than examining the placeholder after getText() finishes. */
-  runWithDelayedGetText(textDocId: TextDocId, code: () => void): void {
+  async runWithDelayedGetText(textDocId: TextDocId, code: () => void): Promise<void> {
     let resolver: (_: TextDoc) => void = _ => {};
-    let textDocBeingGotten: TextDoc = {} as TextDoc;
-    instance(mockedProjectService)
-      .getText(textDocId.toString(), new DocSubscription('spec'))
-      .then((value: TextDoc) => {
-        textDocBeingGotten = value;
-      });
+    const textDocBeingGotten: TextDoc = await instance(mockedProjectService).getText(
+      textDocId.toString(),
+      new DocSubscription('spec')
+    );
     tick();
     when(mockedProjectService.getText(textDocId, anything())).thenReturn(
       new Promise(resolve => {

src/SIL.XForge.Scripture/ClientApp/src/app/sync/sync-progress/sync-progress.component.spec.ts

@@ -51,7 +51,7 @@ describe('SyncProgressComponent', () => {
 
   it('does not initialize if app is offline', fakeAsync(async () => {
     const env = new TestEnvironment({ userId: 'user01' });
-    env.setupProjectDoc();
+    await env.setupProjectDoc();
     env.onlineStatus = false;
     verify(mockedProjectService.subscribe('sourceProject02', anything())).never();
     expect(await env.getMode()).toBe('indeterminate');
@@ -60,7 +60,7 @@ describe('SyncProgressComponent', () => {
   it('ignores source if source project is invalid', fakeAsync(async () => {
     when(mockedProjectService.onlineGetProjectRole('invalid_source')).thenResolve(SFProjectRole.None);
     const env = new TestEnvironment({ userId: 'user01', sourceProject: 'invalid_source' });
-    env.setupProjectDoc();
+    await env.setupProjectDoc();
     verify(mockedProjectService.onlineGetProjectRole('invalid_source')).once();
     await env.updateSyncProgress(0.5, 'testProject01');
     expect(env.host.inProgress).toBe(true);
@@ -72,7 +72,7 @@ describe('SyncProgressComponent', () => {
 
   it('should show progress when sync is active', fakeAsync(async () => {
     const env = new TestEnvironment({ userId: 'user01' });
-    env.setupProjectDoc();
+    await env.setupProjectDoc();
     // Simulate sync starting
     await env.updateSyncProgress(0, 'testProject01');
     expect(env.progressBar).not.toBeNull();
@@ -93,7 +93,7 @@ describe('SyncProgressComponent', () => {
       sourceProject: 'sourceProject02',
       translationSuggestionsEnabled: true
     });
-    env.setupProjectDoc();
+    await env.setupProjectDoc();
     await env.checkCombinedProgress();
     expect(env.syncStatus).not.toBeNull();
     tick();
@@ -105,15 +105,15 @@ describe('SyncProgressComponent', () => {
       sourceProject: 'sourceProject02',
       translationSuggestionsEnabled: false
     });
-    env.setupProjectDoc();
+    await env.setupProjectDoc();
     await env.checkCombinedProgress();
     expect(env.syncStatus).not.toBeNull();
     tick();
   }));
 
   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();
+    await env.setupProjectDoc();
     await env.updateSyncProgress(0, 'testProject01');
     await env.updateSyncProgress(0, 'sourceProject02');
     verify(mockedProjectService.subscribe('sourceProject02', anything())).never();
@@ -124,10 +124,10 @@ describe('SyncProgressComponent', () => {
     await env.emitSyncComplete(true, 'testProject01');
   }));
 
-  it('does not throw error if get project role times out', fakeAsync(() => {
+  it('does not throw error if get project role times out', fakeAsync(async () => {
     const env = new TestEnvironment({ userId: 'user01', sourceProject: 'sourceProject02' });
     when(mockedProjectService.onlineGetProjectRole('sourceProject02')).thenReject(new Error('504: Gateway Timeout'));
-    env.setupProjectDoc();
+    await env.setupProjectDoc();
     verify(mockedProjectService.onlineGetProjectRole('sourceProject02')).once();
     verify(mockedProjectService.subscribe('sourceProject02', anything())).never();
     verify(mockedErrorReportingService.silentError(anything(), anything())).once();
@@ -147,8 +147,8 @@ class HostComponent {
 
   constructor(private readonly projectService: SFProjectService) {}
 
-  setProjectDoc(): void {
-    this.projectService.subscribe('testProject01', new DocSubscription('spec')).then(doc => (this.projectDoc = doc));
+  async setProjectDoc(): Promise<void> {
+    this.projectDoc = await this.projectService.subscribe('testProject01', new DocSubscription('spec'));
   }
 }
 
@@ -272,8 +272,8 @@ class TestEnvironment {
     this.fixture.detectChanges();
   }
 
-  setupProjectDoc(): void {
-    this.host.setProjectDoc();
+  async setupProjectDoc(): Promise<void> {
+    await this.host.setProjectDoc();
     tick();
     this.fixture.detectChanges();
     tick();

src/SIL.XForge.Scripture/ClientApp/src/app/translate/draft-generation/draft-sources/draft-sources.component.spec.ts

@@ -174,7 +174,7 @@ describe('DraftSourcesComponent', () => {
       verify(mockedDialogService.confirm(anything(), anything(), anything())).never();
 
       // SUT
-      env.component.save();
+      await env.component.save();
       tick();
       verify(mockedSFProjectService.onlineUpdateSettings(env.activatedProjectDoc.id, anything())).once();
       const actualSettingsChangeRequest: SFProjectSettings = capture(
@@ -219,7 +219,7 @@ describe('DraftSourcesComponent', () => {
       verify(mockedDialogService.confirm(anything(), anything(), anything())).once();
 
       // SUT
-      env.component.save();
+      await env.component.save();
       tick();
       verify(mockedSFProjectService.onlineUpdateSettings(env.activatedProjectDoc.id, anything())).once();
       const actualSettingsChangeRequest: SFProjectSettings = capture(
@@ -262,7 +262,7 @@ describe('DraftSourcesComponent', () => {
       tick();
 
       // SUT
-      env.component.save();
+      await env.component.save();
       tick();
       verify(mockedSFProjectService.onlineUpdateSettings(env.activatedProjectDoc.id, anything())).once();
       const actualSettingsChangeRequest: SFProjectSettings = capture(
@@ -291,7 +291,7 @@ describe('DraftSourcesComponent', () => {
       );
 
       // SUT
-      env.component.save();
+      await env.component.save();
       tick();
       verify(mockedSFProjectService.onlineUpdateSettings(env.activatedProjectDoc.id, anything())).once();
     }));
@@ -339,7 +339,7 @@ describe('DraftSourcesComponent', () => {
 
       env.component.onTrainingDataSelect([{ dataId: 'test1' } as TrainingData, { dataId: 'test2' } as TrainingData]);
 
-      env.component.save();
+      await env.component.save();
       tick();
       verify(mockedSFProjectService.onlineUpdateSettings(env.activatedProjectDoc.id, anything())).once();
       const actualSettingsChangeRequest: SFProjectSettings = capture(
@@ -363,7 +363,7 @@ describe('DraftSourcesComponent', () => {
 
       const newFile = { dataId: 'test1' } as TrainingData;
       env.component.onTrainingDataSelect([newFile]);
-      env.component.save();
+      await env.component.save();
 
       verify(mockTrainingDataService.createTrainingDataAsync(newFile)).once();
     }));
@@ -387,7 +387,7 @@ describe('DraftSourcesComponent', () => {
       expect(env.component.availableTrainingFiles.length).toEqual(2);
 
       env.component.onTrainingDataSelect([savedFile1]);
-      env.component.save();
+      await env.component.save();
       tick();
 
       verify(mockTrainingDataService.deleteTrainingDataAsync(savedFile2)).once();

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

@@ -2546,7 +2546,7 @@ describe('EditorComponent', () => {
       const insert: string = 'abc';
       const deltaOps: DeltaOperation[] = [{ retain: remoteEditTextPos }, { insert: insert }];
       const textDoc: TextDoc = await env.getTextDoc(new TextDocId('project01', 40, 1));
-      textDoc.submit(new Delta(deltaOps));
+      await textDoc.submit(new Delta(deltaOps));
 
       env.wait();
       expect(env.getNoteThreadEditorPosition('dataid02')).toEqual(notePosition);