Implement bundle features in local store. (#3200)

* Renaming interfaces without leading I

* Initial commit of bundle reading - for web only.

* Tests only run when it is not Node.

* Fix redundant imports

* Fix missing textencoder

* Remove generator.

* Support bundle reader for Node

* Fix rebase errors.

* Remote 'only'

* Merge branch 'wuandy/Bundles' into wuandy/BundleReaderNode

# Conflicts:
#	packages/firestore/src/util/bundle_reader.ts
#	packages/firestore/test/unit/util/bundle.test.ts

* Added more comments, and more tests for Node.

* Implement BundleCache.

* Add applyBundleDocuments to local store.

* Add rest of bundle service to localstore
Fix change buffer bug

* Simplify change buffer get read time logic.

* Fix lint errors

* Add comments.

* Change localstore to check for newer bundle directly.

* A little more comments.

* Address comments.

* Address comments 2

* Make it tree-shakeable.

* More comments addressing.

* Another around of comments

Author: wu-hui

packages/firestore/src/core/bundle.ts

@@ -17,6 +17,17 @@
 
 import { Query } from './query';
 import { SnapshotVersion } from './snapshot_version';
+import {
+  fromDocument,
+  fromName,
+  fromVersion,
+  JsonProtoSerializer
+} from '../remote/serializer';
+import * as bundleProto from '../protos/firestore_bundle_proto';
+import * as api from '../protos/firestore_proto_api';
+import { DocumentKey } from '../model/document_key';
+import { MaybeDocument, NoDocument } from '../model/document';
+import { debugAssert } from '../util/assert';
 
 /**
  * Represents a Firestore bundle saved by the SDK in its local storage.
@@ -40,3 +51,50 @@ export interface NamedQuery {
   /** The time at which the results for this query were read. */
   readonly readTime: SnapshotVersion;
 }
+
+/**
+ * Represents a bundled document, including the metadata and the document
+ * itself, if it exists.
+ */
+interface BundledDocument {
+  metadata: bundleProto.BundledDocumentMetadata;
+  document: api.Document | undefined;
+}
+
+/**
+ * An array of `BundledDocument`.
+ */
+export type BundledDocuments = BundledDocument[];
+
+/**
+ * Helper to convert objects from bundles to model objects in the SDK.
+ */
+export class BundleConverter {
+  constructor(private serializer: JsonProtoSerializer) {}
+
+  toDocumentKey(name: string): DocumentKey {
+    return fromName(this.serializer, name);
+  }
+
+  /**
+   * Converts a BundleDocument to a MaybeDocument.
+   */
+  toMaybeDocument(bundledDoc: BundledDocument): MaybeDocument {
+    if (bundledDoc.metadata.exists) {
+      debugAssert(
+        !!bundledDoc.document,
+        'Document is undefined when metadata.exist is true.'
+      );
+      return fromDocument(this.serializer, bundledDoc.document!, false);
+    } else {
+      return new NoDocument(
+        this.toDocumentKey(bundledDoc.metadata.name!),
+        this.toSnapshotVersion(bundledDoc.metadata.readTime!)
+      );
+    }
+  }
+
+  toSnapshotVersion(time: api.Timestamp): SnapshotVersion {
+    return fromVersion(time);
+  }
+}

packages/firestore/src/core/component_provider.ts

