@azure/web-pubsub-express 1.0.0-beta.1 → 1.0.1-alpha.20211215.2

package/CHANGELOG.md

@@ -1,3 +1,69 @@
+# Release History
+
+## 1.0.1 (Unreleased)
+
+### Features Added
+
+### Breaking Changes
+
+### Bugs Fixed
+
+### Other Changes
+
+## 1.0.0 (2021-11-11)
+
+No changes.
+
+## 1.0.0-beta.4 (2021-11-09)
+
+### Breaking Changes
+
+- Move `allowedEndpoints` settings into `WebPubSubEventHandlerOptions`. If not set, the default behavior is allowing all the incoming endpoints.
+
+  ```js
+  const handler = new WebPubSubEventHandler("chat", {
+    handleConnect(req, res) {
+      // You can set the state for the connection, it lasts throughout the lifetime of the connection
+      res.setState("calledTime", 1);
+      res.success();
+    },
+    handleUserEvent(req, res) {
+      var calledTime = req.context.states.calledTime++;
+      console.log(calledTime);
+      // You can also set the state here
+      res.setState("calledTime", calledTime);
+      res.success();
+    },
+    allowedEndpoints: ["https://xxx.webpubsub.azure.com"]
+  });
+  ```
+
+- Remove `dumpRequest` flag and leverage @azure/logger instead.
+
+## 1.0.0-beta.3 (2021-07-30)
+
+- Support reading and setting connection states, sample usage:
+  ```js
+  const handler = new WebPubSubEventHandler("chat", ["https://xxx.webpubsub.azure.com"], {
+    handleConnect(req, res) {
+      // You can set the state for the connection, it lasts throughout the lifetime of the connection
+      res.setState("calledTime", 1);
+      res.success();
+    },
+    handleUserEvent(req, res) {
+      var calledTime = req.context.states.calledTime++;
+      console.log(calledTime);
+      // You can also set the state here
+      res.setState("calledTime", calledTime);
+      res.success();
+    }
+  });
+  ```
+
+## 1.0.0-beta.2 (2021-07-20)
+
+- Removed unnecessary dependencies.
+
 ## 1.0.0-beta.1 (2021-04-23)
 
 This is the first release of the @azure/web-pubsub-express package.

package/README.md

@@ -1,16 +1,14 @@
 # Azure Web PubSub CloudEvents handlers for Express
 
