Merge master into release

firebase · Sep 12, 2023 · aa0f8a9 · aa0f8a9
2 parents b2f6084 + 98cfcbd
commit aa0f8a9
Show file tree

Hide file tree

Showing 85 changed files with 3,395 additions and 1,446 deletions.
diff --git a/.changeset/fresh-frogs-heal.md b/.changeset/fresh-frogs-heal.md
@@ -0,0 +1,6 @@
+---
+"@firebase/firestore": patch
+"@firebase/webchannel-wrapper": patch
+---
+
+Fix an issue where Firestore was incorrectly using XHR instead of fetch for streaming response.
diff --git a/.changeset/hip-cougars-float.md b/.changeset/hip-cougars-float.md
@@ -0,0 +1,6 @@
+---
+'@firebase/firestore': minor
+'firebase': minor
+---
+
+Add `enablePersistentCacheIndexAutoCreation()` function to enable automatic creation of local cache query indexes, which can improve performance of local query execution.
diff --git a/.changeset/lucky-horses-sin.md b/.changeset/lucky-horses-sin.md
@@ -0,0 +1,6 @@
+---
+'@firebase/rules-unit-testing': patch
+'@firebase/firestore': patch
+---
+
+Updated minor dependencies grpc (firestore) and firebase-admin (rules-unit-testing).
diff --git a/.github/workflows/test-all.yml b/.github/workflows/test-all.yml
@@ -17,13 +17,14 @@ jobs:
     # Install Chrome so the correct version of webdriver can be installed by chromedriver when
     # setting up the repo. This must be done to build and execute Auth properly.
     - name: install Chrome stable
-      # Install Chrome version 110.0.5481.177-1 as some Auth tests start to fail on version 111.
-      # Temporary: Auth team will explore what's going wrong with the auth tests.
+      # Pin Chrome version 114.0.5735.90-1 to avoid install failures like "No such object: chromedriver/LATEST_RELEASE_115.0.5790".
+      # The failure happens because https://chromedriver.chromium.org/downloads only goes up to version 114.
+      # TODO(b/297380444) Update script to install the latest Chrome and ChromeDriver.
       run: |
         sudo apt-get update
         sudo apt-get install wget
-        sudo wget http://dl.google.com/linux/chrome/deb/pool/main/g/google-chrome-stable/google-chrome-stable_110.0.5481.177-1_amd64.deb
-        sudo apt-get install -f ./google-chrome-stable_110.0.5481.177-1_amd64.deb --allow-downgrades
+        sudo wget http://dl.google.com/linux/chrome/deb/pool/main/g/google-chrome-stable/google-chrome-stable_114.0.5735.90-1_amd64.deb
+        sudo apt-get install -f ./google-chrome-stable_114.0.5735.90-1_amd64.deb --allow-downgrades
     - uses: actions/checkout@v3
     - name: Set up Node (16)
       uses: actions/setup-node@v3
@@ -102,13 +103,14 @@ jobs:
     steps:
     # install Chrome so the correct version of webdriver can be installed by chromedriver when setting up the repo
     - name: install Chrome stable
-      # Install Chrome version 110.0.5481.177-1 as some Auth tests start to fail on version 111.
-      # Temporary: Auth team will explore what's going wrong with the auth tests.
+      # Pin Chrome version 114.0.5735.90-1 to avoid install failures like "No such object: chromedriver/LATEST_RELEASE_115.0.5790".
+      # The failure happens because https://chromedriver.chromium.org/downloads only goes up to version 114.
+      # TODO(b/297380444) Update script to install the latest Chrome and ChromeDriver.
       run: |
         sudo apt-get update
         sudo apt-get install wget
-        sudo wget http://dl.google.com/linux/chrome/deb/pool/main/g/google-chrome-stable/google-chrome-stable_110.0.5481.177-1_amd64.deb
-        sudo apt-get install -f ./google-chrome-stable_110.0.5481.177-1_amd64.deb --allow-downgrades
+        sudo wget http://dl.google.com/linux/chrome/deb/pool/main/g/google-chrome-stable/google-chrome-stable_114.0.5735.90-1_amd64.deb
+        sudo apt-get install -f ./google-chrome-stable_114.0.5735.90-1_amd64.deb --allow-downgrades
     - name: Download build archive
       uses: actions/download-artifact@v3
       with:

diff --git a/.github/workflows/test-changed-auth.yml b/.github/workflows/test-changed-auth.yml
@@ -14,13 +14,14 @@ jobs:
     steps:
       # install Chrome first, so the correct version of webdriver can be installed by chromedriver when setting up the repo
       - name: install Chrome stable
-        # Install Chrome version 110.0.5481.177-1 as test starts to fail on version 111.
-        # Temporary: Auth team will explore what's going wrong with the auth tests.
+        # Pin Chrome version 114.0.5735.90-1 to avoid install failures like "No such object: chromedriver/LATEST_RELEASE_115.0.5790".
+        # The failure happens because https://chromedriver.chromium.org/downloads only goes up to version 114.
+        # TODO(b/297380444) Update script to install the latest Chrome and ChromeDriver.
         run: |
           sudo apt-get update
           sudo apt-get install wget
-          sudo wget http://dl.google.com/linux/chrome/deb/pool/main/g/google-chrome-stable/google-chrome-stable_110.0.5481.177-1_amd64.deb
-          sudo apt-get install -f ./google-chrome-stable_110.0.5481.177-1_amd64.deb --allow-downgrades
+          sudo wget http://dl.google.com/linux/chrome/deb/pool/main/g/google-chrome-stable/google-chrome-stable_114.0.5735.90-1_amd64.deb
+          sudo apt-get install -f ./google-chrome-stable_114.0.5735.90-1_amd64.deb --allow-downgrades
       - name: Checkout Repo
         uses: actions/checkout@master
         with:
