Merge 161e64a into b08248a

Author: wu-hui

integration/firestore/firebase_export_memory.ts

@@ -17,7 +17,7 @@
 
 import firebase from '@firebase/app';
 import '@firebase/firestore/memory';
-import '@firebase/firestore/bundle';
+import '@firebase/firestore/memory-bundle';
 import { FirebaseApp } from '@firebase/app-types';
 import { Settings, FirebaseFirestore } from '@firebase/firestore-types';
 

integration/firestore/package.json

@@ -9,7 +9,7 @@
     "test": "yarn build:memory; karma start --single-run; yarn build:persistence; karma start --single-run;",
     "test:ci": "node ../../scripts/run_tests_in_ci.js -s test",
     "test:persistence": " yarn build:persistence; karma start --single-run",
-    "test:persistence:debug:": "yarn build:persistence; karma start --auto-watch --browsers Chrome",
+    "test:persistence:debug": "yarn build:persistence; karma start --auto-watch --browsers Chrome",
     "test:memory": "yarn build:memory; karma start --single-run",
     "test:memory:debug": "yarn build:memory; karma start --auto-watch --browsers Chrome"
   },

packages/firebase/firestore/memory/index.ts

@@ -21,4 +21,4 @@
  */
 
 import '@firebase/firestore/memory';
-import '@firebase/firestore/bundle';
+import '@firebase/firestore/memory-bundle';

packages/firestore/exp/src/api/snapshot.ts