-[Azure Web PubSub Service](https://aka.ms/awps/doc) is a service that enables you to build real-time messaging web applications using WebSockets and the publish-subscribe pattern. Any platform supporting WebSocket APIs can connect to the service easily, e.g. web pages, mobile applications, edge devices, etc. The service manages the WebSocket connections for you and allows up to 100K concurrent connections. It provides powerful APIs for you to manage these clients and deliver real-time messages.
+[Azure Web PubSub service](https://aka.ms/awps/doc) is an Azure-managed service that helps developers easily build web applications with real-time features and publish-subscribe pattern. Any scenario that requires real-time publish-subscribe messaging between server and clients or among clients can use Azure Web PubSub service. Traditional real-time features that often require polling from server or submitting HTTP requests can also use Azure Web PubSub service.
 
-Any scenario that requires real-time publish-subscribe messaging between server and clients or among clients, can use Azure Web PubSub service. Traditional real-time features that often require polling from server or submitting HTTP requests, can also use Azure Web PubSub service.
+When a WebSocket connection connects, the Web PubSub service transforms the connection lifecycle and messages into [events in CloudEvents format](https://docs.microsoft.com/azure/azure-web-pubsub/concept-service-internals#workflow). This library provides an express middleware to handle events representing the WebSocket connection's lifecycle and messages, as shown in below diagram:
 
-Use the express library to:
+![cloudevents](https://user-images.githubusercontent.com/668244/140321213-6442b3b8-72ee-4c28-aec1-127f9ea8f5d9.png)
 
-- Add Web PubSub CloudEvents middleware to handle incoming client events
-  - Handle abuse validation requests
-  - Handle client events requests
+Details about the terms used here are described in [Key concepts](#key-concepts) section.
 
-[Source code](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/web-pubsub/web-pubsub-express) |
+[Source code](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/web-pubsub/web-pubsub-express) |
 [Package (NPM)](https://www.npmjs.com/package/@azure/web-pubsub-express) |
 [API reference documentation](https://aka.ms/awps/sdk/js) |
 [Product documentation](https://aka.ms/awps/doc) |
@@ -20,7 +18,7 @@ Use the express library to:
 
 ### Currently supported environments
 
-- [Node.js](https://nodejs.org/) version 8.x.x or higher
+- [LTS versions of Node.js](https://nodejs.org/about/releases/)
 - [Express](https://expressjs.com/) version 4.x.x or higher
 
 ### Prerequisites
@@ -34,24 +32,13 @@ Use the express library to:
 npm install @azure/web-pubsub-express
 ```
 
-### 2. Create a WebPubSubEventHandler
+### 2. Create a `WebPubSubEventHandler`
 
 ```js
 const express = require("express");
 
 const { WebPubSubEventHandler } = require("@azure/web-pubsub-express");
-const handler = new WebPubSubEventHandler(
-  "chat",
-  ["https://<yourAllowedService>.webpubsub.azure.com"],
-  {
-    handleConnect: (req, res) => {
-      // auth the connection and set the userId of the connection
-      res.success({
-        userId: "<userId>"
-      });
-    }
-  }
-);
+const handler = new WebPubSubEventHandler("chat");
 
 const app = express();
 
@@ -64,17 +51,17 @@ app.listen(3000, () =>
 
 ## Key concepts
 
-### Hub
+### Connection
 
-Hub is a logic set of connections. All connections to Web PubSub connect to a specific hub. Messages that are broadcast to the hub are dispatched to all connections to that hub. For example, hub can be used for different applications, different applications can share one Azure Web PubSub service by using different hub names.
+A connection, also known as a client or a client connection, represents an individual WebSocket connection connected to the Web PubSub service. When successfully connected, a unique connection ID is assigned to this connection by the Web PubSub service.
 
-### Group
+### Hub
 
-Group allow broadcast messages to a subset of connections to the hub. You can add and remove users and connections as needed. A client can join multiple groups, and a group can contain multiple clients.
+A hub is a logical concept for a set of client connections. Usually you use one hub for one purpose, for example, a chat hub, or a notification hub. When a client connection is created, it connects to a hub, and during its lifetime, it belongs to that hub. Different applications can share one Azure Web PubSub service by using different hub names.
 
 ### Group
 
-Group allow broadcast messages to a subset of connections to the hub. You can add and remove users and connections as needed. A client can join multiple groups, and a group can contain multiple clients.
+A group is a subset of connections to the hub. You can add a client connection to a group, or remove the client connection from the group, anytime you want. For example, when a client joins a chat room, or when a client leaves the chat room, this chat room can be considered to be a group. A client can join multiple groups, and a group can contain multiple clients.
 
 ### User
 
@@ -90,11 +77,117 @@ Event handler contains the logic to handle the client events. Event handler need
 
 ## Examples
 
+### Handle the `connect` request and assign `<userId>`
+
+```js
+const express = require("express");
+
+const { WebPubSubEventHandler } = require("@azure/web-pubsub-express");
+const handler = new WebPubSubEventHandler("chat", {
+  handleConnect: (req, res) => {
+    // auth the connection and set the userId of the connection
+    res.success({
+      userId: "<userId>"
+    });
+  },
+  allowedEndpoints: ["https://<yourAllowedService>.webpubsub.azure.com"]
+});
+
+const app = express();
+
+app.use(handler.getMiddleware());
+
+app.listen(3000, () =>
+  console.log(`Azure WebPubSub Upstream ready at http://localhost:3000${handler.path}`)
+);
+```
+
+### Only allow specified endpoints
+
+```js
+const express = require("express");
+
+const { WebPubSubEventHandler } = require("@azure/web-pubsub-express");
+const handler = new WebPubSubEventHandler("chat", {
+  allowedEndpoints: [
+    "https://<yourAllowedService1>.webpubsub.azure.com",
+    "https://<yourAllowedService2>.webpubsub.azure.com"
+  ]
+});
+
+const app = express();
+
+app.use(handler.getMiddleware());
+
+app.listen(3000, () =>
+  console.log(`Azure WebPubSub Upstream ready at http://localhost:3000${handler.path}`)
+);
+```
+
+### Set custom event handler path
+
+```js
+const express = require("express");
+
+const { WebPubSubEventHandler } = require("@azure/web-pubsub-express");
+const handler = new WebPubSubEventHandler("chat", {
+  path: "customPath1"
+});
+
+const app = express();
+
+app.use(handler.getMiddleware());
+
+app.listen(3000, () =>
+  // Azure WebPubSub Upstream ready at http://localhost:3000/customPath1
+  console.log(`Azure WebPubSub Upstream ready at http://localhost:3000${handler.path}`)
+);
+```
+
+### Set and read connection state
+
+```js
+const express = require("express");
+
+const { WebPubSubEventHandler } = require("@azure/web-pubsub-express");
+
+const handler = new WebPubSubEventHandler("chat", {
+  handleConnect(req, res) {
+    // You can set the state for the connection, it lasts throughout the lifetime of the connection
+    res.setState("calledTime", 1);
+    res.success();
+  },
+  handleUserEvent(req, res) {
+    var calledTime = req.context.states.calledTime++;
+    console.log(calledTime);
+    // You can also set the state here
+    res.setState("calledTime", calledTime);
+    res.success();
+  }
+});
+
+const app = express();
+
+app.use(handler.getMiddleware());
+
+app.listen(3000, () =>
+  console.log(`Azure WebPubSub Upstream ready at http://localhost:3000${handler.path}`)
+);
+```
+
 ## Troubleshooting
 
-### Dump request
+### Enable logs
+
+You can set the following environment variable to get the debug logs when using this library.
+
+- Getting debug logs from the SignalR client library
+
+```bash
+export AZURE_LOG_LEVEL=verbose
+```
 
-Set `dumpRequest` to `true` to view the incoming requests.
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
 
 ### Live Trace
 
@@ -108,11 +201,11 @@ directory for detailed examples on how to use this library.
 
 ## Contributing
 
-If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/master/CONTRIBUTING.md) to learn more about how to build and test the code.
+If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
 
 ## Related projects
 
 - [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
 
 [azure_sub]: https://azure.microsoft.com/free/
-[samples_ref]: https://github.com/Azure/azure-webpubsub/tree/main/samples
+[samples_ref]: https://github.com/Azure/azure-webpubsub/tree/main/samples/javascript/