SalesforceCommerceCloud · shethj · Oct 22, 2024 · Oct 21, 2024 · Oct 21, 2024 · Oct 21, 2024
@@ -1,5 +1,6 @@
 ## v3.2.0-dev (Oct 14, 2024)
 
+-   [Server Affinity] Attach dwsid to SCAPI request headers [#2090](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2090)
 -   Add the `authorizeCustomer` and `getPasswordResetToken` to the `ShopperLoginMutations` [#2056](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2056)
 -   Add useDNT hook to commerce-sdk-react and put DNT in auth [#2067](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2067/files)
 -   Add Trusted Agent on Behalf of (TAOB) support for SLAS APIs [#2077](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2077)

@@ -22,8 +22,9 @@ import {
     SLAS_SECRET_WARNING_MSG,
     SLAS_SECRET_PLACEHOLDER,
     SLAS_SECRET_OVERRIDE_MSG,
-    SLAS_REFRESH_TOKEN_COOKIE_TTL_OVERRIDE_MSG,
-    DNT_COOKIE_NAME
+    DNT_COOKIE_NAME,
+    DWSID_COOKIE_NAME,
+    SLAS_REFRESH_TOKEN_COOKIE_TTL_OVERRIDE_MSG
 } from '../constant'
 
 import {Logger} from '../types'
@@ -76,7 +77,7 @@ type AuthDataKeys =
     | 'refresh_token_registered'
     | 'access_token_sfra'
     | typeof DNT_COOKIE_NAME
-    | 'dwsid'
+    | typeof DWSID_COOKIE_NAME
 
 type AuthDataMap = Record<
     AuthDataKeys,
@@ -171,7 +172,7 @@ const DATA_MAP: AuthDataMap = {
     },
     dwsid: {
         storageType: 'cookie',
-        key: 'dwsid'
+        key: DWSID_COOKIE_NAME
     }
 }
 
@@ -478,7 +479,7 @@ class Auth {
      * registered shopper refresh-token and restores session and basket on SFRA.
      */
     private clearECOMSession() {
-        const {key, storageType} = DATA_MAP['dwsid']
+        const {key, storageType} = DATA_MAP[DWSID_COOKIE_NAME]
         const store = this.stores[storageType]
         store.delete(key)
     }

@@ -32,6 +32,20 @@ export const SLAS_REFRESH_TOKEN_COOKIE_TTL_OVERRIDE_MSG =
     'You are attempting to use an invalid refresh token TTL value.'
 
 export const DNT_COOKIE_NAME = 'dw_dnt' as const
+
+export const DWSID_COOKIE_NAME = 'dwsid'
 // commerce-sdk-react namespaces cookies with siteID as suffixes to allow multisite setups.
 // However some cookies are set and used outside of PWA Kit and must not be modified with suffixes.
-export const EXCLUDE_COOKIE_SUFFIX = ['dwsid', DNT_COOKIE_NAME]
+export const EXCLUDE_COOKIE_SUFFIX = [DWSID_COOKIE_NAME, DNT_COOKIE_NAME]
+
+/**
+ * For Hybrid Setups only!
+ * Unlike SCAPI/OCAPI, ECOM creates baskets in app-server cache initially and move the basket object
+ * to the db later based on basket state. In a hybrid storefront, storefront requests might be
+ * routed to different appservers, if the basket object is still in appserver cache, you will start
+ * seeing inconsistencies in basket state. To avoid this, if you have a dwsid cookie, you must send
+ * the value of the dwsid cookie with each SCAPI/OCAPI request in a hybrid storefront to maintain appserver affinity.
+ *
+ * Use the header key below to send dwsid value with SCAPI/OCAPI requests.
+ */
+export const SERVER_AFFINITY_HEADER_KEY = 'sfdc_dwsid'
@@ -21,7 +21,8 @@ import {
 
 jest.mock('../../auth/index.ts', () => {
     return jest.fn().mockImplementation(() => ({
-        ready: jest.fn().mockResolvedValue({access_token: 'access_token'})
+        ready: jest.fn().mockResolvedValue({access_token: 'access_token'}),
+        get: jest.fn().mockResolvedValue({dwsid: 'dw-session-123'})
     }))
 })
 

@@ -23,7 +23,12 @@ import {
 import Auth from './auth'
 import {ApiClientConfigParams, ApiClients} from './hooks/types'
 import {Logger} from './types'
-import {MOBIFY_PATH, SLAS_PRIVATE_PROXY_PATH} from './constant'
+import {
+    DWSID_COOKIE_NAME,
+    MOBIFY_PATH,
+    SERVER_AFFINITY_HEADER_KEY,
+    SLAS_PRIVATE_PROXY_PATH
+} from './constant'
 export interface CommerceApiProviderProps extends ApiClientConfigParams {
     children: React.ReactNode
     proxy: string
@@ -125,9 +130,53 @@ const CommerceApiProvider = (props: CommerceApiProviderProps): ReactElement => {
     // Set the logger based on provided configuration, or default to the console object if no logger is provided
     const configLogger = logger || console
 
+    const auth = useMemo(() => {
+        return new Auth({
+            clientId,
+            organizationId,
+            shortCode,
+            siteId,
+            proxy,
+            redirectURI,
+            fetchOptions,
+            fetchedToken,
+            enablePWAKitPrivateClient,
+            clientSecret,
+            silenceWarnings,
+            logger: configLogger,
+            defaultDnt,
+            refreshTokenRegisteredCookieTTL,
+            refreshTokenGuestCookieTTL
+        })
+    }, [
+        clientId,
+        organizationId,
+        shortCode,
+        siteId,
+        proxy,
+        redirectURI,
+        fetchOptions,
+        fetchedToken,
+        enablePWAKitPrivateClient,
+        clientSecret,
+        silenceWarnings,
+        configLogger,
+        refreshTokenRegisteredCookieTTL,
+        refreshTokenGuestCookieTTL
+    ])
+
+    const dwsid = auth.get(DWSID_COOKIE_NAME)
+    const serverAffinityHeader: Record<string, string> = {}
+    if (dwsid) {
+        serverAffinityHeader[SERVER_AFFINITY_HEADER_KEY] = dwsid
+    }
+
     const config = {
         proxy,
-        headers,
+        headers: {
+            ...headers,
+            ...serverAffinityHeader
+        },
         parameters: {
             clientId,
             organizationId,
@@ -173,41 +222,6 @@ const CommerceApiProvider = (props: CommerceApiProviderProps): ReactElement => {
         headers?.['correlation-id']
     ])
 
-    const auth = useMemo(() => {
-        return new Auth({
-            clientId,
-            organizationId,
-            shortCode,
-            siteId,
-            proxy,
-            redirectURI,
-            fetchOptions,
-            fetchedToken,
-            enablePWAKitPrivateClient,
-            clientSecret,
-            silenceWarnings,
-            logger: configLogger,
-            defaultDnt,
-            refreshTokenRegisteredCookieTTL,
-            refreshTokenGuestCookieTTL
-        })
-    }, [
-        clientId,
-        organizationId,
-        shortCode,
-        siteId,
-        proxy,
-        redirectURI,
-        fetchOptions,
-        fetchedToken,
-        enablePWAKitPrivateClient,
-        clientSecret,
-        silenceWarnings,
-        configLogger,
-        refreshTokenRegisteredCookieTTL,
-        refreshTokenGuestCookieTTL
-    ])
-
     // Initialize the session
     useEffect(() => void auth.ready(), [auth])
 

@@ -1,4 +1,6 @@
 ## v3.8.0-dev (Aug 8, 2024)
+
+- Removed OCAPISessionURL prop from provider template. [#2090](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2090)
 - Update ssr.js templates to include new feature flag to encode non ASCII HTTP headers [#2048](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2048)
 - Replace getAppOrigin with useOrigin to have a better support for an app origin building. [#2050](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2050)
 

@@ -57,7 +57,6 @@ const AppConfig = ({children, locals = {}}) => {
             redirectURI={`${appOrigin}/callback`}
             proxy={`${appOrigin}${commerceApiConfig.proxyPath}`}
             headers={headers}
-            OCAPISessionsURL={`${appOrigin}${proxyBasePath}/ocapi/s/${locals.site?.id}/dw/shop/v22_8/sessions`}
             logger={createLogger({packageName: 'commerce-sdk-react'})}
             {{#if answers.project.commerce.isSlasPrivate}}
             // Set 'enablePWAKitPrivateClient' to true use SLAS private client login flows.

@@ -57,7 +57,6 @@ const AppConfig = ({children, locals = {}}) => {
             redirectURI={`${appOrigin}/callback`}
             proxy={`${appOrigin}${commerceApiConfig.proxyPath}`}
             headers={headers}
-            OCAPISessionsURL={`${appOrigin}${proxyBasePath}/ocapi/s/${locals.site?.id}/dw/shop/v22_8/sessions`}
             logger={createLogger({packageName: 'commerce-sdk-react'})}
             {{#if answers.project.commerce.isSlasPrivate}}
             // Set 'enablePWAKitPrivateClient' to true use SLAS private client login flows.

@@ -73,11 +73,7 @@ module.exports = {
             {
                 host: '{{answers.project.commerce.shortCode}}.api.commercecloud.salesforce.com',
                 path: 'api'
-            }{{~#if answers.project.commerce.instanceUrl}},
-            {
-                host: '{{answers.project.commerce.instanceUrl}}',
-                path: 'ocapi'
-            }{{/if}}
+            }
         ]
     }
 }
@@ -1,4 +1,5 @@
 ## v3.8.0-dev (Aug 08, 2024)
+- [Server Affinity] - Attach dwsid to SCAPI request headers [#2090](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2090)
 - Create useOrigin hook to return an app origin that takes x-forwarded-host header into consideration. [#2050](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2050) 
 
 ## v3.7.0 (Aug 07, 2024)

@@ -30,10 +30,6 @@ jest.mock('@salesforce/pwa-kit-runtime/utils/ssr-config', () => {
                     {
                         host: 'kv7kzm78.api.commercecloud.salesforce.com',
                         path: 'api'
-                    },
-                    {
-                        host: 'zzrf-001.dx.commercecloud.salesforce.com',
-                        path: 'ocapi'
                     }
                 ]
             }

@@ -1,4 +1,6 @@
 ## v4.1.0-dev (Aug 8, 2024)
+
+- [Server Affinity] - Attach dwsid to SCAPI request headers & remove OCAPI proxy [#2090](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2090)
 - Announce wishlist change in total for screen readers (a11y) [#2033](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2033)
 - Fixed a bug that incorrectly imports uninstalled package `@chakra-ui/layout` [#2047](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2047)
 - Replace getAppOrigin with useOrigin to have a better support for an app origin building. [#2050](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2050)

@@ -55,10 +55,6 @@ module.exports = {
             {
                 host: 'kv7kzm78.api.commercecloud.salesforce.com',
                 path: 'api'
-            },
-            {
-                host: 'zzrf-001.dx.commercecloud.salesforce.com',
-                path: 'ocapi'
             }
         ]
     }

@@ -112,10 +112,6 @@ module.exports = {
             {
                 host: 'localhost:8888',
                 path: 'api'
-            },
-            {
-                host: 'localhost:9999',
-                path: 'ocapi'
             }
         ]
     }