Files
OmniRoute/tests/unit/db/per-engine-analytics.test.ts
Diego Rodrigues de Sa e Souza 35dbf0eea1 Release v3.8.25 (#3866)
* chore(release): continue v3.8.25 development cycle after main code-sync (r5)

main fast-forwarded to release/v3.8.25 (#3863): unblocked Build+Docker via
#3864, plus #3837 (mimocode proxy) and #3862 (trivy bump). This marker
re-opens the umbrella PR for further v3.8.25 work. No version bump.

* fix(db): persist the Keep-latest-backups retention setting (#3834) (#3867)

* fix(oauth): clear GitLab Duo setup message instead of 500 (#3861) (#3868)

* test(oauth): prove refresh_token preserved on real gemini-cli/antigravity dispatch (#3850) (#3869)

* feat(compression-ui): unified compression config UI — per-engine pages + combos editor + menu + WS default-on (#3860)

Integrated into release/v3.8.25 — feat(compression-ui): unified compression configuration UI (Compression Hub + per-engine Lite/Aggressive/Ultra pages + combos editor + sidebar entry + live-WS default-on). File-size re-baselined for sidebarVisibility.ts/chatCore.ts growth; orphan ws test relocated to a collected path.

* docs(changelog): complete the v3.8.25 release notes + credit all contributors

Audited every commit since v3.8.24 and filled the gaps the [3.8.25] section
was missing: a New Features section (compression engines + Compression Studios
#3848, compression UI #3860, injection-guard #3857, kiro discovery #3836, Veo
#3839, mimocode proxy #3837, Arena ELO flag #3821), 9 more Fixed entries
(#3811/#3807/#3759/#3849/#3838/#3835/#3814/#3820/#3819), a Security section
(CCR IDOR #3859, supply-chain #3824), and an Internal/Quality section. Every
contributor and issue reporter is now credited.

* docs(changelog): restore + complete the v3.8.25 release notes

Re-adds CHANGELOG.md (a prior server-side commit accidentally dropped it) with
the complete, audited [3.8.25] section: New Features, the full Fixed list,
Security & Hardening, and Internal/Quality — every contributor and issue
reporter credited.

* chore(release): finalize v3.8.25 — reconcile CHANGELOG + i18n mirrors, document OMNIROUTE_MAX_PENDING_MIGRATIONS, green the unit suite

Release-gate reconciliation for v3.8.25:
- CHANGELOG: dated 2026-06-14, linked #3826, rolled up file-size re-baselines (#3823/#3833),
  recorded the test-greening; re-synced all 41 i18n CHANGELOG mirrors.
- Documented OMNIROUTE_MAX_PENDING_MIGRATIONS (#3416) in .env.example + ENVIRONMENT.md.
- Greened the unit suite (was merged red on 4 CI shards): aligned 10 stale tests to this
  cycle's intended behavior (#3838/#3822/#3501/SOCKS5/Vertex-Express/Antigravity) and the
  same-provider 503 fall-through test; de-flaked the compression benchmark reproducibility
  and ServiceSupervisor crash tests. No production code changed.

* ci(security): clear OpenSSF Scorecard code-scanning noise + harden workflow token permissions

The Security tab held 155 open alerts, ALL from the advisory OpenSSF Scorecard tool
(#3824) — supply-chain/posture scores, not code vulnerabilities — which drowned out
real CodeQL findings.

- scorecard.yml: stop uploading SARIF to the code-scanning tab (drop the upload-sarif
  step + the now-unused security-events: write). The run still produces the OpenSSF
  badge (publish_results) and a downloadable SARIF artifact.
- TokenPermissions hardening (the high-severity, genuinely-valuable subset): set each
  workflow's top-level token to read-only and grant the exact writes at the job level
  that needs them — npm-publish (id-token/packages on publish jobs), docker-publish
  (packages on build), electron-release (contents on build/release, id-token/packages
  on publish-npm), build-fork (packages on build), claude (empty top-level; job grants
  its own). The 155 existing alerts were dismissed.

Not adopting repo-wide SHA-pinning (143 PinnedDependencies advisories) — declined.

* test(integration): align stale wiring/socks5 integration tests to this cycle's behavior

These were red on the CI Integration job (pre-existing). No production code changed:
- integration-wiring: the combos page no longer renders a per-page EmailPrivacyToggle
  (#3822 consolidated it into Settings → Appearance); the provider-detail test-result
  masking and upstream-proxy copy moved to decomposed components (#3501
  BatchTestResultsModal / UpstreamProxyCard) — assertions now read the owning files.
- api-routes-critical: SOCKS5 is now enabled by default (opt-out), so the disabled-
  rejection test must set ENABLE_SOCKS5_PROXY=false explicitly (an unset env now means
  enabled).

(The ~32 live-Gemini integration tests are gated on OMNIROUTE_API_KEY and skip in CI;
they only 'fail' locally when that key is present without a running server.)
2026-06-15 03:32:11 -03:00

152 lines
5.6 KiB
TypeScript

/**
* TDD: getPerEngineAnalytics — per-engine aggregation from compression_analytics.
*
* DB isolation pattern mirrors tests/unit/db/api-keys.test.ts:
* - Temp DATA_DIR, resetDbInstance() before/after, close in test.after().
*/
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";
// ─── isolated temp DB ─────────────────────────────────────────────────────────
const TEST_DATA_DIR = fs.mkdtempSync(path.join(os.tmpdir(), "omniroute-per-engine-analytics-"));
const originalDataDir = process.env.DATA_DIR;
process.env.DATA_DIR = TEST_DATA_DIR;
const core = await import("../../../src/lib/db/core.ts");
core.resetDbInstance();
const { insertCompressionAnalyticsRow, getPerEngineAnalytics } =
await import("../../../src/lib/db/compressionAnalytics.ts");
// ─── helpers ──────────────────────────────────────────────────────────────────
function resetDb(): void {
core.resetDbInstance();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
fs.mkdirSync(TEST_DATA_DIR, { recursive: true });
}
// ─── lifecycle ────────────────────────────────────────────────────────────────
test.beforeEach(() => {
resetDb();
});
test.after(() => {
core.resetDbInstance();
fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true });
if (originalDataDir === undefined) delete process.env.DATA_DIR;
else process.env.DATA_DIR = originalDataDir;
});
// ─── tests ────────────────────────────────────────────────────────────────────
test("getPerEngineAnalytics returns runs=0 and zeroed metrics for unknown engine", () => {
const result = getPerEngineAnalytics("unknown-engine");
assert.equal(result.engineId, "unknown-engine");
assert.equal(result.runs, 0);
assert.equal(result.tokensSaved, 0);
assert.equal(result.avgSavingsPercent, 0);
assert.equal(result.days, 7);
});
test("getPerEngineAnalytics returns correct aggregation for headroom rows only", () => {
const now = new Date().toISOString();
// 2 headroom rows: original=1000/compressed=800/saved=200 and original=500/compressed=350/saved=150
insertCompressionAnalyticsRow({
timestamp: now,
mode: "stacked",
engine: "headroom",
original_tokens: 1000,
compressed_tokens: 800,
tokens_saved: 200,
});
insertCompressionAnalyticsRow({
timestamp: now,
mode: "stacked",
engine: "headroom",
original_tokens: 500,
compressed_tokens: 350,
tokens_saved: 150,
});
// 1 caveman row that must NOT appear in headroom results
insertCompressionAnalyticsRow({
timestamp: now,
mode: "stacked",
engine: "caveman",
original_tokens: 800,
compressed_tokens: 600,
tokens_saved: 200,
});
const result = getPerEngineAnalytics("headroom");
assert.equal(result.engineId, "headroom");
assert.equal(result.runs, 2, "should count only the 2 headroom rows");
assert.equal(result.tokensSaved, 350, "should sum tokens_saved for headroom rows");
// avgSavingsPercent = round(((1500 - 1150) / 1500) * 1000) / 10
// = round((350/1500) * 1000) / 10
// = round(233.33...) / 10
// = 233 / 10 = 23.3
assert.equal(result.avgSavingsPercent, 23.3, `expected 23.3%, got ${result.avgSavingsPercent}`);
assert.equal(result.days, 7);
});
test("getPerEngineAnalytics excludes rows outside the days window", () => {
const recent = new Date().toISOString();
// 30 days ago — outside the default 7-day window
const old = new Date(Date.now() - 30 * 86400_000).toISOString();
insertCompressionAnalyticsRow({
timestamp: recent,
mode: "stacked",
engine: "headroom",
original_tokens: 1000,
compressed_tokens: 800,
tokens_saved: 200,
});
insertCompressionAnalyticsRow({
timestamp: old,
mode: "stacked",
engine: "headroom",
original_tokens: 2000,
compressed_tokens: 1000,
tokens_saved: 1000,
});
const result = getPerEngineAnalytics("headroom", 7);
assert.equal(result.runs, 1, "should only count the recent row within 7 days");
assert.equal(result.tokensSaved, 200);
});
test("getPerEngineAnalytics falls back to mode column when engine is null (COALESCE behaviour)", () => {
const now = new Date().toISOString();
// Insert a row where engine is explicitly omitted — insertCompressionAnalyticsRow
// writes engine = row.engine ?? row.mode, so we cannot get NULL via the helper.
// Instead, insert raw via the DB to simulate a pre-engine row.
const db = core.getDbInstance();
db.prepare(
`INSERT INTO compression_analytics (timestamp, mode, engine, original_tokens, compressed_tokens, tokens_saved)
VALUES (?, ?, NULL, ?, ?, ?)`
).run(now, "caveman", 600, 400, 200);
// COALESCE(engine, mode) = 'caveman' for the row above
const result = getPerEngineAnalytics("caveman");
assert.equal(result.runs, 1, "COALESCE fallback should match engine=NULL, mode=caveman");
assert.equal(result.tokensSaved, 200);
});
test("getPerEngineAnalytics accepts custom days parameter", () => {
const result = getPerEngineAnalytics("headroom", 30);
assert.equal(result.days, 30);
});