mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-05 23:02:10 +03:00
* fix(gemini): preserve structured tool calls for antigravity * fix(gemini): parse prefixed textual tool calls * fix(antigravity): preserve textual SSE tool calls * fix(stream): normalize textual passthrough tool calls * fix(stream): normalize split textual tool calls * fix(stream): suppress malformed textual tool calls * fix(stream): suppress compact malformed tool calls * fix(stream): emit structured textual tool calls * fix(stream): suppress unknown textual tool calls * fix(stream): normalize responses textual tool calls * chore: ignore .claude/settings.local.json (per-user Claude Code permissions) * fix(opencode-go): route qwen3.x via claude messages + repair fixMissingToolResponses for Claude-shape upstreams (#2791) Integrated into release/v3.8.6 * fix: resolve npm install warnings — remove dead deps, relax engine constraint (#2792) Integrated into release/v3.8.6 * fix: register missing web-cookie validators (claude-web, gemini-web, copilot-web, t3-web) (#2793) Integrated into release/v3.8.6 * fix: Error: Unable to inspect existing database #2771 (#2795) Integrated into release/v3.8.6 * fix(oauth): repair Google loopback callback flow (#2796) Integrated into release/v3.8.6 * feat(logs): add clean history button (#2799) Integrated into release/v3.8.6 * [codex] home: restore settings-driven home layout and quota auto-refresh (#2800) Integrated into release/v3.8.6 * fix(gemini): emit signaturelessToolCallMode:text for GEMINI format models (#2801) Integrated into release/v3.8.6 * feat(modelSpecs): align opencode-go family with upstream provider limits (#2802) Integrated into release/v3.8.6 * chore: apply unit test fixes, polyfills, and environment precedence fixes * docs(agents): atualiza fluxos de release e triagem Expande os workflows de release para incluir auditoria de segurança, CHANGELOG completo por commits, quality gate obrigatório, homologação em VPS local, publicação oficial, deploy em Akamai e validação de artefatos. Reorganiza a triagem de features com arquivos permanentes por bucket, suporte a itens em andamento, regra de reclaim após 15 dias e novo tratamento para ideias viáveis catalogadas. Corrige a orientação de revisão de discussões para usar a ordem cronológica real dos comentários e respostas ao identificar a última atividade. * fix(lockout): classify Gemini Antigravity resource exhaustion as quota_exhausted * fix(reasoning): gate replay by interleaved field * docs(rule-16): permit human Co-authored-by, restrict only AI/bot trailers Rule #16 previously banned all `Co-Authored-By` trailers absolutely. That blocked the upstream-port workflows (`/port-upstream-features` and `/port-upstream-issues`), which must credit human upstream PR authors and issue reporters in OmniRoute commits. Refine the rule to ban only AI/bot-attributed trailers (Claude, GPT, Copilot, Bot; anthropic.com / openai.com / bot-owned noreply.github.com emails) while allowing standard human `Co-authored-by: Name <email>` attribution. Sync the rule across the source CLAUDE.md, the E2E shakedown doc note, and 41 i18n translations. * fix(gitlawb): add specialty validators for connection test — bypass /models probe GitLawB OpenGateway API (xiaomi-mimo compatible) does not expose a /models endpoint, causing validateOpenAILikeProvider to 404 on the initial probe and report 'Provider validation endpoint not supported'. Add specialty validators for both gitlawb and gitlawb-gmi that follow the same pattern as the existing xiaomi-mimo validator: skip GET /models, validate directly via POST /chat/completions with a minimal test message. Any 401/403 response means an invalid key; all other responses mean auth is OK. Fixes test-connection returning 404 for GitLawB providers. * test(gitlawb): add 12 unit tests for gitlawb and gitlawb-gmi specialty validators Covers success, auth failure (401/403), non-auth acceptance (400/422/429), network errors, and custom baseUrl overrides for both providers. * feat(gitlawb): serve models from static registry without API-unavailable warning GitLawB's OpenGateway API does not expose a /models endpoint per provider-path. Previously the models route fell through to the generic fallback which returned static catalog models with the misleading 'API unavailable — using local catalog' warning. Now gitlawb and gitlawb-gmi are handled as static model providers (same pattern as reka and qwen OAuth) — models are served from the provider registry without any warning, since all registered models are functional via POST /chat/completions. * refactor(gitlawb): extract shared opengateway validator factory, fix docs path in test - Extract gitlawb/gitlawb-gmi validators into buildOpengatewayValidator factory - Fix dockerignore-docs-coverage test: update stale docs/AUTO-COMBO.md -> docs/routing/AUTO-COMBO.md * fix(reasoning): guard interleaved capability lookup * feat(gitlawb): dynamic model fetch with gmi-cloud fallback Hybrid approach: - gitlawb (xiaomi-mimo): dynamic /models endpoint → 356 models - gitlawb-gmi (gmi-cloud): 404 fallback → local catalog gracefully Mimics Gitlawb/openclaude's model-routing pattern * i18n(pt-BR): complete missing translations and sync with en.json * feat(build): nix multi-OS package manager install (#2806) Integrated into release/v3.8.6 * fix(i18n): translate 144 new __MISSING__ pt-BR strings (#2816) Integrated into release/v3.8.6 * chore(docs): set coverage gate to 40/40/40/40 in CLAUDE.md Aligns the documented coverage gate with the v3.8.6 release decision (lowered from 75/75/75/70). Matches the threshold already set in package.json by the large feature PRs (planos 11-22). * fix(cli): respect PORT env var in serve command (#2845) Integrated into release/v3.8.6. * fix(deepseek-web): return 400 when client sends tools[] - chat.deepseek.com has no tool support (#2854) Integrated into release/v3.8.6. * fix(qoder): reject invalid/expired PATs returning Cosy 500 error (#2860) Integrated into release/v3.8.6. * fix(cli): register openclaw in tool-detector (#2833) (#2850) Integrated into release/v3.8.6. * fix(api): include noAuth providers in /v1/models catalog (#2798) (#2814) Integrated into release/v3.8.6. * fix(combo): resolve custom provider targets via combo name (#2778) (#2812) Integrated into release/v3.8.6. * fix(translator): strip safety_identifier in openai-responses cleanup (#2770) (#2809) Integrated into release/v3.8.6. * fix(quota): honor explicit per-connection preflight opt-out (#2831) (#2844) Integrated into release/v3.8.6. * fix(usage): un-invert GitHub Copilot Free/limited quota — limited_user_quotas is remaining (#2876) (#2881) Integrated into release/v3.8.6. * fix(nous-research): correct baseUrl to include /chat/completions (#2826) (#2835) Integrated into release/v3.8.6. * fix(opencode): qwen3.x max/plus models lack vision support (#2822) (#2836) Integrated into release/v3.8.6. * fix(translator): pass-through tool_search built-in tool type (#2766) (#2811) Integrated into release/v3.8.6. * fix(github): route claude-opus-4.6 via chat completions (#2821) Integrated into release/v3.8.6. * docs(oauth): add Windsurf login fix design (Phase 1 hotfix + Phase 2 Firebase OAuth) Two-phase plan to fix the broken Windsurf OAuth flow: - Phase 1: drop the dead app.devin.ai/editor/signin PKCE path, promote import-token from windsurf.com/show-auth-token as the primary path - Phase 2: port Firebase OAuth + RegisterUser flow from fendoushaonian/WindSurf-gRPC-API for full browser-based automation Spec only - no code changes yet. * docs(plan): Phase 1 windsurf login hotfix implementation plan 10 tasks covering: - TDD assertions for flowType + 410 Gone responses - Provider switch to import_token - Route handler retiring authorize/start-callback-server/poll-callback - OAuthModal UI override - i18n sync - Verification + PR steps * fix(cli): replace cli-table3 with hand-rolled formatter (#2752) (#2813) Integrated into release/v3.8.6. * fix(skills): skip interception for unregistered client-native tools (#2815) (#2817) Integrated into release/v3.8.6. * feat(sse): add RTK filters for kubectl, docker-build, composer, gh (#2824) Integrated into release/v3.8.6. * fix(geminiHelper): support rec.image content shape + warn on dropped remote URLs (refs #2807) (#2855) Integrated into release/v3.8.6. * fix(cli): allow nullable/optional apiKey in cliMitmStartSchema (#2857) Integrated into release/v3.8.6. * fix(combo): preserve system messages during context handoff summary generation (#2865) Integrated into release/v3.8.6. * fix: wire CLIProxyAPI fallback settings into chatCore routing engine (#2866) Integrated into release/v3.8.6. * fix(usage): add opencode quota fetcher (#2852) (#2867) Integrated into release/v3.8.6. * feat(claude): default xhigh support for newer Opus models (#2874) Integrated into release/v3.8.6. * fix(cli): restore omniroute logs command stream (#2756) (#2810) Integrated into release/v3.8.6. * fix(combo): normalize upstream Headers for Node 24 undici interop (#2751) (#2823) Integrated into release/v3.8.6. * Rename proxy log Public IP to Client IP (#2880) Integrated into release/v3.8.6. * fix(claude): preserve max effort for supported models (#2875) Integrated into release/v3.8.6. * fix(oauth): switch windsurf provider to import_token flow The PKCE auth URL targeting app.devin.ai/editor/signin returns 404 post-rebrand. Until Phase 2 ports Firebase OAuth + RegisterUser, the only supported path is import-token via windsurf.com/show-auth-token. - windsurf.ts: drop buildAuthUrl, set flowType=import_token - generateAuthData returns supported:false + helpful error for windsurf/devin-cli - tests: assert flowType + disabled stub * fix(oauth): return 410 Gone for retired windsurf/devin-cli PKCE actions start-callback-server, authorize, and poll-callback (GET + POST) now return 410 Gone with a pointer to /import-token. The 410 short-circuit runs before auth so the response is honest about the action being permanently gone, not gated. Codex PKCE flow unchanged. Tests: 5 new assertions cover GET + POST 410 paths and a Codex regression check. * refactor(oauth): annotate retired PKCE fields in WINDSURF_CONFIG No behaviour change - comment-only update documenting that authorizeUrl, codeChallengeMethod, callbackPort, callbackPath, apiServerUrl, and exchangePath are no longer consumed. Active fields (inferenceUrl, showAuthTokenUrl, firebaseApiKey, ideName) called out separately. * fix(cli,docs): use requireCliToolsAuth in logs route + document OPENCODE quota env Post-merge contract fixes for v3.8.6: - src/app/api/cli-tools/logs/route.ts (#2810) now uses the shared requireCliToolsAuth guard (param renamed req->request) to satisfy the cli-tools-auth-hardening contract test. - Document OMNIROUTE_OPENCODE_QUOTA_URL (#2867) in docs/reference/ENVIRONMENT.md to satisfy the env/docs sync contract. * fix(dashboard): force import-token panel for windsurf/devin-cli Phase 1 hotfix: hide the 'Browser Login' tab and start in Paste API Key mode. Removes windsurf/devin-cli from PKCE_CALLBACK_SERVER_PROVIDERS so no callback server is started for them. Codex still uses the PKCE flow. The 'Get token' link continues to point at windsurf.com/show-auth-token via the existing supportsTokenPaste form copy. * fix(oauth): windsurf import-token mapTokens signature mismatch The route at `src/app/api/oauth/[provider]/[action]/route.ts` invokes `providerData.mapTokens({ accessToken: token })` (object), matching the cursor/kiro signature. The windsurf provider was declared with `mapTokens(token: string)` instead, so the entire object was stored as `accessToken`. When the connection record reached the SQLite layer it crashed with: SQLite3 can only bind numbers, strings, bigints, buffers, and null Fix by aligning windsurf's `mapTokens` signature with the route caller and the cursor/kiro convention. Also dedupe a copy-pasted second `if (action === "import-token")` block in the route handler — the second block was unreachable but identical to the first. Adds two regression tests asserting that `provider.mapTokens({ accessToken })` returns a string `accessToken` for both windsurf and devin-cli, so a future signature drift trips the gate instead of the SQLite bind error in production. * feat(compression): expand pt-BR pack with troglodita rules (15 → 49) (#2818) Integrated into release/v3.8.6 * fix(sse): repair RTK engine defaults so dedup and direct calls work (#2825) Integrated into release/v3.8.6 * fix(mcp): redirect console.log/warn to stderr in --mcp stdio mode (#2840) Integrated into release/v3.8.6 * fix(gemini-cli): prefer real project IDs over default-project (#2841) Integrated into release/v3.8.6 * fix(opencode-go): add provider limits quota fetcher (#2861) Integrated into release/v3.8.6 * Audit & add web cookie providers: fix 4 missing registry entries + DuckDuckGo (#2862) Integrated into release/v3.8.6 * fix(antigravity): harden signatureless tool history (#2878) Integrated into release/v3.8.6 * fix: provider model sync pruning and dynamic antigravity MITM proxy mappings (#2886) Integrated into release/v3.8.6 * feat(usage): per-API-key token limits scoped to model/provider/global (#2888) Integrated into release/v3.8.6 * fix(audio): build multipart body manually to preserve Content-Type (#2842) Integrated into release/v3.8.6 * refactor: remove agent skill documentation files and streamline maintenance workflows * test(stabilization): resolve unit test failures in blackbox-web, schema-coercion, translator-helper-branches, usage-service-hardening, and audio-transcription * fix(security): mitigate Socket.dev supply-chain findings + secrets opt-in + minimal build profile (#2863) (#2871) Two real security gaps closed and four cosmetic Socket.dev fingerprints removed. See docs/security/SOCKET_DEV_FINDINGS.md for the per-finding maintainer attestation. Real bugs fixed: - cloudSync: HMAC verification of `X-Cloud-Sig` + opt-in `OMNIROUTE_CLOUD_SYNC_SECRETS=true` before overwriting `accessToken` / `refreshToken` / `providerSpecificData` from a remote response. Closes the silent-credential-swap surface (a misconfigured or hostile CLOUD_URL could previously replace local tokens unverified). - Zed import: split into 2-step `/discover` + `/import` flow. `/import` now requires `confirmedAccounts: [{ service, account, fingerprint }]` and re-reads the keychain server-side to filter by fingerprint, so a tampered discover response cannot trick the endpoint into saving an unrelated token. Cosmetic Socket.dev mitigations: - runElevatedPowerShell writes the elevated payload to a per-call temp `.ps1` file (mode 0o600) and references it via `-File`. Removes the textbook `-EncodedCommand <base64utf16le>` pattern flagged as malware by Socket's AI classifier. - Maintainer attestation `SECURITY-AUDITOR-NOTE:` blocks added at every flagged call site pointing to `docs/security/SOCKET_DEV_FINDINGS.md`. Build-time hardening: - `OMNIROUTE_BUILD_PROFILE=minimal` (`npm run build:secure`) physically removes the four sensitive modules from the standalone bundle via webpack `NormalModuleReplacementPlugin`. Stubs throw `FeatureDisabledError` at runtime. Intended for the `omniroute-secure` artifact. Tests: - 24 new unit tests in `tests/unit/security/` covering the wrapper builder, HMAC verification (4 cases), credential fingerprint determinism (5 cases), confirmedAccounts validation + fingerprint filtering (6 cases), and the minimal-build stubs (5 cases). Docs: - New `docs/security/SOCKET_DEV_FINDINGS.md` — per-finding attestation. - New `socket.yml` — Socket.dev v2 config pointing at the attestation. - Updated `SECURITY.md` — supply-chain scanner section. - Updated `.env.example` — three new env vars documented. Backwards compatibility: - Cloud sync token overwrite is OFF by default. Users who relied on it must set `OMNIROUTE_CLOUD_SYNC_SECRETS=true`. Breaking change documented in CHANGELOG. - Zed import 2-step is the new default; legacy 1-step preserved behind `OMNIROUTE_ZED_IMPORT_LEGACY_ONE_STEP=true` and will be removed in v3.9. Closes #2863 * fix(security): redact public Firebase Web key from windsurf spec; doc SHA-256 cache-key rationale (#2894) Two security-scanning findings on release/v3.8.6: - Secret-scanning alert 7 (google_api_key): the windsurf login-fix design spec embedded the literal public Firebase Web API key on two lines. Firebase Web API keys are non-sensitive by design (they identify the project; access is gated by Firebase Security Rules + key restrictions), but the literal trips secret scanning. Redacted to a placeholder; the embedded default still goes through resolvePublicCred per rule #11. - Code-scanning alert 261 (js/insufficient-password-hash): tokenCacheKey() uses SHA-256 to derive an in-memory cache key from the session token, not for password-at-rest storage. Added a comment documenting why CWE-916 KDFs do not apply (false positive). * fix(ci): resolve release/v3.8.6 gate failures (docs-sync, any-budget, pack-artifact) (#2895) * fix(ci): resolve release/v3.8.6 gate failures (docs-sync, any-budget, pack-artifact) Three CI gates failed on release/v3.8.6 (run 26630300877): - docs-sync: CHANGELOG had a spurious "## [3.8.6-patch]" section above "## [3.8.6]", so the latest release no longer matched package.json (3.8.6) and the 41 i18n CHANGELOG mirrors were flagged as missing that section. Fold the lone #2752 entry into [3.8.6] and drop the patch heading. - any-budget:t11: open-sse/handlers/chatCore.ts regressed to 1 explicit `any` (budget 0). Type the persist callback arg as Record<string, unknown>, which matches runWithOnPersist's RefreshPersistFn contract exactly. - pack-artifact: open-sse/utils/setupPolyfill.ts ships via package.json "files" (bin/omniroute.mjs imports it at startup) but was missing from the pack policy allowlist. Allow it and add a regression test. * fix(security): redact public Firebase Web key from windsurf spec Redact the literal public Firebase Web API key (secret-scanning #7) to a placeholder, mirroring the redaction on release/v3.8.6 (PR #2894) and the windsurf fix branch. Non-sensitive public Web key; trips secret scanning. * feat(combo): Zero-Latency Combos (Hedging, Proactive Compression, Predictive TTFT) (#2868) * feat(combo): implement zero-latency combo optimizations (hedging, proactive compression, predictive TTFT) * fix(combo): fix predictive TTFT skip logic and unhandled promise rejections --------- Co-authored-by: Automation <automation@omniroute> * feat: implement automated skill workflows and update system configuration and validation schemas * test: eliminate dynamic cast warnings in cloud-sync unit test * test: isolate services-branch-hardening database directory to avoid concurrency issues * feat(providers): add 7 new web-cookie providers + research catalog + discovery tool New providers: - huggingchat: free LLM chat via huggingface.co/chat (no subscription) - phind: free dev-focused AI chat via phind.com/api/agent - poe-web: multi-model chat via poe.com GraphQL (p-b cookie) - venice-web: privacy-focused AI chat via venice.ai (session cookie) - v0-vercel-web: Vercel v0 code gen via v0.dev (session cookie) - kimi-web: Moonshot Kimi chat via kimi.moonshot.cn (session cookie) - doubao-web: ByteDance Doubao chat via doubao.com (session cookie) Additional: - Research catalog: docs/research/UNLIMITED_LLM_ACCESS.md - Discovery tool design + stub: src/lib/discovery/ + migration 073 - Unit tests: 33 tests for all 7 providers - Shared helpers consolidated in error.ts (slop cleanup) - All registered in WEB_COOKIE_PROVIDERS + providerRegistry + webSessionCredentials Closes #2885 * fix(typecheck): resolve typecheck errors in combo spec and compression modules * feat(api,oauth): add `agy` (Antigravity CLI) standalone provider with CLI token import (#2899) Add a standalone OAuth provider `agy` (Antigravity CLI) next to gemini-cli/antigravity. It reuses the antigravity inference backend (identical Google client_id + daily-cloudcode-pa.googleapis.com endpoint, executor and token-refresh) but ships its own model catalog — including the Claude models the backend exposes (claude-opus-4-6-thinking, claude-sonnet-4-6) — its own account pool, and four ways to connect: - token-file import (paste/upload the agy oauth token JSON) - auto-detect a local CLI login (~/.gemini/antigravity-cli/antigravity-oauth-token) - browser OAuth (via the shared OAuthModal Google loopback flow) - bulk / ZIP import New routes: POST /api/providers/agy-auth/{import,import-bulk,zip-extract,apply-local}. Catalog pinned from the live :fetchAvailableModels endpoint. Docs (openapi.yaml, ENVIRONMENT.md, .env.example, CHANGELOG) updated; new unit tests for registration, the token parser, and route auth-hardening. * fix(security): redact public Firebase Web key from windsurf spec (#2896) Redact the literal public Firebase Web API key (secret-scanning #7) to a placeholder. Firebase Web API keys are non-sensitive by design but the literal trips GitHub secret scanning. Mirrors the redaction landed on release/v3.8.6 (PR #2894). Embedded default still flows through resolvePublicCred (rule #11). * Pr 2871 (#2897) * fix(security): mitigate Socket.dev supply-chain findings + secrets opt-in + minimal build profile (#2863) Two real security gaps closed and four cosmetic Socket.dev fingerprints removed. See docs/security/SOCKET_DEV_FINDINGS.md for the per-finding maintainer attestation. Real bugs fixed: - cloudSync: HMAC verification of `X-Cloud-Sig` + opt-in `OMNIROUTE_CLOUD_SYNC_SECRETS=true` before overwriting `accessToken` / `refreshToken` / `providerSpecificData` from a remote response. Closes the silent-credential-swap surface (a misconfigured or hostile CLOUD_URL could previously replace local tokens unverified). - Zed import: split into 2-step `/discover` + `/import` flow. `/import` now requires `confirmedAccounts: [{ service, account, fingerprint }]` and re-reads the keychain server-side to filter by fingerprint, so a tampered discover response cannot trick the endpoint into saving an unrelated token. Cosmetic Socket.dev mitigations: - runElevatedPowerShell writes the elevated payload to a per-call temp `.ps1` file (mode 0o600) and references it via `-File`. Removes the textbook `-EncodedCommand <base64utf16le>` pattern flagged as malware by Socket's AI classifier. - Maintainer attestation `SECURITY-AUDITOR-NOTE:` blocks added at every flagged call site pointing to `docs/security/SOCKET_DEV_FINDINGS.md`. Build-time hardening: - `OMNIROUTE_BUILD_PROFILE=minimal` (`npm run build:secure`) physically removes the four sensitive modules from the standalone bundle via webpack `NormalModuleReplacementPlugin`. Stubs throw `FeatureDisabledError` at runtime. Intended for the `omniroute-secure` artifact. Tests: - 24 new unit tests in `tests/unit/security/` covering the wrapper builder, HMAC verification (4 cases), credential fingerprint determinism (5 cases), confirmedAccounts validation + fingerprint filtering (6 cases), and the minimal-build stubs (5 cases). Docs: - New `docs/security/SOCKET_DEV_FINDINGS.md` — per-finding attestation. - New `socket.yml` — Socket.dev v2 config pointing at the attestation. - Updated `SECURITY.md` — supply-chain scanner section. - Updated `.env.example` — three new env vars documented. Backwards compatibility: - Cloud sync token overwrite is OFF by default. Users who relied on it must set `OMNIROUTE_CLOUD_SYNC_SECRETS=true`. Breaking change documented in CHANGELOG. - Zed import 2-step is the new default; legacy 1-step preserved behind `OMNIROUTE_ZED_IMPORT_LEGACY_ONE_STEP=true` and will be removed in v3.9. Closes #2863 * feat: implement automated skill workflows and update system configuration and validation schemas * test: eliminate dynamic cast warnings in cloud-sync unit test * test: isolate services-branch-hardening database directory to avoid concurrency issues * chore(docs): refresh generated docs collection index Update the generated Fumadocs browser collection mapping to keep documentation imports in sync with the current docs structure. * docs: update generated browser docs collection manifest Refresh the generated Fumadocs browser collection mapping so the docs site can resolve the current documentation files correctly. --------- Co-authored-by: OpenClaw <openclaw@kuzhomesrv.local> Co-authored-by: Dmitry Kuznetsov <139351986+dmitry@users.noreply.local> Co-authored-by: KuzyaBot <kuzya@local> Co-authored-by: JeferssonLemes <jeferssondev@gmail.com> Co-authored-by: Paijo <14921983+oyi77@users.noreply.github.com> Co-authored-by: Markus Hartung <mail@hartmark.se> Co-authored-by: akarray <akarray@users.noreply.github.com> Co-authored-by: Apostol Apostolov <theapoapostolov@gmail.com> Co-authored-by: Hernan Javier Ardila Sanchez <hjasgr@gmail.com> Co-authored-by: Dmitry Kuznetsov <dmitry@kuznetsov.me> Co-authored-by: Nikolay Alafuzov <alafuzov_nn@rusklimat.ru> Co-authored-by: oyi77 <oyi77@users.noreply.github.com> Co-authored-by: Ronaldo Davi <alltomatos@users.noreply.github.com> Co-authored-by: levonk <277861+levonk@users.noreply.github.com> Co-authored-by: Lenine Júnior <lenine@engrene.com.br> Co-authored-by: Annas Alghoffar <aag.annas@gmail.com> Co-authored-by: Tushar Agarwal <76201310+Tushar49@users.noreply.github.com> Co-authored-by: GreatLiu <eurasiaxz@qq.com> Co-authored-by: yuna amelia <230527278+yunaamelia@users.noreply.github.com> Co-authored-by: Randi <55005611+rdself@users.noreply.github.com> Co-authored-by: Container <78986709+disonjer@users.noreply.github.com> Co-authored-by: nickwizard <35692452+nickwizard@users.noreply.github.com> Co-authored-by: Rajvardhan Patil <rajvardhanpatil7890@gmail.com> Co-authored-by: Raxxoor <manker_lol@hotmail.com> Co-authored-by: Muhammad Mugni Hadi <mugnimaestra3@gmail.com> Co-authored-by: mi <123757457+soyelmismo@users.noreply.github.com> Co-authored-by: Automation <automation@omniroute>
414 lines
39 KiB
Markdown
414 lines
39 KiB
Markdown
# CLAUDE.md (Русский)
|
||
|
||
🌐 **Languages:** 🇺🇸 [English](../../../CLAUDE.md) · 🇸🇦 [ar](../ar/CLAUDE.md) · 🇦🇿 [az](../az/CLAUDE.md) · 🇧🇬 [bg](../bg/CLAUDE.md) · 🇧🇩 [bn](../bn/CLAUDE.md) · 🇨🇿 [cs](../cs/CLAUDE.md) · 🇩🇰 [da](../da/CLAUDE.md) · 🇩🇪 [de](../de/CLAUDE.md) · 🇪🇸 [es](../es/CLAUDE.md) · 🇮🇷 [fa](../fa/CLAUDE.md) · 🇫🇮 [fi](../fi/CLAUDE.md) · 🇫🇷 [fr](../fr/CLAUDE.md) · 🇮🇳 [gu](../gu/CLAUDE.md) · 🇮🇱 [he](../he/CLAUDE.md) · 🇮🇳 [hi](../hi/CLAUDE.md) · 🇭🇺 [hu](../hu/CLAUDE.md) · 🇮🇩 [id](../id/CLAUDE.md) · 🇮🇩 [in](../in/CLAUDE.md) · 🇮🇹 [it](../it/CLAUDE.md) · 🇯🇵 [ja](../ja/CLAUDE.md) · 🇰🇷 [ko](../ko/CLAUDE.md) · 🇮🇳 [mr](../mr/CLAUDE.md) · 🇲🇾 [ms](../ms/CLAUDE.md) · 🇳🇱 [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) · 🇸🇰 [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)
|
||
|
||
---
|
||
|
||
Этот файл предоставляет руководство для Claude Code (claude.ai/code) при работе с кодом в этом репозитории.
|
||
|
||
## Быстрый старт
|
||
|
||
```bash
|
||
npm install # Установка зависимостей (автоматически генерирует .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 # Строгая проверка (без неявного any)
|
||
npm run test:coverage # Модульные тесты + контроль покрытия (75/75/75/70 — операторы/строки/функции/ветви)
|
||
npm run check # линт + тесты в одном
|
||
npm run check:cycles # Обнаружение циклических зависимостей
|
||
```
|
||
|
||
### Запуск тестов
|
||
|
||
```bash
|
||
# Один файл теста (родной тестовый запускатель 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 маршруты | `src/app/api/v1/` | Next.js App Router — точки входа |
|
||
| Обработчики | `open-sse/handlers/` | Обработка запросов (чат, встраивания и т.д.) |
|
||
| Исполнители | `open-sse/executors/` | HTTP-диспетчер, специфичный для поставщика |
|
||
| Переводчики | `open-sse/translator/` | Конверсия форматов (OpenAI↔Claude↔Gemini) |
|
||
| Трансформер | `open-sse/transformer/` | API ответов ↔ Завершения чата |
|
||
| Сервисы | `open-sse/services/` | Комбинированная маршрутизация, ограничения по скорости, кэширование и т.д. |
|
||
| База данных | `src/lib/db/` | Модули домена SQLite (более 45 файлов, 55 миграций) |
|
||
| Домен/Политика | `src/domain/` | Движок политик, правила затрат, логика резервирования |
|
||
| MCP сервер | `open-sse/mcp-server/` | 37 инструментов (30 базовых + 3 памяти + 4 навыка), 3 транспорта, ~13 областей |
|
||
| A2A сервер | `src/lib/a2a/` | Протокол агента JSON-RPC 2.0 |
|
||
| Навыки | `src/lib/skills/` | Расширяемая структура навыков |
|
||
| Память | `src/lib/memory/` | Постоянная разговорная память |
|
||
|
||
Монорепозиторий: `src/` (приложение Next.js 16), `open-sse/` (рабочее пространство стримингового движка), `electron/` (десктопное приложение), `tests/`, `bin/` (точка входа CLI).
|
||
|
||
---
|
||
|
||
## Запросный Пайплайн
|
||
|
||
```
|
||
Клиент → /v1/chat/completions (маршрут Next.js)
|
||
→ CORS → валидация Zod → аутентификация? → проверка политики → защита от инъекций в запрос
|
||
→ handleChatCore() [open-sse/handlers/chatCore.ts]
|
||
→ проверка кэша → ограничение по частоте → комбинированная маршрутизация?
|
||
→ resolveComboTargets() → handleSingleModel() для каждой цели
|
||
→ translateRequest() → getExecutor() → executor.execute()
|
||
→ fetch() вверх по потоку → повторная попытка с задержкой
|
||
→ перевод ответа → SSE поток или JSON
|
||
→ Если Responses API: responsesTransformer.ts TransformStream
|
||
```
|
||
|
||
API маршруты следуют последовательному шаблону: `Маршрут → предварительная проверка CORS → валидация тела Zod → необязательная аутентификация (extractApiKey/isValidApiKey) → соблюдение политики API ключа → делегирование обработчикам (open-sse)`. Нет глобального промежуточного ПО Next.js — перехват специфичен для маршрута.
|
||
|
||
**Комбинированная маршрутизация** (`open-sse/services/combo.ts`): 14 стратегий (приоритет, взвешенный, заполнение в первую очередь, круговая, P2C, случайный, наименее используемый, оптимизированный по стоимости, учитывающий сброс, строгий случайный, авто, lkgp, оптимизированный по контексту, контекстный реле). Каждая цель вызывает `handleSingleModel()`, который оборачивает `handleChatCore()` с обработкой ошибок для каждой цели и проверками автоматического отключения. См. `docs/routing/AUTO-COMBO.md` для 9-факторного оценивания Auto-Combo и `docs/architecture/RESILIENCE_GUIDE.md` для 3 слоев устойчивости.
|
||
|
||
---
|
||
|
||
## Состояние времени выполнения устойчивости
|
||
|
||
OmniRoute имеет три связанных, но различных механизма временных сбоев. Держите их
|
||
область применения отдельно при отладке поведения маршрутизации. См.
|
||
[диаграмму устойчивости в 3 слоя](./docs/diagrams/exported/resilience-3layers.svg)
|
||
(источник: [docs/diagrams/resilience-3layers.mmd](./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`.
|
||
|
||
Только статусы сбоев на уровне поставщика должны срабатывать на прерывание цепи поставщика:
|
||
|
||
```ts
|
||
(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`
|
||
|
||
Важные поля на соединениях поставщика:
|
||
|
||
```ts
|
||
rateLimitedUntil;
|
||
testStatus: "unavailable";
|
||
lastError;
|
||
lastErrorType;
|
||
errorCode;
|
||
backoffLevel;
|
||
```
|
||
|
||
Во время выбора аккаунта соединение пропускается, пока:
|
||
|
||
```ts
|
||
new Date(rateLimitedUntil).getTime() > Date.now();
|
||
```
|
||
|
||
Охлаждения также ленивые: когда `rateLimitedUntil` в прошлом, соединение снова становится
|
||
доступным. При успешном использовании `clearAccountError()` очищает `testStatus`,
|
||
`rateLimitedUntil`, поля ошибок и `backoffLevel`.
|
||
|
||
Поведение охлаждения соединения по умолчанию:
|
||
|
||
- Базовое охлаждение OAuth: `5s`.
|
||
- Базовое охлаждение API-ключа: `3s`.
|
||
- API-ключ `429` должен предпочитать подсказки повторной попытки вверх по потоку (`Retry-After`, заголовки сброса или
|
||
парсируемый текст сброса), когда это возможно.
|
||
- Повторяющиеся восстанавливаемые сбои используют экспоненциальное увеличение задержки:
|
||
|
||
```ts
|
||
baseCooldownMs * 2 ** failureIndex;
|
||
```
|
||
|
||
Защита от эффекта "громадного стада" предотвращает одновременные сбои на одном соединении от
|
||
повторного продления охлаждения или двойного увеличения `backoffLevel`.
|
||
|
||
Терминальные состояния не являются охлаждениями. `banned`, `expired`, и `credits_exhausted` должны оставаться недоступными до тех пор, пока учетные данные/настройки не изменятся или оператор не сбросит их. Не перезаписывайте терминальные состояния временным состоянием охлаждения.
|
||
|
||
### Блокировка модели
|
||
|
||
**Область применения**: поставщик + соединение + модель.
|
||
|
||
**Цель**: избежать отключения целого соединения, когда только одна модель недоступна или
|
||
ограничена по квоте для этого соединения.
|
||
|
||
Примеры:
|
||
|
||
- Поставщики с квотой на модель, возвращающие `429`.
|
||
- Локальные поставщики, возвращающие `404` для одной отсутствующей модели.
|
||
- Ошибки разрешения режима/модели, специфичные для поставщика, такие как выбранные режимы Grok.
|
||
|
||
Блокировка модели находится в `open-sse/services/accountFallback.ts` и позволяет тому же
|
||
соединению продолжать обслуживать другие модели.
|
||
|
||
### Рекомендации по отладке
|
||
|
||
- Если все ключи для поставщика пропущены, проверьте как состояние прерывания поставщика, так и `rateLimitedUntil`/`testStatus` каждого
|
||
соединения.
|
||
- Если поставщик кажется постоянно исключенным после окна сброса, проверьте, читает ли код
|
||
необработанное `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` (только слой повторного экспорта)
|
||
- **Никогда** не используйте barrel-import из `localDb.ts` — вместо этого импортируйте конкретные модули `db/`
|
||
- Синглтон БД: `getDbInstance()` из `src/lib/db/core.ts` (журналирование WAL)
|
||
- Миграции: `src/lib/db/migrations/` — версионированные SQL файлы, идемпотентные, выполняются в транзакциях
|
||
|
||
### Обработка Ошибок
|
||
|
||
- try/catch с конкретными типами ошибок, логирование с контекстом pino
|
||
- Никогда не игнорируйте ошибки в потоках SSE — используйте сигналы прерывания для очистки
|
||
- Возвращайте правильные коды состояния HTTP (4xx/5xx)
|
||
|
||
### Безопасность
|
||
|
||
- **Никогда** не используйте `eval()`, `new Function()`, или подразумеваемый eval
|
||
- Проверяйте все входные данные с помощью схем Zod
|
||
- Шифруйте учетные данные в состоянии покоя (AES-256-GCM)
|
||
- Список заголовков для отказа: `src/shared/constants/upstreamHeaders.ts` — поддерживайте согласованность между очисткой, схемами Zod и юнит-тестами при редактировании
|
||
- **Публичные учетные данные для upstream** (OAuth client_id/secret в стиле Gemini/Antigravity/Windsurf + ключи Firebase Web, извлеченные из публичных CLI): **ДОЛЖНЫ** быть встроены через `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](https://github.com/tldrsec/awesome-secure-defaults)): предпочитайте Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink перед пользовательскими реализациями при добавлении новых поверхностей, чувствительных к безопасности.
|
||
|
||
---
|
||
|
||
## Общие Сценарии Модификации
|
||
|
||
### Добавление Нового Провайдера
|
||
|
||
1. Зарегистрируйте в `src/shared/constants/providers.ts` (проверка Zod при загрузке)
|
||
2. Добавьте executor в `open-sse/executors/`, если нужна пользовательская логика (расширьте `BaseExecutor`)
|
||
3. Добавьте переводчик в `open-sse/translator/`, если формат не OpenAI
|
||
4. Добавьте конфигурацию OAuth в `src/lib/oauth/constants/oauth.ts`, если на основе OAuth — если upstream CLI поставляет публичный client_id/secret, встроите через `resolvePublicCred()` (см. `docs/security/PUBLIC_CREDS.md`), **никогда** как литерал
|
||
5. Зарегистрируйте модели в `open-sse/config/providerRegistry.ts`
|
||
6. Напишите тесты в `tests/unit/` (включите проверку формы publicCreds, если вы добавили новый встроенный по умолчанию)
|
||
|
||
### Добавление Нового API Маршрута
|
||
|
||
1. Создайте директорию в `src/app/api/v1/your-route/`
|
||
2. Создайте `route.ts` с обработчиками `GET`/`POST`
|
||
3. Следуйте шаблону: CORS → проверка тела Zod → необязательная аутентификация → делегирование обработчика
|
||
4. Обработчик помещается в `open-sse/handlers/` (импортируйте оттуда, а не инлайн)
|
||
5. Ответы на ошибки используют `buildErrorBody()` / `errorResponse()` из `open-sse/utils/error.ts` (автоматически очищены — никогда не помещайте `err.stack` или `err.message` сырыми в тело). См. `docs/security/ERROR_SANITIZATION.md`.
|
||
6. Добавьте тесты — включая как минимум одно утверждение, что ответы на ошибки не раскрывают трассировки стека (`!body.error.message.includes("at /")`)
|
||
|
||
### Добавление Нового Модуля БД
|
||
|
||
1. Создайте `src/lib/db/yourModule.ts` — импортируйте `getDbInstance` из `./core.ts`
|
||
2. Экспортируйте функции CRUD для вашей таблицы(ц)
|
||
3. Добавьте миграцию в `src/lib/db/migrations/`, если нужны новые таблицы
|
||
4. Повторно экспортируйте из `src/lib/localDb.ts` (добавьте только в список повторного экспорта)
|
||
5. Напишите тесты
|
||
|
||
### Добавление Нового Инструмента MCP
|
||
|
||
1. Добавьте определение инструмента в `open-sse/mcp-server/tools/` с схемой ввода Zod + асинхронным обработчиком
|
||
2. Зарегистрируйте в наборе инструментов (подключено через `createMcpServer()`)
|
||
3. Назначьте соответствующим областям
|
||
4. Напишите тесты (вызов инструмента записывается в таблицу `mcp_audit`)
|
||
|
||
### Добавление Нового A2A Навыка
|
||
|
||
1. Создайте навык в `src/lib/a2a/skills/` (уже существует 5: smart-routing, quota-management, provider-discovery, cost-analysis, health-report)
|
||
2. Навык получает контекст задачи (сообщения, метаданные) → возвращает структурированный результат
|
||
3. Зарегистрируйте в `A2A_SKILL_HANDLERS` в `src/lib/a2a/taskExecution.ts`
|
||
4. Экспонируйте в `src/app/.well-known/agent.json/route.ts` (Agent Card)
|
||
5. Напишите тесты в `tests/unit/`
|
||
6. Документируйте в `docs/frameworks/A2A-SERVER.md` таблицу навыков
|
||
|
||
### Добавление Нового Облачного Агента
|
||
|
||
1. Создайте класс агента в `src/lib/cloudAgent/agents/`, расширяющий `CloudAgentBase` (уже существует 3: codex-cloud, devin, jules)
|
||
2. Реализуйте `createTask`, `getStatus`, `approvePlan`, `sendMessage`, `listSources`
|
||
3. Зарегистрируйте в `src/lib/cloudAgent/registry.ts`
|
||
4. Добавьте обработку OAuth/учетных данных, если необходимо (`src/lib/oauth/providers/`)
|
||
5. Тесты + документируйте в `docs/frameworks/CLOUD_AGENT.md`
|
||
|
||
### Добавление Нового Ограничителя / Eval / Навыка / События Webhook
|
||
|
||
- Ограничитель: `src/lib/guardrails/` → документация: `docs/security/GUARDRAILS.md`
|
||
- Eval suite: `src/lib/evals/` → документация: `docs/frameworks/EVALS.md`
|
||
- Навык (песочница): `src/lib/skills/` → документация: `docs/frameworks/SKILLS.md`
|
||
- Событие Webhook: `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 и др.) | `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 / 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.
|
||
|
||
**Предпочтение уровня тестирования**: сначала модульные → интеграционные (мульти-модульные или состояние БД) → e2e (только UI/рабочий процесс). Кодируйте воспроизведения ошибок как автоматизированные тесты до или вместе с исправлением.
|
||
|
||
**Политика покрытия Copilot**: Когда PR изменяет производственный код и покрытие ниже 75% (операторы/строки/функции) или 70% (ветви), не просто сообщайте — добавьте или обновите тесты, повторно запустите порог покрытия, затем запросите подтверждение. Включите выполненные команды, измененные тестовые файлы и окончательный результат покрытия в отчет PR.
|
||
|
||
---
|
||
|
||
## Git Workflow
|
||
|
||
```bash
|
||
# Никогда не коммитьте напрямую в 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**:
|
||
|
||
- **pre-commit**: lint-staged + `check-docs-sync` + `check:any-budget:t11`
|
||
- **pre-push**: `npm run test:unit`
|
||
|
||
---
|
||
|
||
## Среда
|
||
|
||
- **Время выполнения**: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25, ES Модули
|
||
- **TypeScript**: 5.9+, целевой ES2022, модуль esnext, разрешение bundler
|
||
- **Псевдонимы путей**: `@/*` → `src/`, `@omniroute/open-sse` → `open-sse/`, `@omniroute/open-sse/*` → `open-sse/*`
|
||
- **Порт по умолчанию**: 20128 (API + панель управления на одном порту)
|
||
- **Директория данных**: переменная окружения `DATA_DIR`, по умолчанию `~/.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`)
|
||
|
||
---
|
||
|
||
## Жесткие правила
|
||
|
||
1. Никогда не коммитьте секреты или учетные данные
|
||
2. Никогда не добавляйте логику в `localDb.ts`
|
||
3. Никогда не используйте `eval()` / `new Function()` / подразумеваемый eval
|
||
4. Никогда не коммитьте напрямую в `main`
|
||
5. Никогда не пишите сырой SQL в маршрутах — используйте модули `src/lib/db/`
|
||
6. Никогда не игнорируйте ошибки в потоках SSE
|
||
7. Всегда проверяйте входные данные с помощью схем Zod
|
||
8. Всегда включайте тесты при изменении производственного кода
|
||
9. Покрытие должно оставаться ≥75% (операторы, строки, функции) / ≥70% (ветви). Текущая измеренная: ~82%.
|
||
10. Никогда не обходите хуки Husky (`--no-verify`, `--no-gpg-sign`) без явного одобрения оператора.
|
||
11. Никогда не встраивайте публичные upstream OAuth client_id/secret или ключи Firebase Web в виде строковых литералов — всегда используйте `resolvePublicCred()` (`open-sse/utils/publicCreds.ts`). См. `docs/security/PUBLIC_CREDS.md`.
|
||
12. Никогда не возвращайте сырой `err.stack` / `err.message` в HTTP / SSE / ответах исполнителя — всегда обрабатывайте через `buildErrorBody()` или `sanitizeErrorMessage()` (`open-sse/utils/error.ts`). См. `docs/security/ERROR_SANITIZATION.md`.
|
||
13. Никогда не интерполируйте внешние пути или значения времени выполнения в shell-скрипты, передаваемые в `exec()`/`spawn()` — передавайте через опцию `env`. Ссылка: `src/mitm/cert/install.ts::updateNssDatabases`.
|
||
14. Никогда не игнорируйте предупреждение CodeQL / Secret-Scanning без (a) предварительной проверки документации по шаблонам выше, чтобы увидеть, применим ли помощник, и (b) записи технического обоснования в комментарии об отклонении. Прецедент: `js/stack-trace-exposure`, поднятый на вызовах, которые уже обрабатываются через `sanitizeErrorMessage()`, является известным ограничением CodeQL (пользовательские санитайзеры не распознаются) — отклоняйте как `false positive`, ссылаясь на `docs/security/ERROR_SANITIZATION.md`.
|
||
15. Никогда не открывайте маршруты, которые запускают дочерние процессы (`/api/mcp/`, `/api/cli-tools/runtime/`), без классификации `isLocalOnlyPath()` в `src/server/authz/routeGuard.ts`. Принуждение к петле происходит без условий перед любой проверкой аутентификации — утечка JWT через туннель не может вызвать запуск процесса. См. `docs/security/ROUTE_GUARD_TIERS.md`.
|
||
16. Никогда не включайте трейлеры `Co-Authored-By`, которые приписывают авторство AI-ассистенту, LLM или автоматизированному аккаунту (например, имена, содержащие "Claude", "GPT", "Copilot", "Bot"; письма на `anthropic.com` / `openai.com` / адресах `noreply.github.com`, принадлежащих ботам). Такие трейлеры направляют атрибуцию коммитов к аккаунту бота на GitHub, скрывая реального автора (`diegosouzapw`) в истории PR. Человеческие соавторы — включая авторов upstream PR и репортёров issues, портируемых в OmniRoute — МОГУТ и ДОЛЖНЫ быть отмечены стандартными трейлерами `Co-authored-by: Name <email>`; рабочие процессы upstream-port (`/port-upstream-features`, `/port-upstream-issues`) зависят от этого.
|