mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-05 23:02:10 +03:00
* fix(gemini): preserve structured tool calls for antigravity * fix(gemini): parse prefixed textual tool calls * fix(antigravity): preserve textual SSE tool calls * fix(stream): normalize textual passthrough tool calls * fix(stream): normalize split textual tool calls * fix(stream): suppress malformed textual tool calls * fix(stream): suppress compact malformed tool calls * fix(stream): emit structured textual tool calls * fix(stream): suppress unknown textual tool calls * fix(stream): normalize responses textual tool calls * chore: ignore .claude/settings.local.json (per-user Claude Code permissions) * fix(opencode-go): route qwen3.x via claude messages + repair fixMissingToolResponses for Claude-shape upstreams (#2791) Integrated into release/v3.8.6 * fix: resolve npm install warnings — remove dead deps, relax engine constraint (#2792) Integrated into release/v3.8.6 * fix: register missing web-cookie validators (claude-web, gemini-web, copilot-web, t3-web) (#2793) Integrated into release/v3.8.6 * fix: Error: Unable to inspect existing database #2771 (#2795) Integrated into release/v3.8.6 * fix(oauth): repair Google loopback callback flow (#2796) Integrated into release/v3.8.6 * feat(logs): add clean history button (#2799) Integrated into release/v3.8.6 * [codex] home: restore settings-driven home layout and quota auto-refresh (#2800) Integrated into release/v3.8.6 * fix(gemini): emit signaturelessToolCallMode:text for GEMINI format models (#2801) Integrated into release/v3.8.6 * feat(modelSpecs): align opencode-go family with upstream provider limits (#2802) Integrated into release/v3.8.6 * chore: apply unit test fixes, polyfills, and environment precedence fixes * docs(agents): atualiza fluxos de release e triagem Expande os workflows de release para incluir auditoria de segurança, CHANGELOG completo por commits, quality gate obrigatório, homologação em VPS local, publicação oficial, deploy em Akamai e validação de artefatos. Reorganiza a triagem de features com arquivos permanentes por bucket, suporte a itens em andamento, regra de reclaim após 15 dias e novo tratamento para ideias viáveis catalogadas. Corrige a orientação de revisão de discussões para usar a ordem cronológica real dos comentários e respostas ao identificar a última atividade. * fix(lockout): classify Gemini Antigravity resource exhaustion as quota_exhausted * fix(reasoning): gate replay by interleaved field * docs(rule-16): permit human Co-authored-by, restrict only AI/bot trailers Rule #16 previously banned all `Co-Authored-By` trailers absolutely. That blocked the upstream-port workflows (`/port-upstream-features` and `/port-upstream-issues`), which must credit human upstream PR authors and issue reporters in OmniRoute commits. Refine the rule to ban only AI/bot-attributed trailers (Claude, GPT, Copilot, Bot; anthropic.com / openai.com / bot-owned noreply.github.com emails) while allowing standard human `Co-authored-by: Name <email>` attribution. Sync the rule across the source CLAUDE.md, the E2E shakedown doc note, and 41 i18n translations. * fix(gitlawb): add specialty validators for connection test — bypass /models probe GitLawB OpenGateway API (xiaomi-mimo compatible) does not expose a /models endpoint, causing validateOpenAILikeProvider to 404 on the initial probe and report 'Provider validation endpoint not supported'. Add specialty validators for both gitlawb and gitlawb-gmi that follow the same pattern as the existing xiaomi-mimo validator: skip GET /models, validate directly via POST /chat/completions with a minimal test message. Any 401/403 response means an invalid key; all other responses mean auth is OK. Fixes test-connection returning 404 for GitLawB providers. * test(gitlawb): add 12 unit tests for gitlawb and gitlawb-gmi specialty validators Covers success, auth failure (401/403), non-auth acceptance (400/422/429), network errors, and custom baseUrl overrides for both providers. * feat(gitlawb): serve models from static registry without API-unavailable warning GitLawB's OpenGateway API does not expose a /models endpoint per provider-path. Previously the models route fell through to the generic fallback which returned static catalog models with the misleading 'API unavailable — using local catalog' warning. Now gitlawb and gitlawb-gmi are handled as static model providers (same pattern as reka and qwen OAuth) — models are served from the provider registry without any warning, since all registered models are functional via POST /chat/completions. * refactor(gitlawb): extract shared opengateway validator factory, fix docs path in test - Extract gitlawb/gitlawb-gmi validators into buildOpengatewayValidator factory - Fix dockerignore-docs-coverage test: update stale docs/AUTO-COMBO.md -> docs/routing/AUTO-COMBO.md * fix(reasoning): guard interleaved capability lookup * feat(gitlawb): dynamic model fetch with gmi-cloud fallback Hybrid approach: - gitlawb (xiaomi-mimo): dynamic /models endpoint → 356 models - gitlawb-gmi (gmi-cloud): 404 fallback → local catalog gracefully Mimics Gitlawb/openclaude's model-routing pattern * i18n(pt-BR): complete missing translations and sync with en.json * feat(build): nix multi-OS package manager install (#2806) Integrated into release/v3.8.6 * fix(i18n): translate 144 new __MISSING__ pt-BR strings (#2816) Integrated into release/v3.8.6 * chore(docs): set coverage gate to 40/40/40/40 in CLAUDE.md Aligns the documented coverage gate with the v3.8.6 release decision (lowered from 75/75/75/70). Matches the threshold already set in package.json by the large feature PRs (planos 11-22). * fix(cli): respect PORT env var in serve command (#2845) Integrated into release/v3.8.6. * fix(deepseek-web): return 400 when client sends tools[] - chat.deepseek.com has no tool support (#2854) Integrated into release/v3.8.6. * fix(qoder): reject invalid/expired PATs returning Cosy 500 error (#2860) Integrated into release/v3.8.6. * fix(cli): register openclaw in tool-detector (#2833) (#2850) Integrated into release/v3.8.6. * fix(api): include noAuth providers in /v1/models catalog (#2798) (#2814) Integrated into release/v3.8.6. * fix(combo): resolve custom provider targets via combo name (#2778) (#2812) Integrated into release/v3.8.6. * fix(translator): strip safety_identifier in openai-responses cleanup (#2770) (#2809) Integrated into release/v3.8.6. * fix(quota): honor explicit per-connection preflight opt-out (#2831) (#2844) Integrated into release/v3.8.6. * fix(usage): un-invert GitHub Copilot Free/limited quota — limited_user_quotas is remaining (#2876) (#2881) Integrated into release/v3.8.6. * fix(nous-research): correct baseUrl to include /chat/completions (#2826) (#2835) Integrated into release/v3.8.6. * fix(opencode): qwen3.x max/plus models lack vision support (#2822) (#2836) Integrated into release/v3.8.6. * fix(translator): pass-through tool_search built-in tool type (#2766) (#2811) Integrated into release/v3.8.6. * fix(github): route claude-opus-4.6 via chat completions (#2821) Integrated into release/v3.8.6. * docs(oauth): add Windsurf login fix design (Phase 1 hotfix + Phase 2 Firebase OAuth) Two-phase plan to fix the broken Windsurf OAuth flow: - Phase 1: drop the dead app.devin.ai/editor/signin PKCE path, promote import-token from windsurf.com/show-auth-token as the primary path - Phase 2: port Firebase OAuth + RegisterUser flow from fendoushaonian/WindSurf-gRPC-API for full browser-based automation Spec only - no code changes yet. * docs(plan): Phase 1 windsurf login hotfix implementation plan 10 tasks covering: - TDD assertions for flowType + 410 Gone responses - Provider switch to import_token - Route handler retiring authorize/start-callback-server/poll-callback - OAuthModal UI override - i18n sync - Verification + PR steps * fix(cli): replace cli-table3 with hand-rolled formatter (#2752) (#2813) Integrated into release/v3.8.6. * fix(skills): skip interception for unregistered client-native tools (#2815) (#2817) Integrated into release/v3.8.6. * feat(sse): add RTK filters for kubectl, docker-build, composer, gh (#2824) Integrated into release/v3.8.6. * fix(geminiHelper): support rec.image content shape + warn on dropped remote URLs (refs #2807) (#2855) Integrated into release/v3.8.6. * fix(cli): allow nullable/optional apiKey in cliMitmStartSchema (#2857) Integrated into release/v3.8.6. * fix(combo): preserve system messages during context handoff summary generation (#2865) Integrated into release/v3.8.6. * fix: wire CLIProxyAPI fallback settings into chatCore routing engine (#2866) Integrated into release/v3.8.6. * fix(usage): add opencode quota fetcher (#2852) (#2867) Integrated into release/v3.8.6. * feat(claude): default xhigh support for newer Opus models (#2874) Integrated into release/v3.8.6. * fix(cli): restore omniroute logs command stream (#2756) (#2810) Integrated into release/v3.8.6. * fix(combo): normalize upstream Headers for Node 24 undici interop (#2751) (#2823) Integrated into release/v3.8.6. * Rename proxy log Public IP to Client IP (#2880) Integrated into release/v3.8.6. * fix(claude): preserve max effort for supported models (#2875) Integrated into release/v3.8.6. * fix(oauth): switch windsurf provider to import_token flow The PKCE auth URL targeting app.devin.ai/editor/signin returns 404 post-rebrand. Until Phase 2 ports Firebase OAuth + RegisterUser, the only supported path is import-token via windsurf.com/show-auth-token. - windsurf.ts: drop buildAuthUrl, set flowType=import_token - generateAuthData returns supported:false + helpful error for windsurf/devin-cli - tests: assert flowType + disabled stub * fix(oauth): return 410 Gone for retired windsurf/devin-cli PKCE actions start-callback-server, authorize, and poll-callback (GET + POST) now return 410 Gone with a pointer to /import-token. The 410 short-circuit runs before auth so the response is honest about the action being permanently gone, not gated. Codex PKCE flow unchanged. Tests: 5 new assertions cover GET + POST 410 paths and a Codex regression check. * refactor(oauth): annotate retired PKCE fields in WINDSURF_CONFIG No behaviour change - comment-only update documenting that authorizeUrl, codeChallengeMethod, callbackPort, callbackPath, apiServerUrl, and exchangePath are no longer consumed. Active fields (inferenceUrl, showAuthTokenUrl, firebaseApiKey, ideName) called out separately. * fix(cli,docs): use requireCliToolsAuth in logs route + document OPENCODE quota env Post-merge contract fixes for v3.8.6: - src/app/api/cli-tools/logs/route.ts (#2810) now uses the shared requireCliToolsAuth guard (param renamed req->request) to satisfy the cli-tools-auth-hardening contract test. - Document OMNIROUTE_OPENCODE_QUOTA_URL (#2867) in docs/reference/ENVIRONMENT.md to satisfy the env/docs sync contract. * fix(dashboard): force import-token panel for windsurf/devin-cli Phase 1 hotfix: hide the 'Browser Login' tab and start in Paste API Key mode. Removes windsurf/devin-cli from PKCE_CALLBACK_SERVER_PROVIDERS so no callback server is started for them. Codex still uses the PKCE flow. The 'Get token' link continues to point at windsurf.com/show-auth-token via the existing supportsTokenPaste form copy. * fix(oauth): windsurf import-token mapTokens signature mismatch The route at `src/app/api/oauth/[provider]/[action]/route.ts` invokes `providerData.mapTokens({ accessToken: token })` (object), matching the cursor/kiro signature. The windsurf provider was declared with `mapTokens(token: string)` instead, so the entire object was stored as `accessToken`. When the connection record reached the SQLite layer it crashed with: SQLite3 can only bind numbers, strings, bigints, buffers, and null Fix by aligning windsurf's `mapTokens` signature with the route caller and the cursor/kiro convention. Also dedupe a copy-pasted second `if (action === "import-token")` block in the route handler — the second block was unreachable but identical to the first. Adds two regression tests asserting that `provider.mapTokens({ accessToken })` returns a string `accessToken` for both windsurf and devin-cli, so a future signature drift trips the gate instead of the SQLite bind error in production. * feat(compression): expand pt-BR pack with troglodita rules (15 → 49) (#2818) Integrated into release/v3.8.6 * fix(sse): repair RTK engine defaults so dedup and direct calls work (#2825) Integrated into release/v3.8.6 * fix(mcp): redirect console.log/warn to stderr in --mcp stdio mode (#2840) Integrated into release/v3.8.6 * fix(gemini-cli): prefer real project IDs over default-project (#2841) Integrated into release/v3.8.6 * fix(opencode-go): add provider limits quota fetcher (#2861) Integrated into release/v3.8.6 * Audit & add web cookie providers: fix 4 missing registry entries + DuckDuckGo (#2862) Integrated into release/v3.8.6 * fix(antigravity): harden signatureless tool history (#2878) Integrated into release/v3.8.6 * fix: provider model sync pruning and dynamic antigravity MITM proxy mappings (#2886) Integrated into release/v3.8.6 * feat(usage): per-API-key token limits scoped to model/provider/global (#2888) Integrated into release/v3.8.6 * fix(audio): build multipart body manually to preserve Content-Type (#2842) Integrated into release/v3.8.6 * refactor: remove agent skill documentation files and streamline maintenance workflows * test(stabilization): resolve unit test failures in blackbox-web, schema-coercion, translator-helper-branches, usage-service-hardening, and audio-transcription * fix(security): mitigate Socket.dev supply-chain findings + secrets opt-in + minimal build profile (#2863) (#2871) Two real security gaps closed and four cosmetic Socket.dev fingerprints removed. See docs/security/SOCKET_DEV_FINDINGS.md for the per-finding maintainer attestation. Real bugs fixed: - cloudSync: HMAC verification of `X-Cloud-Sig` + opt-in `OMNIROUTE_CLOUD_SYNC_SECRETS=true` before overwriting `accessToken` / `refreshToken` / `providerSpecificData` from a remote response. Closes the silent-credential-swap surface (a misconfigured or hostile CLOUD_URL could previously replace local tokens unverified). - Zed import: split into 2-step `/discover` + `/import` flow. `/import` now requires `confirmedAccounts: [{ service, account, fingerprint }]` and re-reads the keychain server-side to filter by fingerprint, so a tampered discover response cannot trick the endpoint into saving an unrelated token. Cosmetic Socket.dev mitigations: - runElevatedPowerShell writes the elevated payload to a per-call temp `.ps1` file (mode 0o600) and references it via `-File`. Removes the textbook `-EncodedCommand <base64utf16le>` pattern flagged as malware by Socket's AI classifier. - Maintainer attestation `SECURITY-AUDITOR-NOTE:` blocks added at every flagged call site pointing to `docs/security/SOCKET_DEV_FINDINGS.md`. Build-time hardening: - `OMNIROUTE_BUILD_PROFILE=minimal` (`npm run build:secure`) physically removes the four sensitive modules from the standalone bundle via webpack `NormalModuleReplacementPlugin`. Stubs throw `FeatureDisabledError` at runtime. Intended for the `omniroute-secure` artifact. Tests: - 24 new unit tests in `tests/unit/security/` covering the wrapper builder, HMAC verification (4 cases), credential fingerprint determinism (5 cases), confirmedAccounts validation + fingerprint filtering (6 cases), and the minimal-build stubs (5 cases). Docs: - New `docs/security/SOCKET_DEV_FINDINGS.md` — per-finding attestation. - New `socket.yml` — Socket.dev v2 config pointing at the attestation. - Updated `SECURITY.md` — supply-chain scanner section. - Updated `.env.example` — three new env vars documented. Backwards compatibility: - Cloud sync token overwrite is OFF by default. Users who relied on it must set `OMNIROUTE_CLOUD_SYNC_SECRETS=true`. Breaking change documented in CHANGELOG. - Zed import 2-step is the new default; legacy 1-step preserved behind `OMNIROUTE_ZED_IMPORT_LEGACY_ONE_STEP=true` and will be removed in v3.9. Closes #2863 * fix(security): redact public Firebase Web key from windsurf spec; doc SHA-256 cache-key rationale (#2894) Two security-scanning findings on release/v3.8.6: - Secret-scanning alert 7 (google_api_key): the windsurf login-fix design spec embedded the literal public Firebase Web API key on two lines. Firebase Web API keys are non-sensitive by design (they identify the project; access is gated by Firebase Security Rules + key restrictions), but the literal trips secret scanning. Redacted to a placeholder; the embedded default still goes through resolvePublicCred per rule #11. - Code-scanning alert 261 (js/insufficient-password-hash): tokenCacheKey() uses SHA-256 to derive an in-memory cache key from the session token, not for password-at-rest storage. Added a comment documenting why CWE-916 KDFs do not apply (false positive). * fix(ci): resolve release/v3.8.6 gate failures (docs-sync, any-budget, pack-artifact) (#2895) * fix(ci): resolve release/v3.8.6 gate failures (docs-sync, any-budget, pack-artifact) Three CI gates failed on release/v3.8.6 (run 26630300877): - docs-sync: CHANGELOG had a spurious "## [3.8.6-patch]" section above "## [3.8.6]", so the latest release no longer matched package.json (3.8.6) and the 41 i18n CHANGELOG mirrors were flagged as missing that section. Fold the lone #2752 entry into [3.8.6] and drop the patch heading. - any-budget:t11: open-sse/handlers/chatCore.ts regressed to 1 explicit `any` (budget 0). Type the persist callback arg as Record<string, unknown>, which matches runWithOnPersist's RefreshPersistFn contract exactly. - pack-artifact: open-sse/utils/setupPolyfill.ts ships via package.json "files" (bin/omniroute.mjs imports it at startup) but was missing from the pack policy allowlist. Allow it and add a regression test. * fix(security): redact public Firebase Web key from windsurf spec Redact the literal public Firebase Web API key (secret-scanning #7) to a placeholder, mirroring the redaction on release/v3.8.6 (PR #2894) and the windsurf fix branch. Non-sensitive public Web key; trips secret scanning. * feat(combo): Zero-Latency Combos (Hedging, Proactive Compression, Predictive TTFT) (#2868) * feat(combo): implement zero-latency combo optimizations (hedging, proactive compression, predictive TTFT) * fix(combo): fix predictive TTFT skip logic and unhandled promise rejections --------- Co-authored-by: Automation <automation@omniroute> * feat: implement automated skill workflows and update system configuration and validation schemas * test: eliminate dynamic cast warnings in cloud-sync unit test * test: isolate services-branch-hardening database directory to avoid concurrency issues * feat(providers): add 7 new web-cookie providers + research catalog + discovery tool New providers: - huggingchat: free LLM chat via huggingface.co/chat (no subscription) - phind: free dev-focused AI chat via phind.com/api/agent - poe-web: multi-model chat via poe.com GraphQL (p-b cookie) - venice-web: privacy-focused AI chat via venice.ai (session cookie) - v0-vercel-web: Vercel v0 code gen via v0.dev (session cookie) - kimi-web: Moonshot Kimi chat via kimi.moonshot.cn (session cookie) - doubao-web: ByteDance Doubao chat via doubao.com (session cookie) Additional: - Research catalog: docs/research/UNLIMITED_LLM_ACCESS.md - Discovery tool design + stub: src/lib/discovery/ + migration 073 - Unit tests: 33 tests for all 7 providers - Shared helpers consolidated in error.ts (slop cleanup) - All registered in WEB_COOKIE_PROVIDERS + providerRegistry + webSessionCredentials Closes #2885 * fix(typecheck): resolve typecheck errors in combo spec and compression modules * feat(api,oauth): add `agy` (Antigravity CLI) standalone provider with CLI token import (#2899) Add a standalone OAuth provider `agy` (Antigravity CLI) next to gemini-cli/antigravity. It reuses the antigravity inference backend (identical Google client_id + daily-cloudcode-pa.googleapis.com endpoint, executor and token-refresh) but ships its own model catalog — including the Claude models the backend exposes (claude-opus-4-6-thinking, claude-sonnet-4-6) — its own account pool, and four ways to connect: - token-file import (paste/upload the agy oauth token JSON) - auto-detect a local CLI login (~/.gemini/antigravity-cli/antigravity-oauth-token) - browser OAuth (via the shared OAuthModal Google loopback flow) - bulk / ZIP import New routes: POST /api/providers/agy-auth/{import,import-bulk,zip-extract,apply-local}. Catalog pinned from the live :fetchAvailableModels endpoint. Docs (openapi.yaml, ENVIRONMENT.md, .env.example, CHANGELOG) updated; new unit tests for registration, the token parser, and route auth-hardening. * fix(security): redact public Firebase Web key from windsurf spec (#2896) Redact the literal public Firebase Web API key (secret-scanning #7) to a placeholder. Firebase Web API keys are non-sensitive by design but the literal trips GitHub secret scanning. Mirrors the redaction landed on release/v3.8.6 (PR #2894). Embedded default still flows through resolvePublicCred (rule #11). * Pr 2871 (#2897) * fix(security): mitigate Socket.dev supply-chain findings + secrets opt-in + minimal build profile (#2863) Two real security gaps closed and four cosmetic Socket.dev fingerprints removed. See docs/security/SOCKET_DEV_FINDINGS.md for the per-finding maintainer attestation. Real bugs fixed: - cloudSync: HMAC verification of `X-Cloud-Sig` + opt-in `OMNIROUTE_CLOUD_SYNC_SECRETS=true` before overwriting `accessToken` / `refreshToken` / `providerSpecificData` from a remote response. Closes the silent-credential-swap surface (a misconfigured or hostile CLOUD_URL could previously replace local tokens unverified). - Zed import: split into 2-step `/discover` + `/import` flow. `/import` now requires `confirmedAccounts: [{ service, account, fingerprint }]` and re-reads the keychain server-side to filter by fingerprint, so a tampered discover response cannot trick the endpoint into saving an unrelated token. Cosmetic Socket.dev mitigations: - runElevatedPowerShell writes the elevated payload to a per-call temp `.ps1` file (mode 0o600) and references it via `-File`. Removes the textbook `-EncodedCommand <base64utf16le>` pattern flagged as malware by Socket's AI classifier. - Maintainer attestation `SECURITY-AUDITOR-NOTE:` blocks added at every flagged call site pointing to `docs/security/SOCKET_DEV_FINDINGS.md`. Build-time hardening: - `OMNIROUTE_BUILD_PROFILE=minimal` (`npm run build:secure`) physically removes the four sensitive modules from the standalone bundle via webpack `NormalModuleReplacementPlugin`. Stubs throw `FeatureDisabledError` at runtime. Intended for the `omniroute-secure` artifact. Tests: - 24 new unit tests in `tests/unit/security/` covering the wrapper builder, HMAC verification (4 cases), credential fingerprint determinism (5 cases), confirmedAccounts validation + fingerprint filtering (6 cases), and the minimal-build stubs (5 cases). Docs: - New `docs/security/SOCKET_DEV_FINDINGS.md` — per-finding attestation. - New `socket.yml` — Socket.dev v2 config pointing at the attestation. - Updated `SECURITY.md` — supply-chain scanner section. - Updated `.env.example` — three new env vars documented. Backwards compatibility: - Cloud sync token overwrite is OFF by default. Users who relied on it must set `OMNIROUTE_CLOUD_SYNC_SECRETS=true`. Breaking change documented in CHANGELOG. - Zed import 2-step is the new default; legacy 1-step preserved behind `OMNIROUTE_ZED_IMPORT_LEGACY_ONE_STEP=true` and will be removed in v3.9. Closes #2863 * feat: implement automated skill workflows and update system configuration and validation schemas * test: eliminate dynamic cast warnings in cloud-sync unit test * test: isolate services-branch-hardening database directory to avoid concurrency issues * chore(docs): refresh generated docs collection index Update the generated Fumadocs browser collection mapping to keep documentation imports in sync with the current docs structure. * docs: update generated browser docs collection manifest Refresh the generated Fumadocs browser collection mapping so the docs site can resolve the current documentation files correctly. --------- Co-authored-by: OpenClaw <openclaw@kuzhomesrv.local> Co-authored-by: Dmitry Kuznetsov <139351986+dmitry@users.noreply.local> Co-authored-by: KuzyaBot <kuzya@local> Co-authored-by: JeferssonLemes <jeferssondev@gmail.com> Co-authored-by: Paijo <14921983+oyi77@users.noreply.github.com> Co-authored-by: Markus Hartung <mail@hartmark.se> Co-authored-by: akarray <akarray@users.noreply.github.com> Co-authored-by: Apostol Apostolov <theapoapostolov@gmail.com> Co-authored-by: Hernan Javier Ardila Sanchez <hjasgr@gmail.com> Co-authored-by: Dmitry Kuznetsov <dmitry@kuznetsov.me> Co-authored-by: Nikolay Alafuzov <alafuzov_nn@rusklimat.ru> Co-authored-by: oyi77 <oyi77@users.noreply.github.com> Co-authored-by: Ronaldo Davi <alltomatos@users.noreply.github.com> Co-authored-by: levonk <277861+levonk@users.noreply.github.com> Co-authored-by: Lenine Júnior <lenine@engrene.com.br> Co-authored-by: Annas Alghoffar <aag.annas@gmail.com> Co-authored-by: Tushar Agarwal <76201310+Tushar49@users.noreply.github.com> Co-authored-by: GreatLiu <eurasiaxz@qq.com> Co-authored-by: yuna amelia <230527278+yunaamelia@users.noreply.github.com> Co-authored-by: Randi <55005611+rdself@users.noreply.github.com> Co-authored-by: Container <78986709+disonjer@users.noreply.github.com> Co-authored-by: nickwizard <35692452+nickwizard@users.noreply.github.com> Co-authored-by: Rajvardhan Patil <rajvardhanpatil7890@gmail.com> Co-authored-by: Raxxoor <manker_lol@hotmail.com> Co-authored-by: Muhammad Mugni Hadi <mugnimaestra3@gmail.com> Co-authored-by: mi <123757457+soyelmismo@users.noreply.github.com> Co-authored-by: Automation <automation@omniroute>
417 lines
28 KiB
Markdown
417 lines
28 KiB
Markdown
# CLAUDE.md (Español)
|
|
|
|
🌐 **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) · 🇮🇷 [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)
|
|
|
|
---
|
|
|
|
Este archivo proporciona orientación a Claude Code (claude.ai/code) al trabajar con código en este repositorio.
|
|
|
|
## Inicio Rápido
|
|
|
|
```bash
|
|
npm install # Instalar dependencias (genera automáticamente .env a partir de .env.example)
|
|
npm run dev # Servidor de desarrollo en http://localhost:20128
|
|
npm run build # Construcción de producción (Next.js 16 independiente)
|
|
npm run lint # ESLint (se esperan 0 errores; las advertencias son preexistentes)
|
|
npm run typecheck:core # Verificación de TypeScript (debería estar limpio)
|
|
npm run typecheck:noimplicit:core # Verificación estricta (sin any implícito)
|
|
npm run test:coverage # Pruebas unitarias + puerta de cobertura (75/75/75/70 — declaraciones/líneas/funciones/ramas)
|
|
npm run check # lint + test combinados
|
|
npm run check:cycles # Detectar dependencias circulares
|
|
```
|
|
|
|
### Ejecución de Pruebas
|
|
|
|
```bash
|
|
# Archivo de prueba único (ejecutor de pruebas nativo de Node.js — la mayoría de las pruebas)
|
|
node --import tsx/esm --test tests/unit/your-file.test.ts
|
|
|
|
# Vitest (servidor MCP, autoCombo, caché)
|
|
npm run test:vitest
|
|
|
|
# Todas las suites
|
|
npm run test:all
|
|
```
|
|
|
|
Para la matriz completa de pruebas, consulta `CONTRIBUTING.md` → "Ejecución de Pruebas". Para una arquitectura profunda, consulta `AGENTS.md`.
|
|
|
|
---
|
|
|
|
## Proyecto a Simple Vista
|
|
|
|
**OmniRoute** — proxy/router de IA unificado. Un punto final, más de 160 proveedores de LLM, retroceso automático.
|
|
|
|
| Capa | Ubicación | Propósito |
|
|
| ---------------- | ----------------------- | --------------------------------------------------------------------------------- |
|
|
| Rutas API | `src/app/api/v1/` | Enrutador de Aplicaciones Next.js — puntos de entrada |
|
|
| Manejadores | `open-sse/handlers/` | Procesamiento de solicitudes (chat, embeddings, etc) |
|
|
| Ejecutores | `open-sse/executors/` | Despacho HTTP específico del proveedor |
|
|
| Traductores | `open-sse/translator/` | Conversión de formato (OpenAI↔Claude↔Gemini) |
|
|
| Transformador | `open-sse/transformer/` | API de respuestas ↔ Completaciones de Chat |
|
|
| Servicios | `open-sse/services/` | Enrutamiento combinado, límites de tasa, caché, etc |
|
|
| Base de Datos | `src/lib/db/` | Módulos de dominio SQLite (más de 45 archivos, 55 migraciones) |
|
|
| Dominio/Política | `src/domain/` | Motor de políticas, reglas de costo, lógica de retroceso |
|
|
| Servidor MCP | `open-sse/mcp-server/` | 37 herramientas (30 base + 3 memoria + 4 habilidades), 3 transportes, ~13 ámbitos |
|
|
| Servidor A2A | `src/lib/a2a/` | Protocolo de agente JSON-RPC 2.0 |
|
|
| Habilidades | `src/lib/skills/` | Marco de habilidades extensible |
|
|
| Memoria | `src/lib/memory/` | Memoria conversacional persistente |
|
|
|
|
Monorepo: `src/` (aplicación Next.js 16), `open-sse/` (espacio de trabajo del motor de streaming), `electron/` (aplicación de escritorio), `tests/`, `bin/` (punto de entrada CLI).
|
|
|
|
---
|
|
|
|
## Pipeline de Solicitudes
|
|
|
|
```
|
|
Cliente → /v1/chat/completions (ruta de Next.js)
|
|
→ CORS → validación de Zod → ¿autenticación? → verificación de políticas → guardia de inyección de prompts
|
|
→ handleChatCore() [open-sse/handlers/chatCore.ts]
|
|
→ verificación de caché → límite de tasa → ¿enrutamiento combinado?
|
|
→ resolveComboTargets() → handleSingleModel() por objetivo
|
|
→ translateRequest() → getExecutor() → executor.execute()
|
|
→ fetch() upstream → reintentar con retroceso
|
|
→ traducción de respuesta → flujo SSE o JSON
|
|
→ Si Responses API: responsesTransformer.ts TransformStream
|
|
```
|
|
|
|
Las rutas de la API siguen un patrón consistente: `Ruta → preflight CORS → validación del cuerpo de Zod → Autenticación opcional (extractApiKey/isValidApiKey) → aplicación de políticas de clave API → Delegación de manejadores (open-sse)`. No hay middleware global de Next.js: la interceptación es específica de la ruta.
|
|
|
|
**Enrutamiento combinado** (`open-sse/services/combo.ts`): 14 estrategias (prioridad, ponderado, llenar primero, round-robin, P2C, aleatorio, menos utilizado, optimizado por costo, consciente del reinicio, aleatorio estricto, automático, lkgp, optimizado por contexto, retransmisión de contexto). Cada objetivo llama a `handleSingleModel()` que envuelve `handleChatCore()` con manejo de errores por objetivo y verificaciones de cortacircuito. Consulte `docs/routing/AUTO-COMBO.md` para la puntuación de Auto-Combo de 9 factores y `docs/architecture/RESILIENCE_GUIDE.md` para las 3 capas de resiliencia.
|
|
|
|
---
|
|
|
|
## Estado de Ejecución de Resiliencia
|
|
|
|
OmniRoute tiene tres mecanismos de falla temporal relacionados pero distintos. Mantenga su
|
|
alcance separado al depurar el comportamiento de enrutamiento. Consulte el
|
|
[diagrama de resiliencia de 3 capas](./docs/diagrams/exported/resilience-3layers.svg)
|
|
(fuente: [docs/diagrams/resilience-3layers.mmd](./docs/diagrams/resilience-3layers.mmd))
|
|
para un mapa de un vistazo.
|
|
|
|
### Cortacircuito del Proveedor
|
|
|
|
**Alcance**: todo el proveedor, por ejemplo, `glm`, `openai`, `anthropic`.
|
|
|
|
**Propósito**: detener el envío de tráfico a un proveedor que está fallando repetidamente a nivel
|
|
upstream/servicio, para que un proveedor no saludable no ralentice cada solicitud.
|
|
|
|
**Implementación**:
|
|
|
|
- Clase principal: `src/shared/utils/circuitBreaker.ts`
|
|
- Cableado de puerta de chat/ejecución: `src/sse/handlers/chatHelpers.ts`, `src/sse/handlers/chat.ts`
|
|
- API de estado en tiempo de ejecución: `src/app/api/monitoring/health/route.ts`
|
|
- Envolturas compartidas: `open-sse/services/accountFallback.ts`
|
|
- Tabla de estado persistido: `domain_circuit_breakers`
|
|
|
|
**Estados**:
|
|
|
|
- `CLOSED`: se permite tráfico normal.
|
|
- `OPEN`: el proveedor está temporalmente bloqueado; los llamadores reciben una respuesta de circuito-abierto del proveedor
|
|
o el enrutamiento combinado salta a otro objetivo.
|
|
- `HALF_OPEN`: ha transcurrido el tiempo de espera de reinicio; se permite una solicitud de sondeo. El éxito cierra el
|
|
cortacircuito, el fracaso lo abre nuevamente.
|
|
|
|
**Valores predeterminados** (`open-sse/config/constants.ts`):
|
|
|
|
- Proveedores de OAuth: umbral `3`, tiempo de espera de reinicio `60s`.
|
|
- Proveedores de clave API: umbral `5`, tiempo de espera de reinicio `30s`.
|
|
- Proveedores locales: umbral `2`, tiempo de espera de reinicio `15s`.
|
|
|
|
Solo los estados de falla a nivel de proveedor deben activar el cortacircuito del proveedor:
|
|
|
|
```ts
|
|
(408, 500, 502, 503, 504);
|
|
```
|
|
|
|
No active el cortacircuito de todo el proveedor por errores normales de cuenta/clave/modelo como la mayoría
|
|
de los casos `401`, `403` o `429`. Esos generalmente pertenecen a la espera de conexión o bloqueo de modelo. Un proveedor de clave API genérico `403` debería ser recuperable a menos que se clasifique
|
|
como un error terminal de proveedor/cuenta.
|
|
|
|
El cortacircuito utiliza recuperación perezosa, no un temporizador en segundo plano. Cuando `OPEN` expira, lecturas como
|
|
`getStatus()`, `canExecute()`, y `getRetryAfterMs()` actualizan el estado a
|
|
`HALF_OPEN`, para que los paneles de control y los constructores de candidatos combinados no sigan excluyendo un
|
|
proveedor expirado para siempre.
|
|
|
|
### Enfriamiento de Conexión
|
|
|
|
**Alcance**: una conexión/cuenta/clave de proveedor.
|
|
|
|
**Propósito**: omitir temporalmente una clave/cuenta mala mientras permite que otras conexiones para
|
|
el mismo proveedor continúen atendiendo solicitudes.
|
|
|
|
**Implementación**:
|
|
|
|
- Ruta de escritura/actualización: `src/sse/services/auth.ts::markAccountUnavailable()`
|
|
- Selección/filtrado de cuentas: `src/sse/services/auth.ts::getProviderCredentials...`
|
|
- Cálculo de enfriamiento: `open-sse/services/accountFallback.ts::checkFallbackError()`
|
|
- Configuraciones: `src/lib/resilience/settings.ts`
|
|
|
|
Campos importantes en conexiones de proveedor:
|
|
|
|
```ts
|
|
rateLimitedUntil;
|
|
testStatus: "unavailable";
|
|
lastError;
|
|
lastErrorType;
|
|
errorCode;
|
|
backoffLevel;
|
|
```
|
|
|
|
Durante la selección de cuentas, se omite una conexión mientras:
|
|
|
|
```ts
|
|
new Date(rateLimitedUntil).getTime() > Date.now();
|
|
```
|
|
|
|
Los enfriamientos también son perezosos: cuando `rateLimitedUntil` está en el pasado, la conexión se vuelve
|
|
elegible nuevamente. Al usar con éxito, `clearAccountError()` borra `testStatus`,
|
|
`rateLimitedUntil`, campos de error y `backoffLevel`.
|
|
|
|
Comportamiento predeterminado de enfriamiento de conexión:
|
|
|
|
- Enfriamiento base de OAuth: `5s`.
|
|
- Enfriamiento base de clave API: `3s`.
|
|
- La clave API `429` debería preferir pistas de reintento upstream (`Retry-After`, encabezados de reinicio, o
|
|
texto de reinicio parseable) cuando estén disponibles.
|
|
- Fallos recuperables repetidos utilizan retroceso exponencial:
|
|
|
|
```ts
|
|
baseCooldownMs * 2 ** failureIndex;
|
|
```
|
|
|
|
El guardia anti-thundering-herd previene fallos concurrentes en la misma conexión de
|
|
extender repetidamente el enfriamiento o incrementar doblemente `backoffLevel`.
|
|
|
|
Los estados terminales no son enfriamientos. `banned`, `expired`, y `credits_exhausted` están
|
|
destinados a permanecer no disponibles hasta que cambien las credenciales/configuraciones o un operador los reinicie.
|
|
No sobrescriba estados terminales con estados de enfriamiento transitorios.
|
|
|
|
### Bloqueo de Modelo
|
|
|
|
**Alcance**: proveedor + conexión + modelo.
|
|
|
|
**Propósito**: evitar deshabilitar toda una conexión cuando solo un modelo no está disponible o
|
|
tiene un límite de cuota para esa conexión.
|
|
|
|
Ejemplos:
|
|
|
|
- Proveedores de cuota por modelo que devuelven `429`.
|
|
- Proveedores locales que devuelven `404` para un modelo faltante.
|
|
- Fallos de permisos de modo/modelo específicos del proveedor, como modos Grok seleccionados.
|
|
|
|
El bloqueo de modelo vive en `open-sse/services/accountFallback.ts` y permite que la misma
|
|
conexión continúe atendiendo otros modelos.
|
|
|
|
### Orientación para Depuración
|
|
|
|
- Si todas las claves para un proveedor son omitidas, inspeccione tanto el estado del cortacircuito del proveedor como cada
|
|
`rateLimitedUntil`/`testStatus` de conexión.
|
|
- Si un proveedor parece estar excluido permanentemente después de la ventana de reinicio, verifique si el código
|
|
está leyendo el `state` en bruto en lugar de usar `getStatus()`/`canExecute()`.
|
|
- Si una clave de proveedor falla pero otras deberían funcionar, prefiera el enfriamiento de conexión sobre
|
|
el cortacircuito del proveedor.
|
|
- Si solo un modelo falla, prefiera el bloqueo de modelo sobre el enfriamiento de conexión.
|
|
- Si un estado debería recuperarse por sí mismo, debería tener una marca de tiempo futura/tiempo de espera de reinicio y una
|
|
ruta de lectura que actualice el estado expirado. Los estados permanentes requieren cambios manuales de credenciales
|
|
o configuración.
|
|
|
|
## Convenciones Clave
|
|
|
|
### Estilo de Código
|
|
|
|
- **2 espacios**, punto y coma, comillas dobles, ancho de 100 caracteres, comas finales en es5 (aplicado por lint-staged a través de Prettier)
|
|
- **Importaciones**: externo → interno (`@/`, `@omniroute/open-sse`) → relativo
|
|
- **Nomenclatura**: archivos=camelCase/kebab, componentes=PascalCase, constantes=UPPER_SNAKE
|
|
- **ESLint**: `no-eval`, `no-implied-eval`, `no-new-func` = error en todas partes; `no-explicit-any` = advertencia en `open-sse/` y `tests/`
|
|
- **TypeScript**: `strict: false`, objetivo ES2022, módulo esnext, resolución bundler. Preferir tipos explícitos.
|
|
|
|
### Base de Datos
|
|
|
|
- **Siempre** pasar por los módulos de dominio en `src/lib/db/` — **nunca** escribir SQL en bruto en rutas o manejadores
|
|
- **Nunca** agregar lógica a `src/lib/localDb.ts` (capa de re-exportación solamente)
|
|
- **Nunca** importar en bloque desde `localDb.ts` — importar módulos específicos de `db/` en su lugar
|
|
- Singleton de DB: `getDbInstance()` desde `src/lib/db/core.ts` (registro WAL)
|
|
- Migraciones: `src/lib/db/migrations/` — archivos SQL versionados, idempotentes, ejecutados en transacciones
|
|
|
|
### Manejo de Errores
|
|
|
|
- try/catch con tipos de error específicos, registrar con contexto de pino
|
|
- Nunca tragar errores en flujos SSE — usar señales de aborto para limpieza
|
|
- Devolver códigos de estado HTTP apropiados (4xx/5xx)
|
|
|
|
### Seguridad
|
|
|
|
- **Nunca** usar `eval()`, `new Function()`, o eval implícito
|
|
- Validar todas las entradas con esquemas Zod
|
|
- Cifrar credenciales en reposo (AES-256-GCM)
|
|
- Lista de negación de encabezados upstream: `src/shared/constants/upstreamHeaders.ts` — mantener saneados, esquemas Zod y pruebas unitarias alineadas al editar
|
|
- **Credenciales públicas upstream** (client_id/secret de OAuth estilo Gemini/Antigravity/Windsurf + claves web de Firebase extraídas de CLIs públicas): **DEBEN** ser incrustadas a través de `resolvePublicCred()` desde `open-sse/utils/publicCreds.ts` — **nunca** como literales de cadena. Ver `docs/security/PUBLIC_CREDS.md` para el patrón obligatorio.
|
|
- **Respuestas de error** (HTTP / SSE / ejecutor / manejador MCP): **DEBEN** pasar por `buildErrorBody()` o `sanitizeErrorMessage()` desde `open-sse/utils/error.ts` — **nunca** poner `err.stack` o `err.message` en bruto en el cuerpo de la respuesta. Ver `docs/security/ERROR_SANITIZATION.md`.
|
|
- **Comandos de shell construidos a partir de variables**: al llamar a `exec()`/`spawn()` con un script que necesita valores en tiempo de ejecución, pásalos a través de la opción `env` (escapados automáticamente) — **nunca** interpolar cadenas de rutas no confiables/externas en el cuerpo del script. Referencia: `src/mitm/cert/install.ts::updateNssDatabases`.
|
|
- **Bibliotecas seguras por defecto** ([tldrsec/awesome-secure-defaults](https://github.com/tldrsec/awesome-secure-defaults)): preferir Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink sobre implementaciones personalizadas siempre que se agreguen nuevas superficies sensibles a la seguridad.
|
|
|
|
---
|
|
|
|
## Escenarios Comunes de Modificación
|
|
|
|
### Agregar un Nuevo Proveedor
|
|
|
|
1. Registrar en `src/shared/constants/providers.ts` (validado por Zod al cargar)
|
|
2. Agregar ejecutor en `open-sse/executors/` si se necesita lógica personalizada (extender `BaseExecutor`)
|
|
3. Agregar traductor en `open-sse/translator/` si no es formato OpenAI
|
|
4. Agregar configuración de OAuth en `src/lib/oauth/constants/oauth.ts` si es basado en OAuth — si el CLI upstream envía un client_id/secret público, incrustar a través de `resolvePublicCred()` (ver `docs/security/PUBLIC_CREDS.md`), **nunca** como un literal
|
|
5. Registrar modelos en `open-sse/config/providerRegistry.ts`
|
|
6. Escribir pruebas en `tests/unit/` (incluir la afirmación de forma publicCreds si agregaste un nuevo predeterminado incrustado)
|
|
|
|
### Agregar una Nueva Ruta API
|
|
|
|
1. Crear directorio bajo `src/app/api/v1/your-route/`
|
|
2. Crear `route.ts` con manejadores `GET`/`POST`
|
|
3. Seguir el patrón: CORS → validación del cuerpo Zod → autenticación opcional → delegación de manejador
|
|
4. El manejador va en `open-sse/handlers/` (importar desde allí, no en línea)
|
|
5. Las respuestas de error utilizan `buildErrorBody()` / `errorResponse()` desde `open-sse/utils/error.ts` (auto-saneadas — nunca poner `err.stack` o `err.message` en bruto en el cuerpo). Ver `docs/security/ERROR_SANITIZATION.md`.
|
|
6. Agregar pruebas — incluyendo al menos una afirmación de que las respuestas de error no filtran trazas de pila (`!body.error.message.includes("at /")`)
|
|
|
|
### Agregar un Nuevo Módulo DB
|
|
|
|
1. Crear `src/lib/db/yourModule.ts` — importar `getDbInstance` desde `./core.ts`
|
|
2. Exportar funciones CRUD para tu(s) tabla(s) de dominio
|
|
3. Agregar migración en `src/lib/db/migrations/` si se necesitan nuevas tablas
|
|
4. Re-exportar desde `src/lib/localDb.ts` (agregar a la lista de re-exportación solamente)
|
|
5. Escribir pruebas
|
|
|
|
### Agregar una Nueva Herramienta MCP
|
|
|
|
1. Agregar definición de herramienta en `open-sse/mcp-server/tools/` con esquema de entrada Zod + manejador asíncrono
|
|
2. Registrar en el conjunto de herramientas (conectado por `createMcpServer()`)
|
|
3. Asignar a los ámbitos apropiados
|
|
4. Escribir pruebas (invocación de herramienta registrada en la tabla `mcp_audit`)
|
|
|
|
### Agregar una Nueva Habilidad A2A
|
|
|
|
1. Crear habilidad en `src/lib/a2a/skills/` (ya existen 5: smart-routing, quota-management, provider-discovery, cost-analysis, health-report)
|
|
2. La habilidad recibe contexto de tarea (mensajes, metadatos) → devuelve resultado estructurado
|
|
3. Registrar en `A2A_SKILL_HANDLERS` en `src/lib/a2a/taskExecution.ts`
|
|
4. Exponer en `src/app/.well-known/agent.json/route.ts` (Tarjeta de Agente)
|
|
5. Escribir pruebas en `tests/unit/`
|
|
6. Documentar en la tabla de habilidades en `docs/frameworks/A2A-SERVER.md`
|
|
|
|
### Agregar un Nuevo Agente en la Nube
|
|
|
|
1. Crear clase de agente en `src/lib/cloudAgent/agents/` extendiendo `CloudAgentBase` (ya existen 3: codex-cloud, devin, jules)
|
|
2. Implementar `createTask`, `getStatus`, `approvePlan`, `sendMessage`, `listSources`
|
|
3. Registrar en `src/lib/cloudAgent/registry.ts`
|
|
4. Agregar manejo de OAuth/credenciales si es necesario (`src/lib/oauth/providers/`)
|
|
5. Pruebas + documentar en `docs/frameworks/CLOUD_AGENT.md`
|
|
|
|
### Agregar un Nuevo Guardrail / Eval / Skill / Evento Webhook
|
|
|
|
- Guardrail: `src/lib/guardrails/` → docs: `docs/security/GUARDRAILS.md`
|
|
- Suite de Eval: `src/lib/evals/` → docs: `docs/frameworks/EVALS.md`
|
|
- Skill (sandbox): `src/lib/skills/` → docs: `docs/frameworks/SKILLS.md`
|
|
- Evento Webhook: `src/lib/webhookDispatcher.ts` → docs: `docs/frameworks/WEBHOOKS.md`
|
|
|
|
## Documentación de Referencia
|
|
|
|
Para cualquier cambio no trivial, lee primero el análisis correspondiente:
|
|
|
|
| Área | Doc |
|
|
| ----------------------------------------------------- | ----------------------------------------------------------------- |
|
|
| Navegación del repositorio | `docs/architecture/REPOSITORY_MAP.md` |
|
|
| Arquitectura | `docs/architecture/ARCHITECTURE.md` |
|
|
| Referencia de ingeniería | `docs/architecture/CODEBASE_DOCUMENTATION.md` |
|
|
| Auto-Combo (puntuación de 9 factores, 14 estrategias) | `docs/routing/AUTO-COMBO.md` |
|
|
| Resiliencia (3 mecanismos) | `docs/architecture/RESILIENCE_GUIDE.md` |
|
|
| Repetición de razonamiento | `docs/routing/REASONING_REPLAY.md` |
|
|
| Marco de habilidades | `docs/frameworks/SKILLS.md` |
|
|
| Sistema de memoria (FTS5 + Qdrant) | `docs/frameworks/MEMORY.md` |
|
|
| Agentes en la nube | `docs/frameworks/CLOUD_AGENT.md` |
|
|
| Líneas de protección (PII / inyección / visión) | `docs/security/GUARDRAILS.md` |
|
|
| Credenciales públicas upstream (Gemini/etc.) | `docs/security/PUBLIC_CREDS.md` |
|
|
| Saneamiento de mensajes de error | `docs/security/ERROR_SANITIZATION.md` |
|
|
| Evaluaciones | `docs/frameworks/EVALS.md` |
|
|
| Cumplimiento / auditoría | `docs/security/COMPLIANCE.md` |
|
|
| Webhooks | `docs/frameworks/WEBHOOKS.md` |
|
|
| Pipeline de autorización | `docs/architecture/AUTHZ_GUIDE.md` |
|
|
| Sigilo (TLS / huella digital) | `docs/security/STEALTH_GUIDE.md` |
|
|
| Protocolos de agente (A2A / ACP / Nube) | `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md` |
|
|
| Servidor MCP | `docs/frameworks/MCP-SERVER.md` |
|
|
| Servidor A2A | `docs/frameworks/A2A-SERVER.md` |
|
|
| Referencia de API + OpenAPI | `docs/reference/API_REFERENCE.md` + `docs/reference/openapi.yaml` |
|
|
| Catálogo de proveedores (generado automáticamente) | `docs/reference/PROVIDER_REFERENCE.md` |
|
|
| Flujo de lanzamiento | `docs/ops/RELEASE_CHECKLIST.md` |
|
|
|
|
---
|
|
|
|
## Pruebas
|
|
|
|
| Qué | Comando |
|
|
| ----------------------- | ---------------------------------------------------------------------------- |
|
|
| Pruebas unitarias | `npm run test:unit` |
|
|
| Archivo único | `node --import tsx/esm --test tests/unit/file.test.ts` |
|
|
| Vitest (MCP, autoCombo) | `npm run test:vitest` |
|
|
| E2E (Playwright) | `npm run test:e2e` |
|
|
| Protocolo E2E (MCP+A2A) | `npm run test:protocols:e2e` |
|
|
| Ecosistema | `npm run test:ecosystem` |
|
|
| Puerta de cobertura | `npm run test:coverage` (75/75/75/70 — declaraciones/líneas/funciones/ramas) |
|
|
| Informe de cobertura | `npm run coverage:report` |
|
|
|
|
**Regla de PR**: Si cambias el código de producción en `src/`, `open-sse/`, `electron/`, o `bin/`, debes incluir o actualizar pruebas en el mismo PR.
|
|
|
|
**Preferencia de capa de prueba**: unidad primero → integración (multi-módulo o estado de DB) → e2e (solo UI/workflow). Codifica reproducciones de errores como pruebas automatizadas antes o junto con la solución.
|
|
|
|
**Política de cobertura de Copilot**: Cuando un PR cambia el código de producción y la cobertura está por debajo del 75% (declaraciones/líneas/funciones) o 70% (ramas), no solo informes — agrega o actualiza pruebas, vuelve a ejecutar la puerta de cobertura, luego pide confirmación. Incluye comandos ejecutados, archivos de prueba cambiados y el resultado final de la cobertura en el informe del PR.
|
|
|
|
---
|
|
|
|
## Flujo de trabajo de Git
|
|
|
|
```bash
|
|
# Nunca comites directamente en main
|
|
git checkout -b feat/tu-característica
|
|
git commit -m "feat: describe tu cambio"
|
|
git push -u origin feat/tu-característica
|
|
```
|
|
|
|
**Prefijos de rama**: `feat/`, `fix/`, `refactor/`, `docs/`, `test/`, `chore/`
|
|
|
|
**Formato de commit** (Commits Convencionales): `feat(db): agregar cortacircuito` — ámbitos: `db`, `sse`, `oauth`, `dashboard`, `api`, `cli`, `docker`, `ci`, `mcp`, `a2a`, `memory`, `skills`
|
|
|
|
**Ganchos de Husky**:
|
|
|
|
- **pre-commit**: lint-staged + `check-docs-sync` + `check:any-budget:t11`
|
|
- **pre-push**: `npm run test:unit`
|
|
|
|
---
|
|
|
|
## Entorno
|
|
|
|
- **Tiempo de ejecución**: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25, Módulos ES
|
|
- **TypeScript**: 5.9+, objetivo ES2022, módulo esnext, resolución bundler
|
|
- **Alias de ruta**: `@/*` → `src/`, `@omniroute/open-sse` → `open-sse/`, `@omniroute/open-sse/*` → `open-sse/*`
|
|
- **Puerto predeterminado**: 20128 (API + dashboard en el mismo puerto)
|
|
- **Directorio de datos**: variable de entorno `DATA_DIR`, por defecto `~/.omniroute/`
|
|
- **Variables de entorno clave**: `PORT`, `JWT_SECRET`, `API_KEY_SECRET`, `INITIAL_PASSWORD`, `REQUIRE_API_KEY`, `APP_LOG_LEVEL`
|
|
- Configuración: `cp .env.example .env` luego genera `JWT_SECRET` (`openssl rand -base64 48`) y `API_KEY_SECRET` (`openssl rand -hex 32`)
|
|
|
|
---
|
|
|
|
## Reglas estrictas
|
|
|
|
1. Nunca comites secretos o credenciales
|
|
2. Nunca agregues lógica a `localDb.ts`
|
|
3. Nunca uses `eval()` / `new Function()` / eval implícito
|
|
4. Nunca comites directamente en `main`
|
|
5. Nunca escribas SQL en bruto en rutas — usa módulos de `src/lib/db/`
|
|
6. Nunca tragues errores silenciosamente en flujos SSE
|
|
7. Siempre valida entradas con esquemas Zod
|
|
8. Siempre incluye pruebas al cambiar código de producción
|
|
9. La cobertura debe mantenerse ≥75% (declaraciones, líneas, funciones) / ≥70% (ramas). Medido actualmente: ~82%.
|
|
10. Nunca evadas ganchos de Husky (`--no-verify`, `--no-gpg-sign`) sin aprobación explícita del operador.
|
|
11. Nunca incrustes client_id/secret de OAuth público o claves web de Firebase como literales de cadena — siempre pasa por `resolvePublicCred()` (`open-sse/utils/publicCreds.ts`). Ver `docs/security/PUBLIC_CREDS.md`.
|
|
12. Nunca devuelvas `err.stack` / `err.message` en respuestas HTTP / SSE / ejecutores — siempre enruta a través de `buildErrorBody()` o `sanitizeErrorMessage()` (`open-sse/utils/error.ts`). Ver `docs/security/ERROR_SANITIZATION.md`.
|
|
13. Nunca interpolas cadenas de rutas externas o valores de tiempo de ejecución en scripts de shell pasados a `exec()`/`spawn()` — pasa a través de la opción `env` en su lugar. Referencia: `src/mitm/cert/install.ts::updateNssDatabases`.
|
|
14. Nunca desestimes una alerta de CodeQL / Escaneo de Secretos sin (a) primero verificar la documentación del patrón anterior para ver si el helper se aplica, y (b) registrar la justificación técnica en el comentario de desestimación. Precedente: `js/stack-trace-exposure` planteado en sitios de llamada que ya enrutan a través de `sanitizeErrorMessage()` es una limitación conocida de CodeQL (sanitizadores personalizados no reconocidos) — desestima como `falso positivo` haciendo referencia a `docs/security/ERROR_SANITIZATION.md`.
|
|
15. Nunca expongas rutas que generan procesos secundarios (`/api/mcp/`, `/api/cli-tools/runtime/`) sin clasificación `isLocalOnlyPath()` en `src/server/authz/routeGuard.ts`. La aplicación de loopback ocurre incondicionalmente antes de cualquier verificación de autenticación — un JWT filtrado a través de un túnel no puede activar la generación de procesos. Ver `docs/security/ROUTE_GUARD_TIERS.md`.
|
|
16. Nunca incluyas trailers `Co-Authored-By` que acrediten a un asistente de IA, LLM o cuenta automatizada (p. ej. nombres que contengan "Claude", "GPT", "Copilot", "Bot"; correos en `anthropic.com` / `openai.com` / direcciones `noreply.github.com` propiedad de bots). Tales trailers redirigen la atribución del commit a la cuenta del bot en GitHub, ocultando al autor real (`diegosouzapw`) en el historial del PR. Los colaboradores humanos — incluyendo autores de PRs upstream y reporteros de issues que se portan a OmniRoute — PUEDEN y DEBEN ser acreditados con trailers estándar `Co-authored-by: Name <email>`; los flujos de trabajo de port upstream (`/port-upstream-features`, `/port-upstream-issues`) dependen de esto.
|