Firebase Cloud Messaging] getInitialMessage() returns non null notification even after it is consumed.

[suhail600]

Future<void> onSelectBackgroundNotification() async {
    RemoteMessage? message =
        await FirebaseMessaging.instance.getInitialMessage();

    if (message?.notification != null) {
      _handleMessage(message!.data);
      message = null;
      log('background Message has been opened');
    }

    FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) {
      RemoteNotification? notification = message.notification;
      if (notification != null) {
        _handleMessage(message.dat,);
      }
    });
  }

1. the code runs when app is in background state and handle message navigates to a page.

this code snippet is worked --

FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) {
     RemoteNotification? notification = message.notification;
     if (notification != null) {
       _handleMessage(message.dat,);
     }
   });

2. when we hot restart from there --

RemoteMessage? message =
       await FirebaseMessaging.instance.getInitialMessage();

    this return old data  of consumed message (fromstep 1) .
    and is expected to work atlest 2 to 3 times , then discarded.

Please fix this , or give any suggestion

[darshankawar]

@suhail600
Can you provide flutter doctor -v, plugin version, platform on which you are seeing this behavior along with complete minimal reproducible code sample ?

Also check if you see the same behavior using plugin example too or not.

[suhail600]

@suhail600 Can you provide flutter doctor -v, plugin version, platform on which you are seeing this behavior along with complete minimal reproducible code sample ?

Also check if you see the same behavior using plugin example too or not.

this is the flutter doctor -v

[√] Flutter (Channel stable, 3.7.6, on Microsoft Windows [Version 10.0.22621.1413], locale en-IN)
• Flutter version 3.7.6 on channel stable at C:\Users\suhail\development\sdks\flutter
• Upstream repository https://github.com/flutter/flutter.git
• Framework revision 12cb4eb7a0 (6 weeks ago), 2023-03-01 10:29:26 -0800
• Engine revision ada363ee93
• Dart version 2.19.3
• DevTools version 2.20.1

[√] Windows Version (Installed version of Windows is version 10 or higher)

[√] Android toolchain - develop for Android devices (Android SDK version 31.0.0)
• Android SDK at C:\Users\suhail\AppData\Local\Android\sdk
• Platform android-33, build-tools 31.0.0
• Java binary at: C:\Program Files\Android\Android Studio\jre\bin\java
• Java version OpenJDK Runtime Environment (build 11.0.15+0-b2043.56-8887301)
• All Android licenses accepted.

[√] Chrome - develop for the web
• Chrome at C:\Program Files\Google\Chrome\Application\chrome.exe

[X] Visual Studio - develop for Windows
X Visual Studio not installed; this is necessary for Windows development.
Download at https://visualstudio.microsoft.com/downloads/.
Please install the "Desktop development with C++" workload, including all of its default components

[√] Android Studio (version 2022.1)
• Android Studio at C:\Program Files\Android\Android Studio
• Flutter plugin can be installed from:
https://plugins.jetbrains.com/plugin/9212-flutter
• Dart plugin can be installed from:
https://plugins.jetbrains.com/plugin/6351-dart
• Java version OpenJDK Runtime Environment (build 11.0.15+0-b2043.56-8887301)

[√] VS Code (version 1.77.1)
• VS Code at C:\Users\suhail\AppData\Local\Programs\Microsoft VS Code
• Flutter extension version 3.62.0

[√] Connected device (4 available)
• sdk gphone x86 (mobile) • emulator-5554 • android-x86 • Android 11 (API 30) (emulator)
• Windows (desktop) • windows • windows-x64 • Microsoft Windows [Version 10.0.22621.1413]
• Chrome (web) • chrome • web-javascript • Google Chrome 111.0.5563.148
• Edge (web) • edge • web-javascript • Microsoft Edge 112.0.1722.39

[√] HTTP Host Availability
• All required HTTP hosts are available

! Doctor found issues in 1 category.

[suhail600]

@suhail600 Can you provide flutter doctor -v, plugin version, platform on which you are seeing this behavior along with complete minimal reproducible code sample ?

Also check if you see the same behavior using plugin example too or not.

heres the minimal complate code,

import 'dart:async';
import 'dart:convert';
import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_messaging/firebase_messaging.dart';
import 'package:flutter/material.dart';
import 'package:flutter_local_notifications/flutter_local_notifications.dart';


const AndroidNotificationChannel channel = AndroidNotificationChannel(
  'high_importance_channel',
  'High Importance Notifications', 
  description: 'This channel is used for important notifications.',
  importance: Importance.high,
  playSound: true,
);

final FlutterLocalNotificationsPlugin flutterLocalNotificationsPlugin =
    FlutterLocalNotificationsPlugin();

