feat: add ws client adapter (#319)

Co-authored-by: Fran Mendez <[email protected]>

.eslintignore

@@ -1,5 +1,6 @@
 node_modules
 examples/social-network/frontend
+examples/crypto-websockets
 dist
 .glee
 test

.gitignore

@@ -2,4 +2,5 @@ node_modules
 .DS_Store
 dist
 coverage
-.vscode
+.vscode
+.glee

docs/config-file.md

@@ -14,7 +14,6 @@ export default async function () {
 
 This function must return an object with the following shape:
 
-
 ```js
 export default async function () {
   return {
@@ -26,7 +25,8 @@ export default async function () {
 
 ```
 
-Here is an example of a `glee.config.js` file for reference: 
+Here is an example of a `glee.config.js` file for reference:
+
 ```js
 export default async function () {
   return {
@@ -35,6 +35,14 @@ export default async function () {
         httpServer: customServer, // A custom HTTP server of your own.
         adapter: "native", // Default. Can also be 'socket.io' or a reference to a custom adapter.
         port: process.env.PORT,
+      },
+      client: {
+        authentication: {
+          token: process.env.TOKEN
+        },
+        query: {
+          foo: 'bar'
+        }
       }
     },
     cluster: {
@@ -55,17 +63,24 @@ export default async function () {
   };
 }
 ```
+
 Every protocol has different configuration needs so each protocol has unique configurations:
 
 ### Websocket Server
+
 |Field|Description|
 |--|--|
-|websocket.server|Websocket server-specific configuration|
+|websocket.server|Websocket server-specific configurations|
+|websocekt.client|Websocket client-specific configurations|
 |websocket.server.adapter| The Glee adapter to use for the WebSocket server. Defaults to a "native" WebSocket implementation. Other allowed values are `socket.io` (to use the [Socket.IO](https://socket.io/) Glee adapter) or a reference to a custom adapter.|
 |websocket.server.httpServer|  A custom HTTP server of your own. E.g., an [Express](https://expressjs.com/en/4x/api.html) server or any object that implements the [http.Server](https://nodejs.org/api/http.html#http_class_http_server) interface.   |
 |websocket.server.port| The port to use when binding the WebSocket server. This is useful when your server is behind a proxy and the port exposed for consumption is not the same as the port your application should be bound to. Defaults to the port specified in the selected AsyncAPI server.|
+|websocket.client.authetication| Authentication variables for client|
+|websocket.client.authentication.token| HTTP Authentication header|
+|websocket.client.query| Query object for the client to send
+
+### Cluster
 
-### Cluster 
 |Field|Description|
 |--|--|
 |cluster.adapter| The Glee cluster adapter to use for communication between instances. Defaults to Redis Pub/Sub ("redis"). Can be a reference to a custom adapter.|
@@ -81,4 +96,4 @@ Every protocol has different configuration needs so each protocol has unique con
 |mqtt.authentication.clientId| MQTT client Id for authentication
 |mqtt.authentication.userPassword| username and password parameters for authentication|
 |mqtt.authentication.userPassword.username| username parameter
-|mqtt.authentication.userPassword.password| password parameter
+|mqtt.authentication.userPassword.password| password parameter

examples/crypto-websockets/README.md

@@ -0,0 +1,4 @@
+## Crypto Websockets 
+This example tries to showcase how Glee could be used as a WebSocket client. There is a server that streams the price change of a fake cryptocurrency (we can call it asyncapicoin) and the client subscribes to this stream and draws a graph in the terminal. 
+
+<img src="./graph.png">

examples/crypto-websockets/client/.env

@@ -0,0 +1 @@
+TOKEN=arb-tokenValue

examples/crypto-websockets/client/asyncapi.yaml

@@ -0,0 +1,34 @@
+asyncapi: 2.4.0
+info: 
+  title: asyncapicoin client
+  version: 1.0.0
+  description: |
+    This app creates a client that subscribes to the server for the price change.
+servers:
+  websockets:
+    url: ws://localhost:3000
+    protocol: ws
+x-remoteServers:
+  - websockets
+channels:
+  /price:
+    bindings:
+      ws:
+        bindingVersion: 0.1.0
+    publish:
+      operationId: index
+      message:
+        $ref: '#/components/messages/indexGraph'
+components:
+  messages:
+    indexGraph:
+      payload:
+        type: object
+        properties:
+          status:
+            type: string
+          time:
+            type: number
+          price:
+            type: number
+

examples/crypto-websockets/client/db.json

@@ -0,0 +1 @@
+[{"time":1663935946665,"price":130,"status":"started"},{"time":1663935947684,"price":140,"status":"intransit"},{"time":1663935948690,"price":130,"status":"intransit"},{"time":1663935949698,"price":140,"status":"intransit"},{"time":1663935950710,"price":150,"status":"intransit"},{"time":1663935951716,"price":130,"status":"intransit"},{"time":1663935952724,"price":100,"status":"intransit"},{"time":1663935953737,"price":110,"status":"intransit"},{"time":1663935954742,"price":140,"status":"intransit"}]

examples/crypto-websockets/client/functions/index.ts

@@ -0,0 +1,27 @@
+import path from 'path'
+import fs from 'fs'
+import asciichart from 'asciichart'
+
+export default async function (event) {
+    const payload = event.payload
+    const dbPath = path.resolve('./db.json')
+    const read = () => JSON.parse(fs.readFileSync(dbPath, 'utf-8'))
+    const write = (data) => { fs.writeFileSync(dbPath, data, { encoding: 'utf-8' }) }
+    let db
+    switch (payload.status) {
+        case 'started':
+            write(JSON.stringify([payload]))
+            break
+        case 'intransit':
+            db = read()
+            write(JSON.stringify([...db, payload]))
+            break
+        case 'finished':
+            db = read()
+            const values = [...db, payload]
+            console.log(asciichart.plot(values.map(v => v.price), {height: 8}))
+    }
+    return {
+        send: []
+    }
+}

examples/crypto-websockets/client/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "client",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "dev": "glee dev"
+  },
+  "type": "module",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@asyncapi/glee": "file:../../..",
+    "asciichart": "^1.5.25"
+  }
+}

examples/crypto-websockets/client/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "target": "es6",
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "module": "commonjs",
+    "resolveJsonModule": true,
+  }
+}

examples/crypto-websockets/server/asyncapi.yaml

@@ -0,0 +1,31 @@
+asyncapi: 2.4.0
+info:
+  title: asyncapicoin server
+  version: 1.0.0
+  description: |
+    This app is a dummy server that would stream the price of a fake cryptocurrency
+servers:
+  websocket:
+    url: ws://localhost:3000
+    protocol: ws
+channels:
+  /price:
+    bindings:
+      ws:
+        bindingVersion: 0.1.0
+    subscribe:
+      message:
+        $ref: '#/components/messages/indexGraph'
+components:
+  messages:
+    indexGraph:
+      summary: Data required for drawing index graph
+      payload:
+        type: object
+        properties:
+          status:
+            type: string
+          time:
+            type: number
+          price:
+            type: number