@coveo/quantic 3.13.1 → 3.14.0

package/force-app/main/default/lwc/quanticSmartSnippetSuggestions/e2e/pageObject.ts

@@ -0,0 +1,160 @@
+import type {Locator, Page, Request} from '@playwright/test';
+import {
+  isUaCustomEvent,
+  isUaClickEvent,
+} from '../../../../../../playwright/utils/requests';
+
+export class SmartSnippetSuggestionsObject {
+  constructor(public page: Page) {
+    this.page = page;
+  }
+
+  get smartSnippetSuggestions(): Locator {
+    return this.page.locator('c-quantic-smart-snippet-suggestions');
+  }
+
+  get smartSnippetSuggestionHeading(): Locator {
+    return this.page.locator(
+      'lightning-accordion-section .slds-accordion__summary-heading'
+    );
+  }
+
+  get smartSnippetSuggestionSourceUri(): Locator {
+    return this.page.getByTestId('smart-snippet__source-uri');
+  }
+
+  get smartSnippetSuggestionSourceTitle(): Locator {
+    return this.page.getByTestId('smart-snippet__source-title');
+  }
+
+  get smartSnippetSuggestionInlineLink(): Locator {
+    return this.page.getByTestId('smart-snippet-answer').locator('a');
+  }
+
+  async clickOnSmartSnippetSuggestionHeading(index: number): Promise<void> {
+    await this.smartSnippetSuggestionHeading.nth(index).click();
+  }
+
+  async clickOnSmartSnippetSuggestionSourceUri(index: number): Promise<void> {
+    await this.smartSnippetSuggestionSourceUri.nth(index).click();
+  }
+
+  async clickOnSmartSnippetSuggestionSourceTitle(index: number): Promise<void> {
+    await this.smartSnippetSuggestionSourceTitle.nth(index).click();
+  }
+
+  async clickOnSmartSnippetSuggestionInlineLink(index: number): Promise<void> {
+    await this.smartSnippetSuggestionInlineLink.nth(index).click();
+  }
+
+  async waitForExpandSmartSnippetSuggestionUaAnalytics(
+    expectedFields: Record<string, any>
+  ): Promise<Request> {
+    return this.waitForSmartSnippetSuggestionsCustomUaAnalytics(
+      'expandSmartSnippetSuggestion',
+      (customData: Record<string, any>) => {
+        return Object.keys(expectedFields).every(
+          (key) => customData?.[key] === expectedFields[key]
+        );
+      }
+    );
+  }
+
+  async waitForCollapseSmartSnippetSuggestionUaAnalytics(
+    expectedFields: Record<string, any>
+  ): Promise<Request> {
+    return this.waitForSmartSnippetSuggestionsCustomUaAnalytics(
+      'collapseSmartSnippetSuggestion',
+      (customData: Record<string, any>) => {
+        return Object.keys(expectedFields).every(
+          (key) => customData?.[key] === expectedFields[key]
+        );
+      }
+    );
+  }
+
+  async waitForSmartSnippetSuggestionSourceClickUaAnalytics(
+    expectedCustomFields: Record<string, any>
+  ): Promise<Request> {
+    return this.waitForSmartSnippetSuggestionsClickUaAnalytics(
+      'openSmartSnippetSuggestionSource',
+      (customData: Record<string, any>) => {
+        return Object.keys(expectedCustomFields).every(
+          (key) => customData?.[key] === expectedCustomFields[key]
+        );
+      }
+    );
+  }
+
+  async waitForSmartSnippetSuggestionInlineLinkClickUaAnalytics(
+    expectedCustomFields: Record<string, any>
+  ): Promise<Request> {
+    return this.waitForSmartSnippetSuggestionsClickUaAnalytics(
+      'openSmartSnippetSuggestionInlineLink',
+      (customData: Record<string, any>) => {
+        return Object.keys(expectedCustomFields).every(
+          (key) => customData?.[key] === expectedCustomFields[key]
+        );
+      }
+    );
+  }
+
+  async waitForSmartSnippetSuggestionsClickUaAnalytics(
+    actionCause: string,
+    customChecker?: Function
+  ): Promise<Request> {
+    const uaRequest = this.page.waitForRequest((request) => {
+      if (isUaClickEvent(request)) {
+        const requestBody = request.postDataJSON?.();
+        const requestData = JSON.parse(requestBody.clickEvent);
+
+        const expectedFields: Record<string, any> = {
+          actionCause,
+        };
+
+        const matchesExpectedFields = Object.keys(expectedFields).every(
+          (key) => requestData?.[key] === expectedFields[key]
+        );
+
+        const customData = requestData?.customData;
+
+        return (
+          matchesExpectedFields &&
+          (customChecker
+            ? customChecker(requestData.customData, customData)
+            : true)
+        );
+      }
+      return false;
+    });
+    return uaRequest;
+  }
+
+  async waitForSmartSnippetSuggestionsCustomUaAnalytics(
+    eventValue: string,
+    customChecker?: Function
+  ): Promise<Request> {
+    const uaRequest = this.page.waitForRequest((request) => {
+      if (isUaCustomEvent(request)) {
+        const requestBody = request.postDataJSON?.();
+        const expectedFields: Record<string, any> = {
+          eventType: 'smartSnippetSuggestions',
+          eventValue: eventValue,
+        };
+
+        const matchesExpectedFields = Object.keys(expectedFields).every(
+          (key) => requestBody?.[key] === expectedFields[key]
+        );
+
+        const customData = requestBody?.customData;
+
+        return (
+          matchesExpectedFields &&
+          (customChecker ? customChecker(customData) : true)
+        );
+      }
+      return false;
+    });
+    return uaRequest;
+  }
+}

