fix: use last query uuid for custom events (#1953)

* getLastQueryUID for custom events * Fix UT
coveo · Sep 29, 2023 · 48a68da · 48a68da
1 parent 374ee5a
commit 48a68da
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/src/rest/CustomEvent.ts b/src/rest/CustomEvent.ts
@@ -20,4 +20,11 @@ export interface ICustomEvent extends IAnalyticsEvent {
    * **Example:** `pagerNext`
    */
   eventValue: string;
+
+  /**
+   * The searchQueryUid of the last search event that occurred before this event.
+   *
+   * **Example:** `74682726-0e20-46eb-85ac-f37259346f57`
+   */
+  lastSearchQueryUid: string;
 }
diff --git a/src/ui/Analytics/LiveAnalyticsClient.ts b/src/ui/Analytics/LiveAnalyticsClient.ts
@@ -340,7 +340,7 @@ export class LiveAnalyticsClient implements IAnalyticsClient {
     element: HTMLElement
   ): ICustomEvent {
     return this.merge<ICustomEvent>(this.buildAnalyticsEvent(actionCause, metaObject), {
-      searchQueryUid: this.getLastSearchQueryUid(),
+      lastSearchQueryUid: this.getLastSearchQueryUid(),
       eventType: actionCause.type,
       eventValue: actionCause.name,
       originLevel2: this.getOriginLevel2(element),

diff --git a/unitTests/ui/LiveAnalyticsClientTest.ts b/unitTests/ui/LiveAnalyticsClientTest.ts
@@ -486,14 +486,14 @@ export function LiveAnalyticsClientTest() {
         expect(analyticsEventReadySpy).toHaveBeenCalled();
       });
 
-      it('should include searchQueryUid', function (done) {
+      it('should include lastSearchQueryUid', function (done) {
         Simulate.query(env, { promise });
         env.queryController.getLastResults = () => results;
         _.defer(function () {
           client.logCustomEvent<IAnalyticsNoMeta>(analyticsActionCauseList.documentOpen, {}, document.createElement('div'));
           expect(endpoint.sendCustomEvent).toHaveBeenCalledWith(
             jasmine.objectContaining({
-              searchQueryUid: results.searchUid
+              lastSearchQueryUid: results.searchUid
             })
           );
           done();