* 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 · 🇮🇱 he · 🇮🇳 hi · 🇭🇺 hu · 🇮🇩 id · 🇮🇩 in · 🇮🇹 it · 🇯🇵 ja · 🇰🇷 ko · 🇮🇳 mr · 🇲🇾 ms · 🇳🇱 nl · 🇳🇴 no · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇸🇰 sk · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇻🇳 vi · 🇨🇳 zh-CN
આ ફાઇલ claude.ai/code સાથે કોડ પર કામ કરતી વખતે માર્ગદર્શન પ્રદાન કરે છે.
ઝડપી શરૂઆત
npm install # deps સ્થાપિત કરો (.auto-generates .env from .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 # કડક ચેક (કોઈ પણ નમ્ર નથી)
npm run test:coverage # યુનિટ પરીક્ષાઓ + કવરેજ ગેટ (75/75/75/70 — નિવેદનો/લાઇનો/ફંક્શન/શાખાઓ)
npm run check # lint + પરીક્ષા સંયુક્ત
npm run check:cycles # વર્તુળની નિર્ભરતા શોધો
પરીક્ષાઓ ચલાવવી
# એકલ પરીક્ષા ફાઇલ (Node.js નેટિવ પરીક્ષા રનર — સૌથી વધુ પરીક્ષાઓ)
node --import tsx/esm --test tests/unit/your-file.test.ts
# Vitest (MCP સર્વર, autoCombo, કેશ)
npm run test:vitest
# તમામ સૂટ
npm run test:all
પૂર્ણ પરીક્ષા મેટ્રિક્સ માટે, CONTRIBUTING.md → "પરીક્ષાઓ ચલાવવી" જુઓ. ઊંડા આર્કિટેક્ચર માટે, AGENTS.md જુઓ.
પ્રોજેક્ટ એક નજરમાં
OmniRoute — એકીકૃત AI પ્રોક્સી/રાઉટર. એક એન્ડપોઈન્ટ, 160+ LLM પ્રદાતાઓ, ઓટો-ફોલબેક.
| સ્તર | સ્થાન | ઉદ્દેશ્ય |
|---|---|---|
| API Routes | src/app/api/v1/ |
Next.js એપ્લિકેશન રાઉટર — પ્રવેશ બિંદુઓ |
| 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/ |
સતત સંવાદ મેમરી |
મોનોરેપો: src/ (Next.js 16 એપ્લિકેશન), open-sse/ (સ્ટ્રીમિંગ એન્જિન કાર્યસ્થળ), electron/ (ડેસ્કટોપ એપ્લિકેશન), tests/, bin/ (CLI પ્રવેશ બિંદુ).
વિનંતી પાઇપલાઇન
Client → /v1/chat/completions (Next.js માર્ગ)
→ CORS → Zod માન્યતા → auth? → નીતિ ચકાસણી → પ્રોમ્પ્ટ ઇન્જેક્શન ગાર્ડ
→ handleChatCore() [open-sse/handlers/chatCore.ts]
→ કેશ ચકાસણી → દર મર્યાદા → કોમ્બો રૂટિંગ?
→ resolveComboTargets() → handleSingleModel() પ્રતિ લક્ષ્ય
→ translateRequest() → getExecutor() → executor.execute()
→ fetch() upstream → retry w/ backoff
→ પ્રતિસાદ અનુવાદ → SSE સ્ટ્રીમ અથવા JSON
→ જો Responses API: responsesTransformer.ts TransformStream
API માર્ગો એક સંગ્રહિત પેટર્નનું પાલન કરે છે: Route → CORS preflight → Zod body validation → વૈકલ્પિક auth (extractApiKey/isValidApiKey) → API કી નીતિ અમલ → Handler delegation (open-sse) . કોઈ વૈશ્વિક Next.js માધ્યમ નથી — અવરોધન માર્ગ-વિશિષ્ટ છે.
કોમ્બો રૂટિંગ (open-sse/services/combo.ts): 14 વ્યૂહો (પ્રાથમિકતા, વજનદાર, ફીલ-ફર્સ્ટ, રાઉન્ડ-રોબિન, P2C, રેન્ડમ, ઓછા-વપરાયેલી, ખર્ચ-ઓપ્ટિમાઇઝ્ડ, રીસેટ-જાણકાર, કડક-રેન્ડમ, ઓટો, lkgp, સંદર્ભ-ઓપ્ટિમાઇઝ્ડ, સંદર્ભ-રિલે). દરેક લક્ષ્ય handleSingleModel() ને કૉલ કરે છે જે handleChatCore() ને પ્રતિ-લક્ષ્ય ભૂલ હેન્ડલિંગ અને સર્કિટ બ્રેકર ચકાસણીઓ સાથે લપેટે છે. 9-ફેક્ટ ઓટો-કોમ્બો સ્કોરિંગ માટે docs/routing/AUTO-COMBO.md જુઓ અને 3 રેસિલિયન્સ સ્તરો માટે docs/architecture/RESILIENCE_GUIDE.md જુઓ.
રેસિલિયન્સ રનટાઇમ સ્ટેટ
OmniRoute પાસે ત્રણ સંબંધિત પરંતુ અલગ તાત્કાલિક-અસફળતા મિકેનિઝમ છે. રૂટિંગ વર્તન ડિબગ કરતી વખતે તેમના વ્યાપને અલગ રાખો. એક નજરમાં નકશો માટે 3-સ્તરીય રેસિલિયન્સ આકૃતિ જુઓ (સ્ત્રોત: docs/diagrams/resilience-3layers.mmd).
પ્રદાતા સર્કિટ બ્રેકર
વ્યાપ: સમગ્ર પ્રદાતા, ઉદાહરણ તરીકે glm, openai, anthropic.
ઉદ્દેશ: એક પ્રદાતા તરફ ટ્રાફિક મોકલવાનું રોકવું જે વારંવાર upstream/service સ્તરે નિષ્ફળ થઈ રહ્યું છે, જેથી એક અસ્વસ્થ પ્રદાતા દરેક વિનંતીને ધીમું ન કરે.
અમલ:
- કોર વર્ગ:
src/shared/utils/circuitBreaker.ts - ચેટ ગેટ/કાર્યકારી વાયરિંગ:
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
સ્થિતિઓ:
CLOSED: સામાન્ય ટ્રાફિકની મંજૂરી છે.OPEN: પ્રદાતા તાત્કાલિક બ્લોક કરવામાં આવ્યો છે; કૉલર્સને પ્રદાતા-સર્કિટ-ઓપન પ્રતિસાદ મળે છે અથવા કોમ્બો રૂટિંગ બીજા લક્ષ્ય પર જતી રહે છે.HALF_OPEN: રીસેટ ટાઇમઆઉટ પસાર થઈ ગયો છે; એક પ્રોબ વિનંતીની મંજૂરી આપો. સફળતા બ્રેકર બંધ કરે છે, નિષ્ફળતા તેને ફરીથી ખોલે છે.
ડિફોલ્ટ્સ (open-sse/config/constants.ts):
- OAuth પ્રદાતા: થ્રેશોલ્ડ
3, રીસેટ ટાઇમઆઉટ60s. - API-કી પ્રદાતા: થ્રેશોલ્ડ
5, રીસેટ ટાઇમઆઉટ30s. - સ્થાનિક પ્રદાતા: થ્રેશોલ્ડ
2, રીસેટ ટાઇમઆઉટ15s.
ફક્ત પ્રદાતા-સ્તરીય નિષ્ફળતા સ્થિતિઓ જ પ્રદાતા બ્રેકરને ટ્રિપ કરવી જોઈએ:
(408, 500, 502, 503, 504);
સામાન્ય ખાતા/કી/મોડલ ભૂલો જેવી કે મોટાભાગની 401, 403, અથવા 429 કેસો માટે સમગ્ર-પ્રદાતા બ્રેકર ટ્રિપ ન કરો. તે સામાન્ય રીતે કનેક્શન કૂલડાઉન અથવા મોડલ લોકઆઉટમાં આવે છે. એક સામાન્ય API-કી પ્રદાતા 403 પુનઃપ્રાપ્ય હોવું જોઈએ જો તે ટર્મિનલ પ્રદાતા/ખાતાની ભૂલ તરીકે વર્ગીકૃત ન કરવામાં આવે.
બ્રેકર આલસ્ય પુનઃપ્રાપ્તિનો ઉપયોગ કરે છે, પૃષ્ઠભૂમિ ટાઇમર નથી. જ્યારે OPEN સમાપ્ત થાય છે, ત્યારે getStatus(), canExecute(), અને getRetryAfterMs() જેવી વાંચનોએ રાજ્યને HALF_OPEN માં રિફ્રેશ કરે છે, જેથી ડેશબોર્ડ અને કોમ્બો ઉમેદવાર બિલ્ડર્સ એક સમાપ્ત પ્રદાતા ને સદાય માટે બહાર ન રાખે.
કનેક્શન કૂલડાઉન
વ્યાપ: એક પ્રદાતા કનેક્શન/ખાતું/કી.
ઉદ્દેશ: એક ખરાબ કી/ખાતાને તાત્કાલિક છોડી દેવું જ્યારે સમાન પ્રદાતા માટે અન્ય કનેક્શનને વિનંતીઓ સેવા આપવા માટે ચાલુ રહેવા દેવું.
અમલ:
- લખવા/અપડેટ પાથ:
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-કી આધાર કૂલડાઉન:
3s. - API-કી
429ઉપલબ્ધ હોય ત્યારે upstream પુનઃપ્રાપ્તિ સૂચનો (Retry-After, રીસેટ હેડર્સ, અથવા પાર્સેબલ રીસેટ ટેક્સ્ટ) પસંદ કરવું જોઈએ. - પુનરાવર્તિત પુનઃપ્રાપ્ય નિષ્ફળતાઓ એક્સપોનેન્શિયલ બેકઓફનો ઉપયોગ કરે છે:
baseCooldownMs * 2 ** failureIndex;
એન્ટી-થન્ડરિંગ-હર્ડ ગાર્ડ સમાન કનેક્શન પર સમાન નિષ્ફળતાઓને પુનરાવર્તિત રીતે કૂલડાઉન વધારવા અથવા backoffLevelને ડબલ-ઇન્ક્રિમેન્ટ કરવા રોકે છે.
ટર્મિનલ સ્થિતિઓ કૂલડાઉન નથી. banned, expired, અને credits_exhaustedને પ્રમાણપત્રો/સેટિંગ્સ બદલાય ત્યાં સુધી ઉપલબ્ધ રહેવું જોઈએ અથવા એક ઓપરેટર તેમને ફરીથી સેટ કરે છે. ટર્મિનલ સ્થિતિઓને તાત્કાલિક કૂલડાઉન સ્થિતિ સાથેOverwrite ન કરો.
મોડલ લોકઆઉટ
વ્યાપ: પ્રદાતા + કનેક્શન + મોડલ.
ઉદ્દેશ: જ્યારે માત્ર એક મોડલ ઉપલબ્ધ નથી અથવા તે ક્વોટા-મર્યાદિત છે ત્યારે સમગ્ર કનેક્શનને બંધ કરવાનું ટાળવું.
ઉદાહરણો:
- પ્રતિ-મોડલ ક્વોટા પ્રદાતા
429પાછા આપે છે. - સ્થાનિક પ્રદાતા એક ગુમ થયેલ મોડલ માટે
404પાછા આપે છે. - પ્રદાતા-વિશિષ્ટ મોડ/મોડલ પરવાનગીની નિષ્ફળતાઓ જેમ કે પસંદ કરેલ ગ્રોક મોડ્સ.
મોડલ લોકઆઉટ open-sse/services/accountFallback.ts માં રહે છે અને સમાન કનેક્શનને અન્ય મોડલ સેવા આપવા દે છે.
ડિબગિંગ માર્ગદર્શન
- જો પ્રદાતા માટે તમામ કી છોડી દેવામાં આવે છે, તો પ્રદાતા બ્રેકર સ્થિતિ અને દરેક કનેક્શનના
rateLimitedUntil/testStatusને તપાસો. - જો એક પ્રદાતા પુનઃસેટ વિન્ડો પછી કાયમીExcluded લાગે છે, તો તપાસો કે શું કોડ કાચા
stateને વાંચી રહ્યું છે તેના બદલેgetStatus()/canExecute()નો ઉપયોગ કરી રહ્યું છે. - જો એક પ્રદાતા કી નિષ્ફળ જાય પરંતુ અન્ય કાર્ય કરવા જોઈએ, તો પ્રદાતા બ્રેકર કરતાં કનેક્શન કૂલડાઉનને પસંદ કરો.
- જો માત્ર એક મોડલ નિષ્ફળ જાય, તો કનેક્શન કૂલડાઉન કરતાં મોડલ લોકઆઉટને પસંદ કરો.
- જો એક રાજ્ય સ્વયં-પુનઃપ્રાપ્તિ કરવું જોઈએ, તો તેમાં ભવિષ્યની ટાઇમસ્ટેમ્પ/રીસેટ ટાઇમઆઉટ અને એક વાંચન પાથ હોવો જોઈએ જે સમાપ્ત રાજ્યને રિફ્રેશ કરે. કાયમી સ્થિતિઓ માટે મેન્યુઅલ પ્રમાણપત્ર અથવા કન્ફિગ ફેરફારોની જરૂર છે.
મુખ્ય પરંપરાઓ
કોડ શૈલી
- 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 સિંગલટન:
getDbInstance()src/lib/db/core.tsમાંથી (WAL જર્નલિંગ) - માઇગ્રેશન:
src/lib/db/migrations/— સંસ્કરણવાળા SQL ફાઇલો, આઇડેમ્પોટન્ટ, ટ્રાન્ઝેક્શનમાં ચલાવો
ભૂલ સંભાળવું
- ચોક્કસ ભૂલ પ્રકારો સાથે try/catch, pino સંદર્ભ સાથે લોગ કરો
- SSE સ્ટ્રીમમાં ભૂલો ક્યારેય ન છુપાવો — સફાઈ માટે abort સંકેતોનો ઉપયોગ કરો
- યોગ્ય HTTP સ્થિતિ કોડ્સ પરત કરો (4xx/5xx)
સુરક્ષા
- ક્યારેય
eval(),new Function(), અથવા IMPLIED eval નો ઉપયોગ ન કરો - Zod સ્કીમા સાથે તમામ ઇનપુટને માન્ય બનાવો
- આરામ પર ક્રેડેંશિયલ્સને એન્ક્રિપ્ટ કરો (AES-256-GCM)
- અપસ્ટ્રીમ હેડર ડિનાયલિસ્ટ:
src/shared/constants/upstreamHeaders.ts— સંપાદન કરતી વખતે સાફ, Zod સ્કીમા, અને યુનિટ ટેસ્ટને સમન્વયિત રાખો - જાહેર અપસ્ટ્રીમ ક્રેડેંશિયલ્સ (Gemini/Antigravity/Windsurf-શૈલી OAuth client_id/secret + Firebase વેબ કી જાહેર CLIsમાંથી કાઢી લેવામાં આવી): જરૂરી છે
resolvePublicCred()દ્વારા એમ્બેડ કરવુંopen-sse/utils/publicCreds.tsમાં — ક્યારેય સ્ટ્રિંગ લિટરલ તરીકે નહીં. ફરજિયાત પેટર્ન માટેdocs/security/PUBLIC_CREDS.mdજુઓ. - ભૂલ પ્રતિસાદ (HTTP / SSE / executor / MCP હેન્ડલર): જરૂરી છે
buildErrorBody()અથવાsanitizeErrorMessage()દ્વારા માર્ગદર્શન આપવુંopen-sse/utils/error.tsમાં — ક્યારેય કાચાerr.stackઅથવાerr.messageને પ્રતિસાદના શરીરમાં ન મૂકો.docs/security/ERROR_SANITIZATION.mdજુઓ. - ચલનશીલ કમાન્ડ્સ જે ચર સાથે બનાવવામાં આવે છે: જ્યારે
exec()/spawn()ને સ્ક્રિપ્ટ સાથે કૉલ કરો જે રનટાઇમ મૂલ્યોની જરૂર છે, ત્યારે તેમનેenvવિકલ્પ દ્વારા પસાર કરો (સ્વચાલિત રીતે શેલ-એસ્કેપ્ડ) — ક્યારેય વિશ્વાસ ન કરાતા/બાહ્ય પાથને સ્ક્રિપ્ટના શરીરમાં સ્ટ્રિંગ-ઇન્ટરપોલેટ ન કરો. સંદર્ભ: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-માન્ય)- જો કસ્ટમ લોજિકની જરૂર હોય તો
open-sse/executors/માં એક્ઝિક્યુટર ઉમેરો (BaseExecutorને વિસ્તૃત કરો) - જો નોન-ઓપનએઆઈ ફોર્મેટ હોય તો
open-sse/translator/માં અનુવાદક ઉમેરો - જો OAuth આધારિત હોય તો
src/lib/oauth/constants/oauth.tsમાં OAuth કન્ફિગ ઉમેરો — જો અપસ્ટ્રીમ CLI જાહેર client_id/secret મોકલે, તોresolvePublicCred()દ્વારા એમ્બેડ કરો (જુઓdocs/security/PUBLIC_CREDS.md), ક્યારેય લિટરલ તરીકે નહીં open-sse/config/providerRegistry.tsમાં મોડલ્સ નોંધણી કરોtests/unit/માં ટેસ્ટ લખો (જો તમે નવા એમ્બેડેડ ડિફોલ્ટ ઉમેર્યા હોય તો જાહેરCreds આકારની પુષ્ટિનો સમાવેશ કરો)
નવા API માર્ગ ઉમેરવો
src/app/api/v1/your-route/હેઠળ ડિરેક્ટરી બનાવોGET/POSTહેન્ડલર્સ સાથેroute.tsબનાવો- પેટર્ન અનુસરો: CORS → Zod શરીર માન્યતા → વૈકલ્પિક ઓથ → હેન્ડલર ડેલિગેશન
- હેન્ડલર
open-sse/handlers/માં જાય છે (ત્યાંથી આયાત કરો, ઇનલાઇન નહીં) - ભૂલ પ્રતિસાદો
buildErrorBody()/errorResponse()નો ઉપયોગ કરે છેopen-sse/utils/error.tsમાં (સ્વચાલિત રીતે સાફ — ક્યારેયerr.stackઅથવાerr.messageકાચા શરીરમાં ન મૂકો).docs/security/ERROR_SANITIZATION.mdજુઓ. - ટેસ્ટ ઉમેરો — જેમાં ઓછામાં ઓછું એક પુષ્ટિ છે કે ભૂલ પ્રતિસાદ સ્ટેક ટ્રેસને લીક નથી કરતી (
!body.error.message.includes("at /"))
નવા DB મોડ્યુલ ઉમેરવો
src/lib/db/yourModule.tsબનાવો —./core.tsમાંથીgetDbInstanceઆયાત કરો- તમારા ડોમેન ટેબલ માટે CRUD ફંક્શન નિકાસ કરો
- જો નવી ટેબલની જરૂર હોય તો
src/lib/db/migrations/માં માઇગ્રેશન ઉમેરો src/lib/localDb.tsમાંથી પુનઃ-નિકાસ કરો (ફક્ત પુનઃ-નિકાસ યાદીમાં ઉમેરો)- ટેસ્ટ લખો
નવા MCP ટૂલ ઉમેરવો
- Zod ઇનપુટ સ્કીમા + અસિંક હેન્ડલર સાથે
open-sse/mcp-server/tools/માં ટૂલ વ્યાખ્યા ઉમેરો - ટૂલ સેટમાં નોંધણી કરો (
createMcpServer()દ્વારા વાયરડ) - યોગ્ય સ્કોપ(ઓ)ને સોંપો
- ટેસ્ટ લખો (ટૂલ કૉલને
mcp_auditટેબલમાં લોગ કરવામાં આવે છે)
નવા A2A સ્કિલ ઉમેરવો
src/lib/a2a/skills/માં સ્કિલ બનાવો (5 પહેલાથી જ છે: સ્માર્ટ-રાઉટિંગ, ક્વોટા-મૅનેજમેન્ટ, પ્રદાતા-ખોજ, ખર્ચ-વિશ્લેષણ, આરોગ્ય-રિપોર્ટ)- સ્કિલ કાર્ય સંદર્ભ (સંદેશા, મેટાડેટા) પ્રાપ્ત કરે છે → રચિત પરિણામ પરત કરે છે
src/lib/a2a/taskExecution.tsમાંA2A_SKILL_HANDLERSમાં નોંધણી કરોsrc/app/.well-known/agent.json/route.tsમાં બહાર પાડો (એજન્ટ કાર્ડ)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માં દસ્તાવેજ
નવા ગાર્ડરેલ / ઇવલ / સ્કિલ / વેબહૂક ઇવેન્ટ ઉમેરવો
- ગાર્ડરેલ:
src/lib/guardrails/→ દસ્તાવેજ:docs/security/GUARDRAILS.md - ઇવલ સ્યુટ:
src/lib/evals/→ દસ્તાવેજ:docs/frameworks/EVALS.md - સ્કિલ (સેન્ડબોક્સ):
src/lib/skills/→ દસ્તાવેજ:docs/frameworks/SKILLS.md - વેબહૂક ઇવેન્ટ:
src/lib/webhookDispatcher.ts→ દસ્તાવેજ:docs/frameworks/WEBHOOKS.md
સંદર્ભ દસ્તાવેજ
કોઈપણ નોન-ટ્રિવિયલ ફેરફાર માટે, પહેલા મેળ ખાતા ડીપ-ડાઈવ વાંચો:
| વિસ્તાર | દસ્તાવેજ |
|---|---|
| રેપો નેવિગેશન | docs/architecture/REPOSITORY_MAP.md |
| આર્કિટેક્ચર | docs/architecture/ARCHITECTURE.md |
| એન્જિનિયરિંગ સંદર્ભ | docs/architecture/CODEBASE_DOCUMENTATION.md |
| ઓટો-કોમ્બો (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 |
| જાહેર અપસ્ટ્રીમ ક્રેડેન્શિયલ્સ (Gemini/etc.) | docs/security/PUBLIC_CREDS.md |
| ભૂલ સંદેશા સાફ કરવા | docs/security/ERROR_SANITIZATION.md |
| ઇવલ્સ | docs/frameworks/EVALS.md |
| અનુરૂપતા / ઓડિટ | docs/security/COMPLIANCE.md |
| વેબહૂક્સ | docs/frameworks/WEBHOOKS.md |
| અધિકૃતતા પાઇપલાઇન | docs/architecture/AUTHZ_GUIDE.md |
| સ્ટેલ્થ (TLS / ફિંગરપ્રિન્ટ) | docs/security/STEALTH_GUIDE.md |
| એજન્ટ પ્રોટોકોલ્સ (A2A / ACP / ક્લાઉડ) | 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 |
| વિટેસ્ટ (MCP, autoCombo) | npm run test:vitest |
| E2E (પ્લેવિરાઇટ) | 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/વર્કફ્લો માત્ર). બગ પુનરાવૃત્તિઓને સ્વચાલિત પરીક્ષણો તરીકે કોડ કરો પહેલા અથવા સુધારણા સાથે.
કોપાઇલોટ કવરેજ નીતિ: જ્યારે PR ઉત્પાદન કોડને બદલે છે અને કવરેજ 75% (નિવેદનો/લાઇન/ફંક્શન) અથવા 70% (શાખાઓ) ની નીચે છે, તો ફક્ત રિપોર્ટ ન કરો — પરીક્ષણો ઉમેરો અથવા અપડેટ કરો, કવરેજ ગેટ ફરી ચલાવો, પછી પુષ્ટિ માટે પૂછો. PR રિપોર્ટમાં ચલાવેલ આદેશો, બદલાયેલ પરીક્ષણ ફાઇલો, અને અંતિમ કવરેજ પરિણામ સામેલ કરો.
Git વર્કફ્લો
# ક્યારેય સીધા મુખ્યમાં કમિટ ન કરો
git checkout -b feat/your-feature
git commit -m "feat: તમારા ફેરફારનું વર્ણન કરો"
git push -u origin feat/your-feature
બ્રાંચ પ્રિફિક્સ: feat/, fix/, refactor/, docs/, test/, chore/
કમિટ ફોર્મેટ (પરંપરાગત કમિટ્સ): feat(db): સર્કિટ બ્રેકર ઉમેરો — સ્કોપ્સ: db, sse, oauth, dashboard, api, cli, docker, ci, mcp, a2a, memory, skills
હસ્કી હૂક્સ:
- પ્રિ-કમિટ: lint-staged +
check-docs-sync+check:any-budget:t11 - પ્રિ-પુશ:
npm run test:unit
પર્યાવરણ
- રનટાઇમ: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25, ES Modules
- ટાઇપસ્ક્રિપ્ટ: 5.9+, લક્ષ્ય ES2022, મોડ્યુલ esnext, રિઝોલ્યુશન બંડલર
- પાથ એલિયાસ:
@/*→src/,@omniroute/open-sse→open-sse/,@omniroute/open-sse/*→open-sse/* - ડિફોલ્ટ પોર્ટ: 20128 (API + ડેશબોર્ડ એક જ પોર્ટ પર)
- ડેટા ડિરેક્ટરી:
DATA_DIRenv var, ડિફોલ્ટ~/.omniroute/ - કી env vars:
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 સ્ટ્રીમમાં ભૂલને મૌન રીતે નાશ ન કરો
- હંમેશા Zod સ્કીમા સાથે ઇનપુટને માન્ય બનાવો
- ઉત્પાદન કોડ બદલતા સમયે હંમેશા પરીક્ષણો સામેલ કરો
- કવરેજ ≥75% (નિવેદનો, લાઇન, ફંક્શન) / ≥70% (શાખાઓ) રહેવું જોઈએ. વર્તમાન માપવામાં આવેલ: ~82%.
- સ્પષ્ટ ઓપરેટર મંજૂરી વિના હસ્કી હૂક્સ (
--no-verify,--no-gpg-sign) ને ક્યારેય બાયપાસ ન કરો. - ક્યારેય જાહેર અપસ્ટ્રીમ OAuth client_id/secret અથવા Firebase વેબ કી ને સ્ટ્રિંગ લિટરલ તરીકે એમ્બેડ ન કરો — હંમેશા
resolvePublicCred()(open-sse/utils/publicCreds.ts) દ્વારા જાઓ. જુઓdocs/security/PUBLIC_CREDS.md. - ક્યારેય HTTP / SSE / એક્ઝિક્યુટર પ્રતિસાદોમાં કાચા
err.stack/err.messageપાછા ન કરો — હંમેશા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જે કૉલસાઇટ્સ પર ઉઠાવવામાં આવ્યું છે જે પહેલાથી જsanitizeErrorMessage()મારફતે રૂટ કરે છે તે એક જાણીતી CodeQL મર્યાદા છે (કસ્ટમ સેનિટાઇઝર્સ માન્ય નથી) —docs/security/ERROR_SANITIZATION.mdને સંદર્ભિત કરીનેfalse positiveતરીકે નકારી નાખો. - ક્યારેય બાળકોની પ્રક્રિયાઓને શરૂ કરતી રૂટ્સને (
/api/mcp/,/api/cli-tools/runtime/)src/server/authz/routeGuard.tsમાંisLocalOnlyPath()વર્ગીકરણ વિના સામેલ ન કરો. લૂપબેક અમલમાં કોઈપણ ઓથ ચેક પહેલાં શરત વિના થાય છે — ટનલ દ્વારા લીક થયેલ JWT પ્રક્રિયા શરૂ કરવા માટે પ્રેરણા આપી શકતું નથી. જુઓdocs/security/ROUTE_GUARD_TIERS.md. - ક્યારેય
Co-Authored-Byટ્રેલર્સને સામેલ ન કરો જે AI સહાયક, LLM અથવા સ્વચાલિત ખાતાને શ્રેય આપે છે (દા.ત. "Claude", "GPT", "Copilot", "Bot" ધરાવતા નામો;anthropic.com/openai.com/ બોટની માલિકીનાnoreply.github.comસરનામા પરના ઈમેઈલો). આવા ટ્રેલર્સ GitHub પર બોટ ખાતામાં કમિટ એટ્રિબ્યુશન રૂટ કરે છે, PR ઇતિહાસમાં વાસ્તવિક લેખકને (diegosouzapw) છુપાવે છે. માનવ સહયોગીઓ — upstream PR લેખકો અને OmniRoute પર પોર્ટ થતા issue રિપોર્ટરો સહિત — પ્રમાણભૂતCo-authored-by: Name <email>ટ્રેલર્સ સાથે શ્રેય મેળવી શકે છે અને જોઈએ; upstream-port વર્કફ્લો (/port-upstream-features,/port-upstream-issues) આના પર નિર્ભર છે.