passbolt-browser-extension 5.2.0 → 5.3.0

package/CHANGELOG.md

@@ -4,6 +4,55 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [5.3.0] - 2025-06-09
+
+### Added
+- PB-43269 Create the entity CustomFieldEntity
+- PB-43271 Create the entity collection CustomFieldsCollection
+- PB-43273 Create the entity SecretDataV5StandaloneCustomFieldsCollection
+- PB-43275 Update the resource types schema definitions
+- PB-43277 Update the ResourceMetadataEntity
+- PB-43278 Update the ResourceFormEntity
+- PB-43279 Update the Secret Entities
+- PB-43283 Display a new entry the create/edit dialog to set custom fields on the left sidebar and the menu
+- PB-43284 Create the CustomFieldForm for the create/edit dialog
+- PB-43285 Handle the CustomFieldForm warnings and limitation
+- PB-43286 Update create/edit resource to select secret custom fields for a standalone custom fields
+- PB-43287 Display the Custom Fields section on the right sidebar
+- PB-43289 Display standalone custom fields in the component DisplayResourceCreationMenu
+- PB-43290 Display standalone custom fields in the component DisplayResourcesWorkspaceMainMenu
+- PB-43291 Display the URIs section in the right sidebar
+- PB-43374 Add validation on keys and values of each elements of custom fields for the resource form entity
+- PB-43377 Add set collection into entity v2
+- PB-43145 Find a list of resources based on IDs and that are suitable for local storage from the API
+- PB-43146 Find a list of resources based on a parent folder id and that are suitable for the local storage from the API
+- PB-43133 Display padding below tags in resource workspace left sidebar
+- PB-42185 The folder caret that expands or collapses folders in the tree should have a larger clickable area to make it easier to use
+- PB-43222 Improve the group dialog to match the new share dimensions
+- PB-43147 Find and update resources based on parent folder id for the local storage
+- PB-43148 Create a connector for finding resources based on a parent id for the styleguide to call it later
+- PB-43149 Create a ResourcesServiceWorkerService to call the service worker for resource related operations
+- PB-43150 Implement the optimised call in the Styleguide when filtering by a folder
+- PB-43151 Optimise the data retrieved from the API such that updates are not done if unnecessary
+- PB-43156 Clarify implications for backups and other devices before changing the passphrase in the user settings workspace
+- PB-43489 Display unexpected error if there is any issue during the secret decryption
+
+### Fixed
+- PB-43109 Fix: from the sidebar when upgrade from v4 to v5 goes wrong the error message in the notification
+- PB-43118 Hide the "Share metadata keys" button in the users workspace action bar for the current signed-in user
+- PB-43215 Fix account recovery creator name
+- PB-43063 Fix group edit dialog double warning message has broken UI
+- PB-43117 Hide the "Share metadata keys" button in the users workspace action bar after sharing missing metadata keys with a user
+- PB-43064 Fix group edit dialog can show a mix of error and warning messages
+- PB-43150: fix folder not being reloaded
+- PB-43424 Clicking on the "open in a new tab” call to action  in the quick application should open the resource url in a new tab
+- PB-43108 Display attention required icon on "metadata keys" label in the user details sidebar if the user is not having access to some metadata keys
+- PB-43217 The default icon stroke width is too thick in the grid and doesn't match the custom icons
+- PB-43220 Copy URL field action button lacks padding and is broken in the SSO settings
+- PB-43168 Align vertically resources workspace select check-boxes
+- PB-43211 The feedback message notifying the administrator when a metadata key has been shared with a user contains a typo
+- PB-43471 Center vertically the icon on the create and edit dialog
+
 ## [5.2.0] - 2025-06-04
 
 ### Added

package/RELEASE_NOTES.md

@@ -1,81 +1,56 @@
-Song: https://youtu.be/ZA2JknKrCbM?si=H-rta-dE_IVIqm45
+Release song: https://www.youtube.com/watch?v=ubWL8VAPoYw
 
