Merge branch 'feature/PB-30023_Reduce-the-number-of-resources-collect…

…ions-instantiations-while-displaying-the-suggested-resources-in-the-inform-menu' into 'develop'

PB-30023 - Reduce the number of resources collections instantiations while...

See merge request passbolt/passbolt-styleguide!1521

package.json

@@ -1,6 +1,6 @@
 {
   "name": "passbolt-styleguide",
-  "version": "4.6.0-alpha.0",
+  "version": "4.6.0-alpha.1",
   "license": "AGPL-3.0",
   "copyright": "Copyright 2023 Passbolt SA",
   "description": "Passbolt styleguide contains common styling assets used by the different sites, plugin, etc.",

src/shared/models/entity/abstract/entityCollection.js

@@ -199,11 +199,27 @@ class EntityCollection {
       throw new TypeError('EntityCollection filterByPropertyValueIn expects needles to be an array.');
     }
 
-    for (let currentIndex = this._items.length - 1; currentIndex >= 0; currentIndex--) {
-      const item = this._items[currentIndex];
+    this.filterByCallback(item => {
       const isPropertyDefined = Object.prototype.hasOwnProperty.call(item._props, propName);
-      if ((excludeUndefined && !isPropertyDefined) // exclude undefined property.
-        || (isPropertyDefined && !needles.includes(item._props[propName]))) { // or exclude defined property not matching the search.
+      return !((excludeUndefined && !isPropertyDefined) // exclude undefined property.
+        || (isPropertyDefined && !needles.includes(item._props[propName]))); // or exclude defined property not matching the search.
+    });
+  }
+
+  /**
+   * Filter all items with a callback method.
+   *
+   * @param {function} callback The callback execute on each collection item used to filter the collection.
+   * @return {void} The function alters the collection itself.
+   * @throws TypeError if parameters are invalid
+   */
+  filterByCallback(callback) {
+    if (typeof callback !== "function") {
+      throw new TypeError('EntityCollection filterByCallback expects callback to be a function.');
+    }
+
+    for (let currentIndex = this._items.length - 1; currentIndex >= 0; currentIndex--) {
+      if (!callback(this._items[currentIndex])) {
         this._items.splice(currentIndex, 1);
       }
     }

src/shared/models/entity/abstract/entityCollection.test.js

@@ -279,4 +279,38 @@ describe("EntityCollection", () => {
       expect(() => collection.filterByPropertyValueIn(42)).toThrow(TypeError);
     });
   });
+
+  describe("EntityCollection::filterByCallback", () => {
+    it("should filter out all items the callback function will return false for.", () => {
+      const collection = new EntityCollection();
+      collection.push(new TestEntity({name: 'first'}));
+      collection.push(new TestEntity({name: 'second'}));
+      collection.push(new TestEntity({name: 'first'}));
+      collection.push(new TestEntity({}));
+      collection.push(new TestEntity({name: null}));
+
+      expect.assertions(1);
+      collection.filterByCallback(() => false);
+      expect(collection).toHaveLength(0);
+    });
+
+    it("should filter in all items the callback function will return false for.", () => {
+      const collection = new EntityCollection();
+      collection.push(new TestEntity({name: 'first'}));
+      collection.push(new TestEntity({name: 'second'}));
+      collection.push(new TestEntity({name: 'first'}));
+      collection.push(new TestEntity({}));
+      collection.push(new TestEntity({name: null}));
+
+      expect.assertions(1);
+      collection.filterByCallback(() => true);
+      expect(collection).toHaveLength(5);
+    });
+
+    it("should throw an exception if the callback parameter is not a function.", () => {
+      const collection = new EntityCollection();
+      expect.assertions(1);
+      expect(() => collection.filterByCallback(42)).toThrow(TypeError);
+    });
+  });
 });

src/shared/models/entity/resource/resourceEntity.test.data.js

@@ -39,9 +39,9 @@ export const defaultResourceDto = (data = {}) => {
     personal: false,
     resource_type_id: TEST_RESOURCE_TYPE_PASSWORD_AND_DESCRIPTION,
     permission: ownerPermissionDto({aco_foreign_key: id}),
-    // permissions: [],
+    // permissions: [], // Permission are not retrieved by the process storing the information in the local storage.
     favorite: null,
-    secrets: [],
+    // secrets: [], // Secrets are not retrieved by the process storing the information in the local storage.
     ...data
   };
 };