@coveo/quantic 3.14.0 → 3.14.1

package/docs/out/quantic-docs.json

@@ -1022,6 +1022,15 @@
                         "defaultValue": "{false}",
                         "type": "boolean"
                     },
+                    {
+                        "name": "answerConfigurationId",
+                        "attribute": "answer-configuration-id",
+                        "access": "@api",
+                        "description": "<p>The unique identifier of the answer configuration to use to generate the answer.</p>",
+                        "required": true,
+                        "defaultValue": "",
+                        "type": "string"
+                    },
                     {
                         "name": "maxCollapsedHeight",
                         "attribute": "max-collapsed-height",

package/force-app/main/default/lwc/quanticFeedbackModal/success.html

@@ -9,6 +9,6 @@
     </div>
   </lightning-modal-body>
   <lightning-modal-footer>
-    <lightning-button data-cy="feedback-modal-footer__done" variant="brand" label={labels.done} onclick={closeModal}></lightning-button>
+    <lightning-button data-testid="feedback-modal-footer__done" variant="brand" label={labels.done} onclick={closeModal}></lightning-button>
   </lightning-modal-footer>
 </template>

package/force-app/main/default/lwc/quanticFeedbackModalQna/templates/success.html

@@ -13,7 +13,7 @@
   </lightning-modal-body>
   <lightning-modal-footer>
     <lightning-button
-      data-cy="feedback-modal-footer__done"
+      data-testid="feedback-modal-footer__done"
       variant="brand"
       label={labels.done}
       onclick={closeModal}

package/force-app/main/default/lwc/quanticGeneratedAnswer/quanticGeneratedAnswer.js

@@ -85,8 +85,8 @@ export default class QuanticGeneratedAnswer extends LightningElement {
    */
   @api withToggle = false;
   /**
-   * @internal
    * The unique identifier of the answer configuration to use to generate the answer.
+   * @api
    * @type {string}
    */
   @api answerConfigurationId;

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

@@ -337,21 +337,5 @@ describe('c-quantic-smart-snippet', () => {
         });
       });
     });
-
-    describe('when interacting with the feedback modal', () => {
-      describe('when trying to open the feedback modal after executing the same query', () => {
-        // eslint-disable-next-line jest/no-disabled-tests, jest/expect-expect
-        it.skip('should not open the feedback modal', async () => {
-          // TODO: Implement this test - SFINT-5933
-        });
-      });
-
-      describe('when trying to open the feedback modal after executing a query that gave a new answer', () => {
-        // eslint-disable-next-line jest/no-disabled-tests, jest/expect-expect
-        it.skip('should open the feedback modal', async () => {
-          // TODO: Implement this test - SFINT-5933
-        });
-      });
-    });
   });
 });

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

@@ -45,6 +45,10 @@ export class SmartSnippetObject {
     return this.page.getByTestId('feedback-modal-footer__cancel');
   }
 
+  get feedbackModalDoneButton(): Locator {
+    return this.page.getByTestId('feedback-modal-footer__done');
+  }
+
   get firstFeedbackOptionLabel(): Locator {
     const labelFirstOption = "Didn't answer my question at all";
     return this.page.getByText(labelFirstOption);
@@ -94,6 +98,10 @@ export class SmartSnippetObject {
     await this.feedbackSubmitButton.click();
   }
 
+  async clickFeedbackModalDoneButton(): Promise<void> {
+    await this.feedbackModalDoneButton.click();
+  }
+
   async waitForExpandSmartSnippetUaAnalytics(): Promise<Request> {
     return this.waitForSmartSnippetCustomUaAnalytics('expandSmartSnippet');
   }

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

@@ -1,5 +1,6 @@
-import {testSearch, testInsight} from './fixture';
+import {testSearch, testInsight, expect} from './fixture';
 import {useCaseTestCases} from '../../../../../../playwright/utils/useCase';
+import smartSnippetData from './data';
 
 const maximumSnippetHeight = 250;
 
@@ -113,6 +114,55 @@ useCaseTestCases.forEach((useCase) => {
           });
         });
       });