Future<void> _firebaseMessagingBackgroundHandler(RemoteMessage message) async {
  await Firebase.initializeApp();
}

class FirebasePushNotification {
  //initialization
  initialize() async {
    FirebaseMessaging.onBackgroundMessage(_firebaseMessagingBackgroundHandler);

    await flutterLocalNotificationsPlugin
        .resolvePlatformSpecificImplementation<
            AndroidFlutterLocalNotificationsPlugin>()
        ?.createNotificationChannel(channel);

    await FirebaseMessaging.instance
        .setForegroundNotificationPresentationOptions(
      alert: true,
      badge: true,
      sound: true,
    );

    getIosPermission();

    onSelectBackgroundNotification();

    FirebaseMessaging.onMessage.listen((RemoteMessage message) {
      RemoteNotification? notification = message.notification;
      Map<String, dynamic> data = message.data;
      if (notification != null) {
        flutterLocalNotificationsPlugin.show(
          notification.hashCode,
          notification.title,
          notification.body,
          NotificationDetails(
            android: AndroidNotificationDetails(
              channel.id,
              channel.name,
              channelDescription: channel.description,
              playSound: true,
              color: Colors.blue,
              icon: '@mipmap/ic_launcher',
            ),
            iOS: const DarwinNotificationDetails(),
          ),
          payload: jsonEncode(data),
        );
      }
    });

    const AndroidInitializationSettings initializationSettingsAndroid =
        AndroidInitializationSettings('@mipmap/ic_launcher');

    const DarwinInitializationSettings initializationSettingsDarwin =
        DarwinInitializationSettings(
      requestSoundPermission: false,
      requestBadgePermission: false,
      requestAlertPermission: false,
    
    );


    InitializationSettings initializationSettings =
        const InitializationSettings(
      android: initializationSettingsAndroid,
      iOS: initializationSettingsDarwin,
    );

    flutterLocalNotificationsPlugin.initialize(
      initializationSettings,
      onDidReceiveNotificationResponse: onSelectForegroundNotification,
    );
  }

  Future<void> getIosPermission() async {
    NotificationSettings settings =
        await FirebaseMessaging.instance.requestPermission(
      alert: true,
      announcement: false,
      badge: true,
      carPlay: false,
      criticalAlert: false,
      provisional: false,
      sound: true,
    );
    
  }


  Future<void> onSelectBackgroundNotification() async {
  
    RemoteMessage? message =
        await FirebaseMessaging.instance.getInitialMessage();
    
      if (message?.notification != null) {
        _handleMessage(message!.data, true);
      }
    }

    FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) {
      RemoteNotification? notification = message.notification;
      if (notification != null) {
        _handleMessage(message.data, true);
      }
    });
  }

  Future<dynamic> onSelectForegroundNotification(
      NotificationResponse notificationResponse) async {
    var data = jsonDecode(notificationResponse.payload ?? '');
    print('data $data');
    _handleMessage(data, false);
  }


  void _handleMessage(Map<String, dynamic> data) {
   print('count');
  }

and is called from bottom nav page's initstate like

final firebase = FirebasePushNotification();

 @override
  void initState() {
    firebase.initialize();
    super.initState();
  }

[suhail600]

@suhail600 Can you provide flutter doctor -v, plugin version, platform on which you are seeing this behavior along with complete minimal reproducible code sample ?

Also check if you see the same behavior using plugin example too or not.

here are the plugin versions,

firebase_core: ^2.4.1
firebase_messaging: ^14.2.1

and the example in the repo cant be used to replicate , as the use case and implementation differs .(even though the methods are same). It was also experienced in my previous projects as well , and already this issue is raised by someone before me and closed it without the solution as no activity. you can replicate the issue with the details provided.

select a notification while placing the app in backgound , then app opens to a specifc screen by the handler function.
then try to restart the app then the
FirebaseMessaging.instance.getInitialMessage()

gives non null message with the previous message data that consumed while app was in the background, and the message handler functions and goes to that page.

[darshankawar]

@suhail600
Thanks for the update. Can you upgrade plugins to latest version and try again ?
Ideally getInitialMessage() should be called only once and once consumed, it should be null, which leads me to this case : #4188

[suhail600]

@suhail600 Thanks for the update. Can you upgrade plugins to latest version and try again ? Ideally getInitialMessage() should be called only once and once consumed, it should be null, which leads me to this case : #4188

tried updating the plugins,
firebase_core: ^2.9.0
firebase_messaging: ^14.4.0
these are the latest ones and same issue persists.

can u once again go trough the detailed code and issues provided? to find any issue , if not it is with the plugin itself and please fix it as its a major issue.