@coveo/quantic 3.16.0 → 3.16.1-pre.1a6fc4649f

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

@@ -1,335 +0,0 @@
-/* eslint-disable no-import-assign */
-// @ts-ignore
-import QuanticNotifications from 'c/quanticNotifications';
-// @ts-ignore
-import {createElement} from 'lwc';
-import * as mockHeadlessLoader from 'c/quanticHeadlessLoader';
-import {AriaLiveRegion} from 'c/quanticUtils';
-
-jest.mock('c/quanticHeadlessLoader');
-jest.mock('c/quanticUtils');
-
-const exampleNotifications = ['notification1', 'notification2'];
-
-let notificationsState = {
-  notifications: exampleNotifications,
-};
-let isInitialized = false;
-
-const exampleEngine = {
-  id: 'mock engine',
-};
-
-const mockSearchStatusState = {
-  hasResults: true,
-  hasError: false,
-};
-
-const functionsMocks = {
-  buildNotifyTrigger: jest.fn(() => ({
-    state: notificationsState,
-    subscribe: functionsMocks.subscribe,
-  })),
-  dispatchMessage: jest.fn(() => {}),
-  buildSearchStatus: jest.fn(() => ({
-    state: mockSearchStatusState,
-    subscribe: jest.fn((callback) => {
-      functionsMocks.subscribe.callback = callback;
-      return functionsMocks.unsubscribeSearchStatus;
-    }),
-  })),
-  subscribe: jest.fn((callback) => {
-    callback();
-    return functionsMocks.unsubscribe;
-  }),
-  unsubscribe: jest.fn(() => {}),
-  unsubscribeSearchStatus: jest.fn(() => {}),
-};
-
-// @ts-ignore
-AriaLiveRegion.mockImplementation(() => {
-  return {
-    dispatchMessage: functionsMocks.dispatchMessage,
-  };
-});
-
-const selectors = {
-  notifications: '[data-test="notification"]',
-  initializationError: 'c-quantic-component-error',
-  notificationCloseButton: 'lightning-button-icon',
-};
-
-const defaultOptions = {
-  engineId: 'exampleEngineId',
-};
-
-function createTestComponent(options = defaultOptions) {
-  prepareHeadlessState();
-
-  const element = createElement('c-quantic-notifications', {
-    is: QuanticNotifications,
-  });
-  for (const [key, value] of Object.entries(options)) {
-    element[key] = value;
-  }
-
-  document.body.appendChild(element);
-  return element;
-}
-
-function prepareHeadlessState() {
-  // @ts-ignore
-  mockHeadlessLoader.getHeadlessBundle = () => {
-    return {
-      buildNotifyTrigger: functionsMocks.buildNotifyTrigger,
-      buildSearchStatus: functionsMocks.buildSearchStatus,
-    };
-  };
-}
-
-// Helper function to wait until the microtask queue is empty.
-function flushPromises() {
-  // eslint-disable-next-line @lwc/lwc/no-async-operation
-  return new Promise((resolve) => setTimeout(resolve, 0));
-}
-
-function mockSuccessfulHeadlessInitialization() {
-  // @ts-ignore
-  mockHeadlessLoader.initializeWithHeadless = (element, _, initialize) => {
-    if (element instanceof QuanticNotifications && !isInitialized) {
-      isInitialized = true;
-      initialize(exampleEngine);
-    }
-  };
-}
-
-function mockErroneousHeadlessInitialization() {
-  // @ts-ignore
-  mockHeadlessLoader.initializeWithHeadless = (element) => {
-    if (element instanceof QuanticNotifications) {
-      element.setInitializationError();
-    }
-  };
-}
-
-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();
-  isInitialized = false;
-}
-
-describe('c-quantic-notifications', () => {
-  beforeAll(() => {
-    mockSuccessfulHeadlessInitialization();
-  });
-
-  afterEach(() => {
-    cleanup();
-    notificationsState = {
-      notifications: exampleNotifications,
-    };
-  });
-
-  describe('when an error occurs during initialization', () => {
-    beforeEach(() => {
-      mockErroneousHeadlessInitialization();
-    });
-
-    afterAll(() => {
-      mockSuccessfulHeadlessInitialization();
-    });
-
-    it('should display the initialization error component', async () => {
-      const element = createTestComponent();
-      await flushPromises();
-
-      const initializationError = element.shadowRoot.querySelector(
-        selectors.initializationError
-      );
-
-      const notification = element.shadowRoot.querySelector(
-        selectors.notifications
-      );
-
-      expect(initializationError).not.toBeNull();
-      expect(notification).toBeNull();
-    });
-  });
-
-  describe('component initialization', () => {
-    it('should build the notifyTrigger and searchStatus controllers with the proper parameters', async () => {
-      createTestComponent();
-      await flushPromises();
-
-      expect(functionsMocks.buildNotifyTrigger).toHaveBeenCalledTimes(1);
-      expect(functionsMocks.buildNotifyTrigger).toHaveBeenCalledWith(
-        exampleEngine
-      );
-      expect(functionsMocks.buildSearchStatus).toHaveBeenCalledTimes(1);
-      expect(functionsMocks.buildSearchStatus).toHaveBeenCalledWith(
-        exampleEngine
-      );
-    });
-
-    it('should subscribe to the headless notify trigger state changes', async () => {
-      createTestComponent();
-      await flushPromises();
-
-      expect(functionsMocks.subscribe).toHaveBeenCalledTimes(1);
-    });
-
-    it('should call AriaLiveRegion with the right parameters', async () => {
-      await createTestComponent();
-      await flushPromises();
-
-      expect(AriaLiveRegion).toHaveBeenCalledTimes(1);
-      expect(AriaLiveRegion).toHaveBeenCalledWith(
-        'notifications',
-        expect.anything()
-      );
-    });
-  });
-
-  describe('when the component is initialized successfully', () => {
-    describe('when some notifications are present in the state', () => {
-      it('should render the notifications component', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        const notifications = element.shadowRoot.querySelectorAll(
-          selectors.notifications
-        );
-
-        expect(notifications).not.toBeNull();
-        expect(notifications.length).toBe(exampleNotifications.length);
-        notifications.forEach((notification, index) => {
-          expect(notification.textContent).toEqual(exampleNotifications[index]);
-        });
-      });
-
-      it('should call dispatchMessage with the correct message', async () => {
-        await createTestComponent();
-        await flushPromises();
-
-        const expectedMessage =
-          ' Notification 1: notification1 Notification 2: notification2';
-
-        expect(functionsMocks.dispatchMessage).toHaveBeenCalledTimes(1);
-        expect(functionsMocks.dispatchMessage).toHaveBeenCalledWith(
-          expectedMessage
-        );
-      });
-    });
-
-    describe('when no notifications are present in the state', () => {
-      beforeEach(() => {
-        notificationsState = {
-          notifications: [],
-        };
-      });
-
-      it('should not render the notifications component', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        const notifications = element.shadowRoot.querySelectorAll(
-          selectors.notifications
-        );
-
-        expect(notifications.length).toEqual(0);
-      });
-    });
-
-    describe('when there is an error following a search', () => {
-      it('should not render the notifications component', async () => {
-        const element = createTestComponent();
-        mockSearchStatusState.hasError = true;
-        functionsMocks.subscribe.callback();
-        await flushPromises();
-
-        const notifications = element.shadowRoot.querySelectorAll(
-          selectors.notifications
-        );
-
-        expect(notifications.length).toEqual(0);
-      });
-    });
-  });
-
-  describe('when clicking on a notification close button', () => {
-    it('should properly dismiss that notification', async () => {
-      const element = createTestComponent();
-      await flushPromises();
-
-      const notificationsBeforeClose = element.shadowRoot.querySelectorAll(
-        selectors.notifications
-      );
-
-      const firstNotificationCloseButton =
-        notificationsBeforeClose[0].querySelector(
-          selectors.notificationCloseButton
-        );
-      firstNotificationCloseButton.click();
-      await flushPromises();
-
-      const notificationsAfterClose = element.shadowRoot.querySelectorAll(
-        selectors.notifications
-      );
-
-      expect(notificationsAfterClose.length).toEqual(
-        exampleNotifications.length - 1
-      );
-      expect(notificationsAfterClose[0].textContent).toEqual(
-        exampleNotifications[1]
-      );
-    });
-
-    describe('when triggering another search with the same query', () => {
-      it('should reset the visibility of the notifications', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        const notificationsBeforeClose = element.shadowRoot.querySelectorAll(
-          selectors.notifications
-        );
-
-        expect(notificationsBeforeClose.length).toEqual(
-          exampleNotifications.length
-        );
-
-        const firstNotificationCloseButton =
-          notificationsBeforeClose[0].querySelector(
-            selectors.notificationCloseButton
-          );
-        firstNotificationCloseButton.click();
-        await flushPromises();
-
-        const notificationsAfterClose = element.shadowRoot.querySelectorAll(
-          selectors.notifications
-        );
-
-        expect(notificationsAfterClose.length).toEqual(
-          exampleNotifications.length - 1
-        );
-
-        mockSearchStatusState.hasError = false;
-        functionsMocks.subscribe.callback();
-        await flushPromises();
-
-        const notificationsAfterSearch = element.shadowRoot.querySelectorAll(
-          selectors.notifications
-        );
-
-        expect(notificationsAfterSearch.length).toEqual(
-          exampleNotifications.length
-        );
-        notificationsAfterSearch.forEach((notification, index) => {
-          expect(notification.textContent).toEqual(exampleNotifications[index]);
-        });
-      });
-    });
-  });
-});

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

