[🐛 [firebase_messaging] FirebaseMessaging.onMessage (foreground) not triggered with data notification

Bug report

Describe the bug Issue is on iOS only (android works ok) and when the app is in foreground. With data only notification, didReceiveRemoteNotification is fired, but FirebaseMessaging.onMessage is not.

Steps to reproduce

Send 2 different notifications.

Notification received both in didReceiveRemoteNotification and FirebaseMessaging.onMessage.

{
    aps =     {
        alert =         {
            body = B;
            title = A;
        };
    };
    "gcm.message_id" = 1638615208630726;
    "google.c.a.e" = 1;
    "google.c.fid" = fzlSdyFV5UkgptQSaioLni;
    "google.c.sender.id" = 198414532777;
}

Notification received in didReceiveRemoteNotification but NOT in FirebaseMessaging.onMessage.

{
    aps =     {
        "content-available" = 1;
    };
    "gcm.message_id" = 1638615118391202;
    "google.c.fid" = fzlSdyFV5UkgptQSaioLni;
    "google.c.sender.id" = 198414532777;
    my_field = 17;
}

Expected behavior

Also the second notification to be received in FirebaseMessaging.onMessage.

Sample project

#import "UIKit/UIKit.h"
#import "AppDelegate.h"
#import "GeneratedPluginRegistrant.h"

#import "EventHandler.h"

@import UserNotifications;

@implementation AppDelegate {
    FlutterEventSink _eventSink;
    NSMutableDictionary* listeners;
}

- (BOOL)application:(UIApplication*)application
didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {

    [GeneratedPluginRegistrant registerWithRegistry:self];
    FlutterViewController* controller = (FlutterViewController*)self.window.rootViewController;

    FlutterEventChannel* eventFirst = [FlutterEventChannel
        eventChannelWithName:@"my_first_event_channel"
             binaryMessenger:controller.binaryMessenger];
    [eventFirst setStreamHandler:self];

    [FIRMessaging messaging].delegate = self;

     if (@available(iOS 10.0, *)) {
           [UNUserNotificationCenter currentNotificationCenter].delegate = (id<UNUserNotificationCenterDelegate>) self;
     }

    return [super application:application didFinishLaunchingWithOptions:launchOptions];
}

- (FlutterError*)onListenWithArguments:(id)arguments
                             eventSink:(FlutterEventSink)eventSink {
  _eventSink = eventSink;
  return nil;
}

- (FlutterError*)onCancelWithArguments:(id)arguments {
  [[NSNotificationCenter defaultCenter] removeObserver:self];
  _eventSink = nil;
  return nil;
}

- (void) startListening:(id)listener emitter:(FlutterEventSink)emitter {
    // Prepare callback dictionary
    if (self->listeners == nil) self->listeners = [NSMutableDictionary new];

    // Get callback id
    NSString* currentListenerId =
        [[NSNumber numberWithUnsignedInteger:[((NSObject*) listener) hash]] stringValue];

    // Prepare a timer like self calling task
    void (^callback)(void) = ^() {
        void (^callback)(void) = [self->listeners valueForKey:currentListenerId];
        if ([self->listeners valueForKey:currentListenerId] != nil) {
            int time = (int) CFAbsoluteTimeGetCurrent();
            emitter([NSString stringWithFormat:@"Hello Listener! %d", time]);
            dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 1 * NSEC_PER_SEC), dispatch_get_main_queue(), callback);
        }
    };

    // Run task
    [self->listeners setObject:callback forKey:currentListenerId];
    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 1 * NSEC_PER_SEC), dispatch_get_main_queue(), callback);
}

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:
    (void (^)(UIBackgroundFetchResult))   completionHandler {
    [[FIRMessaging messaging] appDidReceiveMessage:userInfo];

    // Print full message.
    NSLog(@"%@", userInfo);

    completionHandler(UIBackgroundFetchResultNewData);
}

