Files
OmniRoute/docs/i18n/fi/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

27 KiB

CLAUDE.md (Suomi)

🌐 Languages: 🇺🇸 English · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇪🇸 es · 🇮🇷 fa · 🇫🇷 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


Tämä tiedosto tarjoaa ohjeita Claude Code (claude.ai/code) käytettäessä koodia tässä repositoriossa.

Nopeasti alkuun

npm install                    # Asenna riippuvuudet (automaattisesti luo .env .env.example:sta)
npm run dev                    # Kehityspalvelin osoitteessa http://localhost:20128
npm run build                  # Tuotantorakennus (Next.js 16 standalone)
npm run lint                   # ESLint (0 virhettä odotettavissa; varoitukset ovat ennestään olemassa)
npm run typecheck:core         # TypeScript-tarkistus (pitäisi olla puhdas)
npm run typecheck:noimplicit:core  # Tiukka tarkistus (ei implisiittistä any)
npm run test:coverage          # Yksikkötestit + kattavuusportti (75/75/75/70 — lauseet/rivit/funktiot/haarat)
npm run check                  # lint + test yhdistettynä
npm run check:cycles           # Havaitse sykliset riippuvuudet

Testien suorittaminen

# Yksittäinen testitiedosto (Node.js:n natiivinen testirunner — suurin osa testeistä)
node --import tsx/esm --test tests/unit/your-file.test.ts

# Vitest (MCP-palvelin, autoCombo, välimuisti)
npm run test:vitest

# Kaikki testisarjat
npm run test:all

Koko testimatriisin näkemiseksi katso CONTRIBUTING.md → "Testien suorittaminen". Syvällistä arkkitehtuuria varten katso AGENTS.md.


Projekti lyhyesti

OmniRoute — yhtenäinen AI-proxy/reititin. Yksi päätepiste, yli 160 LLM-toimittajaa, automaattinen varajärjestelmä.

Kerros Sijainti Tarkoitus
API-reitit src/app/api/v1/ Next.js App Router — sisäänkäynnit
Käsittelijät open-sse/handlers/ Pyyntöjen käsittely (keskustelu, upotukset jne.)
Suorittajat open-sse/executors/ Toimittajakohtainen HTTP-jakelu
Kääntäjät open-sse/translator/ Muotojen muunnos (OpenAI↔Claude↔Gemini)
Muuntaja open-sse/transformer/ Vastaukset API ↔ Keskustelun täydentäminen
Palvelut open-sse/services/ Combo-reititys, nopeusrajoitukset, välimuisti jne.
Tietokanta src/lib/db/ SQLite-alueen moduulit (yli 45 tiedostoa, 55 migraatiota)
Alue/Politiikka src/domain/ Politiikkamoottori, kustannussäännöt, varajärjestelmä
MCP-palvelin open-sse/mcp-server/ 37 työkalua (30 perus + 3 muisti + 4 taitoa), 3 kuljetusta, ~13 laajuutta
A2A-palvelin src/lib/a2a/ JSON-RPC 2.0 agenttiprotokolla
Taidot src/lib/skills/ Laajennettavissa oleva taitokehys
Muisti src/lib/memory/ Kestävä keskustelumuisti

Monorepo: src/ (Next.js 16 -sovellus), open-sse/ (suoratoistoalustatyötila), electron/ (työpöytäsovellus), tests/, bin/ (CLI-sisäänkäynti).

Pyyntöputki

Asiakas → /v1/chat/completions (Next.js-reitti)
  → CORS → Zod-validointi → auth? → politiikan tarkistus → kehotteen injektoinnin suoja
  → handleChatCore() [open-sse/handlers/chatCore.ts]
    → välimuistin tarkistus → nopeusrajoitus → yhdistelmäreittaus?
      → resolveComboTargets() → handleSingleModel() per kohde
    → translateRequest() → getExecutor() → executor.execute()
      → fetch() upstream → yritä uudelleen w/ backoff
    → vastausten käännös → SSE-virta tai JSON
    → Jos Responses API: responsesTransformer.ts TransformStream

