coveo.analytics 2.23.6 → 2.23.8

package/src/searchPage/searchPageClient.spec.ts

@@ -87,8 +87,18 @@ describe('SearchPageClient', () => {
         fetchMock.reset();
     });
 
+    const customDataFromMiddleware = {helloFromMiddleware: 1234};
+
     const initClient = () => {
-        return new CoveoSearchPageClient({}, provider);
+        return new CoveoSearchPageClient(
+            {
+                beforeSendHooks: [
+                    (_, payload) =>
+                        Promise.resolve({...payload, customData: {...payload.customData, ...customDataFromMiddleware}}),
+                ],
+            },
+            provider
+        );
     };
 
     const expectOrigins = () => ({
@@ -105,24 +115,27 @@ describe('SearchPageClient', () => {
 
     const expectMatchPayload = (actionCause: SearchPageEvents, meta = {}) => {
         const [, {body}] = fetchMock.lastCall();
-        const customData = {foo: 'bar', ...meta};
-        expect(JSON.parse(body.toString())).toMatchObject({
+        const customData = {foo: 'bar', ...customDataFromMiddleware, ...meta};
+        expect(JSON.parse(body.toString())).toEqual({
             queryText: 'queryText',
             responseTime: 123,
+            searchQueryUid: provider.getSearchUID(),
             queryPipeline: 'my-pipeline',
             actionCause,
+            anonymous: false,
             customData,
             facetState: fakeFacetState,
             language: 'en',
             clientId: 'visitor-id',
+            userAgent: expect.any(String),
             ...expectOrigins(),
             ...expectSplitTestRun(),
         });
     };
 
     const expectMatchDescription = (description: EventDescription, actionCause: SearchPageEvents, meta = {}) => {
-        const customData = {foo: 'bar', ...meta};
-        expect(description).toMatchObject({
+        const customData = {foo: 'bar', ...customDataFromMiddleware, ...meta};
+        expect(description).toEqual({
             actionCause,
             customData,
         });
@@ -130,13 +143,17 @@ describe('SearchPageClient', () => {
 
     const expectMatchDocumentPayload = (actionCause: SearchPageEvents, doc: PartialDocumentInformation, meta = {}) => {
         const [, {body}] = fetchMock.lastCall();
-        const customData = {foo: 'bar', ...meta};
-        expect(JSON.parse(body.toString())).toMatchObject({
+        const customData = {foo: 'bar', ...customDataFromMiddleware, ...meta};
+        expect(JSON.parse(body.toString())).toEqual({
+            anonymous: false,
             actionCause,
             customData,
             queryPipeline: 'my-pipeline',
             language: 'en',
             clientId: 'visitor-id',
+            facetState: fakeFacetState,
+            searchQueryUid: provider.getSearchUID(),
+            userAgent: expect.any(String),
             ...doc,
             ...expectOrigins(),
             ...expectSplitTestRun(),
@@ -149,14 +166,17 @@ describe('SearchPageClient', () => {
         eventType = CustomEventsTypes[actionCause]
     ) => {
         const [, {body}] = fetchMock.lastCall();
-        const customData = {foo: 'bar', ...meta};
-        expect(JSON.parse(body.toString())).toMatchObject({
+        const customData = {foo: 'bar', ...customDataFromMiddleware, ...meta};
+        expect(JSON.parse(body.toString())).toEqual({
+            anonymous: false,
             eventValue: actionCause,
             eventType,
             lastSearchQueryUid: 'my-uid',
             customData,
             language: 'en',
             clientId: 'visitor-id',
+            facetState: fakeFacetState,
+            userAgent: expect.any(String),
             ...expectOrigins(),
             ...expectSplitTestRun(),
         });
@@ -164,14 +184,17 @@ describe('SearchPageClient', () => {
 
     const expectMatchCustomEventWithTypePayload = (eventValue: string, eventType: string, meta = {}) => {
         const [, {body}] = fetchMock.lastCall();
-        const customData = {foo: 'bar', ...meta};
-        expect(JSON.parse(body.toString())).toMatchObject({
+        const customData = {foo: 'bar', ...customDataFromMiddleware, ...meta};
+        expect(JSON.parse(body.toString())).toEqual({
+            anonymous: false,
             eventValue,
             eventType,
             lastSearchQueryUid: 'my-uid',
             customData,
             language: 'en',
             clientId: 'visitor-id',
+            facetState: fakeFacetState,
+            userAgent: expect.any(String),
             ...expectOrigins(),
             ...expectSplitTestRun(),
         });
@@ -183,8 +206,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeInterfaceLoad', async () => {
-        const built = client.makeInterfaceLoad();
-        await built.log();
+        const built = await client.makeInterfaceLoad();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.interfaceLoad);
         expectMatchDescription(built.description, SearchPageEvents.interfaceLoad);
     });
@@ -197,8 +220,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeInterfaceChange', async () => {
-        const built = client.makeInterfaceChange({interfaceChangeTo: 'bob'});
-        await built.log();
+        const built = await client.makeInterfaceChange({interfaceChangeTo: 'bob'});
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.interfaceChange, {interfaceChangeTo: 'bob'});
         expectMatchDescription(built.description, SearchPageEvents.interfaceChange, {interfaceChangeTo: 'bob'});
     });
@@ -209,8 +232,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeDidyoumeanAutomatic', async () => {
-        const built = client.makeDidYouMeanAutomatic();
-        await built.log();
+        const built = await client.makeDidYouMeanAutomatic();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.didyoumeanAutomatic);
         expectMatchDescription(built.description, SearchPageEvents.didyoumeanAutomatic);
     });
@@ -221,8 +244,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeDidyoumeanClick', async () => {
-        const built = client.makeDidYouMeanClick();
-        await built.log();
+        const built = await client.makeDidYouMeanClick();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.didyoumeanClick);
         expectMatchDescription(built.description, SearchPageEvents.didyoumeanClick);
     });
@@ -233,8 +256,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeResultsSort', async () => {
-        const built = client.makeResultsSort({resultsSortBy: 'date ascending'});
-        await built.log();
+        const built = await client.makeResultsSort({resultsSortBy: 'date ascending'});
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.resultsSort, {resultsSortBy: 'date ascending'});
         expectMatchDescription(built.description, SearchPageEvents.resultsSort, {resultsSortBy: 'date ascending'});
     });
@@ -245,8 +268,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeSearchboxSubmit', async () => {
-        const built = client.makeSearchboxSubmit();
-        await built.log();
+        const built = await client.makeSearchboxSubmit();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.searchboxSubmit);
         expectMatchDescription(built.description, SearchPageEvents.searchboxSubmit);
     });
@@ -257,8 +280,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeSearchboxClear', async () => {
-        const built = client.makeSearchboxClear();
-        await built.log();
+        const built = await client.makeSearchboxClear();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.searchboxClear);
         expectMatchDescription(built.description, SearchPageEvents.searchboxClear);
     });
@@ -269,8 +292,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeSearchboxAsYouType', async () => {
-        const built = client.makeSearchboxAsYouType();
-        await built.log();
+        const built = await client.makeSearchboxAsYouType();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.searchboxAsYouType);
         expectMatchDescription(built.description, SearchPageEvents.searchboxAsYouType);
     });
@@ -281,8 +304,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeDocumentQuickview', async () => {
-        const built = client.makeDocumentQuickview(fakeDocInfo, fakeDocID);
-        await built.log();
+        const built = await client.makeDocumentQuickview(fakeDocInfo, fakeDocID);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchDocumentPayload(SearchPageEvents.documentQuickview, fakeDocInfo, fakeDocID);
         expectMatchDescription(built.description, SearchPageEvents.documentQuickview, {...fakeDocID});
     });
