Merge branch 'remoteMaster' of github.com:SwineTech-Inc/flutterfire into not_found_exception_update

Author: bswhite1

.github/workflows/pr_title.yaml

@@ -11,6 +11,6 @@ jobs:
   validate:
     runs-on: ubuntu-latest
     steps:
-      - uses: amannn/action-semantic-pull-request@cfb60706e18bc85e8aec535e3c577abe8f70378e
+      - uses: amannn/action-semantic-pull-request@0723387faaf9b38adef4775cd42cfd5155ed6017
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

docs/auth/email-link-auth.md

@@ -50,7 +50,7 @@ To initiate the authentication flow, present an interface that prompts the user
 
 1.  Construct the ActionCodeSettings object, which provides Firebase with instructions on how to construct the email link. Set the following fields:
 
-    * `url`: The deep link to embed and any additional state to be passed along. The link's domain has to be whitelisted in the Firebase Console list of authorized domains, which can be found by going to the Sign-in method tab (Authentication -> Sign-in method). The link will redirect the user to this URL if the app is not installed on their device and the app was not able to be installed.
+    * `url`: The deep link to embed and any additional state to be passed along. The link's domain has to be whitelisted in the Firebase Console list of authorized domains, which can be found by going to the Settings tab (Authentication -> Settings -> Authorized Domains). The link will redirect the user to this URL if the app is not installed on their device and the app was not able to be installed.
 
     * `androidPackageName` and `IOSBundleId`: The apps to use when the sign-in link is opened on an Android or iOS device. Learn more on how to configure Firebase Dynamic Links to open email action links via mobile apps.
 

docs/auth/federated-auth.md

