@coveo/quantic 3.33.0 → 3.33.2

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

@@ -0,0 +1,192 @@
+import {testSearch, testInsight, expect} from './fixture';
+import {useCaseTestCases} from '../../../../../../playwright/utils/useCase';
+import smartSnippetData from './data';
+
+const maximumSnippetHeight = 250;
+
+const fixtures = {
+  search: testSearch,
+  insight: testInsight,
+};
+
+useCaseTestCases.forEach((useCase) => {
+  let test = fixtures[useCase.value];
+
+  test.describe(`quantic smart snippet ${useCase.label}`, () => {
+    test.use({
+      options: {maximumSnippetHeight},
+    });
+
+    test.describe('when the smart snippet is expanded', () => {
+      test('should send the source title analytics event when the title is clicked', async ({
+        smartSnippet,
+      }) => {
+        const smartSnippetTitleClickPromise =
+          smartSnippet.waitForSmartSnippetSourceClickUaAnalytics();
+        await smartSnippet.clickOnSourceTitle();
+        await smartSnippetTitleClickPromise;
+      });
+
+      test('should send the source uri analytics event when the source uri is clicked', async ({
+        smartSnippet,
+      }) => {
+        const smartSnippetUriClickPromise =
+          smartSnippet.waitForSmartSnippetSourceClickUaAnalytics();
+        await smartSnippet.clickOnSourceUri();
+        await smartSnippetUriClickPromise;
+      });
+
+      test('should send the inline link analytics event when the inline link is clicked', async ({
+        smartSnippet,
+      }) => {
+        const smartSnippetUriClickPromise =
+          smartSnippet.waitForSmartSnippetInlineLinkClickUaAnalytics();
+        await smartSnippet.clickOnFirstInlineLink();
+        await smartSnippetUriClickPromise;
+      });
+
+      test('should send the expand and collapse analytics events', async ({
+        smartSnippet,
+      }) => {
+        const expandSmartSnippetAnalyticsPromise =
+          smartSnippet.waitForExpandSmartSnippetUaAnalytics();
+        await smartSnippet.clickToggleButton();
+        await expandSmartSnippetAnalyticsPromise;
+
+        const collapseSmartSnippetAnalyticsPromise =
+          smartSnippet.waitForCollapseSmartSnippetUaAnalytics();
+        await smartSnippet.clickToggleButton();
+        await collapseSmartSnippetAnalyticsPromise;
+      });
+    });
+
+    test.describe('feedback modal interactions', () => {
+      test.describe('when clicking on the feedback like button', () => {
+        test('should send the like analytics event', async ({smartSnippet}) => {
+          const likeAnalyticsPromise =
+            smartSnippet.waitForLikeSmartSnippetUaAnalytics();
+          await smartSnippet.clickLikeButton();
+          await likeAnalyticsPromise;
+        });
+      });
+
+      test.describe('when clicking on the feedback dislike button', () => {
+        test('should send the dislike analytics event', async ({
+          smartSnippet,
+        }) => {
+          const dislikeAnalyticsPromise =
+            smartSnippet.waitForDislikeSmartSnippetUaAnalytics();
+          await smartSnippet.clickDislikeButton();
+          await dislikeAnalyticsPromise;
+        });
+
+        test.describe('when opening the feedback modal and providing feedback', () => {
+          test('should send the smart snippet reason analytics events', async ({
+            smartSnippet,
+          }, testInfo) => {
+            // Todo - remove .skip when the feedback modal of Smart Snippet opens in SF with LWS disabled (SFINT-6407)
+            test.skip(
+              testInfo.project.name === 'LWS-disabled',
+              'Feedback modal not available when LWS is disabled (SFINT-6407)'
+            );
+
+            const expectedReason = 'does_not_answer';
+
+            const openFeedbackModalAnalyticsPromise =
+              smartSnippet.waitForOpenFeedbackModalUaAnalytics();
+            await smartSnippet.clickDislikeButton();
+            await smartSnippet.clickExplainWhyButton();
+            await openFeedbackModalAnalyticsPromise;
+
+            const submitFeedbackAnalyticsPromise =
+              smartSnippet.waitForFeedbackSubmitUaAnalytics(expectedReason);
+
+            await smartSnippet.selectFirstFeedbackOptionLabel();
+            await smartSnippet.clickFeedbackSubmitButton();
+            await submitFeedbackAnalyticsPromise;
+          });
+        });
+
+        test.describe('when closing the feedback modal', () => {
+          test('should send the correct close feedback modal analytics event', async ({
+            smartSnippet,
+          }, testInfo) => {
+            // Todo - remove .skip when the feedback modal of Smart Snippet opens in SF with LWS disabled (SFINT-6407)
+            test.skip(
+              testInfo.project.name === 'LWS-disabled',
+              'Feedback modal not available when LWS is disabled (SFINT-6407)'
+            );
+
+            await smartSnippet.clickDislikeButton();
+            await smartSnippet.clickExplainWhyButton();
+            const closeFeedbackModalAnalyticsPromise =
+              smartSnippet.waitForCloseFeedbackModalUaAnalytics();
+            await smartSnippet.clickFeedbackModalCancelButton();
+            await closeFeedbackModalAnalyticsPromise;
+          });
+        });
+      });
+
+      test.describe('when trying to open the feedback modal after executing the same query', () => {
+        test('should not allow to open the feedback modal', async ({
+          smartSnippet,
+          search,
+        }, testInfo) => {
+          // Todo - remove .skip when the feedback modal of Smart Snippet opens in SF with LWS disabled (SFINT-6407)
+          test.skip(
+            testInfo.project.name === 'LWS-disabled',
+            'Feedback modal not available when LWS is disabled (SFINT-6407)'
+          );
+
+          await smartSnippet.clickDislikeButton();
+          await smartSnippet.clickExplainWhyButton();
+          await smartSnippet.selectFirstFeedbackOptionLabel();
+          await smartSnippet.clickFeedbackSubmitButton();
+
+          await smartSnippet.clickFeedbackModalDoneButton();
+
+          const searchResponsePromise = search.waitForSearchResponse();
+          await search.performSearch();
+          await searchResponsePromise;
+
+          expect(smartSnippet.dislikeButton).not.toBeNull();
+          await smartSnippet.clickDislikeButton();
+          await expect(smartSnippet.explainWhyButton).not.toBeVisible();
+        });
+      });
+
+      test.describe('when trying to open the feedback modal after executing a query that gave a new answer', () => {
+        test('should allow to open the feedback modal', async ({
+          smartSnippet,
+          search,
+        }, testInfo) => {
+          // Todo - remove .skip when the feedback modal of Smart Snippet opens in SF with LWS disabled (SFINT-6407)
+          test.skip(
+            testInfo.project.name === 'LWS-disabled',
+            'Feedback modal not available when LWS is disabled (SFINT-6407)'
+          );
+
+          await smartSnippet.clickDislikeButton();
+          await smartSnippet.clickExplainWhyButton();
+          await smartSnippet.selectFirstFeedbackOptionLabel();
+          await smartSnippet.clickFeedbackSubmitButton();
+
+          await smartSnippet.clickFeedbackModalDoneButton();
+
+          await search.mockSearchWithSmartSnippetResponse({
+            ...smartSnippetData,
+            question: 'new question',
+            answerSnippet: 'new answer',
+          });
+          const searchResponsePromise = search.waitForSearchResponse();
+          await search.performSearch();
+          await searchResponsePromise;
+
+          expect(smartSnippet.dislikeButton).not.toBeNull();
+          await smartSnippet.clickDislikeButton();
+          await expect(smartSnippet.explainWhyButton).toBeVisible();
+        });
+      });
+    });
+  });
+});

