Merge pull request #2 from postmanlabs/feature/make-experimental-map-field-decode-opt-in

fix: make experimental map field decode opt-in

Author: appurva21

package-lock.json

@@ -8,7 +8,7 @@
     "@types/lodash.set": "^4.3.6",
     "google-protobuf": "^3.12.2",
     "lodash.set": "^4.3.2",
-    "@postman/protobufjs": "^7.3.2-postman.2"
+    "@postman/protobufjs": "^7.3.2-postman.3"
   },
   "devDependencies": {
     "@postman/grpc-js": "1.10.8-postman.3",
@@ -58,6 +58,6 @@
   ],
   "types": "build/src/index.d.ts",
   "peerDependencies": {
-    "@postman/grpc-js": "1.10.8-postman.3"
+    "@postman/grpc-js": "1.11.0-postman.1"
   }
 }

package.json

@@ -17,11 +17,15 @@ export class Client {
   metadata: Metadata;
   grpcClient: services.IServerReflectionClient;
   private fileDescriptorCache: Map<string, IFileDescriptorProto> = new Map();
+  private reflectionOptions?: {
+    useExperimentalMapFieldDecoding?: boolean;
+  };
   constructor(
     url: string,
     credentials: ChannelCredentials,
     options?: object,
-    metadata?: Metadata
+    metadata?: Metadata,
+    reflectionOptions?: Client['reflectionOptions']
   ) {
     this.fileDescriptorCache = new Map();
     this.metadata = metadata || new Metadata();
@@ -30,6 +34,7 @@ export class Client {
       credentials,
       options
     );
+    this.reflectionOptions = reflectionOptions;
   }
 
   listServices(): Promise<string[]> {
@@ -87,7 +92,10 @@ export class Client {
     );
     const fileDescriptorSet = FileDescriptorSet.create();
     set(fileDescriptorSet, 'file', Array.from(fileDescriptorMap.values()));
-    return getDescriptorRootFromDescriptorSet(fileDescriptorSet);
+    return getDescriptorRootFromDescriptorSet(
+      fileDescriptorSet,
+      this.reflectionOptions?.useExperimentalMapFieldDecoding
+    );
   }
 
   private async resolveDescriptorRecursive(

src/client.ts

@@ -11,25 +11,30 @@ const set = require('lodash.set');
  * Get Protobuf.js Root object from the serialized FileDescriptorProto messages
  * that gotten from reflection service.
  * @param {Array<Uint8Array|string>|undefined} file_descriptor_protos - Reflection descriptor protos
+ * @param {boolean} [useMapField=false] - Use experimental map field decoding support of protobufjs
  * @return {Root} Protobuf.js Root object
  */
 // eslint-disable-next-line node/no-unsupported-features/es-syntax
-export function getDescriptorRoot(file_descriptor_protos) {
+export function getDescriptorRoot(file_descriptor_protos, useMapField = false) {
   const descriptorSet = Descriptor.FileDescriptorSet.create();
 
   file_descriptor_protos.forEach((descriptorByte, i) => {
     const descriptor = Descriptor.FileDescriptorProto.decode(descriptorByte);
     set(descriptorSet, 'file[' + i + ']', descriptor);
   });
-  return protobuf.Root.fromDescriptor(descriptorSet, {useMapField: true});
+  return protobuf.Root.fromDescriptor(descriptorSet, {useMapField});
 }
 
 /**
  * Get Protobuf.js Root object from FileDescriptorSet
  * @param {Message file_descriptor_set - File descriptor set
+ * @param {boolean} [useMapField=false] - Use experimental map field decoding support of protobufjs
  * @return {Root} Protobuf.js Root object
  */
 // eslint-disable-next-line node/no-unsupported-features/es-syntax
-export function getDescriptorRootFromDescriptorSet(file_descriptor_set) {
-  return protobuf.Root.fromDescriptor(file_descriptor_set, {useMapField: true});
+export function getDescriptorRootFromDescriptorSet(
+  file_descriptor_set,
+  useMapField = false
+) {
+  return protobuf.Root.fromDescriptor(file_descriptor_set, {useMapField});
 }