* 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>
43 KiB
CLAUDE.md (ไทย)
🌐 Languages: 🇺🇸 English · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇪🇸 es · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇳 gu · 🇮🇱 he · 🇮🇳 hi · 🇭🇺 hu · 🇮🇩 id · 🇮🇩 in · 🇮🇹 it · 🇯🇵 ja · 🇰🇷 ko · 🇮🇳 mr · 🇲🇾 ms · 🇳🇱 nl · 🇳🇴 no · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇸🇰 sk · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇻🇳 vi · 🇨🇳 zh-CN
ไฟล์นี้ให้แนวทางสำหรับ Claude Code (claude.ai/code) เมื่อทำงานกับโค้ดในที่เก็บนี้
เริ่มต้นอย่างรวดเร็ว
npm install # ติดตั้ง deps (สร้าง .env จาก .env.example โดยอัตโนมัติ)
npm run dev # เซิร์ฟเวอร์พัฒนาอยู่ที่ http://localhost:20128
npm run build # สร้างโปรดักชัน (Next.js 16 standalone)
npm run lint # ESLint (คาดหวัง 0 ข้อผิดพลาด; คำเตือนเป็นสิ่งที่มีอยู่แล้ว)
npm run typecheck:core # ตรวจสอบ TypeScript (ควรสะอาด)
npm run typecheck:noimplicit:core # ตรวจสอบอย่างเข้มงวด (ไม่มี implicit any)
npm run test:coverage # หน่วยทดสอบ + เกณฑ์การครอบคลุม (75/75/75/70 — คำสั่ง/บรรทัด/ฟังก์ชัน/สาขา)
npm run check # lint + ทดสอบรวมกัน
npm run check:cycles # ตรวจจับการพึ่งพาแบบวงกลม
การรันการทดสอบ
# ไฟล์ทดสอบเดียว (Node.js native test runner — ทดสอบส่วนใหญ่)
node --import tsx/esm --test tests/unit/your-file.test.ts
# Vitest (MCP server, autoCombo, cache)
npm run test:vitest
# ทุกชุด
npm run test:all
สำหรับตารางการทดสอบทั้งหมด ดูที่ CONTRIBUTING.md → "การรันการทดสอบ" สำหรับสถาปัตยกรรมเชิงลึก ดูที่ AGENTS.md.
โครงการโดยรวม
OmniRoute — โปรเซสเซอร์/เราเตอร์ AI ที่รวมเป็นหนึ่ง จุดสิ้นสุดเดียว, ผู้ให้บริการ LLM มากกว่า 160 ราย, การสำรองข้อมูลอัตโนมัติ
| เลเยอร์ | ตำแหน่ง | วัตถุประสงค์ |
|---|---|---|
| API Routes | src/app/api/v1/ |
Next.js App Router — จุดเข้า |
| Handlers | open-sse/handlers/ |
การประมวลผลคำขอ (แชท, การฝัง, ฯลฯ) |
| Executors | open-sse/executors/ |
การส่ง HTTP เฉพาะผู้ให้บริการ |
| Translators | open-sse/translator/ |
การแปลงรูปแบบ (OpenAI↔Claude↔Gemini) |
| Transformer | open-sse/transformer/ |
API การตอบกลับ ↔ การเติมแชท |
| Services | open-sse/services/ |
การจัดเส้นทางแบบรวม, ขีดจำกัดอัตรา, การแคช, ฯลฯ |
| Database | src/lib/db/ |
โมดูลโดเมน SQLite (ไฟล์ 45+ ไฟล์, การโยกย้าย 55) |
| Domain/Policy | src/domain/ |
เอนจินนโยบาย, กฎค่าใช้จ่าย, ลอจิกการสำรองข้อมูล |
| MCP Server | open-sse/mcp-server/ |
เครื่องมือ 37 รายการ (30 พื้นฐาน + 3 หน่วยความจำ + 4 ทักษะ), การขนส่ง 3 รายการ, ~13 ขอบเขต |
| A2A Server | src/lib/a2a/ |
โปรโตคอลตัวแทน JSON-RPC 2.0 |
| Skills | src/lib/skills/ |
โครงสร้างทักษะที่ขยายได้ |
| Memory | src/lib/memory/ |
หน่วยความจำการสนทนาที่คงอยู่ |
Monorepo: src/ (แอป Next.js 16), open-sse/ (พื้นที่ทำงานเครื่องยนต์สตรีมมิ่ง), electron/ (แอปเดสก์ท็อป), tests/, bin/ (จุดเข้า CLI).
Request Pipeline
Client → /v1/chat/completions (Next.js route)
→ CORS → Zod validation → auth? → policy check → prompt injection guard
→ handleChatCore() [open-sse/handlers/chatCore.ts]
→ cache check → rate limit → combo routing?
→ resolveComboTargets() → handleSingleModel() per target
→ translateRequest() → getExecutor() → executor.execute()
→ fetch() upstream → retry w/ backoff
→ response translation → SSE stream or JSON
→ If Responses API: responsesTransformer.ts TransformStream
API routes follow a consistent pattern: Route → CORS preflight → Zod body validation → Optional auth (extractApiKey/isValidApiKey) → API key policy enforcement → Handler delegation (open-sse). ไม่มี middleware ของ Next.js ทั่วไป — การดักจับจะเฉพาะเจาะจงต่อเส้นทาง
Combo routing (open-sse/services/combo.ts): 14 กลยุทธ์ (priority, weighted, fill-first, round-robin, P2C, random, least-used, cost-optimized, reset-aware, strict-random, auto, lkgp, context-optimized, context-relay). เป้าหมายแต่ละตัวเรียก handleSingleModel() ซึ่งห่อหุ้ม handleChatCore() ด้วยการจัดการข้อผิดพลาดเฉพาะเป้าหมายและการตรวจสอบ circuit breaker ดู docs/routing/AUTO-COMBO.md สำหรับการให้คะแนน Auto-Combo 9 ปัจจัยและ docs/architecture/RESILIENCE_GUIDE.md สำหรับ 3 ชั้นของความทนทาน
Resilience Runtime State
OmniRoute มีกลไกการล้มเหลวชั่วคราวที่เกี่ยวข้องกันสามอย่าง แต่แตกต่างกัน รักษาขอบเขตของพวกเขาแยกกันเมื่อทำการดีบักพฤติกรรมการจัดเส้นทาง ดู 3-layer resilience diagram (แหล่งที่มา: docs/diagrams/resilience-3layers.mmd) สำหรับแผนที่แบบคร่าวๆ
Provider Circuit Breaker
Scope: ผู้ให้บริการทั้งหมด เช่น glm, openai, anthropic.
Purpose: หยุดการส่งข้อมูลไปยังผู้ให้บริการที่ล้มเหลวซ้ำๆ ที่ระดับ upstream/service เพื่อไม่ให้ผู้ให้บริการที่ไม่แข็งแรงทำให้คำขอทุกคำช้าลง
Implementation:
- คลาสหลัก:
src/shared/utils/circuitBreaker.ts - การเชื่อมต่อ/การดำเนินการของ Chat:
src/sse/handlers/chatHelpers.ts,src/sse/handlers/chat.ts - API สถานะการทำงาน:
src/app/api/monitoring/health/route.ts - ตัวห่อร่วม:
open-sse/services/accountFallback.ts - ตารางสถานะที่เก็บถาวร:
domain_circuit_breakers
States:
CLOSED: อนุญาตให้มีการจราจรปกติOPEN: ผู้ให้บริการถูกบล็อกชั่วคราว; ผู้โทรจะได้รับการตอบสนองว่า provider-circuit-open หรือการจัดเส้นทางแบบ combo จะข้ามไปยังเป้าหมายอื่นHALF_OPEN: เวลาหมดเวลารีเซ็ตได้ผ่านไปแล้ว; อนุญาตให้มีการสอบถามคำขอ หากสำเร็จจะปิด circuit breaker หากล้มเหลวจะเปิดอีกครั้ง
Defaults (open-sse/config/constants.ts):
- ผู้ให้บริการ OAuth: เกณฑ์
3, เวลาหมดเวลารีเซ็ต60s - ผู้ให้บริการ API-key: เกณฑ์
5, เวลาหมดเวลารีเซ็ต30s - ผู้ให้บริการท้องถิ่น: เกณฑ์
2, เวลาหมดเวลารีเซ็ต15s
สถานะการล้มเหลวของผู้ให้บริการเท่านั้นที่ควรทำให้ circuit breaker ของผู้ให้บริการทำงาน:
(408, 500, 502, 503, 504);
อย่าทำให้ circuit breaker ของผู้ให้บริการทั้งหมดทำงานสำหรับข้อผิดพลาดบัญชี/คีย์/โมเดลปกติ เช่น ส่วนใหญ่ 401, 403, หรือ 429 เหล่านั้นมักจะเป็นการเชื่อมต่อที่เย็นลงหรือการล็อคโมเดล ข้อผิดพลาด API-key ทั่วไป 403 ควรสามารถกู้คืนได้ เว้นแต่จะถูกจัดประเภทเป็นข้อผิดพลาดบัญชี/ผู้ให้บริการที่สิ้นสุด
circuit breaker ใช้การกู้คืนแบบขี้เกียจ ไม่ใช่ตัวจับเวลาเบื้องหลัง เมื่อ OPEN หมดอายุ การอ่านเช่น getStatus(), canExecute(), และ getRetryAfterMs() จะรีเฟรชสถานะเป็น HALF_OPEN ดังนั้นแดชบอร์ดและผู้สร้างผู้สมัคร combo จะไม่ขExclude ผู้ให้บริการที่หมดอายุตลอดไป
Connection Cooldown
Scope: การเชื่อมต่อ/บัญชี/คีย์ของผู้ให้บริการหนึ่ง
Purpose: ข้ามคีย์/บัญชีที่ไม่ดีชั่วคราวในขณะที่อนุญาตให้การเชื่อมต่ออื่นๆ สำหรับผู้ให้บริการเดียวกันดำเนินการให้บริการคำขอ
Implementation:
- เส้นทางการเขียน/อัปเดต:
src/sse/services/auth.ts::markAccountUnavailable() - การเลือก/กรองบัญชี:
src/sse/services/auth.ts::getProviderCredentials... - การคำนวณการเย็นลง:
open-sse/services/accountFallback.ts::checkFallbackError() - การตั้งค่า:
src/lib/resilience/settings.ts
ฟิลด์ที่สำคัญในการเชื่อมต่อผู้ให้บริการ:
rateLimitedUntil;
testStatus: "unavailable";
lastError;
lastErrorType;
errorCode;
backoffLevel;
ในระหว่างการเลือกบัญชี การเชื่อมต่อจะถูกข้ามในขณะที่:
new Date(rateLimitedUntil).getTime() > Date.now();
การเย็นลงยังเป็นแบบขี้เกียจ: เมื่อ rateLimitedUntil อยู่ในอดีต การเชื่อมต่อจะมีสิทธิ์อีกครั้ง เมื่อใช้งานสำเร็จ clearAccountError() จะล้าง testStatus, rateLimitedUntil, ฟิลด์ข้อผิดพลาด และ backoffLevel
พฤติกรรมการเย็นลงของการเชื่อมต่อเริ่มต้น:
- การเย็นลงพื้นฐานของ OAuth:
5s - การเย็นลงพื้นฐานของ API-key:
3s - API-key
429ควรให้ความสำคัญกับคำแนะนำการลองใหม่จาก upstream (Retry-After, headers รีเซ็ต หรือข้อความรีเซ็ตที่สามารถวิเคราะห์ได้) เมื่อมีให้ - ความล้มเหลวที่กู้คืนได้ซ้ำใช้การเพิ่มขึ้นแบบเอ็กซ์โพเนนเชียล:
baseCooldownMs * 2 ** failureIndex;
การป้องกันการเกิดภัยพิบัติแบบกลุ่มจะป้องกันไม่ให้ความล้มเหลวพร้อมกันในเชื่อมต่อเดียวกันขยายการเย็นลงซ้ำหรือเพิ่ม backoffLevel สองเท่า
สถานะสุดท้ายไม่ใช่การเย็นลง banned, expired, และ credits_exhausted มีจุดมุ่งหมายเพื่อให้ไม่สามารถใช้งานได้จนกว่าข้อมูลประจำตัว/การตั้งค่าจะเปลี่ยนแปลงหรือผู้ดูแลระบบรีเซ็ตพวกเขา อย่าเขียนทับสถานะสุดท้ายด้วยสถานะการเย็นลงชั่วคราว
Model Lockout
Scope: ผู้ให้บริการ + การเชื่อมต่อ + โมเดล
Purpose: หลีกเลี่ยงการปิดการใช้งานการเชื่อมต่อทั้งหมดเมื่อมีเพียงโมเดลเดียวที่ไม่สามารถใช้งานได้หรือมีการจำกัดโควตาสำหรับการเชื่อมต่อนั้น
ตัวอย่าง:
- ผู้ให้บริการโควตาต่อโมเดลที่ส่งคืน
429 - ผู้ให้บริการท้องถิ่นที่ส่งคืน
404สำหรับโมเดลที่ขาดหายไป - ความล้มเหลวในการอนุญาตโหมด/โมเดลเฉพาะของผู้ให้บริการ เช่น โหมด Grok ที่เลือก
การล็อคโมเดลอยู่ใน open-sse/services/accountFallback.ts และอนุญาตให้การเชื่อมต่อเดียวกันดำเนินการให้บริการโมเดลอื่นๆ ต่อไป
Debugging Guidance
- หากคีย์ทั้งหมดสำหรับผู้ให้บริการถูกข้าม ให้ตรวจสอบทั้งสถานะ circuit breaker ของผู้ให้บริการและ
rateLimitedUntil/testStatusของการเชื่อมต่อแต่ละตัว - หากผู้ให้บริการดูเหมือนจะถูกยกเว้นถาวรหลังจากหน้าต่างรีเซ็ต ให้ตรวจสอบว่าโค้ดกำลังอ่าน
stateดิบแทนที่จะใช้getStatus()/canExecute() - หากคีย์ของผู้ให้บริการหนึ่งล้มเหลวแต่คีย์อื่นควรทำงาน ให้ให้ความสำคัญกับการเย็นลงของการเชื่อมต่อมากกว่าการทำงานของ circuit breaker ของผู้ให้บริการ
- หากโมเดลเพียงหนึ่งล้มเหลว ให้ให้ความสำคัญกับการล็อคโมเดลมากกว่าการเย็นลงของการเชื่อมต่อ
- หากสถานะควรกู้คืนเอง มันควรมี timestamp/เวลาหมดอายุในอนาคตและเส้นทางการอ่านที่รีเฟรชสถานะที่หมดอายุ สถานะถาวรต้องการการเปลี่ยนแปลงข้อมูลประจำตัวหรือการกำหนดค่าด้วยตนเอง
ข้อตกลงหลัก
รูปแบบโค้ด
- 2 ช่องว่าง, เครื่องหมายเซมิโคลอน, เครื่องหมายคำพูดคู่, ความกว้าง 100 ตัวอักษร, คอมม่าใน ES5 (บังคับโดย lint-staged ผ่าน Prettier)
- การนำเข้า: ภายนอก → ภายใน (
@/,@omniroute/open-sse) → เชิงสัมพันธ์ - การตั้งชื่อ: ไฟล์=camelCase/kebab, คอมโพเนนต์=PascalCase, ค่าคงที่=UPPER_SNAKE
- ESLint:
no-eval,no-implied-eval,no-new-func= ข้อผิดพลาดทุกที่;no-explicit-any= เตือนในopen-sse/และtests/ - TypeScript:
strict: false, เป้าหมาย ES2022, โมดูล esnext, การแก้ไข bundler. ชอบประเภทที่ชัดเจน
ฐานข้อมูล
- เสมอ ผ่านโมดูลโดเมน
src/lib/db/— ไม่เคย เขียน SQL ดิบในเส้นทางหรือผู้จัดการ - ไม่เคย เพิ่มตรรกะใน
src/lib/localDb.ts(ชั้นการส่งออกใหม่เท่านั้น) - ไม่เคย นำเข้าจาก
localDb.ts— นำเข้าโมดูลdb/ที่เฉพาะเจาะจงแทน - DB singleton:
getDbInstance()จากsrc/lib/db/core.ts(WAL journaling) - การโยกย้าย:
src/lib/db/migrations/— ไฟล์ SQL ที่มีการเวอร์ชัน, idempotent, รันในธุรกรรม
การจัดการข้อผิดพลาด
- try/catch ด้วยประเภทข้อผิดพลาดที่เฉพาะเจาะจง, บันทึกด้วยบริบท pino
- ไม่เคยกลืนข้อผิดพลาดใน SSE streams — ใช้สัญญาณยกเลิกสำหรับการทำความสะอาด
- คืนค่ารหัสสถานะ HTTP ที่เหมาะสม (4xx/5xx)
ความปลอดภัย
- ไม่เคย ใช้
eval(),new Function(), หรือ implied eval - ตรวจสอบข้อมูลนำเข้าทั้งหมดด้วย Zod schemas
- เข้ารหัสข้อมูลรับรองเมื่ออยู่ในที่เก็บ (AES-256-GCM)
- รายการปฏิเสธส่วนหัวของ upstream:
src/shared/constants/upstreamHeaders.ts— รักษาความสะอาด, Zod schemas, และการทดสอบหน่วยให้สอดคล้องเมื่อแก้ไข - ข้อมูลรับรองสาธารณะของ upstream (client_id/secret แบบ Gemini/Antigravity/Windsurf + คีย์ Firebase Web ที่ดึงมาจาก CLI สาธารณะ): ต้อง ถูกฝังผ่าน
resolvePublicCred()จากopen-sse/utils/publicCreds.ts— ไม่เคย เป็นตัวอักษรสตริง ดูdocs/security/PUBLIC_CREDS.mdสำหรับรูปแบบที่จำเป็น - การตอบสนองข้อผิดพลาด (HTTP / SSE / executor / MCP handler): ต้อง ผ่าน
buildErrorBody()หรือsanitizeErrorMessage()จากopen-sse/utils/error.ts— ไม่เคย ใส่err.stackหรือerr.messageดิบในร่างการตอบสนอง ดูdocs/security/ERROR_SANITIZATION.md. - คำสั่งเชลล์ที่สร้างจากตัวแปร: เมื่อเรียกใช้
exec()/spawn()ด้วยสคริปต์ที่ต้องการค่าระหว่างการทำงาน, ส่งผ่านทางตัวเลือกenv(เชลล์-escaped โดยอัตโนมัติ) — ไม่เคย สอดแทรกเส้นทางที่ไม่เชื่อถือได้/ภายนอกลงในร่างสคริปต์ อ้างอิง:src/mitm/cert/install.ts::updateNssDatabases. - ไลบรารีที่ปลอดภัยตามค่าเริ่มต้น (tldrsec/awesome-secure-defaults): ชอบ Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink มากกว่าการใช้งานที่กำหนดเองเมื่อเพิ่มพื้นผิวที่มีความปลอดภัยสูงใหม่
สถานการณ์การแก้ไขทั่วไป
การเพิ่มผู้ให้บริการใหม่
- ลงทะเบียนใน
src/shared/constants/providers.ts(ตรวจสอบด้วย Zod ที่โหลด) - เพิ่ม executor ใน
open-sse/executors/หากต้องการตรรกะที่กำหนดเอง (ขยายBaseExecutor) - เพิ่ม translator ใน
open-sse/translator/หากไม่ใช่รูปแบบ OpenAI - เพิ่มการกำหนดค่า OAuth ใน
src/lib/oauth/constants/oauth.tsหากใช้ OAuth — หาก CLI ของ upstream ส่ง client_id/secret สาธารณะ, ฝังผ่านresolvePublicCred()(ดูdocs/security/PUBLIC_CREDS.md), ไม่เคย เป็นตัวอักษร - ลงทะเบียนโมเดลใน
open-sse/config/providerRegistry.ts - เขียนการทดสอบใน
tests/unit/(รวมการยืนยันรูปแบบ publicCreds หากคุณเพิ่มค่าเริ่มต้นใหม่ที่ฝัง)
การเพิ่มเส้นทาง API ใหม่
- สร้างไดเรกทอรีภายใต้
src/app/api/v1/your-route/ - สร้าง
route.tsด้วยผู้จัดการGET/POST - ปฏิบัติตามรูปแบบ: CORS → การตรวจสอบร่าง Zod → การตรวจสอบสิทธิ์ที่เลือกได้ → การมอบหมายผู้จัดการ
- ผู้จัดการไปใน
open-sse/handlers/(นำเข้าจากที่นั่น, ไม่ใช่ในบรรทัด) - การตอบสนองข้อผิดพลาดใช้
buildErrorBody()/errorResponse()จากopen-sse/utils/error.ts(ทำความสะอาดโดยอัตโนมัติ — ไม่เคยใส่err.stackหรือerr.messageดิบในร่าง) ดูdocs/security/ERROR_SANITIZATION.md. - เพิ่มการทดสอบ — รวมอย่างน้อยหนึ่งการยืนยันว่าการตอบสนองข้อผิดพลาดไม่รั่วไหลของ stack traces (
!body.error.message.includes("at /"))
การเพิ่มโมดูล DB ใหม่
- สร้าง
src/lib/db/yourModule.ts— นำเข้าgetDbInstanceจาก./core.ts - ส่งออกฟังก์ชัน CRUD สำหรับตารางโดเมนของคุณ
- เพิ่มการโยกย้ายใน
src/lib/db/migrations/หากต้องการตารางใหม่ - ส่งออกใหม่จาก
src/lib/localDb.ts(เพิ่มในรายการการส่งออกใหม่เท่านั้น) - เขียนการทดสอบ
การเพิ่มเครื่องมือ MCP ใหม่
- เพิ่มการกำหนดเครื่องมือใน
open-sse/mcp-server/tools/พร้อมกับสคีมาข้อมูลนำเข้าของ Zod + ผู้จัดการแบบอะซิงโครนัส - ลงทะเบียนในชุดเครื่องมือ (เชื่อมต่อโดย
createMcpServer()) - กำหนดให้กับขอบเขตที่เหมาะสม
- เขียนการทดสอบ (การเรียกใช้เครื่องมือบันทึกลงในตาราง
mcp_audit)
การเพิ่มทักษะ A2A ใหม่
- สร้างทักษะใน
src/lib/a2a/skills/(มีอยู่แล้ว 5 ทักษะ: smart-routing, quota-management, provider-discovery, cost-analysis, health-report) - ทักษะได้รับบริบทของงาน (ข้อความ, เมตาดาต้า) → คืนค่าผลลัพธ์ที่มีโครงสร้าง
- ลงทะเบียนใน
A2A_SKILL_HANDLERSในsrc/lib/a2a/taskExecution.ts - เปิดเผยใน
src/app/.well-known/agent.json/route.ts(Agent Card) - เขียนการทดสอบใน
tests/unit/ - เอกสารในตารางทักษะใน
docs/frameworks/A2A-SERVER.md
การเพิ่มตัวแทนคลาวด์ใหม่
- สร้างคลาสตัวแทนใน
src/lib/cloudAgent/agents/ขยายCloudAgentBase(มีอยู่แล้ว 3 ตัว: codex-cloud, devin, jules) - นำไปใช้
createTask,getStatus,approvePlan,sendMessage,listSources - ลงทะเบียนใน
src/lib/cloudAgent/registry.ts - เพิ่มการจัดการ OAuth/ข้อมูลรับรองหากจำเป็น (
src/lib/oauth/providers/) - การทดสอบ + เอกสารใน
docs/frameworks/CLOUD_AGENT.md
การเพิ่ม Guardrail / Eval / Skill / Webhook event ใหม่
- Guardrail:
src/lib/guardrails/→ เอกสาร:docs/security/GUARDRAILS.md - Eval suite:
src/lib/evals/→ เอกสาร:docs/frameworks/EVALS.md - Skill (sandbox):
src/lib/skills/→ เอกสาร:docs/frameworks/SKILLS.md - Webhook event:
src/lib/webhookDispatcher.ts→ เอกสาร:docs/frameworks/WEBHOOKS.md
เอกสารอ้างอิง
สำหรับการเปลี่ยนแปลงที่ไม่ธรรมดา ให้อ่านเอกสารเชิงลึกที่ตรงกันก่อน:
| พื้นที่ | เอกสาร |
|---|---|
| การนำทางใน Repo | docs/architecture/REPOSITORY_MAP.md |
| สถาปัตยกรรม | docs/architecture/ARCHITECTURE.md |
| เอกสารอ้างอิงด้านวิศวกรรม | docs/architecture/CODEBASE_DOCUMENTATION.md |
| Auto-Combo (การให้คะแนน 9 ปัจจัย, 14 กลยุทธ์) | docs/routing/AUTO-COMBO.md |
| ความยืดหยุ่น (กลไก 3 ประการ) | docs/architecture/RESILIENCE_GUIDE.md |
| การเล่นซ้ำการให้เหตุผล | docs/routing/REASONING_REPLAY.md |
| กรอบทักษะ | docs/frameworks/SKILLS.md |
| ระบบหน่วยความจำ (FTS5 + Qdrant) | docs/frameworks/MEMORY.md |
| ตัวแทนคลาวด์ | docs/frameworks/CLOUD_AGENT.md |
| รั้วป้องกัน (PII / การฉีด / วิสัยทัศน์) | docs/security/GUARDRAILS.md |
| ข้อมูลประจำตัวสาธารณะจาก upstream (Gemini/etc.) | docs/security/PUBLIC_CREDS.md |
| การทำความสะอาดข้อความแสดงข้อผิดพลาด | docs/security/ERROR_SANITIZATION.md |
| การประเมินผล | docs/frameworks/EVALS.md |
| การปฏิบัติตาม / การตรวจสอบ | docs/security/COMPLIANCE.md |
| Webhooks | docs/frameworks/WEBHOOKS.md |
| ท่อการอนุญาต | docs/architecture/AUTHZ_GUIDE.md |
| การซ่อนตัว (TLS / ลายนิ้วมือ) | docs/security/STEALTH_GUIDE.md |
| โปรโตคอลตัวแทน (A2A / ACP / Cloud) | docs/frameworks/AGENT_PROTOCOLS_GUIDE.md |
| เซิร์ฟเวอร์ MCP | docs/frameworks/MCP-SERVER.md |
| เซิร์ฟเวอร์ A2A | docs/frameworks/A2A-SERVER.md |
| เอกสารอ้างอิง API + OpenAPI | docs/reference/API_REFERENCE.md + docs/reference/openapi.yaml |
| แคตตาล็อกผู้ให้บริการ (สร้างโดยอัตโนมัติ) | docs/reference/PROVIDER_REFERENCE.md |
| กระบวนการปล่อย | docs/ops/RELEASE_CHECKLIST.md |
การทดสอบ
| สิ่งที่ | คำสั่ง |
|---|---|
| การทดสอบหน่วย | npm run test:unit |
| ไฟล์เดียว | node --import tsx/esm --test tests/unit/file.test.ts |
| Vitest (MCP, autoCombo) | npm run test:vitest |
| E2E (Playwright) | npm run test:e2e |
| โปรโตคอล E2E (MCP+A2A) | npm run test:protocols:e2e |
| ระบบนิเวศ | npm run test:ecosystem |
| เกณฑ์การครอบคลุม | npm run test:coverage (75/75/75/70 — คำสั่ง/บรรทัด/ฟังก์ชัน/สาขา) |
| รายงานการครอบคลุม | npm run coverage:report |
กฎ PR: หากคุณเปลี่ยนแปลงโค้ดการผลิตใน src/, open-sse/, electron/, หรือ bin/, คุณต้องรวมหรืออัปเดตการทดสอบใน PR เดียวกัน
ความชอบชั้นการทดสอบ: หน่วยก่อน → การรวม (หลายโมดูลหรือสถานะ DB) → e2e (UI/กระบวนการทำงานเท่านั้น) เข้ารหัสการทำซ้ำของข้อบกพร่องเป็นการทดสอบอัตโนมัติก่อนหรือพร้อมกับการแก้ไข
นโยบายการครอบคลุม Copilot: เมื่อ PR เปลี่ยนแปลงโค้ดการผลิตและการครอบคลุมต่ำกว่า 75% (คำสั่ง/บรรทัด/ฟังก์ชัน) หรือ 70% (สาขา) อย่าเพียงแค่รายงาน — เพิ่มหรืออัปเดตการทดสอบ รันเกณฑ์การครอบคลุมอีกครั้ง จากนั้นขอการยืนยัน รวมคำสั่งที่รัน ไฟล์ทดสอบที่เปลี่ยนแปลง และผลลัพธ์การครอบคลุมสุดท้ายในรายงาน PR
การทำงานกับ Git
# อย่าคอมมิตโดยตรงไปยัง main
git checkout -b feat/your-feature
git commit -m "feat: อธิบายการเปลี่ยนแปลงของคุณ"
git push -u origin feat/your-feature
คำนำหน้าสาขา: feat/, fix/, refactor/, docs/, test/, chore/
รูปแบบการคอมมิต (Conventional Commits): feat(db): เพิ่ม circuit breaker — ขอบเขต: 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
สภาพแวดล้อม
- Runtime: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25, ES Modules
- TypeScript: 5.9+, target ES2022, module esnext, resolution bundler
- Path aliases:
@/*→src/,@omniroute/open-sse→open-sse/,@omniroute/open-sse/*→open-sse/* - พอร์ตเริ่มต้น: 20128 (API + แดชบอร์ดบนพอร์ตเดียวกัน)
- ไดเรกทอรีข้อมูล:
DATA_DIRenv var, ค่าเริ่มต้นเป็น~/.omniroute/ - ตัวแปรสภาพแวดล้อมหลัก:
PORT,JWT_SECRET,API_KEY_SECRET,INITIAL_PASSWORD,REQUIRE_API_KEY,APP_LOG_LEVEL - การตั้งค่า:
cp .env.example .envจากนั้นสร้างJWT_SECRET(openssl rand -base64 48) และAPI_KEY_SECRET(openssl rand -hex 32)
กฎที่เข้มงวด
- อย่าคอมมิตความลับหรือข้อมูลรับรอง
- อย่าเพิ่มตรรกะใน
localDb.ts - อย่าใช้
eval()/new Function()/ eval ที่แสดงออก - อย่าคอมมิตโดยตรงไปยัง
main - อย่าเขียน SQL ดิบในเส้นทาง — ใช้โมดูล
src/lib/db/ - อย่ากินข้อผิดพลาดใน SSE streams โดยไม่แสดงออก
- ต้องตรวจสอบข้อมูลนำเข้าด้วย Zod schemas เสมอ
- ต้องรวมการทดสอบเมื่อเปลี่ยนแปลงโค้ดการผลิต
- การครอบคลุมต้องอยู่ที่ ≥75% (คำสั่ง, บรรทัด, ฟังก์ชัน) / ≥70% (สาขา). ข้อมูลที่วัดได้ในปัจจุบัน: ~82%.
- อย่าข้าม Husky hooks (
--no-verify,--no-gpg-sign) โดยไม่มีการอนุมัติจากผู้ปฏิบัติงานอย่างชัดเจน - อย่าแทรก client_id/secret ของ OAuth สาธารณะหรือ Firebase Web keys เป็น string literals — ต้องผ่าน
resolvePublicCred()(open-sse/utils/publicCreds.ts) เสมอ ดูdocs/security/PUBLIC_CREDS.md - อย่าคืนค่า
err.stack/err.messageดิบใน HTTP / SSE / การตอบสนองของ executor — ต้องส่งผ่านbuildErrorBody()หรือsanitizeErrorMessage()(open-sse/utils/error.ts) เสมอ ดูdocs/security/ERROR_SANITIZATION.md - อย่าผสมเส้นทางภายนอกหรือค่ารันไทม์ในสคริปต์เชลล์ที่ส่งไปยัง
exec()/spawn()— ส่งผ่านตัวเลือกenvแทน อ้างอิง:src/mitm/cert/install.ts::updateNssDatabases - อย่าปฏิเสธการแจ้งเตือน CodeQL / Secret-Scanning โดยไม่ (a) ตรวจสอบเอกสารรูปแบบข้างต้นก่อนเพื่อดูว่าผู้ช่วยใช้ได้หรือไม่ และ (b) บันทึกเหตุผลทางเทคนิคในความคิดเห็นการปฏิเสธ ตัวอย่าง:
js/stack-trace-exposureที่เกิดขึ้นใน callsites ที่ส่งผ่านsanitizeErrorMessage()แล้วเป็นข้อจำกัดที่ทราบของ CodeQL (custom sanitizers ไม่ได้รับการรับรู้) — ปฏิเสธว่าเป็นfalse positiveโดยอ้างอิงdocs/security/ERROR_SANITIZATION.md - อย่าเปิดเผยเส้นทางที่สร้างกระบวนการลูก (
/api/mcp/,/api/cli-tools/runtime/) โดยไม่มีการจำแนกประเภทisLocalOnlyPath()ในsrc/server/authz/routeGuard.ts. การบังคับใช้ loopback เกิดขึ้นโดยไม่มีเงื่อนไขก่อนการตรวจสอบการรับรองใด ๆ — JWT ที่รั่วไหลผ่านอุโมงค์ไม่สามารถกระตุ้นการสร้างกระบวนการได้ ดูdocs/security/ROUTE_GUARD_TIERS.md - อย่ารวมส่วนต่อท้าย
Co-Authored-Byที่ให้เครดิตกับ AI assistant, LLM หรือบัญชี automation (เช่น ชื่อที่มี "Claude", "GPT", "Copilot", "Bot"; อีเมลที่anthropic.com/openai.com/ ที่อยู่noreply.github.comที่บอทเป็นเจ้าของ) ไว้ในข้อความ commit เด็ดขาด ส่วนต่อท้ายเช่นนี้จะส่ง attribution ของ commit ไปยังบัญชีบอทบน GitHub และซ่อนผู้เขียนจริง (diegosouzapw) ในประวัติ PR ผู้ร่วมมือที่เป็นมนุษย์ — รวมถึงผู้เขียน PR upstream และผู้รายงาน issue ที่ถูก port มายัง OmniRoute — สามารถและควรได้รับเครดิตด้วยส่วนต่อท้ายมาตรฐานCo-authored-by: Name <email>; workflow upstream-port (/port-upstream-features,/port-upstream-issues) ขึ้นอยู่กับสิ่งนี้