API-reitit noudattavat johdonmukaista kaavaa: Reitti → CORS-esivalmistelu → Zod-kehon validointi → Valinnainen auth (extractApiKey/isValidApiKey) → API-avaimen politiikan täytäntöönpano → Käsittelijän delegointi (open-sse). Ei globaalia Next.js-välikkää — keskeytys on reitti-spesifinen.

Yhdistelmäreittaus (open-sse/services/combo.ts): 14 strategiaa (prioriteetti, painotettu, täytä-ensin, vuorotellen, P2C, satunnainen, vähiten käytetty, kustannusoptimoitu, reset-tieto, tiukka-satunnainen, automaattinen, lkgp, konteksti-optimoitu, konteksti-väylä). Jokainen kohde kutsuu handleSingleModel(), joka käärii handleChatCore()-funktion kohdekohtaisella virheenkäsittelyllä ja piirikytkin tarkistuksilla. Katso docs/routing/AUTO-COMBO.md 9-tekijän Auto-Combo-pisteytykselle ja docs/architecture/RESILIENCE_GUIDE.md 3-resilienssikerrokselle.


Resilienssin Suorituskykytila

OmniRoute:lla on kolme liittyvää mutta erilaista tilapäisen epäonnistumisen mekanismia. Pidä niiden alueet erillään reitityskäyttäytymisen vianetsinnässä. Katso 3-kerroksinen resilienssikaavio (lähde: docs/diagrams/resilience-3layers.mmd) nopeaa karttaa varten.

Palveluntarjoajan Piirikytkin

Alue: koko palveluntarjoaja, esim. glm, openai, anthropic.

Tarkoitus: lopettaa liikenteen lähettäminen palveluntarjoajalle, joka epäonnistuu toistuvasti ylävirrassa/palvelutasolla, jotta yksi epäterveellinen palveluntarjoaja ei hidasta jokaista pyyntöä.

Toteutus:

  • Ydinluokka: src/shared/utils/circuitBreaker.ts
  • Chat-portti/suorituskykykaapeli: src/sse/handlers/chatHelpers.ts, src/sse/handlers/chat.ts
  • Suorituskykytila API: src/app/api/monitoring/health/route.ts
  • Jaetut kääreet: open-sse/services/accountFallback.ts
  • Kestävän tilan taulukko: domain_circuit_breakers

Tilat:

  • CLOSED: normaali liikenne on sallittu.
  • OPEN: palveluntarjoaja on tilapäisesti estetty; kutsujat saavat palveluntarjoaja-piirikytkin-avoin -vastauksen tai yhdistelmäreittaus ohittaa toiseen kohteeseen.
  • HALF_OPEN: nollaus-aika on kulunut; salli koepyyntö. Onnistuminen sulkee kytkimen, epäonnistuminen avaa sen uudelleen.

Oletusarvot (open-sse/config/constants.ts):

  • OAuth-palveluntarjoajat: kynnys 3, nollausaika 60s.
  • API-avaimen palveluntarjoajat: kynnys 5, nollausaika 30s.
  • Paikalliset palveluntarjoajat: kynnys 2, nollausaika 15s.

Vain palveluntarjoajatasoiset epäonnistumistilat saavat aktivoida palveluntarjoajan kytkimen:

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

Älä aktivoi koko palveluntarjoajan kytkintä normaaleille tili/avain/malli-virheille, kuten useimmille 401, 403 tai 429 tapauksille. Ne kuuluvat yleensä yhteyden jäähdytysaikaan tai mallin lukitsemiseen. Yleinen API-avaimen palveluntarjoajan 403 pitäisi olla palautettavissa, ellei sitä luokitella terminaaliseksi palveluntarjoaja/tilivirheeksi.

Kytkin käyttää laiskaa palautumista, ei taustakelloa. Kun OPEN vanhenee, lukemiset kuten getStatus(), canExecute(), ja getRetryAfterMs() päivittävät tilan HALF_OPEN:ksi, jotta koontinäytöt ja yhdistelmäehdokkaat eivät jatkuvasti sulje vanhentunutta palveluntarjoajaa.

Yhteyden Jäähdytys

Alue: yksi palveluntarjoajan yhteys/tili/avain.