-Passbolt v5.2.0 is now available. This version introduces the long-awaited metadata properties for v5 resources (beta): users can set a custom icon for a resource and associate multiple URIs with it. The release also ships with numerous bug fixes. For full details, please see the changelog.
+Passbolt 5.3 adds custom fields, one of the five most‑requested features from the community. Built on top of encrypted‑metadata introduced earlier this year, custom fields let users attach additional key‑value pairs to a resource or as a standalone one. Typical use‑cases include centralising CI/CD job variables and storing environment‑specific configuration values that need more structure than a general note.
 
-As always, we warmly invite the community to test these new features before the production release, and we thank everyone for their valuable feedback and bug reports.
+Custom fields rely on encrypted metadata, therefore the feature is still in beta and is not yet available on Passbolt Cloud. A step‑by‑step guide on how to enable the encrypted metadata  on a self‑hosted instance will be available in a blog post that will be published soon. The encrypted‑metadata feature is scheduled to be marked as stable in Passbolt 5.4, planned for August 2025.
 
-### Added
-- PB-42936 Translate the application into Ukrainian
-- PB-42897 Upgrade resource to v5 from information panel
-- PB-42896 PB-42896 Display an “Upgrade Resource to v5” card in the information panel
-- PB-42895 Upgrade v4 password string resources to v5 default
-- PB-42894 Upgrade a single v4 resource to v5
-- PB-42860 Translate the application into Slovenian
-- PB-42796 Add a limit for multiple URIs
-- PB-42788 As a user I can access the resource appearance customization from the create/edit
-- PB-42704 Display missing metadata keys information in the user sidebar
-- PB-42658 Refresh the users local storage after sharing missing metadata keys
-- PB-42598 Retrieve missing_metadata_keys_ids information when retrieving signed-in user details with the getOrFindMe method of the UserModel
-- PB-42590 Write the background color and icon ID into KDBX files
-- PB-42589 Read the background color and icon ID from KDBX files
-- PB-42588 Adapt the ResourceIcon component to handle IconEntity
-- PB-42587 Add the AddResourceAppearance form part for the resource dialog
-- PB-42586 Add the ‘appearance’ metadata field in the resource dialog
-- PB-42585 Add IconEntity as an associated entity in MetadataEntity
-- PB-42584 Create IconEntity to hold custom icon and color information
-- PB-42570 Create a method canSuggestUris using canSuggestUri
-- PB-42543 Allow users to navigate to the additional URIs from the SelectResourceForm
-- PB-42536 Allow user to add additional URIs from the Create and Edit Resource v5 dialogs
-- PB-42534 Display resource additional URIs badge in the filtered resource of the QuickApplication
-- PB-42533 Display resource additional URIs badge in the suggested resource of the QuickApplication
-- PB-42530 Display resource additional URIs in the details of a resource of the QuickApplication
-- PB-42529 Display resource additional URIs badge in the browsed resource of the QuickApplication
-- PB-42528 Display resource additional URIs badge in the resource details sidebar
-- PB-42527 Display resource additional URIs badge in the resources grid
-- PB-42526 Create the ResourceUrisBadge component to handle resource additional URIs badge and the tooltip displaying them
-- PB-42130 Add shareMetadataKeyPrivate event to AppEvents
-- PB-42129 Create ShareMetadataKeyPrivateController and use ShareMetadataKeyPrivateService to perform the action
-- PB-42127 Create ShareMetadataKeyPrivateService and implement shareMissing method
-- PB-42114 Add create or share method to metadata private key api service
-- PB-42368 Update EncryptOne method from EncryptMetadataPrivateKeysService to allow encryption without signature
-- PB-42134 Update DisplayUsersContextualMenu to display a Share metadata keys action if key is missing
-- PB-42133 Update DisplayUserWorkspaceActions to display a Share metadata keys action if key is missing
-- PB-42132 Implement Dialog confirmation when administrator wants to share keys with an user
-- PB-42131 Add share method into metadataKeysServiceWorkerService to perform the UI action
-- PB-42126 Add cloneForSharing method into MetadataPrivateKeyEntity
-- PB-42124 Create ShareMetadataPrivateKeysCollection
-- PB-42110 Update userModel updateLocalStorage method to include missing_metadata_keys_ids option
-- PB-42109 Add missing_metadata_keys_ids property to UserEntity
-- PB-41617 Add comfortable grid
-- PB-39042 Display upgrade resource to v5 card
-
-### Improved
-- PB-42883 Improve performance by skipping the decryption of unchanged metadata.
-- PB-41654 Transform workspaces shifter into a dropdown
-- PB-42184 Increase the share dialog width to accommodate longer strings from translations or user names
-
-### Fixed
-- PB-43161 Fix: dragging resources or folder should display any error
-- PB-43008 Fix dragging v5 resources into shared folders should trigger the share strategy on the resource
-- PB-42985 Translate the button manage account in the profile dropdown
-- PB-42789 Fix userAvatar on userInformationPanel with attention required svg
-- PB-42702 Fix contains missing_metadata_keys_ids miss match
-- PB-42606 Fix the Quick App Login form CTA spinner should not be displayed over the text of the button
-- PB-42272 Fix display v5 resource metadata in the grid when filtering by group
-- PB-42077 Update navigation menu icon width
-- PB-41649 Re-align components in the left sidebar
-- PB-41643 Remove TOTP MFA (profile workspace) border around the QR code and card
-- PB-41642 Update Turn off MFA primary button to be red
+As part of our continuous performance work, this release concentrates on folder browsing. Loading folders and their resources is now faster and reduces the load on API and client, improving day-to-day usability for organizations having thousands of credentials under management.
 
