-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathInterlinearizerLoader.test.tsx
More file actions
1475 lines (1293 loc) · 54.2 KB
/
Copy pathInterlinearizerLoader.test.tsx
File metadata and controls
1475 lines (1293 loc) · 54.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/** @file Unit tests for components/InterlinearizerLoader.tsx. */
/// <reference types="jest" />
/// <reference types="@testing-library/jest-dom" />
import papi, { logger } from '@papi/frontend';
import { useData, useLocalizedStrings, useSetting } from '@papi/frontend/react';
import type { SerializedVerseRef } from '@sillsdev/scripture';
import { act, render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import type { Book, DraftProject, PhraseAnalysisLink, TextAnalysis } from 'interlinearizer';
import type { Dispatch, SetStateAction } from 'react';
import InterlinearizerLoader from '../../components/InterlinearizerLoader';
import { RECENTER_FADE_MS } from '../../components/recenter-fade';
import useInterlinearizerBookData from '../../hooks/useInterlinearizerBookData';
import useOptimisticBooleanSetting from '../../hooks/useOptimisticBooleanSetting';
import { emptyAnalysis, emptyDraft } from '../../types/empty-factories';
import type { PhraseMode } from '../../types/phrase-mode';
import type { ViewOptions } from '../../types/view-options';
import { GEN_1_1_BOOK, makeScrollGroupHook, makeWebViewState } from '../test-helpers';
jest.mock('../../hooks/useInterlinearizerBookData');
jest.mock('../../hooks/useOptimisticBooleanSetting');
jest.mock('../../components/controls/ViewOptionsDropdown', () => ({
__esModule: true,
default: ({
continuousScroll,
onContinuousScrollChange,
hideInactiveLinkButtons,
onHideInactiveLinkButtonsChange,
simplifyPhrases,
onSimplifyPhrasesChange,
chapterLabelInVerse,
onChapterLabelInVerseChange,
showMorphology,
onShowMorphologyChange,
showFreeTranslation,
onShowFreeTranslationChange,
}: {
continuousScroll: boolean;
onContinuousScrollChange: (v: boolean) => void;
hideInactiveLinkButtons: boolean;
onHideInactiveLinkButtonsChange: (v: boolean) => void;
simplifyPhrases: boolean;
onSimplifyPhrasesChange: (v: boolean) => void;
chapterLabelInVerse: boolean;
onChapterLabelInVerseChange: (v: boolean) => void;
showMorphology: boolean;
onShowMorphologyChange: (v: boolean) => void;
showFreeTranslation: boolean;
onShowFreeTranslationChange: (v: boolean) => void;
}) => (
<div data-testid="view-options-dropdown">
<button
aria-label="continuous scroll"
data-testid="continuous-scroll-toggle"
data-checked={String(continuousScroll)}
onClick={() => onContinuousScrollChange(!continuousScroll)}
type="button"
/>
<button
aria-label="hide inactive link buttons"
data-testid="hide-inactive-link-buttons-toggle"
data-checked={String(hideInactiveLinkButtons)}
onClick={() => onHideInactiveLinkButtonsChange(!hideInactiveLinkButtons)}
type="button"
/>
<button
aria-label="dim inactive segments"
data-testid="dim-inactive-segments-toggle"
data-checked={String(simplifyPhrases)}
onClick={() => onSimplifyPhrasesChange(!simplifyPhrases)}
type="button"
/>
<button
aria-label="chapter label in verse"
data-testid="chapter-label-in-verse-toggle"
data-checked={String(chapterLabelInVerse)}
onClick={() => onChapterLabelInVerseChange(!chapterLabelInVerse)}
type="button"
/>
<button
aria-label="show morphology"
data-testid="show-morphology-toggle"
data-checked={String(showMorphology)}
onClick={() => onShowMorphologyChange(!showMorphology)}
type="button"
/>
<button
aria-label="show free translation"
data-testid="show-free-translation-toggle"
data-checked={String(showFreeTranslation)}
onClick={() => onShowFreeTranslationChange(!showFreeTranslation)}
type="button"
/>
</div>
),
}));
jest.mock('../../components/controls/ScriptureNavControls', () => ({
__esModule: true,
default: () => <div data-testid="scripture-nav-controls" />,
}));
jest.mock('../../components/modals/WipeModal', () => ({
__esModule: true,
/**
* Minimal WipeModal stand-in exposing per-scope confirm buttons and cancel so tests can drive the
* loader's wipe handlers without the real dialog's localization or scope-picker UI.
*
* @param hasActiveBook - Whether a book is loaded; surfaced so tests can assert the loader passes
* it through.
* @param onConfirm - Invoked with the chosen scope (`'book'` or `'all'`) when the user confirms.
* @param onCancel - Invoked when the user backs out.
* @returns A panel with a confirm button per scope plus cancel.
*/
WipeModal: ({
hasActiveBook,
onConfirm,
onCancel,
}: {
hasActiveBook: boolean;
onConfirm: (scope: 'book' | 'all') => void;
onCancel: () => void;
}) => (
<div data-testid="wipe-modal-panel" data-has-active-book={String(hasActiveBook)}>
<button type="button" data-testid="wipe-confirm-book" onClick={() => onConfirm('book')}>
Wipe book
</button>
<button type="button" data-testid="wipe-confirm-all" onClick={() => onConfirm('all')}>
Wipe draft
</button>
<button type="button" data-testid="wipe-modal-cancel" onClick={onCancel}>
Cancel
</button>
</div>
),
}));
jest.mock('../../components/ContinuousView', () => ({
__esModule: true,
default: () => <div data-testid="continuous-view" />,
}));
type CapturedInterlinearizerProps = {
book: Book;
continuousScroll: boolean;
scrRef: SerializedVerseRef;
setScrRef: (newScrRef: SerializedVerseRef) => void;
analysisLanguage: string;
initialAnalysis?: TextAnalysis;
onSaveAnalysis?: (analysis: TextAnalysis) => void;
onPendingEditsChange?: (pending: boolean) => void;
phraseMode: PhraseMode;
setPhraseMode: Dispatch<SetStateAction<PhraseMode>>;
viewOptions: ViewOptions;
};
let capturedInterlinearizerProps: CapturedInterlinearizerProps | undefined;
let interlinearizerMountCount = 0;
jest.mock('../../components/Interlinearizer', () => {
// eslint-disable-next-line @typescript-eslint/no-require-imports, global-require
const { useEffect } = require('react');
return {
__esModule: true,
default: (props: CapturedInterlinearizerProps) => {
capturedInterlinearizerProps = props;
// Count mounts so tests can distinguish a remount (book change) from an in-place update.
// eslint-disable-next-line react-hooks/rules-of-hooks -- stub render fn acts as a component
useEffect(() => {
interlinearizerMountCount += 1;
}, []);
return <div data-testid="interlinearizer" />;
},
};
});
/** Minimal project summary used across modal interaction tests. */
type MockProject = {
id: string;
createdAt: string;
sourceProjectId: string;
analysisLanguages: string[];
name?: string;
description?: string;
};
const mockSendCommand = jest.mocked(papi.commands.sendCommand);
const testProjectId = 'test-project-id';
const STUB_ACTIVE_PROJECT: MockProject = {
id: 'proj-1',
createdAt: '2026-01-01T00:00:00Z',
sourceProjectId: testProjectId,
analysisLanguages: ['en'],
name: 'My Project',
};
jest.mock('../../components/modals/ProjectModals', () => ({
__esModule: true,
/**
* Minimal ProjectModals stand-in that drives modal state and active-project state through the
* same `useWebViewState` hook the real component uses, so tests can assert on state transitions
* without mounting the full modal tree. Accepts (and ignores) the draft-related props the loader
* now passes (`dirty`, `getDraftSnapshot`, `loadFromProject`, `markSynced`).
*
* @param modal - Current modal identifier controlling which stub panel is rendered.
* @param setModal - Callback to transition to a different modal state.
* @param activeProject - The currently active interlinear project, or undefined when none is
* selected.
* @param defaultAnalysisLanguage - BCP 47 tag forwarded as the create modal's default language.
* @param useWebViewState - Injected hook used to read and write persisted WebView state; must
* support the `'activeProject'` key.
* @returns A JSX element containing the stub modal panels keyed by `modal`.
*/
default: function StubProjectModals({
modal,
setModal,
activeProject,
defaultAnalysisLanguage,
useWebViewState,
}: {
modal: string;
setModal: (m: string) => void;
activeProject: MockProject | undefined;
defaultAnalysisLanguage?: string;
dirty: boolean;
getDraftSnapshot: () => DraftProject | undefined;
loadFromProject: (project: unknown) => void;
markSynced: () => void;
useWebViewState: (
key: string,
def: MockProject | undefined,
) => [MockProject | undefined, (v: MockProject | undefined) => void, () => void];
projectId: string;
}) {
const [, setActiveProject] = useWebViewState('activeProject', undefined);
return (
<div
data-testid="project-modals"
data-modal={modal}
data-default-lang={defaultAnalysisLanguage}
data-active-project-name={activeProject?.name}
>
{modal === 'select' && (
<div data-testid="select-modal">
<button
type="button"
data-testid="select-modal-select"
onClick={() => {
setActiveProject(STUB_ACTIVE_PROJECT);
setModal('none');
}}
>
Select
</button>
<button
type="button"
data-testid="select-modal-create-new"
onClick={() => setModal('create')}
>
Create new
</button>
<button type="button" data-testid="select-modal-close" onClick={() => setModal('none')}>
Close
</button>
<button
type="button"
data-testid="select-modal-view-info"
onClick={() => setModal('metadata')}
>
View info
</button>
</div>
)}
{modal === 'create' && (
<div data-testid="create-modal">
<button type="button" data-testid="create-modal-close" onClick={() => setModal('none')}>
Close
</button>
<button
type="button"
data-testid="create-modal-created"
onClick={() => {
setActiveProject(STUB_ACTIVE_PROJECT);
setModal('none');
}}
>
Created
</button>
</div>
)}
{modal === 'saveAs' && (
<div data-testid="save-as-modal">
<button
type="button"
data-testid="save-as-modal-close"
onClick={() => setModal('none')}
>
Close
</button>
</div>
)}
{modal === 'metadata' && activeProject && (
<div data-testid="metadata-modal">
<button
type="button"
data-testid="metadata-modal-close"
onClick={() => setModal('none')}
>
Close
</button>
<button
type="button"
data-testid="metadata-modal-saved"
onClick={() => {
setActiveProject({ ...STUB_ACTIVE_PROJECT, name: 'Renamed Project' });
setModal('none');
}}
>
Save
</button>
<button
type="button"
data-testid="metadata-modal-deleted"
onClick={() => {
setActiveProject(undefined);
setModal('none');
}}
>
Delete
</button>
</div>
)}
</div>
);
},
}));
/**
* Renders {@link InterlinearizerLoader} with the given props, supplying a fresh
* `updateWebViewDefinition` spy (which tests can read back) and sensible defaults for the scroll
* group and WebView-state hooks. Centralizing the render keeps every call site supplying the
* required `updateWebViewDefinition` prop.
*
* @param options - Optional overrides.
* @param options.useWebViewScrollGroupScrRef - Scroll-group hook; defaults to a GEN 1:1 stub.
* @param options.useWebViewState - WebView-state hook; defaults to a fresh empty store.
* @param options.projectId - Source project ID; defaults to {@link testProjectId}.
* @returns The Testing Library render result plus the `updateWebViewDefinition` spy.
*/
function renderLoader(
options: {
useWebViewScrollGroupScrRef?: ReturnType<typeof makeScrollGroupHook>;
useWebViewState?: ReturnType<typeof makeWebViewState>;
projectId?: string;
} = {},
) {
const updateWebViewDefinition = jest.fn(() => true);
const result = render(
<InterlinearizerLoader
projectId={options.projectId ?? testProjectId}
useWebViewScrollGroupScrRef={options.useWebViewScrollGroupScrRef ?? makeScrollGroupHook()}
useWebViewState={options.useWebViewState ?? makeWebViewState()}
updateWebViewDefinition={updateWebViewDefinition}
/>,
);
return { ...result, updateWebViewDefinition };
}
/**
* Configures useInterlinearizerBookData to return the given state.
*
* @param overrides - Partial hook result; all fields default to a successful loaded state
*/
function mockBookData(
overrides: Partial<{
book: Book | undefined;
isLoading: boolean;
bookError: string | undefined;
tokenizeError: { message: string; raw: unknown } | undefined;
}> = {},
): void {
jest.mocked(useInterlinearizerBookData).mockReturnValue({
book: GEN_1_1_BOOK,
isLoading: false,
bookError: undefined,
tokenizeError: undefined,
...overrides,
});
}
/**
* Configures useOptimisticBooleanSetting to return the given state. Each setting key gets its own
* distinct `onChange` mock so wiring tests can verify that a given toggle is connected to the
* correct handler — a single shared mock would let a toggle wired to the wrong setting still pass.
*
* @param value - The current boolean value applied to every setting; defaults to `false`
* @param onChange - The change handler for every setting; defaults to a distinct jest.fn() per key
* @param isLoading - Whether the settings are loading; defaults to `false`
* @returns A map from setting key to that key's `onChange` mock.
*/
function mockOptimisticSetting(
value = false,
onChange: jest.Mock | undefined = undefined,
isLoading = false,
): Map<string, jest.Mock> {
const onChangeByKey = new Map<string, jest.Mock>();
jest.mocked(useOptimisticBooleanSetting).mockImplementation((_projectId, key) => {
const handler = onChange ?? onChangeByKey.get(key) ?? jest.fn();
onChangeByKey.set(key, handler);
return { value, onChange: handler, isLoading };
});
return onChangeByKey;
}
/**
* 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 `[]`.
* @throws {Error} When `useSetting` is called with any key other than `platform.interfaceMode` or
* `platform.interfaceLanguage` (message: `useSetting mock: unexpected key "<key>"`).
*/
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;
interlinearizerMountCount = 0;
mockBookData();
mockOptimisticSetting();
// The loader's draft hook calls `interlinearizer.getDraft` on mount; default to a valid empty
// draft so the editor renders. Individual tests override with mockResolvedValueOnce.
mockSendCommand.mockResolvedValue(JSON.stringify(emptyDraft(testProjectId)));
jest
.mocked(useData)
.mockReturnValue(
new Proxy({}, { get: () => jest.fn().mockReturnValue([undefined, jest.fn(), false]) }),
);
jest.mocked(useLocalizedStrings).mockReturnValue([{}, false]);
mockSettings();
});
it('shows nav controls when interface mode is power', async () => {
mockSettings('power');
await act(async () => {
renderLoader();
});
expect(screen.getByTestId('scripture-nav-controls')).toBeInTheDocument();
expect(screen.getByTestId('interlinearizer')).toBeInTheDocument();
});
it('hides nav controls when interface mode is simple', async () => {
await act(async () => {
renderLoader();
});
expect(screen.queryByTestId('scripture-nav-controls')).not.toBeInTheDocument();
expect(screen.getByTestId('interlinearizer')).toBeInTheDocument();
});
it('resolves a verse-0 reference to verse 1 when the book has no verse-0 segment', async () => {
// GEN_1_1_BOOK has only a GEN 1:1 segment, so a whole-chapter (verse 0) selection falls back to
// the chapter's first numbered verse rather than leaving nothing highlighted.
await act(async () => {
renderLoader({
useWebViewScrollGroupScrRef: makeScrollGroupHook({
book: 'GEN',
chapterNum: 3,
verseNum: 0,
}),
});
});
expect(capturedInterlinearizerProps?.scrRef).toEqual({
book: 'GEN',
chapterNum: 3,
verseNum: 1,
});
});
it('keeps a verse-0 reference when the book has a verse-0 (superscription) segment', async () => {
const bookWithSuperscription: Book = {
id: 'PSA',
bookRef: 'PSA',
textVersion: 'v1',
segments: [
{
id: 'PSA 3:0',
startRef: { book: 'PSA', chapter: 3, verse: 0 },
endRef: { book: 'PSA', chapter: 3, verse: 0 },
baselineText: 'A Psalm by David.',
tokens: [],
},
],
};
mockBookData({ book: bookWithSuperscription });
await act(async () => {
renderLoader({
useWebViewScrollGroupScrRef: makeScrollGroupHook({
book: 'PSA',
chapterNum: 3,
verseNum: 0,
}),
});
});
expect(capturedInterlinearizerProps?.scrRef).toEqual({
book: 'PSA',
chapterNum: 3,
verseNum: 0,
});
});
it('leaves a verse-0 reference untouched while the book is still loading', async () => {
// With no book loaded yet, the verse-0 resolution has nothing to consult, so the loader shows
// the loading placeholder and does not render the interlinearizer.
mockBookData({ book: undefined, isLoading: true });
await act(async () => {
renderLoader({
useWebViewScrollGroupScrRef: makeScrollGroupHook({
book: 'GEN',
chapterNum: 3,
verseNum: 0,
}),
});
});
expect(screen.getByText('Loading…')).toBeInTheDocument();
expect(screen.queryByTestId('interlinearizer')).not.toBeInTheDocument();
});
it('passes a verse-level reference through to Interlinearizer unchanged', async () => {
await act(async () => {
renderLoader({
useWebViewScrollGroupScrRef: makeScrollGroupHook({
book: 'GEN',
chapterNum: 3,
verseNum: 4,
}),
});
});
expect(capturedInterlinearizerProps?.scrRef).toEqual({
book: 'GEN',
chapterNum: 3,
verseNum: 4,
});
});
it('shows Loading when book data has not arrived', async () => {
mockBookData({ book: undefined, isLoading: true });
await act(async () => {
renderLoader();
});
expect(screen.getByText('Loading…')).toBeInTheDocument();
});
it('shows an error heading and message when bookError is set', async () => {
mockBookData({ book: undefined, bookError: 'Project not found' });
await act(async () => {
renderLoader();
});
expect(screen.getByRole('heading', { name: /error loading book/i })).toBeInTheDocument();
expect(screen.getByText(/project not found/i)).toBeInTheDocument();
});
it('shows an error heading and message when tokenization throws an Error', async () => {
mockBookData({
book: undefined,
tokenizeError: { message: 'parse failure', raw: new Error('parse failure') },
});
await act(async () => {
renderLoader();
});
expect(screen.getByRole('heading', { name: /error processing book/i })).toBeInTheDocument();
expect(screen.getByText('parse failure')).toBeInTheDocument();
});
it('shows an error message when tokenization throws a non-Error value', async () => {
mockBookData({
book: undefined,
tokenizeError: { message: 'unexpected string error', raw: 'unexpected string error' },
});
await act(async () => {
renderLoader();
});
expect(screen.getByRole('heading', { name: /error processing book/i })).toBeInTheDocument();
expect(screen.getByText('unexpected string error')).toBeInTheDocument();
});
it('passes the checked value from useOptimisticBooleanSetting to ViewOptionsDropdown', async () => {
mockOptimisticSetting(true);
await act(async () => {
renderLoader();
});
const toggle = screen.getByTestId('continuous-scroll-toggle');
expect(toggle).toHaveAttribute('data-checked', 'true');
});
it('gates rendering until the persisted display settings have loaded', async () => {
mockOptimisticSetting(false, jest.fn(), true);
await act(async () => {
renderLoader();
});
// The saved settings must arrive before the view renders so the user's stored choices apply on
// the first paint instead of flashing the hard-coded defaults.
expect(screen.getByText('Loading…')).toBeInTheDocument();
expect(screen.queryByTestId('continuous-scroll-toggle')).not.toBeInTheDocument();
expect(screen.queryByTestId('interlinearizer')).not.toBeInTheDocument();
});
it('wires ViewOptionsDropdown continuous scroll to the onChange from useOptimisticBooleanSetting', async () => {
const onChangeByKey = mockOptimisticSetting();
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('continuous-scroll-toggle'));
expect(onChangeByKey.get('interlinearizer.continuousScroll')).toHaveBeenCalledWith(true);
});
it('passes all view-option booleans as false to Interlinearizer by default', async () => {
await act(async () => {
renderLoader();
});
expect(capturedInterlinearizerProps?.viewOptions.hideInactiveLinkButtons).toBe(false);
expect(capturedInterlinearizerProps?.viewOptions.simplifyPhrases).toBe(false);
expect(capturedInterlinearizerProps?.viewOptions.chapterLabelInVerse).toBe(false);
expect(capturedInterlinearizerProps?.viewOptions.showMorphology).toBe(false);
expect(capturedInterlinearizerProps?.viewOptions.showFreeTranslation).toBe(false);
});
it('wires ViewOptionsDropdown hide-inactive-link-buttons to onChange from useOptimisticBooleanSetting', async () => {
const onChangeByKey = mockOptimisticSetting();
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('hide-inactive-link-buttons-toggle'));
expect(onChangeByKey.get('interlinearizer.hideInactiveLinkButtons')).toHaveBeenCalledWith(true);
});
it('wires ViewOptionsDropdown dim-inactive-segments to onChange from useOptimisticBooleanSetting', async () => {
const onChangeByKey = mockOptimisticSetting();
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('dim-inactive-segments-toggle'));
expect(onChangeByKey.get('interlinearizer.simplifyPhrases')).toHaveBeenCalledWith(true);
});
it('wires ViewOptionsDropdown chapter-label-in-verse to onChange from useOptimisticBooleanSetting', async () => {
const onChangeByKey = mockOptimisticSetting();
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('chapter-label-in-verse-toggle'));
expect(onChangeByKey.get('interlinearizer.chapterLabelInVerse')).toHaveBeenCalledWith(true);
});
it('wires ViewOptionsDropdown show-morphology to onChange from useOptimisticBooleanSetting', async () => {
const onChangeByKey = mockOptimisticSetting();
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('show-morphology-toggle'));
expect(onChangeByKey.get('interlinearizer.showMorphology')).toHaveBeenCalledWith(true);
});
it('wires ViewOptionsDropdown show-free-translation to onChange from useOptimisticBooleanSetting', async () => {
const onChangeByKey = mockOptimisticSetting();
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('show-free-translation-toggle'));
expect(onChangeByKey.get('interlinearizer.showFreeTranslation')).toHaveBeenCalledWith(true);
});
it('passes continuousScroll=true to Interlinearizer when the setting is true', async () => {
mockOptimisticSetting(true);
await act(async () => {
renderLoader();
});
expect(capturedInterlinearizerProps?.continuousScroll).toBe(true);
});
it('passes continuousScroll=false to Interlinearizer when the setting is false', async () => {
await act(async () => {
renderLoader();
});
expect(capturedInterlinearizerProps?.continuousScroll).toBe(false);
expect(screen.getByTestId('interlinearizer')).toBeInTheDocument();
});
it('takes analysisLanguage from the draft analysisLanguages, not the active project', async () => {
// The draft owns the analysis language now; a draft configured for French must win even when
// the active project's summary lists a different language.
mockSendCommand.mockResolvedValueOnce(
JSON.stringify({ ...emptyDraft(testProjectId), analysisLanguages: ['fr'] }),
);
await act(async () =>
renderLoader({ useWebViewState: makeWebViewState({ activeProject: STUB_ACTIVE_PROJECT }) }),
);
expect(capturedInterlinearizerProps?.analysisLanguage).toBe('fr');
});
it('falls back to the first interfaceLanguage tag when the draft has no analysis language', async () => {
// A brand-new source seeds the draft's analysis language from the platform UI language.
mockSettings('simple', ['fr', 'en']);
await act(async () => {
renderLoader();
});
expect(capturedInterlinearizerProps?.analysisLanguage).toBe('fr');
});
it('passes the platform language to ProjectModals as defaultAnalysisLanguage', async () => {
mockSettings('simple', ['de']);
await act(async () => {
renderLoader();
});
expect(screen.getByTestId('project-modals')).toHaveAttribute('data-default-lang', 'de');
});
it('falls back to "und" as analysisLanguage when the draft has no language and interfaceLanguage is empty', async () => {
await act(async () => {
renderLoader();
});
expect(capturedInterlinearizerProps?.analysisLanguage).toBe('und');
});
describe('modal interactions', () => {
it('opens the select modal when the project menu selectProject item is clicked', async () => {
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('tab-toolbar-project-menu'));
expect(screen.getByTestId('select-modal')).toBeInTheDocument();
});
it('opens the create modal directly when the openNewProjectModal menu item is clicked', async () => {
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('tab-toolbar-new-project'));
expect(screen.getByTestId('create-modal')).toBeInTheDocument();
expect(screen.queryByTestId('select-modal')).not.toBeInTheDocument();
});
it('closes the create modal without showing another when close is clicked from menu source', async () => {
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('tab-toolbar-new-project'));
await userEvent.click(screen.getByTestId('create-modal-close'));
expect(screen.queryByTestId('create-modal')).not.toBeInTheDocument();
expect(screen.queryByTestId('select-modal')).not.toBeInTheDocument();
});
it('closes the select modal when its close button is clicked', async () => {
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('tab-toolbar-project-menu'));
await userEvent.click(screen.getByTestId('select-modal-close'));
expect(screen.queryByTestId('select-modal')).not.toBeInTheDocument();
});
it('opens the create modal from the select modal create-new button', async () => {
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('tab-toolbar-project-menu'));
await userEvent.click(screen.getByTestId('select-modal-create-new'));
expect(screen.getByTestId('create-modal')).toBeInTheDocument();
});
it('closes all modals after a project is created from the select modal', async () => {
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('tab-toolbar-project-menu'));
await userEvent.click(screen.getByTestId('select-modal-create-new'));
await userEvent.click(screen.getByTestId('create-modal-created'));
expect(screen.queryByTestId('create-modal')).not.toBeInTheDocument();
expect(screen.queryByTestId('select-modal')).not.toBeInTheDocument();
});
it('sets the active project and closes the select modal when a project is selected', async () => {
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('tab-toolbar-project-menu'));
await userEvent.click(screen.getByTestId('select-modal-select'));
expect(screen.queryByTestId('select-modal')).not.toBeInTheDocument();
// After selection the view-project-info button becomes available, confirming activeProject is set
await userEvent.click(screen.getByTestId('tab-toolbar-view-project-info'));
expect(screen.getByTestId('metadata-modal')).toBeInTheDocument();
});
it('opens the metadata modal from the openProjectInfoModal menu item when a project is active', async () => {
await act(async () => {
renderLoader();
});
// First create a project to set activeProject
await userEvent.click(screen.getByTestId('tab-toolbar-project-menu'));
await userEvent.click(screen.getByTestId('select-modal-select'));
await userEvent.click(screen.getByTestId('tab-toolbar-view-project-info'));
expect(screen.getByTestId('metadata-modal')).toBeInTheDocument();
});
it('does not open the metadata modal from openProjectInfoModal when no project is active', async () => {
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('tab-toolbar-view-project-info'));
expect(screen.queryByTestId('metadata-modal')).not.toBeInTheDocument();
});
it('dismisses to none when metadata is closed after being opened from the menu', async () => {
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('tab-toolbar-project-menu'));
await userEvent.click(screen.getByTestId('select-modal-select'));
await userEvent.click(screen.getByTestId('tab-toolbar-view-project-info'));
await userEvent.click(screen.getByTestId('metadata-modal-close'));
expect(screen.queryByTestId('metadata-modal')).not.toBeInTheDocument();
expect(screen.queryByTestId('select-modal')).not.toBeInTheDocument();
});
it('dismisses to none and clears active project when the active project is deleted from the menu', async () => {
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('tab-toolbar-project-menu'));
await userEvent.click(screen.getByTestId('select-modal-select'));
await userEvent.click(screen.getByTestId('tab-toolbar-view-project-info'));
await userEvent.click(screen.getByTestId('metadata-modal-deleted'));
expect(screen.queryByTestId('metadata-modal')).not.toBeInTheDocument();
// The deleted project was the active one, so the loader should now pass `activeProject:
// undefined` down to ProjectModals (the stub omits the attribute when there is no name).
expect(screen.getByTestId('project-modals')).not.toHaveAttribute('data-active-project-name');
});
it('updates the active project name when its metadata is saved', async () => {
await act(async () => {
renderLoader();
});
await userEvent.click(screen.getByTestId('tab-toolbar-project-menu'));
await userEvent.click(screen.getByTestId('select-modal-select'));
await userEvent.click(screen.getByTestId('tab-toolbar-view-project-info'));
await userEvent.click(screen.getByTestId('metadata-modal-saved'));
expect(screen.queryByTestId('metadata-modal')).not.toBeInTheDocument();
// Saving renamed the active project; the loader must reflect the new name it reads back from
// WebView state by passing it down to ProjectModals.
expect(screen.getByTestId('project-modals')).toHaveAttribute(
'data-active-project-name',
'Renamed Project',
);
});
it('renders without error when useData provides a topMenu with items', async () => {
const mockWebViewMenu = {
topMenu: {
label: 'top',
items: [
{
command: 'interlinearizer.openProjectInfoModal',
label: 'View',
group: 'g',
order: 1,
localizeNotes: '',
},
{
command: 'interlinearizer.openSelectProjectModal',
label: 'Select',
group: 'g',
order: 2,
localizeNotes: '',
},
],
},
includeDefaults: true,
contextMenu: undefined,
};
jest
.mocked(useData)
.mockReturnValue(
new Proxy(
{},
{ get: () => jest.fn().mockReturnValue([mockWebViewMenu, jest.fn(), false]) },
),
);
await act(async () => {
renderLoader();
});
expect(screen.getByTestId('tab-toolbar')).toBeInTheDocument();
});
});
describe('draft loading', () => {
it('loads the draft on mount and passes its analysis as initialAnalysis', async () => {
const draftAnalysis = emptyAnalysis();
draftAnalysis.tokenAnalyses.push({ id: 't1', surfaceText: 'In', gloss: { en: 'in' } });
mockSendCommand.mockResolvedValueOnce(
JSON.stringify({ ...emptyDraft(testProjectId), analysis: draftAnalysis }),
);
await act(async () => {
renderLoader();
});
expect(mockSendCommand).toHaveBeenCalledWith('interlinearizer.getDraft', testProjectId);
expect(capturedInterlinearizerProps?.initialAnalysis).toEqual(draftAnalysis);
});
it('falls back to an empty draft and logs an error when getDraft rejects', async () => {
const error = new Error('network error');
mockSendCommand.mockRejectedValueOnce(error);
await act(async () => {
renderLoader();
});
expect(jest.mocked(logger.error)).toHaveBeenCalledWith(
'Interlinearizer: failed to load draft',
error,
);
// The fallback empty draft still renders the editor with an empty analysis.
expect(capturedInterlinearizerProps?.initialAnalysis).toEqual(emptyAnalysis());
});
it('skips state updates when the component unmounts before getDraft resolves', async () => {
let resolveGetDraft: ((value: string) => void) | undefined;
mockSendCommand.mockReturnValueOnce(
new Promise<string>((resolve) => {
resolveGetDraft = resolve;
}),
);
const { unmount } = renderLoader();
unmount();