Tarkoitus: ohittaa tilapäisesti yksi huono avain/tili samalla kun sallitaan muiden yhteyksien saman palveluntarjoajan jatkaa pyyntöjen palvelemista.

Toteutus:

  • Kirjoitus/päivityspolku: src/sse/services/auth.ts::markAccountUnavailable()
  • Tilin valinta/suodatus: src/sse/services/auth.ts::getProviderCredentials...
  • Jäähdytyksen laskenta: open-sse/services/accountFallback.ts::checkFallbackError()
  • Asetukset: src/lib/resilience/settings.ts

Tärkeitä kenttiä palveluntarjoajan yhteyksissä:

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

Tilivalinnan aikana yhteys ohitetaan, kun:

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

Jäähdytykset ovat myös laiskoja: kun rateLimitedUntil on menneisyydessä, yhteys tulee uudelleen kelpoiseksi. Onnistuneessa käytössä clearAccountError() tyhjentää testStatus, rateLimitedUntil, virhekentät ja backoffLevel.

Oletusarvoinen yhteyden jäähdytys käyttäytyminen:

  • OAuth-perusjäähdytys: 5s.
  • API-avaimen perusjäähdytys: 3s.
  • API-avaimen 429 pitäisi suosia ylävirran uudelleenyritysohjeita (Retry-After, nollausotsikot tai parsittava nollusteksti) kun saatavilla.
  • Toistuvat palautettavat epäonnistumiset käyttävät eksponentiaalista taaksepäin:
baseCooldownMs * 2 ** failureIndex;

Anti-thundering-herd-suoja estää samanaikaisia epäonnistumisia samalla yhteydellä toistuvasti pidentämästä jäähdytystä tai kaksinkertaistamasta backoffLevel:ia.

Terminologiset tilat eivät ole jäähdytyksiä. banned, expired, ja credits_exhausted on tarkoitettu pysymään saatavilla, kunnes tunnistetiedot/asetukset muuttuvat tai operaattori nollaa ne. Älä ylikirjoita terminologisia tiloja tilapäisellä jäähdytystilalla.

Mallin Lukitus

Alue: palveluntarjoaja + yhteys + malli.

Tarkoitus: välttää koko yhteyden estämistä, kun vain yksi malli on saatavilla tai kiintiörajoitettu tälle yhteydelle.

Esimerkkejä:

  • Per-malli kiintiöpalveluntarjoajat, jotka palauttavat 429.
  • Paikalliset palveluntarjoajat, jotka palauttavat 404 yhdelle puuttuvasta mallista.
  • Palveluntarjoajakohtaiset tila/mallilupa epäonnistumiset, kuten valitut Grok-tilat.

Mallin lukitus sijaitsee open-sse/services/accountFallback.ts ja sallii saman yhteyden jatkaa muiden mallien palvelemista.

Vianetsintäohjeet

  • Jos kaikki avaimet palveluntarjoajalle ohitetaan, tarkista sekä palveluntarjoajan kytkimen tila että jokaisen yhteyden rateLimitedUntil/testStatus.
  • Jos palveluntarjoaja näyttää pysyvästi suljetulta nollausikkunan jälkeen, tarkista, lukevatko koodi raakaa state:a sen sijaan, että käyttäisivät getStatus()/canExecute().
  • Jos yksi palveluntarjoajan avain epäonnistuu, mutta muiden pitäisi toimia, suosii yhteyden jäähdytystä palveluntarjoajan kytkimen yli.
  • Jos vain yksi malli epäonnistuu, suosii mallin lukitusta yhteyden jäähdytyksen yli.
  • Jos tilan pitäisi palautua itsestään, sillä pitäisi olla tuleva aikaleima/nollausaika ja lukupolku, joka päivittää vanhentuneen tilan. Pysyvät tilat vaativat manuaalisia tunnistetietoja tai konfiguraatiomuutoksia.

Avain Konventiot

