mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-04 22:32:12 +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>
410 lines
28 KiB
Markdown
410 lines
28 KiB
Markdown
# CLAUDE.md (Polski)
|
|
|
|
🌐 **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) · 🇵🇹 [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)
|
|
|
|
---
|
|
|
|
Ten plik zawiera wskazówki dla Claude Code (claude.ai/code) podczas pracy z kodem w tym repozytorium.
|
|
|
|
## Szybki Start
|
|
|
|
```bash
|
|
npm install # Instalacja zależności (automatyczne generowanie .env z .env.example)
|
|
npm run dev # Serwer deweloperski na http://localhost:20128
|
|
npm run build # Budowa produkcyjna (Next.js 16 standalone)
|
|
npm run lint # ESLint (0 błędów oczekiwanych; ostrzeżenia są już istniejące)
|
|
npm run typecheck:core # Sprawdzenie TypeScript (powinno być czyste)
|
|
npm run typecheck:noimplicit:core # Ścisłe sprawdzenie (brak implicit any)
|
|
npm run test:coverage # Testy jednostkowe + bramka pokrycia (75/75/75/70 — instrukcje/linie/funkcje/gałęzie)
|
|
npm run check # lint + testy połączone
|
|
npm run check:cycles # Wykrywanie cyklicznych zależności
|
|
```
|
|
|
|
### Uruchamianie Testów
|
|
|
|
```bash
|
|
# Pojedynczy plik testowy (wbudowany runner testów Node.js — większość testów)
|
|
node --import tsx/esm --test tests/unit/your-file.test.ts
|
|
|
|
# Vitest (serwer MCP, autoCombo, cache)
|
|
npm run test:vitest
|
|
|
|
# Wszystkie zestawy
|
|
npm run test:all
|
|
```
|
|
|
|
Aby zobaczyć pełną macierz testów, zapoznaj się z `CONTRIBUTING.md` → "Uruchamianie Testów". Aby zobaczyć głęboką architekturę, zapoznaj się z `AGENTS.md`.
|
|
|
|
---
|
|
|
|
## Projekt w Skrócie
|
|
|
|
**OmniRoute** — zjednoczony proxy/router AI. Jeden punkt końcowy, 160+ dostawców LLM, automatyczne przełączanie.
|
|
|
|
| Warstwa | Lokalizacja | Cel |
|
|
| ------------- | ----------------------- | ---------------------------------------------------------------------------------- |
|
|
| API Routes | `src/app/api/v1/` | Router aplikacji Next.js — punkty wejścia |
|
|
| Handlers | `open-sse/handlers/` | Przetwarzanie żądań (czat, osadzenia itp.) |
|
|
| Executors | `open-sse/executors/` | Specyficzne dla dostawcy wysyłanie HTTP |
|
|
| Translators | `open-sse/translator/` | Konwersja formatów (OpenAI↔Claude↔Gemini) |
|
|
| Transformer | `open-sse/transformer/` | API odpowiedzi ↔ Uzupełnienia czatu |
|
|
| Services | `open-sse/services/` | Routing combo, limity prędkości, cache itp. |
|
|
| Database | `src/lib/db/` | Moduły domeny SQLite (45+ plików, 55 migracji) |
|
|
| Domain/Policy | `src/domain/` | Silnik polityki, zasady kosztów, logika przełączania |
|
|
| MCP Server | `open-sse/mcp-server/` | 37 narzędzi (30 bazowych + 3 pamięci + 4 umiejętności), 3 transporty, ~13 zakresów |
|
|
| A2A Server | `src/lib/a2a/` | Protokół agenta JSON-RPC 2.0 |
|
|
| Skills | `src/lib/skills/` | Rozszerzalna struktura umiejętności |
|
|
| Memory | `src/lib/memory/` | Trwała pamięć konwersacyjna |
|
|
|
|
Monorepo: `src/` (aplikacja Next.js 16), `open-sse/` (workspace silnika strumieniowego), `electron/` (aplikacja desktopowa), `tests/`, `bin/` (punkt wejścia CLI).
|
|
|
|
---
|
|
|
|
## Pipeline Żądań
|
|
|
|
```
|
|
Klient → /v1/chat/completions (trasa Next.js)
|
|
→ CORS → walidacja Zod → autoryzacja? → sprawdzenie polityki → ochrona przed wstrzyknięciem promptu
|
|
→ handleChatCore() [open-sse/handlers/chatCore.ts]
|
|
→ sprawdzenie pamięci podręcznej → limit szybkości → routowanie combo?
|
|
→ resolveComboTargets() → handleSingleModel() dla każdego celu
|
|
→ translateRequest() → getExecutor() → executor.execute()
|
|
→ fetch() upstream → ponów z opóźnieniem
|
|
→ tłumaczenie odpowiedzi → strumień SSE lub JSON
|
|
→ Jeśli API Odpowiedzi: responsesTransformer.ts TransformStream
|
|
```
|
|
|
|
Trasy API podążają za spójnym wzorem: `Trasa → wstępne zapytanie CORS → walidacja ciała Zod → Opcjonalna autoryzacja (extractApiKey/isValidApiKey) → egzekwowanie polityki klucza API → delegacja obsługi (open-sse)`. Brak globalnego middleware Next.js — przechwytywanie jest specyficzne dla trasy.
|
|
|
|
**Routowanie combo** (`open-sse/services/combo.ts`): 14 strategii (priorytet, ważony, fill-first, round-robin, P2C, losowy, najmniej używany, zoptymalizowany kosztowo, świadomy resetu, ścisły losowy, auto, lkgp, zoptymalizowany kontekstowo, relay kontekstowy). Każdy cel wywołuje `handleSingleModel()`, który owija `handleChatCore()` z obsługą błędów dla każdego celu i sprawdzeniami wyłącznika obwodu. Zobacz `docs/routing/AUTO-COMBO.md` dla 9-czynnikowego punktowania Auto-Combo i `docs/architecture/RESILIENCE_GUIDE.md` dla 3 warstw odporności.
|
|
|
|
---
|
|
|
|
## Stan Czasu Wykonania Odporności
|
|
|
|
OmniRoute ma trzy powiązane, ale odrębne mechanizmy tymczasowej awarii. Zachowaj ich zakres oddzielnie podczas debugowania zachowania routingu. Zobacz
|
|
[diagram odporności 3-warstwowej](./docs/diagrams/exported/resilience-3layers.svg)
|
|
(źródło: [docs/diagrams/resilience-3layers.mmd](./docs/diagrams/resilience-3layers.mmd))
|
|
dla szybkiej mapy.
|
|
|
|
### Wyłącznik Obwodu Dostawcy
|
|
|
|
**Zakres**: cały dostawca, np. `glm`, `openai`, `anthropic`.
|
|
|
|
**Cel**: zatrzymać wysyłanie ruchu do dostawcy, który wielokrotnie zawodzi na poziomie upstream/usługi, aby jeden niezdrowy dostawca nie spowalniał każdego żądania.
|
|
|
|
**Implementacja**:
|
|
|
|
- Klasa główna: `src/shared/utils/circuitBreaker.ts`
|
|
- Połączenie bramki czatu/wykonania: `src/sse/handlers/chatHelpers.ts`, `src/sse/handlers/chat.ts`
|
|
- API statusu czasu wykonania: `src/app/api/monitoring/health/route.ts`
|
|
- Wspólne opakowania: `open-sse/services/accountFallback.ts`
|
|
- Tabela stanu utrwalanego: `domain_circuit_breakers`
|
|
|
|
**Stany**:
|
|
|
|
- `CLOSED`: normalny ruch jest dozwolony.
|
|
- `OPEN`: dostawca jest tymczasowo zablokowany; dzwoniący otrzymują odpowiedź provider-circuit-open
|
|
lub routowanie combo pomija inny cel.
|
|
- `HALF_OPEN`: czas resetu upłynął; zezwól na żądanie próbne. Sukces zamyka
|
|
wyłącznik, niepowodzenie ponownie go otwiera.
|
|
|
|
**Domyślne** (`open-sse/config/constants.ts`):
|
|
|
|
- Dostawcy OAuth: próg `3`, czas resetu `60s`.
|
|
- Dostawcy kluczy API: próg `5`, czas resetu `30s`.
|
|
- Dostawcy lokalni: próg `2`, czas resetu `15s`.
|
|
|
|
Tylko statusy awarii na poziomie dostawcy powinny uruchamiać wyłącznik dostawcy:
|
|
|
|
```ts
|
|
(408, 500, 502, 503, 504);
|
|
```
|
|
|
|
Nie uruchamiaj wyłącznika całego dostawcy dla normalnych błędów konta/klucza/modelu, takich jak większość
|
|
`401`, `403` lub `429`. Zwykle należą one do cooldownu połączenia lub zablokowania modelu. Ogólny błąd dostawcy klucza API `403` powinien być możliwy do odzyskania, chyba że zostanie sklasyfikowany
|
|
jako terminalny błąd dostawcy/konta.
|
|
|
|
Wyłącznik używa leniwego odzyskiwania, a nie tła. Gdy `OPEN` wygasa, odczyty takie jak `getStatus()`, `canExecute()`, i `getRetryAfterMs()` odświeżają stan do
|
|
`HALF_OPEN`, aby pulpity nawigacyjne i budowniczy kandydatów combo nie wykluczali wygasłego dostawcy na zawsze.
|
|
|
|
### Cooldown Połączenia
|
|
|
|
**Zakres**: jedno połączenie dostawcy/konto/klucz.
|
|
|
|
**Cel**: tymczasowo pominąć jeden zły klucz/konto, pozwalając innym połączeniom dla
|
|
tego samego dostawcy kontynuować obsługę żądań.
|
|
|
|
**Implementacja**:
|
|
|
|
- Ścieżka zapisu/aktualizacji: `src/sse/services/auth.ts::markAccountUnavailable()`
|
|
- Wybór/filtracja konta: `src/sse/services/auth.ts::getProviderCredentials...`
|
|
- Obliczanie cooldownu: `open-sse/services/accountFallback.ts::checkFallbackError()`
|
|
- Ustawienia: `src/lib/resilience/settings.ts`
|
|
|
|
Ważne pola w połączeniach dostawcy:
|
|
|
|
```ts
|
|
rateLimitedUntil;
|
|
testStatus: "unavailable";
|
|
lastError;
|
|
lastErrorType;
|
|
errorCode;
|
|
backoffLevel;
|
|
```
|
|
|
|
Podczas wyboru konta, połączenie jest pomijane, gdy:
|
|
|
|
```ts
|
|
new Date(rateLimitedUntil).getTime() > Date.now();
|
|
```
|
|
|
|
Cooldowny są również leniwe: gdy `rateLimitedUntil` jest w przeszłości, połączenie staje się
|
|
ponownie kwalifikowalne. Po udanym użyciu, `clearAccountError()` czyści `testStatus`,
|
|
`rateLimitedUntil`, pola błędów i `backoffLevel`.
|
|
|
|
Domyślne zachowanie cooldownu połączenia:
|
|
|
|
- Podstawowy cooldown OAuth: `5s`.
|
|
- Podstawowy cooldown klucza API: `3s`.
|
|
- Klucz API `429` powinien preferować wskazówki ponownego próbowania upstream (`Retry-After`, nagłówki resetu lub
|
|
tekst resetu do analizy) gdy są dostępne.
|
|
- Powtarzające się odzyskiwalne błędy używają wykładniczego opóźnienia:
|
|
|
|
```ts
|
|
baseCooldownMs * 2 ** failureIndex;
|
|
```
|
|
|
|
Ochrona przed zjawiskiem "thundering herd" zapobiega równoczesnym awariom na tym samym połączeniu, które
|
|
wielokrotnie wydłużają cooldown lub podwajają `backoffLevel`.
|
|
|
|
Stany terminalne nie są cooldownami. `banned`, `expired`, i `credits_exhausted` mają
|
|
pozostać niedostępne, aż zmienią się dane uwierzytelniające/ustawienia lub operator je zresetuje. Nie nadpisuj stanów terminalnych stanem cooldownu.
|
|
|
|
### Zablokowanie Modelu
|
|
|
|
**Zakres**: dostawca + połączenie + model.
|
|
|
|
**Cel**: unikać wyłączania całego połączenia, gdy tylko jeden model jest niedostępny lub
|
|
ograniczony kwotowo dla tego połączenia.
|
|
|
|
Przykłady:
|
|
|
|
- Dostawcy z kwotą na model zwracający `429`.
|
|
- Dostawcy lokalni zwracający `404` dla jednego brakującego modelu.
|
|
- Specyficzne dla dostawcy błędy uprawnień trybu/modelu, takie jak wybrane tryby Grok.
|
|
|
|
Zablokowanie modelu znajduje się w `open-sse/services/accountFallback.ts` i pozwala temu samemu
|
|
połączeniu kontynuować obsługę innych modeli.
|
|
|
|
### Wskazówki Debuggingowe
|
|
|
|
- Jeśli wszystkie klucze dla dostawcy są pomijane, sprawdź zarówno stan wyłącznika dostawcy, jak i `rateLimitedUntil`/`testStatus` każdego
|
|
połączenia.
|
|
- Jeśli dostawca wydaje się na stałe wykluczony po oknie resetu, sprawdź, czy kod
|
|
odczytuje surowy `state` zamiast używać `getStatus()`/`canExecute()`.
|
|
- Jeśli jeden klucz dostawcy zawodzi, ale inne powinny działać, preferuj cooldown połączenia nad
|
|
wyłącznikiem dostawcy.
|
|
- Jeśli tylko jeden model zawodzi, preferuj zablokowanie modelu nad cooldownem połączenia.
|
|
- Jeśli stan powinien samodzielnie się odzyskać, powinien mieć przyszły znacznik czasu/czas resetu i ścieżkę
|
|
odczytu, która odświeża wygasły stan. Statusy permanentne wymagają ręcznych zmian danych uwierzytelniających
|
|
lub konfiguracji.
|
|
|
|
## Kluczowe Konwencje
|
|
|
|
### Styl Kodowania
|
|
|
|
- **2 spacje**, średniki, podwójne cudzysłowy, szerokość 100 znaków, es5 przecinki na końcu (egzekwowane przez lint-staged za pomocą Prettier)
|
|
- **Importy**: zewnętrzne → wewnętrzne (`@/`, `@omniroute/open-sse`) → względne
|
|
- **Nazewnictwo**: pliki=camelCase/kebab, komponenty=PascalCase, stałe=UPPER_SNAKE
|
|
- **ESLint**: `no-eval`, `no-implied-eval`, `no-new-func` = błąd wszędzie; `no-explicit-any` = ostrzeżenie w `open-sse/` i `tests/`
|
|
- **TypeScript**: `strict: false`, cel ES2022, moduł esnext, rozdzielczość bundler. Preferuj jawne typy.
|
|
|
|
### Baza Danych
|
|
|
|
- **Zawsze** korzystaj z modułów domenowych w `src/lib/db/` — **nigdy** nie pisz surowego SQL w trasach lub handlerach
|
|
- **Nigdy** nie dodawaj logiki do `src/lib/localDb.ts` (tylko warstwa re-exportu)
|
|
- **Nigdy** nie importuj z `localDb.ts` w sposób barrel-import — zamiast tego importuj konkretne moduły `db/`
|
|
- Singleton DB: `getDbInstance()` z `src/lib/db/core.ts` (dziennik WAL)
|
|
- Migracje: `src/lib/db/migrations/` — wersjonowane pliki SQL, idempotentne, uruchamiane w transakcjach
|
|
|
|
### Obsługa Błędów
|
|
|
|
- try/catch z konkretnymi typami błędów, loguj z kontekstem pino
|
|
- Nigdy nie ignoruj błędów w strumieniach SSE — używaj sygnałów przerywających do czyszczenia
|
|
- Zwracaj odpowiednie kody statusu HTTP (4xx/5xx)
|
|
|
|
### Bezpieczeństwo
|
|
|
|
- **Nigdy** nie używaj `eval()`, `new Function()`, ani implikowanego eval
|
|
- Waliduj wszystkie dane wejściowe za pomocą schematów Zod
|
|
- Szyfruj dane uwierzytelniające w spoczynku (AES-256-GCM)
|
|
- Lista nagłówków denylist: `src/shared/constants/upstreamHeaders.ts` — utrzymuj sanitizację, schematy Zod i testy jednostkowe w zgodzie podczas edytowania
|
|
- **Publiczne dane uwierzytelniające upstream** (Gemini/Antigravity/Windsurf-style OAuth client_id/secret + klucze Firebase Web wyciągnięte z publicznych CLI): **MUSZĄ** być osadzone za pomocą `resolvePublicCred()` z `open-sse/utils/publicCreds.ts` — **nigdy** jako literały stringowe. Zobacz `docs/security/PUBLIC_CREDS.md` dla obowiązkowego wzoru.
|
|
- **Odpowiedzi błędów** (HTTP / SSE / executor / MCP handler): **MUSZĄ** przechodzić przez `buildErrorBody()` lub `sanitizeErrorMessage()` z `open-sse/utils/error.ts` — **nigdy** nie umieszczaj surowego `err.stack` lub `err.message` w ciele odpowiedzi. Zobacz `docs/security/ERROR_SANITIZATION.md`.
|
|
- **Polecenia powłoki budowane z zmiennych**: podczas wywoływania `exec()`/`spawn()` z skryptem, który potrzebuje wartości w czasie wykonywania, przekaż je za pomocą opcji `env` (automatycznie escapowane w powłoce) — **nigdy** nie interpoluj nieufnych/zewnętrznych ścieżek do ciała skryptu. Odniesienie: `src/mitm/cert/install.ts::updateNssDatabases`.
|
|
- **Biblioteki zabezpieczone domyślnie** ([tldrsec/awesome-secure-defaults](https://github.com/tldrsec/awesome-secure-defaults)): preferuj Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink zamiast własnych implementacji, gdy dodajesz nowe powierzchnie wrażliwe na bezpieczeństwo.
|
|
|
|
---
|
|
|
|
## Typowe Scenariusze Modyfikacji
|
|
|
|
### Dodawanie Nowego Dostawcy
|
|
|
|
1. Zarejestruj w `src/shared/constants/providers.ts` (walidowane przez Zod przy ładowaniu)
|
|
2. Dodaj executor w `open-sse/executors/`, jeśli potrzebna jest logika niestandardowa (rozszerz `BaseExecutor`)
|
|
3. Dodaj translator w `open-sse/translator/`, jeśli format nie jest OpenAI
|
|
4. Dodaj konfigurację OAuth w `src/lib/oauth/constants/oauth.ts`, jeśli oparta na OAuth — jeśli upstream CLI dostarcza publiczny client_id/secret, osadź za pomocą `resolvePublicCred()` (zobacz `docs/security/PUBLIC_CREDS.md`), **nigdy** jako literał
|
|
5. Zarejestruj modele w `open-sse/config/providerRegistry.ts`
|
|
6. Napisz testy w `tests/unit/` (dołącz asercję kształtu publicCreds, jeśli dodałeś nowy osadzony domyślny)
|
|
|
|
### Dodawanie Nowej Trasy API
|
|
|
|
1. Utwórz katalog pod `src/app/api/v1/your-route/`
|
|
2. Utwórz `route.ts` z handlerami `GET`/`POST`
|
|
3. Postępuj zgodnie ze wzorem: CORS → walidacja ciała Zod → opcjonalna autoryzacja → delegacja handlera
|
|
4. Handler umieść w `open-sse/handlers/` (importuj stamtąd, nie inline)
|
|
5. Odpowiedzi błędów używają `buildErrorBody()` / `errorResponse()` z `open-sse/utils/error.ts` (automatycznie sanitizowane — nigdy nie umieszczaj surowego `err.stack` lub `err.message` w ciele). Zobacz `docs/security/ERROR_SANITIZATION.md`.
|
|
6. Dodaj testy — w tym przynajmniej jedną asercję, że odpowiedzi błędów nie ujawniają śladów stosu (`!body.error.message.includes("at /")`)
|
|
|
|
### Dodawanie Nowego Modułu DB
|
|
|
|
1. Utwórz `src/lib/db/yourModule.ts` — importuj `getDbInstance` z `./core.ts`
|
|
2. Eksportuj funkcje CRUD dla swojej tabeli domenowej
|
|
3. Dodaj migrację w `src/lib/db/migrations/`, jeśli potrzebne są nowe tabele
|
|
4. Re-exportuj z `src/lib/localDb.ts` (dodaj tylko do listy re-exportu)
|
|
5. Napisz testy
|
|
|
|
### Dodawanie Nowego Narzędzia MCP
|
|
|
|
1. Dodaj definicję narzędzia w `open-sse/mcp-server/tools/` z schematem wejściowym Zod + asynchronicznym handlerem
|
|
2. Zarejestruj w zestawie narzędzi (połączone przez `createMcpServer()`)
|
|
3. Przypisz do odpowiednich zakresów
|
|
4. Napisz testy (wywołanie narzędzia logowane do tabeli `mcp_audit`)
|
|
|
|
### Dodawanie Nowej Umiejętności A2A
|
|
|
|
1. Utwórz umiejętność w `src/lib/a2a/skills/` (istnieje już 5: smart-routing, quota-management, provider-discovery, cost-analysis, health-report)
|
|
2. Umiejętność otrzymuje kontekst zadania (wiadomości, metadane) → zwraca uporządkowany wynik
|
|
3. Zarejestruj w `A2A_SKILL_HANDLERS` w `src/lib/a2a/taskExecution.ts`
|
|
4. Udostępnij w `src/app/.well-known/agent.json/route.ts` (Agent Card)
|
|
5. Napisz testy w `tests/unit/`
|
|
6. Udokumentuj w tabeli umiejętności w `docs/frameworks/A2A-SERVER.md`
|
|
|
|
### Dodawanie Nowego Agenta Chmurowego
|
|
|
|
1. Utwórz klasę agenta w `src/lib/cloudAgent/agents/`, rozszerzając `CloudAgentBase` (istnieją już 3: codex-cloud, devin, jules)
|
|
2. Zaimplementuj `createTask`, `getStatus`, `approvePlan`, `sendMessage`, `listSources`
|
|
3. Zarejestruj w `src/lib/cloudAgent/registry.ts`
|
|
4. Dodaj obsługę OAuth/danych uwierzytelniających, jeśli to konieczne (`src/lib/oauth/providers/`)
|
|
5. Testy + dokumentacja w `docs/frameworks/CLOUD_AGENT.md`
|
|
|
|
### Dodawanie Nowego Guardrail / Eval / Skill / Wydarzenia Webhook
|
|
|
|
- Guardrail: `src/lib/guardrails/` → dokumentacja: `docs/security/GUARDRAILS.md`
|
|
- Zestaw Eval: `src/lib/evals/` → dokumentacja: `docs/frameworks/EVALS.md`
|
|
- Umiejętność (sandbox): `src/lib/skills/` → dokumentacja: `docs/frameworks/SKILLS.md`
|
|
- Wydarzenie Webhook: `src/lib/webhookDispatcher.ts` → dokumentacja: `docs/frameworks/WEBHOOKS.md`
|
|
|
|
## Dokumentacja referencyjna
|
|
|
|
Dla każdej niebanalnej zmiany, najpierw przeczytaj odpowiedni szczegółowy dokument:
|
|
|
|
| Obszar | Dokument |
|
|
| --------------------------------------------------- | ----------------------------------------------------------------- |
|
|
| Nawigacja repozytoriów | `docs/architecture/REPOSITORY_MAP.md` |
|
|
| Architektura | `docs/architecture/ARCHITECTURE.md` |
|
|
| Dokumentacja inżynieryjna | `docs/architecture/CODEBASE_DOCUMENTATION.md` |
|
|
| Auto-Combo (9-czynnikowe ocenianie, 14 strategii) | `docs/routing/AUTO-COMBO.md` |
|
|
| Odporność (3 mechanizmy) | `docs/architecture/RESILIENCE_GUIDE.md` |
|
|
| Odtwarzanie rozumowania | `docs/routing/REASONING_REPLAY.md` |
|
|
| Ramy umiejętności | `docs/frameworks/SKILLS.md` |
|
|
| System pamięci (FTS5 + Qdrant) | `docs/frameworks/MEMORY.md` |
|
|
| Agenci chmurowi | `docs/frameworks/CLOUD_AGENT.md` |
|
|
| Zasady bezpieczeństwa (PII / wstrzykiwanie / wizja) | `docs/security/GUARDRAILS.md` |
|
|
| Publiczne dane uwierzytelniające (Gemini/itd.) | `docs/security/PUBLIC_CREDS.md` |
|
|
| Sanityzacja komunikatów o błędach | `docs/security/ERROR_SANITIZATION.md` |
|
|
| Oceny | `docs/frameworks/EVALS.md` |
|
|
| Zgodność / audyt | `docs/security/COMPLIANCE.md` |
|
|
| Webhooki | `docs/frameworks/WEBHOOKS.md` |
|
|
| Pipeline autoryzacji | `docs/architecture/AUTHZ_GUIDE.md` |
|
|
| Stealth (TLS / odcisk palca) | `docs/security/STEALTH_GUIDE.md` |
|
|
| Protokoły agentów (A2A / ACP / Cloud) | `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md` |
|
|
| Serwer MCP | `docs/frameworks/MCP-SERVER.md` |
|
|
| Serwer A2A | `docs/frameworks/A2A-SERVER.md` |
|
|
| Referencja API + OpenAPI | `docs/reference/API_REFERENCE.md` + `docs/reference/openapi.yaml` |
|
|
| Katalog dostawców (automatycznie generowany) | `docs/reference/PROVIDER_REFERENCE.md` |
|
|
| Proces wydania | `docs/ops/RELEASE_CHECKLIST.md` |
|
|
|
|
## Testowanie
|
|
|
|
| Co | Komenda |
|
|
| ----------------------- | ------------------------------------------------------------------------ |
|
|
| Testy jednostkowe | `npm run test:unit` |
|
|
| Pojedynczy plik | `node --import tsx/esm --test tests/unit/file.test.ts` |
|
|
| Vitest (MCP, autoCombo) | `npm run test:vitest` |
|
|
| E2E (Playwright) | `npm run test:e2e` |
|
|
| Protokół E2E (MCP+A2A) | `npm run test:protocols:e2e` |
|
|
| Ekosystem | `npm run test:ecosystem` |
|
|
| Brama pokrycia | `npm run test:coverage` (75/75/75/70 — instrukcje/linie/funkcje/gałęzie) |
|
|
| Raport pokrycia | `npm run coverage:report` |
|
|
|
|
**Zasada PR**: Jeśli zmieniasz kod produkcyjny w `src/`, `open-sse/`, `electron/`, lub `bin/`, musisz dodać lub zaktualizować testy w tym samym PR.
|
|
|
|
**Preferencje warstwy testów**: najpierw jednostkowe → integracyjne (wielomodułowe lub stan DB) → e2e (tylko UI/flow). Zakoduj reprodukcje błędów jako automatyczne testy przed lub równolegle z poprawką.
|
|
|
|
**Polityka pokrycia Copilot**: Gdy PR zmienia kod produkcyjny, a pokrycie jest poniżej 75% (instrukcje/linie/funkcje) lub 70% (gałęzie), nie tylko zgłaszaj — dodaj lub zaktualizuj testy, uruchom ponownie bramę pokrycia, a następnie poproś o potwierdzenie. Dołącz uruchomione komendy, zmienione pliki testowe i ostateczny wynik pokrycia w raporcie PR.
|
|
|
|
---
|
|
|
|
## Workflow Git
|
|
|
|
```bash
|
|
# Nigdy nie commituj bezpośrednio do main
|
|
git checkout -b feat/your-feature
|
|
git commit -m "feat: opisz swoją zmianę"
|
|
git push -u origin feat/your-feature
|
|
```
|
|
|
|
**Prefiksy gałęzi**: `feat/`, `fix/`, `refactor/`, `docs/`, `test/`, `chore/`
|
|
|
|
**Format commitów** (Conventional Commits): `feat(db): dodaj circuit breaker` — zakresy: `db`, `sse`, `oauth`, `dashboard`, `api`, `cli`, `docker`, `ci`, `mcp`, `a2a`, `memory`, `skills`
|
|
|
|
**Haki Husky**:
|
|
|
|
- **pre-commit**: lint-staged + `check-docs-sync` + `check:any-budget:t11`
|
|
- **pre-push**: `npm run test:unit`
|
|
|
|
---
|
|
|
|
## Środowisko
|
|
|
|
- **Czas działania**: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25, ES Modules
|
|
- **TypeScript**: 5.9+, cel ES2022, moduł esnext, rozdzielczość bundler
|
|
- **Alias ścieżek**: `@/*` → `src/`, `@omniroute/open-sse` → `open-sse/`, `@omniroute/open-sse/*` → `open-sse/*`
|
|
- **Domyślny port**: 20128 (API + dashboard na tym samym porcie)
|
|
- **Katalog danych**: zmienna środowiskowa `DATA_DIR`, domyślnie `~/.omniroute/`
|
|
- **Kluczowe zmienne środowiskowe**: `PORT`, `JWT_SECRET`, `API_KEY_SECRET`, `INITIAL_PASSWORD`, `REQUIRE_API_KEY`, `APP_LOG_LEVEL`
|
|
- Konfiguracja: `cp .env.example .env`, a następnie wygeneruj `JWT_SECRET` (`openssl rand -base64 48`) i `API_KEY_SECRET` (`openssl rand -hex 32`)
|
|
|
|
---
|
|
|
|
## Twarde zasady
|
|
|
|
1. Nigdy nie commituj sekretów ani poświadczeń
|
|
2. Nigdy nie dodawaj logiki do `localDb.ts`
|
|
3. Nigdy nie używaj `eval()` / `new Function()` / domyślnego eval
|
|
4. Nigdy nie commituj bezpośrednio do `main`
|
|
5. Nigdy nie pisz surowego SQL w trasach — używaj modułów `src/lib/db/`
|
|
6. Nigdy nie ignoruj błędów w strumieniach SSE
|
|
7. Zawsze waliduj dane wejściowe za pomocą schematów Zod
|
|
8. Zawsze dołączaj testy przy zmianie kodu produkcyjnego
|
|
9. Pokrycie musi wynosić ≥75% (instrukcje, linie, funkcje) / ≥70% (gałęzie). Aktualnie zmierzone: ~82%.
|
|
10. Nigdy nie omijaj haków Husky (`--no-verify`, `--no-gpg-sign`) bez wyraźnej zgody operatora.
|
|
11. Nigdy nie osadzaj publicznych upstream OAuth client_id/secret ani kluczy Firebase Web jako literałów stringowych — zawsze korzystaj z `resolvePublicCred()` (`open-sse/utils/publicCreds.ts`). Zobacz `docs/security/PUBLIC_CREDS.md`.
|
|
12. Nigdy nie zwracaj surowego `err.stack` / `err.message` w odpowiedziach HTTP / SSE / executor — zawsze kieruj przez `buildErrorBody()` lub `sanitizeErrorMessage()` (`open-sse/utils/error.ts`). Zobacz `docs/security/ERROR_SANITIZATION.md`.
|
|
13. Nigdy nie interpoluj zewnętrznych ścieżek ani wartości czasu wykonania do skryptów powłoki przekazywanych do `exec()`/`spawn()` — przekazuj przez opcję `env`. Odniesienie: `src/mitm/cert/install.ts::updateNssDatabases`.
|
|
14. Nigdy nie ignoruj alertu CodeQL / Secret-Scanning bez (a) najpierw sprawdzenia dokumentacji wzorców powyżej, aby zobaczyć, czy pomocnik ma zastosowanie, oraz (b) zapisania uzasadnienia technicznego w komentarzu o odrzuceniu. Precedens: `js/stack-trace-exposure` zgłoszone w miejscach wywołania, które już kierują przez `sanitizeErrorMessage()`, jest znanym ograniczeniem CodeQL (niestandardowe sanitizery nie są rozpoznawane) — odrzuć jako `fałszywy pozytyw`, odnosząc się do `docs/security/ERROR_SANITIZATION.md`.
|
|
15. Nigdy nie udostępniaj tras, które uruchamiają procesy podrzędne (`/api/mcp/`, `/api/cli-tools/runtime/`) bez klasyfikacji `isLocalOnlyPath()` w `src/server/authz/routeGuard.ts`. Egzekucja loopback odbywa się bezwarunkowo przed jakąkolwiek kontrolą autoryzacji — wyciekający JWT przez tunel nie może uruchomić procesów. Zobacz `docs/security/ROUTE_GUARD_TIERS.md`.
|
|
16. Nigdy nie dołączaj nagłówków `Co-Authored-By`, które przypisują zasługi asystentowi AI, LLM lub kontu automatyzacji (np. nazwy zawierające "Claude", "GPT", "Copilot", "Bot"; e-maile w `anthropic.com` / `openai.com` / adresach `noreply.github.com` należących do botów). Takie nagłówki kierują atrybucję commitów do konta bota na GitHubie, ukrywając prawdziwego autora (`diegosouzapw`) w historii PR. Współpracownicy ludzcy — w tym autorzy upstream PR i zgłaszający issues portowanych do OmniRoute — MOGĄ i POWINNI być uznawani standardowymi nagłówkami `Co-authored-by: Name <email>`; przepływy pracy upstream-port (`/port-upstream-features`, `/port-upstream-issues`) zależą od tego.
|