feat(bindings): Pass Metadata in grpc binding invocation (#348)

* Pass Metadata in grpc binding invocation

Signed-off-by: Deepanshu Agarwal <[email protected]>

* Add e2e test for output binding metadata

Signed-off-by: Deepanshu Agarwal <[email protected]>

* Comment out E2E test

Signed-off-by: Deepanshu Agarwal <[email protected]>

* Fix comment

Signed-off-by: Deepanshu Agarwal <[email protected]>

* Uncomment test

Signed-off-by: Shubham Sharma <[email protected]>

* Fix tests

Signed-off-by: Shubham Sharma <[email protected]>

* Lint it

Signed-off-by: Shubham Sharma <[email protected]>

* Remove underscore

Signed-off-by: Shubham Sharma <[email protected]>

* 💄

Signed-off-by: Shubham Sharma <[email protected]>

Signed-off-by: Deepanshu Agarwal <[email protected]>
Signed-off-by: Shubham Sharma <[email protected]>
Co-authored-by: Shubham Sharma <[email protected]>

Author: DeepanshuA

src/implementation/Client/GRPCClient/binding.ts

@@ -15,6 +15,7 @@ import GRPCClient from "./GRPCClient";
 import { InvokeBindingRequest, InvokeBindingResponse } from "../../../proto/dapr/proto/runtime/v1/dapr_pb";
 import IClientBinding from "../../../interfaces/Client/IClientBinding";
 import * as SerializerUtil from "../../../utils/Serializer.util";
+import { createGRPCMetadata } from "../../../utils/Client.util";
 
 // https://docs.dapr.io/reference/api/bindings_api/
 export default class GRPCClientBinding implements IClientBinding {
@@ -27,16 +28,17 @@ export default class GRPCClientBinding implements IClientBinding {
   // Send an event to an external system
   // @todo: should pass the metadata object
   // @todo: should return a specific typed Promise<TypeBindingResponse> instead of Promise<object>
-  async send(bindingName: string, operation: string, data: any, _metadata: object = {}): Promise<object> {
+  async send(bindingName: string, operation: string, data: any, metadata: object = {}): Promise<object> {
     const msgService = new InvokeBindingRequest();
     msgService.setName(bindingName);
     msgService.setOperation(operation);
     msgService.setData(SerializerUtil.serializeGrpc(data).serializedData);
 
+    const grpcMetadata = createGRPCMetadata(metadata);
     const client = await this.client.getClient();
 
     return new Promise((resolve, reject) => {
-      client.invokeBinding(msgService, (err, res: InvokeBindingResponse) => {
+      client.invokeBinding(msgService, grpcMetadata, (err, res: InvokeBindingResponse) => {
         if (err) {
           return reject(err);
         }

test/components/binding-redis.yaml

@@ -0,0 +1,12 @@
+apiVersion: dapr.io/v1alpha1
+kind: Component
+metadata:
+  name: binding-redis
+spec:
+  type: bindings.redis
+  version: v1
+  metadata:
+    - name: redisHost
+      value: localhost:6379
+    - name: redisPassword
+      value: ""

test/e2e/grpc/server.test.ts

@@ -117,6 +117,13 @@ describe("grpc/server", () => {
       // @ts-ignore
       expect(mockBindingReceive.mock.calls[0][0]["hello"]).toEqual("world");
     });
+
+    it("should be able to send metadata to output binding successfully", async () => {
+      await server.client.binding.send("binding-redis", "create", "helloMessage", { key: "helloKey" });
+
+      const res = await server.client.configuration.get("config-redis", ["helloKey"]);
+      expect(res.items["helloKey"].value).toContain("helloMessage");
+    });
   });
 
   describe("pubsub", () => {
@@ -174,7 +181,7 @@ describe("grpc/server", () => {
       }
     });
 
-    // TODO: uncomment these tests once metadata over gRPC is supported. See https://github.com/dapr/dapr/issues/2860
+    // TODO: uncomment these tests when https://github.com/dapr/dapr/issues/2860 is resolved.
     // it('should be able to send cloud event and receive raw payload', async () => {
     //   const res = await server.client.pubsub.publish('pubsub-redis', 'test-topic-ce-raw', { hello: 'world-ce-raw' });
     //   expect(res).toEqual(true);
@@ -185,7 +192,7 @@ describe("grpc/server", () => {
 
     //   // Also test for receiving data
     //   // @ts-ignore
-    //   const rawData = mockPubSubSubscribeCloudEventRaw.mock.calls[0][0]['data_base64'];
+    //   const rawData = mockPubSub.mock.calls[0][0]['data_base64'];
     //   const data = JSON.parse(Buffer.from(rawData, 'base64').toString());
     //   // @ts-ignore
     //   expect(data['data']['hello']).toEqual('world-ce-raw');
@@ -201,7 +208,7 @@ describe("grpc/server", () => {
 
     //   // Also test for receiving data
     //   // @ts-ignore
-    //   const rawData = mockPubSubSubscribeRawRaw.mock.calls[0][0]['data_base64'];
+    //   const rawData = mockPubSub.mock.calls[0][0]['data_base64'];
     //   const data = JSON.parse(Buffer.from(rawData, 'base64').toString());
     //   // @ts-ignore
     //   expect(data['hello']).toEqual('world-raw-raw');
@@ -217,7 +224,7 @@ describe("grpc/server", () => {
 
     //   // Also test for receiving data
     //   // @ts-ignore
-    //   expect(mockPubSubSubscribeRawCloudEvent.mock.calls[0][0]['hello']).toEqual('world-raw-ce');
+    //   expect(mockPubSub.mock.calls[0][0]['hello']).toEqual('world-raw-ce');
     // })
 
     it("should receive if it was successful or not", async () => {