Feature to delete workspace

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hawk.api",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "main": "index.ts",
   "license": "UNLICENSED",
   "scripts": {

src/dataLoaders.ts

@@ -83,6 +83,9 @@ export default class DataLoaders {
     const queryResult = await this.dbConnection.collection(collectionName)
       .find({
         [fieldName]: { $in: values },
+        isRemoved: {
+          $ne: true,
+        },
       })
       .toArray();
 

src/models/project.ts

@@ -194,6 +194,7 @@ export default class ProjectModel extends AbstractModel<ProjectDBScheme> impleme
 
   /**
    * Generates integration ID that's used in collector URL for sending events
+   * @returns integration ID as string.
    */
   public static generateIntegrationId(): string {
     return uuid.v4();
@@ -203,6 +204,7 @@ export default class ProjectModel extends AbstractModel<ProjectDBScheme> impleme
    * Generates new integration token with integration id field
    *
    * @param integrationId - integration id for using in collector URL
+   * @returns  generated integration token.
    */
   public static generateIntegrationToken(integrationId: string): string {
     const secret = uuid.v4();
@@ -383,4 +385,24 @@ export default class ProjectModel extends AbstractModel<ProjectDBScheme> impleme
       console.log(error);
     }
   }
+
+  /**
+   * Mark project as removed.
+   */
+  public async markProjectAsRemoved(): Promise<void> {
+    await this.collection.updateOne({ _id: this._id }, {
+      $set: { isRemoved: true },
+    });
+
+    try {
+      /**
+       * Remove users in project collection
+       */
+      await this.dbConnection.collection('users-in-project:' + this._id)
+        .drop();
+    } catch (error) {
+      console.log(`Can't remove collection "users-in-project:${this._id}" because it doesn't exist.`);
+      console.log(error);
+    }
+  }
 }

src/models/projectToWorkspace.js

@@ -15,7 +15,7 @@ const { ObjectID } = require('mongodb');
 class ProjectToWorkspace {
   /**
    * Creates an instance of ProjectToWorkspace
-   * @param {string|ObjectID} workspaceId
+   * @param {string|ObjectID} workspaceId workspace.
    */
   constructor(workspaceId) {
     this.workspaceId = new ObjectID(workspaceId);
@@ -53,6 +53,9 @@ class ProjectToWorkspace {
   async findById(projectWorkspaceId) {
     const projectWorkspace = await this.collection.findOne({
       _id: new ObjectID(projectWorkspaceId),
+      isRemoved: {
+        $ne: true,
+      },
     });
 
     if (!projectWorkspace) {

src/models/user.ts

@@ -62,7 +62,7 @@ export interface UserNotificationsDBScheme {
   /**
    * Types of notifications to receive
    */
-  whatToReceive: {[key in UserNotificationType]: boolean};
+  whatToReceive: { [key in UserNotificationType]: boolean };
 }
 
 /**
@@ -165,14 +165,15 @@ export default class UserModel extends AbstractModel<UserDBScheme> implements Us
 
   /**
    * Generate 16bytes password
+   * @returns generated password.
    */
   public static generatePassword(): Promise<string> {
     return new Promise((resolve, reject) => {
       crypto.randomBytes(8, (err, buff) => {
         if (err) {
           return reject(err);
         }
-
+        console.log(buff.toString('hex'));
         resolve(buff.toString('hex'));
       });
     });
@@ -182,6 +183,7 @@ export default class UserModel extends AbstractModel<UserDBScheme> implements Us
    * Compose default notifications settings for new users.
    *
    * @param email - user email from the sign-up form will be used as email-channel endpoint
+   * @returns default notification settings for new users.
    */
   public static generateDefaultNotificationsSettings(email: string): UserNotificationsDBScheme {
     return {
@@ -212,7 +214,6 @@ export default class UserModel extends AbstractModel<UserDBScheme> implements Us
    * Change user's password
    * Hashes new password and updates the document
    *
-   * @param userId - user ID
    * @param newPassword - new user password
    */
   public async changePassword(newPassword: string): Promise<void> {
@@ -230,7 +231,6 @@ export default class UserModel extends AbstractModel<UserDBScheme> implements Us
 
   /**
    * Update user profile data
-   * @param userId - user ID
    * @param  user – user object
    */
   public async updateProfile(user: Partial<UserDBScheme>): Promise<void> {
@@ -317,7 +317,7 @@ export default class UserModel extends AbstractModel<UserDBScheme> implements Us
    * Remove workspace from membership collection
    * @param workspaceId - id of workspace to remove
    */
-  public async removeWorkspace(workspaceId: string): Promise<{workspaceId: string}> {
+  public async removeWorkspace(workspaceId: string): Promise<{ workspaceId: string }> {
     await this.membershipCollection.deleteOne({
       workspaceId: new ObjectId(workspaceId),
     });
@@ -327,6 +327,22 @@ export default class UserModel extends AbstractModel<UserDBScheme> implements Us
     };
   }
 
+  /**
+   * Mark workspace as removed.
+   * @param workspaceId - id of workspace to remove
+   */
+  public async markWorkspaceAsRemoved(workspaceId: string): Promise<{ workspaceId: string }> {
+    await this.membershipCollection.updateOne({
+      workspaceId: new ObjectId(workspaceId),
+    }, {
+      $set: { isRemoved: true },
+    });
+
+    return {
+      workspaceId,
+    };
+  }
+
   /**
    * Confirm membership of workspace by id
    * @param workspaceId - workspace id to confirm
@@ -351,10 +367,16 @@ export default class UserModel extends AbstractModel<UserDBScheme> implements Us
       workspaceId: {
         $in: idsAsObjectId,
       },
+      isRemoved: {
+        $ne: true,
+      },
       isPending: {
         $ne: true,
       },
     } : {
+      isRemoved: {
+        $ne: true,
+      },
       isPending: {
         $ne: true,
       },

src/models/workspace.ts

@@ -94,6 +94,7 @@ export default class WorkspaceModel extends AbstractModel<WorkspaceDBScheme> imp
 
   /**
    * Generates SHA-256 hash that used as invite hash
+   * @returns invitation hash as string.
    */
   public static generateInviteHash(): string {
     return crypto
@@ -106,6 +107,7 @@ export default class WorkspaceModel extends AbstractModel<WorkspaceDBScheme> imp
    * Checks is provided document represents pending member
    *
    * @param doc - doc to check
+   * @returns status of is current member pending.
    */
   public static isPendingMember(doc: MemberDBScheme): doc is PendingMemberDBScheme {
     return !!(doc as PendingMemberDBScheme).userEmail && !(doc as ConfirmedMemberDBScheme).userId;
@@ -127,6 +129,20 @@ export default class WorkspaceModel extends AbstractModel<WorkspaceDBScheme> imp
     }
   }
 
+  /**
+   * Mark workspace as removed.
+   */
+  public async markWorkspaceAsRemoved(): Promise<void> {
+    /**
+     * Delete the workspace data.
+     */
+    await this.collection.updateOne({
+      _id: new ObjectId(this._id),
+    }, {
+      $set: { isRemoved: true },
+    });
+  }
+
   /**
    * Update invite hash of workspace
    * @param inviteHash - new invite hash
@@ -407,6 +423,7 @@ export default class WorkspaceModel extends AbstractModel<WorkspaceDBScheme> imp
 
   /**
    * Due date of the current workspace tariff plan
+   * @returns Date object of due date.
    */
   public getTariffPlanDueDate(): Date {
     const lastChargeDate = new Date(this.lastChargeDate);
@@ -415,7 +432,8 @@ export default class WorkspaceModel extends AbstractModel<WorkspaceDBScheme> imp
   }
 
   /**
-   * Is tariff plan expired or not
+   * Is tariff plan expired or not.
+   * @returns current status of tariff plan.
    */
   public isTariffPlanExpired(): boolean {
     const date = new Date();

src/models/workspacesFactory.ts

@@ -99,7 +99,16 @@ export default class WorkspacesFactory extends AbstractModelFactory<WorkspaceDBS
    * @param inviteHash - workspace invite hash
    */
   public async findByInviteHash(inviteHash: string): Promise<WorkspaceModel | null> {
-    const workspaceData = await this.collection.findOne({ inviteHash });
+    const workspaceData = await this.collection.findOne({
+      inviteHash,
+      isRemoved: {
+        $ne: true,
+      },
+    });
+
+    if (!workspaceData) {
+      return null;
+    }
 
     return workspaceData && new WorkspaceModel(workspaceData);
   }