[firebase_auth]: Firebase User Display Name for user with Apple Sign-In is STILL "null".

[adifyr]

Is there an existing issue for this?

• I have searched the existing issues.

Which plugins are affected?

Auth

Which platforms are affected?

iOS

Description

I am testing Firebase Sign-In With Apple on my app with a Sandbox Apple User. I need to populate the name field in my user registration with the given + family name provided by Apple. But the displayName is coming as "null". Here is the debug log when I debugPrint() the user.displayName.

flutter: User Display Name With Apple Sign-In for user QJWvBkeiGHXhhQgN83xqL4ink9l2: "null"

Reproducing the issue

1. Sign-In With Apple. (I used a Sandbox Account, but sandbox accounts have name too)
2. I have the following code inside my initState() on the registration screen.

@override
void initState() {
  super.initState();
  final user = FirebaseAuth.instance.currentUser!;
  debugPrint('User Display Name With Apple Sign-In for user ${user.uid}: "${user.displayName}"');
}

Firebase Core version

3.8.1

Flutter Version

3.24.4

Relevant Log Output

flutter: User Display Name With Apple Sign-In for user QJWvBkeiGHXwwQgN98xqL4ink9l2: "null"

Flutter dependencies

Expand Flutter dependencies snippet

Dart SDK 3.5.4
Flutter SDK 3.24.4
mobile 1.4.2+43

dependencies:
- audio_video_progress_bar 2.0.3 [flutter]
- cached_network_image 3.4.1 [cached_network_image_platform_interface cached_network_image_web flutter flutter_cache_manager octo_image]
- cloud_firestore 5.5.1 [cloud_firestore_platform_interface cloud_firestore_web collection firebase_core firebase_core_platform_interface flutter meta]
- cloud_functions 5.2.0 [cloud_functions_platform_interface cloud_functions_web firebase_core firebase_core_platform_interface flutter]
- collection 1.18.0
- contact_add 0.0.3 [flutter plugin_platform_interface]
- country_code_picker 3.1.0 [flutter collection]
- file_picker 8.1.4 [flutter flutter_web_plugins flutter_plugin_android_lifecycle plugin_platform_interface ffi path win32 cross_file web]
- firebase_app_check 0.3.1+6 [firebase_app_check_platform_interface firebase_app_check_web firebase_core firebase_core_platform_interface flutter]
- firebase_auth 5.3.4 [firebase_auth_platform_interface firebase_auth_web firebase_core firebase_core_platform_interface flutter meta]
- firebase_core 3.8.1 [firebase_core_platform_interface firebase_core_web flutter meta]
- firebase_messaging 15.1.6 [firebase_core firebase_core_platform_interface firebase_messaging_platform_interface firebase_messaging_web flutter meta]
- firebase_storage 12.3.7 [firebase_core firebase_core_platform_interface firebase_storage_platform_interface firebase_storage_web flutter]
- firebase_ui_firestore 1.7.0 [cloud_firestore firebase_ui_localizations firebase_ui_shared flutter]
- flutter 0.0.0 [characters collection material_color_utilities meta vector_math sky_engine]
- flutter_animate 4.5.2 [flutter flutter_shaders]
- flutter_markdown 0.7.4+1 [flutter markdown meta path]
- flutter_riverpod 2.6.1 [collection flutter meta riverpod state_notifier]
- flutter_staggered_grid_view 0.7.0 [flutter]
- form_builder_validators 11.0.0 [flutter flutter_localizations intl]
- google_fonts 6.2.1 [flutter http path_provider crypto]
- image 4.3.0 [archive meta xml]
- image_cropper 8.0.2 [flutter image_cropper_platform_interface image_cropper_for_web]
- image_picker 1.1.2 [flutter image_picker_android image_picker_for_web image_picker_ios image_picker_linux image_picker_macos image_picker_platform_interface image_picker_windows]
- in_app_purchase 3.2.0 [flutter in_app_purchase_android in_app_purchase_platform_interface in_app_purchase_storekit]
- intl 0.19.0 [clock meta path]
- jovial_svg 1.1.24 [xml collection args vector_math jovial_misc http meta flutter]
- just_audio 0.9.42 [just_audio_platform_interface just_audio_web audio_session rxdart path path_provider async uuid crypto meta flutter]
- material_symbols_icons 4.2801.0 [flutter]
- mobkit_dashed_border 0.0.7 [flutter]
- posthog_flutter 4.7.1 [flutter flutter_web_plugins plugin_platform_interface]
- share_plus 10.1.2 [cross_file meta mime flutter flutter_web_plugins share_plus_platform_interface file url_launcher_web url_launcher_windows url_launcher_linux url_launcher_platform_interface ffi web win32]
- simple_icons 10.1.3 [flutter]
- stream_transform 2.1.0
- url_launcher 6.3.1 [flutter url_launcher_android url_launcher_ios url_launcher_linux url_launcher_macos url_launcher_platform_interface url_launcher_web url_launcher_windows]
- youtube_player_flutter 9.1.1 [flutter flutter_inappwebview]

