passbolt-browser-extension 5.13.0 → 5.14.2

package/src/all/background_page/service/group/getOrFindGroupsService.test.js

@@ -1,168 +0,0 @@
-/**
- * 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.13.0
- */
-
-import { v4 as uuidv4 } from "uuid";
-import AccountEntity from "../../model/entity/account/accountEntity";
-import { defaultAccountDto } from "../../model/entity/account/accountEntity.test.data";
-import { defaultApiClientOptions } from "passbolt-styleguide/src/shared/lib/apiClient/apiClientOptions.test.data";
-import GetOrFindGroupsService from "./getOrFindGroupsService";
-import FindAndUpdateGroupsLocalStorageService from "./findAndUpdateGroupsLocalStorageService";
-import FindGroupsService from "./findGroupsService";
-import GroupsCollection from "passbolt-styleguide/src/shared/models/entity/group/groupsCollection";
-import GroupLocalStorage from "../local_storage/groupLocalStorage";
-import { defaultGroupsDtos } from "passbolt-styleguide/src/shared/models/entity/group/groupsCollection.test.data";
-
-describe("GetOrFindGroupsService", () => {
-  let service, account;
-
-  beforeEach(async () => {
-    jest.clearAllMocks();
-    account = new AccountEntity(defaultAccountDto());
-    service = new GetOrFindGroupsService(account, defaultApiClientOptions());
-    // flush account related storage before each.
-    await service.groupLocalStorage.flush();
-  });
-
-  describe("::getOrFindAll", () => {
-    it("fetches from the API and initializes the local storage with an empty array when the API returns no groups.", async () => {
-      expect.assertions(4);
-      jest
-        .spyOn(FindGroupsService.prototype, "findAllForLocalStorage")
-        .mockImplementation(() => new GroupsCollection([]));
-      jest.spyOn(FindAndUpdateGroupsLocalStorageService.prototype, "findAndUpdateAll");
-
-      const groups = await service.getOrFindAll();
-
-      expect(FindAndUpdateGroupsLocalStorageService.prototype.findAndUpdateAll).toHaveBeenCalledTimes(1);
-      expect(groups).toBeInstanceOf(GroupsCollection);
-      expect(groups).toHaveLength(0);
-      expect(await service.groupLocalStorage.get()).toEqual([]);
-    });
-
-    it("fetches the groups from the API and populates the local storage when the local storage is not initialized.", async () => {
-      expect.assertions(4);
-      const groupsDto = defaultGroupsDtos();
-      jest
-        .spyOn(FindGroupsService.prototype, "findAllForLocalStorage")
-        .mockImplementation(() => new GroupsCollection(groupsDto));
-
-      const groups = await service.getOrFindAll();
-
-      expect(groups).toHaveLength(groupsDto.length);
-      expect(groups.toDto(GroupLocalStorage.DEFAULT_CONTAIN)).toEqual(groupsDto);
-      expect(GroupLocalStorage.hasCachedData(account.id)).toBeTruthy();
-      expect(await service.groupLocalStorage.get()).toEqual(groupsDto);
-    });
-
-    it("retrieves groups from the local storage when the local storage is initialized.", async () => {
-      expect.assertions(5);
-      const groupsDto = defaultGroupsDtos();
-      jest.spyOn(FindGroupsService.prototype, "findAllForLocalStorage");
-      await service.groupLocalStorage.set(new GroupsCollection(groupsDto));
-
-      const groups = await service.getOrFindAll();
-
-      expect(FindGroupsService.prototype.findAllForLocalStorage).not.toHaveBeenCalled();
-      expect(groups).toHaveLength(groupsDto.length);
-      expect(groups.toDto(GroupLocalStorage.DEFAULT_CONTAIN)).toEqual(groupsDto);
-      expect(GroupLocalStorage.hasCachedData(account.id)).toBeTruthy();
-      expect(await service.groupLocalStorage.get()).toEqual(groupsDto);
-    });
-
-    it("does not validate the groups collection if the information is retrieved from the runtime cache.", async () => {
-      expect.assertions(2);
-      jest.spyOn(FindGroupsService.prototype, "findAllForLocalStorage");
-      await service.groupLocalStorage.set(new GroupsCollection(defaultGroupsDtos()));
-      jest.spyOn(GroupsCollection.prototype, "validateSchema");
-
-      await service.getOrFindAll();
-
-      expect(FindGroupsService.prototype.findAllForLocalStorage).not.toHaveBeenCalled();
-      // Validation must not be triggered by getOrFindAll when the data comes from the runtime cache.
-      expect(GroupsCollection.prototype.validateSchema).not.toHaveBeenCalled();
-    });
-
-    it("validates groups collection if the local storage has no runtime cache and the information is retrieved from the local storage.", async () => {
-      expect.assertions(2);
-      jest.spyOn(FindGroupsService.prototype, "findAllForLocalStorage");
-      await service.groupLocalStorage.set(new GroupsCollection(defaultGroupsDtos()));
-      delete GroupLocalStorage._runtimeCachedData[account.id];
-      jest.spyOn(GroupsCollection.prototype, "validateSchema");
-
-      await service.getOrFindAll();
-
-      expect(FindGroupsService.prototype.findAllForLocalStorage).not.toHaveBeenCalled();
-      // Validation must be triggered by getOrFindAll when the data is loaded from the disk cache.
-      expect(GroupsCollection.prototype.validateSchema).toHaveBeenCalled();
-    });
-  });
-
-  describe("::getOrFindByIds", () => {
-    it("returns only the groups whose ids are in the requested set.", async () => {
-      expect.assertions(2);
-      const groupsDto = defaultGroupsDtos();
-      await service.groupLocalStorage.set(new GroupsCollection(groupsDto));
-      const requestedIds = [groupsDto[1].id, groupsDto[3].id, groupsDto[5].id];
-
-      const groups = await service.getOrFindByIds(requestedIds);
-
-      expect(groups).toHaveLength(3);
-      expect(groups.extract("id").sort()).toEqual([...requestedIds].sort());
-    });
-
-    it("returns an empty collection when none of the ids match.", async () => {
-      expect.assertions(1);
-      const groupsDto = defaultGroupsDtos();
-      await service.groupLocalStorage.set(new GroupsCollection(groupsDto));
-
-      const groups = await service.getOrFindByIds([uuidv4(), uuidv4()]);
-
-      expect(groups).toHaveLength(0);
-    });
-
-    it("returns all groups when every group id is requested.", async () => {
-      expect.assertions(2);
-      const groupsDto = defaultGroupsDtos();
-      await service.groupLocalStorage.set(new GroupsCollection(groupsDto));
-      const allIds = groupsDto.map((group) => group.id);
-
-      const groups = await service.getOrFindByIds(allIds);
-
-      expect(groups).toHaveLength(groupsDto.length);
-      expect(groups.extract("id").sort()).toEqual([...allIds].sort());
-    });
-
-    it("fetches from the API when the local storage is not initialized, then filters.", async () => {
-      expect.assertions(3);
-      const groupsDto = defaultGroupsDtos();
-      jest
-        .spyOn(FindGroupsService.prototype, "findAllForLocalStorage")
-        .mockImplementation(() => new GroupsCollection(groupsDto));
-      const requestedIds = [groupsDto[0].id, groupsDto[2].id];
-
-      const groups = await service.getOrFindByIds(requestedIds);
-
-      expect(FindGroupsService.prototype.findAllForLocalStorage).toHaveBeenCalledTimes(1);
-      expect(groups).toHaveLength(2);
-      expect(groups.extract("id").sort()).toEqual([...requestedIds].sort());
-    });
-
-    it("should assert its parameter.", async () => {
-      expect.assertions(1);
-      await expect(() => service.getOrFindByIds(["not-a-uuid"])).rejects.toThrow(
-        "The given parameter is not a valid array of uuid",
-      );
-    });
-  });
-});