package/force-app/main/default/lwc/quanticSmartSnippetSuggestions/e2e/quanticSmartSnippetSuggestions.e2e.ts

@@ -0,0 +1,127 @@
+import {testSearch, testInsight} from './fixture';
+import {useCaseTestCases} from '../../../../../../playwright/utils/useCase';
+import smartSnippetSuggestionsData from './data';
+
+const fixtures = {
+  search: testSearch,
+  insight: testInsight,
+};
+
+useCaseTestCases.forEach((useCase) => {
+  let test = fixtures[useCase.value];
+
+  test.describe(`quantic smart snippet suggestions ${useCase.label}`, () => {
+    test.use({
+      smartSnippetSuggestionsData,
+    });
+    test.describe('when expanding and collapsing the smart snippet suggestions', () => {
+      test('should send the expand and collapse analytics events', async ({
+        smartSnippetSuggestions,
+      }) => {
+        const smartSnippetSuggestionIndex = 0;
+        const {question, answerSnippet} =
+          smartSnippetSuggestionsData.relatedQuestions[
+            smartSnippetSuggestionIndex
+          ];
+        const expandSmartSnippetSuggestionsPromise =
+          smartSnippetSuggestions.waitForExpandSmartSnippetSuggestionUaAnalytics(
+            {
+              question,
+              answerSnippet,
+            }
+          );
+
+        await smartSnippetSuggestions.clickOnSmartSnippetSuggestionHeading(
+          smartSnippetSuggestionIndex
+        );
+        await expandSmartSnippetSuggestionsPromise;
+
+        const collapseSmartSnippetSuggestionsPromise =
+          smartSnippetSuggestions.waitForCollapseSmartSnippetSuggestionUaAnalytics(
+            {
+              question,
+              answerSnippet,
+            }
+          );
+
+        await smartSnippetSuggestions.clickOnSmartSnippetSuggestionHeading(
+          smartSnippetSuggestionIndex
+        );
+        await collapseSmartSnippetSuggestionsPromise;
+      });
+    });
+
+    test.describe('when clicking on elements of the smart snippet suggestion', () => {
+      test.beforeEach(async ({smartSnippetSuggestions}) => {
+        await smartSnippetSuggestions.clickOnSmartSnippetSuggestionHeading(0);
+      });
+
+      test('should send the source title analytics event when the title is clicked', async ({
+        smartSnippetSuggestions,
+      }) => {
+        const smartSnippetSuggestionIndex = 0;
+        const {question, answerSnippet} =
+          smartSnippetSuggestionsData.relatedQuestions[
+            smartSnippetSuggestionIndex
+          ];
+        const smartSnippetSuggestionsTitleClickPromise =
+          smartSnippetSuggestions.waitForSmartSnippetSuggestionSourceClickUaAnalytics(
+            {
+              question,
+              answerSnippet,
+            }
+          );
+
+        await smartSnippetSuggestions.clickOnSmartSnippetSuggestionSourceTitle(
+          smartSnippetSuggestionIndex
+        );
+        await smartSnippetSuggestionsTitleClickPromise;
+      });
+
+      test('should send the source uri analytics event when the uri is clicked', async ({
+        smartSnippetSuggestions,
+      }) => {
+        const smartSnippetSuggestionIndex = 0;
+        const {question, answerSnippet} =
+          smartSnippetSuggestionsData.relatedQuestions[
+            smartSnippetSuggestionIndex
+          ];
+
+        const smartSnippetSuggestionsSourceUriClickPromise =
+          smartSnippetSuggestions.waitForSmartSnippetSuggestionSourceClickUaAnalytics(
+            {
+              question,
+              answerSnippet,
+            }
+          );
+
+        await smartSnippetSuggestions.clickOnSmartSnippetSuggestionSourceUri(
+          smartSnippetSuggestionIndex
+        );
+        await smartSnippetSuggestionsSourceUriClickPromise;
+      });
+
+      test('should send the inline link analytics event when an inline link is clicked', async ({
+        smartSnippetSuggestions,
+      }) => {
+        const smartSnippetSuggestionIndex = 0;
+        const {question, answerSnippet} =
+          smartSnippetSuggestionsData.relatedQuestions[
+            smartSnippetSuggestionIndex
+          ];
+        const smartSnippetSuggestionsInlineLinkClickPromise =
+          smartSnippetSuggestions.waitForSmartSnippetSuggestionInlineLinkClickUaAnalytics(
+            {
+              question,
+              answerSnippet,
+            }
+          );
+
+        await smartSnippetSuggestions.clickOnSmartSnippetSuggestionInlineLink(
+          smartSnippetSuggestionIndex
+        );
+        await smartSnippetSuggestionsInlineLinkClickPromise;
+      });
+    });
+  });
+});

package/force-app/main/default/lwc/quanticSmartSnippetSuggestions/quanticSmartSnippetSuggestions.html

@@ -5,7 +5,7 @@
   </template>
   <template lwc:else>
     <template if:true={shouldDisplaySmartSnippetSuggestions}>
-      <div data-cy="smart-snippet-suggestions-card" class="slds-card">
+      <div data-testid="smart-snippet-suggestions-card" class="slds-card">
         <p
           class="slds-text-heading_small slds-var-p-around_small slds-border_bottom smart-snippet-suggestions__title"
         >
@@ -18,6 +18,7 @@
           <template for:each={suggestions} for:item="suggestion">
             <lightning-accordion-section
               data-id={suggestion.questionAnswerId}
+              data-testid="smart-snippet-suggestion"
               key={suggestion.questionAnswerId}
               name={suggestion.question}
               label={suggestion.question}