@olenbetong/synergi-react 4.3.1 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/styles/styles.css +1 -1
- package/dist/styles/styles.css.map +1 -1
- package/es/components/Checkbox/index.js +1 -9
- package/es/components/FilePond.js +3 -12
- package/es/components/ImageEditor/plugins/redactPlugin/useRedactTool.js +18 -14
- package/es/components/ImageEditor/useImageHistory.js +13 -1
- package/es/components/MergeProgressDialog/MergeProgressDialogDs.d.ts +7 -0
- package/es/components/MergeProgressDialog/MergeProgressDialogDs.js +20 -0
- package/es/components/MergeProgressDialog/index.d.ts +3 -8
- package/es/components/MergeProgressDialog/index.js +4 -133
- package/es/components/MergeProgressDialog/useMergeJob.d.ts +36 -0
- package/es/components/MergeProgressDialog/useMergeJob.js +142 -0
- package/es/components/Portal/index.js +20 -20
- package/es/components/ProgressBar/index.css +1 -1
- package/es/components/SplitContainer/index.js +3 -1
- package/es/components/Toolbar/index.js +6 -1
- package/es/elements/ElementLookupDialog/BarcodeScanner/BarcodeScanner.css +81 -0
- package/es/elements/ElementLookupDialog/BarcodeScanner/DeadIcon.d.ts +2 -2
- package/es/elements/ElementLookupDialog/BarcodeScanner/DeadIcon.js +1 -2
- package/es/elements/ElementLookupDialog/BarcodeScanner/Error.js +3 -29
- package/es/elements/ElementLookupDialog/BarcodeScanner/decoders/zxing.js +8 -0
- package/es/elements/ElementLookupDialog/BarcodeScanner/index.d.ts +1 -0
- package/es/elements/ElementLookupDialog/BarcodeScanner/index.js +3 -28
- package/es/elements/ElementLookupDialog/HIDScanner/useHIDScanner.js +3 -1
- package/es/elements-ds/DescriptionInput.d.ts +16 -0
- package/es/elements-ds/DescriptionInput.js +41 -0
- package/es/elements-ds/DuplicateElementDamage.d.ts +40 -0
- package/es/elements-ds/DuplicateElementDamage.js +57 -0
- package/es/elements-ds/ElementLookup.d.ts +23 -0
- package/es/elements-ds/ElementLookup.js +35 -0
- package/es/elements-ds/ElementLookupDialog.d.ts +7 -0
- package/es/elements-ds/ElementLookupDialog.js +84 -0
- package/es/elements-ds/FormFields.d.ts +43 -0
- package/es/elements-ds/FormFields.js +67 -0
- package/es/elements-ds/HIDScanner.d.ts +7 -0
- package/es/elements-ds/HIDScanner.js +36 -0
- package/es/elements-ds/ManualForm.d.ts +7 -0
- package/es/elements-ds/ManualForm.js +70 -0
- package/es/elements-ds/ProjectSelect.d.ts +28 -0
- package/es/elements-ds/ProjectSelect.js +45 -0
- package/es/elements-ds/elements-ds.css +157 -0
- package/es/elements-ds/index.d.ts +12 -0
- package/es/elements-ds/index.js +14 -0
- package/es/index.css +1 -1
- package/es/index.d.ts +2 -1
- package/es/index.js +2 -1
- package/es/mui/index.d.ts +1 -0
- package/es/mui/index.js +1 -0
- package/es/useTranslation/index.js +5 -3
- package/package.json +34 -15
- package/src/chrome/AppShell/AppShell.test.tsx +48 -0
- package/src/chrome/openReport.test.ts +50 -0
- package/src/colorScheme.test.ts +188 -0
- package/src/components/Checkbox/Checkbox.browser.test.tsx +116 -0
- package/src/components/Checkbox/index.tsx +1 -10
- package/src/components/ColorCard/ColorCard.test.tsx +34 -0
- package/src/components/DateNavigator/DateNavigator.test.tsx +175 -0
- package/src/components/FilePond.browser.test.tsx +389 -0
- package/src/components/FilePond.tsx +3 -12
- package/src/components/ImageEditor/ImageEditor.browser.test.tsx +286 -0
- package/src/components/ImageEditor/ImageEditor.test.tsx +299 -0
- package/src/components/ImageEditor/plugins/cropPlugin/useCropTool.test.ts +225 -0
- package/src/components/ImageEditor/plugins/plugins.browser.test.ts +252 -0
- package/src/components/ImageEditor/plugins/redactPlugin/useRedactTool.test.ts +89 -0
- package/src/components/ImageEditor/plugins/redactPlugin/useRedactTool.ts +16 -13
- package/src/components/ImageEditor/plugins/zoomPlugin/useZoomPan.test.ts +154 -0
- package/src/components/ImageEditor/useEdgeDetection.test.ts +96 -0
- package/src/components/ImageEditor/useImageHistory.test.ts +409 -0
- package/src/components/ImageEditor/useImageHistory.ts +10 -1
- package/src/components/ImageEditor/useOpenCV.test.ts +208 -0
- package/src/components/MergeProgressDialog/MergeProgressDialogDs.browser.test.tsx +156 -0
- package/src/components/MergeProgressDialog/MergeProgressDialogDs.tsx +92 -0
- package/src/components/MergeProgressDialog/index.tsx +5 -158
- package/src/components/MergeProgressDialog/useMergeJob.test.ts +326 -0
- package/src/components/MergeProgressDialog/useMergeJob.ts +170 -0
- package/src/components/PdfViewer/PdfViewer.browser.test.tsx +78 -0
- package/src/components/Portal/Portal.test.tsx +106 -0
- package/src/components/Portal/index.tsx +22 -25
- package/src/components/ProgressBar/index.scss +23 -54
- package/src/components/Sidebar/Sidebar.browser.test.tsx +57 -0
- package/src/components/Sidebar/Sidebar.test.tsx +123 -0
- package/src/components/SplitContainer/SplitContainer.browser.test.tsx +304 -0
- package/src/components/SplitContainer/index.tsx +3 -1
- package/src/components/Toolbar/Toolbar.test.tsx +216 -0
- package/src/components/Toolbar/ToolbarBreadcrumbs.browser.test.tsx +137 -0
- package/src/components/Toolbar/index.tsx +6 -1
- package/src/components/ValueToggleGroup/ValueToggleGroup.test.tsx +112 -0
- package/src/elements/ElementLookupDialog/BarcodeScanner/BarcodeScanner.browser.test.tsx +175 -0
- package/src/elements/ElementLookupDialog/BarcodeScanner/BarcodeScanner.css +81 -0
- package/src/elements/ElementLookupDialog/BarcodeScanner/DeadIcon.tsx +4 -4
- package/src/elements/ElementLookupDialog/BarcodeScanner/Error.tsx +7 -36
- package/src/elements/ElementLookupDialog/BarcodeScanner/decoders/zxing.ts +8 -0
- package/src/elements/ElementLookupDialog/BarcodeScanner/engines.browser.test.ts +225 -0
- package/src/elements/ElementLookupDialog/BarcodeScanner/index.tsx +20 -49
- package/src/elements/ElementLookupDialog/HIDScanner/useHIDScanner.test.ts +124 -0
- package/src/elements/ElementLookupDialog/HIDScanner/useHIDScanner.ts +2 -1
- package/src/elements/ElementLookupDialog/getElement.test.ts +133 -0
- package/src/elements/ElementLookupDialog/utils/Giai.test.ts +53 -0
- package/src/elements-ds/DamageForm.browser.test.tsx +530 -0
- package/src/elements-ds/DescriptionInput.tsx +114 -0
- package/src/elements-ds/DuplicateElementDamage.tsx +185 -0
- package/src/elements-ds/ElementLookup.tsx +114 -0
- package/src/elements-ds/ElementLookupDialog.browser.test.tsx +207 -0
- package/src/elements-ds/ElementLookupDialog.tsx +196 -0
- package/src/elements-ds/FormFields.tsx +176 -0
- package/src/elements-ds/HIDScanner.tsx +53 -0
- package/src/elements-ds/ManualForm.tsx +129 -0
- package/src/elements-ds/ProjectSelect.tsx +120 -0
- package/src/elements-ds/elements-ds.css +157 -0
- package/src/elements-ds/index.ts +16 -0
- package/src/i18n.test.ts +31 -0
- package/src/index.ts +5 -1
- package/src/mui/index.ts +1 -0
- package/src/test/fakeCamera.ts +98 -0
- package/src/test/fakeDataApi.ts +90 -0
- package/src/test/setup.browser.ts +21 -0
- package/src/test/setup.ts +15 -0
- package/src/useTranslation/index.ts +5 -3
- package/src/useTranslation/useTranslation.test.ts +128 -0
- package/es/elements/ElementLookupDialog/BarcodeScanner/decoders.test.d.ts +0 -1
- package/es/elements/ElementLookupDialog/BarcodeScanner/decoders.test.js +0 -103
- package/es/test/setup.d.ts +0 -1
- package/es/test/setup.js +0 -6
|
@@ -0,0 +1,326 @@
|
|
|
1
|
+
import { act, renderHook } from "@testing-library/react";
|
|
2
|
+
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
3
|
+
|
|
4
|
+
import { type MergeJobOptions, useMergeJob } from "./useMergeJob";
|
|
5
|
+
|
|
6
|
+
/** A stand-in for the merger's server-sent event stream; the test plays the server. */
|
|
7
|
+
class FakeEventSource {
|
|
8
|
+
static instances: FakeEventSource[] = [];
|
|
9
|
+
|
|
10
|
+
url: string;
|
|
11
|
+
closed = false;
|
|
12
|
+
listeners = new Map<string, ((event: Event) => void)[]>();
|
|
13
|
+
|
|
14
|
+
constructor(url: string) {
|
|
15
|
+
this.url = url;
|
|
16
|
+
FakeEventSource.instances.push(this);
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
addEventListener(type: string, listener: (event: Event) => void) {
|
|
20
|
+
this.listeners.set(type, [...(this.listeners.get(type) ?? []), listener]);
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
close() {
|
|
24
|
+
this.closed = true;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
emit(type: string, data?: unknown) {
|
|
28
|
+
let event = new MessageEvent(type, { data: data === undefined ? undefined : JSON.stringify(data) });
|
|
29
|
+
act(() => {
|
|
30
|
+
for (let listener of this.listeners.get(type) ?? []) listener(event);
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/** What EventSource fires when the connection drops: an error with no data. */
|
|
35
|
+
drop() {
|
|
36
|
+
act(() => {
|
|
37
|
+
for (let listener of this.listeners.get("error") ?? []) listener(new Event("error"));
|
|
38
|
+
});
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
static get last() {
|
|
42
|
+
return FakeEventSource.instances[FakeEventSource.instances.length - 1];
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
let fetchMock: ReturnType<typeof vi.fn>;
|
|
47
|
+
let windowOpen: ReturnType<typeof vi.spyOn>;
|
|
48
|
+
|
|
49
|
+
beforeEach(() => {
|
|
50
|
+
vi.useFakeTimers({ toFake: ["setTimeout", "clearTimeout", "setInterval", "clearInterval", "Date"] });
|
|
51
|
+
FakeEventSource.instances = [];
|
|
52
|
+
vi.stubGlobal("EventSource", FakeEventSource);
|
|
53
|
+
fetchMock = vi.fn(async () => new Response(JSON.stringify({ jobId: "job-1" }), { status: 200 }));
|
|
54
|
+
vi.stubGlobal("fetch", fetchMock);
|
|
55
|
+
windowOpen = vi.spyOn(window, "open").mockImplementation(() => null);
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
afterEach(() => {
|
|
59
|
+
vi.useRealTimers();
|
|
60
|
+
vi.unstubAllGlobals();
|
|
61
|
+
vi.restoreAllMocks();
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
function renderMergeJob(initial: Partial<MergeJobOptions> = {}) {
|
|
65
|
+
let options: MergeJobOptions = {
|
|
66
|
+
open: true,
|
|
67
|
+
onClose: vi.fn(),
|
|
68
|
+
getMergerId: vi.fn(async () => 42),
|
|
69
|
+
...initial,
|
|
70
|
+
};
|
|
71
|
+
let hook = renderHook((props: MergeJobOptions) => useMergeJob(props), { initialProps: options });
|
|
72
|
+
return { ...hook, options };
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/** Lets the merger ID, the start request and its JSON body resolve. */
|
|
76
|
+
async function settle() {
|
|
77
|
+
await act(async () => {
|
|
78
|
+
for (let i = 0; i < 5; i++) await Promise.resolve();
|
|
79
|
+
});
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
describe("useMergeJob", () => {
|
|
83
|
+
it("does nothing until the dialog opens", async () => {
|
|
84
|
+
let { result, options } = renderMergeJob({ open: false });
|
|
85
|
+
await settle();
|
|
86
|
+
|
|
87
|
+
expect(options.getMergerId).not.toHaveBeenCalled();
|
|
88
|
+
expect(fetchMock).not.toHaveBeenCalled();
|
|
89
|
+
expect(result.current.phase).toEqual({ kind: "preparing" });
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
it("starts the merge for the merger ID and follows its events", async () => {
|
|
93
|
+
let { result } = renderMergeJob();
|
|
94
|
+
|
|
95
|
+
expect(result.current.phase.kind).toBe("preparing");
|
|
96
|
+
expect(result.current.title).toBe("Merging drawings");
|
|
97
|
+
expect(result.current.canClose).toBe(false);
|
|
98
|
+
|
|
99
|
+
await settle();
|
|
100
|
+
|
|
101
|
+
expect(fetchMock).toHaveBeenCalledExactlyOnceWith("/api/ob/merger/start/42/pdf", { method: "POST" });
|
|
102
|
+
expect(FakeEventSource.instances.map((es) => es.url)).toEqual(["/api/ob/merger/events/job-1"]);
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
it("asks for a zip when the merge type is zip", async () => {
|
|
106
|
+
renderMergeJob({ mergeType: "zip" });
|
|
107
|
+
await settle();
|
|
108
|
+
|
|
109
|
+
expect(fetchMock).toHaveBeenCalledWith("/api/ob/merger/start/42/zip", { method: "POST" });
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
it("shows progress and cannot be closed while the job runs", async () => {
|
|
113
|
+
let { result } = renderMergeJob();
|
|
114
|
+
await settle();
|
|
115
|
+
|
|
116
|
+
FakeEventSource.last.emit("progress", { completed: 0, total: 4 });
|
|
117
|
+
expect(result.current.phase).toMatchObject({ kind: "processing", completed: 0, total: 4, currentFile: "" });
|
|
118
|
+
expect(result.current.pct).toBe(0);
|
|
119
|
+
expect(result.current.remaining).toBeNull();
|
|
120
|
+
|
|
121
|
+
FakeEventSource.last.emit("progress", { completed: 1, total: 4, currentFile: "A-101.pdf" });
|
|
122
|
+
expect(result.current.phase).toMatchObject({ completed: 1, currentFile: "A-101.pdf" });
|
|
123
|
+
expect(result.current.pct).toBe(25);
|
|
124
|
+
expect(result.current.canClose).toBe(false);
|
|
125
|
+
expect(result.current.title).toBe("Merging drawings");
|
|
126
|
+
});
|
|
127
|
+
|
|
128
|
+
it("estimates the time left from the pace so far", async () => {
|
|
129
|
+
let { result } = renderMergeJob();
|
|
130
|
+
await settle();
|
|
131
|
+
|
|
132
|
+
FakeEventSource.last.emit("progress", { completed: 0, total: 4 });
|
|
133
|
+
act(() => vi.advanceTimersByTime(10_000));
|
|
134
|
+
FakeEventSource.last.emit("progress", { completed: 1, total: 4 });
|
|
135
|
+
|
|
136
|
+
// 10 s per file, three files to go.
|
|
137
|
+
expect(result.current.remaining).toBe("~30s");
|
|
138
|
+
|
|
139
|
+
// The estimate is recomputed every second, not only when an event arrives.
|
|
140
|
+
act(() => vi.advanceTimersByTime(10_000));
|
|
141
|
+
expect(result.current.remaining).toBe("~1m");
|
|
142
|
+
|
|
143
|
+
act(() => vi.advanceTimersByTime(1_000));
|
|
144
|
+
expect(result.current.remaining).toBe("~1m 3s");
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
it("never shows 60 seconds in a minute estimate", async () => {
|
|
148
|
+
let { result } = renderMergeJob();
|
|
149
|
+
await settle();
|
|
150
|
+
|
|
151
|
+
FakeEventSource.last.emit("progress", { completed: 0, total: 3 });
|
|
152
|
+
act(() => vi.advanceTimersByTime(59_800));
|
|
153
|
+
FakeEventSource.last.emit("progress", { completed: 1, total: 3 });
|
|
154
|
+
|
|
155
|
+
// 2 x 59.8 s = 119.6 s, which rounds up to two minutes, not "1m 60s".
|
|
156
|
+
expect(result.current.remaining).toBe("~2m");
|
|
157
|
+
});
|
|
158
|
+
|
|
159
|
+
it("opens the download when the merge is done and lets the user close", async () => {
|
|
160
|
+
let { result } = renderMergeJob();
|
|
161
|
+
await settle();
|
|
162
|
+
let es = FakeEventSource.last;
|
|
163
|
+
|
|
164
|
+
es.emit("progress", { completed: 2, total: 2 });
|
|
165
|
+
es.emit("done", { fileName: "drawings.pdf" });
|
|
166
|
+
|
|
167
|
+
expect(result.current.phase).toEqual({ kind: "completed", jobId: "job-1", fileName: "drawings.pdf" });
|
|
168
|
+
expect(result.current.title).toBe("Merge complete");
|
|
169
|
+
expect(result.current.canClose).toBe(true);
|
|
170
|
+
expect(es.closed).toBe(true);
|
|
171
|
+
expect(windowOpen).toHaveBeenCalledExactlyOnceWith("/api/ob/merger/download/job-1");
|
|
172
|
+
|
|
173
|
+
// The server closes the stream after "done", which fires error; that is not a failure.
|
|
174
|
+
es.drop();
|
|
175
|
+
act(() => vi.advanceTimersByTime(60_000));
|
|
176
|
+
expect(result.current.phase.kind).toBe("completed");
|
|
177
|
+
expect(FakeEventSource.instances).toHaveLength(1);
|
|
178
|
+
});
|
|
179
|
+
|
|
180
|
+
it("reports the message of an error the server sends", async () => {
|
|
181
|
+
let { result } = renderMergeJob();
|
|
182
|
+
await settle();
|
|
183
|
+
let es = FakeEventSource.last;
|
|
184
|
+
|
|
185
|
+
es.emit("error", { message: "Drawing A-101 is missing" });
|
|
186
|
+
|
|
187
|
+
expect(result.current.phase).toEqual({ kind: "failed", error: "Drawing A-101 is missing" });
|
|
188
|
+
expect(result.current.title).toBe("Merge failed");
|
|
189
|
+
expect(result.current.canClose).toBe(true);
|
|
190
|
+
expect(es.closed).toBe(true);
|
|
191
|
+
expect(FakeEventSource.instances).toHaveLength(1);
|
|
192
|
+
});
|
|
193
|
+
|
|
194
|
+
it("reports an unknown error when the server's error cannot be read", async () => {
|
|
195
|
+
let { result } = renderMergeJob();
|
|
196
|
+
await settle();
|
|
197
|
+
|
|
198
|
+
act(() => {
|
|
199
|
+
let event = new MessageEvent("error", { data: "<html>Bad gateway</html>" });
|
|
200
|
+
for (let listener of FakeEventSource.last.listeners.get("error") ?? []) listener(event);
|
|
201
|
+
});
|
|
202
|
+
|
|
203
|
+
expect(result.current.phase).toEqual({ kind: "failed", error: "Unknown error" });
|
|
204
|
+
});
|
|
205
|
+
|
|
206
|
+
it("reconnects with a backoff when the connection drops", async () => {
|
|
207
|
+
let { result } = renderMergeJob();
|
|
208
|
+
await settle();
|
|
209
|
+
|
|
210
|
+
FakeEventSource.last.emit("progress", { completed: 1, total: 4 });
|
|
211
|
+
FakeEventSource.last.drop();
|
|
212
|
+
expect(FakeEventSource.instances[0].closed).toBe(true);
|
|
213
|
+
expect(result.current.phase.kind).toBe("processing");
|
|
214
|
+
|
|
215
|
+
act(() => vi.advanceTimersByTime(999));
|
|
216
|
+
expect(FakeEventSource.instances).toHaveLength(1);
|
|
217
|
+
act(() => vi.advanceTimersByTime(1));
|
|
218
|
+
expect(FakeEventSource.instances).toHaveLength(2);
|
|
219
|
+
expect(FakeEventSource.last.url).toBe("/api/ob/merger/events/job-1");
|
|
220
|
+
|
|
221
|
+
// The second drop waits longer.
|
|
222
|
+
FakeEventSource.last.drop();
|
|
223
|
+
act(() => vi.advanceTimersByTime(1_999));
|
|
224
|
+
expect(FakeEventSource.instances).toHaveLength(2);
|
|
225
|
+
act(() => vi.advanceTimersByTime(1));
|
|
226
|
+
expect(FakeEventSource.instances).toHaveLength(3);
|
|
227
|
+
|
|
228
|
+
// Progress on the new connection carries on from where the job was.
|
|
229
|
+
FakeEventSource.last.emit("progress", { completed: 2, total: 4 });
|
|
230
|
+
expect(result.current.phase).toMatchObject({ kind: "processing", completed: 2 });
|
|
231
|
+
|
|
232
|
+
// ...and resets the backoff.
|
|
233
|
+
FakeEventSource.last.drop();
|
|
234
|
+
act(() => vi.advanceTimersByTime(1_000));
|
|
235
|
+
expect(FakeEventSource.instances).toHaveLength(4);
|
|
236
|
+
});
|
|
237
|
+
|
|
238
|
+
it("gives up after about half a minute of failed reconnects", async () => {
|
|
239
|
+
let { result } = renderMergeJob();
|
|
240
|
+
await settle();
|
|
241
|
+
|
|
242
|
+
for (let delay of [1000, 2000, 3000, 5000, 8000, 13000]) {
|
|
243
|
+
FakeEventSource.last.drop();
|
|
244
|
+
expect(result.current.phase.kind).toBe("preparing");
|
|
245
|
+
act(() => vi.advanceTimersByTime(delay));
|
|
246
|
+
}
|
|
247
|
+
expect(FakeEventSource.instances).toHaveLength(7);
|
|
248
|
+
|
|
249
|
+
FakeEventSource.last.drop();
|
|
250
|
+
expect(result.current.phase).toEqual({ kind: "failed", error: "Unknown error" });
|
|
251
|
+
act(() => vi.advanceTimersByTime(60_000));
|
|
252
|
+
expect(FakeEventSource.instances).toHaveLength(7);
|
|
253
|
+
});
|
|
254
|
+
|
|
255
|
+
it("fails when the job cannot be started", async () => {
|
|
256
|
+
fetchMock.mockResolvedValueOnce(new Response("", { status: 500, statusText: "Internal Server Error" }));
|
|
257
|
+
let { result } = renderMergeJob();
|
|
258
|
+
await settle();
|
|
259
|
+
|
|
260
|
+
expect(result.current.phase).toEqual({ kind: "failed", error: "500 Internal Server Error" });
|
|
261
|
+
expect(result.current.canClose).toBe(true);
|
|
262
|
+
expect(FakeEventSource.instances).toHaveLength(0);
|
|
263
|
+
});
|
|
264
|
+
|
|
265
|
+
it("fails when the merger ID cannot be created", async () => {
|
|
266
|
+
let { result } = renderMergeJob({ getMergerId: vi.fn(async () => Promise.reject(new Error("No drawings"))) });
|
|
267
|
+
await settle();
|
|
268
|
+
|
|
269
|
+
expect(result.current.phase).toEqual({ kind: "failed", error: "No drawings" });
|
|
270
|
+
expect(fetchMock).not.toHaveBeenCalled();
|
|
271
|
+
});
|
|
272
|
+
|
|
273
|
+
it("does not start the job when the dialog closes before the merger ID arrives", async () => {
|
|
274
|
+
let resolveId!: (id: number) => void;
|
|
275
|
+
let getMergerId = vi.fn(() => new Promise<number>((resolve) => (resolveId = resolve)));
|
|
276
|
+
let { rerender, options } = renderMergeJob({ getMergerId });
|
|
277
|
+
|
|
278
|
+
rerender({ ...options, open: false });
|
|
279
|
+
resolveId(42);
|
|
280
|
+
await settle();
|
|
281
|
+
|
|
282
|
+
expect(fetchMock).not.toHaveBeenCalled();
|
|
283
|
+
expect(FakeEventSource.instances).toHaveLength(0);
|
|
284
|
+
});
|
|
285
|
+
|
|
286
|
+
it("stops listening and reconnecting when the dialog closes", async () => {
|
|
287
|
+
let { result, rerender, options } = renderMergeJob();
|
|
288
|
+
await settle();
|
|
289
|
+
FakeEventSource.last.drop();
|
|
290
|
+
|
|
291
|
+
rerender({ ...options, open: false });
|
|
292
|
+
act(() => vi.advanceTimersByTime(60_000));
|
|
293
|
+
|
|
294
|
+
expect(FakeEventSource.instances).toHaveLength(1);
|
|
295
|
+
expect(result.current.phase.kind).toBe("preparing");
|
|
296
|
+
});
|
|
297
|
+
|
|
298
|
+
it("closes the stream and tells the app when the user closes", async () => {
|
|
299
|
+
let { result, options } = renderMergeJob();
|
|
300
|
+
await settle();
|
|
301
|
+
let es = FakeEventSource.last;
|
|
302
|
+
es.emit("done", {});
|
|
303
|
+
|
|
304
|
+
act(() => result.current.handleClose());
|
|
305
|
+
|
|
306
|
+
expect(es.closed).toBe(true);
|
|
307
|
+
expect(options.onClose).toHaveBeenCalledOnce();
|
|
308
|
+
});
|
|
309
|
+
|
|
310
|
+
it("starts a fresh job each time the dialog opens again", async () => {
|
|
311
|
+
let { result, rerender, options } = renderMergeJob();
|
|
312
|
+
await settle();
|
|
313
|
+
FakeEventSource.last.emit("done", { fileName: "first.pdf" });
|
|
314
|
+
|
|
315
|
+
fetchMock.mockResolvedValueOnce(new Response(JSON.stringify({ jobId: "job-2" })));
|
|
316
|
+
rerender({ ...options, open: false });
|
|
317
|
+
rerender({ ...options, open: true });
|
|
318
|
+
|
|
319
|
+
expect(result.current.phase).toEqual({ kind: "preparing" });
|
|
320
|
+
expect(result.current.canClose).toBe(false);
|
|
321
|
+
await settle();
|
|
322
|
+
|
|
323
|
+
expect(options.getMergerId).toHaveBeenCalledTimes(2);
|
|
324
|
+
expect(FakeEventSource.last.url).toBe("/api/ob/merger/events/job-2");
|
|
325
|
+
});
|
|
326
|
+
});
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
import { useEffect, useRef, useState } from "react";
|
|
2
|
+
import { getLocalizedString } from "../../i18n.js";
|
|
3
|
+
|
|
4
|
+
export type MergeJobOptions = {
|
|
5
|
+
open: boolean;
|
|
6
|
+
onClose: () => void;
|
|
7
|
+
/** Called once when the dialog opens; should return the merger ID for the start route */
|
|
8
|
+
getMergerId: () => Promise<string | number>;
|
|
9
|
+
mergeType?: "pdf" | "zip";
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
export type MergePhase =
|
|
13
|
+
| { kind: "preparing" }
|
|
14
|
+
| { kind: "processing"; completed: number; total: number; currentFile: string; startedAt: number }
|
|
15
|
+
| { kind: "completed"; jobId: string; fileName: string }
|
|
16
|
+
| { kind: "failed"; error: string };
|
|
17
|
+
|
|
18
|
+
/** Waits between reconnects; together they cover a server restart of about half a minute. */
|
|
19
|
+
const RECONNECT_DELAYS_MS = [1000, 2000, 3000, 5000, 8000, 13000];
|
|
20
|
+
|
|
21
|
+
function formatRemaining(ms: number) {
|
|
22
|
+
let total = Math.ceil(ms / 1000);
|
|
23
|
+
if (total < 60) return `~${total}s`;
|
|
24
|
+
let mins = Math.floor(total / 60);
|
|
25
|
+
let secs = total % 60;
|
|
26
|
+
return secs > 0 ? `~${mins}m ${secs}s` : `~${mins}m`;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* The merge job behind `MergeProgressDialog`: starts it each time `open` turns true, follows its
|
|
31
|
+
* progress events and opens the download when it is done. Shared by the MUI and the
|
|
32
|
+
* Designsystemet dialog.
|
|
33
|
+
*/
|
|
34
|
+
export function useMergeJob({ open, onClose, getMergerId, mergeType = "pdf" }: MergeJobOptions) {
|
|
35
|
+
let [phase, setPhase] = useState<MergePhase>({ kind: "preparing" });
|
|
36
|
+
let [now, setNow] = useState(Date.now);
|
|
37
|
+
let esRef = useRef<EventSource | null>(null);
|
|
38
|
+
let doneRef = useRef(false);
|
|
39
|
+
|
|
40
|
+
// Tick every second while processing to recompute the time estimate
|
|
41
|
+
useEffect(() => {
|
|
42
|
+
if (phase.kind !== "processing") return;
|
|
43
|
+
let timer = setInterval(() => setNow(Date.now()), 1000);
|
|
44
|
+
return () => clearInterval(timer);
|
|
45
|
+
}, [phase.kind]);
|
|
46
|
+
|
|
47
|
+
// Start the merge job each time the dialog opens
|
|
48
|
+
// oxlint-disable-next-line react-hooks/exhaustive-deps -- intentionally only re-runs on open change
|
|
49
|
+
useEffect(() => {
|
|
50
|
+
if (!open) return;
|
|
51
|
+
|
|
52
|
+
setPhase({ kind: "preparing" });
|
|
53
|
+
doneRef.current = false;
|
|
54
|
+
|
|
55
|
+
let cancelled = false;
|
|
56
|
+
let es: EventSource | null = null;
|
|
57
|
+
let retryTimer: ReturnType<typeof setTimeout> | undefined;
|
|
58
|
+
|
|
59
|
+
async function start() {
|
|
60
|
+
try {
|
|
61
|
+
let mergerId = await getMergerId();
|
|
62
|
+
if (cancelled) return;
|
|
63
|
+
|
|
64
|
+
let response = await fetch(`/api/ob/merger/start/${mergerId}/${mergeType}`, { method: "POST" });
|
|
65
|
+
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);
|
|
66
|
+
let { jobId } = await response.json();
|
|
67
|
+
if (cancelled) return;
|
|
68
|
+
|
|
69
|
+
// The server keeps a job's state on disk and runs it again when the process running it
|
|
70
|
+
// goes away (a deploy or an app pool recycle), so a dropped connection is retried with
|
|
71
|
+
// a backoff before the merge is reported as failed. EventSource only reconnects by
|
|
72
|
+
// itself after a clean drop, not after the 502/503 a restarting server answers with.
|
|
73
|
+
let attempt = 0;
|
|
74
|
+
|
|
75
|
+
function connect() {
|
|
76
|
+
es = new EventSource(`/api/ob/merger/events/${jobId}`);
|
|
77
|
+
esRef.current = es;
|
|
78
|
+
|
|
79
|
+
es.addEventListener("progress", (e) => {
|
|
80
|
+
attempt = 0;
|
|
81
|
+
let d = JSON.parse((e as MessageEvent).data);
|
|
82
|
+
setPhase((prev) => ({
|
|
83
|
+
kind: "processing",
|
|
84
|
+
completed: d.completed,
|
|
85
|
+
total: d.total,
|
|
86
|
+
currentFile: d.currentFile ?? "",
|
|
87
|
+
startedAt: prev.kind === "processing" ? prev.startedAt : Date.now(),
|
|
88
|
+
}));
|
|
89
|
+
setNow(Date.now());
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
es.addEventListener("done", (e) => {
|
|
93
|
+
doneRef.current = true;
|
|
94
|
+
es?.close();
|
|
95
|
+
let d = JSON.parse((e as MessageEvent).data);
|
|
96
|
+
setPhase({ kind: "completed", jobId, fileName: d.fileName ?? "" });
|
|
97
|
+
window.open(`/api/ob/merger/download/${jobId}`);
|
|
98
|
+
});
|
|
99
|
+
|
|
100
|
+
// Catches both server-sent "event: error" (with data) and connection errors.
|
|
101
|
+
// After a "done" event the server closes the stream, which also fires error —
|
|
102
|
+
// doneRef guards against treating that as a failure.
|
|
103
|
+
es.addEventListener("error", (e) => {
|
|
104
|
+
if (doneRef.current) return;
|
|
105
|
+
es?.close();
|
|
106
|
+
let data = (e as MessageEvent).data;
|
|
107
|
+
if (!data && attempt < RECONNECT_DELAYS_MS.length) {
|
|
108
|
+
retryTimer = setTimeout(() => {
|
|
109
|
+
if (!cancelled && !doneRef.current) connect();
|
|
110
|
+
}, RECONNECT_DELAYS_MS[attempt++]);
|
|
111
|
+
return;
|
|
112
|
+
}
|
|
113
|
+
let message = getLocalizedString("Unknown error");
|
|
114
|
+
if (data) {
|
|
115
|
+
try {
|
|
116
|
+
message = JSON.parse(data).message ?? message;
|
|
117
|
+
} catch {}
|
|
118
|
+
}
|
|
119
|
+
setPhase({ kind: "failed", error: message });
|
|
120
|
+
});
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
connect();
|
|
124
|
+
} catch (err: unknown) {
|
|
125
|
+
if (!cancelled) {
|
|
126
|
+
setPhase({ kind: "failed", error: (err as Error)?.message ?? String(err) });
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
start();
|
|
132
|
+
|
|
133
|
+
return () => {
|
|
134
|
+
cancelled = true;
|
|
135
|
+
clearTimeout(retryTimer);
|
|
136
|
+
es?.close();
|
|
137
|
+
esRef.current = null;
|
|
138
|
+
};
|
|
139
|
+
}, [open]);
|
|
140
|
+
|
|
141
|
+
function handleClose() {
|
|
142
|
+
esRef.current?.close();
|
|
143
|
+
esRef.current = null;
|
|
144
|
+
onClose();
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
let pct = 0;
|
|
148
|
+
let remaining: string | null = null;
|
|
149
|
+
|
|
150
|
+
if (phase.kind === "processing" && phase.total > 0) {
|
|
151
|
+
pct = Math.round((phase.completed / phase.total) * 100);
|
|
152
|
+
if (phase.completed > 0) {
|
|
153
|
+
let elapsed = now - phase.startedAt;
|
|
154
|
+
let msPerFile = elapsed / phase.completed;
|
|
155
|
+
let remainingMs = msPerFile * (phase.total - phase.completed);
|
|
156
|
+
remaining = formatRemaining(remainingMs);
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
let title =
|
|
161
|
+
phase.kind === "completed"
|
|
162
|
+
? getLocalizedString("Merge complete")
|
|
163
|
+
: phase.kind === "failed"
|
|
164
|
+
? getLocalizedString("Merge failed")
|
|
165
|
+
: getLocalizedString("Merging drawings");
|
|
166
|
+
|
|
167
|
+
let canClose = phase.kind === "completed" || phase.kind === "failed";
|
|
168
|
+
|
|
169
|
+
return { phase, pct, remaining, title, canClose, handleClose };
|
|
170
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { render, screen } from "@testing-library/react";
|
|
2
|
+
import { PDFDocument, rgb } from "pdf-lib";
|
|
3
|
+
import workerUrl from "pdfjs-dist/build/pdf.worker.min.mjs?url";
|
|
4
|
+
import { pdfjs } from "react-pdf";
|
|
5
|
+
import { userEvent } from "vitest/browser";
|
|
6
|
+
import { beforeAll, describe, expect, it } from "vitest";
|
|
7
|
+
|
|
8
|
+
import { PdfViewer } from "./PdfViewer";
|
|
9
|
+
|
|
10
|
+
beforeAll(() => {
|
|
11
|
+
/*
|
|
12
|
+
* On a page the platform serves pdf.js's worker next to pdfjs-dist; here there is no import
|
|
13
|
+
* map, so point pdf.js at the worker the way the platform would.
|
|
14
|
+
*/
|
|
15
|
+
pdfjs.GlobalWorkerOptions.workerSrc = workerUrl;
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
/** A PDF of `pages` A4 pages, each with a black block in its top-left corner. */
|
|
19
|
+
async function createPdf(pages: number) {
|
|
20
|
+
let pdf = await PDFDocument.create();
|
|
21
|
+
for (let i = 0; i < pages; i++) {
|
|
22
|
+
let page = pdf.addPage([595, 842]);
|
|
23
|
+
page.drawRectangle({ x: 0, y: 742, width: 100, height: 100, color: rgb(0, 0, 0) });
|
|
24
|
+
}
|
|
25
|
+
return new Blob([(await pdf.save()) as BlobPart], { type: "application/pdf" });
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
function canvases(container: HTMLElement) {
|
|
29
|
+
return [...container.querySelectorAll("canvas")];
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
describe("PdfViewer", () => {
|
|
33
|
+
it("draws every page of the document", async () => {
|
|
34
|
+
let file = await createPdf(3);
|
|
35
|
+
let { container } = render(
|
|
36
|
+
<div style={{ width: 400, height: 600 }}>
|
|
37
|
+
<PdfViewer file={file} />
|
|
38
|
+
</div>,
|
|
39
|
+
);
|
|
40
|
+
|
|
41
|
+
await expect.poll(() => canvases(container).length, { timeout: 10_000 }).toBe(3);
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
it("fits the whole page in the viewer, then zooms with Ctrl", async () => {
|
|
45
|
+
let file = await createPdf(1);
|
|
46
|
+
let { container } = render(
|
|
47
|
+
<div style={{ width: 600, height: 400 }}>
|
|
48
|
+
<PdfViewer file={file} />
|
|
49
|
+
</div>,
|
|
50
|
+
);
|
|
51
|
+
let width = () => Math.round(canvases(container)[0]?.getBoundingClientRect().width ?? 0);
|
|
52
|
+
|
|
53
|
+
// An A4 page in a 600 x 400 box is as tall as the box: 400 x 595 / 842 = 283 px wide.
|
|
54
|
+
await expect.poll(width, { timeout: 10_000 }).toBe(283);
|
|
55
|
+
|
|
56
|
+
await userEvent.keyboard("{Control>}={/Control}");
|
|
57
|
+
await expect.poll(width).toBe(311);
|
|
58
|
+
|
|
59
|
+
await userEvent.keyboard("{Control>}-{/Control}");
|
|
60
|
+
await expect.poll(width).toBe(283);
|
|
61
|
+
|
|
62
|
+
await userEvent.keyboard("{Control>}={/Control}{Control>}={/Control}{Control>}0{/Control}");
|
|
63
|
+
await expect.poll(width).toBe(283);
|
|
64
|
+
|
|
65
|
+
// Ctrl + wheel zooms the document, not the page.
|
|
66
|
+
let wheel = new WheelEvent("wheel", { deltaY: -500, ctrlKey: true, bubbles: true, cancelable: true });
|
|
67
|
+
container.querySelector(".pdfViewerContainer")!.dispatchEvent(wheel);
|
|
68
|
+
expect(wheel.defaultPrevented).toBe(true);
|
|
69
|
+
await expect.poll(width).toBeGreaterThan(283);
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
it("shows why a document cannot be read", async () => {
|
|
73
|
+
let file = new Blob(["this is not a pdf"], { type: "application/pdf" });
|
|
74
|
+
render(<PdfViewer file={file} />);
|
|
75
|
+
|
|
76
|
+
expect(await screen.findByText(/Error loading PDF/, {}, { timeout: 10_000 })).toBeInTheDocument();
|
|
77
|
+
});
|
|
78
|
+
});
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { render, screen } from "@testing-library/react";
|
|
2
|
+
import { StrictMode } from "react";
|
|
3
|
+
import { afterEach, describe, expect, it } from "vitest";
|
|
4
|
+
|
|
5
|
+
import { Portal } from "./index";
|
|
6
|
+
|
|
7
|
+
afterEach(() => {
|
|
8
|
+
document.getElementById("dialogs")?.remove();
|
|
9
|
+
});
|
|
10
|
+
|
|
11
|
+
describe("Portal", () => {
|
|
12
|
+
it("renders its children at the end of <body>, outside the component's own tree", () => {
|
|
13
|
+
let { container } = render(
|
|
14
|
+
<Portal>
|
|
15
|
+
<p>Floating</p>
|
|
16
|
+
</Portal>,
|
|
17
|
+
);
|
|
18
|
+
|
|
19
|
+
let content = screen.getByText("Floating");
|
|
20
|
+
expect(container).not.toContainElement(content);
|
|
21
|
+
expect(content.parentElement?.tagName).toBe("DIV");
|
|
22
|
+
expect(content.parentElement?.parentElement).toBe(document.body);
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
it("renders into the element the root selector points at", () => {
|
|
26
|
+
let host = document.createElement("section");
|
|
27
|
+
host.id = "dialogs";
|
|
28
|
+
document.body.append(host);
|
|
29
|
+
|
|
30
|
+
render(
|
|
31
|
+
<Portal root="#dialogs">
|
|
32
|
+
<p>Floating</p>
|
|
33
|
+
</Portal>,
|
|
34
|
+
);
|
|
35
|
+
|
|
36
|
+
expect(host).toContainElement(screen.getByText("Floating"));
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
it("falls back to <body> when the root is not on the page", () => {
|
|
40
|
+
render(
|
|
41
|
+
<Portal root="#missing">
|
|
42
|
+
<p>Floating</p>
|
|
43
|
+
</Portal>,
|
|
44
|
+
);
|
|
45
|
+
|
|
46
|
+
expect(screen.getByText("Floating").parentElement?.parentElement).toBe(document.body);
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
it("wraps the children in an element of the given type", () => {
|
|
50
|
+
render(
|
|
51
|
+
<Portal type="aside">
|
|
52
|
+
<p>Floating</p>
|
|
53
|
+
</Portal>,
|
|
54
|
+
);
|
|
55
|
+
|
|
56
|
+
expect(screen.getByText("Floating").parentElement?.tagName).toBe("ASIDE");
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
it("removes its element when it unmounts", () => {
|
|
60
|
+
let { unmount } = render(
|
|
61
|
+
<Portal type="aside">
|
|
62
|
+
<p>Floating</p>
|
|
63
|
+
</Portal>,
|
|
64
|
+
);
|
|
65
|
+
|
|
66
|
+
unmount();
|
|
67
|
+
|
|
68
|
+
expect(screen.queryByText("Floating")).toBeNull();
|
|
69
|
+
expect(document.body.querySelector("aside")).toBeNull();
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
it("moves its children when the root changes", () => {
|
|
73
|
+
let host = document.createElement("section");
|
|
74
|
+
host.id = "dialogs";
|
|
75
|
+
document.body.append(host);
|
|
76
|
+
|
|
77
|
+
let { rerender } = render(
|
|
78
|
+
<Portal>
|
|
79
|
+
<p>Floating</p>
|
|
80
|
+
</Portal>,
|
|
81
|
+
);
|
|
82
|
+
let first = screen.getByText("Floating").parentElement;
|
|
83
|
+
expect(host).not.toContainElement(first);
|
|
84
|
+
|
|
85
|
+
rerender(
|
|
86
|
+
<Portal root="#dialogs">
|
|
87
|
+
<p>Floating</p>
|
|
88
|
+
</Portal>,
|
|
89
|
+
);
|
|
90
|
+
|
|
91
|
+
expect(host).toContainElement(screen.getByText("Floating"));
|
|
92
|
+
expect(first).not.toBeInTheDocument();
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
it("shows its children under StrictMode", () => {
|
|
96
|
+
render(
|
|
97
|
+
<StrictMode>
|
|
98
|
+
<Portal>
|
|
99
|
+
<p>Floating</p>
|
|
100
|
+
</Portal>
|
|
101
|
+
</StrictMode>,
|
|
102
|
+
);
|
|
103
|
+
|
|
104
|
+
expect(screen.getByText("Floating")).toBeInTheDocument();
|
|
105
|
+
});
|
|
106
|
+
});
|