package/src/all/background_page/service/group/getOrFindGroupsUsersService.js

@@ -1,51 +0,0 @@
-/**
- * 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.13.0
- */
-import GroupsUsersCollection from "passbolt-styleguide/src/shared/models/entity/groupUser/groupsUsersCollection";
-import GetOrFindGroupsService from "./getOrFindGroupsService";
-import { assertUuid } from "../../utils/assertions";
-
-/**
- * The service aims to retrieve the group members of a given group from the local storage cache
- * served by `GetOrFindGroupsService`, falling back to the API on a cold cache.
- */
-class GetOrFindGroupsUsersService {
-  /**
-   * Constructor.
-   * @param {AccountEntity} account The user account.
-   * @param {ApiClientOptions} apiClientOptions The api client options.
-   */
-  constructor(account, apiClientOptions) {
-    this.getOrFindGroupsService = new GetOrFindGroupsService(account, apiClientOptions);
-  }
-
-  /**
-   * Get or find the members of the group matching the given id.
-   * @param {string} groupId The id of the group whose members are requested.
-   * @returns {Promise<GroupsUsersCollection>}
-   * @throws {Error} If no group is found for the given id.
-   */
-  async getOrFindByGroupId(groupId) {
-    assertUuid(groupId);
-
-    const groupsCollection = await this.getOrFindGroupsService.getOrFindAll();
-    const group = groupsCollection.getFirst("id", groupId);
-    if (!group) {
-      throw new Error(`The group with id ${groupId} could not be found.`);
-    }
-
-    return group.groupsUsers ?? new GroupsUsersCollection([]);
-  }
-}
-
-export default GetOrFindGroupsUsersService;

