Files
OmniRoute/tests/unit/virtual-auto-combo.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

343 lines
12 KiB
TypeScript

import test from "node:test";
import assert from "node:assert/strict";
import fs from "node:fs";
import os from "node:os";
import path from "node:path";
const TEST_DATA_DIR = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-virtual-auto-"));
const ORIGINAL_DATA_DIR = process.env.DATA_DIR;
process.env.DATA_DIR = TEST_DATA_DIR;
const core = await import("../../src/lib/db/core.ts");
const providersDb = await import("../../src/lib/db/providers.ts");
const virtualFactory = await import("../../open-sse/services/autoCombo/virtualFactory.ts");
type VirtualComboResult = Awaited<ReturnType<typeof virtualFactory.createVirtualAutoCombo>>;
async function resetStorage() {
core.resetDbInstance();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
fs.mkdirSync(TEST_DATA_DIR, { recursive: true });
}
test.beforeEach(async () => {
await resetStorage();
});
test.after(async () => {
await resetStorage();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
if (ORIGINAL_DATA_DIR === undefined) {
delete process.env.DATA_DIR;
} else {
process.env.DATA_DIR = ORIGINAL_DATA_DIR;
}
});
test("createVirtualAutoCombo returns an executable auto combo for API-key connections", async () => {
await providersDb.createProviderConnection({
provider: "openai",
authType: "apikey",
name: "OpenAI",
apiKey: "sk-test-openai",
defaultModel: "gpt-4o-mini",
});
const combo: VirtualComboResult = await virtualFactory.createVirtualAutoCombo("fast");
assert.equal(combo.strategy, "auto");
assert.ok(combo.models.length >= 1);
const openaiModel = combo.models.find(
(model) => model.providerId === "openai" && model.model === "openai/gpt-4o-mini"
);
assert.ok(openaiModel, "the configured default must remain among registry candidates");
assert.equal(openaiModel.kind, "model");
assert.equal(combo.autoConfig.routerStrategy, "lkgp");
assert.ok(combo.autoConfig.candidatePool.includes("openai"));
});
test("createVirtualAutoCombo includes OAuth accessToken connections with real expiry fields", async () => {
await providersDb.createProviderConnection({
provider: "anthropic",
authType: "oauth",
email: "oauth@example.com",
accessToken: "oauth-access-token",
tokenExpiresAt: new Date(Date.now() + 60_000).toISOString(),
defaultModel: "claude-sonnet-4-5",
});
const combo: VirtualComboResult = await virtualFactory.createVirtualAutoCombo("coding");
assert.equal(combo.strategy, "auto");
assert.ok(combo.models.length >= 1);
assert.ok(
combo.models.some(
(model) => model.providerId === "anthropic" && model.model === "anthropic/claude-sonnet-4-5"
),
"the configured default must remain among registry candidates"
);
assert.ok(combo.autoConfig.candidatePool.includes("anthropic"));
});
test("createVirtualAutoCombo includes configured web-session providers without apiKey fields", async () => {
await providersDb.createProviderConnection({
provider: "kimi-web",
authType: "apikey",
name: "Kimi Web Session",
providerSpecificData: { token: "kimi-web-session-token" },
defaultModel: "k3",
});
const combo: VirtualComboResult = await virtualFactory.createVirtualAutoCombo("coding");
const kimiWeb = combo.models.find(
(model) => model.providerId === "kimi-web" && model.model === "kimi-web/k3"
);
assert.ok(kimiWeb, "the configured web-session model should be an auto candidate");
assert.ok(combo.autoConfig.candidatePool.includes("kimi-web"));
});
test("createVirtualAutoCombo excludes web-session providers with empty required token data", async () => {
await providersDb.createProviderConnection({
provider: "kimi-web",
authType: "apikey",
name: "Kimi Web Empty Session",
providerSpecificData: { token: " " },
defaultModel: "k3",
});
const combo: VirtualComboResult = await virtualFactory.createVirtualAutoCombo("coding");
assert.equal(
combo.models.some((model) => model.providerId === "kimi-web"),
false,
"web-session providers with empty required token data must not be auto-combo candidates"
);
assert.equal(combo.autoConfig.candidatePool.includes("kimi-web"), false);
});
test("createVirtualAutoCombo excludes web-session providers with irrelevant providerSpecificData", async () => {
await providersDb.createProviderConnection({
provider: "perplexity-web",
authType: "apikey",
name: "Perplexity Web Invalid Session",
providerSpecificData: { unrelated: "value" },
defaultModel: "pplx-auto",
});
const combo: VirtualComboResult = await virtualFactory.createVirtualAutoCombo("coding");
assert.equal(
combo.models.some((model) => model.providerId === "perplexity-web"),
false,
"web-session providers with irrelevant providerSpecificData must not be auto-combo candidates"
);
assert.equal(combo.autoConfig.candidatePool.includes("perplexity-web"), false);
});
test("createVirtualAutoCombo groups same-provider web sessions behind one logical model", async () => {
const connA = await providersDb.createProviderConnection({
provider: "kimi-web",
authType: "apikey",
name: "Kimi Web Session A",
providerSpecificData: { token: "kimi-web-session-token-a" },
defaultModel: "k3",
});
const connB = await providersDb.createProviderConnection({
provider: "kimi-web",
authType: "apikey",
name: "Kimi Web Session B",
providerSpecificData: { token: "kimi-web-session-token-b" },
defaultModel: "k3",
});
const combo: VirtualComboResult = await virtualFactory.createVirtualAutoCombo("coding");
const kimiWebModel = combo.models.find(
(model) => model.providerId === "kimi-web" && model.model === "kimi-web/k3"
);
assert.ok(kimiWebModel, "the provider model should remain in the candidate pool");
assert.equal(kimiWebModel.connectionId, null);
assert.deepEqual(
new Set(kimiWebModel.allowedConnectionIds),
new Set([connA.id, connB.id]),
"same-provider web sessions should remain available as account fallbacks"
);
assert.equal(
combo.autoConfig.candidatePool.filter((provider) => provider === "kimi-web").length,
1,
"provider pool remains provider-scoped while model entries preserve connection identity"
);
});
test("createVirtualAutoCombo excludes trigger-bypassed retired Qwen rows", async () => {
const db = core.getDbInstance();
db.exec(`
DROP TRIGGER provider_connections_retire_qwen_web_insert;
DROP TRIGGER provider_connections_retire_qwen_web_update;
`);
await providersDb.createProviderConnection({
provider: "qwen-web",
authType: "apikey",
name: "Retired Qwen Web",
apiKey: "retired-qwen-web-key",
defaultModel: "qwen3.8-max",
});
await providersDb.createProviderConnection({
provider: "qw",
authType: "apikey",
name: "Retired Qwen Web Alias",
apiKey: "retired-qw-key",
defaultModel: "qwen3.8-max",
});
await providersDb.createProviderConnection({
provider: "qwen-cloud",
authType: "apikey",
name: "Qwen Cloud Control",
apiKey: "qwen-cloud-key",
defaultModel: "qwen3.8-max",
});
const combo: VirtualComboResult = await virtualFactory.createVirtualAutoCombo("coding");
assert.equal(
combo.models.some((model) => model.providerId === "qwen-web"),
false
);
assert.equal(
combo.models.some((model) => model.providerId === "qw"),
false
);
assert.equal(combo.autoConfig.candidatePool.includes("qwen-web"), false);
assert.equal(combo.autoConfig.candidatePool.includes("qw"), false);
assert.ok(combo.autoConfig.candidatePool.includes("qwen-cloud"));
});
test("createVirtualAutoCombo excludes restored active ChatGPT Web rows that bypassed 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, default_model, is_active, test_status, " +
"created_at, updated_at) VALUES (?, ?, 'apikey', ?, ?, 'gpt-5.5', 1, 'active', " +
"datetime('now'), datetime('now'))"
).run(
`${provider}-restored-auto`,
provider,
`${provider} restored auto`,
`sk-${provider}-restored-auto`
);
}
const combo: VirtualComboResult = await virtualFactory.createVirtualAutoCombo("coding");
assert.equal(
combo.models.some((model) => ["chatgpt-web", "cgpt-web"].includes(model.providerId)),
false
);
assert.equal(combo.autoConfig.candidatePool.includes("chatgpt-web"), false);
assert.equal(combo.autoConfig.candidatePool.includes("cgpt-web"), false);
});
test("createVirtualAutoCombo includes no-auth OpenCode Free without provider_connections rows", async () => {
const combo: VirtualComboResult = await virtualFactory.createVirtualAutoCombo("fast");
const opencode = combo.models.find((model) => model.providerId === "opencode");
assert.ok(
opencode,
"OpenCode Free should appear in auto/* even when it has no provider_connections row"
);
assert.equal(opencode.connectionId, "noauth");
assert.equal(opencode.model, "oc/big-pickle");
assert.ok(combo.autoConfig.candidatePool.includes("opencode"));
});
test("createVirtualAutoCombo restricts the no-auth pool to the allowlist", async () => {
// Policy: the no-auth (keyless) auto-combo allowlist is narrowed to `opencode`
// (open-sse/services/autoCombo/virtualFactory.ts::AUTO_COMBO_NOAUTH_ALLOWLIST) —
// the keyless backend verified to work without configuration on our reference
// egress. The others stay usable via direct `<alias>/<model>` calls but must
// NOT be auto-routed to. Dedicated guard:
// tests/unit/noauth-autocombo-allowlist.test.ts.
const combo: VirtualComboResult = await virtualFactory.createVirtualAutoCombo("fast");
for (const allowed of ["opencode"]) {
const models = combo.models.filter((m) => m.providerId === allowed);
assert.ok(models.length >= 1, `${allowed} should have at least one model`);
assert.ok(
models.every((m) => m.connectionId === "noauth"),
`all ${allowed} models should use noauth connection`
);
}
for (const excluded of ["duckduckgo-web", "theoldllm", "chipotle", "aihorde"]) {
assert.equal(
combo.models.some((model) => model.providerId === excluded),
false,
`no-auth provider "${excluded}" must be excluded from the auto-combo pool (not in allowlist)`
);
}
assert.equal(
combo.models.some((model) => model.providerId === "veoaifree-web"),
false,
"video-only no-auth providers must not be inserted into chat auto-combos"
);
});
test("createVirtualAutoCombo keeps credential-required providers out when disconnected", async () => {
const combo: VirtualComboResult = await virtualFactory.createVirtualAutoCombo("fast");
assert.equal(
combo.models.some((model) => model.providerId === "openai"),
false,
"OpenAI should still require a real active connection"
);
});
test("createVirtualAutoCombo excludes trigger-bypassed Microsoft Designer connections exactly", async () => {
await core.ensureDbInitialized();
const db = core.getDbInstance();
db.exec("DROP TRIGGER IF EXISTS trg_retire_microsoft_designer_web_provider_insert");
db.exec("DROP TRIGGER IF EXISTS trg_retire_microsoft_designer_web_provider_update");
for (const [provider, model] of [
["microsoft-designer-web", "dall-e-3"],
["msdesigner", "dall-e-3"],
["microsoft-designer-web-preview", "preview-model"],
] as const) {
await providersDb.createProviderConnection({
provider,
authType: "apikey",
name: `${provider}-trigger-bypass`,
apiKey: `sk-${provider}-test`,
providerSpecificData: { accessToken: `${provider}-token` },
defaultModel: model,
isActive: true,
});
}
const combo: VirtualComboResult = await virtualFactory.createVirtualAutoCombo("coding");
assert.equal(
combo.models.some((model) =>
["microsoft-designer-web", "msdesigner"].includes(model.providerId)
),
false
);
assert.equal(combo.autoConfig.candidatePool.includes("microsoft-designer-web"), false);
assert.equal(combo.autoConfig.candidatePool.includes("msdesigner"), false);
assert.equal(
combo.models.some((model) => model.providerId === "microsoft-designer-web-preview"),
true,
"a merely similar provider ID must remain eligible"
);
});