@@ -49,6 +49,7 @@ import {
 import { newConnectivityMonitor } from '../platform/connection';
 import { newSerializer } from '../platform/serializer';
 import { getDocument, getWindow } from '../platform/dom';
+import { JsonProtoSerializer } from '../remote/serializer';
 
 const MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE =
   'You are using the memory-only build of Firestore. Persistence support is ' +
@@ -96,7 +97,10 @@ export class MemoryComponentProvider implements ComponentProvider {
   remoteStore!: RemoteStore;
   eventManager!: EventManager;
 
+  serializer!: JsonProtoSerializer;
+
   async initialize(cfg: ComponentConfiguration): Promise<void> {
+    this.serializer = newSerializer(cfg.databaseInfo.databaseId);
     this.sharedClientState = this.createSharedClientState(cfg);
     this.persistence = this.createPersistence(cfg);
     await this.persistence.start();
@@ -134,7 +138,8 @@ export class MemoryComponentProvider implements ComponentProvider {
     return newLocalStore(
       this.persistence,
       new IndexFreeQueryEngine(),
-      cfg.initialUser
+      cfg.initialUser,
+      this.serializer
     );
   }
 
@@ -145,8 +150,7 @@ export class MemoryComponentProvider implements ComponentProvider {
         MEMORY_ONLY_PERSISTENCE_ERROR_MESSAGE
       );
     }
-    const serializer = newSerializer(cfg.databaseInfo.databaseId);
-    return new MemoryPersistence(MemoryEagerDelegate.factory, serializer);
+    return new MemoryPersistence(MemoryEagerDelegate.factory, this.serializer);
   }
 
   createRemoteStore(cfg: ComponentConfiguration): RemoteStore {
@@ -221,7 +225,8 @@ export class IndexedDbComponentProvider extends MemoryComponentProvider {
     return newMultiTabLocalStore(
       this.persistence,
       new IndexFreeQueryEngine(),
-      cfg.initialUser
+      cfg.initialUser,
+      this.serializer
     );
   }
 
@@ -257,7 +262,6 @@ export class IndexedDbComponentProvider extends MemoryComponentProvider {
     const persistenceKey = IndexedDbPersistence.buildStoragePrefix(
       cfg.databaseInfo
     );
-    const serializer = newSerializer(cfg.databaseInfo.databaseId);
     return new IndexedDbPersistence(
       cfg.persistenceSettings.synchronizeTabs,
       persistenceKey,
@@ -266,7 +270,7 @@ export class IndexedDbComponentProvider extends MemoryComponentProvider {
       cfg.asyncQueue,
       getWindow(),
       getDocument(),
-      serializer,
+      this.serializer,
       this.sharedClientState,
       cfg.persistenceSettings.forceOwningTab
     );

packages/firestore/src/local/bundle_cache.ts

@@ -28,7 +28,7 @@ export interface BundleCache {
    * Gets a saved `Bundle` for a given `bundleId`, returns undefined if
    * no bundles are found under the given id.
    */
-  getBundle(
+  getBundleMetadata(
     transaction: PersistenceTransaction,
     bundleId: string
   ): PersistencePromise<Bundle | undefined>;

packages/firestore/src/local/indexeddb_bundle_cache.ts

@@ -39,7 +39,7 @@ import { Bundle, NamedQuery } from '../core/bundle';
 export class IndexedDbBundleCache implements BundleCache {
   constructor(private serializer: LocalSerializer) {}
 
-  getBundle(
+  getBundleMetadata(
     transaction: PersistenceTransaction,
     bundleId: string
   ): PersistencePromise<Bundle | undefined> {

packages/firestore/src/local/indexeddb_remote_document_cache.ts

@@ -451,21 +451,21 @@ export class IndexedDbRemoteDocumentCache implements RemoteDocumentCache {
         primitiveComparator(l.canonicalString(), r.canonicalString())
       );
 
-      this.changes.forEach((key, maybeDocument) => {
+      this.changes.forEach((key, documentChange) => {
         const previousSize = this.documentSizes.get(key);
         debugAssert(
           previousSize !== undefined,
           `Cannot modify a document that wasn't read (for ${key})`
         );
-        if (maybeDocument) {
+        if (documentChange.maybeDocument) {
           debugAssert(
-            !this.readTime.isEqual(SnapshotVersion.min()),
+            !this.getReadTime(key).isEqual(SnapshotVersion.min()),
             'Cannot add a document with a read time of zero'
           );
           const doc = toDbRemoteDocument(
             this.documentCache.serializer,
-            maybeDocument,
-            this.readTime
+            documentChange.maybeDocument,
+            this.getReadTime(key)
           );
           collectionParents = collectionParents.add(key.path.popLast());
 
@@ -482,7 +482,7 @@ export class IndexedDbRemoteDocumentCache implements RemoteDocumentCache {
             const deletedDoc = toDbRemoteDocument(
               this.documentCache.serializer,
               new NoDocument(key, SnapshotVersion.min()),
-              this.readTime
+              this.getReadTime(key)
             );
             promises.push(
               this.documentCache.addEntry(transaction, key, deletedDoc)