Fix a bug where localCache is not copied as part of Settings

Author: wu-hui

docs-devsite/firestore_.firestoresettings.md

@@ -28,7 +28,7 @@ export declare interface FirestoreSettings
 |  [experimentalLongPollingOptions](./firestore_.firestoresettings.md#firestoresettingsexperimentallongpollingoptions) | [ExperimentalLongPollingOptions](./firestore_.experimentallongpollingoptions.md#experimentallongpollingoptions_interface) | Options that configure the SDK’s underlying network transport (WebChannel) when long-polling is used.<!-- -->These options are only used if <code>experimentalForceLongPolling</code> is true or if <code>experimentalAutoDetectLongPolling</code> is true and the auto-detection determined that long-polling was needed. Otherwise, these options have no effect. |
 |  [host](./firestore_.firestoresettings.md#firestoresettingshost) | string | The hostname to connect to. |
 |  [ignoreUndefinedProperties](./firestore_.firestoresettings.md#firestoresettingsignoreundefinedproperties) | boolean | Whether to skip nested properties that are set to <code>undefined</code> during object serialization. If set to <code>true</code>, these properties are skipped and not written to Firestore. If set to <code>false</code> or omitted, the SDK throws an exception when it encounters properties of type <code>undefined</code>. |
-|  [localCache](./firestore_.firestoresettings.md#firestoresettingslocalcache) | [FirestoreLocalCache](./firestore_.md#firestorelocalcache) | Specifies the cache used by the SDK. Available options are <code>MemoryLocalCache</code> and <code>IndexedDbLocalCache</code>, each with different configuration options.<!-- -->When unspecified, <code>MemoryLocalCache</code> will be used by default.<!-- -->NOTE: setting this field and <code>cacheSizeBytes</code> at the same time will throw exception during SDK initialization. Instead, using the configuration in the <code>FirestoreLocalCache</code> object to specify the cache size. |
+|  [localCache](./firestore_.firestoresettings.md#firestoresettingslocalcache) | [FirestoreLocalCache](./firestore_.md#firestorelocalcache) | Specifies the cache used by the SDK. Available options are <code>MemoryLocalCache</code> and <code>PersistentLocalCache</code>, each with different configuration options.<!-- -->When unspecified, <code>MemoryLocalCache</code> will be used by default.<!-- -->NOTE: setting this field and <code>cacheSizeBytes</code> at the same time will throw exception during SDK initialization. Instead, using the configuration in the <code>FirestoreLocalCache</code> object to specify the cache size. |
 |  [ssl](./firestore_.firestoresettings.md#firestoresettingsssl) | boolean | Whether to use SSL when connecting. |
 
 ## FirestoreSettings.cacheSizeBytes
@@ -107,7 +107,7 @@ ignoreUndefinedProperties?: boolean;
 
 ## FirestoreSettings.localCache
 
-Specifies the cache used by the SDK. Available options are `MemoryLocalCache` and `IndexedDbLocalCache`<!-- -->, each with different configuration options.
+Specifies the cache used by the SDK. Available options are `MemoryLocalCache` and `PersistentLocalCache`<!-- -->, each with different configuration options.
 
 When unspecified, `MemoryLocalCache` will be used by default.
 

docs-devsite/firestore_.md

@@ -408,7 +408,7 @@ If the final path has an odd number of segments and does not point to a document
 
 > Warning: This API is now obsolete.
 > 
-> This function will be removed in a future major release. Instead, set `FirestoreSettings.cache` to an instance of `IndexedDbLocalCache` to turn on IndexedDb cache. Calling this function when `FirestoreSettings.cache` is already specified will throw an exception.
+> This function will be removed in a future major release. Instead, set `FirestoreSettings.localCache` to an instance of `PersistentLocalCache` to turn on IndexedDb cache. Calling this function when `FirestoreSettings.localCache` is already specified will throw an exception.
 > 
 
 Attempts to enable persistent storage, if possible.
@@ -446,7 +446,7 @@ A `Promise` that represents successfully enabling persistent storage.
 
 > Warning: This API is now obsolete.
 > 
-> This function will be removed in a future major release. Instead, set `FirestoreSettings.cache` to an instance of `IndexedDbLocalCache` to turn on indexeddb cache. Calling this function when `FirestoreSettings.cache` is already specified will throw an exception.
+> This function will be removed in a future major release. Instead, set `FirestoreSettings.localCache` to an instance of `PersistentLocalCache` to turn on indexeddb cache. Calling this function when `FirestoreSettings.localCache` is already specified will throw an exception.
 > 
 
 Attempts to enable multi-tab persistent storage, if possible. If enabled across all tabs, all operations share access to local persistence, including shared execution of queries and latency-compensated local document updates across all connected instances.

packages/firestore/src/api/database.ts

@@ -291,13 +291,13 @@ export function configureFirestore(firestore: Firestore): void {
     databaseInfo
   );
   if (
-    settings.cache?._offlineComponentProvider &&
-    settings.cache?._onlineComponentProvider
+    settings.localCache?._offlineComponentProvider &&
+    settings.localCache?._onlineComponentProvider
   ) {
     firestore._firestoreClient._uninitializedComponentsProvider = {
-      _offlineKind: settings.cache.kind,
-      _offline: settings.cache._offlineComponentProvider,
-      _online: settings.cache._onlineComponentProvider
+      _offlineKind: settings.localCache.kind,
+      _offline: settings.localCache._offlineComponentProvider,
+      _online: settings.localCache._onlineComponentProvider
     };
   }
 }
@@ -327,8 +327,8 @@ export function configureFirestore(firestore: Firestore): void {
  * persistence.
  * @returns A `Promise` that represents successfully enabling persistent storage.
  * @deprecated This function will be removed in a future major release. Instead, set
- * `FirestoreSettings.cache` to an instance of `IndexedDbLocalCache` to
- * turn on IndexedDb cache. Calling this function when `FirestoreSettings.cache`
+ * `FirestoreSettings.localCache` to an instance of `PersistentLocalCache` to
+ * turn on IndexedDb cache. Calling this function when `FirestoreSettings.localCache`
  * is already specified will throw an exception.
  */
 export function enableIndexedDbPersistence(
@@ -387,8 +387,8 @@ export function enableIndexedDbPersistence(
  * @returns A `Promise` that represents successfully enabling persistent
  * storage.
  * @deprecated This function will be removed in a future major release. Instead, set
- * `FirestoreSettings.cache` to an instance of `IndexedDbLocalCache` to
- * turn on indexeddb cache. Calling this function when `FirestoreSettings.cache`
+ * `FirestoreSettings.localCache` to an instance of `PersistentLocalCache` to
+ * turn on indexeddb cache. Calling this function when `FirestoreSettings.localCache`
  * is already specified will throw an exception.
  */
 export function enableMultiTabIndexedDbPersistence(

packages/firestore/src/api/settings.ts

@@ -60,7 +60,7 @@ export interface FirestoreSettings extends LiteSettings {
 
   /**
    * Specifies the cache used by the SDK. Available options are `MemoryLocalCache`
-   * and `IndexedDbLocalCache`, each with different configuration options.
+   * and `PersistentLocalCache`, each with different configuration options.
    *
    * When unspecified, `MemoryLocalCache` will be used by default.
    *

packages/firestore/src/lite-api/database.ts

@@ -302,7 +302,7 @@ export function connectFirestoreEmulator(
   firestore = cast(firestore, Firestore);
   const settings = firestore._getSettings();
 
-  logWarn(`before connect emulator, settings is {JSON.stringify(settings)}`);
+  logWarn(`before connect emulator, settings is ${JSON.stringify(settings)}`);
   if (settings.host !== DEFAULT_HOST && settings.host !== host) {
     logWarn(
       'Host has been set in both settings() and useEmulator(), emulator host ' +
@@ -315,8 +315,15 @@ export function connectFirestoreEmulator(
     host: `${host}:${port}`,
     ssl: false
   };
-  logWarn(`after connect emulator, settings is ${JSON.stringify(newSettings)}`);
+  logWarn(`before set settings ${JSON.stringify(newSettings, undefined, 2)}`);
   firestore._setSettings(newSettings);
+  logWarn(
+    `after set settings, _getSettings is ${JSON.stringify(
+      firestore._getSettings(),
+      undefined,
+      2
+    )}`
+  );
 
   if (options.mockUserToken) {
     let token: string;

packages/firestore/src/lite-api/settings.ts

@@ -104,7 +104,7 @@ export class FirestoreSettingsImpl {
   readonly ignoreUndefinedProperties: boolean;
 
   readonly useFetchStreams: boolean;
-  readonly cache?: FirestoreLocalCache;
+  readonly localCache?: FirestoreLocalCache;
 
   // Can be a google-auth-library or gapi client.
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -127,7 +127,7 @@ export class FirestoreSettingsImpl {
 
     this.credentials = settings.credentials;
     this.ignoreUndefinedProperties = !!settings.ignoreUndefinedProperties;
-    this.cache = settings.localCache;
+    this.localCache = settings.localCache;
 
     if (settings.cacheSizeBytes === undefined) {
       this.cacheSizeBytes = LRU_DEFAULT_CACHE_SIZE_BYTES;

packages/firestore/test/integration/api/provider.test.ts

@@ -29,9 +29,7 @@ import {
   enableIndexedDbPersistence,
   setDoc,
   memoryLocalCache,
-  getDocFromCache,
-  persistentLocalCache,
-  connectFirestoreEmulator
+  getDocFromCache
 } from '../util/firebase_export';
 import { DEFAULT_SETTINGS } from '../util/settings';
 
@@ -143,25 +141,6 @@ describe('Firestore Provider', () => {
     });
   });
 
-  it.only('connectFirestoreEmulator() keeps other settings', async () => {
-    const app = initializeApp(
-      { apiKey: 'fake-api-key', projectId: 'test-project' },
-      'test-use-enablePersistence'
-    );
-    const db = initializeFirestore(app, {
-      ...DEFAULT_SETTINGS,
-      localCache: persistentLocalCache()
-    });
-    connectFirestoreEmulator(db, "localhost", 8080);
-
-    // SDK still functions.
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises
-    setDoc(doc(db, 'coll/doc'), { field: 'foo' });
-    expect((await getDocFromCache(doc(db, 'coll/doc'))).data()).to.deep.equal({
-      field: 'foo'
-    });
-  });
-
   it('cannot mix enableIndexedDbPersistence() and settings.cache', async () => {
     const app = initializeApp(
       { apiKey: 'fake-api-key', projectId: 'test-project' },