mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-06 07:12:12 +03:00
* docs(compression): design spec for the unified compression config panel
Engine-centric central panel (single source for master + per-engine on/off + level),
default pipeline derived from the engines map; Combos page owns named ordered pipelines +
active-profile selection; per-engine pages keep only detailed config. Phased: (1) core
consolidation + Model A migration, (2) named profiles + active selector, (3) per-request
x-omniroute-compression header.
* docs(compression): Phase 1 implementation plan for the unified config panel
12 TDD tasks: engine catalog, engines map + activeComboId, deriveDefaultPlan,
migration 102 + backfill, resolveCompressionPlan, runtime wiring, API, default-combo
shim, the engine-grid panel, consolidation, menu. Ends with a recap + the pending
follow-ups (Phase 2 named profiles/active selector, Phase 3 header, deferred items).
* feat(compression): engine catalog metadata (levels, single-mode, order)
* feat(compression): add engines map + activeComboId to CompressionConfig
* feat(compression): deriveDefaultPlan (engines map -> mode/pipeline)
Pure function that converts a per-engine EngineToggle map + masterEnabled
flag into a { mode, stackedPipeline } plan: off when master is off or no
engines on; single-mode when exactly one single-mode engine is enabled;
stacked (sorted by stackPriority) otherwise.
* feat(compression): persist+backfill engines map and activeComboId (migration 102)
* feat(compression): resolveCompressionPlan precedence resolver (header>override>active>default)
* feat(compression): selectCompressionStrategy uses resolveCompressionPlan
* feat(api): settings/compression carries engines map + activeComboId
Extends compressionSettingsUpdateSchema with engines (Record<string,{enabled:boolean,level?:string}>)
and activeComboId (string|null) so the PUT route accepts and persists these fields.
GET already returns the full getCompressionSettings() object which includes both fields.
TDD: added route round-trip tests (PUT+GET) for engines, activeComboId, null clear,
and schema rejection of invalid engines shape.
* refactor(compression): default-combo route is a read-only shim (default derived from engines)
* feat(dashboard): engine-grid compression panel (single source for on/off + level)
* refactor(dashboard): remove duplicate compression toggles; per-engine pages keep only detailed config
* feat(compression): unified panel menu order + derived-pipeline integration coverage
* fix(compression): import ENGINE_IDS via types re-export so it resolves under vitest
The bare "@omniroute/open-sse/.../engineCatalog.ts" specifier resolves under tsc/tsx
but not under vitest's MCP config: Vite externalizes a brand-new open-sse module to
Node, which can't load the .ts subpath. types.ts is already in Vite's graph, so route
ENGINE_IDS through its re-export. Fixes 3 failing MCP vitest suites (cacheTools,
dbHealthTool, essentialTools).
* fix(compression): engines map drives dispatch only when explicitly panel-saved
Code-review finding: the legacy seeded default combo (present on every install via
migration 042/043) was silently overriding a panel-configured engines map — the
default-combo block in chatCore set compressionComboApplied=true, skipping the
engines-map override, so an operator's panel toggles were ignored.
Gate the engines-map path on a new runtime-only CompressionConfig.enginesExplicit
(true when a stored engines row exists). Panel-saved installs: the engines map is
authoritative (deriveDefaultPlanFromConfig + new enginesMapDerivesStackedPipeline
guard the chatCore default-combo block). Legacy/backfilled installs: the map is
display-only and dispatch stays on the historical defaultMode/default-combo path —
zero behaviour change until the operator opts in via the panel.
Also documents why resolveCacheAwareConfig's getCacheAwareStrategy(config.defaultMode)
arg is safe (skipSystemPrompt is mode-independent).
* docs(compression): add MDX frontmatter + escape inline brace to fix fumadocs build
docs/compression/**/*.md is compiled as MDX by the Next build (fumadocs,
source.config.ts). The two planning docs lacked the required `title`
frontmatter (build error: 'title: expected string, received undefined') and the
design doc had a bare {rtk,caveman} that MDX parsed as a JSX expression. Adds
frontmatter matching the sibling docs and backticks the brace. Fixes the
dast-smoke build step.
224 lines
7.6 KiB
TypeScript
224 lines
7.6 KiB
TypeScript
// @vitest-environment jsdom
|
|
import React, { act } from "react";
|
|
import { createRoot } from "react-dom/client";
|
|
import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
|
|
|
|
// ── Helpers ───────────────────────────────────────────────────────────────
|
|
|
|
const containers: HTMLElement[] = [];
|
|
const roots: Array<{ unmount: () => void }> = [];
|
|
|
|
function mountInContainer(ui: React.ReactElement): HTMLElement {
|
|
const container = document.createElement("div");
|
|
document.body.appendChild(container);
|
|
containers.push(container);
|
|
const root = createRoot(container);
|
|
roots.push(root);
|
|
act(() => {
|
|
root.render(ui);
|
|
});
|
|
return container;
|
|
}
|
|
|
|
beforeEach(() => {
|
|
(
|
|
globalThis as typeof globalThis & { IS_REACT_ACT_ENVIRONMENT?: boolean }
|
|
).IS_REACT_ACT_ENVIRONMENT = true;
|
|
});
|
|
|
|
afterEach(async () => {
|
|
vi.restoreAllMocks();
|
|
await act(async () => {
|
|
while (roots.length > 0) {
|
|
roots.pop()?.unmount();
|
|
}
|
|
});
|
|
for (let i = 0; i < 10; i++) {
|
|
await Promise.resolve();
|
|
}
|
|
while (containers.length > 0) {
|
|
containers.pop()?.remove();
|
|
}
|
|
document.body.innerHTML = "";
|
|
});
|
|
|
|
// ── Mock fetch ────────────────────────────────────────────────────────────
|
|
|
|
const ENGINES = [
|
|
{ id: "session-dedup", name: "Session Dedup", stackPriority: 3, stable: true },
|
|
{ id: "rtk", name: "RTK", stackPriority: 10, stable: true },
|
|
{ id: "caveman", name: "Caveman", stackPriority: 20, stable: true },
|
|
{ id: "llmlingua", name: "LLMLingua-2", stackPriority: 35, stable: false },
|
|
];
|
|
|
|
function enginePayload() {
|
|
return {
|
|
engines: ENGINES.map((e) => ({
|
|
id: e.id,
|
|
name: e.name,
|
|
description: `${e.name} description`,
|
|
icon: "compress",
|
|
stackable: true,
|
|
stackPriority: e.stackPriority,
|
|
metadata: { stable: e.stable },
|
|
configSchema: [],
|
|
})),
|
|
};
|
|
}
|
|
|
|
function setupFetchMock(opts: {
|
|
enabled?: boolean;
|
|
mode?: string;
|
|
pipeline?: Array<{ engine: string }>;
|
|
}) {
|
|
const { enabled = true, mode = "stacked", pipeline = [{ engine: "rtk" }] } = opts;
|
|
const json = (body: unknown, status = 200) =>
|
|
new Response(JSON.stringify(body), {
|
|
status,
|
|
headers: { "Content-Type": "application/json" },
|
|
});
|
|
|
|
vi.spyOn(globalThis, "fetch").mockImplementation(async (input: RequestInfo | URL) => {
|
|
const url = input.toString();
|
|
if (url.includes("/api/settings/compression")) {
|
|
return json({ enabled, defaultMode: mode });
|
|
}
|
|
if (url.includes("/api/compression/engines")) {
|
|
return json(enginePayload());
|
|
}
|
|
if (url.includes("/api/context/combos/default")) {
|
|
return json({ id: "default-caveman", name: "Standard Savings", pipeline });
|
|
}
|
|
if (url.includes("/api/context/combos")) {
|
|
return json({ combos: [] });
|
|
}
|
|
if (url.includes("/api/combos")) {
|
|
return json({ combos: [] });
|
|
}
|
|
if (url.includes("/api/compression/language-packs")) {
|
|
return json({ packs: [] });
|
|
}
|
|
return json({}, 404);
|
|
});
|
|
}
|
|
|
|
async function flush() {
|
|
await act(async () => {
|
|
for (let i = 0; i < 10; i++) await Promise.resolve();
|
|
});
|
|
}
|
|
|
|
// ── Tests ─────────────────────────────────────────────────────────────────
|
|
|
|
describe("CompressionHub", () => {
|
|
it("renders the master switch, mode selector, and the layered pipeline", async () => {
|
|
setupFetchMock({ enabled: true, mode: "stacked", pipeline: [{ engine: "rtk" }] });
|
|
const { default: CompressionHub } =
|
|
await import("../../../src/app/(dashboard)/dashboard/context/combos/CompressionHub");
|
|
|
|
let container!: HTMLElement;
|
|
await act(async () => {
|
|
container = mountInContainer(<CompressionHub />);
|
|
});
|
|
await flush();
|
|
|
|
const text = container.textContent ?? "";
|
|
expect(text).toContain("Compression Hub");
|
|
expect(text).toContain("Token Saver");
|
|
expect(text).toContain("Stacked");
|
|
// Active pipeline engine (from the default combo) renders
|
|
expect(text).toContain("RTK");
|
|
// Inactive engines from the catalog render too
|
|
expect(text).toContain("Caveman");
|
|
// Active-pipeline callout shows when enabled && stacked
|
|
expect(text).toContain("Layer pipeline is active");
|
|
});
|
|
|
|
it("INVARIANT #1: no per-layer control issues a PUT/POST to /api/context/combos/default", { timeout: 20000 }, async () => {
|
|
const comboWrites: { method: string }[] = [];
|
|
const json = (body: unknown, status = 200) =>
|
|
new Response(JSON.stringify(body), {
|
|
status,
|
|
headers: { "Content-Type": "application/json" },
|
|
});
|
|
vi.spyOn(globalThis, "fetch").mockImplementation(
|
|
async (input: RequestInfo | URL, init?: RequestInit) => {
|
|
const url = input.toString();
|
|
if (url.includes("/api/context/combos/default")) {
|
|
if (init?.method === "PUT" || init?.method === "POST") {
|
|
comboWrites.push({ method: init.method });
|
|
}
|
|
return json({ id: "default", name: "Default", pipeline: [{ engine: "rtk" }] });
|
|
}
|
|
if (url.includes("/api/settings/compression")) {
|
|
return json({ enabled: true, defaultMode: "stacked" });
|
|
}
|
|
if (url.includes("/api/compression/engines")) {
|
|
return json(enginePayload());
|
|
}
|
|
if (url.includes("/api/context/combos") || url.includes("/api/combos")) {
|
|
return json({ combos: [] });
|
|
}
|
|
if (url.includes("/api/compression/language-packs")) {
|
|
return json({ packs: [] });
|
|
}
|
|
return json({}, 404);
|
|
}
|
|
);
|
|
|
|
const { default: CompressionHub } =
|
|
await import("../../../src/app/(dashboard)/dashboard/context/combos/CompressionHub");
|
|
|
|
let container!: HTMLElement;
|
|
await act(async () => {
|
|
container = mountInContainer(<CompressionHub />);
|
|
});
|
|
await flush();
|
|
|
|
// Click every on/off switch in the Hub (master + any layer controls that remain).
|
|
const switches = Array.from(container.querySelectorAll('[role="switch"]'));
|
|
for (const sw of switches) {
|
|
await act(async () => {
|
|
(sw as HTMLElement).click();
|
|
});
|
|
await flush();
|
|
}
|
|
|
|
expect(comboWrites).toHaveLength(0);
|
|
});
|
|
|
|
it("shows the activation warning when Token Saver is off", async () => {
|
|
setupFetchMock({ enabled: false, mode: "off", pipeline: [] });
|
|
const { default: CompressionHub } =
|
|
await import("../../../src/app/(dashboard)/dashboard/context/combos/CompressionHub");
|
|
|
|
let container!: HTMLElement;
|
|
await act(async () => {
|
|
container = mountInContainer(<CompressionHub />);
|
|
});
|
|
await flush();
|
|
|
|
const text = container.textContent ?? "";
|
|
expect(text).toContain("Enable Token Saver");
|
|
expect(text).toContain("only run in Stacked mode");
|
|
});
|
|
});
|
|
|
|
describe("CompressionCombosPageClient", () => {
|
|
it("renders the Hub on top and the named-combos manager below", async () => {
|
|
setupFetchMock({ enabled: true, mode: "stacked", pipeline: [{ engine: "rtk" }] });
|
|
const { default: CompressionCombosPageClient } =
|
|
await import("../../../src/app/(dashboard)/dashboard/context/combos/CompressionCombosPageClient");
|
|
|
|
let container!: HTMLElement;
|
|
await act(async () => {
|
|
container = mountInContainer(<CompressionCombosPageClient />);
|
|
});
|
|
await flush();
|
|
|
|
const text = container.textContent ?? "";
|
|
expect(text).toContain("Compression Hub");
|
|
expect(text).toContain("Named combos");
|
|
});
|
|
});
|