mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-05 14:52:09 +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>
412 lines
27 KiB
Markdown
412 lines
27 KiB
Markdown
# CLAUDE.md (Bahasa Indonesia)
|
|
|
|
🌐 **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) · 🇮🇩 [in](../in/CLAUDE.md) · 🇮🇹 [it](../it/CLAUDE.md) · 🇯🇵 [ja](../ja/CLAUDE.md) · 🇰🇷 [ko](../ko/CLAUDE.md) · 🇮🇳 [mr](../mr/CLAUDE.md) · 🇲🇾 [ms](../ms/CLAUDE.md) · 🇳🇱 [nl](../nl/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)
|
|
|
|
---
|
|
|
|
File ini memberikan panduan untuk Claude Code (claude.ai/code) saat bekerja dengan kode di repositori ini.
|
|
|
|
## Memulai dengan Cepat
|
|
|
|
```bash
|
|
npm install # Instal deps (secara otomatis menghasilkan .env dari .env.example)
|
|
npm run dev # Server dev di http://localhost:20128
|
|
npm run build # Build produksi (Next.js 16 standalone)
|
|
npm run lint # ESLint (0 kesalahan yang diharapkan; peringatan sudah ada sebelumnya)
|
|
npm run typecheck:core # Pemeriksaan TypeScript (harus bersih)
|
|
npm run typecheck:noimplicit:core # Pemeriksaan ketat (tidak ada implicit any)
|
|
npm run test:coverage # Unit tests + coverage gate (75/75/75/70 — pernyataan/garis/fungsi/cabang)
|
|
npm run check # lint + test digabungkan
|
|
npm run check:cycles # Deteksi ketergantungan melingkar
|
|
```
|
|
|
|
### Menjalankan Tes
|
|
|
|
```bash
|
|
# File tes tunggal (penguji native Node.js — sebagian besar tes)
|
|
node --import tsx/esm --test tests/unit/your-file.test.ts
|
|
|
|
# Vitest (server MCP, autoCombo, cache)
|
|
npm run test:vitest
|
|
|
|
# Semua suite
|
|
npm run test:all
|
|
```
|
|
|
|
Untuk matriks tes lengkap, lihat `CONTRIBUTING.md` → "Menjalankan Tes". Untuk arsitektur mendalam, lihat `AGENTS.md`.
|
|
|
|
---
|
|
|
|
## Proyek Sekilas
|
|
|
|
**OmniRoute** — proxy/router AI terpadu. Satu endpoint, 160+ penyedia LLM, auto-fallback.
|
|
|
|
| Lapisan | Lokasi | Tujuan |
|
|
| ------------- | ----------------------- | --------------------------------------------------------------------------- |
|
|
| API Routes | `src/app/api/v1/` | Next.js App Router — titik masuk |
|
|
| Handlers | `open-sse/handlers/` | Pemrosesan permintaan (chat, embeddings, dll) |
|
|
| Executors | `open-sse/executors/` | Pengiriman HTTP spesifik penyedia |
|
|
| Translators | `open-sse/translator/` | Konversi format (OpenAI↔Claude↔Gemini) |
|
|
| Transformer | `open-sse/transformer/` | API Respons ↔ Penyelesaian Chat |
|
|
| Services | `open-sse/services/` | Routing combo, batasan laju, caching, dll |
|
|
| Database | `src/lib/db/` | Modul domain SQLite (45+ file, 55 migrasi) |
|
|
| Domain/Policy | `src/domain/` | Mesin kebijakan, aturan biaya, logika fallback |
|
|
| MCP Server | `open-sse/mcp-server/` | 37 alat (30 dasar + 3 memori + 4 keterampilan), 3 transportasi, ~13 lingkup |
|
|
| A2A Server | `src/lib/a2a/` | Protokol agen JSON-RPC 2.0 |
|
|
| Skills | `src/lib/skills/` | Kerangka keterampilan yang dapat diperluas |
|
|
| Memory | `src/lib/memory/` | Memori percakapan yang persisten |
|
|
|
|
Monorepo: `src/` (aplikasi Next.js 16), `open-sse/` (workspace mesin streaming), `electron/` (aplikasi desktop), `tests/`, `bin/` (titik masuk CLI).
|
|
|
|
---
|
|
|
|
## Jalur Permintaan
|
|
|
|
```
|
|
Klien → /v1/chat/completions (rute Next.js)
|
|
→ CORS → validasi Zod → otentikasi? → pemeriksaan kebijakan → penjaga injeksi prompt
|
|
→ handleChatCore() [open-sse/handlers/chatCore.ts]
|
|
→ pemeriksaan cache → batasan laju → routing combo?
|
|
→ resolveComboTargets() → handleSingleModel() per target
|
|
→ translateRequest() → getExecutor() → executor.execute()
|
|
→ fetch() upstream → coba lagi dengan backoff
|
|
→ terjemahan respons → aliran SSE atau JSON
|
|
→ Jika API Respons: responsesTransformer.ts TransformStream
|
|
```
|
|
|
|
Rute API mengikuti pola yang konsisten: `Rute → CORS preflight → validasi body Zod → Otentikasi opsional (extractApiKey/isValidApiKey) → penegakan kebijakan kunci API → Delegasi Handler (open-sse)`. Tidak ada middleware global Next.js — intersepsi bersifat spesifik rute.
|
|
|
|
**Routing combo** (`open-sse/services/combo.ts`): 14 strategi (prioritas, berbobot, isi-pertama, round-robin, P2C, acak, paling-sedikit-digunakan, dioptimalkan-biaya, sadar-reset, acak-ketat, otomatis, lkgp, dioptimalkan-konteks, relay-konteks). Setiap target memanggil `handleSingleModel()` yang membungkus `handleChatCore()` dengan penanganan kesalahan per-target dan pemeriksaan pemutus sirkuit. Lihat `docs/routing/AUTO-COMBO.md` untuk penilaian Auto-Combo 9-faktor dan `docs/architecture/RESILIENCE_GUIDE.md` untuk 3 lapisan ketahanan.
|
|
|
|
---
|
|
|
|
## Status Runtime Ketahanan
|
|
|
|
OmniRoute memiliki tiga mekanisme kegagalan sementara yang terkait tetapi berbeda. Jaga agar ruang lingkup mereka terpisah saat melakukan debug perilaku routing. Lihat
|
|
[diagram ketahanan 3-lapisan](./docs/diagrams/exported/resilience-3layers.svg)
|
|
(sumber: [docs/diagrams/resilience-3layers.mmd](./docs/diagrams/resilience-3layers.mmd))
|
|
untuk peta sekilas.
|
|
|
|
### Pemutus Sirkuit Penyedia
|
|
|
|
**Ruang Lingkup**: seluruh penyedia, misalnya `glm`, `openai`, `anthropic`.
|
|
|
|
**Tujuan**: menghentikan pengiriman lalu lintas ke penyedia yang terus-menerus gagal di tingkat upstream/layanan, sehingga satu penyedia yang tidak sehat tidak memperlambat setiap permintaan.
|
|
|
|
**Implementasi**:
|
|
|
|
- Kelas inti: `src/shared/utils/circuitBreaker.ts`
|
|
- Pengaturan gate/eksekusi chat: `src/sse/handlers/chatHelpers.ts`, `src/sse/handlers/chat.ts`
|
|
- API status runtime: `src/app/api/monitoring/health/route.ts`
|
|
- Pembungkus bersama: `open-sse/services/accountFallback.ts`
|
|
- Tabel status yang dipersistenkan: `domain_circuit_breakers`
|
|
|
|
**Status**:
|
|
|
|
- `CLOSED`: lalu lintas normal diizinkan.
|
|
- `OPEN`: penyedia diblokir sementara; pemanggil mendapatkan respons pemutus-sirkuit-penyedia-terbuka
|
|
atau routing combo melewati ke target lain.
|
|
- `HALF_OPEN`: waktu tunggu reset telah berlalu; izinkan permintaan probe. Keberhasilan menutup
|
|
pemutus, kegagalan membukanya lagi.
|
|
|
|
**Defaults** (`open-sse/config/constants.ts`):
|
|
|
|
- Penyedia OAuth: ambang `3`, waktu tunggu reset `60s`.
|
|
- Penyedia kunci API: ambang `5`, waktu tunggu reset `30s`.
|
|
- Penyedia lokal: ambang `2`, waktu tunggu reset `15s`.
|
|
|
|
Hanya status kegagalan tingkat penyedia yang harus memicu pemutus penyedia:
|
|
|
|
```ts
|
|
(408, 500, 502, 503, 504);
|
|
```
|
|
|
|
Jangan memicu pemutus seluruh-penyedia untuk kesalahan akun/kunci/model normal seperti kebanyakan
|
|
kasus `401`, `403`, atau `429`. Itu biasanya termasuk dalam cooldown koneksi atau penguncian model. Kunci API penyedia generik `403` harus dapat dipulihkan kecuali diklasifikasikan
|
|
sebagai kesalahan penyedia/akun terminal.
|
|
|
|
Pemutus menggunakan pemulihan malas, bukan timer latar belakang. Ketika `OPEN` kedaluwarsa, pembacaan seperti
|
|
`getStatus()`, `canExecute()`, dan `getRetryAfterMs()` menyegarkan status menjadi
|
|
`HALF_OPEN`, sehingga dasbor dan pembangun kandidat combo tidak terus mengecualikan penyedia yang kedaluwarsa selamanya.
|
|
|
|
### Cooldown Koneksi
|
|
|
|
**Ruang Lingkup**: satu koneksi/akun/kunci penyedia.
|
|
|
|
**Tujuan**: sementara melewatkan satu kunci/akun yang buruk sambil memungkinkan koneksi lain untuk
|
|
penyedia yang sama terus melayani permintaan.
|
|
|
|
**Implementasi**:
|
|
|
|
- Jalur tulis/perbarui: `src/sse/services/auth.ts::markAccountUnavailable()`
|
|
- Pemilihan/filtering akun: `src/sse/services/auth.ts::getProviderCredentials...`
|
|
- Perhitungan cooldown: `open-sse/services/accountFallback.ts::checkFallbackError()`
|
|
- Pengaturan: `src/lib/resilience/settings.ts`
|
|
|
|
Bidang penting pada koneksi penyedia:
|
|
|
|
```ts
|
|
rateLimitedUntil;
|
|
testStatus: "unavailable";
|
|
lastError;
|
|
lastErrorType;
|
|
errorCode;
|
|
backoffLevel;
|
|
```
|
|
|
|
Selama pemilihan akun, koneksi dilewati sementara:
|
|
|
|
```ts
|
|
new Date(rateLimitedUntil).getTime() > Date.now();
|
|
```
|
|
|
|
Cooldown juga bersifat malas: ketika `rateLimitedUntil` berada di masa lalu, koneksi menjadi
|
|
layak lagi. Pada penggunaan yang berhasil, `clearAccountError()` menghapus `testStatus`,
|
|
`rateLimitedUntil`, bidang kesalahan, dan `backoffLevel`.
|
|
|
|
Perilaku default cooldown koneksi:
|
|
|
|
- Cooldown dasar OAuth: `5s`.
|
|
- Cooldown dasar kunci API: `3s`.
|
|
- Kunci API `429` harus lebih memilih petunjuk coba lagi upstream (`Retry-After`, header reset, atau
|
|
teks reset yang dapat dianalisis) jika tersedia.
|
|
- Kegagalan yang dapat dipulihkan berulang menggunakan backoff eksponensial:
|
|
|
|
```ts
|
|
baseCooldownMs * 2 ** failureIndex;
|
|
```
|
|
|
|
Penjaga anti-thundering-herd mencegah kegagalan bersamaan pada koneksi yang sama dari
|
|
berulang kali memperpanjang cooldown atau menggandakan `backoffLevel`.
|
|
|
|
Status terminal bukanlah cooldown. `banned`, `expired`, dan `credits_exhausted` dimaksudkan untuk tetap tidak tersedia hingga kredensial/pengaturan berubah atau operator meresetnya. Jangan menimpa status terminal dengan status cooldown sementara.
|
|
|
|
### Penguncian Model
|
|
|
|
**Ruang Lingkup**: penyedia + koneksi + model.
|
|
|
|
**Tujuan**: menghindari menonaktifkan seluruh koneksi ketika hanya satu model yang tidak tersedia atau
|
|
terbatas kuota untuk koneksi tersebut.
|
|
|
|
Contoh:
|
|
|
|
- Penyedia kuota per-model yang mengembalikan `429`.
|
|
- Penyedia lokal yang mengembalikan `404` untuk satu model yang hilang.
|
|
- Kegagalan izin mode/model spesifik penyedia seperti mode Grok yang dipilih.
|
|
|
|
Penguncian model berada di `open-sse/services/accountFallback.ts` dan memungkinkan koneksi yang sama
|
|
terus melayani model lain.
|
|
|
|
### Panduan Debugging
|
|
|
|
- Jika semua kunci untuk penyedia dilewati, periksa status pemutus penyedia dan setiap
|
|
koneksi `rateLimitedUntil`/`testStatus`.
|
|
- Jika penyedia tampak secara permanen dikecualikan setelah jendela reset, periksa apakah kode
|
|
membaca `state` mentah alih-alih menggunakan `getStatus()`/`canExecute()`.
|
|
- Jika satu kunci penyedia gagal tetapi yang lain seharusnya berfungsi, lebih baik menggunakan cooldown koneksi daripada
|
|
pemutus penyedia.
|
|
- Jika hanya satu model yang gagal, lebih baik menggunakan penguncian model daripada cooldown koneksi.
|
|
- Jika suatu status seharusnya pulih sendiri, itu harus memiliki cap waktu/reset waktu depan dan jalur
|
|
baca yang menyegarkan status yang kedaluwarsa. Status permanen memerlukan perubahan kredensial
|
|
atau konfigurasi secara manual.
|
|
|
|
## Konvensi Kunci
|
|
|
|
### Gaya Kode
|
|
|
|
- **2 spasi**, titik koma, tanda kutip ganda, lebar 100 karakter, koma trailing es5 (ditegakkan oleh lint-staged melalui Prettier)
|
|
- **Impor**: eksternal → internal (`@/`, `@omniroute/open-sse`) → relatif
|
|
- **Penamaan**: file=camelCase/kebab, komponen=PascalCase, konstanta=UPPER_SNAKE
|
|
- **ESLint**: `no-eval`, `no-implied-eval`, `no-new-func` = kesalahan di mana saja; `no-explicit-any` = peringatan di `open-sse/` dan `tests/`
|
|
- **TypeScript**: `strict: false`, target ES2022, module esnext, resolusi bundler. Utamakan tipe eksplisit.
|
|
|
|
### Basis Data
|
|
|
|
- **Selalu** melalui modul domain `src/lib/db/` — **jangan pernah** menulis SQL mentah di rute atau pengendali
|
|
- **Jangan pernah** menambahkan logika ke `src/lib/localDb.ts` (hanya lapisan re-ekspor)
|
|
- **Jangan pernah** barrel-import dari `localDb.ts` — impor modul `db/` tertentu sebagai gantinya
|
|
- Singleton DB: `getDbInstance()` dari `src/lib/db/core.ts` (jurnal WAL)
|
|
- Migrasi: `src/lib/db/migrations/` — file SQL versi, idempotent, dijalankan dalam transaksi
|
|
|
|
### Penanganan Kesalahan
|
|
|
|
- coba/tangkap dengan tipe kesalahan spesifik, log dengan konteks pino
|
|
- Jangan pernah menelan kesalahan dalam aliran SSE — gunakan sinyal abort untuk pembersihan
|
|
- Kembalikan kode status HTTP yang tepat (4xx/5xx)
|
|
|
|
### Keamanan
|
|
|
|
- **Jangan pernah** menggunakan `eval()`, `new Function()`, atau eval implisit
|
|
- Validasi semua input dengan skema Zod
|
|
- Enkripsi kredensial saat tidak aktif (AES-256-GCM)
|
|
- Daftar penolakan header upstream: `src/shared/constants/upstreamHeaders.ts` — jaga sanitasi, skema Zod, dan pengujian unit tetap selaras saat mengedit
|
|
- **Kredensial upstream publik** (Gemini/Antigravity/Windsurf-style OAuth client_id/secret + kunci Web Firebase yang diambil dari CLI publik): **HARUS** disematkan melalui `resolvePublicCred()` dari `open-sse/utils/publicCreds.ts` — **jangan pernah** sebagai literal string. Lihat `docs/security/PUBLIC_CREDS.md` untuk pola yang wajib.
|
|
- **Respon kesalahan** (HTTP / SSE / eksekutor / pengendali MCP): **HARUS** diarahkan melalui `buildErrorBody()` atau `sanitizeErrorMessage()` dari `open-sse/utils/error.ts` — **jangan pernah** menempatkan `err.stack` atau `err.message` mentah dalam tubuh respon. Lihat `docs/security/ERROR_SANITIZATION.md`.
|
|
- **Perintah shell yang dibangun dari variabel**: saat memanggil `exec()`/`spawn()` dengan skrip yang membutuhkan nilai runtime, kirimkan melalui opsi `env` (secara otomatis di-escape shell) — **jangan pernah** menginterpolasi string jalur yang tidak tepercaya/eksternal ke dalam tubuh skrip. Referensi: `src/mitm/cert/install.ts::updateNssDatabases`.
|
|
- **Perpustakaan aman secara default** ([tldrsec/awesome-secure-defaults](https://github.com/tldrsec/awesome-secure-defaults)): lebih suka Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink daripada implementasi kustom kapan pun menambahkan permukaan yang sensitif terhadap keamanan baru.
|
|
|
|
---
|
|
|
|
## Skenario Modifikasi Umum
|
|
|
|
### Menambahkan Penyedia Baru
|
|
|
|
1. Daftarkan di `src/shared/constants/providers.ts` (divalidasi Zod saat dimuat)
|
|
2. Tambahkan eksekutor di `open-sse/executors/` jika logika kustom diperlukan (perluas `BaseExecutor`)
|
|
3. Tambahkan penerjemah di `open-sse/translator/` jika format bukan OpenAI
|
|
4. Tambahkan konfigurasi OAuth di `src/lib/oauth/constants/oauth.ts` jika berbasis OAuth — jika CLI upstream mengirimkan client_id/secret publik, sematkan melalui `resolvePublicCred()` (lihat `docs/security/PUBLIC_CREDS.md`), **jangan pernah** sebagai literal
|
|
5. Daftarkan model di `open-sse/config/providerRegistry.ts`
|
|
6. Tulis pengujian di `tests/unit/` (sertakan pernyataan bentuk publicCreds jika Anda menambahkan default yang disematkan baru)
|
|
|
|
### Menambahkan Rute API Baru
|
|
|
|
1. Buat direktori di bawah `src/app/api/v1/your-route/`
|
|
2. Buat `route.ts` dengan pengendali `GET`/`POST`
|
|
3. Ikuti pola: CORS → validasi tubuh Zod → otentikasi opsional → delegasi pengendali
|
|
4. Pengendali masuk di `open-sse/handlers/` (impor dari sana, bukan inline)
|
|
5. Respon kesalahan menggunakan `buildErrorBody()` / `errorResponse()` dari `open-sse/utils/error.ts` (otomatis disanitasi — jangan pernah menempatkan `err.stack` atau `err.message` mentah dalam tubuh). Lihat `docs/security/ERROR_SANITIZATION.md`.
|
|
6. Tambahkan pengujian — termasuk setidaknya satu pernyataan bahwa respon kesalahan tidak membocorkan jejak tumpukan (`!body.error.message.includes("at /")`)
|
|
|
|
### Menambahkan Modul DB Baru
|
|
|
|
1. Buat `src/lib/db/yourModule.ts` — impor `getDbInstance` dari `./core.ts`
|
|
2. Ekspor fungsi CRUD untuk tabel domain Anda
|
|
3. Tambahkan migrasi di `src/lib/db/migrations/` jika tabel baru diperlukan
|
|
4. Re-ekspor dari `src/lib/localDb.ts` (tambahkan ke daftar re-ekspor saja)
|
|
5. Tulis pengujian
|
|
|
|
### Menambahkan Alat MCP Baru
|
|
|
|
1. Tambahkan definisi alat di `open-sse/mcp-server/tools/` dengan skema input Zod + pengendali asinkron
|
|
2. Daftarkan dalam set alat (terhubung oleh `createMcpServer()`)
|
|
3. Tetapkan ke ruang lingkup yang sesuai
|
|
4. Tulis pengujian (panggilan alat dicatat ke tabel `mcp_audit`)
|
|
|
|
### Menambahkan Keterampilan A2A Baru
|
|
|
|
1. Buat keterampilan di `src/lib/a2a/skills/` (5 sudah ada: smart-routing, quota-management, provider-discovery, cost-analysis, health-report)
|
|
2. Keterampilan menerima konteks tugas (pesan, metadata) → mengembalikan hasil terstruktur
|
|
3. Daftarkan di `A2A_SKILL_HANDLERS` di `src/lib/a2a/taskExecution.ts`
|
|
4. Ekspos di `src/app/.well-known/agent.json/route.ts` (Kartu Agen)
|
|
5. Tulis pengujian di `tests/unit/`
|
|
6. Dokumentasikan di tabel keterampilan `docs/frameworks/A2A-SERVER.md`
|
|
|
|
### Menambahkan Agen Cloud Baru
|
|
|
|
1. Buat kelas agen di `src/lib/cloudAgent/agents/` yang memperluas `CloudAgentBase` (3 sudah ada: codex-cloud, devin, jules)
|
|
2. Implementasikan `createTask`, `getStatus`, `approvePlan`, `sendMessage`, `listSources`
|
|
3. Daftarkan di `src/lib/cloudAgent/registry.ts`
|
|
4. Tambahkan penanganan OAuth/kredensial jika diperlukan (`src/lib/oauth/providers/`)
|
|
5. Pengujian + dokumentasikan di `docs/frameworks/CLOUD_AGENT.md`
|
|
|
|
### Menambahkan Guardrail / Eval / Keterampilan / Acara Webhook Baru
|
|
|
|
- Guardrail: `src/lib/guardrails/` → dokumen: `docs/security/GUARDRAILS.md`
|
|
- Suite Eval: `src/lib/evals/` → dokumen: `docs/frameworks/EVALS.md`
|
|
- Keterampilan (sandbox): `src/lib/skills/` → dokumen: `docs/frameworks/SKILLS.md`
|
|
- Acara Webhook: `src/lib/webhookDispatcher.ts` → dokumen: `docs/frameworks/WEBHOOKS.md`
|
|
|
|
## Dokumentasi Referensi
|
|
|
|
Untuk setiap perubahan yang tidak sepele, baca penjelasan mendalam yang sesuai terlebih dahulu:
|
|
|
|
| Area | Dok |
|
|
| --------------------------------------------- | ----------------------------------------------------------------- |
|
|
| Navigasi repo | `docs/architecture/REPOSITORY_MAP.md` |
|
|
| Arsitektur | `docs/architecture/ARCHITECTURE.md` |
|
|
| Referensi teknik | `docs/architecture/CODEBASE_DOCUMENTATION.md` |
|
|
| Auto-Combo (skor 9 faktor, 14 strategi) | `docs/routing/AUTO-COMBO.md` |
|
|
| Ketahanan (3 mekanisme) | `docs/architecture/RESILIENCE_GUIDE.md` |
|
|
| Pemutaran penalaran | `docs/routing/REASONING_REPLAY.md` |
|
|
| Kerangka keterampilan | `docs/frameworks/SKILLS.md` |
|
|
| Sistem memori (FTS5 + Qdrant) | `docs/frameworks/MEMORY.md` |
|
|
| Agen cloud | `docs/frameworks/CLOUD_AGENT.md` |
|
|
| Pengaman (PII / injeksi / visi) | `docs/security/GUARDRAILS.md` |
|
|
| Kredensial publik hulu (Gemini/dll.) | `docs/security/PUBLIC_CREDS.md` |
|
|
| Sanitasi pesan kesalahan | `docs/security/ERROR_SANITIZATION.md` |
|
|
| Evaluasi | `docs/frameworks/EVALS.md` |
|
|
| Kepatuhan / audit | `docs/security/COMPLIANCE.md` |
|
|
| Webhook | `docs/frameworks/WEBHOOKS.md` |
|
|
| Jalur otorisasi | `docs/architecture/AUTHZ_GUIDE.md` |
|
|
| Stealth (TLS / sidik jari) | `docs/security/STEALTH_GUIDE.md` |
|
|
| Protokol agen (A2A / ACP / Cloud) | `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md` |
|
|
| Server MCP | `docs/frameworks/MCP-SERVER.md` |
|
|
| Server A2A | `docs/frameworks/A2A-SERVER.md` |
|
|
| Referensi API + OpenAPI | `docs/reference/API_REFERENCE.md` + `docs/reference/openapi.yaml` |
|
|
| Katalog penyedia (dihasilkan secara otomatis) | `docs/reference/PROVIDER_REFERENCE.md` |
|
|
| Alur rilis | `docs/ops/RELEASE_CHECKLIST.md` |
|
|
|
|
---
|
|
|
|
## Pengujian
|
|
|
|
| Apa | Perintah |
|
|
| ----------------------- | ---------------------------------------------------------------------- |
|
|
| Uji unit | `npm run test:unit` |
|
|
| File tunggal | `node --import tsx/esm --test tests/unit/file.test.ts` |
|
|
| Vitest (MCP, autoCombo) | `npm run test:vitest` |
|
|
| E2E (Playwright) | `npm run test:e2e` |
|
|
| Protokol E2E (MCP+A2A) | `npm run test:protocols:e2e` |
|
|
| Ekosistem | `npm run test:ecosystem` |
|
|
| Gerbang cakupan | `npm run test:coverage` (75/75/75/70 — pernyataan/garis/fungsi/cabang) |
|
|
| Laporan cakupan | `npm run coverage:report` |
|
|
|
|
**Aturan PR**: Jika Anda mengubah kode produksi di `src/`, `open-sse/`, `electron/`, atau `bin/`, Anda harus menyertakan atau memperbarui pengujian dalam PR yang sama.
|
|
|
|
**Preferensi lapisan pengujian**: unit pertama → integrasi (multi-modul atau status DB) → e2e (UI/workflow saja). Kodekan reproduksi bug sebagai pengujian otomatis sebelum atau bersamaan dengan perbaikan.
|
|
|
|
**Kebijakan cakupan Copilot**: Ketika PR mengubah kode produksi dan cakupan di bawah 75% (pernyataan/garis/fungsi) atau 70% (cabang), jangan hanya melaporkan — tambahkan atau perbarui pengujian, jalankan kembali gerbang cakupan, lalu minta konfirmasi. Sertakan perintah yang dijalankan, file pengujian yang diubah, dan hasil cakupan akhir dalam laporan PR.
|
|
|
|
---
|
|
|
|
## Alur Kerja Git
|
|
|
|
```bash
|
|
# Jangan pernah melakukan commit langsung ke main
|
|
git checkout -b feat/your-feature
|
|
git commit -m "feat: deskripsikan perubahan Anda"
|
|
git push -u origin feat/your-feature
|
|
```
|
|
|
|
**Awalan cabang**: `feat/`, `fix/`, `refactor/`, `docs/`, `test/`, `chore/`
|
|
|
|
**Format commit** (Conventional Commits): `feat(db): tambahkan circuit breaker` — ruang lingkup: `db`, `sse`, `oauth`, `dashboard`, `api`, `cli`, `docker`, `ci`, `mcp`, `a2a`, `memory`, `skills`
|
|
|
|
**Hook Husky**:
|
|
|
|
- **pre-commit**: lint-staged + `check-docs-sync` + `check:any-budget:t11`
|
|
- **pre-push**: `npm run test:unit`
|
|
|
|
---
|
|
|
|
## Lingkungan
|
|
|
|
- **Runtime**: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25, ES Modules
|
|
- **TypeScript**: 5.9+, target ES2022, module esnext, resolution bundler
|
|
- **Alias jalur**: `@/*` → `src/`, `@omniroute/open-sse` → `open-sse/`, `@omniroute/open-sse/*` → `open-sse/*`
|
|
- **Port default**: 20128 (API + dashboard di port yang sama)
|
|
- **Direktori data**: variabel env `DATA_DIR`, default ke `~/.omniroute/`
|
|
- **Variabel env kunci**: `PORT`, `JWT_SECRET`, `API_KEY_SECRET`, `INITIAL_PASSWORD`, `REQUIRE_API_KEY`, `APP_LOG_LEVEL`
|
|
- Setup: `cp .env.example .env` lalu hasilkan `JWT_SECRET` (`openssl rand -base64 48`) dan `API_KEY_SECRET` (`openssl rand -hex 32`)
|
|
|
|
---
|
|
|
|
## Aturan Keras
|
|
|
|
1. Jangan pernah melakukan commit rahasia atau kredensial
|
|
2. Jangan pernah menambahkan logika ke `localDb.ts`
|
|
3. Jangan pernah menggunakan `eval()` / `new Function()` / eval tersirat
|
|
4. Jangan pernah melakukan commit langsung ke `main`
|
|
5. Jangan pernah menulis SQL mentah di rute — gunakan modul `src/lib/db/`
|
|
6. Jangan pernah menelan kesalahan secara diam-diam di aliran SSE
|
|
7. Selalu validasi input dengan skema Zod
|
|
8. Selalu sertakan pengujian saat mengubah kode produksi
|
|
9. Cakupan harus tetap ≥75% (pernyataan, garis, fungsi) / ≥70% (cabang). Saat ini terukur: ~82%.
|
|
10. Jangan pernah melewati hook Husky (`--no-verify`, `--no-gpg-sign`) tanpa persetujuan operator yang eksplisit.
|
|
11. Jangan pernah menyematkan client_id/secret OAuth upstream publik atau kunci Web Firebase sebagai literal string — selalu melalui `resolvePublicCred()` (`open-sse/utils/publicCreds.ts`). Lihat `docs/security/PUBLIC_CREDS.md`.
|
|
12. Jangan pernah mengembalikan `err.stack` / `err.message` mentah dalam respons HTTP / SSE / eksekutor — selalu rute melalui `buildErrorBody()` atau `sanitizeErrorMessage()` (`open-sse/utils/error.ts`). Lihat `docs/security/ERROR_SANITIZATION.md`.
|
|
13. Jangan pernah melakukan interpolasi string jalur eksternal atau nilai runtime ke dalam skrip shell yang diteruskan ke `exec()`/`spawn()` — teruskan melalui opsi `env` sebagai gantinya. Referensi: `src/mitm/cert/install.ts::updateNssDatabases`.
|
|
14. Jangan pernah mengabaikan peringatan CodeQL / Secret-Scanning tanpa (a) terlebih dahulu memeriksa dokumen pola di atas untuk melihat apakah pembantu berlaku, dan (b) mencatat justifikasi teknis dalam komentar pengabaian. Preseden: `js/stack-trace-exposure` yang muncul di callsites yang sudah rute melalui `sanitizeErrorMessage()` adalah batasan CodeQL yang diketahui (pembersih kustom tidak dikenali) — abaikan sebagai `false positive` yang merujuk pada `docs/security/ERROR_SANITIZATION.md`.
|
|
15. Jangan pernah mengekspos rute yang memunculkan proses anak (`/api/mcp/`, `/api/cli-tools/runtime/`) tanpa klasifikasi `isLocalOnlyPath()` di `src/server/authz/routeGuard.ts`. Penegakan loopback terjadi tanpa syarat sebelum pemeriksaan otentikasi — JWT yang bocor melalui terowongan tidak dapat memicu pemunculan proses. Lihat `docs/security/ROUTE_GUARD_TIERS.md`.
|
|
16. Jangan pernah menyertakan trailer `Co-Authored-By` yang memberi kredit kepada asisten AI, LLM, atau akun otomatisasi (mis. nama yang mengandung "Claude", "GPT", "Copilot", "Bot"; email di `anthropic.com` / `openai.com` / alamat `noreply.github.com` milik bot). Trailer semacam itu mengarahkan atribusi commit ke akun bot di GitHub, menyembunyikan penulis sebenarnya (`diegosouzapw`) dalam riwayat PR. Kolaborator manusia — termasuk penulis PR upstream dan pelapor issue yang di-port ke OmniRoute — DAPAT dan HARUS dikreditkan dengan trailer standar `Co-authored-by: Name <email>`; alur kerja upstream-port (`/port-upstream-features`, `/port-upstream-issues`) bergantung pada ini.
|