Allow passing metadata to client.state.save and return a custom response with error (#461)

* Use metadata in statestore save

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

* Prettify

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

* Add e2e tests and fix gRPC metadata

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

* Fix e2e tests

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

* Final

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

* Address comments

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

---------

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

Author: shubham1172

daprdocs/content/en/js-sdk-docs/js-client/_index.md

@@ -184,16 +184,27 @@ async function start() {
   const serviceStoreName = "my-state-store-name";
 
   // Save State
-  const response = await client.state.save(serviceStoreName, [
-    {
-      key: "first-key-name",
-      value: "hello",
-    },
+  const response = await client.state.save(
+    serviceStoreName,
+    [
+      {
+        key: "first-key-name",
+        value: "hello",
+        metadata: {
+          foo: "bar",
+        },
+      },
+      {
+        key: "second-key-name",
+        value: "world",
+      },
+    ],
     {
-      key: "second-key-name",
-      value: "world",
+      metadata: {
+        ttlInSeconds: "3", // this should override the ttl in the state item
+      },
     },
-  ]);
+  );
 
   // Get State
   const response = await client.state.get(serviceStoreName, "first-key-name");

src/implementation/Client/GRPCClient/state.ts

@@ -36,6 +36,8 @@ import { StateQueryResponseType } from "../../../types/state/StateQueryResponse.
 import { StateGetBulkOptions } from "../../../types/state/StateGetBulkOptions.type";
 import { Settings } from "../../../utils/Settings.util";
 import { addMetadataToMap } from "../../../utils/Client.util";
+import { StateSaveResponseType } from "../../../types/state/StateSaveResponseType";
+import { StateSaveOptions } from "../../../types/state/StateSaveOptions.type";
 
 // https://docs.dapr.io/reference/api/state_api/
 export default class GRPCClientState implements IClientState {
@@ -45,7 +47,11 @@ export default class GRPCClientState implements IClientState {
     this.client = client;
   }
 
-  async save(storeName: string, stateObjects: KeyValuePairType[]): Promise<void> {
+  async save(
+    storeName: string,
+    stateObjects: KeyValuePairType[],
+    options: StateSaveOptions = {},
+  ): Promise<StateSaveResponseType> {
     const stateList: StateItem[] = [];
 
     for (const stateObject of stateObjects) {
@@ -57,6 +63,11 @@ export default class GRPCClientState implements IClientState {
           "utf-8",
         ),
       );
+      // Merge metadata from stateObject and options.
+      // Note, metadata from options will override metadata from stateObject.
+      // See https://github.com/dapr/dapr/blob/029ec8cb7a1c88ec5d222bc2b0d1d53541217f19/pkg/http/api.go#L1525-L1532
+      addMetadataToMap(si.getMetadataMap(), stateObject.metadata);
+      addMetadataToMap(si.getMetadataMap(), options.metadata);
       stateList.push(si);
     }
 
@@ -69,11 +80,11 @@ export default class GRPCClientState implements IClientState {
     return new Promise((resolve, reject) => {
       client.saveState(msgService, (err, _res) => {
         if (err) {
-          return reject(err);
+          return reject({ error: err });
         }
 
         // https://docs.dapr.io/reference/api/state_api/#response-body
-        return resolve();
+        return resolve({});
       });
     });
   }
@@ -107,7 +118,7 @@ export default class GRPCClientState implements IClientState {
     });
   }
 
-  async getBulk(storeName: string, keys: string[], options: StateGetBulkOptions): Promise<KeyValueType[]> {
+  async getBulk(storeName: string, keys: string[], options: StateGetBulkOptions = {}): Promise<KeyValueType[]> {
     const msgService = new GetBulkStateRequest();
     msgService.setStoreName(storeName);
     msgService.setKeysList(keys);

src/implementation/Client/HTTPClient/state.ts

@@ -22,28 +22,46 @@ import { StateQueryResponseType } from "../../../types/state/StateQueryResponse.
 import { StateGetBulkOptions } from "../../../types/state/StateGetBulkOptions.type";
 import { createHTTPMetadataQueryParam } from "../../../utils/Client.util";
 import { Settings } from "../../../utils/Settings.util";
+import { Logger } from "../../../logger/Logger";
+import { StateSaveResponseType } from "../../../types/state/StateSaveResponseType";
+import { StateSaveOptions } from "../../../types/state/StateSaveOptions.type";
 
 // https://docs.dapr.io/reference/api/state_api/
 export default class HTTPClientState implements IClientState {
   client: HTTPClient;
+  private readonly logger: Logger;
 
   constructor(client: HTTPClient) {
     this.client = client;
+    this.logger = new Logger("HTTPClient", "State", client.options.logger);
   }
 
-  async save(storeName: string, stateObjects: KeyValuePairType[]): Promise<void> {
-    await this.client.execute(`/state/${storeName}`, {
-      method: "POST",
-      body: stateObjects,
-    });
+  async save(
+    storeName: string,
+    stateObjects: KeyValuePairType[],
+    options: StateSaveOptions = {},
+  ): Promise<StateSaveResponseType> {
+    const queryParams = createHTTPMetadataQueryParam(options.metadata);
+
+    try {
+      await this.client.execute(`/state/${storeName}?${queryParams}`, {
+        method: "POST",
+        body: stateObjects,
+      });
+    } catch (e: any) {
+      this.logger.error(`Error saving state to store ${storeName}, error: ${e}`);
+      return { error: e };
+    }
+
+    return {};
   }
 
   async get(storeName: string, key: string): Promise<KeyValueType | string> {
     const result = await this.client.execute(`/state/${storeName}/${key}`);
     return result as KeyValueType;
   }
 
-  async getBulk(storeName: string, keys: string[], options: StateGetBulkOptions): Promise<KeyValueType[]> {
+  async getBulk(storeName: string, keys: string[], options: StateGetBulkOptions = {}): Promise<KeyValueType[]> {
     const queryParams = createHTTPMetadataQueryParam(options.metadata);
 
     const result = await this.client.execute(`/state/${storeName}/bulk?${queryParams}`, {

src/interfaces/Client/IClientState.ts

@@ -18,9 +18,11 @@ import { KeyValueType } from "../../types/KeyValue.type";
 import { StateQueryType } from "../../types/state/StateQuery.type";
 import { StateQueryResponseType } from "../../types/state/StateQueryResponse.type";
 import { StateGetBulkOptions } from "../../types/state/StateGetBulkOptions.type";
+import { StateSaveResponseType } from "../../types/state/StateSaveResponseType";
+import { StateSaveOptions } from "../../types/state/StateSaveOptions.type";
 
 export default interface IClientState {
-  save(storeName: string, stateObjects: KeyValuePairType[]): Promise<void>;
+  save(storeName: string, stateObjects: KeyValuePairType[], options?: StateSaveOptions): Promise<StateSaveResponseType>;
   get(storeName: string, key: string): Promise<KeyValueType | string>;
   getBulk(storeName: string, keys: string[], options?: StateGetBulkOptions): Promise<KeyValueType[]>;
   delete(storeName: string, key: string): Promise<void>;

src/types/state/StateSaveOptions.type.ts

@@ -0,0 +1,21 @@
+/*
+Copyright 2023 The Dapr Authors
+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 { KeyValueType } from "../KeyValue.type";
+
+export type StateSaveOptions = {
+  /**
+   * Metadata to be passed to get save operation.
+   */
+  metadata?: KeyValueType;
+};

src/types/state/StateSaveResponseType.ts

@@ -0,0 +1,20 @@
+/*
+Copyright 2023 The Dapr Authors
+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.
+*/
+
+/**
+ * StateSaveResponseType defines the response from a save request.
+ */
+export type StateSaveResponseType = {
+  // error contains the error if the save request failed.
+  error?: Error;
+};

src/utils/Client.util.ts

@@ -24,6 +24,7 @@ import { PubSubBulkPublishEntry } from "../types/pubsub/PubSubBulkPublishEntry.t
 import { PubSubBulkPublishResponse } from "../types/pubsub/PubSubBulkPublishResponse.type";
 import { PubSubBulkPublishMessage } from "../types/pubsub/PubSubBulkPublishMessage.type";
 import { PubSubBulkPublishApiResponse } from "../types/pubsub/PubSubBulkPublishApiResponse.type";
+
 /**
  * Adds metadata to a map.
  * @param map Input map

test/components/common/state-mongodb.yaml

@@ -0,0 +1,23 @@
+#
+# Copyright 2023 The Dapr Authors
+# 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.
+#
+
+apiVersion: dapr.io/v1alpha1
+kind: Component
+metadata:
+  name: state-mongodb
+spec:
+  type: state.mongodb
+  version: v1
+  metadata:
+    - name: host
+      value: localhost:27017

test/components/common/state-redis.yaml

@@ -0,0 +1,33 @@
+#
+# Copyright 2023 The Dapr Authors
+# 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.
+#
+
+# https://docs.dapr.io/reference/components-reference/supported-bindings/rabbitmq/
+apiVersion: dapr.io/v1alpha1
+kind: Component
+metadata:
+  name: state-redis
+  namespace: default
+spec:
+  type: state.redis
+  version: v1
+  metadata:
+    - name: redisHost
+      value: localhost:6379
+    - name: redisPassword
+      value: ""
+    - name: enableTLS
+      value: "false"
+    - name: failover
+      value: "false"
+    - name: actorStateStore
+      value: "true"