@@ -224,6 +224,33 @@ Future<UserCredential> signInWithApple() async {
 }
 ```
 
+#### Apple platform sign-in only
+
+Apple sign-in on iOS+ platforms can also be achieved with the following method:
+
+```dart
+// Implement a function that generates a nonce. See iOS documentation for how to create a nonce:
+// https://firebase.google.com/docs/auth/ios/apple#sign_in_with_apple_and_authenticate_with_firebase
+String rawNonce = createNonce();
+// Create a SHA-256 hash of the nonce. Consider using the `crypto` package from the pub.dev registry.
+String hashSHA256String = createHashSHA256String(rawNonce);
+// Use the hash of the nonce to get the idToken. Consider using the `sign_in_with_apple` plugin from the pub.dev registry.
+String idToken = await getIdToken();
+
+final fullName = AppleFullPersonName(
+  familyName: 'Name',
+  givenName: 'Your',
+);
+// Use the `rawNonce` and `idToken` to get the credential
+final credential = AppleAuthProvider.credentialWithIDToken(
+  idToken,
+  rawNonce,
+  fullName,
+);
+
+await FirebaseAuth.instance.signInWithCredential(credential);
+```
+
 ### Revoke Apple auth tokens {:#revoke-apple}
 
 Apple sign-in on Apple platforms returns an authorization code that can be used

docs/cloud-messaging/receive.md

@@ -376,9 +376,11 @@ Here's how to use the second method:
 
    ```json
    {
-     "data": {
-       "title_loc_key": "notification_title",
-       "body_loc_key": "notification_message"
+     "android": {
+        "notification": {
+          "title_loc_key": "notification_title",
+          "body_loc_key": "notification_message"
+        }
      }
    }
    ```
@@ -403,9 +405,13 @@ Here's how to use the second method:
 
    ```json
    {
-     "data": {
-       "title_loc_key": "NOTIFICATION_TITLE",
-       "body_loc_key": "NOTIFICATION_MESSAGE"
+     "apns": {
+        "payload": {
+          "alert": {
+            "title-loc-key": "NOTIFICATION_TITLE",
+            "loc-key": "NOTIFICATION_MESSAGE"
+          }
+        }
      }
    }
    ```

docs/setup/_setup_prereq_ios.md

@@ -26,3 +26,5 @@
 If you don't already have a Flutter app, you can complete the [Get
 Started: Test Drive](//flutter.io/get-started/test-drive/#androidstudio) to
 create a new Flutter app using your preferred editor or IDE.
+
+Note: If you're targeting macOS or macOS Catalyst, you must add the [Keychain Sharing capability](https://firebase.google.com/docs/ios/troubleshooting-faq#macos-keychain-sharing) to your target. In Xcode, navigate to your target's *Signing & Capabilities* tab, and then click **+ Capabilities** to add a new capability.

melos.yaml

@@ -229,7 +229,7 @@ scripts:
       melos exec -- "flutter pub run pigeon --input ./pigeons/messages.dart" && \
       melos run generate:pigeon:macos --no-select && \
       melos run generate:pigeon:android --no-select && \
-      melos run format --no-select
+      melos run format-ci --no-select
     packageFilters:
       fileExists: 'pigeons/messages.dart'
     description: Generate the pigeon messages for all the supported packages.

packages/cloud_firestore/cloud_firestore/android/src/main/java/io/flutter/plugins/firebase/firestore/FlutterFirebaseFirestorePlugin.java

@@ -9,6 +9,7 @@
 import static com.google.firebase.firestore.AggregateField.sum;
 
 import android.app.Activity;
+import android.util.Log;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import com.google.android.gms.tasks.Task;
@@ -24,6 +25,7 @@
 import com.google.firebase.firestore.FirebaseFirestore;
 import com.google.firebase.firestore.FirebaseFirestoreSettings;
 import com.google.firebase.firestore.MemoryCacheSettings;
+import com.google.firebase.firestore.PersistentCacheIndexManager;
 import com.google.firebase.firestore.PersistentCacheSettings;
 import com.google.firebase.firestore.Query;
 import com.google.firebase.firestore.QuerySnapshot;
@@ -64,7 +66,7 @@ public class FlutterFirebaseFirestorePlugin
         GeneratedAndroidFirebaseFirestore.FirebaseFirestoreHostApi {
   protected static final HashMap<FirebaseFirestore, FlutterFirebaseFirestoreExtension>
       firestoreInstanceCache = new HashMap<>();
-
+  public static final String TAG = "FlutterFirestorePlugin";
   public static final String DEFAULT_ERROR_CODE = "firebase_firestore";
 
   private static final String METHOD_CHANNEL_NAME = "plugins.flutter.io/firebase_firestore";
@@ -473,6 +475,35 @@ public void setIndexConfiguration(
         });
   }
 
+  @Override
+  public void persistenceCacheIndexManagerRequest(
+      @NonNull GeneratedAndroidFirebaseFirestore.FirestorePigeonFirebaseApp app,
+      @NonNull GeneratedAndroidFirebaseFirestore.PersistenceCacheIndexManagerRequest request,
+      @NonNull GeneratedAndroidFirebaseFirestore.Result<Void> result) {
+    cachedThreadPool.execute(
+        () -> {
+          PersistentCacheIndexManager indexManager =
+              getFirestoreFromPigeon(app).getPersistentCacheIndexManager();
+          if (indexManager != null) {
+            switch (request) {
+              case ENABLE_INDEX_AUTO_CREATION:
+                indexManager.enableIndexAutoCreation();
+                break;
+              case DISABLE_INDEX_AUTO_CREATION:
+                indexManager.disableIndexAutoCreation();
+                break;
+              case DELETE_ALL_INDEXES:
+                indexManager.deleteAllIndexes();
+                break;
+            }
+          } else {
+            Log.d(TAG, "`PersistentCacheIndexManager` is not available.");
+          }
+
+          result.success(null);
+        });
+  }
+
   @Override
   public void setLoggingEnabled(
       @NonNull Boolean loggingEnabled,

packages/cloud_firestore/cloud_firestore/android/src/main/java/io/flutter/plugins/firebase/firestore/GeneratedAndroidFirebaseFirestore.java

@@ -166,6 +166,22 @@ private AggregateSource(final int index) {
     }
   }
 
+  /**
+   * [PersistenceCacheIndexManagerRequest] represents the request types for the persistence cache
+   * index manager.
+   */
+  public enum PersistenceCacheIndexManagerRequest {
+    ENABLE_INDEX_AUTO_CREATION(0),
+    DISABLE_INDEX_AUTO_CREATION(1),
+    DELETE_ALL_INDEXES(2);
+
+    final int index;
+
+    private PersistenceCacheIndexManagerRequest(final int index) {
+      this.index = index;
+    }
+  }
+
   public enum PigeonTransactionResult {
     SUCCESS(0),
     FAILURE(1);
@@ -1815,6 +1831,11 @@ void documentReferenceSnapshot(
         @NonNull ListenSource source,
         @NonNull Result<String> result);
 
+    void persistenceCacheIndexManagerRequest(
+        @NonNull FirestorePigeonFirebaseApp app,
+        @NonNull PersistenceCacheIndexManagerRequest request,
+        @NonNull Result<Void> result);
+
     /** The codec used by FirebaseFirestoreHostApi. */
     static @NonNull MessageCodec<Object> getCodec() {
       return FirebaseFirestoreHostApiCodec.INSTANCE;
@@ -2570,6 +2591,39 @@ public void error(Throwable error) {
           channel.setMessageHandler(null);
         }
       }
+      {
+        BasicMessageChannel<Object> channel =
+            new BasicMessageChannel<>(
+                binaryMessenger,
+                "dev.flutter.pigeon.cloud_firestore_platform_interface.FirebaseFirestoreHostApi.persistenceCacheIndexManagerRequest",
+                getCodec());
+        if (api != null) {
+          channel.setMessageHandler(
+              (message, reply) -> {
+                ArrayList<Object> wrapped = new ArrayList<Object>();
+                ArrayList<Object> args = (ArrayList<Object>) message;
+                FirestorePigeonFirebaseApp appArg = (FirestorePigeonFirebaseApp) args.get(0);
+                PersistenceCacheIndexManagerRequest requestArg =
+                    PersistenceCacheIndexManagerRequest.values()[(int) args.get(1)];
+                Result<Void> resultCallback =
+                    new Result<Void>() {
+                      public void success(Void result) {
+                        wrapped.add(0, null);
+                        reply.reply(wrapped);
+                      }
+
+                      public void error(Throwable error) {
+                        ArrayList<Object> wrappedError = wrapError(error);
+                        reply.reply(wrappedError);
+                      }
+                    };
+
+                api.persistenceCacheIndexManagerRequest(appArg, requestArg, resultCallback);
+              });
+        } else {
+          channel.setMessageHandler(null);
+        }
+      }
     }
   }
 }

packages/cloud_firestore/cloud_firestore/example/integration_test/instance_e2e.dart

@@ -6,6 +6,7 @@ import 'dart:async';
 import 'dart:convert';
 
 import 'package:cloud_firestore/cloud_firestore.dart';
+import 'package:firebase_core/firebase_core.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter_test/flutter_test.dart';
 
@@ -312,6 +313,121 @@ void runInstanceTests() {
           {'some': 'data'},
         );
       });
+      testWidgets(
+        '`PersistenceCacheIndexManager` with default persistence settings for each platform',
+        (widgetTester) async {
+          if (defaultTargetPlatform == TargetPlatform.windows) {
+            try {
+              // Windows does not have `PersistenceCacheIndexManager` support
+              FirebaseFirestore.instance.persistentCacheIndexManager();
+            } catch (e) {
+              expect(e, isInstanceOf<UnimplementedError>());
+            }
+          } else {
+            if (kIsWeb) {
+              // persistence is disabled by default on web
+              final firestore = FirebaseFirestore.instanceFor(
+                app: Firebase.app(),
+                // Use different firestore instance to test behavior
+                databaseId: 'default-web',
+              );
+              PersistentCacheIndexManager? indexManager =
+                  firestore.persistentCacheIndexManager();
+              expect(indexManager, isNull);
+            } else {
+              final firestore = FirebaseFirestore.instanceFor(
+                app: Firebase.app(),
+                // Use different firestore instance to test behavior
+                databaseId: 'default-other-platform-test',
+              );
+              // macOS, android, iOS have persistence enabled by default
+              PersistentCacheIndexManager? indexManager =
+                  firestore.persistentCacheIndexManager();
+              await indexManager!.enableIndexAutoCreation();
+              await indexManager.disableIndexAutoCreation();
+              await indexManager.deleteAllIndexes();
+            }
+          }
+        },
+      );
+
+      testWidgets(
+        '`PersistenceCacheIndexManager` with persistence enabled for each platform',
+        (widgetTester) async {
+          if (kIsWeb) {
+            final firestore = FirebaseFirestore.instanceFor(
+              app: Firebase.app(),
+              databaseId: 'web-enabled',
+            );
+            // persistence is disabled by default so we enable it
+            firestore.settings = const Settings(persistenceEnabled: true);
+
+            PersistentCacheIndexManager? indexManager =
+                firestore.persistentCacheIndexManager();
+
+            await indexManager!.enableIndexAutoCreation();
+            await indexManager.disableIndexAutoCreation();
+            await indexManager.deleteAllIndexes();
+
+            final firestore2 = FirebaseFirestore.instanceFor(
+              app: Firebase.app(),
+              databaseId: 'web-disabled-2',
+            );
+
+            // Now try using `enablePersistence()`, web only API
+            await firestore2.enablePersistence();
+
+            PersistentCacheIndexManager? indexManager2 =
+                firestore2.persistentCacheIndexManager();
+
+            await indexManager2!.enableIndexAutoCreation();
+            await indexManager2.disableIndexAutoCreation();
+            await indexManager2.deleteAllIndexes();
+          } else {
+            final firestore = FirebaseFirestore.instanceFor(
+              app: Firebase.app(),
+              databaseId: 'other-platform-enabled',
+            );
+            firestore.settings = const Settings(persistenceEnabled: true);
+            PersistentCacheIndexManager? indexManager =
+                firestore.persistentCacheIndexManager();
+            await indexManager!.enableIndexAutoCreation();
+            await indexManager.disableIndexAutoCreation();
+            await indexManager.deleteAllIndexes();
+          }
+        },
+        skip: defaultTargetPlatform == TargetPlatform.windows,
+      );
+
+      testWidgets(
+        '`PersistenceCacheIndexManager` with persistence disabled for each platform',
+        (widgetTester) async {
+          if (kIsWeb) {
+            final firestore = FirebaseFirestore.instanceFor(
+              app: Firebase.app(),
+              databaseId: 'web-disabled-1',
+            );
+            // persistence is disabled by default so we enable it
+            firestore.settings = const Settings(persistenceEnabled: false);
+
+            PersistentCacheIndexManager? indexManager =
+                firestore.persistentCacheIndexManager();
+
+            expect(indexManager, isNull);
+          } else {
+            final firestore = FirebaseFirestore.instanceFor(
+              app: Firebase.app(),
+              databaseId: 'other-platform-disabled',
+            );
+            // macOS, android, iOS have persistence enabled by default so we disable it
+            firestore.settings = const Settings(persistenceEnabled: false);
+            PersistentCacheIndexManager? indexManager =
+                firestore.persistentCacheIndexManager();
+            expect(indexManager, isNull);
+          }
+        },
+        skip: defaultTargetPlatform == TargetPlatform.windows,
+      );
     },
   );
 }