Use ReactNativeAsyncStorage from community package. #7128

hsubox76 · 2023-03-15T20:03:55Z

DO NOT MERGE until 6/20. This is a breaking change and must be released with a major version. It is expected to release with the next major version of the SDK in June 2023.

See internal doc: https://docs.google.com/document/d/1ZA1u7gfyIZjNpFY_v8DVBpBvDZAbxASl826OvjiTLvg/edit?resourcekey=0-AfgkOJV0qHh5waZvdLxucg#heading=h.9g9y2z36z0g9

getAuth() has been usingAsyncStorage from the React Native core package, which was deprecated for a while and has now been removed. Users are expected to get AsyncStorage from the community package (@react-native-async-storage/async-storage) now. We have tried to bridge the gap for a while by using the core AsyncStorage as the default and allowing users to import the community AsyncStorage using initializeAuth(), but the core AsyncStorage no longer exists so we can default to the community package with the next breaking change.

The community package has been added as a dependency to auth, which is an extraneous dependency for non-react-native users but it won't go into non-react-native bundles and the npm download size should be small. If the community package isn't installed, the React Native bundle will error on build, something we can't avoid as the Metro bundler doesn't allow runtime requires.

Fixes #6493
Fixes #6067

Tested this out in Expo and it's working.

changeset-bot · 2023-03-15T20:03:59Z

🦋 Changeset detected

Latest commit: 9a04b68

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
@firebase/auth	Major
firebase	Major
@firebase/auth-compat	Patch
@firebase/rules-unit-testing	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

google-oss-bot · 2023-03-15T20:28:52Z

Size Report ¹

Affected Products

@firebase/auth
Type Base (60ff98d) Merge (4c32520) Diff
react-native 183 kB 182 kB -842 B (-0.5%)
@firebase/auth/react-native
Type Base (60ff98d) Merge (4c32520) Diff
browser 183 kB 182 kB -842 B (-0.5%)
module 183 kB 182 kB -842 B (-0.5%)
firebase
Type Base (60ff98d) Merge (4c32520) Diff
firebase-auth-react-native.js 160 kB 162 kB +2.75 kB (+1.7%)

Test Logs

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

google-oss-bot · 2023-03-15T20:54:09Z

Size Analysis Report ¹

Affected Products

No changes between base commit (60ff98d) and merge commit (4c32520).

Test Logs

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

Neosoulink · 2023-03-16T10:20:44Z

Thanks @hsubox76 for this PR, will help a lot when merged 🙏

hsubox76 · 2023-03-16T17:17:43Z

packages/auth/index.rn.ts