-### Maintenance
-- PB-43012 Change authentication_token parameter to token for get the user key policies endpoint
-- PB-42790 Replace legacy Icon by SVG
-- PB-42572 Update Quickaccess HomePage to use the canSuggestUris
-- PB-42571 Update isSuggestion in resource entity to use canSuggestUris
-- PB-42569 Create and merge canSuggestUri into a service
-- PB-42978 Check object_type is defined and valid before metadata encryption
+Several bugs reported by the community have also been fixed. As always, thank you to everyone who took the time to file issues, test patches and suggest improvements. For a complete list of changes, consult the changelog.
 
-### Security
-- PB-42700 Upgrade vulnerable library undici and lockfile-lint-api
-- PB-42391 Update Papaparse library
+### Added
+- PB-43269 Create the entity CustomFieldEntity
+- PB-43271 Create the entity collection CustomFieldsCollection
+- PB-43273 Create the entity SecretDataV5StandaloneCustomFieldsCollection
+- PB-43275 Update the resource types schema definitions
+- PB-43277 Update the ResourceMetadataEntity
+- PB-43278 Update the ResourceFormEntity
+- PB-43279 Update the Secret Entities
+- PB-43283 Display a new entry the create/edit dialog to set custom fields on the left sidebar and the menu
+- PB-43284 Create the CustomFieldForm for the create/edit dialog
+- PB-43285 Handle the CustomFieldForm warnings and limitation
+- PB-43286 Update create/edit resource to select secret custom fields for a standalone custom fields
+- PB-43287 Display the Custom Fields section on the right sidebar
+- PB-43289 Display standalone custom fields in the component DisplayResourceCreationMenu
+- PB-43290 Display standalone custom fields in the component DisplayResourcesWorkspaceMainMenu
+- PB-43291 Display the URIs section in the right sidebar
+- PB-43374 Add validation on keys and values of each elements of custom fields for the resource form entity
+- PB-43377 Add set collection into entity v2
+- PB-43145 Find a list of resources based on IDs and that are suitable for local storage from the API
+- PB-43146 Find a list of resources based on a parent folder id and that are suitable for the local storage from the API
+- PB-43133 Display padding below tags in resource workspace left sidebar
+- PB-42185 The folder caret that expands or collapses folders in the tree should have a larger clickable area to make it easier to use
+- PB-43222 Improve the group dialog to match the new share dimensions
+- PB-43147 Find and update resources based on parent folder id for the local storage
+- PB-43148 Create a connector for finding resources based on a parent id for the styleguide to call it later
+- PB-43149 Create a ResourcesServiceWorkerService to call the service worker for resource related operations
+- PB-43150 Implement the optimised call in the Styleguide when filtering by a folder
+- PB-43151 Optimise the data retrieved from the API such that updates are not done if unnecessary
+- PB-43156 Clarify implications for backups and other devices before changing the passphrase in the user settings workspace
+- PB-43489 Display unexpected error if there is any issue during the secret decryption
 
