passbolt-browser-extension 3.0.6 → 4.6.2

package/src/all/background_page/model/entity/avatar/avatarEntity.js

@@ -11,8 +11,8 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         2.13.0
  */
-const {Entity} = require('../abstract/entity');
-const {EntitySchema} = require('../abstract/entitySchema');
+import Entity from "passbolt-styleguide/src/shared/models/entity/abstract/entity";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
 
 const ENTITY_NAME = 'Avatar';
 const AVATAR_URL_SIZE_SMALL = 'small';
@@ -20,17 +20,14 @@ const AVATAR_URL_SIZE_MEDIUM = 'medium';
 
 class AvatarEntity extends Entity {
   /**
-   * Avatar entity constructor
-   *
-   * @param {Object} avatarDto avatar DTO
-   * @throws EntityValidationError if the dto cannot be converted into an entity
+   * @inheritDoc
    */
-  constructor(avatarDto) {
+  constructor(avatarDto, options = {}) {
     super(EntitySchema.validate(
       AvatarEntity.ENTITY_NAME,
       avatarDto,
       AvatarEntity.getSchema()
-    ));
+    ), options);
   }
 
   /**
@@ -48,10 +45,6 @@ class AvatarEntity extends Entity {
           "type": "string",
           "format": "uuid"
         },
-        // "user_id": {
-        //   "type": "string",
-        //   "format": "uuid"
-        // },
         "url": {
           "type": "object",
           "required": [
@@ -78,12 +71,14 @@ class AvatarEntity extends Entity {
           "format": "date-time"
         },
       }
-    }
+    };
   }
 
-  // ==================================================
-  // Dynamic properties getters
-  // ==================================================
+  /*
+   * ==================================================
+   * Dynamic properties getters
+   * ==================================================
+   */
   /**
    * Get avatar id
    * @returns {(string|null)} uuid
@@ -92,14 +87,6 @@ class AvatarEntity extends Entity {
     return this._props.id || null;
   }
 
-  /**
-   * Get user id
-   * @returns {(string|null)}
-   */
-  get userId() {
-    return this._props.user_id || null;
-  }
-
   /**
    * Get url (medium size)
    * @returns {*}
@@ -116,22 +103,6 @@ class AvatarEntity extends Entity {
     return this._props.url["small"];
   }
 
-  /**
-   * Get avatar url
-   *
-   * @param {string} size medium|small
-   * @returns {string} admin or user
-   */
-   getUrl(size) {
-    if (!size) {
-      throw new TypeError('A size is needed.');
-    }
-    if (size !== 'medium' || size !== 'small') {
-      throw new TypeError('Invalid size, use small or medium.');
-    }
-    return this._props.url[size];
-  }
-
   /**
    * Get avatar creation date
    * @returns {(string|null)} date
@@ -148,9 +119,11 @@ class AvatarEntity extends Entity {
     return this._props.modified || null;
   }
 
-  // ==================================================
-  // Static properties getters
-  // ==================================================
+  /*
+   * ==================================================
+   * Static properties getters
+   * ==================================================
+   */
   /**
    * AvatarEntity.ENTITY_NAME
    * @returns {string}
@@ -176,4 +149,4 @@ class AvatarEntity extends Entity {
   }
 }
 
-exports.AvatarEntity = AvatarEntity;
+export default AvatarEntity;

package/src/all/background_page/model/entity/avatar/avatarEntity.test.js

@@ -11,64 +11,141 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         2.13.0
  */
-import {AvatarEntity} from "./avatarEntity";
-import {EntitySchema} from "../abstract/entitySchema";
-import Validator from 'validator';
 
-// Reset the modules before each test.
-beforeEach(() => {
-  window.Validator = Validator;
-  jest.resetModules();
-});
+import each from "jest-each";
+import AvatarEntity from "./avatarEntity";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
+import {
+  defaultAvatarDto,
+  minimalAvatarDto
+} from "passbolt-styleguide/src/shared/models/entity/avatar/avatarEntity.test.data";
+import Validator from "validator";
+import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
 