Koodityyli

  • 2 välilyöntiä, puolipisteet, kaksoisviittaukset, 100 merkin leveys, es5 loppupisteet (pakotettu lint-stagedin kautta Prettierillä)
  • Tuonnit: ulkoiset → sisäiset (@/, @omniroute/open-sse) → suhteelliset
  • Nimeäminen: tiedostot=camelCase/kebab, komponentit=PascalCase, vakioarvot=UPPER_SNAKE
  • ESLint: no-eval, no-implied-eval, no-new-func = virhe kaikkialla; no-explicit-any = varoitus open-sse/ ja tests/
  • TypeScript: strict: false, kohde ES2022, moduuli esnext, resoluutio bundler. Suosi eksplisiittisiä tyyppejä.

Tietokanta

  • Aina käytä src/lib/db/ alueen moduuleja — älä koskaan kirjoita raakaa SQL:ta reiteille tai käsittelijöille
  • Älä koskaan lisää logiikkaa src/lib/localDb.ts (vain uudelleenvienti kerros)
  • Älä koskaan barrel-importoi localDb.ts — tuo spesifisiä db/ moduuleja sen sijaan
  • DB singleton: getDbInstance() src/lib/db/core.ts (WAL lokitus)
  • Migraatiot: src/lib/db/migrations/ — versioidut SQL-tiedostot, idempotentit, suoritetaan transaktioissa

Virheiden käsittely

  • try/catch tietyillä virhetyypeillä, lokita pino kontekstilla
  • Älä koskaan niele virheitä SSE-virroissa — käytä keskeytyssignaaleja siivoukseen
  • Palauta oikeat HTTP-tilakoodit (4xx/5xx)

Turvallisuus

  • Älä koskaan käytä eval(), new Function(), tai implikoitua evalia
  • Vahvista kaikki syötteet Zod-skeemoilla
  • Salaa tunnistetiedot levossa (AES-256-GCM)
  • Ylöspäin suuntautuvan otsikon estolista: src/shared/constants/upstreamHeaders.ts — pidä puhdistus, Zod-skeemat ja yksikkötestit synkronoituna muokkaamisen aikana
  • Julkiset ylöspäin suuntautuvat tunnistetiedot (Gemini/Antigravity/Windsurf-tyylinen OAuth client_id/salaisuus + Firebase Web -avaimet, jotka on saatu julkisista CLI:stä): ON upotettava resolvePublicCred() kautta open-sse/utils/publicCreds.tsälä koskaan merkkijonolitteraalina. Katso docs/security/PUBLIC_CREDS.md pakollisesta mallista.
  • Virhevastaukset (HTTP / SSE / suorittaja / MCP-käsittelijä): ON ohjattava buildErrorBody() tai sanitizeErrorMessage() kautta open-sse/utils/error.tsälä koskaan laita raakaa err.stack tai err.message vastauskehoon. Katso docs/security/ERROR_SANITIZATION.md.
  • Shell-komennot, jotka on rakennettu muuttujista: kun kutsut exec()/spawn() skriptiä, joka tarvitsee ajonaikaisia arvoja, siirrä ne env-vaihtoehdon kautta (shell-escape automaattisesti) — älä koskaan merkkijonointerpoloi luotettomia/ulkopuolisia polkuja skriptin kehoon. Viite: src/mitm/cert/install.ts::updateNssDatabases.
  • Oletusarvoisesti turvalliset kirjastot (tldrsec/awesome-secure-defaults): suosi Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink yli mukautettujen toteutusten aina, kun lisäät uusia turvallisuuteen liittyviä pintoja.

Yleiset Muokkausskenaariot

Uuden Palveluntarjoajan Lisääminen

  1. Rekisteröi src/shared/constants/providers.ts (Zod-vahvistettu latauksessa)
  2. Lisää suorittaja open-sse/executors/ jos tarvitaan mukautettua logiikkaa (laajenna BaseExecutor)
  3. Lisää kääntäjä open-sse/translator/ jos ei-OpenAI-muoto
  4. Lisää OAuth-konfiguraatio src/lib/oauth/constants/oauth.ts jos perustuu OAuth:iin — jos ylöspäin suuntautuva CLI toimittaa julkisen client_id/salaisuuden, upota resolvePublicCred() kautta (katso docs/security/PUBLIC_CREDS.md), älä koskaan litteraalina
  5. Rekisteröi mallit open-sse/config/providerRegistry.ts
  6. Kirjoita testit tests/unit/ (sisällytä publicCreds-muodon vahvistus, jos lisäsit uuden upotetun oletuksen)