+### Fixed
+- PB-43109 Fix: from the sidebar when upgrade from v4 to v5 goes wrong the error message in the notification
+- PB-43118 Hide the "Share metadata keys" button in the users workspace action bar for the current signed-in user
+- PB-43215 Fix account recovery creator name
+- PB-43063 Fix group edit dialog double warning message has broken UI
+- PB-43117 Hide the "Share metadata keys" button in the users workspace action bar after sharing missing metadata keys with a user
+- PB-43064 Fix group edit dialog can show a mix of error and warning messages
+- PB-43150: fix folder not being reloaded
+- PB-43424 Clicking on the "open in a new tab” call to action  in the quick application should open the resource url in a new tab
+- PB-43108 Display attention required icon on "metadata keys" label in the user details sidebar if the user is not having access to some metadata keys
+- PB-43217 The default icon stroke width is too thick in the grid and doesn't match the custom icons
+- PB-43220 Copy URL field action button lacks padding and is broken in the SSO settings
+- PB-43168 Align vertically resources workspace select check-boxes
+- PB-43211 The feedback message notifying the administrator when a metadata key has been shared with a user contains a typo
+- PB-43471 Center vertically the icon on the create and edit dialog

package/doc/browser-extension-class-diagram.md

@@ -48,6 +48,11 @@ classDiagram
             +exec() Promise
         }
 
+        class UpdateResourceLocalStorageByFolderParentIdController{
+            event "passbolt.resources.update-local-storage-for-parent-folder"
+            +exec(string parentFolderId) Promise
+        }
+
     %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
     %% Resources services
     %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -62,6 +67,7 @@ classDiagram
 
         class FindAndUpdateResourcesLocalStorageService {
             +findAndUpdateAll(FindAndUpdateResourcesLocalStorageOptions) Promise~ResourcesCollection~
+            +findAndUpdateAllByParentFolderId(uuid parentFolderId, string passphrase) Promise~ResourcesCollection~
             +findAndUpdateByIsSharedWithGroup(uuid groupId) Promise~ResourcesCollection~
         }
 
@@ -79,6 +85,8 @@ classDiagram
             +findAllByIdsWithPermissions(array~uuid~ resourcesIds) Promise~ResourcesCollection~
             +findAllByIsSharedWithGroupForLocalStorage(uuid groupId) Promise~ResourcesCollection~
             +findAllForDecrypt(array~uuid~ resourceIds) Promise~ResourcesCollection~
+            +findAllByIdsForLocalStorage(Array~uuid~ resourcesIds) Promise~ResourcesCollection~
+            +findAllByParentFolderIdForLocalStorage(string uuid) Promise~ResourcesCollection~
             +findOneById(string uuid, object contains) Promise~ResourceEntity~
             +findOneByIdForDetails(string uuid) Promise~ResourceEntity~
         }
@@ -1065,6 +1073,7 @@ classDiagram
     UpdateAllResourcesLocalStorageController*--FindAndUpdateResourcesLocalStorageService
 %%    UpdateResourceController*--GetPassphraseService
     UpdateResourceController*--UpdateResourceService
+    UpdateResourceLocalStorageByFolderParentIdController *--FindAndUpdateResourcesLocalStorage
     style CreateResourceController fill:#D2E0FB
     style ExportResourcesFileController fill:#D2E0FB
     style FindAllIdsByIsSharedWithGroupController fill:#D2E0FB

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "passbolt-browser-extension",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "license": "AGPL-3.0",
   "copyright": "Copyright 2025 Passbolt SA",
   "description": "Passbolt web extension for the open source password manager for teams",
@@ -22,7 +22,7 @@
     "locutus": "~2.0.9",
     "openpgp": "^6.1.1",
     "papaparse": "^5.5.2",
-    "passbolt-styleguide": "^5.2.2",
+    "passbolt-styleguide": "^5.3.1",
     "react": "17.0.2",
     "react-dom": "17.0.2",
     "secrets-passbolt": "github:passbolt/secrets.js#v2.0.1",

