change cloud feature flags to be loaded dynamically at runtime rather than set in build (#6246)

## Summary

Implements server-side remote configuration to decouple runtime behavior
from build artifacts, enabling dynamic configuration updates without
redeployment.

## Technical Changes

- **Replaced** build-time constants (`__MIXPANEL_TOKEN__`,
`__BUILD_FLAGS__`) with runtime configuration loaded from
`/api/features`
- Configuration now sourced from `window.__CONFIG__` (hydrated from
`/api/features` endpoint)
- **Added** `src/platform/remoteConfig/` service that polls server
configuration every 30 seconds
- **Modified** application bootstrap sequence in `main.ts` to load
remote config before module initialization (required for cloud builds)
- **Removed** global constants: `__BUILD_FLAGS__`, `__MIXPANEL_TOKEN__`.
Runtime subscription enforcement toggle via `subscription_required` flag
- Server health alerts with variant-based severity rendering
(info/warning/error) via topbar badges

## Rationale

- **Build-once-deploy-anywhere**: Single immutable artifact promoted
through environments (staging → production)
- **Zero-downtime configuration**: Update behavior without rebuilding or
redeploying the application
- **Incident response**: Disable features or display alerts dynamically
in response to outages or degraded service
- **Instant rollback**: Revert configuration changes server-side without
artifact redeployment
- **Progressive delivery**: Enable A/B testing, canary releases, and
user/region-based configuration
- **Environment parity**: Eliminate configuration drift between staging
and production builds
- Decouples deployment cadence from configuration changes
- Enables GitOps workflows for configuration management separate from
code deployments
- Supports real-time operational control of client behavior
- Reduces build matrix complexity (no per-environment builds)

┆Issue is synchronized with this [Notion
page](https://www.notion.so/PR-6246-change-cloud-feature-flags-to-be-loaded-dynamically-at-runtime-rather-than-set-in-build-2966d73d3650811cbb41c9093961037a)
by [Unito](https://www.unito.io)
This commit is contained in:
Christian Byrne
2025-10-23 20:16:18 -07:00
committed by GitHub
parent a3bfc2e91a
commit d7a58a7a9b
24 changed files with 354 additions and 107 deletions

View File

@@ -27,7 +27,7 @@ interface CloudSubscriptionStatusResponse {
const subscriptionStatus = ref<CloudSubscriptionStatusResponse | null>(null)
const isActiveSubscription = computed(() => {
if (!isCloud || !__BUILD_FLAGS__.REQUIRE_SUBSCRIPTION) return true
if (!isCloud || !window.__CONFIG__?.subscription_required) return true
return subscriptionStatus.value?.is_active ?? false
})

View File

@@ -0,0 +1,45 @@
/**
* Remote configuration service
*
* Fetches configuration from the server at runtime, enabling:
* - Feature flags without rebuilding
* - Server-side feature discovery
* - Version compatibility management
* - Avoiding vendor lock-in for native apps
*
* This module is tree-shaken in OSS builds.
* Used for initial config load in main.ts and polling in the extension.
*/
import { ref } from 'vue'
import type { RemoteConfig } from './types'
/**
* Reactive remote configuration
* Updated whenever config is loaded from the server
*/
export const remoteConfig = ref<RemoteConfig>({})
/**
* Loads remote configuration from the backend /api/features endpoint
* and updates the reactive remoteConfig ref
*/
export async function loadRemoteConfig(): Promise<void> {
try {
const response = await fetch('/api/features', { cache: 'no-store' })
if (response.ok) {
const config = await response.json()
window.__CONFIG__ = config
remoteConfig.value = config
} else {
console.warn('Failed to load remote config:', response.statusText)
window.__CONFIG__ = {}
remoteConfig.value = {}
}
} catch (error) {
console.error('Failed to fetch remote config:', error)
window.__CONFIG__ = {}
remoteConfig.value = {}
}
}

View File

@@ -0,0 +1,19 @@
/**
* Server health alert configuration from the backend
*/
type ServerHealthAlert = {
message: string
tooltip?: string
severity?: 'info' | 'warning' | 'error'
badge?: string
}
/**
* Remote configuration type
* Configuration fetched from the server at runtime
*/
export type RemoteConfig = {
mixpanel_token?: string
subscription_required?: boolean
server_health_alert?: ServerHealthAlert
}

View File

@@ -81,7 +81,7 @@ export function useSettingUI(
}
const subscriptionPanel: SettingPanelItem | null =
!isCloud || !__BUILD_FLAGS__.REQUIRE_SUBSCRIPTION
!isCloud || !window.__CONFIG__?.subscription_required
? null
: {
node: {
@@ -149,7 +149,9 @@ export function useSettingUI(
keybindingPanel,
extensionPanel,
...(isElectron() ? [serverConfigPanel] : []),
...(isCloud && __BUILD_FLAGS__.REQUIRE_SUBSCRIPTION && subscriptionPanel
...(isCloud &&
window.__CONFIG__?.subscription_required &&
subscriptionPanel
? [subscriptionPanel]
: [])
].filter((panel) => panel.component)
@@ -185,12 +187,12 @@ export function useSettingUI(
userPanel.node,
...(isLoggedIn.value &&
isCloud &&
__BUILD_FLAGS__.REQUIRE_SUBSCRIPTION &&
window.__CONFIG__?.subscription_required &&
subscriptionPanel
? [subscriptionPanel.node]
: []),
...(isLoggedIn.value &&
!(isCloud && __BUILD_FLAGS__.REQUIRE_SUBSCRIPTION)
!(isCloud && window.__CONFIG__?.subscription_required)
? [creditsPanel.node]
: [])
].map(translateCategory)

View File

@@ -7,6 +7,8 @@ import { useWorkflowTemplatesStore } from '@/platform/workflow/templates/reposit
import type {
AuthMetadata,
ExecutionContext,
ExecutionErrorMetadata,
ExecutionSuccessMetadata,
RunButtonProperties,
SurveyResponses,
TelemetryEventName,
@@ -40,7 +42,7 @@ export class MixpanelTelemetryProvider implements TelemetryProvider {
private isInitialized = false
constructor() {
const token = __MIXPANEL_TOKEN__
const token = window.__CONFIG__?.mixpanel_token
if (token) {
try {
@@ -74,7 +76,7 @@ export class MixpanelTelemetryProvider implements TelemetryProvider {
this.isEnabled = false
}
} else {
console.warn('Mixpanel token not provided')
console.warn('Mixpanel token not provided in runtime config')
this.isEnabled = false
}
}
@@ -178,7 +180,15 @@ export class MixpanelTelemetryProvider implements TelemetryProvider {
trackWorkflowExecution(): void {
const context = this.getExecutionContext()
this.trackEvent(TelemetryEvents.WORKFLOW_EXECUTION_STARTED, context)
this.trackEvent(TelemetryEvents.EXECUTION_START, context)
}
trackExecutionError(metadata: ExecutionErrorMetadata): void {
this.trackEvent(TelemetryEvents.EXECUTION_ERROR, metadata)
}
trackExecutionSuccess(metadata: ExecutionSuccessMetadata): void {
this.trackEvent(TelemetryEvents.EXECUTION_SUCCESS, metadata)
}
getExecutionContext(): ExecutionContext {

View File

@@ -59,6 +59,23 @@ export interface ExecutionContext {
template_license?: string
}
/**
* Execution error metadata
*/
export interface ExecutionErrorMetadata {
jobId: string
nodeId?: string
nodeType?: string
error?: string
}
/**
* Execution success metadata
*/
export interface ExecutionSuccessMetadata {
jobId: string
}
/**
* Template metadata for workflow tracking
*/
@@ -94,34 +111,42 @@ export interface TelemetryProvider {
// Workflow execution events
trackWorkflowExecution(): void
trackExecutionError(metadata: ExecutionErrorMetadata): void
trackExecutionSuccess(metadata: ExecutionSuccessMetadata): void
}
/**
* Telemetry event constants
*
* Event naming conventions:
* - 'app:' prefix: UI/user interaction events
* - No prefix: Backend/system events (execution lifecycle)
*/
export const TelemetryEvents = {
// Authentication Flow
USER_AUTH_COMPLETED: 'user_auth_completed',
USER_AUTH_COMPLETED: 'app:user_auth_completed',
// Subscription Flow
RUN_BUTTON_CLICKED: 'run_button_clicked',
SUBSCRIPTION_REQUIRED_MODAL_OPENED: 'subscription_required_modal_opened',
SUBSCRIBE_NOW_BUTTON_CLICKED: 'subscribe_now_button_clicked',
RUN_BUTTON_CLICKED: 'app:run_button_click',
SUBSCRIPTION_REQUIRED_MODAL_OPENED: 'app:subscription_required_modal_opened',
SUBSCRIBE_NOW_BUTTON_CLICKED: 'app:subscribe_now_button_clicked',
// Onboarding Survey
USER_SURVEY_OPENED: 'user_survey_opened',
USER_SURVEY_SUBMITTED: 'user_survey_submitted',
USER_SURVEY_OPENED: 'app:user_survey_opened',
USER_SURVEY_SUBMITTED: 'app:user_survey_submitted',
// Email Verification
USER_EMAIL_VERIFY_OPENED: 'user_email_verify_opened',
USER_EMAIL_VERIFY_REQUESTED: 'user_email_verify_requested',
USER_EMAIL_VERIFY_COMPLETED: 'user_email_verify_completed',
USER_EMAIL_VERIFY_OPENED: 'app:user_email_verify_opened',
USER_EMAIL_VERIFY_REQUESTED: 'app:user_email_verify_requested',
USER_EMAIL_VERIFY_COMPLETED: 'app:user_email_verify_completed',
// Template Tracking
TEMPLATE_WORKFLOW_OPENED: 'template_workflow_opened',
TEMPLATE_WORKFLOW_OPENED: 'app:template_workflow_opened',
// Workflow Execution Tracking
WORKFLOW_EXECUTION_STARTED: 'workflow_execution_started'
// Execution Lifecycle
EXECUTION_START: 'execution_start',
EXECUTION_ERROR: 'execution_error',
EXECUTION_SUCCESS: 'execution_success'
} as const
export type TelemetryEventName =
@@ -136,3 +161,5 @@ export type TelemetryEventProperties =
| TemplateMetadata
| ExecutionContext
| RunButtonProperties
| ExecutionErrorMetadata
| ExecutionSuccessMetadata