feat(firebase_auth): v1 rework (#3140)

* feat(firebase_auth): v1 rework (#30)

Co-authored-by: Salakar <[email protected]>
Co-authored-by: Helena Ford <[email protected]>
Co-authored-by: ehesp <[email protected]>
Co-authored-by: Kirsty Williams <[email protected]>
Co-authored-by: Greg Hesp <[email protected]>

Author: 5 people

.github/workflows/firebase_auth.yaml

@@ -39,21 +39,27 @@ jobs:
           profile: Nexus 5X
           script: ./.github/workflows/scripts/drive-example.sh android
 
-  ios:
+  apple:
     runs-on: macos-latest
-    timeout-minutes: 30
+    timeout-minutes: 40
     steps:
       - uses: actions/checkout@v1
         with:
           fetch-depth: 0
       - name: "Install Flutter"
-        run: ./.github/workflows/scripts/install-flutter.sh stable
+        run: ./.github/workflows/scripts/install-flutter.sh dev
       - name: "Install Tools"
-        run: ./.github/workflows/scripts/install-tools.sh
-      - name: "Build Example"
+        run: |
+          ./.github/workflows/scripts/install-tools.sh
+          flutter config --enable-macos-desktop
+      - name: "Build iOS Example"
         run: ./.github/workflows/scripts/build-example.sh ios
-      - name: "Drive Example"
+      - name: "Drive iOS Example"
         run: ./.github/workflows/scripts/drive-example.sh ios
+      - name: "Build MacOS Example"
+        run: ./.github/workflows/scripts/build-example.sh macos
+      - name: "Drive MacOS Example"
+        run: ./.github/workflows/scripts/drive-example.sh macos
 
   web:
     runs-on: ubuntu-latest

.vscode/tasks.json

@@ -107,6 +107,69 @@
       "command": "melos exec -c 1 --scope=\"*cloud_firestore_example*\" --fail-fast -- flutter build web",
       "detail": "Build the Firestore Web example application",
       "problemMatcher": []
+    },
+    {
+      "label": "auth -> analyze",
+      "type": "shell",
+      "command": "melos exec -c 1 --scope=\"*auth*\" --fail-fast -- pub global run tuneup check",
+      "detail": "Run Dart Analyzer on all Auth packages",
+      "problemMatcher": []
+    },
+    {
+      "label": "auth -> test",
+      "type": "shell",
+      "command": "melos exec -c 1 --scope=\"*auth*\" --fail-fast --ignore=\"*web*\" --ignore=\"*example*\" -- flutter test",
+      "detail": "Run `flutter test` on all Auth packages (excluding web & example)",
+      "problemMatcher": []
+    },
+    {
+      "label": "auth -> test:e2e",
+      "type": "shell",
+      "command": "melos exec -c 1 --scope=\"*firebase_auth_example*\" --fail-fast --dir-exists=test_driver -- flutter drive --no-pub --target=./test_driver/MELOS_PARENT_PACKAGE_NAME_e2e.dart",
+      "detail": "Run end-to-end testing for Android & iOS via `flutter drive` on the Auth example application",
+      "problemMatcher": []
+    },
+    {
+      "label": "auth -> test:e2e:web",
+      "type": "shell",
+      "command": "melos exec -c 1 --scope=\"*firebase_auth_example*\" --dir-exists=web --fail-fast --dir-exists=test_driver -- flutter drive --release -d chrome --no-pub --verbose-system-logs --browser-name=chrome --target=./test_driver/MELOS_PARENT_PACKAGE_NAME_e2e.dart",
+      "detail": "Run end-to-end testing for Web via `flutter drive` on the Auth example application",
+      "problemMatcher": []
+    },
+    {
+      "label": "auth -> test:web",
+      "type": "shell",
+      "command": "melos exec -c 1 --scope=\"*firebase_auth_web*\" --fail-fast --  flutter test --platform=chrome",
+      "detail": "Run `flutter test` on the Auth web package (with '--platform=chrome')",
+      "problemMatcher": []
+    },
+    {
+      "label": "auth -> build:example:ios",
+      "type": "shell",
+      "command": "melos exec -c 1 --scope=\"*firebase_auth_example*\" --fail-fast -- flutter build ios --no-codesign",
+      "detail": "Build the Auth iOS example application",
+      "problemMatcher": []
+    },
+    {
+      "label": "auth -> build:example:android",
+      "type": "shell",
+      "command": "melos exec -c 1 --scope=\"*firebase_auth_example*\" --fail-fast -- flutter build apk",
+      "detail": "Build the Auth Android example application",
+      "problemMatcher": []
+    },
+    {
+      "label": "auth -> build:example:macos",
+      "type": "shell",
+      "command": "melos exec -c 1 --scope=\"*firebase_auth_example*\" --fail-fast -- flutter build macos",
+      "detail": "Build the Auth MacOS example application",
+      "problemMatcher": []
+    },
+    {
+      "label": "auth -> build:example:web",
+      "type": "shell",
+      "command": "melos exec -c 1 --scope=\"*firebase_auth_example*\" --fail-fast -- flutter build web",
+      "detail": "Build the Auth Web example application",
+      "problemMatcher": []
     }
   ]
 }

