@faststore/core 4.7.0-dev.3 → 4.7.0-dev.5

package/test/sdk/analytics/useStartRecommendationSession.test.ts

@@ -18,50 +18,21 @@ vi.mock('src/sdk/graphql/useLazyQuery', () => ({
 const getCookie = vi.hoisted(() => vi.fn())
 vi.mock('src/utils/getCookie', () => ({ getCookie }))
 
+const storeConfigMock = vi.hoisted(() => ({
+  experimental: { enableRecommendations: true },
+}))
+vi.mock('discovery.config', () => ({ default: storeConfigMock }))
+
 import {
   resetStartRecommendationSessionLock,
   useStartRecommendationSession,
 } from 'src/sdk/analytics/hooks/useStartRecommendationSession'
 
-const enabledPageProps = {
-  sections: [
-    {
-      name: 'RecommendationShelf',
-      data: { enableRecommendations: true },
-    },
-  ],
-}
-
-const multipleEnabledShelvesPageProps = {
-  sections: [
-    {
-      name: 'RecommendationShelf',
-      data: { enableRecommendations: true, campaignVrn: 'vrn:a' },
-    },
-    {
-      name: 'RecommendationShelf',
-      data: { enableRecommendations: true, campaignVrn: 'vrn:b' },
-    },
-    {
-      name: 'ProductShelf',
-      data: {},
-    },
-  ],
-}
-
-const disabledPageProps = {
-  sections: [
-    {
-      name: 'RecommendationShelf',
-      data: { enableRecommendations: false },
-    },
-  ],
-}
-
 beforeEach(() => {
   resetStartRecommendationSessionLock()
   useLazyQueryMock.mockReturnValue([runStartRecommendationSession, {}])
   runStartRecommendationSession.mockResolvedValue(true)
+  storeConfigMock.experimental.enableRecommendations = true
 })
 
 afterEach(() => {
@@ -69,18 +40,19 @@ afterEach(() => {
 })
 
 describe('useStartRecommendationSession', () => {
-  it('does not start a session when no RecommendationShelf is enabled in CMS', async () => {
+  it('does not start a session when experimental.enableRecommendations is false', async () => {
+    storeConfigMock.experimental.enableRecommendations = false
     getCookie.mockReturnValue(undefined)
 
-    renderHook(() => useStartRecommendationSession(disabledPageProps))
+    renderHook(() => useStartRecommendationSession())
 
     await waitFor(() => {
       expect(runStartRecommendationSession).not.toHaveBeenCalled()
     })
   })
 
-  it('does not start a session when page props are missing', async () => {
-    getCookie.mockReturnValue(undefined)
+  it('does not start a session when the session cookie already exists', async () => {
+    getCookie.mockReturnValue('already-started')
 
     renderHook(() => useStartRecommendationSession())
 
@@ -89,53 +61,50 @@ describe('useStartRecommendationSession', () => {
     })
   })
 
-  it('does not start a session when the session cookie already exists', async () => {
-    getCookie.mockReturnValue('already-started')
+  it('starts a session when the feature flag is on and no session cookie is present', async () => {
+    getCookie.mockReturnValue(undefined)
 
-    renderHook(() => useStartRecommendationSession(enabledPageProps))
+    renderHook(() => useStartRecommendationSession())
 
     await waitFor(() => {
-      expect(runStartRecommendationSession).not.toHaveBeenCalled()
+      expect(runStartRecommendationSession).toHaveBeenCalledTimes(1)
     })
   })
 
-  it('starts a session when CMS enableRecommendations is true and no session cookie is present', async () => {
+  it('starts a session when enabled override is true even if the feature flag is off', async () => {
+    storeConfigMock.experimental.enableRecommendations = false
     getCookie.mockReturnValue(undefined)
 
-    renderHook(() => useStartRecommendationSession(enabledPageProps))
+    renderHook(() => useStartRecommendationSession(true))
 
     await waitFor(() => {
       expect(runStartRecommendationSession).toHaveBeenCalledTimes(1)
     })
   })
 
-  it('starts a session only once when the page has multiple enabled RecommendationShelves', async () => {
+  it('does not start a session when enabled override is false even if the feature flag is on', async () => {
     getCookie.mockReturnValue(undefined)
 
-    const { rerender } = renderHook(
-      ({ pageProps }) => useStartRecommendationSession(pageProps),
-      { initialProps: { pageProps: multipleEnabledShelvesPageProps } }
-    )
-
-    // Simulate Layout re-renders caused by multiple shelves updating.
-    rerender({ pageProps: multipleEnabledShelvesPageProps })
-    rerender({ pageProps: multipleEnabledShelvesPageProps })
+    renderHook(() => useStartRecommendationSession(false))
 
     await waitFor(() => {
-      expect(runStartRecommendationSession).toHaveBeenCalledTimes(1)
+      expect(runStartRecommendationSession).not.toHaveBeenCalled()
     })
   })
 
-  it('does not start a second session when the hook mounts again without a cookie', async () => {
+  it('starts a session only once across remounts / re-renders (in-memory lock)', async () => {
     getCookie.mockReturnValue(undefined)
 
-    renderHook(() => useStartRecommendationSession(enabledPageProps))
+    const { rerender } = renderHook(() => useStartRecommendationSession())
+
+    rerender()
+    rerender()
 
     await waitFor(() => {
       expect(runStartRecommendationSession).toHaveBeenCalledTimes(1)
     })
 
-    renderHook(() => useStartRecommendationSession(enabledPageProps))
+    renderHook(() => useStartRecommendationSession())
 
     await waitFor(() => {
       expect(runStartRecommendationSession).toHaveBeenCalledTimes(1)

package/test/sdk/recommendations/useRecommendationShelf.browser.test.tsx

@@ -17,6 +17,11 @@ vi.mock('src/sdk/recommendations/useRecommendationUserId', () => ({
   useRecommendationUserId,
 }))
 
+const useStartRecommendationSession = vi.hoisted(() => vi.fn())
+vi.mock('src/sdk/analytics/hooks/useStartRecommendationSession', () => ({
+  useStartRecommendationSession,
+}))
+
 import { useRecommendationShelf } from 'src/sdk/recommendations/useRecommendationShelf'
 
 const TOP_ITEMS_VRN = 'vrn:recommendations:acc:rec-top-items-v2:campaign-1'
@@ -53,12 +58,9 @@ afterEach(() => {
 })
 
 describe('useRecommendationShelf', () => {
-  it('exposes the campaign payload when enabled', () => {
+  it('exposes the campaign payload', () => {
     const { result } = renderHook(() =>
-      useRecommendationShelf({
-        campaignVrn: TOP_ITEMS_VRN,
-        enableRecommendations: true,
-      })
+      useRecommendationShelf({ campaignVrn: TOP_ITEMS_VRN })
     )
 
     expect(result.current.items).toHaveLength(2)
@@ -66,32 +68,40 @@ describe('useRecommendationShelf', () => {
     expect(result.current.correlationId).toBe('corr-1')
   })
 
-  it('never fetches while recommendations are disabled', () => {
+  it('never fetches before a userId resolves', () => {
+    useRecommendationUserId.mockReturnValue(null)
+
     renderHook(() => useRecommendationShelf({ campaignVrn: TOP_ITEMS_VRN }))
 
     expect(lastArgs()).toBeNull()
   })
 
-  it('never fetches before a userId resolves', () => {
+  it('starts the recommendation session as a fallback when userId is missing', () => {
     useRecommendationUserId.mockReturnValue(null)
 
-    renderHook(() =>
-      useRecommendationShelf({
-        campaignVrn: TOP_ITEMS_VRN,
-        enableRecommendations: true,
-      })
-    )
+    renderHook(() => useRecommendationShelf({ campaignVrn: TOP_ITEMS_VRN }))
 
-    expect(lastArgs()).toBeNull()
+    expect(useStartRecommendationSession).toHaveBeenCalledWith(true)
+  })
+
+  it('starts the recommendation session while userId is still resolving', () => {
+    useRecommendationUserId.mockReturnValue(undefined)
+
+    renderHook(() => useRecommendationShelf({ campaignVrn: TOP_ITEMS_VRN }))
+
+    expect(useStartRecommendationSession).toHaveBeenCalledWith(true)
+  })
+
+  it('does not start the recommendation session when userId already exists', () => {
+    useRecommendationUserId.mockReturnValue('user-1')
+
+    renderHook(() => useRecommendationShelf({ campaignVrn: TOP_ITEMS_VRN }))
+
+    expect(useStartRecommendationSession).toHaveBeenCalledWith(false)
   })
 
   it('never fetches on a malformed campaign vrn', () => {
-    renderHook(() =>
-      useRecommendationShelf({
-        campaignVrn: 'not-a-vrn',
-        enableRecommendations: true,
-      })
-    )
+    renderHook(() => useRecommendationShelf({ campaignVrn: 'not-a-vrn' }))
 
     expect(lastArgs()).toBeNull()
   })
@@ -104,7 +114,6 @@ describe('useRecommendationShelf', () => {
     renderHook(() =>
       useRecommendationShelf({
         campaignVrn: CROSS_SELL_VRN,
-        enableRecommendations: true,
         itemsContext: 'CART',
       })
     )
@@ -120,7 +129,6 @@ describe('useRecommendationShelf', () => {
     renderHook(() =>
       useRecommendationShelf({
         campaignVrn: CROSS_SELL_VRN,
-        enableRecommendations: true,
         itemsContext: 'CART',
       })
     )
@@ -132,7 +140,6 @@ describe('useRecommendationShelf', () => {
     renderHook(() =>
       useRecommendationShelf({
         campaignVrn: TOP_ITEMS_VRN,
-        enableRecommendations: true,
         itemsContext: 'CART',
       })
     )
@@ -150,7 +157,6 @@ describe('useRecommendationShelf', () => {
     const { rerender } = renderHook(() =>
       useRecommendationShelf({
         campaignVrn: CROSS_SELL_VRN,
-        enableRecommendations: true,
         itemsContext: 'CART',
       })
     )
@@ -166,12 +172,7 @@ describe('useRecommendationShelf', () => {
       data: { product: { isVariantOf: { productGroupID: 'pg-pdp' } } },
     })
 
-    renderHook(() =>
-      useRecommendationShelf({
-        campaignVrn: CROSS_SELL_VRN,
-        enableRecommendations: true,
-      })
-    )
+    renderHook(() => useRecommendationShelf({ campaignVrn: CROSS_SELL_VRN }))
 
     expect(lastArgs()?.products).toEqual(['pg-pdp'])
   })
@@ -185,10 +186,7 @@ describe('useRecommendationShelf', () => {
     })
 
     const { result } = renderHook(() =>
-      useRecommendationShelf({
-        campaignVrn: TOP_ITEMS_VRN,
-        enableRecommendations: true,
-      })
+      useRecommendationShelf({ campaignVrn: TOP_ITEMS_VRN })
     )
 
     expect(result.current.items).toEqual([])

package/test/sdk/recommendations/useRecommendationShelf.sessionFallback.browser.test.tsx

@@ -0,0 +1,110 @@
+import { renderHook, waitFor } from '@testing-library/react'
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+
+const usePDP = vi.hoisted(() => vi.fn())
+vi.mock('@faststore/core', () => ({ usePDP }))
+
+vi.mock('@faststore/core/api', () => ({
+  gql: (s: string) => ({ __meta__: {}, query: s }),
+}))
+
+const useCart = vi.hoisted(() => vi.fn())
+vi.mock('src/sdk/cart', () => ({ useCart }))
+
+const useRecommendations = vi.hoisted(() => vi.fn())
+vi.mock('src/sdk/recommendations/useRecommendations', () => ({
+  useRecommendations,
+}))
+
+const runStartRecommendationSession = vi.hoisted(() => vi.fn())
+vi.mock('src/sdk/graphql/useLazyQuery', () => ({
+  useLazyQuery: () => [runStartRecommendationSession, {}],
+}))
+
+const cookies = vi.hoisted(() => ({
+  current: {} as Record<string, string | undefined>,
+}))
+vi.mock('src/utils/getCookie', () => ({
+  getCookie: (name: string) => cookies.current[name],
+}))
+
+const storeConfigMock = vi.hoisted(() => ({
+  experimental: { enableRecommendations: false },
+}))
+vi.mock('discovery.config', () => ({ default: storeConfigMock }))
+
+// Keep retry semantics (loop until `until` / attempts) but skip wall-clock
+// backoff so the cookie lookup can observe the session mutation in this test.
+vi.mock('src/utils/retry', async (importOriginal) => {
+  const actual = await importOriginal<typeof import('src/utils/retry')>()
+  return {
+    retry: <T,>(
+      fn: () => T | Promise<T>,
+      options?: Parameters<typeof actual.retry>[1]
+    ) => actual.retry(fn, { ...options, delayMs: 0, maxDelayMs: 0 }),
+  }
+})
+
+import { resetStartRecommendationSessionLock } from 'src/sdk/analytics/hooks/useStartRecommendationSession'
+import { useRecommendationShelf } from 'src/sdk/recommendations/useRecommendationShelf'
+
+const TOP_ITEMS_VRN = 'vrn:recommendations:acc:rec-top-items-v2:campaign-1'
+
+const lastArgs = () => useRecommendations.mock.calls.at(-1)?.[0]
+
+beforeEach(() => {
+  cookies.current = {}
+  resetStartRecommendationSessionLock()
+  storeConfigMock.experimental.enableRecommendations = false
+  usePDP.mockReturnValue({ data: undefined })
+  useCart.mockReturnValue({ items: [] })
+  useRecommendations.mockReturnValue({
+    data: undefined,
+    isLoading: false,
+    error: null,
+  })
+  runStartRecommendationSession.mockImplementation(async () => {
+    cookies.current['vtex-rec-user-id'] = 'user-from-session'
+    cookies.current['vtex-rec-user-start-session'] = '1'
+    return true
+  })
+})
+
+afterEach(() => {
+  vi.clearAllMocks()
+})
+
+describe('useRecommendationShelf session fallback race', () => {
+  it('starts the session in parallel with cookie retry so the first page can fetch', async () => {
+    renderHook(() => useRecommendationShelf({ campaignVrn: TOP_ITEMS_VRN }))
+
+    await waitFor(() => {
+      expect(runStartRecommendationSession).toHaveBeenCalledTimes(1)
+    })
+
+    await waitFor(() => {
+      expect(lastArgs()).toEqual({
+        userId: 'user-from-session',
+        campaignVrn: TOP_ITEMS_VRN,
+        products: [],
+      })
+    })
+  })
+
+  it('does not start a session when the user id cookie is already present', async () => {
+    cookies.current['vtex-rec-user-id'] = 'existing-user'
+    cookies.current['vtex-rec-user-start-session'] = '1'
+
+    renderHook(() => useRecommendationShelf({ campaignVrn: TOP_ITEMS_VRN }))
+
+    await waitFor(() => {
+      expect(lastArgs()).toEqual({
+        userId: 'existing-user',
+        campaignVrn: TOP_ITEMS_VRN,
+        products: [],
+      })
+    })
+
+    expect(runStartRecommendationSession).not.toHaveBeenCalled()
+  })
+})

package/test/server/cms/myAccountDefaultSections.test.ts

@@ -20,6 +20,50 @@ describe('getDefaultMyAccountSections', () => {
   it('returns an empty list for store (unknown) content-types', () => {
     expect(getDefaultMyAccountSections('myAccountWishlist')).toEqual([])
   })
+
+  /**
+   * The order-details defaults must mirror the render order of the
+   * `@deprecated OrderDetails.tsx` component, which is the design reference
+   * available in the repo. The delivery option accordions travel with
+   * AccountOrderDelivery, which is the single known deviation.
+   */
+  it('orders the myAccountOrderDetails defaults like the deprecated component', () => {
+    expect(
+      getDefaultMyAccountSections('myAccountOrderDetails').map(
+        (section) => section.$componentKey
+      )
+    ).toEqual([
+      'AccountNavigation',
+      'AccountOrderDetails',
+      'AccountOrderOrderedBy',
+      'AccountOrderDelivery',
+      'AccountOrderStatus',
+      'AccountOrderPayment',
+      'AccountOrderSummary',
+      'AccountOrderMoreInfo',
+      'AccountOrderBudgets',
+    ])
+  })
+
+  it('keeps the myAccountOrderDetails default section set unchanged', () => {
+    const keys = getDefaultMyAccountSections('myAccountOrderDetails').map(
+      (section) => section.$componentKey
+    )
+
+    expect(new Set(keys)).toEqual(
+      new Set([
+        'AccountNavigation',
+        'AccountOrderDetails',
+        'AccountOrderStatus',
+        'AccountOrderPayment',
+        'AccountOrderDelivery',
+        'AccountOrderSummary',
+        'AccountOrderOrderedBy',
+        'AccountOrderBudgets',
+        'AccountOrderMoreInfo',
+      ])
+    )
+  })
 })
 
 describe('withDefaultMyAccountSections', () => {

package/src/sdk/analytics/utils/hasEnabledRecommendationShelf.ts

@@ -1,49 +0,0 @@
-type CmsSection = {
-  name?: string
-  $componentKey?: string
-  data?: {
-    enableRecommendations?: boolean
-  }
-}
-
-function pushSections(target: CmsSection[], value: unknown) {
-  if (Array.isArray(value)) {
-    for (const item of value) {
-      if (item && typeof item === 'object') {
-        target.push(item as CmsSection)
-      }
-    }
-    return
-  }
-
-  if (value && typeof value === 'object') {
-    const sections = (value as { sections?: unknown }).sections
-    if (Array.isArray(sections)) {
-      pushSections(target, sections)
-    }
-  }
-}
-
-/**
- * Returns true when the current page CMS data includes at least one
- * `RecommendationShelf` with `enableRecommendations: true`.
- */
-export function hasEnabledRecommendationShelf(pageProps: unknown): boolean {
-  if (!pageProps || typeof pageProps !== 'object') {
-    return false
-  }
-
-  const props = pageProps as Record<string, unknown>
-  const sections: CmsSection[] = []
-
-  pushSections(sections, props.sections)
-  pushSections(sections, props.globalSections)
-  pushSections(sections, props.page)
-
-  return sections.some(
-    (section) =>
-      (section.name === 'RecommendationShelf' ||
-        section.$componentKey === 'RecommendationShelf') &&
-      section.data?.enableRecommendations === true
-  )
-}

package/test/sdk/analytics/hasEnabledRecommendationShelf.test.ts

@@ -1,88 +0,0 @@
-import { describe, expect, it } from 'vitest'
-
-import { hasEnabledRecommendationShelf } from 'src/sdk/analytics/utils/hasEnabledRecommendationShelf'
-
-describe('hasEnabledRecommendationShelf', () => {
-  it('returns false for empty or unrelated page props', () => {
-    expect(hasEnabledRecommendationShelf(undefined)).toBe(false)
-    expect(hasEnabledRecommendationShelf({})).toBe(false)
-    expect(
-      hasEnabledRecommendationShelf({
-        sections: [{ name: 'ProductShelf', data: {} }],
-      })
-    ).toBe(false)
-  })
-
-  it('returns true when a page section enables recommendations', () => {
-    expect(
-      hasEnabledRecommendationShelf({
-        sections: [
-          {
-            name: 'RecommendationShelf',
-            data: { enableRecommendations: true, campaignVrn: 'vrn:x' },
-          },
-        ],
-      })
-    ).toBe(true)
-  })
-
-  it('returns true when a global section enables recommendations', () => {
-    expect(
-      hasEnabledRecommendationShelf({
-        globalSections: {
-          sections: [
-            {
-              $componentKey: 'RecommendationShelf',
-              data: { enableRecommendations: true },
-            },
-          ],
-        },
-      })
-    ).toBe(true)
-  })
-
-  it('returns true when page.sections enables recommendations', () => {
-    expect(
-      hasEnabledRecommendationShelf({
-        page: {
-          sections: [
-            {
-              name: 'RecommendationShelf',
-              data: { enableRecommendations: true },
-            },
-          ],
-        },
-      })
-    ).toBe(true)
-  })
-
-  it('returns false when the shelf is present but enableRecommendations is false', () => {
-    expect(
-      hasEnabledRecommendationShelf({
-        sections: [
-          {
-            name: 'RecommendationShelf',
-            data: { enableRecommendations: false },
-          },
-        ],
-      })
-    ).toBe(false)
-  })
-
-  it('returns true when at least one of multiple shelves enables recommendations', () => {
-    expect(
-      hasEnabledRecommendationShelf({
-        sections: [
-          {
-            name: 'RecommendationShelf',
-            data: { enableRecommendations: false },
-          },
-          {
-            name: 'RecommendationShelf',
-            data: { enableRecommendations: true },
-          },
-        ],
-      })
-    ).toBe(true)
-  })
-})