Merge master into release

Author: google-oss-bot

.changeset/cool-games-care.md

@@ -0,0 +1,6 @@
+---
+'@firebase/firestore': patch
+'firebase': patch
+---
+
+Implemented internal logic to auto-create client-side indexes

.changeset/healthy-peas-heal.md

@@ -0,0 +1,6 @@
+---
+'@firebase/firestore': patch
+'firebase': patch
+---
+
+Implemented internal logic to delete all client-side indexes

.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:

.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

packages/auth/test/integration/webdriver/redirect.test.ts

@@ -39,8 +39,13 @@ import { START_FUNCTION } from './util/auth_driver';
 use(chaiAsPromised);
 
 browserDescribe('WebDriver redirect IdP test', driver => {
-  beforeEach(async () => {
-    await driver.pause(200); // Race condition on auth init
+  afterEach(async function () {
+    this.timeout(25000); // Starting browsers can be slow.
+
+    // Redirect tests are flaky on Chrome v111+
+    // Stop and re-initialize the webdrive instance to prevent flakiness.
+    await driver.stop();
+    await driver.start('chrome');
   });
 
   it('allows users to sign in', async () => {
@@ -327,7 +332,11 @@ browserDescribe('WebDriver redirect IdP test', driver => {
       expect(user.email).to.eq(user1.email);
     });
 
-    it('reauthenticate throws for wrong user', async () => {
+    it('reauthenticate throws for wrong user', async function () {
+      // Test is ignored for now as it fails on Chrome version 111+.
+      // TODO(b/297245662): Investigate and unskip the test.
+      this.skip();
+
       // Sign in using pre-poulated user
       await driver.callNoWait(RedirectFunction.IDP_REDIRECT);
 
@@ -350,7 +359,11 @@ browserDescribe('WebDriver redirect IdP test', driver => {
       );
     });
 
-    it('handles aborted sign ins', async () => {
+    it('handles aborted sign ins', async function () {
+      // Test is ignored for now as it fails on Chrome version 111+.
+      // TODO(b/297245662): Investigate and unskip the test.
+      this.skip();
+
       await driver.callNoWait(RedirectFunction.IDP_REDIRECT);
       const widget = new IdPPage(driver.webDriver);
 

packages/firestore/src/api.ts

@@ -202,6 +202,14 @@ export {
   setIndexConfiguration
 } from './api/index_configuration';
 
+export {
+  PersistentCacheIndexManager,
+  getPersistentCacheIndexManager,
+  deleteAllPersistentCacheIndexes,
+  enablePersistentCacheIndexAutoCreation,
+  disablePersistentCacheIndexAutoCreation
+} from './api/persistent_cache_index_manager';
+
 /**
  * Internal exports
  */

packages/firestore/src/api/persistent_cache_index_manager.ts

@@ -0,0 +1,164 @@
+/**
+ * @license
+ * Copyright 2023 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.
+ */
+
+import {
+  firestoreClientDeleteAllFieldIndexes,
+  firestoreClientSetPersistentCacheIndexAutoCreationEnabled,
+  FirestoreClient
+} from '../core/firestore_client';
+import { cast } from '../util/input_validation';
+import { logDebug, logWarn } from '../util/log';
+
+import { ensureFirestoreConfigured, Firestore } from './database';
+
+/**
+ * A `PersistentCacheIndexManager` which you can config persistent cache indexes
+ * used for local query execution.
+ *
+ * To use, call `getPersistentCacheIndexManager()` to get an instance.
+ *
+ * TODO(CSI) Remove @internal to make the API publicly available.
+ * @internal
+ */
+export class PersistentCacheIndexManager {
+  readonly type: 'PersistentCacheIndexManager' = 'PersistentCacheIndexManager';
+
+  /** @hideconstructor */
+  constructor(readonly _client: FirestoreClient) {}
+}
+
+/**
+ * Returns the PersistentCache Index Manager used by the given `Firestore`
+ * object.
+ *
+ * @return The `PersistentCacheIndexManager` instance, or `null` if local
+ * persistent storage is not in use.
+ *
+ * TODO(CSI) Remove @internal to make the API publicly available.
+ * @internal
+ */
+export function getPersistentCacheIndexManager(
+  firestore: Firestore
+): PersistentCacheIndexManager | null {
+  firestore = cast(firestore, Firestore);
+
+  const cachedInstance = persistentCacheIndexManagerByFirestore.get(firestore);
+  if (cachedInstance) {
+    return cachedInstance;
+  }
+
+  const client = ensureFirestoreConfigured(firestore);
+  if (client._uninitializedComponentsProvider?._offlineKind !== 'persistent') {
+    return null;
+  }
+
+  const instance = new PersistentCacheIndexManager(client);
+  persistentCacheIndexManagerByFirestore.set(firestore, instance);
+  return instance;
+}
+
+/**
+ * Enables SDK to create persistent cache indexes automatically for local query
+ * execution when SDK believes cache indexes can help improves performance.
+ *
+ * This feature is disabled by default.
+ *
+ * TODO(CSI) Remove @internal to make the API publicly available.
+ * @internal
+ */
+export function enablePersistentCacheIndexAutoCreation(
+  indexManager: PersistentCacheIndexManager
+): void {
+  setPersistentCacheIndexAutoCreationEnabled(indexManager, true);
+}
+
+/**
+ * Stops creating persistent cache indexes automatically for local query
+ * execution. The indexes which have been created by calling
+ * `enablePersistentCacheIndexAutoCreation()` still take effect.
+ *
+ * TODO(CSI) Remove @internal to make the API publicly available.
+ * @internal
+ */
+export function disablePersistentCacheIndexAutoCreation(
+  indexManager: PersistentCacheIndexManager
+): void {
+  setPersistentCacheIndexAutoCreationEnabled(indexManager, false);
+}
+
+/**
+ * Removes all persistent cache indexes.
+ *
+ * Please note this function will also deletes indexes generated by
+ * `setIndexConfiguration()`, which is deprecated.
+ *
+ * TODO(CSI) Remove @internal to make the API publicly available.
+ * @internal
+ */
+export function deleteAllPersistentCacheIndexes(
+  indexManager: PersistentCacheIndexManager
+): void {
+  indexManager._client.verifyNotTerminated();
+
+  const promise = firestoreClientDeleteAllFieldIndexes(indexManager._client);
+
+  promise
+    .then(_ => logDebug('deleting all persistent cache indexes succeeded'))
+    .catch(error =>
+      logWarn('deleting all persistent cache indexes failed', error)
+    );
+}
+
+function setPersistentCacheIndexAutoCreationEnabled(
+  indexManager: PersistentCacheIndexManager,
+  isEnabled: boolean
+): void {
+  indexManager._client.verifyNotTerminated();
+
+  const promise = firestoreClientSetPersistentCacheIndexAutoCreationEnabled(
+    indexManager._client,
+    isEnabled
+  );
+
+  promise
+    .then(_ =>
+      logDebug(
+        `setting persistent cache index auto creation ` +
+          `isEnabled=${isEnabled} succeeded`
+      )
+    )
+    .catch(error =>
+      logWarn(
+        `setting persistent cache index auto creation ` +
+          `isEnabled=${isEnabled} failed`,
+        error
+      )
+    );
+}
+
+/**
+ * Maps `Firestore` instances to their corresponding
+ * `PersistentCacheIndexManager` instances.
+ *
+ * Use a `WeakMap` so that the mapping will be automatically dropped when the
+ * `Firestore` instance is garbage collected. This emulates a private member
+ * as described in https://goo.gle/454yvug.
+ */
+const persistentCacheIndexManagerByFirestore = new WeakMap<
+  Firestore,
+  PersistentCacheIndexManager
+>();

packages/firestore/src/core/firestore_client.ts

@@ -26,10 +26,12 @@ import { User } from '../auth/user';
 import { LocalStore } from '../local/local_store';
 import {
   localStoreConfigureFieldIndexes,
+  localStoreDeleteAllFieldIndexes,
   localStoreExecuteQuery,
   localStoreGetNamedQuery,
   localStoreHandleUserChange,
-  localStoreReadDocument
+  localStoreReadDocument,
+  localStoreSetIndexAutoCreationEnabled
 } from '../local/local_store_impl';
 import { Persistence } from '../local/persistence';
 import { Document } from '../model/document';
@@ -828,3 +830,23 @@ export function firestoreClientSetIndexConfiguration(
     );
   });
 }
+
+export function firestoreClientSetPersistentCacheIndexAutoCreationEnabled(
+  client: FirestoreClient,
+  isEnabled: boolean
+): Promise<void> {
+  return client.asyncQueue.enqueue(async () => {
+    return localStoreSetIndexAutoCreationEnabled(
+      await getLocalStore(client),
+      isEnabled
+    );
+  });
+}
+
+export function firestoreClientDeleteAllFieldIndexes(
+  client: FirestoreClient
+): Promise<void> {
+  return client.asyncQueue.enqueue(async () => {
+    return localStoreDeleteAllFieldIndexes(await getLocalStore(client));
+  });
+}

packages/firestore/src/local/index_manager.ts

@@ -41,6 +41,19 @@ export const enum IndexType {
   FULL
 }
 
+export function displayNameForIndexType(indexType: IndexType): string {
+  switch (indexType) {
+    case IndexType.NONE:
+      return 'NONE';
+    case IndexType.PARTIAL:
+      return 'PARTIAL';
+    case IndexType.FULL:
+      return 'FULL';
+    default:
+      return `[unknown IndexType: ${indexType}]`;
+  }
+}
+
 /**
  * Represents a set of indexes that are used to execute queries efficiently.
  *
@@ -92,6 +105,17 @@ export interface IndexManager {
     index: FieldIndex
   ): PersistencePromise<void>;
 
+  /** Removes all field indexes and deletes all index values. */
+  deleteAllFieldIndexes(
+    transaction: PersistenceTransaction
+  ): PersistencePromise<void>;
+
+  /** Creates a full matched field index which serves the given target. */
+  createTargetIndexes(
+    transaction: PersistenceTransaction,
+    target: Target
+  ): PersistencePromise<void>;
+
   /**
    * Returns a list of field indexes that correspond to the specified collection
    * group.