@@ -293,8 +316,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeDocumentOpen', async () => {
-        const built = client.makeDocumentOpen(fakeDocInfo, fakeDocID);
-        await built.log();
+        const built = await client.makeDocumentOpen(fakeDocInfo, fakeDocID);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchDocumentPayload(SearchPageEvents.documentOpen, fakeDocInfo, fakeDocID);
         expectMatchDescription(built.description, SearchPageEvents.documentOpen, {...fakeDocID});
     });
@@ -305,8 +328,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeShowMoreFoldedResults', async () => {
-        const built = client.makeShowMoreFoldedResults(fakeDocInfo, fakeDocID);
-        await built.log();
+        const built = await client.makeShowMoreFoldedResults(fakeDocInfo, fakeDocID);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchDocumentPayload(SearchPageEvents.showMoreFoldedResults, fakeDocInfo, fakeDocID);
         expectMatchDescription(built.description, SearchPageEvents.showMoreFoldedResults, fakeDocID);
     });
@@ -317,8 +340,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeShowLessFoldedResults', async () => {
-        const built = client.makeShowLessFoldedResults();
-        await built.log();
+        const built = await client.makeShowLessFoldedResults();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.showLessFoldedResults);
         expectMatchDescription(built.description, SearchPageEvents.showLessFoldedResults);
     });
