@coveo/quantic 3.33.0 → 3.33.1

package/force-app/main/default/lwc/quanticNumericFacet/e2e/data.ts

@@ -0,0 +1,28 @@
+const facetData = {
+  domain: {
+    start: 0,
+    end: 200,
+  },
+  facetId: 'ytlikecount',
+  field: 'ytlikecount',
+  moreValuesAvailable: false,
+  values: [
+    {
+      start: 0,
+      end: 100,
+      endInclusive: false,
+      state: 'idle',
+      numberOfResults: 10,
+    },
+    {
+      start: 100,
+      end: 200,
+      endInclusive: false,
+      state: 'idle',
+      numberOfResults: 20,
+    },
+  ],
+  indexScore: 0.4,
+};
+
+export default facetData;

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

@@ -0,0 +1,71 @@
+import {NumericFacetObject} from './pageObject';
+import {useCaseEnum} from '../../../../../../playwright/utils/useCase';
+import {InsightSetupObject} from '../../../../../../playwright/page-object/insightSetupObject';
+import {
+  searchRequestRegex,
+  insightSearchRequestRegex,
+} from '../../../../../../playwright/utils/requests';
+import {BaseFacetObject} from '../../../../../../playwright/page-object/baseFacetObject';
+import facetData from './data';
+import {facetBase} from '../../../../../../playwright/fixtures/baseFacetFixture';
+
+const pageUrl = 's/quantic-numeric-facet';
+
+interface FacetOptions {
+  withInput: boolean;
+}
+
+type QuanticNumericFacetE2EFixtures = {
+  facet: NumericFacetObject;
+  options: Partial<FacetOptions>;
+  insightSetup?: InsightSetupObject;
+};
+
+export const testSearch = facetBase.extend<QuanticNumericFacetE2EFixtures>({
+  options: {withInput: true},
+  facetResponseMock: [facetData],
+  baseFacet: async ({page}, use) => {
+    await use(new BaseFacetObject(page, searchRequestRegex));
+  },
+  facet: async (
+    {page, options, configuration, baseFacet, urlHash, facetResponseMock},
+    use
+  ) => {
+    await page.goto(`${pageUrl}#${urlHash ? urlHash : ''}`);
+    if (facetResponseMock) {
+      await baseFacet.mockSearchWithFacetResponse(facetResponseMock);
+    }
+
+    configuration.configure(options);
+    await baseFacet.waitForSearchResponse();
+
+    await use(new NumericFacetObject(page));
+  },
+});
+
+export const testInsight = facetBase.extend<QuanticNumericFacetE2EFixtures>({
+  options: {withInput: true},
+  facetResponseMock: [facetData],
+  baseFacet: async ({page}, use) => {
+    await use(new BaseFacetObject(page, insightSearchRequestRegex));
+  },
+  insightSetup: async ({page}, use) => {
+    await use(new InsightSetupObject(page));
+  },
+  facet: async (
+    {page, options, baseFacet, configuration, insightSetup, facetResponseMock},
+    use
+  ) => {
+    await page.goto(pageUrl);
+    if (facetResponseMock) {
+      await baseFacet.mockSearchWithFacetResponse(facetResponseMock);
+    }
+    configuration.configure({...options, useCase: useCaseEnum.insight});
+    await insightSetup?.waitForInsightInterfaceInitialization();
+    await baseFacet.performSearch();
+    await baseFacet.waitForSearchResponse();
+    await use(new NumericFacetObject(page));
+  },
+});
+
+export {expect} from '@playwright/test';

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

