From f44718ad34e9d3cc2e14de57787b8a4c8c83d531 Mon Sep 17 00:00:00 2001 From: Amp Date: Sun, 27 Sep 2026 18:49:50 +0000 Subject: [PATCH 1/2] refactor: move model library asset browser routing onto the sidebar tab sidebarTabStore special-cased the model-library tab id to open the asset browser instead of the sidebar, importing openModelLibraryBrowser and the feature flag and setting stores for one tab. SidebarTabExtension gains an optional onToggle hook; the toggle command defers to it and the model library tab owns the asset browser routing. Import cycles: 471 -> 467 cyclic modules, largest SCC 257 -> 253. Amp-Thread-ID: https://ampcode.com/threads/T-01a0dcdd-4461-71d3-be73-0705e36d5297 --- .../useModelLibrarySidebarTab.test.ts | 58 ++++++++++++++ .../sidebarTabs/useModelLibrarySidebarTab.ts | 11 +++ src/stores/workspace/sidebarTabStore.test.ts | 76 +++++-------------- src/stores/workspace/sidebarTabStore.ts | 19 +---- src/types/extensionTypes.ts | 2 + 5 files changed, 92 insertions(+), 74 deletions(-) create mode 100644 src/composables/sidebarTabs/useModelLibrarySidebarTab.test.ts diff --git a/src/composables/sidebarTabs/useModelLibrarySidebarTab.test.ts b/src/composables/sidebarTabs/useModelLibrarySidebarTab.test.ts new file mode 100644 index 00000000000..b8bb193514f --- /dev/null +++ b/src/composables/sidebarTabs/useModelLibrarySidebarTab.test.ts @@ -0,0 +1,58 @@ +import { describe, expect, it, vi } from 'vitest' + +import { useModelLibrarySidebarTab } from '@/composables/sidebarTabs/useModelLibrarySidebarTab' +import { useFeatureFlags } from '@/composables/useFeatureFlags' +import { openModelLibraryBrowser } from '@/platform/assets/composables/openModelLibraryBrowser' +import { useSettingStore } from '@/platform/settings/settingStore' + +vi.mock( + import('@/components/sidebar/tabs/ModelLibrarySidebarTab.vue'), + () => ({ + default: {} + }) +) +vi.mock(import('@/composables/useFeatureFlags')) +vi.mock( + import('@/platform/assets/composables/openModelLibraryBrowser'), + () => ({ + openModelLibraryBrowser: vi.fn() + }) +) + +describe('useModelLibrarySidebarTab', () => { + it.for([ + { + name: 'opens the asset browser when the asset view and the assets capability are both enabled', + useAssetBrowser: true, + assetsEnabled: true, + handled: true, + browserOpens: 1 + }, + { + name: 'toggles the sidebar tab when the asset view is disabled', + useAssetBrowser: false, + assetsEnabled: true, + handled: false, + browserOpens: 0 + }, + { + name: 'falls back to the sidebar tree when the assets capability is missing', + useAssetBrowser: true, + assetsEnabled: false, + handled: false, + browserOpens: 0 + } + ])( + '$name', + async ({ useAssetBrowser, assetsEnabled, handled, browserOpens }) => { + useSettingStore().settingValues['Comfy.ModelLibrary.UseAssetBrowser'] = + useAssetBrowser + vi.mocked(useFeatureFlags().flags).assetsEnabled = assetsEnabled + + const tab = useModelLibrarySidebarTab() + + await expect(tab.onToggle?.()).resolves.toBe(handled) + expect(openModelLibraryBrowser).toHaveBeenCalledTimes(browserOpens) + } + ) +}) diff --git a/src/composables/sidebarTabs/useModelLibrarySidebarTab.ts b/src/composables/sidebarTabs/useModelLibrarySidebarTab.ts index 8970178621b..7268198392b 100644 --- a/src/composables/sidebarTabs/useModelLibrarySidebarTab.ts +++ b/src/composables/sidebarTabs/useModelLibrarySidebarTab.ts @@ -1,7 +1,10 @@ import { markRaw } from 'vue' import ModelLibrarySidebarTab from '@/components/sidebar/tabs/ModelLibrarySidebarTab.vue' +import { useFeatureFlags } from '@/composables/useFeatureFlags' +import { openModelLibraryBrowser } from '@/platform/assets/composables/openModelLibraryBrowser' import { isDesktop } from '@/platform/distribution/types' +import { useSettingStore } from '@/platform/settings/settingStore' import { useElectronDownloadStore } from '@/stores/electronDownloadStore' import type { SidebarTabExtension } from '@/types/extensionTypes' @@ -14,6 +17,14 @@ export const useModelLibrarySidebarTab = (): SidebarTabExtension => { label: 'sideToolbar.labels.models', component: markRaw(ModelLibrarySidebarTab), type: 'vue', + onToggle: async () => { + const useAssetBrowser = + useSettingStore().get('Comfy.ModelLibrary.UseAssetBrowser') && + useFeatureFlags().flags.assetsEnabled + if (!useAssetBrowser) return false + await openModelLibraryBrowser() + return true + }, iconBadge: () => { if (isDesktop) { const electronDownloadStore = useElectronDownloadStore() diff --git a/src/stores/workspace/sidebarTabStore.test.ts b/src/stores/workspace/sidebarTabStore.test.ts index cd7c2f171c2..1899f4fd7c9 100644 --- a/src/stores/workspace/sidebarTabStore.test.ts +++ b/src/stores/workspace/sidebarTabStore.test.ts @@ -1,83 +1,47 @@ import { describe, expect, it, vi } from 'vitest' -import { useFeatureFlags } from '@/composables/useFeatureFlags' -import { useSettingStore } from '@/platform/settings/settingStore' import { useCommandStore } from '@/stores/commandStore' import { useSidebarTabStore } from '@/stores/workspace/sidebarTabStore' -const mockOpenModelLibraryBrowser = vi.hoisted(() => vi.fn()) - -vi.mock(import('@/composables/useFeatureFlags')) -vi.mock( - import('@/platform/assets/composables/openModelLibraryBrowser'), - () => ({ - openModelLibraryBrowser: mockOpenModelLibraryBrowser - }) -) - vi.mock(import('@/i18n'), () => ({ t: (key: string) => key, te: () => false })) describe('useSidebarTabStore', () => { - const registerModelLibraryTab = () => { + const registerTab = (onToggle?: () => Promise) => { const store = useSidebarTabStore() store.registerSidebarTab({ - id: 'model-library', - title: 'model-library', + id: 'tab', + title: 'tab', type: 'vue', - component: {} + component: {}, + onToggle }) return store } - const toggleModelLibrary = async () => { + const runToggleCommand = async () => { const toggleCommand = useCommandStore().commands.find( - (command) => command.id === 'Workspace.ToggleSidebarTab.model-library' + (command) => command.id === 'Workspace.ToggleSidebarTab.tab' ) await toggleCommand?.function() } - describe('model library view selection', () => { - const useAssetBrowserSetting = (enabled: boolean) => { - useSettingStore().settingValues['Comfy.ModelLibrary.UseAssetBrowser'] = - enabled - } - - it('toggles the sidebar tab when the asset view is disabled', async () => { - useAssetBrowserSetting(false) - vi.mocked(useFeatureFlags().flags).assetsEnabled = true - - const store = registerModelLibraryTab() - - await toggleModelLibrary() - - expect(store.activeSidebarTabId).toBe('model-library') - expect(mockOpenModelLibraryBrowser).not.toHaveBeenCalled() - }) - - it('opens the asset browser when the asset view and the assets capability are both enabled', async () => { - useAssetBrowserSetting(true) - vi.mocked(useFeatureFlags().flags).assetsEnabled = true + describe('toggle command', () => { + it.for([ + { hook: 'none', onToggle: undefined, activeTabId: 'tab' }, + { hook: 'declines', onToggle: async () => false, activeTabId: 'tab' }, + { hook: 'handles', onToggle: async () => true, activeTabId: null } + ])( + 'activates the tab unless the onToggle hook handles it ($hook)', + async ({ onToggle, activeTabId }) => { + const store = registerTab(onToggle) - const store = registerModelLibraryTab() + await runToggleCommand() - await toggleModelLibrary() - - expect(mockOpenModelLibraryBrowser).toHaveBeenCalledOnce() - expect(store.activeSidebarTabId).toBeNull() - }) - - it('falls back to the sidebar tree when the assets capability is missing', async () => { - useAssetBrowserSetting(true) - - const store = registerModelLibraryTab() - - await toggleModelLibrary() - - expect(store.activeSidebarTabId).toBe('model-library') - expect(mockOpenModelLibraryBrowser).not.toHaveBeenCalled() - }) + expect(store.activeSidebarTabId).toBe(activeTabId) + } + ) }) }) diff --git a/src/stores/workspace/sidebarTabStore.ts b/src/stores/workspace/sidebarTabStore.ts index 38689ebac05..465479d62d5 100644 --- a/src/stores/workspace/sidebarTabStore.ts +++ b/src/stores/workspace/sidebarTabStore.ts @@ -1,10 +1,7 @@ import { defineStore } from 'pinia' import { computed, ref } from 'vue' -import { useFeatureFlags } from '@/composables/useFeatureFlags' import { t, te } from '@/i18n' -import { openModelLibraryBrowser } from '@/platform/assets/composables/openModelLibraryBrowser' -import { useSettingStore } from '@/platform/settings/settingStore' import { useCommandStore } from '@/stores/commandStore' import type { SidebarTabExtension } from '@/types/extensionTypes' @@ -68,21 +65,7 @@ export const useSidebarTabStore = defineStore('sidebarTab', () => { versionAdded: '1.3.9', category: 'view-controls' as const, function: async () => { - const settingStore = useSettingStore() - - // The asset browser cannot function without backend asset support, so - // the browser routing requires both the user preference and the server - // capability; without the capability the preference is inert and the - // tab opens the sidebar tree. - if ( - tab.id === 'model-library' && - settingStore.get('Comfy.ModelLibrary.UseAssetBrowser') && - useFeatureFlags().flags.assetsEnabled - ) { - await openModelLibraryBrowser() - return - } - + if (await tab.onToggle?.()) return toggleSidebarTab(tab.id) }, active: () => activeSidebarTab.value?.id === tab.id, diff --git a/src/types/extensionTypes.ts b/src/types/extensionTypes.ts index 782d7520436..e934f96771d 100644 --- a/src/types/extensionTypes.ts +++ b/src/types/extensionTypes.ts @@ -13,6 +13,8 @@ interface BaseSidebarTabExtension { iconBadge?: string | (() => string | null) tooltip?: string label?: string + /** Returns true when the tab handled the toggle itself. */ + onToggle?: () => boolean | Promise } interface BaseBottomPanelExtension { From df7d64038cb3ea950523907c48f87c3685937e47 Mon Sep 17 00:00:00 2001 From: Alexander Brown Date: Wed, 7 Oct 2026 00:55:40 +0000 Subject: [PATCH 2/2] refactor: drop onToggle JSDoc to match sibling sidebar tab fields Amp-Thread-ID: https://ampcode.com/threads/T-01a113aa-d4ac-74ac-b71a-55368495cbd6 --- src/types/extensionTypes.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/src/types/extensionTypes.ts b/src/types/extensionTypes.ts index e934f96771d..bcf9fd0e1d9 100644 --- a/src/types/extensionTypes.ts +++ b/src/types/extensionTypes.ts @@ -13,7 +13,6 @@ interface BaseSidebarTabExtension { iconBadge?: string | (() => string | null) tooltip?: string label?: string - /** Returns true when the tab handled the toggle itself. */ onToggle?: () => boolean | Promise }