@@ -343,8 +366,8 @@ describe('SearchPageClient', () => {
             suggestions: 'q;w;e;r;t;y',
             querySuggestResponseId: '1',
         };
-        const built = client.makeOmniboxAnalytics(meta);
-        await built.log();
+        const built = await client.makeOmniboxAnalytics(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.omniboxAnalytics, meta);
         expectMatchDescription(built.description, SearchPageEvents.omniboxAnalytics, meta);
     });
@@ -369,8 +392,8 @@ describe('SearchPageClient', () => {
             suggestions: 'q;w;e;r;t;y',
             querySuggestResponseId: '1',
         };
-        const built = client.makeOmniboxFromLink(meta);
-        await built.log();
+        const built = await client.makeOmniboxFromLink(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.omniboxFromLink, meta);
         expectMatchDescription(built.description, SearchPageEvents.omniboxFromLink, meta);
     });
@@ -381,8 +404,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeSearchFromLink', async () => {
-        const built = client.makeSearchFromLink();
-        await built.log();
+        const built = await client.makeSearchFromLink();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.searchFromLink);
         expectMatchDescription(built.description, SearchPageEvents.searchFromLink);
     });
@@ -399,8 +422,8 @@ describe('SearchPageClient', () => {
         const meta = {
             notifications: ['foo', 'bar'],
         };
-        const built = client.makeTriggerNotify(meta);
-        await built.log();
+        const built = await client.makeTriggerNotify(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.triggerNotify, meta);
         expectMatchDescription(built.description, SearchPageEvents.triggerNotify, meta);
     });
@@ -423,8 +446,8 @@ describe('SearchPageClient', () => {
                 {functionName: 'world', params: []},
             ],
         };
-        const built = client.makeTriggerExecute(meta);
-        await built.log();
+        const built = await client.makeTriggerExecute(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.triggerExecute, meta);
         expectMatchDescription(built.description, SearchPageEvents.triggerExecute, meta);
     });
@@ -441,8 +464,8 @@ describe('SearchPageClient', () => {
         const meta = {
             query: 'queryText',
         };
-        const built = client.makeTriggerQuery();
-        await built.log();
+        const built = await client.makeTriggerQuery();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.triggerQuery, meta, 'queryPipelineTriggers');
         expectMatchDescription(built.description, SearchPageEvents.triggerQuery, meta);
     });
@@ -459,8 +482,8 @@ describe('SearchPageClient', () => {
         const meta = {
             undoneQuery: 'foo',
         };
-        const built = client.makeUndoTriggerQuery(meta);
-        await built.log();
+        const built = await client.makeUndoTriggerQuery(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.undoTriggerQuery, meta);
         expectMatchDescription(built.description, SearchPageEvents.undoTriggerQuery, meta);
     });
