@prosopo/load-balancer 2.11.3 → 2.11.5

package/src/tests/productionProviderList.unit.test.ts

@@ -1,267 +0,0 @@
-// 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.
-
-// End-to-end coverage that drives the *real* balancer parsing against the shape
-// served by https://provider-list.prosopo.io/ — dual-stack pronode entries at
-// the top level alongside `ipv4` / `ipv6` single-stack sub-lists. Deliberately
-// does NOT mock `../balancer.js` (unlike providers.unit.test.ts) so the raw JSON
-// flows through convertHostedProvider → loadBalancer → getProviders →
-// getRandomProviderFromList exactly as it does in production, with only
-// `fetch` stubbed.
-
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import {
-	PROVIDER_LIST_FETCH_TIMEOUT_MS,
-	convertHostedProvider,
-	getProviderHostname,
-	loadBalancer,
-} from "../balancer.js";
-import {
-	_resetPinCache,
-	_resetProviderListCache,
-	getRandomProviderFromList,
-} from "../providers.js";
-
-const DATASET_ID =
-	"0x2e52a1e70f0e0c808972bc04e6fbc8f264b1fbb29c94041fdf01a839b000a40e";
-const ADDRESS = "5FnBurrfqWgSLJFMsojjEP74mLX1vZZ9ASyNXKfA5YXu8FR2";
-
-type ProviderEntry = { url: string; datasetId: string; address: string };
-
-const entry = (host: string): ProviderEntry => ({
-	url: `https://${host}.prosopo.io`,
-	datasetId: DATASET_ID,
-	address: ADDRESS,
-});
-
-// A trimmed but faithful copy of the production provider-list JSON: three
-// pronodes, each present in the ipv4 sub-list, the ipv6 sub-list, and the
-// top-level dual-stack list. Note pronode16 sorts before pronode6 and pronode7
-// under a plain string compare ('1' < '6' < '7').
-const productionJson: Record<string, unknown> = {
-	ipv4: {
-		pronode6: entry("ipv4.pronode6"),
-		pronode7: entry("ipv4.pronode7"),
-		pronode16: entry("ipv4.pronode16"),
-	},
-	ipv6: {
-		pronode6: entry("ipv6.pronode6"),
-		pronode7: entry("ipv6.pronode7"),
-		pronode16: entry("ipv6.pronode16"),
-	},
-	pronode6: entry("pronode6"),
-	pronode7: entry("pronode7"),
-	pronode16: entry("pronode16"),
-};
-
-const originalFetch = globalThis.fetch;
-
-const mockFetchReturning = (payload: unknown) => {
-	const mocked = vi.fn(
-		async () => new Response(JSON.stringify(payload), { status: 200 }),
-	);
-	globalThis.fetch = mocked as typeof fetch;
-	return mocked;
-};
-
-beforeEach(() => {
-	_resetPinCache();
-	_resetProviderListCache();
-});
-
-afterEach(() => {
-	globalThis.fetch = originalFetch;
-	vi.restoreAllMocks();
-});
-
-describe("convertHostedProvider (production.json shape)", () => {
-	it("keeps only the dual-stack pronodes and drops the ipv4/ipv6 sub-lists", () => {
-		const providers = convertHostedProvider(productionJson);
-		expect(providers.map((p) => p.url)).toEqual([
-			// sorted by url.localeCompare — pronode16 first ('1' < '6')
-			"https://pronode16.prosopo.io",
-			"https://pronode6.prosopo.io",
-			"https://pronode7.prosopo.io",
-		]);
-		// Every entry defaults to weight 1 and carries the shared dataset/address.
-		for (const provider of providers) {
-			expect(provider.weight).toBe(1);
-			expect(provider.datasetId).toBe(DATASET_ID);
-			expect(provider.address).toBe(ADDRESS);
-			expect(provider.url).not.toMatch(/ipv[46]\./);
-		}
-	});
-
-	it("returns the ipv4 single-stack sub-list when ipMode=ipv4", () => {
-		const providers = convertHostedProvider(productionJson, "ipv4");
-		expect(providers.map((p) => p.url)).toEqual([
-			"https://ipv4.pronode16.prosopo.io",
-			"https://ipv4.pronode6.prosopo.io",
-			"https://ipv4.pronode7.prosopo.io",
-		]);
-		// The label strips back to the bare pronode hostname for identity.
-		expect(providers.map((p) => getProviderHostname(p))).toEqual([
-			"pronode16.prosopo.io",
-			"pronode6.prosopo.io",
-			"pronode7.prosopo.io",
-		]);
-	});
-
-	it("returns the ipv6 single-stack sub-list when ipMode=ipv6", () => {
-		const providers = convertHostedProvider(productionJson, "ipv6");
-		expect(providers.map((p) => p.url)).toEqual([
-			"https://ipv6.pronode16.prosopo.io",
-			"https://ipv6.pronode6.prosopo.io",
-			"https://ipv6.pronode7.prosopo.io",
-		]);
-	});
-});
-
-describe("loadBalancer (production.json shape)", () => {
-	it("fetches the production list and returns the dual-stack pronodes", async () => {
-		const mocked = mockFetchReturning(productionJson);
-		const providers = await loadBalancer("production");
-		expect(mocked).toHaveBeenCalledWith(
-			"https://provider-list.prosopo.io/",
-			expect.objectContaining({ method: "GET" }),
-		);
-		expect(providers.map((p) => p.url)).toEqual([
-			"https://pronode16.prosopo.io",
-			"https://pronode6.prosopo.io",
-			"https://pronode7.prosopo.io",
-		]);
-	});
-});
-
-describe("getRandomProviderFromList (production.json end-to-end)", () => {
-	const dualStackUrls = [
-		"https://pronode16.prosopo.io",
-		"https://pronode6.prosopo.io",
-		"https://pronode7.prosopo.io",
-	];
-
-	it("picks a dual-stack pronode from the fetched production list", async () => {
-		mockFetchReturning(productionJson);
-		const result = await getRandomProviderFromList(
-			"production",
-			undefined,
-			undefined,
-			() => 0,
-		);
-		// random=0 selects the first entry after the url sort.
-		expect(result.provider.url).toBe("https://pronode16.prosopo.io");
-		expect(result.providerAccount).toBe(ADDRESS);
-	});
-
-	it("labels the chosen pronode with ipv4 when ipMode=ipv4", async () => {
-		mockFetchReturning(productionJson);
-		const result = await getRandomProviderFromList(
-			"production",
-			"ipv4",
-			undefined,
-			() => 0,
-		);
-		// Matches the url found under the production `ipv4` sub-list.
-		expect(result.provider.url).toBe("https://ipv4.pronode16.prosopo.io");
-	});
-
-	it("labels the chosen pronode with ipv6 when ipMode=ipv6", async () => {
-		mockFetchReturning(productionJson);
-		const result = await getRandomProviderFromList(
-			"production",
-			"ipv6",
-			undefined,
-			() => 0.99,
-		);
-		// random≈1 selects the last entry (pronode7) after the sort.
-		expect(result.provider.url).toBe("https://ipv6.pronode7.prosopo.io");
-	});
-
-	it("excludes the pronode that just failed and picks a different one", async () => {
-		mockFetchReturning(productionJson);
-		const result = await getRandomProviderFromList(
-			"production",
-			undefined,
-			"https://pronode16.prosopo.io",
-			() => 0,
-		);
-		expect(result.provider.url).not.toBe("https://pronode16.prosopo.io");
-		expect(dualStackUrls).toContain(result.provider.url);
-		// With pronode16 removed the sorted pool starts at pronode6.
-		expect(result.provider.url).toBe("https://pronode6.prosopo.io");
-	});
-
-	it("excludes by ipv4-labelled url, matching what the widget actually used", async () => {
-		mockFetchReturning(productionJson);
-		// The widget's previous attempt used the ipv4-labelled url; exclusion must
-		// still match the underlying pronode so it is dropped from the pool.
-		const result = await getRandomProviderFromList(
-			"production",
-			"ipv4",
-			"https://ipv4.pronode16.prosopo.io",
-			() => 0,
-		);
-		expect(result.provider.url).not.toBe("https://ipv4.pronode16.prosopo.io");
-		expect(result.provider.url).toBe("https://ipv4.pronode6.prosopo.io");
-	});
-
-	it("serves the cached list across repeat selections (one fetch)", async () => {
-		const mocked = mockFetchReturning(productionJson);
-		await getRandomProviderFromList(
-			"production",
-			undefined,
-			undefined,
-			() => 0,
-		);
-		await getRandomProviderFromList("production", "ipv4", undefined, () => 0);
-		await getRandomProviderFromList("production", "ipv6", undefined, () => 0);
-		expect(mocked).toHaveBeenCalledTimes(1);
-	});
-});
-
-describe("loadBalancer provider-list fetch timeout", () => {
-	// A list endpoint that accepts the request and never answers: the fetch
-	// only settles if the caller supplied an abort signal.
-	const stallingFetch = () =>
-		vi.fn(
-			(_input: RequestInfo | URL, init?: RequestInit): Promise<Response> =>
-				new Promise<Response>((_resolve, reject) => {
-					init?.signal?.addEventListener("abort", () =>
-						reject(init.signal?.reason),
-					);
-				}),
-		);
-
-	it("aborts a stalled provider-list fetch after the timeout", async () => {
-		const mocked = stallingFetch();
-		globalThis.fetch = mocked as typeof fetch;
-		const started = Date.now();
-		await expect(
-			loadBalancer("production", undefined, 50),
-		).rejects.toMatchObject({ name: "TimeoutError" });
-		expect(Date.now() - started).toBeLessThan(2_000);
-	});
-
-	it("bounds the fetch by default", async () => {
-		const mocked = vi.fn(
-			async (_input: RequestInfo | URL, _init?: RequestInit) =>
-				new Response(JSON.stringify(productionJson), { status: 200 }),
-		);
-		globalThis.fetch = mocked as typeof fetch;
-		await loadBalancer("production");
-		const init = mocked.mock.calls[0]?.[1];
-		expect(init?.signal).toBeInstanceOf(AbortSignal);
-		expect(PROVIDER_LIST_FETCH_TIMEOUT_MS).toBe(10_000);
-	});
-});

