mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-04 06:12: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>
416 lines
27 KiB
Markdown
416 lines
27 KiB
Markdown
# CLAUDE.md (Italiano)
|
|
|
|
🌐 **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) · 🇯🇵 [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)
|
|
|
|
---
|
|
|
|
Questo file fornisce indicazioni a Claude Code (claude.ai/code) quando si lavora con il codice in questo repository.
|
|
|
|
## Avvio Veloce
|
|
|
|
```bash
|
|
npm install # Installa le dipendenze (genera automaticamente .env da .env.example)
|
|
npm run dev # Server di sviluppo su http://localhost:20128
|
|
npm run build # Build di produzione (Next.js 16 standalone)
|
|
npm run lint # ESLint (0 errori previsti; avvisi già esistenti)
|
|
npm run typecheck:core # Controllo TypeScript (dovrebbe essere pulito)
|
|
npm run typecheck:noimplicit:core # Controllo rigoroso (nessun implicit any)
|
|
npm run test:coverage # Test unitari + gate di copertura (75/75/75/70 — dichiarazioni/righe/funzioni/rami)
|
|
npm run check # lint + test combinati
|
|
npm run check:cycles # Rileva dipendenze circolari
|
|
```
|
|
|
|
### Esecuzione dei Test
|
|
|
|
```bash
|
|
# Singolo file di test (runner di test nativo di Node.js — la maggior parte dei test)
|
|
node --import tsx/esm --test tests/unit/your-file.test.ts
|
|
|
|
# Vitest (server MCP, autoCombo, cache)
|
|
npm run test:vitest
|
|
|
|
# Tutti i suite
|
|
npm run test:all
|
|
```
|
|
|
|
Per la matrice completa dei test, vedere `CONTRIBUTING.md` → "Esecuzione dei Test". Per un'architettura approfondita, vedere `AGENTS.md`.
|
|
|
|
---
|
|
|
|
## Progetto a Colpo d'Occhio
|
|
|
|
**OmniRoute** — proxy/router AI unificato. Un endpoint, oltre 160 fornitori di LLM, fallback automatico.
|
|
|
|
| Livello | Posizione | Scopo |
|
|
| ------------- | ----------------------- | ----------------------------------------------------------------------- |
|
|
| API Routes | `src/app/api/v1/` | Next.js App Router — punti di ingresso |
|
|
| Handlers | `open-sse/handlers/` | Elaborazione delle richieste (chat, embeddings, ecc.) |
|
|
| Executors | `open-sse/executors/` | Dispatch HTTP specifico per fornitore |
|
|
| Translators | `open-sse/translator/` | Conversione di formato (OpenAI↔Claude↔Gemini) |
|
|
| Transformer | `open-sse/transformer/` | API delle risposte ↔ Completamenti Chat |
|
|
| Services | `open-sse/services/` | Routing combinato, limiti di velocità, caching, ecc. |
|
|
| Database | `src/lib/db/` | Moduli di dominio SQLite (oltre 45 file, 55 migrazioni) |
|
|
| Domain/Policy | `src/domain/` | Motore di policy, regole di costo, logica di fallback |
|
|
| MCP Server | `open-sse/mcp-server/` | 37 strumenti (30 base + 3 memoria + 4 abilità), 3 trasporti, ~13 ambiti |
|
|
| A2A Server | `src/lib/a2a/` | Protocollo agente JSON-RPC 2.0 |
|
|
| Skills | `src/lib/skills/` | Framework di abilità estensibile |
|
|
| Memory | `src/lib/memory/` | Memoria conversazionale persistente |
|
|
|
|
Monorepo: `src/` (app Next.js 16), `open-sse/` (workspace del motore di streaming), `electron/` (app desktop), `tests/`, `bin/` (punto di ingresso CLI).
|
|
|
|
---
|
|
|
|
## Pipeline di Richiesta
|
|
|
|
```
|
|
Client → /v1/chat/completions (rotta Next.js)
|
|
→ CORS → validazione Zod → auth? → controllo della policy → guardia contro l'iniezione del prompt
|
|
→ handleChatCore() [open-sse/handlers/chatCore.ts]
|
|
→ controllo cache → limite di frequenza → routing combo?
|
|
→ resolveComboTargets() → handleSingleModel() per target
|
|
→ translateRequest() → getExecutor() → executor.execute()
|
|
→ fetch() upstream → retry w/ backoff
|
|
→ traduzione della risposta → stream SSE o JSON
|
|
→ Se Responses API: responsesTransformer.ts TransformStream
|
|
```
|
|
|
|
Le rotte API seguono uno schema coerente: `Roatta → preflight CORS → validazione del corpo Zod → Auth opzionale (extractApiKey/isValidApiKey) → applicazione della policy della chiave API → delega del gestore (open-sse)`. Nessun middleware globale di Next.js — l'intercettazione è specifica per rotta.
|
|
|
|
**Routing combo** (`open-sse/services/combo.ts`): 14 strategie (priorità, ponderato, riempi-primo, round-robin, P2C, casuale, meno-utilizzato, ottimizzato per costo, consapevole del reset, rigorosamente-casuale, auto, lkgp, ottimizzato per contesto, relay di contesto). Ogni target chiama `handleSingleModel()` che avvolge `handleChatCore()` con gestione degli errori per target e controlli del circuito. Vedi `docs/routing/AUTO-COMBO.md` per il punteggio Auto-Combo a 9 fattori e `docs/architecture/RESILIENCE_GUIDE.md` per i 3 livelli di resilienza.
|
|
|
|
---
|
|
|
|
## Stato di Esecuzione della Resilienza
|
|
|
|
OmniRoute ha tre meccanismi di guasto temporaneo correlati ma distinti. Mantieni il loro
|
|
ambito separato durante il debug del comportamento di routing. Vedi il
|
|
[diagramma di resilienza a 3 livelli](./docs/diagrams/exported/resilience-3layers.svg)
|
|
(fonte: [docs/diagrams/resilience-3layers.mmd](./docs/diagrams/resilience-3layers.mmd))
|
|
per una mappa a colpo d'occhio.
|
|
|
|
### Interruttore di Circuito del Fornitore
|
|
|
|
**Ambito**: intero fornitore, ad esempio `glm`, `openai`, `anthropic`.
|
|
|
|
**Scopo**: fermare l'invio di traffico a un fornitore che sta ripetutamente fallendo a livello
|
|
upstream/servizio, in modo che un fornitore non sano non rallenti ogni richiesta.
|
|
|
|
**Implementazione**:
|
|
|
|
- Classe principale: `src/shared/utils/circuitBreaker.ts`
|
|
- Cablaggio di gate/esecuzione chat: `src/sse/handlers/chatHelpers.ts`, `src/sse/handlers/chat.ts`
|
|
- API di stato di esecuzione: `src/app/api/monitoring/health/route.ts`
|
|
- Wrapper condivisi: `open-sse/services/accountFallback.ts`
|
|
- Tabella di stato persistente: `domain_circuit_breakers`
|
|
|
|
**Stati**:
|
|
|
|
- `CLOSED`: il traffico normale è consentito.
|
|
- `OPEN`: il fornitore è temporaneamente bloccato; i chiamanti ricevono una risposta di circuito-fornitore-aperto
|
|
oppure il routing combo salta a un altro target.
|
|
- `HALF_OPEN`: il timeout di reset è scaduto; consenti una richiesta di probe. Il successo chiude il
|
|
circuito, il fallimento lo riapre.
|
|
|
|
**Predefiniti** (`open-sse/config/constants.ts`):
|
|
|
|
- Fornitori OAuth: soglia `3`, timeout di reset `60s`.
|
|
- Fornitori di chiavi API: soglia `5`, timeout di reset `30s`.
|
|
- Fornitori locali: soglia `2`, timeout di reset `15s`.
|
|
|
|
Solo gli stati di fallimento a livello di fornitore dovrebbero attivare l'interruttore del fornitore:
|
|
|
|
```ts
|
|
(408, 500, 502, 503, 504);
|
|
```
|
|
|
|
Non attivare l'interruttore dell'intero fornitore per errori normali di account/chiave/modello come la maggior parte
|
|
dei casi `401`, `403`, o `429`. Questi di solito appartengono a cooldown di connessione o lockout del modello. Un generico errore `403` del fornitore di chiavi API dovrebbe essere recuperabile a meno che non sia classificato
|
|
come errore terminale di fornitore/account.
|
|
|
|
L'interruttore utilizza un recupero pigro, non un timer in background. Quando `OPEN` scade, letture come
|
|
`getStatus()`, `canExecute()`, e `getRetryAfterMs()` aggiornano lo stato a
|
|
`HALF_OPEN`, in modo che i dashboard e i costruttori di candidati combo non continuino a escludere un
|
|
fornitore scaduto per sempre.
|
|
|
|
### Cooldown di Connessione
|
|
|
|
**Ambito**: una connessione/account/chiave del fornitore.
|
|
|
|
**Scopo**: saltare temporaneamente una chiave/account difettosa consentendo ad altre connessioni per
|
|
lo stesso fornitore di continuare a servire richieste.
|
|
|
|
**Implementazione**:
|
|
|
|
- Percorso di scrittura/aggiornamento: `src/sse/services/auth.ts::markAccountUnavailable()`
|
|
- Selezione/filtraggio dell'account: `src/sse/services/auth.ts::getProviderCredentials...`
|
|
- Calcolo del cooldown: `open-sse/services/accountFallback.ts::checkFallbackError()`
|
|
- Impostazioni: `src/lib/resilience/settings.ts`
|
|
|
|
Campi importanti sulle connessioni del fornitore:
|
|
|
|
```ts
|
|
rateLimitedUntil;
|
|
testStatus: "unavailable";
|
|
lastError;
|
|
lastErrorType;
|
|
errorCode;
|
|
backoffLevel;
|
|
```
|
|
|
|
Durante la selezione dell'account, una connessione viene saltata mentre:
|
|
|
|
```ts
|
|
new Date(rateLimitedUntil).getTime() > Date.now();
|
|
```
|
|
|
|
I cooldown sono anche pigri: quando `rateLimitedUntil` è nel passato, la connessione diventa
|
|
nuovamente idonea. All'uso riuscito, `clearAccountError()` cancella `testStatus`,
|
|
`rateLimitedUntil`, campi di errore e `backoffLevel`.
|
|
|
|
Comportamento predefinito del cooldown di connessione:
|
|
|
|
- Cooldown base OAuth: `5s`.
|
|
- Cooldown base per chiavi API: `3s`.
|
|
- `429` per chiavi API dovrebbe preferire suggerimenti di retry upstream (`Retry-After`, intestazioni di reset, o
|
|
testo di reset analizzabile) quando disponibili.
|
|
- Fallimenti recuperabili ripetuti utilizzano un backoff esponenziale:
|
|
|
|
```ts
|
|
baseCooldownMs * 2 ** failureIndex;
|
|
```
|
|
|
|
La guardia anti-thundering-herd previene fallimenti concorrenti sulla stessa connessione da
|
|
estendere ripetutamente il cooldown o incrementare doppiamente `backoffLevel`.
|
|
|
|
Gli stati terminali non sono cooldown. `banned`, `expired`, e `credits_exhausted` sono
|
|
destinati a rimanere non disponibili fino a quando le credenziali/impostazioni non cambiano o un operatore le ripristina.
|
|
Non sovrascrivere stati terminali con stati di cooldown transitori.
|
|
|
|
### Lockout del Modello
|
|
|
|
**Ambito**: fornitore + connessione + modello.
|
|
|
|
**Scopo**: evitare di disabilitare un'intera connessione quando solo un modello è non disponibile o
|
|
limitato per quota per quella connessione.
|
|
|
|
Esempi:
|
|
|
|
- Fornitori per quota per modello che restituiscono `429`.
|
|
- Fornitori locali che restituiscono `404` per un modello mancante.
|
|
- Fallimenti di permesso di modalità/modello specifici del fornitore come le modalità Grok selezionate.
|
|
|
|
Il lockout del modello vive in `open-sse/services/accountFallback.ts` e consente alla stessa
|
|
connessione di continuare a servire altri modelli.
|
|
|
|
### Guida al Debugging
|
|
|
|
- Se tutte le chiavi per un fornitore vengono saltate, ispeziona sia lo stato dell'interruttore del fornitore che `rateLimitedUntil`/`testStatus` di ciascuna connessione.
|
|
- Se un fornitore appare permanentemente escluso dopo la finestra di reset, controlla se il codice
|
|
sta leggendo lo stato grezzo invece di utilizzare `getStatus()`/`canExecute()`.
|
|
- Se una chiave di fornitore fallisce ma altre dovrebbero funzionare, preferisci il cooldown di connessione rispetto
|
|
all'interruttore del fornitore.
|
|
- Se solo un modello fallisce, preferisci il lockout del modello rispetto al cooldown di connessione.
|
|
- Se uno stato dovrebbe auto-recuperarsi, dovrebbe avere un timestamp futuro/timeout di reset e un
|
|
percorso di lettura che aggiorna lo stato scaduto. Gli stati permanenti richiedono modifiche manuali alle credenziali
|
|
o alla configurazione.
|
|
|
|
## Convenzioni Chiave
|
|
|
|
### Stile di Codice
|
|
|
|
- **2 spazi**, punti e virgola, virgolette doppie, larghezza 100 caratteri, virgole finali es5 (imposte da lint-staged tramite Prettier)
|
|
- **Importazioni**: esterne → interne (`@/`, `@omniroute/open-sse`) → relative
|
|
- **Nomenclatura**: file=camelCase/kebab, componenti=PascalCase, costanti=UPPER_SNAKE
|
|
- **ESLint**: `no-eval`, `no-implied-eval`, `no-new-func` = errore ovunque; `no-explicit-any` = avviso in `open-sse/` e `tests/`
|
|
- **TypeScript**: `strict: false`, target ES2022, modulo esnext, risoluzione bundler. Preferire tipi espliciti.
|
|
|
|
### Database
|
|
|
|
- **Sempre** passare attraverso i moduli di dominio `src/lib/db/` — **mai** scrivere SQL raw in rotte o gestori
|
|
- **Mai** aggiungere logica a `src/lib/localDb.ts` (solo livello di re-export)
|
|
- **Mai** importare a barre da `localDb.ts` — importare invece moduli specifici `db/`
|
|
- Singleton DB: `getDbInstance()` da `src/lib/db/core.ts` (journaling WAL)
|
|
- Migrazioni: `src/lib/db/migrations/` — file SQL versionati, idempotenti, eseguiti in transazioni
|
|
|
|
### Gestione degli Errori
|
|
|
|
- try/catch con tipi di errore specifici, log con contesto pino
|
|
- Non nascondere errori nei flussi SSE — utilizzare segnali di abort per la pulizia
|
|
- Restituire codici di stato HTTP appropriati (4xx/5xx)
|
|
|
|
### Sicurezza
|
|
|
|
- **Mai** usare `eval()`, `new Function()`, o eval implicito
|
|
- Validare tutti gli input con schemi Zod
|
|
- Crittografare le credenziali a riposo (AES-256-GCM)
|
|
- Denylist degli header upstream: `src/shared/constants/upstreamHeaders.ts` — mantenere sanitizzazione, schemi Zod e test unitari allineati durante la modifica
|
|
- **Credenziali pubbliche upstream** (client_id/secret OAuth stile Gemini/Antigravity/Windsurf + chiavi Web Firebase estratte da CLI pubblici): **DEVONO** essere incorporate tramite `resolvePublicCred()` da `open-sse/utils/publicCreds.ts` — **mai** come stringhe letterali. Vedi `docs/security/PUBLIC_CREDS.md` per il modello obbligatorio.
|
|
- **Risposte di errore** (HTTP / SSE / gestore executor / gestore MCP): **DEVONO** passare attraverso `buildErrorBody()` o `sanitizeErrorMessage()` da `open-sse/utils/error.ts` — **mai** mettere `err.stack` o `err.message` raw nel corpo della risposta. Vedi `docs/security/ERROR_SANITIZATION.md`.
|
|
- **Comandi shell costruiti da variabili**: quando si chiama `exec()`/`spawn()` con uno script che necessita di valori di runtime, passarli tramite l'opzione `env` (automaticamente shell-escaped) — **mai** interpolare stringhe percorsi non fidati/esterni nel corpo dello script. Riferimento: `src/mitm/cert/install.ts::updateNssDatabases`.
|
|
- **Librerie sicure per impostazione predefinita** ([tldrsec/awesome-secure-defaults](https://github.com/tldrsec/awesome-secure-defaults)): preferire Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink rispetto a implementazioni personalizzate ogni volta che si aggiungono nuove superfici sensibili alla sicurezza.
|
|
|
|
---
|
|
|
|
## Scenari Comuni di Modifica
|
|
|
|
### Aggiungere un Nuovo Fornitore
|
|
|
|
1. Registrare in `src/shared/constants/providers.ts` (validato da Zod al caricamento)
|
|
2. Aggiungere executor in `open-sse/executors/` se necessaria logica personalizzata (estendere `BaseExecutor`)
|
|
3. Aggiungere traduttore in `open-sse/translator/` se formato non OpenAI
|
|
4. Aggiungere configurazione OAuth in `src/lib/oauth/constants/oauth.ts` se basato su OAuth — se il CLI upstream fornisce un client_id/secret pubblico, incorporare tramite `resolvePublicCred()` (vedi `docs/security/PUBLIC_CREDS.md`), **mai** come letterale
|
|
5. Registrare modelli in `open-sse/config/providerRegistry.ts`
|
|
6. Scrivere test in `tests/unit/` (includere l'asserzione della forma publicCreds se hai aggiunto un nuovo default incorporato)
|
|
|
|
### Aggiungere una Nuova Rotta API
|
|
|
|
1. Creare directory sotto `src/app/api/v1/your-route/`
|
|
2. Creare `route.ts` con gestori `GET`/`POST`
|
|
3. Seguire il modello: CORS → validazione del corpo Zod → auth opzionale → delega del gestore
|
|
4. Il gestore va in `open-sse/handlers/` (importare da lì, non inline)
|
|
5. Le risposte di errore utilizzano `buildErrorBody()` / `errorResponse()` da `open-sse/utils/error.ts` (auto-sanitizzate — non mettere `err.stack` o `err.message` raw nel corpo). Vedi `docs/security/ERROR_SANITIZATION.md`.
|
|
6. Aggiungere test — includendo almeno un'asserzione che le risposte di errore non rivelino tracce di stack (`!body.error.message.includes("at /")`)
|
|
|
|
### Aggiungere un Nuovo Modulo DB
|
|
|
|
1. Creare `src/lib/db/yourModule.ts` — importare `getDbInstance` da `./core.ts`
|
|
2. Esportare funzioni CRUD per la tua tabella di dominio
|
|
3. Aggiungere migrazione in `src/lib/db/migrations/` se necessarie nuove tabelle
|
|
4. Re-esportare da `src/lib/localDb.ts` (aggiungere solo all'elenco di re-export)
|
|
5. Scrivere test
|
|
|
|
### Aggiungere un Nuovo Strumento MCP
|
|
|
|
1. Aggiungere definizione dello strumento in `open-sse/mcp-server/tools/` con schema di input Zod + gestore async
|
|
2. Registrare nel set di strumenti (collegato da `createMcpServer()`)
|
|
3. Assegnare agli ambiti appropriati
|
|
4. Scrivere test (invocazione dello strumento registrata nella tabella `mcp_audit`)
|
|
|
|
### Aggiungere una Nuova Abilità A2A
|
|
|
|
1. Creare abilità in `src/lib/a2a/skills/` (5 già esistenti: smart-routing, quota-management, provider-discovery, cost-analysis, health-report)
|
|
2. L'abilità riceve il contesto del compito (messaggi, metadati) → restituisce un risultato strutturato
|
|
3. Registrare in `A2A_SKILL_HANDLERS` in `src/lib/a2a/taskExecution.ts`
|
|
4. Esporre in `src/app/.well-known/agent.json/route.ts` (Agent Card)
|
|
5. Scrivere test in `tests/unit/`
|
|
6. Documentare nella tabella delle abilità in `docs/frameworks/A2A-SERVER.md`
|
|
|
|
### Aggiungere un Nuovo Agente Cloud
|
|
|
|
1. Creare classe agente in `src/lib/cloudAgent/agents/` estendendo `CloudAgentBase` (3 già esistenti: codex-cloud, devin, jules)
|
|
2. Implementare `createTask`, `getStatus`, `approvePlan`, `sendMessage`, `listSources`
|
|
3. Registrare in `src/lib/cloudAgent/registry.ts`
|
|
4. Aggiungere gestione OAuth/credenziali se necessario (`src/lib/oauth/providers/`)
|
|
5. Test + documentare in `docs/frameworks/CLOUD_AGENT.md`
|
|
|
|
### Aggiungere un Nuovo Guardrail / Eval / Abilità / Evento Webhook
|
|
|
|
- Guardrail: `src/lib/guardrails/` → documenti: `docs/security/GUARDRAILS.md`
|
|
- Suite Eval: `src/lib/evals/` → documenti: `docs/frameworks/EVALS.md`
|
|
- Abilità (sandbox): `src/lib/skills/` → documenti: `docs/frameworks/SKILLS.md`
|
|
- Evento Webhook: `src/lib/webhookDispatcher.ts` → documenti: `docs/frameworks/WEBHOOKS.md`
|
|
|
|
## Documentazione di Riferimento
|
|
|
|
Per qualsiasi modifica non banale, leggi prima il documento di approfondimento corrispondente:
|
|
|
|
| Area | Documento |
|
|
| ------------------------------------------------- | ----------------------------------------------------------------- |
|
|
| Navigazione del repository | `docs/architecture/REPOSITORY_MAP.md` |
|
|
| Architettura | `docs/architecture/ARCHITECTURE.md` |
|
|
| Riferimento ingegneristico | `docs/architecture/CODEBASE_DOCUMENTATION.md` |
|
|
| Auto-Combo (scoring a 9 fattori, 14 strategie) | `docs/routing/AUTO-COMBO.md` |
|
|
| Resilienza (3 meccanismi) | `docs/architecture/RESILIENCE_GUIDE.md` |
|
|
| Riproduzione del ragionamento | `docs/routing/REASONING_REPLAY.md` |
|
|
| Framework delle competenze | `docs/frameworks/SKILLS.md` |
|
|
| Sistema di memoria (FTS5 + Qdrant) | `docs/frameworks/MEMORY.md` |
|
|
| Agenti cloud | `docs/frameworks/CLOUD_AGENT.md` |
|
|
| Guardrail (PII / injection / visione) | `docs/security/GUARDRAILS.md` |
|
|
| Credenziali pubbliche upstream (Gemini/ecc.) | `docs/security/PUBLIC_CREDS.md` |
|
|
| Sanitizzazione dei messaggi di errore | `docs/security/ERROR_SANITIZATION.md` |
|
|
| Valutazioni | `docs/frameworks/EVALS.md` |
|
|
| Conformità / audit | `docs/security/COMPLIANCE.md` |
|
|
| Webhook | `docs/frameworks/WEBHOOKS.md` |
|
|
| Pipeline di autorizzazione | `docs/architecture/AUTHZ_GUIDE.md` |
|
|
| Stealth (TLS / impronta digitale) | `docs/security/STEALTH_GUIDE.md` |
|
|
| Protocolli degli agenti (A2A / ACP / Cloud) | `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md` |
|
|
| Server MCP | `docs/frameworks/MCP-SERVER.md` |
|
|
| Server A2A | `docs/frameworks/A2A-SERVER.md` |
|
|
| Riferimento API + OpenAPI | `docs/reference/API_REFERENCE.md` + `docs/reference/openapi.yaml` |
|
|
| Catalogo dei fornitori (generato automaticamente) | `docs/reference/PROVIDER_REFERENCE.md` |
|
|
| Flusso di rilascio | `docs/ops/RELEASE_CHECKLIST.md` |
|
|
|
|
---
|
|
|
|
## Test
|
|
|
|
| Cosa | Comando |
|
|
| ----------------------- | ------------------------------------------------------------------------- |
|
|
| Test unitari | `npm run test:unit` |
|
|
| Singolo file | `node --import tsx/esm --test tests/unit/file.test.ts` |
|
|
| Vitest (MCP, autoCombo) | `npm run test:vitest` |
|
|
| E2E (Playwright) | `npm run test:e2e` |
|
|
| Protocol E2E (MCP+A2A) | `npm run test:protocols:e2e` |
|
|
| Ecosistema | `npm run test:ecosystem` |
|
|
| Porta di copertura | `npm run test:coverage` (75/75/75/70 — dichiarazioni/righe/funzioni/rami) |
|
|
| Rapporto di copertura | `npm run coverage:report` |
|
|
|
|
**Regola PR**: Se modifichi il codice di produzione in `src/`, `open-sse/`, `electron/`, o `bin/`, devi includere o aggiornare i test nella stessa PR.
|
|
|
|
**Preferenza per il livello di test**: unità prima → integrazione (multi-modulo o stato DB) → e2e (solo UI/flusso di lavoro). Codifica le riproduzioni di bug come test automatizzati prima o insieme alla correzione.
|
|
|
|
**Politica di copertura di Copilot**: Quando una PR modifica il codice di produzione e la copertura è inferiore al 75% (dichiarazioni/righe/funzioni) o al 70% (rami), non limitarti a segnalare — aggiungi o aggiorna i test, riesegui la porta di copertura, poi chiedi conferma. Includi i comandi eseguiti, i file di test modificati e il risultato finale della copertura nel rapporto PR.
|
|
|
|
---
|
|
|
|
## Flusso di lavoro Git
|
|
|
|
```bash
|
|
# Non impegnarti mai direttamente su main
|
|
git checkout -b feat/your-feature
|
|
git commit -m "feat: descrivi la tua modifica"
|
|
git push -u origin feat/your-feature
|
|
```
|
|
|
|
**Prefissi dei branch**: `feat/`, `fix/`, `refactor/`, `docs/`, `test/`, `chore/`
|
|
|
|
**Formato del commit** (Conventional Commits): `feat(db): aggiungi circuit breaker` — scope: `db`, `sse`, `oauth`, `dashboard`, `api`, `cli`, `docker`, `ci`, `mcp`, `a2a`, `memory`, `skills`
|
|
|
|
**Hook di Husky**:
|
|
|
|
- **pre-commit**: lint-staged + `check-docs-sync` + `check:any-budget:t11`
|
|
- **pre-push**: `npm run test:unit`
|
|
|
|
---
|
|
|
|
## Ambiente
|
|
|
|
- **Runtime**: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25, ES Modules
|
|
- **TypeScript**: 5.9+, target ES2022, module esnext, risoluzione bundler
|
|
- **Alias di percorso**: `@/*` → `src/`, `@omniroute/open-sse` → `open-sse/`, `@omniroute/open-sse/*` → `open-sse/*`
|
|
- **Porta predefinita**: 20128 (API + dashboard sulla stessa porta)
|
|
- **Directory dei dati**: variabile d'ambiente `DATA_DIR`, predefinita a `~/.omniroute/`
|
|
- **Variabili d'ambiente chiave**: `PORT`, `JWT_SECRET`, `API_KEY_SECRET`, `INITIAL_PASSWORD`, `REQUIRE_API_KEY`, `APP_LOG_LEVEL`
|
|
- Configurazione: `cp .env.example .env` poi genera `JWT_SECRET` (`openssl rand -base64 48`) e `API_KEY_SECRET` (`openssl rand -hex 32`)
|
|
|
|
---
|
|
|
|
## Regole Rigide
|
|
|
|
1. Non impegnare mai segreti o credenziali
|
|
2. Non aggiungere mai logica a `localDb.ts`
|
|
3. Non usare mai `eval()` / `new Function()` / eval implicito
|
|
4. Non impegnarsi mai direttamente su `main`
|
|
5. Non scrivere mai SQL raw nelle route — usa i moduli in `src/lib/db/`
|
|
6. Non ignorare mai silenziosamente gli errori nei flussi SSE
|
|
7. Validare sempre gli input con gli schemi Zod
|
|
8. Includere sempre test quando si modifica il codice di produzione
|
|
9. La copertura deve rimanere ≥75% (dichiarazioni, righe, funzioni) / ≥70% (rami). Misurato attualmente: ~82%.
|
|
10. Non bypassare mai gli hook di Husky (`--no-verify`, `--no-gpg-sign`) senza esplicita approvazione dell'operatore.
|
|
11. Non incorporare mai client_id/secret OAuth pubblici upstream o chiavi Web Firebase come stringhe letterali — passare sempre attraverso `resolvePublicCred()` (`open-sse/utils/publicCreds.ts`). Vedi `docs/security/PUBLIC_CREDS.md`.
|
|
12. Non restituire mai `err.stack` / `err.message` raw nelle risposte HTTP / SSE / executor — instradare sempre attraverso `buildErrorBody()` o `sanitizeErrorMessage()` (`open-sse/utils/error.ts`). Vedi `docs/security/ERROR_SANITIZATION.md`.
|
|
13. Non interpolare mai stringhe percorsi esterni o valori di runtime in script shell passati a `exec()`/`spawn()` — passare invece tramite l'opzione `env`. Riferimento: `src/mitm/cert/install.ts::updateNssDatabases`.
|
|
14. Non ignorare mai un avviso CodeQL / Secret-Scanning senza (a) controllare prima la documentazione del pattern sopra per vedere se l'aiuto si applica, e (b) registrare la giustificazione tecnica nel commento di dismissione. Precedente: `js/stack-trace-exposure` sollevato su callsites che già instradano attraverso `sanitizeErrorMessage()` è una limitazione nota di CodeQL (sanitizzatori personalizzati non riconosciuti) — dismettere come `false positive` facendo riferimento a `docs/security/ERROR_SANITIZATION.md`.
|
|
15. Non esporre mai route che generano processi figlio (`/api/mcp/`, `/api/cli-tools/runtime/`) senza classificazione `isLocalOnlyPath()` in `src/server/authz/routeGuard.ts`. L'applicazione del loopback avviene incondizionatamente prima di qualsiasi controllo di autenticazione — un JWT trapelato tramite tunnel non può attivare la generazione di processi. Vedi `docs/security/ROUTE_GUARD_TIERS.md`.
|
|
16. Non includere mai trailer `Co-Authored-By` che accreditano un assistente AI, LLM o account di automazione (es. nomi contenenti "Claude", "GPT", "Copilot", "Bot"; email su `anthropic.com` / `openai.com` / indirizzi `noreply.github.com` di proprietà di bot). Tali trailer indirizzano l'attribuzione del commit all'account del bot su GitHub, nascondendo l'autore reale (`diegosouzapw`) nella cronologia della PR. I collaboratori umani — inclusi gli autori di PR upstream e i segnalatori di issue portati in OmniRoute — POSSONO e DEVONO essere accreditati con trailer standard `Co-authored-by: Name <email>`; i workflow di port upstream (`/port-upstream-features`, `/port-upstream-issues`) ne dipendono.
|