@@ -468,6 +491,7 @@ describe('SearchPageClient', () => {
     it('should send proper payload for #logTriggerRedirect', async () => {
         const meta = {
             redirectedTo: 'foo',
+            query: provider.getSearchEventRequestPayload().queryText,
         };
         await client.logTriggerRedirect(meta);
         expectMatchCustomEventPayload(SearchPageEvents.triggerRedirect, meta);
@@ -476,9 +500,10 @@ describe('SearchPageClient', () => {
     it('should send proper payload for #makeTriggerRedirect', async () => {
         const meta = {
             redirectedTo: 'foo',
+            query: provider.getSearchEventRequestPayload().queryText,
         };
-        const built = client.makeTriggerRedirect(meta);
-        await built.log();
+        const built = await client.makeTriggerRedirect(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.triggerRedirect, meta);
         expectMatchDescription(built.description, SearchPageEvents.triggerRedirect, meta);
     });
@@ -495,8 +520,8 @@ describe('SearchPageClient', () => {
         const meta = {
             currentResultsPerPage: 123,
         };
-        const built = client.makePagerResize(meta);
-        await built.log();
+        const built = await client.makePagerResize(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.pagerResize, meta);
         expectMatchDescription(built.description, SearchPageEvents.pagerResize, meta);
     });
@@ -509,8 +534,8 @@ describe('SearchPageClient', () => {
 
     it('should send proper payload for #makePagerNumber', async () => {
         const meta = {pagerNumber: 123};
-        const built = client.makePagerNumber(meta);
-        await built.log();
+        const built = await client.makePagerNumber(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.pagerNumber, meta);
         expectMatchDescription(built.description, SearchPageEvents.pagerNumber, meta);
     });
@@ -523,8 +548,8 @@ describe('SearchPageClient', () => {
 
     it('should send proper payload for #makePagerNext', async () => {
         const meta = {pagerNumber: 123};
-        const built = client.makePagerNext(meta);
-        await built.log();
+        const built = await client.makePagerNext(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.pagerNext, meta);
         expectMatchDescription(built.description, SearchPageEvents.pagerNext, meta);
     });
@@ -537,8 +562,8 @@ describe('SearchPageClient', () => {
 
     it('should send proper payload for #makePagerPrevious', async () => {
         const meta = {pagerNumber: 123};
-        const built = client.makePagerPrevious(meta);
-        await built.log();
+        const built = await client.makePagerPrevious(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.pagerPrevious, meta);
         expectMatchDescription(built.description, SearchPageEvents.pagerPrevious, meta);
     });
@@ -549,8 +574,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makePagerScrolling', async () => {
-        const built = client.makePagerScrolling();
-        await built.log();
+        const built = await client.makePagerScrolling();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.pagerScrolling);
         expectMatchDescription(built.description, SearchPageEvents.pagerScrolling);
     });
@@ -564,8 +589,8 @@ describe('SearchPageClient', () => {
 
     it('should send the proper payload for #makeStaticFilterClearAll', async () => {
         const staticFilterId = 'filetypes';
-        const built = client.makeStaticFilterClearAll({staticFilterId});
-        await built.log();
+        const built = await client.makeStaticFilterClearAll({staticFilterId});
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.staticFilterClearAll, {staticFilterId});
         expectMatchDescription(built.description, SearchPageEvents.staticFilterClearAll, {staticFilterId});
     });
@@ -591,8 +616,8 @@ describe('SearchPageClient', () => {
                 expression: '@filetype="youtubevideo"',
             },
         };
-        const built = client.makeStaticFilterSelect(meta);
-        await built.log();
+        const built = await client.makeStaticFilterSelect(meta);
+        await built.log({searchUID: provider.getSearchUID()});
 
         expectMatchPayload(SearchPageEvents.staticFilterSelect, meta);
         expectMatchDescription(built.description, SearchPageEvents.staticFilterSelect, meta);
@@ -619,8 +644,8 @@ describe('SearchPageClient', () => {
                 expression: '@filetype="youtubevideo"',
             },
         };
-        const built = client.makeStaticFilterDeselect(meta);
-        await built.log();
+        const built = await client.makeStaticFilterDeselect(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.staticFilterDeselect, meta);
         expectMatchDescription(built.description, SearchPageEvents.staticFilterDeselect, meta);
     });
@@ -641,8 +666,8 @@ describe('SearchPageClient', () => {
             facetId: 'bar',
             facetTitle: 'title',
         };
-        const built = client.makeFacetSearch(meta);
-        await built.log();
+        const built = await client.makeFacetSearch(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.facetSearch, meta);
         expectMatchDescription(built.description, SearchPageEvents.facetSearch, meta);
     });
@@ -667,7 +692,7 @@ describe('SearchPageClient', () => {
             facetValue: 'qwerty',
         };
         const built = await client.makeFacetSelect(meta);
-        await built.log();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.facetSelect, meta);
         expectMatchDescription(built.description, SearchPageEvents.facetSelect, meta);
     });
@@ -692,8 +717,8 @@ describe('SearchPageClient', () => {
             facetValue: 'qwerty',
         };
 
-        const built = client.makeFacetDeselect(meta);
-        await built.log();
+        const built = await client.makeFacetDeselect(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.facetDeselect, meta);
         expectMatchDescription(built.description, SearchPageEvents.facetDeselect, meta);
     });
@@ -716,8 +741,8 @@ describe('SearchPageClient', () => {
             facetTitle: 'title',
             facetValue: 'qwerty',
         };
-        const built = client.makeFacetExclude(meta);
-        await built.log();
+        const built = await client.makeFacetExclude(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.facetExclude, meta);
         expectMatchDescription(built.description, SearchPageEvents.facetExclude, meta);
     });
@@ -740,8 +765,8 @@ describe('SearchPageClient', () => {
             facetTitle: 'title',
             facetValue: 'qwerty',
         };
-        const built = client.makeFacetUnexclude(meta);
-        await built.log();
+        const built = await client.makeFacetUnexclude(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.facetUnexclude, meta);
         expectMatchDescription(built.description, SearchPageEvents.facetUnexclude, meta);
     });
@@ -762,8 +787,8 @@ describe('SearchPageClient', () => {
             facetId: 'bar',
             facetTitle: 'title',
         };
-        const built = client.makeFacetSelectAll(meta);
-        await built.log();
+        const built = await client.makeFacetSelectAll(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.facetSelectAll, meta);
         expectMatchDescription(built.description, SearchPageEvents.facetSelectAll, meta);
     });
@@ -786,8 +811,8 @@ describe('SearchPageClient', () => {
             facetTitle: 'title',
             criteria: 'bazz',
         };
-        const built = client.makeFacetUpdateSort(meta);
-        await built.log();
+        const built = await client.makeFacetUpdateSort(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.facetUpdateSort, meta);
         expectMatchDescription(built.description, SearchPageEvents.facetUpdateSort, meta);
     });