@@ -1,343 +0,0 @@
-/* eslint-disable no-import-assign */
-// @ts-ignore
-import {createElement} from 'lwc';
-import QuanticNumericFacet from 'c/quanticNumericFacet';
-import * as mockHeadlessLoader from 'c/quanticHeadlessLoader';
-import {generateFacetDependencyConditions} from 'c/quanticUtils';
-
-jest.mock('c/quanticUtils', () => ({
-  generateFacetDependencyConditions: jest.fn(),
-  Store: {
-    facetTypes: {
-      NUMERICFACETS: 'numericFacets',
-    },
-  },
-  I18nUtils: {
-    format: jest.fn(),
-  },
-}));
-jest.mock('c/quanticHeadlessLoader');
-
-const selectors = {
-  facetContent: '[data-test="facet-content"]',
-  componentError: 'c-quantic-component-error',
-};
-
-const exampleFacetId = 'example facet id';
-const exampleField = 'exampleField';
-const exampleFilterId = `${exampleFacetId}_input`;
-const defaultOptions = {
-  field: exampleField,
-};
-const numericFacetControllerMock = {
-  subscribe: jest.fn((callback) => callback()),
-  state: {
-    facetId: exampleFacetId,
-    values: [],
-  },
-};
-const parentFacetIdError = `The ${exampleField} c-quantic-numeric-facet requires dependsOn.parentFacetId to be a valid string.`;
-const expectedValueError = `The ${exampleField} c-quantic-numeric-facet requires dependsOn.expectedValue to be a valid string.`;
-
-function createTestComponent(options = defaultOptions) {
-  prepareHeadlessState();
-
-  const element = createElement('c-quantic-numeric-facet', {
-    is: QuanticNumericFacet,
-  });
-  for (const [key, value] of Object.entries(options)) {
-    element[key] = value;
-  }
-
-  document.body.appendChild(element);
-  return element;
-}
-
-const functionsMocks = {
-  buildNumericFacet: jest.fn(() => numericFacetControllerMock),
-  buildNumericFilter: jest.fn(() => ({
-    subscribe: jest.fn((callback) => callback()),
-    state: {
-      facetId: exampleFilterId,
-    },
-  })),
-  stopWatching: jest.fn(),
-  buildFacetConditionsManager: jest.fn(() => ({
-    stopWatching: functionsMocks.stopWatching,
-  })),
-  buildSearchStatus: jest.fn(() => ({
-    subscribe: jest.fn((callback) => callback()),
-    state: {},
-  })),
-};
-
-function prepareHeadlessState() {
-  // @ts-ignore
-  mockHeadlessLoader.getHeadlessBundle = () => {
-    return {
-      buildNumericFacet: functionsMocks.buildNumericFacet,
-      buildNumericFilter: functionsMocks.buildNumericFilter,
-      buildSearchStatus: functionsMocks.buildSearchStatus,
-      buildFacetConditionsManager: functionsMocks.buildFacetConditionsManager,
-    };
-  };
-}
-
-// Helper function to wait until the microtask queue is empty.
-function flushPromises() {
-  // eslint-disable-next-line @lwc/lwc/no-async-operation
-  return new Promise((resolve) => setTimeout(resolve, 0));
-}
-
-const exampleEngine = {
-  id: 'dummy engine',
-};
-let isInitialized = false;
-
-function mockBueno() {
-  // @ts-ignore
-  mockHeadlessLoader.getBueno = () => {
-    // @ts-ignore
-    global.Bueno = {
-      isString: jest
-        .fn()
-        .mockImplementation(
-          (value) => Object.prototype.toString.call(value) === '[object String]'
-        ),
-    };
-    return new Promise((resolve) => resolve());
-  };
-}
-
-function mockSuccessfulHeadlessInitialization() {
-  // @ts-ignore
-  mockHeadlessLoader.initializeWithHeadless = (element, _, initialize) => {
-    if (element instanceof QuanticNumericFacet && !isInitialized) {
-      isInitialized = true;
-      initialize(exampleEngine);
-    }
-  };
-}
-
-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();
-  isInitialized = false;
-}
-
-describe('c-quantic-numeric-facet', () => {
-  beforeAll(() => {
-    mockSuccessfulHeadlessInitialization();
-    mockBueno();
-  });
-
-  afterEach(() => {
-    cleanup();
-  });
-
-  describe('the facet conditions manager', () => {
-    it('should build the controller when the dependsOn property is set', async () => {
-      const exampleFacetDependency = {
-        parentFacetId: 'filetype',
-        expectedValue: 'txt',
-      };
-      createTestComponent({
-        ...defaultOptions,
-        dependsOn: exampleFacetDependency,
-        withInput: true,
-      });
-      await flushPromises();
-
-      expect(functionsMocks.buildNumericFacet).toHaveBeenCalledTimes(1);
-      expect(functionsMocks.buildNumericFilter).toHaveBeenCalledTimes(1);
-      expect(functionsMocks.buildFacetConditionsManager).toHaveBeenCalledTimes(
-        2
-      );
-      expect(functionsMocks.buildFacetConditionsManager).toHaveBeenCalledWith(
-        exampleEngine,
-        {
-          facetId: exampleFacetId,
-        }
-      );
-      expect(functionsMocks.buildFacetConditionsManager).toHaveBeenCalledWith(
-        exampleEngine,
-        {
-          facetId: exampleFilterId,
-        }
-      );
-
-      expect(generateFacetDependencyConditions).toHaveBeenCalledTimes(2);
-      expect(generateFacetDependencyConditions).toHaveBeenCalledWith({
-        [exampleFacetDependency.parentFacetId]:
-          exampleFacetDependency.expectedValue,
-      });
-    });
-
-    it('should not build the controller when the dependsOn property is not set', async () => {
-      createTestComponent({
-        ...defaultOptions,
-        withInput: true,
-      });
-      await flushPromises();
-
-      expect(functionsMocks.buildNumericFacet).toHaveBeenCalledTimes(1);
-      expect(functionsMocks.buildFacetConditionsManager).toHaveBeenCalledTimes(
-        0
-      );
-      expect(generateFacetDependencyConditions).toHaveBeenCalledTimes(0);
-    });
-  });
-
-  describe('the facet enablement', () => {
-    describe('when the facet is enabled', () => {
-      beforeAll(() => {
-        functionsMocks.buildNumericFacet.mockReturnValue({
-          ...numericFacetControllerMock,
-          state: {...numericFacetControllerMock.state, enabled: true},
-        });
-      });
-
-      it('should display the facet content', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        const facetContent = element.shadowRoot.querySelector(
-          selectors.facetContent
-        );
-        expect(facetContent).not.toBeNull();
-      });
-    });
-
-    describe('when the facet is not enabled', () => {
-      beforeAll(() => {
-        functionsMocks.buildNumericFacet.mockReturnValue({
-          ...numericFacetControllerMock,
-          state: {...numericFacetControllerMock.state, enabled: false},
-        });
-      });
-
-      it('should not display the facet content', async () => {
-        const element = createTestComponent();
-        await flushPromises();
-
-        const facetContent = element.shadowRoot.querySelector(
-          selectors.facetContent
-        );
-        expect(facetContent).toBeNull();
-      });
-    });
-
-    afterAll(() => {
-      functionsMocks.buildNumericFacet.mockReturnValue(
-        numericFacetControllerMock
-      );
-    });
-  });
-
-  describe('validation of the dependsOn property', () => {
-    let consoleError;
-    beforeAll(() => {
-      consoleError = jest.spyOn(console, 'error').mockImplementation(() => {});
-    });
-    describe('when dependsOn.parentFacetId is not provided', () => {
-      it('should display the error component', async () => {
-        const invalidFacetDependency = {
-          expectedValue: 'txt',
-        };
-        const element = createTestComponent({
-          ...defaultOptions,
-          dependsOn: invalidFacetDependency,
-        });
-        await flushPromises();
-
-        const componentError = element.shadowRoot.querySelector(
-          selectors.componentError
-        );
-        const facetContent = element.shadowRoot.querySelector(
-          selectors.facetContent
-        );
-
-        expect(consoleError).toHaveBeenCalledTimes(1);
-        expect(consoleError).toHaveBeenCalledWith(parentFacetIdError);
-        expect(componentError).not.toBeNull();
-        expect(facetContent).toBeNull();
-      });
-    });
-
-    describe('when dependsOn.parentFacetId is not a string', () => {
-      it('should display the error component', async () => {
-        const invalidFacetDependency = {
-          parentFacetId: 1,
-          expectedValue: 'txt',
-        };
-        const element = createTestComponent({
-          ...defaultOptions,
-          dependsOn: invalidFacetDependency,
-        });
-        await flushPromises();
-
-        const componentError = element.shadowRoot.querySelector(
-          selectors.componentError
-        );
-        const facetContent = element.shadowRoot.querySelector(
-          selectors.facetContent
-        );
-
-        expect(consoleError).toHaveBeenCalledTimes(1);
-        expect(consoleError).toHaveBeenCalledWith(parentFacetIdError);
-        expect(componentError).not.toBeNull();
-        expect(facetContent).toBeNull();
-      });
-    });
-
-    describe('when dependsOn.expectedValue is not a string', () => {
-      it('should display the error component', async () => {
-        const invalidFacetDependency = {
-          parentFacetId: 'filetype',
-          expectedValue: 2,
-        };
-        const element = createTestComponent({
-          ...defaultOptions,
-          dependsOn: invalidFacetDependency,
-        });
-        await flushPromises();
-
-        const componentError = element.shadowRoot.querySelector(
-          selectors.componentError
-        );
-        const facetContent = element.shadowRoot.querySelector(
-          selectors.facetContent
-        );
-
-        expect(consoleError).toHaveBeenCalledTimes(1);
-        expect(consoleError).toHaveBeenCalledWith(expectedValueError);
-        expect(componentError).not.toBeNull();
-        expect(facetContent).toBeNull();
-      });
-    });
-  });
-
-  describe('when the component is disconnected', () => {
-    it('should make the condition manager stop watching the facet', async () => {
-      const exampleFacetDependency = {
-        parentFacetId: 'filetype',
-        expectedValue: 'txt',
-      };
-      const element = createTestComponent({
-        ...defaultOptions,
-        dependsOn: exampleFacetDependency,
-        withInput: true,
-      });
-      await flushPromises();
-      expect(functionsMocks.buildFacetConditionsManager).toHaveBeenCalledTimes(
-        2
-      );
-
-      document.body.removeChild(element);
-      expect(functionsMocks.stopWatching).toHaveBeenCalledTimes(2);
-    });
-  });
-});