mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-07-31 04:12:10 +03:00
* docs: move superpowers/research artifacts to isolated _tasks repo + docs tree cleanup
- Move docs/superpowers/{plans,specs} and docs/research/* into the gitignored,
separately-versioned _tasks/ repo; untrack the two tracked research design docs.
- Add CLAUDE.md "Planning & Research Artifacts" section overriding the superpowers
default save paths (docs/... -> _tasks/...); align REPOSITORY_MAP and
DOCUMENTATION_OVERHAUL_PLAN with the new convention.
- Drop 4 now-obsolete /api/discovery/* entries from check-docs-symbols allowlist
(stale-enforcement) and refresh code/spec path comments to _tasks/...
- Sweeps in concurrent docs-tree restructuring (root-level provider/guide docs,
compression spec cleanup, .mcp.json.example removal).
* docs: reorganize docs/ tree + fix stale facts across ~26 docs
Phase A — reorganization:
- Move 7 orphan root docs into subfolders (providers/ created; TIERS+USAGE_QUOTA→guides/;
plugins+PLUGIN_SDK→frameworks/); delete 8 obsolete/redundant docs (SUBMIT_PR superseded
by CONTRIBUTING; DOCUMENTATION_OVERHAUL_PLAN; INCIDENT_RESPONSE/PERF_BUDGETS/THREAT_MODEL;
3 ops snapshots). Rebuild README index (was missing ~40 files) + per-folder meta.json nav.
- Clean 14 dangling doc-path references in bin/ ops scripts, scripts/, workflow, tests;
fix the dockerignore-docs-coverage required-docs path (PROVIDERS→providers/CLAUDE_WEB).
Phase B — content accuracy (verified against code, not the audit summary):
- Functional: ENVIRONMENT flag defaults (INPUT_SANITIZER/MCP_ENFORCE_SCOPES=true,
COMPRESS_DESCRIPTIONS=false, dynamic heap); MCP-SERVER notion tool names (omniroute_*→
notion_*) + counts 87→94; coverage gate 75/70→60/60/60/60 (RELEASE_CHECKLIST, COVERAGE_PLAN,
ERROR_SANITIZATION, CONTRIBUTING); pre-push hook description; regenerate PROVIDER_REFERENCE (237).
- Count drift: providers 237, executors 70, migrations 106, db modules 94, oauth 19,
strategies 17, MCP 94, flags 38, TS 6.0, open-sse ~900/services 294 across architecture/
frameworks/ops docs; AUTO-COMBO 9→12 factors w/ correct DEFAULT_WEIGHTS; REASONING +2
patterns; STEALTH UA defaults; AGENT_PROTOCOLS +cursor-cloud/list-capabilities;
LANGUAGE_PACKS +id pack.
- Kept Node 20 (runtime guard accepts 20.20.2+; only engines is stricter) and MCP scopes=13
(mcpScopes.ts) — both were correct in the docs; corrected only the attribution.
* docs: finish content refresh — compression engines, CLI_TOKEN merge, metadata sweep
- Compression: document the additional built-in engines (CCR, headroom, ionizer,
session-dedup) in COMPRESSION_ENGINES; clarify LLMLingua-2 is the ultra-mode SLM
backend + cross-ref the extra engines in EXTENDING_COMPRESSION; add the id
(Indonesian) language pack to LANGUAGE_PACKS.
- AUTO-COMBO: replace the orphan 'How tiers fit' weight table (stale weights) with a
pointer to the canonical 12-factor DEFAULT_WEIGHTS table.
- Security: merge CLI_TOKEN_AUTH.md (legacy 32-char SHA-256 format) into CLI_TOKEN.md
as a 'Legacy format — still accepted' section (server accepts both HMAC + legacy),
delete CLI_TOKEN_AUTH.md, drop it from the index + security nav.
- Metadata: bump stale frontmatter (version/lastUpdated) to 3.8.40/2026-06-28 across the
doc set audited this pass, and normalize the in-body 'Last updated' header lines to match.
* fix(runtime): drop Node 20 from supported range + align all docs/diagrams/counts
- Node minimum is now 22 (aligned with package.json engines). SUPPORTED_NODE_RANGE in
src/shared/utils/nodeRuntimeSupport.ts (and the bin/ mirror) drops the 20.x line →
'>=22.22.2 <23 || >=24.0.0 <27'; getNodeRuntimeSupport now rejects Node 20 as
unsupported-major. Test updated (TDD): node-runtime-support.test.ts asserts Node 20
rejected. Docs aligned (TROUBLESHOOTING ×2, TERMUX, RELEASE_CHECKLIST, CODEBASE,
CLI-TOOLS, README, llm.txt + 42 i18n llm.txt mirrors, skills/cli-serve).
- Diagrams regenerated: mcp-tools-87 -> mcp-tools-94 (34 base + pool 6 = 94) and
auto-combo-9factor -> auto-combo-12factor (correct DEFAULT_WEIGHTS); SVGs re-rendered
via mermaid-cli; doc refs + diagrams/README updated; fixed a pre-existing broken
resilience-3layers image path.
- CLAUDE.md + AGENTS.md aligned to real counts (237 providers, 94 MCP tools / 34 base,
106 migrations, 94 db modules, 12-factor auto-combo, 17 strategies); README provider
count 231 -> 237; executor count corrected to 68 (provider executors, excl base/index)
and OAuth to 18 across architecture docs. check:docs-all now passes (0 strict drift,
0 broken links); removed dead .mcp.json.example doc link.
* fix(services): update installer Node hint to >=22.22.2 (aligned with dropped Node 20)
* docs: realign counts to current release tip after rebase
The release tip advanced while this work was in flight (Gemini CLI provider/executor
removed by #5246, plus other PRs). Re-counted against the current code and updated:
providers 237->236, executors 68->67, OAuth modules 18->17, open-sse services 294->298;
regenerated PROVIDER_REFERENCE.md (236). check:docs-all passes (0 strict drift).
* docs(changelog) + i18n: record Node 20 drop + fix nodeIncompatibleHint
- CHANGELOG: add [3.8.40] entries for the Node 20.x removal (runtime) and the docs
reorganization/accuracy audit.
- i18n: nodeIncompatibleHint across all 42 locales no longer lists Node 20.x as
supported (ASCII + CJK full-width variants), aligned with the dropped Node 20.
* fix(docs): repair CI breakages from the doc moves
- test: cli-plugin-system asserted docs/dev/plugins.md exists; the file moved to
docs/frameworks/PLUGINS.md — point the test at the new path (Unit fast-path 2/2 fix).
- frontmatter: PLUGINS.md and PLUGIN_SDK.md moved into the fumadocs-indexed
docs/frameworks/ which requires a 'title' frontmatter; the missing frontmatter
failed the Next.js MDX build (dast-smoke 'invalid frontmatter'). Added frontmatter
to both, plus the providers/ docs (consistency; that folder is not indexed).
196 lines
7.3 KiB
TypeScript
196 lines
7.3 KiB
TypeScript
import test from "node:test";
|
|
import assert from "node:assert/strict";
|
|
import { existsSync, readFileSync, mkdirSync, writeFileSync, rmSync } from "node:fs";
|
|
import { join, dirname } from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
import { tmpdir, homedir } from "node:os";
|
|
|
|
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
const ROOT = join(__dirname, "..", "..");
|
|
|
|
test("bin/cli/plugins.mjs exporta discoverPlugins, loadPlugins, buildPluginContext", async () => {
|
|
const mod = await import("../../bin/cli/plugins.mjs");
|
|
assert.equal(typeof mod.discoverPlugins, "function");
|
|
assert.equal(typeof mod.loadPlugins, "function");
|
|
assert.equal(typeof mod.buildPluginContext, "function");
|
|
});
|
|
|
|
test("discoverPlugins retorna array vazio se nenhum plugin instalado (diretório não existe)", async () => {
|
|
const { discoverPlugins } = await import("../../bin/cli/plugins.mjs");
|
|
const orig = process.env.OMNIROUTE_PLUGIN_PATH;
|
|
process.env.OMNIROUTE_PLUGIN_PATH = join(tmpdir(), `no-such-dir-${Date.now()}`);
|
|
try {
|
|
const plugins = await discoverPlugins();
|
|
assert.ok(Array.isArray(plugins));
|
|
} finally {
|
|
if (orig === undefined) delete process.env.OMNIROUTE_PLUGIN_PATH;
|
|
else process.env.OMNIROUTE_PLUGIN_PATH = orig;
|
|
}
|
|
});
|
|
|
|
test("discoverPlugins descobre plugin com package.json válido", async () => {
|
|
const { discoverPlugins } = await import("../../bin/cli/plugins.mjs");
|
|
const pluginDir = join(tmpdir(), `omniroute-plugins-test-${Date.now()}`);
|
|
const pkgDir = join(pluginDir, "omniroute-cmd-test-hello");
|
|
mkdirSync(pkgDir, { recursive: true });
|
|
writeFileSync(
|
|
join(pkgDir, "package.json"),
|
|
JSON.stringify({
|
|
name: "omniroute-cmd-test-hello",
|
|
version: "1.0.0",
|
|
type: "module",
|
|
main: "index.mjs",
|
|
})
|
|
);
|
|
writeFileSync(join(pkgDir, "index.mjs"), `export function register() {}`);
|
|
|
|
const orig = process.env.OMNIROUTE_PLUGIN_PATH;
|
|
process.env.OMNIROUTE_PLUGIN_PATH = pluginDir;
|
|
try {
|
|
const plugins = await discoverPlugins();
|
|
assert.ok(
|
|
plugins.some((p) => p.name === "omniroute-cmd-test-hello"),
|
|
"deve encontrar o plugin"
|
|
);
|
|
} finally {
|
|
if (orig === undefined) delete process.env.OMNIROUTE_PLUGIN_PATH;
|
|
else process.env.OMNIROUTE_PLUGIN_PATH = orig;
|
|
try {
|
|
rmSync(pluginDir, { recursive: true });
|
|
} catch {}
|
|
}
|
|
});
|
|
|
|
test("discoverPlugins ignora pacotes sem prefixo omniroute-cmd-", async () => {
|
|
const { discoverPlugins } = await import("../../bin/cli/plugins.mjs");
|
|
const pluginDir = join(tmpdir(), `omniroute-plugins-test-${Date.now()}`);
|
|
const pkgDir = join(pluginDir, "some-unrelated-package");
|
|
mkdirSync(pkgDir, { recursive: true });
|
|
writeFileSync(
|
|
join(pkgDir, "package.json"),
|
|
JSON.stringify({ name: "some-unrelated-package", version: "1.0.0" })
|
|
);
|
|
|
|
const orig = process.env.OMNIROUTE_PLUGIN_PATH;
|
|
process.env.OMNIROUTE_PLUGIN_PATH = pluginDir;
|
|
try {
|
|
const plugins = await discoverPlugins();
|
|
assert.ok(
|
|
!plugins.some((p) => p.name === "some-unrelated-package"),
|
|
"não deve descobrir pacotes sem prefixo"
|
|
);
|
|
} finally {
|
|
if (orig === undefined) delete process.env.OMNIROUTE_PLUGIN_PATH;
|
|
else process.env.OMNIROUTE_PLUGIN_PATH = orig;
|
|
try {
|
|
rmSync(pluginDir, { recursive: true });
|
|
} catch {}
|
|
}
|
|
});
|
|
|
|
test("loadPlugins não quebra CLI quando plugin tem erro de load (try/catch)", async () => {
|
|
const { loadPlugins } = await import("../../bin/cli/plugins.mjs");
|
|
const pluginDir = join(tmpdir(), `omniroute-plugins-test-${Date.now()}`);
|
|
const pkgDir = join(pluginDir, "omniroute-cmd-broken");
|
|
mkdirSync(pkgDir, { recursive: true });
|
|
writeFileSync(
|
|
join(pkgDir, "package.json"),
|
|
JSON.stringify({
|
|
name: "omniroute-cmd-broken",
|
|
version: "1.0.0",
|
|
type: "module",
|
|
main: "broken.mjs",
|
|
})
|
|
);
|
|
writeFileSync(join(pkgDir, "broken.mjs"), "throw new Error('intentional load error');");
|
|
|
|
const orig = process.env.OMNIROUTE_PLUGIN_PATH;
|
|
process.env.OMNIROUTE_PLUGIN_PATH = pluginDir;
|
|
const { Command } = await import("commander");
|
|
const prog = new Command();
|
|
try {
|
|
// Deve não lançar exceção
|
|
await assert.doesNotReject(async () => loadPlugins(prog));
|
|
} finally {
|
|
if (orig === undefined) delete process.env.OMNIROUTE_PLUGIN_PATH;
|
|
else process.env.OMNIROUTE_PLUGIN_PATH = orig;
|
|
try {
|
|
rmSync(pluginDir, { recursive: true });
|
|
} catch {}
|
|
}
|
|
});
|
|
|
|
test("loadPlugins carrega plugin válido e chama register()", async () => {
|
|
const { loadPlugins } = await import("../../bin/cli/plugins.mjs");
|
|
const pluginDir = join(tmpdir(), `omniroute-plugins-test-${Date.now()}`);
|
|
const pkgDir = join(pluginDir, "omniroute-cmd-valid");
|
|
mkdirSync(pkgDir, { recursive: true });
|
|
writeFileSync(
|
|
join(pkgDir, "package.json"),
|
|
JSON.stringify({
|
|
name: "omniroute-cmd-valid",
|
|
version: "1.0.0",
|
|
type: "module",
|
|
main: "index.mjs",
|
|
})
|
|
);
|
|
// Plugin que adiciona um comando 'testcmd'
|
|
writeFileSync(
|
|
join(pkgDir, "index.mjs"),
|
|
`export function register(program) { program.command('testcmd-from-plugin'); }`
|
|
);
|
|
|
|
const orig = process.env.OMNIROUTE_PLUGIN_PATH;
|
|
process.env.OMNIROUTE_PLUGIN_PATH = pluginDir;
|
|
const { Command } = await import("commander");
|
|
const prog = new Command();
|
|
try {
|
|
const count = await loadPlugins(prog);
|
|
assert.ok(count >= 1, "deve ter carregado pelo menos 1 plugin");
|
|
assert.ok(
|
|
prog.commands.some((c) => c.name() === "testcmd-from-plugin"),
|
|
"comando do plugin deve estar registrado"
|
|
);
|
|
} finally {
|
|
if (orig === undefined) delete process.env.OMNIROUTE_PLUGIN_PATH;
|
|
else process.env.OMNIROUTE_PLUGIN_PATH = orig;
|
|
try {
|
|
rmSync(pluginDir, { recursive: true });
|
|
} catch {}
|
|
}
|
|
});
|
|
|
|
test("commands/plugin.mjs exporta registerPlugin", async () => {
|
|
const mod = await import("../../bin/cli/commands/plugin.mjs");
|
|
assert.equal(typeof mod.registerPlugin, "function");
|
|
});
|
|
|
|
test("registerPlugin registra subcomandos: list, install, remove, info, search, update, scaffold", async () => {
|
|
const { registerPlugin } = await import("../../bin/cli/commands/plugin.mjs");
|
|
const { Command } = await import("commander");
|
|
const prog = new Command().exitOverride();
|
|
registerPlugin(prog);
|
|
const pluginCmd = prog.commands.find((c) => c.name() === "plugin");
|
|
assert.ok(pluginCmd, "plugin command deve existir");
|
|
const names = pluginCmd.commands.map((c) => c.name());
|
|
for (const sub of ["list", "install", "remove", "info", "search", "update", "scaffold"]) {
|
|
assert.ok(names.includes(sub), `plugin ${sub} deve existir`);
|
|
}
|
|
});
|
|
|
|
test("exemplo omniroute-cmd-hello existe e tem register()", () => {
|
|
const examplePath = join(ROOT, "examples", "omniroute-cmd-hello", "index.mjs");
|
|
assert.ok(existsSync(examplePath), "exemplo index.mjs deve existir");
|
|
const src = readFileSync(examplePath, "utf8");
|
|
assert.ok(src.includes("export function register"), "deve exportar register");
|
|
assert.ok(src.includes("export const meta"), "deve exportar meta");
|
|
});
|
|
|
|
test("docs/frameworks/PLUGINS.md existe", () => {
|
|
const docPath = join(ROOT, "docs", "frameworks", "PLUGINS.md");
|
|
assert.ok(existsSync(docPath), "docs/frameworks/PLUGINS.md deve existir");
|
|
const src = readFileSync(docPath, "utf8");
|
|
assert.ok(src.includes("omniroute-cmd"), "deve mencionar omniroute-cmd");
|
|
assert.ok(src.includes("register(program, ctx)"), "deve documentar a API register");
|
|
});
|