package/src/all/background_page/service/group/getOrFindGroupsUsersService.test.js

@@ -1,94 +0,0 @@
-/**
- * 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.13.0
- */
-
-import { v4 as uuidv4 } from "uuid";
-import AccountEntity from "../../model/entity/account/accountEntity";
-import { defaultAccountDto } from "../../model/entity/account/accountEntity.test.data";
-import { defaultApiClientOptions } from "passbolt-styleguide/src/shared/lib/apiClient/apiClientOptions.test.data";
-import GetOrFindGroupsUsersService from "./getOrFindGroupsUsersService";
-import FindGroupsService from "./findGroupsService";
-import GroupsCollection from "passbolt-styleguide/src/shared/models/entity/group/groupsCollection";
-import GroupsUsersCollection from "passbolt-styleguide/src/shared/models/entity/groupUser/groupsUsersCollection";
-import { defaultGroupsDtos } from "passbolt-styleguide/src/shared/models/entity/group/groupsCollection.test.data";
-
-describe("GetOrFindGroupsUsersService", () => {
-  let service, account;
-
-  beforeEach(async () => {
-    jest.clearAllMocks();
-    account = new AccountEntity(defaultAccountDto());
-    service = new GetOrFindGroupsUsersService(account, defaultApiClientOptions());
-    // flush account related storage before each.
-    await service.getOrFindGroupsService.groupLocalStorage.flush();
-  });
-
-  describe("::getOrFindByGroupId", () => {
-    it("returns the members of the requested group when the local storage is populated.", async () => {
-      expect.assertions(3);
-      const groupsDto = defaultGroupsDtos(5, { withGroupsUsers: 3 });
-      await service.getOrFindGroupsService.groupLocalStorage.set(new GroupsCollection(groupsDto));
-      const targetGroup = groupsDto[2];
-
-      const result = await service.getOrFindByGroupId(targetGroup.id);
-
-      expect(result).toBeInstanceOf(GroupsUsersCollection);
-      expect(result).toHaveLength(3);
-      expect(result.items.every((groupUser) => groupUser.groupId === targetGroup.id)).toBe(true);
-    });
-
-    it("returns an empty GroupsUsersCollection when the group has no members.", async () => {
-      expect.assertions(2);
-      const groupsDto = defaultGroupsDtos(1, { withGroupsUsers: 0 });
-      await service.getOrFindGroupsService.groupLocalStorage.set(new GroupsCollection(groupsDto));
-
-      const result = await service.getOrFindByGroupId(groupsDto[0].id);
-
-      expect(result).toBeInstanceOf(GroupsUsersCollection);
-      expect(result).toHaveLength(0);
-    });
-
-    it("fetches from the API when the local storage is not initialized, then returns the requested group's members.", async () => {
-      expect.assertions(3);
-      const groupsDto = defaultGroupsDtos(3, { withGroupsUsers: 2 });
-      jest
-        .spyOn(FindGroupsService.prototype, "findAllForLocalStorage")
-        .mockImplementation(() => new GroupsCollection(groupsDto));
-      const targetGroup = groupsDto[1];
-
-      const result = await service.getOrFindByGroupId(targetGroup.id);
-
-      expect(FindGroupsService.prototype.findAllForLocalStorage).toHaveBeenCalledTimes(1);
-      expect(result).toBeInstanceOf(GroupsUsersCollection);
-      expect(result).toHaveLength(2);
-    });
-
-    it("throws when the group id does not exist.", async () => {
-      expect.assertions(1);
-      const groupsDto = defaultGroupsDtos();
-      await service.getOrFindGroupsService.groupLocalStorage.set(new GroupsCollection(groupsDto));
-      const missingId = uuidv4();
-
-      await expect(() => service.getOrFindByGroupId(missingId)).rejects.toThrow(
-        `The group with id ${missingId} could not be found.`,
-      );
-    });
-
-    it("should assert its parameter.", async () => {
-      expect.assertions(1);
-      await expect(() => service.getOrFindByGroupId("not-a-uuid")).rejects.toThrow(
-        "The given parameter is not a valid UUID",
-      );
-    });
-  });
-});

package/src/all/background_page/service/local_storage/authStatusLocalStorage.js

