Add Sign in with Apple Display Name API and unit test

[aiwenisevan]

Discussion

• This resolves Sign in with Apple display name not fulfilled [235848270] - Buganizer

Testing

• Unit testing Passed for both FIROAuthProviderTest and FIRAuthTest

API Changes

• Internal API proposal: Sign in with Apple Display Name API

[rosalyntan]

One initial comment: Please remove the files under AuthSample.xcodeproj and xcshareddata/xcschemes, as well as Application.plist from the PR -- these files should only be updated locally.

I'll take a more in-depth look at this later today!

[google-oss-bot]

Size Report ¹

Affected Products

• FirebaseAuth

  Type	Base (c105a0d)	Merge (ee1587c)	Diff
  CocoaPods	?	1.20 MB	? (?)

Test Logs

• Merge (ee1587c): https://github.com/firebase/firebase-ios-sdk/actions/runs/2849428004

1. https://storage.googleapis.com/firebase-sdk-metric-reports/DffkGOcnTv.html

[renkelvin]

LGTM, thanks!

[byaruhaf]

So does this mean the display name is auto-updated so there is no need to update display name with appleIDCredential?

[peterfriese]

So does this mean the display name is auto-updated so there is no need to update display name with appleIDCredential?

After receiving ASAuthorization from Apple, call appleCredential(withIDToken: rawNonce: fullName:) to create the credential, and then sign in.

Here is the relevant code snippet from the documentation:

@available(iOS 13.0, *)
extension MainViewController: ASAuthorizationControllerDelegate {

  func authorizationController(controller: ASAuthorizationController, didCompleteWithAuthorization authorization: ASAuthorization) {
    if let appleIDCredential = authorization.credential as? ASAuthorizationAppleIDCredential {
      guard let nonce = currentNonce else {
        fatalError("Invalid state: A login callback was received, but no login request was sent.")
      }
      guard let appleIDToken = appleIDCredential.identityToken else {
        print("Unable to fetch identity token")
        return
      }
      guard let idTokenString = String(data: appleIDToken, encoding: .utf8) else {
        print("Unable to serialize token string from data: \(appleIDToken.debugDescription)")
        return
      }
      // Initialize a Firebase credential, including the user's full name.
      let credential = OAuthProvider.appleCredential(withIDToken: idTokenString,
                                                        rawNonce: nonce,
                                                        fullName: appleIDCredential.fullName)
      // Sign in with Firebase.
      Auth.auth().signIn(with: credential) { (authResult, error) in
        if error {
          // Error. If error.code == .MissingOrInvalidNonce, make sure
          // you're sending the SHA256-hashed nonce as a hex string with
          // your request to Apple.
          print(error.localizedDescription)
          return
        }
        // User is signed in to Firebase with Apple.
        // ...
      }
    }
  }

  func authorizationController(controller: ASAuthorizationController, didCompleteWithError error: Error) {
    // Handle error.
    print("Sign in with Apple errored: \(error)")
  }

}

As you can see, you no longer need to update the user's displayName in a separate operation, it's all done for you.

[byaruhaf]

This is Awesome Thanks Peter

[LilaQ]

@peterfriese I feel like I'm missing something. In the Auth.auth().addStateDidChangeListener the user still comes with a nil for a displayName for me

[peterfriese]

Hi @LilaQ, I just verified this works as intended with Firebase 10.7.0.

If you're on the latest version of the SDK, can you share an MVCE with us? You can also check out the code in this PR - it contains the updated call that updates the user's display name when signing in with Apple.

[jscottarmstrong]

@LilaQ are you using the local emulator? If I run my app connected to the local emulator for authentication, I don't see full name getting populated, but if I connect to the my live Firebase app, it is working as expected with 10.7.0.