Uuden API-reitin Lisääminen

  1. Luo hakemisto src/app/api/v1/your-route/
  2. Luo route.ts GET/POST käsittelijöillä
  3. Noudata kaavaa: CORS → Zod-kehon vahvistus → valinnainen todennus → käsittelijän delegointi
  4. Käsittelijä menee open-sse/handlers/ (tuo sieltä, ei inline)
  5. Virhevastaukset käyttävät buildErrorBody() / errorResponse() open-sse/utils/error.ts (automaattisesti puhdistettu — älä koskaan laita err.stack tai err.message raakana kehoon). Katso docs/security/ERROR_SANITIZATION.md.
  6. Lisää testit — mukaan lukien vähintään yksi vahvistus, että virhevastaukset eivät vuoda pinojälkiä (!body.error.message.includes("at /"))

Uuden DB-moduulin Lisääminen

  1. Luo src/lib/db/yourModule.ts — tuo getDbInstance ./core.ts:stä
  2. Vie CRUD-toiminnot alueen taulukoillesi
  3. Lisää migraatio src/lib/db/migrations/ jos uusia tauluja tarvitaan
  4. Uudelleenvienti src/lib/localDb.ts (lisää vain uudelleenvientiluetteloon)
  5. Kirjoita testit

Uuden MCP-työkalun Lisääminen

  1. Lisää työkalun määritelmä open-sse/mcp-server/tools/ Zod-syöteskeeman + asynkronisen käsittelijän kanssa
  2. Rekisteröi työkalusarjaan (kytketty createMcpServer() kautta)
  3. Määritä sopiville alueille
  4. Kirjoita testit (työkalun kutsu lokitetaan mcp_audit tauluun)

Uuden A2A-taidon Lisääminen

  1. Luo taito src/lib/a2a/skills/ (5 on jo olemassa: älykäs-reititys, kiintiöhallinta, palveluntarjoajan-haku, kustannusanalyysi, terveysraportti)
  2. Taito saa tehtäväkontekstin (viestit, metatiedot) → palauttaa rakenteellisen tuloksen
  3. Rekisteröi A2A_SKILL_HANDLERS src/lib/a2a/taskExecution.ts tiedostossa
  4. Altista src/app/.well-known/agent.json/route.ts (Agent Card)
  5. Kirjoita testit tests/unit/
  6. Dokumentoi docs/frameworks/A2A-SERVER.md taitotaulukossa

Uuden Pilviagentin Lisääminen

  1. Luo agenttiluokka src/lib/cloudAgent/agents/ laajentamalla CloudAgentBase (3 on jo olemassa: codex-cloud, devin, jules)
  2. Toteuta createTask, getStatus, approvePlan, sendMessage, listSources
  3. Rekisteröi src/lib/cloudAgent/registry.ts
  4. Lisää OAuth/tunnistetietojen käsittely tarvittaessa (src/lib/oauth/providers/)
  5. Testit + dokumentoi docs/frameworks/CLOUD_AGENT.md

Uuden Guardrail / Eval / Taito / Webhook-tapahtuman Lisääminen

  • Guardrail: src/lib/guardrails/ → dokumentaatio: docs/security/GUARDRAILS.md
  • Eval-sarja: src/lib/evals/ → dokumentaatio: docs/frameworks/EVALS.md
  • Taito (sandbox): src/lib/skills/ → dokumentaatio: docs/frameworks/SKILLS.md
  • Webhook-tapahtuma: src/lib/webhookDispatcher.ts → dokumentaatio: docs/frameworks/WEBHOOKS.md

Viiteasiakirja

Mikäli teet ei-triviaalia muutosta, lue ensin vastaava syväsukellus:

