Get analysis language from platform, improve docs

Author: alex-rawlings-yyc

src/__tests__/components/AnalysisStore.test.tsx

@@ -20,7 +20,7 @@ import {
  * Builds a minimal `TextAnalysis` with a single approved `TokenAnalysis` for the given token.
  *
  * @param tokenRef - Token reference string.
- * @param gloss - Gloss value for the `'en'` language key.
+ * @param gloss - Gloss value for the `'und'` language key.
  * @param surfaceText - Surface text of the token.
  * @returns A `TextAnalysis` seeded with one approved token analysis.
  */
@@ -32,7 +32,7 @@ function makeAnalysisWithGloss(
   const ta: TokenAnalysis = {
     id: `${tokenRef}-analysis`,
     surfaceText,
-    gloss: { en: gloss },
+    gloss: { und: gloss },
   };
   const link: TokenAnalysisLink = {
     analysisId: ta.id,
@@ -109,7 +109,7 @@ function GlossWriter({
 describe('useGloss', () => {
   it('returns an empty string for an unknown token', () => {
     render(
-      <AnalysisStoreProvider>
+      <AnalysisStoreProvider analysisLanguage="und">
         <GlossReader tokenRef="tok-1" />
       </AnalysisStoreProvider>,
     );
@@ -118,7 +118,10 @@ describe('useGloss', () => {
 
   it('returns the approved gloss from initialAnalysis', () => {
     render(
-      <AnalysisStoreProvider initialAnalysis={makeAnalysisWithGloss('tok-1', 'hello')}>
+      <AnalysisStoreProvider
+        initialAnalysis={makeAnalysisWithGloss('tok-1', 'hello')}
+        analysisLanguage="und"
+      >
         <GlossReader tokenRef="tok-1" />
       </AnalysisStoreProvider>,
     );
@@ -141,7 +144,7 @@ describe('useGloss', () => {
       phraseAnalysisLinks: [],
     };
     render(
-      <AnalysisStoreProvider initialAnalysis={analysis}>
+      <AnalysisStoreProvider initialAnalysis={analysis} analysisLanguage="und">
         <GlossReader tokenRef="tok-1" />
       </AnalysisStoreProvider>,
     );
@@ -150,7 +153,7 @@ describe('useGloss', () => {
 
   it('updates when the subscribed token is glossed via dispatch', async () => {
     render(
-      <AnalysisStoreProvider>
+      <AnalysisStoreProvider analysisLanguage="und">
         <GlossReader tokenRef="tok-1" />
         <GlossWriter tokenRef="tok-1" surfaceText="word" value="world" />
       </AnalysisStoreProvider>,
@@ -170,7 +173,7 @@ describe('useGloss', () => {
     }
 
     render(
-      <AnalysisStoreProvider>
+      <AnalysisStoreProvider analysisLanguage="und">
         <CountingGlossReader tokenRef="tok-1" />
         <GlossWriter tokenRef="tok-2" surfaceText="other" value="other" />
       </AnalysisStoreProvider>,
@@ -214,7 +217,7 @@ describe('useGloss', () => {
 describe('useAnalysis', () => {
   it('returns an empty analysis when no initialAnalysis is provided', () => {
     render(
-      <AnalysisStoreProvider>
+      <AnalysisStoreProvider analysisLanguage="und">
         <AnalysisReader />
       </AnalysisStoreProvider>,
     );
@@ -226,7 +229,7 @@ describe('useAnalysis', () => {
   it('returns seeded analyses from initialAnalysis', () => {
     const seed = makeAnalysisWithGloss('tok-1', 'hi');
     render(
-      <AnalysisStoreProvider initialAnalysis={seed}>
+      <AnalysisStoreProvider initialAnalysis={seed} analysisLanguage="und">
         <AnalysisReader />
       </AnalysisStoreProvider>,
     );
@@ -237,15 +240,15 @@ describe('useAnalysis', () => {
 
   it('updates after a gloss write', async () => {
     render(
-      <AnalysisStoreProvider>
+      <AnalysisStoreProvider analysisLanguage="und">
         <AnalysisReader />
         <GlossWriter tokenRef="tok-1" surfaceText="word" value="world" />
       </AnalysisStoreProvider>,
     );
     await userEvent.click(screen.getByRole('button', { name: 'write' }));
     const analysis: TextAnalysis = JSON.parse(screen.getByTestId('analysis').textContent ?? '');
     expect(analysis.tokenAnalyses).toHaveLength(1);
-    expect(analysis.tokenAnalyses[0].gloss).toStrictEqual({ en: 'world' });
+    expect(analysis.tokenAnalyses[0].gloss).toStrictEqual({ und: 'world' });
     expect(analysis.tokenAnalysisLinks[0].status).toBe('approved');
   });
 
@@ -260,7 +263,7 @@ describe('useAnalysis', () => {
 describe('useGlossDispatch', () => {
   it('creates a new approved TokenAnalysis on each write', async () => {
     render(
-      <AnalysisStoreProvider>
+      <AnalysisStoreProvider analysisLanguage="und">
         <AnalysisReader />
         <GlossWriter tokenRef="tok-1" surfaceText="word" value="hi" />
       </AnalysisStoreProvider>,
@@ -293,7 +296,7 @@ describe('useGlossDispatch', () => {
       phraseAnalysisLinks: [],
     };
     render(
-      <AnalysisStoreProvider initialAnalysis={seed}>
+      <AnalysisStoreProvider initialAnalysis={seed} analysisLanguage="und">
         <AnalysisReader />
         <GlossWriter tokenRef="tok-1" surfaceText="word" value="new" />
       </AnalysisStoreProvider>,
@@ -310,7 +313,7 @@ describe('useGlossDispatch', () => {
   it('calls the onGlossChange spy with tokenRef and value', async () => {
     const spy = jest.fn();
     render(
-      <AnalysisStoreProvider onGlossChange={spy}>
+      <AnalysisStoreProvider analysisLanguage="und" onGlossChange={spy}>
         <GlossWriter tokenRef="tok-1" surfaceText="word" value="hi" />
       </AnalysisStoreProvider>,
     );
@@ -322,14 +325,14 @@ describe('useGlossDispatch', () => {
   it('calls onSave with the updated TextAnalysis', async () => {
     const onSave = jest.fn();
     render(
-      <AnalysisStoreProvider onSave={onSave}>
+      <AnalysisStoreProvider analysisLanguage="und" onSave={onSave}>
         <GlossWriter tokenRef="tok-1" surfaceText="word" value="hi" />
       </AnalysisStoreProvider>,
     );
     await userEvent.click(screen.getByRole('button', { name: 'write' }));
     expect(onSave).toHaveBeenCalledTimes(1);
     const saved: TextAnalysis = onSave.mock.calls[0][0];
-    expect(saved.tokenAnalyses[0].gloss).toStrictEqual({ en: 'hi' });
+    expect(saved.tokenAnalyses[0].gloss).toStrictEqual({ und: 'hi' });
   });
 
   it('throws when called outside an AnalysisStoreProvider', () => {

src/__tests__/components/ContinuousView.test.tsx

@@ -15,15 +15,19 @@ import { AnalysisStoreProvider } from '../../components/AnalysisStore';
 
 jest.mock('../../components/AnalysisStore', () => ({
   __esModule: true,
-  AnalysisStoreProvider({ children }: Readonly<{ children: ReactNode }>) {
+  AnalysisStoreProvider({ children }: Readonly<{ children: ReactNode; analysisLanguage: string }>) {
     return children;
   },
   useGloss: () => '',
   useGlossDispatch: () => () => {},
 }));
 
 /** Render options that wrap every test render in a `AnalysisStoreProvider`. */
-const withAnalysisStore = { wrapper: AnalysisStoreProvider };
+const withAnalysisStore = {
+  wrapper({ children }: Readonly<{ children: ReactNode }>) {
+    return <AnalysisStoreProvider analysisLanguage="und">{children}</AnalysisStoreProvider>;
+  },
+};
 
 jest.mock('../../components/TokenChip', () => ({
   __esModule: true,

src/__tests__/components/Interlinearizer.test.tsx

@@ -171,6 +171,7 @@ function renderInterlinearizer({
       continuousScroll={continuousScroll}
       scrRef={scrRef}
       setScrRef={setScrRef}
+      analysisLanguage="und"
     />,
   );
 }
@@ -304,6 +305,7 @@ describe('Interlinearizer', () => {
         continuousScroll
         scrRef={defaultScrRef}
         setScrRef={() => {}}
+        analysisLanguage="und"
       />,
     );
 
@@ -349,6 +351,7 @@ describe('Interlinearizer', () => {
         continuousScroll
         scrRef={defaultScrRef}
         setScrRef={() => {}}
+        analysisLanguage="und"
       />,
     );
 
@@ -380,6 +383,7 @@ describe('Interlinearizer', () => {
         continuousScroll={false}
         scrRef={defaultScrRef}
         setScrRef={() => {}}
+        analysisLanguage="und"
       />,
     );
 
@@ -406,6 +410,7 @@ describe('Interlinearizer', () => {
         continuousScroll={false}
         scrRef={{ book: 'GEN', chapterNum: 1, verseNum: 1 }}
         setScrRef={() => {}}
+        analysisLanguage="und"
       />,
     );
 
@@ -438,6 +443,7 @@ describe('Interlinearizer', () => {
         continuousScroll
         scrRef={defaultScrRef}
         setScrRef={() => {}}
+        analysisLanguage="und"
       />,
     );
 
@@ -450,6 +456,7 @@ describe('Interlinearizer', () => {
         continuousScroll={false}
         scrRef={defaultScrRef}
         setScrRef={() => {}}
+        analysisLanguage="und"
       />,
     );
 
@@ -504,6 +511,7 @@ describe('Interlinearizer', () => {
         continuousScroll={false}
         scrRef={{ book: 'GEN', chapterNum: 1, verseNum: 99 }}
         setScrRef={() => {}}
+        analysisLanguage="und"
       />,
     );
 

src/__tests__/components/InterlinearizerLoader.test.tsx

@@ -49,6 +49,7 @@ jest.mock('../../components/ContinuousView', () => ({
 
 type CapturedInterlinearizerProps = {
   continuousScroll: boolean;
+  analysisLanguage: string | undefined;
 };
 let capturedInterlinearizerProps: CapturedInterlinearizerProps | undefined;
 
@@ -271,6 +272,25 @@ function mockOptimisticSetting(
   return onChange;
 }
 
+/**
+ * Configures `useSetting` to return per-key values for the two settings consumed by
+ * `InterlinearizerLoader`: `platform.interfaceMode` and `platform.interfaceLanguage`.
+ *
+ * @param interfaceMode - Value for `platform.interfaceMode`; defaults to `'simple'`.
+ * @param interfaceLanguage - Value for `platform.interfaceLanguage`; defaults to `[]`.
+ */
+function mockSettings(
+  interfaceMode: 'simple' | 'power' = 'simple',
+  interfaceLanguage: string[] = [],
+): void {
+  jest.mocked(useSetting).mockImplementation((key: string) => {
+    if (key === 'platform.interfaceMode') return [interfaceMode, jest.fn(), jest.fn(), false];
+    if (key === 'platform.interfaceLanguage')
+      return [interfaceLanguage, jest.fn(), jest.fn(), false];
+    throw new Error(`useSetting mock: unexpected key "${key}"`);
+  });
+}
+
 describe('InterlinearizerLoader', () => {
   beforeEach(() => {
     capturedInterlinearizerProps = undefined;
@@ -282,11 +302,11 @@ describe('InterlinearizerLoader', () => {
         new Proxy({}, { get: () => jest.fn().mockReturnValue([undefined, jest.fn(), false]) }),
       );
     jest.mocked(useLocalizedStrings).mockReturnValue([{}, false]);
-    jest.mocked(useSetting).mockReturnValue(['simple', jest.fn(), jest.fn(), false]);
+    mockSettings();
   });
 
   it('shows nav controls when interface mode is power', () => {
-    jest.mocked(useSetting).mockReturnValue(['power', jest.fn(), jest.fn(), false]);
+    mockSettings('power');
     render(
       <InterlinearizerLoader
         projectId={testProjectId}
@@ -429,6 +449,31 @@ describe('InterlinearizerLoader', () => {
     expect(screen.getByTestId('interlinearizer')).toBeInTheDocument();
   });
 
+  it('passes the first interfaceLanguage tag to Interlinearizer as analysisLanguage', () => {
+    mockSettings('simple', ['fr', 'en']);
+    render(
+      <InterlinearizerLoader
+        projectId={testProjectId}
+        useWebViewScrollGroupScrRef={makeScrollGroupHook()}
+        useWebViewState={makeWebViewState()}
+      />,
+    );
+
+    expect(capturedInterlinearizerProps?.analysisLanguage).toBe('fr');
+  });
+
+  it('passes "und" to Interlinearizer as analysisLanguage when interfaceLanguage is empty', () => {
+    render(
+      <InterlinearizerLoader
+        projectId={testProjectId}
+        useWebViewScrollGroupScrRef={makeScrollGroupHook()}
+        useWebViewState={makeWebViewState()}
+      />,
+    );
+
+    expect(capturedInterlinearizerProps?.analysisLanguage).toBe('und');
+  });
+
   describe('modal interactions', () => {
     it('opens the select modal when the project menu selectProject item is clicked', async () => {
       render(