Add State Query API

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

Author: XavierGeerinck

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

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
       })
     });
 

src/implementation/Server/DaprServer.ts

@@ -100,7 +100,7 @@ export default class DaprServer {
   }
 
   async stopServer(): Promise<void> {
-    await this.daprServer.stopServer();
+    await this.daprServer.stop();
   }
 
   getDaprClient(): IServer {

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 = {

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

test/e2e/main.http.test.ts

@@ -341,6 +341,139 @@ describe('http/main', () => {
         expect(resTransactionDelete).toEqual('');
         expect(resTransactionUpsert).toEqual('my-new-data-1');
       });
+
+      it('should be able to query state', async () => {
+        // First save our data
+        await client.state.save("state-mongodb", [
+          {
+            key: 'key-1',
+            value: {
+              person: {
+                id: 1036,
+                org: "Dev Ops"
+              },
+              city: "Seattle",
+              state: "WA"
+            }
+          },
+          {
+            key: 'key-2',
+            value: {
+              person: {
+                id: 1037,
+                org: "Developers"
+              },
+              city: "Seattle",
+              state: "WA"
+            },
+          },
+          {
+            key: 'key-3',
+            value: {
+              person: {
+                id: 1038,
+                org: "Developers"
+              },
+              city: "Seattle",
+              state: "WA"
+            },
+          },
+          {
+            key: 'key-4',
+            value: {
+              person: {
+                id: 1039,
+                org: "Dev Ops"
+              },
+              city: "Spokane",
+              state: "WA"
+            },
+          },
+          {
+            key: 'key-5',
+            value: {
+              person: {
+                id: 1040,
+                org: "Developers"
+              },
+              city: "Seattle",
+              state: "WA"
+            },
+          },
+          {
+            key: 'key-6',
+            value: {
+              person: {
+                id: 1041,
+                org: "Dev Ops"
+              },
+              city: "Seattle",
+              state: "WA"
+            },
+          },
+          {
+            key: 'key-7',
+            value: {
+              person: {
+                id: 1042,
+                org: "Finance"
+              },
+              city: "Brussels",
+              state: "Flemish-Brabant"
+            },
+          },
+          {
+            key: 'key-8',
+            value: {
+              person: {
+                id: 1043,
+                org: "Finance"
+              },
+              city: "San Francisco",
+              state: "CA"
+            },
+          }
+        ]);
+
+        const res = await client.state.query("state-mongodb", {
+          filter: {
+            OR: [
+              {
+                EQ: { "value.person.org": "Dev Ops" }
+              },
+              {
+                "AND": [
+                  {
+                    "EQ": { "value.person.org": "Finance" }
+                  },
+                  {
+                    "IN": { "value.state": ["CA", "WA"] }
+                  }
+                ]
+              }
+            ]
+          },
+          sort: [
+            {
+              key: "value.state",
+              order: "DESC"
+            }
+          ],
+          page: {
+            limit: 10
+          }
+        });
+
+        expect(res.results.length).toEqual(4);
+        expect(res.results.map(i => i.key).indexOf("key-1")).toBeGreaterThan(-1);
+        expect(res.results.map(i => i.key).indexOf("key-4")).toBeGreaterThan(-1);
+        expect(res.results.map(i => i.key).indexOf("key-6")).toBeGreaterThan(-1);
+        expect(res.results.map(i => i.key).indexOf("key-8")).toBeGreaterThan(-1);
+
+        for (let i = 1; i <= 8; i++) {
+          await client.state.delete("state-mongodb", `key-${i}`)
+        }
+      });
     });
   });
 });