Add the Paratext 9 import service, storage, and commands

__mocks__/papi-backend.ts

@@ -15,6 +15,8 @@ const mockReadUserData = jest.fn();
 const mockWriteUserData = jest.fn();
 const mockDeleteUserData = jest.fn();
 const mockNotificationsSend = jest.fn();
+const mockProjectDataProvidersGet = jest.fn();
+const mockGetLocalizedString = jest.fn();
 const mockLogger = {
   debug: jest.fn(),
   error: jest.fn(),
@@ -35,6 +37,12 @@ const papi = {
   notifications: {
     send: mockNotificationsSend,
   },
+  projectDataProviders: {
+    get: mockProjectDataProvidersGet,
+  },
+  localization: {
+    getLocalizedString: mockGetLocalizedString,
+  },
   storage: {
     readUserData: mockReadUserData,
     writeUserData: mockWriteUserData,
@@ -69,6 +77,8 @@ const defaultExport = {
   __mockWriteUserData: mockWriteUserData,
   __mockDeleteUserData: mockDeleteUserData,
   __mockNotificationsSend: mockNotificationsSend,
+  __mockProjectDataProvidersGet: mockProjectDataProvidersGet,
+  __mockGetLocalizedString: mockGetLocalizedString,
   __mockLogger: mockLogger,
 };
 

contributions/localizedStrings.json

@@ -142,7 +142,13 @@
       "%interlinearizer_error_update_project_failed%": "Could not update the interlinearizer project. Please try again.",
       "%interlinearizer_error_load_projects_failed%": "Could not load interlinear projects. Please try again.",
       "%interlinearizer_error_save_draft_failed%": "Could not save your working draft. Please try again.",
-      "%interlinearizer_error_save_analysis_failed%": "Could not save your analysis. Please try again."
+      "%interlinearizer_error_save_analysis_failed%": "Could not save your analysis. Please try again.",
+
+      "%interlinearizer_pt9Import_name%": "Paratext 9 Interlinear",
+      "%interlinearizer_pt9Import_description%": "Imported from this project's Paratext 9 interlinear data. Read-only; synced from the Paratext 9 files.",
+      "%interlinearizer_error_pt9Import_failed%": "Could not import the Paratext 9 interlinear data. Please try again.",
+      "%interlinearizer_warning_pt9Import_sourceEmpty%": "The project's Paratext 9 interlinear files are missing, so the imported data was left as it was.",
+      "%interlinearizer_error_createEditableCopy_failed%": "Could not copy the imported project. Please try again."
     }
   }
 }

src/__tests__/main.test.ts

@@ -5,10 +5,12 @@ import papiBackendMock from '@papi/backend';
 import { activate, deactivate } from '@main';
 import type { InterlinearizerOpenOptions } from '@main';
 import * as projectStorage from '../services/projectStorage';
+import * as pt9ImportService from '../services/pt9ImportService';
 import { emptyAnalysis, emptyDraft } from '../types/empty-factories';
 import { createTestActivationContext, makeStubProject } from './test-helpers';
 
 jest.mock('../services/projectStorage');
+jest.mock('../services/pt9ImportService');
 
 /** Shape of the Jest-mocked @papi/backend default export used in these tests. */
 interface PapiBackendTestMock {
@@ -144,6 +146,18 @@ const getUpdateProjectMetadataHandler = () =>
     ) => Promise<string | undefined>
   >('interlinearizer.updateProjectMetadata');
 
+/** Activates the extension and returns the `interlinearizer.importPt9Project` handler. */
+const getImportPt9ProjectHandler = () =>
+  activateAndGetHandler<(sourceProjectId: string) => Promise<string>>(
+    'interlinearizer.importPt9Project',
+  );
+
+/** Activates the extension and returns the `interlinearizer.createEditableCopy` handler. */
+const getCreateEditableCopyHandler = () =>
+  activateAndGetHandler<(id: string, name: string, description?: string) => Promise<string>>(
+    'interlinearizer.createEditableCopy',
+  );
+
 /** Activates the extension and returns the `interlinearizer.getProject` handler. */
 const getGetProjectHandler = () =>
   activateAndGetHandler<(id: string) => Promise<string | undefined>>('interlinearizer.getProject');
