Merge pull request #150 from XavierGeerinck/master

XavierGeerinck · web-flow · commit e74840819f44 · 2022-01-13T19:48:43.000+01:00
feat(state): Add State Query API
diff --git a/documentation/development.md b/documentation/development.md
@@ -36,6 +36,9 @@ Tests are written per protocol layer: http or grpc. This is done because Dapr re
 # Ports: 1883 = TCP MQTT Port | 8081 = HTTP API | 8083 = MQTT/SSL Port | 8883 = MQTT/Websocket/SSL Port | 8084 = MQTT/Websocket Port | 18083 = Dashboard
 docker run -d --rm --name emqx -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx
 
+# Start MongoDB for State Query
+docker run -d --rm --name mongodb -p 27017:27017 mongo
+
 # Run Unit Tests
 npm run test:unit:main
 npm run test:unit:actors
diff --git a/src/implementation/Client/GRPCClient/state.ts b/src/implementation/Client/GRPCClient/state.ts
@@ -197,7 +197,7 @@ export default class GRPCClientState implements IClientState {
 
         // https://docs.dapr.io/reference/api/state_api/#response-body
         // map the res from gRPC 
-        let resMapped: StateQueryResponseType = {
+        const resMapped: StateQueryResponseType = {
           results: res.getResultsList().map((i) => ({
             key: i.getKey(),
             data: i.getData(),
diff --git a/src/implementation/Client/HTTPClient/HTTPClient.ts b/src/implementation/Client/HTTPClient/HTTPClient.ts
@@ -73,7 +73,7 @@ export default class HTTPClient implements IClient {
     this.httpsAgent.destroy();
   }
 
-  async executeWithApiVersion(apiVersion: string = "v1.0", url: string, params: any = {}): Promise<object | string> {
+  async executeWithApiVersion(apiVersion = "v1.0", url: string, params: any = {}): Promise<object | string> {
     const newClientUrl = this.clientUrl.replace("v1.0", apiVersion);
     return await this.execute(`${newClientUrl}${url}`, params);
   }
diff --git a/src/implementation/Client/HTTPClient/state.ts b/src/implementation/Client/HTTPClient/state.ts
@@ -71,7 +71,7 @@ export default class HTTPClientState implements IClientState {
         "Content-Type": "application/json"
       },
       body: JSON.stringify({
-        query
+        ...query
       })
     });
 
diff --git a/src/implementation/Server/DaprServer.ts b/src/implementation/Server/DaprServer.ts
@@ -99,10 +99,6 @@ export default class DaprServer {
     await this.daprServer.stop();
   }
 
-  async stopServer(): Promise<void> {
-    await this.daprServer.stopServer();
-  }
-
   getDaprClient(): IServer {
     return this.daprServer;
   }
diff --git a/src/implementation/Server/GRPCServer/GRPCServer.ts b/src/implementation/Server/GRPCServer/GRPCServer.ts
@@ -77,7 +77,7 @@ export default class GRPCServer implements IServer {
     // if we are using actors we will change this to 4s to let the placement tables update
     let isHealthy = false;
     let isHealthyRetryCount = 0;
-    let isHealthyMaxRetryCount = 60; // 1s startup delay and we try max for 60s
+    const isHealthyMaxRetryCount = 60; // 1s startup delay and we try max for 60s
 
     console.log(`[Dapr-JS] Letting Dapr pick-up the server (Maximum 60s wait time)`);
     while (!isHealthy) {
diff --git a/src/implementation/Server/HTTPServer/HTTPServer.ts b/src/implementation/Server/HTTPServer/HTTPServer.ts
@@ -104,7 +104,7 @@ export default class HTTPServer implements IServer {
     // if we are using actors we will change this to 4s to let the placement tables update
     let isHealthy = false;
     let isHealthyRetryCount = 0;
-    let isHealthyMaxRetryCount = 60; // 1s startup delay and we try max for 60s
+    const isHealthyMaxRetryCount = 60; // 1s startup delay and we try max for 60s
 
     console.log(`[Dapr-JS] Letting Dapr pick-up the server (Maximum 60s wait time)`);
     while (!isHealthy) {
diff --git a/src/types/StateQuery.type.ts b/src/types/StateQuery.type.ts
@@ -3,7 +3,7 @@ import { Enumerable } from "./Enumerable.type"
 export type StateQueryType = {
   filter: StateQueryFilter;
   sort: StateQuerySort[];
-  pagination: StateQueryPagination;
+  page: StateQueryPagination;
 }
 
 type StateQuerySort = {
diff --git a/test/components/state-mongodb.yaml b/test/components/state-mongodb.yaml
@@ -0,0 +1,10 @@
+apiVersion: dapr.io/v1alpha1
+kind: Component
+metadata:
+  name: state-mongodb
+spec:
+  type: state.mongodb
+  version: v1
+  metadata:
+  - name: host
+    value: localhost:27017
diff --git a/test/e2e/main.grpc.test.ts b/test/e2e/main.grpc.test.ts
@@ -205,165 +205,52 @@ describe('grpc/main', () => {
       expect(res).toEqual('');
     });
 
-    describe('state', () => {
-      it('should be able to save the state', async () => {
-        await client.state.save('state-redis', [
-          {
-            key: 'key-1',
-            value: 'value-1',
-          },
-          {
-            key: 'key-2',
-            value: 2,
-          },
-          {
-            key: 'key-3',
-            value: true,
-          },
-          {
-            key: 'key-4',
-            value: {
-              nested: {
-                str: 'string',
-                num: 123,
-              },
-            },
-          },
-        ]);
-
-        const res = await Promise.all([
-          client.state.get('state-redis', 'key-1'),
-          client.state.get('state-redis', 'key-2'),
-          client.state.get('state-redis', 'key-3'),
-          client.state.get('state-redis', 'key-4'),
-        ]);
-
-        expect(res).toEqual([
-          'value-1',
-          2,
-          true,
-          {
-            nested: {
-              str: 'string',
-              num: 123,
-            },
-          },
-        ]);
-      });
-
-      it('should be able to get the state in bulk', async () => {
-        await client.state.save('state-redis', [
-          {
-            key: 'key-1',
-            value: 'value-1',
-          },
-          {
-            key: 'key-2',
-            value: 2,
-          },
-          {
-            key: 'key-3',
-            value: true,
-          },
-          {
-            key: 'key-4',
-            value: {
-              nested: {
-                str: 'string',
-                num: 123,
-              },
-            },
-          },
-        ]);
-
-        const res = await client.state.getBulk('state-redis', ['key-3', 'key-2', 'key-1', 'key-4']);
-
-        expect(res).toEqual(
-          expect.arrayContaining([
-            expect.objectContaining({ key: 'key-1', data: 'value-1' }),
-            expect.objectContaining({ key: 'key-2', data: 2 }),
-            expect.objectContaining({ key: 'key-3', data: true }),
-            expect.objectContaining({
-              key: 'key-4',
-              data: {
-                nested: {
-                  str: 'string',
-                  num: 123,
-                },
-              },
-            }),
-          ]),
-        );
-      });
-
-      it('should be able to delete a key from the state store', async () => {
-        await client.state.save('state-redis', [
-          {
+    it('should be able to perform a transaction that replaces a key and deletes another', async () => {
+      await client.state.transaction('state-redis', [
+        {
+          operation: 'upsert',
+          request: {
             key: 'key-1',
-            value: 'value-1',
-          },
-          {
-            key: 'key-2',
-            value: 'value-2',
+            value: 'my-new-data-1',
           },
-          {
+        },
+        {
+          operation: 'delete',
+          request: {
             key: 'key-3',
-            value: 'value-3',
           },
-        ]);
+        },
+      ]);
 
-        await client.state.delete('state-redis', 'key-2');
-        const res = await client.state.get('state-redis', 'key-2');
-        expect(res).toEqual('');
-      });
+      const resTransactionDelete = await client.state.get('state-redis', 'key-3');
+      const resTransactionUpsert = await client.state.get('state-redis', 'key-1');
+      expect(resTransactionDelete).toEqual('');
+      expect(resTransactionUpsert).toEqual('my-new-data-1');
+    });
 
-      it('should be able to perform a transaction that replaces a key and deletes another', async () => {
-        await client.state.transaction('state-redis', [
-          {
-            operation: 'upsert',
-            request: {
-              key: 'key-1',
-              value: 'my-new-data-1',
-            },
+    it('should be able to perform a transaction with metadata', async () => {
+      await client.state.transaction('state-redis', [
+        {
+          operation: 'upsert',
+          request: {
+            key: 'key-with-metadata-1',
+            value: 'my-new-data-with-metadata-1',
           },
-          {
-            operation: 'delete',
-            request: {
-              key: 'key-3',
-            },
+        },
+        {
+          operation: 'delete',
+          request: {
+            key: 'key-with-metadata-2',
           },
-        ]);
-
-        const resTransactionDelete = await client.state.get('state-redis', 'key-3');
-        const resTransactionUpsert = await client.state.get('state-redis', 'key-1');
-        expect(resTransactionDelete).toEqual('');
-        expect(resTransactionUpsert).toEqual('my-new-data-1');
+        },
+      ], {
+        trace_id: 'mock trace id here',
       });
 
-      it('should be able to perform a transaction with metadata', async () => {
-        await client.state.transaction('state-redis', [
-          {
-            operation: 'upsert',
-            request: {
-              key: 'key-with-metadata-1',
-              value: 'my-new-data-with-metadata-1',
-            },
-          },
-          {
-            operation: 'delete',
-            request: {
-              key: 'key-with-metadata-2',
-            },
-          },
-        ], {
-          trace_id: 'mock trace id here',
-        });
-
-        const resTransactionDelete = await client.state.get('state-redis', 'key-with-metadata-2');
-        const resTransactionUpsert = await client.state.get('state-redis', 'key-with-metadata-1');
-        expect(resTransactionDelete).toEqual('');
-        expect(resTransactionUpsert).toEqual('my-new-data-with-metadata-1');
-      });
+      const resTransactionDelete = await client.state.get('state-redis', 'key-with-metadata-2');
+      const resTransactionUpsert = await client.state.get('state-redis', 'key-with-metadata-1');
+      expect(resTransactionDelete).toEqual('');
+      expect(resTransactionUpsert).toEqual('my-new-data-with-metadata-1');
     });
   });
 
diff --git a/test/e2e/main.http.test.ts b/test/e2e/main.http.test.ts
diff --git a/test/load/pubsub.http.test.ts b/test/load/pubsub.http.test.ts
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ export default class HTTPClient implements IClient {`
`73`	`73`	`this.httpsAgent.destroy();`
`74`	`74`	`}`
`75`	`75`
`76`		`- async executeWithApiVersion(apiVersion: string = "v1.0", url: string, params: any = {}): Promise<object \| string> {`
	`76`	`+ async executeWithApiVersion(apiVersion = "v1.0", url: string, params: any = {}): Promise<object \| string> {`
`77`	`77`	`const newClientUrl = this.clientUrl.replace("v1.0", apiVersion);`
`78`	`78`	return await this.execute(`${newClientUrl}${url}`, params);
`79`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -99,10 +99,6 @@ export default class DaprServer {`
`99`	`99`	`await this.daprServer.stop();`
`100`	`100`	`}`
`101`	`101`
`102`		`- async stopServer(): Promise<void> {`
`103`		`- await this.daprServer.stopServer();`
`104`		`- }`
`105`		`-`
`106`	`102`	`getDaprClient(): IServer {`
`107`	`103`	`return this.daprServer;`
`108`	`104`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ import { Enumerable } from "./Enumerable.type"`
`3`	`3`	`export type StateQueryType = {`
`4`	`4`	`filter: StateQueryFilter;`
`5`	`5`	`sort: StateQuerySort[];`
`6`		`- pagination: StateQueryPagination;`
	`6`	`+ page: StateQueryPagination;`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`type StateQuerySort = {`