mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-05-01 19:51:54 +00:00
Summary - Add comprehensive telemetry for key UI interactions using existing telemetry hooks (cloud-enabled, no-op in OSS): Sidebar and top-level - Node library button: `node_library` - Model library button: `model_library` - Workflows button: `workflows` - Assets/Media button: `assets` - Templates button: `templates` - Keyboard Shortcuts: `keyboard_shortcuts` - Console: `console` - Help Center: `help_center` - Settings (from Comfy logo menu): `settings_menu` Floating canvas menu - Minimap toggle: `minimap_toggle` - Hide links toggle: `hide_links` Run button and queue - Run button handle (drag): `run_button_handle` - Run mode selection: `run_instant`, `run_on_change` - Queue multiple: `queue_multiple` fires on each run when batch count > 1 (moved from batch-count-change to run-time, per guidance) Error dialogs - Close (X/mask/ESC): `error_dialog_close` via dialog onClose - Show report: `error_show_report` - Help fix this: `error_help_fix_this` - Find issues: `error_find_issues` Nodes / Subgraphs - Selection toolbox “Node info”: `node_info` - Enter subgraph (node header enter): `open_subgraph` - Subgraph breadcrumb navigation: `subgraph_breadcrumb_item` and `subgraph_breadcrumb_root` Settings / Credits / Search - Settings menu button (under Comfy logo): `settings_menu` - Purchase credits (Settings > Credits panel): tracked via existing `trackAddApiCreditButtonClicked` - Purchase credits (Avatar popover Top Up): tracked via existing `trackAddApiCreditButtonClicked` - Debounced search telemetry already present for node search and template filters; left as-is Notes and answers - Error dialog onClose: only fires when the dialog actually closes (X, mask, ESC, or programmatic close). “Show report” and “Help fix this” do not close the dialog; they each emit their own events. - Telemetry is behind the cloud provider; calls are optional (`useTelemetry()?.…`). OSS builds send nothing. Open questions / follow-ups - Primary Run button click: today cloud-only `trackRunButton` exists; we can also emit a UI-level `run` click (`UI_BUTTON_CLICKED` style) alongside it if desired. Confirm preference and I can add it. - Subgraph usage richness: if we want structured analytics (e.g., action, depth, subgraph id, node count), I can add a dedicated provider method and include richer metadata at enter/breadcrumb. - Optional parity: track the Comfy menu’s “Browse Templates” item in addition to the sidebar Templates button. Quality - Ran `pnpm lint:fix` and `pnpm typecheck`; both pass locally. Implementation details - All handlers refactored to named functions where needed; used `void` for intentionally unawaited async calls per lint rules. - Event names kept consistent in `button_id` strings; happy to align to a different naming scheme if you prefer. ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-6511-feat-telemetry-add-tracking-for-sidebar-run-menu-dialogs-subgraphs-settings-and-cre-29e6d73d365081a1b8b4fdfbbf40e18b) by [Unito](https://www.unito.io) --------- Co-authored-by: Christian Byrne <cbyrne@comfy.org> Co-authored-by: Claude <noreply@anthropic.com>
221 lines
5.6 KiB
Vue
221 lines
5.6 KiB
Vue
<template>
|
|
<div>
|
|
<SidebarIcon
|
|
icon="pi pi-question-circle"
|
|
class="comfy-help-center-btn"
|
|
:label="$t('menu.help')"
|
|
:tooltip="$t('sideToolbar.helpCenter')"
|
|
:icon-badge="shouldShowRedDot ? '•' : ''"
|
|
:is-small="isSmall"
|
|
@click="toggleHelpCenter"
|
|
/>
|
|
|
|
<!-- Help Center Popup positioned within canvas area -->
|
|
<Teleport to="#graph-canvas-container">
|
|
<div
|
|
v-if="isHelpCenterVisible"
|
|
class="help-center-popup"
|
|
:class="{
|
|
'sidebar-left': sidebarLocation === 'left',
|
|
'sidebar-right': sidebarLocation === 'right',
|
|
'small-sidebar': isSmall
|
|
}"
|
|
>
|
|
<HelpCenterMenuContent @close="closeHelpCenter" />
|
|
</div>
|
|
</Teleport>
|
|
|
|
<!-- Release Notification Toast positioned within canvas area -->
|
|
<Teleport to="#graph-canvas-container">
|
|
<ReleaseNotificationToast
|
|
:class="{
|
|
'sidebar-left': sidebarLocation === 'left',
|
|
'sidebar-right': sidebarLocation === 'right',
|
|
'small-sidebar': isSmall
|
|
}"
|
|
/>
|
|
</Teleport>
|
|
|
|
<!-- WhatsNew Popup positioned within canvas area -->
|
|
<Teleport to="#graph-canvas-container">
|
|
<WhatsNewPopup
|
|
:class="{
|
|
'sidebar-left': sidebarLocation === 'left',
|
|
'sidebar-right': sidebarLocation === 'right',
|
|
'small-sidebar': isSmall
|
|
}"
|
|
@whats-new-dismissed="handleWhatsNewDismissed"
|
|
/>
|
|
</Teleport>
|
|
|
|
<!-- Backdrop to close popup when clicking outside -->
|
|
<Teleport to="body">
|
|
<div
|
|
v-if="isHelpCenterVisible"
|
|
class="help-center-backdrop"
|
|
@click="closeHelpCenter"
|
|
/>
|
|
</Teleport>
|
|
</div>
|
|
</template>
|
|
|
|
<script setup lang="ts">
|
|
import { storeToRefs } from 'pinia'
|
|
import { computed, onMounted, toRefs } from 'vue'
|
|
|
|
import HelpCenterMenuContent from '@/components/helpcenter/HelpCenterMenuContent.vue'
|
|
import { useSettingStore } from '@/platform/settings/settingStore'
|
|
import { useTelemetry } from '@/platform/telemetry'
|
|
import { useReleaseStore } from '@/platform/updates/common/releaseStore'
|
|
import ReleaseNotificationToast from '@/platform/updates/components/ReleaseNotificationToast.vue'
|
|
import WhatsNewPopup from '@/platform/updates/components/WhatsNewPopup.vue'
|
|
import { useDialogService } from '@/services/dialogService'
|
|
import { useHelpCenterStore } from '@/stores/helpCenterStore'
|
|
import { useConflictAcknowledgment } from '@/workbench/extensions/manager/composables/useConflictAcknowledgment'
|
|
import { useConflictDetection } from '@/workbench/extensions/manager/composables/useConflictDetection'
|
|
|
|
import SidebarIcon from './SidebarIcon.vue'
|
|
|
|
const settingStore = useSettingStore()
|
|
const releaseStore = useReleaseStore()
|
|
const helpCenterStore = useHelpCenterStore()
|
|
const { isVisible: isHelpCenterVisible } = storeToRefs(helpCenterStore)
|
|
const { shouldShowRedDot: showReleaseRedDot } = storeToRefs(releaseStore)
|
|
|
|
const conflictDetection = useConflictDetection()
|
|
|
|
const { showNodeConflictDialog } = useDialogService()
|
|
|
|
// Use conflict acknowledgment state from composable - call only once
|
|
const { shouldShowRedDot: shouldShowConflictRedDot, markConflictsAsSeen } =
|
|
useConflictAcknowledgment()
|
|
|
|
const props = defineProps<{
|
|
isSmall: boolean
|
|
}>()
|
|
const { isSmall } = toRefs(props)
|
|
|
|
// Use either release red dot or conflict red dot
|
|
const shouldShowRedDot = computed((): boolean => {
|
|
const releaseRedDot = showReleaseRedDot.value
|
|
return releaseRedDot || shouldShowConflictRedDot.value
|
|
})
|
|
|
|
const sidebarLocation = computed(() =>
|
|
settingStore.get('Comfy.Sidebar.Location')
|
|
)
|
|
|
|
/**
|
|
* Toggle Help Center and track UI button click.
|
|
*/
|
|
const toggleHelpCenter = () => {
|
|
useTelemetry()?.trackUiButtonClicked({
|
|
button_id: 'sidebar_help_center_toggled'
|
|
})
|
|
helpCenterStore.toggle()
|
|
}
|
|
|
|
const closeHelpCenter = () => {
|
|
helpCenterStore.hide()
|
|
}
|
|
|
|
/**
|
|
* Handle What's New popup dismissal
|
|
* Check if conflict modal should be shown after ComfyUI update
|
|
*/
|
|
const handleWhatsNewDismissed = async () => {
|
|
try {
|
|
// Check if conflict modal should be shown after update
|
|
const shouldShow =
|
|
await conflictDetection.shouldShowConflictModalAfterUpdate()
|
|
if (shouldShow) {
|
|
showConflictModal()
|
|
}
|
|
} catch (error) {
|
|
console.error('[HelpCenter] Error checking conflict modal:', error)
|
|
}
|
|
}
|
|
/**
|
|
* Show the node conflict dialog with current conflict data
|
|
*/
|
|
const showConflictModal = () => {
|
|
showNodeConflictDialog({
|
|
showAfterWhatsNew: true,
|
|
dialogComponentProps: {
|
|
onClose: () => {
|
|
markConflictsAsSeen()
|
|
}
|
|
}
|
|
})
|
|
}
|
|
|
|
// Initialize release store on mount
|
|
onMounted(async () => {
|
|
// Initialize release store to fetch releases for toast and popup
|
|
await releaseStore.initialize()
|
|
})
|
|
</script>
|
|
|
|
<style scoped>
|
|
.help-center-backdrop {
|
|
position: absolute;
|
|
top: 0;
|
|
left: 0;
|
|
right: 0;
|
|
bottom: 0;
|
|
z-index: 9999;
|
|
background: transparent;
|
|
}
|
|
|
|
.help-center-popup {
|
|
position: absolute;
|
|
bottom: 1rem;
|
|
z-index: 10000;
|
|
animation: slideInUp 0.2s ease-out;
|
|
pointer-events: auto;
|
|
}
|
|
|
|
.help-center-popup.sidebar-left {
|
|
left: 1rem;
|
|
}
|
|
|
|
.help-center-popup.sidebar-left.small-sidebar {
|
|
left: 1rem;
|
|
}
|
|
|
|
.help-center-popup.sidebar-right {
|
|
right: 1rem;
|
|
}
|
|
|
|
@keyframes slideInUp {
|
|
from {
|
|
opacity: 0;
|
|
transform: translateY(20px);
|
|
}
|
|
|
|
to {
|
|
opacity: 1;
|
|
transform: translateY(0);
|
|
}
|
|
}
|
|
|
|
:deep(.p-badge) {
|
|
background: #ff3b30;
|
|
color: #ff3b30;
|
|
min-width: 8px;
|
|
height: 8px;
|
|
padding: 0;
|
|
border-radius: 9999px;
|
|
font-size: 0;
|
|
margin-top: 4px;
|
|
margin-right: 4px;
|
|
border: none;
|
|
outline: none;
|
|
box-shadow: none;
|
|
}
|
|
|
|
:deep(.p-badge.p-badge-dot) {
|
|
width: 8px !important;
|
|
}
|
|
</style>
|