package/src/all/_locales/sl/messages.json

@@ -1,10 +1,10 @@
 {
   "appName": {
-    "message": "Passbolt - upravljalnik gesel z odprto kodo",
+    "message": "Passbolt - Odprtokodni upravitelj gesel",
     "description": "The application name of the extension, displayed in the web store. 45 characters max."
   },
   "appDescription": {
-    "message": "Razširitev Passbolt za upravljalnik gesel z odprto kodo za ekipe.",
+    "message": "Razširitev Passbolt za odprtokodnega upravitelja gesel za ekipe.",
     "description": "The description of the extension, displayed in the web store. 85 characters max."
   }
 }

package/src/all/background_page/controller/resource/updateResourceLocalStorageByFolderParentIdController.js

@@ -0,0 +1,70 @@
+/**
+ * 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.3.0
+ */
+import {assertUuid} from "../../utils/assertions";
+import FindAndUpdateResourcesLocalStorage from "../../service/resource/findAndUpdateResourcesLocalStorageService";
+import UserPassphraseRequiredError from "passbolt-styleguide/src/shared/error/userPassphraseRequiredError";
+import GetPassphraseService from "../../service/passphrase/getPassphraseService";
+
+class UpdateResourceLocalStorageByFolderParentIdController {
+  /**
+   * Constructor.
+   * @param {Worker} worker The associated worker.
+   * @param {string} requestId The associated request id.
+   * @param {ApiClientOptions} apiClientOptions The api client options.
+   * @param {AccountEntity} account The user account
+   */
+  constructor(worker, requestId, apiClientOptions, account) {
+    this.worker = worker;
+    this.requestId = requestId;
+    this.findAndUpdateResourcesLocalStorage = new FindAndUpdateResourcesLocalStorage(account, apiClientOptions);
+    this.getPassphraseService = new GetPassphraseService(account);
+  }
+
+  /**
+   * Controller executor.
+   * @param {string} parentFolderId the resources parent folder id
+   * @returns {Promise<void>}
+   */
+  async _exec(parentFolderId) {
+    try {
+      await this.exec(parentFolderId);
+      this.worker.port.emit(this.requestId, 'SUCCESS');
+    } catch (error) {
+      console.error(error);
+      this.worker.port.emit(this.requestId, 'ERROR', error);
+    }
+  }
+
+  /**
+   * Update resource local storage resource for a given folder.
+   * @param {string} parentFolderId the resources parent folder id
+   * @returns {Promise<void>}
+   */
+  async exec(parentFolderId) {
+    assertUuid(parentFolderId);
+    try {
+      await this.findAndUpdateResourcesLocalStorage.findAndUpdateAllByParentFolderId(parentFolderId);
+      return;
+    } catch (error) {
+      if (!(error instanceof UserPassphraseRequiredError)) {
+        throw error;
+      }
+    }
+
+    const passphrase = await this.getPassphraseService.getPassphrase(this.worker, 60);
+    await this.findAndUpdateResourcesLocalStorage.findAndUpdateAllByParentFolderId(parentFolderId, passphrase);
+  }
+}
+
+export default UpdateResourceLocalStorageByFolderParentIdController;

package/src/all/background_page/controller/resource/updateResourceLocalStorageByFolderParentIdController.test.js

