Handle null Copilot notification responses

src/app/api/notification/notification.service.ts

@@ -66,12 +66,16 @@ export class NotificationService extends BaseService {
       )
       console.info('NotificationService#create | Creating single notification:', notificationDetails)
 
-      let notification: NotificationCreatedResponse
+      let notification: NotificationCreatedResponse | null
       try {
         notification = await this.copilot.createNotification(notificationDetails)
       } catch (e: unknown) {
         notification = await this.handleIfSenderCompanyIdError(e, notificationDetails)
       }
+      if (!notification) {
+        console.info('NotificationService#create | Notification delivery did not create an in-product resource')
+        return null
+      }
 
       console.info('NotificationService#create | Created single notification:', notification)
 
@@ -169,7 +173,7 @@ export class NotificationService extends BaseService {
           )
 
           console.info('NotificationService#bulkCreate | Creating single notification:', notificationDetails)
-          let notification: NotificationCreatedResponse
+          let notification: NotificationCreatedResponse | null
           try {
             notification = await this.copilot.createNotification(notificationDetails)
           } catch (e: unknown) {

src/app/api/notification/validate-count/validateCount.service.ts

@@ -171,8 +171,16 @@ export class ValidateCountService extends NotificationService {
     // Now track those to ClientNotifications table
     const newClientNotificationData = []
     for (const i in newNotifications) {
+      const notification = newNotifications[i]
+      if (!notification) {
+        console.error(
+          `ValidateCount :: Copilot did not return a notification resource for task ${tasksWithoutNotifications[i].id}`,
+        )
+        continue
+      }
+
       newClientNotificationData.push({
-        notificationId: newNotifications[i].id,
+        notificationId: notification.id,
         taskId: tasksWithoutNotifications[i].id,
         clientId,
         companyId: tasksWithoutNotifications[i].companyId,

src/app/api/webhook/webhook.service.ts

@@ -113,17 +113,25 @@ class WebhookService extends BaseService {
         // If any of the given action is not present in details obj, that type of notification is not sent
         deliveryTargets: { inProduct },
       }
-      createNotificationPromises.push(copilotBottleneck.schedule(() => this.copilot.createNotification(notificationDetails)))
+      createNotificationPromises.push(
+        copilotBottleneck
+          .schedule(() => this.copilot.createNotification(notificationDetails))
+          .then((notification) => ({ task, notification })),
+      )
     }
-    const notifications = await Promise.all(createNotificationPromises)
+    const notificationResults = await Promise.all(createNotificationPromises)
 
     // Now add appropriate records to our ClientNotifications table
     const insertPromises = []
     const notificationService = new NotificationService(this.user)
-    for (let i = 0; i < notifications.length; i++) {
+    for (const { task, notification } of notificationResults) {
+      if (!notification) {
+        console.error('WebhookService#handleClientCreated :: Copilot did not return a notification resource for task', task.id)
+        continue
+      }
+
       insertPromises.push(
-        // This is assuming a 1:1 map for tasks and notifications
-        dbBottleneck.schedule(() => notificationService.addToClientNotifications(tasks[i], notifications[i])),
+        dbBottleneck.schedule(() => notificationService.addToClientNotifications(task, notification)),
       )
     }
     await Promise.all(insertPromises)

src/cmd/backfill-missed-emails/index.ts

@@ -31,6 +31,11 @@ const dispatchNotification = async (copilot: CopilotAPI, taskId: string, payload
   // <<- Emails are triggered here. Proceed with caution ->>
 
   const notification = await copilot.createNotification(payload)
+  if (!notification) {
+    console.info('No notification resource returned for email-only delivery:', { taskId, payload })
+    return
+  }
+
   await db.clientNotification.create({
     data: {
       clientId: payload.recipientClientId!,

src/utils/CopilotAPI.test.ts

@@ -0,0 +1,61 @@
+const mockCreateNotification = jest.fn()
+
+jest.mock('copilot-node-sdk', () => ({
+  copilotApi: jest.fn(() => ({
+    createNotification: mockCreateNotification,
+  })),
+}))
+
+jest.mock('@/config', () => ({
+  APP_ID: '00000000-0000-0000-0000-000000000000',
+  assemblyApiDomain: 'https://api.example.com',
+  copilotAPIKey: 'test-api-key',
+}))
+
+jest.mock('@/app/api/core/utils/withRetry', () => ({
+  withRetry: jest.fn((fn, args) => fn(...args)),
+}))
+
+import { CopilotAPI } from './CopilotAPI'
+
+describe('CopilotAPI#createNotification', () => {
+  beforeEach(() => {
+    mockCreateNotification.mockReset()
+  })
+
+  it('returns null when Copilot does not create a resource for email-only delivery', async () => {
+    mockCreateNotification.mockResolvedValueOnce(null)
+    const copilot = new CopilotAPI('test-token')
+
+    await expect(
+      copilot._createNotification({
+        senderId: 'sender-id',
+        senderType: 'internalUser',
+        recipientClientId: 'recipient-id',
+        deliveryTargets: {
+          email: {
+            subject: 'Reminder',
+          },
+        },
+      }),
+    ).resolves.toBeNull()
+  })
+
+  it('throws a clear error when an in-product delivery does not create a resource', async () => {
+    mockCreateNotification.mockResolvedValueOnce(null)
+    const copilot = new CopilotAPI('test-token')
+
+    await expect(
+      copilot._createNotification({
+        senderId: 'sender-id',
+        senderType: 'internalUser',
+        recipientInternalUserId: 'recipient-id',
+        deliveryTargets: {
+          inProduct: {
+            title: 'Reminder',
+          },
+        },
+      }),
+    ).rejects.toThrow('CopilotAPI#createNotification returned no notification for an in-product delivery')
+  })
+})

src/utils/CopilotAPI.ts

@@ -208,9 +208,17 @@ export class CopilotAPI {
     return InternalUsersSchema.parse(await this.copilot.retrieveInternalUser({ id }))
   }
 
-  async _createNotification(requestBody: NotificationRequestBody): Promise<NotificationCreatedResponse> {
+  async _createNotification(requestBody: NotificationRequestBody): Promise<NotificationCreatedResponse | null> {
     console.info('CopilotAPI#_createNotification', this.token)
     const notification = await this.copilot.createNotification({ requestBody })
+    if (!notification) {
+      if (!requestBody.deliveryTargets?.inProduct) {
+        console.info('CopilotAPI#_createNotification | No notification resource returned for email-only delivery')
+        return null
+      }
+
+      throw new Error('CopilotAPI#createNotification returned no notification for an in-product delivery')
+    }
     return NotificationCreatedResponseSchema.parse(notification)
   }