@@ -50,28 +49,6 @@ export {
 // MFA
 export { PhoneMultiFactorGenerator } from './src/platform_browser/mfa/assertions/phone';

-/**


For reviewers: This section was added as a hack to import from react-native core by default (which will normally show a warning), but not show the warning if the user overrides the default and provides the newer community version of AsyncStorage. Since this change makes the community package the default, this isn't needed anymore.

prameshj · 2023-03-20T19:10:29Z

LGTM, Thanks!

Should we also update docs to call out this change + the issue with Metro and runtime deps?

hsubox76 · 2023-03-27T20:30:11Z

Note to self: ensure auth-compat also defaults to community AsyncStorage.

prameshj · 2023-05-16T23:14:20Z

docs-devsite/auth.md

@@ -1969,16 +1968,6 @@ ProviderId: {
 }
 ```

-## reactNativeLocalPersistence
-
-An implementation of [Persistence](./auth.persistence.md#persistence_interface) of type 'LOCAL' for use in React Native environments.


I'm curious why this was exposed externally. Looks like the index.rn.ts was using "reactNativeLocalPersistence" as part of getAuth, but the developer wasn;t directly passing it as a param to initializeAuth, were they?

I don't actually remember the reason, maybe in case the users wanted to call it explicitly, or if they wanted to add multiple persistences (use the array format) for some reason, although I can't think of another persistence you'd want to add for React Native.

prameshj · 2023-05-16T23:30:23Z

cc @sam-gc @renkelvin

prameshj · 2023-05-16T23:33:05Z

LGTM, Thanks!

Should we also update docs to call out this change + the issue with Metro and runtime deps?

@hsubox76 bumping this back up.. should we update the web SDK docs/guide for react-native?

hsubox76 · 2023-05-17T16:45:21Z

LGTM, Thanks!
Should we also update docs to call out this change + the issue with Metro and runtime deps?

@hsubox76 bumping this back up.. should we update the web SDK docs/guide for react-native?

Thanks for the reminder, it's in blog post format right now I believe, so we can edit the blog post.

# Why When updating an example using the Firebase JS SDK, I found out that it wasn't persisting the auth session, meaning you had to login again every time you refreshed. At some point after `firebase` 9.1.3, it started defaulting to in-memory storage**. Between all the pre-9.x instructions still out there and the tendency for internet searches to return instructions that work for web but not React Native, but without saying they don't work for React Native, it's tricky to find what you need. Further, once you find the needed `reactNativeLocalPersistence` persistence provider, you'll find that it doesn't work in SDK 48, as it uses the now-removed core local storage. [This at least will be fixed soon](firebase/firebase-js-sdk#7128). While the custom persistence code should be short-lived, at least overriding the default persistence could be necessary indefinitely. It took me several hours to figure this all out, the Firebase JS SDK can otherwise be a splendid way to quickly bootstrap an app, so would like to save others the trouble with a concise, complete, and confirmed-working code example. ** EDIT: as I read me, it seems possible that this is instead fallback behavior due to local persistence not working, so don't want to presume it's an intentional default. Depending on how I apply `reactNativeLocalPersistence`, I can get actual errors about missing local storage functionality, or it fails silently, and the silent failure scenario is the exact same code that used to give me a deprecation warning, so it's unclear. # How Created an FYI with the details, added a callout for additional auth configuration in the Using Firebase guide. # Test Plan Looked at the doc, tried the link. # Checklist  - [x] Documentation is up to date to reflect these changes (eg: https://docs.expo.dev and README.md).

dwyfrequency

LGTM

hsubox76 changed the title ~~Use ReactNativeAsyncStorage from community package.~~ DO NOT MERGE: Use ReactNativeAsyncStorage from community package. Mar 15, 2023

Neosoulink mentioned this pull request Mar 16, 2023

Bug: authentication persistence incompatible with React-native v0.71.x ( and Expo SDK 48 or upper) #7129

Closed

hsubox76 requested a review from sam-gc March 16, 2023 17:13

hsubox76 commented Mar 16, 2023

View reviewed changes

NhienLam mentioned this pull request Mar 27, 2023

onAuthStateChange or persist no longer works on react native expo apps!!!! #7152

Closed

ben-hamel mentioned this pull request Apr 30, 2023

Firebase Auth not being persisted on expo refresh ben-hamel/rn-the-scene-app-expo-version#10

Closed

hsubox76 added 3 commits May 15, 2023 10:14

Use React Native AsyncStorage community package

ee01c95

Use React Native AsyncStorage community package

a0d2877

Add changeset

0020a65

hsubox76 force-pushed the ch-asyncstorage branch from 86d1273 to 0020a65 Compare May 15, 2023 17:15

fix docs

9a04b68

prameshj approved these changes May 16, 2023

View reviewed changes

hsubox76 added this to the v10 milestone May 23, 2023

keith-kurak mentioned this pull request Jun 2, 2023

[docs] link to FYI for additional Firebase JS auth setup expo/expo#22729

Merged

1 task

hsubox76 changed the title ~~DO NOT MERGE: Use ReactNativeAsyncStorage from community package.~~ Use ReactNativeAsyncStorage from community package. Jul 2, 2023

hsubox76 marked this pull request as ready for review July 2, 2023 18:35

hsubox76 requested review from a team and egilmorez as code owners July 2, 2023 18:35

hsubox76 requested review from markarndt, kevinthecheung, lisajian, renkelvin and dwyfrequency as code owners July 2, 2023 18:35

dwyfrequency approved these changes Jul 5, 2023

View reviewed changes

hsubox76 merged commit f1c8d38 into master Jul 5, 2023
21 of 22 checks passed

hsubox76 deleted the ch-asyncstorage branch July 5, 2023 20:59

google-oss-bot mentioned this pull request Jul 6, 2023

Version Packages #7421

Merged

firebase locked and limited conversation to collaborators Aug 5, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use ReactNativeAsyncStorage from community package. #7128

Use ReactNativeAsyncStorage from community package. #7128

hsubox76 commented Mar 15, 2023 •

edited

changeset-bot bot commented Mar 15, 2023 •

edited

google-oss-bot commented Mar 15, 2023 •

edited

`@firebase/auth`

`@firebase/auth/react-native`

`firebase`

google-oss-bot commented Mar 15, 2023 •

edited

Neosoulink commented Mar 16, 2023

hsubox76 Mar 16, 2023

prameshj commented Mar 20, 2023

hsubox76 commented Mar 27, 2023

prameshj May 16, 2023

hsubox76 May 17, 2023

prameshj commented May 16, 2023

prameshj commented May 16, 2023

hsubox76 commented May 17, 2023

dwyfrequency left a comment

Use ReactNativeAsyncStorage from community package. #7128

Use ReactNativeAsyncStorage from community package. #7128

Conversation

hsubox76 commented Mar 15, 2023 • edited

changeset-bot bot commented Mar 15, 2023 • edited

🦋 Changeset detected

google-oss-bot commented Mar 15, 2023 • edited

Size Report 1

Affected Products

@firebase/auth

@firebase/auth/react-native

firebase

Test Logs

google-oss-bot commented Mar 15, 2023 • edited

Size Analysis Report 1

Affected Products

Test Logs

Neosoulink commented Mar 16, 2023

hsubox76 Mar 16, 2023

Choose a reason for hiding this comment

prameshj commented Mar 20, 2023

hsubox76 commented Mar 27, 2023

prameshj May 16, 2023

Choose a reason for hiding this comment

hsubox76 May 17, 2023

Choose a reason for hiding this comment

prameshj commented May 16, 2023

prameshj commented May 16, 2023

hsubox76 commented May 17, 2023

dwyfrequency left a comment

Choose a reason for hiding this comment

hsubox76 commented Mar 15, 2023 •

edited

changeset-bot bot commented Mar 15, 2023 •

edited

google-oss-bot commented Mar 15, 2023 •

edited

Size Report ¹

`@firebase/auth`

`@firebase/auth/react-native`

`firebase`

google-oss-bot commented Mar 15, 2023 •

edited

Size Analysis Report ¹