dev dependencies:
- flutter_launcher_icons 0.14.2 [args checked_yaml cli_util image json_annotation path yaml]
- flutter_lints 5.0.0 [lints]
- flutter_test 0.0.0 [flutter test_api matcher path fake_async clock stack_trace vector_math leak_tracker_flutter_testing async boolean_selector characters collection leak_tracker leak_tracker_testing material_color_utilities meta source_span stream_channel string_scanner term_glyph vm_service]

transitive dependencies:
- _flutterfire_internals 1.3.47 [collection firebase_core firebase_core_platform_interface flutter meta]
- archive 3.6.1 [crypto path]
- args 2.5.0
- async 2.11.0 [collection meta]
- audio_session 0.1.21 [flutter flutter_web_plugins rxdart meta]
- boolean_selector 2.1.1 [source_span string_scanner]
- cached_network_image_platform_interface 4.1.1 [flutter flutter_cache_manager]
- cached_network_image_web 1.3.1 [cached_network_image_platform_interface flutter flutter_cache_manager web]
- characters 1.3.0
- checked_yaml 2.0.3 [json_annotation source_span yaml]
- cli_util 0.4.2 [meta path]
- clock 1.1.1
- cloud_firestore_platform_interface 6.5.1 [_flutterfire_internals collection firebase_core flutter meta plugin_platform_interface]
- cloud_firestore_web 4.3.5 [_flutterfire_internals cloud_firestore_platform_interface collection firebase_core firebase_core_web flutter flutter_web_plugins]
- cloud_functions_platform_interface 5.5.40 [firebase_core flutter meta plugin_platform_interface]
- cloud_functions_web 4.10.5 [cloud_functions_platform_interface firebase_core firebase_core_web flutter flutter_web_plugins]
- convert 3.1.1 [typed_data]
- cross_file 0.3.4+2 [meta web]
- crypto 3.0.5 [typed_data]
- fake_async 1.3.1 [clock collection]
- ffi 2.1.3
- file 7.0.1 [meta path]
- file_selector_linux 0.9.3 [cross_file file_selector_platform_interface flutter]
- file_selector_macos 0.9.4+2 [cross_file file_selector_platform_interface flutter]
- file_selector_platform_interface 2.6.2 [cross_file flutter http plugin_platform_interface]
- file_selector_windows 0.9.3+3 [cross_file file_selector_platform_interface flutter]
- firebase_app_check_platform_interface 0.1.0+40 [_flutterfire_internals firebase_core flutter meta plugin_platform_interface]
- firebase_app_check_web 0.2.0+2 [_flutterfire_internals firebase_app_check_platform_interface firebase_core firebase_core_web flutter flutter_web_plugins web]
- firebase_auth_platform_interface 7.4.10 [_flutterfire_internals collection firebase_core flutter meta plugin_platform_interface]
- firebase_auth_web 5.13.5 [firebase_auth_platform_interface firebase_core firebase_core_web flutter flutter_web_plugins http_parser meta web]
- firebase_core_platform_interface 5.3.1 [collection flutter flutter_test meta plugin_platform_interface]
- firebase_core_web 2.18.2 [firebase_core_platform_interface flutter flutter_web_plugins meta web]
- firebase_messaging_platform_interface 4.5.49 [_flutterfire_internals firebase_core flutter meta plugin_platform_interface]
- firebase_messaging_web 3.9.5 [_flutterfire_internals firebase_core firebase_core_web firebase_messaging_platform_interface flutter flutter_web_plugins meta web]
- firebase_storage_platform_interface 5.1.34 [_flutterfire_internals collection firebase_core flutter meta plugin_platform_interface]
- firebase_storage_web 3.10.6 [_flutterfire_internals async firebase_core firebase_core_web firebase_storage_platform_interface flutter flutter_web_plugins http meta web]
- firebase_ui_localizations 1.13.0 [flutter flutter_localizations path]
- firebase_ui_shared 1.4.1 [flutter]
- fixnum 1.1.1
- flutter_cache_manager 3.4.1 [clock collection file flutter http path path_provider rxdart sqflite uuid]
- flutter_inappwebview 6.1.5 [flutter flutter_inappwebview_platform_interface flutter_inappwebview_android flutter_inappwebview_ios flutter_inappwebview_macos flutter_inappwebview_web flutter_inappwebview_windows]
- flutter_inappwebview_android 1.1.3 [flutter flutter_inappwebview_platform_interface]
- flutter_inappwebview_internal_annotations 1.1.1
- flutter_inappwebview_ios 1.1.2 [flutter flutter_inappwebview_platform_interface]
- flutter_inappwebview_macos 1.1.2 [flutter flutter_inappwebview_platform_interface]
- flutter_inappwebview_platform_interface 1.3.0+1 [flutter flutter_inappwebview_internal_annotations plugin_platform_interface]
- flutter_inappwebview_web 1.1.2 [flutter flutter_web_plugins web flutter_inappwebview_platform_interface]
- flutter_inappwebview_windows 0.6.0 [flutter flutter_inappwebview_platform_interface]
- flutter_localizations 0.0.0 [flutter intl characters clock collection material_color_utilities meta path vector_math]
- flutter_plugin_android_lifecycle 2.0.23 [flutter]
- flutter_shaders 0.1.3 [flutter vector_math]
- flutter_web_plugins 0.0.0 [flutter characters collection material_color_utilities meta vector_math]
- http 1.2.2 [async http_parser meta web]
- http_parser 4.0.2 [collection source_span string_scanner typed_data]
- image_cropper_for_web 6.0.2 [flutter flutter_web_plugins image_cropper_platform_interface web]
- image_cropper_platform_interface 7.0.0 [flutter plugin_platform_interface http]
- image_picker_android 0.8.12+15 [flutter flutter_plugin_android_lifecycle image_picker_platform_interface]
- image_picker_for_web 3.0.5 [flutter flutter_web_plugins image_picker_platform_interface mime web]
- image_picker_ios 0.8.12 [flutter image_picker_platform_interface]
- image_picker_linux 0.2.1+1 [file_selector_linux file_selector_platform_interface flutter image_picker_platform_interface]
- image_picker_macos 0.2.1+1 [file_selector_macos file_selector_platform_interface flutter image_picker_platform_interface]
- image_picker_platform_interface 2.10.0 [cross_file flutter http plugin_platform_interface]
- image_picker_windows 0.2.1+1 [file_selector_platform_interface file_selector_windows flutter image_picker_platform_interface]
- in_app_purchase_android 0.3.6+12 [collection flutter in_app_purchase_platform_interface json_annotation]
- in_app_purchase_platform_interface 1.4.0 [flutter plugin_platform_interface]
- in_app_purchase_storekit 0.3.20+2 [collection flutter in_app_purchase_platform_interface json_annotation]
- jovial_misc 0.9.0 [async collection convert meta]
- json_annotation 4.9.0 [meta]
- just_audio_platform_interface 4.3.0 [flutter plugin_platform_interface]
- just_audio_web 0.4.13 [just_audio_platform_interface flutter flutter_web_plugins web]
- leak_tracker 10.0.5 [clock collection meta path vm_service]
- leak_tracker_flutter_testing 3.0.5 [flutter leak_tracker leak_tracker_testing matcher meta]
- leak_tracker_testing 3.0.1 [leak_tracker matcher meta]
- lints 5.0.0
- markdown 7.2.2 [args meta]
- matcher 0.12.16+1 [async meta stack_trace term_glyph test_api]
- material_color_utilities 0.11.1 [collection]
- meta 1.15.0
- mime 1.0.6
- octo_image 2.1.0 [flutter]
- path 1.9.0
- path_provider 2.1.4 [flutter path_provider_android path_provider_foundation path_provider_linux path_provider_platform_interface path_provider_windows]
- path_provider_android 2.2.10 [flutter path_provider_platform_interface]
- path_provider_foundation 2.4.0 [flutter path_provider_platform_interface]
- path_provider_linux 2.2.1 [ffi flutter path path_provider_platform_interface xdg_directories]
- path_provider_platform_interface 2.1.2 [flutter platform plugin_platform_interface]
- path_provider_windows 2.3.0 [ffi flutter path path_provider_platform_interface]
- petitparser 6.0.2 [meta]
- platform 3.1.5
- plugin_platform_interface 2.1.8 [meta]
- riverpod 2.6.1 [collection meta stack_trace state_notifier]
- rxdart 0.28.0
- share_plus_platform_interface 5.0.1 [cross_file flutter meta mime plugin_platform_interface path_provider uuid]
- sky_engine 0.0.99
- source_span 1.10.0 [collection path term_glyph]
- sprintf 7.0.0
- sqflite 2.4.1 [flutter sqflite_android sqflite_darwin sqflite_platform_interface sqflite_common path]
- sqflite_android 2.4.0 [flutter sqflite_common path sqflite_platform_interface]
- sqflite_common 2.5.4+5 [synchronized path meta]
- sqflite_darwin 2.4.1 [flutter sqflite_platform_interface meta sqflite_common path]
- sqflite_platform_interface 2.4.0 [flutter platform sqflite_common plugin_platform_interface meta]
- stack_trace 1.11.1 [path]
- state_notifier 1.0.0 [meta]
- stream_channel 2.1.2 [async]
- string_scanner 1.2.0 [source_span]
- synchronized 3.3.0+3
- term_glyph 1.2.1
- test_api 0.7.2 [async boolean_selector collection meta source_span stack_trace stream_channel string_scanner term_glyph]
- typed_data 1.3.2 [collection]
- url_launcher_android 6.3.11 [flutter url_launcher_platform_interface]
- url_launcher_ios 6.3.1 [flutter url_launcher_platform_interface]
- url_launcher_linux 3.2.0 [flutter url_launcher_platform_interface]
- url_launcher_macos 3.2.1 [flutter url_launcher_platform_interface]
- url_launcher_platform_interface 2.3.2 [flutter plugin_platform_interface]
- url_launcher_web 2.3.3 [flutter flutter_web_plugins url_launcher_platform_interface web]
- url_launcher_windows 3.1.2 [flutter url_launcher_platform_interface]
- uuid 4.5.1 [crypto sprintf meta fixnum]
- vector_math 2.1.4
- vm_service 14.2.5
- web 1.0.0
- win32 5.7.2 [ffi]
- xdg_directories 1.0.4 [meta path]
- xml 6.5.0 [collection meta petitparser]
- yaml 3.1.2 [collection source_span string_scanner]

