Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions src/composables/sidebarTabs/useModelLibrarySidebarTab.test.ts
Original file line number Diff line number Diff line change
@@ -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<unknown>(
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)
}
)
})
11 changes: 11 additions & 0 deletions src/composables/sidebarTabs/useModelLibrarySidebarTab.ts
Original file line number Diff line number Diff line change
@@ -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'

Expand All @@ -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()
Expand Down
76 changes: 20 additions & 56 deletions src/stores/workspace/sidebarTabStore.test.ts
Original file line number Diff line number Diff line change
@@ -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<boolean>) => {
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)
}
)
})
})
19 changes: 1 addition & 18 deletions src/stores/workspace/sidebarTabStore.ts
Original file line number Diff line number Diff line change
@@ -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'

Expand Down Expand Up @@ -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,
Expand Down
1 change: 1 addition & 0 deletions src/types/extensionTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ interface BaseSidebarTabExtension {
iconBadge?: string | (() => string | null)
tooltip?: string
label?: string
onToggle?: () => boolean | Promise<boolean>
}

interface BaseBottomPanelExtension {
Expand Down
Loading