-describe("Role entity", () => {
-  it("schema must validate", () => {
-    EntitySchema.validateSchema(AvatarEntity.ENTITY_NAME, AvatarEntity.getSchema());
-  });
+describe("AvatarEntity", () => {
+  describe("AvatarEntity:constructor", () => {
+    it("schema must validate", () => {
+      EntitySchema.validateSchema(AvatarEntity.ENTITY_NAME, AvatarEntity.getSchema());
+    });
 
-  it("constructor works if valid minimal DTO is provided", () => {
-    let dto = {
-      "id":"ae1cd004-d1f6-4e7b-a3c7-3b28da81e9e8",
-      "user_id":"597f24ea-a4cc-4d21-a24e-2181ac1f17ef",
-      "foreign_key":"597f24ea-de28-4b96-9073-2181ac1f17ef",
-      "model":"Avatar",
-      "filename":"avatar.png",
-      "filesize":102968,
-      "mime_type":"image\/png",
-      "extension":"png",
-      "hash":"bc1cd004d1f64e7ba3c67b28da81e9e8",
-      "path":"Avatar\/39\/71\/4b\/ae1cd004fff64e7ba3c73b384481e9e8\/bc1cd004d1f64e7ba3c67b28da81e9e8.png",
-      "adapter":"Local",
-      "created":"2020-03-26T11:14:02+00:00",
-      "modified":"2020-03-26T11:14:02+00:00",
-      "url": {
-        "medium":"img\/public\/Avatar\/39\/71\/4b\/ae1cd004fff64e7ba3c73b384481e9e8\/bc1cd004d1f64e7ba3c67b28da81e9e8.a99472d5.png",
-        "small":"img\/public\/Avatar\/39\/71\/4b\/ae1cd004fff64e7ba3c73b384481e9e8\/bc1cd004d1f64e7ba3c67b28da81e9e8.65a0ba70.png"
-      },
-    };
-    const entity = new AvatarEntity(dto);
-    expect(entity.id).toEqual('ae1cd004-d1f6-4e7b-a3c7-3b28da81e9e8');
-    //expect(entity.userId).toEqual('597f24ea-a4cc-4d21-a24e-2181ac1f17ef');
-    expect(entity.urlMedium).toEqual('img/public/Avatar/39/71/4b/ae1cd004fff64e7ba3c73b384481e9e8/bc1cd004d1f64e7ba3c67b28da81e9e8.a99472d5.png');
-    expect(entity.urlSmall).toEqual('img/public/Avatar/39/71/4b/ae1cd004fff64e7ba3c73b384481e9e8/bc1cd004d1f64e7ba3c67b28da81e9e8.65a0ba70.png');
-    expect(entity.created).toEqual('2020-03-26T11:14:02+00:00');
-    expect(entity.modified).toEqual('2020-03-26T11:14:02+00:00');
-    expect(entity._hasProp('filesize')).toBe(false);
-    expect(entity._hasProp('model')).toBe(false);
-    expect(entity._hasProp('mime_type')).toBe(false);
-    expect(entity._hasProp('hash')).toBe(false);
-    expect(entity._hasProp('filesize')).toBe(false);
-  });
+    it("constructor works if valid minimal DTO is provided", () => {
+      const dto = minimalAvatarDto();
+      const entity = new AvatarEntity(dto);
+      expect(entity.id).toBeNull();
+      expect(entity.urlMedium).toEqual('img/avatar/user_medium.png');
+      expect(entity.urlSmall).toEqual('img/avatar/user.png');
+      expect(entity.created).toBeNull();
+      expect(entity.modified).toBeNull();
+    });
 
-  it("constructor works if valid DTO is provided with optional and non supported fields", () => {
+    it("constructor works if valid DTO is provided with optional properties", () => {
+      const dto = defaultAvatarDto();
+      const entity = new AvatarEntity(dto);
+      expect(Validator.isUUID(entity.id)).toBe(true);
+      expect(entity.urlMedium).toEqual('/avatars/view/e6927385-195c-4c7f-a107-a202ea86de40/medium.jpg');
+      expect(entity.urlSmall).toEqual('/avatars/view/e6927385-195c-4c7f-a107-a202ea86de40/small.jpg');
+      expect(entity.created).toEqual('2023-06-03T12:03:46+00:00');
+      expect(entity.modified).toEqual('2023-06-03T12:03:46+00:00');
+    });
 
-  });
+    each([
+      {scenario: 'valid uuid', rule: 'format', value: 'invalid-id'},
+      {scenario: 'valid format', rule: 'type', value: 42},
+    ]).describe("Should validate the id", test => {
+      it(`Should not accept: ${test.scenario}`, async() => {
+        expect.assertions(2);
+        const dto = defaultAvatarDto({
+          id: test.value
+        });
+        try {
+          new AvatarEntity(dto);
+        } catch (error) {
+          expect(error).toBeInstanceOf(EntityValidationError);
+          expect(error.hasError('id', test.rule)).toBeTruthy();
+        }
+      });
+    });
+
+    each([
+      {scenario: 'required', rule: 'type'},
+      {scenario: 'valid url object', rule: 'type', value: 42},
+      /*
+       * @todo Should validate small & medium urls
+       * {scenario: 'valid medium url', rule: 'type', value: {
+       *     medium: 42
+       *   }},
+       * {scenario: 'valid small url', rule: 'type', value: {
+       *     medium: 42
+       *   }},
+       */
+    ]).describe("Should validate the url", test => {
+      it(`Should not accept: ${test.scenario}`, async() => {
+        expect.assertions(2);
+        const dto = defaultAvatarDto({
+          url: test.value
+        });
+        try {
+          new AvatarEntity(dto);
+        } catch (error) {
+          expect(error).toBeInstanceOf(EntityValidationError);
+          expect(error.hasError('url', test.rule)).toBeTruthy();
+        }
+      });
+    });
 
-  it("constructor returns validation error if dto required fields are missing", () => {
+    each([
+      {scenario: 'is not required but cannot be null', rule: null},
+      {scenario: 'valid url object', rule: 'type', value: 42},
+    ]).describe("Should validate the created", test => {
+      it(`Should not accept: ${test.scenario}`, async() => {
+        expect.assertions(2);
+        const dto = defaultAvatarDto({
+          created: test.value
+        });
+        try {
+          new AvatarEntity(dto);
+        } catch (error) {
+          expect(error).toBeInstanceOf(EntityValidationError);
+          expect(error.hasError('created', test.rule)).toBeTruthy();
+        }
+      });
+    });
 
+    each([
+      {scenario: 'is not required but cannot be null', rule: null},
+      {scenario: 'valid url object', rule: 'type', value: 42},
+    ]).describe("Should validate the modified", test => {
+      it(`Should not accept: ${test.scenario}`, async() => {
+        expect.assertions(2);
+        const dto = defaultAvatarDto({
+          modified: test.value
+        });
+        try {
+          new AvatarEntity(dto);
+        } catch (error) {
+          expect(error).toBeInstanceOf(EntityValidationError);
+          expect(error.hasError('modified', test.rule)).toBeTruthy();
+        }
+      });
+    });
   });
 
-  it("constructor returns validation error if dto fields are invalid", () => {
+  describe("AvatarEntity:toDto", () => {
+    it("should return the expected properties.", () => {
+      expect.assertions(2);
+      const expectedKeys = [
+        "id",
+        "url",
+        "created",
+        "modified",
+      ];
 
+      const dto = defaultAvatarDto();
+      const entity = new AvatarEntity(dto);
+      const resultDto = entity.toDto();
+      const keys = Object.keys(resultDto);
+      expect(keys).toEqual(expectedKeys);
+      expect(Object.keys(resultDto).length).toBe(expectedKeys.length);
+    });
   });
 });

package/src/all/background_page/model/entity/avatar/update/avatarUpdateEntity.js

@@ -11,25 +11,25 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         2.13.0
  */
-const {Entity} = require('../../abstract/entity');
-const {EntitySchema} = require('../../abstract/entitySchema');
-const {b64ToBlob} = require("../../../../utils/format/base64");
+import Entity from "passbolt-styleguide/src/shared/models/entity/abstract/entity";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
+import b64ToBlob from "../../../../utils/format/base64";
+
 
 const ENTITY_NAME = 'AvatarUpdate';
 
 class AvatarUpdateEntity extends Entity {
   /**
-   * Avatar entity constructor
-   *
-   * @param {Object} avatarUpdateDto avatar DTO
-   * @throws EntityValidationError if the dto cannot be converted into an entity
+   * @inheritDoc
+   * Note: The entity does not clone the DTO file blob, a functionality not supported by the inherited entity's
+   * cloning process. Doesn't embed this entity into another one for this reason.
    */
-  constructor(avatarUpdateDto) {
+  constructor(avatarUpdateDto, options = {}) {
     super(EntitySchema.validate(
       AvatarUpdateEntity.ENTITY_NAME,
       avatarUpdateDto,
       AvatarUpdateEntity.getSchema()
-    ));
+    ), options);
     // The default behavior of the constructor is to serialize/unserialize the props to ensure a deep copy, it doesn't work with Blob.
     this.file = avatarUpdateDto.file;
   }
@@ -48,7 +48,7 @@ class AvatarUpdateEntity extends Entity {
     const fileBase64 = avatarBase64UpdateDto.fileBase64;
     const mimeType = avatarBase64UpdateDto.mimeType;
     const file = b64ToBlob(fileBase64, mimeType);
-    const avatarUpdateDto = {file, filename, mimeType};
+    const avatarUpdateDto = {file: file, filename: filename, mimeType: mimeType};
     return new AvatarUpdateEntity(avatarUpdateDto);
   }
 
@@ -75,12 +75,14 @@ class AvatarUpdateEntity extends Entity {
           "type": "string"
         }
       }
-    }
+    };
   }
 
-  // ==================================================
-  // Dynamic properties getters
-  // ==================================================
+  /*
+   * ==================================================
+   * Dynamic properties getters
+   * ==================================================
+   */
 
   /**
    * Get the file
@@ -114,9 +116,11 @@ class AvatarUpdateEntity extends Entity {
     return this._props.mimeType;
   }
 
-  // ==================================================
-  // Static properties getters
-  // ==================================================
+  /*
+   * ==================================================
+   * Static properties getters
+   * ==================================================
+   */
 
   /**
    * AvatarEntity.ENTITY_NAME
@@ -127,4 +131,4 @@ class AvatarUpdateEntity extends Entity {
   }
 }
 
-exports.AvatarUpdateEntity = AvatarUpdateEntity;
+export default AvatarUpdateEntity;

package/src/all/background_page/model/entity/comment/commentEntity.js

@@ -11,10 +11,10 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         3.0.0
  */
-const {Entity} = require('../abstract/entity');
-const {EntitySchema} = require('../abstract/entitySchema');
-const {ResourceEntity} = require('../resource/resourceEntity');
-const {UserEntity} = require('../user/userEntity');
+import ResourceEntity from "../resource/resourceEntity";
+import Entity from "passbolt-styleguide/src/shared/models/entity/abstract/entity";
+import UserEntity from "../user/userEntity";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
 
 const ENTITY_NAME = 'Comment';
 const COMMENT_CONTENT_MIN_LENGTH = 1;
@@ -29,25 +29,22 @@ const ALLOWED_FOREIGN_MODELS = [
 
 class CommentEntity extends Entity {
   /**
-   * Comment entity constructor
-   *
-   * @param {Object} commentDto comment DTO
-   * @throws EntityValidationError if the dto cannot be converted into an entity
+   * @inheritDoc
    */
-  constructor(commentDto) {
+  constructor(commentDto, options = {}) {
     super(EntitySchema.validate(
       CommentEntity.ENTITY_NAME,
       commentDto,
       CommentEntity.getSchema()
-    ));
+    ), options);
 
     // Associations
     if (this._props.creator) {
-      this._creator = new UserEntity(this._props.creator);
+      this._creator = new UserEntity(this._props.creator, {clone: false});
       delete this._props.creator;
     }
     if (this._props.modifier) {
-      this._modifier = new UserEntity(this._props.modifier);
+      this._modifier = new UserEntity(this._props.modifier, {clone: false});
       delete this._props.modifier;
     }
   }
@@ -115,19 +112,21 @@ class CommentEntity extends Entity {
         "creator": UserEntity.getSchema(),
         "modifier": UserEntity.getSchema(),
       }
-    }
+    };
   }
 
