mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-04-29 18:52:19 +00:00
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:
15
global.d.ts
vendored
15
global.d.ts
vendored
@@ -4,12 +4,19 @@ declare const __SENTRY_DSN__: string
|
|||||||
declare const __ALGOLIA_APP_ID__: string
|
declare const __ALGOLIA_APP_ID__: string
|
||||||
declare const __ALGOLIA_API_KEY__: string
|
declare const __ALGOLIA_API_KEY__: string
|
||||||
declare const __USE_PROD_CONFIG__: boolean
|
declare const __USE_PROD_CONFIG__: boolean
|
||||||
declare const __MIXPANEL_TOKEN__: string
|
|
||||||
|
|
||||||
type BuildFeatureFlags = {
|
interface Window {
|
||||||
REQUIRE_SUBSCRIPTION: boolean
|
__CONFIG__: {
|
||||||
|
mixpanel_token?: string
|
||||||
|
subscription_required?: boolean
|
||||||
|
server_health_alert?: {
|
||||||
|
message: string
|
||||||
|
tooltip?: string
|
||||||
|
severity?: 'info' | 'warning' | 'error'
|
||||||
|
badge?: string
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
declare const __BUILD_FLAGS__: BuildFeatureFlags
|
|
||||||
|
|
||||||
interface Navigator {
|
interface Navigator {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -2,6 +2,6 @@ import { defineAsyncComponent } from 'vue'
|
|||||||
|
|
||||||
import { isCloud } from '@/platform/distribution/types'
|
import { isCloud } from '@/platform/distribution/types'
|
||||||
|
|
||||||
export default isCloud && __BUILD_FLAGS__.REQUIRE_SUBSCRIPTION
|
export default isCloud && window.__CONFIG__?.subscription_required
|
||||||
? defineAsyncComponent(() => import('./CloudRunButtonWrapper.vue'))
|
? defineAsyncComponent(() => import('./CloudRunButtonWrapper.vue'))
|
||||||
: defineAsyncComponent(() => import('./ComfyQueueButton.vue'))
|
: defineAsyncComponent(() => import('./ComfyQueueButton.vue'))
|
||||||
|
|||||||
@@ -12,7 +12,7 @@
|
|||||||
v-if="isNativeWindow() && workflowTabsPosition !== 'Topbar'"
|
v-if="isNativeWindow() && workflowTabsPosition !== 'Topbar'"
|
||||||
class="app-drag fixed top-0 left-0 z-10 h-[var(--comfy-topbar-height)] w-full"
|
class="app-drag fixed top-0 left-0 z-10 h-[var(--comfy-topbar-height)] w-full"
|
||||||
/>
|
/>
|
||||||
<div class="flex">
|
<div class="flex h-full items-center">
|
||||||
<WorkflowTabs />
|
<WorkflowTabs />
|
||||||
<TopbarBadges />
|
<TopbarBadges />
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -1,39 +1,83 @@
|
|||||||
<template>
|
<template>
|
||||||
<div
|
<div
|
||||||
class="flex items-center gap-2 bg-comfy-menu-secondary"
|
v-tooltip="badge.tooltip"
|
||||||
|
class="flex h-full shrink-0 items-center gap-2 whitespace-nowrap"
|
||||||
:class="[{ 'flex-row-reverse': reverseOrder }, noPadding ? '' : 'px-3']"
|
:class="[{ 'flex-row-reverse': reverseOrder }, noPadding ? '' : 'px-3']"
|
||||||
|
:style="{ backgroundColor: 'var(--comfy-menu-bg)' }"
|
||||||
>
|
>
|
||||||
|
<i
|
||||||
|
v-if="iconClass"
|
||||||
|
:class="['shrink-0 text-base', iconClass, iconColorClass]"
|
||||||
|
/>
|
||||||
<div
|
<div
|
||||||
v-if="badge.label"
|
v-if="badge.label"
|
||||||
class="rounded-full bg-white px-1.5 py-0.5 text-xxxs font-semibold text-black"
|
class="shrink-0 rounded-full px-1.5 py-0.5 text-xxxs font-semibold"
|
||||||
:class="labelClass"
|
:class="labelClasses"
|
||||||
>
|
>
|
||||||
{{ badge.label }}
|
{{ badge.label }}
|
||||||
</div>
|
</div>
|
||||||
<div
|
<div class="font-inter text-sm font-extrabold" :class="textClasses">
|
||||||
class="font-inter text-sm font-extrabold text-slate-100"
|
|
||||||
:class="textClass"
|
|
||||||
>
|
|
||||||
{{ badge.text }}
|
{{ badge.text }}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
|
import { computed } from 'vue'
|
||||||
|
|
||||||
import type { TopbarBadge } from '@/types/comfy'
|
import type { TopbarBadge } from '@/types/comfy'
|
||||||
|
|
||||||
withDefaults(
|
const props = withDefaults(
|
||||||
defineProps<{
|
defineProps<{
|
||||||
badge: TopbarBadge
|
badge: TopbarBadge
|
||||||
reverseOrder?: boolean
|
reverseOrder?: boolean
|
||||||
noPadding?: boolean
|
noPadding?: boolean
|
||||||
labelClass?: string
|
|
||||||
textClass?: string
|
|
||||||
}>(),
|
}>(),
|
||||||
{
|
{
|
||||||
reverseOrder: false,
|
reverseOrder: false,
|
||||||
noPadding: false,
|
noPadding: false
|
||||||
labelClass: '',
|
|
||||||
textClass: ''
|
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const variant = computed(() => props.badge.variant ?? 'info')
|
||||||
|
|
||||||
|
const labelClasses = computed(() => {
|
||||||
|
switch (variant.value) {
|
||||||
|
case 'error':
|
||||||
|
return 'bg-danger-100 text-white'
|
||||||
|
case 'warning':
|
||||||
|
return 'bg-warning-100 text-black'
|
||||||
|
case 'info':
|
||||||
|
default:
|
||||||
|
return 'bg-white text-black'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
const textClasses = computed(() => {
|
||||||
|
switch (variant.value) {
|
||||||
|
case 'error':
|
||||||
|
return 'text-danger-100'
|
||||||
|
case 'warning':
|
||||||
|
return 'text-warning-100'
|
||||||
|
case 'info':
|
||||||
|
default:
|
||||||
|
return 'text-slate-100'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
const iconColorClass = computed(() => textClasses.value)
|
||||||
|
|
||||||
|
const iconClass = computed(() => {
|
||||||
|
if (props.badge.icon) {
|
||||||
|
return props.badge.icon
|
||||||
|
}
|
||||||
|
switch (variant.value) {
|
||||||
|
case 'error':
|
||||||
|
return 'pi pi-exclamation-circle'
|
||||||
|
case 'warning':
|
||||||
|
return 'pi pi-exclamation-triangle'
|
||||||
|
case 'info':
|
||||||
|
default:
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
|
})
|
||||||
</script>
|
</script>
|
||||||
|
|||||||
@@ -1,18 +1,18 @@
|
|||||||
<template>
|
<template>
|
||||||
<div class="flex">
|
<div v-if="notMobile" class="flex h-full shrink-0 items-center">
|
||||||
<TopbarBadge
|
<TopbarBadge
|
||||||
v-for="badge in topbarBadgeStore.badges"
|
v-for="badge in topbarBadgeStore.badges"
|
||||||
:key="badge.text"
|
:key="badge.text"
|
||||||
:badge
|
:badge
|
||||||
:reverse-order="reverseOrder"
|
:reverse-order="reverseOrder"
|
||||||
:no-padding="noPadding"
|
:no-padding="noPadding"
|
||||||
:label-class="labelClass"
|
|
||||||
:text-class="textClass"
|
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<script lang="ts" setup>
|
<script lang="ts" setup>
|
||||||
|
import { useBreakpoints } from '@vueuse/core'
|
||||||
|
|
||||||
import { useTopbarBadgeStore } from '@/stores/topbarBadgeStore'
|
import { useTopbarBadgeStore } from '@/stores/topbarBadgeStore'
|
||||||
|
|
||||||
import TopbarBadge from './TopbarBadge.vue'
|
import TopbarBadge from './TopbarBadge.vue'
|
||||||
@@ -21,16 +21,16 @@ withDefaults(
|
|||||||
defineProps<{
|
defineProps<{
|
||||||
reverseOrder?: boolean
|
reverseOrder?: boolean
|
||||||
noPadding?: boolean
|
noPadding?: boolean
|
||||||
labelClass?: string
|
|
||||||
textClass?: string
|
|
||||||
}>(),
|
}>(),
|
||||||
{
|
{
|
||||||
reverseOrder: false,
|
reverseOrder: false,
|
||||||
noPadding: false,
|
noPadding: false
|
||||||
labelClass: '',
|
|
||||||
textClass: ''
|
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const BREAKPOINTS = { md: 880 }
|
||||||
|
const breakpoints = useBreakpoints(BREAKPOINTS)
|
||||||
|
const notMobile = breakpoints.greater('md')
|
||||||
|
|
||||||
const topbarBadgeStore = useTopbarBadgeStore()
|
const topbarBadgeStore = useTopbarBadgeStore()
|
||||||
</script>
|
</script>
|
||||||
|
|||||||
@@ -1,12 +0,0 @@
|
|||||||
import { t } from '@/i18n'
|
|
||||||
import { useExtensionService } from '@/services/extensionService'
|
|
||||||
|
|
||||||
useExtensionService().registerExtension({
|
|
||||||
name: 'Comfy.CloudBadge',
|
|
||||||
topbarBadges: [
|
|
||||||
{
|
|
||||||
label: t('g.beta'),
|
|
||||||
text: 'Comfy Cloud'
|
|
||||||
}
|
|
||||||
]
|
|
||||||
})
|
|
||||||
36
src/extensions/core/cloudBadges.ts
Normal file
36
src/extensions/core/cloudBadges.ts
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
import { computed } from 'vue'
|
||||||
|
|
||||||
|
import { remoteConfig } from '@/platform/remoteConfig/remoteConfig'
|
||||||
|
import { t } from '@/i18n'
|
||||||
|
import { useExtensionService } from '@/services/extensionService'
|
||||||
|
import type { TopbarBadge } from '@/types/comfy'
|
||||||
|
|
||||||
|
const badges = computed<TopbarBadge[]>(() => {
|
||||||
|
const result: TopbarBadge[] = []
|
||||||
|
|
||||||
|
// Add server health alert first (if present)
|
||||||
|
const alert = remoteConfig.value.server_health_alert
|
||||||
|
if (alert) {
|
||||||
|
result.push({
|
||||||
|
text: alert.message,
|
||||||
|
label: alert.badge,
|
||||||
|
variant: alert.severity ?? 'error',
|
||||||
|
tooltip: alert.tooltip
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Always add cloud badge last (furthest right)
|
||||||
|
result.push({
|
||||||
|
label: t('g.beta'),
|
||||||
|
text: 'Comfy Cloud'
|
||||||
|
})
|
||||||
|
|
||||||
|
return result
|
||||||
|
})
|
||||||
|
|
||||||
|
useExtensionService().registerExtension({
|
||||||
|
name: 'Comfy.Cloud.Badges',
|
||||||
|
get topbarBadges() {
|
||||||
|
return badges.value
|
||||||
|
}
|
||||||
|
})
|
||||||
15
src/extensions/core/cloudRemoteConfig.ts
Normal file
15
src/extensions/core/cloudRemoteConfig.ts
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
import { loadRemoteConfig } from '@/platform/remoteConfig/remoteConfig'
|
||||||
|
import { useExtensionService } from '@/services/extensionService'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cloud-only extension that polls for remote config updates
|
||||||
|
* Initial config load happens in main.ts before any other imports
|
||||||
|
*/
|
||||||
|
useExtensionService().registerExtension({
|
||||||
|
name: 'Comfy.Cloud.RemoteConfig',
|
||||||
|
|
||||||
|
setup: async () => {
|
||||||
|
// Poll for config updates every 30 seconds
|
||||||
|
setInterval(() => void loadRemoteConfig(), 30000)
|
||||||
|
}
|
||||||
|
})
|
||||||
@@ -4,8 +4,11 @@ import { useCurrentUser } from '@/composables/auth/useCurrentUser'
|
|||||||
import { useSubscription } from '@/platform/cloud/subscription/composables/useSubscription'
|
import { useSubscription } from '@/platform/cloud/subscription/composables/useSubscription'
|
||||||
import { useExtensionService } from '@/services/extensionService'
|
import { useExtensionService } from '@/services/extensionService'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cloud-only extension that enforces active subscription requirement
|
||||||
|
*/
|
||||||
useExtensionService().registerExtension({
|
useExtensionService().registerExtension({
|
||||||
name: 'Comfy.CloudSubscription',
|
name: 'Comfy.Cloud.Subscription',
|
||||||
|
|
||||||
setup: async () => {
|
setup: async () => {
|
||||||
const { isLoggedIn } = useCurrentUser()
|
const { isLoggedIn } = useCurrentUser()
|
||||||
@@ -13,7 +16,6 @@ useExtensionService().registerExtension({
|
|||||||
|
|
||||||
const checkSubscriptionStatus = () => {
|
const checkSubscriptionStatus = () => {
|
||||||
if (!isLoggedIn.value) return
|
if (!isLoggedIn.value) return
|
||||||
|
|
||||||
void requireActiveSubscription()
|
void requireActiveSubscription()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -24,10 +24,12 @@ import './uploadImage'
|
|||||||
import './webcamCapture'
|
import './webcamCapture'
|
||||||
import './widgetInputs'
|
import './widgetInputs'
|
||||||
|
|
||||||
|
// Cloud-only extensions - tree-shaken in OSS builds
|
||||||
if (isCloud) {
|
if (isCloud) {
|
||||||
import('./cloudBadge')
|
await import('./cloudRemoteConfig')
|
||||||
|
await import('./cloudBadges')
|
||||||
|
|
||||||
if (__BUILD_FLAGS__.REQUIRE_SUBSCRIPTION) {
|
if (window.__CONFIG__?.subscription_required) {
|
||||||
import('./cloudSubscription')
|
await import('./cloudSubscription')
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
13
src/main.ts
13
src/main.ts
@@ -21,6 +21,19 @@ import App from './App.vue'
|
|||||||
import './assets/css/style.css'
|
import './assets/css/style.css'
|
||||||
import { i18n } from './i18n'
|
import { i18n } from './i18n'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* CRITICAL: Load remote config FIRST for cloud builds to ensure
|
||||||
|
* window.__CONFIG__is available for all modules during initialization
|
||||||
|
*/
|
||||||
|
import { isCloud } from '@/platform/distribution/types'
|
||||||
|
|
||||||
|
if (isCloud) {
|
||||||
|
const { loadRemoteConfig } = await import(
|
||||||
|
'@/platform/remoteConfig/remoteConfig'
|
||||||
|
)
|
||||||
|
await loadRemoteConfig()
|
||||||
|
}
|
||||||
|
|
||||||
const ComfyUIPreset = definePreset(Aura, {
|
const ComfyUIPreset = definePreset(Aura, {
|
||||||
semantic: {
|
semantic: {
|
||||||
// @ts-expect-error fixme ts strict error
|
// @ts-expect-error fixme ts strict error
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ interface CloudSubscriptionStatusResponse {
|
|||||||
const subscriptionStatus = ref<CloudSubscriptionStatusResponse | null>(null)
|
const subscriptionStatus = ref<CloudSubscriptionStatusResponse | null>(null)
|
||||||
|
|
||||||
const isActiveSubscription = computed(() => {
|
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
|
return subscriptionStatus.value?.is_active ?? false
|
||||||
})
|
})
|
||||||
|
|||||||
45
src/platform/remoteConfig/remoteConfig.ts
Normal file
45
src/platform/remoteConfig/remoteConfig.ts
Normal 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 = {}
|
||||||
|
}
|
||||||
|
}
|
||||||
19
src/platform/remoteConfig/types.ts
Normal file
19
src/platform/remoteConfig/types.ts
Normal 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
|
||||||
|
}
|
||||||
@@ -81,7 +81,7 @@ export function useSettingUI(
|
|||||||
}
|
}
|
||||||
|
|
||||||
const subscriptionPanel: SettingPanelItem | null =
|
const subscriptionPanel: SettingPanelItem | null =
|
||||||
!isCloud || !__BUILD_FLAGS__.REQUIRE_SUBSCRIPTION
|
!isCloud || !window.__CONFIG__?.subscription_required
|
||||||
? null
|
? null
|
||||||
: {
|
: {
|
||||||
node: {
|
node: {
|
||||||
@@ -149,7 +149,9 @@ export function useSettingUI(
|
|||||||
keybindingPanel,
|
keybindingPanel,
|
||||||
extensionPanel,
|
extensionPanel,
|
||||||
...(isElectron() ? [serverConfigPanel] : []),
|
...(isElectron() ? [serverConfigPanel] : []),
|
||||||
...(isCloud && __BUILD_FLAGS__.REQUIRE_SUBSCRIPTION && subscriptionPanel
|
...(isCloud &&
|
||||||
|
window.__CONFIG__?.subscription_required &&
|
||||||
|
subscriptionPanel
|
||||||
? [subscriptionPanel]
|
? [subscriptionPanel]
|
||||||
: [])
|
: [])
|
||||||
].filter((panel) => panel.component)
|
].filter((panel) => panel.component)
|
||||||
@@ -185,12 +187,12 @@ export function useSettingUI(
|
|||||||
userPanel.node,
|
userPanel.node,
|
||||||
...(isLoggedIn.value &&
|
...(isLoggedIn.value &&
|
||||||
isCloud &&
|
isCloud &&
|
||||||
__BUILD_FLAGS__.REQUIRE_SUBSCRIPTION &&
|
window.__CONFIG__?.subscription_required &&
|
||||||
subscriptionPanel
|
subscriptionPanel
|
||||||
? [subscriptionPanel.node]
|
? [subscriptionPanel.node]
|
||||||
: []),
|
: []),
|
||||||
...(isLoggedIn.value &&
|
...(isLoggedIn.value &&
|
||||||
!(isCloud && __BUILD_FLAGS__.REQUIRE_SUBSCRIPTION)
|
!(isCloud && window.__CONFIG__?.subscription_required)
|
||||||
? [creditsPanel.node]
|
? [creditsPanel.node]
|
||||||
: [])
|
: [])
|
||||||
].map(translateCategory)
|
].map(translateCategory)
|
||||||
|
|||||||
@@ -7,6 +7,8 @@ import { useWorkflowTemplatesStore } from '@/platform/workflow/templates/reposit
|
|||||||
import type {
|
import type {
|
||||||
AuthMetadata,
|
AuthMetadata,
|
||||||
ExecutionContext,
|
ExecutionContext,
|
||||||
|
ExecutionErrorMetadata,
|
||||||
|
ExecutionSuccessMetadata,
|
||||||
RunButtonProperties,
|
RunButtonProperties,
|
||||||
SurveyResponses,
|
SurveyResponses,
|
||||||
TelemetryEventName,
|
TelemetryEventName,
|
||||||
@@ -40,7 +42,7 @@ export class MixpanelTelemetryProvider implements TelemetryProvider {
|
|||||||
private isInitialized = false
|
private isInitialized = false
|
||||||
|
|
||||||
constructor() {
|
constructor() {
|
||||||
const token = __MIXPANEL_TOKEN__
|
const token = window.__CONFIG__?.mixpanel_token
|
||||||
|
|
||||||
if (token) {
|
if (token) {
|
||||||
try {
|
try {
|
||||||
@@ -74,7 +76,7 @@ export class MixpanelTelemetryProvider implements TelemetryProvider {
|
|||||||
this.isEnabled = false
|
this.isEnabled = false
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
console.warn('Mixpanel token not provided')
|
console.warn('Mixpanel token not provided in runtime config')
|
||||||
this.isEnabled = false
|
this.isEnabled = false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -178,7 +180,15 @@ export class MixpanelTelemetryProvider implements TelemetryProvider {
|
|||||||
|
|
||||||
trackWorkflowExecution(): void {
|
trackWorkflowExecution(): void {
|
||||||
const context = this.getExecutionContext()
|
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 {
|
getExecutionContext(): ExecutionContext {
|
||||||
|
|||||||
@@ -59,6 +59,23 @@ export interface ExecutionContext {
|
|||||||
template_license?: string
|
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
|
* Template metadata for workflow tracking
|
||||||
*/
|
*/
|
||||||
@@ -94,34 +111,42 @@ export interface TelemetryProvider {
|
|||||||
|
|
||||||
// Workflow execution events
|
// Workflow execution events
|
||||||
trackWorkflowExecution(): void
|
trackWorkflowExecution(): void
|
||||||
|
trackExecutionError(metadata: ExecutionErrorMetadata): void
|
||||||
|
trackExecutionSuccess(metadata: ExecutionSuccessMetadata): void
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Telemetry event constants
|
* Telemetry event constants
|
||||||
|
*
|
||||||
|
* Event naming conventions:
|
||||||
|
* - 'app:' prefix: UI/user interaction events
|
||||||
|
* - No prefix: Backend/system events (execution lifecycle)
|
||||||
*/
|
*/
|
||||||
export const TelemetryEvents = {
|
export const TelemetryEvents = {
|
||||||
// Authentication Flow
|
// Authentication Flow
|
||||||
USER_AUTH_COMPLETED: 'user_auth_completed',
|
USER_AUTH_COMPLETED: 'app:user_auth_completed',
|
||||||
|
|
||||||
// Subscription Flow
|
// Subscription Flow
|
||||||
RUN_BUTTON_CLICKED: 'run_button_clicked',
|
RUN_BUTTON_CLICKED: 'app:run_button_click',
|
||||||
SUBSCRIPTION_REQUIRED_MODAL_OPENED: 'subscription_required_modal_opened',
|
SUBSCRIPTION_REQUIRED_MODAL_OPENED: 'app:subscription_required_modal_opened',
|
||||||
SUBSCRIBE_NOW_BUTTON_CLICKED: 'subscribe_now_button_clicked',
|
SUBSCRIBE_NOW_BUTTON_CLICKED: 'app:subscribe_now_button_clicked',
|
||||||
|
|
||||||
// Onboarding Survey
|
// Onboarding Survey
|
||||||
USER_SURVEY_OPENED: 'user_survey_opened',
|
USER_SURVEY_OPENED: 'app:user_survey_opened',
|
||||||
USER_SURVEY_SUBMITTED: 'user_survey_submitted',
|
USER_SURVEY_SUBMITTED: 'app:user_survey_submitted',
|
||||||
|
|
||||||
// Email Verification
|
// Email Verification
|
||||||
USER_EMAIL_VERIFY_OPENED: 'user_email_verify_opened',
|
USER_EMAIL_VERIFY_OPENED: 'app:user_email_verify_opened',
|
||||||
USER_EMAIL_VERIFY_REQUESTED: 'user_email_verify_requested',
|
USER_EMAIL_VERIFY_REQUESTED: 'app:user_email_verify_requested',
|
||||||
USER_EMAIL_VERIFY_COMPLETED: 'user_email_verify_completed',
|
USER_EMAIL_VERIFY_COMPLETED: 'app:user_email_verify_completed',
|
||||||
|
|
||||||
// Template Tracking
|
// Template Tracking
|
||||||
TEMPLATE_WORKFLOW_OPENED: 'template_workflow_opened',
|
TEMPLATE_WORKFLOW_OPENED: 'app:template_workflow_opened',
|
||||||
|
|
||||||
// Workflow Execution Tracking
|
// Execution Lifecycle
|
||||||
WORKFLOW_EXECUTION_STARTED: 'workflow_execution_started'
|
EXECUTION_START: 'execution_start',
|
||||||
|
EXECUTION_ERROR: 'execution_error',
|
||||||
|
EXECUTION_SUCCESS: 'execution_success'
|
||||||
} as const
|
} as const
|
||||||
|
|
||||||
export type TelemetryEventName =
|
export type TelemetryEventName =
|
||||||
@@ -136,3 +161,5 @@ export type TelemetryEventProperties =
|
|||||||
| TemplateMetadata
|
| TemplateMetadata
|
||||||
| ExecutionContext
|
| ExecutionContext
|
||||||
| RunButtonProperties
|
| RunButtonProperties
|
||||||
|
| ExecutionErrorMetadata
|
||||||
|
| ExecutionSuccessMetadata
|
||||||
|
|||||||
@@ -488,7 +488,7 @@ export const useDialogService = () => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function showSubscriptionRequiredDialog() {
|
function showSubscriptionRequiredDialog() {
|
||||||
if (!isCloud || !__BUILD_FLAGS__.REQUIRE_SUBSCRIPTION) {
|
if (!isCloud || !window.__CONFIG__?.subscription_required) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ import type ChatHistoryWidget from '@/components/graph/widgets/ChatHistoryWidget
|
|||||||
import { useNodeChatHistory } from '@/composables/node/useNodeChatHistory'
|
import { useNodeChatHistory } from '@/composables/node/useNodeChatHistory'
|
||||||
import { useNodeProgressText } from '@/composables/node/useNodeProgressText'
|
import { useNodeProgressText } from '@/composables/node/useNodeProgressText'
|
||||||
import type { LGraph, Subgraph } from '@/lib/litegraph/src/litegraph'
|
import type { LGraph, Subgraph } from '@/lib/litegraph/src/litegraph'
|
||||||
|
import { isCloud } from '@/platform/distribution/types'
|
||||||
|
import { useTelemetry } from '@/platform/telemetry'
|
||||||
import type { ComfyWorkflow } from '@/platform/workflow/management/stores/workflowStore'
|
import type { ComfyWorkflow } from '@/platform/workflow/management/stores/workflowStore'
|
||||||
import { useWorkflowStore } from '@/platform/workflow/management/stores/workflowStore'
|
import { useWorkflowStore } from '@/platform/workflow/management/stores/workflowStore'
|
||||||
import type {
|
import type {
|
||||||
@@ -288,6 +290,11 @@ export const useExecutionStore = defineStore('execution', () => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function handleExecutionSuccess() {
|
function handleExecutionSuccess() {
|
||||||
|
if (isCloud && activePromptId.value) {
|
||||||
|
useTelemetry()?.trackExecutionSuccess({
|
||||||
|
jobId: activePromptId.value
|
||||||
|
})
|
||||||
|
}
|
||||||
resetExecutionState()
|
resetExecutionState()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -352,6 +359,14 @@ export const useExecutionStore = defineStore('execution', () => {
|
|||||||
|
|
||||||
function handleExecutionError(e: CustomEvent<ExecutionErrorWsMessage>) {
|
function handleExecutionError(e: CustomEvent<ExecutionErrorWsMessage>) {
|
||||||
lastExecutionError.value = e.detail
|
lastExecutionError.value = e.detail
|
||||||
|
if (isCloud) {
|
||||||
|
useTelemetry()?.trackExecutionError({
|
||||||
|
jobId: e.detail.prompt_id,
|
||||||
|
nodeId: String(e.detail.node_id),
|
||||||
|
nodeType: e.detail.node_type,
|
||||||
|
error: e.detail.exception_message
|
||||||
|
})
|
||||||
|
}
|
||||||
resetExecutionState()
|
resetExecutionState()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -39,6 +39,22 @@ export interface TopbarBadge {
|
|||||||
* Optional badge label (e.g., "BETA", "ALPHA", "NEW")
|
* Optional badge label (e.g., "BETA", "ALPHA", "NEW")
|
||||||
*/
|
*/
|
||||||
label?: string
|
label?: string
|
||||||
|
/**
|
||||||
|
* Visual variant for the badge
|
||||||
|
* - info: Default informational badge (white label, gray background)
|
||||||
|
* - warning: Warning badge (orange theme, higher emphasis)
|
||||||
|
* - error: Error/alert badge (red theme, highest emphasis)
|
||||||
|
*/
|
||||||
|
variant?: 'info' | 'warning' | 'error'
|
||||||
|
/**
|
||||||
|
* Optional icon class (e.g., "pi-exclamation-triangle")
|
||||||
|
* If not provided, variant will determine the default icon
|
||||||
|
*/
|
||||||
|
icon?: string
|
||||||
|
/**
|
||||||
|
* Optional tooltip text to show on hover
|
||||||
|
*/
|
||||||
|
tooltip?: string
|
||||||
}
|
}
|
||||||
|
|
||||||
export type MissingNodeType =
|
export type MissingNodeType =
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ describe('useTelemetry', () => {
|
|||||||
|
|
||||||
// Should return null for OSS builds
|
// Should return null for OSS builds
|
||||||
expect(provider).toBeNull()
|
expect(provider).toBeNull()
|
||||||
})
|
}, 10000)
|
||||||
|
|
||||||
it('should return null consistently for OSS builds', async () => {
|
it('should return null consistently for OSS builds', async () => {
|
||||||
const { useTelemetry } = await import('@/platform/telemetry')
|
const { useTelemetry } = await import('@/platform/telemetry')
|
||||||
|
|||||||
@@ -1,22 +1,31 @@
|
|||||||
import { createPinia, setActivePinia } from 'pinia'
|
import { createPinia, setActivePinia } from 'pinia'
|
||||||
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
||||||
|
|
||||||
import { useWorkflowStore } from '@/platform/workflow/management/stores/workflowStore'
|
|
||||||
import { app } from '@/scripts/app'
|
import { app } from '@/scripts/app'
|
||||||
import { useExecutionStore } from '@/stores/executionStore'
|
import { useExecutionStore } from '@/stores/executionStore'
|
||||||
|
|
||||||
|
// Create mock functions that will be shared
|
||||||
|
const mockNodeExecutionIdToNodeLocatorId = vi.fn()
|
||||||
|
const mockNodeIdToNodeLocatorId = vi.fn()
|
||||||
|
const mockNodeLocatorIdToNodeExecutionId = vi.fn()
|
||||||
|
|
||||||
// Mock the workflowStore
|
// Mock the workflowStore
|
||||||
vi.mock('@/platform/workflow/management/stores/workflowStore', () => ({
|
vi.mock('@/platform/workflow/management/stores/workflowStore', async () => {
|
||||||
useWorkflowStore: vi.fn(() => ({
|
const { ComfyWorkflow } = await vi.importActual<
|
||||||
nodeExecutionIdToNodeLocatorId: vi.fn(),
|
typeof import('@/platform/workflow/management/stores/workflowStore')
|
||||||
nodeIdToNodeLocatorId: vi.fn(),
|
>('@/platform/workflow/management/stores/workflowStore')
|
||||||
nodeLocatorIdToNodeExecutionId: vi.fn()
|
return {
|
||||||
}))
|
ComfyWorkflow,
|
||||||
}))
|
useWorkflowStore: vi.fn(() => ({
|
||||||
|
nodeExecutionIdToNodeLocatorId: mockNodeExecutionIdToNodeLocatorId,
|
||||||
|
nodeIdToNodeLocatorId: mockNodeIdToNodeLocatorId,
|
||||||
|
nodeLocatorIdToNodeExecutionId: mockNodeLocatorIdToNodeExecutionId
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
// Remove any previous global types
|
// Remove any previous global types
|
||||||
declare global {
|
declare global {
|
||||||
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
|
||||||
interface Window {}
|
interface Window {}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -37,7 +46,8 @@ vi.mock('@/composables/node/useNodeProgressText', () => ({
|
|||||||
vi.mock('@/scripts/app', () => ({
|
vi.mock('@/scripts/app', () => ({
|
||||||
app: {
|
app: {
|
||||||
graph: {
|
graph: {
|
||||||
getNodeById: vi.fn()
|
getNodeById: vi.fn(),
|
||||||
|
_nodes: [] // Add _nodes array for workflowStore iteration
|
||||||
},
|
},
|
||||||
revokePreviews: vi.fn(),
|
revokePreviews: vi.fn(),
|
||||||
nodePreviewImages: {}
|
nodePreviewImages: {}
|
||||||
@@ -98,24 +108,16 @@ describe('executionStore - display_component handling', () => {
|
|||||||
|
|
||||||
describe('useExecutionStore - NodeLocatorId conversions', () => {
|
describe('useExecutionStore - NodeLocatorId conversions', () => {
|
||||||
let store: ReturnType<typeof useExecutionStore>
|
let store: ReturnType<typeof useExecutionStore>
|
||||||
let workflowStore: ReturnType<typeof useWorkflowStore>
|
|
||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
setActivePinia(createPinia())
|
|
||||||
|
|
||||||
// Create the mock workflowStore instance
|
|
||||||
const mockWorkflowStore = {
|
|
||||||
nodeExecutionIdToNodeLocatorId: vi.fn(),
|
|
||||||
nodeIdToNodeLocatorId: vi.fn(),
|
|
||||||
nodeLocatorIdToNodeExecutionId: vi.fn()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Mock the useWorkflowStore function to return our mock
|
|
||||||
vi.mocked(useWorkflowStore).mockReturnValue(mockWorkflowStore as any)
|
|
||||||
|
|
||||||
workflowStore = mockWorkflowStore as any
|
|
||||||
store = useExecutionStore()
|
|
||||||
vi.clearAllMocks()
|
vi.clearAllMocks()
|
||||||
|
// Reset mock implementations
|
||||||
|
mockNodeExecutionIdToNodeLocatorId.mockReset()
|
||||||
|
mockNodeIdToNodeLocatorId.mockReset()
|
||||||
|
mockNodeLocatorIdToNodeExecutionId.mockReset()
|
||||||
|
|
||||||
|
setActivePinia(createPinia())
|
||||||
|
store = useExecutionStore()
|
||||||
})
|
})
|
||||||
|
|
||||||
describe('executionIdToNodeLocatorId', () => {
|
describe('executionIdToNodeLocatorId', () => {
|
||||||
@@ -168,24 +170,20 @@ describe('useExecutionStore - NodeLocatorId conversions', () => {
|
|||||||
describe('nodeLocatorIdToExecutionId', () => {
|
describe('nodeLocatorIdToExecutionId', () => {
|
||||||
it('should convert NodeLocatorId to execution ID', () => {
|
it('should convert NodeLocatorId to execution ID', () => {
|
||||||
const mockExecutionId = '123:456'
|
const mockExecutionId = '123:456'
|
||||||
vi.spyOn(workflowStore, 'nodeLocatorIdToNodeExecutionId').mockReturnValue(
|
mockNodeLocatorIdToNodeExecutionId.mockReturnValue(mockExecutionId)
|
||||||
mockExecutionId as any
|
|
||||||
)
|
|
||||||
|
|
||||||
const result = store.nodeLocatorIdToExecutionId(
|
const result = store.nodeLocatorIdToExecutionId(
|
||||||
'a1b2c3d4-e5f6-7890-abcd-ef1234567890:456'
|
'a1b2c3d4-e5f6-7890-abcd-ef1234567890:456'
|
||||||
)
|
)
|
||||||
|
|
||||||
expect(workflowStore.nodeLocatorIdToNodeExecutionId).toHaveBeenCalledWith(
|
expect(mockNodeLocatorIdToNodeExecutionId).toHaveBeenCalledWith(
|
||||||
'a1b2c3d4-e5f6-7890-abcd-ef1234567890:456'
|
'a1b2c3d4-e5f6-7890-abcd-ef1234567890:456'
|
||||||
)
|
)
|
||||||
expect(result).toBe(mockExecutionId)
|
expect(result).toBe(mockExecutionId)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should return null when conversion fails', () => {
|
it('should return null when conversion fails', () => {
|
||||||
vi.spyOn(workflowStore, 'nodeLocatorIdToNodeExecutionId').mockReturnValue(
|
mockNodeLocatorIdToNodeExecutionId.mockReturnValue(null)
|
||||||
null
|
|
||||||
)
|
|
||||||
|
|
||||||
const result = store.nodeLocatorIdToExecutionId('invalid:format')
|
const result = store.nodeLocatorIdToExecutionId('invalid:format')
|
||||||
|
|
||||||
|
|||||||
@@ -53,10 +53,6 @@ const DEV_SERVER_COMFYUI_URL =
|
|||||||
const cloudProxyConfig =
|
const cloudProxyConfig =
|
||||||
DISTRIBUTION === 'cloud' ? { secure: false, changeOrigin: true } : {}
|
DISTRIBUTION === 'cloud' ? { secure: false, changeOrigin: true } : {}
|
||||||
|
|
||||||
const BUILD_FLAGS = {
|
|
||||||
REQUIRE_SUBSCRIPTION: process.env.REQUIRE_SUBSCRIPTION === 'true'
|
|
||||||
}
|
|
||||||
|
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
base: '',
|
base: '',
|
||||||
server: {
|
server: {
|
||||||
@@ -306,9 +302,7 @@ export default defineConfig({
|
|||||||
__ALGOLIA_APP_ID__: JSON.stringify(process.env.ALGOLIA_APP_ID || ''),
|
__ALGOLIA_APP_ID__: JSON.stringify(process.env.ALGOLIA_APP_ID || ''),
|
||||||
__ALGOLIA_API_KEY__: JSON.stringify(process.env.ALGOLIA_API_KEY || ''),
|
__ALGOLIA_API_KEY__: JSON.stringify(process.env.ALGOLIA_API_KEY || ''),
|
||||||
__USE_PROD_CONFIG__: process.env.USE_PROD_CONFIG === 'true',
|
__USE_PROD_CONFIG__: process.env.USE_PROD_CONFIG === 'true',
|
||||||
__DISTRIBUTION__: JSON.stringify(DISTRIBUTION),
|
__DISTRIBUTION__: JSON.stringify(DISTRIBUTION)
|
||||||
__BUILD_FLAGS__: JSON.stringify(BUILD_FLAGS),
|
|
||||||
__MIXPANEL_TOKEN__: JSON.stringify(process.env.MIXPANEL_TOKEN || '')
|
|
||||||
},
|
},
|
||||||
|
|
||||||
resolve: {
|
resolve: {
|
||||||
|
|||||||
@@ -1,6 +1,17 @@
|
|||||||
import { vi } from 'vitest'
|
import { vi } from 'vitest'
|
||||||
import 'vue'
|
import 'vue'
|
||||||
|
|
||||||
|
// Augment Window interface for tests
|
||||||
|
declare global {
|
||||||
|
interface Window {
|
||||||
|
__CONFIG__: {
|
||||||
|
mixpanel_token?: string
|
||||||
|
subscription_required?: boolean
|
||||||
|
server_health_alert?: string
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Define global variables for tests
|
// Define global variables for tests
|
||||||
globalThis.__COMFYUI_FRONTEND_VERSION__ = '1.24.0'
|
globalThis.__COMFYUI_FRONTEND_VERSION__ = '1.24.0'
|
||||||
globalThis.__SENTRY_ENABLED__ = false
|
globalThis.__SENTRY_ENABLED__ = false
|
||||||
@@ -9,8 +20,11 @@ globalThis.__ALGOLIA_APP_ID__ = ''
|
|||||||
globalThis.__ALGOLIA_API_KEY__ = ''
|
globalThis.__ALGOLIA_API_KEY__ = ''
|
||||||
globalThis.__USE_PROD_CONFIG__ = false
|
globalThis.__USE_PROD_CONFIG__ = false
|
||||||
globalThis.__DISTRIBUTION__ = 'localhost'
|
globalThis.__DISTRIBUTION__ = 'localhost'
|
||||||
globalThis.__BUILD_FLAGS__ = {
|
|
||||||
REQUIRE_SUBSCRIPTION: true
|
// Define runtime config for tests
|
||||||
|
window.__CONFIG__ = {
|
||||||
|
subscription_required: true,
|
||||||
|
mixpanel_token: 'test-token'
|
||||||
}
|
}
|
||||||
|
|
||||||
// Mock Worker for extendable-media-recorder
|
// Mock Worker for extendable-media-recorder
|
||||||
|
|||||||
Reference in New Issue
Block a user