Files
OmniRoute/src/shared/constants/featureFlagDefinitions.ts
Diego Rodrigues de Sa e Souza 35dbf0eea1 Release v3.8.25 (#3866)
* chore(release): continue v3.8.25 development cycle after main code-sync (r5)

main fast-forwarded to release/v3.8.25 (#3863): unblocked Build+Docker via
#3864, plus #3837 (mimocode proxy) and #3862 (trivy bump). This marker
re-opens the umbrella PR for further v3.8.25 work. No version bump.

* fix(db): persist the Keep-latest-backups retention setting (#3834) (#3867)

* fix(oauth): clear GitLab Duo setup message instead of 500 (#3861) (#3868)

* test(oauth): prove refresh_token preserved on real gemini-cli/antigravity dispatch (#3850) (#3869)

* feat(compression-ui): unified compression config UI — per-engine pages + combos editor + menu + WS default-on (#3860)

Integrated into release/v3.8.25 — feat(compression-ui): unified compression configuration UI (Compression Hub + per-engine Lite/Aggressive/Ultra pages + combos editor + sidebar entry + live-WS default-on). File-size re-baselined for sidebarVisibility.ts/chatCore.ts growth; orphan ws test relocated to a collected path.

* docs(changelog): complete the v3.8.25 release notes + credit all contributors

Audited every commit since v3.8.24 and filled the gaps the [3.8.25] section
was missing: a New Features section (compression engines + Compression Studios
#3848, compression UI #3860, injection-guard #3857, kiro discovery #3836, Veo
#3839, mimocode proxy #3837, Arena ELO flag #3821), 9 more Fixed entries
(#3811/#3807/#3759/#3849/#3838/#3835/#3814/#3820/#3819), a Security section
(CCR IDOR #3859, supply-chain #3824), and an Internal/Quality section. Every
contributor and issue reporter is now credited.

* docs(changelog): restore + complete the v3.8.25 release notes

Re-adds CHANGELOG.md (a prior server-side commit accidentally dropped it) with
the complete, audited [3.8.25] section: New Features, the full Fixed list,
Security & Hardening, and Internal/Quality — every contributor and issue
reporter credited.

* chore(release): finalize v3.8.25 — reconcile CHANGELOG + i18n mirrors, document OMNIROUTE_MAX_PENDING_MIGRATIONS, green the unit suite

Release-gate reconciliation for v3.8.25:
- CHANGELOG: dated 2026-06-14, linked #3826, rolled up file-size re-baselines (#3823/#3833),
  recorded the test-greening; re-synced all 41 i18n CHANGELOG mirrors.
- Documented OMNIROUTE_MAX_PENDING_MIGRATIONS (#3416) in .env.example + ENVIRONMENT.md.
- Greened the unit suite (was merged red on 4 CI shards): aligned 10 stale tests to this
  cycle's intended behavior (#3838/#3822/#3501/SOCKS5/Vertex-Express/Antigravity) and the
  same-provider 503 fall-through test; de-flaked the compression benchmark reproducibility
  and ServiceSupervisor crash tests. No production code changed.

* ci(security): clear OpenSSF Scorecard code-scanning noise + harden workflow token permissions

The Security tab held 155 open alerts, ALL from the advisory OpenSSF Scorecard tool
(#3824) — supply-chain/posture scores, not code vulnerabilities — which drowned out
real CodeQL findings.

- scorecard.yml: stop uploading SARIF to the code-scanning tab (drop the upload-sarif
  step + the now-unused security-events: write). The run still produces the OpenSSF
  badge (publish_results) and a downloadable SARIF artifact.
- TokenPermissions hardening (the high-severity, genuinely-valuable subset): set each
  workflow's top-level token to read-only and grant the exact writes at the job level
  that needs them — npm-publish (id-token/packages on publish jobs), docker-publish
  (packages on build), electron-release (contents on build/release, id-token/packages
  on publish-npm), build-fork (packages on build), claude (empty top-level; job grants
  its own). The 155 existing alerts were dismissed.

Not adopting repo-wide SHA-pinning (143 PinnedDependencies advisories) — declined.

* test(integration): align stale wiring/socks5 integration tests to this cycle's behavior

These were red on the CI Integration job (pre-existing). No production code changed:
- integration-wiring: the combos page no longer renders a per-page EmailPrivacyToggle
  (#3822 consolidated it into Settings → Appearance); the provider-detail test-result
  masking and upstream-proxy copy moved to decomposed components (#3501
  BatchTestResultsModal / UpstreamProxyCard) — assertions now read the owning files.
- api-routes-critical: SOCKS5 is now enabled by default (opt-out), so the disabled-
  rejection test must set ENABLE_SOCKS5_PROXY=false explicitly (an unset env now means
  enabled).

(The ~32 live-Gemini integration tests are gated on OMNIROUTE_API_KEY and skip in CI;
they only 'fail' locally when that key is present without a running server.)
2026-06-15 03:32:11 -03:00

388 lines
13 KiB
TypeScript

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 (6) ────────────────
{
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",
},
// ──────────────── Network (5) ────────────────
{
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: "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: "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: "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 (3) ────────────────
{
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",
},
// ──────────────── Runtime (10) ────────────────
{
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 20129, 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: "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: "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",
},
// ──────────────── CLI (3) ────────────────
{
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",
},
// ──────────────── 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",
},
];