Remove use of deprecated grpc.load() method (#1669)

* Workaround for deprecated grpc.load() method

* Update to protobufjs 6.x

* Switch serializer tests to test round trips

Rather than separate tests for encoding/decoding. Similar to the other
platforms.

* update descriptor.proto

* Clean up some serializer stuff.

1. The switch to protobufjs 6.x seems to have removed the need for hasTag() (and actually it had broken our usage of it since the tags ended up changing from snake_case to camelCase). So I've removed hasTag() and set `oneofs: false` in protoLoaderOptions so the virtual "fooType" fields are no longer added.
2. 'seconds' in timestamps should always be serialized as a string, since it's an int64 but we weren't doing that. I fixed it, which removed some of the special casing from rsgowman/grpc_load.
3. I reworked the expect...RoundTrip methods into a single unified one which saves some repetition and I think is easier to make sense of.
4. I re-added the disabled useProto3Json assert and instead tweaked the offending test not to try to round-trip through protobufjs.

* Update grpc/proto-loader to 0.5.0.

Author: rsgowman

packages/firestore/package.json

@@ -31,6 +31,7 @@
     "@firebase/firestore-types": "1.2.1",
     "@firebase/logger": "0.1.13",
     "@firebase/webchannel-wrapper": "0.2.19",
+    "@grpc/proto-loader": "^0.5.0",
     "grpc": "1.20.0",
     "tslib": "1.9.3"
   },
@@ -62,6 +63,7 @@
     "npm-run-all": "4.1.5",
     "nyc": "14.0.0",
     "prettier": "1.17.0",
+    "protobufjs": "6.8.8",
     "rollup": "1.10.1",
     "rollup-plugin-copy-assets": "1.1.0",
     "rollup-plugin-node-resolve": "4.2.3",

packages/firestore/src/platform_node/load_protos.ts

@@ -15,28 +15,64 @@
  * limitations under the License.
  */
 
+import * as protoLoader from '@grpc/proto-loader';
 import * as grpc from 'grpc';
-import { resolve } from 'path';
+import * as path from 'path';
+import * as ProtobufJS from 'protobufjs';
+
+/** Used by tests so we can match @grpc/proto-loader behavior. */
+export const protoLoaderOptions: ProtobufJS.IConversionOptions = {
+  longs: String,
+  enums: String,
+  defaults: true,
+  oneofs: false
+};
 
 /**
  * Loads the protocol buffer definitions for Firestore.
  *
  * @returns The GrpcObject representing our protos.
  */
 export function loadProtos(): grpc.GrpcObject {
-  const options = {
-    // Beware that converting fields to camel case does not convert the tag
-    // fields in oneof groups (!!!). This will likely be fixed when we upgrade
-    // to protobufjs 6.x
-    convertFieldsToCamelCase: true
-  };
-  const root = resolve(
+  const root = path.resolve(
+    __dirname,
+    process.env.FIRESTORE_PROTO_ROOT || '../protos'
+  );
+  const firestoreProtoFile = path.join(
+    root,
+    'google/firestore/v1/firestore.proto'
+  );
+
+  const packageDefinition = protoLoader.loadSync(firestoreProtoFile, {
+    ...protoLoaderOptions,
+    includeDirs: [root]
+  });
+
+  return grpc.loadPackageDefinition(packageDefinition);
+}
+
+/** Used by tests so we can directly create ProtobufJS proto message objects from JSON protos. */
+export function loadRawProtos(): ProtobufJS.Root {
+  const root = path.resolve(
     __dirname,
     process.env.FIRESTORE_PROTO_ROOT || '../protos'
   );
-  const firestoreProtoFile = {
+  const firestoreProtoFile = path.join(
     root,
-    file: 'google/firestore/v1/firestore.proto'
+    'google/firestore/v1/firestore.proto'
+  );
+
+  const protoRoot = new ProtobufJS.Root();
+  // Override the resolvePath function to look for protos in the 'root'
+  // directory.
+  protoRoot.resolvePath = (origin: string, target: string) => {
+    if (path.isAbsolute(target)) {
+      return target;
+    }
+    return path.join(root, target);
   };
-  return grpc.load(firestoreProtoFile, /*format=*/ 'proto', options);
+
+  protoRoot.loadSync(firestoreProtoFile);
+  protoRoot.resolveAll();
+  return protoRoot;
 }

packages/firestore/src/protos/firestore_proto_api.d.ts

@@ -353,9 +353,9 @@ export declare namespace firestoreV1ApiClientInterfaces {
     booleanValue?: boolean;
     integerValue?: string;
     doubleValue?: number;
-    timestampValue?: string;
+    timestampValue?: string | { seconds: long; nanos: long };
     stringValue?: string;
-    bytesValue?: string;
+    bytesValue?: string | Uint8Array;
     referenceValue?: string;
     geoPointValue?: LatLng;
     arrayValue?: ArrayValue;