Read live PT book via USJ and open interlinearizer from project menu

Author: alex-rawlings-yyc

.vscode/settings.json

@@ -17,9 +17,8 @@
   },
   "files.eol": "\n",
 
-  "javascript.validate.enable": false,
-  "javascript.format.enable": false,
-  "typescript.format.enable": false,
+  "js/ts.validate.enabled": false,
+  "js/ts.format.enabled": false,
 
   "search.exclude": {
     ".git": true,

__mocks__/papi-backend.ts

@@ -4,7 +4,9 @@
  */
 
 const mockRegisterWebViewProvider = jest.fn().mockResolvedValue({ dispose: jest.fn() });
-const mockOpenWebView = jest.fn().mockResolvedValue(undefined);
+const mockRegisterCommand = jest.fn().mockResolvedValue({ dispose: jest.fn() });
+const mockOpenWebView = jest.fn().mockResolvedValue('mock-webview-id');
+const mockSelectProject = jest.fn().mockResolvedValue(undefined);
 const mockLogger = {
   debug: jest.fn(),
   error: jest.fn(),
@@ -13,6 +15,12 @@ const mockLogger = {
 };
 
 const papi = {
+  commands: {
+    registerCommand: mockRegisterCommand,
+  },
+  dialogs: {
+    selectProject: mockSelectProject,
+  },
   webViewProviders: {
     registerWebViewProvider: mockRegisterWebViewProvider,
   },
@@ -24,7 +32,9 @@ const papi = {
 const defaultExport = {
   ...papi,
   __mockRegisterWebViewProvider: mockRegisterWebViewProvider,
+  __mockRegisterCommand: mockRegisterCommand,
   __mockOpenWebView: mockOpenWebView,
+  __mockSelectProject: mockSelectProject,
   __mockLogger: mockLogger,
 };
 
@@ -33,9 +43,11 @@ module.exports = {
   default: defaultExport,
   logger: mockLogger,
   __mockRegisterWebViewProvider: mockRegisterWebViewProvider,
+  __mockRegisterCommand: mockRegisterCommand,
   __mockOpenWebView: mockOpenWebView,
+  __mockSelectProject: mockSelectProject,
   __mockLogger: mockLogger,
 };
 
 /** Marks this file as a module so top-level const/let are module-scoped; avoids TS "redeclare" when both papi-backend and papi-frontend mocks are in the project (they are used mutually exclusively by Jest). */
-export {};
+export {};

__mocks__/platform-bible-utils.ts

@@ -53,4 +53,13 @@ class UnsubscriberAsyncList {
   }
 }
 
-export { UnsubscriberAsyncList };
+/** Minimal PlatformError shape matching the real platform-bible-utils type. */
+interface PlatformError {
+  message: string;
+  isPlatformError: true;
+}
+
+const isPlatformError = (value: unknown): value is PlatformError =>
+  typeof value === 'object' && value !== null && (value as PlatformError).isPlatformError === true;
+
+export { UnsubscriberAsyncList, isPlatformError };

contributions/localizedStrings.json

@@ -1,6 +1,11 @@
 {
   "metadata": {},
   "localizedStrings": {
-    "en": {}
+    "en": {
+      "%interlinearizer_dialog_open_title%": "Open Interlinearizer",
+      "%interlinearizer_dialog_open_prompt%": "Choose a project to open in the Interlinearizer:",
+      "%mainMenu_interlinearizerSubmenu%": "Interlinearizer",
+      "%mainMenu_openInterlinearizer%": "Open Interlinearizer"
+    }
   }
 }

contributions/menus.json

@@ -1,8 +1,29 @@
 {
   "mainMenu": {
     "columns": {},
-    "groups": {},
-    "items": []
+    "groups": {
+      "interlinearizer.interlinearizerProjects": {
+        "order": 1.5,
+        "isExtensible": true,
+        "menuItem": "interlinearizer.projectSubmenu"
+      }
+    },
+    "items": [
+      {
+        "id": "interlinearizer.projectSubmenu",
+        "label": "%mainMenu_interlinearizerSubmenu%",
+        "localizeNotes": "Application main menu > Project > Interlinearizer",
+        "group": "platform.projectProjects",
+        "order": 1000.1
+      },
+      {
+        "label": "%mainMenu_openInterlinearizer%",
+        "localizeNotes": "Application main menu > Project > Interlinearizer > Open Interlinearizer",
+        "group": "interlinearizer.interlinearizerProjects",
+        "order": 1,
+        "command": "interlinearizer.open"
+      }
+    ]
   },
   "defaultWebViewTopMenu": {
     "columns": {},

jest.config.ts

@@ -10,8 +10,12 @@
 import type { Config } from 'jest';
 
 const config: Config = {
-  /** Automatically clear mock calls, instances, contexts and results before every test. */
-  clearMocks: true,
+  /**
+   * Reset mock implementations before every test (superset of clearMocks: also removes
+   * mockReturnValue/mockImplementation so implementations never leak between tests). Each test must
+   * set up the implementations it needs, typically in beforeEach.
+   */
+  resetMocks: true,
 
   /**
    * Coverage only when run with --coverage (see npm run test:coverage). Omit for faster default

package-lock.json

@@ -5,17 +5,7 @@
 import type { WebViewProps } from '@papi/core';
 import type { SerializedVerseRef } from '@sillsdev/scripture';
 import { render, screen } from '@testing-library/react';
-import { InterlinearXmlParser } from 'parsers/interlinearXmlParser';
-
-/** Mock parser to allow overriding constructor behavior per test. */
-jest.mock('parsers/interlinearXmlParser', () => {
-  const actual = jest.requireActual<typeof import('parsers/interlinearXmlParser')>(
-    'parsers/interlinearXmlParser',
-  );
-  return {
-    InterlinearXmlParser: jest.fn().mockImplementation(() => new actual.InterlinearXmlParser()),
-  };
-});
+import { useProjectData } from '@papi/frontend/react';
 
 /**
  * Load the WebView module; it assigns the component to globalThis.webViewComponent. This pattern is
@@ -32,94 +22,86 @@ if (!InterlinearizerWebView) throw new Error('webViewComponent not loaded');
 /** Minimal SerializedVerseRef for hook mock return. */
 const defaultScrRef: SerializedVerseRef = { book: 'GEN', chapterNum: 1, verseNum: 1 };
 
-/** Full WebViewProps for tests; interlinearizer component ignores hooks/update. */
-const testWebViewProps: WebViewProps = {
-  id: 'test-id',
-  webViewType: 'interlinearizer.mainWebView',
-  useWebViewState: <T,>(_key: string, defaultValue: T): [T, (v: T) => void, () => void] => [
-    defaultValue,
-    () => {},
-    () => {},
-  ],
-  useWebViewScrollGroupScrRef: (): [
-    SerializedVerseRef,
-    (r: SerializedVerseRef) => void,
-    number | undefined,
-    (id: number | undefined) => void,
-  ] => [defaultScrRef, () => {}, undefined, () => {}],
-  updateWebViewDefinition: () => true,
-};
+/** Builds a minimal WebViewProps for tests. */
+function makeProps(projectId?: string): WebViewProps {
+  return {
+    id: 'test-id',
+    webViewType: 'interlinearizer.mainWebView',
+    projectId,
+    useWebViewState: <T,>(_key: string, defaultValue: T): [T, (v: T) => void, () => void] => [
+      defaultValue,
+      () => {},
+      () => {},
+    ],
+    useWebViewScrollGroupScrRef: (): [
+      SerializedVerseRef,
+      (r: SerializedVerseRef) => void,
+      number | undefined,
+      (id: number | undefined) => void,
+    ] => [defaultScrRef, () => {}, undefined, () => {}],
+    updateWebViewDefinition: () => true,
+  };
+}
+
+/** Configures useProjectData to return the given BookUSJ value this render. */
+function mockBookData(value: unknown): void {
+  jest.mocked(useProjectData).mockImplementation(() => ({
+    BookUSJ: () => [value, jest.fn(), false],
+  }));
+}
 
 describe('InterlinearizerWebView', () => {
+  beforeEach(() => {
+    mockBookData(undefined);
+  });
+
   it('renders the heading "Interlinearizer"', () => {
-    render(<InterlinearizerWebView {...testWebViewProps} />);
+    render(<InterlinearizerWebView {...makeProps()} />);
 
     expect(screen.getByRole('heading', { name: /interlinearizer/i })).toBeInTheDocument();
   });
 
-  it('renders the description mentioning test-data XML', () => {
-    render(<InterlinearizerWebView {...testWebViewProps} />);
+  it('shows a prompt to open from a project when no projectId is provided', () => {
+    render(<InterlinearizerWebView {...makeProps()} />);
 
-    expect(
-      screen.getByText(/raw json of the model parsed from/i, { exact: false }),
-    ).toBeInTheDocument();
-    expect(screen.getByText(/test-data\/Interlinear_en_MAT\.xml/i)).toBeInTheDocument();
+    expect(screen.getByText(/open this webview from a paratext project/i)).toBeInTheDocument();
   });
 
-  it('parses the bundled test XML and displays parsed JSON', () => {
-    render(<InterlinearizerWebView {...testWebViewProps} />);
+  it('shows the book and projectId when a project is linked', () => {
+    mockBookData({
+      type: 'USJ',
+      version: '3.1',
+      content: [{ type: 'book', marker: 'id', code: 'GEN' }],
+    });
+    render(<InterlinearizerWebView {...makeProps('test-project-id')} />);
 
-    expect(screen.getByText(/parsed interlinear data \(json\)/i)).toBeInTheDocument();
-    expect(screen.getByText(/"GlossLanguage"/)).toBeInTheDocument();
-    expect(screen.getByText(/"BookId"/)).toBeInTheDocument();
+    expect(screen.getByText(/test-project-id/)).toBeInTheDocument();
+    expect(screen.getByText(/GEN · project/)).toBeInTheDocument();
   });
 
-  it('displays parsed structure with expected verse data', () => {
-    render(<InterlinearizerWebView {...testWebViewProps} />);
+  it('shows Loading when projectId is set but book data has not arrived', () => {
+    mockBookData(undefined);
+    render(<InterlinearizerWebView {...makeProps('test-project-id')} />);
 
-    expect(screen.getByText(/"en"/)).toBeInTheDocument();
-    expect(screen.getByText(/"MAT"/)).toBeInTheDocument();
+    expect(screen.getByText('Loading…')).toBeInTheDocument();
   });
 
-  it('does not show parse error when XML is valid', () => {
-    render(<InterlinearizerWebView {...testWebViewProps} />);
+  it('shows the raw USFM when book data arrives', () => {
+    mockBookData({
+      type: 'USJ',
+      version: '3.1',
+      content: [{ type: 'book', marker: 'id', code: 'GEN' }],
+    });
+    render(<InterlinearizerWebView {...makeProps('test-project-id')} />);
 
-    expect(screen.queryByText(/^parse error$/i)).not.toBeInTheDocument();
+    expect(screen.getByText(/"code": "GEN"/)).toBeInTheDocument();
   });
 
-  it('displays parse error when parser throws an Error (uses err.message)', () => {
-    const actual = jest.requireActual<typeof import('../parsers/interlinearXmlParser')>(
-      '../parsers/interlinearXmlParser',
-    );
-    const realInstance = new actual.InterlinearXmlParser();
-    const throwingParse = (): never => {
-      throw new Error('Invalid XML structure');
-    };
-    Object.defineProperty(realInstance, 'parse', { value: throwingParse, writable: true });
-    jest.mocked(InterlinearXmlParser).mockImplementationOnce(() => realInstance);
-
-    render(<InterlinearizerWebView {...testWebViewProps} />);
-
-    expect(screen.getByRole('heading', { name: /^parse error$/i })).toBeInTheDocument();
-    expect(screen.getByText(/invalid xml structure/i)).toBeInTheDocument();
-  });
+  it('shows an error heading and message when book data is a PlatformError', () => {
+    mockBookData({ isPlatformError: true, message: 'Project not found' });
+    render(<InterlinearizerWebView {...makeProps('test-project-id')} />);
 
-  it('displays parse error when parser throws non-Error (uses String(err))', () => {
-    const actual = jest.requireActual<typeof import('../parsers/interlinearXmlParser')>(
-      '../parsers/interlinearXmlParser',
-    );
-    const realInstance = new actual.InterlinearXmlParser();
-    const throwingParse = (): never => {
-      // Intentionally throw a non-Error to test the String(err) branch in the catch block.
-      // eslint-disable-next-line no-throw-literal -- testing non-Error handling
-      throw 'plain string error';
-    };
-    Object.defineProperty(realInstance, 'parse', { value: throwingParse, writable: true });
-    jest.mocked(InterlinearXmlParser).mockImplementationOnce(() => realInstance);
-
-    render(<InterlinearizerWebView {...testWebViewProps} />);
-
-    expect(screen.getByRole('heading', { name: /^parse error$/i })).toBeInTheDocument();
-    expect(screen.getByText('plain string error')).toBeInTheDocument();
+    expect(screen.getByRole('heading', { name: /error loading book/i })).toBeInTheDocument();
+    expect(screen.getByText(/project not found/i)).toBeInTheDocument();
   });
 });