Throttle email notifications upon updating document frequently (#4026)

* feat: add needed columns for throttling notifs * feat: update model * feat: deliver only one notif in a 12 hour window * fix: address review comments * prevent retry if notification update fails * fix type compatibility instead of circumventing it * add index for emailedAt * fix: add metadata attr to EmailProps * chore: decouple metadata from EmailProps * chore: add test * chore: revert sending metadata in props
2022-09-07 16:51:30 +05:30
parent e4023d87e2
commit 1e39b564fe
7 changed files with 264 additions and 17 deletions
--- a/server/migrations/20220828144837-add-columns-to-notifications-for-tracking.js
+++ b/server/migrations/20220828144837-add-columns-to-notifications-for-tracking.js
@@ -0,0 +1,120 @@
+"use strict";
+
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    const transaction = await queryInterface.sequelize.transaction();
+
+    try {
+      await queryInterface.addColumn(
+        "notifications",
+        "viewedAt",
+        {
+          type: Sequelize.DATE,
+          allowNull: true,
+        },
+        { transaction }
+      );
+
+      await queryInterface.addColumn(
+        "notifications",
+        "emailedAt",
+        {
+          type: Sequelize.DATE,
+          allowNull: true,
+        },
+        { transaction }
+      );
+
+      await queryInterface.addIndex("notifications", ["emailedAt"], {
+        name: "notifications_emailed_at",
+        transaction,
+      });
+
+      await queryInterface.addColumn(
+        "notifications",
+        "teamId",
+        {
+          type: Sequelize.UUID,
+          references: {
+            model: "teams",
+            key: "id",
+          },
+        },
+        { transaction }
+      );
+
+      await queryInterface.addColumn(
+        "notifications",
+        "documentId",
+        {
+          type: Sequelize.UUID,
+          allowNull: true,
+          references: {
+            model: "documents",
+            key: "id",
+          },
+        },
+        { transaction }
+      );
+
+      await queryInterface.changeColumn(
+        "notifications",
+        "actorId",
+        {
+          type: Sequelize.UUID,
+          allowNull: true,
+        },
+        { transaction }
+      );
+
+      await queryInterface.removeColumn("notifications", "email", {
+        transaction,
+      });
+
+      await transaction.commit();
+    } catch (err) {
+      await transaction.rollback();
+      throw err;
+    }
+  },
+
+  async down(queryInterface, Sequelize) {
+    const transaction = await queryInterface.sequelize.transaction();
+
+    try {
+      await queryInterface.removeColumn("notifications", "viewedAt", {
+        transaction,
+      });
+      await queryInterface.removeColumn("notifications", "emailedAt", {
+        transaction,
+      });
+      await queryInterface.removeColumn("notifications", "teamId", {
+        transaction,
+      });
+      await queryInterface.removeColumn("notifications", "documentId", {
+        transaction,
+      });
+      await queryInterface.changeColumn(
+        "notifications",
+        "actorId",
+        {
+          type: Sequelize.UUID,
+          allowNull: false,
+        },
+        { transaction }
+      );
+      await queryInterface.addColumn(
+        "notifications",
+        "email",
+        {
+          type: Sequelize.BOOLEAN,
+        },
+        { transaction }
+      );
+      await transaction.commit();
+    } catch (err) {
+      await transaction.rollback();
+      throw err;
+    }
+  },
+};