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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Invalidate import-touched caches on import completion (#14326)
Damian Legawiec77e3a007523a
diff --git a/packages/dashboard/e2e/imports.spec.ts b/packages/dashboard/e2e/imports.spec.tsindex da04d820b9..57829de673 100644--- a/packages/dashboard/e2e/imports.spec.ts+++ b/packages/dashboard/e2e/imports.spec.ts@@ -83,8 +83,11 @@ test.describe('csv import', () => {timeout: 15_000,})- // The good row became a real product.- await page.goto(PRODUCTS_PATH(creds.store_id))+ // The good row became a real product, visible through in-app navigation:+ // completion invalidates the products cache, so the list mounted under+ // the wizard is already fresh. (A full-page goto would reset the query+ // cache and mask a stale list.)+ await page.getByRole('button', { name: /view products/i }).click()await expect(page.getByText(goodName)).toBeVisible({ timeout: 15_000 })})diff --git a/packages/dashboard/src/hooks/use-imports.ts b/packages/dashboard/src/hooks/use-imports.tsindex 314e8a62a4..2f4dfc4816 100644--- a/packages/dashboard/src/hooks/use-imports.ts+++ b/packages/dashboard/src/hooks/use-imports.ts@@ -1,6 +1,7 @@import type { Import, ImportCompleteMappingParams } from '@spree/admin-sdk'import { adminClient, useResourceKey, useResourceKeyBuilder } from '@spree/dashboard-core'import { useMutation, useQuery, useQueryClient } from '@tanstack/react-query'+import { useEffect } from 'react'import { toast } from 'sonner'import { isImportActive } from '../lib/import-types'@@ -9,19 +10,48 @@ export { isImportActive }const IMPORT_POLL_INTERVAL_MS = 2000const ROWS_POLL_INTERVAL_MS = 5000+// Caches any import may have written to, plus `imports` itself (history table+// status column). Deliberately not per-type — imports are rare, so a few+// extra refetches beat maintaining a type → resource map (product rows alone+// fan out to option types/values and categories created on the fly).+const IMPORT_TOUCHED_RESOURCES = ['products', 'option-types', 'categories', 'customers', 'imports']+/*** Single import, polled every 2s while the pipeline is running. `mapping`* (user-driven) and terminal statuses don't poll — a mapping-state refetch* would re-read the attached CSV server-side on every tick.+ *+ * A finished import (completed, or failed — earlier rows may still have been+ * written) invalidates every cache imports can touch: the pipeline writes+ * records server-side, outside any tracked mutation, so nothing else ever+ * marks those lists stale and "View products" would keep serving the+ * pre-import cache.*/export function useImport(id: string) {- return useQuery({+ const queryClient = useQueryClient()+ const buildKey = useResourceKeyBuilder()++ const query = useQuery({queryKey: useResourceKey('imports', id),queryFn: () => adminClient.imports.get(id),enabled: !!id,refetchInterval: (query) =>isImportActive(query.state.data?.status) ? IMPORT_POLL_INTERVAL_MS : false,})++ // Fires when the poll lands on a finished status — including again after+ // each retry pass (`finished` flips false → true anew). Reopening an+ // already-finished import refires it; harmless, invalidation is idempotent.+ const status = query.data?.status+ const finished = status === 'completed' || status === 'failed'+ useEffect(() => {+ if (!finished) return+ for (const resource of IMPORT_TOUCHED_RESOURCES) {+ queryClient.invalidateQueries({ queryKey: buildKey(resource) })+ }+ }, [finished, queryClient, buildKey])++ return query}/** Rows of an import (the failure report), optionally polled while processing. */diff --git a/spree/core/lib/generators/spree/dummy/templates/rails/database.yml b/spree/core/lib/generators/spree/dummy/templates/rails/database.ymlindex dc36bb1c7e..635949d614 100644--- a/spree/core/lib/generators/spree/dummy/templates/rails/database.yml+++ b/spree/core/lib/generators/spree/dummy/templates/rails/database.yml@@ -75,6 +75,7 @@ development:test:adapter: sqlite3database: db/spree_test<%%= ENV['TEST_ENV_NUMBER'] %>.sqlite3+ timeout: 10000production:adapter: sqlite3database: db/spree_production.sqlite3