Merge pull request #137 from XavierGeerinck/master

feat(actors): implement actor proxy object and remove actor access remotely

Author: XavierGeerinck

CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+## 2.x release
+
+### v2.0.0
+
+Version 2.0.0 brings a lot of changes to the Dapr JS SDK that were long due. Below an overview of the major contributions can be found, with a more detailed overview of the **Breaking Changes** under it.
+
+* Actor Support has been added
+* Actor Proxy has been added for Actor Access
+* The HTTP Connection is now being reused to reduce the CONNRESET errors when intensively using the JS SDK 
+
+#### Breaking Changes
+
+* `DaprServer.ts`: `startServer()`, `stopServer()` have been renamed to `start()` and `stop()` this means that `await server.startServer()` will now be called as `await server.start()`
+* `DaprServer.ts`: `close()` has been removed in favor of `stop()`
+
+#### Major Changes
+
+* KeepAlive for HTTP has been added and a new method in the `DaprClient` has been added named `stop()` to stop the client and release the connections kept by the sockets.
+
+## 1.x release

README.md

@@ -54,7 +54,7 @@ const client = new DaprClient(daprHost, daprPort);
 
 // Initialize the server to subscribe (listen)
 await server.pubsub.subscribe("my-pubsub-component", "my-topic", async (data: any) => console.log(`Received: ${JSON.stringify(data)}`));
-await server.startServer();
+await server.start();
 
 // Send a message
 await client.pubsub.publish("my-pubsub-component", "my-topic", { hello: "world" });

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

@@ -71,7 +71,7 @@ async function start() {
 
   await server.actor.init(); // Let the server know we need actors
   server.actor.registerActor(ParkingSensorImpl); // Register the actor
-  await server.startServer(); // Start the server
+  await server.start(); // Start the server
 }
 ```                                              
 
@@ -88,7 +88,7 @@ async function start() {
 
   await server.actor.init(); 
   server.actor.registerActor(ParkingSensorImpl); 
-  await server.startServer();
+  await server.start();
 
 
   await client.actor.invoke("PUT", ParkingSensorImpl.name, `actor-id`, "carEnter"); // Invoke the ParkingSensor Actor by calling the carEnter function
@@ -107,7 +107,7 @@ async function start() {
 
   await server.actor.init(); 
   server.actor.registerActor(ParkingSensorImpl); 
-  await server.startServer();
+  await server.start();
 
   // Perform state transaction
   await client.actor.stateTransaction("ParkingSensorImpl", `actor-id`, [
@@ -152,7 +152,7 @@ async function start()
 
   await server.actor.init(); 
   server.actor.registerActor(ParkingSensorImpl); 
-  await server.startServer();
+  await server.start();
 
   // Register a timer
   await client.actor.timerCreate(ParkingSensorImpl.name, `actor-id`, `timer-id`, {
@@ -177,7 +177,7 @@ async function start()
 
   await server.actor.init(); 
   server.actor.registerActor(ParkingSensorImpl); 
-  await server.startServer();
+  await server.start();
 
 
   // Register a reminder, it has a default callback

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

@@ -41,7 +41,7 @@ const client = new DaprClient(daprHost, daprPort, CommunicationProtocolEnum.GRPC
 A library that provides methods for how an application communicates with the Dapr sidecar.
 
 ##### DaprServer Library
-A library for how an application registers bindings / routes with Dapr. The `startServer()` method is used to start the server and bind the routes. 
+A library for how an application registers bindings / routes with Dapr. The `start()` method is used to start the server and bind the routes. 
 
 ## Building blocks
 
@@ -165,7 +165,7 @@ async function start() {
   // Configure Subscriber for a Topic
   await server.pubsub.subscribe(pubSubName, topic, async (data: any) => console.log(`Got Data: ${JSON.stringify(data)}`));
 
-  await server.startServer();
+  await server.start();
 }
 ```
 
