mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-03 22:02:08 +03:00
* fix(gemini): preserve structured tool calls for antigravity * fix(gemini): parse prefixed textual tool calls * fix(antigravity): preserve textual SSE tool calls * fix(stream): normalize textual passthrough tool calls * fix(stream): normalize split textual tool calls * fix(stream): suppress malformed textual tool calls * fix(stream): suppress compact malformed tool calls * fix(stream): emit structured textual tool calls * fix(stream): suppress unknown textual tool calls * fix(stream): normalize responses textual tool calls * chore: ignore .claude/settings.local.json (per-user Claude Code permissions) * fix(opencode-go): route qwen3.x via claude messages + repair fixMissingToolResponses for Claude-shape upstreams (#2791) Integrated into release/v3.8.6 * fix: resolve npm install warnings — remove dead deps, relax engine constraint (#2792) Integrated into release/v3.8.6 * fix: register missing web-cookie validators (claude-web, gemini-web, copilot-web, t3-web) (#2793) Integrated into release/v3.8.6 * fix: Error: Unable to inspect existing database #2771 (#2795) Integrated into release/v3.8.6 * fix(oauth): repair Google loopback callback flow (#2796) Integrated into release/v3.8.6 * feat(logs): add clean history button (#2799) Integrated into release/v3.8.6 * [codex] home: restore settings-driven home layout and quota auto-refresh (#2800) Integrated into release/v3.8.6 * fix(gemini): emit signaturelessToolCallMode:text for GEMINI format models (#2801) Integrated into release/v3.8.6 * feat(modelSpecs): align opencode-go family with upstream provider limits (#2802) Integrated into release/v3.8.6 * chore: apply unit test fixes, polyfills, and environment precedence fixes * docs(agents): atualiza fluxos de release e triagem Expande os workflows de release para incluir auditoria de segurança, CHANGELOG completo por commits, quality gate obrigatório, homologação em VPS local, publicação oficial, deploy em Akamai e validação de artefatos. Reorganiza a triagem de features com arquivos permanentes por bucket, suporte a itens em andamento, regra de reclaim após 15 dias e novo tratamento para ideias viáveis catalogadas. Corrige a orientação de revisão de discussões para usar a ordem cronológica real dos comentários e respostas ao identificar a última atividade. * fix(lockout): classify Gemini Antigravity resource exhaustion as quota_exhausted * fix(reasoning): gate replay by interleaved field * docs(rule-16): permit human Co-authored-by, restrict only AI/bot trailers Rule #16 previously banned all `Co-Authored-By` trailers absolutely. That blocked the upstream-port workflows (`/port-upstream-features` and `/port-upstream-issues`), which must credit human upstream PR authors and issue reporters in OmniRoute commits. Refine the rule to ban only AI/bot-attributed trailers (Claude, GPT, Copilot, Bot; anthropic.com / openai.com / bot-owned noreply.github.com emails) while allowing standard human `Co-authored-by: Name <email>` attribution. Sync the rule across the source CLAUDE.md, the E2E shakedown doc note, and 41 i18n translations. * fix(gitlawb): add specialty validators for connection test — bypass /models probe GitLawB OpenGateway API (xiaomi-mimo compatible) does not expose a /models endpoint, causing validateOpenAILikeProvider to 404 on the initial probe and report 'Provider validation endpoint not supported'. Add specialty validators for both gitlawb and gitlawb-gmi that follow the same pattern as the existing xiaomi-mimo validator: skip GET /models, validate directly via POST /chat/completions with a minimal test message. Any 401/403 response means an invalid key; all other responses mean auth is OK. Fixes test-connection returning 404 for GitLawB providers. * test(gitlawb): add 12 unit tests for gitlawb and gitlawb-gmi specialty validators Covers success, auth failure (401/403), non-auth acceptance (400/422/429), network errors, and custom baseUrl overrides for both providers. * feat(gitlawb): serve models from static registry without API-unavailable warning GitLawB's OpenGateway API does not expose a /models endpoint per provider-path. Previously the models route fell through to the generic fallback which returned static catalog models with the misleading 'API unavailable — using local catalog' warning. Now gitlawb and gitlawb-gmi are handled as static model providers (same pattern as reka and qwen OAuth) — models are served from the provider registry without any warning, since all registered models are functional via POST /chat/completions. * refactor(gitlawb): extract shared opengateway validator factory, fix docs path in test - Extract gitlawb/gitlawb-gmi validators into buildOpengatewayValidator factory - Fix dockerignore-docs-coverage test: update stale docs/AUTO-COMBO.md -> docs/routing/AUTO-COMBO.md * fix(reasoning): guard interleaved capability lookup * feat(gitlawb): dynamic model fetch with gmi-cloud fallback Hybrid approach: - gitlawb (xiaomi-mimo): dynamic /models endpoint → 356 models - gitlawb-gmi (gmi-cloud): 404 fallback → local catalog gracefully Mimics Gitlawb/openclaude's model-routing pattern * i18n(pt-BR): complete missing translations and sync with en.json * feat(build): nix multi-OS package manager install (#2806) Integrated into release/v3.8.6 * fix(i18n): translate 144 new __MISSING__ pt-BR strings (#2816) Integrated into release/v3.8.6 * chore(docs): set coverage gate to 40/40/40/40 in CLAUDE.md Aligns the documented coverage gate with the v3.8.6 release decision (lowered from 75/75/75/70). Matches the threshold already set in package.json by the large feature PRs (planos 11-22). * fix(cli): respect PORT env var in serve command (#2845) Integrated into release/v3.8.6. * fix(deepseek-web): return 400 when client sends tools[] - chat.deepseek.com has no tool support (#2854) Integrated into release/v3.8.6. * fix(qoder): reject invalid/expired PATs returning Cosy 500 error (#2860) Integrated into release/v3.8.6. * fix(cli): register openclaw in tool-detector (#2833) (#2850) Integrated into release/v3.8.6. * fix(api): include noAuth providers in /v1/models catalog (#2798) (#2814) Integrated into release/v3.8.6. * fix(combo): resolve custom provider targets via combo name (#2778) (#2812) Integrated into release/v3.8.6. * fix(translator): strip safety_identifier in openai-responses cleanup (#2770) (#2809) Integrated into release/v3.8.6. * fix(quota): honor explicit per-connection preflight opt-out (#2831) (#2844) Integrated into release/v3.8.6. * fix(usage): un-invert GitHub Copilot Free/limited quota — limited_user_quotas is remaining (#2876) (#2881) Integrated into release/v3.8.6. * fix(nous-research): correct baseUrl to include /chat/completions (#2826) (#2835) Integrated into release/v3.8.6. * fix(opencode): qwen3.x max/plus models lack vision support (#2822) (#2836) Integrated into release/v3.8.6. * fix(translator): pass-through tool_search built-in tool type (#2766) (#2811) Integrated into release/v3.8.6. * fix(github): route claude-opus-4.6 via chat completions (#2821) Integrated into release/v3.8.6. * docs(oauth): add Windsurf login fix design (Phase 1 hotfix + Phase 2 Firebase OAuth) Two-phase plan to fix the broken Windsurf OAuth flow: - Phase 1: drop the dead app.devin.ai/editor/signin PKCE path, promote import-token from windsurf.com/show-auth-token as the primary path - Phase 2: port Firebase OAuth + RegisterUser flow from fendoushaonian/WindSurf-gRPC-API for full browser-based automation Spec only - no code changes yet. * docs(plan): Phase 1 windsurf login hotfix implementation plan 10 tasks covering: - TDD assertions for flowType + 410 Gone responses - Provider switch to import_token - Route handler retiring authorize/start-callback-server/poll-callback - OAuthModal UI override - i18n sync - Verification + PR steps * fix(cli): replace cli-table3 with hand-rolled formatter (#2752) (#2813) Integrated into release/v3.8.6. * fix(skills): skip interception for unregistered client-native tools (#2815) (#2817) Integrated into release/v3.8.6. * feat(sse): add RTK filters for kubectl, docker-build, composer, gh (#2824) Integrated into release/v3.8.6. * fix(geminiHelper): support rec.image content shape + warn on dropped remote URLs (refs #2807) (#2855) Integrated into release/v3.8.6. * fix(cli): allow nullable/optional apiKey in cliMitmStartSchema (#2857) Integrated into release/v3.8.6. * fix(combo): preserve system messages during context handoff summary generation (#2865) Integrated into release/v3.8.6. * fix: wire CLIProxyAPI fallback settings into chatCore routing engine (#2866) Integrated into release/v3.8.6. * fix(usage): add opencode quota fetcher (#2852) (#2867) Integrated into release/v3.8.6. * feat(claude): default xhigh support for newer Opus models (#2874) Integrated into release/v3.8.6. * fix(cli): restore omniroute logs command stream (#2756) (#2810) Integrated into release/v3.8.6. * fix(combo): normalize upstream Headers for Node 24 undici interop (#2751) (#2823) Integrated into release/v3.8.6. * Rename proxy log Public IP to Client IP (#2880) Integrated into release/v3.8.6. * fix(claude): preserve max effort for supported models (#2875) Integrated into release/v3.8.6. * fix(oauth): switch windsurf provider to import_token flow The PKCE auth URL targeting app.devin.ai/editor/signin returns 404 post-rebrand. Until Phase 2 ports Firebase OAuth + RegisterUser, the only supported path is import-token via windsurf.com/show-auth-token. - windsurf.ts: drop buildAuthUrl, set flowType=import_token - generateAuthData returns supported:false + helpful error for windsurf/devin-cli - tests: assert flowType + disabled stub * fix(oauth): return 410 Gone for retired windsurf/devin-cli PKCE actions start-callback-server, authorize, and poll-callback (GET + POST) now return 410 Gone with a pointer to /import-token. The 410 short-circuit runs before auth so the response is honest about the action being permanently gone, not gated. Codex PKCE flow unchanged. Tests: 5 new assertions cover GET + POST 410 paths and a Codex regression check. * refactor(oauth): annotate retired PKCE fields in WINDSURF_CONFIG No behaviour change - comment-only update documenting that authorizeUrl, codeChallengeMethod, callbackPort, callbackPath, apiServerUrl, and exchangePath are no longer consumed. Active fields (inferenceUrl, showAuthTokenUrl, firebaseApiKey, ideName) called out separately. * fix(cli,docs): use requireCliToolsAuth in logs route + document OPENCODE quota env Post-merge contract fixes for v3.8.6: - src/app/api/cli-tools/logs/route.ts (#2810) now uses the shared requireCliToolsAuth guard (param renamed req->request) to satisfy the cli-tools-auth-hardening contract test. - Document OMNIROUTE_OPENCODE_QUOTA_URL (#2867) in docs/reference/ENVIRONMENT.md to satisfy the env/docs sync contract. * fix(dashboard): force import-token panel for windsurf/devin-cli Phase 1 hotfix: hide the 'Browser Login' tab and start in Paste API Key mode. Removes windsurf/devin-cli from PKCE_CALLBACK_SERVER_PROVIDERS so no callback server is started for them. Codex still uses the PKCE flow. The 'Get token' link continues to point at windsurf.com/show-auth-token via the existing supportsTokenPaste form copy. * fix(oauth): windsurf import-token mapTokens signature mismatch The route at `src/app/api/oauth/[provider]/[action]/route.ts` invokes `providerData.mapTokens({ accessToken: token })` (object), matching the cursor/kiro signature. The windsurf provider was declared with `mapTokens(token: string)` instead, so the entire object was stored as `accessToken`. When the connection record reached the SQLite layer it crashed with: SQLite3 can only bind numbers, strings, bigints, buffers, and null Fix by aligning windsurf's `mapTokens` signature with the route caller and the cursor/kiro convention. Also dedupe a copy-pasted second `if (action === "import-token")` block in the route handler — the second block was unreachable but identical to the first. Adds two regression tests asserting that `provider.mapTokens({ accessToken })` returns a string `accessToken` for both windsurf and devin-cli, so a future signature drift trips the gate instead of the SQLite bind error in production. * feat(compression): expand pt-BR pack with troglodita rules (15 → 49) (#2818) Integrated into release/v3.8.6 * fix(sse): repair RTK engine defaults so dedup and direct calls work (#2825) Integrated into release/v3.8.6 * fix(mcp): redirect console.log/warn to stderr in --mcp stdio mode (#2840) Integrated into release/v3.8.6 * fix(gemini-cli): prefer real project IDs over default-project (#2841) Integrated into release/v3.8.6 * fix(opencode-go): add provider limits quota fetcher (#2861) Integrated into release/v3.8.6 * Audit & add web cookie providers: fix 4 missing registry entries + DuckDuckGo (#2862) Integrated into release/v3.8.6 * fix(antigravity): harden signatureless tool history (#2878) Integrated into release/v3.8.6 * fix: provider model sync pruning and dynamic antigravity MITM proxy mappings (#2886) Integrated into release/v3.8.6 * feat(usage): per-API-key token limits scoped to model/provider/global (#2888) Integrated into release/v3.8.6 * fix(audio): build multipart body manually to preserve Content-Type (#2842) Integrated into release/v3.8.6 * refactor: remove agent skill documentation files and streamline maintenance workflows * test(stabilization): resolve unit test failures in blackbox-web, schema-coercion, translator-helper-branches, usage-service-hardening, and audio-transcription * fix(security): mitigate Socket.dev supply-chain findings + secrets opt-in + minimal build profile (#2863) (#2871) Two real security gaps closed and four cosmetic Socket.dev fingerprints removed. See docs/security/SOCKET_DEV_FINDINGS.md for the per-finding maintainer attestation. Real bugs fixed: - cloudSync: HMAC verification of `X-Cloud-Sig` + opt-in `OMNIROUTE_CLOUD_SYNC_SECRETS=true` before overwriting `accessToken` / `refreshToken` / `providerSpecificData` from a remote response. Closes the silent-credential-swap surface (a misconfigured or hostile CLOUD_URL could previously replace local tokens unverified). - Zed import: split into 2-step `/discover` + `/import` flow. `/import` now requires `confirmedAccounts: [{ service, account, fingerprint }]` and re-reads the keychain server-side to filter by fingerprint, so a tampered discover response cannot trick the endpoint into saving an unrelated token. Cosmetic Socket.dev mitigations: - runElevatedPowerShell writes the elevated payload to a per-call temp `.ps1` file (mode 0o600) and references it via `-File`. Removes the textbook `-EncodedCommand <base64utf16le>` pattern flagged as malware by Socket's AI classifier. - Maintainer attestation `SECURITY-AUDITOR-NOTE:` blocks added at every flagged call site pointing to `docs/security/SOCKET_DEV_FINDINGS.md`. Build-time hardening: - `OMNIROUTE_BUILD_PROFILE=minimal` (`npm run build:secure`) physically removes the four sensitive modules from the standalone bundle via webpack `NormalModuleReplacementPlugin`. Stubs throw `FeatureDisabledError` at runtime. Intended for the `omniroute-secure` artifact. Tests: - 24 new unit tests in `tests/unit/security/` covering the wrapper builder, HMAC verification (4 cases), credential fingerprint determinism (5 cases), confirmedAccounts validation + fingerprint filtering (6 cases), and the minimal-build stubs (5 cases). Docs: - New `docs/security/SOCKET_DEV_FINDINGS.md` — per-finding attestation. - New `socket.yml` — Socket.dev v2 config pointing at the attestation. - Updated `SECURITY.md` — supply-chain scanner section. - Updated `.env.example` — three new env vars documented. Backwards compatibility: - Cloud sync token overwrite is OFF by default. Users who relied on it must set `OMNIROUTE_CLOUD_SYNC_SECRETS=true`. Breaking change documented in CHANGELOG. - Zed import 2-step is the new default; legacy 1-step preserved behind `OMNIROUTE_ZED_IMPORT_LEGACY_ONE_STEP=true` and will be removed in v3.9. Closes #2863 * fix(security): redact public Firebase Web key from windsurf spec; doc SHA-256 cache-key rationale (#2894) Two security-scanning findings on release/v3.8.6: - Secret-scanning alert 7 (google_api_key): the windsurf login-fix design spec embedded the literal public Firebase Web API key on two lines. Firebase Web API keys are non-sensitive by design (they identify the project; access is gated by Firebase Security Rules + key restrictions), but the literal trips secret scanning. Redacted to a placeholder; the embedded default still goes through resolvePublicCred per rule #11. - Code-scanning alert 261 (js/insufficient-password-hash): tokenCacheKey() uses SHA-256 to derive an in-memory cache key from the session token, not for password-at-rest storage. Added a comment documenting why CWE-916 KDFs do not apply (false positive). * fix(ci): resolve release/v3.8.6 gate failures (docs-sync, any-budget, pack-artifact) (#2895) * fix(ci): resolve release/v3.8.6 gate failures (docs-sync, any-budget, pack-artifact) Three CI gates failed on release/v3.8.6 (run 26630300877): - docs-sync: CHANGELOG had a spurious "## [3.8.6-patch]" section above "## [3.8.6]", so the latest release no longer matched package.json (3.8.6) and the 41 i18n CHANGELOG mirrors were flagged as missing that section. Fold the lone #2752 entry into [3.8.6] and drop the patch heading. - any-budget:t11: open-sse/handlers/chatCore.ts regressed to 1 explicit `any` (budget 0). Type the persist callback arg as Record<string, unknown>, which matches runWithOnPersist's RefreshPersistFn contract exactly. - pack-artifact: open-sse/utils/setupPolyfill.ts ships via package.json "files" (bin/omniroute.mjs imports it at startup) but was missing from the pack policy allowlist. Allow it and add a regression test. * fix(security): redact public Firebase Web key from windsurf spec Redact the literal public Firebase Web API key (secret-scanning #7) to a placeholder, mirroring the redaction on release/v3.8.6 (PR #2894) and the windsurf fix branch. Non-sensitive public Web key; trips secret scanning. * feat(combo): Zero-Latency Combos (Hedging, Proactive Compression, Predictive TTFT) (#2868) * feat(combo): implement zero-latency combo optimizations (hedging, proactive compression, predictive TTFT) * fix(combo): fix predictive TTFT skip logic and unhandled promise rejections --------- Co-authored-by: Automation <automation@omniroute> * feat: implement automated skill workflows and update system configuration and validation schemas * test: eliminate dynamic cast warnings in cloud-sync unit test * test: isolate services-branch-hardening database directory to avoid concurrency issues * feat(providers): add 7 new web-cookie providers + research catalog + discovery tool New providers: - huggingchat: free LLM chat via huggingface.co/chat (no subscription) - phind: free dev-focused AI chat via phind.com/api/agent - poe-web: multi-model chat via poe.com GraphQL (p-b cookie) - venice-web: privacy-focused AI chat via venice.ai (session cookie) - v0-vercel-web: Vercel v0 code gen via v0.dev (session cookie) - kimi-web: Moonshot Kimi chat via kimi.moonshot.cn (session cookie) - doubao-web: ByteDance Doubao chat via doubao.com (session cookie) Additional: - Research catalog: docs/research/UNLIMITED_LLM_ACCESS.md - Discovery tool design + stub: src/lib/discovery/ + migration 073 - Unit tests: 33 tests for all 7 providers - Shared helpers consolidated in error.ts (slop cleanup) - All registered in WEB_COOKIE_PROVIDERS + providerRegistry + webSessionCredentials Closes #2885 * fix(typecheck): resolve typecheck errors in combo spec and compression modules * feat(api,oauth): add `agy` (Antigravity CLI) standalone provider with CLI token import (#2899) Add a standalone OAuth provider `agy` (Antigravity CLI) next to gemini-cli/antigravity. It reuses the antigravity inference backend (identical Google client_id + daily-cloudcode-pa.googleapis.com endpoint, executor and token-refresh) but ships its own model catalog — including the Claude models the backend exposes (claude-opus-4-6-thinking, claude-sonnet-4-6) — its own account pool, and four ways to connect: - token-file import (paste/upload the agy oauth token JSON) - auto-detect a local CLI login (~/.gemini/antigravity-cli/antigravity-oauth-token) - browser OAuth (via the shared OAuthModal Google loopback flow) - bulk / ZIP import New routes: POST /api/providers/agy-auth/{import,import-bulk,zip-extract,apply-local}. Catalog pinned from the live :fetchAvailableModels endpoint. Docs (openapi.yaml, ENVIRONMENT.md, .env.example, CHANGELOG) updated; new unit tests for registration, the token parser, and route auth-hardening. * fix(security): redact public Firebase Web key from windsurf spec (#2896) Redact the literal public Firebase Web API key (secret-scanning #7) to a placeholder. Firebase Web API keys are non-sensitive by design but the literal trips GitHub secret scanning. Mirrors the redaction landed on release/v3.8.6 (PR #2894). Embedded default still flows through resolvePublicCred (rule #11). * Pr 2871 (#2897) * fix(security): mitigate Socket.dev supply-chain findings + secrets opt-in + minimal build profile (#2863) Two real security gaps closed and four cosmetic Socket.dev fingerprints removed. See docs/security/SOCKET_DEV_FINDINGS.md for the per-finding maintainer attestation. Real bugs fixed: - cloudSync: HMAC verification of `X-Cloud-Sig` + opt-in `OMNIROUTE_CLOUD_SYNC_SECRETS=true` before overwriting `accessToken` / `refreshToken` / `providerSpecificData` from a remote response. Closes the silent-credential-swap surface (a misconfigured or hostile CLOUD_URL could previously replace local tokens unverified). - Zed import: split into 2-step `/discover` + `/import` flow. `/import` now requires `confirmedAccounts: [{ service, account, fingerprint }]` and re-reads the keychain server-side to filter by fingerprint, so a tampered discover response cannot trick the endpoint into saving an unrelated token. Cosmetic Socket.dev mitigations: - runElevatedPowerShell writes the elevated payload to a per-call temp `.ps1` file (mode 0o600) and references it via `-File`. Removes the textbook `-EncodedCommand <base64utf16le>` pattern flagged as malware by Socket's AI classifier. - Maintainer attestation `SECURITY-AUDITOR-NOTE:` blocks added at every flagged call site pointing to `docs/security/SOCKET_DEV_FINDINGS.md`. Build-time hardening: - `OMNIROUTE_BUILD_PROFILE=minimal` (`npm run build:secure`) physically removes the four sensitive modules from the standalone bundle via webpack `NormalModuleReplacementPlugin`. Stubs throw `FeatureDisabledError` at runtime. Intended for the `omniroute-secure` artifact. Tests: - 24 new unit tests in `tests/unit/security/` covering the wrapper builder, HMAC verification (4 cases), credential fingerprint determinism (5 cases), confirmedAccounts validation + fingerprint filtering (6 cases), and the minimal-build stubs (5 cases). Docs: - New `docs/security/SOCKET_DEV_FINDINGS.md` — per-finding attestation. - New `socket.yml` — Socket.dev v2 config pointing at the attestation. - Updated `SECURITY.md` — supply-chain scanner section. - Updated `.env.example` — three new env vars documented. Backwards compatibility: - Cloud sync token overwrite is OFF by default. Users who relied on it must set `OMNIROUTE_CLOUD_SYNC_SECRETS=true`. Breaking change documented in CHANGELOG. - Zed import 2-step is the new default; legacy 1-step preserved behind `OMNIROUTE_ZED_IMPORT_LEGACY_ONE_STEP=true` and will be removed in v3.9. Closes #2863 * feat: implement automated skill workflows and update system configuration and validation schemas * test: eliminate dynamic cast warnings in cloud-sync unit test * test: isolate services-branch-hardening database directory to avoid concurrency issues * chore(docs): refresh generated docs collection index Update the generated Fumadocs browser collection mapping to keep documentation imports in sync with the current docs structure. * docs: update generated browser docs collection manifest Refresh the generated Fumadocs browser collection mapping so the docs site can resolve the current documentation files correctly. --------- Co-authored-by: OpenClaw <openclaw@kuzhomesrv.local> Co-authored-by: Dmitry Kuznetsov <139351986+dmitry@users.noreply.local> Co-authored-by: KuzyaBot <kuzya@local> Co-authored-by: JeferssonLemes <jeferssondev@gmail.com> Co-authored-by: Paijo <14921983+oyi77@users.noreply.github.com> Co-authored-by: Markus Hartung <mail@hartmark.se> Co-authored-by: akarray <akarray@users.noreply.github.com> Co-authored-by: Apostol Apostolov <theapoapostolov@gmail.com> Co-authored-by: Hernan Javier Ardila Sanchez <hjasgr@gmail.com> Co-authored-by: Dmitry Kuznetsov <dmitry@kuznetsov.me> Co-authored-by: Nikolay Alafuzov <alafuzov_nn@rusklimat.ru> Co-authored-by: oyi77 <oyi77@users.noreply.github.com> Co-authored-by: Ronaldo Davi <alltomatos@users.noreply.github.com> Co-authored-by: levonk <277861+levonk@users.noreply.github.com> Co-authored-by: Lenine Júnior <lenine@engrene.com.br> Co-authored-by: Annas Alghoffar <aag.annas@gmail.com> Co-authored-by: Tushar Agarwal <76201310+Tushar49@users.noreply.github.com> Co-authored-by: GreatLiu <eurasiaxz@qq.com> Co-authored-by: yuna amelia <230527278+yunaamelia@users.noreply.github.com> Co-authored-by: Randi <55005611+rdself@users.noreply.github.com> Co-authored-by: Container <78986709+disonjer@users.noreply.github.com> Co-authored-by: nickwizard <35692452+nickwizard@users.noreply.github.com> Co-authored-by: Rajvardhan Patil <rajvardhanpatil7890@gmail.com> Co-authored-by: Raxxoor <manker_lol@hotmail.com> Co-authored-by: Muhammad Mugni Hadi <mugnimaestra3@gmail.com> Co-authored-by: mi <123757457+soyelmismo@users.noreply.github.com> Co-authored-by: Automation <automation@omniroute>
412 lines
27 KiB
Markdown
412 lines
27 KiB
Markdown
# CLAUDE.md (Čeština)
|
|
|
|
🌐 **Languages:** 🇺🇸 [English](../../../CLAUDE.md) · 🇸🇦 [ar](../ar/CLAUDE.md) · 🇦🇿 [az](../az/CLAUDE.md) · 🇧🇬 [bg](../bg/CLAUDE.md) · 🇧🇩 [bn](../bn/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) · 🇷🇺 [ru](../ru/CLAUDE.md) · 🇸🇰 [sk](../sk/CLAUDE.md) · 🇸🇪 [sv](../sv/CLAUDE.md) · 🇰🇪 [sw](../sw/CLAUDE.md) · 🇮🇳 [ta](../ta/CLAUDE.md) · 🇮🇳 [te](../te/CLAUDE.md) · 🇹🇭 [th](../th/CLAUDE.md) · 🇹🇷 [tr](../tr/CLAUDE.md) · 🇺🇦 [uk-UA](../uk-UA/CLAUDE.md) · 🇵🇰 [ur](../ur/CLAUDE.md) · 🇻🇳 [vi](../vi/CLAUDE.md) · 🇨🇳 [zh-CN](../zh-CN/CLAUDE.md)
|
|
|
|
---
|
|
|
|
Tento soubor poskytuje pokyny pro Claude Code (claude.ai/code) při práci s kódem v tomto repozitáři.
|
|
|
|
## Rychlý start
|
|
|
|
```bash
|
|
npm install # Nainstalujte závislosti (automaticky vygeneruje .env z .env.example)
|
|
npm run dev # Vývojový server na http://localhost:20128
|
|
npm run build # Produkční build (Next.js 16 standalone)
|
|
npm run lint # ESLint (0 chyb očekáváno; varování jsou předchozí)
|
|
npm run typecheck:core # Kontrola TypeScriptu (mělo by být čisté)
|
|
npm run typecheck:noimplicit:core # Přísná kontrola (žádné implicitní any)
|
|
npm run test:coverage # Jednotkové testy + pokrytí (75/75/75/70 — prohlášení/řádky/funkce/větve)
|
|
npm run check # lint + testy dohromady
|
|
npm run check:cycles # Detekce cyklických závislostí
|
|
```
|
|
|
|
### Spouštění testů
|
|
|
|
```bash
|
|
# Jediný testovací soubor (nativní testovací běžec Node.js — většina testů)
|
|
node --import tsx/esm --test tests/unit/your-file.test.ts
|
|
|
|
# Vitest (MCP server, autoCombo, cache)
|
|
npm run test:vitest
|
|
|
|
# Všechny sady
|
|
npm run test:all
|
|
```
|
|
|
|
Pro plnou testovací matici viz `CONTRIBUTING.md` → "Spouštění testů". Pro hlubokou architekturu viz `AGENTS.md`.
|
|
|
|
---
|
|
|
|
## Projekt na první pohled
|
|
|
|
**OmniRoute** — jednotný AI proxy/router. Jeden koncový bod, 160+ poskytovatelů LLM, automatické zálohování.
|
|
|
|
| Vrstva | Umístění | Účel |
|
|
| ------------- | ----------------------- | ------------------------------------------------------------------------------- |
|
|
| API Routes | `src/app/api/v1/` | Next.js App Router — vstupní body |
|
|
| Handlers | `open-sse/handlers/` | Zpracování požadavků (chat, embeddings, atd.) |
|
|
| Executors | `open-sse/executors/` | HTTP dispatch specifický pro poskytovatele |
|
|
| Translators | `open-sse/translator/` | Konverze formátu (OpenAI↔Claude↔Gemini) |
|
|
| Transformer | `open-sse/transformer/` | API odpovědí ↔ Dokončení chatu |
|
|
| Services | `open-sse/services/` | Kombinované směrování, limity rychlosti, caching, atd. |
|
|
| Database | `src/lib/db/` | SQLite doménové moduly (45+ souborů, 55 migrací) |
|
|
| Domain/Policy | `src/domain/` | Engin politiky, pravidla nákladů, logika zálohování |
|
|
| MCP Server | `open-sse/mcp-server/` | 37 nástrojů (30 základních + 3 paměť + 4 dovednosti), 3 transporty, ~13 rozsahů |
|
|
| A2A Server | `src/lib/a2a/` | JSON-RPC 2.0 agent protokol |
|
|
| Skills | `src/lib/skills/` | Rozšiřitelný rámec dovedností |
|
|
| Memory | `src/lib/memory/` | Trvalá konverzační paměť |
|
|
|
|
Monorepo: `src/` (Next.js 16 aplikace), `open-sse/` (pracovní prostor streamovacího enginu), `electron/` (desktopová aplikace), `tests/`, `bin/` (CLI vstupní bod).
|
|
|
|
---
|
|
|
|
## Pipeline požadavků
|
|
|
|
```
|
|
Klient → /v1/chat/completions (Next.js route)
|
|
→ CORS → Zod validace → auth? → kontrola politiky → ochrana proti injekci promptu
|
|
→ handleChatCore() [open-sse/handlers/chatCore.ts]
|
|
→ kontrola cache → limit rychlosti → combo routing?
|
|
→ resolveComboTargets() → handleSingleModel() pro každý cíl
|
|
→ translateRequest() → getExecutor() → executor.execute()
|
|
→ fetch() upstream → opakování s backoff
|
|
→ překlad odpovědi → SSE stream nebo JSON
|
|
→ Pokud Responses API: responsesTransformer.ts TransformStream
|
|
```
|
|
|
|
API trasy následují konzistentní vzor: `Route → CORS preflight → Zod validace těla → Volitelná autentizace (extractApiKey/isValidApiKey) → Vynucení politiky API klíče → Delegace handleru (open-sse)`. Žádný globální Next.js middleware — interceptace je specifická pro trasu.
|
|
|
|
**Combo routing** (`open-sse/services/combo.ts`): 14 strategií (priorita, vážené, fill-first, round-robin, P2C, náhodné, nejméně používané, optimalizované podle nákladů, reset-aware, strict-random, auto, lkgp, optimalizované podle kontextu, kontext-relay). Každý cíl volá `handleSingleModel()`, který obaluje `handleChatCore()` s chybovým zpracováním a kontrolami obvodu pro každý cíl. Viz `docs/routing/AUTO-COMBO.md` pro 9-faktorové hodnocení Auto-Combo a `docs/architecture/RESILIENCE_GUIDE.md` pro 3 vrstvy odolnosti.
|
|
|
|
---
|
|
|
|
## Stav běhu odolnosti
|
|
|
|
OmniRoute má tři související, ale odlišné mechanismy dočasného selhání. Udržujte jejich rozsah oddělený při ladění chování routování. Viz
|
|
[diagram odolnosti ve 3 vrstvách](./docs/diagrams/exported/resilience-3layers.svg)
|
|
(zdroj: [docs/diagrams/resilience-3layers.mmd](./docs/diagrams/resilience-3layers.mmd))
|
|
pro rychlý přehled.
|
|
|
|
### Obvod poskytovatele
|
|
|
|
**Rozsah**: celý poskytovatel, např. `glm`, `openai`, `anthropic`.
|
|
|
|
**Účel**: zastavit posílání provozu k poskytovateli, který opakovaně selhává na úrovni upstream/služby, aby jeden nezdravý poskytovatel nezpomalil každý požadavek.
|
|
|
|
**Implementace**:
|
|
|
|
- Hlavní třída: `src/shared/utils/circuitBreaker.ts`
|
|
- Chat gate/execution wiring: `src/sse/handlers/chatHelpers.ts`, `src/sse/handlers/chat.ts`
|
|
- API stavu běhu: `src/app/api/monitoring/health/route.ts`
|
|
- Sdílené obaly: `open-sse/services/accountFallback.ts`
|
|
- Tabulka trvalého stavu: `domain_circuit_breakers`
|
|
|
|
**Stavy**:
|
|
|
|
- `CLOSED`: normální provoz je povolen.
|
|
- `OPEN`: poskytovatel je dočasně zablokován; volající dostanou odpověď provider-circuit-open
|
|
nebo combo routing přeskočí na jiný cíl.
|
|
- `HALF_OPEN`: resetovací timeout uplynul; povolit zkušební požadavek. Úspěch uzavírá
|
|
obvod, selhání jej znovu otevírá.
|
|
|
|
**Výchozí hodnoty** (`open-sse/config/constants.ts`):
|
|
|
|
- OAuth poskytovatelé: práh `3`, resetovací timeout `60s`.
|
|
- API-klíč poskytovatelé: práh `5`, resetovací timeout `30s`.
|
|
- Lokální poskytovatelé: práh `2`, resetovací timeout `15s`.
|
|
|
|
Pouze stavy selhání na úrovni poskytovatele by měly spustit obvod poskytovatele:
|
|
|
|
```ts
|
|
(408, 500, 502, 503, 504);
|
|
```
|
|
|
|
Nespouštějte obvod celého poskytovatele pro normální chyby účtu/klíče/modelu jako většina
|
|
případů `401`, `403` nebo `429`. Ty obvykle patří do cooldownu připojení nebo uzamčení modelu. Obecný API-klíč poskytovatel `403` by měl být obnovitelný, pokud není klasifikován
|
|
jako terminální chyba poskytovatele/účtu.
|
|
|
|
Obvod používá lenivou obnovu, ne pozadí časovač. Když `OPEN` vyprší, čtení jako
|
|
`getStatus()`, `canExecute()`, a `getRetryAfterMs()` obnoví stav na
|
|
`HALF_OPEN`, takže panely a stavitelé kandidátů na combo nebudou navždy vylučovat vypršeného poskytovatele.
|
|
|
|
### Cooldown připojení
|
|
|
|
**Rozsah**: jedno připojení/účet/klíč poskytovatele.
|
|
|
|
**Účel**: dočasně přeskočit jeden špatný klíč/účet, zatímco ostatní připojení pro
|
|
stejného poskytovatele mohou pokračovat v obsluze požadavků.
|
|
|
|
**Implementace**:
|
|
|
|
- Cesta zápisu/aktualizace: `src/sse/services/auth.ts::markAccountUnavailable()`
|
|
- Výběr/filtrování účtu: `src/sse/services/auth.ts::getProviderCredentials...`
|
|
- Výpočet cooldownu: `open-sse/services/accountFallback.ts::checkFallbackError()`
|
|
- Nastavení: `src/lib/resilience/settings.ts`
|
|
|
|
Důležitá pole na připojeních poskytovatele:
|
|
|
|
```ts
|
|
rateLimitedUntil;
|
|
testStatus: "unavailable";
|
|
lastError;
|
|
lastErrorType;
|
|
errorCode;
|
|
backoffLevel;
|
|
```
|
|
|
|
Během výběru účtu je připojení přeskočeno, pokud:
|
|
|
|
```ts
|
|
new Date(rateLimitedUntil).getTime() > Date.now();
|
|
```
|
|
|
|
Cooldowny jsou také lenivé: když je `rateLimitedUntil` v minulosti, připojení se opět stává
|
|
způsobilým. Při úspěšném použití `clearAccountError()` vymaže `testStatus`,
|
|
`rateLimitedUntil`, chybová pole a `backoffLevel`.
|
|
|
|
Výchozí chování cooldownu připojení:
|
|
|
|
- Základní cooldown OAuth: `5s`.
|
|
- Základní cooldown API-klíče: `3s`.
|
|
- API-klíč `429` by měl preferovat upstream retry hints (`Retry-After`, resetovací hlavičky, nebo
|
|
parsovatelný reset text) když jsou k dispozici.
|
|
- Opakované obnovitelné selhání používá exponenciální backoff:
|
|
|
|
```ts
|
|
baseCooldownMs * 2 ** failureIndex;
|
|
```
|
|
|
|
Ochrana proti thundering-herd zabraňuje souběžným selháním na stejném připojení v
|
|
opakovaném prodlužování cooldownu nebo dvojitému zvyšování `backoffLevel`.
|
|
|
|
Terminální stavy nejsou cooldowny. `banned`, `expired`, a `credits_exhausted` jsou
|
|
určeny k tomu, aby zůstaly nedostupné, dokud se nezmění pověření/nastavení nebo je operátor
|
|
neobnoví. Nepřepisujte terminální stavy do přechodného stavu cooldownu.
|
|
|
|
### Uzamčení modelu
|
|
|
|
**Rozsah**: poskytovatel + připojení + model.
|
|
|
|
**Účel**: vyhnout se deaktivaci celého připojení, když je k dispozici pouze jeden model
|
|
nebo je omezený kvótou pro toto připojení.
|
|
|
|
Příklady:
|
|
|
|
- Poskytovatelé s kvótou na model vracející `429`.
|
|
- Lokální poskytovatelé vracející `404` pro jeden chybějící model.
|
|
- Chyby oprávnění specifické pro poskytovatele/model, jako jsou vybrané režimy Grok.
|
|
|
|
Uzamčení modelu žije v `open-sse/services/accountFallback.ts` a umožňuje stejnému
|
|
připojení pokračovat v obsluze dalších modelů.
|
|
|
|
### Pokyny pro ladění
|
|
|
|
- Pokud jsou všechny klíče pro poskytovatele přeskočeny, zkontrolujte jak stav obvodu poskytovatele, tak
|
|
`rateLimitedUntil`/`testStatus` každého připojení.
|
|
- Pokud se zdá, že je poskytovatel trvale vyloučen po resetovacím okně, zkontrolujte, zda kód
|
|
čte surový `state` místo používání `getStatus()`/`canExecute()`.
|
|
- Pokud jeden klíč poskytovatele selže, ale ostatní by měly fungovat, preferujte cooldown připojení před
|
|
obvodem poskytovatele.
|
|
- Pokud selže pouze jeden model, preferujte uzamčení modelu před cooldownem připojení.
|
|
- Pokud by se měl stav sám obnovit, měl by mít budoucí časové razítko/resetovací timeout a
|
|
čtecí cestu, která obnovuje vypršený stav. Trvalé stavy vyžadují ruční změny pověření
|
|
nebo konfigurace.
|
|
|
|
## Klíčové konvence
|
|
|
|
### Styl kódu
|
|
|
|
- **2 mezery**, středníky, dvojité uvozovky, šířka 100 znaků, es5 koncové čárky (vynuceno lint-staged pomocí Prettier)
|
|
- **Importy**: externí → interní (`@/`, `@omniroute/open-sse`) → relativní
|
|
- **Pojmenování**: soubory=camelCase/kebab, komponenty=PascalCase, konstanty=UPPER_SNAKE
|
|
- **ESLint**: `no-eval`, `no-implied-eval`, `no-new-func` = chyba všude; `no-explicit-any` = varování v `open-sse/` a `tests/`
|
|
- **TypeScript**: `strict: false`, cíl ES2022, modul esnext, rozlišení bundler. Preferujte explicitní typy.
|
|
|
|
### Databáze
|
|
|
|
- **Vždy** procházejte doménovými moduly `src/lib/db/` — **nikdy** nepíšete surové SQL v trasách nebo obslužných funkcích
|
|
- **Nikdy** nepřidávejte logiku do `src/lib/localDb.ts` (pouze vrstva pro opětovný export)
|
|
- **Nikdy** neprovádějte barrel-import z `localDb.ts` — místo toho importujte konkrétní moduly `db/`
|
|
- DB singleton: `getDbInstance()` z `src/lib/db/core.ts` (WAL žurnálování)
|
|
- Migrace: `src/lib/db/migrations/` — verzované SQL soubory, idempotentní, prováděné v transakcích
|
|
|
|
### Zpracování chyb
|
|
|
|
- try/catch se specifickými typy chyb, logování s kontextem pino
|
|
- Nikdy nezapomínejte na chyby ve SSE streamech — použijte signály pro zrušení pro úklid
|
|
- Vraťte správné HTTP status kódy (4xx/5xx)
|
|
|
|
### Bezpečnost
|
|
|
|
- **Nikdy** nepoužívejte `eval()`, `new Function()`, nebo implicitní eval
|
|
- Ověřte všechny vstupy pomocí Zod schémat
|
|
- Šifrujte přihlašovací údaje v klidu (AES-256-GCM)
|
|
- Seznam zakázaných hlaviček upstream: `src/shared/constants/upstreamHeaders.ts` — udržujte sanitaci, Zod schémata a jednotkové testy v souladu při úpravách
|
|
- **Veřejné přihlašovací údaje upstream** (Gemini/Antigravity/Windsurf-style OAuth client_id/secret + Firebase Web klíče extrahované z veřejných CLI): **MUSÍ** být vloženy pomocí `resolvePublicCred()` z `open-sse/utils/publicCreds.ts` — **nikdy** jako literály. Viz `docs/security/PUBLIC_CREDS.md` pro povinný vzor.
|
|
- **Odpovědi na chyby** (HTTP / SSE / executor / MCP obslužná funkce): **MUSÍ** procházet `buildErrorBody()` nebo `sanitizeErrorMessage()` z `open-sse/utils/error.ts` — **nikdy** nevkládejte surové `err.stack` nebo `err.message` do těla odpovědi. Viz `docs/security/ERROR_SANITIZATION.md`.
|
|
- **Shell příkazy vytvořené z proměnných**: při volání `exec()`/`spawn()` se skriptem, který potřebuje hodnoty za běhu, předávejte je pomocí možnosti `env` (automaticky shell-escaped) — **nikdy** neprovádějte interpolaci neověřených/externalních cest do těla skriptu. Odkaz: `src/mitm/cert/install.ts::updateNssDatabases`.
|
|
- **Knihovny zabezpečené podle výchozího nastavení** ([tldrsec/awesome-secure-defaults](https://github.com/tldrsec/awesome-secure-defaults)): preferujte Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink před vlastními implementacemi při přidávání nových bezpečnostně citlivých povrchů.
|
|
|
|
---
|
|
|
|
## Běžné scénáře úprav
|
|
|
|
### Přidání nového poskytovatele
|
|
|
|
1. Zaregistrujte v `src/shared/constants/providers.ts` (ověřeno Zod při načítání)
|
|
2. Přidejte executor v `open-sse/executors/`, pokud je potřeba vlastní logika (rozšiřte `BaseExecutor`)
|
|
3. Přidejte překladač v `open-sse/translator/`, pokud není ve formátu OpenAI
|
|
4. Přidejte OAuth konfiguraci v `src/lib/oauth/constants/oauth.ts`, pokud je založena na OAuth — pokud upstream CLI dodává veřejný client_id/secret, vložte pomocí `resolvePublicCred()` (viz `docs/security/PUBLIC_CREDS.md`), **nikdy** jako literál
|
|
5. Zaregistrujte modely v `open-sse/config/providerRegistry.ts`
|
|
6. Napište testy v `tests/unit/` (zahrňte ověření tvaru publicCreds, pokud jste přidali nový vložený výchozí)
|
|
|
|
### Přidání nové API trasy
|
|
|
|
1. Vytvořte adresář pod `src/app/api/v1/your-route/`
|
|
2. Vytvořte `route.ts` s obslužnými funkcemi `GET`/`POST`
|
|
3. Dodržujte vzor: CORS → Zod ověření těla → volitelná autentizace → delegace obslužné funkce
|
|
4. Obslužná funkce jde do `open-sse/handlers/` (importujte odtud, ne inline)
|
|
5. Odpovědi na chyby používají `buildErrorBody()` / `errorResponse()` z `open-sse/utils/error.ts` (automaticky sanitizováno — nikdy nevkládejte `err.stack` nebo `err.message` surově do těla). Viz `docs/security/ERROR_SANITIZATION.md`.
|
|
6. Přidejte testy — včetně alespoň jednoho ověření, že odpovědi na chyby neunikají stopy (`!body.error.message.includes("at /")`)
|
|
|
|
### Přidání nového DB modulu
|
|
|
|
1. Vytvořte `src/lib/db/yourModule.ts` — importujte `getDbInstance` z `./core.ts`
|
|
2. Exportujte CRUD funkce pro vaše doménové tabulky
|
|
3. Přidejte migraci v `src/lib/db/migrations/`, pokud jsou potřeba nové tabulky
|
|
4. Znovu exportujte z `src/lib/localDb.ts` (přidejte pouze do seznamu pro opětovný export)
|
|
5. Napište testy
|
|
|
|
### Přidání nového MCP nástroje
|
|
|
|
1. Přidejte definici nástroje v `open-sse/mcp-server/tools/` s Zod vstupním schématem + asynchronní obslužnou funkcí
|
|
2. Zaregistrujte v sadě nástrojů (propojeno pomocí `createMcpServer()`)
|
|
3. Přiřaďte k příslušným rozsahům
|
|
4. Napište testy (vyvolání nástroje je zaznamenáno do tabulky `mcp_audit`)
|
|
|
|
### Přidání nové A2A dovednosti
|
|
|
|
1. Vytvořte dovednost v `src/lib/a2a/skills/` (5 již existuje: smart-routing, quota-management, provider-discovery, cost-analysis, health-report)
|
|
2. Dovednost přijímá kontext úkolu (zprávy, metadata) → vrací strukturovaný výsledek
|
|
3. Zaregistrujte v `A2A_SKILL_HANDLERS` v `src/lib/a2a/taskExecution.ts`
|
|
4. Exponujte v `src/app/.well-known/agent.json/route.ts` (Agent Card)
|
|
5. Napište testy v `tests/unit/`
|
|
6. Dokumentujte v `docs/frameworks/A2A-SERVER.md` tabulka dovedností
|
|
|
|
### Přidání nového cloudového agenta
|
|
|
|
1. Vytvořte třídu agenta v `src/lib/cloudAgent/agents/` rozšiřující `CloudAgentBase` (3 již existují: codex-cloud, devin, jules)
|
|
2. Implementujte `createTask`, `getStatus`, `approvePlan`, `sendMessage`, `listSources`
|
|
3. Zaregistrujte v `src/lib/cloudAgent/registry.ts`
|
|
4. Přidejte zpracování OAuth/přihlašovacích údajů, pokud je potřeba (`src/lib/oauth/providers/`)
|
|
5. Testy + dokumentujte v `docs/frameworks/CLOUD_AGENT.md`
|
|
|
|
### Přidání nového guardrail / eval / dovednosti / webhook události
|
|
|
|
- Guardrail: `src/lib/guardrails/` → dokumentace: `docs/security/GUARDRAILS.md`
|
|
- Eval suite: `src/lib/evals/` → dokumentace: `docs/frameworks/EVALS.md`
|
|
- Dovednost (sandbox): `src/lib/skills/` → dokumentace: `docs/frameworks/SKILLS.md`
|
|
- Webhook událost: `src/lib/webhookDispatcher.ts` → dokumentace: `docs/frameworks/WEBHOOKS.md`
|
|
|
|
## Referenční dokumentace
|
|
|
|
Před jakoukoli netriviální změnou si nejprve přečtěte odpovídající podrobnou analýzu:
|
|
|
|
| Oblast | Dokument |
|
|
| ------------------------------------------------ | ----------------------------------------------------------------- |
|
|
| Navigace repozitářem | `docs/architecture/REPOSITORY_MAP.md` |
|
|
| Architektura | `docs/architecture/ARCHITECTURE.md` |
|
|
| Odkaz na inženýrství | `docs/architecture/CODEBASE_DOCUMENTATION.md` |
|
|
| Auto-Combo (9-faktorové hodnocení, 14 strategií) | `docs/routing/AUTO-COMBO.md` |
|
|
| Odolnost (3 mechanismy) | `docs/architecture/RESILIENCE_GUIDE.md` |
|
|
| Opakování uvažování | `docs/routing/REASONING_REPLAY.md` |
|
|
| Rámec dovedností | `docs/frameworks/SKILLS.md` |
|
|
| Systém paměti (FTS5 + Qdrant) | `docs/frameworks/MEMORY.md` |
|
|
| Cloudoví agenti | `docs/frameworks/CLOUD_AGENT.md` |
|
|
| Ochranné prvky (PII / injekce / vize) | `docs/security/GUARDRAILS.md` |
|
|
| Veřejné přihlašovací údaje (Gemini atd.) | `docs/security/PUBLIC_CREDS.md` |
|
|
| Sanitizace chybových zpráv | `docs/security/ERROR_SANITIZATION.md` |
|
|
| Hodnocení | `docs/frameworks/EVALS.md` |
|
|
| Soulad / audit | `docs/security/COMPLIANCE.md` |
|
|
| Webhooky | `docs/frameworks/WEBHOOKS.md` |
|
|
| Autorizační pipeline | `docs/architecture/AUTHZ_GUIDE.md` |
|
|
| Stealth (TLS / otisk) | `docs/security/STEALTH_GUIDE.md` |
|
|
| Protokoly agentů (A2A / ACP / Cloud) | `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md` |
|
|
| MCP server | `docs/frameworks/MCP-SERVER.md` |
|
|
| A2A server | `docs/frameworks/A2A-SERVER.md` |
|
|
| Odkaz na API + OpenAPI | `docs/reference/API_REFERENCE.md` + `docs/reference/openapi.yaml` |
|
|
| Katalog poskytovatelů (automaticky generovaný) | `docs/reference/PROVIDER_REFERENCE.md` |
|
|
| Tok vydání | `docs/ops/RELEASE_CHECKLIST.md` |
|
|
|
|
## Testování
|
|
|
|
| Co | Příkaz |
|
|
| ----------------------- | ------------------------------------------------------------------ |
|
|
| Jednotkové testy | `npm run test:unit` |
|
|
| Jediný soubor | `node --import tsx/esm --test tests/unit/file.test.ts` |
|
|
| Vitest (MCP, autoCombo) | `npm run test:vitest` |
|
|
| E2E (Playwright) | `npm run test:e2e` |
|
|
| Protokol E2E (MCP+A2A) | `npm run test:protocols:e2e` |
|
|
| Ekosystém | `npm run test:ecosystem` |
|
|
| Brána pokrytí | `npm run test:coverage` (75/75/75/70 — příkazy/řádky/funkce/větve) |
|
|
| Zpráva o pokrytí | `npm run coverage:report` |
|
|
|
|
**Pravidlo PR**: Pokud změníte produkční kód v `src/`, `open-sse/`, `electron/` nebo `bin/`, musíte zahrnout nebo aktualizovat testy ve stejném PR.
|
|
|
|
**Preferovaný testovací vrstvy**: jednotkové testy první → integrace (více modulů nebo stav DB) → e2e (pouze UI/workflow). Kódování reprodukcí chyb jako automatizovaných testů před nebo spolu s opravou.
|
|
|
|
**Politika pokrytí Copilot**: Když PR změní produkční kód a pokrytí je pod 75% (příkazy/řádky/funkce) nebo 70% (větve), nehlaste pouze — přidejte nebo aktualizujte testy, znovu spusťte bránu pokrytí a poté požádejte o potvrzení. Zahrňte provedené příkazy, změněné testovací soubory a konečný výsledek pokrytí do zprávy PR.
|
|
|
|
---
|
|
|
|
## Git Workflow
|
|
|
|
```bash
|
|
# Nikdy neprovádějte commit přímo do main
|
|
git checkout -b feat/your-feature
|
|
git commit -m "feat: popište svou změnu"
|
|
git push -u origin feat/your-feature
|
|
```
|
|
|
|
**Předpony větví**: `feat/`, `fix/`, `refactor/`, `docs/`, `test/`, `chore/`
|
|
|
|
**Formát commitu** (Conventional Commits): `feat(db): přidat circuit breaker` — rozsahy: `db`, `sse`, `oauth`, `dashboard`, `api`, `cli`, `docker`, `ci`, `mcp`, `a2a`, `memory`, `skills`
|
|
|
|
**Husky hooky**:
|
|
|
|
- **pre-commit**: lint-staged + `check-docs-sync` + `check:any-budget:t11`
|
|
- **pre-push**: `npm run test:unit`
|
|
|
|
---
|
|
|
|
## Prostředí
|
|
|
|
- **Runtime**: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25, ES moduly
|
|
- **TypeScript**: 5.9+, cíl ES2022, modul esnext, rozlišení bundler
|
|
- **Cestovní aliasy**: `@/*` → `src/`, `@omniroute/open-sse` → `open-sse/`, `@omniroute/open-sse/*` → `open-sse/*`
|
|
- **Výchozí port**: 20128 (API + dashboard na stejném portu)
|
|
- **Adresář dat**: `DATA_DIR` env var, výchozí hodnota `~/.omniroute/`
|
|
- **Klíčové env vars**: `PORT`, `JWT_SECRET`, `API_KEY_SECRET`, `INITIAL_PASSWORD`, `REQUIRE_API_KEY`, `APP_LOG_LEVEL`
|
|
- Nastavení: `cp .env.example .env` poté vygenerujte `JWT_SECRET` (`openssl rand -base64 48`) a `API_KEY_SECRET` (`openssl rand -hex 32`)
|
|
|
|
---
|
|
|
|
## Přísná pravidla
|
|
|
|
1. Nikdy neprovádějte commit tajemství nebo přihlašovacích údajů
|
|
2. Nikdy nepřidávejte logiku do `localDb.ts`
|
|
3. Nikdy nepoužívejte `eval()` / `new Function()` / implicitní eval
|
|
4. Nikdy neprovádějte commit přímo do `main`
|
|
5. Nikdy nepíšete surový SQL v trasách — používejte moduly `src/lib/db/`
|
|
6. Nikdy tiše nezachycujte chyby ve SSE streamech
|
|
7. Vždy validujte vstupy pomocí Zod schémat
|
|
8. Vždy zahrňte testy při změně produkčního kódu
|
|
9. Pokrytí musí zůstat ≥75% (příkazy, řádky, funkce) / ≥70% (větve). Aktuálně měřeno: ~82%.
|
|
10. Nikdy neobcházejte Husky hooky (`--no-verify`, `--no-gpg-sign`) bez explicitního schválení operátora.
|
|
11. Nikdy nezahrnujte veřejné upstream OAuth client_id/secret nebo Firebase Web klíče jako řetězcové literály — vždy používejte `resolvePublicCred()` (`open-sse/utils/publicCreds.ts`). Viz `docs/security/PUBLIC_CREDS.md`.
|
|
12. Nikdy nevracejte surový `err.stack` / `err.message` v HTTP / SSE / odpovědích executorů — vždy procházejte přes `buildErrorBody()` nebo `sanitizeErrorMessage()` (`open-sse/utils/error.ts`). Viz `docs/security/ERROR_SANITIZATION.md`.
|
|
13. Nikdy neprovádějte interpolaci řetězců externích cest nebo runtime hodnot do shell skriptů předávaných do `exec()`/`spawn()` — předávejte je místo toho přes možnost `env`. Odkaz: `src/mitm/cert/install.ts::updateNssDatabases`.
|
|
14. Nikdy neignorujte upozornění CodeQL / Secret-Scanning bez (a) nejprve zkontrolování dokumentace vzoru výše, abyste zjistili, zda se pomocník vztahuje, a (b) zaznamenání technického odůvodnění do komentáře o zamítnutí. Precedent: `js/stack-trace-exposure` vznesený na místech volání, která již procházejí přes `sanitizeErrorMessage()`, je známé omezení CodeQL (vlastní sanitizátory nejsou rozpoznány) — zamítněte jako `false positive` s odkazem na `docs/security/ERROR_SANITIZATION.md`.
|
|
15. Nikdy nezveřejňujte trasy, které spouštějí podřízené procesy (`/api/mcp/`, `/api/cli-tools/runtime/`) bez klasifikace `isLocalOnlyPath()` v `src/server/authz/routeGuard.ts`. Vynucení loopbacku probíhá bezpodmínečně před jakýmkoli ověřením — uniklý JWT přes tunel nemůže spustit proces. Viz `docs/security/ROUTE_GUARD_TIERS.md`.
|
|
16. Nikdy nezahrnujte `Co-Authored-By` přílohy, které připisují AI asistenta, LLM nebo automatizovaný účet (např. jména obsahující "Claude", "GPT", "Copilot", "Bot"; e-maily na `anthropic.com` / `openai.com` / adresách `noreply.github.com` vlastněných boty). Takové přílohy směrují přiřazení commitů na účet bota na GitHubu, čímž skrývají skutečného autora (`diegosouzapw`) v historii PR. Lidští spolupracovníci — včetně autorů upstream PR a hlasatelů issues přenášených do OmniRoute — MOHOU a MĚLI BY být uvedeni standardními přílohami `Co-authored-by: Name <email>`; upstream-port pracovní postupy (`/port-upstream-features`, `/port-upstream-issues`) na tom závisí.
|