Merge pull request #272 from XavierGeerinck/issue_268

feat: Implement `await client.start()` to ensure sidecar has started

Author: XavierGeerinck

README.md

@@ -52,15 +52,13 @@ const daprPort = "50000"; // Dapr Sidecar Port
 const serverHost = "127.0.0.1"; // App Host of this Example Server
 const serverPort = "50001"; // App Port of this Example Server
 
-// Create a Server (will subscribe) and Client (will publish)
+// Create a Server (will subscribe)
 const server = new DaprServer(serverHost, serverPort, daprHost, daprPort);
-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.start();
 
-// Send a message
+// Create a Client (will publish)
+const client = new DaprClient(daprHost, daprPort);
 await client.pubsub.publish("my-pubsub-component", "my-topic", { hello: "world" });
 ```
 

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

@@ -347,10 +347,7 @@ const daprAppId = "example-config";
 
 async function start() {
 
-  const client = new DaprClient(
-    daprHost,
-    process.env.DAPR_HTTP_PORT
-  );
+  const client = new DaprClient(daprHost, process.env.DAPR_HTTP_PORT);
 
   const config = await client.configuration.get('config-store', ['key1', 'key2']);
   console.log(config);

documentation/development.md

@@ -44,11 +44,10 @@ npm run test:unit:main
 npm run test:unit:actors
 
 # Start gRPC tests
-npm run test:e2e:grpc:main
+npm run test:e2e:grpc
 
 # Start HTTP tests
-npm run test:e2e:http:main
-npm run test:e2e:http:actors
+npm run test:e2e:http
 ```
 
 ## Publishing

examples/configuration/src/index.ts

