Merge branch 'master' into mila/fix-mutation-on-emptyMap

Author: milaGGL

.github/workflows/ci_tests.yml

@@ -199,6 +199,50 @@ jobs:
         run: |
           ./gradlew firebase-firestore:deviceCheck withErrorProne -PtargetBackend="prod" -PtargetDatabaseId="test-db"
 
+
+  firestore_nightly_integ_tests:
+    name: "Firestore Instrumentation Tests Against Nightly Environment"
+    runs-on: ubuntu-22.04
+    needs:
+      - determine_changed
+    # only run on post submit or PRs not originating from forks.
+    if: ((github.repository == 'Firebase/firebase-android-sdk' && github.event_name == 'push') || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository)) && contains(fromJSON(needs.determine_changed.outputs.modules), ':firebase-firestore')
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/[email protected]
+        with:
+          fetch-depth: 2
+          submodules: true
+
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: 11
+          distribution: temurin
+          cache: gradle
+
+      - name: Add google-services.json
+        env:
+          INTEG_TESTS_GOOGLE_SERVICES: ${{ secrets.NIGHTLY_INTEG_TESTS_GOOGLE_SERVICES }}
+        run: |
+          echo $INTEG_TESTS_GOOGLE_SERVICES > google-services.json
+      - uses: google-github-actions/auth@v0
+        with:
+          credentials_json: ${{ secrets.GCP_SERVICE_ACCOUNT }}
+      - uses: google-github-actions/setup-gcloud@v0
+
+      - name: Firestore Nightly Integ Tests
+        env:
+          FIREBASE_CI: 1
+          FTL_RESULTS_BUCKET: android-ci
+          FTL_RESULTS_DIR: ${{ github.event_name == 'pull_request' && format('pr-logs/pull/{0}/{1}/{2}/{3}_{4}/artifacts/', github.repository, github.event.pull_request.number, github.job, github.run_id, github.run_attempt) || format('logs/{0}/{1}_{2}/artifacts/', github.workflow, github.run_id, github.run_attempt)}}
+          FIREBASE_APP_CHECK_DEBUG_SECRET: ${{ secrets.FIREBASE_APP_CHECK_DEBUG_SECRET }}
+        run: |
+          ./gradlew firebase-firestore:deviceCheck withErrorProne -PtargetBackend="nightly"
+
+
   publish-test-results:
     name: "Publish Tests Results"
     needs:

firebase-config-interop/CHANGELOG.md

@@ -1,2 +1,4 @@
 # Unreleased
+
+# 16.0.0
 * [feature] Initial release.

firebase-config-interop/gradle.properties

@@ -1 +1,2 @@
-version=16.0.0
+version=16.0.1
+latestReleasedVersion=16.0.0

firebase-config/CHANGELOG.md

@@ -1,4 +1,6 @@
 # Unreleased
+
+# 21.6.0
 * [changed] Added support for other Firebase products to integrate with [remote_config].
 
 # 21.5.0

firebase-config/gradle.properties

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-version=21.6.0
-latestReleasedVersion=21.5.0
+version=21.6.1
+latestReleasedVersion=21.6.0
 android.enableUnitTestBinaryResources=true
 

firebase-crashlytics-ndk/CHANGELOG.md

@@ -1,8 +1,11 @@
 # Unreleased
 
 
+# 18.6.0
+* [changed] Updated `firebase-crashlytics` dependency to v18.6.0
+
 # 18.5.0
-* [changed] Updated `firebase-crashlytics` dependency to v18.4.3
+* [changed] Updated `firebase-crashlytics` dependency to v18.5.0
 
 # 18.4.3
 * [changed] Updated `firebase-crashlytics` dependency to v18.4.3

firebase-crashlytics-ndk/gradle.properties

@@ -1,2 +1,2 @@
-version=18.5.2
-latestReleasedVersion=18.5.1
+version=18.6.1
+latestReleasedVersion=18.6.0

firebase-crashlytics/CHANGELOG.md

