Merge pull request #205 from vernu/dev

invalidate stale fcm tokens

Author: vernu

api/src/gateway/gateway.service.ts

@@ -46,6 +46,7 @@ export class GatewayService {
       buildId: input.buildId,
     })
 
+    const now = new Date()
     const deviceData: any = { ...input, user }
 
     // Set default name to "brand model" if not provided
@@ -57,10 +58,16 @@ export class GatewayService {
     if (input.simInfo) {
       deviceData.simInfo = {
         ...input.simInfo,
-        lastUpdated: input.simInfo.lastUpdated || new Date(),
+        lastUpdated: input.simInfo.lastUpdated || now,
       }
     }
 
+    if (input.fcmToken) {
+      deviceData.fcmTokenUpdatedAt = now
+      deviceData.fcmTokenInvalidatedAt = undefined
+      deviceData.fcmTokenInvalidReason = undefined
+    }
+
     if (device && device.appVersionCode <= 11) {
       return await this.updateDevice(device._id.toString(), {
         ...deviceData,
@@ -98,15 +105,22 @@ export class GatewayService {
       input.enabled = true;
     }
 
+    const now = new Date()
     const updateData: any = { ...input }
 
     // Handle simInfo if provided
     if (input.simInfo) {
       updateData.simInfo = {
         ...input.simInfo,
-        lastUpdated: input.simInfo.lastUpdated || new Date(),
+        lastUpdated: input.simInfo.lastUpdated || now,
       }
     }
+
+    if (input.fcmToken && input.fcmToken !== device.fcmToken) {
+      updateData.fcmTokenUpdatedAt = now
+      updateData.fcmTokenInvalidatedAt = undefined
+      updateData.fcmTokenInvalidReason = undefined
+    }
 
     return await this.deviceModel.findByIdAndUpdate(
       deviceId,
@@ -1078,6 +1092,9 @@ const updatedSms = await this.smsModel.findByIdAndUpdate(
     // Update FCM token if provided and different
     if (input.fcmToken && input.fcmToken !== device.fcmToken) {
       updateData.fcmToken = input.fcmToken
+      updateData.fcmTokenUpdatedAt = now
+      updateData.fcmTokenInvalidatedAt = undefined
+      updateData.fcmTokenInvalidReason = undefined
       fcmTokenUpdated = true
     }
 

api/src/gateway/schemas/device.schema.ts

@@ -20,6 +20,15 @@ export class Device {
   @Prop({ type: String })
   fcmToken: string
 
+  @Prop({ type: Date })
+  fcmTokenUpdatedAt?: Date
+
+  @Prop({ type: Date })
+  fcmTokenInvalidatedAt?: Date
+
+  @Prop({ type: String })
+  fcmTokenInvalidReason?: string
+
   @Prop({ type: String })
   brand: string
 

api/src/gateway/tasks/heartbeat-check.task.ts

@@ -1,13 +1,44 @@
 import { Injectable, Logger } from '@nestjs/common'
 import { Cron, CronExpression } from '@nestjs/schedule'
 import { InjectModel } from '@nestjs/mongoose'
-import { Model } from 'mongoose'
+import { Model, Types } from 'mongoose'
 import { Device, DeviceDocument } from '../schemas/device.schema'
 import * as firebaseAdmin from 'firebase-admin'
 import { Message } from 'firebase-admin/messaging'
 
 const FCM_BATCH_SIZE = 500
 
+function isPermanentFcmTokenError(
+  error: { code?: string; message?: string } | null | undefined,
+): boolean {
+  if (!error) {
+    return false
+  }
+
+  const normalizedCode = String(error.code || '')
+    .toLowerCase()
+    .replace(/^messaging\//, '')
+  const normalizedMessage = String(error.message || '').toLowerCase()
+
+  if (
+    normalizedCode === 'registration-token-not-registered' ||
+    normalizedCode === 'unregistered' ||
+    normalizedCode === 'invalid-registration-token'
+  ) {
+    return true
+  }
+
+  if (
+    normalizedMessage.includes('requested entity was not found') ||
+    normalizedMessage.includes('not registered') ||
+    normalizedMessage.includes('registration token is not a valid')
+  ) {
+    return true
+  }
+
+  return false
+}
+
 @Injectable()
 export class HeartbeatCheckTask {
   private readonly logger = new Logger(HeartbeatCheckTask.name)
@@ -17,10 +48,10 @@ export class HeartbeatCheckTask {
   ) {}
 
   /**
-   * Cron job that runs every 5 minutes to check for devices with stale heartbeats
+   * Cron job that runs hourly to check for devices with stale heartbeats
    * (>30 minutes) and send FCM push notifications to trigger heartbeat requests.
    */
-  @Cron(CronExpression.EVERY_5_MINUTES)
+  @Cron(CronExpression.EVERY_HOUR)
   async checkAndTriggerStaleHeartbeats() {
     this.logger.log('Running cron job to check for stale heartbeats')
 
@@ -36,6 +67,7 @@ export class HeartbeatCheckTask {
           { lastHeartbeat: { $lt: thirtyMinutesAgo } },
         ],
         fcmToken: { $exists: true, $ne: null },
+        fcmTokenInvalidatedAt: { $exists: false },
       })
 
       if (devices.length === 0) {
@@ -88,13 +120,49 @@ export class HeartbeatCheckTask {
         totalFailureCount += response.failureCount
 
         if (response.failureCount > 0) {
+          const invalidationUpdates: Array<{
+            deviceId: string
+            reason: string
+          }> = []
+
           response.responses.forEach((resp, index) => {
             if (!resp.success) {
+              const errorMessage = resp.error?.message || 'Unknown error'
+              const errorCode = resp.error?.code || 'UNKNOWN_ERROR'
+
               this.logger.error(
-                `Failed to send heartbeat check to device ${batchDeviceIds[index]}: ${resp.error?.message || 'Unknown error'}`,
+                `Failed to send heartbeat check to device ${batchDeviceIds[index]}: ${errorMessage}`,
               )
+
+              if (isPermanentFcmTokenError(resp.error)) {
+                invalidationUpdates.push({
+                  deviceId: batchDeviceIds[index],
+                  reason: `${errorCode}: ${errorMessage}`,
+                })
+              }
             }
           })
+
+          if (invalidationUpdates.length > 0) {
+            const invalidatedAt = new Date()
+            await this.deviceModel.bulkWrite(
+              invalidationUpdates.map(({ deviceId, reason }) => ({
+                updateOne: {
+                  filter: { _id: new Types.ObjectId(deviceId) },
+                  update: {
+                    $set: {
+                      fcmTokenInvalidatedAt: invalidatedAt,
+                      fcmTokenInvalidReason: reason,
+                    },
+                  },
+                },
+              })),
+            )
+
+            this.logger.warn(
+              `Marked ${invalidationUpdates.length} device(s) as FCM-token-invalid; heartbeat retries paused until token update`,
+            )
+          }
         }
       }