Files
ComfyUI_frontend/src/stores/workspaceStore.ts
Alexander Brown 14369c08a3 refactor: parallelize bootstrap and simplify lifecycle with VueUse (#8307)
## Summary

Refactors bootstrap and lifecycle management to parallelize
initialization, use Vue best practices, and fix a logout state bug.

## Changes

### Bootstrap Store (`bootstrapStore.ts`)
- Extract early bootstrap logic into a dedicated store using
`useAsyncState`
- Parallelize settings, i18n, and workflow sync loading (previously
sequential)
- Handle multi-user login scenarios by deferring settings/workflows
until authenticated

### GraphCanvas Refactoring
- Move non-DOM composables (`useGlobalLitegraph`, `useCopy`, `usePaste`,
etc.) to script setup level for earlier initialization
- Move `watch` and `whenever` declarations outside `onMounted` (Vue best
practice)
- Use `until()` from VueUse to await bootstrap store readiness instead
of direct async calls

### GraphView Simplification
- Replace manual `addEventListener`/`removeEventListener` with
`useEventListener`
- Replace `setInterval` with `useIntervalFn` for automatic cleanup
- Move core command registration to script setup level

### Bug Fix
Using `router.push()` for logout caused `isSettingsReady` to persist as
`true`, making new users inherit the previous user's cached settings.
Reverted to `window.location.reload()` with TODOs for future store reset
implementation.

## Testing

- Verified login/logout cycle clears settings correctly
- Verified bootstrap sequence completes without errors

---------

Co-authored-by: Amp <amp@ampcode.com>
2026-01-27 12:50:13 -08:00

111 lines
3.5 KiB
TypeScript

import { useMagicKeys } from '@vueuse/core'
import { defineStore } from 'pinia'
import { computed, ref } from 'vue'
import { useSettingStore } from '@/platform/settings/settingStore'
import { useToastStore } from '@/platform/updates/common/toastStore'
import { useWorkflowStore } from '@/platform/workflow/management/stores/workflowStore'
import type { Settings } from '@/schemas/apiSchema'
import { useColorPaletteService } from '@/services/colorPaletteService'
import { useDialogService } from '@/services/dialogService'
import type { SidebarTabExtension, ToastManager } from '@/types/extensionTypes'
import { useApiKeyAuthStore } from './apiKeyAuthStore'
import { useCommandStore } from './commandStore'
import { useFirebaseAuthStore } from './firebaseAuthStore'
import { useQueueSettingsStore } from './queueStore'
import { useBottomPanelStore } from './workspace/bottomPanelStore'
import { useSidebarTabStore } from './workspace/sidebarTabStore'
export const useWorkspaceStore = defineStore('workspace', () => {
const spinner = ref(false)
const { shift: shiftDown } = useMagicKeys()
/**
* Whether the workspace is in focus mode.
* When in focus mode, only the graph editor is visible.
*/
const focusMode = ref(false)
const toast = computed<ToastManager>(() => useToastStore())
const queueSettings = computed(() => useQueueSettingsStore())
const command = computed(() => ({
commands: useCommandStore().commands,
execute: useCommandStore().execute
}))
const sidebarTab = computed(() => useSidebarTabStore())
const setting = computed(() => ({
settings: useSettingStore().settingsById,
// Allow generic key access to settings as custom nodes may add their
// own settings which is not tracked by the `Setting` schema.
get: (key: string) => useSettingStore().get(key as keyof Settings),
set: (key: string, value: unknown) =>
useSettingStore().set(key as keyof Settings, value)
}))
const workflow = computed(() => useWorkflowStore())
const colorPalette = useColorPaletteService()
const dialog = useDialogService()
const bottomPanel = useBottomPanelStore()
const authStore = useFirebaseAuthStore()
const apiKeyStore = useApiKeyAuthStore()
const firebaseUser = computed(() => authStore.currentUser)
const isApiKeyLogin = computed(() => apiKeyStore.isAuthenticated)
const isLoggedIn = computed(
() => !!isApiKeyLogin.value || firebaseUser.value !== null
)
const partialUserStore = {
isLoggedIn
}
/**
* Registers a sidebar tab.
* @param tab The sidebar tab to register.
* @deprecated Use `sidebarTab.registerSidebarTab` instead.
*/
function registerSidebarTab(tab: SidebarTabExtension) {
sidebarTab.value.registerSidebarTab(tab)
}
/**
* Unregisters a sidebar tab.
* @param id The id of the sidebar tab to unregister.
* @deprecated Use `sidebarTab.unregisterSidebarTab` instead.
*/
function unregisterSidebarTab(id: string) {
sidebarTab.value.unregisterSidebarTab(id)
}
/**
* Gets all registered sidebar tabs.
* @returns All registered sidebar tabs.
* @deprecated Use `sidebarTab.sidebarTabs` instead.
*/
function getSidebarTabs(): SidebarTabExtension[] {
return sidebarTab.value.sidebarTabs
}
return {
spinner,
shiftDown,
focusMode,
toggleFocusMode: () => {
focusMode.value = !focusMode.value
},
toast,
queueSettings,
command,
sidebarTab,
setting,
workflow,
colorPalette,
dialog,
bottomPanel,
user: partialUserStore,
registerSidebarTab,
unregisterSidebarTab,
getSidebarTabs
}
})