@@ -0,0 +1,59 @@
+import type {Locator, Page} from '@playwright/test';
+
+export class NumericFacetObject {
+  constructor(public page: Page) {
+    this.page = page;
+  }
+
+  get facet(): Locator {
+    return this.page.locator('c-quantic-numeric-facet');
+  }
+
+  get facetValue(): Locator {
+    return this.facet.getByTestId('facet__value');
+  }
+
+  get facetValueInput(): Locator {
+    return this.facet.getByRole('checkbox', {name: 'Facet value option'});
+  }
+
+  get filterMinInput(): Locator {
+    return this.facet.getByRole('spinbutton', {
+      name: /enter a minimum numerical value for the .* facet/i,
+    });
+  }
+
+  get filterMaxInput(): Locator {
+    return this.facet.getByRole('spinbutton', {
+      name: /enter a maximum numerical value for the .* facet/i,
+    });
+  }
+
+  get filterApplyButton(): Locator {
+    return this.facet.getByRole('button', {name: /apply/i});
+  }
+
+  get clearSelectionButton(): Locator {
+    return this.page.getByTestId('clear-selection-button');
+  }
+
+  async clickOnFacetValue(index: number): Promise<void> {
+    await this.facetValue.nth(index).click();
+  }
+
+  async fillFilterMinInput(min: string): Promise<void> {
+    await this.filterMinInput.fill(min);
+  }
+
+  async fillFilterMaxInput(max: string): Promise<void> {
+    await this.filterMaxInput.fill(max);
+  }
+
+  async clickOnFilterApplyButton(): Promise<void> {
+    await this.filterApplyButton.click();
+  }
+
+  async clickOnClearSelectionButton(): Promise<void> {
+    await this.clearSelectionButton.click();
+  }
+}

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

