Files
OmniRoute/tests/unit/plugins-metrics.test.ts
Diego Rodrigues de Sa e Souza 20c31493af feat(plugins): plugins framework + per-API-key disable-non-public-models (#3041)
Integrates two community contributions into release/v3.8.8 with security hardening and conflict resolution.

- **Plugins framework** (#2913 — thanks @oyi77): hooks + registry unification, plugin SDK (`definePlugin`), worker-thread sandbox, per-plugin hook rate limiting, SHA-256 integrity verification, semver-gated upgrade, and execution analytics. Plugin routes are loopback-only (`isLocalOnlyPath`); `child_process` exec is opt-in via `OMNIROUTE_PLUGINS_ALLOW_EXEC` (default off).
- **API key option: disable non-published models** (#3017 — thanks @androw): a per-key flag restricting the key to discovered public models (combos / `auto/*` / `qtSd/*` routing still allowed).

Hardening applied during integration: migration renumber (089/090/091), `/api/plugins` LOCAL_ONLY route-guard classification (closes the plugin-RCE vector), atomic install/upgrade with path containment, `O_EXCL` tmp-file creation (TOCTOU), rate-limit-map eviction, `validatePluginConfig` on configure, `buildErrorBody` on all plugin error paths. 246/246 tests; typecheck / cycles / docs-sync clean.

Co-authored-by: oyi77 <14921983+oyi77@users.noreply.github.com>
Co-authored-by: Nicolas Lorin <androw95220@gmail.com>
2026-06-01 15:43:55 -03:00

74 lines
3.0 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-metrics-"));
process.env.DATA_DIR = TEST_DATA_DIR;
const core = await import("../../src/lib/db/core.ts");
const hooks = await import("../../src/lib/plugins/hooks.ts");
test.beforeEach(() => {
core.resetDbInstance();
hooks.resetHooks();
fs.mkdirSync(TEST_DATA_DIR, { recursive: true });
});
test.after(() => {
core.resetDbInstance();
try { fs.rmSync(TEST_DATA_DIR, { recursive: true, force: true }); } catch {}
});
test("recordPluginMetric stores call count", async () => {
const { recordPluginMetric, getPluginMetrics } = await import("../../src/lib/db/pluginMetrics.ts");
recordPluginMetric("test-plugin", "onRequest", 5.2, false);
recordPluginMetric("test-plugin", "onRequest", 3.1, false);
const metrics = getPluginMetrics("test-plugin");
assert.ok(metrics.length > 0, "should have metrics");
const m = metrics.find((r: { event: string }) => r.event === "onRequest");
assert.ok(m, "should have onRequest metric");
assert.ok(m.calls >= 2, `expected calls >= 2, got ${m.calls}`);
});
test("recordPluginMetric tracks errors", async () => {
const { recordPluginMetric, getPluginMetrics } = await import("../../src/lib/db/pluginMetrics.ts");
recordPluginMetric("err-plugin", "onRequest", 1.0, true);
const metrics = getPluginMetrics("err-plugin");
const m = metrics.find((r: { event: string }) => r.event === "onRequest");
assert.ok(m, "should have onRequest metric");
assert.ok(m.errors >= 1, `expected errors >= 1, got ${m.errors}`);
});
test("recordPluginMetric tracks latency", async () => {
const { recordPluginMetric, getPluginMetrics } = await import("../../src/lib/db/pluginMetrics.ts");
recordPluginMetric("latency-plugin", "onRequest", 42.5, false);
const metrics = getPluginMetrics("latency-plugin");
const m = metrics.find((r: { event: string }) => r.event === "onRequest");
assert.ok(m, "should have onRequest metric");
assert.ok(m.totalDurationMs >= 42, `expected totalDurationMs >= 42, got ${m.totalDurationMs}`);
});
test("getPluginMetrics returns all plugins when no filter", async () => {
const { recordPluginMetric, getPluginMetrics } = await import("../../src/lib/db/pluginMetrics.ts");
recordPluginMetric("p1", "onRequest", 1, false);
recordPluginMetric("p2", "onResponse", 2, false);
const all = getPluginMetrics();
assert.ok(all.length >= 2, `expected >= 2, got ${all.length}`);
});
test("clearPluginMetrics removes metrics", async () => {
const { recordPluginMetric, clearPluginMetrics, getPluginMetrics } = await import("../../src/lib/db/pluginMetrics.ts");
recordPluginMetric("clear-test", "onRequest", 1, false);
clearPluginMetrics("clear-test");
const metrics = getPluginMetrics("clear-test");
const m = metrics.find((r: { event: string }) => r.event === "onRequest");
assert.equal(m, undefined, "should be cleared");
});