@@ -808,8 +833,8 @@ describe('SearchPageClient', () => {
             facetId: 'bar',
             facetTitle: 'title',
         };
-        const built = client.makeFacetShowMore(meta);
-        await built.log();
+        const built = await client.makeFacetShowMore(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.facetShowMore, meta);
         expectMatchDescription(built.description, SearchPageEvents.facetShowMore, meta);
     });
@@ -830,8 +855,8 @@ describe('SearchPageClient', () => {
             facetId: 'bar',
             facetTitle: 'title',
         };
-        const built = client.makeFacetShowLess(meta);
-        await built.log();
+        const built = await client.makeFacetShowLess(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.facetShowLess, meta);
         expectMatchDescription(built.description, SearchPageEvents.facetShowLess, meta);
     });
@@ -858,8 +883,8 @@ describe('SearchPageClient', () => {
             errorMessage: 'boom',
             errorType: 'a bad one',
         };
-        const built = client.makeQueryError(meta);
-        await built.log();
+        const built = await client.makeQueryError(meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.queryError, meta);
         expectMatchDescription(built.description, SearchPageEvents.queryError, meta);
     });
@@ -870,8 +895,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeQueryErrorBack', async () => {
-        const built = client.makeQueryErrorBack();
-        await built.log();
+        const built = await client.makeQueryErrorBack();
+        await built.log({searchUID: provider.getSearchUID()});
 
         expectMatchPayload(SearchPageEvents.queryErrorBack);
         expectMatchDescription(built.description, SearchPageEvents.queryErrorBack);
