Merge branch 'master' into shubham1172/customizable-logging

Author: shubham1172

README.md

@@ -1,83 +1,70 @@
-[![Discord](https://img.shields.io/discord/778680217417809931)]()
-[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/dapr/js-sdk/blob/master/LICENSE)
-[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B162%2Fgithub.com%2Fdapr%2Fcomponents-contrib.svg?type=shield)](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fdapr%2Fcomponents-contrib?ref=badge_shield)
+<p align="center">
+  <a href="https://dapr.io">
+    <img src="https://dapr.io/images/dapr.svg" height="128">
+    <h1 align="center">Dapr</h1>
+  </a>
+</p>
+
+<p align="center">
+  <a aria-label="NPM version" href="https://www.npmjs.com/package/@dapr/dapr">
+    <img alt="" src="https://img.shields.io/npm/v/@dapr/dapr?style=for-the-badge&labelColor=000000">
+  </a>
+  <a aria-label="License" href="https://github.com/dapr/js-sdk/blob/master/LICENSE">
+    <img alt="" src="https://img.shields.io/badge/License-Apache_2.0-blue.svg?style=for-the-badge&labelColor=000000">
+  </a>
+  <a aria-label="Join the community on Discord" href="https://discord.com/invite/ptHhX6jc34">
+    <img alt="" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=Discord&labelColor=000000&logoWidth=20&logoColor=FFFFFF">
+  </a>
+</p>
+
+## Getting Started
+
+Instantly get started by installing the Dapr JS SDK and reading the [getting started documentation](https://docs.dapr.io/developing-applications/sdks/js) or [follow one of the quickstarts](https://github.com/dapr/quickstarts)
 
-# Dapr Node.js SDKs
-
-The official [Dapr](https://dapr.io) Node.js SDK that allows interfacing with the Dapr sidecar for easy application building.
-
-## Introduction
-
-The Dapr JS SDK will allow you to interface with the Dapr process that abstracts several commonly used functionalities such as Service-to-Service invocation, State Management, PubSub, and more.
-
-![](./documentation/assets/dapr-architecture.png)
-
-Looking at the illustration above, we can see there will always always be another process (the Dapr Sidecar) running that your application will interface with. This process can either be started manually (e.g. through Dapr CLI) or injected as a container (e.g. through Kubernetes Sidecar injection in your pod).
-
-For your application to interface with this, 2 components should be taken into account:
-* **DaprServer:** Dapr Sidecar -> our Application - When we Subscribe to a Topic, Create an Actor, ... we receive an event from the Dapr process that abstracted its implementation. Our application should thus listen to this (which this SDK helps you with).
-* **DaprClient:** Your Application -> Dapr Sidecar - When we want to Publish an Event, Execute a Binding, ... we will talk with the Dapr process that calls its implementation for us so that we don't have to write it ourself!
-
-## Simple Example
+```
+npm install --save @dapr/dapr
+```
 
-> [Full version](./examples/http/pubsub)
+> ⚠️ the [`dapr-client`](https://www.npmjs.com/package/dapr-client) package has been deprecated. Please see https://github.com/dapr/js-sdk/issues/259 for more information.
 
-As a simple example, consider the use case: "Creating a PubSub where we can publish a message on a Topic and also receive messages back from this topic". Normally for this use case we would have to look at the Broker that we want to utilize and implement their specificities. While as with Dapr we can use a simple SDK and configure the "component" that we want to interface with.
+## Documentation
 
-> 🤩 This also means that if we want to switch from one broker to another (e.g. [Azure Service Bus](https://docs.dapr.io/reference/components-reference/supported-pubsub/setup-azure-servicebus/) to [RabbitMQ](https://docs.dapr.io/reference/components-reference/supported-pubsub/setup-rabbitmq/)) we just have to change the component implementation!
+Visit [https://docs.dapr.io/developing-applications/sdks/js/](https://docs.dapr.io/developing-applications/sdks/js/) to view the full documentation.
 
-**component.yaml**
+## Who is using Dapr?
 
-```yaml
-apiVersion: dapr.io/v1alpha1
-kind: Component
-metadata:
-  name: my-pubsub-component
-  namespace: default
-spec:
-  type: pubsub.rabbitmq
-  version: v1
-  metadata:
-  - name: host
-    value: "amqp://localhost:5672"
-```
+Dapr is used by the world's leading companies. 
 
-**example.ts**
+<div align="center">               
+    <img src="https://dapr.io/images/bosch.png" width="100px">      
+    <img src="https://dapr.io/images/zeiss.png" width="100px">        
+    <img src="https://dapr.io/images/alibaba.png" width="100px">       
+    <img src="https://dapr.io/images/ignition-group.png" width="100px">      
+    <img src="https://dapr.io/images/roadwork.png" width="100px">     
+    <img src="https://dapr.io/images/autonavi.png" width="100px">     
+    <img src="https://dapr.io/images/legentic.png" width="100px">      
+    <img src="https://dapr.io/images/man-group.png" width="100px">
+</div>
 
-```javascript
-import { DaprClient, DaprServer } from "@dapr/dapr";
+View the main site [https://dapr.io/](https://dapr.io/) to learn more.
 
-const daprHost = "127.0.0.1"; // Dapr Sidecar Host
-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
+## Community
 
-// Create a Server (will subscribe) and Client (will publish)
-const server = new DaprServer(serverHost, serverPort, daprHost, daprPort);
-const client = new DaprClient(daprHost, daprPort);
+For the JS SDK we are utilizing [GitHub Communities](https://github.com/dapr/js-sdk/discussions) to track announcements, articles, and more! 
 
-// 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();
+The General Dapr community can be found on [Discord](https://discord.com/invite/ptHhX6jc34), where you can ask questions, propose features, and share your thoughts.
 
-// Send a message
-await client.pubsub.publish("my-pubsub-component", "my-topic", { hello: "world" });
-```
+## Contributing
 
-To start this we of course have to start the Dapr process with it. With the command below we can utilize the CLI to quickly test this:
+Please see our [Contributing Overview](https://docs.dapr.io/contributing/js-contributing/).
 
-```bash
-dapr run --app-id example-http-pubsub --app-protocol http --app-port 50001 --dapr-http-port 50000 --components-path ./components npm run start
-```
-
-Which will result in the message:
+### Good First Issues
 
-```bash
-Received: {"hello":"world"}
-```
+We have a list of [good first issues](https://github.com/dapr/js-sdk/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.
 
-## Information & Links
+## Authors
 
-* [Reference](./documentation/reference.md) containing code snippets of how to use the different methods.
-* [Examples](./documentation/examples.md) containing examples you can use to build your application.
-* [Development](./documentation/development.md) containing pointers for getting started on how to contribute to the SDK.
+- [Xavier Geerinck](https://www.linkedin.com/in/xaviergeerinck/) ([@XavierGeerinck](https://twitter.com/XavierGeerinck)) – [M18X](https://xaviergeerinck.com/) & [Proximus](https://proximus.com)
+- [Shubham Sharma](https://www.linkedin.com/in/shubham1172/) ([@shubham1172](https://twitter.com/shubham1172)) – [Microsoft](https://microsoft.com)
+- [Amulya Varote](https://www.linkedin.com/in/amulya-varote-96954287/) - [Microsoft](https://microsoft.com)
+- [Tanvi Gour](https://www.linkedin.com/in/tanvigour/) - [Microsoft](https://microsoft.com)

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

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

@@ -0,0 +1,31 @@
+---
+type: docs
+title: "JavaScript Examples"
+linkTitle: "Examples"
+weight: 500
+description: Get started with the Dapr Javascript SDK through some of our examples!
+---
+
+## Quickstarts
+
+* [State Management](https://github.com/dapr/quickstarts/tree/master/state_management/javascript/sdk): Learn the concept of state management with Dapr
+* [Pub Sub](https://github.com/dapr/quickstarts/tree/master/pub_sub/javascript/sdk): Create your own Publish / Subscribe system
+* [Secrets Management](https://github.com/dapr/quickstarts/tree/master/secrets_management/javascript/sdk)
+* [Service Invocation](https://github.com/dapr/quickstarts/tree/master/service_invocation/javascript/http)
+
+## Articles
+
+> Want your article added? [Let us know!](https://github.com/dapr/js-sdk/discussions/categories/articles) so we can add it below
+
+* [xaviergeerinck.com - Create an Azure IoT Hub Stream Processor with Dapr](https://xaviergeerinck.com/post/2022/05/19/dapr-stream-processor)
+
+* [xaviergeerinck.com - Integrate Dapr with Nest.JS and the Dapr KS SDK](https://xaviergeerinck.com/post/2022/03/29/dapr-with-nestjs)
+
+
+* [xaviergeerinck.com - Parking Garage Sensor implementation using Dapr Actors](https://xaviergeerinck.com/post/2021/10/09/parking-garage)
+
+* [xaviergeerinck.com - Running Dapr on Azure IoT Edge](https://xaviergeerinck.com/post/2021/04/23/iot-edge)
+
+* [xaviergeerinck.com - Creating an Email Microservice with Typescript and Dapr](https://xaviergeerinck.com/post/2021/03/25/creating-email-microservice)
+
+* [xaviergeerinck.com - Creating a User Login/Register Microservice](https://xaviergeerinck.com/post/2020/04/10/creating-account-microservice)

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

@@ -11,6 +11,8 @@ 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';
 import IClientState from '../../interfaces/Client/IClientState';
@@ -136,6 +138,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;
   }