Remove gRPC and protos from @firebase/testing (#3236)

Author: samtstern

packages/testing/.firebaserc

@@ -0,0 +1 @@
+{}

packages/testing/README.md

@@ -1,14 +1,9 @@
 # @firebase/testing
 
-This is the testing component for the Firebase JS SDK.
+A set of utilities useful for testing Security Rules with the Realtime Database or Cloud Firestore
+emulators.
 
+See:
 
-## Protocol buffers
-
-There are some protocol buffers (the `.proto` files in `src/protos/`) that
-are included in this package but should not be modified. They're copied from
-Google production and emulator APIs, and are immutable specifically to maintain
-compatibility with those services.
-
-When those services update their APIs, the new versions should be mirrored into
-this package.
+  * [Test your Cloud Firestore Security Rules](https://firebase.google.com/docs/firestore/security/test-rules-emulator)
+  * [Testing Security Rules with the Realtime Database Emulator](https://firebase.google.com/docs/database/security/test-rules-emulator)

packages/testing/firebase.json

@@ -0,0 +1,13 @@
+{
+  "emulators": {
+    "firestore": {
+      "port": 9001
+    },
+    "database": {
+      "port": 9000
+    },
+    "ui": {
+      "enabled": false
+    }
+  }
+}

packages/testing/package.json

@@ -14,7 +14,8 @@
     "build": "rollup -c",
     "build:deps": "lerna run --scope @firebase/testing --include-dependencies build",
     "dev": "rollup -c -w",
-    "test": "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --config ../../config/mocharc.node.js",
+    "test:nyc": "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --config ../../config/mocharc.node.js",
+    "test": "firebase emulators:exec 'yarn test:nyc'",
     "test:ci": "node ../../scripts/run_tests_in_ci.js",
     "prepare": "yarn build"
   },
@@ -23,13 +24,12 @@
     "firebase": "7.15.2",
     "@firebase/logger": "0.2.5",
     "@firebase/util": "0.2.49",
-    "@types/request": "2.48.4",
     "request": "2.88.2"
   },
   "devDependencies": {
+    "@types/request": "2.48.4",
+    "firebase-tools": "^8.4.3",
     "rollup": "2.7.6",
-    "rollup-plugin-copy-assets": "1.1.0",
-    "rollup-plugin-replace": "2.2.0",
     "rollup-plugin-typescript2": "0.27.0"
   },
   "repository": {

packages/testing/rollup.config.js

@@ -17,8 +17,6 @@
 
 import typescriptPlugin from 'rollup-plugin-typescript2';
 import pkg from './package.json';
-import replace from 'rollup-plugin-replace';
-import copy from 'rollup-plugin-copy-assets';
 import typescript from 'typescript';
 
 const plugins = [
@@ -34,13 +32,6 @@ const deps = Object.keys(
 export default {
   input: 'index.ts',
   output: [{ file: pkg.main, format: 'cjs', sourcemap: true }],
-  plugins: [
-    ...plugins,
-    // Needed as we also use the *.proto files
-    copy({ assets: ['./src/protos'] }),
-    replace({
-      'process.env.FIRESTORE_EMULATOR_PROTO_ROOT': JSON.stringify('src/protos')
-    })
-  ],
+  plugins: [...plugins],
   external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
 };

packages/testing/src/api/index.ts

@@ -21,25 +21,10 @@ import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
 import * as request from 'request';
 import { base64 } from '@firebase/util';
 import { setLogLevel, LogLevel } from '@firebase/logger';
-import * as grpc from '@grpc/grpc-js';
-import * as protoLoader from '@grpc/proto-loader';
-import { resolve } from 'path';
 import { Component, ComponentType } from '@firebase/component';
 
 export { database, firestore } from 'firebase';
 
-const PROTO_ROOT = resolve(
-  __dirname,
-  process.env.FIRESTORE_EMULATOR_PROTO_ROOT || '../protos'
-);
-const PROTO_FILE = resolve(
-  PROTO_ROOT,
-  'google/firestore/emulator/v1/firestore_emulator.proto'
-);
-const PKG_DEF = protoLoader.loadSync(PROTO_FILE, { includeDirs: [PROTO_ROOT] });
-const PROTOS = grpc.loadPackageDefinition(PKG_DEF);
-const EMULATOR = (PROTOS['google'] as any)['firestore']['emulator']['v1'];
-
 /** If this environment variable is set, use it for the database emulator's address. */
 const DATABASE_ADDRESS_ENV: string = 'FIREBASE_DATABASE_EMULATOR_ADDRESS';
 /** The default address for the local database emulator. */
@@ -218,22 +203,24 @@ export function loadFirestoreRules(
     throw new Error('must provide rules to loadFirestoreRules');
   }
 
-  let client = new EMULATOR.FirestoreEmulator(
-    FIRESTORE_ADDRESS,
-    grpc.credentials.createInsecure()
-  );
   return new Promise((resolve, reject) => {
-    client.setSecurityRules(
+    request.put(
       {
-        project: `projects/${options.projectId}`,
-        rules: { files: [{ content: options.rules }] }
+        uri: `http://${FIRESTORE_ADDRESS}/emulator/v1/projects/${options.projectId}:securityRules`,
+        body: JSON.stringify({
+          rules: {
+            files: [{ content: options.rules }]
+          }
+        })
       },
-      // @ts-ignore Defined in protobuf.
-      (err: Error, resp) => {
+      (err, resp, body) => {
         if (err) {
           reject(err);
+        } else if (resp.statusCode !== 200) {
+          console.log('body', body);
+          reject(JSON.parse(body).error);
         } else {
-          resolve(resp);
+          resolve();
         }
       }
     );
@@ -250,26 +237,22 @@ export function clearFirestoreData(
     throw new Error('projectId not specified');
   }
 
-  let client = new EMULATOR.FirestoreEmulator(
-    FIRESTORE_ADDRESS,
-    grpc.credentials.createInsecure(),
-    {
-      // As with 'loadFirestoreRules', cap how much backoff gRPC will perform.
-      'grpc.initial_reconnect_backoff_ms': 100,
-      'grpc.max_reconnect_backoff_ms': 100
-    }
-  );
   return new Promise((resolve, reject) => {
-    client.clearData(
+    request.delete(
       {
-        database: `projects/${options.projectId}/databases/(default)`
+        uri: `http://${FIRESTORE_ADDRESS}/emulator/v1/projects/${options.projectId}/databases/(default)/documents`,
+        body: JSON.stringify({
+          database: `projects/${options.projectId}/databases/(default)`
+        })
       },
-      // @ts-ignore Defined in protobuf.
-      (err: Error, resp) => {
+      (err, resp, body) => {
         if (err) {
           reject(err);
+        } else if (resp.statusCode !== 200) {
+          console.log('body', body);
+          reject(JSON.parse(body).error);
         } else {
-          resolve(resp);
+          resolve();
         }
       }
     );