package/force-app/main/default/lwc/quanticSmartSnippetAnswer/__tests__/quanticSmartSnippetAnswer.test.js

@@ -0,0 +1,126 @@
+// @ts-ignore
+import {createElement} from 'lwc';
+import QuanticSmartSnippetAnswer from '../quanticSmartSnippetAnswer';
+
+const functionsMocks = {
+  exampleSelect: jest.fn(() => {}),
+  exampleBeginDelayedSelect: jest.fn(() => {}),
+  exampleCancelPendingSelect: jest.fn(() => {}),
+};
+
+const exampleAnswer =
+  '<div x-test_quanticsmartsnippetanswer=""><p x-test_quanticsmartsnippetanswer="">Example smart snippet answer</p><a href="#" x-test_quanticsmartsnippetanswer="">Example inline link</a></div>';
+const exampleAnswerWithInvalidLink =
+  '<div><a>Example invalid inline link</a></div>';
+const exampleActions = {
+  select: functionsMocks.exampleSelect,
+  beginDelayedSelect: functionsMocks.exampleBeginDelayedSelect,
+  cancelPendingSelect: functionsMocks.exampleCancelPendingSelect,
+};
+
+const defaultOptions = {
+  answer: exampleAnswer,
+  actions: exampleActions,
+};
+
+function createTestComponent(options = defaultOptions) {
+  const element = createElement('c-quantic-smart-snippet-answer', {
+    is: QuanticSmartSnippetAnswer,
+  });
+
+  for (const [key, value] of Object.entries(options)) {
+    element[key] = value;
+  }
+
+  document.body.appendChild(element);
+  return element;
+}
+
+// Helper function to wait until the microtask queue is empty.
+function flushPromises() {
+  return new Promise((resolve) => setTimeout(resolve, 0));
+}
+
+const bindingsMap = {
+  contextmenu: functionsMocks.exampleSelect,
+  click: functionsMocks.exampleSelect,
+  mouseup: functionsMocks.exampleSelect,
+  mousedown: functionsMocks.exampleSelect,
+  touchstart: functionsMocks.exampleBeginDelayedSelect,
+  touchend: functionsMocks.exampleCancelPendingSelect,
+};
+
+describe('c-quantic-smart-snippet-answer', () => {
+  function cleanup() {
+    // The jsdom instance is shared across test cases in a single file so reset the DOM
+    while (document.body.firstChild) {
+      document.body.removeChild(document.body.firstChild);
+    }
+    jest.clearAllMocks();
+  }
+
+  afterEach(() => {
+    cleanup();
+  });
+
+  it('should properly display the smart snippet answer', async () => {
+    const element = createTestComponent();
+    await flushPromises();
+
+    const answer = element.shadowRoot.querySelector('div > p');
+    expect(answer).not.toBeNull();
+
+    const answerLink = element.shadowRoot.querySelector('div > a');
+    expect(answerLink).not.toBeNull();
+
+    // eslint-disable-next-line @lwc/lwc/no-inner-html
+    expect(answer.innerHTML).toBe('Example smart snippet answer');
+
+    // eslint-disable-next-line @lwc/lwc/no-inner-html
+    expect(answerLink.innerHTML).toEqual('Example inline link');
+    expect(answerLink.target).toEqual('_blank');
+  });
+
+  describe('the analytics bindings of the inline links within the smart snippet answer', () => {
+    for (const [eventName, action] of Object.entries(bindingsMap)) {
+      it(`should execute the proper action when the ${eventName} is triggered`, async () => {
+        const element = createTestComponent();
+        await flushPromises();
+
+        const inlineLink = element.shadowRoot.querySelector('a');
+        inlineLink.dispatchEvent(new CustomEvent(eventName));
+
+        expect(action).toHaveBeenCalledTimes(1);
+      });
+
+      it(`should not execute the proper action when the ${eventName} is triggered on an invalid link`, async () => {
+        const element = createTestComponent({
+          ...defaultOptions,
+          answer: exampleAnswerWithInvalidLink,
+        });
+        await flushPromises();
+
+        const inlineLink = element.shadowRoot.querySelector('a');
+        inlineLink.dispatchEvent(new CustomEvent(eventName));
+
+        expect(action).toHaveBeenCalledTimes(0);
+      });
+    }
+  });
+
+  describe('when invalid inline links are returned in the answer of the smart snippet', () => {
+    it('should properly assign the disabled CSS class to the invalid inline link', async () => {
+      const element = createTestComponent({
+        ...defaultOptions,
+        answer: exampleAnswerWithInvalidLink,
+      });
+      await flushPromises();
+
+      const answer = element.shadowRoot.querySelector(
+        'div .inline-link--disabled'
+      );
+
+      expect(answer).not.toBeNull();
+    });
+  });
+});

