Files
OmniRoute/@omniroute/opencode-plugin-v2/tests/usable-only.test.ts
Eliot B 136b67a58a fix(opencode-plugin-v2): use advertised combo name as model id (#15755)
Validated in a combined board with the other PRs of this wave on release/v3.8.52: the PR's own tests pass; typecheck:core, open-sse typecheck, api-typecheck, complexity, changelog-integrity, env-doc-sync, test-discovery, vitest-exclusions, error-helper, test-masking, lockfile, deps, gate-manifest, cli-i18n and i18n coverage green. Any file-size ceiling or stryker registration this wave needs lands in the wave's follow-up PR. Thank you for the contribution!
2026-10-08 03:03:36 -03:00

323 lines
11 KiB
TypeScript

import { describe, it } from "node:test";
import assert from "node:assert/strict";
import { publishCatalog } from "../src/catalog.js";
import { parsePluginOptions } from "../src/options.js";
type BetaDraft = {
provider: {
list?: () => unknown[];
get?: (id: string) => unknown;
update: (id: string, fn: (p: Record<string, any>) => void) => void;
remove?: () => void;
};
model: {
get?: (...a: string[]) => unknown;
update: (pid: string, mid: string, fn: (m: Record<string, any>) => void) => void;
remove?: () => void;
default?: { get: () => undefined; set: () => void };
};
};
function fakeDraft(): { models: Map<string, Record<string, any>>; draft: BetaDraft } {
const providers = new Map<string, Record<string, any>>();
const models = new Map<string, Record<string, any>>();
const draft = {
provider: {
list: () => [],
get: (id: string) => providers.get(id) as never,
update: (id: string, fn: (p: Record<string, any>) => void) => {
const p = (providers.get(id) ?? { id }) as Record<string, any>;
fn(p);
providers.set(id, p);
},
remove: () => {},
},
model: {
get: () => undefined,
update: (pid: string, mid: string, fn: (m: Record<string, any>) => void) => {
const k = pid + "/" + mid;
const m = (models.get(k) ?? { id: mid, providerID: pid }) as Record<string, any>;
fn(m);
models.set(k, m);
},
remove: () => {},
default: { get: () => undefined, set: () => {} },
},
};
return { models, draft };
}
function silence() {
const origWarn = console.warn;
const origLog = console.log;
console.warn = () => {};
console.log = () => {};
return {
restore() {
console.warn = origWarn;
console.log = origLog;
},
};
}
function enrichmentOf(...pairs: Array<[string, string]>) {
return new Map(
pairs.map(([alias, canonical]) => [
`${alias}/model-x`,
{ providerAlias: alias, providerCanonical: canonical },
])
);
}
const baseOpts = {
providerId: "omniroute",
baseURL: "https://gw.example.com",
apiKey: "k",
timeoutMs: 1000,
modelCacheTtlMs: 300000,
};
describe("usableOnly option default", () => {
it("defaults to false", () => {
const opts = parsePluginOptions({ baseURL: "https://gw.example.com" });
assert.equal(opts.usableOnly, false);
});
});
describe("catalog usableOnly gating", () => {
const stubModels = async () => [
{ id: "cc/keep-me" },
{ id: "dead/drop-me" },
{ id: "agentrouter/mystery" },
];
it("usableOnly=false performs zero providers fetches", async () => {
const { draft, models } = fakeDraft();
let providersCalls = 0;
const res = await publishCatalog(
draft,
{ ...baseOpts, usableOnly: false },
{
fetcher: stubModels,
combosFetcher: async () => [],
providersFetcher: async () => {
providersCalls += 1;
return [];
},
}
);
assert.equal(providersCalls, 0);
assert.equal(res.models, 3);
assert.deepEqual(res, { models: 3, combos: 0 });
assert.ok(models.has("omniroute/cc/keep-me"));
assert.ok(models.has("omniroute/dead/drop-me"));
});
it("usableOnly=true drops known-but-not-provisioned models, keeps unknown prefixes", async () => {
const { draft, models } = fakeDraft();
const res = await publishCatalog(
draft,
{
...baseOpts,
usableOnly: true,
enrichment: enrichmentOf(["cc", "claude"], ["dead", "legacy"]),
},
{
fetcher: stubModels,
combosFetcher: async () => [],
providersFetcher: async () => [
{ id: "c1", provider: "claude", isActive: true, testStatus: "active" },
],
}
);
assert.equal(res.models, 2);
assert.ok(models.has("omniroute/cc/keep-me"));
assert.ok(!models.has("omniroute/dead/drop-me"));
assert.ok(models.has("omniroute/agentrouter/mystery"));
});
it("usableOnly=true with providers soft-fail keeps the full catalog", async () => {
const { draft, models } = fakeDraft();
const res = await publishCatalog(
draft,
{ ...baseOpts, usableOnly: true },
{
fetcher: stubModels,
combosFetcher: async () => [],
providersFetcher: async () => {
throw new Error("down");
},
}
);
assert.equal(res.models, 3);
assert.ok(models.has("omniroute/dead/drop-me"));
});
it("usableOnly=true filters combos by member usability", async () => {
const { draft, models } = fakeDraft();
const res = await publishCatalog(
draft,
{
...baseOpts,
usableOnly: true,
enrichment: enrichmentOf(["cc", "claude"], ["dead", "legacy"]),
},
{
fetcher: async () => [{ id: "cc/x" }, { id: "dead/y" }],
combosFetcher: async () => [
{ id: "good", name: "Good", models: [{ kind: "model", model: "cc/x" }] },
{ id: "bad", name: "Bad", models: [{ kind: "model", model: "dead/y" }] },
],
providersFetcher: async () => [
{ id: "c1", provider: "claude", isActive: true, testStatus: "active" },
],
}
);
assert.equal(res.combos, 1);
assert.deepEqual(res, { models: 1, combos: 1 });
assert.ok(models.has("omniroute/Good"));
assert.ok(!models.has("omniroute/Bad"));
});
it("usableOnly=false issues no providers request through setup (gating)", async () => {
const seen: string[] = [];
const origFetch = globalThis.fetch;
globalThis.fetch = (async (url: unknown) => {
const href = String(url);
seen.push(href);
if (href.includes("/api/combos")) {
return { ok: true, status: 200, statusText: "OK", json: async () => ({ combos: [] }) };
}
return {
ok: true,
status: 200,
statusText: "OK",
json: async () => ({ data: [{ id: "m1", capabilities: { tool_calling: true } }] }),
};
}) as typeof fetch;
const guard = silence();
try {
const plugin = (await import("../src/index.js")).default as unknown as {
setup: (ctx: unknown) => Promise<void>;
};
const catalogCallbacks: Array<(draft: unknown) => Promise<void>> = [];
await plugin.setup({
options: { baseURL: "https://gw.example.com", providerId: "usable-gate" },
provider: {
transform: (cb: (editor: { add: (input: unknown) => void }) => void) => {
catalogCallbacks.push(async () => {
cb({ add: () => {} });
});
return Promise.resolve({ dispose: async () => {} });
},
},
model: {
transform: () => Promise.resolve({ dispose: async () => {} }),
},
integration: { transform: () => Promise.resolve({ dispose: async () => {} }) },
});
const { mkdtempSync } = await import("node:fs");
const { tmpdir } = await import("node:os");
const { join } = await import("node:path");
const prevDataDir = process.env.OPENCODE_DATA_DIR;
process.env.OPENCODE_DATA_DIR = mkdtempSync(join(tmpdir(), "omniroute-usable-"));
try {
const { draft } = fakeDraft();
await catalogCallbacks[0](draft as never);
} finally {
if (prevDataDir === undefined) delete process.env.OPENCODE_DATA_DIR;
else process.env.OPENCODE_DATA_DIR = prevDataDir;
}
assert.ok(
!seen.some((href) => href.includes("/api/providers")),
`no providers fetch expected, got: ${JSON.stringify(seen)}`
);
assert.ok(
!seen.some((href) => new URL(href).pathname === "/api/combos/auto"),
`retired route must never be requested, got: ${JSON.stringify(seen)}`
);
} finally {
globalThis.fetch = origFetch;
guard.restore();
}
});
// The default publishes the full catalog; toolsOnly: true is the opt-in filter (owner
// decision 2026-10-07, reverting the #14554 default). Both paths run through setup.
for (const [label, toolsOnly, expectPlain] of [
["toolsOnly default keeps models without tool calling through setup", undefined, true],
["toolsOnly: true drops models without tool calling through setup", true, false],
] as const) {
it(label, async () => {
const origFetch = globalThis.fetch;
globalThis.fetch = (async (url: unknown) => {
const href = String(url);
if (href.includes("/api/combos/auto")) {
return { ok: true, status: 200, statusText: "OK", json: async () => ({ combos: [] }) };
}
if (href.includes("/api/combos")) {
return { ok: true, status: 200, statusText: "OK", json: async () => ({ combos: [] }) };
}
return {
ok: true,
status: 200,
statusText: "OK",
json: async () => ({
data: [{ id: "m-tools", capabilities: { tool_calling: true } }, { id: "m-plain" }],
}),
};
}) as typeof fetch;
const guard = silence();
const { mkdtempSync } = await import("node:fs");
const { tmpdir } = await import("node:os");
const { join } = await import("node:path");
const prevDataDir = process.env.OPENCODE_DATA_DIR;
process.env.OPENCODE_DATA_DIR = mkdtempSync(join(tmpdir(), "omniroute-toolsdrop-"));
try {
const plugin = (await import("../src/index.js")).default as unknown as {
setup: (ctx: unknown) => Promise<void>;
};
const added: unknown[] = [];
const catalogCallbacks: Array<(draft: unknown) => Promise<void>> = [];
await plugin.setup({
options: {
baseURL: "https://gw.example.com",
providerId: "tools-drop",
apiKey: "k",
...(toolsOnly === undefined ? {} : { toolsOnly }),
},
provider: {
transform: (cb: (editor: { add: (input: unknown) => void }) => void) => {
catalogCallbacks.push(async () => {
cb({
add: (input: unknown) => {
added.push(input);
},
});
});
return Promise.resolve({ dispose: async () => {} });
},
},
model: {
transform: () => Promise.resolve({ dispose: async () => {} }),
},
integration: { transform: () => Promise.resolve({ dispose: async () => {} }) },
});
const { draft } = fakeDraft();
await catalogCallbacks[0](draft as never);
const dumped = JSON.stringify(added);
assert.ok(added.length > 0, `expected a published catalog, got: ${dumped}`);
assert.ok(dumped.includes("m-tools"), `expected the tool-capable model, got: ${dumped}`);
assert.equal(
dumped.includes("m-plain"),
expectPlain,
`expected the plain model ${expectPlain ? "kept" : "dropped"}, got: ${dumped}`
);
} finally {
if (prevDataDir === undefined) delete process.env.OPENCODE_DATA_DIR;
else process.env.OPENCODE_DATA_DIR = prevDataDir;
globalThis.fetch = origFetch;
guard.restore();
}
});
}
});