feat(dictation): add persistent language selection in General settings
This commit is contained in:
Bartosz Chronowki
@@ -0,0 +1,309 @@
|
||||
import React, { act } from "react";
|
||||
import assert from "node:assert/strict";
|
||||
import { afterEach, test } from "node:test";
|
||||
import { parseHTML } from "linkedom";
|
||||
import { useDictation, type Dictation } from "../components/dictation.tsx";
|
||||
import { notifySettingsSaved } from "../components/settings-signal.ts";
|
||||
import { useDictationLanguage } from "../components/dictation-preference.ts";
|
||||
import { isDictationActive, useDictationActive } from "../components/dictation-state.ts";
|
||||
import type { UserSettings } from "../src/core/index.ts";
|
||||
|
||||
function deferred<T>() {
|
||||
let resolve!: (value: T) => void;
|
||||
const promise = new Promise<T>((done) => { resolve = done; });
|
||||
return { promise, resolve };
|
||||
}
|
||||
|
||||
class Socket extends EventTarget {
|
||||
static CONNECTING = 0;
|
||||
static OPEN = 1;
|
||||
static all: Socket[] = [];
|
||||
readyState = Socket.CONNECTING;
|
||||
sent: unknown[] = [];
|
||||
constructor(readonly url: string, readonly protocols: string[]) { super(); Socket.all.push(this); }
|
||||
get language() { return new URL(this.url).searchParams.get("language"); }
|
||||
send(data: unknown) { this.sent.push(data); }
|
||||
close() { this.readyState = 3; }
|
||||
open() { this.readyState = Socket.OPEN; this.dispatchEvent(new Event("open")); }
|
||||
end(code = 1000) { this.close(); this.dispatchEvent(Object.assign(new Event("close"), { code })); }
|
||||
final(text: string) {
|
||||
this.dispatchEvent(Object.assign(new Event("message"), {
|
||||
data: JSON.stringify({ type: "Results", is_final: true, channel: { alternatives: [{ transcript: text }] } }),
|
||||
}));
|
||||
}
|
||||
}
|
||||
|
||||
class AudioGraph {
|
||||
state = "running";
|
||||
destination = {};
|
||||
audioWorklet = { addModule: async () => {} };
|
||||
createMediaStreamSource() { return { connect() {}, disconnect() {} }; }
|
||||
}
|
||||
class Worklet { port = {}; connect() {} disconnect() {} }
|
||||
|
||||
const globals = globalThis as Record<string, unknown>;
|
||||
let restore: (() => void) | undefined;
|
||||
let dispose: (() => Promise<void>) | undefined;
|
||||
|
||||
async function fixture(language: "pl" | "en" = "pl", delayedRead?: Promise<Response>) {
|
||||
const dom = parseHTML("<html><body><div id='root'></div></body></html>");
|
||||
const state = {
|
||||
record: { version: 1, dictation: { language } } as UserSettings,
|
||||
nextRead: delayedRead,
|
||||
nextWrite: undefined as Promise<Response> | undefined,
|
||||
nextMic: undefined as Promise<{ getTracks: () => { stop: () => void }[] }> | undefined,
|
||||
readFails: false,
|
||||
active: false,
|
||||
captures: 0,
|
||||
stops: 0,
|
||||
appends: [] as string[],
|
||||
};
|
||||
Socket.all = [];
|
||||
const previous = new Map<string, PropertyDescriptor | undefined>();
|
||||
for (const [key, value] of Object.entries({
|
||||
React, window: dom.window, document: dom.document, CustomEvent: dom.window.CustomEvent,
|
||||
navigator: { userAgent: "", platform: "", mediaDevices: { getUserMedia: async () => {
|
||||
state.captures++;
|
||||
if (state.nextMic) return state.nextMic;
|
||||
return { getTracks: () => [{ stop() { state.stops++; } }] };
|
||||
} } },
|
||||
WebSocket: Socket, AudioContext: AudioGraph, AudioWorkletNode: Worklet,
|
||||
IS_REACT_ACT_ENVIRONMENT: true,
|
||||
fetch: async (url: string, init?: RequestInit) => {
|
||||
if (url === "/api/stt/token") return Response.json({ token: "test-token" });
|
||||
if (url === "/api/settings") {
|
||||
if (state.nextRead) { const response = state.nextRead; state.nextRead = undefined; return response; }
|
||||
return state.readFails ? Response.json({}, { status: 500 }) : Response.json({ settings: state.record });
|
||||
}
|
||||
assert.equal(url, "/api/settings/dictation");
|
||||
assert.equal(init?.method, "PUT");
|
||||
if (state.nextWrite) { const response = state.nextWrite; state.nextWrite = undefined; return response; }
|
||||
state.record = { ...state.record, dictation: JSON.parse(init.body as string) };
|
||||
return Response.json({ settings: state.record });
|
||||
},
|
||||
})) {
|
||||
previous.set(key, Object.getOwnPropertyDescriptor(globalThis, key));
|
||||
Object.defineProperty(globalThis, key, { configurable: true, writable: true, value });
|
||||
}
|
||||
restore = () => {
|
||||
for (const [key, descriptor] of previous) {
|
||||
if (descriptor) Object.defineProperty(globalThis, key, descriptor);
|
||||
else delete globals[key];
|
||||
}
|
||||
};
|
||||
const { createRoot } = await import("react-dom/client");
|
||||
let latest!: Dictation;
|
||||
let setting!: ReturnType<typeof useDictationLanguage>;
|
||||
function Harness() {
|
||||
latest = useDictation({ append: (text) => state.appends.push(text) });
|
||||
setting = useDictationLanguage();
|
||||
state.active = useDictationActive();
|
||||
return null;
|
||||
}
|
||||
let root = createRoot(document.getElementById("root")!);
|
||||
const mount = async () => { await act(async () => { root.render(<Harness />); }); };
|
||||
dispose = async () => { await act(async () => { root.unmount(); }); };
|
||||
return {
|
||||
state,
|
||||
get dictation() { return latest; },
|
||||
get setting() { return setting; },
|
||||
mount,
|
||||
unmount: () => dispose!(),
|
||||
remount: async () => {
|
||||
await dispose!();
|
||||
root = createRoot(document.getElementById("root")!);
|
||||
await mount();
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
afterEach(async () => { await dispose?.(); restore?.(); dispose = undefined; restore = undefined; });
|
||||
|
||||
test("waits for the saved language; reconnect preserves it and finals still flush exactly once", async () => {
|
||||
const read = deferred<Response>();
|
||||
const f = await fixture("pl", read.promise);
|
||||
await f.mount();
|
||||
await act(async () => { f.dictation.toggle(); });
|
||||
assert.equal(f.dictation.phase, "connecting");
|
||||
assert.equal(f.state.active, true, "the settings row locks while connecting");
|
||||
assert.equal(f.state.captures, 0);
|
||||
assert.equal(Socket.all.length, 0, "must not open a default-English socket before settings arrive");
|
||||
await act(async () => { read.resolve(Response.json({ settings: f.state.record })); });
|
||||
const first = Socket.all[0]!;
|
||||
assert.equal(first.language, "pl");
|
||||
await act(async () => { first.open(); first.final("Cześć"); });
|
||||
assert.deepEqual(f.state.appends, []);
|
||||
// A preference refresh during capture affects the next run only.
|
||||
f.state.record.dictation = { language: "multi" };
|
||||
await act(async () => { notifySettingsSaved("dictation"); });
|
||||
await act(async () => { first.end(1006); });
|
||||
const second = Socket.all[1]!;
|
||||
assert.equal(second.language, "pl");
|
||||
assert.deepEqual(second.protocols, ["bearer", "test-token"]);
|
||||
await act(async () => { second.open(); second.final("świecie"); });
|
||||
await act(async () => { f.dictation.stop(); });
|
||||
assert.equal(f.dictation.phase, "stopping");
|
||||
assert.equal(f.state.active, true, "the settings row remains locked while stopping");
|
||||
assert.equal(second.sent.at(-1), JSON.stringify({ type: "CloseStream" }));
|
||||
await act(async () => { second.end(); });
|
||||
assert.deepEqual(f.state.appends, ["Cześć świecie"]);
|
||||
assert.equal(f.dictation.phase, "idle");
|
||||
assert.equal(f.state.active, false);
|
||||
await act(async () => { f.dictation.toggle(); });
|
||||
assert.equal(Socket.all[2]!.language, "multi");
|
||||
});
|
||||
|
||||
test("a failed save keeps the previous language, including a shortcut pressed while saving", async () => {
|
||||
const f = await fixture();
|
||||
await f.mount();
|
||||
const write = deferred<Response>();
|
||||
f.state.nextWrite = write.promise;
|
||||
let saved!: Promise<boolean>;
|
||||
await act(async () => { saved = f.setting.save("multi"); });
|
||||
assert.equal(f.setting.saving, true);
|
||||
await act(async () => { f.dictation.toggle(); });
|
||||
assert.equal(f.state.captures, 0);
|
||||
await act(async () => { write.resolve(Response.json({}, { status: 500 })); await saved; });
|
||||
assert.equal(await saved, false);
|
||||
assert.equal(f.setting.language, "pl");
|
||||
assert.match(f.setting.error!, /Could not save/);
|
||||
assert.equal(Socket.all[0]!.language, "pl");
|
||||
});
|
||||
|
||||
test("successful choices survive unmount/remount and failed reads never start capture", async () => {
|
||||
const f = await fixture();
|
||||
await f.mount();
|
||||
await act(async () => { assert.equal(await f.setting.save("multi"), true); });
|
||||
await f.remount();
|
||||
assert.equal(f.setting.language, "multi");
|
||||
f.state.readFails = true;
|
||||
await f.remount();
|
||||
await act(async () => { f.dictation.toggle(); });
|
||||
assert.match(f.dictation.error!, /Could not load/);
|
||||
assert.equal(f.state.captures, 0);
|
||||
assert.equal(Socket.all.length, 0);
|
||||
f.state.readFails = false;
|
||||
await act(async () => { f.dictation.toggle(); });
|
||||
assert.equal(Socket.all[0]!.language, "multi");
|
||||
});
|
||||
|
||||
test("a shortcut waits for a language save made by the separate settings control", async () => {
|
||||
const f = await fixture();
|
||||
await f.mount();
|
||||
const write = deferred<Response>();
|
||||
f.state.nextWrite = write.promise;
|
||||
let saved!: Promise<boolean>;
|
||||
await act(async () => { saved = f.setting.save("multi"); });
|
||||
await act(async () => { f.dictation.toggle(); });
|
||||
assert.equal(f.state.captures, 0);
|
||||
f.state.record.dictation = { language: "multi" };
|
||||
await act(async () => { write.resolve(Response.json({ settings: f.state.record })); await saved; });
|
||||
assert.equal(Socket.all[0]!.language, "multi");
|
||||
});
|
||||
|
||||
test("a saved-language refresh gates capture even when an older choice is cached", async () => {
|
||||
const f = await fixture();
|
||||
await f.mount();
|
||||
const read = deferred<Response>();
|
||||
f.state.nextRead = read.promise;
|
||||
f.state.record.dictation = { language: "multi" };
|
||||
await act(async () => { notifySettingsSaved("dictation"); });
|
||||
await act(async () => { f.dictation.toggle(); });
|
||||
assert.equal(f.state.captures, 0);
|
||||
assert.equal(Socket.all.length, 0);
|
||||
await act(async () => { read.resolve(Response.json({ settings: f.state.record })); });
|
||||
assert.equal(Socket.all[0]!.language, "multi");
|
||||
});
|
||||
|
||||
test("a stale settings refresh cannot overwrite a newer confirmed choice", async () => {
|
||||
const f = await fixture();
|
||||
await f.mount();
|
||||
const read = deferred<Response>();
|
||||
f.state.nextRead = read.promise;
|
||||
await act(async () => { notifySettingsSaved("dictation"); });
|
||||
await act(async () => { await f.setting.save("multi"); });
|
||||
await act(async () => { read.resolve(Response.json({ settings: { version: 1, dictation: { language: "pl" } } })); });
|
||||
assert.equal(f.setting.language, "multi");
|
||||
await act(async () => { f.dictation.toggle(); });
|
||||
assert.equal(Socket.all[0]!.language, "multi");
|
||||
});
|
||||
|
||||
test("cancel while settings load does not open a microphone or socket later", async () => {
|
||||
const read = deferred<Response>();
|
||||
const f = await fixture("pl", read.promise);
|
||||
await f.mount();
|
||||
await act(async () => { f.dictation.toggle(); });
|
||||
await act(async () => { f.dictation.cancel(); });
|
||||
await act(async () => { read.resolve(Response.json({ settings: f.state.record })); });
|
||||
assert.equal(f.dictation.phase, "idle");
|
||||
assert.equal(f.state.captures, 0);
|
||||
assert.equal(Socket.all.length, 0);
|
||||
});
|
||||
|
||||
test("reopening settings during a save shares its busy state and rejects a competing selection", async () => {
|
||||
const f = await fixture();
|
||||
await f.mount();
|
||||
const write = deferred<Response>();
|
||||
f.state.nextWrite = write.promise;
|
||||
let first!: Promise<boolean>;
|
||||
await act(async () => { first = f.setting.save("multi"); });
|
||||
await f.remount();
|
||||
assert.equal(f.setting.saving, true);
|
||||
assert.equal(await f.setting.save("en"), false, "a different selection cannot inherit another write's success");
|
||||
f.state.record.dictation = { language: "multi" };
|
||||
await act(async () => { write.resolve(Response.json({ settings: f.state.record })); await first; });
|
||||
assert.equal(f.setting.saving, false);
|
||||
assert.equal(f.setting.language, "multi");
|
||||
});
|
||||
|
||||
test("a confirmed save applies to capture even when subsequent settings GET requests would fail", async () => {
|
||||
const f = await fixture();
|
||||
await f.mount();
|
||||
f.state.readFails = true;
|
||||
await act(async () => { assert.equal(await f.setting.save("multi"), true); });
|
||||
assert.equal(f.state.record.dictation?.language, "multi");
|
||||
await act(async () => { f.dictation.toggle(); });
|
||||
assert.equal(Socket.all[0]!.language, "multi");
|
||||
});
|
||||
|
||||
test("unmount during a pending language read prevents orphaned capture", async () => {
|
||||
const read = deferred<Response>();
|
||||
const f = await fixture("pl", read.promise);
|
||||
await f.mount();
|
||||
await act(async () => { f.dictation.toggle(); });
|
||||
await f.unmount();
|
||||
await act(async () => { read.resolve(Response.json({ settings: f.state.record })); });
|
||||
assert.equal(f.state.captures, 0);
|
||||
assert.equal(Socket.all.length, 0);
|
||||
assert.equal(isDictationActive(), false);
|
||||
});
|
||||
|
||||
test("unmount during recording stops resources and discards the departing page's buffered text", async () => {
|
||||
const f = await fixture();
|
||||
await f.mount();
|
||||
await act(async () => { f.dictation.toggle(); });
|
||||
const socket = Socket.all[0]!;
|
||||
await act(async () => { socket.open(); socket.final("do not append into another page"); });
|
||||
await f.unmount();
|
||||
assert.equal(f.state.stops, 1);
|
||||
assert.equal(socket.readyState, 3);
|
||||
assert.equal(isDictationActive(), false);
|
||||
assert.deepEqual(f.state.appends, []);
|
||||
await act(async () => { socket.final("late event"); socket.end(1006); });
|
||||
assert.equal(Socket.all.length, 1);
|
||||
assert.deepEqual(f.state.appends, []);
|
||||
});
|
||||
|
||||
test("microphone permission resolving after unmount immediately stops the late stream", async () => {
|
||||
const f = await fixture();
|
||||
await f.mount();
|
||||
const mic = deferred<{ getTracks: () => { stop: () => void }[] }>();
|
||||
f.state.nextMic = mic.promise;
|
||||
await act(async () => { f.dictation.toggle(); });
|
||||
assert.equal(f.state.captures, 1);
|
||||
await f.unmount();
|
||||
await act(async () => { mic.resolve({ getTracks: () => [{ stop() { f.state.stops++; } }] }); });
|
||||
assert.equal(f.state.stops, 1);
|
||||
assert.equal(Socket.all.length, 0);
|
||||
assert.equal(isDictationActive(), false);
|
||||
});
|
||||
Reference in New Issue
Block a user