[IOS] The onMessageReceivedInTheForeground callback triggers multiple times for a single notification

[ebabhi]

Issue

When the app is in the foreground and receives a notification, the onMessageReceivedInTheForeground callback is triggered multiple times.

Expected Behaviour

onMessageReceivedInTheForeground should only be triggered once per notification.

Steps to replicate

1. Set up Pusher Beams on iOS.
2. Add a callback to onMessageReceivedInTheForeground.
3. The callback will be triggered multiple times.

Logs from Xcode for a single notification

SwiftPusherBeamsPlugin: message received: ["body": "DEBUG", "data": Optional({
    pusher =     {
        instanceId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
        publishId = "pubid-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
        userShouldIgnore = 1;
    };
}), "title": "DEBUG"]
flutter: {pusher: {userShouldIgnore: true, publishId: pubid-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, instanceId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}}
SwiftPusherBeamsPlugin: message received: ["body": "DEBUG", "data": nil, "title": "DEBUG"]
SwiftPusherBeamsPlugin: message received: ["body": "DEBUG", "data": Optional({
    pusher =     {
        instanceId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
        publishId = "pubid-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
        userShouldIgnore = 1;
    };
}), "title": "DEBUG"]
flutter: null
flutter: {pusher: {userShouldIgnore: true, publishId: pubid-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, instanceId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}}
SwiftPusherBeamsPlugin: message received: ["body": "DEBUG", "data": nil, "title": "DEBUG"]
SwiftPusherBeamsPlugin: message received: ["body": "DEBUG", "data": nil, "title": "DEBUG"]
flutter: null
flutter: null
SwiftPusherBeamsPlugin: message received: ["body": "DEBUG", "data": nil, "title": "DEBUG"]
flutter: null

[Miko2x]

Have you been able to solve this problem? @ebabhi

[ebabhi]

@Miko2x, No, We switched to Firebase Cloud Messaging. I believe you should, too.

[roazagba]

@ebabhi
@Miko2x
@aonemd

I found a solution that works correctly and without bugs. You can avoid repetitive duplicate notifications by using a timestamp-based identifier. This will check whether the notification has already been processed.

Another technique: In the notification data, you can insert unique data for the same control.

int? _lastTimestamp; 
PusherBeams.instance.onMessageReceivedInTheForeground((notification) {
    if (Platform.isIOS) {
      final now = DateTime.now().millisecondsSinceEpoch;

      // Avoid repetitions within a short interval of 100 milliseconds
      if (_lastTimestamp != null && (now - _lastTimestamp!) < 100) {
        return;
      }

      _lastTimestamp = now;
    }

    final title = (notification['title'] as String?) ?? 'Notification';
    final body = (notification['body'] as String?) ?? '';

    NotificationService.showNotification(title: title, body: body);
});