@faststore/core 4.10.1-dev.4 → 4.10.1-dev.6

package/test/sdk/product/usePageProductsQuery.deliveryPromise.browser.test.ts

@@ -0,0 +1,130 @@
+/**
+ * @vitest-environment jsdom
+ */
+
+import { renderHook } from '@testing-library/react'
+import { afterEach, describe, expect, it, vi } from 'vitest'
+
+const mockUseSession = vi.hoisted(() => vi.fn())
+const mockUseQuery = vi.hoisted(() => vi.fn())
+const mockUseLocalizedVariables = vi.hoisted(() => vi.fn())
+
+vi.mock('@generated', () => ({ gql: (query: unknown) => query }))
+vi.mock('discovery.config', () => ({
+  default: { deliveryPromise: { enabled: true } },
+}))
+vi.mock('@faststore/sdk', () => ({
+  useSearch: () => ({
+    state: { sort: 'score_desc', term: '', selectedFacets: [] },
+    itemsPerPage: 12,
+  }),
+}))
+vi.mock('src/sdk/session', () => ({ useSession: mockUseSession }))
+vi.mock('src/sdk/graphql/useQuery', () => ({ useQuery: mockUseQuery }))
+vi.mock('src/sdk/product/useLocalizedVariables', () => ({
+  useLocalizedVariables: mockUseLocalizedVariables,
+}))
+
+import {
+  hashContractScope,
+  useCreateUseGalleryPage,
+} from '../../../src/sdk/product/usePageProductsQuery'
+
+const serverManyProductsVariables = {
+  first: 12,
+  after: '0',
+  sort: 'score_desc' as const,
+  term: '',
+  selectedFacets: [
+    { key: 'category-1', value: 'computers---tablets' },
+    { key: 'channel', value: '{"salesChannel":"1"}' },
+    { key: 'locale', value: 'en-CA' },
+  ],
+  sponsoredCount: 3,
+}
+
+type GalleryProps = NonNullable<Parameters<typeof useCreateUseGalleryPage>[0]>
+
+const initialPages = {
+  search: { products: { pageInfo: { totalCount: 2 }, edges: [] } },
+} as unknown as GalleryProps['initialPages']
+
+const renderFirstGalleryPage = () => {
+  const { result: created } = renderHook(() =>
+    useCreateUseGalleryPage({ initialPages, serverManyProductsVariables })
+  )
+
+  return renderHook(() => created.current.useGalleryPage(0))
+}
+
+// `isDeliveryPromiseEnabled` is read when the module loads, so this scenario
+// needs its own file with the flag mocked on.
+describe('useCreateUseGalleryPage with deliveryPromise enabled', () => {
+  afterEach(() => {
+    vi.clearAllMocks()
+  })
+
+  it('scopes the page by postal code and contract together for B2B buyers', () => {
+    mockUseSession.mockReturnValue({
+      postalCode: '01310-100',
+      b2b: { customerId: 'contract-137' },
+      isValidating: false,
+    })
+    mockUseLocalizedVariables.mockReturnValue(serverManyProductsVariables)
+    mockUseQuery.mockReturnValue({ data: null })
+
+    renderFirstGalleryPage()
+
+    expect(mockUseQuery).toHaveBeenCalledWith(
+      expect.anything(),
+      {
+        ...serverManyProductsVariables,
+        _postalCode: '01310-100',
+        _contract: hashContractScope('contract-137'),
+      },
+      expect.objectContaining({ doNotRun: false })
+    )
+  })
+
+  it('still reuses the SSG page for an anonymous shopper with a postal code', () => {
+    mockUseSession.mockReturnValue({
+      postalCode: '01310-100',
+      b2b: null,
+      isValidating: false,
+    })
+    mockUseLocalizedVariables.mockReturnValue(serverManyProductsVariables)
+    mockUseQuery.mockReturnValue({ data: null })
+
+    const { result } = renderFirstGalleryPage()
+
+    expect(mockUseQuery).toHaveBeenCalledWith(
+      expect.anything(),
+      { ...serverManyProductsVariables, _postalCode: '01310-100' },
+      expect.objectContaining({ doNotRun: true })
+    )
+    expect(result.current.data).toBe(initialPages)
+  })
+
+  it('re-fetches when the postal code changed after the SSG page was seeded', () => {
+    mockUseSession.mockReturnValueOnce({
+      postalCode: null,
+      b2b: null,
+      isValidating: false,
+    })
+    mockUseSession.mockReturnValue({
+      postalCode: '01310-100',
+      b2b: null,
+      isValidating: false,
+    })
+    mockUseLocalizedVariables.mockReturnValue(serverManyProductsVariables)
+    mockUseQuery.mockReturnValue({ data: null })
+
+    renderFirstGalleryPage()
+
+    expect(mockUseQuery).toHaveBeenCalledWith(
+      expect.anything(),
+      { ...serverManyProductsVariables, _postalCode: '01310-100' },
+      expect.objectContaining({ doNotRun: false })
+    )
+  })
+})