Alue Asiakirja
Repo-navigointi docs/architecture/REPOSITORY_MAP.md
Arkkitehtuuri docs/architecture/ARCHITECTURE.md
Insinööriviite docs/architecture/CODEBASE_DOCUMENTATION.md
Auto-Combo (9-tekijän pisteytys, 14 strategiaa) docs/routing/AUTO-COMBO.md
Kestävyys (3 mekanismia) docs/architecture/RESILIENCE_GUIDE.md
Perustelujen toisto docs/routing/REASONING_REPLAY.md
Taitojen kehys docs/frameworks/SKILLS.md
Muistijärjestelmä (FTS5 + Qdrant) docs/frameworks/MEMORY.md
Pilviagentit docs/frameworks/CLOUD_AGENT.md
Suojakaiteet (PII / injektio / visio) docs/security/GUARDRAILS.md
Julkiset ylävirran tunnistetiedot (Gemini/ym.) docs/security/PUBLIC_CREDS.md
Virheilmoitusten puhdistus docs/security/ERROR_SANITIZATION.md
Arvioinnit docs/frameworks/EVALS.md
Vaatimustenmukaisuus / auditointi docs/security/COMPLIANCE.md
Webhookit docs/frameworks/WEBHOOKS.md
Valtuutusputki docs/architecture/AUTHZ_GUIDE.md
Piilottelu (TLS / sormenjälki) docs/security/STEALTH_GUIDE.md
Agenttiprotokollat (A2A / ACP / Pilvi) docs/frameworks/AGENT_PROTOCOLS_GUIDE.md
MCP-palvelin docs/frameworks/MCP-SERVER.md
A2A-palvelin docs/frameworks/A2A-SERVER.md
API-viite + OpenAPI docs/reference/API_REFERENCE.md + docs/reference/openapi.yaml
Palveluntarjoajan luettelo (automaattisesti luotu) docs/reference/PROVIDER_REFERENCE.md
Julkaisuprosessi docs/ops/RELEASE_CHECKLIST.md

Testaus

Mikä Komento
Yksikkötestit npm run test:unit
Yksi tiedosto node --import tsx/esm --test tests/unit/file.test.ts
Vitest (MCP, autoCombo) npm run test:vitest
E2E (Playwright) npm run test:e2e
Protokolla E2E (MCP+A2A) npm run test:protocols:e2e
Ekosysteemi npm run test:ecosystem
Peittoportti npm run test:coverage (75/75/75/70 — lauseet/rivit/funktiot/haarat)
Peittoraportti npm run coverage:report

PR-sääntö: Jos muutat tuotantokoodia kansioissa src/, open-sse/, electron/ tai bin/, sinun on sisällytettävä tai päivitettävä testit samaan PR:ään.

Testikerroksen mieltymys: yksikkö ensin → integraatio (moni-moduuli tai DB-tila) → e2e (UI/työnkulku vain). Koodivirheiden toistot on koodattava automatisoiduiksi testeiksi ennen tai rinnakkain korjauksen kanssa.

Copilot-peittopolitiikka: Kun PR muuttaa tuotantokoodia ja peitto on alle 75% (lauseet/rivit/funktiot) tai 70% (haarat), älä vain raportoi — lisää tai päivitä testit, suorita peittoportti uudelleen ja pyydä sitten vahvistusta. Sisällytä suoritettavat komennot, muutetut testitiedostot ja lopullinen peittotulos PR-raporttiin.


Git-työprosessi

# Älä koskaan tee suoria sitoumuksia päähaaraan
git checkout -b feat/your-feature
git commit -m "feat: kuvaa muutoksesi"
git push -u origin feat/your-feature

Haaraetuliitteet: feat/, fix/, refactor/, docs/, test/, chore/

Sitoutumismuoto (Conventional Commits): feat(db): lisää piiri katkaisin — laajuudet: db, sse, oauth, dashboard, api, cli, docker, ci, mcp, a2a, memory, skills

Husky-koukut:

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

