fix(auth): deprecate FirebaseAuth.instanceFor's persistence parameter
#11259
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
russellwheatley
requested changes
Jul 11, 2023
packages/firebase_auth/firebase_auth_web/lib/src/interop/auth.dart
Outdated
Show resolved
Hide resolved
exaby73
changed the title
FirebaseAuth.instanceFor's persistance parameter
russellwheatley
changed the title
FirebaseAuth.instanceFor's persistance parameterFirebaseAuth.instanceFor's persistence parameter
russellwheatley
approved these changes
Sep 14, 2023
Lyokone
requested changes
Sep 18, 2023
Comment on lines
+44
to
+52
| factory FirebaseAuth.instanceFor({ | ||
| required FirebaseApp app, | ||
| @Deprecated( | ||
| 'Will be removed in future release. Use setPersistence() instead.', | ||
| ) | ||
| Persistence? persistence, | ||
| }) { | ||
| return _firebaseAuthInstances.putIfAbsent(app.name, () { | ||
| return FirebaseAuth._(app: app, persistence: persistence); | ||
| return FirebaseAuth._(app: app); |
There was a problem hiding this comment.
If we remove the behavior, it's not a deprecation but a straight removal (breaking) even if we are warning the user.
we should just put the warning now, and remove the behavior at the next breaking release
Lyokone
approved these changes
Sep 18, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
When the plugin is initialised by Flutter, initialise
FirebaseAuthwithout any persistence. This causes a error to be thrown when callingFirebaseAuth.instanceForwith a persistence value as firebase_auth tries to reinitialise the auth instance with a new persistence.We cannot use
setPersistenceto fix this since it's aFutureandinstanceForis synchronous, and the user cannot provide the persistence they want before the plugin is initialised. Therefore, thepersistenceparameter is being deprecated and users are expected to callsetPersistenceseparately to set thepersistenceof the auth object.Only affects web
Related Issues
Fixes #10961
Checklist
Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (
[x]).This will ensure a smooth and quick review process. Updating the
pubspec.yamland changelogs is not required.///).melos run analyze) does not report any problems on my PR.Breaking Change
Does your PR require plugin users to manually update their apps to accommodate your change?