Memory-only Firestore build

integration/firestore/gulpfile.js

@@ -27,6 +27,10 @@ function clean() {
   return del(['temp/**/*', 'dist/**/*']);
 }
 
+function isPersistenceEnabled() {
+  return process.env.DISABLE_FIRESTORE_PERSISTENCE !== 'true';
+}
+
 function copyTests() {
   /**
    * NOTE: We intentionally don't copy src/ files (to make sure we are only
@@ -37,7 +41,9 @@ function copyTests() {
   const firebaseAppSdk = 'firebase/app/dist/index.esm.js';
   const firebaseFirestoreSdk = resolve(
     __dirname,
-    '../../packages/firestore/dist/index.esm.js'
+    isPersistenceEnabled()
+      ? '../../packages/firestore/dist/index.esm.js'
+      : '../../packages/firestore/dist/index.memory.esm.js'
   );
   return gulp
     .src(
@@ -63,7 +69,14 @@ function copyTests() {
          */
         /import\s+firebase\s+from\s+('|")[^\1]+firebase_export\1;?/,
         `import firebase from '${firebaseAppSdk}';
-         import '${firebaseFirestoreSdk}';`
+         import '${firebaseFirestoreSdk}';
+
+         if (typeof process === 'undefined') {
+           process = { env: { DISABLE_FIRESTORE_PERSISTENCE: '${!isPersistenceEnabled()}' } } as any;
+         } else {
+           process.env.DISABLE_FIRESTORE_PERSISTENCE = '${!isPersistenceEnabled()}';
+         }
+         `
       )
     )
     .pipe(

integration/firestore/package.json

@@ -3,12 +3,19 @@
   "version": "1.0.1",
   "private": true,
   "scripts": {
-    "build": "(cd ../../ ; yarn build) ; gulp compile-tests",
+    "build:dependencies": "(cd ../../ ; yarn build)",
+    "build": "yarn build:dependencies; gulp compile-tests",
+    "build:memory": "yarn build:dependencies; DISABLE_FIRESTORE_PERSISTENCE=true gulp compile-tests",
+    "pretest": "yarn build:dependencies",
     "pretest:manual": "yarn build",
+    "pretest:manual:memory": "yarn build:memory",
     "pretest:debug": "yarn build",
-    "test": "echo 'Automated tests temporarily disabled, run `yarn test:manual` to execute these tests'",
+    "pretest:debug:memort": "yarn build:memory",
+    "test": "gulp compile-tests; karma start --single-run; DISABLE_FIRESTORE_PERSISTENCE=true gulp compile-tests; karma start --single-run;",
     "test:manual": "karma start --single-run",
-    "test:debug": "karma start --auto-watch --browsers Chrome"
+    "test:manual:memory": "karma start --single-run",
+    "test:debug": "karma start --auto-watch --browsers Chrome",
+    "test:debug:memory": "karma start --single-run"
   },
   "devDependencies": {
     "@types/mocha": "7.0.1",

packages/firebase/firestore/index.memory.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ * Copyright 2020 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 '../../firestore/dist/index.memory.esm';

packages/firebase/rollup.config.js

@@ -147,6 +147,13 @@ const componentBuilds = pkg.components
   })
   .reduce((a, b) => a.concat(b), []);
 
+const firestoreMemoryBuild = {
+  input: `firestore/index.memory.ts`,
+  output: createUmdOutputConfig(`firebase-firestore.memory.js`),
+  plugins: [...plugins, uglify()],
+  external: ['@firebase/app']
+};
+
 /**
  * Complete Package Builds
  */
@@ -260,4 +267,9 @@ const completeBuilds = [
   }
 ];
 
-export default [...appBuilds, ...componentBuilds, ...completeBuilds];
+export default [
+  ...appBuilds,
+  ...componentBuilds,
+  firestoreMemoryBuild,
+  ...completeBuilds
+];

packages/firestore/index.memory.ts

@@ -0,0 +1,33 @@
+/**
+ * @license
+ * Copyright 2020 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 firebase from '@firebase/app';
+import { FirebaseNamespace } from '@firebase/app-types';
+
+import { configureForFirebase } from './src/platform/config';
+import './register-module';
+import './src/platform_browser/browser_init';
+
+import { name, version } from './package.json';
+import { Firestore, PublicMemoryFirestore } from './src/api/database';
+
+export function registerFirestore(instance: FirebaseNamespace): void {
+  configureForFirebase(instance, PublicMemoryFirestore, Firestore);
+  instance.registerVersion(name, version);
+}
+
+registerFirestore(firebase);

packages/firestore/index.node.memory.ts

@@ -0,0 +1,33 @@
+/**
+ * @license
+ * Copyright 2020 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 firebase from '@firebase/app';
+import { FirebaseNamespace } from '@firebase/app-types';
+
+import { configureForFirebase } from './src/platform/config';
+import './register-module';
+import './src/platform_node/node_init';
+
+import { name, version } from './package.json';
+import { Firestore, PublicMemoryFirestore } from './src/api/database';
+
+export function registerFirestore(instance: FirebaseNamespace): void {
+  configureForFirebase(instance, PublicMemoryFirestore, Firestore);
+  instance.registerVersion(name, version);
+}
+
+registerFirestore(firebase);

packages/firestore/index.node.ts

@@ -21,9 +21,17 @@ import './src/platform_node/node_init';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { name, version } from './package.json';
+import {
+  PersistenceFirestore,
+  PublicPersistenceFirestore
+} from './src/api/persistence';
 
 export function registerFirestore(instance: FirebaseNamespace): void {
-  configureForFirebase(instance);
+  configureForFirebase(
+    instance,
+    PublicPersistenceFirestore,
+    PersistenceFirestore
+  );
   instance.registerVersion(name, version, 'node');
 }
 

packages/firestore/index.ts

@@ -23,9 +23,17 @@ import './src/platform_browser/browser_init';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { name, version } from './package.json';
+import {
+  PersistenceFirestore,
+  PublicPersistenceFirestore
+} from './src/api/persistence';
 
 export function registerFirestore(instance: FirebaseNamespace): void {
-  configureForFirebase(instance);
+  configureForFirebase(
+    instance,
+    PublicPersistenceFirestore,
+    PersistenceFirestore
+  );
   instance.registerVersion(name, version);
 }
 

packages/firestore/package.json

@@ -20,13 +20,17 @@
     "test:node:persistence": "FIRESTORE_EMULATOR_PORT=8080 FIRESTORE_EMULATOR_PROJECT_ID=test-emulator USE_MOCK_PERSISTENCE=YES TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --require ts-node/register --require index.node.ts --require test/util/node_persistence.ts --opts ../../config/mocha.node.opts",
     "test:node:persistence:prod": "USE_MOCK_PERSISTENCE=YES TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --require ts-node/register --require index.node.ts --require test/util/node_persistence.ts --opts ../../config/mocha.node.opts",
     "test:travis": "ts-node --compiler-options='{\"module\":\"commonjs\"}' ../../scripts/emulator-testing/firestore-test-runner.ts",
-    "test:minified": "(cd ../../integration/firestore ; yarn test:manual)",
+    "test:minified": "(cd ../../integration/firestore ; yarn test)",
     "prepare": "yarn build"
   },
   "main": "dist/index.node.cjs.js",
+  "mainMemoryPersistence": "dist/index.node.memory.cjs.js",
   "browser": "dist/index.cjs.js",
+  "browserMemoryPersistence": "dist/index.memory.cjs.js",
   "module": "dist/index.esm.js",
+  "moduleMemoryPersistence": "dist/index.memory.esm.js",
   "esm2017": "dist/index.esm2017.js",
+  "esm2017MemoryPersistence": "dist/index.memory.esm2017.js",
   "license": "Apache-2.0",
   "files": [
     "dist"

packages/firestore/rollup.config.js

@@ -62,32 +62,81 @@ const terserOptions = {
   }
 };
 
+/**
+ * ES5 Builds
+ */
+const es5BuildPlugins = [
+  typescriptPlugin({
+    typescript,
+    transformers,
+    cacheRoot: './.cache/es5.min/'
+  }),
+  json(),
+  terser(terserOptions)
+];
+
+const nodeBuildPlugins = [
+  ...es5BuildPlugins,
+  // Needed as we also use the *.proto files
+  copy({
+    assets: ['./src/protos']
+  }),
+  replace({
+    'process.env.FIRESTORE_PROTO_ROOT': JSON.stringify('src/protos')
+  })
+];
+
+/**
+ * Returns the externs locations for the Memory-based Firestore implementation.
+ * Verifies that no persistence sources are used by Firestore's memory-only
+ * implementation.
+ */
+function resolveMemoryExterns(id, referencedBy) {
+  const externalRef = path
+    .resolve(path.dirname(referencedBy), id)
+    .replace('.ts', '');
+
+  const persistenceRef = [
+    'local/indexeddb_persistence.ts',
+    'local/indexeddb_index_manager.ts',
+    'local/indexeddb_mutation_queue.ts',
+    'local/indexeddb_remote_document_cache.ts',
+    'local/indexeddb_schema.ts',
+    'local/indexeddb_target_cache.ts',
+    'local/local_serializer.ts',
+    'local/simple_db.ts',
+    'api/persistence.ts'
+  ].map(p => path.resolve(__dirname, 'src', p));
+
+  if (persistenceRef.indexOf(externalRef) !== -1) {
+    throw new Error('Unexpected reference in Memory-only client on ' + id);
+  }
+  return [...deps, 'util', 'path'].some(
+    dep => id === dep || id.startsWith(`${dep}/`)
+  );
+}
+
 const es5Builds = [
   /**
    * Node.js Build
    */
   {
     input: 'index.node.ts',
     output: [{ file: pkg.main, format: 'cjs', sourcemap: true }],
-    plugins: [
-      typescriptPlugin({
-        typescript,
-        cacheRoot: './.cache/node.cjs/'
-      }),
-      json(),
-      // Needed as we also use the *.proto files
-      copy({
-        assets: ['./src/protos']
-      }),
-      replace({
-        'process.env.FIRESTORE_PROTO_ROOT': JSON.stringify('src/protos')
-      })
-    ],
+    plugins: nodeBuildPlugins,
     external: id =>
       [...deps, 'util', 'path'].some(
         dep => id === dep || id.startsWith(`${dep}/`)
       )
   },
+  {
+    input: 'index.node.memory.ts',
+    output: [
+      { file: pkg.mainMemoryPersistence, format: 'cjs', sourcemap: true }
+    ],
+    plugins: nodeBuildPlugins,
+    external: resolveMemoryExterns
+  },
   /**
    * Browser ESM Build
    */
@@ -105,17 +154,40 @@ const es5Builds = [
     ],
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   },
+  {
+    input: 'index.memory.ts',
+    output: { file: pkg.moduleMemoryPersistence, format: 'es', sourcemap: true },
+    plugins: [
+      typescriptPlugin({
+        typescript,
+        transformers,
+        cacheRoot: './.cache/esm/'
+      }),
+      json(),
+      terser(terserOptions)
+    ],
+    external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
+  },
   /**
-   * Browser CJS Build 
-   * 
-   * This build is based on the mangling in the ESM build above, since
+   * Browser CJS Build
+   *
+   * These builds are based on the mangling in the ESM build above, since
    * Terser's Property name mangling doesn't work well with CJS's syntax.
    */
   {
     input: pkg.module,
     output: { file: pkg.browser, format: 'cjs', sourcemap: true },
-    plugins: [ sourcemaps() ]
+    plugins: [sourcemaps()]
   },
+  {
+    input: pkg.moduleMemoryPersistence,
+    output: {
+      file: pkg.browserMemoryPersistence,
+      format: 'cjs',
+      sourcemap: true
+    },
+    plugins: [sourcemaps()]
+  }
 ];
 
 /**
@@ -149,6 +221,16 @@ const es2017Builds = [
     },
     plugins: es2017BuildPlugins,
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
+  },
+  {
+    input: 'index.memory.ts',
+    output: {
+      file: pkg.esm2017MemoryPersistence,
+      format: 'es',
+      sourcemap: true
+    },
+    plugins: es2017BuildPlugins,
+    external: resolveMemoryExterns
   }
 ];