feat(user-notifications): Send notificationId in push notifications (#…

…15962)

So the notification can be easily marked as read/seen when the user taps on the push notification.

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

apps/services/user-notification/src/app/modules/notifications/notificationDispatch.service.ts

@@ -24,10 +24,12 @@ export class NotificationDispatchService {
     notification,
     nationalId,
     messageId,
+    notificationId,
   }: {
     notification: Notification
     nationalId: string
     messageId: string
+    notificationId?: number | null
   }): Promise<void> {
     const tokens = await this.getDeviceTokens(nationalId, messageId)
 
@@ -42,7 +44,12 @@ export class NotificationDispatchService {
 
     for (const token of tokens) {
       try {
-        await this.sendNotificationToToken(notification, token, messageId)
+        await this.sendNotificationToToken(
+          notification,
+          token,
+          messageId,
+          notificationId,
+        )
       } catch (error) {
         await this.handleSendError(error, nationalId, token, messageId)
       }
@@ -82,6 +89,7 @@ export class NotificationDispatchService {
     notification: Notification,
     token: string,
     messageId: string,
+    notificationId?: number | null,
   ): Promise<void> {
     const message = {
       token,
@@ -92,6 +100,7 @@ export class NotificationDispatchService {
       data: {
         messageId,
         clickActionUrl: notification.clickActionUrl,
+        ...(notificationId && { notificationId: String(notificationId) }),
       },
     }
 

apps/services/user-notification/src/app/modules/notifications/notificationsWorker/notificationsWorker.service.spec.ts

@@ -227,18 +227,23 @@ describe('NotificationsWorkerService', () => {
 
     expect(emailService.sendEmail).toHaveBeenCalledTimes(2)
 
+    // should write the messages to db
+    const messages = await notificationModel.findAll()
+    const recipientMessage = messages.find(
+      (message) => message.recipient === userWithDelegations.nationalId,
+    )
+    expect(messages).toHaveLength(2)
+    expect(recipientMessage).toBeDefined()
+
     // should only send push notification for primary recipient
     expect(notificationDispatch.sendPushNotification).toHaveBeenCalledTimes(1)
     expect(notificationDispatch.sendPushNotification).toHaveBeenCalledWith(
       expect.objectContaining({
         nationalId: userWithDelegations.nationalId,
+        notificationId: recipientMessage.id,
       }),
     )
 
-    // should write the messages to db
-    const messages = await notificationModel.findAll()
-    expect(messages).toHaveLength(2)
-
     // should have gotten user profile for primary recipient
     expect(
       userProfileApi.userProfileControllerFindUserProfile,

apps/services/user-notification/src/app/modules/notifications/notificationsWorker/notificationsWorker.service.ts

@@ -51,6 +51,7 @@ type HandleNotification = {
     emailNotifications: boolean
     locale?: string
   }
+  notificationId?: number | null
   messageId: string
   message: CreateHnippNotificationDto
 }
@@ -93,6 +94,7 @@ export class NotificationsWorkerService implements OnApplicationBootstrap {
   async handleDocumentNotification({
     profile,
     messageId,
+    notificationId,
     message,
   }: HandleNotification) {
     // don't send message unless user wants this type of notification and national id is a person.
@@ -126,6 +128,7 @@ export class NotificationsWorkerService implements OnApplicationBootstrap {
       nationalId: profile.nationalId,
       notification,
       messageId,
+      notificationId,
     })
   }
 
@@ -342,21 +345,22 @@ export class NotificationsWorkerService implements OnApplicationBootstrap {
         await this.sleepOutsideWorkingHours(messageId)
 
         const notification = { messageId, ...message }
-        const messageIdExists = await this.notificationModel.count({
+        let dbNotification = await this.notificationModel.findOne({
           where: { messageId },
+          attributes: ['id'],
         })
 
-        if (messageIdExists > 0) {
-          // messageId exists do nothing
+        if (dbNotification) {
+          // messageId exists in db, do nothing
           this.logger.info('notification with messageId already exists in db', {
             messageId,
           })
         } else {
           // messageId does not exist
           // write to db
           try {
-            const res = await this.notificationModel.create(notification)
-            if (res) {
+            dbNotification = await this.notificationModel.create(notification)
+            if (dbNotification) {
               this.logger.info('notification written to db', {
                 notification,
                 messageId,
@@ -398,6 +402,7 @@ export class NotificationsWorkerService implements OnApplicationBootstrap {
         const handleNotificationArgs: HandleNotification = {
           profile: { ...profile, nationalId: message.recipient },
           messageId,
+          notificationId: dbNotification?.id,
           message,
         }