@@ -1151,4 +1165,106 @@ describe('main', () => {
       expect(__mockLogger.debug).toHaveBeenCalledWith('Interlinearizer extension is deactivating!');
     });
   });
+
+  describe('interlinearizer.importPt9Project command', () => {
+    const mockImport = jest.mocked(pt9ImportService.importPt9Project);
+
+    it('registers the interlinearizer.importPt9Project command', async () => {
+      const context = createTestActivationContext();
+
+      await activate(context);
+
+      expect(__mockRegisterCommand).toHaveBeenCalledWith(
+        'interlinearizer.importPt9Project',
+        expect.any(Function),
+        expect.any(Object),
+      );
+    });
+
+    it('returns the import result as JSON without a warning when data was imported', async () => {
+      mockImport.mockResolvedValue({ outcome: 'imported', projectId: 'import-id' });
+      const handler = await getImportPt9ProjectHandler();
+
+      const result = await handler('src-project');
+
+      expect(mockImport).toHaveBeenCalledWith(expect.anything(), 'src-project');
+      expect(JSON.parse(result)).toStrictEqual({ outcome: 'imported', projectId: 'import-id' });
+      expect(__mockNotificationsSend).not.toHaveBeenCalled();
+    });
+
+    it('sends a warning notification when the stored import was kept', async () => {
+      mockImport.mockResolvedValue({ outcome: 'staleKept', projectId: 'import-id' });
+      const handler = await getImportPt9ProjectHandler();
+
+      const result = await handler('src-project');
+
+      expect(JSON.parse(result)).toStrictEqual({ outcome: 'staleKept', projectId: 'import-id' });
+      expect(__mockNotificationsSend).toHaveBeenCalledWith({
+        message: '%interlinearizer_warning_pt9Import_sourceEmpty%',
+        severity: 'warning',
+      });
+    });
+
+    it('logs the error, sends an error notification, and rethrows when the import fails', async () => {
+      mockImport.mockRejectedValue(new Error('nothing to import'));
+      const handler = await getImportPt9ProjectHandler();
+
+      await expect(handler('src-project')).rejects.toThrow('nothing to import');
+      expect(__mockLogger.error).toHaveBeenCalledWith(
+        'Interlinearizer: failed to import Paratext 9 interlinear data',
+        expect.any(Error),
+      );
+      expect(__mockNotificationsSend).toHaveBeenCalledWith({
+        message: '%interlinearizer_error_pt9Import_failed%',
+        severity: 'error',
+      });
+    });
+  });
+
+  describe('interlinearizer.createEditableCopy command', () => {
+    const mockCopy = jest.mocked(projectStorage.createEditableCopy);
+
+    it('registers the interlinearizer.createEditableCopy command', async () => {
+      const context = createTestActivationContext();
+
+      await activate(context);
+
+      expect(__mockRegisterCommand).toHaveBeenCalledWith(
+        'interlinearizer.createEditableCopy',
+        expect.any(Function),
+        expect.any(Object),
+      );
+    });
+
+    it('returns the created copy as JSON', async () => {
+      const copy = { ...makeStubProject('copy-id'), name: 'My Copy' };
+      mockCopy.mockResolvedValue(copy);
+      const handler = await getCreateEditableCopyHandler();
+
+      const result = await handler('import-id', 'My Copy', 'my description');
+
+      expect(mockCopy).toHaveBeenCalledWith(
+        expect.anything(),
+        'import-id',
+        'My Copy',
+        'my description',
+      );
+      expect(JSON.parse(result)).toStrictEqual(copy);
+    });
+
+    it('logs the error, sends an error notification, and rethrows when the copy fails', async () => {
+      mockCopy.mockRejectedValue(new Error('not a Paratext 9 import'));
+      const handler = await getCreateEditableCopyHandler();
+
+      await expect(handler('plain-id', 'My Copy')).rejects.toThrow('not a Paratext 9 import');
+      expect(__mockLogger.error).toHaveBeenCalledWith(
+        'Interlinearizer: failed to create an editable copy',
+        expect.any(Error),
+      );
+      expect(__mockNotificationsSend).toHaveBeenCalledWith({
+        message: '%interlinearizer_error_createEditableCopy_failed%',
+        severity: 'error',
+      });
+    });
+  });
 });