Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Add filtering by tags to Orders, Customers and Products in Admin API/SDK/SPA

Damian Legawiec32f9548f4b5d
diff --git a/packages/admin/src/components/spree/resource-multi-autocomplete.tsx b/packages/admin/src/components/spree/resource-multi-autocomplete.tsx
index 3d86e2b2e5..4c6ca06887 100644
--- a/packages/admin/src/components/spree/resource-multi-autocomplete.tsx
+++ b/packages/admin/src/components/spree/resource-multi-autocomplete.tsx
@@ -1,5 +1,5 @@
import { useQuery } from '@tanstack/react-query'
-import { useCallback, useMemo, useState } from 'react'
+import { useCallback, useEffect, useMemo, useState } from 'react'
import {
Combobox,
ComboboxChip,
@@ -120,13 +120,9 @@ export function ResourceMultiAutocomplete<T extends AutocompleteOption>({
// missing ids so re-toggling a known id doesn't refetch.
const idsToHydrate = useMemo(() => value.filter((id) => !cache.has(id)), [value, cache])
- useQuery({
+ const { data: hydrateData } = useQuery({
queryKey: [queryKey, 'hydrate', idsToHydrate],
- queryFn: async () => {
- const result = await hydrate(idsToHydrate)
- cacheItems(result.data)
- return result
- },
+ queryFn: () => hydrate(idsToHydrate),
enabled: idsToHydrate.length > 0,
staleTime: Number.POSITIVE_INFINITY,
})
@@ -135,14 +131,23 @@ export function ResourceMultiAutocomplete<T extends AutocompleteOption>({
const { data: searchData, isFetching } = useQuery({
queryKey: [queryKey, 'search', trimmedInput],
- queryFn: async () => {
- const result = await search(trimmedInput)
- cacheItems(result.data)
- return result
- },
+ queryFn: () => search(trimmedInput),
enabled: trimmedInput.length > 0,
})
+ // Mirror query results into the local id→option cache via an effect, not
+ // inside `queryFn`. When the picker remounts (filter panel reopens) with
+ // `staleTime: Infinity`, TanStack Query returns the cached result without
+ // re-running `queryFn`, so writes inside `queryFn` are skipped. Reading
+ // `data` here re-fires on every remount.
+ useEffect(() => {
+ if (hydrateData?.data?.length) cacheItems(hydrateData.data)
+ }, [hydrateData, cacheItems])
+
+ useEffect(() => {
+ if (searchData?.data?.length) cacheItems(searchData.data)
+ }, [searchData, cacheItems])
+
// Dropdown items — search results, then any selected IDs not in
// results so the user can deselect chips via the dropdown.
const items = useMemo<T[]>(() => {
diff --git a/packages/admin/src/components/ui/combobox.tsx b/packages/admin/src/components/ui/combobox.tsx
index 2aa30cedcb..8ee5c43d08 100644
--- a/packages/admin/src/components/ui/combobox.tsx
+++ b/packages/admin/src/components/ui/combobox.tsx
@@ -222,12 +222,12 @@ function ComboboxChip({
<ComboboxPrimitive.Chip
data-slot="combobox-chip"
className={cn(
- 'flex h-[calc(--spacing(5.25))] w-fit items-center justify-center gap-1 rounded-sm bg-muted px-1.5 text-xs font-medium whitespace-nowrap text-foreground has-disabled:pointer-events-none has-disabled:cursor-not-allowed has-disabled:opacity-50 has-data-[slot=combobox-chip-remove]:pr-0',
+ 'flex h-[calc(--spacing(5.25))] w-fit max-w-full items-center justify-center gap-1 rounded-sm bg-muted px-1.5 text-xs font-medium text-foreground has-disabled:pointer-events-none has-disabled:cursor-not-allowed has-disabled:opacity-50 has-data-[slot=combobox-chip-remove]:pr-0',
className,
)}
{...props}
>
- {children}
+ <span className="min-w-0 truncate">{children}</span>
{showRemove && (
<ComboboxPrimitive.ChipRemove
render={<Button variant="ghost" size="icon-xs" />}
diff --git a/packages/admin/src/hooks/use-categories.ts b/packages/admin/src/hooks/use-categories.ts
index f86ed3f1fe..296c99bd19 100644
--- a/packages/admin/src/hooks/use-categories.ts
+++ b/packages/admin/src/hooks/use-categories.ts
@@ -1,4 +1,6 @@
+import type { Category } from '@spree/admin-sdk'
import { useQuery } from '@tanstack/react-query'
+import i18n from 'i18next'
import { adminClient } from '@/client'
export function useCategories() {
@@ -8,3 +10,20 @@ export function useCategories() {
staleTime: 1000 * 60 * 5,
})
}
+
+/**
+ * Shared config for any `<ResourceMultiAutocomplete>` picking categories
+ * (product edit page, bulk-action dialog, promotion-rule editor). Pass a
+ * unique `queryKey` per instance so independent caches don't collide.
+ */
+export function categoryAutocompleteProps(queryKey: string) {
+ return {
+ queryKey,
+ search: (q: string) =>
+ adminClient.categories.list({ name_cont: q, limit: 20, sort: 'pretty_name' }),
+ hydrate: (ids: string[]) => adminClient.categories.list({ id_in: ids, limit: ids.length }),
+ getOptionLabel: (c: Category) => c.pretty_name ?? c.name ?? c.id,
+ placeholder: i18n.t('admin.products.category_search_placeholder'),
+ emptyText: i18n.t('admin.products.no_categories_found'),
+ }
+}
diff --git a/packages/admin/src/lib/filters-to-ransack.ts b/packages/admin/src/lib/filters-to-ransack.ts
index d544de8e2c..a4252bb854 100644
--- a/packages/admin/src/lib/filters-to-ransack.ts
+++ b/packages/admin/src/lib/filters-to-ransack.ts
@@ -29,7 +29,12 @@ export function filtersToRansack(
const out: Record<string, string | string[]> = {}
for (const filter of filters) {
const col = columns.find((c) => c.key === filter.field)
- const ransackKey = col?.ransackAttribute ?? filter.field
+ // `filterType: 'tags'` rides on the polymorphic `tags` association exposed
+ // via `acts_as_taggable_on`. Predicates target the join's `name` column
+ // (`tags_name_in`), not the column key (`tags_in`), so default the
+ // ransack alias here when one isn't explicitly set.
+ const fallback = col?.filterType === 'tags' ? 'tags_name' : filter.field
+ const ransackKey = col?.ransackAttribute ?? fallback
const key = `${ransackKey}_${filter.operator}`
if (ARRAY_OPERATORS.has(filter.operator)) {
const ids = parseFilterIds(filter.value)
diff --git a/packages/admin/src/lib/table-registry.ts b/packages/admin/src/lib/table-registry.ts
index da4610bb77..38b6999778 100644
--- a/packages/admin/src/lib/table-registry.ts
+++ b/packages/admin/src/lib/table-registry.ts
@@ -38,28 +38,41 @@ export interface ResourceFilterConfig<R extends { id: string } = { id: string }>
emptyText?: string
}
+/** Models that `TagCombobox` can target for tag autocomplete. */
+export type TaggableType = 'Spree::Product' | 'Spree::User' | 'Spree::Order'
+
/**
* Column definition. Discriminated union on `filterType`:
* - `'enum'` → `filterOptions` is **required**
* - `'resource'` → `filterResource` is **required** (multi-select picker)
- * - other types → both must be omitted
+ * - `'tags'` → `taggableType` is **required** (drives TagCombobox)
+ * - other types → all variant fields must be omitted
*/
export type ColumnDef<T = any> =
| (ColumnDefBase<T> & {
filterType?: 'string' | 'boolean' | 'number' | 'date' | 'currency'
filterOptions?: never
filterResource?: never
+ taggableType?: never
})
| (ColumnDefBase<T> & {
filterType: 'enum'
filterOptions: { value: string; label: string }[]
filterResource?: never
+ taggableType?: never
})
| (ColumnDefBase<T> & {
filterType: 'resource'
filterOptions?: never
// eslint-disable-next-line @typescript-eslint/no-explicit-any
filterResource: ResourceFilterConfig<any>
+ taggableType?: never
+ })
+ | (ColumnDefBase<T> & {
+ filterType: 'tags'
+ filterOptions?: never
+ filterResource?: never
+ taggableType: TaggableType
})
export interface FilterRule {
diff --git a/packages/admin/src/tables/customers.tsx b/packages/admin/src/tables/customers.tsx
index bd862e17b5..9e0fadc7b3 100644
--- a/packages/admin/src/tables/customers.tsx
+++ b/packages/admin/src/tables/customers.tsx
@@ -1,6 +1,7 @@
import { Link } from '@tanstack/react-router'
import { UsersIcon } from 'lucide-react'
import { RelativeTime } from '@/components/spree/relative-time'
+import { TagList } from '@/components/spree/tag-list'
import { ActiveBadge, Badge } from '@/components/ui/badge'
import { customerGroupAutocompleteProps } from '@/hooks/use-customer-groups'
import { defineTable } from '@/lib/table-registry'
@@ -90,6 +91,16 @@ defineTable('customers', {
)
},
},
+ {
+ key: 'tags',
+ label: 'Tags',
+ sortable: false,
+ filterable: true,
+ filterType: 'tags',
+ taggableType: 'Spree::User',
+ default: false,
+ render: (c) => <TagList tags={c.tags} />,
+ },
{
key: 'accepts_email_marketing',
label: 'Newsletter',
diff --git a/packages/admin/src/tables/orders.tsx b/packages/admin/src/tables/orders.tsx
index d23aafe8dc..b52d4d5015 100644
--- a/packages/admin/src/tables/orders.tsx
+++ b/packages/admin/src/tables/orders.tsx
@@ -1,6 +1,7 @@
import { Link } from '@tanstack/react-router'
import { ShoppingCartIcon } from 'lucide-react'
import { RelativeTime } from '@/components/spree/relative-time'
+import { TagList } from '@/components/spree/tag-list'
import { StatusBadge } from '@/components/ui/badge'
import { defineTable } from '@/lib/table-registry'
@@ -125,6 +126,16 @@ defineTable('orders', {
],
render: (order) => <StatusBadge status={order.status} />,
},
+ {
+ key: 'tags',
+ label: 'Tags',
+ sortable: false,
+ filterable: true,
+ filterType: 'tags',
+ taggableType: 'Spree::Order',
+ default: false,
+ render: (order) => <TagList tags={order.tags} />,
+ },
{
key: 'created_at',
label: 'Created at',
diff --git a/packages/admin/src/tables/products.tsx b/packages/admin/src/tables/products.tsx
index c365629210..c274f39a14 100644
--- a/packages/admin/src/tables/products.tsx
+++ b/packages/admin/src/tables/products.tsx
@@ -2,7 +2,9 @@ import { Link } from '@tanstack/react-router'
import i18n from 'i18next'
import { PackageIcon } from 'lucide-react'
import { RelativeTime } from '@/components/spree/relative-time'
+import { TagList } from '@/components/spree/tag-list'
import { StatusBadge } from '@/components/ui/badge'
+import { categoryAutocompleteProps } from '@/hooks/use-categories'
import { formatPrice } from '@/lib/formatters'
import { defineTable } from '@/lib/table-registry'
@@ -119,6 +121,16 @@ defineTable('products', {
className: 'text-right tabular-nums whitespace-nowrap',
render: (product) => formatPrice(product.price),
},
+ {
+ key: 'tags',
+ label: i18n.t('admin.fields.product.tags.label'),
+ sortable: false,
+ filterable: true,
+ filterType: 'tags',
+ taggableType: 'Spree::Product',
+ default: false,
+ render: (product) => <TagList tags={product.tags} />,
+ },
{
key: 'created_at',
label: i18n.t('admin.fields.created_at.label'),
@@ -147,5 +159,19 @@ defineTable('products', {
displayable: false,
default: false,
},
+ // Filter-only — Ransack joins through `products.taxons`, so the predicate
+ // emitted is `taxons_id_in`. We don't render a categories cell on the
+ // index to avoid expanding categories on every list refetch; users can
+ // see attached categories on the product edit page.
+ {
+ key: 'categories',
+ label: i18n.t('admin.fields.product.category_ids.label'),
+ filterable: true,
+ filterType: 'resource',
+ filterResource: categoryAutocompleteProps('products-table-category-filter'),
+ ransackAttribute: 'taxons_id',
+ displayable: false,
+ default: false,
+ },
],
})
diff --git a/spree/core/app/models/spree/order.rb b/spree/core/app/models/spree/order.rb
index c1ad7ed63b..6a5f2d664e 100644
--- a/spree/core/app/models/spree/order.rb
+++ b/spree/core/app/models/spree/order.rb
@@ -109,7 +109,7 @@ module Spree
go_to_state :complete
end
- self.whitelisted_ransackable_associations = %w[shipments user created_by approver canceler promotions bill_address ship_address line_items store channel]
+ self.whitelisted_ransackable_associations = %w[shipments user created_by approver canceler promotions bill_address ship_address line_items store channel tags]
self.whitelisted_ransackable_attributes = %w[
completed_at email number state status payment_state shipment_state
total item_total item_count considered_risky channel_id currency