@@ -1,70 +0,0 @@
-/**
- * Passbolt ~ Open source password manager for teams
- * Copyright (c) Passbolt SARL (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         2.13.4
- */
-import Log from "../../model/log";
-
-const AUTH_STATUS_STORAGE_KEY = "auth_status";
-
-class AuthStatusLocalStorage {
-  /**
-   * Get the storage key.
-   */
-  static get storageKey() {
-    return AUTH_STATUS_STORAGE_KEY;
-  }
-
-  /**
-   * Flush the folders local storage
-   *
-   * @throws {Error} if operation failed
-   * @return {Promise<void>}
-   */
-  static async flush() {
-    Log.write({ level: "debug", message: "AuthStatusLocalStorage flushed" });
-    return await browser.storage.local.remove(this.storageKey);
-  }
-
-  /**
-   * Set the folders local storage.
-   *
-   * @throws {Error} if operation failed
-   * @return {Promise} results object, containing every object in keys that was found in the storage area.
-   * If storage is not set, undefined will be returned.
-   */
-  static async get() {
-    const result = await browser.storage.local.get([this.storageKey]);
-    if (result) {
-      return result[this.storageKey];
-    }
-    return undefined;
-  }
-
-  /**
-   * Set the folders local storage.
-   *
-   * @param {boolean} isAuthenticated
-   * @param {boolean} isMfaRequired
-   * @return {Promise<void>}
-   */
-  static async set(isAuthenticated, isMfaRequired) {
-    await navigator.locks.request(this.storageKey, async () => {
-      const auth_status = {
-        isAuthenticated: Boolean(isAuthenticated),
-        isMfaRequired: Boolean(isMfaRequired),
-      };
-      await browser.storage.local.set({ [this.storageKey]: auth_status });
-    });
-  }
-}
-
-export default AuthStatusLocalStorage;

package/src/all/background_page/service/sessionStorage/userMeSessionStorageService.js

@@ -1,94 +0,0 @@
-/**
- * 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         4.1.0
- */
-
-import UserEntity from "../../model/entity/user/userEntity";
-
-const USER_ME_STORAGE_KEY_PREFIX = "user-me";
-
-/**
- * A cache service used to store the result of the requests made on the users me entry point.
- */
-class UserMeSessionStorageService {
-  /**
-   * Get the storage key.
-   * @param {AbstractAccountEntity} account The account to get the key for.
-   * @returns {string}
-   * @throws {Error} If it cannot retrieve account id.
-   */
-  static getStorageKey(account) {
-    if (!account.id) {
-      throw new Error("Cannot retrieve account id, necessary to get a users me storage key.");
-    }
-    return `${USER_ME_STORAGE_KEY_PREFIX}-${account.id}`;
-  }
-
-  /**
-   * Get a user me cached data for a given account.
-   * @param {AbstractAccountEntity} account The account to get the cached data for.
-   * @returns {Promise<UserEntity|null>} Return the user me cached entity or null if the cache was not initialized.
-   * Note that in case the cache would be invalid, it would return null as well.
-   * @throws {Error} If it cannot get the storage key.
-   */
-  static async get(account) {
-    const storageKey = this.getStorageKey(account);
-    let storageData;
-
-    try {
-      storageData = await browser.storage.session.get(storageKey);
-    } catch (error) {
-      throw new Error("Unable to access the user me session storage", { cause: error });
-    }
-
-    const userMeDto = storageData?.[storageKey];
-
-    if (userMeDto) {
-      try {
-        return new UserEntity(userMeDto);
-      } catch (error) {
-        console.debug("Unable to instantiate the user entity based on the cached user dto.", error);
-      }
-    }
-
-    return null;
-  }
-
-  /**
-   * Cache a user me data for a given account.
-   * @param {AbstractAccountEntity} account The account to get the cached data for.
-   * @param {UserEntity} user The user me to cache
-   * @returns {Promise<void>}
-   */
-  static async set(account, user) {
-    const storageKey = this.getStorageKey(account);
-
-    await navigator.locks.request(storageKey, async () => {
-      await browser.storage.session.set({ [storageKey]: user.toDto(UserEntity.ALL_CONTAIN_OPTIONS) });
-    });
-  }
-
-  /**
-   * Remove the cached data for a given account.
-   * @param {AbstractAccountEntity} account The account to get the cached data for.
-   * @returns {Promise<void>}
-   */
-  static async remove(account) {
-    const storageKey = this.getStorageKey(account);
-
-    await navigator.locks.request(storageKey, async () => {
-      await browser.storage.session.remove(storageKey);
-    });
-  }
-}
-
-export default UserMeSessionStorageService;