feat(models): added project patterns methods

Author: e11sy

src/models/project.ts

@@ -1,59 +1,9 @@
 import { Collection, ObjectId } from 'mongodb';
 import AbstractModel from './abstractModel';
 import { NotificationsChannelsDBScheme } from '../types/notification-channels';
-import { ProjectDBScheme } from '@hawk.so/types';
+import { ProjectDBScheme, ProjectNotificationsRuleDBScheme, ProjectEventGroupingPatternsDBScheme } from '@hawk.so/types';
 import { v4 as uuid } from 'uuid';
 
-/**
- * This structure represents a single rule of notifications settings
- */
-export interface ProjectNotificationsRuleDBScheme {
-  /**
-   * Id of Rule
-   */
-  _id: ObjectId;
-
-  /**
-   * Allows to disable rule without removing
-   */
-  isEnabled: boolean;
-
-  /**
-   * Creator of the rule
-   */
-  uidAdded: ObjectId;
-
-  /**
-   * Receive type: 'SEEN_MORE'  or 'ONLY_NEW'
-   */
-  whatToReceive: ReceiveTypes;
-
-  /**
-   * Only those which contains passed words
-   */
-  including: string[];
-
-  /**
-   * Skip those which contains passed words
-   */
-  excluding: string[];
-
-  /**
-   * Available channels to receive
-   */
-  channels: NotificationsChannelsDBScheme;
-
-  /**
-   * If this number of events is reached in the eventThresholdPeriod, the rule will be triggered
-   */
-  threshold?: number;
-
-  /**
-   * Size of period (in milliseconds) to count events to compare to rule threshold
-   */
-  thresholdPeriod?: number;
-}
-
 /**
  * Available options of 'What to receive'
  */
@@ -159,6 +109,33 @@ interface UpdateProjectNotificationsRulePayload {
   thresholdPeriod?: number;
 }
 
+/**
+ * Payload for creating new project pattern
+ */
+type CreateProjectPatternPayload = {
+  pattern: string,
+};
+
+/**
+ * Payload for updating project patterns
+ * It will just rewrite the whole lits of patterns
+ */
+type UpdateProjectPatternPayload = {
+  /**
+   * Id of the pattern to be updated
+   */
+  id: string,
+
+  /**
+   * New pattern string
+   */
+  pattern: string,
+};
+
+type RemoveProjectPatternPayload = {
+  id: string,
+}
+
 /**
  * Project model to work with project data
  */
@@ -208,6 +185,11 @@ export default class ProjectModel extends AbstractModel<ProjectDBScheme> impleme
    */
   public notifications!: ProjectNotificationsRuleDBScheme[];
 
+  /**
+   * Project events grouping pattern list
+   */
+  public eventGroupingPatterns!: ProjectEventGroupingPatternsDBScheme[];
+
   /**
    * Model's collection
    */
@@ -282,6 +264,109 @@ export default class ProjectModel extends AbstractModel<ProjectDBScheme> impleme
     return rule;
   }
 
+  /**
+   * Method for appending patterns list with new pattern
+   * @param payload - object that contains pattern string
+   * @returns - pattern, that has been added
+   */
+  public async createProjectEventGroupingPattern(payload: CreateProjectPatternPayload): Promise<ProjectEventGroupingPatternsDBScheme> {
+    const pattern: ProjectEventGroupingPatternsDBScheme = {
+      _id: new ObjectId(),
+      pattern: payload.pattern,
+    }
+
+    console.log('inserted new pattern to the db');
+
+    await this.collection.updateOne({
+      _id: this._id,
+    },
+    {
+      $push:  {
+        eventGroupingPatterns: {
+          $each: [ pattern ],
+          $position: 0,
+        }
+      }
+    });
+
+    console.log('pattern: ', pattern);
+
+    return pattern;
+  }
+
+  /**
+   * Method that rewrites pattern by id
+   * @param payload - object that contains id of the pattern to be updated and new pattern string
+   * @returns - updated pattern
+   */
+  public async updateProjectEventGroupingPattern(payload: UpdateProjectPatternPayload): Promise<ProjectEventGroupingPatternsDBScheme> {
+    const udpatedPattern = {
+      _id: new ObjectId(payload.id),
+      pattern: payload.pattern
+    }
+    
+    await this.collection.updateOne({
+      _id: this._id, "eventGroupingPatterns._id": new ObjectId(udpatedPattern._id)
+    },
+    { 
+      $set: { "eventGroupingPatterns.$.pattern": udpatedPattern.pattern } 
+    });
+    
+    return udpatedPattern;
+  }
+
+  /**
+   * Method that gets all patterns for project
+   * @returns - list of patterns related to the current project
+   */
+  public async getProjectPatterns(): Promise<ProjectEventGroupingPatternsDBScheme[]> {
+    const project = await this.collection.findOne({
+      _id: this._id,
+    });
+
+    if (!project) {
+      throw new Error('Project with such id does not exist');
+    }
+
+    return project.eventGroupingPatterns ?? [];
+  }
+
+  /**
+   * Method that removes pattern by its id
+   * @param payload - object that contains id of the pattern to be removed
+   */
+  public async removeProjectEventGroupingPattern(payload: RemoveProjectPatternPayload): Promise<ProjectEventGroupingPatternsDBScheme> {
+    const project = await this.collection.findOne({
+      _id: this._id,
+    });
+
+    if (!project) {
+      throw new Error ('Project with such id does not exist');
+    }
+
+    const patternList = await this.collection.findOne(
+      { _id: this._id, "eventGroupingPatterns._id": new ObjectId(payload.id) },
+      { projection: { "eventGroupingPatterns.$": 1 } }
+    );
+    
+    const deletedPattern = patternList?.eventGroupingPatterns[0];
+
+    if (deletedPattern === undefined) {
+      throw new Error ('Pattern with such id does not exist')
+    }
+
+    await this.collection.updateOne(
+      {
+        _id: new ObjectId(this._id)
+      },
+      { 
+        $pull: { eventGroupingPatterns: { _id: new ObjectId(payload.id) } } 
+      }
+    );
+
+    return deletedPattern;
+  }
+
   /**
    * Updates notifications rule in project
    * @param payload - data for updating