@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,208 @@
|
|
|
1
|
+
import { act, renderHook, waitFor } from "@testing-library/react";
|
|
2
|
+
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
3
|
+
|
|
4
|
+
/*
|
|
5
|
+
* OpenCV.js is never downloaded: script tags the loader adds to <head> are captured, and
|
|
6
|
+
* each test decides whether that "download" fails or what it leaves on `window.cv`.
|
|
7
|
+
*/
|
|
8
|
+
let scripts: HTMLScriptElement[] = [];
|
|
9
|
+
|
|
10
|
+
type OpenCVModule = typeof import("./useOpenCV");
|
|
11
|
+
|
|
12
|
+
/** A fresh copy of the module, since it caches the load in module state. */
|
|
13
|
+
async function freshModule(): Promise<OpenCVModule> {
|
|
14
|
+
vi.resetModules();
|
|
15
|
+
return import("./useOpenCV");
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
beforeEach(() => {
|
|
19
|
+
scripts = [];
|
|
20
|
+
vi.spyOn(console, "warn").mockImplementation(() => {});
|
|
21
|
+
let append = document.head.appendChild.bind(document.head);
|
|
22
|
+
vi.spyOn(document.head, "appendChild").mockImplementation(<T extends Node>(node: T): T => {
|
|
23
|
+
if (node instanceof HTMLScriptElement) {
|
|
24
|
+
scripts.push(node);
|
|
25
|
+
return node;
|
|
26
|
+
}
|
|
27
|
+
return append(node);
|
|
28
|
+
});
|
|
29
|
+
window.cv = undefined;
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
afterEach(() => {
|
|
33
|
+
vi.restoreAllMocks();
|
|
34
|
+
vi.useRealTimers();
|
|
35
|
+
window.cv = undefined;
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
/** Waits for the loader to request its next script. */
|
|
39
|
+
async function nextScript(count: number) {
|
|
40
|
+
await vi.waitFor(() => expect(scripts).toHaveLength(count));
|
|
41
|
+
return scripts[count - 1];
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
function fail(script: HTMLScriptElement) {
|
|
45
|
+
script.onerror?.(new Event("error"));
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
function succeed(script: HTMLScriptElement, cv: unknown = { Mat: class {}, imread: () => {} }) {
|
|
49
|
+
window.cv = cv;
|
|
50
|
+
script.onload?.(new Event("load"));
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
describe("loadOpenCV", () => {
|
|
54
|
+
it("tries the 5.x build first and falls back to 4.x when it cannot be loaded", async () => {
|
|
55
|
+
let { loadOpenCV, DEFAULT_OPENCV_URLS } = await freshModule();
|
|
56
|
+
|
|
57
|
+
let loading = loadOpenCV();
|
|
58
|
+
let first = await nextScript(1);
|
|
59
|
+
expect(first.src).toBe(DEFAULT_OPENCV_URLS[0]);
|
|
60
|
+
fail(first);
|
|
61
|
+
|
|
62
|
+
let second = await nextScript(2);
|
|
63
|
+
expect(second.src).toBe(DEFAULT_OPENCV_URLS[1]);
|
|
64
|
+
succeed(second);
|
|
65
|
+
|
|
66
|
+
await expect(loading).resolves.toBeUndefined();
|
|
67
|
+
expect(window.cv.Mat).toBeDefined();
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
it("rejects when no build can be loaded, naming every URL it tried", async () => {
|
|
71
|
+
let { loadOpenCV, configureOpenCV } = await freshModule();
|
|
72
|
+
configureOpenCV(["https://a.example/opencv.js", "https://b.example/opencv.js"]);
|
|
73
|
+
|
|
74
|
+
let loading = loadOpenCV();
|
|
75
|
+
fail(await nextScript(1));
|
|
76
|
+
fail(await nextScript(2));
|
|
77
|
+
|
|
78
|
+
let error = await loading.catch((e: Error) => e);
|
|
79
|
+
expect(error).toBeInstanceOf(Error);
|
|
80
|
+
expect((error as Error).message).toBe(
|
|
81
|
+
"Failed to load OpenCV.js from: https://a.example/opencv.js, https://b.example/opencv.js",
|
|
82
|
+
);
|
|
83
|
+
expect((error as Error).cause).toHaveLength(2);
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
it("tries again on the next call after a failure, e.g. once the network is back", async () => {
|
|
87
|
+
let { loadOpenCV, configureOpenCV } = await freshModule();
|
|
88
|
+
configureOpenCV("https://a.example/opencv.js");
|
|
89
|
+
|
|
90
|
+
let first = loadOpenCV();
|
|
91
|
+
fail(await nextScript(1));
|
|
92
|
+
await expect(first).rejects.toThrow();
|
|
93
|
+
|
|
94
|
+
let second = loadOpenCV();
|
|
95
|
+
succeed(await nextScript(2));
|
|
96
|
+
await expect(second).resolves.toBeUndefined();
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
it("shares one download between callers", async () => {
|
|
100
|
+
let { loadOpenCV } = await freshModule();
|
|
101
|
+
|
|
102
|
+
let a = loadOpenCV();
|
|
103
|
+
let b = loadOpenCV();
|
|
104
|
+
succeed(await nextScript(1));
|
|
105
|
+
|
|
106
|
+
await Promise.all([a, b]);
|
|
107
|
+
expect(a).toBe(b);
|
|
108
|
+
expect(scripts).toHaveLength(1);
|
|
109
|
+
});
|
|
110
|
+
|
|
111
|
+
it("uses an OpenCV the page already loaded", async () => {
|
|
112
|
+
let { loadOpenCV } = await freshModule();
|
|
113
|
+
window.cv = { Mat: class {} };
|
|
114
|
+
|
|
115
|
+
await loadOpenCV();
|
|
116
|
+
|
|
117
|
+
expect(scripts).toHaveLength(0);
|
|
118
|
+
});
|
|
119
|
+
|
|
120
|
+
it("unwraps a promise-style Emscripten build without resolving to the thenable module", async () => {
|
|
121
|
+
let { loadOpenCV } = await freshModule();
|
|
122
|
+
// The real module is thenable too: resolving a promise *with* it would never settle.
|
|
123
|
+
let instance = { Mat: class {} };
|
|
124
|
+
let pending = {
|
|
125
|
+
// oxlint-disable-next-line unicorn/no-thenable -- stands in for the Emscripten module
|
|
126
|
+
then(resolve: (value: unknown) => void) {
|
|
127
|
+
resolve(instance);
|
|
128
|
+
},
|
|
129
|
+
};
|
|
130
|
+
|
|
131
|
+
let loading = loadOpenCV();
|
|
132
|
+
succeed(await nextScript(1), pending);
|
|
133
|
+
|
|
134
|
+
await expect(loading).resolves.toBeUndefined();
|
|
135
|
+
expect(window.cv).toBe(instance);
|
|
136
|
+
});
|
|
137
|
+
|
|
138
|
+
it("waits for a build that initialises after its script has loaded, and gives up after a minute", async () => {
|
|
139
|
+
vi.useFakeTimers();
|
|
140
|
+
let { loadOpenCV, configureOpenCV } = await freshModule();
|
|
141
|
+
configureOpenCV(["https://slow.example/opencv.js", "https://b.example/opencv.js"]);
|
|
142
|
+
|
|
143
|
+
let loading = loadOpenCV();
|
|
144
|
+
await vi.advanceTimersByTimeAsync(0);
|
|
145
|
+
scripts[0].onload?.(new Event("load"));
|
|
146
|
+
|
|
147
|
+
await vi.advanceTimersByTimeAsync(59_000);
|
|
148
|
+
expect(scripts).toHaveLength(1);
|
|
149
|
+
await vi.advanceTimersByTimeAsync(1_000);
|
|
150
|
+
expect(scripts).toHaveLength(2);
|
|
151
|
+
|
|
152
|
+
// The second build initialises asynchronously, a moment after its script loaded.
|
|
153
|
+
scripts[1].onload?.(new Event("load"));
|
|
154
|
+
window.cv = { Mat: class {} };
|
|
155
|
+
await vi.advanceTimersByTimeAsync(100);
|
|
156
|
+
|
|
157
|
+
await expect(loading).resolves.toBeUndefined();
|
|
158
|
+
});
|
|
159
|
+
|
|
160
|
+
it("lets the app point at a self-hosted build before loading starts, and not after", async () => {
|
|
161
|
+
let { loadOpenCV, configureOpenCV } = await freshModule();
|
|
162
|
+
|
|
163
|
+
configureOpenCV("/lib/opencv.js");
|
|
164
|
+
let loading = loadOpenCV();
|
|
165
|
+
configureOpenCV("/other/opencv.js");
|
|
166
|
+
let script = await nextScript(1);
|
|
167
|
+
succeed(script);
|
|
168
|
+
await loading;
|
|
169
|
+
|
|
170
|
+
expect(script.src).toContain("/lib/opencv.js");
|
|
171
|
+
expect(console.warn).toHaveBeenCalledWith(expect.stringContaining("configureOpenCV() ignored"));
|
|
172
|
+
});
|
|
173
|
+
});
|
|
174
|
+
|
|
175
|
+
describe("useOpenCV", () => {
|
|
176
|
+
it("does not load anything until enabled", async () => {
|
|
177
|
+
let { useOpenCV } = await freshModule();
|
|
178
|
+
|
|
179
|
+
let { result } = renderHook(() => useOpenCV(false));
|
|
180
|
+
|
|
181
|
+
expect(result.current).toEqual({ cv: null, ready: false, error: null });
|
|
182
|
+
expect(scripts).toHaveLength(0);
|
|
183
|
+
});
|
|
184
|
+
|
|
185
|
+
it("reports ready with the loaded module", async () => {
|
|
186
|
+
let { useOpenCV } = await freshModule();
|
|
187
|
+
let cv = { Mat: class {} };
|
|
188
|
+
|
|
189
|
+
let { result } = renderHook(() => useOpenCV(true));
|
|
190
|
+
succeed(await nextScript(1), cv);
|
|
191
|
+
|
|
192
|
+
await waitFor(() => expect(result.current.ready).toBe(true));
|
|
193
|
+
expect(result.current.cv).toBe(cv);
|
|
194
|
+
expect(result.current.error).toBeNull();
|
|
195
|
+
});
|
|
196
|
+
|
|
197
|
+
it("reports a load failure as an error instead of throwing", async () => {
|
|
198
|
+
let { useOpenCV, configureOpenCV } = await freshModule();
|
|
199
|
+
configureOpenCV("https://a.example/opencv.js");
|
|
200
|
+
|
|
201
|
+
let { result } = renderHook(() => useOpenCV(true));
|
|
202
|
+
await act(async () => fail(await nextScript(1)));
|
|
203
|
+
|
|
204
|
+
await waitFor(() => expect(result.current.error).toBeInstanceOf(Error));
|
|
205
|
+
expect(result.current.ready).toBe(false);
|
|
206
|
+
expect(result.current.cv).toBeNull();
|
|
207
|
+
});
|
|
208
|
+
});
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
import { act, render, screen } from "@testing-library/react";
|
|
2
|
+
import { useState } from "react";
|
|
3
|
+
import { userEvent } from "vitest/browser";
|
|
4
|
+
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
5
|
+
|
|
6
|
+
import { MergeProgressDialogDs } from "./MergeProgressDialogDs";
|
|
7
|
+
|
|
8
|
+
/** A stand-in for the merger's server-sent event stream; the test plays the server. */
|
|
9
|
+
class FakeEventSource {
|
|
10
|
+
static instances: FakeEventSource[] = [];
|
|
11
|
+
|
|
12
|
+
url: string;
|
|
13
|
+
closed = false;
|
|
14
|
+
listeners = new Map<string, ((event: Event) => void)[]>();
|
|
15
|
+
|
|
16
|
+
constructor(url: string) {
|
|
17
|
+
this.url = url;
|
|
18
|
+
FakeEventSource.instances.push(this);
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
addEventListener(type: string, listener: (event: Event) => void) {
|
|
22
|
+
this.listeners.set(type, [...(this.listeners.get(type) ?? []), listener]);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
close() {
|
|
26
|
+
this.closed = true;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
emit(type: string, data: unknown) {
|
|
30
|
+
let event = new MessageEvent(type, { data: JSON.stringify(data) });
|
|
31
|
+
act(() => {
|
|
32
|
+
for (let listener of this.listeners.get(type) ?? []) listener(event);
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
static get last() {
|
|
37
|
+
return FakeEventSource.instances[FakeEventSource.instances.length - 1];
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
let windowOpen: ReturnType<typeof vi.spyOn>;
|
|
42
|
+
|
|
43
|
+
beforeEach(() => {
|
|
44
|
+
FakeEventSource.instances = [];
|
|
45
|
+
vi.stubGlobal("EventSource", FakeEventSource);
|
|
46
|
+
vi.spyOn(window, "fetch").mockImplementation(async () => new Response(JSON.stringify({ jobId: "job-7" })));
|
|
47
|
+
windowOpen = vi.spyOn(window, "open").mockImplementation(() => null);
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
afterEach(() => {
|
|
51
|
+
vi.unstubAllGlobals();
|
|
52
|
+
vi.restoreAllMocks();
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
/** The dialog as the apps use it: open from a button, closed through `onClose`. */
|
|
56
|
+
function Harness({ onClose }: { onClose: () => void }) {
|
|
57
|
+
let [open, setOpen] = useState(true);
|
|
58
|
+
return (
|
|
59
|
+
<MergeProgressDialogDs
|
|
60
|
+
open={open}
|
|
61
|
+
onClose={() => {
|
|
62
|
+
onClose();
|
|
63
|
+
setOpen(false);
|
|
64
|
+
}}
|
|
65
|
+
getMergerId={async () => 42}
|
|
66
|
+
/>
|
|
67
|
+
);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
async function started() {
|
|
71
|
+
await vi.waitFor(() => expect(FakeEventSource.instances).toHaveLength(1));
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
describe("MergeProgressDialogDs", () => {
|
|
75
|
+
it("shows the job starting, then its progress", async () => {
|
|
76
|
+
render(<Harness onClose={() => {}} />);
|
|
77
|
+
|
|
78
|
+
let dialog = await screen.findByRole("dialog");
|
|
79
|
+
await vi.waitFor(() => expect(dialog).toBeVisible());
|
|
80
|
+
expect(screen.getByRole("heading", { name: "Merging drawings" })).toBeInTheDocument();
|
|
81
|
+
expect(screen.getByText("Starting merge job…")).toBeInTheDocument();
|
|
82
|
+
|
|
83
|
+
await started();
|
|
84
|
+
FakeEventSource.last.emit("progress", { completed: 3, total: 12, currentFile: "B-204.pdf" });
|
|
85
|
+
|
|
86
|
+
expect(await screen.findByText(/3 \/ 12 files/)).toBeInTheDocument();
|
|
87
|
+
expect(screen.getByText("B-204.pdf")).toBeInTheDocument();
|
|
88
|
+
expect(screen.getByRole("progressbar")).toBeInTheDocument();
|
|
89
|
+
});
|
|
90
|
+
|
|
91
|
+
it("cannot be dismissed while the job runs", async () => {
|
|
92
|
+
let onClose = vi.fn();
|
|
93
|
+
render(<Harness onClose={onClose} />);
|
|
94
|
+
await started();
|
|
95
|
+
FakeEventSource.last.emit("progress", { completed: 1, total: 4 });
|
|
96
|
+
|
|
97
|
+
expect(screen.getByRole("button", { name: "Close" })).toBeDisabled();
|
|
98
|
+
await userEvent.keyboard("{Escape}");
|
|
99
|
+
|
|
100
|
+
expect(screen.getByRole("dialog")).toBeVisible();
|
|
101
|
+
expect(onClose).not.toHaveBeenCalled();
|
|
102
|
+
expect(FakeEventSource.last.closed).toBe(false);
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
it("has no close button in the header while the job runs", async () => {
|
|
106
|
+
let onClose = vi.fn();
|
|
107
|
+
render(<Harness onClose={onClose} />);
|
|
108
|
+
await started();
|
|
109
|
+
FakeEventSource.last.emit("progress", { completed: 1, total: 4 });
|
|
110
|
+
|
|
111
|
+
// Only the disabled Close button: Designsystemet's own close button in the header would
|
|
112
|
+
// end the dialog, and with it the job's event stream.
|
|
113
|
+
expect(screen.getAllByRole("button")).toEqual([screen.getByRole("button", { name: "Close" })]);
|
|
114
|
+
let enabled = screen.queryAllByRole("button").filter((button) => !(button as HTMLButtonElement).disabled);
|
|
115
|
+
for (let button of enabled) await userEvent.click(button);
|
|
116
|
+
|
|
117
|
+
expect(screen.getByRole("dialog")).toBeVisible();
|
|
118
|
+
expect(onClose).not.toHaveBeenCalled();
|
|
119
|
+
expect(FakeEventSource.last.closed).toBe(false);
|
|
120
|
+
});
|
|
121
|
+
|
|
122
|
+
it("offers the download and closes once the merge is done", async () => {
|
|
123
|
+
let onClose = vi.fn();
|
|
124
|
+
render(<Harness onClose={onClose} />);
|
|
125
|
+
await started();
|
|
126
|
+
|
|
127
|
+
FakeEventSource.last.emit("done", { fileName: "drawings.pdf" });
|
|
128
|
+
|
|
129
|
+
expect(await screen.findByRole("heading", { name: "Merge complete" })).toBeInTheDocument();
|
|
130
|
+
expect(windowOpen).toHaveBeenCalledWith("/api/ob/merger/download/job-7");
|
|
131
|
+
expect(screen.getByRole("link", { name: "click here to open it" })).toHaveAttribute(
|
|
132
|
+
"href",
|
|
133
|
+
"/api/ob/merger/download/job-7",
|
|
134
|
+
);
|
|
135
|
+
|
|
136
|
+
await userEvent.click(screen.getByRole("button", { name: "Close" }));
|
|
137
|
+
|
|
138
|
+
expect(onClose).toHaveBeenCalled();
|
|
139
|
+
await vi.waitFor(() => expect(screen.queryByRole("dialog")).toBeNull());
|
|
140
|
+
});
|
|
141
|
+
|
|
142
|
+
it("shows why the merge failed and can then be closed with Escape", async () => {
|
|
143
|
+
let onClose = vi.fn();
|
|
144
|
+
render(<Harness onClose={onClose} />);
|
|
145
|
+
await started();
|
|
146
|
+
|
|
147
|
+
FakeEventSource.last.emit("error", { message: "Drawing A-101 is missing" });
|
|
148
|
+
|
|
149
|
+
expect(await screen.findByRole("heading", { name: "Merge failed" })).toBeInTheDocument();
|
|
150
|
+
expect(screen.getByText("Drawing A-101 is missing")).toBeInTheDocument();
|
|
151
|
+
expect(screen.getByRole("button", { name: "Close" })).toBeEnabled();
|
|
152
|
+
|
|
153
|
+
await userEvent.keyboard("{Escape}");
|
|
154
|
+
await vi.waitFor(() => expect(onClose).toHaveBeenCalled());
|
|
155
|
+
});
|
|
156
|
+
});
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import { Button, Dialog, Link, Paragraph } from "@digdir/designsystemet-react";
|
|
2
|
+
import { LinearProgress, ResponsiveDialog } from "@olenbetong/appframe-ds";
|
|
3
|
+
import { getLocalizedString } from "../../i18n.js";
|
|
4
|
+
import { type MergeJobOptions, useMergeJob } from "./useMergeJob.js";
|
|
5
|
+
|
|
6
|
+
export type MergeProgressDialogDsProps = MergeJobOptions;
|
|
7
|
+
|
|
8
|
+
const subtle = { color: "var(--ds-color-neutral-text-subtle)" };
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Designsystemet version of `MergeProgressDialog`, for apps off MUI: the same merge job and
|
|
12
|
+
* props. The dialog cannot be dismissed while the job runs.
|
|
13
|
+
*/
|
|
14
|
+
export function MergeProgressDialogDs(props: MergeProgressDialogDsProps) {
|
|
15
|
+
let { phase, pct, remaining, title, canClose, handleClose } = useMergeJob(props);
|
|
16
|
+
|
|
17
|
+
return (
|
|
18
|
+
<ResponsiveDialog
|
|
19
|
+
open={props.open}
|
|
20
|
+
onClose={handleClose}
|
|
21
|
+
closedby={canClose ? "any" : "none"}
|
|
22
|
+
closeButton={canClose ? undefined : false}
|
|
23
|
+
title={title}
|
|
24
|
+
maxWidth="sm"
|
|
25
|
+
>
|
|
26
|
+
<Dialog.Block>
|
|
27
|
+
{(phase.kind === "preparing" || phase.kind === "processing") && (
|
|
28
|
+
<LinearProgress
|
|
29
|
+
value={phase.kind === "processing" && phase.total > 0 ? pct : undefined}
|
|
30
|
+
style={{ marginBottom: "0.75rem" }}
|
|
31
|
+
/>
|
|
32
|
+
)}
|
|
33
|
+
|
|
34
|
+
{phase.kind === "preparing" && (
|
|
35
|
+
<Paragraph data-size="sm" style={subtle}>
|
|
36
|
+
{getLocalizedString("Starting merge job…")}
|
|
37
|
+
</Paragraph>
|
|
38
|
+
)}
|
|
39
|
+
|
|
40
|
+
{phase.kind === "processing" && (
|
|
41
|
+
<>
|
|
42
|
+
<Paragraph data-size="sm">
|
|
43
|
+
{phase.completed} / {phase.total} {getLocalizedString("files")}
|
|
44
|
+
{remaining && <span style={subtle}> — {remaining}</span>}
|
|
45
|
+
</Paragraph>
|
|
46
|
+
{phase.currentFile && (
|
|
47
|
+
<Paragraph
|
|
48
|
+
data-size="sm"
|
|
49
|
+
title={phase.currentFile}
|
|
50
|
+
style={{
|
|
51
|
+
...subtle,
|
|
52
|
+
marginTop: "0.25rem",
|
|
53
|
+
overflow: "hidden",
|
|
54
|
+
textOverflow: "ellipsis",
|
|
55
|
+
whiteSpace: "nowrap",
|
|
56
|
+
}}
|
|
57
|
+
>
|
|
58
|
+
{phase.currentFile}
|
|
59
|
+
</Paragraph>
|
|
60
|
+
)}
|
|
61
|
+
</>
|
|
62
|
+
)}
|
|
63
|
+
|
|
64
|
+
{phase.kind === "completed" && (
|
|
65
|
+
<>
|
|
66
|
+
<Paragraph data-size="sm" style={{ color: "var(--ds-color-success-text-default)" }}>
|
|
67
|
+
{getLocalizedString("Download started. You can close this dialog.")}
|
|
68
|
+
</Paragraph>
|
|
69
|
+
<Paragraph data-size="sm" style={{ ...subtle, marginTop: "0.5rem" }}>
|
|
70
|
+
{getLocalizedString("If the file did not open automatically, ")}{" "}
|
|
71
|
+
<Link href={`/api/ob/merger/download/${phase.jobId}`} target="_blank" rel="noopener noreferrer">
|
|
72
|
+
{getLocalizedString("click here to open it")}
|
|
73
|
+
</Link>
|
|
74
|
+
.
|
|
75
|
+
</Paragraph>
|
|
76
|
+
</>
|
|
77
|
+
)}
|
|
78
|
+
|
|
79
|
+
{phase.kind === "failed" && (
|
|
80
|
+
<Paragraph data-size="sm" style={{ color: "var(--ds-color-danger-text-default)" }}>
|
|
81
|
+
{phase.error}
|
|
82
|
+
</Paragraph>
|
|
83
|
+
)}
|
|
84
|
+
</Dialog.Block>
|
|
85
|
+
<Dialog.Block style={{ display: "flex", justifyContent: "flex-end" }}>
|
|
86
|
+
<Button variant="tertiary" onClick={handleClose} disabled={!canClose}>
|
|
87
|
+
{getLocalizedString("Close")}
|
|
88
|
+
</Button>
|
|
89
|
+
</Dialog.Block>
|
|
90
|
+
</ResponsiveDialog>
|
|
91
|
+
);
|
|
92
|
+
}
|
|
@@ -1,166 +1,13 @@
|
|
|
1
1
|
import { Box, Button, DialogActions, LinearProgress, Link, Typography } from "@mui/material";
|
|
2
2
|
import { ResponsiveDialog } from "@olenbetong/appframe-mui";
|
|
3
|
-
import { useEffect, useRef, useState } from "react";
|
|
4
3
|
import { getLocalizedString } from "../../i18n.js";
|
|
4
|
+
import { type MergeJobOptions, useMergeJob } from "./useMergeJob.js";
|
|
5
5
|
|
|
6
|
-
export type MergeProgressDialogProps =
|
|
7
|
-
open: boolean;
|
|
8
|
-
onClose: () => void;
|
|
9
|
-
/** Called once when the dialog opens; should return the merger ID for the start route */
|
|
10
|
-
getMergerId: () => Promise<string | number>;
|
|
11
|
-
mergeType?: "pdf" | "zip";
|
|
12
|
-
};
|
|
6
|
+
export type MergeProgressDialogProps = MergeJobOptions;
|
|
13
7
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| { kind: "completed"; jobId: string; fileName: string }
|
|
18
|
-
| { kind: "failed"; error: string };
|
|
19
|
-
|
|
20
|
-
/** Waits between reconnects; together they cover a server restart of about half a minute. */
|
|
21
|
-
const RECONNECT_DELAYS_MS = [1000, 2000, 3000, 5000, 8000, 13000];
|
|
22
|
-
|
|
23
|
-
function formatRemaining(ms: number) {
|
|
24
|
-
if (ms < 60_000) return `~${Math.ceil(ms / 1000)}s`;
|
|
25
|
-
let mins = Math.floor(ms / 60_000);
|
|
26
|
-
let secs = Math.ceil((ms % 60_000) / 1000);
|
|
27
|
-
return secs > 0 ? `~${mins}m ${secs}s` : `~${mins}m`;
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
export function MergeProgressDialog({ open, onClose, getMergerId, mergeType = "pdf" }: MergeProgressDialogProps) {
|
|
31
|
-
let [phase, setPhase] = useState<MergePhase>({ kind: "preparing" });
|
|
32
|
-
let [now, setNow] = useState(Date.now);
|
|
33
|
-
let esRef = useRef<EventSource | null>(null);
|
|
34
|
-
let doneRef = useRef(false);
|
|
35
|
-
|
|
36
|
-
// Tick every second while processing to recompute the time estimate
|
|
37
|
-
useEffect(() => {
|
|
38
|
-
if (phase.kind !== "processing") return;
|
|
39
|
-
let timer = setInterval(() => setNow(Date.now()), 1000);
|
|
40
|
-
return () => clearInterval(timer);
|
|
41
|
-
}, [phase.kind]);
|
|
42
|
-
|
|
43
|
-
// Start the merge job each time the dialog opens
|
|
44
|
-
// oxlint-disable-next-line react-hooks/exhaustive-deps -- intentionally only re-runs on open change
|
|
45
|
-
useEffect(() => {
|
|
46
|
-
if (!open) return;
|
|
47
|
-
|
|
48
|
-
setPhase({ kind: "preparing" });
|
|
49
|
-
doneRef.current = false;
|
|
50
|
-
|
|
51
|
-
let cancelled = false;
|
|
52
|
-
let es: EventSource | null = null;
|
|
53
|
-
let retryTimer: ReturnType<typeof setTimeout> | undefined;
|
|
54
|
-
|
|
55
|
-
async function start() {
|
|
56
|
-
try {
|
|
57
|
-
let mergerId = await getMergerId();
|
|
58
|
-
if (cancelled) return;
|
|
59
|
-
|
|
60
|
-
let response = await fetch(`/api/ob/merger/start/${mergerId}/${mergeType}`, { method: "POST" });
|
|
61
|
-
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);
|
|
62
|
-
let { jobId } = await response.json();
|
|
63
|
-
if (cancelled) return;
|
|
64
|
-
|
|
65
|
-
// The server keeps a job's state on disk and runs it again when the process running it
|
|
66
|
-
// goes away (a deploy or an app pool recycle), so a dropped connection is retried with
|
|
67
|
-
// a backoff before the merge is reported as failed. EventSource only reconnects by
|
|
68
|
-
// itself after a clean drop, not after the 502/503 a restarting server answers with.
|
|
69
|
-
let attempt = 0;
|
|
70
|
-
|
|
71
|
-
function connect() {
|
|
72
|
-
es = new EventSource(`/api/ob/merger/events/${jobId}`);
|
|
73
|
-
esRef.current = es;
|
|
74
|
-
|
|
75
|
-
es.addEventListener("progress", (e) => {
|
|
76
|
-
attempt = 0;
|
|
77
|
-
let d = JSON.parse((e as MessageEvent).data);
|
|
78
|
-
setPhase((prev) => ({
|
|
79
|
-
kind: "processing",
|
|
80
|
-
completed: d.completed,
|
|
81
|
-
total: d.total,
|
|
82
|
-
currentFile: d.currentFile ?? "",
|
|
83
|
-
startedAt: prev.kind === "processing" ? prev.startedAt : Date.now(),
|
|
84
|
-
}));
|
|
85
|
-
setNow(Date.now());
|
|
86
|
-
});
|
|
87
|
-
|
|
88
|
-
es.addEventListener("done", (e) => {
|
|
89
|
-
doneRef.current = true;
|
|
90
|
-
es?.close();
|
|
91
|
-
let d = JSON.parse((e as MessageEvent).data);
|
|
92
|
-
setPhase({ kind: "completed", jobId, fileName: d.fileName ?? "" });
|
|
93
|
-
window.open(`/api/ob/merger/download/${jobId}`);
|
|
94
|
-
});
|
|
95
|
-
|
|
96
|
-
// Catches both server-sent "event: error" (with data) and connection errors.
|
|
97
|
-
// After a "done" event the server closes the stream, which also fires error —
|
|
98
|
-
// doneRef guards against treating that as a failure.
|
|
99
|
-
es.addEventListener("error", (e) => {
|
|
100
|
-
if (doneRef.current) return;
|
|
101
|
-
es?.close();
|
|
102
|
-
let data = (e as MessageEvent).data;
|
|
103
|
-
if (!data && attempt < RECONNECT_DELAYS_MS.length) {
|
|
104
|
-
retryTimer = setTimeout(() => {
|
|
105
|
-
if (!cancelled && !doneRef.current) connect();
|
|
106
|
-
}, RECONNECT_DELAYS_MS[attempt++]);
|
|
107
|
-
return;
|
|
108
|
-
}
|
|
109
|
-
let message = getLocalizedString("Unknown error");
|
|
110
|
-
if (data) {
|
|
111
|
-
try {
|
|
112
|
-
message = JSON.parse(data).message ?? message;
|
|
113
|
-
} catch {}
|
|
114
|
-
}
|
|
115
|
-
setPhase({ kind: "failed", error: message });
|
|
116
|
-
});
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
connect();
|
|
120
|
-
} catch (err: unknown) {
|
|
121
|
-
if (!cancelled) {
|
|
122
|
-
setPhase({ kind: "failed", error: (err as Error)?.message ?? String(err) });
|
|
123
|
-
}
|
|
124
|
-
}
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
start();
|
|
128
|
-
|
|
129
|
-
return () => {
|
|
130
|
-
cancelled = true;
|
|
131
|
-
clearTimeout(retryTimer);
|
|
132
|
-
es?.close();
|
|
133
|
-
esRef.current = null;
|
|
134
|
-
};
|
|
135
|
-
}, [open]);
|
|
136
|
-
|
|
137
|
-
function handleClose() {
|
|
138
|
-
esRef.current?.close();
|
|
139
|
-
esRef.current = null;
|
|
140
|
-
onClose();
|
|
141
|
-
}
|
|
142
|
-
|
|
143
|
-
let pct = 0;
|
|
144
|
-
let remaining: string | null = null;
|
|
145
|
-
|
|
146
|
-
if (phase.kind === "processing" && phase.total > 0) {
|
|
147
|
-
pct = Math.round((phase.completed / phase.total) * 100);
|
|
148
|
-
if (phase.completed > 0) {
|
|
149
|
-
let elapsed = now - phase.startedAt;
|
|
150
|
-
let msPerFile = elapsed / phase.completed;
|
|
151
|
-
let remainingMs = msPerFile * (phase.total - phase.completed);
|
|
152
|
-
remaining = formatRemaining(remainingMs);
|
|
153
|
-
}
|
|
154
|
-
}
|
|
155
|
-
|
|
156
|
-
let title =
|
|
157
|
-
phase.kind === "completed"
|
|
158
|
-
? getLocalizedString("Merge complete")
|
|
159
|
-
: phase.kind === "failed"
|
|
160
|
-
? getLocalizedString("Merge failed")
|
|
161
|
-
: getLocalizedString("Merging drawings");
|
|
162
|
-
|
|
163
|
-
let canClose = phase.kind === "completed" || phase.kind === "failed";
|
|
8
|
+
export function MergeProgressDialog(props: MergeProgressDialogProps) {
|
|
9
|
+
let { phase, pct, remaining, title, canClose, handleClose } = useMergeJob(props);
|
|
10
|
+
let { open } = props;
|
|
164
11
|
|
|
165
12
|
return (
|
|
166
13
|
<ResponsiveDialog
|