package/test/sdk/session/validateSession.browser.test.ts

@@ -1,12 +1,27 @@
 import type { Session } from '@faststore/sdk'
-import { beforeEach, describe, expect, it, vi } from 'vitest'
+import {
+  afterEach,
+  beforeAll,
+  beforeEach,
+  describe,
+  expect,
+  it,
+  vi,
+} from 'vitest'
 
 const mockRequest = vi.hoisted(() => vi.fn())
+const mockRefreshTokenRequest = vi.hoisted(() => vi.fn())
 
 vi.mock('../../../src/sdk/graphql/request', () => ({
   request: mockRequest,
 }))
 
+vi.mock('../../../src/sdk/account/refreshToken', () => ({
+  refreshTokenRequest: mockRefreshTokenRequest,
+  isRefreshTokenSuccessful: () => true,
+}))
+
+import storeConfig from '../../../discovery.config'
 import { validateSession } from '../../../src/sdk/session'
 
 const session: Session = {
@@ -25,12 +40,17 @@ const session: Session = {
   refreshAfter: null,
 }
 
+// The store validates its initial session when the module loads. Let that
+// call settle once, so no test depends on calls left by another one.
+beforeAll(async () => {
+  mockRequest.mockResolvedValue({ validateSession: null })
+  await vi.waitFor(() => expect(mockRequest).toHaveBeenCalled())
+})
+
 describe('validateSession', () => {
-  beforeEach(async () => {
+  beforeEach(() => {
+    mockRequest.mockReset()
     mockRequest.mockResolvedValue({ validateSession: null })
-    // The store validates its initial session on load; let it settle first
-    await vi.waitFor(() => expect(mockRequest).toHaveBeenCalled())
-    mockRequest.mockClear()
   })
 
   it('does not send the UI state persisted with the session', async () => {
@@ -45,3 +65,86 @@ describe('validateSession', () => {
     expect(mockRequest.mock.calls[0][1].session).toStrictEqual(session)
   })
 })
+
+describe('validateSession refresh-token bypass', () => {
+  const originalLocation = window.location
+  const originalRefreshToken = storeConfig.experimental.refreshToken
+
+  // An already expired `refreshAfter` (in seconds) triggers the refresh path.
+  const expiredSession: Session = { ...session, refreshAfter: '1' }
+
+  function stubHostname(hostname: string) {
+    // jsdom forbids assigning to `window.location` directly, so we redefine the
+    // descriptor with a minimal stub that exposes the hostname we want to test.
+    Object.defineProperty(window, 'location', {
+      configurable: true,
+      value: { ...originalLocation, hostname },
+    })
+  }
+
+  beforeEach(() => {
+    mockRequest.mockReset()
+    mockRequest.mockResolvedValue({ validateSession: null })
+    mockRefreshTokenRequest.mockReset()
+    mockRefreshTokenRequest.mockResolvedValue({
+      status: 'success',
+      refreshAfter: new Date(Date.now() + 60_000).toISOString(),
+    })
+    storeConfig.experimental.refreshToken = true
+  })
+
+  afterEach(() => {
+    storeConfig.experimental.refreshToken = originalRefreshToken
+    Object.defineProperty(window, 'location', {
+      configurable: true,
+      value: originalLocation,
+    })
+  })
+
+  it.each(['localhost', 'brandless-abc123.preview.vtex.app'])(
+    'skips the refresh when refreshAfter is expired on %s',
+    async (hostname) => {
+      stubHostname(hostname)
+
+      await validateSession(expiredSession)
+
+      expect(mockRefreshTokenRequest).not.toHaveBeenCalled()
+      expect(mockRequest).toHaveBeenCalledTimes(1)
+    }
+  )
+
+  it.each(['localhost', 'brandless-abc123.preview.vtex.app'])(
+    'skips the refresh when ValidateSession answers 401 on %s',
+    async (hostname) => {
+      stubHostname(hostname)
+      mockRequest.mockRejectedValueOnce({ status: 401 })
+
+      await validateSession(session)
+
+      expect(mockRefreshTokenRequest).not.toHaveBeenCalled()
+    }
+  )
+
+  it.each(['brandless.vtex.app', 'brandless.fast.store'])(
+    'refreshes the token when refreshAfter is expired on %s',
+    async (hostname) => {
+      stubHostname(hostname)
+
+      await validateSession(expiredSession)
+
+      expect(mockRefreshTokenRequest).toHaveBeenCalledTimes(1)
+    }
+  )
+
+  it.each(['brandless.vtex.app', 'brandless.fast.store'])(
+    'refreshes the token when ValidateSession answers 401 on %s',
+    async (hostname) => {
+      stubHostname(hostname)
+      mockRequest.mockRejectedValueOnce({ status: 401 })
+
+      await validateSession(session)
+
+      expect(mockRefreshTokenRequest).toHaveBeenCalledTimes(1)
+    }
+  )
+})

package/test/utils/shouldBypassRefreshToken.browser.test.ts

@@ -0,0 +1,38 @@
+import { afterEach, describe, expect, it } from 'vitest'
+import { shouldBypassRefreshTokenBrowser } from '../../src/utils/shouldBypassRefreshToken'
+
+const originalLocation = window.location
+
+function stubHostname(hostname: string) {
+  // jsdom forbids assigning to `window.location` directly, so we redefine the
+  // descriptor with a minimal stub that exposes the hostname we want to test.
+  Object.defineProperty(window, 'location', {
+    configurable: true,
+    value: { ...originalLocation, hostname },
+  })
+}
+
+describe('shouldBypassRefreshTokenBrowser', () => {
+  afterEach(() => {
+    Object.defineProperty(window, 'location', {
+      configurable: true,
+      value: originalLocation,
+    })
+  })
+
+  it.each(['localhost', '127.0.0.1', 'brandless-abc123.preview.vtex.app'])(
+    'returns true when window.location.hostname is "%s"',
+    (hostname) => {
+      stubHostname(hostname)
+      expect(shouldBypassRefreshTokenBrowser()).toBe(true)
+    }
+  )
+
+  it.each(['brandless.vtex.app', 'brandless.fast.store'])(
+    'returns false for the production hostname "%s"',
+    (hostname) => {
+      stubHostname(hostname)
+      expect(shouldBypassRefreshTokenBrowser()).toBe(false)
+    }
+  )
+})

package/test/utils/shouldBypassRefreshToken.test.ts

@@ -0,0 +1,98 @@
+import { describe, expect, it } from 'vitest'
+import {
+  shouldBypassRefreshToken,
+  shouldBypassRefreshTokenBrowser,
+  shouldBypassRefreshTokenForRequest,
+} from '../../src/utils/shouldBypassRefreshToken'
+
+describe('shouldBypassRefreshToken', () => {
+  it.each(['localhost', '127.0.0.1'])('returns true for "%s"', (hostname) => {
+    expect(shouldBypassRefreshToken(hostname)).toBe(true)
+  })
+
+  it('returns true for a WebOps preview host', () => {
+    expect(shouldBypassRefreshToken('brandless-abc123.preview.vtex.app')).toBe(
+      true
+    )
+  })
+
+  it('is case-insensitive for preview hosts', () => {
+    expect(shouldBypassRefreshToken('Brandless-ABC123.Preview.VTEX.app')).toBe(
+      true
+    )
+  })
+
+  it('ignores the trailing dot of a fully qualified preview host', () => {
+    expect(shouldBypassRefreshToken('brandless-abc123.preview.vtex.app.')).toBe(
+      true
+    )
+  })
+
+  it('returns false for the production "{account}.vtex.app" domain', () => {
+    // `{account}.vtex.app` is a production default domain, not a preview.
+    expect(shouldBypassRefreshToken('brandless.vtex.app')).toBe(false)
+  })
+
+  it('returns false for a custom store domain', () => {
+    expect(shouldBypassRefreshToken('brandless.fast.store')).toBe(false)
+  })
+
+  it('returns false for hosts that only contain the preview suffix', () => {
+    expect(shouldBypassRefreshToken('preview.vtex.app')).toBe(false)
+    expect(shouldBypassRefreshToken('x.preview.vtex.app.evil.com')).toBe(false)
+  })
+
+  it('returns false for nullish or empty input', () => {
+    expect(shouldBypassRefreshToken(null)).toBe(false)
+    expect(shouldBypassRefreshToken(undefined)).toBe(false)
+    expect(shouldBypassRefreshToken('')).toBe(false)
+  })
+})
+
+describe('shouldBypassRefreshTokenForRequest', () => {
+  it('returns true when the Host header is a local or preview host', () => {
+    expect(shouldBypassRefreshTokenForRequest({ host: 'localhost:3000' })).toBe(
+      true
+    )
+    expect(
+      shouldBypassRefreshTokenForRequest({
+        host: 'brandless-abc123.preview.vtex.app',
+      })
+    ).toBe(true)
+  })
+
+  it('returns true when the preview host arrives in x-forwarded-host', () => {
+    // Behind the preview ingress, Host is an internal name.
+    expect(
+      shouldBypassRefreshTokenForRequest({
+        host: 'faststore-internal:3000',
+        'x-forwarded-host': 'brandless-abc123.preview.vtex.app',
+      })
+    ).toBe(true)
+  })
+
+  it('ignores a multi-value x-forwarded-host', () => {
+    expect(
+      shouldBypassRefreshTokenForRequest({
+        host: 'brandless.fast.store',
+        'x-forwarded-host': 'brandless-abc123.preview.vtex.app, proxy',
+      })
+    ).toBe(false)
+  })
+
+  it('returns false on production hosts', () => {
+    expect(
+      shouldBypassRefreshTokenForRequest({
+        host: 'brandless.fast.store',
+        'x-forwarded-host': 'brandless.fast.store',
+      })
+    ).toBe(false)
+    expect(shouldBypassRefreshTokenForRequest({})).toBe(false)
+  })
+})
+
+describe('shouldBypassRefreshTokenBrowser', () => {
+  it('returns false when window is not available (SSR/Node)', () => {
+    expect(shouldBypassRefreshTokenBrowser()).toBe(false)
+  })
+})

package/test/utils/isLocalHost.browser.test.ts

@@ -1,37 +0,0 @@
-import { afterEach, describe, expect, it } from 'vitest'
-import { isLocalHostBrowser } from '../../src/utils/isLocalHost'
-
-const originalLocation = window.location
-
-function stubHostname(hostname: string) {
-  // jsdom forbids assigning to `window.location` directly, so we redefine the
-  // descriptor with a minimal stub that exposes the hostname we want to test.
-  Object.defineProperty(window, 'location', {
-    configurable: true,
-    value: { ...originalLocation, hostname },
-  })
-}
-
-describe('isLocalHostBrowser', () => {
-  afterEach(() => {
-    Object.defineProperty(window, 'location', {
-      configurable: true,
-      value: originalLocation,
-    })
-  })
-
-  it('returns true when window.location.hostname is "localhost"', () => {
-    stubHostname('localhost')
-    expect(isLocalHostBrowser()).toBe(true)
-  })
-
-  it('returns true when window.location.hostname is "127.0.0.1"', () => {
-    stubHostname('127.0.0.1')
-    expect(isLocalHostBrowser()).toBe(true)
-  })
-
-  it('returns false for a production hostname', () => {
-    stubHostname('brandless.fast.store')
-    expect(isLocalHostBrowser()).toBe(false)
-  })
-})