Files
OmniRoute/tests/unit/config-hot-reload.test.ts
Ravi Tharuma fbc67f1338 fix(models): honor MODELS_DEV_SYNC_ENABLED=0 over dashboard settings (#10299)
* fix(deps): bump nanoid, dompurify for 2 new Dependabot alerts (#189, #190)

Bumps: nanoid ^3.3.17 (was transitive, now overridden), dompurify ^3.4.13
(with monaco-editor scoped override). Closes Dependabot #189, #190.

Remaining #182-#188 (js-yaml + mermaid) already closed by #9651 merge —
awaiting Dependabot re-scan.

npm audit → 0 vulnerabilities.

* fix(repo): harden .gitignore to also ignore a _tasks symlink (/_tasks)

_tasks is a SEPARATE nested git repo (gitignored). The pattern _tasks/ (trailing
slash) ignores only a directory, not a SYMLINK named _tasks. A self-referential
_tasks symlink can slip in via git add -A and, once pulled, checkout materializes
it over the real _tasks repo (destroying plans/specs/hands-off). Anchored /_tasks
ignores the symlink too, preventing re-capture.

* Hide health-check excluded models from /v1/models catalog (#10026)

Mirror the request-time exclusion rule (provider_specific_data.excludedModels)
in the unified catalog builder: a model is hidden when its provider has
connections but none of them is eligible for it. Applied across the
PROVIDER_MODELS, synced, custom, alias-backed, and managed-fallback loops
so ghost models no longer appear as available.

Co-authored-by: ritheshcn25 <ritheshcn25@users.noreply.github.com>

* fix(models): memoize getModelsDevPricing (event loop / healthz) (#10055)

* fix(models): memoize getModelsDevPricing for /v1/models catalog

resolveCatalogPricing called getModelsDevPricing once per model while
building GET /v1/models. Each call re-scanned models_dev_pricing and
JSON.parsed every row (~10k SQL scans + multi-GB parse work), pegging
the event loop so even /healthz timed out (#9685, #10052).

Memoize the parsed map until saveModelsDevPricing / clearModelsDevPricing
and add a unit test for invalidation.

Signed-off-by: Ravi Tharuma <RaviTharuma@users.noreply.github.com>

* fix(db): invalidate modelsDevPricing cache on DB reset (#10055)

Copilot review fixes:
1. Register invalidateModelsDevPricingCache() with DB state reset system
   so resetDbInstance() clears the process-local memo, preventing stale
   pricing data from surviving across DB reset/restore operations.
2. Add test assertion verifying DB reset bypasses the memo (Copilot #10055).

The process-local memo at modelsDevSync.ts:204 caches getModelsDevPricing()
results until saveModelsDevPricing()/clearModelsDevPricing() to avoid
re-scanning all pricing rows on every /v1/models request. Without this hook,
backup restore and test DB resets would serve stale cached data from the
previous connection.

Tests: npm run test:unit:serial -- tests/unit/modelsDevSync-extended.test.ts

---------

Signed-off-by: Ravi Tharuma <RaviTharuma@users.noreply.github.com>
Co-authored-by: Ravi Tharuma <RaviTharuma@users.noreply.github.com>
Co-authored-by: Cursor Agent <cursoragent@cursor.com>

* fix(models): honor MODELS_DEV_SYNC_ENABLED=0 over dashboard settings

The file header already advertised this env var but nothing read it.
When catalog/compression pin the event loop, the dashboard (same process)
cannot turn models.dev sync off. Let 0/false/off win over sqlite so an
operator can recover with env + restart. Skip getModelsDevPricing SQL
scans while the kill switch is set.

* fix(models): restore prettier formatting after base merge

Co-authored-by: diegosouzapw <diegosouza.pw@gmail.com>

* test(models): cover env kill switch during live settings updates

Co-authored-by: diegosouzapw <8016841+diegosouzapw@users.noreply.github.com>

---------

Signed-off-by: Ravi Tharuma <RaviTharuma@users.noreply.github.com>
Co-authored-by: diegosouzapw <diegosouzapw@users.noreply.github.com>
Co-authored-by: Diego Rodrigues de Sa e Souza <diegosouza.pw@outlook.com>
Co-authored-by: diegosouzapw <diegosouza.pw@gmail.com>
Co-authored-by: ritheshcn25 <rithesh.chandran@snb.ca>
Co-authored-by: ritheshcn25 <ritheshcn25@users.noreply.github.com>
Co-authored-by: Ravi Tharuma <RaviTharuma@users.noreply.github.com>
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: adevwithpurpose <adevwithpurpose@users.noreply.github.com>
Co-authored-by: diegosouzapw <8016841+diegosouzapw@users.noreply.github.com>
2026-08-17 08:02:47 -03:00

198 lines
7.3 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-config-hot-reload-"));
process.env.DATA_DIR = TEST_DATA_DIR;
process.env.OMNIROUTE_CONFIG_HOT_RELOAD_MS = "100";
const core = await import("../../src/lib/db/core.ts");
const settingsDb = await import("../../src/lib/db/settings.ts");
const { getDbInstance } = core;
const runtimeSettings = await import("../../src/lib/config/runtimeSettings.ts");
const { applyRuntimeSettings, resetRuntimeSettingsStateForTests } = runtimeSettings;
const { startRuntimeConfigHotReload, stopRuntimeConfigHotReloadForTests } =
await import("../../src/lib/config/hotReload.ts");
const { getCliCompatProviders } = await import("../../open-sse/config/cliFingerprints.ts");
const { getCustomAliases, setCustomAliases } =
await import("../../open-sse/services/modelDeprecation.ts");
const {
getBackgroundDegradationConfig,
getDefaultDegradationMap,
getDefaultDetectionPatterns,
setBackgroundDegradationConfig,
} = await import("../../open-sse/services/backgroundTaskDetector.ts");
const { clearGeminiThoughtSignatures, getGeminiThoughtSignatureMode } =
await import("../../open-sse/services/geminiThoughtSignatureStore.ts");
const { getPayloadRulesConfig, resetPayloadRulesConfigForTests } =
await import("../../open-sse/services/payloadRules.ts");
const { getCacheControlSettings, invalidateCacheControlSettingsCache } =
await import("../../src/lib/cacheControlSettings.ts");
const { getSyncStatus, stopPeriodicSync } = await import("../../src/lib/modelsDevSync.ts");
async function resetStorage() {
stopRuntimeConfigHotReloadForTests();
resetRuntimeSettingsStateForTests();
resetPayloadRulesConfigForTests();
clearGeminiThoughtSignatures();
setCustomAliases({});
setBackgroundDegradationConfig({
enabled: false,
degradationMap: getDefaultDegradationMap(),
detectionPatterns: getDefaultDetectionPatterns(),
});
invalidateCacheControlSettingsCache();
core.resetDbInstance();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
fs.mkdirSync(TEST_DATA_DIR, { recursive: true });
}
async function waitFor(check: () => Promise<boolean> | boolean, timeoutMs = 3000) {
const deadline = Date.now() + timeoutMs;
while (Date.now() < deadline) {
if (await check()) return;
await new Promise((resolve) => setTimeout(resolve, 50));
}
assert.fail("Timed out waiting for hot-reload condition");
}
test.beforeEach(async () => {
await resetStorage();
});
test.after(async () => {
await resetStorage();
});
test("runtime settings public surface excludes removed snapshot inspection helper", () => {
assert.equal(
Object.hasOwn(runtimeSettings, "getLastAppliedRuntimeSettingsSnapshotForTests"),
false
);
assert.equal(typeof runtimeSettings.applyRuntimeSettings, "function");
assert.equal(typeof runtimeSettings.getAuthzBypassSnapshot, "function");
assert.equal(typeof runtimeSettings.resetRuntimeSettingsStateForTests, "function");
});
test("updateSettings applies runtime settings incrementally without restart", async () => {
await applyRuntimeSettings(await settingsDb.getSettings(), {
force: true,
source: "test:startup",
});
await settingsDb.updateSettings({
cliCompatProviders: ["OpenAI", "claude", "copilot"],
modelAliases: JSON.stringify({ "team-default": "openai/gpt-4o-mini" }),
backgroundDegradation: {
enabled: true,
degradationMap: { "gpt-4o": "gpt-4o-mini" },
detectionPatterns: ["summarize this"],
},
payloadRules: {
override: [
{
models: [{ name: "gpt-*", protocol: "openai" }],
params: { temperature: 0.1 },
},
],
},
alwaysPreserveClientCache: "always",
antigravitySignatureCacheMode: "bypass",
});
assert.deepEqual(getCliCompatProviders().sort(), ["claude", "github"]);
assert.deepEqual(getCustomAliases(), { "team-default": "openai/gpt-4o-mini" });
assert.equal(getBackgroundDegradationConfig().enabled, true);
assert.equal(getBackgroundDegradationConfig().degradationMap["gpt-4o"], "gpt-4o-mini");
assert.deepEqual(getBackgroundDegradationConfig().detectionPatterns, ["summarize this"]);
assert.equal((await getPayloadRulesConfig()).override[0].params.temperature, 0.1);
assert.equal(await getCacheControlSettings(), "always");
assert.equal(getGeminiThoughtSignatureMode(), "bypass");
await settingsDb.updateSettings({
cliCompatProviders: [],
modelAliases: {},
backgroundDegradation: null,
payloadRules: null,
alwaysPreserveClientCache: "auto",
antigravitySignatureCacheMode: "enabled",
});
assert.deepEqual(getCliCompatProviders(), []);
assert.deepEqual(getCustomAliases(), {});
assert.equal(getBackgroundDegradationConfig().enabled, false);
assert.equal((await getPayloadRulesConfig()).override.length, 0);
assert.equal(await getCacheControlSettings(), "auto");
assert.equal(getGeminiThoughtSignatureMode(), "enabled");
});
test("MODELS_DEV_SYNC_ENABLED=0 blocks a live settings update from starting the sync timer", async () => {
const previousEnvFlag = process.env.MODELS_DEV_SYNC_ENABLED;
const previousBackgroundTasks = process.env.OMNIROUTE_ENABLE_RUNTIME_BACKGROUND_TASKS;
process.env.MODELS_DEV_SYNC_ENABLED = "0";
process.env.OMNIROUTE_ENABLE_RUNTIME_BACKGROUND_TASKS = "1";
stopPeriodicSync();
try {
await applyRuntimeSettings(
{
...(await settingsDb.getSettings()),
modelsDevSyncEnabled: false,
modelsDevSyncInterval: 3_600_000,
},
{ force: true, source: "test:startup" }
);
const persistedSettings = await settingsDb.updateSettings({
modelsDevSyncEnabled: true,
modelsDevSyncInterval: 3_600_000,
});
assert.equal(
persistedSettings.modelsDevSyncEnabled,
true,
"the live settings update must persist the dashboard toggle"
);
assert.equal(
getSyncStatus().enabled,
false,
"MODELS_DEV_SYNC_ENABLED=0 must prevent a live settings update from starting the timer"
);
} finally {
stopPeriodicSync();
if (previousEnvFlag === undefined) delete process.env.MODELS_DEV_SYNC_ENABLED;
else process.env.MODELS_DEV_SYNC_ENABLED = previousEnvFlag;
if (previousBackgroundTasks === undefined) {
delete process.env.OMNIROUTE_ENABLE_RUNTIME_BACKGROUND_TASKS;
} else {
process.env.OMNIROUTE_ENABLE_RUNTIME_BACKGROUND_TASKS = previousBackgroundTasks;
}
}
});
test("hot-reload watcher picks up external sqlite changes via polling fallback", async () => {
await applyRuntimeSettings(await settingsDb.getSettings(), {
force: true,
source: "test:startup",
});
startRuntimeConfigHotReload({ pollIntervalMs: 100 });
const db = getDbInstance();
db.prepare(
"INSERT OR REPLACE INTO key_value (namespace, key, value) VALUES ('settings', 'cliCompatProviders', ?)"
).run(JSON.stringify(["github", "openai"]));
db.prepare(
"INSERT OR REPLACE INTO key_value (namespace, key, value) VALUES ('settings', 'antigravitySignatureCacheMode', ?)"
).run(JSON.stringify("bypass-strict"));
await waitFor(
() =>
getCliCompatProviders().includes("github") &&
!getCliCompatProviders().includes("openai") &&
getGeminiThoughtSignatureMode() === "bypass-strict"
);
});