Files
OmniRoute/docs/i18n/ar/CLAUDE.md
Diego Rodrigues de Sa e Souza f59f8daa94 Release v3.8.6 (#2804)
* 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>
2026-05-29 12:44:29 -03:00

33 KiB

CLAUDE.md (العربية)

🌐 Languages: 🇺🇸 English · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇪🇸 es · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇳 gu · 🇮🇱 he · 🇮🇳 hi · 🇭🇺 hu · 🇮🇩 id · 🇮🇩 in · 🇮🇹 it · 🇯🇵 ja · 🇰🇷 ko · 🇮🇳 mr · 🇲🇾 ms · 🇳🇱 nl · 🇳🇴 no · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇸🇰 sk · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇻🇳 vi · 🇨🇳 zh-CN


هذا الملف يوفر إرشادات لـ Claude Code (claude.ai/code) عند العمل مع الكود في هذا المستودع.

البداية السريعة

npm install                    # تثبيت التبعيات (توليد .env تلقائيًا من .env.example)
npm run dev                    # خادم التطوير على http://localhost:20128
npm run build                  # بناء الإنتاج (Next.js 16 مستقل)
npm run lint                   # ESLint (0 أخطاء متوقعة؛ التحذيرات موجودة مسبقًا)
npm run typecheck:core         # فحص TypeScript (يجب أن يكون نظيفًا)
npm run typecheck:noimplicit:core  # فحص صارم (لا أي ضمني)
npm run test:coverage          # اختبارات الوحدة + بوابة التغطية (75/75/75/70 — العبارات/الأسطر/الدوال/الفروع)
npm run check                  # lint + اختبار مجتمعة
npm run check:cycles           # اكتشاف الاعتماديات الدائرية

تشغيل الاختبارات

# ملف اختبار فردي (جهاز اختبار Node.js الأصلي — معظم الاختبارات)
node --import tsx/esm --test tests/unit/your-file.test.ts

# Vitest (خادم MCP، autoCombo، ذاكرة التخزين المؤقت)
npm run test:vitest

# جميع المجموعات
npm run test:all

للحصول على مصفوفة الاختبار الكاملة، راجع CONTRIBUTING.md → "تشغيل الاختبارات". للحصول على بنية عميقة، راجع AGENTS.md.


نظرة عامة على المشروع

OmniRoute — وكيل/موجه AI موحد. نقطة نهاية واحدة، أكثر من 160 مزود LLM، تراجع تلقائي.

الطبقة الموقع الغرض
مسارات API src/app/api/v1/ موجه تطبيق Next.js — نقاط الدخول
المعالجات open-sse/handlers/ معالجة الطلبات (الدردشة، التضمينات، إلخ)
المنفذون open-sse/executors/ إرسال HTTP محدد لمزود الخدمة
المترجمون open-sse/translator/ تحويل التنسيق (OpenAI↔Claude↔Gemini)
المحول open-sse/transformer/ واجهات برمجة التطبيقات للردود ↔ إكمالات الدردشة
الخدمات open-sse/services/ توجيه مجموعة، حدود المعدل، التخزين المؤقت، إلخ
قاعدة البيانات src/lib/db/ وحدات مجال SQLite (أكثر من 45 ملف، 55 ترحيل)
المجال/السياسة src/domain/ محرك السياسة، قواعد التكلفة، منطق التراجع
خادم MCP open-sse/mcp-server/ 37 أداة (30 قاعدة + 3 ذاكرة + 4 مهارات)، 3 وسائل نقل، ~13 نطاقات
خادم A2A src/lib/a2a/ بروتوكول وكيل JSON-RPC 2.0
المهارات src/lib/skills/ إطار عمل مهارات قابل للتوسيع
الذاكرة src/lib/memory/ ذاكرة محادثة دائمة

Monorepo: src/ (تطبيق Next.js 16)، open-sse/ (مساحة عمل محرك البث)، electron/ (تطبيق سطح المكتب)، tests/، bin/ (نقطة دخول CLI).


خط أنابيب الطلب

العميل → /v1/chat/completions (مسار Next.js)
  → CORS → تحقق Zod → مصادقة؟ → فحص السياسة → حماية حقن المطالبات
  → handleChatCore() [open-sse/handlers/chatCore.ts]
    → تحقق من التخزين المؤقت → حد معدل الطلبات → توجيه مجموعة؟
      → resolveComboTargets() → handleSingleModel() لكل هدف
    → translateRequest() → getExecutor() → executor.execute()
      → fetch() upstream → إعادة المحاولة مع التراجع
    → ترجمة الاستجابة → تدفق SSE أو JSON
    → إذا كانت واجهة برمجة التطبيقات Responses: responsesTransformer.ts TransformStream

تتبع مسارات واجهة برمجة التطبيقات نمطًا متسقًا: Route → CORS preflight → Zod body validation → مصادقة اختيارية (extractApiKey/isValidApiKey) → تنفيذ سياسة مفتاح واجهة برمجة التطبيقات → تفويض المعالج (open-sse). لا توجد وسائط عالمية لـ Next.js — الاعتراض خاص بالمسار.

توجيه المجموعة (open-sse/services/combo.ts): 14 استراتيجية (الأولوية، الوزن، ملء أولاً، التناوب، P2C، عشوائي، الأقل استخدامًا، الأمثل من حيث التكلفة، الواعي بإعادة التعيين، عشوائي صارم، تلقائي، lkgp، الأمثل من حيث السياق، نقل السياق). كل هدف يستدعي handleSingleModel() الذي يلف handleChatCore() مع معالجة الأخطاء الخاصة بكل هدف وفحوصات قاطع الدائرة. راجع docs/routing/AUTO-COMBO.md لتسجيل 9 عوامل Auto-Combo و docs/architecture/RESILIENCE_GUIDE.md للطبقات الثلاث من المرونة.


حالة وقت التشغيل للمرونة

يمتلك OmniRoute ثلاث آليات فشل مؤقتة مرتبطة ولكن متميزة. حافظ على نطاقها منفصلًا عند تصحيح سلوك التوجيه. راجع مخطط المرونة ذو 3 طبقات (المصدر: docs/diagrams/resilience-3layers.mmd) لخريطة سريعة.

قاطع دائرة المزود

النطاق: المزود بالكامل، مثل glm، openai، anthropic.

الغرض: إيقاف إرسال الحركة إلى مزود يفشل بشكل متكرر على مستوى الخدمة/التيار، حتى لا يؤدي مزود غير صحي إلى إبطاء كل طلب.

التنفيذ:

  • الفئة الأساسية: src/shared/utils/circuitBreaker.ts
  • توصيل بوابة الدردشة/التنفيذ: src/sse/handlers/chatHelpers.ts، src/sse/handlers/chat.ts
  • واجهة برمجة التطبيقات لحالة وقت التشغيل: src/app/api/monitoring/health/route.ts
  • الأغطية المشتركة: open-sse/services/accountFallback.ts
  • جدول الحالة المستمرة: domain_circuit_breakers

الحالات:

  • CLOSED: يُسمح بحركة المرور العادية.
  • OPEN: تم حظر المزود مؤقتًا؛ يحصل المتصلون على استجابة قاطع دائرة المزود مفتوح أو يتخطى توجيه المجموعة إلى هدف آخر.
  • HALF_OPEN: انتهت مهلة إعادة التعيين؛ يسمح بطلب اختبار. النجاح يغلق القاطع، والفشل يفتحه مرة أخرى.

الإعدادات الافتراضية (open-sse/config/constants.ts):

  • مزودو OAuth: العتبة 3، مهلة إعادة التعيين 60s.
  • مزودو مفتاح واجهة برمجة التطبيقات: العتبة 5، مهلة إعادة التعيين 30s.
  • المزودون المحليون: العتبة 2، مهلة إعادة التعيين 15s.

يجب أن تؤدي حالات الفشل على مستوى المزود فقط إلى تفعيل قاطع المزود:

(408, 500, 502, 503, 504);

لا تقم بتفعيل قاطع المزود بالكامل لأخطاء الحساب/المفتاح/النموذج العادية مثل معظم حالات 401، 403، أو 429. عادةً ما تنتمي تلك إلى فترة تبريد الاتصال أو قفل النموذج. يجب أن يكون مزود مفتاح واجهة برمجة التطبيقات العام 403 قابلاً للاسترداد ما لم يتم تصنيفه كخطأ نهائي للمزود/الحساب.

يستخدم القاطع استردادًا كسولًا، وليس مؤقتًا في الخلفية. عندما تنتهي حالة OPEN، فإن عمليات القراءة مثل getStatus(), canExecute(), و getRetryAfterMs() تقوم بتحديث الحالة إلى HALF_OPEN، بحيث لا تستمر لوحات المعلومات وبناة مرشحي المجموعة في استبعاد مزود منتهي الصلاحية إلى الأبد.

فترة تبريد الاتصال

النطاق: اتصال/حساب/مفتاح مزود واحد.

الغرض: تخطي مؤقت لمفتاح/حساب سيئ واحد مع السماح للاتصالات الأخرى لنفس المزود بالاستمرار في تقديم الطلبات.

التنفيذ:

  • مسار الكتابة/التحديث: src/sse/services/auth.ts::markAccountUnavailable()
  • اختيار/تصفية الحساب: src/sse/services/auth.ts::getProviderCredentials...
  • حساب فترة التبريد: open-sse/services/accountFallback.ts::checkFallbackError()
  • الإعدادات: src/lib/resilience/settings.ts

الحقول المهمة على اتصالات المزود:

rateLimitedUntil;
testStatus: "unavailable";
lastError;
lastErrorType;
errorCode;
backoffLevel;

أثناء اختيار الحساب، يتم تخطي الاتصال بينما:

new Date(rateLimitedUntil).getTime() > Date.now();

فترات التبريد أيضًا كسولة: عندما تكون rateLimitedUntil في الماضي، يصبح الاتصال مؤهلاً مرة أخرى. عند الاستخدام الناجح، تقوم clearAccountError() بمسح testStatus، rateLimitedUntil، حقول الأخطاء، و backoffLevel.

سلوك فترة تبريد الاتصال الافتراضي:

  • فترة تبريد أساسية لمزود OAuth: 5s.
  • فترة تبريد أساسية لمزود مفتاح واجهة برمجة التطبيقات: 3s.
  • يجب أن يفضل مفتاح واجهة برمجة التطبيقات 429 تلميحات إعادة المحاولة من المصدر (Retry-After، رؤوس إعادة التعيين، أو نص إعادة التعيين القابل للتحليل) عند توفرها.
  • تستخدم الفشل القابلة للاسترداد المتكررة التراجع الأسي:
baseCooldownMs * 2 ** failureIndex;

تحمي حراسة مكافحة قطيع الرعد من الفشل المتزامن على نفس الاتصال من تمديد فترة التبريد بشكل متكرر أو زيادة backoffLevel مرتين.

الحالات النهائية ليست فترات تبريد. banned، expired، و credits_exhausted مصممة للبقاء غير متاحة حتى تتغير بيانات الاعتماد/الإعدادات أو يقوم مشغل بإعادة تعيينها. لا تقم بكتابة الحالات النهائية فوق حالة فترة التبريد العابرة.

قفل النموذج

النطاق: المزود + الاتصال + النموذج.

الغرض: تجنب تعطيل اتصال كامل عندما يكون نموذج واحد فقط غير متاح أو محدود الحصة لذلك الاتصال.

أمثلة:

  • مزودو الحصة لكل نموذج الذين يعيدون 429.
  • مزودون محليون يعيدون 404 لنموذج مفقود واحد.
  • فشل إذن وضع/نموذج محدد للمزود مثل أوضاع Grok المختارة.

يعيش قفل النموذج في open-sse/services/accountFallback.ts ويسمح لنفس الاتصال بالاستمرار في تقديم نماذج أخرى.

إرشادات التصحيح

  • إذا تم تخطي جميع المفاتيح لمزود، تحقق من حالة قاطع المزود وحالة rateLimitedUntil/testStatus لكل اتصال.
  • إذا بدا أن مزودًا ما مستبعدًا بشكل دائم بعد نافذة إعادة التعيين، تحقق مما إذا كان الكود يقرأ state الخام بدلاً من استخدام getStatus()/canExecute().
  • إذا فشل مفتاح مزود واحد ولكن يجب أن تعمل المفاتيح الأخرى، يفضل استخدام فترة تبريد الاتصال على قاطع المزود.
  • إذا فشل نموذج واحد فقط، يفضل استخدام قفل النموذج على فترة تبريد الاتصال.
  • إذا كان يجب أن يتعافى حالة ما ذاتيًا، يجب أن تحتوي على طابع زمني مستقبلي/مهلة إعادة تعيين ومسار قراءة يقوم بتحديث الحالة المنتهية. تتطلب الحالات الدائمة تغييرات يدوية في بيانات الاعتماد أو التكوين.

الاتفاقيات الرئيسية

نمط الكود

  • مسافتان، فاصلات منقوطة، علامات اقتباس مزدوجة، عرض 100 حرف، فاصلات متأخرة ES5 (تطبق بواسطة lint-staged عبر Prettier)
  • الاستيرادات: خارجي → داخلي (@/, @omniroute/open-sse) → نسبي
  • التسمية: الملفات=camelCase/kebab، المكونات=PascalCase، الثوابت=UPPER_SNAKE
  • ESLint: no-eval، no-implied-eval، no-new-func = خطأ في كل مكان؛ no-explicit-any = تحذير في open-sse/ و tests/
  • TypeScript: strict: false، الهدف ES2022، الوحدة esnext، دقة التجميع. يفضل الأنواع الصريحة.

قاعدة البيانات

  • دائمًا مرر عبر وحدات المجال في src/lib/db/لا تكتب SQL خام في المسارات أو المعالجات
  • لا تضف منطقًا إلى src/lib/localDb.ts (طبقة إعادة تصدير فقط)
  • لا تستورد من localDb.ts بشكل مجمع — استورد وحدات db/ المحددة بدلاً من ذلك
  • مثيل قاعدة البيانات المفردة: getDbInstance() من src/lib/db/core.ts (تدوين WAL)
  • الترحيلات: src/lib/db/migrations/ — ملفات SQL ذات إصدار، متكررة، تعمل في معاملات

معالجة الأخطاء

  • try/catch مع أنواع أخطاء محددة، سجل باستخدام سياق pino
  • لا تبتلع الأخطاء في تدفقات SSE — استخدم إشارات الإنهاء للتنظيف
  • أعد القيم الصحيحة لرموز الحالة HTTP (4xx/5xx)

الأمان

  • لا تستخدم eval()، new Function()، أو eval الضمني
  • تحقق من جميع المدخلات باستخدام مخططات Zod
  • قم بتشفير بيانات الاعتماد عند الراحة (AES-256-GCM)
  • قائمة حظر رأس المصدر: src/shared/constants/upstreamHeaders.ts — حافظ على التنظيف، ومخططات Zod، واختبارات الوحدة متوافقة عند التحرير
  • بيانات الاعتماد العامة للمصدر (Gemini/Antigravity/Windsurf-style OAuth client_id/secret + مفاتيح Firebase Web المستخرجة من CLIs العامة): يجب تضمينها عبر resolvePublicCred() من open-sse/utils/publicCreds.tsلا كأدلة نصية. انظر docs/security/PUBLIC_CREDS.md للنمط الإلزامي.
  • استجابات الأخطاء (HTTP / SSE / المعالج / MCP): يجب توجيهها عبر buildErrorBody() أو sanitizeErrorMessage() من open-sse/utils/error.tsلا تضع err.stack أو err.message الخام في جسم الاستجابة. انظر docs/security/ERROR_SANITIZATION.md.
  • أوامر الصدفة المبنية من المتغيرات: عند استدعاء exec()/spawn() مع نص يحتاج إلى قيم وقت التشغيل، مررها عبر خيار env (تُهرب تلقائيًا) — لا تدمج مسارات غير موثوقة/خارجية في جسم النص. المرجع: src/mitm/cert/install.ts::updateNssDatabases.
  • المكتبات الآمنة بشكل افتراضي (tldrsec/awesome-secure-defaults): يفضل Helmet.js، DOMPurify، ssrf-req-filter، safe-regex، Google Tink على التنفيذات المخصصة كلما تم إضافة أسطح حساسة جديدة للأمان.

سيناريوهات التعديل الشائعة

إضافة مزود جديد

  1. سجل في src/shared/constants/providers.ts (تم التحقق منه بواسطة Zod عند التحميل)
  2. أضف معالج في open-sse/executors/ إذا كانت هناك حاجة إلى منطق مخصص (قم بتمديد BaseExecutor)
  3. أضف مترجمًا في open-sse/translator/ إذا كان بتنسيق غير OpenAI
  4. أضف تكوين OAuth في src/lib/oauth/constants/oauth.ts إذا كان يعتمد على OAuth — إذا كان CLI المصدر يرسل client_id/secret عام، قم بتضمينه عبر resolvePublicCred() (انظر docs/security/PUBLIC_CREDS.mdلا كأدلة نصية
  5. سجل النماذج في open-sse/config/providerRegistry.ts
  6. اكتب اختبارات في tests/unit/ (تضمن تأكيد شكل publicCreds إذا أضفت افتراضيًا جديدًا مضمنًا)

إضافة مسار API جديد

  1. أنشئ دليلًا تحت src/app/api/v1/your-route/
  2. أنشئ route.ts مع معالجات GET/POST
  3. اتبع النمط: CORS → تحقق من صحة جسم Zod → مصادقة اختيارية → تفويض المعالج
  4. يذهب المعالج في open-sse/handlers/ (استورد من هناك، وليس داخل السطر)
  5. تستخدم استجابات الأخطاء buildErrorBody() / errorResponse() من open-sse/utils/error.ts (تم تنظيفها تلقائيًا — لا تضع err.stack أو err.message الخام في الجسم). انظر docs/security/ERROR_SANITIZATION.md.
  6. أضف اختبارات — بما في ذلك على الأقل تأكيد واحد بأن استجابات الأخطاء لا تسرب تتبع المكدس (!body.error.message.includes("at /"))

إضافة وحدة DB جديدة

  1. أنشئ src/lib/db/yourModule.ts — استورد getDbInstance من ./core.ts
  2. صدر وظائف CRUD لجدول (جداول) المجال الخاص بك
  3. أضف ترحيلًا في src/lib/db/migrations/ إذا كانت هناك حاجة إلى جداول جديدة
  4. أعد تصدير من src/lib/localDb.ts (أضف إلى قائمة إعادة التصدير فقط)
  5. اكتب اختبارات

إضافة أداة MCP جديدة

  1. أضف تعريف الأداة في open-sse/mcp-server/tools/ مع مخطط إدخال Zod + معالج غير متزامن
  2. سجل في مجموعة الأدوات (موصول بواسطة createMcpServer())
  3. عيّن إلى النطاق (النطاقات) المناسبة
  4. اكتب اختبارات (تسجيل استدعاء الأداة في جدول mcp_audit)

إضافة مهارة A2A جديدة

  1. أنشئ مهارة في src/lib/a2a/skills/ (يوجد 5 بالفعل: التوجيه الذكي، إدارة الحصص، اكتشاف المزود، تحليل التكلفة، تقرير الصحة)
  2. تتلقى المهارة سياق المهمة (الرسائل، البيانات الوصفية) → تعيد نتيجة منظمة
  3. سجل في A2A_SKILL_HANDLERS في src/lib/a2a/taskExecution.ts
  4. اعرض في src/app/.well-known/agent.json/route.ts (بطاقة الوكيل)
  5. اكتب اختبارات في tests/unit/
  6. وثق في جدول المهارات في docs/frameworks/A2A-SERVER.md

إضافة وكيل سحابي جديد

  1. أنشئ فئة وكيل في src/lib/cloudAgent/agents/ تمتد من CloudAgentBase (يوجد 3 بالفعل: codex-cloud، devin، jules)
  2. نفذ createTask، getStatus، approvePlan، sendMessage، listSources
  3. سجل في src/lib/cloudAgent/registry.ts
  4. أضف معالجة OAuth/بيانات الاعتماد إذا لزم الأمر (src/lib/oauth/providers/)
  5. اختبارات + وثق في docs/frameworks/CLOUD_AGENT.md

إضافة حواجز جديدة / تقييم / مهارة / حدث Webhook

  • الحواجز: src/lib/guardrails/ → الوثائق: docs/security/GUARDRAILS.md
  • مجموعة التقييم: src/lib/evals/ → الوثائق: docs/frameworks/EVALS.md
  • المهارة (الصندوق الرمل): src/lib/skills/ → الوثائق: docs/frameworks/SKILLS.md
  • حدث Webhook: src/lib/webhookDispatcher.ts → الوثائق: docs/frameworks/WEBHOOKS.md

وثائق المرجع

لأي تغيير غير تافه، اقرأ الغوص العميق المطابق أولاً:

المجال الوثيقة
تنقل المستودع docs/architecture/REPOSITORY_MAP.md
الهندسة docs/architecture/ARCHITECTURE.md
مرجع الهندسة docs/architecture/CODEBASE_DOCUMENTATION.md
Auto-Combo (تقييم 9 عوامل، 14 استراتيجية) docs/routing/AUTO-COMBO.md
المرونة (3 آليات) docs/architecture/RESILIENCE_GUIDE.md
إعادة تشغيل التفكير docs/routing/REASONING_REPLAY.md
إطار المهارات docs/frameworks/SKILLS.md
نظام الذاكرة (FTS5 + Qdrant) docs/frameworks/MEMORY.md
وكلاء السحابة docs/frameworks/CLOUD_AGENT.md
حواجز الأمان (PII / حقن / رؤية) docs/security/GUARDRAILS.md
بيانات اعتماد عامة (Gemini/إلخ.) docs/security/PUBLIC_CREDS.md
تطهير رسائل الخطأ docs/security/ERROR_SANITIZATION.md
التقييمات docs/frameworks/EVALS.md
الامتثال / التدقيق docs/security/COMPLIANCE.md
Webhooks docs/frameworks/WEBHOOKS.md
خط أنابيب التفويض docs/architecture/AUTHZ_GUIDE.md
التخفي (TLS / بصمة) docs/security/STEALTH_GUIDE.md
بروتوكولات الوكلاء (A2A / ACP / سحابة) docs/frameworks/AGENT_PROTOCOLS_GUIDE.md
خادم MCP docs/frameworks/MCP-SERVER.md
خادم A2A docs/frameworks/A2A-SERVER.md
مرجع API + OpenAPI docs/reference/API_REFERENCE.md + docs/reference/openapi.yaml
كتالوج المزودين (تم إنشاؤه تلقائيًا) docs/reference/PROVIDER_REFERENCE.md
تدفق الإصدار docs/ops/RELEASE_CHECKLIST.md

الاختبار

ما الأمر
اختبارات الوحدة npm run test:unit
ملف واحد node --import tsx/esm --test tests/unit/file.test.ts
Vitest (MCP, autoCombo) npm run test:vitest
E2E (Playwright) npm run test:e2e
بروتوكول E2E (MCP+A2A) npm run test:protocols:e2e
النظام البيئي npm run test:ecosystem
بوابة التغطية npm run test:coverage (75/75/75/70 — العبارات/الأسطر/الدوال/الفروع)
تقرير التغطية npm run coverage:report

قاعدة PR: إذا قمت بتغيير كود الإنتاج في src/، open-sse/، electron/، أو bin/، يجب عليك تضمين أو تحديث الاختبارات في نفس PR.

تفضيل طبقة الاختبار: الوحدة أولاً → التكامل (حالة متعددة الوحدات أو قاعدة البيانات) → e2e (واجهة المستخدم/سير العمل فقط). قم بتشفير إعادة إنتاج الأخطاء كاختبارات آلية قبل أو بالتزامن مع الإصلاح.

سياسة تغطية Copilot: عندما يغير PR كود الإنتاج وتكون التغطية أقل من 75% (العبارات/الأسطر/الدوال) أو 70% (الفروع)، لا تقم بالإبلاغ فقط — أضف أو قم بتحديث الاختبارات، أعد تشغيل بوابة التغطية، ثم اطلب التأكيد. قم بتضمين الأوامر التي تم تشغيلها، وملفات الاختبار التي تم تغييرها، ونتيجة التغطية النهائية في تقرير PR.


سير عمل Git

# لا تقم بالالتزام مباشرة إلى main
git checkout -b feat/your-feature
git commit -m "feat: وصف التغيير الخاص بك"
git push -u origin feat/your-feature

بادئات الفروع: feat/، fix/، refactor/، docs/، test/، chore/

تنسيق الالتزام (Commits التقليدية): feat(db): إضافة قاطع الدائرة — النطاقات: db، sse، oauth، dashboard، api، cli، docker، ci، mcp، a2a، memory، skills

خطافات Husky:

  • pre-commit: lint-staged + check-docs-sync + check:any-budget:t11
  • pre-push: npm run test:unit

البيئة

  • وقت التشغيل: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25، وحدات ES
  • TypeScript: 5.9+، الهدف ES2022، الوحدة esnext، دقة المجمع
  • أسماء المسارات: @/*src/، @omniroute/open-sseopen-sse/، @omniroute/open-sse/*open-sse/*
  • المنفذ الافتراضي: 20128 (API + لوحة التحكم على نفس المنفذ)
  • دليل البيانات: متغير البيئة DATA_DIR، الافتراضي هو ~/.omniroute/
  • المتغيرات البيئية الرئيسية: PORT، JWT_SECRET، API_KEY_SECRET، INITIAL_PASSWORD، REQUIRE_API_KEY، APP_LOG_LEVEL
  • الإعداد: cp .env.example .env ثم توليد JWT_SECRET (openssl rand -base64 48) و API_KEY_SECRET (openssl rand -hex 32)

القواعد الصارمة

  1. لا تقم بالالتزام بالأسرار أو بيانات الاعتماد
  2. لا تضف منطقًا إلى localDb.ts
  3. لا تستخدم eval() / new Function() / eval الضمني
  4. لا تقم بالالتزام مباشرة إلى main
  5. لا تكتب SQL الخام في المسارات — استخدم وحدات src/lib/db/
  6. لا تبتلع الأخطاء بصمت في تدفقات SSE
  7. تحقق دائمًا من المدخلات باستخدام مخططات Zod
  8. قم دائمًا بتضمين الاختبارات عند تغيير كود الإنتاج
  9. يجب أن تبقى التغطية ≥75% (العبارات، الأسطر، الدوال) / ≥70% (الفروع). القياس الحالي: ~82%.
  10. لا تتجاوز خطافات Husky (--no-verify، --no-gpg-sign) بدون موافقة مشغل صريحة.
  11. لا تقم بتضمين client_id/secret العامة من OAuth أو مفاتيح Firebase Web كقيم نصية — دائمًا استخدم resolvePublicCred() (open-sse/utils/publicCreds.ts). انظر docs/security/PUBLIC_CREDS.md.
  12. لا تقم بإرجاع err.stack / err.message الخام في HTTP / SSE / استجابات المنفذ — دائمًا قم بتوجيهها عبر buildErrorBody() أو sanitizeErrorMessage() (open-sse/utils/error.ts). انظر docs/security/ERROR_SANITIZATION.md.
  13. لا تقم بإدراج مسارات خارجية أو قيم وقت التشغيل في سكربتات الشل المرسلة إلى exec()/spawn() — مرر عبر خيار env بدلاً من ذلك. المرجع: src/mitm/cert/install.ts::updateNssDatabases.
  14. لا تتجاهل تنبيه CodeQL / Secret-Scanning بدون (أ) التحقق أولاً من وثائق النمط أعلاه لمعرفة ما إذا كان المساعد ينطبق، و (ب) تسجيل التبرير الفني في تعليق الإلغاء. سابقة: js/stack-trace-exposure التي تم رفعها على مواقع الاتصال التي تمر بالفعل عبر sanitizeErrorMessage() هي قيود معروفة لـ CodeQL (المعقمات المخصصة غير معترف بها) — تجاهل كـ false positive مع الإشارة إلى docs/security/ERROR_SANITIZATION.md.
  15. لا تعرض المسارات التي تولد عمليات فرعية (/api/mcp/، /api/cli-tools/runtime/) بدون تصنيف isLocalOnlyPath() في src/server/authz/routeGuard.ts. يتم تنفيذ التحقق من الحلقة بشكل غير مشروط قبل أي تحقق من المصادقة — لا يمكن أن يؤدي تسرب JWT عبر النفق إلى تشغيل العملية. انظر docs/security/ROUTE_GUARD_TIERS.md.
  16. لا تضمن أبدًا ملحقات Co-Authored-By التي تنسب لمساعد ذكاء اصطناعي أو LLM أو حساب آلي (مثل الأسماء التي تحتوي على "Claude" أو "GPT" أو "Copilot" أو "Bot"؛ والبريد الإلكتروني على anthropic.com / openai.com / عناوين noreply.github.com المملوكة للبوتات). تلك الملحقات توجه نسبة الالتزامات إلى حساب البوت على GitHub، مما يخفي المؤلف الحقيقي (diegosouzapw) في تاريخ PR. المساهمون البشريون — بما في ذلك مؤلفو PRs upstream ومُبلغو الـ issues الذين يتم نقلهم إلى OmniRoute — يجوز ويجب أن يُنسبوا باستخدام ملحقات Co-authored-by: Name <email> القياسية؛ تعتمد سير عمل النقل (/port-upstream-features و /port-upstream-issues) على ذلك.