@@ -207,7 +207,7 @@ async function start() {
 
   const response = await server.binding.receive(bindingName, async (data: any) => console.log(`Got Data: ${JSON.stringify(data)}`));
 
-  await server.startServer();
+  await server.start();
 }
 ```
 

examples/grpc/hello-world-distributed/server/src/index.ts

@@ -7,7 +7,7 @@ const serverPort = "50051"; // App Port of this Example Server
 
 async function start() {
   const server = new DaprServer(serverHost, serverPort, daprHost, daprPort, CommunicationProtocolEnum.GRPC);
-  await server.startServer();
+  await server.start();
 
   await server.invoker.listen("hello-world", async (data: any) => {
     console.log("[Dapr-JS][Example] Received Hello World Method Call");
@@ -18,6 +18,6 @@ async function start() {
 }
 
 start().catch((e) => {
-    console.error(e);
-    process.exit(1);
+  console.error(e);
+  process.exit(1);
 });

examples/grpc/hello-world/src/index.ts

@@ -27,7 +27,7 @@ async function start() {
   // We initialize after registering our listeners since these should be defined upfront
   // this is how Dapr works, it waits until we are listening on the port. Once that is detected
   // it will scan the binding list and pubsub subscriptions list to process
-  await server.startServer();
+  await server.start();
 
   console.log("===============================================================");
   console.log("EXECUTING CLIENT -INVOKER")
@@ -94,7 +94,7 @@ async function start() {
   const resState = await client.state.get("state-redis", "key-1");
   console.log(`[Dapr-JS][Example][State] Fetched State: ${JSON.stringify(resState)}`);
 
-  const resStateBulk = await client.state.getBulk("state-redis", [ "key-3", "key-2"]);
+  const resStateBulk = await client.state.getBulk("state-redis", ["key-3", "key-2"]);
   console.log(`[Dapr-JS][Example][State] Fetched State Bulk: ${JSON.stringify(resStateBulk)}`);
 
   await client.state.delete("state-redis", "key-2");

examples/http/actor-parking-sensor/src/index.ts

@@ -19,7 +19,7 @@ async function start() {
   console.log("===============================================================");
   await server.actor.init(); // Let the server know we need actors
   server.actor.registerActor(ParkingSensorImpl); // Register the actor
-  await server.startServer(); // Start the server
+  await server.start(); // Start the server
 
   console.log("===============================================================");
   console.log("CLIENT EXECUTION");

examples/http/actor/src/index.ts

@@ -31,7 +31,7 @@ async function start() {
   // We initialize after registering our listeners since these should be defined upfront
   // this is how Dapr works, it waits until we are listening on the port. Once that is detected
   // it will scan the binding list and pubsub subscriptions list to process
-  await server.startServer();
+  await server.start();
 
   console.log("===============================================================");
   console.log("EXECUTING CLIENT - ACTORS");

examples/http/pubsub/src/index.ts

@@ -13,7 +13,7 @@ async function start() {
 
   // Initialize the server to subscribe (listen)
   await server.pubsub.subscribe("my-pubsub-component", "my-topic", async (data: any) => console.log(`Received: ${JSON.stringify(data)}`));
-  await server.startServer();
+  await server.start();
 
   // Send a message
   await client.pubsub.publish("my-pubsub-component", "my-topic", { hello: "world" });

examples/invocation/src/index.ts

@@ -3,27 +3,27 @@ import { DaprServer, DaprClient, HttpMethod, CommunicationProtocolEnum } from "d
 // Common settings
 const daprAppId = "example-invocation";
 const serverHost = "127.0.0.1"; // App Host of this Example Server
-const daprHost = "127.0.0.1"; 
+const daprHost = "127.0.0.1";
 const serverPort = "50051"; // App Port of this Example Server
 
 async function start() {
   // Note that the DAPR_HTTP_PORT and DAPR_GRPC_PORT environment variables are set by DAPR itself. https://docs.dapr.io/reference/environment/
   const server = new DaprServer(
-    serverHost, 
-    serverPort, 
-    daprHost, 
-    process.env.DAPR_HTTP_PORT, 
+    serverHost,
+    serverPort,
+    daprHost,
+    process.env.DAPR_HTTP_PORT,
     CommunicationProtocolEnum.HTTP
   );
 
   const client = new DaprClient(
-    daprHost, 
-    process.env.DAPR_HTTP_PORT as string, 
+    daprHost,
+    process.env.DAPR_HTTP_PORT as string,
     CommunicationProtocolEnum.HTTP
   );
 
-  // Note that invoker listeners can be set up after startServer() has been called
-  await server.startServer();
+  // Note that invoker listeners can be set up after start() has been called
+  await server.start();
 
   console.log("Setting up invocation endpoints")
   await server.invoker.listen("hello-world", async (data: Record<string, any>) => {