@@ -0,0 +1,78 @@
+/**
+ * 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.3.0
+ */
+
+import {defaultApiClientOptions} from "passbolt-styleguide/src/shared/lib/apiClient/apiClientOptions.test.data";
+import AccountEntity from "../../model/entity/account/accountEntity";
+import {defaultAccountDto} from "../../model/entity/account/accountEntity.test.data";
+import {v4 as uuidv4} from "uuid";
+import UpdateResourceLocalStorageByFolderParentIdController from "./updateResourceLocalStorageByFolderParentIdController";
+import UserPassphraseRequiredError from "passbolt-styleguide/src/shared/error/userPassphraseRequiredError";
+
+describe("UpdateResourceLocalStorageByFolderParentIdController", () => {
+  let controller, worker;
+
+  beforeEach(() => {
+    worker = {
+      port: {
+        emit: jest.fn()
+      }
+    };
+    const account = new AccountEntity(defaultAccountDto());
+    const apiClientOptions = defaultApiClientOptions();
+    controller = new UpdateResourceLocalStorageByFolderParentIdController(worker, null, apiClientOptions, account);
+  });
+
+  describe("::exec", () => {
+    it("should call for update the local storage given a folder ID", async() => {
+      expect.assertions(2);
+
+      const parentFolderId = uuidv4();
+
+      jest.spyOn(controller.findAndUpdateResourcesLocalStorage, "findAndUpdateAllByParentFolderId").mockImplementation(() => {});
+
+      await controller.exec(parentFolderId);
+
+      expect(controller.findAndUpdateResourcesLocalStorage.findAndUpdateAllByParentFolderId).toHaveBeenCalledTimes(1);
+      expect(controller.findAndUpdateResourcesLocalStorage.findAndUpdateAllByParentFolderId).toHaveBeenCalledWith(parentFolderId);
+    });
+
+    it("should call for update the local storage given a folder ID a second time with a passphrase if the first time it failed", async() => {
+      expect.assertions(3);
+
+      const parentFolderId = uuidv4();
+      const passphrase = "passphrase";
+
+      jest.spyOn(controller.getPassphraseService, "getPassphrase").mockImplementation(async() => passphrase);
+      jest.spyOn(controller.findAndUpdateResourcesLocalStorage, "findAndUpdateAllByParentFolderId").mockImplementation(async(_, passphrase) => {
+        if (!passphrase) {
+          throw new UserPassphraseRequiredError("Missing passphrase");
+        }
+      });
+
+      await controller.exec(parentFolderId);
+
+      expect(controller.findAndUpdateResourcesLocalStorage.findAndUpdateAllByParentFolderId).toHaveBeenCalledTimes(2);
+      expect(controller.findAndUpdateResourcesLocalStorage.findAndUpdateAllByParentFolderId).toHaveBeenCalledWith(parentFolderId);
+      expect(controller.findAndUpdateResourcesLocalStorage.findAndUpdateAllByParentFolderId).toHaveBeenCalledWith(parentFolderId, passphrase);
+    });
+
+    it("should throw an error if the parent folder id is not a valid uuid", async() => {
+      expect.assertions(1);
+
+      const promise =  controller.exec(42);
+
+      await expect(promise).rejects.toThrowError("The given parameter is not a valid UUID");
+    });
+  });
+});

package/src/all/background_page/controller/share/shareOneFolderController.test.js

@@ -15,7 +15,7 @@ import {v4 as uuidv4} from "uuid";
 import AccountEntity from "../../model/entity/account/accountEntity";
 import {adminAccountDto} from "../../model/entity/account/accountEntity.test.data";
 import {defaultApiClientOptions} from "passbolt-styleguide/src/shared/lib/apiClient/apiClientOptions.test.data";
