Fix: save workspace blocked date

lib/utils/payday.ts

@@ -1,3 +1,4 @@
+import { WorkspaceDBScheme } from '@hawk.so/types';
 import { HOURS_IN_DAY, MINUTES_IN_HOUR, SECONDS_IN_MINUTE, MS_IN_SEC } from './consts';
 
 /**
@@ -14,7 +15,7 @@ const MILLISECONDS_IN_DAY = HOURS_IN_DAY * MINUTES_IN_HOUR * SECONDS_IN_MINUTE *
  * @param paidUntil - paid until date
  * @param isDebug - flag for debug purposes
  */
-export function daysBeforePayday(date: Date, paidUntil: Date = null, isDebug = false): number {
+export function countDaysBeforePayday(date: Date, paidUntil: Date = null, isDebug = false): number {
   const expectedPayDay = paidUntil ? new Date(paidUntil) : new Date(date);
 
   if (isDebug) {
@@ -37,7 +38,7 @@ export function daysBeforePayday(date: Date, paidUntil: Date = null, isDebug = f
  * @param paidUntil - paid until date
  * @param isDebug - flag for debug purposes
  */
-export function daysAfterPayday(date: Date, paidUntil: Date = null, isDebug = false): number {
+export function countDaysAfterPayday(date: Date, paidUntil: Date = null, isDebug = false): number {
   const expectedPayDay = paidUntil ? new Date(paidUntil) : new Date(date);
 
   if (isDebug) {
@@ -49,4 +50,21 @@ export function daysAfterPayday(date: Date, paidUntil: Date = null, isDebug = fa
   const now = new Date().getTime();
 
   return Math.floor((now - expectedPayDay.getTime()) / MILLISECONDS_IN_DAY);
+}
+
+/**
+ * Returns difference between day when workspace was blocked and now in days. Undefined for workspaces blocked before the "blockedDate" implemented.
+ *
+ * @param workspace - workspace object
+ */
+export function countDaysAfterBlock(workspace: WorkspaceDBScheme): number | undefined {
+  if (!workspace.blockedDate) {
+    return undefined;
+  }
+
+  const blockedDay = new Date(workspace.blockedDate);
+
+  const now = new Date().getTime();
+
+  return Math.floor((now - blockedDay.getTime()) / MILLISECONDS_IN_DAY);
 }

package.json

@@ -50,8 +50,10 @@
         "run-limiter": "yarn worker hawk-worker-limiter"
     },
     "dependencies": {
+        "@babel/parser": "^7.26.9",
+        "@babel/traverse": "7.26.9",
         "@hawk.so/nodejs": "^3.1.1",
-        "@hawk.so/types": "^0.1.35",
+        "@hawk.so/types": "^0.2.0",
         "@types/amqplib": "^0.8.2",
         "@types/jest": "^29.2.3",
         "@types/mongodb": "^3.5.15",
@@ -73,9 +75,7 @@
         "typescript": "^4.9.4",
         "uuid": "^8.3.0",
         "winston": "^3.2.1",
-        "yup": "^0.28.5",
-        "@babel/parser": "^7.26.9",
-        "@babel/traverse": "7.26.9"
+        "yup": "^0.28.5"
     },
     "devDependencies": {
         "@shelf/jest-mongodb": "^1.2.3",

workers/email/scripts/emailOverview.ts

@@ -19,7 +19,7 @@ import { ObjectId } from 'mongodb';
 import * as path from 'path';
 import * as dotenv from 'dotenv';
 import { HttpStatusCode } from '../../../lib/utils/consts';
-import { daysAfterPayday } from '../../../lib/utils/payday';
+import { countDaysAfterPayday } from '../../../lib/utils/payday';
 
 /**
  * Merge email worker .env and root workers .env
@@ -148,7 +148,7 @@ class EmailTestServer {
       user,
       period: 10,
       reason: 'error on the payment server side',
-      daysAfterPayday: await this.calculateDaysAfterPayday(workspace),
+      daysAfterPayday: countDaysAfterPayday(workspace.lastChargeDate, workspace.paidUntil),
     };
 
     try {
@@ -339,7 +339,7 @@ class EmailTestServer {
       return 0;
     }
 
-    const days = daysAfterPayday(workspace.lastChargeDate, workspace.paidUntil);
+    const days = countDaysAfterPayday(workspace.lastChargeDate, workspace.paidUntil);
 
     return days > 0 ? days : 0;
   }

workers/email/src/templates/emails/blocked-workspace-reminder/html.twig

@@ -14,7 +14,7 @@
     <td align="center" style="padding: 15px 0;">
       <font color="#dbe6ff" style="font-size: 15px; text-align: center; color: #dbe6ff; letter-spacing: 0.4px;">
         <span style="vertical-align: middle; display: inline-block;">
-          {{ daysAfterPayday }} {{ pluralize_ru(daysAfterPayday, ['день', 'дня', 'дней']) }} без мониторинга
+          {{ daysAfterBlock }} {{ pluralize_ru(daysAfterBlock, ['день', 'дня', 'дней']) }} без мониторинга
         </span>
       </font>
     </td>

workers/email/src/templates/emails/blocked-workspace-reminder/subject.twig

@@ -1 +1 @@
-Требуется действие: мониторинг ошибок в {{ workspace.name }} не работает уже {{ daysAfterPayday }} {{ pluralize_ru(daysAfterPayday, ['день', 'дня', 'дней']) }}
+Требуется действие: мониторинг ошибок в {{ workspace.name }} не работает уже {{ daysAfterBlock }} {{ pluralize_ru(daysAfterBlock, ['день', 'дня', 'дней']) }}

workers/email/src/templates/emails/blocked-workspace-reminder/text.twig

@@ -1,4 +1,4 @@
-Требуется действие: мониторинг ошибок в {{ workspace.name }} не работает уже {{ daysAfterPayday }} {{ pluralize_ru(daysAfterPayday, ['день', 'дня', 'дней']) }}
+Требуется действие: мониторинг ошибок в {{ workspace.name }} не работает уже {{ daysAfterBlock }} {{ pluralize_ru(daysAfterBlock, ['день', 'дня', 'дней']) }}
 
 Чтобы снова видеть актуальные события, выберите подходящий тарифный план и продлите подписку в настройках оплаты: {{ host }}/workspace/{{ workspace._id }}/settings/billing
 

workers/limiter/src/dbHelper.ts

@@ -100,6 +100,7 @@ export class DbHelper {
             $set: {
               billingPeriodEventsCount: workspace.billingPeriodEventsCount,
               isBlocked: workspace.isBlocked,
+              blockedDate: workspace.blockedDate,
             },
           },
         },

workers/limiter/src/index.ts

@@ -131,6 +131,7 @@ export default class LimiterWorker extends Worker {
     const { updatedWorkspace } = await this.prepareWorkspaceUsageUpdate(workspace, workspaceProjects);
 
     updatedWorkspace.isBlocked = true;
+    updatedWorkspace.blockedDate = new Date();
     await this.dbHelper.updateWorkspacesEventsCountAndIsBlocked([ updatedWorkspace ]);
 
     this.logger.info('workspace blocked in db ', event.workspaceId);
@@ -174,6 +175,7 @@ export default class LimiterWorker extends Worker {
     }
 
     updatedWorkspace.isBlocked = false;
+    updatedWorkspace.blockedDate = null;
 
     await this.dbHelper.updateWorkspacesEventsCountAndIsBlocked([ updatedWorkspace ]);
     await this.redis.removeBannedProjects(projectIds);
@@ -218,6 +220,9 @@ export default class LimiterWorker extends Worker {
       if (shouldBeBlockedByQuota) {
         const projectIds = projectsToUpdate.map(project => project._id.toString());
 
+        updatedWorkspace.isBlocked = true;
+        updatedWorkspace.blockedDate = new Date();
+
         this.redis.appendBannedProjects(projectIds);
         message += this.formSingleWorkspaceMessage(updatedWorkspace, projectsToUpdate, 'blocked');
       }

workers/limiter/tests/dbHelper.test.ts

@@ -28,6 +28,7 @@ describe('DbHelper', () => {
     billingPeriodEventsCount: number;
     lastChargeDate: Date;
     isBlocked?: boolean;
+    blockedDate?: Date;
   }): WorkspaceDBScheme => {
     return {
       _id: new ObjectId(),
@@ -39,6 +40,7 @@ describe('DbHelper', () => {
       accountId: '',
       balance: 0,
       isBlocked: parameters.isBlocked,
+      blockedDate: parameters.blockedDate,
     };
   };
 
@@ -213,17 +215,20 @@ describe('DbHelper', () => {
 
       await workspaceCollection.insertMany([workspace1, workspace2]);
 
+      const blockedDate = new Date();
       const updatedWorkspaces = [
         {
           ...workspace1,
           billingPeriodEventsCount: 5,
           isBlocked: true,
+          blockedDate: blockedDate,
           tariffPlan: mockedPlans.eventsLimit10,
         },
         {
           ...workspace2,
           billingPeriodEventsCount: 5000,
           isBlocked: true,
+          blockedDate: blockedDate,
           tariffPlan: mockedPlans.eventsLimit10000,
         },
       ];
@@ -241,8 +246,10 @@ describe('DbHelper', () => {
 
       expect(updatedWorkspace1.billingPeriodEventsCount).toBe(5);
       expect(updatedWorkspace1.isBlocked).toBe(true);
+      expect(updatedWorkspace1.blockedDate).toEqual(blockedDate);
       expect(updatedWorkspace2.billingPeriodEventsCount).toBe(5000);
       expect(updatedWorkspace2.isBlocked).toBe(true);
+      expect(updatedWorkspace2.blockedDate).toEqual(blockedDate);
     });
 
     test('Should not update anything if empty array provided', async () => {
@@ -254,6 +261,7 @@ describe('DbHelper', () => {
         billingPeriodEventsCount: 0,
         lastChargeDate: new Date(),
         isBlocked: false,
+        blockedDate: null,
       });
 
       await workspaceCollection.insertOne(workspace);
@@ -270,6 +278,42 @@ describe('DbHelper', () => {
 
       expect(unchangedWorkspace).toEqual(workspace);
     });
+
+    test('Should set blockedDate to null when unblocking workspace', async () => {
+      /**
+       * Arrange
+       */
+      const blockedDate = new Date();
+      const workspace = createWorkspaceMock({
+        plan: mockedPlans.eventsLimit10,
+        billingPeriodEventsCount: 0,
+        lastChargeDate: new Date(),
+        isBlocked: true,
+        blockedDate: blockedDate,
+      });
+
+      await workspaceCollection.insertOne(workspace);
+
+      const updatedWorkspace = {
+        ...workspace,
+        isBlocked: false,
+        blockedDate: null,
+        tariffPlan: mockedPlans.eventsLimit10,
+      };
+
+      /**
+       * Act
+       */
+      await dbHelper.updateWorkspacesEventsCountAndIsBlocked([updatedWorkspace]);
+
+      /**
+       * Assert
+       */
+      const result = await workspaceCollection.findOne({ _id: workspace._id });
+
+      expect(result.isBlocked).toBe(false);
+      expect(result.blockedDate).toBeNull();
+    });
   });
 
   describe('getEventsCountByProject', () => {

workers/limiter/tests/index.test.ts

@@ -45,6 +45,7 @@ describe('Limiter worker', () => {
     billingPeriodEventsCount: number;
     lastChargeDate: Date;
     isBlocked?: boolean;
+    blockedDate?: Date;
   }): WorkspaceDBScheme => {
     return {
       _id: new ObjectId(),
@@ -56,6 +57,7 @@ describe('Limiter worker', () => {
       accountId: '',
       balance: 0,
       isBlocked: parameters.isBlocked,
+      blockedDate: parameters.blockedDate,
     };
   };
 
@@ -391,6 +393,7 @@ describe('Limiter worker', () => {
       const blockedProjects = await redisClient.sMembers('DisabledProjectsSet');
 
       expect(updatedWorkspace.isBlocked).toBe(true);
+      expect(updatedWorkspace.blockedDate).toBeInstanceOf(Date);
       expect(blockedProjects).toContain(project._id.toString());
       expect(telegram.sendMessage).toHaveBeenCalledWith(
         expect.stringContaining('⛔️ Workspace <b>Mocked workspace</b> blocked <b>(id: <code>'),
@@ -416,6 +419,7 @@ describe('Limiter worker', () => {
         billingPeriodEventsCount: 0,
         lastChargeDate: LAST_CHARGE_DATE,
         isBlocked: true,
+        blockedDate: new Date(),
       });
       const project = createProjectMock({ workspaceId: workspace._id });
 
@@ -449,6 +453,7 @@ describe('Limiter worker', () => {
       const blockedProjects = await redisClient.sMembers('DisabledProjectsSet');
 
       expect(updatedWorkspace.isBlocked).toBe(false);
+      expect(updatedWorkspace.blockedDate).toBeNull();
       expect(blockedProjects).not.toContain(project._id.toString());
       expect(telegram.sendMessage).toHaveBeenCalledWith(
         expect.stringContaining('✅ Workspace <b>Mocked workspace</b> unblocked <b>(id: <code>'),

workers/paymaster/src/index.ts

@@ -9,7 +9,7 @@ import { EventType, PaymasterEvent } from '../types/paymaster-worker-events';
 import axios from 'axios';
 import * as WorkerNames from '../../../lib/workerNames';
 import HawkCatcher from '@hawk.so/nodejs';
-import { daysBeforePayday, daysAfterPayday } from '../../../lib/utils/payday';
+import { countDaysBeforePayday, countDaysAfterPayday, countDaysAfterBlock } from '../../../lib/utils/payday';
 
 dotenv.config({
   path: path.resolve(__dirname, '../.env'),
@@ -29,10 +29,10 @@ const DAYS_AFTER_PAYDAY_TO_TRY_PAYING = 3;
 const DAYS_LEFT_ALERT = [3, 2, 1, 0];
 
 /**
- * Days after payday to remind admins about blocked workspace
+ * Days after block to remind admins about blocked workspace
  */
 // eslint-disable-next-line @typescript-eslint/no-magic-numbers
-const DAYS_AFTER_PAYDAY_TO_REMIND = [1, 2, 3, 5, 7, 30];
+const DAYS_AFTER_BLOCK_TO_REMIND = [1, 2, 3, 5, 7, 30];
 
 /**
  * Worker to check workspaces subscription status and ban workspaces without actual subscription
@@ -199,16 +199,21 @@ export default class PaymasterWorker extends Worker {
     const isTimeToRecharge = PaymasterWorker.isTimeToRecharge(workspace.lastChargeDate, workspace.isDebug);
 
     /**
-     * How many days have passed since payments the expected day of payments
+     * How many days left for the expected day of payments
      */
     // @ts-expect-error debug
-    const daysAfterPaydayValue = daysAfterPayday(workspace.lastChargeDate, workspace.paidUntil, workspace.isDebug);
+    const daysLeft = countDaysBeforePayday(workspace.lastChargeDate, workspace.paidUntil, workspace.isDebug);
 
     /**
-     * How many days left for the expected day of payments
+     * How many days have passed since the expected day of payments
      */
     // @ts-expect-error debug
-    const daysLeft = daysBeforePayday(workspace.lastChargeDate, workspace.paidUntil, workspace.isDebug);
+    const daysAfterPayday = countDaysAfterPayday(workspace.lastChargeDate, workspace.paidUntil, workspace.isDebug);
+
+    /**
+     * How many days have passed since the workspace was blocked
+     */
+    const daysAfterBlock = countDaysAfterBlock(workspace);
 
     /**
      * Do we need to ask for money
@@ -277,10 +282,9 @@ export default class PaymasterWorker extends Worker {
      * If it is blocked then remind admins about it
      */
     if (workspace.isBlocked) {
-      // Send reminders on certain days after payday
-      // eslint-disable-next-line @typescript-eslint/no-magic-numbers
-      if (DAYS_AFTER_PAYDAY_TO_REMIND.includes(daysAfterPaydayValue)) {
-        await this.sendBlockedWorkspaceReminders(workspace, daysAfterPaydayValue);
+      // Send reminders on certain days after block
+      if (daysAfterBlock !== undefined && DAYS_AFTER_BLOCK_TO_REMIND.includes(daysAfterBlock)) {
+        await this.sendBlockedWorkspaceReminders(workspace, daysAfterBlock);
       }
 
       return [workspace, true];
@@ -299,7 +303,7 @@ export default class PaymasterWorker extends Worker {
      * Block workspace if it has paid subscription,
      * but a few days have passed after payday
      */
-    if (daysAfterPaydayValue > DAYS_AFTER_PAYDAY_TO_TRY_PAYING) {
+    if (daysAfterPayday > DAYS_AFTER_PAYDAY_TO_TRY_PAYING) {
       await this.blockWorkspace(workspace);
 
       return [workspace, true];
@@ -369,17 +373,17 @@ export default class PaymasterWorker extends Worker {
    * Sends reminder emails to blocked workspace admins
    *
    * @param workspace - workspace to send reminders for
-   * @param days - number of days the workspace spent after payday
+   * @param daysAfterBlock - number of days since the workspace was blocked
    */
   private async sendBlockedWorkspaceReminders(
     workspace: WorkspaceDBScheme,
-    days: number
+    daysAfterBlock: number
   ): Promise<void> {
     await this.addTask(WorkerNames.EMAIL, {
       type: 'blocked-workspace-reminder',
       payload: {
         workspaceId: workspace._id.toString(),
-        daysAfterPayday: days,
+        daysAfterBlock,
       },
     });
   }