[TTAHUB-5384] Add notification services

docs/logical_data_model.puml

@@ -1057,20 +1057,28 @@ class NextSteps{
  completeDate : date
 }
 
+class NotificationUserStates{
+ * id : integer : <generated>
+ * notificationId : integer : REFERENCES "Notifications".id
+ * userId : integer : REFERENCES "Users".id
+ * createdAt : timestamp with time zone
+ * updatedAt : timestamp with time zone
+ archivedAt : date
+ viewedAt : date
+}
+
 class Notifications{
  * id : integer : <generated>
  userId : integer : REFERENCES "Users".id
  * createdAt : timestamp with time zone
  * type : enum
  * updatedAt : timestamp with time zone
- archivedAt : date
  displayId : varchar(255)
  entityId : integer
  label : text
  link : text
  text : text
  triggeredAt : date
- viewedAt : date
 }
 
 class ObjectiveCollaborators{
@@ -2541,6 +2549,20 @@ class ZALNextSteps{
  session_sig : text
 }
 
+class ZALNotificationUserStates{
+ * id : bigint : <generated>
+ * data_id : bigint
+ * dml_as : bigint
+ * dml_by : bigint
+ * dml_timestamp : timestamp with time zone
+ * dml_txid : uuid
+ * dml_type : enum
+ descriptor_id : integer
+ new_row_data : jsonb
+ old_row_data : jsonb
+ session_sig : text
+}
+
 class ZALNotifications{
  * id : bigint : <generated>
  * data_id : bigint
@@ -3069,6 +3091,7 @@ NationalCenters "1" --[#black,dashed,thickness=2]--{  "n" EventReportPilotNation
 NationalCenters "1" --[#black,dashed,thickness=2]--{  "n" NationalCenterUsers : nationalCenter, nationalCenterUsers
 NationalCenters "1" --[#black,dashed,thickness=2]--{  "n" NationalCenters : mapsToNationalCenter, mapsFromNationalCenters
 NextSteps "1" --[#black,dashed,thickness=2]--{  "n" NextStepResources : nextStep, nextStepResources
+Notifications "1" --[#black,dashed,thickness=2]--{  "n" NotificationUserStates : notification, userStates
 ObjectiveTemplates "1" --[#black,dashed,thickness=2]--{  "n" GoalTemplateObjectiveTemplates : objectiveTemplate, goalTemplateObjectiveTemplates
 ObjectiveTemplates "1" --[#black,dashed,thickness=2]--{  "n" Objectives : objectives, objectiveTemplate
 Objectives "1" --[#black,dashed,thickness=2]--{  "n" ActivityReportObjectives : objective, originalObjective, activityReportObjectives, reassignedActivityReportObjectives
@@ -3118,6 +3141,7 @@ Users "1" --[#black,dashed,thickness=2]--{  "n" GoalCollaborators : user, goalCo
 Users "1" --[#black,dashed,thickness=2]--{  "n" GoalStatusChanges : user, goalStatusChanges
 Users "1" --[#black,dashed,thickness=2]--{  "n" GroupCollaborators : user, groupCollaborators
 Users "1" --[#black,dashed,thickness=2]--{  "n" NationalCenterUsers : user, nationalCenterUsers
+Users "1" --[#black,dashed,thickness=2]--{  "n" NotificationUserStates : user, notificationUserStates
 Users "1" --[#black,dashed,thickness=2]--{  "n" Notifications : user, notifications
 Users "1" --[#black,dashed,thickness=2]--{  "n" ObjectiveCollaborators : user, objectiveCollaborators
 Users "1" --[#black,dashed,thickness=2]--{  "n" Permissions : user, permissions

src/constants.js

@@ -205,6 +205,29 @@ const NOTIFICATION_TYPES = {
   SYSTEM_UNPLANNED_OUTAGE: 'systemUnplannedOutage',
 };
 
+const NOTIFICATION_CONFIGURATION = {
+  [NOTIFICATION_TYPES.ACTIVITY_REPORT_NEEDS_ACTION]: {
+    textFn: ({ userName, recipientName }) =>
+      `${userName} has requested changes to your Activity Report for ${recipientName}.`,
+    actionable: true,
+    linkFn: ({ id }) => `/activity-reports/${id}`,
+    linkText: () => 'View AR',
+    displayId: ({ displayId }) => displayId,
+  },
+  [NOTIFICATION_TYPES.SYSTEM_PLANNED_OUTAGE]: {
+    textFn: ({ date }) => `Planned outage: the TTA Hub will be closed for maintenance from ${date}`,
+    actionable: true,
+    linkFn: () => null,
+    linkText: () => null,
+    displayId: () => null,
+  },
+};
+
+const ADMIN_BROADCASTABLE_NOTIFICATION_TYPES = [
+  NOTIFICATION_TYPES.SYSTEM_PLANNED_OUTAGE,
+  NOTIFICATION_TYPES.SYSTEM_UNPLANNED_OUTAGE,
+];
+
 const EMAIL_ACTIONS = {
   COLLABORATOR_ADDED: 'collaboratorAssigned',
   NEEDS_ACTION: 'changesRequested',
@@ -358,6 +381,8 @@ module.exports = {
   RESOURCE_ACTIONS,
   USER_SETTINGS,
   NOTIFICATION_TYPES,
+  NOTIFICATION_CONFIGURATION,
+  ADMIN_BROADCASTABLE_NOTIFICATION_TYPES,
   EMAIL_ACTIONS,
   S3_ACTIONS,
   EMAIL_DIGEST_FREQ,

src/middleware/checkIdParamMiddleware.js

@@ -283,3 +283,7 @@ export function checkGrantIdQueryParam(req, res, next) {
   req.query.parsedGrantId = parsed;
   return next();
 }
+
+export function checkNotificationIdParam(req, res, next) {
+  return checkIdParam(req, res, next, 'notificationId');
+}

src/middleware/checkIdParamMiddleware.test.js

@@ -13,6 +13,7 @@ import {
   checkGroupIdParam,
   checkIdIdParam,
   checkIdParam,
+  checkNotificationIdParam,
   checkObjectiveIdParam,
   checkObjectiveTemplateIdParam,
   checkRecipientIdParam,
@@ -405,6 +406,56 @@ describe('checkIdParamMiddleware', () => {
     });
   });
 
+  describe('checkNotificationIdParam', () => {
+    it('calls next if notification id is string or integer', () => {
+      const mockRequest = {
+        path: '/api/endpoint',
+        params: {
+          notificationId: '2',
+        },
+      };
+
+      checkNotificationIdParam(mockRequest, mockResponse, mockNext);
+      expect(mockResponse.status).not.toHaveBeenCalled();
+      expect(mockNext).toHaveBeenCalled();
+    });
+
+    it('throw 400 if param is not string or integer', () => {
+      const mockRequest = {
+        path: '/api/endpoint',
+        params: {
+          notificationId: '2D',
+        },
+      };
+
+      checkNotificationIdParam(mockRequest, mockResponse, mockNext);
+      expect(mockResponse.status).toHaveBeenCalledWith(400);
+      expect(auditLogger.error).toHaveBeenCalled();
+      expect(mockNext).not.toHaveBeenCalled();
+    });
+
+    it('throw 400 if param is missing', () => {
+      const mockRequest = {
+        path: '/api/endpoint',
+        params: {},
+      };
+
+      checkNotificationIdParam(mockRequest, mockResponse, mockNext);
+      expect(mockResponse.status).toHaveBeenCalledWith(400);
+      expect(auditLogger.error).toHaveBeenCalled();
+      expect(mockNext).not.toHaveBeenCalled();
+    });
+
+    it('throw 400 if notificationId param is undefined', () => {
+      const mockRequest = { path: '/api/endpoint', params: {} };
+
+      checkNotificationIdParam(mockRequest, mockResponse, mockNext);
+      expect(mockResponse.status).toHaveBeenCalledWith(400);
+      expect(auditLogger.error).toHaveBeenCalledWith(`${errorMessage}: notificationId undefined`);
+      expect(mockNext).not.toHaveBeenCalled();
+    });
+  });
+
   describe('checkGroupIdParam', () => {
     it('calls next if objective id is string or integer', () => {
       const mockRequest = {

src/migrations/20260608135105-create-notifications-table.js

@@ -86,17 +86,47 @@ module.exports = {
             type: Sequelize.TEXT,
             allowNull: true,
           },
-          archivedAt: {
+          triggeredAt: {
             type: Sequelize.DATEONLY,
             allowNull: true,
           },
-          viewedAt: {
-            type: Sequelize.DATEONLY,
-            allowNull: true,
+          createdAt: {
+            type: Sequelize.DATE,
+            allowNull: false,
           },
-          triggeredAt: {
-            type: Sequelize.DATEONLY,
-            allowNull: true,
+          updatedAt: {
+            type: Sequelize.DATE,
+            allowNull: false,
+          },
+        },
+        { transaction }
+      );
+
+      await queryInterface.createTable(
+        'NotificationUserStates',
+        {
+          id: {
+            type: Sequelize.INTEGER,
+            autoIncrement: true,
+            primaryKey: true,
+          },
+          notificationId: {
+            type: Sequelize.INTEGER,
+            allowNull: false,
+            references: {
+              model: 'Notifications',
+              key: 'id',
+            },
+            onDelete: 'CASCADE',
+          },
+          userId: {
+            type: Sequelize.INTEGER,
+            allowNull: false,
+            references: {
+              model: 'Users',
+              key: 'id',
+            },
+            onDelete: 'CASCADE',
           },
           createdAt: {
             type: Sequelize.DATE,
@@ -106,10 +136,23 @@ module.exports = {
             type: Sequelize.DATE,
             allowNull: false,
           },
+          archivedAt: {
+            type: Sequelize.DATEONLY,
+            allowNull: true,
+          },
+          viewedAt: {
+            type: Sequelize.DATEONLY,
+            allowNull: true,
+          },
         },
         { transaction }
       );
 
+      await queryInterface.addIndex('NotificationUserStates', ['notificationId', 'userId'], {
+        unique: true,
+        transaction,
+      });
+
       await updateUsersFlagsEnum(
         queryInterface,
         transaction,
@@ -124,6 +167,7 @@ module.exports = {
       const sessionSig = __filename;
       await prepMigration(queryInterface, transaction, sessionSig);
 
+      await removeTables(queryInterface, transaction, ['NotificationUserStates']);
       await removeTables(queryInterface, transaction, ['Notifications']);
 
       // no simple way to remove enum from feature flag; write a new migration for that

src/models/notification.js

@@ -5,6 +5,10 @@ export default (sequelize, DataTypes) => {
   class Notification extends Model {
     static associate(models) {
       Notification.belongsTo(models.User, { foreignKey: 'userId', as: 'user' });
+      Notification.hasMany(models.NotificationUserState, {
+        foreignKey: 'notificationId',
+        as: 'userStates',
+      });
     }
   }
 
@@ -44,30 +48,16 @@ export default (sequelize, DataTypes) => {
         type: DataTypes.STRING,
         allowNull: true,
       },
-      archivedAt: {
-        type: DataTypes.DATEONLY,
-        allowNull: true,
-      },
       triggeredAt: {
         type: DataTypes.DATEONLY,
         allowNull: true,
       },
-      viewedAt: {
-        type: DataTypes.DATEONLY,
-        allowNull: true,
-      },
       isGlobal: {
         type: DataTypes.VIRTUAL,
         get() {
           return this.userId === null;
         },
       },
-      isInformational: {
-        type: DataTypes.VIRTUAL,
-        get() {
-          return this.triggeredAt === null;
-        },
-      },
     },
     {
       sequelize,

src/models/notificationUserState.js

@@ -0,0 +1,57 @@
+const { Model } = require('sequelize');
+
+export default (sequelize, DataTypes) => {
+  class NotificationUserState extends Model {
+    static associate(models) {
+      NotificationUserState.belongsTo(models.Notification, {
+        foreignKey: 'notificationId',
+        as: 'notification',
+      });
+      NotificationUserState.belongsTo(models.User, {
+        foreignKey: 'userId',
+        as: 'user',
+      });
+    }
+  }
+
+  NotificationUserState.init(
+    {
+      notificationId: {
+        type: DataTypes.INTEGER,
+        allowNull: false,
+        references: {
+          model: {
+            tableName: 'Notifications',
+          },
+          key: 'id',
+        },
+      },
+      userId: {
+        type: DataTypes.INTEGER,
+        allowNull: false,
+        references: {
+          model: {
+            tableName: 'Users',
+          },
+          key: 'id',
+        },
+      },
+      viewedAt: {
+        type: DataTypes.DATEONLY,
+        allowNull: true,
+      },
+      archivedAt: {
+        type: DataTypes.DATEONLY,
+        allowNull: true,
+      },
+    },
+    {
+      sequelize,
+      modelName: 'NotificationUserState',
+      timestamps: true,
+      paranoid: false,
+    }
+  );
+
+  return NotificationUserState;
+};