RFC: Memory-only Firestore build

Author: schmidt-sebastian

integration/firestore/gulpfile.js

@@ -27,6 +27,10 @@ function clean() {
   return del(['temp/**/*', 'dist/**/*']);
 }
 
+function isPersistenceEnabled() {
+  return process.env.USE_FIRESTORE_PERSISTENCE !== 'false';
+}
+
 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.min.js'
+    isPersistenceEnabled()
+      ? '../../packages/firestore/dist/index.esm.min.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: { USE_FIRESTORE_PERSISTENCE: '${isPersistenceEnabled()}' } } as any;
+         } else {
+           process.env.USE_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; USE_FIRESTORE_PERSISTENCE=true gulp compile-tests",
+    "build:memory": "yarn build:dependencies; USE_FIRESTORE_PERSISTENCE=false 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": "USE_FIRESTORE_PERSISTENCE=true gulp compile-tests; karma start --single-run; USE_FIRESTORE_PERSISTENCE=false 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 Inc.
+ *
+ * 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

@@ -154,6 +154,13 @@ const firestoreMinifiedBuild = {
   external: ['@firebase/app']
 };
 
+const firestoreMemoryBuild = {
+  input: `firestore/index.memory.ts`,
+  output: createUmdOutputConfig(`firebase-firestore.memory.js`),
+  plugins: [...plugins, uglify()],
+  external: ['@firebase/app']
+};
+
 /**
  * Complete Package Builds
  */
@@ -271,5 +278,6 @@ export default [
   ...appBuilds,
   ...componentBuilds,
   firestoreMinifiedBuild,
+  firestoreMemoryBuild,
   ...completeBuilds
 ];

packages/firestore/index.memory.ts

@@ -0,0 +1,58 @@
+/**
+ * @license
+ * Copyright 2020 Google Inc.
+ *
+ * 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 * as types from '@firebase/firestore-types';
+import { FirebaseNamespace } from '@firebase/app-types';
+
+import { configureForFirebase } from './src/platform/config';
+import './src/platform_browser/browser_init';
+
+import { name, version } from './package.json';
+
+export function registerFirestore(instance: FirebaseNamespace): void {
+  configureForFirebase(instance);
+  instance.registerVersion(name, version);
+}
+
+registerFirestore(firebase);
+
+declare module '@firebase/app-types' {
+  interface FirebaseNamespace {
+    firestore?: {
+      (app?: FirebaseApp): types.FirebaseFirestore;
+      Blob: typeof types.Blob;
+      CollectionReference: typeof types.CollectionReference;
+      DocumentReference: typeof types.DocumentReference;
+      DocumentSnapshot: typeof types.DocumentSnapshot;
+      FieldPath: typeof types.FieldPath;
+      FieldValue: typeof types.FieldValue;
+      Firestore: typeof types.FirebaseFirestore;
+      GeoPoint: typeof types.GeoPoint;
+      Query: typeof types.Query;
+      QueryDocumentSnapshot: typeof types.QueryDocumentSnapshot;
+      QuerySnapshot: typeof types.QuerySnapshot;
+      Timestamp: typeof types.Timestamp;
+      Transaction: typeof types.Transaction;
+      WriteBatch: typeof types.WriteBatch;
+      setLogLevel: typeof types.setLogLevel;
+    };
+  }
+  interface FirebaseApp {
+    firestore?(): types.FirebaseFirestore;
+  }
+}

packages/firestore/index.node.memory.ts

@@ -0,0 +1,58 @@
+/**
+ * @license
+ * Copyright 2020 Google Inc.
+ *
+ * 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 * as types from '@firebase/firestore-types';
+import { FirebaseNamespace } from '@firebase/app-types';
+
+import { configureForFirebase } from './src/platform/config';
+import './src/platform_browser/browser_init';
+
+import { name, version } from './package.json';
+
+export function registerFirestore(instance: FirebaseNamespace): void {
+  configureForFirebase(instance);
+  instance.registerVersion(name, version);
+}
+
+registerFirestore(firebase);
+
+declare module '@firebase/app-types' {
+  interface FirebaseNamespace {
+    firestore?: {
+      (app?: FirebaseApp): types.FirebaseFirestore;
+      Blob: typeof types.Blob;
+      CollectionReference: typeof types.CollectionReference;
+      DocumentReference: typeof types.DocumentReference;
+      DocumentSnapshot: typeof types.DocumentSnapshot;
+      FieldPath: typeof types.FieldPath;
+      FieldValue: typeof types.FieldValue;
+      Firestore: typeof types.FirebaseFirestore;
+      GeoPoint: typeof types.GeoPoint;
+      Query: typeof types.Query;
+      QueryDocumentSnapshot: typeof types.QueryDocumentSnapshot;
+      QuerySnapshot: typeof types.QuerySnapshot;
+      Timestamp: typeof types.Timestamp;
+      Transaction: typeof types.Transaction;
+      WriteBatch: typeof types.WriteBatch;
+      setLogLevel: typeof types.setLogLevel;
+    };
+  }
+  interface FirebaseApp {
+    firestore?(): types.FirebaseFirestore;
+  }
+}

packages/firestore/index.node.ts

@@ -17,13 +17,15 @@
 import firebase from '@firebase/app';
 import * as types from '@firebase/firestore-types';
 import { configureForFirebase } from './src/platform/config';
+import { registerFirestorePersistence } from './src/platform/persistence';
 import './src/platform_node/node_init';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { name, version } from './package.json';
 
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(instance);
+  registerFirestorePersistence(instance);
   instance.registerVersion(name, version, 'node');
 }
 

packages/firestore/index.ts

@@ -17,6 +17,7 @@
 
 import firebase from '@firebase/app';
 import { configureForFirebase } from './src/platform/config';
+import { registerFirestorePersistence } from './src/platform/persistence';
 import './src/platform_browser/browser_init';
 
 import * as types from '@firebase/firestore-types';
@@ -26,6 +27,7 @@ import { name, version } from './package.json';
 
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(instance);
+  registerFirestorePersistence(instance);
   instance.registerVersion(name, version);
 }
 

packages/firestore/package.json

@@ -20,16 +20,20 @@
     "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",
   "browserMinified": "dist/index.cjs.min.js",
+  "browserMemoryPersistence": "dist/index.memory.cjs.js",
   "module": "dist/index.esm.js",
   "moduleMinified": "dist/index.esm.min.js",
+  "moduleMemoryPersistence": "dist/index.memory.esm.js",
   "esm2017": "dist/index.esm2017.js",
   "esm2017Minified": "dist/index.esm2017.min.js",
+  "esm2017MemoryPersistence": "dist/index.memory.esm2017.js",
   "license": "Apache-2.0",
   "files": [
     "dist"