-import MockPort from "passbolt-styleguide/test/mocks/mockPort";
+import MockPort from "passbolt-styleguide/src/react-extension/test/mock/MockPort";
 import {
   defaultPermissionDto,
   minimumPermissionDto
@@ -26,6 +26,7 @@ import FoldersCollection from "../../model/entity/folder/foldersCollection";
 import {defaultFolderDto} from "passbolt-styleguide/src/shared/models/entity/folder/folderEntity.test.data";
 const {pgpKeys} = require("passbolt-styleguide/test/fixture/pgpKeys/keys");
 
+
 describe("ShareOneFolderController", () => {
   describe("::exec", () => {
     let account, controller;

package/src/all/background_page/controller/share/shareResourcesController.test.js

@@ -23,7 +23,7 @@ import {
 import ResourcesCollection from "../../model/entity/resource/resourcesCollection";
 import expect from "expect";
 import {defaultApiClientOptions} from "passbolt-styleguide/src/shared/lib/apiClient/apiClientOptions.test.data";
-import MockPort from "passbolt-styleguide/test/mocks/mockPort";
+import MockPort from "passbolt-styleguide/src/react-extension/test/mock/MockPort";
 import {v4 as uuidv4} from "uuid";
 import {minimumPermissionDto} from "passbolt-styleguide/src/shared/models/entity/permission/permissionEntity.test.data";
 import EncryptMessageService from "../../service/crypto/encryptMessageService";

package/src/all/background_page/event/resourceEvents.js

@@ -22,6 +22,7 @@ import FindAllByIdsForDisplayPermissionsController
 import MoveResourcesController from "../controller/move/moveResourcesController";
 import ResetResourceGridUserSettingController
   from "../controller/resourceGridSetting/resetResourceGridUserSettingController";
+import UpdateResourceLocalStorageByFolderParentIdController from "../controller/resource/updateResourceLocalStorageByFolderParentIdController";
 
 const listen = function(worker, apiClientOptions, account) {
   /*
@@ -173,6 +174,16 @@ const listen = function(worker, apiClientOptions, account) {
     const controller = new MoveResourcesController(worker, requestId, apiClientOptions, account);
     await controller._exec(resourcesIds, destinationFolderId);
   });
+
+  /*
+   * Update the local storage for resources in the specified parent folder.
+   * @listens passbolt.resources.update-local-storage-by-folder-parent-id
+   * @param {string} parentFolderId The id of the parent folder.
+   */
+  worker.port.on('passbolt.resources.update-local-storage-by-folder-parent-id', async(requestId, parentFolderId) => {
+    const controller = new UpdateResourceLocalStorageByFolderParentIdController(worker, requestId, apiClientOptions, account);
+    await controller._exec(parentFolderId);
+  });
 };
 
 export const ResourceEvents = {listen};

package/src/all/background_page/model/entity/resource/resourcesCollection.js

@@ -336,6 +336,31 @@ class ResourcesCollection extends EntityV2Collection {
     return result;
   }
 
+  /**
+   * Update the current resource collection with the given collection.
+   * If an element already exists, it is replaced, otherwise, it's added.
+   * Note: mutation of the original collection does not trigger collection validation (schema or build rules).
+   * @param {ResourcesCollection} resourcesCollection
+   */
+  updateWithCollection(resourcesCollection) {
+    assertType(resourcesCollection, ResourcesCollection);
+
+    const resourceMapByIdWithIndex = this.items.reduce((result, resource, currentIndex) => {
+      result[resource.id] = currentIndex;
+      return result;
+    }, {});
+
+    for (let i = 0; i < resourcesCollection.length; i++) {
+      const resource = resourcesCollection.items[i];
+      const mappedResourceIndex = resourceMapByIdWithIndex[resource.id];
+      if (typeof mappedResourceIndex === "undefined") {
+        this.push(resource, {validate: false});
+      } else {
+        this._items[mappedResourceIndex] = resource;
+      }
+    }
+  }
+
   /*
    * ==================================================
    * Static getters

package/src/all/background_page/model/entity/resource/resourcesCollection.test.js

@@ -446,4 +446,38 @@ describe("ResourcesCollection", () => {
       expect(() => collection.setDecryptedMetadataFromCollection("test")).toThrow('The `resourcesCollection` parameter should be a ResourcesCollection.');
     });
   });
+
+  describe("::updateWithCollection", () => {
+    it("should update the existing resources and add the new ones", () => {
+      expect.assertions(5);
+      const resource1 = defaultResourceDto();
+      const resource2 = defaultResourceDto();
+      const collection = new ResourcesCollection([resource1, resource2]);
+
+      const updatedResource2 = {
+        ...resource2,
+        metadata: defaultResourceMetadataDto({
+          name: "UPDATE - RESOURCE",
+        }),
+      };
+
+      const resource3 = defaultResourceDto();
+      const collectionForUpdate = new ResourcesCollection([resource3, updatedResource2]);
+
+      collection.updateWithCollection(collectionForUpdate);
+
+      expect(collection).toHaveLength(3);
+      expect(collection.items[0].id).toStrictEqual(resource1.id);
+      expect(collection.items[1].id).toStrictEqual(resource2.id);
+      expect(collection.items[1].metadata.name).toStrictEqual(updatedResource2.metadata.name);
+      expect(collection.items[2].id).toStrictEqual(resource3.id);
+    });
+
+    it("should assert its parameters", () => {
+      expect.assertions(1);
+      const collection = new ResourcesCollection([]);
+
+      expect(() => collection.updateWithCollection("test")).toThrow();
+    });
+  });
 });

package/src/all/background_page/service/api/resource/resourceService.js

@@ -73,6 +73,7 @@ class ResourceService extends AbstractService {
       'has-id',
       // if tag plugin
       'has-tag',
+      "has-parent",
     ];
   }
 

package/src/all/background_page/service/resource/findAndUpdateResourcesLocalStorageService.js

@@ -12,7 +12,7 @@
  * @since         4.6.0
  */
 import ResourceLocalStorage from "../local_storage/resourceLocalStorage";
-import {assertNumber} from "../../utils/assertions";
+import {assertNumber, assertUuid} from "../../utils/assertions";
 import FindResourcesService from "./findResourcesService";
 import ResourcesCollection from "../../model/entity/resource/resourcesCollection";
 import ResourceTypeModel from "../../model/resourceType/resourceTypeModel";
@@ -113,6 +113,57 @@ class FindAndUpdateResourcesLocalStorage {
     await ResourceLocalStorage.addOrReplaceResourcesCollection(resourcesCollection);
     return resourcesCollection;
   }
+
+  /**
+   * Find and update the local storage with the resources filtered by parent folder id retrieved from the API.
+   * @param {string} parentFolderId The parent folder id to filter the resources with.
+   * @param {string|null} [passphrase = null] The passphrase to use to decrypt the metadata. Marked as optional as it
+   * might be available in the passphrase session storage.
+   * @return {Promise<ResourcesCollection>} The resource shared with the group
+   * @throw {TypeError} If the parentFolderId is not valid UUID
+   */
+  async findAndUpdateAllByParentFolderId(parentFolderId, passphrase = null) {
+    assertUuid(parentFolderId);
+    const resourceTypes = await this.resourceTypeModel.getOrFindAll();
+
+    const apiResourcesCollection = await this.findResourcesServices.findAllByParentFolderIdForLocalStorage(parentFolderId);
+    apiResourcesCollection.filterByResourceTypes(resourceTypes);
+
+    const apiResourcesCollectionMapIds = apiResourcesCollection.items.reduce((result, resource) => {
+      result[resource.id] = resource;
+      return result;
+    }, {});
+
+    const localStorageResourcesCollection = new ResourcesCollection(await ResourceLocalStorage.get(), {validate: false});
+    const knownResourcesCollectionInFolderIds = localStorageResourcesCollection.items.reduce((result, resource) => {
+      if (resource.folderParentId === parentFolderId) {
+        result.push(resource.id);
+      }
+      return result;
+    }, Array(apiResourcesCollection.length));
+
+    apiResourcesCollection.setDecryptedMetadataFromCollection(localStorageResourcesCollection);
+    localStorageResourcesCollection.updateWithCollection(apiResourcesCollection);
+
+    const movedOrRemovedResourcesIds = knownResourcesCollectionInFolderIds.filter(id => !apiResourcesCollectionMapIds[id]);
+    if (movedOrRemovedResourcesIds.length > 0) {
+      const updatedResources = await this.findResourcesServices.findAllByIdsForLocalStorage(movedOrRemovedResourcesIds);
+
+      updatedResources.setDecryptedMetadataFromCollection(localStorageResourcesCollection);
+      localStorageResourcesCollection.updateWithCollection(updatedResources);
+
+      // These resources have been deleted (or permissions revoked) and need to be removed from the local storage.
+      const remainingResourcesIds = movedOrRemovedResourcesIds
+        .filter(id => !updatedResources.getFirstById(id));
+
+      localStorageResourcesCollection.removeMany(remainingResourcesIds);
+    }
+
+    await this.decryptMetadataService.decryptAllFromForeignModels(localStorageResourcesCollection, passphrase, {ignoreDecryptionError: true, updateSessionKeys: true});
+    localStorageResourcesCollection.filterOutMetadataEncrypted();
+
+    await ResourceLocalStorage.set(localStorageResourcesCollection);
+  }
 }
 
 export default FindAndUpdateResourcesLocalStorage;