@@ -176,9 +176,9 @@ export interface DocumentChange<T = DocumentData> {
  * access will return 'undefined'. You can use the `exists()` method to
  * explicitly verify a document's existence.
  */
-export class DocumentSnapshot<
-  T = DocumentData
-> extends LiteDocumentSnapshot<T> {
+export class DocumentSnapshot<T = DocumentData> extends LiteDocumentSnapshot<
+  T
+> {
   private readonly _firestoreImpl: FirebaseFirestore;
 
   /**
@@ -291,9 +291,9 @@ export class DocumentSnapshot<
  * `exists` property will always be true and `data()` will never return
  * 'undefined'.
  */
-export class QueryDocumentSnapshot<
-  T = DocumentData
-> extends DocumentSnapshot<T> {
+export class QueryDocumentSnapshot<T = DocumentData> extends DocumentSnapshot<
+  T
+> {
   /**
    * Retrieves all fields in the document as an `Object`.
    *

packages/firestore/index.bundle.ts

@@ -34,7 +34,7 @@ export function registerBundle(instance: typeof Firestore): void {
     return namedQuery(this, queryName);
   };
 
-  //TODO: add loadBundle and namedQuery to the firestore namespace
+  //TODO(wuandy): add loadBundle and namedQuery to the firestore namespace
 }
 
 registerBundle(Firestore);

packages/firestore/lite/src/api/snapshot.ts

@@ -211,9 +211,9 @@ export class DocumentSnapshot<T = DocumentData> {
  * `exists` property will always be true and `data()` will never return
  * 'undefined'.
  */
-export class QueryDocumentSnapshot<
-  T = DocumentData
-> extends DocumentSnapshot<T> {
+export class QueryDocumentSnapshot<T = DocumentData> extends DocumentSnapshot<
+  T
+> {
   /**
    * Retrieves all fields in the document as an `Object`.
    *

packages/firestore/memory-bundle/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@firebase/firestore/memory-bundle",
+  "description": "Firestore bundle",
+  "main": "../dist/memory/node-cjs/bundle.js",
+  "main-esm2017": "../dist/memory/node-esm2017/bundle.js",
+  "react-native": "../dist/memory/rn/bundle.js",
+  "browser": "../dist/memory/esm5/bundle.js",
+  "module": "../dist/memory/esm5/bundle.js",
+  "esm2017": "../dist/memory/esm2017/bundle.js"
+}

packages/firestore/rollup.config.browser.js

@@ -2,6 +2,7 @@ import pkg from './package.json';
 import path from 'path';
 import memoryPkg from './memory/package.json';
 import bundlePkg from './bundle/package.json';
+import memoryBundlePkg from './memory-bundle/package.json';
 
 /**
  * @license
@@ -50,7 +51,7 @@ export default [
     },
     plugins: [
       util.applyPrebuilt(),
-      ...util.es2017Plugins('browser', /* mangled= */ true)
+      ...util.es2017Plugins('browser', /* mangled= */ false)
     ],
     external: util.resolveBrowserExterns,
     treeshake: {
@@ -89,7 +90,7 @@ export default [
     },
     plugins: [
       util.applyPrebuilt(),
-      ...util.es2017Plugins('browser', /* mangled= */ true)
+      ...util.es2017Plugins('browser', /* mangled= */ false)
     ],
     external: util.resolveBrowserExterns,
     treeshake: {
@@ -100,7 +101,7 @@ export default [
   {
     input: {
       index: path.resolve('./memory', memoryPkg['esm2017']),
-      bundle: path.resolve('./bundle', bundlePkg['esm2017'])
+      bundle: path.resolve('./bundle', memoryBundlePkg['esm2017'])
     },
     output: [
       {

packages/firestore/rollup.config.node.js

@@ -20,6 +20,7 @@ import copy from 'rollup-plugin-copy';
 import pkg from './package.json';
 import bundlePkg from './bundle/package.json';
 import memoryPkg from './memory/package.json';
+import memoryBundlePkg from './memory-bundle/package.json';
 import path from 'path';
 
 const util = require('./rollup.shared');
@@ -91,7 +92,7 @@ export default [
   {
     input: {
       index: path.resolve('./memory', memoryPkg['main-esm2017']),
-      bundle: path.resolve('./bundle', bundlePkg['main-esm2017'])
+      bundle: path.resolve('./bundle', memoryBundlePkg['main-esm2017'])
     },
     output: [
       {

packages/firestore/rollup.config.rn.js

@@ -45,7 +45,7 @@ export default [
     },
     plugins: [
       util.applyPrebuilt('prebuilt.rn.js'),
-      ...util.es2017Plugins('rn', /* mangled= */ true)
+      ...util.es2017Plugins('rn', /* mangled= */ false)
     ],
     external: util.resolveBrowserExterns,
     treeshake: {

packages/firestore/rollup.shared.js

@@ -204,11 +204,11 @@ const manglePrivatePropertiesOptions = {
 exports.manglePrivatePropertiesOptions = manglePrivatePropertiesOptions;
 
 exports.applyPrebuilt = function (name = 'prebuilt.js') {
-  alias({
+  return alias({
     entries: [
       {
         find: /^(.*)\/export$/,
-        replacement: `$1\/dist/${name}.js`
+        replacement: `$1\/dist/${name}`
       }
     ]
   });

packages/firestore/src/core/bundle.ts

@@ -31,28 +31,18 @@ import {
 import * as api from '../protos/firestore_proto_api';
 import { DocumentKey } from '../model/document_key';
 import { MaybeDocument, NoDocument } from '../model/document';
-import { debugAssert, debugCast } from '../util/assert';
-import { LocalStore } from '../local/local_store';
-import { BundleReader, SizedBundleElement } from '../util/bundle_reader';
+import { debugAssert } from '../util/assert';
+import {
+  applyBundleDocuments,
+  LocalStore,
+  saveNamedQuery
+} from '../local/local_store';
+import { SizedBundleElement } from '../util/bundle_reader';
 import {
   documentKeySet,
   DocumentKeySet,
   MaybeDocumentMap
 } from '../model/collections';
-import { LoadBundleTask } from '../api/bundle';
-import {
-  emitNewSnapsAndNotifyLocalStore,
-  SyncEngine,
-  SyncEngineImpl
-} from './sync_engine';
-import { logWarn } from '../util/log';
-import { LOG_TAG } from '../../lite/src/api/components';
-import {
-  applyBundleDocuments,
-  hasNewerBundle,
-  saveBundle,
-  saveNamedQuery
-} from '../local/local_store_bundle';
 
 /**
  * Represents a bundled document, including the metadata and the document
@@ -105,7 +95,7 @@ export class BundleConverter {
  * Returns a `LoadBundleTaskProgress` representing the initial progress of
  * loading a bundle.
  */
-function bundleInitialProgress(
+export function bundleInitialProgress(
   metadata: ProtoBundleMetadata
 ): LoadBundleTaskProgress {
   return {
@@ -121,7 +111,7 @@ function bundleInitialProgress(
  * Returns a `LoadBundleTaskProgress` representing the progress that the loading
  * has succeeded.
  */
-function bundleSuccessProgress(
+export function bundleSuccessProgress(
   metadata: ProtoBundleMetadata
 ): LoadBundleTaskProgress {
   return {
@@ -133,7 +123,7 @@ function bundleSuccessProgress(
   };
 }
 
-class BundleLoadResult {
+export class BundleLoadResult {
   constructor(
     readonly progress: LoadBundleTaskProgress,
     readonly changedDocs: MaybeDocumentMap
@@ -144,7 +134,7 @@ class BundleLoadResult {
  * A class to process the elements from a bundle, load them into local
  * storage and provide progress update while loading.
  */
-class BundleLoader {
+export class BundleLoader {
   /** The current progress of loading */
   private progress: LoadBundleTaskProgress;
   /** Batched queries to be saved into storage */
@@ -249,77 +239,3 @@ class BundleLoader {
     return new BundleLoadResult({ ...this.progress }, changedDocuments);
   }
 }
-
-/**
- * Loads a Firestore bundle into the SDK. The returned promise resolves when
- * the bundle finished loading.
- *
- * @param bundleReader Bundle to load into the SDK.
- * @param task LoadBundleTask used to update the loading progress to public API.
- */
-export function syncEngineLoadBundle(
-  syncEngine: SyncEngine,
-  bundleReader: BundleReader,
-  task: LoadBundleTask
-): void {
-  const syncEngineImpl = debugCast(syncEngine, SyncEngineImpl);
-
-  // eslint-disable-next-line @typescript-eslint/no-floating-promises
-  loadBundleImpl(syncEngineImpl, bundleReader, task).then(() => {
-    syncEngineImpl.sharedClientState.notifyBundleLoaded();
-  });
-}
-
-async function loadBundleImpl(
-  syncEngine: SyncEngineImpl,
-  reader: BundleReader,
-  task: LoadBundleTask
-): Promise<void> {
-  try {
-    const metadata = await reader.getMetadata();
-    const skip = await hasNewerBundle(syncEngine.localStore, metadata);
-    if (skip) {
-      await reader.close();
-      task._completeWith(bundleSuccessProgress(metadata));
-      return;
-    }
-
-    task._updateProgress(bundleInitialProgress(metadata));
-
-    const loader = new BundleLoader(
-      metadata,
-      syncEngine.localStore,
-      reader.serializer
-    );
-    let element = await reader.nextElement();
-    while (element) {
-      debugAssert(
-        !element.payload.metadata,
-        'Unexpected BundleMetadata element.'
-      );
-      const progress = await loader.addSizedElement(element);
-      if (progress) {
-        task._updateProgress(progress);
-      }
-
-      element = await reader.nextElement();
-    }
-
-    const result = await loader.complete();
-    // TODO(b/160876443): This currently raises snapshots with
-    // `fromCache=false` if users already listen to some queries and bundles
-    // has newer version.
-    await emitNewSnapsAndNotifyLocalStore(
-      syncEngine,
-      result.changedDocs,
-      /* remoteEvent */ undefined
-    );
-
-    // Save metadata, so loading the same bundle will skip.
-    await saveBundle(syncEngine.localStore, metadata);
-    task._completeWith(result.progress);
-  } catch (e) {
-    logWarn(LOG_TAG, `Loading bundle failed with ${e}`);
-    task._failWith(e);
-  }
-}

packages/firestore/src/core/firestore_client.ts

@@ -24,6 +24,7 @@ import {
 import { User } from '../auth/user';
 import {
   executeQuery,
+  getNamedQuery,
   handleUserChange,
   LocalStore,
   readLocalDocument
@@ -54,6 +55,7 @@ import {
   registerPendingWritesCallback,
   SyncEngine,
   syncEngineListen,
+  syncEngineLoadBundle,
   syncEngineUnlisten,
   syncEngineWrite
 } from './sync_engine';
@@ -77,11 +79,9 @@ import { Persistence } from '../local/persistence';
 import { Datastore } from '../remote/datastore';
 import { LoadBundleTask } from '../api/bundle';
 import { newSerializer, newTextEncoder } from '../platform/serializer';
-import { getNamedQuery } from '../local/local_store_bundle';
 import { JsonProtoSerializer } from '../remote/serializer';
 import { BundleReader } from '../util/bundle_reader';
 import { toByteStreamReader } from '../platform/byte_stream_reader';
-import { syncEngineLoadBundle } from './bundle';
 import { NamedQuery } from './bundle_types';
 
 const LOG_TAG = 'FirestoreClient';