@@ -883,8 +908,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeQueryErrorRetry', async () => {
-        const built = client.makeQueryErrorRetry();
-        await built.log();
+        const built = await client.makeQueryErrorRetry();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.queryErrorRetry);
         expectMatchDescription(built.description, SearchPageEvents.queryErrorRetry);
     });
@@ -895,8 +920,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeQueryErrorClear', async () => {
-        const built = client.makeQueryErrorClear();
-        await built.log();
+        const built = await client.makeQueryErrorClear();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.queryErrorClear);
         expectMatchDescription(built.description, SearchPageEvents.queryErrorClear);
     });
@@ -907,8 +932,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeRecommendationInterfaceLoad', async () => {
-        const built = client.makeRecommendationInterfaceLoad();
-        await built.log();
+        const built = await client.makeRecommendationInterfaceLoad();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchPayload(SearchPageEvents.recommendationInterfaceLoad);
         expectMatchDescription(built.description, SearchPageEvents.recommendationInterfaceLoad);
     });
@@ -919,8 +944,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeRecommendation', async () => {
-        const built = client.makeRecommendation();
-        await built.log();
+        const built = await client.makeRecommendation();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.recommendation);
     });
 
@@ -930,8 +955,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeRecommendationOpen', async () => {
-        const built = client.makeRecommendationOpen(fakeDocInfo, fakeDocID);
-        await built.log();
+        const built = await client.makeRecommendationOpen(fakeDocInfo, fakeDocID);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchDocumentPayload(SearchPageEvents.recommendationOpen, fakeDocInfo, fakeDocID);
         expectMatchDescription(built.description, SearchPageEvents.recommendationOpen, {...fakeDocID});
     });
@@ -942,10 +967,10 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeFetchMoreResults', async () => {
-        const built = client.makeFetchMoreResults();
-        await built.log();
+        const built = await client.makeFetchMoreResults();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.pagerScrolling, {type: 'getMoreResults'});
-        expectMatchDescription(built.description, SearchPageEvents.pagerScrolling);
+        expectMatchDescription(built.description, SearchPageEvents.pagerScrolling, {type: 'getMoreResults'});
     });
 
     it('should send proper payload for #logLikeSmartSnippet', async () => {
@@ -954,8 +979,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeLikeSmartSnippet', async () => {
-        const built = client.makeLikeSmartSnippet();
-        await built.log();
+        const built = await client.makeLikeSmartSnippet();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.likeSmartSnippet);
         expectMatchDescription(built.description, SearchPageEvents.likeSmartSnippet);
     });
@@ -966,8 +991,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeDislikeSmartSnippet', async () => {
-        const built = client.makeDislikeSmartSnippet();
-        await built.log();
+        const built = await client.makeDislikeSmartSnippet();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.dislikeSmartSnippet);
         expectMatchDescription(built.description, SearchPageEvents.dislikeSmartSnippet);
     });
@@ -978,8 +1003,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeExpandSmartSnippet', async () => {
-        const built = client.makeExpandSmartSnippet();
-        await built.log();
+        const built = await client.makeExpandSmartSnippet();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.expandSmartSnippet);
         expectMatchDescription(built.description, SearchPageEvents.expandSmartSnippet);
     });
@@ -990,8 +1015,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeCollapseSmartSnippet', async () => {
-        const built = client.makeCollapseSmartSnippet();
-        await built.log();
+        const built = await client.makeCollapseSmartSnippet();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.collapseSmartSnippet);
         expectMatchDescription(built.description, SearchPageEvents.collapseSmartSnippet);
     });
@@ -1002,8 +1027,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeOpenSmartSnippetFeedbackModal', async () => {
-        const built = client.makeOpenSmartSnippetFeedbackModal();
-        await built.log();
+        const built = await client.makeOpenSmartSnippetFeedbackModal();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.openSmartSnippetFeedbackModal);
         expectMatchDescription(built.description, SearchPageEvents.openSmartSnippetFeedbackModal);
     });