Additional context and comments

This issue was brought to the team's twice before in #7274 and #9662. But AFAIK a fix was never done and the conversations were limited to collaborators.

[SelaseKay]

Hi @adifyr, it seems to work as expected for actual accounts. I'm yet to test with a sandbox account. Can you confirm if it works with an actual account on your end?

[adifyr]

@SelaseKay Can confirm that it neither works with a Sandbox Account nor with an actual account. Here's the log for the returned user credential after authentication:

flutter: Apple Credential - UID: 9ciyH9NzsrXfJo26nneb8x1EdW43 | Display Name: null | Email: null

Here's the code I'm using to Sign-In With Apple. I've added the scopes for email & name and everything. Getting null in return every time.

void signInWithApple() async {
  setState(() => loadingApple = true);
  try {
    final appleProvider = AppleAuthProvider();
    appleProvider.addScope('email');
    appleProvider.addScope('name');
    final cred = await FirebaseAuth.instance.signInWithProvider(AppleAuthProvider());
    debugPrint(
      'Apple Credential - UID: ${cred.user?.uid} | Display Name: ${cred.user?.displayName} | Email: ${cred.user?.email}',
    );
    final user = await ref.read(userProvider.future);
    if (user == null && cred.user != null) {
      Posthog().capture(eventName: 'app-register', properties: {
        'provider': 'apple',
        'platform': Platform.operatingSystem,
        'user_id': cred.user!.uid,
      });
    }
    if (mounted) Navigator.pushReplacementNamed(context, user == null ? '/register' : '/home', arguments: true);
  } on FirebaseAuthException catch (fae) {
    debugPrintStack(label: 'Error signing in with Apple: ${fae.code} - ${fae.message}', stackTrace: fae.stackTrace);
    if (mounted) {
      setState(() => loadingApple = false);
      ScaffoldMessenger.of(context).showSnackBar(SnackBar(
        content: Text('Could Not Sign In: ${fae.code} - ${fae.message}'),
        backgroundColor: Colors.red.shade800,
      ));
    }
  }
}