package/src/tests/providerUrlOverride.unit.test.ts

@@ -1,182 +0,0 @@
-// 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 { getProviderListOverride, loadBalancer } from "../balancer.js";
-import { readProviderListOverride } from "../providerUrlOverride.js";
-
-const ENV_KEY = "PROSOPO_PROVIDER_LIST";
-const original: string | undefined = process.env[ENV_KEY];
-const originalFetch = globalThis.fetch;
-
-afterEach(() => {
-	if (original === undefined) delete process.env[ENV_KEY];
-	else process.env[ENV_KEY] = original;
-	globalThis.fetch = originalFetch;
-});
-
-const PROVIDER_LIST_JSON = JSON.stringify({
-	one: {
-		address: "5Provider1",
-		url: "https://one.example.com/",
-		datasetId: "0xabc",
-		weight: 3,
-	},
-	two: {
-		address: "5Provider2",
-		url: "https://two.example.com",
-		datasetId: "0xdef",
-	},
-});
-
-describe("reading the override", () => {
-	it("returns undefined when unset", () => {
-		delete process.env[ENV_KEY];
-		expect(readProviderListOverride()).toBeUndefined();
-	});
-
-	it("returns the raw value when set", () => {
-		process.env[ENV_KEY] = "https://captcha.example.com";
-		expect(readProviderListOverride()).toBe("https://captcha.example.com");
-	});
-});
-
-describe("parsing the override", () => {
-	it("is empty when unset or blank, so normal discovery is untouched", () => {
-		expect(getProviderListOverride(undefined)).toEqual([]);
-		expect(getProviderListOverride("")).toEqual([]);
-		expect(getProviderListOverride("   ")).toEqual([]);
-	});
-
-	it("accepts a single bare url", () => {
-		expect(getProviderListOverride("https://captcha.example.com")).toEqual([
-			{
-				address: "self-hosted",
-				url: "https://captcha.example.com",
-				datasetId: "",
-				weight: 1,
-			},
-		]);
-	});
-
-	it("accepts several comma-separated urls", () => {
-		const providers = getProviderListOverride(
-			"https://one.example.com, https://two.example.com",
-		);
-		expect(providers.map((p) => p.url)).toEqual([
-			"https://one.example.com",
-			"https://two.example.com",
-		]);
-	});
-
-	it("strips trailing slashes from both forms", () => {
-		// A token embeds the provider url it was minted against and the verifier
-		// matches it by exact string, so the two spellings must normalise.
-		expect(
-			getProviderListOverride("https://captcha.example.com/")[0]?.url,
-		).toBe("https://captcha.example.com");
-		const fromJson = getProviderListOverride(PROVIDER_LIST_JSON);
-		expect(fromJson.map((p) => p.url)).toEqual([
-			"https://one.example.com",
-			"https://two.example.com",
-		]);
-	});
-
-	it("accepts the hosted provider-list JSON, preserving address and weight", () => {
-		const providers = getProviderListOverride(PROVIDER_LIST_JSON);
-		expect(providers).toEqual([
-			{
-				address: "5Provider1",
-				url: "https://one.example.com",
-				datasetId: "0xabc",
-				weight: 3,
-			},
-			{
-				address: "5Provider2",
-				url: "https://two.example.com",
-				datasetId: "0xdef",
-				weight: 1,
-			},
-		]);
-	});
-
-	it("reads the ipv4 / ipv6 sub-lists when the JSON carries them", () => {
-		const raw = JSON.stringify({
-			dual: {
-				address: "5Dual",
-				url: "https://dual.example.com",
-				datasetId: "0x1",
-			},
-			ipv4: {
-				four: {
-					address: "5Four",
-					url: "https://v4.example.com",
-					datasetId: "0x2",
-				},
-			},
-		});
-		expect(getProviderListOverride(raw, "ipv4").map((p) => p.url)).toEqual([
-			"https://v4.example.com",
-		]);
-		expect(getProviderListOverride(raw).map((p) => p.url)).toEqual([
-			"https://dual.example.com",
-		]);
-	});
-
-	it("falls back to normal discovery rather than throwing on malformed JSON", () => {
-		// A deployment-time typo must not take down every captcha on the page.
-		expect(getProviderListOverride("{not json")).toEqual([]);
-		expect(
-			getProviderListOverride('{"one":{"url":"missing-other-fields"}}'),
-		).toEqual([]);
-	});
-});
-
-describe("loadBalancer with an override", () => {
-	it("returns the override without fetching the hosted list", async () => {
-		process.env[ENV_KEY] = "https://captcha.example.com/";
-		const fetchSpy = vi.fn();
-		// biome-ignore lint/suspicious/noExplicitAny: asserting the fetch never happens
-		globalThis.fetch = fetchSpy as any;
-
-		await expect(loadBalancer("production")).resolves.toEqual([
-			{
-				address: "self-hosted",
-				url: "https://captcha.example.com",
-				datasetId: "",
-				weight: 1,
-			},
-		]);
-		expect(fetchSpy).not.toHaveBeenCalled();
-	});
-
-	it("applies in every environment, not just development", async () => {
-		process.env[ENV_KEY] = "https://captcha.example.com";
-		for (const env of ["development", "staging", "production"] as const) {
-			const providers = await loadBalancer(env);
-			expect(providers.map((p) => p.url)).toEqual([
-				"https://captcha.example.com",
-			]);
-		}
-	});
-
-	it("does not prefix ipv4/ipv6 labels onto a bare-url override", async () => {
-		// Those labels only resolve inside our own fleet's DNS.
-		process.env[ENV_KEY] = "https://captcha.example.com";
-		const providers = await loadBalancer("production", "ipv4");
-		expect(providers.map((p) => p.url)).toEqual([
-			"https://captcha.example.com",
-		]);
-	});
-});