@@ -1014,8 +1039,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeCloseSmartSnippetFeedbackModal', async () => {
-        const built = client.makeCloseSmartSnippetFeedbackModal();
-        await built.log();
+        const built = await client.makeCloseSmartSnippetFeedbackModal();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.closeSmartSnippetFeedbackModal);
         expectMatchDescription(built.description, SearchPageEvents.closeSmartSnippetFeedbackModal);
     });
@@ -1029,8 +1054,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeSmartSnippetFeedbackReason', async () => {
-        const built = client.makeSmartSnippetFeedbackReason('does_not_answer', 'this is irrelevant');
-        await built.log();
+        const built = await client.makeSmartSnippetFeedbackReason('does_not_answer', 'this is irrelevant');
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.sendSmartSnippetReason, {
             details: 'this is irrelevant',
             reason: 'does_not_answer',
@@ -1055,12 +1080,12 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeExpandSmartSnippetSuggestion', async () => {
-        const built = client.makeExpandSmartSnippetSuggestion({
+        const built = await client.makeExpandSmartSnippetSuggestion({
             question: 'Abc',
             answerSnippet: 'Def',
             documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
         });
-        await built.log();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.expandSmartSnippetSuggestion, {
             question: 'Abc',
             answerSnippet: 'Def',
@@ -1087,12 +1112,12 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeCollapseSmartSnippetSuggestion', async () => {
-        const built = client.makeCollapseSmartSnippetSuggestion({
+        const built = await client.makeCollapseSmartSnippetSuggestion({
             question: 'Abc',
             answerSnippet: 'Def',
             documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
         });
-        await built.log();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.collapseSmartSnippetSuggestion, {
             question: 'Abc',
             answerSnippet: 'Def',
@@ -1113,11 +1138,11 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeExpandSmartSnippetSuggestion when called with only the documentId', async () => {
-        const built = client.makeExpandSmartSnippetSuggestion({
+        const built = await client.makeExpandSmartSnippetSuggestion({
             contentIdKey: 'permanentid',
             contentIdValue: 'foo',
         });
-        await built.log();
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.expandSmartSnippetSuggestion, {
             documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
         });
@@ -1134,8 +1159,11 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeCollapseSmartSnippetSuggestion when called with only the documentId', async () => {
-        const built = client.makeCollapseSmartSnippetSuggestion({contentIdKey: 'permanentid', contentIdValue: 'foo'});
-        await built.log();
+        const built = await client.makeCollapseSmartSnippetSuggestion({
+            contentIdKey: 'permanentid',
+            contentIdValue: 'foo',
+        });
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchCustomEventPayload(SearchPageEvents.collapseSmartSnippetSuggestion, {
             documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
         });
@@ -1153,6 +1181,7 @@ describe('SearchPageClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.showMoreSmartSnippetSuggestion, {
             question: 'Abc',
             answerSnippet: 'Def',
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
         });
     });
 
@@ -1180,8 +1209,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeOpenSmartSnippetSource', async () => {
-        const built = client.makeOpenSmartSnippetSource(fakeDocInfo, fakeDocID);
-        await built.log();
+        const built = await client.makeOpenSmartSnippetSource(fakeDocInfo, fakeDocID);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetSource, fakeDocInfo, fakeDocID);
         expectMatchDescription(built.description, SearchPageEvents.openSmartSnippetSource, {...fakeDocID});
     });
@@ -1204,10 +1233,12 @@ describe('SearchPageClient', () => {
         const meta = {
             question: 'Abc',
             answerSnippet: 'Def',
+            contentIDKey: 'permanentid',
+            contentIDValue: 'foo',
             documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
         };
-        const built = client.makeOpenSmartSnippetSuggestionSource(fakeDocInfo, meta);
-        await built.log();
+        const built = await client.makeOpenSmartSnippetSuggestionSource(fakeDocInfo, meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetSuggestionSource, fakeDocInfo, meta);
         expectMatchDescription(built.description, SearchPageEvents.openSmartSnippetSuggestionSource, meta);
     });
@@ -1228,8 +1259,8 @@ describe('SearchPageClient', () => {
             linkText: 'Some text',
             linkURL: 'https://invalid.com',
         };
-        const built = client.makeOpenSmartSnippetInlineLink(fakeDocInfo, meta);
-        await built.log();
+        const built = await client.makeOpenSmartSnippetInlineLink(fakeDocInfo, meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetInlineLink, fakeDocInfo, meta);
         expectMatchDescription(built.description, SearchPageEvents.openSmartSnippetInlineLink, meta);
     });
@@ -1254,12 +1285,14 @@ describe('SearchPageClient', () => {
         const meta = {
             question: 'Abc',
             answerSnippet: 'Def',
+            contentIDKey: 'permanentid',
+            contentIDValue: 'foo',
             documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
             linkText: 'Some text',
             linkURL: 'https://invalid.com',
         };
-        const built = client.makeOpenSmartSnippetSuggestionInlineLink(fakeDocInfo, meta);
-        await built.log();
+        const built = await client.makeOpenSmartSnippetSuggestionInlineLink(fakeDocInfo, meta);
+        await built.log({searchUID: provider.getSearchUID()});
         expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetSuggestionInlineLink, fakeDocInfo, meta);
         expectMatchDescription(built.description, SearchPageEvents.openSmartSnippetSuggestionInlineLink, meta);
     });
