fix(actor): Configured the delete operation in the state provider (#486)

* fix(actor): Configured the delete operation in the state provider

Signed-off-by: Ruokun Niu <[email protected]>

* test(actors): added a test for deleting the actor state

Signed-off-by: Ruokun Niu <[email protected]>

* test(actor): fixed the failed test for deleting an actor state

Signed-off-by: Ruokun Niu <[email protected]>

* test(actor): ran pretty-fix

Signed-off-by: Ruokun Niu <[email protected]>

---------

Signed-off-by: Ruokun Niu <[email protected]>
Co-authored-by: Ruokun Niu <[email protected]>

Author: ruokun-niu

src/actors/runtime/StateProvider.ts

@@ -76,7 +76,7 @@ export default class StateProvider {
           operation = "upsert";
           break;
         case StateChangeKind.REMOVE:
-          operation = "remove";
+          operation = "delete";
           break;
         case StateChangeKind.UPDATE:
           // dapr doesn't know add, we use upsert

test/actor/DemoActorDeleteStateImpl.ts

@@ -0,0 +1,33 @@
+/*
+Copyright 2022 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 { AbstractActor } from "../../src";
+import DemoActorDeleteStateInterface from "./DemoActorDeleteStateInterface";
+
+export default class DemoActorDeleteStateImpl extends AbstractActor implements DemoActorDeleteStateInterface {
+  async init(): Promise<string> {
+    await this.getStateManager().getOrAddState("data", "Hello World!");
+
+    return "state initialized";
+  }
+
+  async tryGetState(): Promise<boolean | null> {
+    const [hasValue, _] = await this.getStateManager().tryGetState("data");
+    return hasValue;
+  }
+
+  async deleteState(key: string): Promise<void> {
+    await this.getStateManager().removeState(key);
+    await this.getStateManager().saveState();
+  }
+}

test/actor/DemoActorDeleteStateInterface.ts

@@ -0,0 +1,18 @@
+/*
+Copyright 2022 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.
+*/
+
+export default interface DemoActorCounterInterface {
+  init(): Promise<string>;
+  tryGetState(): Promise<boolean | null>;
+  deleteState(key: string): Promise<void>;
+}

test/e2e/http/actors.test.ts

@@ -29,6 +29,8 @@ import DemoActorTimerImpl from "../../actor/DemoActorTimerImpl";
 import DemoActorTimerInterface from "../../actor/DemoActorTimerInterface";
 import DemoActorTimerTtlImpl from "../../actor/DemoActorTimerTtlImpl";
 import DemoActorReminderTtlImpl from "../../actor/DemoActorReminderTtlImpl";
+import DemoActorDeleteStateImpl from "../../actor/DemoActorDeleteStateImpl";
+import DemoActorDeleteStateInterface from "../../actor/DemoActorDeleteStateInterface";
 
 const serverHost = "127.0.0.1";
 const serverPort = "50001";
@@ -84,6 +86,7 @@ describe("http/actors", () => {
     await server.actor.registerActor(DemoActorActivateImpl);
     await server.actor.registerActor(DemoActorTimerTtlImpl);
     await server.actor.registerActor(DemoActorReminderTtlImpl);
+    await server.actor.registerActor(DemoActorDeleteStateImpl);
 
     // Start server
     await server.start(); // Start the general server, this can take a while
@@ -106,7 +109,7 @@ describe("http/actors", () => {
 
       const config = JSON.parse(await res.text());
 
-      expect(config.entities.length).toBe(8);
+      expect(config.entities.length).toBe(9);
       expect(config.actorIdleTimeout).toBe("1h");
       expect(config.actorScanInterval).toBe("30s");
       expect(config.drainOngoingCallTimeout).toBe("1m");
@@ -152,11 +155,27 @@ describe("http/actors", () => {
     });
   });
 
+  describe("deleteActorState", () => {
+    it("should be able to delete actor state", async () => {
+      const builder = new ActorProxyBuilder<DemoActorDeleteStateInterface>(DemoActorDeleteStateImpl, client);
+      const actor = builder.build(ActorId.createRandomId());
+      await actor.init();
+
+      const res = await actor.tryGetState();
+      expect(res).toEqual(true);
+
+      await actor.deleteState("data");
+
+      const deletedRes = await actor.tryGetState();
+      console.log(deletedRes);
+      expect(deletedRes).toEqual(false);
+    });
+  });
   describe("invoke", () => {
     it("should register actors correctly", async () => {
       const actors = await server.actor.getRegisteredActors();
 
-      expect(actors.length).toEqual(8);
+      expect(actors.length).toEqual(9);
 
       expect(actors).toContain(DemoActorCounterImpl.name);
       expect(actors).toContain(DemoActorSayImpl.name);