mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-05 23:02:10 +03:00
* fix(gemini): preserve structured tool calls for antigravity * fix(gemini): parse prefixed textual tool calls * fix(antigravity): preserve textual SSE tool calls * fix(stream): normalize textual passthrough tool calls * fix(stream): normalize split textual tool calls * fix(stream): suppress malformed textual tool calls * fix(stream): suppress compact malformed tool calls * fix(stream): emit structured textual tool calls * fix(stream): suppress unknown textual tool calls * fix(stream): normalize responses textual tool calls * chore: ignore .claude/settings.local.json (per-user Claude Code permissions) * fix(opencode-go): route qwen3.x via claude messages + repair fixMissingToolResponses for Claude-shape upstreams (#2791) Integrated into release/v3.8.6 * fix: resolve npm install warnings — remove dead deps, relax engine constraint (#2792) Integrated into release/v3.8.6 * fix: register missing web-cookie validators (claude-web, gemini-web, copilot-web, t3-web) (#2793) Integrated into release/v3.8.6 * fix: Error: Unable to inspect existing database #2771 (#2795) Integrated into release/v3.8.6 * fix(oauth): repair Google loopback callback flow (#2796) Integrated into release/v3.8.6 * feat(logs): add clean history button (#2799) Integrated into release/v3.8.6 * [codex] home: restore settings-driven home layout and quota auto-refresh (#2800) Integrated into release/v3.8.6 * fix(gemini): emit signaturelessToolCallMode:text for GEMINI format models (#2801) Integrated into release/v3.8.6 * feat(modelSpecs): align opencode-go family with upstream provider limits (#2802) Integrated into release/v3.8.6 * chore: apply unit test fixes, polyfills, and environment precedence fixes * docs(agents): atualiza fluxos de release e triagem Expande os workflows de release para incluir auditoria de segurança, CHANGELOG completo por commits, quality gate obrigatório, homologação em VPS local, publicação oficial, deploy em Akamai e validação de artefatos. Reorganiza a triagem de features com arquivos permanentes por bucket, suporte a itens em andamento, regra de reclaim após 15 dias e novo tratamento para ideias viáveis catalogadas. Corrige a orientação de revisão de discussões para usar a ordem cronológica real dos comentários e respostas ao identificar a última atividade. * fix(lockout): classify Gemini Antigravity resource exhaustion as quota_exhausted * fix(reasoning): gate replay by interleaved field * docs(rule-16): permit human Co-authored-by, restrict only AI/bot trailers Rule #16 previously banned all `Co-Authored-By` trailers absolutely. That blocked the upstream-port workflows (`/port-upstream-features` and `/port-upstream-issues`), which must credit human upstream PR authors and issue reporters in OmniRoute commits. Refine the rule to ban only AI/bot-attributed trailers (Claude, GPT, Copilot, Bot; anthropic.com / openai.com / bot-owned noreply.github.com emails) while allowing standard human `Co-authored-by: Name <email>` attribution. Sync the rule across the source CLAUDE.md, the E2E shakedown doc note, and 41 i18n translations. * fix(gitlawb): add specialty validators for connection test — bypass /models probe GitLawB OpenGateway API (xiaomi-mimo compatible) does not expose a /models endpoint, causing validateOpenAILikeProvider to 404 on the initial probe and report 'Provider validation endpoint not supported'. Add specialty validators for both gitlawb and gitlawb-gmi that follow the same pattern as the existing xiaomi-mimo validator: skip GET /models, validate directly via POST /chat/completions with a minimal test message. Any 401/403 response means an invalid key; all other responses mean auth is OK. Fixes test-connection returning 404 for GitLawB providers. * test(gitlawb): add 12 unit tests for gitlawb and gitlawb-gmi specialty validators Covers success, auth failure (401/403), non-auth acceptance (400/422/429), network errors, and custom baseUrl overrides for both providers. * feat(gitlawb): serve models from static registry without API-unavailable warning GitLawB's OpenGateway API does not expose a /models endpoint per provider-path. Previously the models route fell through to the generic fallback which returned static catalog models with the misleading 'API unavailable — using local catalog' warning. Now gitlawb and gitlawb-gmi are handled as static model providers (same pattern as reka and qwen OAuth) — models are served from the provider registry without any warning, since all registered models are functional via POST /chat/completions. * refactor(gitlawb): extract shared opengateway validator factory, fix docs path in test - Extract gitlawb/gitlawb-gmi validators into buildOpengatewayValidator factory - Fix dockerignore-docs-coverage test: update stale docs/AUTO-COMBO.md -> docs/routing/AUTO-COMBO.md * fix(reasoning): guard interleaved capability lookup * feat(gitlawb): dynamic model fetch with gmi-cloud fallback Hybrid approach: - gitlawb (xiaomi-mimo): dynamic /models endpoint → 356 models - gitlawb-gmi (gmi-cloud): 404 fallback → local catalog gracefully Mimics Gitlawb/openclaude's model-routing pattern * i18n(pt-BR): complete missing translations and sync with en.json * feat(build): nix multi-OS package manager install (#2806) Integrated into release/v3.8.6 * fix(i18n): translate 144 new __MISSING__ pt-BR strings (#2816) Integrated into release/v3.8.6 * chore(docs): set coverage gate to 40/40/40/40 in CLAUDE.md Aligns the documented coverage gate with the v3.8.6 release decision (lowered from 75/75/75/70). Matches the threshold already set in package.json by the large feature PRs (planos 11-22). * fix(cli): respect PORT env var in serve command (#2845) Integrated into release/v3.8.6. * fix(deepseek-web): return 400 when client sends tools[] - chat.deepseek.com has no tool support (#2854) Integrated into release/v3.8.6. * fix(qoder): reject invalid/expired PATs returning Cosy 500 error (#2860) Integrated into release/v3.8.6. * fix(cli): register openclaw in tool-detector (#2833) (#2850) Integrated into release/v3.8.6. * fix(api): include noAuth providers in /v1/models catalog (#2798) (#2814) Integrated into release/v3.8.6. * fix(combo): resolve custom provider targets via combo name (#2778) (#2812) Integrated into release/v3.8.6. * fix(translator): strip safety_identifier in openai-responses cleanup (#2770) (#2809) Integrated into release/v3.8.6. * fix(quota): honor explicit per-connection preflight opt-out (#2831) (#2844) Integrated into release/v3.8.6. * fix(usage): un-invert GitHub Copilot Free/limited quota — limited_user_quotas is remaining (#2876) (#2881) Integrated into release/v3.8.6. * fix(nous-research): correct baseUrl to include /chat/completions (#2826) (#2835) Integrated into release/v3.8.6. * fix(opencode): qwen3.x max/plus models lack vision support (#2822) (#2836) Integrated into release/v3.8.6. * fix(translator): pass-through tool_search built-in tool type (#2766) (#2811) Integrated into release/v3.8.6. * fix(github): route claude-opus-4.6 via chat completions (#2821) Integrated into release/v3.8.6. * docs(oauth): add Windsurf login fix design (Phase 1 hotfix + Phase 2 Firebase OAuth) Two-phase plan to fix the broken Windsurf OAuth flow: - Phase 1: drop the dead app.devin.ai/editor/signin PKCE path, promote import-token from windsurf.com/show-auth-token as the primary path - Phase 2: port Firebase OAuth + RegisterUser flow from fendoushaonian/WindSurf-gRPC-API for full browser-based automation Spec only - no code changes yet. * docs(plan): Phase 1 windsurf login hotfix implementation plan 10 tasks covering: - TDD assertions for flowType + 410 Gone responses - Provider switch to import_token - Route handler retiring authorize/start-callback-server/poll-callback - OAuthModal UI override - i18n sync - Verification + PR steps * fix(cli): replace cli-table3 with hand-rolled formatter (#2752) (#2813) Integrated into release/v3.8.6. * fix(skills): skip interception for unregistered client-native tools (#2815) (#2817) Integrated into release/v3.8.6. * feat(sse): add RTK filters for kubectl, docker-build, composer, gh (#2824) Integrated into release/v3.8.6. * fix(geminiHelper): support rec.image content shape + warn on dropped remote URLs (refs #2807) (#2855) Integrated into release/v3.8.6. * fix(cli): allow nullable/optional apiKey in cliMitmStartSchema (#2857) Integrated into release/v3.8.6. * fix(combo): preserve system messages during context handoff summary generation (#2865) Integrated into release/v3.8.6. * fix: wire CLIProxyAPI fallback settings into chatCore routing engine (#2866) Integrated into release/v3.8.6. * fix(usage): add opencode quota fetcher (#2852) (#2867) Integrated into release/v3.8.6. * feat(claude): default xhigh support for newer Opus models (#2874) Integrated into release/v3.8.6. * fix(cli): restore omniroute logs command stream (#2756) (#2810) Integrated into release/v3.8.6. * fix(combo): normalize upstream Headers for Node 24 undici interop (#2751) (#2823) Integrated into release/v3.8.6. * Rename proxy log Public IP to Client IP (#2880) Integrated into release/v3.8.6. * fix(claude): preserve max effort for supported models (#2875) Integrated into release/v3.8.6. * fix(oauth): switch windsurf provider to import_token flow The PKCE auth URL targeting app.devin.ai/editor/signin returns 404 post-rebrand. Until Phase 2 ports Firebase OAuth + RegisterUser, the only supported path is import-token via windsurf.com/show-auth-token. - windsurf.ts: drop buildAuthUrl, set flowType=import_token - generateAuthData returns supported:false + helpful error for windsurf/devin-cli - tests: assert flowType + disabled stub * fix(oauth): return 410 Gone for retired windsurf/devin-cli PKCE actions start-callback-server, authorize, and poll-callback (GET + POST) now return 410 Gone with a pointer to /import-token. The 410 short-circuit runs before auth so the response is honest about the action being permanently gone, not gated. Codex PKCE flow unchanged. Tests: 5 new assertions cover GET + POST 410 paths and a Codex regression check. * refactor(oauth): annotate retired PKCE fields in WINDSURF_CONFIG No behaviour change - comment-only update documenting that authorizeUrl, codeChallengeMethod, callbackPort, callbackPath, apiServerUrl, and exchangePath are no longer consumed. Active fields (inferenceUrl, showAuthTokenUrl, firebaseApiKey, ideName) called out separately. * fix(cli,docs): use requireCliToolsAuth in logs route + document OPENCODE quota env Post-merge contract fixes for v3.8.6: - src/app/api/cli-tools/logs/route.ts (#2810) now uses the shared requireCliToolsAuth guard (param renamed req->request) to satisfy the cli-tools-auth-hardening contract test. - Document OMNIROUTE_OPENCODE_QUOTA_URL (#2867) in docs/reference/ENVIRONMENT.md to satisfy the env/docs sync contract. * fix(dashboard): force import-token panel for windsurf/devin-cli Phase 1 hotfix: hide the 'Browser Login' tab and start in Paste API Key mode. Removes windsurf/devin-cli from PKCE_CALLBACK_SERVER_PROVIDERS so no callback server is started for them. Codex still uses the PKCE flow. The 'Get token' link continues to point at windsurf.com/show-auth-token via the existing supportsTokenPaste form copy. * fix(oauth): windsurf import-token mapTokens signature mismatch The route at `src/app/api/oauth/[provider]/[action]/route.ts` invokes `providerData.mapTokens({ accessToken: token })` (object), matching the cursor/kiro signature. The windsurf provider was declared with `mapTokens(token: string)` instead, so the entire object was stored as `accessToken`. When the connection record reached the SQLite layer it crashed with: SQLite3 can only bind numbers, strings, bigints, buffers, and null Fix by aligning windsurf's `mapTokens` signature with the route caller and the cursor/kiro convention. Also dedupe a copy-pasted second `if (action === "import-token")` block in the route handler — the second block was unreachable but identical to the first. Adds two regression tests asserting that `provider.mapTokens({ accessToken })` returns a string `accessToken` for both windsurf and devin-cli, so a future signature drift trips the gate instead of the SQLite bind error in production. * feat(compression): expand pt-BR pack with troglodita rules (15 → 49) (#2818) Integrated into release/v3.8.6 * fix(sse): repair RTK engine defaults so dedup and direct calls work (#2825) Integrated into release/v3.8.6 * fix(mcp): redirect console.log/warn to stderr in --mcp stdio mode (#2840) Integrated into release/v3.8.6 * fix(gemini-cli): prefer real project IDs over default-project (#2841) Integrated into release/v3.8.6 * fix(opencode-go): add provider limits quota fetcher (#2861) Integrated into release/v3.8.6 * Audit & add web cookie providers: fix 4 missing registry entries + DuckDuckGo (#2862) Integrated into release/v3.8.6 * fix(antigravity): harden signatureless tool history (#2878) Integrated into release/v3.8.6 * fix: provider model sync pruning and dynamic antigravity MITM proxy mappings (#2886) Integrated into release/v3.8.6 * feat(usage): per-API-key token limits scoped to model/provider/global (#2888) Integrated into release/v3.8.6 * fix(audio): build multipart body manually to preserve Content-Type (#2842) Integrated into release/v3.8.6 * refactor: remove agent skill documentation files and streamline maintenance workflows * test(stabilization): resolve unit test failures in blackbox-web, schema-coercion, translator-helper-branches, usage-service-hardening, and audio-transcription * fix(security): mitigate Socket.dev supply-chain findings + secrets opt-in + minimal build profile (#2863) (#2871) Two real security gaps closed and four cosmetic Socket.dev fingerprints removed. See docs/security/SOCKET_DEV_FINDINGS.md for the per-finding maintainer attestation. Real bugs fixed: - cloudSync: HMAC verification of `X-Cloud-Sig` + opt-in `OMNIROUTE_CLOUD_SYNC_SECRETS=true` before overwriting `accessToken` / `refreshToken` / `providerSpecificData` from a remote response. Closes the silent-credential-swap surface (a misconfigured or hostile CLOUD_URL could previously replace local tokens unverified). - Zed import: split into 2-step `/discover` + `/import` flow. `/import` now requires `confirmedAccounts: [{ service, account, fingerprint }]` and re-reads the keychain server-side to filter by fingerprint, so a tampered discover response cannot trick the endpoint into saving an unrelated token. Cosmetic Socket.dev mitigations: - runElevatedPowerShell writes the elevated payload to a per-call temp `.ps1` file (mode 0o600) and references it via `-File`. Removes the textbook `-EncodedCommand <base64utf16le>` pattern flagged as malware by Socket's AI classifier. - Maintainer attestation `SECURITY-AUDITOR-NOTE:` blocks added at every flagged call site pointing to `docs/security/SOCKET_DEV_FINDINGS.md`. Build-time hardening: - `OMNIROUTE_BUILD_PROFILE=minimal` (`npm run build:secure`) physically removes the four sensitive modules from the standalone bundle via webpack `NormalModuleReplacementPlugin`. Stubs throw `FeatureDisabledError` at runtime. Intended for the `omniroute-secure` artifact. Tests: - 24 new unit tests in `tests/unit/security/` covering the wrapper builder, HMAC verification (4 cases), credential fingerprint determinism (5 cases), confirmedAccounts validation + fingerprint filtering (6 cases), and the minimal-build stubs (5 cases). Docs: - New `docs/security/SOCKET_DEV_FINDINGS.md` — per-finding attestation. - New `socket.yml` — Socket.dev v2 config pointing at the attestation. - Updated `SECURITY.md` — supply-chain scanner section. - Updated `.env.example` — three new env vars documented. Backwards compatibility: - Cloud sync token overwrite is OFF by default. Users who relied on it must set `OMNIROUTE_CLOUD_SYNC_SECRETS=true`. Breaking change documented in CHANGELOG. - Zed import 2-step is the new default; legacy 1-step preserved behind `OMNIROUTE_ZED_IMPORT_LEGACY_ONE_STEP=true` and will be removed in v3.9. Closes #2863 * fix(security): redact public Firebase Web key from windsurf spec; doc SHA-256 cache-key rationale (#2894) Two security-scanning findings on release/v3.8.6: - Secret-scanning alert 7 (google_api_key): the windsurf login-fix design spec embedded the literal public Firebase Web API key on two lines. Firebase Web API keys are non-sensitive by design (they identify the project; access is gated by Firebase Security Rules + key restrictions), but the literal trips secret scanning. Redacted to a placeholder; the embedded default still goes through resolvePublicCred per rule #11. - Code-scanning alert 261 (js/insufficient-password-hash): tokenCacheKey() uses SHA-256 to derive an in-memory cache key from the session token, not for password-at-rest storage. Added a comment documenting why CWE-916 KDFs do not apply (false positive). * fix(ci): resolve release/v3.8.6 gate failures (docs-sync, any-budget, pack-artifact) (#2895) * fix(ci): resolve release/v3.8.6 gate failures (docs-sync, any-budget, pack-artifact) Three CI gates failed on release/v3.8.6 (run 26630300877): - docs-sync: CHANGELOG had a spurious "## [3.8.6-patch]" section above "## [3.8.6]", so the latest release no longer matched package.json (3.8.6) and the 41 i18n CHANGELOG mirrors were flagged as missing that section. Fold the lone #2752 entry into [3.8.6] and drop the patch heading. - any-budget:t11: open-sse/handlers/chatCore.ts regressed to 1 explicit `any` (budget 0). Type the persist callback arg as Record<string, unknown>, which matches runWithOnPersist's RefreshPersistFn contract exactly. - pack-artifact: open-sse/utils/setupPolyfill.ts ships via package.json "files" (bin/omniroute.mjs imports it at startup) but was missing from the pack policy allowlist. Allow it and add a regression test. * fix(security): redact public Firebase Web key from windsurf spec Redact the literal public Firebase Web API key (secret-scanning #7) to a placeholder, mirroring the redaction on release/v3.8.6 (PR #2894) and the windsurf fix branch. Non-sensitive public Web key; trips secret scanning. * feat(combo): Zero-Latency Combos (Hedging, Proactive Compression, Predictive TTFT) (#2868) * feat(combo): implement zero-latency combo optimizations (hedging, proactive compression, predictive TTFT) * fix(combo): fix predictive TTFT skip logic and unhandled promise rejections --------- Co-authored-by: Automation <automation@omniroute> * feat: implement automated skill workflows and update system configuration and validation schemas * test: eliminate dynamic cast warnings in cloud-sync unit test * test: isolate services-branch-hardening database directory to avoid concurrency issues * feat(providers): add 7 new web-cookie providers + research catalog + discovery tool New providers: - huggingchat: free LLM chat via huggingface.co/chat (no subscription) - phind: free dev-focused AI chat via phind.com/api/agent - poe-web: multi-model chat via poe.com GraphQL (p-b cookie) - venice-web: privacy-focused AI chat via venice.ai (session cookie) - v0-vercel-web: Vercel v0 code gen via v0.dev (session cookie) - kimi-web: Moonshot Kimi chat via kimi.moonshot.cn (session cookie) - doubao-web: ByteDance Doubao chat via doubao.com (session cookie) Additional: - Research catalog: docs/research/UNLIMITED_LLM_ACCESS.md - Discovery tool design + stub: src/lib/discovery/ + migration 073 - Unit tests: 33 tests for all 7 providers - Shared helpers consolidated in error.ts (slop cleanup) - All registered in WEB_COOKIE_PROVIDERS + providerRegistry + webSessionCredentials Closes #2885 * fix(typecheck): resolve typecheck errors in combo spec and compression modules * feat(api,oauth): add `agy` (Antigravity CLI) standalone provider with CLI token import (#2899) Add a standalone OAuth provider `agy` (Antigravity CLI) next to gemini-cli/antigravity. It reuses the antigravity inference backend (identical Google client_id + daily-cloudcode-pa.googleapis.com endpoint, executor and token-refresh) but ships its own model catalog — including the Claude models the backend exposes (claude-opus-4-6-thinking, claude-sonnet-4-6) — its own account pool, and four ways to connect: - token-file import (paste/upload the agy oauth token JSON) - auto-detect a local CLI login (~/.gemini/antigravity-cli/antigravity-oauth-token) - browser OAuth (via the shared OAuthModal Google loopback flow) - bulk / ZIP import New routes: POST /api/providers/agy-auth/{import,import-bulk,zip-extract,apply-local}. Catalog pinned from the live :fetchAvailableModels endpoint. Docs (openapi.yaml, ENVIRONMENT.md, .env.example, CHANGELOG) updated; new unit tests for registration, the token parser, and route auth-hardening. * fix(security): redact public Firebase Web key from windsurf spec (#2896) Redact the literal public Firebase Web API key (secret-scanning #7) to a placeholder. Firebase Web API keys are non-sensitive by design but the literal trips GitHub secret scanning. Mirrors the redaction landed on release/v3.8.6 (PR #2894). Embedded default still flows through resolvePublicCred (rule #11). * Pr 2871 (#2897) * fix(security): mitigate Socket.dev supply-chain findings + secrets opt-in + minimal build profile (#2863) Two real security gaps closed and four cosmetic Socket.dev fingerprints removed. See docs/security/SOCKET_DEV_FINDINGS.md for the per-finding maintainer attestation. Real bugs fixed: - cloudSync: HMAC verification of `X-Cloud-Sig` + opt-in `OMNIROUTE_CLOUD_SYNC_SECRETS=true` before overwriting `accessToken` / `refreshToken` / `providerSpecificData` from a remote response. Closes the silent-credential-swap surface (a misconfigured or hostile CLOUD_URL could previously replace local tokens unverified). - Zed import: split into 2-step `/discover` + `/import` flow. `/import` now requires `confirmedAccounts: [{ service, account, fingerprint }]` and re-reads the keychain server-side to filter by fingerprint, so a tampered discover response cannot trick the endpoint into saving an unrelated token. Cosmetic Socket.dev mitigations: - runElevatedPowerShell writes the elevated payload to a per-call temp `.ps1` file (mode 0o600) and references it via `-File`. Removes the textbook `-EncodedCommand <base64utf16le>` pattern flagged as malware by Socket's AI classifier. - Maintainer attestation `SECURITY-AUDITOR-NOTE:` blocks added at every flagged call site pointing to `docs/security/SOCKET_DEV_FINDINGS.md`. Build-time hardening: - `OMNIROUTE_BUILD_PROFILE=minimal` (`npm run build:secure`) physically removes the four sensitive modules from the standalone bundle via webpack `NormalModuleReplacementPlugin`. Stubs throw `FeatureDisabledError` at runtime. Intended for the `omniroute-secure` artifact. Tests: - 24 new unit tests in `tests/unit/security/` covering the wrapper builder, HMAC verification (4 cases), credential fingerprint determinism (5 cases), confirmedAccounts validation + fingerprint filtering (6 cases), and the minimal-build stubs (5 cases). Docs: - New `docs/security/SOCKET_DEV_FINDINGS.md` — per-finding attestation. - New `socket.yml` — Socket.dev v2 config pointing at the attestation. - Updated `SECURITY.md` — supply-chain scanner section. - Updated `.env.example` — three new env vars documented. Backwards compatibility: - Cloud sync token overwrite is OFF by default. Users who relied on it must set `OMNIROUTE_CLOUD_SYNC_SECRETS=true`. Breaking change documented in CHANGELOG. - Zed import 2-step is the new default; legacy 1-step preserved behind `OMNIROUTE_ZED_IMPORT_LEGACY_ONE_STEP=true` and will be removed in v3.9. Closes #2863 * feat: implement automated skill workflows and update system configuration and validation schemas * test: eliminate dynamic cast warnings in cloud-sync unit test * test: isolate services-branch-hardening database directory to avoid concurrency issues * chore(docs): refresh generated docs collection index Update the generated Fumadocs browser collection mapping to keep documentation imports in sync with the current docs structure. * docs: update generated browser docs collection manifest Refresh the generated Fumadocs browser collection mapping so the docs site can resolve the current documentation files correctly. --------- Co-authored-by: OpenClaw <openclaw@kuzhomesrv.local> Co-authored-by: Dmitry Kuznetsov <139351986+dmitry@users.noreply.local> Co-authored-by: KuzyaBot <kuzya@local> Co-authored-by: JeferssonLemes <jeferssondev@gmail.com> Co-authored-by: Paijo <14921983+oyi77@users.noreply.github.com> Co-authored-by: Markus Hartung <mail@hartmark.se> Co-authored-by: akarray <akarray@users.noreply.github.com> Co-authored-by: Apostol Apostolov <theapoapostolov@gmail.com> Co-authored-by: Hernan Javier Ardila Sanchez <hjasgr@gmail.com> Co-authored-by: Dmitry Kuznetsov <dmitry@kuznetsov.me> Co-authored-by: Nikolay Alafuzov <alafuzov_nn@rusklimat.ru> Co-authored-by: oyi77 <oyi77@users.noreply.github.com> Co-authored-by: Ronaldo Davi <alltomatos@users.noreply.github.com> Co-authored-by: levonk <277861+levonk@users.noreply.github.com> Co-authored-by: Lenine Júnior <lenine@engrene.com.br> Co-authored-by: Annas Alghoffar <aag.annas@gmail.com> Co-authored-by: Tushar Agarwal <76201310+Tushar49@users.noreply.github.com> Co-authored-by: GreatLiu <eurasiaxz@qq.com> Co-authored-by: yuna amelia <230527278+yunaamelia@users.noreply.github.com> Co-authored-by: Randi <55005611+rdself@users.noreply.github.com> Co-authored-by: Container <78986709+disonjer@users.noreply.github.com> Co-authored-by: nickwizard <35692452+nickwizard@users.noreply.github.com> Co-authored-by: Rajvardhan Patil <rajvardhanpatil7890@gmail.com> Co-authored-by: Raxxoor <manker_lol@hotmail.com> Co-authored-by: Muhammad Mugni Hadi <mugnimaestra3@gmail.com> Co-authored-by: mi <123757457+soyelmismo@users.noreply.github.com> Co-authored-by: Automation <automation@omniroute>
416 lines
27 KiB
Markdown
416 lines
27 KiB
Markdown
# CLAUDE.md (Nederlands)
|
|
|
|
🌐 **Languages:** 🇺🇸 [English](../../../CLAUDE.md) · 🇸🇦 [ar](../ar/CLAUDE.md) · 🇦🇿 [az](../az/CLAUDE.md) · 🇧🇬 [bg](../bg/CLAUDE.md) · 🇧🇩 [bn](../bn/CLAUDE.md) · 🇨🇿 [cs](../cs/CLAUDE.md) · 🇩🇰 [da](../da/CLAUDE.md) · 🇩🇪 [de](../de/CLAUDE.md) · 🇪🇸 [es](../es/CLAUDE.md) · 🇮🇷 [fa](../fa/CLAUDE.md) · 🇫🇮 [fi](../fi/CLAUDE.md) · 🇫🇷 [fr](../fr/CLAUDE.md) · 🇮🇳 [gu](../gu/CLAUDE.md) · 🇮🇱 [he](../he/CLAUDE.md) · 🇮🇳 [hi](../hi/CLAUDE.md) · 🇭🇺 [hu](../hu/CLAUDE.md) · 🇮🇩 [id](../id/CLAUDE.md) · 🇮🇩 [in](../in/CLAUDE.md) · 🇮🇹 [it](../it/CLAUDE.md) · 🇯🇵 [ja](../ja/CLAUDE.md) · 🇰🇷 [ko](../ko/CLAUDE.md) · 🇮🇳 [mr](../mr/CLAUDE.md) · 🇲🇾 [ms](../ms/CLAUDE.md) · 🇳🇴 [no](../no/CLAUDE.md) · 🇵🇭 [phi](../phi/CLAUDE.md) · 🇵🇱 [pl](../pl/CLAUDE.md) · 🇵🇹 [pt](../pt/CLAUDE.md) · 🇧🇷 [pt-BR](../pt-BR/CLAUDE.md) · 🇷🇴 [ro](../ro/CLAUDE.md) · 🇷🇺 [ru](../ru/CLAUDE.md) · 🇸🇰 [sk](../sk/CLAUDE.md) · 🇸🇪 [sv](../sv/CLAUDE.md) · 🇰🇪 [sw](../sw/CLAUDE.md) · 🇮🇳 [ta](../ta/CLAUDE.md) · 🇮🇳 [te](../te/CLAUDE.md) · 🇹🇭 [th](../th/CLAUDE.md) · 🇹🇷 [tr](../tr/CLAUDE.md) · 🇺🇦 [uk-UA](../uk-UA/CLAUDE.md) · 🇵🇰 [ur](../ur/CLAUDE.md) · 🇻🇳 [vi](../vi/CLAUDE.md) · 🇨🇳 [zh-CN](../zh-CN/CLAUDE.md)
|
|
|
|
---
|
|
|
|
Dit bestand biedt richtlijnen voor Claude Code (claude.ai/code) bij het werken met code in deze repository.
|
|
|
|
## Snelle Start
|
|
|
|
```bash
|
|
npm install # Installeer afhankelijkheden (genereert automatisch .env vanuit .env.example)
|
|
npm run dev # Dev-server op http://localhost:20128
|
|
npm run build # Productiebouw (Next.js 16 standalone)
|
|
npm run lint # ESLint (0 fouten verwacht; waarschuwingen zijn al aanwezig)
|
|
npm run typecheck:core # TypeScript controle (zou schoon moeten zijn)
|
|
npm run typecheck:noimplicit:core # Strikte controle (geen impliciete any)
|
|
npm run test:coverage # Eenheidstests + dekkingseis (75/75/75/70 — statements/lines/functions/branches)
|
|
npm run check # lint + test gecombineerd
|
|
npm run check:cycles # Detecteer circulaire afhankelijkheden
|
|
```
|
|
|
|
### Tests Uitvoeren
|
|
|
|
```bash
|
|
# Enkele testbestand (Node.js native test runner — de meeste tests)
|
|
node --import tsx/esm --test tests/unit/your-file.test.ts
|
|
|
|
# Vitest (MCP-server, autoCombo, cache)
|
|
npm run test:vitest
|
|
|
|
# Alle suites
|
|
npm run test:all
|
|
```
|
|
|
|
Voor de volledige testmatrix, zie `CONTRIBUTING.md` → "Tests Uitvoeren". Voor diepgaande architectuur, zie `AGENTS.md`.
|
|
|
|
---
|
|
|
|
## Project in een Oogopslag
|
|
|
|
**OmniRoute** — verenigde AI proxy/router. Eén eindpunt, 160+ LLM-providers, automatische fallback.
|
|
|
|
| Laag | Locatie | Doel |
|
|
| ------------- | ----------------------- | ---------------------------------------------------------------------------- |
|
|
| API Routes | `src/app/api/v1/` | Next.js App Router — toegangspunten |
|
|
| Handlers | `open-sse/handlers/` | Verzoekverwerking (chat, embeddings, enz.) |
|
|
| Executors | `open-sse/executors/` | Provider-specifieke HTTP dispatch |
|
|
| Translators | `open-sse/translator/` | Formaatconversie (OpenAI↔Claude↔Gemini) |
|
|
| Transformer | `open-sse/transformer/` | Antwoorden API ↔ Chat Completes |
|
|
| Services | `open-sse/services/` | Combo-routing, snelheidslimieten, caching, enz. |
|
|
| Database | `src/lib/db/` | SQLite domeinmodules (45+ bestanden, 55 migraties) |
|
|
| Domein/Beleid | `src/domain/` | Beleid engine, kostenregels, fallback-logica |
|
|
| MCP Server | `open-sse/mcp-server/` | 37 tools (30 basis + 3 geheugen + 4 vaardigheden), 3 transporten, ~13 scopes |
|
|
| A2A Server | `src/lib/a2a/` | JSON-RPC 2.0 agentprotocol |
|
|
| Vaardigheden | `src/lib/skills/` | Uitbreidbaar vaardighedenframework |
|
|
| Geheugen | `src/lib/memory/` | Persistente conversatiemonitor |
|
|
|
|
Monorepo: `src/` (Next.js 16 app), `open-sse/` (streaming engine workspace), `electron/` (desktop app), `tests/`, `bin/` (CLI-toegangspunt).
|
|
|
|
---
|
|
|
|
## Verzoekpijplijn
|
|
|
|
```
|
|
Client → /v1/chat/completions (Next.js route)
|
|
→ CORS → Zod-validatie → auth? → beleidscontrole → promptinjectiebescherming
|
|
→ handleChatCore() [open-sse/handlers/chatCore.ts]
|
|
→ cachecontrole → snelheidslimiet → combo-routing?
|
|
→ resolveComboTargets() → handleSingleModel() per target
|
|
→ translateRequest() → getExecutor() → executor.execute()
|
|
→ fetch() upstream → opnieuw proberen met backoff
|
|
→ responsvertaling → SSE-stream of JSON
|
|
→ Als Responses API: responsesTransformer.ts TransformStream
|
|
```
|
|
|
|
API-routes volgen een consistent patroon: `Route → CORS preflight → Zod body validatie → Optionele auth (extractApiKey/isValidApiKey) → Handhaving van API-sleutelbeleid → Handler delegatie (open-sse)`. Geen globale Next.js middleware — onderschepping is route-specifiek.
|
|
|
|
**Combo-routing** (`open-sse/services/combo.ts`): 14 strategieën (prioriteit, gewogen, vul-eerst, round-robin, P2C, willekeurig, minst-gebruikt, kosten-geoptimaliseerd, reset-bewust, strikt-willekeurig, auto, lkgp, context-geoptimaliseerd, context-relay). Elke target roept `handleSingleModel()` aan, dat `handleChatCore()` omhult met foutafhandeling per target en circuitbreaker-controles. Zie `docs/routing/AUTO-COMBO.md` voor de 9-factor Auto-Combo scoring en `docs/architecture/RESILIENCE_GUIDE.md` voor de 3 veerkrachtlagen.
|
|
|
|
---
|
|
|
|
## Veerkracht Runtime Status
|
|
|
|
OmniRoute heeft drie gerelateerde maar verschillende mechanismen voor tijdelijke fouten. Houd hun
|
|
bereik gescheiden bij het debuggen van routeringsgedrag. Zie het
|
|
[3-laags veerkracht diagram](./docs/diagrams/exported/resilience-3layers.svg)
|
|
(bron: [docs/diagrams/resilience-3layers.mmd](./docs/diagrams/resilience-3layers.mmd))
|
|
voor een overzichtskaart.
|
|
|
|
### Provider Circuit Breaker
|
|
|
|
**Bereik**: hele provider, bijv. `glm`, `openai`, `anthropic`.
|
|
|
|
**Doel**: stop met het verzenden van verkeer naar een provider die herhaaldelijk faalt op het
|
|
upstream/service-niveau, zodat één ongezonde provider niet elke aanvraag vertraagt.
|
|
|
|
**Implementatie**:
|
|
|
|
- Kernklasse: `src/shared/utils/circuitBreaker.ts`
|
|
- Chat gate/executiewiring: `src/sse/handlers/chatHelpers.ts`, `src/sse/handlers/chat.ts`
|
|
- Runtime status API: `src/app/api/monitoring/health/route.ts`
|
|
- Gedeelde wrappers: `open-sse/services/accountFallback.ts`
|
|
- Persistente status tabel: `domain_circuit_breakers`
|
|
|
|
**Statussen**:
|
|
|
|
- `CLOSED`: normaal verkeer is toegestaan.
|
|
- `OPEN`: provider is tijdelijk geblokkeerd; aanroepers krijgen een provider-circuit-open respons
|
|
of combo-routing slaat over naar een andere target.
|
|
- `HALF_OPEN`: resettimeout is verstreken; sta een probe-aanroep toe. Succes sluit de
|
|
breaker, falen opent deze opnieuw.
|
|
|
|
**Standaarden** (`open-sse/config/constants.ts`):
|
|
|
|
- OAuth-providers: drempel `3`, resettimeout `60s`.
|
|
- API-sleutelproviders: drempel `5`, resettimeout `30s`.
|
|
- Lokale providers: drempel `2`, resettimeout `15s`.
|
|
|
|
Alleen provider-niveau foutstatussen zouden de provider breaker moeten activeren:
|
|
|
|
```ts
|
|
(408, 500, 502, 503, 504);
|
|
```
|
|
|
|
Activeer de hele-provider breaker niet voor normale account/sleutel/model fouten zoals de meeste
|
|
`401`, `403`, of `429` gevallen. Die behoren meestal tot verbinding cooldown of model
|
|
lockout. Een generieke API-sleutelprovider `403` zou hersteld moeten kunnen worden, tenzij deze wordt geclassificeerd
|
|
als een terminal provider/account fout.
|
|
|
|
De breaker gebruikt luie herstel, geen achtergrondtimer. Wanneer `OPEN` verloopt, lezen zoals
|
|
`getStatus()`, `canExecute()`, en `getRetryAfterMs()` vernieuwen de status naar
|
|
`HALF_OPEN`, zodat dashboards en combo-kandidaatbouwers niet blijven uitsluiten van een
|
|
verlopen provider voor altijd.
|
|
|
|
### Verbinding Cooldown
|
|
|
|
**Bereik**: één providerverbinding/account/sleutel.
|
|
|
|
**Doel**: tijdelijk één slechte sleutel/account overslaan terwijl andere verbindingen voor
|
|
dezelfde provider doorgaan met het bedienen van aanvragen.
|
|
|
|
**Implementatie**:
|
|
|
|
- Schrijf/update pad: `src/sse/services/auth.ts::markAccountUnavailable()`
|
|
- Accountselectie/filtering: `src/sse/services/auth.ts::getProviderCredentials...`
|
|
- Cooldown-berekening: `open-sse/services/accountFallback.ts::checkFallbackError()`
|
|
- Instellingen: `src/lib/resilience/settings.ts`
|
|
|
|
Belangrijke velden op providerverbindingen:
|
|
|
|
```ts
|
|
rateLimitedUntil;
|
|
testStatus: "unavailable";
|
|
lastError;
|
|
lastErrorType;
|
|
errorCode;
|
|
backoffLevel;
|
|
```
|
|
|
|
Tijdens accountselectie wordt een verbinding overgeslagen terwijl:
|
|
|
|
```ts
|
|
new Date(rateLimitedUntil).getTime() > Date.now();
|
|
```
|
|
|
|
Cooldowns zijn ook lui: wanneer `rateLimitedUntil` in het verleden ligt, wordt de verbinding
|
|
weer in aanmerking genomen. Bij succesvol gebruik, `clearAccountError()` wist `testStatus`,
|
|
`rateLimitedUntil`, foutvelden en `backoffLevel`.
|
|
|
|
Standaardgedrag voor verbinding cooldown:
|
|
|
|
- OAuth basis cooldown: `5s`.
|
|
- API-sleutel basis cooldown: `3s`.
|
|
- API-sleutel `429` zou de voorkeur moeten geven aan upstream retry hints (`Retry-After`, resetheaders, of
|
|
parseerbare resettekst) wanneer beschikbaar.
|
|
- Herhaalde herstelbare fouten gebruiken exponentiële backoff:
|
|
|
|
```ts
|
|
baseCooldownMs * 2 ** failureIndex;
|
|
```
|
|
|
|
De anti-thundering-herd bescherming voorkomt dat gelijktijdige fouten op dezelfde verbinding
|
|
herhaaldelijk de cooldown verlengen of `backoffLevel` dubbel verhogen.
|
|
|
|
Terminal statussen zijn geen cooldowns. `banned`, `expired`, en `credits_exhausted` zijn
|
|
bedoeld om onbeschikbaar te blijven totdat inloggegevens/instellingen veranderen of een operator
|
|
ze reset. Overschrijf terminal statussen niet met tijdelijke cooldownstatus.
|
|
|
|
### Model Lockout
|
|
|
|
**Bereik**: provider + verbinding + model.
|
|
|
|
**Doel**: voorkom dat een hele verbinding wordt uitgeschakeld wanneer slechts één model niet beschikbaar of
|
|
quota-beperkt is voor die verbinding.
|
|
|
|
Voorbeelden:
|
|
|
|
- Per-model quota providers die `429` retourneren.
|
|
- Lokale providers die `404` retourneren voor één ontbrekend model.
|
|
- Provider-specifieke modus/model toestemming fouten zoals geselecteerde Grok-modi.
|
|
|
|
Model lockout bevindt zich in `open-sse/services/accountFallback.ts` en laat dezelfde
|
|
verbinding andere modellen blijven bedienen.
|
|
|
|
### Debugging Richtlijnen
|
|
|
|
- Als alle sleutels voor een provider worden overgeslagen, inspecteer zowel de provider breaker status als elke
|
|
verbinding's `rateLimitedUntil`/`testStatus`.
|
|
- Als een provider permanent uitgesloten lijkt na het resetvenster, controleer of de code
|
|
ruwe `state` leest in plaats van `getStatus()`/`canExecute()`.
|
|
- Als één provider sleutel faalt maar anderen zouden moeten werken, geef de voorkeur aan verbinding cooldown boven
|
|
provider breaker.
|
|
- Als slechts één model faalt, geef de voorkeur aan model lockout boven verbinding cooldown.
|
|
- Als een status zichzelf zou moeten herstellen, moet deze een toekomstige timestamp/resettimeout hebben en een
|
|
leespad dat verlopen status vernieuwt. Permanente statussen vereisen handmatige wijziging van inloggegevens
|
|
of configuratie.
|
|
|
|
## Belangrijke Conventies
|
|
|
|
### Code Stijl
|
|
|
|
- **2 spaties**, puntkomma's, dubbele aanhalingstekens, 100 tekens breed, es5 trailing commas (afgedwongen door lint-staged via Prettier)
|
|
- **Imports**: extern → intern (`@/`, `@omniroute/open-sse`) → relatief
|
|
- **Naming**: bestanden=camelCase/kebab, componenten=PascalCase, constanten=UPPER_SNAKE
|
|
- **ESLint**: `no-eval`, `no-implied-eval`, `no-new-func` = fout overal; `no-explicit-any` = waarschuwing in `open-sse/` en `tests/`
|
|
- **TypeScript**: `strict: false`, doel ES2022, module esnext, resolutie bundelaar. Geef de voorkeur aan expliciete types.
|
|
|
|
### Database
|
|
|
|
- **Ga altijd** via `src/lib/db/` domeinmodules — **schrijf nooit** ruwe SQL in routes of handlers
|
|
- **Voeg nooit** logica toe aan `src/lib/localDb.ts` (alleen re-exportlaag)
|
|
- **Barrel-import nooit** van `localDb.ts` — importeer in plaats daarvan specifieke `db/` modules
|
|
- DB singleton: `getDbInstance()` van `src/lib/db/core.ts` (WAL journaling)
|
|
- Migraties: `src/lib/db/migrations/` — versiegebonden SQL-bestanden, idempotent, uitgevoerd in transacties
|
|
|
|
### Foutafhandeling
|
|
|
|
- try/catch met specifieke fouttypes, log met pino context
|
|
- Slurp nooit fouten in SSE-stromen — gebruik abort-signalen voor opruiming
|
|
- Geef juiste HTTP-statuscodes terug (4xx/5xx)
|
|
|
|
### Beveiliging
|
|
|
|
- **Gebruik nooit** `eval()`, `new Function()`, of impliciete eval
|
|
- Valideer alle invoer met Zod-schema's
|
|
- Versleutel inloggegevens in rust (AES-256-GCM)
|
|
- Upstream header denylist: `src/shared/constants/upstreamHeaders.ts` — houd sanitization, Zod-schema's en eenheidstests in lijn bij het bewerken
|
|
- **Openbare upstream inloggegevens** (Gemini/Antigravity/Windsurf-stijl OAuth client_id/secret + Firebase Web-sleutels geëxtraheerd uit openbare CLI's): **MOETEN** worden ingebed via `resolvePublicCred()` van `open-sse/utils/publicCreds.ts` — **nooit** als string literals. Zie `docs/security/PUBLIC_CREDS.md` voor het verplichte patroon.
|
|
- **Foutreacties** (HTTP / SSE / executor / MCP handler): **MOETEN** door `buildErrorBody()` of `sanitizeErrorMessage()` van `open-sse/utils/error.ts` worden geleid — **nooit** ruwe `err.stack` of `err.message` in een reactiebody plaatsen. Zie `docs/security/ERROR_SANITIZATION.md`.
|
|
- **Shell-opdrachten opgebouwd uit variabelen**: bij het aanroepen van `exec()`/`spawn()` met een script dat runtime-waarden nodig heeft, geef ze door via de `env` optie (automatisch shell-escaped) — **nooit** onbetrouwbare/externe paden in de scriptbody interpoleren. Referentie: `src/mitm/cert/install.ts::updateNssDatabases`.
|
|
- **Secure-by-default bibliotheken** ([tldrsec/awesome-secure-defaults](https://github.com/tldrsec/awesome-secure-defaults)): geef de voorkeur aan Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink boven aangepaste implementaties wanneer je nieuwe beveiligingsgevoelige oppervlakken toevoegt.
|
|
|
|
---
|
|
|
|
## Veelvoorkomende Wijzigingsscenario's
|
|
|
|
### Een Nieuwe Provider Toevoegen
|
|
|
|
1. Registreer in `src/shared/constants/providers.ts` (Zod-gevalideerd bij laden)
|
|
2. Voeg executor toe in `open-sse/executors/` als aangepaste logica nodig is (verleng `BaseExecutor`)
|
|
3. Voeg vertaler toe in `open-sse/translator/` als niet-OpenAI formaat
|
|
4. Voeg OAuth-configuratie toe in `src/lib/oauth/constants/oauth.ts` als op OAuth gebaseerd — als de upstream CLI een openbare client_id/secret levert, embed dan via `resolvePublicCred()` (zie `docs/security/PUBLIC_CREDS.md`), **nooit** als een literal
|
|
5. Registreer modellen in `open-sse/config/providerRegistry.ts`
|
|
6. Schrijf tests in `tests/unit/` (inclusief de publicCreds shape assertion als je een nieuwe ingebedde standaard hebt toegevoegd)
|
|
|
|
### Een Nieuwe API Route Toevoegen
|
|
|
|
1. Maak een directory onder `src/app/api/v1/your-route/`
|
|
2. Maak `route.ts` met `GET`/`POST` handlers
|
|
3. Volg het patroon: CORS → Zod body validatie → optionele auth → handler delegatie
|
|
4. Handler gaat in `open-sse/handlers/` (importeer van daar, niet inline)
|
|
5. Foutreacties gebruiken `buildErrorBody()` / `errorResponse()` van `open-sse/utils/error.ts` (automatisch gesanitiseerd — plaats nooit `err.stack` of `err.message` ruw in de body). Zie `docs/security/ERROR_SANITIZATION.md`.
|
|
6. Voeg tests toe — inclusief ten minste één assertion dat foutreacties geen stack traces lekken (`!body.error.message.includes("at /")`)
|
|
|
|
### Een Nieuwe DB Module Toevoegen
|
|
|
|
1. Maak `src/lib/db/yourModule.ts` — importeer `getDbInstance` van `./core.ts`
|
|
2. Exporteer CRUD-functies voor je domeintabel(len)
|
|
3. Voeg migratie toe in `src/lib/db/migrations/` als nieuwe tabellen nodig zijn
|
|
4. Re-exporteer van `src/lib/localDb.ts` (voeg alleen toe aan de re-exportlijst)
|
|
5. Schrijf tests
|
|
|
|
### Een Nieuwe MCP Tool Toevoegen
|
|
|
|
1. Voeg tooldefinitie toe in `open-sse/mcp-server/tools/` met Zod invoerschema + asynchrone handler
|
|
2. Registreer in de toolset (verbonden door `createMcpServer()`)
|
|
3. Wijs toe aan de juiste scope(s)
|
|
4. Schrijf tests (toolaanroep gelogd in `mcp_audit` tabel)
|
|
|
|
### Een Nieuwe A2A Skill Toevoegen
|
|
|
|
1. Maak skill in `src/lib/a2a/skills/` (5 bestaan al: smart-routing, quota-management, provider-discovery, cost-analysis, health-report)
|
|
2. Skill ontvangt taakcontext (berichten, metadata) → retourneert gestructureerd resultaat
|
|
3. Registreer in `A2A_SKILL_HANDLERS` in `src/lib/a2a/taskExecution.ts`
|
|
4. Expose in `src/app/.well-known/agent.json/route.ts` (Agent Card)
|
|
5. Schrijf tests in `tests/unit/`
|
|
6. Documenteer in `docs/frameworks/A2A-SERVER.md` skill tabel
|
|
|
|
### Een Nieuwe Cloud Agent Toevoegen
|
|
|
|
1. Maak agentklasse in `src/lib/cloudAgent/agents/` die `CloudAgentBase` uitbreidt (3 bestaan al: codex-cloud, devin, jules)
|
|
2. Implementeer `createTask`, `getStatus`, `approvePlan`, `sendMessage`, `listSources`
|
|
3. Registreer in `src/lib/cloudAgent/registry.ts`
|
|
4. Voeg OAuth/inloggegevensverwerking toe indien nodig (`src/lib/oauth/providers/`)
|
|
5. Tests + documenteer in `docs/frameworks/CLOUD_AGENT.md`
|
|
|
|
### Een Nieuwe Guardrail / Eval / Skill / Webhook evenement Toevoegen
|
|
|
|
- Guardrail: `src/lib/guardrails/` → docs: `docs/security/GUARDRAILS.md`
|
|
- Eval suite: `src/lib/evals/` → docs: `docs/frameworks/EVALS.md`
|
|
- Skill (sandbox): `src/lib/skills/` → docs: `docs/frameworks/SKILLS.md`
|
|
- Webhook evenement: `src/lib/webhookDispatcher.ts` → docs: `docs/frameworks/WEBHOOKS.md`
|
|
|
|
## Referentiedocumentatie
|
|
|
|
Voor elke niet-triviale wijziging, lees eerst de bijbehorende diepgaande analyse:
|
|
|
|
| Gebied | Document |
|
|
| ------------------------------------------------ | ----------------------------------------------------------------- |
|
|
| Repo-navigatie | `docs/architecture/REPOSITORY_MAP.md` |
|
|
| Architectuur | `docs/architecture/ARCHITECTURE.md` |
|
|
| Engineeringreferentie | `docs/architecture/CODEBASE_DOCUMENTATION.md` |
|
|
| Auto-Combo (9-factor scoring, 14 strategieën) | `docs/routing/AUTO-COMBO.md` |
|
|
| Veerkracht (3 mechanismen) | `docs/architecture/RESILIENCE_GUIDE.md` |
|
|
| Redeneringsherhaling | `docs/routing/REASONING_REPLAY.md` |
|
|
| Vaardighedenkader | `docs/frameworks/SKILLS.md` |
|
|
| Geheugensysteem (FTS5 + Qdrant) | `docs/frameworks/MEMORY.md` |
|
|
| Cloudagenten | `docs/frameworks/CLOUD_AGENT.md` |
|
|
| Beveiligingsmaatregelen (PII / injectie / visie) | `docs/security/GUARDRAILS.md` |
|
|
| Publieke upstream referenties (Gemini/etc.) | `docs/security/PUBLIC_CREDS.md` |
|
|
| Foutmelding sanering | `docs/security/ERROR_SANITIZATION.md` |
|
|
| Evaluaties | `docs/frameworks/EVALS.md` |
|
|
| Naleving / audit | `docs/security/COMPLIANCE.md` |
|
|
| Webhooks | `docs/frameworks/WEBHOOKS.md` |
|
|
| Autorisatiepipeline | `docs/architecture/AUTHZ_GUIDE.md` |
|
|
| Stealth (TLS / vingerafdruk) | `docs/security/STEALTH_GUIDE.md` |
|
|
| Agentprotocollen (A2A / ACP / Cloud) | `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md` |
|
|
| MCP-server | `docs/frameworks/MCP-SERVER.md` |
|
|
| A2A-server | `docs/frameworks/A2A-SERVER.md` |
|
|
| API-referentie + OpenAPI | `docs/reference/API_REFERENCE.md` + `docs/reference/openapi.yaml` |
|
|
| Leveranciercatalogus (automatisch gegenereerd) | `docs/reference/PROVIDER_REFERENCE.md` |
|
|
| Releaseflow | `docs/ops/RELEASE_CHECKLIST.md` |
|
|
|
|
## Testen
|
|
|
|
| Wat | Opdracht |
|
|
| ----------------------- | --------------------------------------------------------------------------- |
|
|
| Eenheidstests | `npm run test:unit` |
|
|
| Enkel bestand | `node --import tsx/esm --test tests/unit/file.test.ts` |
|
|
| Vitest (MCP, autoCombo) | `npm run test:vitest` |
|
|
| E2E (Playwright) | `npm run test:e2e` |
|
|
| Protocol E2E (MCP+A2A) | `npm run test:protocols:e2e` |
|
|
| Ecosysteem | `npm run test:ecosystem` |
|
|
| Dekking poort | `npm run test:coverage` (75/75/75/70 — statements/lines/functions/branches) |
|
|
| Dekking rapport | `npm run coverage:report` |
|
|
|
|
**PR-regel**: Als je productiecodes in `src/`, `open-sse/`, `electron/`, of `bin/` wijzigt, moet je tests in dezelfde PR opnemen of bijwerken.
|
|
|
|
**Voorkeur testlaag**: eenheid eerst → integratie (multi-module of DB-status) → e2e (UI/workflow alleen). Encodeer bugreproducties als geautomatiseerde tests vóór of samen met de oplossing.
|
|
|
|
**Copilot dekking beleid**: Wanneer een PR productiecodes wijzigt en de dekking onder 75% (statements/lines/functions) of 70% (branches) ligt, rapporteer dan niet alleen — voeg tests toe of werk ze bij, voer de dekking poort opnieuw uit, en vraag vervolgens om bevestiging. Neem uitgevoerde opdrachten, gewijzigde testbestanden en het uiteindelijke dekkingsresultaat op in het PR-rapport.
|
|
|
|
---
|
|
|
|
## Git Workflow
|
|
|
|
```bash
|
|
# Nooit rechtstreeks naar main committen
|
|
git checkout -b feat/your-feature
|
|
git commit -m "feat: beschrijf je wijziging"
|
|
git push -u origin feat/your-feature
|
|
```
|
|
|
|
**Branch-prefixen**: `feat/`, `fix/`, `refactor/`, `docs/`, `test/`, `chore/`
|
|
|
|
**Commitformaat** (Conventional Commits): `feat(db): voeg circuit breaker toe` — scopes: `db`, `sse`, `oauth`, `dashboard`, `api`, `cli`, `docker`, `ci`, `mcp`, `a2a`, `memory`, `skills`
|
|
|
|
**Husky hooks**:
|
|
|
|
- **pre-commit**: lint-staged + `check-docs-sync` + `check:any-budget:t11`
|
|
- **pre-push**: `npm run test:unit`
|
|
|
|
---
|
|
|
|
## Omgeving
|
|
|
|
- **Runtime**: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25, ES Modules
|
|
- **TypeScript**: 5.9+, target ES2022, module esnext, resolution bundler
|
|
- **Padaliassen**: `@/*` → `src/`, `@omniroute/open-sse` → `open-sse/`, `@omniroute/open-sse/*` → `open-sse/*`
|
|
- **Standaardpoort**: 20128 (API + dashboard op dezelfde poort)
|
|
- **Gegevensdirectory**: `DATA_DIR` omgevingsvariabele, standaard `~/.omniroute/`
|
|
- **Belangrijke omgevingsvariabelen**: `PORT`, `JWT_SECRET`, `API_KEY_SECRET`, `INITIAL_PASSWORD`, `REQUIRE_API_KEY`, `APP_LOG_LEVEL`
|
|
- Setup: `cp .env.example .env` en genereer vervolgens `JWT_SECRET` (`openssl rand -base64 48`) en `API_KEY_SECRET` (`openssl rand -hex 32`)
|
|
|
|
---
|
|
|
|
## Strikte Regels
|
|
|
|
1. Nooit geheimen of inloggegevens committen
|
|
2. Nooit logica toevoegen aan `localDb.ts`
|
|
3. Nooit `eval()` / `new Function()` / impliciete eval gebruiken
|
|
4. Nooit rechtstreeks naar `main` committen
|
|
5. Nooit ruwe SQL in routes schrijven — gebruik `src/lib/db/` modules
|
|
6. Nooit stilletjes fouten in SSE-stromen negeren
|
|
7. Altijd invoer valideren met Zod-schema's
|
|
8. Altijd tests opnemen bij het wijzigen van productiecodes
|
|
9. Dekking moet ≥75% (statements, lines, functions) / ≥70% (branches) blijven. Huidige meting: ~82%.
|
|
10. Nooit Husky hooks omzeilen (`--no-verify`, `--no-gpg-sign`) zonder expliciete goedkeuring van de operator.
|
|
11. Nooit openbare upstream OAuth client_id/secret of Firebase Web-sleutels als stringliteral opnemen — altijd via `resolvePublicCred()` (`open-sse/utils/publicCreds.ts`). Zie `docs/security/PUBLIC_CREDS.md`.
|
|
12. Nooit ruwe `err.stack` / `err.message` retourneren in HTTP / SSE / executor-responses — altijd doorsturen via `buildErrorBody()` of `sanitizeErrorMessage()` (`open-sse/utils/error.ts`). Zie `docs/security/ERROR_SANITIZATION.md`.
|
|
13. Nooit externe paden of runtime-waarden in shell-scripts die aan `exec()`/`spawn()` worden doorgegeven, string-interpoleren — geef in plaats daarvan door via de `env` optie. Referentie: `src/mitm/cert/install.ts::updateNssDatabases`.
|
|
14. Nooit een CodeQL / Secret-Scanning waarschuwing negeren zonder (a) eerst de patroon-documentatie hierboven te controleren om te zien of de helper van toepassing is, en (b) de technische rechtvaardiging in de afwijscommentaar vast te leggen. Precedent: `js/stack-trace-exposure` opgegooid op callsites die al via `sanitizeErrorMessage()` gaan, is een bekende CodeQL-beperking (aangepaste sanitizers niet herkend) — afwijzen als `false positive` met verwijzing naar `docs/security/ERROR_SANITIZATION.md`.
|
|
15. Nooit routes blootstellen die kindprocessen opstarten (`/api/mcp/`, `/api/cli-tools/runtime/`) zonder `isLocalOnlyPath()` classificatie in `src/server/authz/routeGuard.ts`. Loopback-afdwinging gebeurt onvoorwaardelijk vóór elke auth-controle — gelekte JWT via tunnel kan geen procesopstarten activeren. Zie `docs/security/ROUTE_GUARD_TIERS.md`.
|
|
16. Neem nooit `Co-Authored-By`-trailers op die een AI-assistent, LLM of automatiseringsaccount crediteren (bijv. namen met "Claude", "GPT", "Copilot", "Bot"; e-mails op `anthropic.com` / `openai.com` / `noreply.github.com`-adressen die eigendom zijn van bots). Dergelijke trailers leiden commit-attributie naar het botaccount op GitHub, waardoor de werkelijke auteur (`diegosouzapw`) in de PR-geschiedenis verborgen blijft. Menselijke medewerkers — inclusief upstream PR-auteurs en issue-rapporteurs die naar OmniRoute worden geport — MOGEN en MOETEN worden gecrediteerd met standaard `Co-authored-by: Name <email>`-trailers; de upstream-port workflows (`/port-upstream-features`, `/port-upstream-issues`) zijn hiervan afhankelijk.
|