SF-3633 Add draft import wizard (#3638)

Co-authored-by: Nateowami <nathaniel_paulus@sil.org>

Author: pmachapman

src/RealtimeServer/common/index.ts

@@ -210,7 +210,8 @@ export = {
     collection: string,
     id: string,
     data: any,
-    typeName: OTType
+    typeName: OTType,
+    source: string | undefined
   ): void => {
     if (server == null) {
       callback(new Error('Server not started.'));
@@ -221,7 +222,17 @@ export = {
       callback(new Error('Connection not found.'));
       return;
     }
-    doc.create(data, typeName, err => callback(err, createSnapshot(doc)));
+    const options: any = {};
+    doc.submitSource = source != null;
+    if (source != null) {
+      options.source = source;
+    }
+    doc.create(data, typeName, options, err => {
+      if (source != null) {
+        doc.submitSource = false;
+      }
+      callback(err, createSnapshot(doc));
+    });
   },
 
   fetchDoc: (callback: InteropCallback, handle: number, collection: string, id: string): void => {

src/RealtimeServer/common/utils/sharedb-utils.ts

@@ -13,9 +13,15 @@ export function docFetch(doc: Doc): Promise<void> {
   });
 }
 
-export function docCreate(doc: Doc, data: any, type?: OTType): Promise<void> {
+export function docCreate(
+  doc: Doc,
+  data: any,
+  type?: OTType,
+  source: boolean | any | undefined = undefined
+): Promise<void> {
+  const options: ShareDBSourceOptions = source != null ? { source } : {};
   return new Promise<void>((resolve, reject) => {
-    doc.create(data, type, err => {
+    doc.create(data, type, options, err => {
       if (err != null) {
         reject(err);
       } else {

src/RealtimeServer/common/utils/test-utils.ts

@@ -20,8 +20,19 @@ export async function hasDoc(conn: Connection, collection: string, id: string):
   return doc.data != null;
 }
 
-export function createDoc<T>(conn: Connection, collection: string, id: string, data: T, type?: OTType): Promise<void> {
-  return docCreate(conn.get(collection, id), data, type);
+export function createDoc<T>(
+  conn: Connection,
+  collection: string,
+  id: string,
+  data: T,
+  type?: OTType,
+  source: boolean | any | undefined = undefined
+): Promise<void> {
+  const doc = conn.get(collection, id);
+  if (source != null) {
+    doc.submitSource = true;
+  }
+  return docCreate(doc, data, type, source);
 }
 
 export async function submitOp(

src/RealtimeServer/scriptureforge/services/text-service.spec.ts

@@ -75,6 +75,22 @@ describe('TextService', () => {
       });
     });
   });
+
+  it('writes the op source to the database on create', async () => {
+    const env = new TestEnvironment();
+    await env.createData();
+
+    const conn = clientConnect(env.server, 'administrator');
+    const id: string = getTextDocId('project01', 40, 2);
+    const source: string = 'history';
+    await createDoc<TextData>(conn, TEXTS_COLLECTION, id, new Delta(), 'rich-text', source);
+    await new Promise<void>(resolve => {
+      env.db.getOps(TEXTS_COLLECTION, id, 0, null, { metadata: true }, (_, ops) => {
+        expect(ops[0].m.source).toBe(source);
+        resolve();
+      });
+    });
+  });
 });
 
 class TestEnvironment {

src/SIL.XForge.Scripture/ClientApp/e2e/workflows/generate-draft.ts

@@ -1,6 +1,6 @@
 import { expect } from 'npm:@playwright/test';
 import { Locator, Page } from 'npm:playwright';
-import { preset, ScreenshotContext } from '../e2e-globals.ts';
+import { E2E_SYNC_DEFAULT_TIMEOUT, preset, ScreenshotContext } from '../e2e-globals.ts';
 import {
   enableDeveloperMode,
   enableDraftingOnProjectAsServalAdmin,
@@ -203,21 +203,27 @@ export async function generateDraft(
   await user.click(page.getByRole('button', { name: 'Save' }));
 
   // Preview and apply chapter 1
-  await user.click(page.getByRole('radio', { name: bookToDraft }));
+  await user.click(page.getByRole('button', { name: bookToDraft, exact: true }));
   await user.click(page.getByRole('button', { name: 'Add to project' }));
   await user.click(page.getByRole('button', { name: 'Overwrite chapter' }));
   await user.click(page.locator('app-tab-header').filter({ hasText: DRAFT_PROJECT_SHORT_NAME }));
 
   // Go back to generate draft page and apply all chapters
   await user.click(page.getByRole('link', { name: 'Generate draft' }));
-  await user.click(page.locator('app-draft-preview-books mat-button-toggle:last-child button'));
-  await user.click(page.getByRole('menuitem', { name: 'Add to project' }));
-  await user.check(page.getByRole('checkbox', { name: /I understand the draft will overwrite .* in .* project/ }));
   await user.click(page.getByRole('button', { name: 'Add to project' }));
-  await expect(
-    page.getByRole('heading', { name: `Successfully applied all chapters to ${bookToDraft}` })
-  ).toBeVisible();
-  await user.click(page.getByRole('button', { name: 'Close' }));
+  await user.click(page.getByRole('combobox', { name: 'Choose a project' }));
+  await user.type(DRAFT_PROJECT_SHORT_NAME);
+  await user.click(page.getByRole('option', { name: `${DRAFT_PROJECT_SHORT_NAME} -` }));
+  await user.click(page.getByRole('button', { name: 'Next' }));
+  await user.check(page.getByRole('checkbox', { name: /I understand that existing content will be overwritten/ }));
+  await user.click(page.getByRole('button', { name: 'Import' }));
+  await expect(page.getByText('Import complete', { exact: true })).toBeVisible();
+  await user.click(page.getByRole('button', { name: 'Next' }));
+  await user.click(page.locator('[data-test-id="step-7-sync"]'));
+  await expect(page.getByText(`The draft has been imported into ${DRAFT_PROJECT_SHORT_NAME}`)).toBeVisible({
+    timeout: E2E_SYNC_DEFAULT_TIMEOUT
+  });
+  await user.click(page.getByRole('button', { name: 'Done' }));
 
   await screenshot(page, { pageName: 'generate_draft_add_to_project', ...context });
 

src/SIL.XForge.Scripture/ClientApp/e2e/workflows/localized-screenshots.ts

@@ -432,11 +432,11 @@ export async function localizedScreenshots(
   await user.click(page.getByRole('button', { name: 'Save' }));
 
   await forEachLocale(async locale => {
-    await user.hover(page.getByRole('radio').first(), defaultArrowLocation);
+    await user.hover(page.getByRole('button', { name: 'Ruth', exact: true }), defaultArrowLocation);
     await screenshot(page, { ...context, pageName: 'draft_complete', locale });
   });
 
-  await page.getByRole('radio', { name: 'Ruth' }).first().click();
+  await user.click(page.getByRole('button', { name: 'Ruth', exact: true }));
 
   await expect(page.getByRole('button', { name: 'Add to project' })).toBeVisible({ timeout: 15_000 });
 
@@ -461,19 +461,16 @@ export async function localizedScreenshots(
   await expect(page.getByText('The draft is ready')).toBeVisible();
 
   await forEachLocale(async locale => {
-    await page.getByRole('radio').nth(1).click();
-    await user.hover(page.getByRole('menuitem').last(), defaultArrowLocation);
+    await user.hover(page.getByRole('button', { name: 'Add to project' }), defaultArrowLocation);
     await screenshot(page, { ...context, pageName: 'import_book', locale });
-    await page.keyboard.press('Escape');
   });
 
   await forEachLocale(async locale => {
-    await page.getByRole('radio').nth(1).click();
-    await page.getByRole('menuitem').last().click();
+    await user.click(page.getByRole('button', { name: 'Add to project' }));
+
     await page.getByRole('combobox').fill('seedsp2');
     await page.getByRole('option', { name: 'seedsp2 - ' }).click();
-    await page.getByRole('checkbox').check();
-    await user.hover(page.getByRole('button').last(), defaultArrowLocation);
+    await user.hover(page.getByRole('button', { name: 'next' }), defaultArrowLocation);
     await screenshotElements(
       page,
       [page.locator('mat-dialog-container')],

src/SIL.XForge.Scripture/ClientApp/src/app/core/project-notification.service.ts

@@ -1,5 +1,11 @@
 import { Injectable } from '@angular/core';
-import { AbortError, HubConnection, HubConnectionBuilder, IHttpConnectionOptions } from '@microsoft/signalr';
+import {
+  AbortError,
+  HubConnection,
+  HubConnectionBuilder,
+  HubConnectionState,
+  IHttpConnectionOptions
+} from '@microsoft/signalr';
 import { AuthService } from 'xforge-common/auth.service';
 import { OnlineStatusService } from 'xforge-common/online-status.service';
 
@@ -11,6 +17,7 @@ export class ProjectNotificationService {
   private options: IHttpConnectionOptions = {
     accessTokenFactory: async () => (await this.authService.getAccessToken()) ?? ''
   };
+  private openConnections: number = 0;
 
   constructor(
     private authService: AuthService,
@@ -30,6 +37,10 @@ export class ProjectNotificationService {
     this.connection.off('notifyBuildProgress', handler);
   }
 
+  removeNotifyDraftApplyProgressHandler(handler: any): void {
+    this.connection.off('notifyDraftApplyProgress', handler);
+  }
+
   removeNotifySyncProgressHandler(handler: any): void {
     this.connection.off('notifySyncProgress', handler);
   }
@@ -38,25 +49,39 @@ export class ProjectNotificationService {
     this.connection.on('notifyBuildProgress', handler);
   }
 
+  setNotifyDraftApplyProgressHandler(handler: any): void {
+    this.connection.on('notifyDraftApplyProgress', handler);
+  }
+
   setNotifySyncProgressHandler(handler: any): void {
     this.connection.on('notifySyncProgress', handler);
   }
 
   async start(): Promise<void> {
-    await this.connection.start().catch(err => {
-      // Suppress AbortErrors, as they are not caused by server error, but the SignalR connection state
-      // These will be thrown if a user navigates away quickly after
-      // starting the sync or the app loses internet connection
-      if (err instanceof AbortError || !this.appOnline) {
-        return;
-      } else {
-        throw err;
-      }
-    });
+    this.openConnections++;
+    if (
+      this.connection.state !== HubConnectionState.Connected &&
+      this.connection.state !== HubConnectionState.Connecting &&
+      this.connection.state !== HubConnectionState.Reconnecting
+    ) {
+      await this.connection.start().catch(err => {
+        // Suppress AbortErrors, as they are not caused by server error, but the SignalR connection state
+        // These will be thrown if a user navigates away quickly after
+        // starting the sync or the app loses internet connection
+        if (err instanceof AbortError || !this.appOnline) {
+          return;
+        } else {
+          throw err;
+        }
+      });
+    }
   }
 
   async stop(): Promise<void> {
-    await this.connection.stop();
+    // Only stop the connection if this is the last open connection
+    if (this.openConnections > 0 && --this.openConnections === 0) {
+      await this.connection.stop();
+    }
   }
 
   async subscribeToProject(projectId: string): Promise<void> {

src/SIL.XForge.Scripture/ClientApp/src/app/core/sf-project.service.spec.ts

@@ -119,15 +119,6 @@ describe('SFProjectService', () => {
     }));
   });
 
-  describe('onlineAddChapters', () => {
-    it('should invoke the command service', fakeAsync(async () => {
-      const env = new TestEnvironment();
-      await env.service.onlineAddChapters('project01', 1, [2, 3]);
-      verify(mockedCommandService.onlineInvoke(anything(), 'addChapters', anything())).once();
-      expect().nothing();
-    }));
-  });
-
   describe('onlineSetDraftApplied', () => {
     it('should invoke the command service', fakeAsync(async () => {
       const env = new TestEnvironment();

src/SIL.XForge.Scripture/ClientApp/src/app/core/sf-project.service.ts

@@ -236,10 +236,6 @@ export class SFProjectService extends ProjectService<SFProject, SFProjectDoc> {
     });
   }
 
-  onlineAddChapters(projectId: string, book: number, chapters: number[]): Promise<void> {
-    return this.onlineInvoke<void>('addChapters', { projectId, book, chapters });
-  }
-
   onlineUpdateSettings(id: string, settings: SFProjectSettings): Promise<void> {
     return this.onlineInvoke('updateSettings', { projectId: id, settings });
   }

src/SIL.XForge.Scripture/ClientApp/src/app/core/text-doc.service.spec.ts

@@ -183,25 +183,6 @@ describe('TextDocService', () => {
     });
   });
 
-  describe('createTextDoc', () => {
-    it('should throw error if text doc already exists', fakeAsync(() => {
-      const env = new TestEnvironment();
-      expect(() => {
-        env.textDocService.createTextDoc(env.textDocId, getTextDoc(env.textDocId));
-        tick();
-      }).toThrowError();
-    }));
-
-    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));
-      tick();
-
-      expect(textDoc.data).toBeDefined();
-    }));
-  });
-
   describe('isDataInSync', () => {
     it('should return true if the project is undefined', () => {
       const env = new TestEnvironment();