pjandro/OmniRoute
1
0
Fork 0
mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-08-17 12:42:21 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
9bfdc15cbcc1dac4e83a1b0325da0b9143226073
OmniRoute/src/shared/constants/featureFlagDefinitions.ts
Dizzle 94cf4c402a fix(executors): rotate to the next account on network throws when the account has a dedicated proxy (#10402) 
OpencodeExecutor and MimocodeExecutor rotated to the next account only on
HTTP 429. A network exception (timeout, connection refused/reset) on one
account instead propagated out of execute() and failed the whole request,
even when other accounts remained available.

Both executors now rotate on a network exception only when the failed
account has its own dedicated proxy (account.proxy !== null) — a dead
proxy is genuinely account-scoped, so rotating away from it is safe.
Accounts sharing the default egress (no proxy configured) trigger the
same cooldown and are skipped for the rest of the request once the shared
egress is known down, but a later account with its own dedicated proxy is
still tried normally — a throw on a proxy-less account no longer strands
a proxied account further in the rotation. This behavior is gated behind
NETWORK_ROTATION_SHARED_EGRESS_GUARD (Feature Flag, default on); disabled,
it reproduces the immediate-propagation behavior this fix started from.

The shared rotation mechanics (pickAccount/markCooldown/markSuccess) are
extracted into executors/accountRotation.ts, used by both executors —
they had independently implemented the same round-robin+cooldown
skeleton. This also fixes an identical, pre-existing bug in
MimocodeExecutor that predates this PR: its catch block called
markCooldown unconditionally on any throw, with no proxy check and no
warn log (a silent exception swallow on a path that influences the
result).

The cooldown formula for both the proxy and shared-egress cases reuses
the repo's already-established "transient, not clearly attributable"
constants (errorConfig.ts TRANSIENT_COOLDOWN_MS/COOLDOWN_MS.transientMax,
already used by accountFallback.ts for network-error classification)
instead of introducing a separate value.

MimocodeExecutor's network-error 502 body also now goes through
buildErrorBody()/sanitizeErrorMessage() instead of embedding the raw
caught error message directly (Hard Rule #12), matching the sanitization
already used on its #2101 malformed-request path.

Validated by TDD (Hard Rule #18): tests/unit/account-rotation.test.ts
covers the shared module directly; opencode-proxy-rotation-4954.test.ts
and mimocode-executor.test.ts cover the proxy-configured rotation path,
the mixed-fleet case, the shared-egress single-network-call case, and the
NETWORK_ROTATION_SHARED_EGRESS_GUARD-disabled legacy path, for each
executor. tsc, lint, and the provider golden-path gates
(check:provider-consistency, check:provider-assets,
provider-translate-path-golden.test.ts) are clean on all touched files.

Co-authored-by: Max <maxmad64@gmail.com>
2026-08-16 00:16:04 -03:00

581 lines
21 KiB
TypeScript
Raw Blame History

export interface FeatureFlagDefinition {
key: string;
label: string;
description: string;
descriptionI18nKey: string;
category: "security" | "network" | "policies" | "runtime" | "cli" | "health";
defaultValue: string;
type: "boolean" | "enum";
enumValues?: string[];
requiresRestart: boolean;
warningLevel?: "info" | "caution" | "danger";
}
export const FEATURE_FLAG_DEFINITIONS: FeatureFlagDefinition[] = [
// ──────────────── Security (9) ────────────────
{
key: "REQUIRE_API_KEY",
label: "Require API Key",
description: "Require an API key for all incoming requests",
descriptionI18nKey: "featureFlagRequireApiKeyDescription",
category: "security",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "caution",
},
{
key: "INPUT_SANITIZER_ENABLED",
label: "Input Sanitizer",
description: "Enable input sanitization for all requests",
descriptionI18nKey: "featureFlagInputSanitizerEnabledDescription",
category: "security",
defaultValue: "true",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "INJECTION_GUARD_MODE",
label: "Injection Guard Mode",
description: "Set the prompt injection guard mode",
descriptionI18nKey: "featureFlagInjectionGuardModeDescription",
category: "security",
defaultValue: "off",
type: "enum",
enumValues: ["off", "warn", "block", "redact"],
requiresRestart: false,
warningLevel: "info",
},
{
key: "PII_REDACTION_ENABLED",
label: "PII Redaction",
description: "Redact personally identifiable information from requests",
descriptionI18nKey: "featureFlagPiiRedactionEnabledDescription",
category: "security",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "PII_RESPONSE_SANITIZATION",
label: "PII Response Sanitization",
description: "Sanitize PII from provider responses",
descriptionI18nKey: "featureFlagPiiResponseSanitizationDescription",
category: "security",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "PII_RESPONSE_SANITIZATION_MODE",
label: "PII Response Sanitization Mode",
description:
"Mode for PII response sanitization: redact (replace PII), warn (log only), block (reject), off (disable)",
descriptionI18nKey: "featureFlagPiiResponseSanitizationModeDescription",
category: "security",
defaultValue: "redact",
type: "enum",
enumValues: ["redact", "warn", "block", "off"],
requiresRestart: false,
warningLevel: "info",
},
{
key: "OUTBOUND_SSRF_GUARD_ENABLED",
label: "SSRF Guard",
description: "Block outbound requests to private/internal IP ranges",
descriptionI18nKey: "featureFlagOutboundSsrfGuardEnabledDescription",
category: "security",
defaultValue: "true",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "ALLOW_API_KEY_REVEAL",
label: "API Key Reveal",
description:
"Allow authenticated dashboard users to reveal stored API keys instead of only seeing masked values.",
descriptionI18nKey: "featureFlagAllowApiKeyRevealDescription",
category: "security",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "danger",
},
// ──────────────── Network (7) ────────────────
{
key: "ENABLE_TLS_FINGERPRINT",
label: "TLS Fingerprint",
description: "Enable TLS fingerprint stealth mode",
descriptionI18nKey: "featureFlagEnableTlsFingerprintDescription",
category: "network",
defaultValue: "false",
type: "boolean",
requiresRestart: true,
warningLevel: "info",
},
{
key: "AUDIO_REMOTE_PROVIDER_NODES",
label: "Remote Audio Provider Nodes",
description:
"Allow the /v1/audio/* routes to use OpenAI-compatible provider nodes hosted outside localhost. Off by default — routing audio to a remote host changes egress identity and must be an explicit operator decision. Loopback nodes are always allowed and unaffected.",
descriptionI18nKey: "settings.featureFlags.audioRemoteProviderNodes",
category: "network",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "danger",
},
{
key: "ONEPROXY_ENABLED",
label: "OneProxy Enabled",
description: "Enable 1proxy request proxying.",
descriptionI18nKey: "settings.featureFlags.oneproxyEnabled",
category: "network",
defaultValue: "true",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "PROXY_AUTO_SELECT_ENABLED",
label: "Proxy Auto-Selection Fallback",
description:
"When no proxy is assigned to a connection, auto-select the first working proxy from the registry. Off by default — otherwise any single registry proxy becomes a global fallback for all traffic (#3332).",
descriptionI18nKey: "settings.featureFlags.proxyAutoSelectEnabled",
category: "network",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "caution",
},
{
key: "OMNIROUTE_CONTROL_PLANE_PROXY_DIRECT_FALLBACK",
label: "Control-Plane Proxy Direct Fallback",
description:
"Allow OAuth and provider validation flows to bypass a pinned proxy and connect directly when proxy reachability pre-checks fail. Off by default because this can change account egress IP.",
descriptionI18nKey: "featureFlagOmnirouteControlPlaneProxyDirectFallbackDescription",
category: "network",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "danger",
},
{
key: "NETWORK_ROTATION_SHARED_EGRESS_GUARD",
label: "Network Rotation Shared-Egress Guard",
description:
"On a network exception (timeout, connection refused/reset) for a multi-account rotation executor, when the failing account has no dedicated proxy, apply a short cooldown and skip other proxy-less accounts for the rest of the request instead of retrying each one. On by default (safe: no egress IP change, only reduces latency/cooldown risk on shared-egress accounts). Disable to restore immediate propagation on the first proxy-less throw.",
descriptionI18nKey: "featureFlagNetworkRotationSharedEgressGuardDescription",
category: "network",
defaultValue: "true",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "MITM_DISABLE_TLS_VERIFY",
label: "Disable TLS Verify (MITM)",
description: "Disable TLS certificate verification for MITM proxy",
descriptionI18nKey: "featureFlagMitmDisableTlsVerifyDescription",
category: "network",
defaultValue: "false",
type: "boolean",
requiresRestart: true,
warningLevel: "danger",
},
{
key: "OMNIROUTE_ALLOW_PRIVATE_PROVIDER_URLS",
label: "Allow Private Provider URLs",
description: "Allow provider URLs pointing to private/internal networks",
descriptionI18nKey: "featureFlagOmnirouteAllowPrivateProviderUrlsDescription",
category: "network",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "caution",
},
{
key: "OMNIROUTE_ALLOW_LOCAL_PROVIDER_URLS",
label: "Allow Local Provider URLs",
description:
"Allow adding and validating providers on local/private addresses (127.0.0.1, localhost, LAN, private IP ranges) — needed for local OpenAI-compatible models. Enabled by default (OmniRoute is local-first); turn it OFF to enforce strict public-only blocking if you only use public providers. Cloud-metadata endpoints (e.g. 169.254.169.254) stay blocked either way.",
descriptionI18nKey: "featureFlagOmnirouteAllowLocalProviderUrlsDescription",
category: "network",
defaultValue: "true",
type: "boolean",
requiresRestart: false,
warningLevel: "caution",
},
{
key: "ENABLE_CC_COMPATIBLE_PROVIDER",
label: "CC Compatible Provider",
description: "Enable Claude Code compatible provider mode",
descriptionI18nKey: "featureFlagEnableCcCompatibleProviderDescription",
category: "network",
defaultValue: "false",
type: "boolean",
requiresRestart: true,
warningLevel: "info",
},
// ──────────────── Policies (4) ────────────────
{
key: "TOOL_POLICY_MODE",
label: "Tool Policy Mode",
description: "Set the tool use policy enforcement mode",
descriptionI18nKey: "featureFlagToolPolicyModeDescription",
category: "policies",
defaultValue: "disabled",
type: "enum",
enumValues: ["disabled", "warn", "block"],
requiresRestart: false,
warningLevel: "info",
},
{
key: "RATE_LIMIT_AUTO_ENABLE",
label: "Rate Limit Auto-Enable",
description: "Automatically enable rate limiting based on usage patterns",
descriptionI18nKey: "featureFlagRateLimitAutoEnableDescription",
category: "policies",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "ALLOW_MULTI_CONNECTIONS_PER_COMPAT_NODE",
label: "Multi Connections per Compat Node",
description: "Allow multiple connections per compatibility node",
descriptionI18nKey: "featureFlagAllowMultiConnectionsPerCompatNodeDescription",
category: "policies",
defaultValue: "false",
type: "boolean",
requiresRestart: true,
warningLevel: "info",
},
{
key: "CAPABILITY_FILTER_ENABLED",
label: "Capability Filter",
description:
"Reject requests before dispatch when the target model lacks required capabilities (vision, tools, structured output, context window). Protects direct single-provider requests that bypass the combo-layer compatibility filter.",
descriptionI18nKey: "featureFlagCapabilityFilterEnabledDescription",
category: "policies",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "caution",
},
{
key: "RADAR_ENABLED",
label: "Radar",
description:
"Enable the OmniRoute Radar module (catalog feed screens and sync). Off by default; enabling only unlocks the UI — data sync remains a separate opt-in.",
descriptionI18nKey: "featureFlagRadarEnabledDescription",
category: "policies",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
// ──────────────── Runtime (16) ────────────────
{
key: "RESPONSES_PASSTHROUGH_DROP_COMMENTARY",
label: "Drop Responses Commentary",
description:
"Drop internal commentary-phase output items from Responses API passthrough streams before forwarding to clients. Disable to receive raw upstream commentary.",
descriptionI18nKey: "featureFlagResponsesPassthroughDropCommentaryDescription",
category: "runtime",
defaultValue: "true",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "OMNIROUTE_MCP_ENFORCE_SCOPES",
label: "MCP Enforce Scopes",
description: "Enforce scope restrictions on MCP tool access",
descriptionI18nKey: "featureFlagOmnirouteMcpEnforceScopesDescription",
category: "runtime",
defaultValue: "true",
type: "boolean",
requiresRestart: false,
warningLevel: "caution",
},
{
key: "OMNIROUTE_MCP_COMPRESS_DESCRIPTIONS",
label: "MCP Compress Descriptions",
description: "Compress MCP tool descriptions to reduce token usage",
descriptionI18nKey: "featureFlagOmnirouteMcpCompressDescriptionsDescription",
category: "runtime",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "OMNIROUTE_ENABLE_RUNTIME_BACKGROUND_TASKS",
label: "Runtime Background Tasks",
description: "Enable background task processing at runtime",
descriptionI18nKey: "featureFlagOmnirouteEnableRuntimeBackgroundTasksDescription",
category: "runtime",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "OMNIROUTE_DISABLE_BACKGROUND_SERVICES",
label: "Disable Background Services",
description: "Disable all background services (quota refresh, sync, etc)",
descriptionI18nKey: "featureFlagOmnirouteDisableBackgroundServicesDescription",
category: "runtime",
defaultValue: "false",
type: "boolean",
requiresRestart: true,
warningLevel: "caution",
},
{
key: "OMNIROUTE_RTK_TRUST_PROJECT_FILTERS",
label: "RTK Trust Project Filters",
description: "Trust project-level filters from RTK without validation",
descriptionI18nKey: "featureFlagOmnirouteRtkTrustProjectFiltersDescription",
category: "runtime",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "caution",
},
{
key: "OMNIROUTE_ENABLE_LIVE_WS",
label: "Live Dashboard WebSocket",
description:
"Start the real-time dashboard WebSocket server on import (port 20132, loopback-bound by default). Default: enabled. Set to '0' or 'false' to disable. LAN exposure requires LIVE_WS_HOST=0.0.0.0 + LIVE_WS_ALLOWED_ORIGINS.",
descriptionI18nKey: "featureFlagOmnirouteEnableLiveWsDescription",
category: "runtime",
defaultValue: "true",
type: "boolean",
requiresRestart: true,
warningLevel: "info",
},
{
key: "OMNIROUTE_CODEX_WS_ENABLED",
label: "Codex Responses WebSocket",
description:
"Allow Codex to use the Responses-over-WebSocket transport (the codex CLI WS endpoint and codexTransport=websocket). When off, Codex falls back to HTTP Responses.",
descriptionI18nKey: "featureFlagOmnirouteCodexWsEnabledDescription",
category: "runtime",
defaultValue: "true",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "OMNIROUTE_EMERGENCY_FALLBACK",
label: "Emergency Fallback",
description: "Route budget-exhausted requests to the emergency free fallback provider/model.",
descriptionI18nKey: "featureFlagOmnirouteEmergencyFallbackDescription",
category: "runtime",
defaultValue: "true",
type: "boolean",
requiresRestart: false,
warningLevel: "caution",
},
{
key: "STREAM_RECOVERY_ENABLED",
label: "Stream Recovery",
description:
"Enable transparent early retry for truncated upstream SSE streams before any response bytes reach the client.",
descriptionI18nKey: "featureFlagStreamRecoveryEnabledDescription",
category: "runtime",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "caution",
},
{
key: "STREAM_RECOVERY_MIDSTREAM_ENABLED",
label: "Mid-Stream Continuation",
description:
"Allow stream recovery to re-request and stitch a response after bytes have already reached the client.",
descriptionI18nKey: "featureFlagStreamRecoveryMidstreamEnabledDescription",
category: "runtime",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "danger",
},
{
key: "MODEL_CATALOG_INCLUDE_NAMES",
label: "Model Catalog Names",
description:
"Include display-friendly name fields in /v1/models responses. Disable for clients that expect model IDs only.",
descriptionI18nKey: "settings.featureFlags.modelCatalogIncludeNames",
category: "runtime",
defaultValue: "true",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "MODELS_CATALOG_PREFIX_MODE",
label: "Models Catalog Prefix Mode",
description:
"Controls how model IDs are prefixed in /v1/models. 'dual' (default) emits both alias and canonical provider-id prefixes for backward compatibility. 'alias' emits only the short alias prefix (e.g. ds-web/model, not deepseek-web/model). 'canonical' emits only the full provider-id prefix.",
descriptionI18nKey: "featureFlagModelsCatalogPrefixModeDescription",
category: "runtime",
defaultValue: "dual",
type: "enum",
enumValues: ["dual", "alias", "canonical"],
requiresRestart: false,
warningLevel: "info",
},
{
key: "ARENA_ELO_SYNC_ENABLED",
label: "Arena ELO Sync",
description: "Enable periodic Arena AI leaderboard ELO sync for model intelligence rankings.",
descriptionI18nKey: "featureFlagArenaEloSyncEnabledDescription",
category: "runtime",
defaultValue: "true",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "EXPOSE_CC_DISCOVERY_ALIASES",
label: "Claude Code Discovery Aliases",
description:
"Advertise claude/<provider>/<model> mirror ids on /v1/models so Claude Code gateway model discovery lists non-Claude models. Warning: doubles catalog entries for all clients when enabled globally.",
descriptionI18nKey: "featureFlagExposeCcDiscoveryAliasesDescription",
category: "runtime",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "EXPOSE_FUNCTIONAL_GATEWAY_MIRRORS",
label: "Functional Gateway Mirrors",
description:
"Advertise <gateway-alias>/<model> mirror ids on /v1/models for models whose canonical owner has no active credential but a passthrough gateway with an active credential routes them. Warning: adds catalog entries for all clients when enabled globally.",
descriptionI18nKey: "featureFlagExposeFunctionalGatewayMirrorsDescription",
category: "runtime",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "NEWAPI_AGGREGATOR_BALANCE",
label: "New-API Aggregator Balance",
description:
"Enable balance detection for New-API / One-API / Sub2API aggregator compatible nodes. When enabled, compatible nodes with the aggregator flag set will report their balance in the dashboard and quota-preflight routing.",
descriptionI18nKey: "featureFlagNewApiAggregatorBalanceDescription",
category: "runtime",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
// ──────────────── CLI (5) ────────────────
{
key: "CLI_COMPAT_ALL",
label: "CLI Compat All",
description: "Enable compatibility mode for all CLI clients",
descriptionI18nKey: "featureFlagCliCompatAllDescription",
category: "cli",
defaultValue: "false",
type: "boolean",
requiresRestart: true,
warningLevel: "info",
},
{
key: "MODEL_ALIAS_COMPAT_ENABLED",
label: "Model Alias Compat",
description: "Enable model alias compatibility layer",
descriptionI18nKey: "featureFlagModelAliasCompatEnabledDescription",
category: "cli",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "PRICING_SYNC_ENABLED",
label: "Pricing Sync",
description:
"Enable automatic pricing data synchronization (requires the PRICING_SYNC_ENABLED environment variable to be set to true)",
descriptionI18nKey: "featureFlagPricingSyncEnabledDescription",
category: "cli",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "OMNIROUTE_AUTO_SYNC_CODEX_PROFILES",
label: "Auto-Sync Codex Profiles",
description:
"After a provider model sync, automatically (re)write ~/.codex/*.config.toml profile files from the live catalog. Never changes the active/default Codex config. Off by default.",
descriptionI18nKey: "featureFlagOmnirouteAutoSyncCodexProfilesDescription",
category: "cli",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "caution",
},
{
key: "OMNIROUTE_AUTO_SYNC_CLAUDE_PROFILES",
label: "Auto-Sync Claude Code Profiles",
description:
"After a provider model sync, automatically (re)write ~/.claude/profiles/<name>/settings.json Claude Code profiles from the live catalog. Never changes the active/default Claude config. Off by default.",
descriptionI18nKey: "featureFlagOmnirouteAutoSyncClaudeProfilesDescription",
category: "cli",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "caution",
},
// ──────────────── Health (3) ────────────────
{
key: "OMNIROUTE_DISABLE_LOCAL_HEALTHCHECK",
label: "Disable Local Health Check",
description: "Disable the local instance health check endpoint",
descriptionI18nKey: "featureFlagOmnirouteDisableLocalHealthcheckDescription",
category: "health",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "OMNIROUTE_DISABLE_TOKEN_HEALTHCHECK",
label: "Disable Token Health Check",
description: "Disable the token validation health check",
descriptionI18nKey: "featureFlagOmnirouteDisableTokenHealthcheckDescription",
category: "health",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "info",
},
{
key: "SKILLS_SANDBOX_NETWORK_ENABLED",
label: "Skills Sandbox Network",
description: "Enable network access in the skills sandbox environment",
descriptionI18nKey: "featureFlagSkillsSandboxNetworkEnabledDescription",
category: "health",
defaultValue: "false",
type: "boolean",
requiresRestart: false,
warningLevel: "caution",
},
];
Reference in New Issue View Git Blame Copy Permalink