|
| 1 | +/* |
| 2 | + * Copyright (c) 2025, Salesforce, Inc. |
| 3 | + * All rights reserved. |
| 4 | + * SPDX-License-Identifier: BSD-3-Clause |
| 5 | + * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause |
| 6 | + */ |
| 7 | +import {act, waitFor} from '@testing-library/react' |
| 8 | +import {ShopperConsentsTypes} from 'commerce-sdk-isomorphic' |
| 9 | +import nock from 'nock' |
| 10 | +import { |
| 11 | + assertInvalidateQuery, |
| 12 | + mockMutationEndpoints, |
| 13 | + mockQueryEndpoint, |
| 14 | + renderHookWithProviders, |
| 15 | + waitAndExpectSuccess |
| 16 | +} from '../../test-utils' |
| 17 | +import {ShopperConsentsMutation, useShopperConsentsMutation} from '../ShopperConsents' |
| 18 | +import {ApiClients, Argument} from '../types' |
| 19 | +import * as queries from './query' |
| 20 | +import {CLIENT_KEYS} from '../../constant' |
| 21 | + |
| 22 | +jest.mock('../../auth/index.ts', () => { |
| 23 | + const {default: mockAuth} = jest.requireActual('../../auth/index.ts') |
| 24 | + mockAuth.prototype.ready = jest.fn().mockResolvedValue({access_token: 'access_token'}) |
| 25 | + return mockAuth |
| 26 | +}) |
| 27 | + |
| 28 | +const CLIENT_KEY = CLIENT_KEYS.SHOPPER_CONSENTS |
| 29 | +type Client = NonNullable<ApiClients[typeof CLIENT_KEY]> |
| 30 | +const consentsEndpoint = '/shopper/shopper-consents/' |
| 31 | +/** All Shopper Consents parameters. Can be used for all endpoints, as unused params are ignored. */ |
| 32 | +const PARAMETERS = { |
| 33 | + siteId: 'RefArch' |
| 34 | +} as const |
| 35 | +/** Options object that can be used for all query endpoints. */ |
| 36 | +const queryOptions = {parameters: PARAMETERS} |
| 37 | + |
| 38 | +const baseSubscriptionResponse: ShopperConsentsTypes.ConsentSubscriptionResponse = { |
| 39 | + data: [ |
| 40 | + { |
| 41 | + subscriptionId: 'test-subscription', |
| 42 | + channels: ['email' as ShopperConsentsTypes.ChannelType], |
| 43 | + contactPointValue: 'test@example.com' |
| 44 | + } |
| 45 | + ] |
| 46 | +} |
| 47 | + |
| 48 | +type Mutation = ShopperConsentsMutation |
| 49 | +/** Map of mutation method name to test options. */ |
| 50 | +type TestMap = {[Mut in Mutation]?: Argument<Client[Mut]>} |
| 51 | +const testMap: TestMap = { |
| 52 | + updateSubscription: { |
| 53 | + parameters: PARAMETERS, |
| 54 | + body: { |
| 55 | + subscriptionId: 'test-subscription', |
| 56 | + channel: 'email', |
| 57 | + status: 'opt_in', |
| 58 | + contactPointValue: 'test@example.com' |
| 59 | + } |
| 60 | + }, |
| 61 | + updateSubscriptions: { |
| 62 | + parameters: PARAMETERS, |
| 63 | + body: { |
| 64 | + subscriptions: [ |
| 65 | + { |
| 66 | + subscriptionId: 'test-subscription', |
| 67 | + channel: 'email' as ShopperConsentsTypes.ChannelType, |
| 68 | + status: 'opt_in' as ShopperConsentsTypes.ConsentStatus, |
| 69 | + contactPointValue: 'test@example.com' |
| 70 | + } |
| 71 | + ] |
| 72 | + } |
| 73 | + } |
| 74 | +} |
| 75 | +// Type assertion is necessary because `Object.entries` is limited |
| 76 | +type TestCase = [Mutation, NonNullable<TestMap[Mutation]>] |
| 77 | +const testCases = Object.entries(testMap) as TestCase[] |
| 78 | + |
| 79 | +describe('Shopper Consents mutations', () => { |
| 80 | + beforeEach(() => nock.cleanAll()) |
| 81 | + test.each(testCases)('`%s` returns data on success', async (mutationName, options) => { |
| 82 | + mockMutationEndpoints(consentsEndpoint, {}) |
| 83 | + const {result} = renderHookWithProviders(() => { |
| 84 | + return useShopperConsentsMutation(mutationName) |
| 85 | + }) |
| 86 | + act(() => result.current.mutate(options)) |
| 87 | + await waitAndExpectSuccess(() => result.current) |
| 88 | + }) |
| 89 | +}) |
| 90 | + |
| 91 | +describe('Cache update behavior', () => { |
| 92 | + describe('updateSubscription', () => { |
| 93 | + beforeEach(() => nock.cleanAll()) |
| 94 | + |
| 95 | + test('invalidates `getSubscriptions` query', async () => { |
| 96 | + mockQueryEndpoint(consentsEndpoint, baseSubscriptionResponse) |
| 97 | + mockMutationEndpoints(consentsEndpoint, {}) |
| 98 | + mockQueryEndpoint(consentsEndpoint, baseSubscriptionResponse) |
| 99 | + const {result} = renderHookWithProviders(() => { |
| 100 | + return { |
| 101 | + query: queries.useSubscriptions(queryOptions), |
| 102 | + mutation: useShopperConsentsMutation('updateSubscription') |
| 103 | + } |
| 104 | + }) |
| 105 | + await waitAndExpectSuccess(() => result.current.query) |
| 106 | + const oldData = result.current.query.data |
| 107 | + |
| 108 | + act(() => |
| 109 | + result.current.mutation.mutate({ |
| 110 | + parameters: PARAMETERS, |
| 111 | + body: { |
| 112 | + subscriptionId: 'test-subscription', |
| 113 | + channel: 'email', |
| 114 | + status: 'opt_out', |
| 115 | + contactPointValue: 'test@example.com' |
| 116 | + } |
| 117 | + }) |
| 118 | + ) |
| 119 | + await waitAndExpectSuccess(() => result.current.mutation) |
| 120 | + assertInvalidateQuery(result.current.query, oldData) |
| 121 | + }) |
| 122 | + |
| 123 | + test('triggers refetch after cache invalidation', async () => { |
| 124 | + const updatedResponse: ShopperConsentsTypes.ConsentSubscriptionResponse = { |
| 125 | + data: [ |
| 126 | + { |
| 127 | + subscriptionId: 'test-subscription', |
| 128 | + channels: ['email' as ShopperConsentsTypes.ChannelType], |
| 129 | + contactPointValue: 'test@example.com' |
| 130 | + } |
| 131 | + ] |
| 132 | + } |
| 133 | + |
| 134 | + mockQueryEndpoint(consentsEndpoint, baseSubscriptionResponse) |
| 135 | + mockMutationEndpoints(consentsEndpoint, {}) |
| 136 | + mockQueryEndpoint(consentsEndpoint, updatedResponse) // Refetch returns updated data |
| 137 | + |
| 138 | + const {result} = renderHookWithProviders(() => { |
| 139 | + return { |
| 140 | + query: queries.useSubscriptions(queryOptions), |
| 141 | + mutation: useShopperConsentsMutation('updateSubscription') |
| 142 | + } |
| 143 | + }) |
| 144 | + await waitAndExpectSuccess(() => result.current.query) |
| 145 | + expect(result.current.query.data).toEqual(baseSubscriptionResponse) |
| 146 | + |
| 147 | + act(() => |
| 148 | + result.current.mutation.mutate({ |
| 149 | + parameters: PARAMETERS, |
| 150 | + body: { |
| 151 | + subscriptionId: 'test-subscription', |
| 152 | + channel: 'email', |
| 153 | + status: 'opt_out', |
| 154 | + contactPointValue: 'test@example.com' |
| 155 | + } |
| 156 | + }) |
| 157 | + ) |
| 158 | + await waitAndExpectSuccess(() => result.current.mutation) |
| 159 | + |
| 160 | + // Wait for refetch to complete |
| 161 | + await waitAndExpectSuccess(() => result.current.query) |
| 162 | + // After refetch, data should be updated |
| 163 | + expect(result.current.query.data).toEqual(updatedResponse) |
| 164 | + }) |
| 165 | + }) |
| 166 | + |
| 167 | + describe('updateSubscriptions', () => { |
| 168 | + beforeEach(() => nock.cleanAll()) |
| 169 | + |
| 170 | + test('invalidates `getSubscriptions` query', async () => { |
| 171 | + mockQueryEndpoint(consentsEndpoint, baseSubscriptionResponse) |
| 172 | + mockMutationEndpoints(consentsEndpoint, {}) |
| 173 | + mockQueryEndpoint(consentsEndpoint, baseSubscriptionResponse) |
| 174 | + const {result} = renderHookWithProviders(() => { |
| 175 | + return { |
| 176 | + query: queries.useSubscriptions(queryOptions), |
| 177 | + mutation: useShopperConsentsMutation('updateSubscriptions') |
| 178 | + } |
| 179 | + }) |
| 180 | + await waitAndExpectSuccess(() => result.current.query) |
| 181 | + const oldData = result.current.query.data |
| 182 | + |
| 183 | + act(() => |
| 184 | + result.current.mutation.mutate({ |
| 185 | + parameters: PARAMETERS, |
| 186 | + body: { |
| 187 | + subscriptions: [ |
| 188 | + { |
| 189 | + subscriptionId: 'test-subscription', |
| 190 | + channel: 'email' as ShopperConsentsTypes.ChannelType, |
| 191 | + status: 'opt_out' as ShopperConsentsTypes.ConsentStatus, |
| 192 | + contactPointValue: 'test@example.com' |
| 193 | + }, |
| 194 | + { |
| 195 | + subscriptionId: 'test-subscription-2', |
| 196 | + channel: 'sms' as ShopperConsentsTypes.ChannelType, |
| 197 | + status: 'opt_in' as ShopperConsentsTypes.ConsentStatus, |
| 198 | + contactPointValue: '+15551234567' |
| 199 | + } |
| 200 | + ] |
| 201 | + } |
| 202 | + }) |
| 203 | + ) |
| 204 | + await waitAndExpectSuccess(() => result.current.mutation) |
| 205 | + assertInvalidateQuery(result.current.query, oldData) |
| 206 | + }) |
| 207 | + |
| 208 | + test('ensures stale cache is not served after mutation', async () => { |
| 209 | + const staleResponse = baseSubscriptionResponse |
| 210 | + const freshResponse: ShopperConsentsTypes.ConsentSubscriptionResponse = { |
| 211 | + data: [ |
| 212 | + { |
| 213 | + subscriptionId: 'test-subscription', |
| 214 | + channels: ['email' as ShopperConsentsTypes.ChannelType], |
| 215 | + contactPointValue: 'test@example.com' |
| 216 | + }, |
| 217 | + { |
| 218 | + subscriptionId: 'test-subscription-2', |
| 219 | + channels: ['sms' as ShopperConsentsTypes.ChannelType], |
| 220 | + contactPointValue: '+15551234567' |
| 221 | + } |
| 222 | + ] |
| 223 | + } |
| 224 | + |
| 225 | + mockQueryEndpoint(consentsEndpoint, staleResponse) |
| 226 | + mockMutationEndpoints(consentsEndpoint, {}) |
| 227 | + mockQueryEndpoint(consentsEndpoint, freshResponse) // Refetch returns fresh data |
| 228 | + |
| 229 | + const {result} = renderHookWithProviders(() => { |
| 230 | + return { |
| 231 | + query: queries.useSubscriptions(queryOptions), |
| 232 | + mutation: useShopperConsentsMutation('updateSubscriptions') |
| 233 | + } |
| 234 | + }) |
| 235 | + |
| 236 | + // Initial fetch - get stale data |
| 237 | + await waitAndExpectSuccess(() => result.current.query) |
| 238 | + expect(result.current.query.data?.data).toHaveLength(1) |
| 239 | + |
| 240 | + // Perform mutation |
| 241 | + act(() => |
| 242 | + result.current.mutation.mutate({ |
| 243 | + parameters: PARAMETERS, |
| 244 | + body: { |
| 245 | + subscriptions: [ |
| 246 | + { |
| 247 | + subscriptionId: 'test-subscription', |
| 248 | + channel: 'email' as ShopperConsentsTypes.ChannelType, |
| 249 | + status: 'opt_out' as ShopperConsentsTypes.ConsentStatus, |
| 250 | + contactPointValue: 'test@example.com' |
| 251 | + }, |
| 252 | + { |
| 253 | + subscriptionId: 'test-subscription-2', |
| 254 | + channel: 'sms' as ShopperConsentsTypes.ChannelType, |
| 255 | + status: 'opt_in' as ShopperConsentsTypes.ConsentStatus, |
| 256 | + contactPointValue: '+15551234567' |
| 257 | + } |
| 258 | + ] |
| 259 | + } |
| 260 | + }) |
| 261 | + ) |
| 262 | + await waitAndExpectSuccess(() => result.current.mutation) |
| 263 | + |
| 264 | + // Wait for refetch to complete with fresh data |
| 265 | + await waitFor(() => { |
| 266 | + expect(result.current.query.data?.data).toHaveLength(2) |
| 267 | + }) |
| 268 | + expect(result.current.query.data).toEqual(freshResponse) |
| 269 | + }) |
| 270 | + }) |
| 271 | +}) |
0 commit comments