Update prod (#467)

* types(notification-rule): respect new notification model

* Bump version up to 1.1.2

* chore(dependencies): update hawk.so/types

* Bump version up to 1.1.7

* chore (yarn) update yarn lock file

* types(notifications): update typeDefs

* types(resolvers): update projectNotifications types for resolvers

* feat(models): add extra fields for update and create notification rule methods

* types(notifications): improve notifications graphql schemas

* imp(resolver): improved notification rules resolver

* Return back business operation

* Operation type

* Bump version up to 1.1.10

* fix(resolvers): improve create rule data validation

* imp(resolvers): add channels validation for rules in api resolvers

* clean(resolvers): remove redundant validation

* chore(): lint fix

* Update types

* Update package.json

* bump package version

* fix(): build fix

---------

Co-authored-by: e11sy <130844513+e11sy@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Tanya Fomina <fomina.tatianaaa@yandex.ru>

Author: 3 people

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hawk.api",
-  "version": "1.1.9",
+  "version": "1.1.12",
   "main": "index.ts",
   "license": "UNLICENSED",
   "scripts": {
@@ -37,7 +37,7 @@
     "@graphql-tools/schema": "^8.5.1",
     "@graphql-tools/utils": "^8.9.0",
     "@hawk.so/nodejs": "^3.1.1",
-    "@hawk.so/types": "^0.1.21",
+    "@hawk.so/types": "^0.1.26",
     "@types/amqp-connection-manager": "^2.0.4",
     "@types/bson": "^4.0.5",
     "@types/debug": "^4.1.5",

src/billing/cloudpayments.ts

@@ -205,36 +205,6 @@ export default class CloudPaymentsWebhooks {
     return `${workspace.name} ${now.getDate()}/${now.getMonth() + 1} ${tariffPlan.name}`;
   }
 
-  /**
-   * Confirms the correctness of a user's payment for card linking
-   * @param req - express request
-   * @param res - express response
-   * @param data - payment data receinved from checksum and request payload
-   */
-  private async checkCardLinkOperation(req: express.Request, res: express.Response, data: PaymentData): Promise<void> {
-    if (data.isCardLinkOperation && (!data.userId || !data.workspaceId)) {
-      this.sendError(res, CheckCodes.PAYMENT_COULD_NOT_BE_ACCEPTED, '[Billing / Check] Card linking – invalid data', req.body);
-
-      return;
-    }
-
-    try {
-      const workspace = await this.getWorkspace(req, data.workspaceId);
-
-      telegram
-        .sendMessage(`✅ [Billing / Check] Card linked for subscription workspace «${workspace.name}»`, TelegramBotURLs.Money)
-        .catch(e => console.error('Error while sending message to Telegram: ' + e));
-
-      res.json({
-        code: CheckCodes.SUCCESS,
-      } as CheckResponse);
-    } catch (e) {
-      const error = e as Error;
-
-      this.sendError(res, CheckCodes.PAYMENT_COULD_NOT_BE_ACCEPTED, `[Billing / Check] ${error.toString()}`, req.body);
-    }
-  }
-
   /**
    * Route to confirm the correctness of a user's payment
    * https://developers.cloudpayments.ru/#check
@@ -257,28 +227,33 @@ export default class CloudPaymentsWebhooks {
       return;
     }
 
+    /** Data validation */
     if (data.isCardLinkOperation) {
-      this.checkCardLinkOperation(req, res, data);
+      if (!data.userId || !data.workspaceId) {
+        this.sendError(res, CheckCodes.PAYMENT_COULD_NOT_BE_ACCEPTED, '[Billing / Check] There is no necessary data in the card linking request', req.body);
 
-      return;
+        return;
+      }
+    } else {
+      if (!data.userId || !data.workspaceId || !data.tariffPlanId) {
+        this.sendError(res, CheckCodes.PAYMENT_COULD_NOT_BE_ACCEPTED, '[Billing / Check] There is no necessary data in the request', body);
+
+        return;
+      }
     }
 
     let workspace: WorkspaceModel;
     let member: ConfirmedMemberDBScheme;
     let plan: PlanDBScheme;
-
-    if (!data.userId || !data.workspaceId || !data.tariffPlanId) {
-      this.sendError(res, CheckCodes.PAYMENT_COULD_NOT_BE_ACCEPTED, '[Billing / Check] There is no necessary data in the request', body);
-
-      return;
-    }
+    let planId: string;
 
     const { workspaceId, userId, tariffPlanId } = data;
 
     try {
       workspace = await this.getWorkspace(req, workspaceId);
       member = await this.getMember(userId, workspace);
-      plan = await this.getPlan(req, tariffPlanId);
+      planId = data.isCardLinkOperation ? workspace.tariffPlanId.toString() : tariffPlanId;
+      plan = await this.getPlan(req, planId);
     } catch (e) {
       const error = e as Error;
 
@@ -307,7 +282,7 @@ export default class CloudPaymentsWebhooks {
     try {
       await context.factories.businessOperationsFactory.create<PayloadOfWorkspacePlanPurchase>({
         transactionId: body.TransactionId.toString(),
-        type: BusinessOperationType.WorkspacePlanPurchase,
+        type: data.isCardLinkOperation ? BusinessOperationType.CardLinkCharge : BusinessOperationType.WorkspacePlanPurchase,
         status: BusinessOperationStatus.Pending,
         payload: {
           workspaceId: workspace._id,
@@ -361,16 +336,19 @@ export default class CloudPaymentsWebhooks {
       return;
     }
 
-    if (data.isCardLinkOperation && (!data.userId || !data.workspaceId)) {
-      this.sendError(res, PayCodes.SUCCESS, '[Billing / Pay] No workspace or user id in request body', req.body);
-
-      return;
-    }
+    /** Data validation */
+    if (data.isCardLinkOperation) {
+      if (!data.userId || !data.workspaceId) {
+        this.sendError(res, PayCodes.SUCCESS, '[Billing / Pay] No workspace or user id in request body', req.body);
 
-    if (!data.isCardLinkOperation && (!data.workspaceId || !data.tariffPlanId || !data.userId)) {
-      this.sendError(res, PayCodes.SUCCESS, `[Billing / Pay] No workspace, tariff plan or user id in request body`, body);
+        return;
+      }
+    } else {
+      if (!data.workspaceId || !data.tariffPlanId || !data.userId) {
+        this.sendError(res, PayCodes.SUCCESS, `[Billing / Pay] No workspace, tariff plan or user id in request body`, body);
 
-      return;
+        return;
+      }
     }
 
     let businessOperation;
@@ -384,7 +362,6 @@ export default class CloudPaymentsWebhooks {
       workspace = await this.getWorkspace(req, data.workspaceId);
       user = await this.getUser(req, data.userId);
       planId = data.isCardLinkOperation ? workspace.tariffPlanId.toString() : data.tariffPlanId;
-
       tariffPlan = await this.getPlan(req, planId);
     } catch (e) {
       const error = e as Error;

src/models/project.ts

@@ -24,7 +24,7 @@ export interface ProjectNotificationsRuleDBScheme {
   uidAdded: ObjectId;
 
   /**
-   * Receive type: 'ALL'  or 'ONLY_NEW'
+   * Receive type: 'SEEN_MORE'  or 'ONLY_NEW'
    */
   whatToReceive: ReceiveTypes;
 
@@ -42,6 +42,16 @@ export interface ProjectNotificationsRuleDBScheme {
    * 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;
 }
 
 /**
@@ -51,7 +61,7 @@ export enum ReceiveTypes {
   /**
    * All notifications
    */
-  ALL = 'ALL',
+  SEEN_MORE = 'SEEN_MORE',
 
   /**
    * Only first occurrence
@@ -69,7 +79,7 @@ export interface CreateProjectNotificationsRulePayload {
   isEnabled: true;
 
   /**
-   * Receive type: 'ALL'  or 'ONLY_NEW'
+   * Receive type: 'SEEN_MORE'  or 'ONLY_NEW'
    */
   whatToReceive: ReceiveTypes;
 
@@ -92,6 +102,16 @@ export interface CreateProjectNotificationsRulePayload {
    * 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;
 }
 
 /**
@@ -127,6 +147,16 @@ interface UpdateProjectNotificationsRulePayload {
    * 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;
 }
 
 /**
@@ -232,6 +262,11 @@ export default class ProjectModel extends AbstractModel<ProjectDBScheme> impleme
       excluding: payload.excluding,
     };
 
+    if (rule.whatToReceive === ReceiveTypes.SEEN_MORE) {
+      rule.threshold = payload.threshold;
+      rule.thresholdPeriod = payload.thresholdPeriod;
+    }
+
     await this.collection.updateOne({
       _id: this._id,
     },
@@ -261,6 +296,11 @@ export default class ProjectModel extends AbstractModel<ProjectDBScheme> impleme
       excluding: payload.excluding,
     };
 
+    if (rule.whatToReceive === ReceiveTypes.SEEN_MORE) {
+      rule.threshold = payload.threshold;
+      rule.thresholdPeriod = payload.thresholdPeriod;
+    }
+
     const result = await this.collection.findOneAndUpdate(
       {
         _id: this._id,

src/resolvers/projectNotifications.ts

@@ -39,6 +39,16 @@ interface CreateProjectNotificationsRuleMutationPayload {
    * Available channels to receive
    */
   channels: NotificationsChannelsDBScheme;
+
+  /**
+   * Threshold to receive notification
+   */
+  threshold: number;
+
+  /**
+   * Period to receive notification
+   */
+  thresholdPeriod: number;
 }
 
 /**
@@ -67,16 +77,50 @@ interface ProjectNotificationsRulePointer {
 }
 
 /**
- * Return true if all passed channels are empty
- * @param channels - project notifications channels
+ * Returns true is threshold and threshold period are valid
+ * @param threshold - threshold of the notification rule to be checked
+ * @param thresholdPeriod - threshold period of the notification rule to be checked
  */
-function isChannelsEmpty(channels: NotificationsChannelsDBScheme): boolean {
-  const notEmptyChannels = Object.entries(channels)
-    .filter(([_, channel]) => {
-      return (channel as NotificationsChannelSettingsDBScheme).endpoint.replace(/\s+/, '').trim().length !== 0;
-    });
+function validateNotificationsRuleTresholdAndPeriod(
+  threshold: ProjectNotificationsRuleDBScheme['threshold'],
+  thresholdPeriod: ProjectNotificationsRuleDBScheme['thresholdPeriod']
+): string | null {
+  const validThresholdPeriods = [60_000, 3_600_000, 86_400_000, 604_800_000];
+
+  if (thresholdPeriod === undefined || !validThresholdPeriods.includes(thresholdPeriod)) {
+    return 'Threshold period should be one of the following: 60000, 3600000, 86400000, 604800000';
+  }
+
+  if (threshold === undefined || threshold < 1) {
+    return 'Threshold should be greater than 0';
+  }
+
+  return null;
+}
 
-  return notEmptyChannels.length === 0;
+/**
+ * Return true if all passed channels are filled with correct endpoints
+ */
+function validateNotificationsRuleChannels(channels: NotificationsChannelsDBScheme): string | null {
+  if (channels.email!.isEnabled) {
+    if (!/^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/.test(channels.email!.endpoint)) {
+      return 'Invalid email endpoint passed';
+    }
+  }
+
+  if (channels.slack!.isEnabled) {
+    if (!/^https:\/\/hooks\.slack\.com\/services\/[A-Za-z0-9]+\/[A-Za-z0-9]+\/[A-Za-z0-9]+$/.test(channels.slack!.endpoint)) {
+      return 'Invalid slack endpoint passed';
+    }
+  }
+
+  if (channels.telegram!.isEnabled) {
+    if (!/^https:\/\/notify\.bot\.codex\.so\/u\/[A-Za-z0-9]+$/.test(channels.telegram!.endpoint)) {
+      return 'Invalid telegram endpoint passed';
+    }
+  }
+
+  return null;
 }
 
 /**
@@ -102,8 +146,18 @@ export default {
         throw new ApolloError('No project with such id');
       }
 
-      if (isChannelsEmpty(input.channels)) {
-        throw new UserInputError('At least one channel is required');
+      const channelsValidationResult = validateNotificationsRuleChannels(input.channels);
+
+      if (channelsValidationResult !== null) {
+        throw new UserInputError(channelsValidationResult);
+      }
+
+      if (input.whatToReceive === ReceiveTypes.SEEN_MORE) {
+        const thresholdValidationResult = validateNotificationsRuleTresholdAndPeriod(input.threshold, input.thresholdPeriod);
+
+        if (thresholdValidationResult !== null) {
+          throw new UserInputError(thresholdValidationResult);
+        }
       }
 
       return project.createNotificationsRule({
@@ -130,8 +184,18 @@ export default {
         throw new ApolloError('No project with such id');
       }
 
-      if (isChannelsEmpty(input.channels)) {
-        throw new UserInputError('At least one channel is required');
+      const channelsValidationResult = validateNotificationsRuleChannels(input.channels);
+
+      if (channelsValidationResult !== null) {
+        throw new UserInputError(channelsValidationResult);
+      }
+
+      if (input.whatToReceive === ReceiveTypes.SEEN_MORE) {
+        const thresholdValidationResult = validateNotificationsRuleTresholdAndPeriod(input.threshold, input.thresholdPeriod);
+
+        if (thresholdValidationResult !== null) {
+          throw new UserInputError(thresholdValidationResult);
+        }
       }
 
       return project.updateNotificationsRule(input);

src/typeDefs/projectNotifications.ts

@@ -11,9 +11,9 @@ export default gql`
     ONLY_NEW
 
     """
-    Receive all events
+    Receive all events that reached threshold in period
     """
-    ALL
+    SEEN_MORE
   }
 
   """
@@ -49,5 +49,15 @@ export default gql`
     Notification channels to recieve events
     """
     channels: NotificationsChannels
+
+    """
+    Threshold to receive notification
+    """
+    threshold: Int
+
+    """
+    Period to receive notification
+    """
+    thresholdPeriod: Int
   }
 `;