Files
OmniRoute/tests/unit/chatgpt-web-runtime-block.test.ts
Diego Rodrigues de Sa e Souza 7d57d9f4a1 fix(providers): retire common ChatGPT Web provider (#11754)
Rebased onto the current release/v3.8.51 tip as part of a combined provider-retirement/provenance merge batch (Designer Web, Felo Web, Runtime, GPL-derived removal, Qwen Web already landed). Large conflict set (this is the biggest PR in the batch — the common ChatGPT Web provider touches chat, images, count-tokens, session leases, and combos). Conflicts resolved:

- `open-sse/config/providers/registry/chatgpt-web/*`, `open-sse/executors/chatgpt-web*`, `open-sse/handlers/imageGeneration/providers/chatgptWeb.ts`, and their tests: kept deleted, matching the PR's stated scope.
- `open-sse/config/providers/registry/minimax/web/index.ts`, `open-sse/handlers/imageGeneration/providers/geminiWeb.ts`, `open-sse/executors/gemini-web.ts`'s stale image-mode branch: base-drift collisions against already-merged sibling retirements (#11691, #11708) — kept deleted / dropped the dead code, since this PR's own branch forked before those merged.
- `src/shared/constants/reservedProviderPrefixes.ts`, `open-sse/executors/index.ts`, `executorProxy.ts`, `virtualFactory.ts`, `autoStrategy.ts`, `src/lib/db/providers.ts`, `src/sse/handlers/chat.ts`: combined the Designer + Runtime (Felo/Qwen) + common-ChatGPT-Web retirement guard calls at each shared chokepoint — compute-once-then-OR pattern, consistent with prior combinations in this batch.
- `src/sse/services/model.ts` / `src/sse/handlers/chatHelpers.ts`: adopted this PR's new `getModelInfoOrRetirementResponse()` central wrapper (a real improvement over ad-hoc try/catch), and extended it to also catch the Designer + Runtime retirement errors it didn't originally cover, so the consolidation doesn't regress the other two mechanisms.
- `src/app/api/v1/images/edits/route.ts`: this PR moved the retirement check earlier (before `enforceApiKeyPolicy`) but left the old later call+catch block in place from base drift — removed the now-redundant duplicate `resolveImageRouteModel()` call and merged the Designer catch into the earlier one.
- `open-sse/config/imageRegistry.ts`, `tests/snapshots/executors/executor-map.json` (`keyCount` recomputed to 133), `tests/snapshots/provider/translate-path.json`: same "both sides inserted a different retired provider at the same slot" pattern — resolved by dropping both.
- `tests/unit/chatcore-executor-proxy.test.ts`, `provider-node-reserved-prefix.test.ts`, `combo-auto-candidate-expansion.test.ts`, `messages-count-tokens-route.test.ts`, `virtual-auto-combo.test.ts`: split into independent per-mechanism test blocks (established pattern); `virtual-auto-combo.test.ts`'s old "includes cookie web-session providers" positive-inclusion test (which used chatgpt-web as its example) was retired along with the provider and replaced by this PR's negative-exclusion test for the same slot.
- `docs/architecture/ARCHITECTURE.md`, `CODEBASE_DOCUMENTATION.md` (+ 4 i18n mirrors), `README.md`, `FREE-TIERS-GUIDE.md`, `docs/diagrams/free-tier-budget.svg`, `docs/screenshots/free-tier-budget-card.svg`, `docs/reference/PROVIDER_REFERENCE.md`: recomputed every stale count from the real merged state — 104 executors (`countFiles` gate logic), 351 providers (regenerated via `gen:provider-reference`), 152/351 `hasFree` entries, 445/438/7 free-tier catalog rows, 13 ToS-avoid providers, budget-card regenerated via its real generator script. One doc conflict (`oauth/` module list) needed picking HEAD's side specifically — theirs still listed the already-removed `raycast` module instead of the real `openference`.
- `config/quality/test-masking-allowlist.json`: additive merge of the PR's 17 `_deletedWithReplacement` entries alongside the batch's existing ones (one real duplicate-key mistake in my first pass, caught and fixed via a `object_pairs_hook` duplicate-key check before finalizing).

Also fixed two real, unrelated-to-my-merge issues surfaced by the focused suite:
- `tests/unit/resolve-web-provider-host.test.ts`: the PR's own test had a typo — it asserted `perplexity-web`'s resolved host as `"perplexity.ai"`, but the provider's registered `website` is `"https://www.perplexity.ai"` and the resolver returns the URL's `host` verbatim (no www-stripping), so the correct value is `"www.perplexity.ai"` (consistent with the same test's own `url` assertion).
- `tests/unit/hard-session-lease-bypass-inventory.test.ts`: this golden call-site inventory was already stale on the pristine post-#11713 tip (confirmed via a throwaway probe worktree) — `src/lib/db/providers.ts`'s 3 connection-fallback sites and a third `src/app/api/providers/route.ts` site were never added to the golden list by the earlier-merged #11698/#11720 PRs. Updated it to the real current inventory (dated inline comments explain each delta and which PR introduced it), plus this PR's own legitimate deltas (image-edits duplicate-call removal, `ChatGptWebExecutor.execute()` site removed).

Focused suite green (433/433 across executor-proxy, reserved-prefix, hard-session-lease-bypass-inventory, resolve-web-provider-host, retirement/runtime-block/source-retirement/management-retirement/image-handler-retirement, migration-168, combo-auto-candidate-expansion, virtual-auto-combo, executor-map-golden and siblings), plus `typecheck:core`, `check-file-size`, and `check-changelog-integrity` clean. Thanks for the thorough provenance-hold retirement work — appreciated.
2026-08-28 06:52:46 -03:00

300 lines
10 KiB
TypeScript

import assert from "node:assert/strict";
import fs from "node:fs";
import os from "node:os";
import path from "node:path";
import test from "node:test";
const TEST_DATA_DIR = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-chatgpt-web-retired-"));
process.env.DATA_DIR = TEST_DATA_DIR;
const core = await import("../../src/lib/db/core.ts");
const combosDb = await import("../../src/lib/db/combos.ts");
const providersDb = await import("../../src/lib/db/providers.ts");
const providerNodesDb = await import("../../src/lib/db/providers/nodes.ts");
const modelAliasesDb = await import("../../src/lib/db/models/aliases.ts");
const settingsDb = await import("../../src/lib/db/settings.ts");
const modelAliasResolver = await import("../../src/lib/modelAliasResolver.ts");
const { getModelInfo } = await import("../../src/sse/services/model.ts");
const { resolveModelOrError } = await import("../../src/sse/handlers/chatHelpers.ts");
const auth = await import("../../src/sse/services/auth.ts");
const chatRoute = await import("../../src/app/api/v1/chat/completions/route.ts");
const originalFetch = globalThis.fetch;
function isRetiredError(error: unknown): boolean {
const typed = error as Error & { code?: string; status?: number };
assert.equal(typed.code, "PROVIDER_RETIRED");
assert.equal(typed.status, 410);
assert.equal(typed.message, "Provider is retired and unavailable.");
return true;
}
async function resetStorage(): Promise<void> {
core.resetDbInstance();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
fs.mkdirSync(TEST_DATA_DIR, { recursive: true });
core.getDbInstance();
modelAliasResolver.invalidateAliasCache();
}
test.beforeEach(async () => {
globalThis.fetch = originalFetch;
await resetStorage();
});
test.afterEach(() => {
globalThis.fetch = originalFetch;
});
test.after(() => {
globalThis.fetch = originalFetch;
core.resetDbInstance();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
});
test("retired common ChatGPT Web prefixes cannot shadow compatible nodes", async () => {
for (const [index, prefix] of ["chatgpt-web", "cgpt-web", "ChatGPT-Web", "CGPT-WEB"].entries()) {
await providerNodesDb.createProviderNode({
id: `openai-compatible-retired-chatgpt-web-${index}`,
type: "openai-compatible",
name: `Retired ChatGPT Web prefix ${prefix}`,
prefix,
apiType: "chat",
baseUrl: "https://retired.example.invalid/v1",
});
await assert.rejects(() => getModelInfo(`${prefix}/gpt-5.5`), isRetiredError);
}
const codex = await getModelInfo("chatgpt-web-codex/high");
assert.equal(codex.provider, "chatgpt-web-codex");
assert.equal(codex.model, "high");
});
test("provider writes return the durable ChatGPT Web tombstone instead of stale active data", async () => {
for (const provider of ["chatgpt-web", "cgpt-web"]) {
const created = await providersDb.createProviderConnection({
provider,
authType: "apikey",
name: `${provider} retired write`,
apiKey: `sk-${provider}-retired-write`,
isActive: true,
testStatus: "active",
});
assert.equal(created.isActive, false);
assert.equal(created.testStatus, "unavailable");
assert.equal(created.errorCode, "PROVIDER_REMOVED");
const updated = await providersDb.updateProviderConnection(String(created.id), {
isActive: true,
testStatus: "active",
errorCode: null,
});
assert.equal(updated?.isActive, false);
assert.equal(updated?.testStatus, "unavailable");
assert.equal(updated?.errorCode, "PROVIDER_REMOVED");
}
});
test("credential selection rejects retired ids even if a writer bypasses migration triggers", async () => {
const db = core.getDbInstance();
db.exec(`
DROP TRIGGER IF EXISTS provider_connections_retire_chatgpt_web_insert;
DROP TRIGGER IF EXISTS provider_connections_retire_chatgpt_web_update;
`);
for (const provider of ["chatgpt-web", "cgpt-web"]) {
db.prepare(
"INSERT INTO provider_connections " +
"(id, provider, auth_type, name, api_key, is_active, test_status, created_at, updated_at) " +
"VALUES (?, ?, 'apikey', ?, ?, 1, 'active', datetime('now'), datetime('now'))"
).run(
`${provider}-bypassed-trigger`,
provider,
`${provider} bypassed trigger`,
`sk-${provider}-bypassed-trigger`
);
const credentials = await auth.getProviderCredentials(provider);
assert.equal(credentials, null);
}
});
test("chat resolution returns a sanitized retirement response", async () => {
const result = await resolveModelOrError(
"cgpt-web/gpt-5.5",
{
model: "cgpt-web/gpt-5.5",
messages: [{ role: "user", content: "hello" }],
},
"/v1/chat/completions"
);
assert.ok(result.error instanceof Response);
assert.equal(result.error.status, 410);
const body = (await result.error.json()) as {
error?: { code?: string; message?: string };
};
assert.equal(body.error?.code, "PROVIDER_RETIRED");
assert.equal(body.error?.message, "Provider is retired and unavailable.");
assert.equal(JSON.stringify(body).includes("cgpt-web"), false);
});
test("persisted aliases cannot rewrite retired ChatGPT Web models before routing", async () => {
await providersDb.createProviderConnection({
provider: "openai",
authType: "apikey",
name: "Retired ChatGPT Web alias control",
apiKey: "sk-chatgpt-web-retirement-control",
isActive: true,
testStatus: "active",
});
await modelAliasesDb.setModelAlias("chatgpt-web/gpt-5.5", "openai/gpt-4o");
await modelAliasesDb.setModelAlias("cgpt-web", "openai/gpt-4o");
await modelAliasesDb.setModelAlias("friendly-retired-chatgpt", "chatgpt-web/gpt-5.5");
await modelAliasesDb.setModelAlias("friendly-retired-cgpt", "cgpt-web/gpt-5.5");
await modelAliasesDb.setModelAlias("cgpt-web-preview", "openai/gpt-4o");
await settingsDb.updateSettings({
wildcardAliases: [{ pattern: "wildcard-retired-chatgpt-*", target: "chatgpt-web/gpt-5.5" }],
});
modelAliasResolver.invalidateAliasCache();
const fetchCalls: string[] = [];
globalThis.fetch = async (input: string | URL | Request) => {
fetchCalls.push(String(input));
return Response.json({
id: "chatcmpl-chatgpt-web-retirement-control",
choices: [{ message: { role: "assistant", content: "healthy control" } }],
});
};
const retired = await chatRoute.POST(
new Request("http://localhost/v1/chat/completions", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
model: "chatgpt-web/gpt-5.5",
messages: [{ role: "user", content: "hello" }],
stream: false,
}),
})
);
assert.equal(retired.status, 410);
assert.equal(fetchCalls.length, 0);
const retiredBody = (await retired.json()) as {
error?: { code?: string; message?: string };
};
assert.equal(retiredBody.error?.code, "PROVIDER_RETIRED");
assert.equal(retiredBody.error?.message, "Provider is retired and unavailable.");
assert.equal(JSON.stringify(retiredBody).includes("chatgpt-web"), false);
const retiredBareAlias = await chatRoute.POST(
new Request("http://localhost/v1/chat/completions", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
model: "cgpt-web",
messages: [{ role: "user", content: "hello" }],
stream: false,
}),
})
);
assert.equal(retiredBareAlias.status, 410);
assert.equal(fetchCalls.length, 0);
const retiredBareBody = (await retiredBareAlias.json()) as {
error?: { code?: string; message?: string };
};
assert.equal(retiredBareBody.error?.code, "PROVIDER_RETIRED");
assert.equal(retiredBareBody.error?.message, "Provider is retired and unavailable.");
for (const alias of [
"friendly-retired-chatgpt",
"friendly-retired-cgpt",
"wildcard-retired-chatgpt-model",
]) {
const retiredTargetAlias = await chatRoute.POST(
new Request("http://localhost/v1/chat/completions", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
model: alias,
messages: [{ role: "user", content: "hello" }],
stream: false,
}),
})
);
assert.equal(retiredTargetAlias.status, 410);
const retiredTargetBody = (await retiredTargetAlias.json()) as {
error?: { code?: string; message?: string };
};
assert.equal(retiredTargetBody.error?.code, "PROVIDER_RETIRED");
assert.equal(retiredTargetBody.error?.message, "Provider is retired and unavailable.");
assert.equal(fetchCalls.length, 0);
}
const legitimateBareAlias = await chatRoute.POST(
new Request("http://localhost/v1/chat/completions", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
model: "cgpt-web-preview",
messages: [{ role: "user", content: "hello" }],
stream: false,
}),
})
);
assert.equal(legitimateBareAlias.status, 200);
assert.equal(fetchCalls.length, 1);
});
test("priority combo skips a retired ChatGPT Web target and uses its fallback", async () => {
await providersDb.createProviderConnection({
provider: "openai",
authType: "apikey",
name: "Healthy ChatGPT Web combo fallback",
apiKey: "sk-chatgpt-web-combo-fallback",
isActive: true,
testStatus: "active",
});
await combosDb.createCombo({
name: "retired-chatgpt-web-fallback",
strategy: "priority",
models: [
{ provider: "chatgpt-web", model: "gpt-5.5" },
{ provider: "openai", model: "gpt-4o" },
],
});
const fetchCalls: string[] = [];
globalThis.fetch = async (input: string | URL | Request) => {
fetchCalls.push(String(input));
return Response.json({
id: "chatcmpl-chatgpt-web-combo-fallback",
choices: [{ message: { role: "assistant", content: "healthy fallback" } }],
});
};
const response = await chatRoute.POST(
new Request("http://localhost/v1/chat/completions", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-OmniRoute-No-Cache": "true",
},
body: JSON.stringify({
model: "retired-chatgpt-web-fallback",
messages: [{ role: "user", content: "hello" }],
stream: false,
}),
})
);
assert.equal(response.status, 200);
assert.equal(fetchCalls.length, 1);
const body = (await response.json()) as {
choices?: Array<{ message?: { content?: string } }>;
};
assert.equal(body.choices?.[0]?.message?.content, "healthy fallback");
});