package/force-app/main/default/lwc/quanticSmartSnippetSource/__tests__/quanticSmartSnippetSource.test.js

@@ -0,0 +1,290 @@
+import {
+  getNavigateCalledWith,
+  getGenerateUrlCalledWith,
+} from 'lightning/navigation';
+// @ts-ignore
+import {createElement} from 'lwc';
+import QuanticSmartSnippetSource from '../quanticSmartSnippetSource';
+
+const functionsMocks = {
+  exampleSelect: jest.fn(() => {}),
+  exampleBeginDelayedSelect: jest.fn(() => {}),
+  exampleCancelPendingSelect: jest.fn(() => {}),
+};
+
+const selectors = {
+  sourceUri: '.smart-snippet__source-uri',
+  sourceTitle: '.smart-snippet__source-title',
+};
+
+const exampleUri = 'https://www.example.com/';
+const exampleTitle = 'example label';
+const exampleActions = {
+  select: functionsMocks.exampleSelect,
+  beginDelayedSelect: functionsMocks.exampleBeginDelayedSelect,
+  cancelPendingSelect: functionsMocks.exampleCancelPendingSelect,
+};
+
+const defaultOptions = {
+  source: {
+    clickUri: exampleUri,
+    title: exampleTitle,
+  },
+  actions: exampleActions,
+};
+
+function createTestComponent(options = defaultOptions) {
+  const element = createElement('c-quantic-smart-snippet-source', {
+    is: QuanticSmartSnippetSource,
+  });
+
+  for (const [key, value] of Object.entries(options)) {
+    element[key] = value;
+  }
+
+  document.body.appendChild(element);
+  return element;
+}
+
+// Helper function to wait until the microtask queue is empty.
+function flushPromises() {
+  return new Promise((resolve) => setTimeout(resolve, 0));
+}
+
+const bindingsMap = {
+  contextmenu: functionsMocks.exampleSelect,
+  click: functionsMocks.exampleSelect,
+  mouseup: functionsMocks.exampleSelect,
+  mousedown: functionsMocks.exampleSelect,
+  touchstart: functionsMocks.exampleBeginDelayedSelect,
+  touchend: functionsMocks.exampleCancelPendingSelect,
+};
+
+describe('c-quantic-smart-snippet-source', () => {
+  function cleanup() {
+    // The jsdom instance is shared across test cases in a single file so reset the DOM
+    while (document.body.firstChild) {
+      document.body.removeChild(document.body.firstChild);
+    }
+    jest.clearAllMocks();
+  }
+
+  afterEach(() => {
+    cleanup();
+  });
+
+  it('should properly display the source uri', async () => {
+    const element = createTestComponent();
+    await flushPromises();
+
+    const sourceUri = element.shadowRoot.querySelector(selectors.sourceUri);
+
+    expect(sourceUri).not.toBeNull();
+    expect(sourceUri.textContent).toBe(exampleUri);
+    expect(sourceUri.href).toBe(exampleUri);
+  });
+
+  it('should target a new tab when clicked', async () => {
+    const element = createTestComponent();
+    await flushPromises();
+
+    const sourceUri = element.shadowRoot.querySelector(selectors.sourceUri);
+    const sourceTitle = element.shadowRoot.querySelector(selectors.sourceTitle);
+
+    expect(sourceUri).not.toBeNull();
+    expect(sourceUri.target).toBe('_blank');
+
+    expect(sourceTitle).not.toBeNull();
+    expect(sourceTitle.target).toBe('_blank');
+  });
+
+  it('should properly display the source title', async () => {
+    const element = createTestComponent();
+    await flushPromises();
+
+    const sourceTitle = element.shadowRoot.querySelector(selectors.sourceTitle);
+
+    expect(sourceTitle).not.toBeNull();
+    expect(sourceTitle.textContent).toBe(exampleTitle);
+    expect(sourceTitle.href).toBe(exampleUri);
+  });
+
+  it('should not display the source uri when the uri option is undefined', async () => {
+    const element = createTestComponent({
+      ...defaultOptions,
+      source: {
+        clickUri: undefined,
+        title: exampleTitle,
+      },
+    });
+    await flushPromises();
+
+    const sourceUri = element.shadowRoot.querySelector(selectors.sourceUri);
+
+    expect(sourceUri).toBeNull();
+  });
+
+  it('should not display the source title when the title option is undefined', async () => {
+    const element = createTestComponent({
+      ...defaultOptions,
+      source: {
+        clickUri: exampleUri,
+        title: undefined,
+      },
+    });
+    await flushPromises();
+
+    const sourceTitle = element.shadowRoot.querySelector(selectors.sourceTitle);
+
+    expect(sourceTitle).toBeNull();
+  });
+
+  ['sourceUri', 'sourceTitle'].forEach((key) => {
+    describe(`the analytics bindings of the ${key}`, () => {
+      for (const [eventName, action] of Object.entries(bindingsMap)) {
+        it(`should execute the proper action when the ${eventName} is triggered`, async () => {
+          const element = createTestComponent({
+            ...defaultOptions,
+            source: {
+              clickUri: '#',
+              title: exampleTitle,
+            },
+          });
+          await flushPromises();
+
+          const sourceUri = element.shadowRoot.querySelector(selectors[key]);
+          sourceUri.dispatchEvent(new CustomEvent(eventName));
+
+          expect(action).toHaveBeenCalledTimes(1);
+        });
+      }
+    });
+  });
+
+  describe('when the smart snippet source is of type Salesforce', () => {
+    const exampleSfid = '123';
+    const exampleSalesforceLink = 'https://www.example-salesforce.com/';
+
+    it('should call the navigation mixin to get the Salesforce record URL', async () => {
+      const element = createTestComponent({
+        ...defaultOptions,
+        source: {
+          clickUri: exampleUri,
+          title: exampleTitle,
+          raw: {
+            sfid: exampleSfid,
+          },
+        },
+      });
+      await flushPromises();
+
+      const sourceTitle = element.shadowRoot.querySelector(
+        selectors.sourceTitle
+      );
+      const sourceUri = element.shadowRoot.querySelector(selectors.sourceUri);
+      const {pageReference} = getGenerateUrlCalledWith();
+
+      expect(pageReference.attributes.recordId).toBe(exampleSfid);
+      expect(sourceTitle.href).toBe(exampleSalesforceLink);
+      expect(sourceUri.href).toBe(exampleSalesforceLink);
+    });
+
+    it('should open the source link inside Salesforce after clicking the source title', async () => {
+      const element = createTestComponent({
+        ...defaultOptions,
+        source: {
+          clickUri: exampleUri,
+          title: exampleTitle,
+          raw: {
+            sfid: exampleSfid,
+          },
+        },
+      });
+      await flushPromises();
+
+      const sourceTitle = element.shadowRoot.querySelector(
+        selectors.sourceTitle
+      );
+      sourceTitle.click();
+
+      const {pageReference} = getNavigateCalledWith();
+
+      expect(pageReference.attributes.recordId).toBe(exampleSfid);
+    });
+
+    it('should open the source link inside Salesforce after clicking the source uri', async () => {
+      const element = createTestComponent({
+        ...defaultOptions,
+        source: {
+          clickUri: exampleUri,
+          title: exampleTitle,
+          raw: {
+            sfid: exampleSfid,
+          },
+        },
+      });
+      await flushPromises();
+
+      const sourceUri = element.shadowRoot.querySelector(selectors.sourceUri);
+      sourceUri.click();
+
+      const {pageReference} = getNavigateCalledWith();
+
+      expect(pageReference.attributes.recordId).toBe(exampleSfid);
+    });
+
+    describe('when the result is a knowledge article', () => {
+      it('should open the source link inside Salesforce after clicking the source title', async () => {
+        const exampleSfkavid = 'bar';
+        const element = createTestComponent({
+          ...defaultOptions,
+          source: {
+            clickUri: exampleUri,
+            title: exampleTitle,
+            raw: {
+              sfid: exampleSfid,
+              sfkbid: 'foo',
+              sfkavid: exampleSfkavid,
+            },
+          },
+        });
+        await flushPromises();
+
+        const sourceTitle = element.shadowRoot.querySelector(
+          selectors.sourceTitle
+        );
+        sourceTitle.click();
+
+        const {pageReference} = getNavigateCalledWith();
+
+        expect(pageReference.attributes.recordId).toBe(exampleSfkavid);
+        expect(sourceTitle.href).toBe(exampleSalesforceLink);
+      });
+
+      it('should open the source link inside Salesforce after clicking the source uri', async () => {
+        const exampleSfkavid = 'bar';
+        const element = createTestComponent({
+          ...defaultOptions,
+          source: {
+            clickUri: exampleUri,
+            title: exampleTitle,
+            raw: {
+              sfid: exampleSfid,
+              sfkbid: 'foo',
+              sfkavid: exampleSfkavid,
+            },
+          },
+        });
+        await flushPromises();
+
+        const sourceUri = element.shadowRoot.querySelector(selectors.sourceUri);
+        sourceUri.click();
+
+        const {pageReference} = getNavigateCalledWith();
+
+        expect(pageReference.attributes.recordId).toBe(exampleSfkavid);
+        expect(sourceUri.href).toBe(exampleSalesforceLink);
+      });
+    });
+  });
+});