fix(headless/commerce): send clientId only when analytics are enabled (…

…#4217) https://coveord.atlassian.net/browse/KIT-3312 Legally, one can only send data persisted in the browser (like the clientId) when the user agrees to tracking (even for search queries, not just for UA). Most cases across the ui-kit project were already covered. I think these are the only two spots left, but let me know 👍
coveo · Jul 26, 2024 · 323cede · 323cede
1 parent bcecc55
commit 323cede
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 3 deletions.
diff --git a/packages/headless/src/api/commerce/commerce-api-params.ts b/packages/headless/src/api/commerce/commerce-api-params.ts
@@ -18,7 +18,7 @@ export interface CurrencyParam {
 }
 
 export interface ClientIdParam {
-  clientId: string;
+  clientId?: string;
 }
 
 export interface ContextParam {

diff --git a/packages/headless/src/features/commerce/common/actions.test.ts b/packages/headless/src/features/commerce/common/actions.test.ts
@@ -245,6 +245,27 @@ describe('commerce common actions', () => {
       }
     );
 
+    it.each([true, false])(
+      'sets the clientId conditionally upon the analytics configuration',
+      (analyticsEnabled) => {
+        state.configuration.analytics.enabled = analyticsEnabled;
+
+        const request = Actions.buildCommerceAPIRequest(
+          state,
+          navigatorContext
+        );
+
+        expect(mockedBuildBaseCommerceAPIRequest).toHaveBeenCalledWith(
+          state,
+          navigatorContext
+        );
+
+        expect(request.clientId).toEqual(
+          analyticsEnabled ? 'client_id' : undefined
+        );
+      }
+    );
+
     describe('given a state that has the commerceFacetSet and manualNumericFacetSet', () => {
       let facet1: CommerceFacetSlice;
       let manualFacet1: ManualNumericFacetSetSlice;

diff --git a/packages/headless/src/features/commerce/common/actions.ts b/packages/headless/src/features/commerce/common/actions.ts
@@ -65,7 +65,9 @@ export const buildBaseCommerceAPIRequest = (
     organizationId: state.configuration.organizationId,
     trackingId: state.configuration.analytics.trackingId,
     ...restOfContext,
-    clientId: navigatorContext.clientId,
+    ...(state.configuration.analytics.enabled
+      ? {clientId: navigatorContext.clientId}
+      : {}),
     context: {
       ...(navigatorContext.userAgent
         ? {

diff --git a/packages/headless/src/features/commerce/query-suggest/query-suggest-actions.ts b/packages/headless/src/features/commerce/query-suggest/query-suggest-actions.ts
@@ -129,7 +129,9 @@ export const buildQuerySuggestRequest = (
     trackingId: state.configuration.analytics.trackingId,
     query: state.querySet[id],
     ...restOfContext,
-    clientId: navigatorContext.clientId,
+    ...(state.configuration.analytics.enabled
+      ? {clientId: navigatorContext.clientId}
+      : {}),
     context: {
       ...(navigatorContext.userAgent
         ? {