feat: add Metadata field to the State Save operation (#323)

* WIP on adding metadata

Signed-off-by: Xavier Geerinck <[email protected]>

* Add tests for state change

Signed-off-by: Xavier Geerinck <[email protected]>

Author: XavierGeerinck

src/types/KeyValuePair.type.ts

@@ -11,7 +11,12 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-export type KeyValuePairType= {
+import { KeyValueType } from "./KeyValue.type";
+
+export type KeyValuePairType = {
   key: string;
   value: any;
+  etag?: string;
+  metadata?: KeyValueType;
+  options?: object;
 }

test/e2e/grpc/client.test.ts

@@ -158,6 +158,12 @@ describe('grpc/client', () => {
   });
 
   describe('state', () => {
+    beforeEach(async () => {
+      await client.state.delete("state-redis", "key-1");
+      await client.state.delete("state-redis", "key-2");
+      await client.state.delete("state-redis", "key-3");
+    });
+
     it('should be able to save the state', async () => {
       await client.state.save('state-redis', [
         {
@@ -178,6 +184,34 @@ describe('grpc/client', () => {
       expect(res).toEqual('value-1');
     });
 
+    it('should be able to add metadata, etag and options', async () => {
+      await client.state.save('state-redis', [
+        {
+          key: 'key-1',
+          value: 'value-1',
+          etag: "1234",
+          options: {
+            "concurrency": "first-write",
+            "consistency": "strong"
+          },
+          metadata: {
+            hello: "world"
+          }
+        },
+        {
+          key: 'key-2',
+          value: 'value-2',
+        },
+        {
+          key: 'key-3',
+          value: 'value-3',
+        },
+      ]);
+
+      const res = await client.state.get('state-redis', 'key-1');
+      expect(res).toEqual('value-1');
+    });
+
     it('should be able to get the state in bulk', async () => {
       await client.state.save('state-redis', [
         {
@@ -272,6 +306,35 @@ describe('grpc/client', () => {
       expect(resTransactionDelete).toEqual('');
       expect(resTransactionUpsert).toEqual('my-new-data-with-metadata-1');
     });
+
+    it('should be able to add metadata, etag and options', async () => {
+      await client.state.save('state-redis', [
+        {
+          key: 'key-1',
+          value: 'value-1',
+          etag: "1234",
+          options: {
+            "concurrency": "first-write",
+            "consistency": "strong"
+          },
+          metadata: {
+            hello: "world"
+          }
+        },
+        {
+          key: 'key-2',
+          value: 'value-2',
+        },
+        {
+          key: 'key-3',
+          value: 'value-3',
+        },
+      ]);
+
+      const res = await client.state.get('state-redis', 'key-1');
+      expect(res).toEqual('value-1');
+      console.log(res);
+    });
   });
 
   describe('configuration', () => {

test/e2e/http/client.test.ts

@@ -90,6 +90,12 @@ describe('http/client', () => {
   });
 
   describe('state', () => {
+    beforeEach(async () => {
+      await client.state.delete("state-redis", "key-1");
+      await client.state.delete("state-redis", "key-2");
+      await client.state.delete("state-redis", "key-3");
+    });
+
     it('should be able to save the state', async () => {
       await client.state.save('state-redis', [
         {
@@ -110,6 +116,34 @@ describe('http/client', () => {
       expect(res).toEqual('value-1');
     });
 
+    it('should be able to add metadata, etag and options', async () => {
+      await client.state.save('state-redis', [
+        {
+          key: 'key-1',
+          value: 'value-1',
+          etag: "1234",
+          options: {
+            "concurrency": "first-write",
+            "consistency": "strong"
+          },
+          metadata: {
+            hello: "world"
+          }
+        },
+        {
+          key: 'key-2',
+          value: 'value-2',
+        },
+        {
+          key: 'key-3',
+          value: 'value-3',
+        },
+      ]);
+
+      const res = await client.state.get('state-redis', 'key-1');
+      expect(res).toEqual('value-1');
+    });
+
     it('should be able to get the state in bulk', async () => {
       await client.state.save('state-redis', [
         {