@@ -1,4 +1,6 @@
 # Unreleased
+
+# 18.6.0
 * [changed] Include more details about app processes in reports.
 * [feature] Updated `firebase-sessions` dependency for more accurate sessions on multi-process apps.
 * [changed] Added support for [crashlytics] to report information from [remote_config].

firebase-crashlytics/gradle.properties

@@ -1,2 +1,2 @@
-version=18.6.0
-latestReleasedVersion=18.5.1
+version=18.6.1
+latestReleasedVersion=18.6.0

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/internal/common/Utils.java

@@ -20,7 +20,6 @@
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.TaskCompletionSource;
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
-
 import java.util.concurrent.Callable;
 import java.util.concurrent.CancellationException;
 import java.util.concurrent.CountDownLatch;

firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/internal/metadata/UserMetadata.java

@@ -16,7 +16,6 @@
 
 import androidx.annotation.Nullable;
 import androidx.annotation.VisibleForTesting;
-
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import com.google.firebase.crashlytics.internal.common.CommonUtils;
 import com.google.firebase.crashlytics.internal.common.CrashlyticsBackgroundWorker;

firebase-firestore/CHANGELOG.md

@@ -2,7 +2,10 @@
 * [fixed] Fixed an issue caused by calling mutation on immutable map object. [#5573](//github.com/firebase/firebase-android-sdk/pull/5573)
 
 * [fixed] Fixed an issue in the local cache synchronization logic where all locally-cached documents that matched a resumed query would be unnecessarily re-downloaded; with the fix it now only downloads the documents that are known to be out-of-sync. [#5506](//github.com/firebase/firebase-android-sdk/pull/5506)
+* [fixed] Fixed an issue where GC runs into a infinite loop in a certain case. [#5417](https://github.com/firebase/firebase-android-sdk/issues/5417)
 
+# 24.10.0
+* [fixed] Fixed the `DocumentSnapshot` equals method to not consider internal state when comparing snapshots.
 
 # 24.9.1
 * [feature] Expose Sum/Average aggregate query support in API. [#5217](//github.com/firebase/firebase-android-sdk/pull/5217)

firebase-firestore/gradle.properties

@@ -1,2 +1,2 @@
-version=24.9.2
-latestReleasedVersion=24.9.1
+version=24.10.1
+latestReleasedVersion=24.10.0

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/DocumentSnapshotTest.java

@@ -0,0 +1,67 @@
+// Copyright 2018 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.firestore;
+
+import static com.google.firebase.firestore.testutil.IntegrationTestUtil.testCollection;
+import static com.google.firebase.firestore.testutil.IntegrationTestUtil.waitFor;
+import static com.google.firebase.firestore.testutil.TestUtil.map;
+import static org.junit.Assert.assertEquals;
+
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+import com.google.firebase.firestore.testutil.IntegrationTestUtil;
+import java.util.Map;
+import org.junit.After;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+@RunWith(AndroidJUnit4.class)
+public class DocumentSnapshotTest {
+  @After
+  public void tearDown() {
+    IntegrationTestUtil.tearDown();
+  }
+
+  @Test
+  public void testCanUpdateAnExistingDocument() {
+    DocumentReference documentReference = testCollection("rooms").document("eros");
+    Map<String, Object> initialValue =
+        map("desc", "Description", "owner", map("name", "Jonny", "email", "[email protected]"));
+    waitFor(documentReference.set(initialValue));
+
+    DocumentSnapshot snapshot1 = waitFor(documentReference.get());
+    DocumentSnapshot snapshot2 = waitFor(documentReference.get());
+    DocumentSnapshot snapshot3 = waitFor(documentReference.get());
+    assertEquals(snapshot1.getMetadata(), snapshot2.getMetadata());
+    assertEquals(snapshot2.getMetadata(), snapshot3.getMetadata());
+
+    assertEquals(snapshot1.getId(), snapshot2.getId());
+    assertEquals(snapshot2.getId(), snapshot3.getId());
+
+    assertEquals(snapshot1.exists(), snapshot2.exists());
+    assertEquals(snapshot2.exists(), snapshot3.exists());
+
+    assertEquals(snapshot1.getReference(), snapshot2.getReference());
+    assertEquals(snapshot2.getReference(), snapshot3.getReference());
+
+    assertEquals(snapshot1.getData(), snapshot2.getData());
+    assertEquals(snapshot2.getData(), snapshot3.getData());
+
+    assertEquals(snapshot1.getData(), snapshot2.getData());
+    assertEquals(snapshot2.getData(), snapshot3.getData());
+
+    assertEquals(snapshot1, snapshot2);
+    assertEquals(snapshot2, snapshot3);
+  }
+}

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/QueryTest.java

@@ -1341,8 +1341,8 @@ public void bloomFilterShouldCorrectlyEncodeComplexUnicodeCharacters() throws Ex
         isRunningAgainstEmulator());
 
     // Firestore does not do any Unicode normalization on the document IDs. Therefore, two document
-    // IDs that are canonically-equivalent (i.e. they visually appear identical) but are represented
-    // by a different sequence of Unicode code points are treated as distinct document IDs.
+    // IDs that are canonically-equivalent (they visually appear identical) but are represented by a
+    // different sequence of Unicode code points are treated as distinct document IDs.
     ArrayList<String> testDocIds = new ArrayList<>();
     testDocIds.add("DocumentToDelete");
     // The next two strings both end with "e" with an accent: the first uses the dedicated Unicode

firebase-firestore/src/main/java/com/google/firebase/Timestamp.java

@@ -25,8 +25,8 @@
  * A Timestamp represents a point in time independent of any time zone or calendar, represented as
  * seconds and fractions of seconds at nanosecond resolution in UTC Epoch time. It is encoded using
  * the Proleptic Gregorian Calendar which extends the Gregorian calendar backwards to year one. It
- * is encoded assuming all minutes are 60 seconds long, i.e. leap seconds are "smeared" so that no
- * leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to
+ * is encoded assuming all minutes are 60 seconds long, specifically leap seconds are "smeared" so
+ * that no leap second table is needed for interpretation. Range is from 0001-01-01T00:00:00Z to
  * 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to
  * and from RFC 3339 date strings.
  *

firebase-firestore/src/main/java/com/google/firebase/firestore/AggregateField.java

@@ -39,7 +39,7 @@ private AggregateField(@Nullable FieldPath fieldPath, @NonNull String operator)
 
   /**
    * Returns the field on which the aggregation takes place. Returns an empty string if there's no
-   * field (e.g. for count).
+   * field (specifically, for count).
    */
   @RestrictTo(RestrictTo.Scope.LIBRARY)
   @NonNull

firebase-firestore/src/main/java/com/google/firebase/firestore/CollectionReference.java

@@ -109,7 +109,7 @@ public DocumentReference document(@NonNull String documentPath) {
    * Adds a new document to this collection with the specified data, assigning it a document ID
    * automatically.
    *
-   * @param data The data to write to the document (e.g. a Map or a POJO containing the desired
+   * @param data The data to write to the document (like a Map or a POJO containing the desired
    *     document contents).
    * @return A Task that will be resolved with the {@code DocumentReference} of the newly created
    *     document.

firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentReference.java

@@ -138,7 +138,7 @@ public CollectionReference collection(@NonNull String collectionPath) {
    * Overwrites the document referred to by this {@code DocumentReference}. If the document does not
    * yet exist, it will be created. If a document already exists, it will be overwritten.
    *
-   * @param data The data to write to the document (e.g. a Map or a POJO containing the desired
+   * @param data The data to write to the document (like a Map or a POJO containing the desired
    *     document contents).
    * @return A Task that will be resolved when the write finishes.
    */
@@ -152,7 +152,7 @@ public Task<Void> set(@NonNull Object data) {
    * yet exist, it will be created. If you pass {@code SetOptions}, the provided data can be merged
    * into an existing document.
    *
-   * @param data The data to write to the document (e.g. a Map or a POJO containing the desired
+   * @param data The data to write to the document (like a Map or a POJO containing the desired
    *     document contents).
    * @param options An object to configure the set behavior.
    * @return A Task that will be resolved when the write finishes.
@@ -402,7 +402,7 @@ public ListenerRegistration addSnapshotListener(
    * Starts listening to the document referenced by this {@code DocumentReference} with the given
    * options.
    *
-   * @param metadataChanges Indicates whether metadata-only changes (i.e. only {@code
+   * @param metadataChanges Indicates whether metadata-only changes (specifically, only {@code
    *     DocumentSnapshot.getMetadata()} changed) should trigger snapshot events.
    * @param listener The event listener that will be called with the snapshots.
    * @return A registration object that can be used to remove the listener.
@@ -418,7 +418,7 @@ public ListenerRegistration addSnapshotListener(
    * options.
    *
    * @param executor The executor to use to call the listener.
-   * @param metadataChanges Indicates whether metadata-only changes (i.e. only {@code
+   * @param metadataChanges Indicates whether metadata-only changes (specifically, only {@code
    *     DocumentSnapshot.getMetadata()} changed) should trigger snapshot events.
    * @param listener The event listener that will be called with the snapshots.
    * @return A registration object that can be used to remove the listener.
@@ -441,7 +441,7 @@ public ListenerRegistration addSnapshotListener(
    * <p>The listener will be automatically removed during {@link Activity#onStop}.
    *
    * @param activity The activity to scope the listener to.
-   * @param metadataChanges Indicates whether metadata-only changes (i.e. only {@code
+   * @param metadataChanges Indicates whether metadata-only changes (specifically, only {@code
    *     DocumentSnapshot.getMetadata()} changed) should trigger snapshot events.
    * @param listener The event listener that will be called with the snapshots.
    * @return A registration object that can be used to remove the listener.

firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentSnapshot.java

@@ -526,8 +526,10 @@ public boolean equals(@Nullable Object obj) {
     DocumentSnapshot other = (DocumentSnapshot) obj;
     return firestore.equals(other.firestore)
         && key.equals(other.key)
-        && (doc == null ? other.doc == null : doc.equals(other.doc))
-        && metadata.equals(other.metadata);
+        && metadata.equals(other.metadata)
+        && (doc == null
+            ? other.doc == null
+            : other.doc != null && doc.getData().equals(other.doc.getData()));
   }
 
   @Override

firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestore.java

@@ -886,7 +886,7 @@ void validateReference(DocumentReference docRef) {
 
   /**
    * Sets the language of the public API in the format of "gl-<language>/<version>" where version
-   * might be blank, e.g. `gl-cpp/`. The provided string is used as is.
+   * might be blank, for example `gl-cpp/`. The provided string is used as is.
    *
    * <p>Note: this method is package-private because it is expected to only be called via JNI (which
    * ignores access modifiers).

firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreException.java

@@ -44,7 +44,7 @@ public enum Code {
     /**
      * Client specified an invalid argument. Note that this differs from {@link
      * #FAILED_PRECONDITION}. {@code INVALID_ARGUMENT} indicates arguments that are problematic
-     * regardless of the state of the system (e.g., an invalid field name).
+     * regardless of the state of the system (like an invalid field name).
      */
     INVALID_ARGUMENT(3),
 

firebase-firestore/src/main/java/com/google/firebase/firestore/LoadBundleTask.java

@@ -48,7 +48,7 @@ public class LoadBundleTask extends Task<LoadBundleTaskProgress> {
   private LoadBundleTaskProgress snapshot;
 
   /**
-   * A TaskCompletionSource that is used to deliver all standard Task API events (e.g.
+   * A TaskCompletionSource that is used to deliver all standard Task API events (such as,
    * `onComplete`).
    */
   private final TaskCompletionSource<LoadBundleTaskProgress> completionSource;

firebase-firestore/src/main/java/com/google/firebase/firestore/Query.java

@@ -399,7 +399,8 @@ public Query whereNotIn(@NonNull FieldPath fieldPath, @NonNull List<? extends Ob
   public Query where(@NonNull Filter filter) {
     com.google.firebase.firestore.core.Filter parsedFilter = parseFilter(filter);
     if (parsedFilter.getFilters().isEmpty()) {
-      // Return the existing query if not adding any more filters (e.g. an empty composite filter).
+      // Return the existing query if not adding any more filters (because composite filter is
+      // empty).
       return this;
     }
     validateNewFilter(parsedFilter);
@@ -1070,7 +1071,7 @@ public ListenerRegistration addSnapshotListener(
   /**
    * Starts listening to this query with the given options.
    *
-   * @param metadataChanges Indicates whether metadata-only changes (i.e. only {@code
+   * @param metadataChanges Indicates whether metadata-only changes (specifically, only {@code
    *     QuerySnapshot.getMetadata()} changed) should trigger snapshot events.
    * @param listener The event listener that will be called with the snapshots.
    * @return A registration object that can be used to remove the listener.
@@ -1085,7 +1086,7 @@ public ListenerRegistration addSnapshotListener(
    * Starts listening to this query with the given options.
    *
    * @param executor The executor to use to call the listener.
-   * @param metadataChanges Indicates whether metadata-only changes (i.e. only {@code
+   * @param metadataChanges Indicates whether metadata-only changes (specifically, only {@code
    *     QuerySnapshot.getMetadata()} changed) should trigger snapshot events.
    * @param listener The event listener that will be called with the snapshots.
    * @return A registration object that can be used to remove the listener.
@@ -1107,7 +1108,7 @@ public ListenerRegistration addSnapshotListener(
    * <p>The listener will be automatically removed during {@link Activity#onStop}.
    *
    * @param activity The activity to scope the listener to.
-   * @param metadataChanges Indicates whether metadata-only changes (i.e. only {@code
+   * @param metadataChanges Indicates whether metadata-only changes (specifically, only {@code
    *     QuerySnapshot.getMetadata()} changed) should trigger snapshot events.
    * @param listener The event listener that will be called with the snapshots.
    * @return A registration object that can be used to remove the listener.
@@ -1181,7 +1182,7 @@ private void validateHasExplicitOrderByForLimitToLast() {
    *
    * <p>Using the returned query to count the documents is efficient because only the final count,
    * not the documents' data, is downloaded. The returned query can even count the documents if the
-   * result set would be prohibitively large to download entirely (e.g. thousands of documents).
+   * result set would be prohibitively large to download entirely (like thousands of documents).
    *
    * @return The {@code AggregateQuery} that counts the documents in the result set of this query.
    */
@@ -1196,7 +1197,7 @@ public AggregateQuery count() {
    *
    * <p>Using this function to perform aggregations is efficient because only the final aggregation
    * values, not the documents' data, is downloaded. This function can even perform aggregations of
-   * the documents if the result set would be prohibitively large to download entirely (e.g.
+   * the documents if the result set would be prohibitively large to download entirely (like
    * thousands of documents).
    *
    * @return The {@code AggregateQuery} that performs aggregations on the documents in the result

firebase-firestore/src/main/java/com/google/firebase/firestore/QuerySnapshot.java

@@ -105,7 +105,7 @@ public List<DocumentChange> getDocumentChanges() {
    * Returns the list of documents that changed since the last snapshot. If it's the first snapshot
    * all documents will be in the list as added changes.
    *
-   * @param metadataChanges Indicates whether metadata-only changes (i.e. only {@code
+   * @param metadataChanges Indicates whether metadata-only changes (specifically, only {@code
    *     DocumentSnapshot.getMetadata()} changed) should be included.
    * @return The list of document changes since the last snapshot.
    */