diff --git a/apps/website/src/components/workshop/WorkflowCatalogue.analytics.test.ts b/apps/website/src/components/workshop/WorkflowCatalogue.analytics.test.ts index 5b897acb05b..d438154fa91 100644 --- a/apps/website/src/components/workshop/WorkflowCatalogue.analytics.test.ts +++ b/apps/website/src/components/workshop/WorkflowCatalogue.analytics.test.ts @@ -110,6 +110,44 @@ describe('WorkflowCatalogue analytics', () => { ]) }) + it('reports a capability the visitor removes but not the one a shared link sets', async () => { + const user = userEvent.setup() + render(WorkflowCatalogue, { + props: { + models: [{ ...models[0], capabilities: ['Upscale'] }], + initialSearch: '?capability=Upscale', + serverPage: { + mode: 'cursor', + page: 1, + pageSize: 24, + count: 1, + hasPrevious: false, + hasNext: false + }, + serverFacets: { categories: [], models: [] } + } + }) + const remove = await screen.findByRole('button', { + name: 'Remove Upscale' + }) + vi.advanceTimersByTime(SEARCH_SETTLE_MS) + expect(captureWorkshopEvent).not.toHaveBeenCalled() + + await user.click(remove) + + expect(events('hub_filter_changed')).toEqual([ + { + name: 'hub_filter_changed', + properties: { + surface: 'workflows', + filter: 'capability', + value: 'all', + previous_value: 'Upscale' + } + } + ]) + }) + it('reports a workflow opened from the featured banner', async () => { const user = userEvent.setup() const highlighted = models.map((model) => ({ diff --git a/apps/website/src/components/workshop/WorkflowCatalogue.test.ts b/apps/website/src/components/workshop/WorkflowCatalogue.test.ts index 2479c4698d5..e00addf49df 100644 --- a/apps/website/src/components/workshop/WorkflowCatalogue.test.ts +++ b/apps/website/src/components/workshop/WorkflowCatalogue.test.ts @@ -278,4 +278,121 @@ describe('workflow catalogue ordering and shared links', () => { '/models/workflows/connect/' ]) }) + + it('ignores capability on the static list and keeps the other filters', async () => { + history.replaceState( + null, + '', + '/hub/workflows/?capability=Upscale&model=SeedVR2' + ) + render(WorkflowCatalogue, { + props: { + models: [ + { ...models[0], capabilities: ['Upscale'] }, + ...models.slice(1) + ] + } + }) + await waitFor(() => + expect(screen.getByTestId('workshop-filter-chips')).toHaveTextContent( + 'SeedVR2' + ) + ) + expect(screen.getByTestId('workshop-filter-chips')).not.toHaveTextContent( + 'Upscale' + ) + expect(visibleOutcomes()).toEqual([ + '/models/workflows/connect/', + '/models/workflows/restore/' + ]) + }) +}) + +describe('workflow catalogue capability address on the server-filtered list', () => { + const serverPage = { + mode: 'cursor' as const, + page: 1, + pageSize: 24, + count: 2, + hasPrevious: false, + hasNext: false + } + const serverFacets = { categories: [], models: [] } + + it('opens the capability and search from the address as results, and keeps both in sync', async () => { + const user = userEvent.setup() + const { emitted } = render(WorkflowCatalogue, { + props: { + models: [models[1], models[2]], + initialSearch: '?q=flux&capability=Image+Edit', + serverPage, + serverFacets + } + }) + await waitFor(() => + expect(screen.getByTestId('workshop-filter-chips')).toHaveTextContent( + 'Image Edit' + ) + ) + expect(screen.getByRole('searchbox')).toHaveValue('flux') + expect(screen.getByTestId('workflow-search-results')).toBeInTheDocument() + + await user.click(screen.getByTestId('workshop-sort')) + await user.click(screen.getByTestId('sort-name')) + await waitFor(() => + expect(emitted('search').at(-1)).toEqual([ + 'q=flux&capability=Image+Edit&sort=name' + ]) + ) + + await user.click(screen.getByRole('button', { name: 'Remove Image Edit' })) + await waitFor(() => + expect(emitted('search').at(-1)).toEqual(['q=flux&sort=name']) + ) + }) + + it('trims, drops blank and merges repeated capabilities from the address', async () => { + const user = userEvent.setup() + const { emitted } = render(WorkflowCatalogue, { + props: { + models: [models[1]], + initialSearch: '?capability=+&capability=+b+&capability=b', + serverPage, + serverFacets + } + }) + await waitFor(() => + expect(screen.getAllByRole('button', { name: /^Remove / })).toHaveLength( + 1 + ) + ) + expect(screen.getByRole('button', { name: 'Remove b' })).toBeInTheDocument() + + await user.click(screen.getByTestId('workshop-sort')) + await user.click(screen.getByTestId('sort-name')) + await waitFor(() => + expect(emitted('search').at(-1)).toEqual(['capability=b&sort=name']) + ) + }) + + it('shows the empty result for a capability the server does not know, and clears it', async () => { + const user = userEvent.setup() + const { emitted } = render(WorkflowCatalogue, { + props: { + models: [], + initialSearch: '?capability=Not+A+Capability', + serverPage: { ...serverPage, count: 0 }, + serverFacets + } + }) + expect( + await screen.findByText('No workflows match your search and filters.') + ).toBeInTheDocument() + expect(screen.getByTestId('workshop-filter-chips')).toHaveTextContent( + 'Not A Capability' + ) + + await user.click(screen.getByRole('button', { name: 'Clear' })) + await waitFor(() => expect(emitted('search').at(-1)).toEqual([''])) + }) }) diff --git a/apps/website/src/components/workshop/WorkflowCatalogue.vue b/apps/website/src/components/workshop/WorkflowCatalogue.vue index ccefd27f774..56b715c533d 100644 --- a/apps/website/src/components/workshop/WorkflowCatalogue.vue +++ b/apps/website/src/components/workshop/WorkflowCatalogue.vue @@ -18,7 +18,11 @@ import type { WorkflowWorkshopModel, WorkshopModel } from '@/config/models-catalogue' -import { sortWorkshopModels } from '@/config/models-catalogue' +import { + addressCapabilities, + catalogueAddress, + sortWorkshopModels +} from '@/config/models-catalogue' import { searchWorkshopModels } from '@/config/models-search' import type { CatalogListPages, @@ -65,6 +69,7 @@ const { t } = translationsFor(locale) const query = ref('') const selected = ref([]) const runsOn = ref([]) +const capabilities = ref([]) const sort = ref('popular') const filterMenu = useTemplateRef>('filterMenu') @@ -85,6 +90,7 @@ const { submitSearch, quietly } = useHubCatalogueTracking('workflows', { filters: [ ['category', () => selected.value], ['model', () => runsOn.value], + ['capability', () => capabilities.value], ['sort', () => sort.value] ] }) @@ -123,9 +129,21 @@ function readAddress(search: string, preserveQuery = false) { ? serverFacets.models.some((model) => model.value === name) : models.some((model) => model.models?.includes(name)) ) + capabilities.value = serverPage ? addressCapabilities(params) : [] if (serverPage) sort.value = params.get('sort') === 'name' ? 'name' : 'popular' } +function filterAddress() { + return catalogueAddress(initialSearch ?? location.search, { + query: query.value, + sort: sort.value, + filters: { + category: selected.value, + model: runsOn.value, + capability: capabilities.value + } + }) +} let searchReady = false let requestedQuery: string | undefined let searchTimer: ReturnType | undefined @@ -150,19 +168,12 @@ watch( } ) watch( - [query, selected, runsOn, sort], + [query, selected, runsOn, capabilities, sort], () => { if (!serverPage || !searchReady) return clearTimeout(searchTimer) searchTimer = setTimeout(() => { - const params = new URLSearchParams(initialSearch ?? location.search) - for (const key of ['q', 'category', 'model', 'sort', 'p', 'cursor']) - params.delete(key) - if (query.value) params.set('q', query.value) - for (const value of selected.value) params.append('category', value) - for (const value of runsOn.value) params.append('model', value) - if (sort.value !== 'popular') params.set('sort', sort.value) - const search = params.toString() + const search = filterAddress() const current = new URLSearchParams(initialSearch ?? location.search) current.delete('p') current.delete('cursor') @@ -231,11 +242,19 @@ const modelOptions = computed(() => { const matchingCategories = computed(() => rows.value.flatMap((category) => !selected.value.length || selected.value.includes(category.id) - ? category.models.filter( - (model) => - !runsOn.value.length || - model.models?.some((name) => runsOn.value.includes(name)) - ) + ? category.models + .filter( + (model) => + !runsOn.value.length || + model.models?.some((name) => runsOn.value.includes(name)) + ) + .filter( + (model) => + !capabilities.value.length || + model.capabilities.some((value) => + capabilities.value.includes(value) + ) + ) : [] ) ) @@ -256,6 +275,7 @@ const browsing = computed( !query.value.trim() && !selected.value.length && !runsOn.value.length && + !capabilities.value.length && !browseAll.value ) const featured = computed(() => @@ -279,6 +299,10 @@ const chips = computed(() => [ modelOptions.value.find((option) => option.value === name)?.label ?? name }) + })), + ...capabilities.value.map((value) => ({ + key: `capability:${value}`, + label: value })) ]) @@ -287,12 +311,16 @@ function removeChip(key: string) { const value = rest.join(':') if (kind === 'use') selected.value = selected.value.filter((id) => id !== value) - else runsOn.value = runsOn.value.filter((name) => name !== value) + else if (kind === 'capability') + capabilities.value = capabilities.value.filter((name) => name !== value) + else if (kind === 'model') + runsOn.value = runsOn.value.filter((name) => name !== value) } function clearFilters() { selected.value = [] runsOn.value = [] + capabilities.value = [] } function clear() { diff --git a/apps/website/src/components/workshop/WorkshopModelsGrid.vue b/apps/website/src/components/workshop/WorkshopModelsGrid.vue index 83b5e53ef57..933a479d326 100644 --- a/apps/website/src/components/workshop/WorkshopModelsGrid.vue +++ b/apps/website/src/components/workshop/WorkshopModelsGrid.vue @@ -22,6 +22,7 @@ import type { import { parseCatalogSearch, USE_CASES, + catalogueAddress, countByUseCase, sortOrdersFor, sortWorkshopModels @@ -237,22 +238,16 @@ watch( if (!serverPage || !scrollReady) return clearTimeout(searchTimer) searchTimer = setTimeout(() => { - const params = new URLSearchParams(initialSearch ?? location.search) - for (const key of [ - 'q', - 'useCase', - 'modality', - 'provider', - 'capability', - 'sort', - 'p', - 'cursor' - ]) - params.delete(key) - if (query.value) params.set('q', query.value) - appendSelectedFilters(params) - if (sort.value !== 'popular') params.set('sort', sort.value) - const search = params.toString() + const search = catalogueAddress(initialSearch ?? location.search, { + query: query.value, + sort: sort.value, + filters: { + useCase: selectedUseCases.value, + modality: legacyModalities.value, + provider: legacyProviders.value, + capability: legacyCapabilities.value + } + }) const current = new URLSearchParams(initialSearch ?? location.search) current.delete('p') current.delete('cursor') @@ -264,16 +259,6 @@ watch( }, { deep: true } ) -function appendSelectedFilters(params: URLSearchParams) { - const filters = { - useCase: selectedUseCases.value, - modality: legacyModalities.value, - provider: legacyProviders.value, - capability: legacyCapabilities.value - } - for (const [key, values] of Object.entries(filters)) - for (const value of values) params.append(key, value) -} onBeforeUnmount(() => clearTimeout(searchTimer)) watch(inSection, (value) => emit('section', value), { immediate: true }) // Inside a category the tabs give up the row, and the search takes it. diff --git a/apps/website/src/config/models-catalogue.test.ts b/apps/website/src/config/models-catalogue.test.ts index 92f502a92e6..0d362d7bb1f 100644 --- a/apps/website/src/config/models-catalogue.test.ts +++ b/apps/website/src/config/models-catalogue.test.ts @@ -18,6 +18,7 @@ import { countByFacet, countByUseCase, catalogSearch, + catalogueAddress, filterWorkshopModels, parseCatalogSearch, isRouterModel, @@ -554,3 +555,45 @@ describe('summaryFor', () => { expect(summaryFor([])).toBeUndefined() }) }) + +describe('catalogueAddress', () => { + it.for<{ + name: string + base: string + address: Parameters[1] + expected: string + }>([ + { + name: 'replaces the list keys and keeps the others', + base: '?q=old&category=a&p=3&cursor=x§ion=workflows', + address: { + query: 'flux', + sort: 'name', + filters: { category: ['b'] } + }, + expected: 'section=workflows&q=flux&category=b&sort=name' + }, + { + name: 'drops an empty search and the default sort', + base: '?q=old&sort=name&capability=a', + address: { + query: '', + sort: 'popular', + filters: { capability: [] } + }, + expected: '' + }, + { + name: 'appends every value of each filter in order', + base: '', + address: { + query: '', + sort: 'popular', + filters: { model: ['x', 'y'], capability: ['Image Edit'] } + }, + expected: 'model=x&model=y&capability=Image+Edit' + } + ])('$name', ({ base, address, expected }) => { + expect(catalogueAddress(base, address)).toBe(expected) + }) +}) diff --git a/apps/website/src/config/models-catalogue.ts b/apps/website/src/config/models-catalogue.ts index 3001b6c989e..32a16e159bb 100644 --- a/apps/website/src/config/models-catalogue.ts +++ b/apps/website/src/config/models-catalogue.ts @@ -459,6 +459,44 @@ export function catalogSearch(filter: CatalogLocation): string { return search ? `?${search}` : '' } +export function addressCapabilities(params: URLSearchParams): string[] { + return [ + ...new Set( + params + .getAll('capability') + .map((value) => value.trim()) + .filter(Boolean) + ) + ] +} + +/** + * Rewrites the filters in `base` and drops `p` and `cursor`. Unlike + * `catalogSearch`, it returns no leading `?`. Callers compare the result to + * the current search as a string, so the key order of `filters` matters. + */ +export function catalogueAddress( + base: string, + { + query, + sort, + filters + }: { + query: string + sort: SortOrder + filters: Readonly> + } +): string { + const params = new URLSearchParams(base) + for (const key of ['q', ...Object.keys(filters), 'sort', 'p', 'cursor']) + params.delete(key) + if (query) params.set('q', query) + for (const [key, values] of Object.entries(filters)) + for (const value of values) params.append(key, value) + if (sort !== 'popular') params.set('sort', sort) + return params.toString() +} + export function parseCatalogSearch(search: string): ParsedCatalogLocation { const params = new URLSearchParams(search) const useCase = params.get('useCase') diff --git a/apps/website/src/lib/cms/catalog-list.test.ts b/apps/website/src/lib/cms/catalog-list.test.ts index a6475783bde..16ddf0bc89d 100644 --- a/apps/website/src/lib/cms/catalog-list.test.ts +++ b/apps/website/src/lib/cms/catalog-list.test.ts @@ -127,6 +127,19 @@ describe('bounded website catalog transport', () => { } ) + it('sends each capability from the address trimmed, once and never blank', async () => { + const upstream = setup() + const result = await loadSiteCatalogList( + undefined, + 'en', + 'workflows', + new URLSearchParams('capability=+&capability=+b+&capability=b') + ) + assert.isTrue(result.ok) + const url = new URL(String(upstream.mock.calls[0][0])) + expect(url.searchParams.getAll('capability')).toEqual(['b']) + }) + it('keeps authored details out of the serialized card model', async () => { const response = page() Object.assign(response.items[0].data, { diff --git a/apps/website/src/lib/cms/catalog-list.ts b/apps/website/src/lib/cms/catalog-list.ts index ee5587ab1c4..262613e97be 100644 --- a/apps/website/src/lib/cms/catalog-list.ts +++ b/apps/website/src/lib/cms/catalog-list.ts @@ -4,7 +4,7 @@ import type { } from '@comfyorg/ingest-types' import { zListCccWebsiteCardsQuery } from '@comfyorg/ingest-types/zod' -import { USE_CASES } from '@/config/models-catalogue' +import { USE_CASES, addressCapabilities } from '@/config/models-catalogue' import type { UseCase, SortOrder } from '@/config/models-catalogue' import { modelSchema } from '@/config/models-catalogue-data' import { workflowCategoryLabel } from '@/lib/workshop/workflow-category-label' @@ -75,7 +75,7 @@ function cardQuery( ), modality: params.getAll('modality'), provider: params.getAll('provider'), - capability: params.getAll('capability') + capability: addressCapabilities(params) }) } diff --git a/apps/website/src/scripts/workshop-analytics.ts b/apps/website/src/scripts/workshop-analytics.ts index 76a137f0ea5..b81047e9c12 100644 --- a/apps/website/src/scripts/workshop-analytics.ts +++ b/apps/website/src/scripts/workshop-analytics.ts @@ -54,7 +54,13 @@ export type HubItemSource = | 'app_row' | 'results_grid' -export type HubFilter = 'catalogue' | 'use_case' | 'category' | 'model' | 'sort' +export type HubFilter = + | 'catalogue' + | 'use_case' + | 'category' + | 'model' + | 'capability' + | 'sort' export type WorkshopCheckoutFailureStage = 'balance' | 'credential' | 'checkout'