Files
OmniRoute/tests/unit/ui/compressionPanel.test.tsx
Diego Rodrigues de Sa e Souza 95e6522720 feat(compression): unified config panel — single source for engine on/off + level (Phase 1) (#4432)
* 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.
2026-06-20 19:07:39 -03:00

221 lines
7.1 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";
import {
ENGINE_IDS,
engineMeta,
} from "../../../open-sse/services/compression/engineCatalog.ts";
// i18n does not resolve to a real locale in vitest/jsdom, so mock next-intl to echo
// the key. This test therefore asserts ONLY on i18n-independent strings: catalog
// labels/descriptions, engine ids, data-testid hooks, and the PUT request body.
vi.mock("next-intl", () => ({
useTranslations: () => (key: string) => key,
}));
// ── Harness ─────────────────────────────────────────────────────────────────
const containers: HTMLElement[] = [];
const roots: Array<{ unmount: () => void }> = [];
function mount(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 = "";
});
async function flush() {
await act(async () => {
for (let i = 0; i < 10; i++) await Promise.resolve();
});
}
// ── Fetch stub ────────────────────────────────────────────────────────────────
interface CapturedPut {
url: string;
body: Record<string, unknown>;
}
function setupFetchMock(): { puts: CapturedPut[] } {
const puts: CapturedPut[] = [];
const json = (body: unknown, status = 200) =>
new Response(JSON.stringify(body), {
status,
headers: { "Content-Type": "application/json" },
});
const initialConfig = {
enabled: true,
defaultMode: "stacked",
autoTriggerTokens: 0,
cacheMinutes: 5,
preserveSystemPrompt: true,
comboOverrides: {},
engines: {
rtk: { enabled: true, level: "standard" },
caveman: { enabled: false },
},
activeComboId: null,
cavemanOutputMode: { enabled: false, intensity: "full", autoClarity: true },
};
vi.spyOn(globalThis, "fetch").mockImplementation(
async (input: RequestInfo | URL, init?: RequestInit) => {
const url = input.toString();
const method = (init?.method ?? "GET").toUpperCase();
if (url.includes("/api/settings/compression/mcp-accessibility")) {
if (method === "PUT") {
puts.push({ url, body: JSON.parse(String(init?.body ?? "{}")) });
return json({ enabled: true });
}
return json({ enabled: true, maxTextChars: 50000 });
}
if (url.includes("/api/settings/compression")) {
if (method === "PUT") {
const body = JSON.parse(String(init?.body ?? "{}"));
puts.push({ url, body });
// Echo a merged config so the panel keeps a coherent state.
return json({ ...initialConfig, ...body });
}
return json(initialConfig);
}
return json({}, 404);
}
);
return { puts };
}
// ── Tests ─────────────────────────────────────────────────────────────────────
describe("CompressionPanel", () => {
it("renders a row for every engine id in the catalog", async () => {
setupFetchMock();
const { default: CompressionPanel } = await import(
"../../../src/app/(dashboard)/dashboard/context/settings/CompressionPanel"
);
let container!: HTMLElement;
await act(async () => {
container = mount(<CompressionPanel />);
});
await flush();
for (const id of ENGINE_IDS) {
const row = container.querySelector(`[data-testid="engine-row-${id}"]`);
expect(row, `expected a row for engine "${id}"`).toBeTruthy();
// Catalog label/description are hardcoded English (i18n-independent).
expect(container.textContent).toContain(engineMeta(id).label);
}
});
it("shows the rtk level 'standard' as selected", async () => {
setupFetchMock();
const { default: CompressionPanel } = await import(
"../../../src/app/(dashboard)/dashboard/context/settings/CompressionPanel"
);
let container!: HTMLElement;
await act(async () => {
container = mount(<CompressionPanel />);
});
await flush();
const select = container.querySelector(
`[data-testid="engine-row-rtk"] select`
) as HTMLSelectElement | null;
expect(select).toBeTruthy();
expect(select?.value).toBe("standard");
});
it("toggling caveman PUTs engines.caveman.enabled === true", async () => {
const { puts } = setupFetchMock();
const { default: CompressionPanel } = await import(
"../../../src/app/(dashboard)/dashboard/context/settings/CompressionPanel"
);
let container!: HTMLElement;
await act(async () => {
container = mount(<CompressionPanel />);
});
await flush();
// The data-testid hook wraps the Toggle; its inner <button role="switch"> is the
// clickable element.
const toggle = container.querySelector(
`[data-testid="engine-toggle-caveman"] button`
) as HTMLButtonElement | null;
expect(toggle, "caveman toggle must exist").toBeTruthy();
await act(async () => {
toggle!.click();
});
await flush();
const settingsPuts = puts.filter(
(p) => p.url.includes("/api/settings/compression") && !p.url.includes("mcp-accessibility")
);
expect(settingsPuts.length).toBeGreaterThan(0);
const lastEngines = settingsPuts
.map((p) => p.body.engines as Record<string, { enabled: boolean }> | undefined)
.filter(Boolean)
.pop();
expect(lastEngines).toBeTruthy();
expect(lastEngines!.caveman.enabled).toBe(true);
// Full engines map is sent (whole-row persistence), so rtk is not dropped.
expect(lastEngines!.rtk.enabled).toBe(true);
});
it("derived-pipeline preview reflects the enabled engines", async () => {
setupFetchMock();
const { default: CompressionPanel } = await import(
"../../../src/app/(dashboard)/dashboard/context/settings/CompressionPanel"
);
let container!: HTMLElement;
await act(async () => {
container = mount(<CompressionPanel />);
});
await flush();
const preview = container.querySelector(`[data-testid="derived-pipeline-preview"]`);
expect(preview).toBeTruthy();
// Only rtk is enabled in the initial config → preview mentions rtk, not caveman.
expect(preview?.textContent).toContain("rtk");
expect(preview?.textContent).not.toContain("caveman");
});
});