@@ -1270,8 +1303,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeRecentQueryClick', async () => {
-        const built = client.makeRecentQueryClick();
-        await built.log();
+        const built = await client.makeRecentQueryClick();
+        await built.log({searchUID: provider.getSearchUID()});
 
         expectMatchPayload(SearchPageEvents.recentQueryClick);
         expectMatchDescription(built.description, SearchPageEvents.recentQueryClick);
@@ -1283,8 +1316,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeClearRecentQueries', async () => {
-        const built = client.makeClearRecentQueries();
-        await built.log();
+        const built = await client.makeClearRecentQueries();
+        await built.log({searchUID: provider.getSearchUID()});
 
         expectMatchCustomEventPayload(SearchPageEvents.clearRecentQueries);
         expectMatchDescription(built.description, SearchPageEvents.clearRecentQueries);
@@ -1299,8 +1332,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeRecentResultClick', async () => {
-        const built = client.makeRecentResultClick(fakeDocInfo, fakeDocID);
-        await built.log();
+        const built = await client.makeRecentResultClick(fakeDocInfo, fakeDocID);
+        await built.log({searchUID: provider.getSearchUID()});
 
         expectMatchCustomEventPayload(SearchPageEvents.recentResultClick, {
             info: fakeDocInfo,
@@ -1319,8 +1352,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeNoResultsBack', async () => {
-        const built = client.makeNoResultsBack();
-        await built.log();
+        const built = await client.makeNoResultsBack();
+        await built.log({searchUID: provider.getSearchUID()});
 
         expectMatchPayload(SearchPageEvents.noResultsBack);
         expectMatchDescription(built.description, SearchPageEvents.noResultsBack);
@@ -1332,8 +1365,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeClearRecentResults', async () => {
-        const built = client.makeClearRecentResults();
-        await built.log();
+        const built = await client.makeClearRecentResults();
+        await built.log({searchUID: provider.getSearchUID()});
 
         expectMatchCustomEventPayload(SearchPageEvents.clearRecentResults);
         expectMatchDescription(built.description, SearchPageEvents.clearRecentResults);
@@ -1345,8 +1378,8 @@ describe('SearchPageClient', () => {
     });
 
     it('should send proper payload for #makeCustomEventWithType', async () => {
-        const built = client.makeCustomEventWithType('foo', 'bar', {buzz: 'bazz'});
-        await built.log();
+        const built = await client.makeCustomEventWithType('foo', 'bar', {buzz: 'bazz'});
+        await built.log({searchUID: provider.getSearchUID()});
 
         expectMatchCustomEventWithTypePayload('foo', 'bar', {buzz: 'bazz'});
         expectMatchDescription(built.description, 'foo' as SearchPageEvents, {buzz: 'bazz'});