Fix getToken() iOS function for messaging

[anfriis]

This function often throws an exception:
Cloud Messaging "[messaging/unknown] The operation couldn’t be completed"
This fixes it and returns the FCM token successfully.

Fixes #2657

Summary

Checklist

• Supports Android
• Supports iOS
• e2e tests added or updated in packages/**/e2e
• Flow types updated
• Typescript types updated

Test Plan

I have tested on two different iPhone's, trying to get FCM token several times using this function, and it works now whereas it didn't before because it threw the exception above.

Release Plan

[IOS][BUGFIX] [messaging] - Fix getToken() iOS function for messaging

[CATEGORY][type] [LOCATION] - Message

---

Think react-native-firebase is great? Please consider supporting the project with any of the below:

• 👉 Donate via Open Collective
• 👉 Follow React Native Firebase and Invertase on Twitter
• 👉 Star this repo on GitHub ⭐️
• 👉 Contribute; see our contributing guide

[mikehardy]

Tagging in @Salakar and @Ehesp - this could be a fix for what appears to me to be the hottest issue in the repo right now

[Salakar]

Thanks for the PR, but this looks incomplete to me, authorisedEntity, scope & options args are no longer handled in the method (breaking change).

[anfriis]

Thanks for reviewing @Salakar.
It may be a breaking change for someone whom it is currently working for. Though I assume that very few people (perhaps nobody) are using the advanced usage params authorizedEntity and scope, which defaults to 'FCM'. and options. I am unfortunately not that deep into the internals of the framework to be able to change this.
By looking at the feedback on the issue #2657, the getToken() function is currently broken most of the time even for basic usage, so we should consider supporting basic usage first, and then support the more advanced usage later IMO.

[Ehesp]

@anfriis not sure that's a wise call on our end, we need it to be working with no breaking changes - who knows what people have done in their projects (patch packages, local fixes etc). We'll get it looked at asap.

[jacobp100]

What about if we call the function in this PR if the scope is undefined (defaulted to *) - and leave the current behaviour on other cases?

[MamyChow]

Any update ?
I don't understand why we don't use instanceIDWithHandler because firebase's docs say that's better to use it unless there is a need to enable multiple senders.

[codecov]

Codecov Report

Merging #3130 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #3130   +/-   ##
=======================================
  Coverage   89.77%   89.77%           
=======================================
  Files         109      109           
  Lines        3389     3389           
=======================================
  Hits         3042     3042           
  Misses        347      347

[ottob]

This fixed getToken for me too. And then with #3075 I could finally get my notifications.

Thanks @anfriis!

[Gray-Wind]

You should also drop options, as they are not used anymore.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ Salakar
❌ Anders Friis

---

Anders Friis seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[Ehesp]

Thanks for sending this PR up. I'm going to close it as we ended up re-writing a lot of the iOS internals as part of wider fixes on #3339. We implemented this change along with supporting scopes/auth-entities too using the previous API.