🐛 [Firebase Cloud Messaging] getInitialMessage() called multiple times for a single notification

[MuhammadFaizan980]

Bug report

Whenever a message is sent from server or any other device, getInitailMessage() gets called 3 times and getInitialMessage stream is being listened multiple times. It is expected to be called only once as notification is processed or read.
I am using firebase_messaging: ^8.0.0-dev.8

[markusaksli-nc]

Hi @MuhammadFaizan980
What do you mean? getInitialMessage is an asynchronous method that returns a RemoteMessage if the app was opened from a terminated state through one. It is not a stream and it is only called by using it in your own code. The method also consumes the initial RemoteMessage and any calls to it after the first will return null.

This is either a mistake in your code or you are referring to a different method/stream. Please check your code or provide additional clarification as to what you mean.
Thank you

[MuhammadFaizan980]

Thanks for your reply @markusaksli-nc, I had a typo (now typo is fixed).
Let me elaborate further.
When getInitialMessage() is called or onMessageOpenedApp is listened, it is supposed to consume RemoteMessage right? but thing is, it does not, when I open the app from terminated state or suspended state by clicking notification, respective functions are called but when I restart app, it again calls above functions with RemoteMessage still not null as I have added a null check for RemoteMessage, This behavior persists for two to three attempts (that is what I mean by 2-3 times call) before RemoteMessage is consumed and null is returned.

[markusaksli-nc]

Can you please provide a minimal complete reproducible code sample?

I was not able to reproduce this with the official example using firebase_messaging: ^8.0.0-dev.8

flutter doctor -v

[√] Flutter (Channel master, 1.24.0-8.0.pre.365, on Microsoft Windows [Version 10.0.19041.630], locale et-EE)
    • Flutter version 1.24.0-8.0.pre.365 at C:\Development\flutter_master
    • Framework revision 2ceb371d21 (8 hours ago), 2020-11-24 17:18:06 -0800
    • Engine revision 6ed357c8b3
    • Dart version 2.12.0 (build 2.12.0-74.0.dev)

[√] Android toolchain - develop for Android devices (Android SDK version 30.0.2)
    • Android SDK at C:\Users\marku\AppData\Local\Android\sdk
    • Platform android-30, build-tools 30.0.2
    • Java binary at: C:\Users\marku\AppData\Local\JetBrains\Toolbox\apps\AndroidStudio\ch-0\201.6953283\jre\bin\java
    • Java version OpenJDK Runtime Environment (build 1.8.0_242-release-1644-b01)
    • All Android licenses accepted.

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

[√] Visual Studio - develop for Windows (Visual Studio Community 2019 16.7.7)
    • Visual Studio at C:\Program Files (x86)\Microsoft Visual Studio\2019\Community
    • Visual Studio Community 2019 version 16.7.30621.155
    • Windows 10 SDK version 10.0.18362.0

[√] Android Studio (version 4.1.0)
    • Android Studio at C:\Users\marku\AppData\Local\JetBrains\Toolbox\apps\AndroidStudio\ch-0\201.6953283
    • 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 1.8.0_242-release-1644-b01)

[√] IntelliJ IDEA Ultimate Edition (version 2020.2)
    • IntelliJ at C:\Users\marku\AppData\Local\JetBrains\Toolbox\apps\IDEA-U\ch-0\202.7660.26
    • 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

[√] Connected device (5 available)
    • SM G950F (mobile) • ce12171c51cc001c03 • android-arm64  • Android 9 (API 28)
    • Windows (desktop) • windows            • windows-x64    • Microsoft Windows [Version 10.0.19041.630]
    • Web Server (web)  • web-server         • web-javascript • Flutter Tools
    • Chrome (web)      • chrome             • web-javascript • Google Chrome 87.0.4280.66
    • Edge (web)        • edge               • web-javascript • Microsoft Edge 86.0.622.68

• No issues found!

[MuhammadFaizan980]

Sorry for late reply, was out of town, here is the minimal code:

  void initState() {
    _configureFcm();
    super.initState();
  }
  Future<void> _configureFcm() async {
    _firebaseMessaging = FirebaseMessaging.instance;
    await _firebaseMessaging.requestPermission(
      alert: true,
      announcement: false,
      badge: true,
      carPlay: false,
      criticalAlert: false,
      provisional: false,
      sound: true,
    );
    FirebaseMessaging.onMessage.listen((RemoteMessage message) async {
      // Works fine
    });
    FirebaseMessaging.onMessageOpenedApp.listen((RemoteMessage message) { 
      AppToast.showToast(message: 'onMessageOpenedApp called');
      // This gets called three times, every time gets called when app is restarted or I navigate back using pushReplacement()
    });
    FirebaseMessaging.instance.getInitialMessage().then((RemoteMessage message){
      AppToast.showToast(message: 'getInitialMessage() called');
      // This gets called 4 times, every time gets called when app is restarted or I navigate back using pushReplacement()
    });
  }