docs/migration-guide.mdx

@@ -15,8 +15,8 @@ The table below shows the recommended minimum versions for each plugin which the
 ## Breaking Changes & Deprecations
 
 Although breaking changes have been kept to a minimum, the substantial changes and improvements which have been made
-required us to break a few things (for the greater good). Where possible, we've deprecated any of the "old ways" of
-integrating FlutterFire. You should aim to replace these deprecations as soon as possible.
+required us to break a few things (for the greater good). Where possible, we've deprecated some of the "old ways" of
+integrating FlutterFire and you should aim to replace these deprecations as soon as possible.
 
 ## Migration Steps
 
@@ -253,4 +253,15 @@ The API has mainly been kept the same, however there are some breaking changes.
   - **DEPRECATED**: All sub-class (e.g. `GoogleAuthProvider`) `getCredential()` methods have been deprecated in favor of `credential()`.
     - **DEPRECATED**:  `EmailAuthProvider.getCredentialWithLink()` has been deprecated in favor of `EmailAuthProvider.credentialWithLink()`.
   - **NEW**: Supporting providers can now assign scope and custom request parameters.
-    - The scope and parameters will be used on web platforms when triggering a redirect or popup via `signInWithPopup()` or `signInWithRedirect()`.
+    - The scope and parameters will be used on web platforms when triggering a redirect or popup via `signInWithPopup()` or `signInWithRedirect()`.
+
+## Common Upgrade Issues
+
+### CocoaPods could not find compatible versions for pod 
+
+This issue can happen when you upgrade your FlutterFire packages and attempt to build for iOS or MacOS, this is usually down to one of the following:
+
+ - Your `Podfile.lock` version inside your iOS or MacOS directory is out of date and locked to older versions of the Firebase iOS SDKs whereas the newly upgraded FlutterFire packages might be using newer versions of these SDKs.
+   - **Solution:** Delete the `Podfile.lock` file and try your build again. This file will get regenerated after the next `pod install`.
+ - Your pod specs repo is out of date, meanining CocoaPods locally isn't aware of any potential newer versions of the Firebase iOS SDKs that have been recently published.
+   - **Solution:** Run `pod repo update` in your terminal and try your build again.

docs/sidebars.js