@@ -17,7 +17,6 @@ const daprHost = "127.0.0.1";
 const daprPortDefault = "3500";
 
 async function start() {
-
   const client = new DaprClient(
     daprHost,
     process.env.DAPR_HTTP_PORT ?? daprPortDefault

package-lock.json

@@ -6,12 +6,12 @@
     "scripts": {
         "test": "npm run test:unit:all && npm run test:e2e:all",
         "test:load": "jest --runInBand --detectOpenHandles",
-        "test:load:http": "TEST_SECRET_1=secret_val_1 TEST_SECRET_2=secret_val_2 dapr run --app-id test-suite --app-protocol http --app-port 50001 --dapr-http-port 50000 --components-path ./test/components npm run test:load 'test/load'",
+        "test:load:http": "TEST_SECRET_1=secret_val_1 TEST_SECRET_2=secret_val_2 dapr run --app-id test-suite --app-protocol http --app-port 50001 --dapr-http-port 50000 --components-path ./test/components -- npm run test:load 'test/load'",
         "test:e2e": "jest --runInBand --detectOpenHandles",
-        "test:e2e:all": "npm run test:e2e:grpc:main && npm run test:e2e:http:main && npm run test:e2e:http:actors",
-        "test:e2e:grpc:main": "TEST_SECRET_1=secret_val_1 TEST_SECRET_2=secret_val_2 dapr run --app-id test-suite --app-protocol grpc --app-port 50001 --dapr-grpc-port 50000 --components-path ./test/components npm run test:e2e 'test/e2e/main.grpc.test.ts'",
-        "test:e2e:http:main": "TEST_SECRET_1=secret_val_1 TEST_SECRET_2=secret_val_2 dapr run --app-id test-suite --app-protocol http --app-port 50001 --dapr-http-port 50000 --components-path ./test/components npm run test:e2e 'test/e2e/main.http.test.ts'",
-        "test:e2e:http:actors": "dapr run --app-id test-suite --app-protocol http --app-port 50001 --dapr-http-port 50000 --components-path ./test/components npm run test:e2e 'test/e2e/actors.http.test.ts'",
+        "test:e2e:all": "npm run test:e2e:grpc && npm run test:e2e:http && npm run test:e2e:http:actors",
+        "test:e2e:grpc": "TEST_SECRET_1=secret_val_1 TEST_SECRET_2=secret_val_2 dapr run --app-id test-suite --app-protocol grpc --app-port 50001 --dapr-grpc-port 50000 --components-path ./test/components -- jest --runInBand --detectOpenHandles --testMatch [ '**/test/e2e/grpc/(client|server).test.ts' ]",
+        "test:e2e:http": "TEST_SECRET_1=secret_val_1 TEST_SECRET_2=secret_val_2 dapr run --app-id test-suite --app-protocol http --app-port 50001 --dapr-http-port 50000 --components-path ./test/components -- jest --runInBand --detectOpenHandles --testMatch [ '**/test/e2e/http/(client|server).test.ts' ]",
+        "test:e2e:http:actors": "TEST_SECRET_1=secret_val_1 TEST_SECRET_2=secret_val_2 dapr run --app-id test-suite --app-protocol http --app-port 50001 --dapr-http-port 50000 --components-path ./test/components -- jest --runInBand --detectOpenHandles --testMatch [ '**/test/e2e/http/actors.test.ts' ]",
         "test:unit": "jest --runInBand --detectOpenHandles",
         "test:unit:all": "npm run test:unit:main && npm run test:unit:actors && npm run test:unit:utils",
         "test:unit:main": "NODE_ENV=test npm run test:unit 'test/unit/main/.*\\.test\\.ts'",

package.json

@@ -15,9 +15,8 @@
 
 # Start gRPC tests
 echo "Running gRPC tests"
-npm run test:e2e:grpc:main
+npm run test:e2e:grpc
 
 # Start HTTP tests
 echo "Running HTTP tests"
-npm run test:e2e:http:main
-npm run test:e2e:http:actors
+npm run test:e2e:http

scripts/test-e2e.sh

@@ -10,6 +10,7 @@ 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 * as NodeJSUtils from "../../utils/NodeJS.util";
 
 import IClientBinding from '../../interfaces/Client/IClientBinding';
 import IClientPubSub from '../../interfaces/Client/IClientPubSub';
@@ -133,6 +134,45 @@ export default class DaprClient {
     await this.daprClient.stop();
   }
 
+  async awaitSidecarStarted(): Promise<void> {
+    // Dapr will probe every 50ms to see if we are listening on our port: https://github.com/dapr/dapr/blob/a43712c97ead550ca2f733e9f7e7769ecb195d8b/pkg/runtime/runtime.go#L1694
+    // if we are using actors we will change this to 4s to let the placement tables update
+    let isHealthy = false;
+    let isHealthyRetryCount = 0;
+    const isHealthyMaxRetryCount = 60; // 1s startup delay and we try max for 60s
+
+    console.log(`[Dapr-JS][Client] Awaiting Sidecar to be Started`);
+    while (!isHealthy) {
+      console.log(`[Dapr-JS][Client] Waiting till Dapr Sidecar Started (#${isHealthyRetryCount})`);
+      await NodeJSUtils.sleep(Settings.getDaprSidecarPollingDelayMs());
+
+      // Implement API call manually as we need to enable calling without initialization
+      // everything routes through the `execute` method
+      // to check health, we just ping the /metadata endpoint and see if we get a response
+      isHealthy = await this.health.isHealthy();
+
+      // Finally, Handle the retry logic
+      isHealthyRetryCount++;
+
+      if (isHealthyRetryCount > isHealthyMaxRetryCount) {
+        throw new Error("DAPR_SIDECAR_COULD_NOT_BE_STARTED");
+      }
+    }
+  }
+
+  /**
+   * Ensure the client is started, this takes care of:
+   * 1. Making sure the sidecar is started
+   * 2. Making sure the connection is established (e.g. in gRPC)
+   * 3. Making sure the client is ready to be used
+   */
+  async start(): Promise<void> {
+    await this.awaitSidecarStarted();
+    await this.daprClient.start();
+    await this.daprClient.setIsInitialized(true);
+    console.log(`[Dapr-JS][Client] Sidecar Started`);
+  }
+
   getDaprClient(): IClient {
     return this.daprClient;
   }

scripts/test-init.sh

@@ -12,14 +12,15 @@ limitations under the License.
 */
 
 import * as grpc from "@grpc/grpc-js";
-import { ChannelCredentials } from "@grpc/grpc-js";
 import { DaprClient } from "../../../proto/dapr/proto/runtime/v1/dapr_grpc_pb"
 import IClient from "../../../interfaces/Client/IClient";
 import CommunicationProtocolEnum from "../../../enum/CommunicationProtocol.enum";
 import { DaprClientOptions } from "../../../types/DaprClientOptions";
 import { Settings } from '../../../utils/Settings.util';
 
 export default class GRPCClient implements IClient {
+  private isInitialized: boolean;
+
   private readonly client: DaprClient;
   private readonly clientCredentials: grpc.ChannelCredentials;
   private readonly clientHost: string;
@@ -35,8 +36,9 @@ export default class GRPCClient implements IClient {
   ) {
     this.clientHost = host;
     this.clientPort = port;
-    this.clientCredentials = ChannelCredentials.createInsecure();
+    this.clientCredentials = grpc.ChannelCredentials.createInsecure();
     this.options = options;
+    this.isInitialized = false;
 
     console.log(`[Dapr-JS][gRPC] Opening connection to ${this.clientHost}:${this.clientPort}`);
     this.client = new DaprClient(`${this.clientHost}:${this.clientPort}`, this.clientCredentials);
@@ -62,7 +64,30 @@ export default class GRPCClient implements IClient {
     return this.options;
   }
 
+  setIsInitialized(isInitialized: boolean): void {
+    this.isInitialized = isInitialized;
+  }
+
   async stop(): Promise<void> {
     this.client.close();
   }
+
+  async _startWaitForClientReady(): Promise<void> {
+    const deadline = Date.now() + Settings.getDaprSidecarStartupTimeoutMs();
+
+    return new Promise((resolve, reject) => {
+      this.client.waitForReady(deadline, (err?) => {
+        if (err) {
+          console.error(err);
+          return reject();
+        }
+
+        return resolve();
+      });
+    })
+  }
+
+  async start(): Promise<void> {
+    await this._startWaitForClientReady();
+  }
 }