@prosopo/procaptcha-common 2.11.16 → 2.11.18

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prosopo/procaptcha-common",
-	"version": "2.11.16",
+	"version": "2.11.18",
 	"author": "PROSOPO LIMITED <info@prosopo.io>",
 	"license": "Apache-2.0",
 	"main": "dist/index.js",
@@ -34,20 +34,20 @@
 	"dependencies": {
 		"@emotion/react": "11.11.1",
 		"@emotion/styled": "11.11.0",
-		"@prosopo/account": "2.8.62",
-		"@prosopo/load-balancer": "2.10.14",
-		"@prosopo/types": "4.9.11",
+		"@prosopo/account": "2.8.64",
+		"@prosopo/load-balancer": "2.10.16",
+		"@prosopo/types": "4.10.0",
 		"@prosopo/widget-skeleton": "2.8.4",
 		"react": "18.3.1",
 		"react-dom": "18.3.1"
 	},
 	"devDependencies": {
-		"@prosopo/config": "3.3.4",
+		"@prosopo/config": "3.3.5",
 		"@types/jsdom": "21.1.7",
 		"@types/node": "22.10.2",
 		"@types/react": "18.3.1",
 		"@types/react-dom": "18.3.1",
-		"@vitest/coverage-v8": "3.2.4",
+		"@vitest/coverage-v8": "4.1.10",
 		"concurrently": "9.0.1",
 		"del-cli": "6.0.0",
 		"dotenv": "16.4.5",
@@ -56,8 +56,8 @@
 		"tslib": "2.7.0",
 		"tsx": "4.20.3",
 		"typescript": "5.6.2",
-		"vite": "6.4.1",
-		"vitest": "3.2.4"
+		"vite": "8.1.5",
+		"vitest": "4.1.10"
 	},
 	"repository": {
 		"type": "git",

package/src/index.ts

@@ -17,6 +17,7 @@ export * from "./state/builder.js";
 export * from "./callbacks/defaultCallbacks.js";
 export * from "./callbacks/defaultEvents.js";
 export * from "./extensionLoader.js";
+export * from "./simdReadings.js";
 export * from "./elements/window.js";
 export * from "./reactComponents/Reload.js";
 export * from "./reactComponents/Checkbox.js";

package/src/simdReadings.ts

@@ -0,0 +1,45 @@
+// Copyright 2021-2026 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+export const SIMD_READINGS_SUBMIT_TIMEOUT_MS = 5000;
+
+export interface SimdReadingsSource {
+	getSimdReadings?: (timeoutMs?: number) => Promise<string | undefined>;
+}
+
+export const getSimdReadingsForSubmit = async (
+	source: SimdReadingsSource | undefined,
+	timeoutMs: number = SIMD_READINGS_SUBMIT_TIMEOUT_MS,
+): Promise<string | undefined> => {
+	if (!source?.getSimdReadings) return undefined;
+	const { getSimdReadings } = source;
+
+	let readings: Promise<string | undefined>;
+	try {
+		readings = Promise.resolve(getSimdReadings.call(source, timeoutMs));
+	} catch {
+		return undefined;
+	}
+
+	let timeoutId: ReturnType<typeof setTimeout> | undefined;
+	const timeout = new Promise<undefined>((resolve) => {
+		timeoutId = setTimeout(() => resolve(undefined), timeoutMs);
+	});
+
+	try {
+		return await Promise.race([readings.catch(() => undefined), timeout]);
+	} finally {
+		if (timeoutId !== undefined) clearTimeout(timeoutId);
+	}
+};

package/src/tests/simdReadings.test.ts

@@ -0,0 +1,149 @@
+// Copyright 2021-2026 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { afterEach, describe, expect, it, vi } from "vitest";
+import {
+	SIMD_READINGS_SUBMIT_TIMEOUT_MS,
+	type SimdReadingsSource,
+	getSimdReadingsForSubmit,
+} from "../simdReadings.js";
+
+afterEach(() => {
+	vi.useRealTimers();
+	vi.restoreAllMocks();
+});
+
+describe("getSimdReadingsForSubmit", () => {
+	it("blocks on the readings and returns them", async () => {
+		const getSimdReadings = vi.fn<
+			(timeoutMs?: number) => Promise<string | undefined>
+		>(async () => "ENCODED_SIMD");
+		const source: SimdReadingsSource = { getSimdReadings };
+
+		await expect(getSimdReadingsForSubmit(source)).resolves.toBe(
+			"ENCODED_SIMD",
+		);
+	});
+
+	it("passes the submit timeout budget down to the detector", async () => {
+		const getSimdReadings = vi.fn<
+			(timeoutMs?: number) => Promise<string | undefined>
+		>(async () => "ENCODED_SIMD");
+
+		await getSimdReadingsForSubmit({ getSimdReadings });
+
+		expect(getSimdReadings).toHaveBeenCalledWith(
+			SIMD_READINGS_SUBMIT_TIMEOUT_MS,
+		);
+		expect(SIMD_READINGS_SUBMIT_TIMEOUT_MS).toBe(5000);
+	});
+
+	it("waits for slow readings that still land inside the budget", async () => {
+		vi.useFakeTimers();
+		const getSimdReadings = vi.fn<
+			(timeoutMs?: number) => Promise<string | undefined>
+		>(
+			() =>
+				new Promise<string>((resolve) => {
+					setTimeout(() => resolve("LATE_SIMD"), 4000);
+				}),
+		);
+
+		const pending = getSimdReadingsForSubmit({ getSimdReadings });
+		await vi.advanceTimersByTimeAsync(4000);
+
+		await expect(pending).resolves.toBe("LATE_SIMD");
+	});
+
+	it("gives up at the timeout when the detector never resolves", async () => {
+		vi.useFakeTimers();
+		const getSimdReadings = vi.fn<
+			(timeoutMs?: number) => Promise<string | undefined>
+		>(() => new Promise<string>(() => undefined));
+
+		const pending = getSimdReadingsForSubmit({ getSimdReadings });
+		await vi.advanceTimersByTimeAsync(SIMD_READINGS_SUBMIT_TIMEOUT_MS);
+
+		await expect(pending).resolves.toBeUndefined();
+	});
+
+	it("honours an explicit timeout override", async () => {
+		vi.useFakeTimers();
+		const getSimdReadings = vi.fn<
+			(timeoutMs?: number) => Promise<string | undefined>
+		>(() => new Promise<string>(() => undefined));
+
+		const pending = getSimdReadingsForSubmit({ getSimdReadings }, 100);
+		await vi.advanceTimersByTimeAsync(100);
+
+		await expect(pending).resolves.toBeUndefined();
+		expect(getSimdReadings).toHaveBeenCalledWith(100);
+	});
+
+	it("resolves undefined when the readings promise rejects", async () => {
+		const getSimdReadings = vi.fn<
+			(timeoutMs?: number) => Promise<string | undefined>
+		>(async () => {
+			throw new Error("benchmark failed");
+		});
+
+		await expect(
+			getSimdReadingsForSubmit({ getSimdReadings }),
+		).resolves.toBeUndefined();
+	});
+
+	it("resolves undefined when the accessor throws synchronously", async () => {
+		const getSimdReadings = vi.fn<
+			(timeoutMs?: number) => Promise<string | undefined>
+		>(() => {
+			throw new Error("detector exploded");
+		});
+
+		await expect(
+			getSimdReadingsForSubmit({ getSimdReadings }),
+		).resolves.toBeUndefined();
+	});
+
+	it("resolves undefined without a source or accessor", async () => {
+		await expect(getSimdReadingsForSubmit(undefined)).resolves.toBeUndefined();
+		await expect(getSimdReadingsForSubmit({})).resolves.toBeUndefined();
+	});
+
+	it("calls the accessor with the source as `this`", async () => {
+		// The detector ships prebuilt; its accessor may be a method relying on
+		// its own receiver, so it must not be invoked detached.
+		const source = {
+			marker: "SIMD_FROM_THIS",
+			getSimdReadings(this: { marker: string }): Promise<string | undefined> {
+				return Promise.resolve(this.marker);
+			},
+		};
+
+		await expect(getSimdReadingsForSubmit(source)).resolves.toBe(
+			"SIMD_FROM_THIS",
+		);
+	});
+
+	it("clears the timeout timer once readings arrive", async () => {
+		vi.useFakeTimers();
+		const clearTimeoutSpy = vi.spyOn(globalThis, "clearTimeout");
+		const getSimdReadings = vi.fn<
+			(timeoutMs?: number) => Promise<string | undefined>
+		>(async () => "ENCODED_SIMD");
+
+		await getSimdReadingsForSubmit({ getSimdReadings });
+
+		expect(clearTimeoutSpy).toHaveBeenCalled();
+	});
+});