@@ -19,10 +19,10 @@ module.exports = {
     Analytics: ["analytics/overview", toReferenceAPI("firebase_analytics")],
     Authentication: [
       "auth/overview",
-      // "auth/usage",
-      // "auth/social",
-      // "auth/phone",
-      // "auth/error-handling",
+      "auth/usage",
+      "auth/social",
+      "auth/phone",
+      "auth/error-handling",
       toReferenceAPI("firebase_auth"),
     ],
     "Cloud Firestore": [

melos.yaml

@@ -88,7 +88,7 @@ scripts:
       rm -rf ./build ./android/.gradle ./ios/.symlinks ./ios/Pods ./android/.idea ./.idea ./.dart-tool/build
 
 dev_dependencies:
-  pedantic: ^1.8.0
+  pedantic: 1.8.0
 
 environment:
   sdk: ">=2.1.0 <3.0.0"

packages/firebase_auth/analysis_options.yaml

@@ -1,3 +1,59 @@
+## 0.18.0-dev.1
+
+Overall, Firebase Auth has been heavily reworked to bring it inline with the federated plugin setup along with adding new features, documentation and many more unit and end-to-end tests. The API has mainly been kept the same, however there are some breaking changes.
+
+### General
+
+- **BREAKING**: The `FirebaseUser` class has been renamed to `User`.
+- **BREAKING**: The `AuthResult` class has been renamed to `UserCredential`.
+- **NEW**: The `ActionCodeSettings` class is now consumable on all supporting methods.
+  - **NEW**: Added support for the `dynamicLinkDomain` property.
+- **NEW**: Added a new `FirebaseAuthException` class (extends `FirebaseException`).
+  - All errors are now returned as a `FirebaseAuthException`, allowing you to access the code & message associated with the error.
+  - In addition, it is now possible to access the `email` and `credential` properties on exceptions if they exist.
+
+### `FirebaseAuth`
+
+- **BREAKING**: Accessing the current user via `currentUser()` is now synchronous via the `currentUser` getter.
+- **BREAKING**: `isSignInWithEmailLink()` is now synchronous.
+- **DEPRECATED**: `FirebaseAuth.fromApp()` is now deprecated in favor of `FirebaseAuth.instanceFor()`.
+- **DEPRECATED**: `onAuthStateChanged` has been deprecated in favor of `authStateChanges()`.
+- **NEW**: Added support for `idTokenChanges()` stream listener.
+- **NEW**: Added support for `userChanges()` stream listener.
+  - The purpose of this API is to allow users to subscribe to all user events without having to manually hydrate app state in cases where a manual reload was required (e.g. `updateProfile()`).
+- **NEW**: Added support for `applyActionCode()`.
+- **NEW**: Added support for `checkActionCode()`.
+- **NEW**: Added support for `verifyPasswordResetCode()`.
+- **NEW**: Added support for accessing the current language code via the `languageCode` getter.
+- **NEW**: `setLanguageCode()` now supports providing a `null` value.
+  - On web platforms, if `null` is provided the Firebase projects default language will be set.
+  - On native platforms, if `null` is provided the device language will be used.
+- **NEW**: `verifyPhoneNumber()` exposes a `autoRetrievedSmsCodeForTesting` property.
+  - This allows developers to test automatic SMS code resolution on Android devices during development.
+- **NEW** (iOS): `appVerificationDisabledForTesting`  setting can now be set for iOS.
+  - This allows developers to skip ReCaptcha verification when testing phone authentication.
+- **NEW** (iOS): `userAccessGroup` setting can now be set for iOS & MacOS.
+  - This allows developers to share authentication states across multiple apps or extensions on iOS & MacOS. For more information see the [Firebase iOS SDK documentation](https://firebase.google.com/docs/auth/ios/single-sign-on).
+
+### `User`
+
+- **BREAKING**: Removed the `UpdateUserInfo` class when using `updateProfile` in favor of named arguments.
+- **NEW**: Added support for `getIdTokenResult()`.
+- **NEW**: Added support for `verifyBeforeUpdateEmail()`.
+- **FIX**: Fixed several iOS crashes when the Firebase SDK returned `nil` property values.
+- **FIX**: Fixed an issue on Web & iOS where a users email address would still show after unlinking the email/password provider.
+
+### `UserCredential`
+
+- **NEW**: Added support for accessing the users `AuthCredential` via the `credential` property.
+
+### `AuthProvider` & `AuthCredential`
+
+- **DEPRECATED**: All sub-class (e.g. `GoogleAuthProvider`) `getCredential()` methods have been deprecated in favor of `credential()`.
+  - **DEPRECATED**:  `EmailAuthProvider.getCredentialWithLink()` has been deprecated in favor of `EmailAuthProvider.credentialWithLink()`.
+- **NEW**: Supporting providers can now assign scope and custom request parameters.
+  - The scope and parameters will be used on web platforms when triggering a redirect or popup via `signInWithPopup()` or `signInWithRedirect()`.
+
 ## 0.17.0-dev.2
 
 * Update plugin and example to use the same core.