passbolt-styleguide/src/shared/context/MetadataKeysSettingsLocalStorageContext/MetadataKeysSettingsLocalStorageContext.test.js

Passbolt styleguide contains common styling assets used by the different sites, plugin, etc.

/**
 * Passbolt ~ Open source password manager for teams
 * Copyright (c) Passbolt SA (https://www.passbolt.com)
 *
 * Licensed under GNU Affero General Public License version 3 of the or any later version.
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright     Copyright (c) Passbolt SA (https://www.passbolt.com)
 * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
 * @link          https://www.passbolt.com Passbolt(tm)
 * @since         5.4.0
 */

import { waitFor } from "@testing-library/dom";
import mockComponentSetState from "../../../react-extension/test/mock/components/React/mockSetState";
import { defaultProps } from "./MetadataKeysSettingsLocalStorageContext.test.data";
import { MetadataKeysSettingsLocalStorageContextProvider } from "./MetadataKeysSettingsLocalStorageContext";
import { defaultMetadataKeysSettingsDto } from "../../models/entity/metadata/metadataKeysSettingsEntity.test.data";

beforeEach(() => {
  jest.clearAllMocks();
});

describe("MetadataKeysSettingsLocalStorageContext", () => {
  describe("::constructor", () => {
    it("should initialise the default state and handlers", () => {
      expect.assertions(3);

      const contextProvider = new MetadataKeysSettingsLocalStorageContextProvider(defaultProps());
      mockComponentSetState(contextProvider);

      expect(contextProvider.runningLocalStorageUpdatePromise).not.toBeUndefined();
      expect(contextProvider.runningLocalStorageUpdatePromise).toBeNull();
      expect(contextProvider.state).toMatchObject({
        get: expect.any(Function),
        metadataKeysSettings: null,
        updateLocalStorage: expect.any(Function),
      });
    });
  });

  describe("::componentDidMount", () => {
    it("should listen to the expected event", () => {
      expect.assertions(2);

      const contextProvider = new MetadataKeysSettingsLocalStorageContextProvider(defaultProps());
      mockComponentSetState(contextProvider);

      contextProvider.componentDidMount();

      const callbacks = contextProvider.props.context.storage.changeCallbacks;
      expect(callbacks.length).toStrictEqual(1);
      expect(callbacks[0]).toStrictEqual(contextProvider.handleStorageChange);
    });
  });

  describe("::componentWillUnmount", () => {
    it("should listen to the expected event", () => {
      expect.assertions(2);

      const contextProvider = new MetadataKeysSettingsLocalStorageContextProvider(defaultProps());
      mockComponentSetState(contextProvider);

      contextProvider.componentDidMount();
      expect(contextProvider.props.context.storage.changeCallbacks.length).toStrictEqual(1);

      contextProvider.componentWillUnmount();
      expect(contextProvider.props.context.storage.changeCallbacks.length).toStrictEqual(0);
    });
  });

  describe("::handleStorageChange", () => {
    it("should update the current state with the changed metadata keys settings", () => {
      expect.assertions(1);

      const props = defaultProps();
      const contextProvider = new MetadataKeysSettingsLocalStorageContextProvider(props);
      mockComponentSetState(contextProvider);

      const expectedMetadataKeysSettings = defaultMetadataKeysSettingsDto();

      contextProvider.handleStorageChange({
        [contextProvider.storageKey]: {
          newValue: expectedMetadataKeysSettings,
        },
      });

      expect(contextProvider.state.metadataKeysSettings.toDto()).toStrictEqual(expectedMetadataKeysSettings);
    });

    it("should ignore storage change event that are not related to metadata keys settings", () => {
      expect.assertions(1);

      const contextProvider = new MetadataKeysSettingsLocalStorageContextProvider(defaultProps());
      mockComponentSetState(contextProvider);

      contextProvider.handleStorageChange({
        test: "something",
      });

      expect(contextProvider.setState).not.toHaveBeenCalled();
    });
  });

  describe("::get", () => {
    it("should return the metadata keys settings if the state have been initialised already", () => {
      expect.assertions(1);

      const props = defaultProps();
      const contextProvider = new MetadataKeysSettingsLocalStorageContextProvider(props);
      mockComponentSetState(contextProvider);

      const expectedMetadataKeysSettings = defaultMetadataKeysSettingsDto();

      contextProvider.handleStorageChange({
        [contextProvider.storageKey]: {
          newValue: expectedMetadataKeysSettings,
        },
      });

      expect(contextProvider.get().toDto()).toStrictEqual(expectedMetadataKeysSettings);
    });

    it("should return null if the state hasn't been initialized yet and set a blocking promise while the init occurs", async () => {
      expect.assertions(3);

      const props = defaultProps();
      const contextProvider = new MetadataKeysSettingsLocalStorageContextProvider(props);

      props.context.storage.local.set({ [contextProvider.storageKey]: null });

      mockComponentSetState(contextProvider);

      expect(contextProvider.runningLocalStorageUpdatePromise).toBeNull();
      expect(contextProvider.get()).toBeNull();

      await waitFor(() => {});

      expect(contextProvider.runningLocalStorageUpdatePromise).not.toBeNull();
    });
  });

  describe("::set", () => {
    it("should set the metadata keys settings", () => {
      expect.assertions(2);

      const metadataKeysSettings = defaultMetadataKeysSettingsDto();

      const contextProvider = new MetadataKeysSettingsLocalStorageContextProvider(defaultProps());
      mockComponentSetState(contextProvider);

      expect(contextProvider.state.metadataKeysSettings).toBeNull();
      contextProvider.set(metadataKeysSettings);

      expect(contextProvider.state.metadataKeysSettings.toDto()).toStrictEqual(metadataKeysSettings);
    });
  });

  describe("::loadLocalStorage", () => {
    it("should find the metadata keys settings from the local storage and set the context state with it.", async () => {
      expect.assertions(1);

      const metadataKeysSettings = defaultMetadataKeysSettingsDto();

      const props = defaultProps();
      const contextProvider = new MetadataKeysSettingsLocalStorageContextProvider(props);

      props.context.storage.local.set({ [contextProvider.storageKey]: metadataKeysSettings });
      mockComponentSetState(contextProvider);

      await contextProvider.loadLocalStorage();

      expect(contextProvider.state.metadataKeysSettings.toDto()).toStrictEqual(metadataKeysSettings);
    });

    it("should call for updating the local storage if there is no metadata keys settings in the local storage.", async () => {
      expect.assertions(2);

      const props = defaultProps();
      const contextProvider = new MetadataKeysSettingsLocalStorageContextProvider(props);

      props.context.storage.local.set({ [contextProvider.storageKey]: null });
      props.context.port.addRequestListener("passbolt.metadata.get-or-find-metadata-keys-settings", async () => {});

      const spyOnRequest = jest.spyOn(props.context.port, "request");

      mockComponentSetState(contextProvider);

      await contextProvider.loadLocalStorage();

      expect(spyOnRequest).toHaveBeenCalledTimes(1);
      expect(spyOnRequest).toHaveBeenCalledWith("passbolt.metadata.get-or-find-metadata-keys-settings");
    });
  });

  describe("::updateLocalStorage", () => {
    it("should call the service worker with the right event to trigger the local storage update.", async () => {
      expect.assertions(2);

      const props = defaultProps();
      const contextProvider = new MetadataKeysSettingsLocalStorageContextProvider(props);

      props.context.storage.local.set({ [contextProvider.storageKey]: null });
      props.context.port.addRequestListener("passbolt.metadata.get-or-find-metadata-keys-settings", async () => {});

      const spyOnRequest = jest.spyOn(props.context.port, "request");

      mockComponentSetState(contextProvider);

      contextProvider.updateLocalStorage();

      expect(spyOnRequest).toHaveBeenCalledTimes(1);
      expect(spyOnRequest).toHaveBeenCalledWith("passbolt.metadata.get-or-find-metadata-keys-settings");
    });

    it("should not call the service worker twice if a pending promise is running.", async () => {
      expect.assertions(4);

      const props = defaultProps();
      let resolveUpdadeLocalStoragePromise;
      const spyOnRequest = jest
        .spyOn(props.context.port, "request")
        .mockImplementation(() => new Promise((resolve) => (resolveUpdadeLocalStoragePromise = resolve)));

      const contextProvider = new MetadataKeysSettingsLocalStorageContextProvider(props);
      mockComponentSetState(contextProvider);

      contextProvider.updateLocalStorage();

      expect(spyOnRequest).toHaveBeenCalledTimes(1);
      expect(spyOnRequest).toHaveBeenCalledWith("passbolt.metadata.get-or-find-metadata-keys-settings");

      contextProvider.updateLocalStorage();

      expect(spyOnRequest).toHaveBeenCalledTimes(1);

      await resolveUpdadeLocalStoragePromise();

      contextProvider.updateLocalStorage();

      expect(spyOnRequest).toHaveBeenCalledTimes(2);

      await resolveUpdadeLocalStoragePromise();
    });

    it("should call the service worker again if the promise has been resolved.", async () => {
      expect.assertions(5);

      const props = defaultProps();
      props.context.port.addRequestListener("passbolt.metadata.get-or-find-metadata-keys-settings", async () => {});

      const spyOnRequest = jest.spyOn(props.context.port, "request");

      const contextProvider = new MetadataKeysSettingsLocalStorageContextProvider(props);
      mockComponentSetState(contextProvider);

      contextProvider.updateLocalStorage();
      expect(contextProvider.runningLocalStorageUpdatePromise).not.toBeNull();

      expect(spyOnRequest).toHaveBeenCalledTimes(1);
      contextProvider.updateLocalStorage();
      expect(spyOnRequest).toHaveBeenCalledTimes(1);

      await contextProvider.runningLocalStorageUpdatePromise;

      //promise should be reinit now;
      expect(contextProvider.runningLocalStorageUpdatePromise).toBeNull();

      contextProvider.updateLocalStorage();

      expect(spyOnRequest).toHaveBeenCalledTimes(2);
    });
  });
});