@@ -0,0 +1,164 @@
+import {testSearch, testInsight, expect} from './fixture';
+import {
+  useCaseEnum,
+  useCaseTestCases,
+} from '../../../../../../playwright/utils/useCase';
+import facetData from './data';
+
+const fixtures = {
+  search: testSearch,
+  insight: testInsight,
+};
+
+useCaseTestCases.forEach((useCase) => {
+  let test = fixtures[useCase.value];
+  test.describe(`quantic numeric facet ${useCase.label}`, () => {
+    test.describe('when selecting and deselecting a facet value', () => {
+      test('should trigger a new search and log the corresponding UA analytics events', async ({
+        baseFacet,
+        facet,
+      }) => {
+        const selectedIndex = 0;
+        const {facetId, field, values} = facetData;
+        const expectedFacetData = {
+          facetId,
+          facetField: field,
+          facetValue: `${values[selectedIndex].start}..${values[selectedIndex].end}`,
+        };
+        const facetSelectUaRequest =
+          baseFacet.waitForFacetSelectUaAnalytics(expectedFacetData);
+        const firstSearchResponsePromise = baseFacet.waitForSearchResponse();
+
+        await facet.clickOnFacetValue(selectedIndex);
+
+        await facetSelectUaRequest;
+        const firstSearchResponse = await firstSearchResponsePromise;
+        const {analytics: analyticsForFacetSelect} =
+          baseFacet.extractDataFromResponse(firstSearchResponse);
+        expect(analyticsForFacetSelect.actionCause).toEqual('facetSelect');
+        if (useCase.value === useCaseEnum.search) {
+          expect(analyticsForFacetSelect.customData).toEqual(
+            expect.objectContaining(expectedFacetData)
+          );
+        }
+
+        const facetDeselectUaRequest =
+          baseFacet.waitForFacetDeselectUaAnalytics({
+            facetId,
+            facetField: field,
+            facetValue: `${values[selectedIndex].start}..${values[selectedIndex].end}`,
+          });
+        const secondSearchResponsePromise = baseFacet.waitForSearchResponse();
+
+        await facet.clickOnFacetValue(selectedIndex);
+
+        await facetDeselectUaRequest;
+        const secondSearchResponse = await secondSearchResponsePromise;
+        const {analytics: analyticsForFacetDeselect} =
+          baseFacet.extractDataFromResponse(secondSearchResponse);
+        expect(analyticsForFacetDeselect.actionCause).toEqual('facetDeselect');
+      });
+    });
+
+    test.describe('when selecting a facet value and clicking the clear filter button', () => {
+      test('should trigger a new search and log the corresponding UA analytics events', async ({
+        baseFacet,
+        facet,
+      }) => {
+        const selectedIndex = 0;
+        const {facetId, field, values} = facetData;
+        const expectedFacetData = {
+          facetId,
+          facetField: field,
+          facetValue: `${values[selectedIndex].start}..${values[selectedIndex].end}`,
+        };
+
+        const facetSelectUaRequest =
+          baseFacet.waitForFacetSelectUaAnalytics(expectedFacetData);
+        const firstSearchResponsePromise = baseFacet.waitForSearchResponse();
+
+        await facet.clickOnFacetValue(selectedIndex);
+
+        await facetSelectUaRequest;
+        const firstSearchResponse = await firstSearchResponsePromise;
+        const {analytics: analyticsForFacetSelect} =
+          baseFacet.extractDataFromResponse(firstSearchResponse);
+        expect(analyticsForFacetSelect.actionCause).toEqual('facetSelect');
+        if (useCase.value === useCaseEnum.search) {
+          expect(analyticsForFacetSelect.customData).toEqual(
+            expect.objectContaining(expectedFacetData)
+          );
+        }
+
+        const clearAllUaRequest = baseFacet.waitForFacetClearAllUaAnalytics({
+          facetId,
+          facetField: field,
+        });
+        const secondSearchResponsePromise = baseFacet.waitForSearchResponse();
+
+        await facet.clickOnClearSelectionButton();
+
+        await clearAllUaRequest;
+        const secondSearchResponse = await secondSearchResponsePromise;
+        const {analytics: analyticsForFacetDeselect} =
+          baseFacet.extractDataFromResponse(secondSearchResponse);
+        expect(analyticsForFacetDeselect.actionCause).toEqual('facetClearAll');
+      });
+    });
+
+    test.describe('when typing in the facet search box input', () => {
+      test('should fetch facet values according to the query typed', async ({
+        baseFacet,
+        facet,
+      }) => {
+        const exampleMin = '1';
+        const exampleMax = '2';
+        const {facetId, field} = facetData;
+        const expectedFacetData = {
+          facetId: `${facetId}_input`,
+          facetField: field,
+          facetValue: `${exampleMin}..${exampleMax}`,
+        };
+
+        const facetSelectUaRequest =
+          baseFacet.waitForFacetSelectUaAnalytics(expectedFacetData);
+        const searchResponsePromise = baseFacet.waitForSearchResponse();
+
+        await facet.fillFilterMinInput(exampleMin);
+        await facet.fillFilterMaxInput(exampleMax);
+        await facet.clickOnFilterApplyButton();
+
+        await facetSelectUaRequest;
+        const searchResponse = await searchResponsePromise;
+        const {analytics: analyticsForFacetSelect} =
+          baseFacet.extractDataFromResponse(searchResponse);
+        expect(analyticsForFacetSelect.actionCause).toEqual('facetSelect');
+        if (useCase.value === useCaseEnum.search) {
+          expect(analyticsForFacetSelect.customData).toEqual(
+            expect.objectContaining(expectedFacetData)
+          );
+        }
+      });
+    });
+
+    if (useCase.value === useCaseEnum.search) {
+      test.describe('with a selected value in the URL', () => {
+        const selectedIndex = 0;
+        const {field, values} = facetData;
+        test.use({
+          urlHash: `nf-${field}=${values[selectedIndex].start}...${values[selectedIndex].end}`,
+          facetResponseMock: undefined,
+        });
+
+        test('should select the correct facet value', async ({facet}) => {
+          await expect(facet.facetValueInput.nth(selectedIndex)).toBeChecked();
+          expect(facet.facetValue.nth(selectedIndex)).toHaveText(
+            new RegExp(
+              `${values[selectedIndex].start} - ${values[selectedIndex].end}`
+            )
+          );
+        });
+      });
+    }
+  });
+});