fix: don't store query/object associations when userHasOptedOut is tr…

…ue (#557) [EEX-1348](https://algolia.atlassian.net/browse/EEX-1348) [EEX-1348]: https://algolia.atlassian.net/browse/EEX-1348?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
algolia · Sep 11, 2024 · 7c4ab3a · 7c4ab3a
1 parent d2c3e98
commit 7c4ab3a
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 4 deletions.
diff --git a/lib/__tests__/click.test.ts b/lib/__tests__/click.test.ts
@@ -65,6 +65,16 @@ describe("clickedObjectIDsAfterSearch", () => {
       expect.any(Number)
     ]);
   });
+
+  it("shouldn't store the queryID when user has opted out", () => {
+    const aa = new AlgoliaAnalytics({
+      requestFn: jest.fn().mockResolvedValue(true)
+    });
+    aa.init({ ...credentials, userHasOptedOut: true });
+    expect(getQueryForObject("index1", "2")).toBeUndefined();
+    aa.clickedObjectIDsAfterSearch(clickParams);
+    expect(getQueryForObject("index1", "2")).toBeUndefined();
+  });
 });
 
 describe("clickedObjectIDs", () => {

diff --git a/lib/__tests__/conversion.test.ts b/lib/__tests__/conversion.test.ts
@@ -123,6 +123,32 @@ describe("addedToCartObjectIDsAfterSearch", () => {
       expect.any(Number)
     ]);
   });
+
+  it("shouldn't store the queryID when user has opted out", () => {
+    const aa = new AlgoliaAnalytics({
+      requestFn: jest.fn().mockResolvedValue(true)
+    });
+    aa.init({ ...credentials, userHasOptedOut: true });
+    expect(getQueryForObject("index1", "12345")).toBeUndefined();
+    aa.addedToCartObjectIDsAfterSearch(convertParams);
+    expect(getQueryForObject("index1", "12345")).toBeUndefined();
+  });
+
+  it("shouldn't store the objectData.queryID if specified when user has opted out", () => {
+    const aa = new AlgoliaAnalytics({
+      requestFn: jest.fn().mockResolvedValue(true)
+    });
+    aa.init({ ...credentials, userHasOptedOut: true });
+    expect(getQueryForObject("index1", "12345")).toBeUndefined();
+    aa.addedToCartObjectIDsAfterSearch({
+      ...convertParams,
+      objectData: convertParams.objectData.map((data) => ({
+        ...data,
+        queryID: "objectData-query"
+      }))
+    });
+    expect(getQueryForObject("index1", "12345")).toBeUndefined();
+  });
 });
 
 describe("purchasedObjectIDsAfterSearch", () => {

diff --git a/lib/click.ts b/lib/click.ts
@@ -23,8 +23,9 @@ export function clickedObjectIDsAfterSearch(
     extractAdditionalParams<InsightsSearchClickEvent>(params);
 
   events.forEach(({ index, queryID, objectIDs }) =>
-    objectIDs.forEach((objectID) =>
-      storeQueryForObject(index, objectID, queryID)
+    objectIDs.forEach(
+      (objectID) =>
+        !this._userHasOptedOut && storeQueryForObject(index, objectID, queryID)
     )
   );
 

diff --git a/lib/conversion.ts b/lib/conversion.ts
@@ -38,7 +38,8 @@ export function addedToCartObjectIDsAfterSearch(
   events.forEach(({ index, queryID, objectIDs, objectData }) =>
     objectIDs.forEach((objectID, i) => {
       const objQueryID = objectData?.[i]?.queryID ?? queryID;
-      if (objQueryID) storeQueryForObject(index, objectID, objQueryID);
+      if (!this._userHasOptedOut && objQueryID)
+        storeQueryForObject(index, objectID, objQueryID);
     })
   );
 
@@ -102,7 +103,8 @@ export function addedToCartObjectIDs(
   events.forEach(({ index, objectIDs, objectData }) =>
     objectIDs.forEach((objectID, i) => {
       const queryID = objectData?.[i]?.queryID;
-      if (queryID) storeQueryForObject(index, objectID, queryID);
+      if (!this._userHasOptedOut && queryID)
+        storeQueryForObject(index, objectID, queryID);
     })
   );