Update:

I tried removing the Sign-In Apple ID configuration from my iPhone Settings in Account > Sign-In & Security > Sign in with Apple. Still no luck. Getting null again.

[adifyr]

I also have a question: Why aren't the scopes for name and email added by default? Developers will need them most of the time and during Apple Review, we always have to contend with Guideline 4.0 - Design where we can't ask for the user's name ourselves.

Dealing with this just feels unnecessarily painful is all I'm saying.

[SelaseKay]

Hi @adifyr, I tested this with the current firebase_auth example app, and it appears to work as expected. Could you try running the example app to see if the issue still persists? You can also use it as a reference to check if anything might be missing in your implementation.

[adifyr]

Hi. The issue was with my code. The name is present in providerData[0].displayName instead of user.displayName. And it's only available the first time from Apple. So it needs to be set as the user's display name using user.updateDisplayName(name).

Here's the updated code that works:

void signInWithApple() async {
  setState(() => loadingApple = true);
  try {
    final appleProvider = AppleAuthProvider()
      ..addScope('email')
      ..addScope('name');
    final user = (await FirebaseAuth.instance.signInWithProvider(appleProvider)).user;
    final info = user?.providerData[0];
    debugPrint('Apple Credential - UID: ${user?.uid} | Name: ${info?.displayName} | Email: ${info?.email}');
    if (user?.displayName == null && info?.displayName != null) await user?.updateDisplayName(info?.displayName);
    final appUser = await ref.read(userProvider.future);
    if (appUser == null && user != null) {
      await Posthog().capture(
        eventName: 'app-register',
        properties: {'provider': 'apple', 'platform': Platform.operatingSystem, 'user_id': user.uid},
      );
    }
    if (mounted) Navigator.pushReplacementNamed(context, appUser == null ? '/register' : '/home');
  } on FirebaseAuthException catch (fae) {
    debugPrintStack(label: 'Error signing in with Apple: ${fae.code} - ${fae.message}', stackTrace: fae.stackTrace);
    if (mounted) {
      setState(() => loadingApple = false);
      ScaffoldMessenger.of(context).showSnackBar(SnackBar(
        content: Text('Could Not Sign In: ${fae.code} - ${fae.message}'),
        backgroundColor: Colors.red.shade800,
      ));
    }
  }
}

That being said, I'd really do think that the Display Name scope should be included internally every time, since their Guideline 4.0 - Design prohibits the requesting of the user's name manually. Also, this needs to be thoroughly documented.