@@ -48,16 +49,17 @@ jobs:
 
     runs-on: ubuntu-20.04
 
-    # Chrome webdriver version is pinned to avoid install failures like "No such object: chromedriver/LATEST_RELEASE_115.0.5790"
-    # These are installed even in the Firefox test due to `yarn` command which pulls the devDependency listed in package.json.
+    # Pin Chrome version 114.0.5735.90-1 to avoid install failures like "No such object: chromedriver/LATEST_RELEASE_115.0.5790".
+    # The failure happens because https://chromedriver.chromium.org/downloads only goes up to version 114.
+    # TODO(b/297380444) Update script to install the latest Chrome and ChromeDriver.
     steps:
       - name: install Firefox stable
         run: |
           sudo apt-get update
           sudo apt-get install firefox
           sudo apt-get install wget
-          sudo wget http://dl.google.com/linux/chrome/deb/pool/main/g/google-chrome-stable/google-chrome-stable_110.0.5481.177-1_amd64.deb
-          sudo apt-get install -f ./google-chrome-stable_110.0.5481.177-1_amd64.deb --allow-downgrades
+          sudo wget http://dl.google.com/linux/chrome/deb/pool/main/g/google-chrome-stable/google-chrome-stable_114.0.5735.90-1_amd64.deb
+          sudo apt-get install -f ./google-chrome-stable_114.0.5735.90-1_amd64.deb --allow-downgrades
 
       - name: Checkout Repo
         uses: actions/checkout@master

diff --git a/common/api-review/firestore.api.md b/common/api-review/firestore.api.md
@@ -101,6 +101,9 @@ export function connectFirestoreEmulator(firestore: Firestore, host: string, por
     mockUserToken?: EmulatorMockTokenOptions | string;
 }): void;
 
+// @public
+export function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;
+
 // @public
 export function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;
 
@@ -110,6 +113,9 @@ export function deleteField(): FieldValue;
 // @public
 export function disableNetwork(firestore: Firestore): Promise<void>;
 
+// @public
+export function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;
+
 // @public
 export function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;
 
@@ -172,6 +178,9 @@ export function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promis
 // @public
 export function enableNetwork(firestore: Firestore): Promise<void>;
 
+// @public
+export function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;
+
 // @public
 export function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;
 
@@ -286,25 +295,28 @@ export function getFirestore(): Firestore;
 // @beta
 export function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
 
+// @public
+export function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;
+
 // @public
 export function increment(n: number): FieldValue;
 
-// @beta
+// @beta @deprecated
 export interface Index {
     // (undocumented)
     [key: string]: unknown;
     readonly collectionGroup: string;
     readonly fields?: IndexField[];
 }
 
-// @beta
+// @beta @deprecated
 export interface IndexConfiguration {
     // (undocumented)
     [key: string]: unknown;
     readonly indexes?: Index[];
 }
 
-// @beta
+// @beta @deprecated
 export interface IndexField {
     // (undocumented)
     [key: string]: unknown;
@@ -457,6 +469,11 @@ export interface PersistenceSettings {
     forceOwnership?: boolean;
 }
 
+// @public
+export class PersistentCacheIndexManager {
+    readonly type: 'PersistentCacheIndexManager';
+}
+
 // @public
 export interface PersistentCacheSettings {
     cacheSizeBytes?: number;
@@ -596,10 +613,10 @@ export function setDoc<AppModelType, DbModelType extends DocumentData>(reference
 // @public
 export function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;
 
-// @beta
+// @beta @deprecated
 export function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
 
-// @beta
+// @beta @deprecated
 export function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
 
 // @public

diff --git a/config/functions/package.json b/config/functions/package.json
@@ -3,7 +3,7 @@
   "description": "Cloud Functions for Firebase",
   "dependencies": {
     "cors": "2.8.5",
-    "firebase-admin": "11.9.0",
+    "firebase-admin": "11.10.1",
     "firebase-functions": "3.24.1"
   },
   "private": true,

diff --git a/docs-devsite/firestore_.index.md b/docs-devsite/firestore_.index.md
@@ -13,6 +13,11 @@ https://github.com/firebase/firebase-js-sdk
 > This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
+> Warning: This API is now obsolete.
+> 
+> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to create cache indexes for queries running locally.
+> 
+
 The SDK definition of a Firestore index.
 
 <b>Signature:</b>

diff --git a/docs-devsite/firestore_.indexconfiguration.md b/docs-devsite/firestore_.indexconfiguration.md
@@ -13,6 +13,11 @@ https://github.com/firebase/firebase-js-sdk
 > This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
+> Warning: This API is now obsolete.
+> 
+> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to create cache indexes for queries running locally.
+> 
+
 A list of Firestore indexes to speed up local query execution.
 
 See [JSON Format](https://firebase.google.com/docs/reference/firestore/indexes/#json_format) for a description of the format of the index definition.

diff --git a/docs-devsite/firestore_.indexfield.md b/docs-devsite/firestore_.indexfield.md
@@ -13,6 +13,11 @@ https://github.com/firebase/firebase-js-sdk
 > This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
+> Warning: This API is now obsolete.
+> 
+> Instead of creating cache indexes manually, consider using `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to create cache indexes for queries running locally.
+> 
+
 A single field element in an index configuration.
 
 <b>Signature:</b>