Ympäristö

  • Suoritusaika: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25, ES-moduulit
  • TypeScript: 5.9+, kohde ES2022, moduuli esnext, resoluutio bundler
  • Polkualias: @/*src/, @omniroute/open-sseopen-sse/, @omniroute/open-sse/*open-sse/*
  • Oletusportti: 20128 (API + dashboard samalla portilla)
  • Tietohakemisto: DATA_DIR ympäristömuuttuja, oletuksena ~/.omniroute/
  • Avain ympäristömuuttujat: PORT, JWT_SECRET, API_KEY_SECRET, INITIAL_PASSWORD, REQUIRE_API_KEY, APP_LOG_LEVEL
  • Asetus: cp .env.example .env ja sitten luo JWT_SECRET (openssl rand -base64 48) ja API_KEY_SECRET (openssl rand -hex 32)

Tiukat säännöt

  1. Älä koskaan sitoudu salaisuuksia tai tunnistetietoja
  2. Älä koskaan lisää logiikkaa localDb.ts
  3. Älä koskaan käytä eval() / new Function() / implisiittistä eval
  4. Älä koskaan tee suoria sitoumuksia main-haaraan
  5. Älä koskaan kirjoita raakaa SQL:ta reitteihin — käytä src/lib/db/ moduuleja
  6. Älä koskaan hiljaa niele virheitä SSE-virroissa
  7. Varmista aina syötteet Zod-skeemoilla
  8. Sisällytä aina testit, kun muutat tuotantokoodia
  9. Peiton on pysyttävä ≥75% (lauseet, rivit, funktiot) / ≥70% (haarat). Nykyinen mittaus: ~82%.
  10. Älä koskaan ohita Husky-koukkuja (--no-verify, --no-gpg-sign) ilman nimenomaista operaattorin hyväksyntää.
  11. Älä koskaan upota julkisia ylävirran OAuth client_id/salaisuutta tai Firebase Web -avaimia merkkijonolittereinä — käytä aina resolvePublicCred() (open-sse/utils/publicCreds.ts). Katso docs/security/PUBLIC_CREDS.md.
  12. Älä koskaan palauta raakaa err.stack / err.message HTTP / SSE / suorittimen vastauksissa — ohjaa aina buildErrorBody() tai sanitizeErrorMessage() kautta (open-sse/utils/error.ts). Katso docs/security/ERROR_SANITIZATION.md.
  13. Älä koskaan merkkijonointerpoloi ulkoisia polkuja tai suoritusaikaisia arvoja shell-skripteihin, jotka annetaan exec()/spawn() — siirrä sen sijaan env-vaihtoehdon kautta. Viite: src/mitm/cert/install.ts::updateNssDatabases.
  14. Älä koskaan hylkää CodeQL / Secret-Scanning -ilmoitusta ilman (a) ensin tarkistamalla yllä olevat kaaviodokumentit nähdäksesi, soveltuuko apuri, ja (b) kirjaamalla tekninen perustelu hylkäyskommenttiin. Ennakkotapaus: js/stack-trace-exposure, joka nostettiin kutsupaikoissa, jotka jo ohjaavat sanitizeErrorMessage() kautta, on tunnettu CodeQL-rajoitus (räätälöityjä puhdistimia ei tunnisteta) — hylkää false positive viitaten docs/security/ERROR_SANITIZATION.md.
  15. Älä koskaan paljasta reittejä, jotka käynnistävät lapsiprosesseja (/api/mcp/, /api/cli-tools/runtime/) ilman isLocalOnlyPath() luokittelua src/server/authz/routeGuard.ts. Loopback-valvonta tapahtuu ehdottomasti ennen mitään todennustarkistusta — vuotanut JWT tunnelin kautta ei voi laukaista prosessin käynnistämistä. Katso docs/security/ROUTE_GUARD_TIERS.md.
  16. Älä koskaan sisällytä Co-Authored-By-liitteitä, jotka antavat kunnian tekoälyavustajalle, LLM:lle tai automaatiotilille (esim. nimet, joissa esiintyy "Claude", "GPT", "Copilot", "Bot"; sähköpostit osoitteissa anthropic.com / openai.com / bottien omistamissa noreply.github.com-osoitteissa). Tällaiset liitteet ohjaavat commit-attribuution bottitilille GitHubissa, piilottaen oikean kirjoittajan (diegosouzapw) PR-historiassa. Inhimilliset avustajat — mukaan lukien upstream-PR:n kirjoittajat ja issue-raportoijat, joita portataan OmniRouteen — VOIVAT ja PITÄISI saada kunnian vakiomuotoisilla Co-authored-by: Name <email>-liitteillä; upstream-port-työnkulut (/port-upstream-features, /port-upstream-issues) riippuvat tästä.