- (void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler {
 [super userNotificationCenter:center willPresentNotification:notification withCompletionHandler:completionHandler];
}

- (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler {
 [super userNotificationCenter:center didReceiveNotificationResponse:response withCompletionHandler:completionHandler];
}

- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error {
  NSLog(@"Unable to register for remote notifications: %@", error);
}

// This function is added here only for debugging purposes, and can be removed if swizzling is enabled.
// If swizzling is disabled then this function must be implemented so that the APNs device token can be paired to the FCM registration token.
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
  NSLog(@"APNs device token retrieved: %@", deviceToken);
  // With swizzling disabled you must set the APNs device token here.
  // [FIRMessaging messaging].APNSToken = deviceToken;
}
@end
\

Additional context

One Signal is also configured with a NotificationServiceExtension target.

Flutter doctor

Click To Expand

``` [✓] Flutter (Channel stable, 2.5.3, locale en-IT) • Flutter version 2.5.3 at /usr/local/Caskroom/flutter/2.0.5/flutter • Upstream repository https://github.com/flutter/flutter.git • Framework revision 18116933e7 (7 weeks ago), 2021-10-15 10:46:35 -0700 • Engine revision d3ea636dc5 • Dart version 2.14.4 [✓] Xcode - develop for iOS and macOS • Xcode at /Applications/Xcode.app/Contents/Developer • Xcode 13.1, Build version 13A1030d • CocoaPods version 1.11.2 ```

Flutter dependencies

Click To Expand

``` dependencies: - audioplayers 0.20.1 [uuid path_provider http flutter flutter_web_plugins] - auth_buttons 2.0.2 [flutter flutter_svg google_fonts] - auto_size_text 3.0.0 [flutter] - better_player 0.0.73 [flutter cupertino_icons wakelock pedantic meta flutter_widget_from_html_core visibility_detector path_provider collection xml] - cached_network_image 3.2.0 [flutter flutter_cache_manager octo_image cached_network_image_platform_interface cached_network_image_web] - camera 0.9.4+5 [camera_platform_interface camera_web flutter pedantic quiver flutter_plugin_android_lifecycle] - carousel_slider 4.0.0 [flutter] - crypto 3.0.1 [collection typed_data] - custom_navigation_bar 0.8.2 [flutter] - datetime_picker_formfield 2.0.0 [flutter intl] - device_info_plus 3.1.1 [flutter device_info_plus_platform_interface device_info_plus_linux device_info_plus_macos device_info_plus_web device_info_plus_windows] - dio 4.0.4 [http_parser path] - dio_cookie_manager 2.0.0 [cookie_jar dio] - easy_localization 3.0.0 [flutter shared_preferences intl args path easy_logger flutter_localizations] - emoji_picker_flutter 1.0.8 [flutter shared_preferences] - file_picker 4.2.6 [flutter flutter_web_plugins flutter_plugin_android_lifecycle plugin_platform_interface ffi path] - firebase_auth 3.2.0 [firebase_auth_platform_interface firebase_auth_web firebase_core firebase_core_platform_interface flutter meta] - firebase_crashlytics 2.3.0 [firebase_core firebase_core_platform_interface firebase_crashlytics_platform_interface flutter stack_trace] - firebase_database 8.1.0 [firebase_core firebase_database_platform_interface firebase_database_web flutter] - firebase_messaging 11.2.0 [firebase_core firebase_core_platform_interface firebase_messaging_platform_interface firebase_messaging_web flutter meta] - flutter 0.0.0 [characters collection meta typed_data vector_math sky_engine] - flutter_bloc 7.3.3 [flutter bloc provider] - flutter_colorpicker 1.0.2 [flutter] - flutter_keyboard_visibility 5.1.0 [meta flutter_keyboard_visibility_platform_interface flutter_keyboard_visibility_web flutter] - flutter_local_notifications 9.1.4 [clock flutter flutter_local_notifications_linux flutter_local_notifications_platform_interface timezone] - flutter_map 0.14.0 [async collection flutter http intl latlong2 meta positioned_tap_detector_2 proj4dart transparent_image tuple vector_math] - flutter_native_splash 1.3.2 [args image meta path xml yaml universal_io] - flutter_shimmer 2.1.2 [flutter] - flutter_slidable 1.1.0 [flutter] - flutter_sound 8.4.2 [path_provider recase uuid provider path synchronized logger flutter flutter_sound_platform_interface flutter_sound_web] - flutter_spinkit 5.1.0 [flutter] - flutter_webrtc 0.6.8 [flutter path_provider] - fluttertoast 8.0.8 [flutter flutter_web_plugins] - gallery_saver 2.3.2 [flutter path_provider http path] - google_fonts 2.1.0 [flutter http path_provider crypto] - google_sign_in 5.2.1 [flutter google_sign_in_platform_interface google_sign_in_web meta] - image 3.1.0 [archive meta xml] - image_cropper 1.4.1 [flutter] - image_picker 0.8.4+4 [flutter flutter_plugin_android_lifecycle image_picker_for_web image_picker_platform_interface] - intl_phone_number_input 0.7.0+2 [flutter meta libphonenumber_plugin equatable collection] - jitsi_meet 4.0.0 [flutter jitsi_meet_platform_interface jitsi_meet_web_plugin] - lat_lon_grid_plugin 0.2.2 [flutter flutter_map latlong2] - material_dialogs 1.1.1 [flutter lottie] - onesignal_flutter 3.2.7 [flutter] - open_file 3.2.1 [flutter ffi] - permission_handler 8.3.0 [flutter meta permission_handler_platform_interface] - proximity_sensor 1.0.2 [flutter] - scrollable_positioned_list 0.2.3 [flutter collection] - settings_ui 1.0.0 [flutter] - share_extend 2.0.0 [meta flutter] - share_plus 3.0.4 [meta mime flutter share_plus_platform_interface share_plus_linux share_plus_macos share_plus_windows share_plus_web] - shared_preferences 2.0.9 [flutter meta shared_preferences_android shared_preferences_ios shared_preferences_linux shared_preferences_macos shared_preferences_platform_interface shared_preferences_web shared_preferences_windows] - shimmer 2.0.0 [flutter] - sign_in_with_apple 3.3.0 [flutter meta sign_in_with_apple_platform_interface sign_in_with_apple_web] - socket_io_client 2.0.0-beta.4-nullsafety.0 [logging socket_io_common js] - sqflite 2.0.0+4 [flutter sqflite_common path] - string_validator 0.3.0 - syncfusion_flutter_sliders 19.3.56 [flutter intl syncfusion_flutter_core] - synchronized 3.0.0 - timeago 3.1.0 - url_launcher 6.0.17 [flutter meta url_launcher_android url_launcher_ios url_launcher_linux url_launcher_macos url_launcher_platform_interface url_launcher_web url_launcher_windows] - video_compress 3.1.0 [flutter] - video_player 2.2.7 [flutter meta video_player_platform_interface video_player_web html] - visibility_detector 0.2.2 [flutter] - wakelock 0.5.6 [flutter meta wakelock_macos wakelock_platform_interface wakelock_web wakelock_windows] dev dependencies: - build_runner 2.1.5 [args async analyzer build build_config build_daemon build_resolvers build_runner_core code_builder collection crypto dart_style frontend_server_client glob graphs http_multi_server io js logging meta mime package_config path pool pub_semver pubspec_parse shelf shelf_web_socket stack_trace stream_transform timing watcher web_socket_channel yaml] - flutter_test 0.0.0 [flutter test_api path fake_async clock stack_trace vector_math async boolean_selector characters charcode collection matcher meta source_span stream_channel string_scanner term_glyph typed_data] - freezed 1.0.0 [analyzer build build_config collection meta source_gen freezed_annotation] dependency overrides: - libphonenumber 2.0.2 [flutter meta] transitive dependencies: - _fe_analyzer_shared 31.0.0 [meta] - analyzer 2.8.0 [_fe_analyzer_shared cli_util collection convert crypto glob meta package_config path pub_semver source_span watcher yaml] - archive 3.1.6 [crypto path] - args 2.3.0 - async 2.8.1 [collection meta] - bloc 7.2.1 [meta] - boolean_selector 2.1.0 [source_span string_scanner] - build 2.1.1 [analyzer async convert crypto glob logging meta path] - build_config 1.0.0 [checked_yaml json_annotation path pubspec_parse yaml] - build_daemon 3.0.1 [built_collection built_value http_multi_server logging path pool shelf shelf_web_socket stream_transform watcher web_socket_channel] - build_resolvers 2.0.5 [analyzer async build crypto graphs logging path package_config pool pub_semver stream_transform yaml] - build_runner_core 7.2.2 [async build build_config build_resolvers collection convert crypto glob graphs json_annotation logging meta path package_config pool timing watcher yaml] - built_collection 5.1.1 - built_value 8.1.3 [built_collection collection fixnum meta] - cached_network_image_platform_interface 1.0.0 [flutter flutter_cache_manager] - cached_network_image_web 1.0.1 [flutter flutter_cache_manager cached_network_image_platform_interface] - camera_platform_interface 2.1.1 [cross_file flutter meta plugin_platform_interface stream_transform] - camera_web 0.2.1+1 [camera_platform_interface flutter flutter_web_plugins stream_transform] - characters 1.1.0 - charcode 1.3.1 - checked_yaml 2.0.1 [json_annotation source_span yaml] - cli_util 0.3.5 [meta path] - clock 1.1.0 - code_builder 4.1.0 [built_collection built_value collection matcher meta] - collection 1.15.0 - convert 3.0.1 [typed_data] - cookie_jar 3.0.1 - cross_file 0.3.2 [flutter js meta] - csslib 0.17.1 [source_span] - cupertino_icons 1.0.4 - dart_style 2.2.0 [analyzer args path pub_semver source_span] - dbus 0.5.6 [args ffi meta pedantic xml] - device_info_plus_linux 2.1.0 [device_info_plus_platform_interface file flutter meta] - device_info_plus_macos 2.2.0 [device_info_plus_platform_interface flutter] - device_info_plus_platform_interface 2.2.1 [flutter meta plugin_platform_interface] - device_info_plus_web 2.1.0 [device_info_plus_platform_interface flutter_web_plugins flutter] - device_info_plus_windows 2.1.0 [device_info_plus_platform_interface ffi flutter win32] - easy_logger 0.0.2 [flutter] - equatable 2.0.3 [collection meta] - fake_async 1.2.0 [clock collection] - ffi 1.1.2 - file 6.1.2 [meta path] - firebase_auth_platform_interface 6.1.4 [firebase_core flutter meta plugin_platform_interface] - firebase_auth_web 3.2.0 [firebase_auth_platform_interface firebase_core firebase_core_web flutter flutter_web_plugins http_parser intl js meta] - firebase_core 1.10.0 [firebase_core_platform_interface firebase_core_web flutter meta] - firebase_core_platform_interface 4.2.0 [collection flutter meta plugin_platform_interface] - firebase_core_web 1.3.0 [firebase_core_platform_interface flutter flutter_web_plugins js meta] - firebase_crashlytics_platform_interface 3.1.6 [collection firebase_core flutter meta plugin_platform_interface] - firebase_database_platform_interface 0.1.0+3 [collection firebase_core flutter meta plugin_platform_interface] - firebase_database_web 0.1.1 [firebase_core firebase_core_web firebase_database_platform_interface flutter flutter_web_plugins js] - firebase_messaging_platform_interface 3.1.0 [firebase_core flutter meta plugin_platform_interface] - firebase_messaging_web 2.2.0 [firebase_core firebase_core_web firebase_messaging_platform_interface flutter flutter_web_plugins js meta] - fixnum 1.0.0 - flutter_blurhash 0.6.0 [flutter meta pedantic] - flutter_cache_manager 3.3.0 [clock collection file flutter http path path_provider pedantic rxdart sqflite uuid] - flutter_keyboard_visibility_platform_interface 2.0.0 [flutter meta plugin_platform_interface] - flutter_keyboard_visibility_web 2.0.0 [flutter_keyboard_visibility_platform_interface flutter_web_plugins flutter] - flutter_local_notifications_linux 0.3.0 [flutter flutter_local_notifications_platform_interface dbus path xdg_directories] - flutter_local_notifications_platform_interface 5.0.0 [flutter plugin_platform_interface] - flutter_localizations 0.0.0 [flutter intl characters clock collection meta path typed_data vector_math] - flutter_plugin_android_lifecycle 2.0.5 [flutter] - flutter_sound_platform_interface 8.4.2 [flutter meta plugin_platform_interface logger] - flutter_sound_web 8.4.2 [flutter_sound_platform_interface flutter logger flutter_web_plugins meta js] - flutter_svg 0.23.0+1 [flutter meta path_drawing vector_math xml] - flutter_web_plugins 0.0.0 [flutter js characters collection meta typed_data vector_math] - flutter_widget_from_html_core 0.6.2 [csslib flutter html] - freezed_annotation 1.0.0 [collection json_annotation meta] - frontend_server_client 2.1.2 [async path] - glob 2.0.2 [async collection file path string_scanner] - google_sign_in_platform_interface 2.1.0 [flutter meta quiver] - google_sign_in_web 0.10.0+3 [flutter flutter_web_plugins google_sign_in_platform_interface js meta] - graphs 2.1.0 [collection] - html 0.15.0 [csslib source_span] - http 0.13.4 [async http_parser meta path] - http_multi_server 3.0.1 [async] - http_parser 4.0.0 [charcode collection source_span string_scanner typed_data] - image_picker_for_web 2.1.4 [flutter flutter_web_plugins image_picker_platform_interface meta] - image_picker_platform_interface 2.4.1 [flutter http meta plugin_platform_interface cross_file] - intl 0.17.0 [clock path] - io 1.0.3 [meta path string_scanner] - jitsi_meet_platform_interface 2.0.0 [flutter plugin_platform_interface] - jitsi_meet_web_plugin 2.0.0 [flutter js meta flutter_web_plugins jitsi_meet_platform_interface] - js 0.6.3 - json_annotation 4.3.0 [meta] - latlong2 0.8.1 [intl] - libphonenumber_platform_interface 0.3.1 [flutter plugin_platform_interface] - libphonenumber_plugin 0.2.3 [flutter flutter_web_plugins libphonenumber_platform_interface libphonenumber_web libphonenumber] - libphonenumber_web 0.2.0+1 [flutter flutter_web_plugins js libphonenumber_platform_interface] - lists 1.0.1 [meta] - logger 1.1.0 - logging 1.0.2 - lottie 1.2.1 [archive characters flutter path vector_math] - matcher 0.12.10 [stack_trace] - meta 1.7.0 - mgrs_dart 2.0.0 [unicode] - mime 1.0.1 - nested 1.0.0 [flutter] - octo_image 1.0.0+1 [flutter flutter_blurhash] - package_config 2.0.2 [path] - path 1.8.0 - path_drawing 0.5.1+1 [vector_math meta path_parsing flutter] - path_parsing 0.2.1 [vector_math meta] - path_provider 2.0.7 [flutter path_provider_android path_provider_ios path_provider_linux path_provider_macos path_provider_platform_interface path_provider_windows] - path_provider_android 2.0.9 [flutter path_provider_platform_interface] - path_provider_ios 2.0.7 [flutter path_provider_platform_interface] - path_provider_linux 2.1.2 [flutter path path_provider_platform_interface xdg_directories] - path_provider_macos 2.0.3 [flutter] - path_provider_platform_interface 2.0.1 [flutter meta platform plugin_platform_interface] - path_provider_windows 2.0.4 [ffi flutter meta path path_provider_platform_interface win32] - pedantic 1.11.1 - permission_handler_platform_interface 3.7.0 [flutter meta plugin_platform_interface] - petitparser 4.4.0 [meta] - platform 3.0.2 - plugin_platform_interface 2.0.2 [meta] - pool 1.5.0 [async stack_trace] - positioned_tap_detector_2 1.0.4 [flutter] - process 4.2.4 [file path platform] - proj4dart 2.0.0 [mgrs_dart wkt_parser meta] - provider 6.0.1 [collection flutter nested] - pub_semver 2.1.0 [collection meta] - pubspec_parse 1.1.0 [checked_yaml collection json_annotation pub_semver yaml] - quiver 3.0.1+1 [matcher] - recase 4.0.0 - rxdart 0.27.3 - share_plus_linux 2.0.4 [share_plus_platform_interface file flutter meta url_launcher] - share_plus_macos 2.0.2 [share_plus_platform_interface flutter] - share_plus_platform_interface 2.0.1 [flutter meta mime plugin_platform_interface] - share_plus_web 2.0.4 [share_plus_platform_interface url_launcher flutter flutter_web_plugins meta] - share_plus_windows 2.0.3 [share_plus_platform_interface flutter meta url_launcher] - shared_preferences_android 2.0.9 [flutter meta shared_preferences_platform_interface] - shared_preferences_ios 2.0.8 [flutter meta shared_preferences_platform_interface] - shared_preferences_linux 2.0.3 [file flutter meta path path_provider_linux shared_preferences_platform_interface] - shared_preferences_macos 2.0.2 [flutter shared_preferences_platform_interface] - shared_preferences_platform_interface 2.0.0 [flutter] - shared_preferences_web 2.0.2 [flutter flutter_web_plugins meta shared_preferences_platform_interface] - shared_preferences_windows 2.0.3 [file flutter meta path path_provider_platform_interface path_provider_windows shared_preferences_platform_interface] - shelf 1.2.0 [async collection http_parser path stack_trace stream_channel] - shelf_web_socket 1.0.1 [shelf stream_channel web_socket_channel] - sign_in_with_apple_platform_interface 1.0.0 [flutter plugin_platform_interface meta] - sign_in_with_apple_web 1.0.1 [flutter flutter_web_plugins sign_in_with_apple_platform_interface js] - sky_engine 0.0.99 - socket_io_common 2.0.0-beta.1-nullsafety.1 [logging] - source_gen 1.2.0 [analyzer async build dart_style glob meta path source_span yaml] - source_span 1.8.1 [collection path term_glyph] - sqflite_common 2.0.1+1 [synchronized path meta] - stack_trace 1.10.0 [path] - stream_channel 2.1.0 [async] - stream_transform 2.0.0 - string_scanner 1.1.0 [charcode source_span] - syncfusion_flutter_core 19.3.56 [vector_math flutter] - term_glyph 1.2.0 - test_api 0.4.2 [async boolean_selector collection meta source_span stack_trace stream_channel string_scanner term_glyph matcher] - timezone 0.8.0 [path] - timing 1.0.0 [json_annotation] - transparent_image 2.0.0 - tuple 2.0.0 [quiver] - typed_data 1.3.0 [collection] - unicode 0.3.1 [lists] - universal_io 2.0.4 [collection crypto meta typed_data] - url_launcher_android 6.0.13 [flutter meta url_launcher_platform_interface] - url_launcher_ios 6.0.13 [flutter meta url_launcher_platform_interface] - url_launcher_linux 2.0.2 [flutter] - url_launcher_macos 2.0.2 [flutter] - url_launcher_platform_interface 2.0.4 [flutter plugin_platform_interface] - url_launcher_web 2.0.4 [flutter flutter_web_plugins meta url_launcher_platform_interface] - url_launcher_windows 2.0.2 [flutter] - uuid 3.0.5 [crypto] - vector_math 2.1.0 - video_player_platform_interface 4.2.0 [flutter flutter_test meta] - video_player_web 2.0.4 [flutter flutter_web_plugins meta video_player_platform_interface] - wakelock_macos 0.4.0 [flutter flutter_web_plugins wakelock_platform_interface] - wakelock_platform_interface 0.3.0 [flutter meta] - wakelock_web 0.4.0 [flutter flutter_web_plugins js wakelock_platform_interface] - wakelock_windows 0.2.0 [flutter wakelock_platform_interface win32] - watcher 1.0.1 [async path] - web_socket_channel 2.1.0 [async crypto stream_channel] - win32 2.3.1 [ffi] - wkt_parser 2.0.0 - xdg_directories 0.2.0 [meta path process] - xml 5.3.1 [collection meta petitparser] - yaml 3.1.0 [collection source_span string_scanner] ```

firebase / flutterfire