-  // ==================================================
-  // Serialization
-  // ==================================================
+  /*
+   * ==================================================
+   * Serialization
+   * ==================================================
+   */
   /**
    * Return a DTO ready to be sent to API
    * @param {object} [contain] optional for example {creator: false, modifier: false}
    * @returns {*}
    */
   toDto(contain) {
-    let result = Object.assign({}, this._props);
+    const result = Object.assign({}, this._props);
     if (!contain) {
       return result;
     }
@@ -148,9 +147,11 @@ class CommentEntity extends Entity {
     return this.toDto(CommentEntity.ALL_CONTAIN_OPTIONS);
   }
 
-  // ==================================================
-  // Dynamic properties getters
-  // ==================================================
+  /*
+   * ==================================================
+   * Dynamic properties getters
+   * ==================================================
+   */
   /**
    * Get comment id
    * @returns {(string|null)} uuid
@@ -231,9 +232,11 @@ class CommentEntity extends Entity {
     return this._props.modified_by || null;
   }
 
-  // ==================================================
-  // Associated properties getters
-  // ==================================================
+  /*
+   * ==================================================
+   * Associated properties getters
+   * ==================================================
+   */
   /**
    * Get user profile of person who created the comment
    * @returns {(UserEntity|null)} user
@@ -250,9 +253,11 @@ class CommentEntity extends Entity {
     return this._modifier || null;
   }
 
-  // ==================================================
-  // Static properties getters
-  // ==================================================
+  /*
+   * ==================================================
+   * Static properties getters
+   * ==================================================
+   */
   /**
    * CommentEntity.ENTITY_NAME
    * @returns {string}
@@ -297,4 +302,4 @@ class CommentEntity extends Entity {
   }
 }
 
-exports.CommentEntity = CommentEntity;
+export default CommentEntity;

package/src/all/background_page/model/entity/comment/commentEntity.test.js

@@ -11,16 +11,9 @@
  * @link          https://www.passbolt.com Passbolt(tm)
  * @since         3.0.0
  */
-import {CommentEntity} from "./commentEntity";
-import {EntityValidationError} from "../abstract/entityValidationError";
-import {EntitySchema} from "../abstract/entitySchema";
-import Validator from 'validator';
-
-// Reset the modules before each test.
-beforeEach(() => {
-  window.Validator = Validator;
-  jest.resetModules();
-});
+import CommentEntity from "./commentEntity";
+import EntityValidationError from "passbolt-styleguide/src/shared/models/entity/abstract/entityValidationError";
+import EntitySchema from "passbolt-styleguide/src/shared/models/entity/abstract/entitySchema";
 
 const minimalDto = {
   "user_id": "a58de6d3-f52c-5080-b79b-a601a647ac85",
@@ -90,12 +83,12 @@ describe("Comment entity", () => {
 
   it("constructor returns validation error if dto required fields are missing", () => {
     const required = ["user_id", "foreign_key", "foreign_model", "content"];
-    for (let i in required) {
-      let sut = Object.assign(minimalDto);
-      if (required.hasOwnProperty(i) && sut.hasOwnProperty(required[i])) {
-        let field = required[i];
+    for (const i in required) {
+      const sut = Object.assign(minimalDto);
+      if (Object.prototype.hasOwnProperty.call(required, i) && Object.prototype.hasOwnProperty.call(sut, required[i])) {
+        const field = required[i];
         delete sut[field];
-        let t = () => {
+        const t = () => {
           new CommentEntity(sut);
         };
         expect(t).toThrow(EntityValidationError);
@@ -116,11 +109,11 @@ describe("Comment entity", () => {
       "created_by": "a58de6d3-f52c-5080-b79b-a601a647ac85",
       "modified_by": "a58de6d3-f52c-5080-b79b-a601a647ac85"
     };
-    for (let i in uuids) {
-      let sut = Object.assign(dto);
-      if (uuids.hasOwnProperty(i) && sut.hasOwnProperty(uuids[i])) {
+    for (const i in uuids) {
+      const sut = Object.assign(dto);
+      if (Object.prototype.hasOwnProperty.call(uuids, i) && Object.prototype.hasOwnProperty.call(sut, uuids[i])) {
         sut[uuids[i]] = 'not a uuid';
-        let t = () => {new CommentEntity(sut);};
+        const t = () => { new CommentEntity(sut); };
         expect(t).toThrow(EntityValidationError);
       } else {
         expect(false).toBe(true);
@@ -203,11 +196,11 @@ describe("Comment entity", () => {
     expect(entity.creator.profile.avatar.urlMedium).toBe('img\/public\/Avatar\/f5\/02\/2f\/b98d0c19c79841b4bcb98d44036f3234\/b98d0c19c79841b4bcb98d44036f3234.a99472d5.png');
 
     const serializedDto = entity.toDto();
-    expect(serializedDto.hasOwnProperty('creator')).toBe(false);
-    expect(serializedDto.hasOwnProperty('modifier')).toBe(false);
+    expect(Object.prototype.hasOwnProperty.call(serializedDto, 'creator')).toBe(false);
+    expect(Object.prototype.hasOwnProperty.call(serializedDto, 'modifier')).toBe(false);
 
-    const serializedDtoWithAssoc = entity.toDto({creator:true, modifier:true});
-    expect(serializedDtoWithAssoc.hasOwnProperty('creator')).toBe(true);
-    expect(serializedDtoWithAssoc.hasOwnProperty('modifier')).toBe(true);
+    const serializedDtoWithAssoc = entity.toDto({creator: true, modifier: true});
+    expect(Object.prototype.hasOwnProperty.call(serializedDtoWithAssoc, 'creator')).toBe(true);
+    expect(Object.prototype.hasOwnProperty.call(serializedDtoWithAssoc, 'modifier')).toBe(true);
   });
-});
+});

package/src/all/background_page/model/entity/comment/comments.test.data.js

@@ -0,0 +1,45 @@
+/**
+ * Passbolt ~ Open source password manager for teams
+ * Copyright (c) 2022 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) 2022 Passbolt SA (https://www.passbolt.com)
+ * @license       https://opensource.org/licenses/AGPL-3.0 AGPL License
+ * @link          https://www.passbolt.com Passbolt(tm)
+ * @since         3.8.0
+ */
+
+import {v4 as uuidv4} from "uuid";
+
+const foreingModel = "Resource";
+
+export const commentsMockDto = () => {
+  const foreignKey = uuidv4();
+  const comment1 = {
+    "id": uuidv4(),
+    "user_id": uuidv4(),
+    "foreign_key": foreignKey,
+    "foreign_model": foreingModel,
+    "content": "comment1"
+  };
+  const comment2 = {
+    "id": uuidv4(),
+    "user_id": uuidv4(),
+    "foreign_key": foreignKey,
+    "foreign_model": foreingModel,
+    "content": "comment2"
+  };
+  return [comment1, comment2];
+};
+
+export const commentCreationMock = () => ({
+  "user_id": uuidv4(),
+  "foreign_key": uuidv4(),
+  "foreign_model": foreingModel,
+  "content": "comment3"
+});
+
+export const commentResponseMock = creationMock => Object.assign({id: uuidv4()}, creationMock);