@coveo/quantic 3.33.0 → 3.33.1

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

@@ -0,0 +1,27 @@
+const facetData = {
+  facetId: 'geographicalhierarchy',
+  field: 'geographicalhierarchy',
+  moreValuesAvailable: true,
+  values: [
+    {
+      value: 'North America',
+      state: 'idle',
+      numberOfResults: 112,
+      children: [],
+      path: ['North America'],
+      isLeafValue: false,
+    },
+    {
+      value: 'Africa',
+      state: 'idle',
+      numberOfResults: 58,
+      children: [],
+      path: ['Africa'],
+      isLeafValue: false,
+    },
+  ],
+  indexScore: 0.40500903971252294,
+  label: 'Object type',
+};
+
+export default facetData;

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

@@ -0,0 +1,75 @@
+import {CategoryFacetObject} 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-category-facet';
+
+interface FacetOptions {
+  value?: string;
+  caption?: string;
+  withSearch?: boolean;
+  numberOfValues?: number;
+}
+
+type QuanticFacetE2EFixtures = {
+  facet: CategoryFacetObject;
+  options: Partial<FacetOptions>;
+  insightSetup?: InsightSetupObject;
+};
+
+export const testSearch = facetBase.extend<QuanticFacetE2EFixtures>({
+  options: {},
+  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}${options.caption ? '-with-captions' : ''}#${urlHash ? urlHash : ''}`
+    );
+    if (facetResponseMock) {
+      await baseFacet.mockSearchWithFacetResponse(facetResponseMock);
+    }
+    configuration.configure(options);
+    await baseFacet.waitForSearchResponse();
+
+    await use(new CategoryFacetObject(page));
+  },
+});
+
+export const testInsight = facetBase.extend<QuanticFacetE2EFixtures>({
+  options: {},
+  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}${options.caption ? '-with-captions' : ''}`);
+    if (facetResponseMock) {
+      await baseFacet.mockSearchWithFacetResponse(facetResponseMock);
+    }
+    configuration.configure({...options, useCase: useCaseEnum.insight});
+    await insightSetup?.waitForInsightInterfaceInitialization();
+    await baseFacet.performSearch();
+    await baseFacet.waitForSearchResponse();
+    await use(new CategoryFacetObject(page));
+  },
+});
+
+export {expect} from '@playwright/test';

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

@@ -0,0 +1,55 @@
+import type {Locator, Page} from '@playwright/test';
+
+export class CategoryFacetObject {
+  constructor(public page: Page) {
+    this.page = page;
+  }
+
+  get facet(): Locator {
+    return this.page.locator('c-quantic-category-facet');
+  }
+
+  get facetValue(): Locator {
+    return this.facet.locator('c-quantic-category-facet-value');
+  }
+
+  get activeParent(): Locator {
+    return this.facet.getByTestId('facet__active-parent');
+  }
+
+  get allCategoriesButton(): Locator {
+    return this.facet.getByRole('button', {name: /all categories/i});
+  }
+
+  get showMoreFacetValuesButton(): Locator {
+    return this.facet.getByRole('button', {
+      name: /Show more values for the .* facet/i,
+    });
+  }
+
+  get showLessFacetValuesButton(): Locator {
+    return this.facet.getByRole('button', {
+      name: /Show less values for the .* facet/i,
+    });
+  }
+
+  get facetSearchBoxInput(): Locator {
+    return this.facet.getByTestId('facet__searchbox-input').locator('input');
+  }
+
+  get facetBreadcrumb(): Locator {
+    return this.page.getByTestId('category-facet-breadcrumb');
+  }
+
+  facetBreadcrumbValueByIndex(index: number): Locator {
+    return this.facetBreadcrumb.locator('c-quantic-pill').nth(index);
+  }
+
+  async clickOnFacetValue(index: number): Promise<void> {
+    await this.facetValue.nth(index).click();
+  }
+
+  async fillFacetSearchBoxInput(query: string): Promise<void> {
+    await this.facetSearchBoxInput.fill(query);
+  }
+}

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

@@ -0,0 +1,199 @@
+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 category facet ${useCase.label}`, () => {
+    test.describe('when selecting a facet value and clicking the all categories button', () => {
+      test('should trigger a new search and log the corresponding UA analytics events', async ({
+        baseFacet,
+        facet,
+        page,
+      }) => {
+        const selectedIndex = 0;
+        const {facetId, field, values} = facetData;
+        const expectedFacetData = {
+          facetId,
+          facetField: field,
+          facetValue: values[selectedIndex].value,
+        };
+        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 url = page.url();
+          expect(decodeURIComponent(url)).toContain(
+            `cf-${field}=${values[selectedIndex].value}`
+          );
+        }
+
+        const FacetClearAllUaRequest =
+          baseFacet.waitForFacetClearAllUaAnalytics({
+            facetId,
+            facetField: field,
+          });
+        const secondSearchResponsePromise = baseFacet.waitForSearchResponse();
+
+        await facet.allCategoriesButton.click();
+
+        await FacetClearAllUaRequest;
+        const secondSearchResponse = await secondSearchResponsePromise;
+        const {analytics: analyticsForFacetDeselect} =
+          baseFacet.extractDataFromResponse(secondSearchResponse);
+        expect(analyticsForFacetDeselect.actionCause).toEqual('facetClearAll');
+      });
+    });
+
+    test.describe('when expanding and collapsing facet values using Show More/Less buttons', () => {
+      test.use({
+        options: {
+          numberOfValues: 2,
+        },
+      });
+
+      test('should fetch additional facet values and send correct UA analytics', async ({
+        baseFacet,
+        facet,
+      }) => {
+        const {facetId, field} = facetData;
+        const uaRequest = baseFacet.waitForShowMoreFacetResultsUaAnalytics({
+          facetId,
+          facetField: field,
+        });
+        const firstSearchResponsePromise = baseFacet.waitForSearchResponse();
+
+        await facet.showMoreFacetValuesButton.click();
+
+        await uaRequest;
+        const firstSearchResponse = await firstSearchResponsePromise;
+        const {analytics: analyticsForShowMore} =
+          baseFacet.extractDataFromResponse(firstSearchResponse);
+        expect(analyticsForShowMore.actionCause).toEqual(
+          'showMoreFacetResults'
+        );
+
+        const showLessUaRequest =
+          baseFacet.waitForShowLessFacetResultsUaAnalytics({
+            facetId,
+            facetField: field,
+          });
+        const secondSearchResponsePromise = baseFacet.waitForSearchResponse();
+
+        await facet.showLessFacetValuesButton.click();
+
+        await showLessUaRequest;
+        const secondSearchResponse = await secondSearchResponsePromise;
+        const {analytics: analyticsForShowLess} =
+          baseFacet.extractDataFromResponse(secondSearchResponse);
+        expect(analyticsForShowLess.actionCause).toEqual(
+          'showLessFacetResults'
+        );
+      });
+    });
+
+    test.describe('when a custom caption is provided', () => {
+      const exampleCaption = 'example caption';
+      const facetValueIndex = 0;
+
+      test.use({
+        options: {
+          caption: exampleCaption,
+          value: facetData.values[facetValueIndex].value,
+        },
+      });
+      test('should display the custom caption instead of the raw facet value', async ({
+        baseFacet,
+        facet,
+      }) => {
+        expect(facet.facetValue.nth(facetValueIndex)).toHaveText(
+          new RegExp(exampleCaption)
+        );
+        const {facetId, field, values} = facetData;
+        const expectedFacetData = {
+          facetId,
+          facetField: field,
+          facetValue: values[facetValueIndex].value,
+        };
+        const uaRequest =
+          baseFacet.waitForFacetSelectUaAnalytics(expectedFacetData);
+        const searchResponsePromise = baseFacet.waitForSearchResponse();
+        await facet.clickOnFacetValue(facetValueIndex);
+        await uaRequest;
+        const searchResponse = await searchResponsePromise;
+        const {analytics} = baseFacet.extractDataFromResponse(searchResponse);
+
+        if (useCase.value === useCaseEnum.search) {
+          expect(analytics.customData).toEqual(
+            expect.objectContaining(expectedFacetData)
+          );
+        }
+        expect(facet.facetBreadcrumbValueByIndex(facetValueIndex)).toHaveText(
+          exampleCaption
+        );
+      });
+    });
+
+    if (useCase.value === useCaseEnum.search) {
+      test.describe('when typing in the facet search box input', () => {
+        test.use({
+          options: {
+            withSearch: true,
+          },
+        });
+
+        test('should fetch facet values according to the query typed', async ({
+          baseFacet,
+          facet,
+        }) => {
+          const {field: expectedField} = facetData;
+          const exampleQuery = 'test';
+          const facetSearchResponsePromise =
+            baseFacet.waitForFacetSearchResponse();
+
+          await facet.fillFacetSearchBoxInput(exampleQuery);
+
+          const facetSearchResponse = await facetSearchResponsePromise;
+          const {field, query} =
+            baseFacet.extractDataFromResponse(facetSearchResponse);
+          expect(field).toEqual(expectedField);
+          expect(query).toContain(exampleQuery);
+        });
+      });
+
+      test.describe('with a selected value in the URL', () => {
+        const selectedIndex = 0;
+        const {field, values} = facetData;
+        test.use({
+          urlHash: `cf-${field}=${values[selectedIndex].value}`,
+          facetResponseMock: undefined,
+        });
+
+        test('should select the correct facet value', async ({facet}) => {
+          expect(facet.activeParent).toHaveText(
+            new RegExp(values[selectedIndex].value)
+          );
+        });
+      });
+    }
+  });
+});