+
+      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,
+        }) => {
+          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();
+          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,
+        }) => {
+          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();
+          expect(smartSnippet.explainWhyButton).toBeVisible();
+        });
+      });
     });
   });
 });

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

@@ -5,6 +5,13 @@ import QuanticSort from 'c/quanticSort';
 import {createElement} from 'lwc';
 import * as mockHeadlessLoader from 'c/quanticHeadlessLoader';
 
+const selectors = {
+  lightningCombobox: 'lightning-combobox',
+  componentError: 'c-quantic-component-error',
+  sortDropdown: '[data-testid="sort-dropdown"]',
+  initializationError: 'c-quantic-component-error',
+};
+
 const sortVariants = {
   default: {
     name: 'default',
@@ -20,25 +27,40 @@ const sortVariants = {
   },
 };
 
+const sortByLabel = 'Sort By';
+
 jest.mock('c/quanticHeadlessLoader');
-jest.mock('@salesforce/label/c.quantic_SortBy', () => ({default: 'Sort By'}), {
-  virtual: true,
-});
+jest.mock(
+  '@salesforce/label/c.quantic_SortBy',
+  () => ({default: sortByLabel}),
+  {
+    virtual: true,
+  }
+);
 
-function mockBueno() {
-  jest.spyOn(mockHeadlessLoader, 'getBueno').mockReturnValue(
-    new Promise(() => {
-      // @ts-ignore
-      global.Bueno = {
-        isString: jest
-          .fn()
-          .mockImplementation(
-            (value) =>
-              Object.prototype.toString.call(value) === '[object String]'
-          ),
-      };
-    })
-  );
+function mockBueno(shouldError = false) {
+  // @ts-ignore
+  mockHeadlessLoader.getBueno = () => {
+    // @ts-ignore
+    global.Bueno = {
+      isString: jest
+        .fn()
+        .mockImplementation(
+          (value) => Object.prototype.toString.call(value) === '[object String]'
+        ),
+      StringValue: jest.fn(),
+      RecordValue: jest.fn(),
+      Schema: jest.fn(() => ({
+        validate: () => {
+          if (shouldError) {
+            throw new Error();
+          }
+          jest.fn();
+        },
+      })),
+    };
+    return new Promise((resolve) => resolve());
+  };
 }
 
 let isInitialized = false;
@@ -47,32 +69,35 @@ const exampleEngine = {
   id: 'exampleEngineId',
 };
 
-const mockSearchStatusState = {
+const defaultSearchStatusState = {
   hasResults: true,
 };
-
-const mockSearchStatus = {
-  state: mockSearchStatusState,
-  subscribe: jest.fn((callback) => {
-    callback();
-    return jest.fn();
-  }),
-};
+let searchStatusState = defaultSearchStatusState;
 
 const functionsMocks = {
   buildSort: jest.fn(() => ({
     state: {},
-    subscribe: functionsMocks.subscribe,
+    subscribe: functionsMocks.sortStateSubscriber,
+    sortBy: functionsMocks.sortBy,
+  })),
+  buildSearchStatus: jest.fn(() => ({
+    state: searchStatusState,
+    subscribe: functionsMocks.searchStatusStateSubscriber,
   })),
   buildCriterionExpression: jest.fn((criterion) => criterion),
   buildRelevanceSortCriterion: jest.fn(() => 'relevance'),
   buildDateSortCriterion: jest.fn(() => 'date'),
-  buildSearchStatus: jest.fn(() => mockSearchStatus),
-  subscribe: jest.fn((cb) => {
+  sortStateSubscriber: jest.fn((cb) => {
     cb();
-    return functionsMocks.unsubscribe;
+    return functionsMocks.sortStateUnsubscriber;
   }),
-  unsubscribe: jest.fn(() => {}),
+  searchStatusStateSubscriber: jest.fn((cb) => {
+    cb();
+    return functionsMocks.searchStatusStateUnsubscriber;
+  }),
+  sortStateUnsubscriber: jest.fn(),
+  searchStatusStateUnsubscriber: jest.fn(),
+  sortBy: jest.fn(),
 };
 
 const defaultOptions = {
@@ -80,10 +105,19 @@ const defaultOptions = {
   variant: 'default',
 };
 
-const expectedSortByLabel = 'Sort By';
+/**
+ * Mocks the return value of the assignedNodes method.
+ * @param {Array<Element>} assignedElements
+ */
+function mockSlotAssignedNodes(assignedElements) {
+  HTMLSlotElement.prototype.assignedNodes = function () {
+    return assignedElements;
+  };
+}
 
-function createTestComponent(options = defaultOptions) {
+function createTestComponent(options = defaultOptions, assignedElements = []) {
   prepareHeadlessState();
+  mockSlotAssignedNodes(assignedElements);
 
   const element = createElement('c-quantic-sort', {
     is: QuanticSort,
@@ -128,6 +162,15 @@ function mockSuccessfulHeadlessInitialization() {
   };
 }
 
+function mockErroneousHeadlessInitialization() {
+  // @ts-ignore
+  mockHeadlessLoader.initializeWithHeadless = (element) => {
+    if (element instanceof QuanticSort) {
+      element.setInitializationError();
+    }
+  };
+}
+
 function cleanup() {
   // The jsdom instance is shared across test cases in a single file so reset the DOM
   while (document.body.firstChild) {
@@ -145,14 +188,152 @@ describe('c-quantic-sort', () => {
 
   afterEach(() => {
     cleanup();
+    searchStatusState = defaultSearchStatusState;
+  });
+
+  describe('when an initialization error occurs', () => {
+    beforeEach(() => {
+      mockErroneousHeadlessInitialization();
+    });
+
+    it('should display the initialization error component', async () => {
+      const element = createTestComponent();
+      await flushPromises();
+
+      const initializationError = element.shadowRoot.querySelector(
+        selectors.initializationError
+      );
+
+      expect(initializationError).not.toBeNull();
+    });
   });
 
   describe('controller initialization', () => {
-    it('should subscribe to the headless state changes', async () => {
+    it('should subscribe to the headless sort and search status state changes', async () => {
       createTestComponent();
       await flushPromises();
 
-      expect(functionsMocks.subscribe).toHaveBeenCalledTimes(1);
+      expect(functionsMocks.sortStateSubscriber).toHaveBeenCalledTimes(1);
+      expect(functionsMocks.searchStatusStateSubscriber).toHaveBeenCalledTimes(
+        1
+      );
+    });
+  });
+
+  describe('when no results are found', () => {
+    beforeAll(() => {
+      searchStatusState = {...defaultSearchStatusState, hasResults: false};
+    });
+
+    it('should not display the sort dropdown', async () => {
+      const element = createTestComponent();
+      await flushPromises();
+
+      const sortDropdown = element.shadowRoot.querySelector(
+        selectors.sortDropdown
+      );
+
+      expect(sortDropdown).toBeNull();
+    });
+  });
+
+  describe('when a sort option is selected', () => {
+    it('should call the sortBy method of the sort controller', async () => {
+      const element = createTestComponent();
+      await flushPromises();
+
+      const lightningCombobox = element.shadowRoot.querySelector(
+        selectors.lightningCombobox
+      );
+      const exampleDefaultSortOptionValue = 'relevance';
+      expect(lightningCombobox).not.toBeNull();
+
+      lightningCombobox.dispatchEvent(
+        new CustomEvent('change', {
+          detail: {value: exampleDefaultSortOptionValue},
+        })
+      );
+
+      expect(functionsMocks.sortBy).toHaveBeenCalledTimes(1);
+      expect(functionsMocks.sortBy).toHaveBeenCalledWith(
+        exampleDefaultSortOptionValue
+      );
+    });
+  });
+
+  describe('when custom sort options are passed', () => {
+    const exampleSlot = {
+      value: 'example value',
+      label: 'example label',
+      criterion: {
+        by: 'example field',
+        order: 'example order',
+      },
+    };
+    const exampleAssignedElements = [exampleSlot];
+
+    it('should build the controller with the correct sort option and display the custom sort options', async () => {
+      const element = createTestComponent(
+        defaultOptions,
+        exampleAssignedElements
+      );
+      await flushPromises();
+
+      expect(functionsMocks.buildSort).toHaveBeenCalledTimes(1);
+      expect(functionsMocks.buildSort).toHaveBeenCalledWith(exampleEngine, {
+        initialState: {
+          criterion: {
+            by: 'example field',
+            order: 'example order',
+          },
+        },
+      });
+      const lightningCombobox = element.shadowRoot.querySelector(
+        selectors.lightningCombobox
+      );
+
+      expect(lightningCombobox.options).toEqual([exampleSlot]);
+    });
+  });
+
+  describe('when invalid sort options are passed', () => {
+    beforeEach(() => {
+      mockBueno(true);
+      jest.spyOn(console, 'error').mockImplementation(() => {});
+    });
+
+    const invalidExampleSlot = {
+      value: 'example value',
+      label: '',
+      criterion: {
+        by: 'example field',
+        order: 'example order',
+      },
+    };
+    const exampleAssignedElements = [invalidExampleSlot];
+
+    it('should display the component error', async () => {
+      const element = createTestComponent(
+        defaultOptions,
+        exampleAssignedElements
+      );
+      await flushPromises();
+
+      expect(functionsMocks.buildSort).toHaveBeenCalledTimes(1);
+      expect(functionsMocks.buildSort).toHaveBeenCalledWith(exampleEngine, {
+        initialState: {
+          criterion: {
+            by: 'example field',
+            order: 'example order',
+          },
+        },
+      });
+      const componentError = element.shadowRoot.querySelector(
+        selectors.componentError
+      );
+
+      expect(componentError).not.toBeNull();
+      expect(console.error).toHaveBeenCalledTimes(1);
     });
   });
 
@@ -187,7 +368,7 @@ describe('c-quantic-sort', () => {
 
       const sortLabel = element.shadowRoot.querySelector(variant.labelSelector);
 
-      expect(sortLabel.value).toBe(expectedSortByLabel);
+      expect(sortLabel.value).toBe(sortByLabel);
     });
   });
 
@@ -228,7 +409,7 @@ describe('c-quantic-sort', () => {
 
       const sortLabel = element.shadowRoot.querySelector(variant.labelSelector);
 
-      expect(sortLabel.textContent).toBe(expectedSortByLabel);
+      expect(sortLabel.textContent).toBe(sortByLabel);
       expect(sortLabel.classList).toContain('slds-text-heading_small');
     });
   });

package/force-app/main/default/lwc/quanticSort/e2e/fixture.ts

@@ -0,0 +1,61 @@
+import {SortObject} from './pageObject';
+import {quanticBase} from '../../../../../../playwright/fixtures/baseFixture';
+import {SearchObject} from '../../../../../../playwright/page-object/searchObject';
+import {
+  searchRequestRegex,
+  insightSearchRequestRegex,
+} from '../../../../../../playwright/utils/requests';
+import {InsightSetupObject} from '../../../../../../playwright/page-object/insightSetupObject';
+import {useCaseEnum} from '../../../../../../playwright/utils/useCase';
+
+const sortUrl = 's/quantic-sort';
+
+interface SortOptions {}
+
+type QuanticSortE2EFixtures = {
+  sort: SortObject;
+  search: SearchObject;
+  options: Partial<SortOptions>;
+};
+
+type QuanticSortE2ESearchFixtures = QuanticSortE2EFixtures & {
+  urlHash: string;
+};
+
+type QuanticSortE2EInsightFixtures = QuanticSortE2EFixtures & {
+  insightSetup: InsightSetupObject;
+};
+
+export const testSearch = quanticBase.extend<QuanticSortE2ESearchFixtures>({
+  options: {},
+  urlHash: '',
+  search: async ({page}, use) => {
+    await use(new SearchObject(page, searchRequestRegex));
+  },
+  sort: async ({page, options, configuration, search, urlHash}, use) => {
+    await page.goto(urlHash ? `${sortUrl}#${urlHash}` : sortUrl);
+    configuration.configure(options);
+    await search.waitForSearchResponse();
+    await use(new SortObject(page));
+  },
+});
+
+export const testInsight = quanticBase.extend<QuanticSortE2EInsightFixtures>({
+  options: {},
+  search: async ({page}, use) => {
+    await use(new SearchObject(page, insightSearchRequestRegex));
+  },
+  insightSetup: async ({page}, use) => {
+    await use(new InsightSetupObject(page));
+  },
+  sort: async ({page, options, search, configuration, insightSetup}, use) => {
+    await page.goto(sortUrl);
+    configuration.configure({...options, useCase: useCaseEnum.insight});
+    await insightSetup.waitForInsightInterfaceInitialization();
+    await search.performSearch();
+    await search.waitForSearchResponse();
+    await use(new SortObject(page));
+  },
+});
+
+export {expect} from '@playwright/test';

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

@@ -0,0 +1,89 @@
+import type {Locator, Page, Request} from '@playwright/test';
+import {isUaSearchEvent} from '../../../../../../playwright/utils/requests';
+
+export class SortObject {
+  constructor(public page: Page) {
+    this.page = page;
+  }
+
+  get sortDropDown(): Locator {
+    return this.page.getByRole('combobox', {name: 'Sort by'});
+  }
+
+  get sortPreviewButton(): Locator {
+    return this.page.getByRole('button', {name: 'Preview'});
+  }
+
+  sortButton(buttonName: string): Locator {
+    return this.page.getByRole('option', {name: buttonName});
+  }
+
+  async clickSortDropDown(): Promise<void> {
+    await this.sortDropDown.click();
+  }
+
+  async focusSortDropDown(): Promise<void> {
+    await this.sortPreviewButton.click();
+    await this.page.keyboard.press('Tab');
+  }
+
+  async clickSortButton(buttonName: string): Promise<void> {
+    await this.sortButton(buttonName).click();
+  }
+
+  async openSortDropdownUsingKeyboardEnter(useEnter = true): Promise<void> {
+    if (useEnter) {
+      await this.page.keyboard.press('Enter');
+    } else {
+      await this.page.keyboard.press('Space');
+    }
+    await this.sortButton('Oldest').isVisible();
+    await this.page.waitForTimeout(500);
+  }
+
+  async waitForSortUaAnalytics(eventValue: any): Promise<Request> {
+    const uaRequest = this.page.waitForRequest((request) => {
+      if (isUaSearchEvent(request)) {
+        const requestBody = request.postDataJSON();
+        const expectedFields = {
+          actionCause: 'resultsSort',
+          customData: {
+            resultsSortBy: eventValue,
+          },
+        };
+
+        const validateObject = (obj: any, expectedResult: any): boolean =>
+          Object.entries(expectedResult).every(([key, value]) =>
+            value && typeof value === 'object'
+              ? validateObject(obj?.[key], value)
+              : obj?.[key] === value
+          );
+
+        return validateObject(requestBody, expectedFields);
+      }
+      return false;
+    });
+    return uaRequest;
+  }
+
+  async allSortLabelOptions() {
+    const options = await this.page
+      .locator('div[part="dropdown overlay"]')
+      .allInnerTexts();
+    const arrSort = options[0].split('\n');
+    return arrSort;
+  }
+
+  async getSortLabelValue() {
+    const arrSort = await this.allSortLabelOptions();
+    const sortLabelwithValueList = await Promise.all(
+      arrSort.map(async (item) => ({
+        label: item,
+        value: await this.page
+          .getByRole('option', {name: item})
+          .getAttribute('data-value'),
+      }))
+    );
+    return sortLabelwithValueList;
+  }
+}