feat: delegate protocol decoding in server-factory and protocol-decoder

README.md

@@ -101,6 +101,7 @@ Other info:
 - [aedes-stats]: Stats for Aedes
 - [aedes-cli]: Run Aedes MQTT Broker from the CLI
 - [aedes-protocol-decoder]: Protocol decoder for Aedes MQTT Broker
+- [aedes-server-factory]: Create a server instance such as TCP, HTTP, TLS...
 
 ## Middleware Plugins
 
@@ -258,6 +259,7 @@ Here is a list of some interesting projects that are using Aedes as MQTT Broker.
 - [__Behrad Zari__](https://github.com/behrad)
 - [__Gnought__](https://github.com/gnought)
 - [__Daniel Lando__](https://github.com/robertsLando)
+- [__Getlarge__](https://github.com/getlarge)
 
 ## Contribution
 
@@ -297,6 +299,7 @@ Licensed under [MIT](./LICENSE).
 [aedes-stats]: https://www.npmjs.com/aedes-stats
 [aedes-cli]: https://www.npmjs.com/aedes-cli
 [aedes-protocol-decoder]: https://www.npmjs.com/aedes-protocol-decoder
+[aedes-server-factory]: https://www.npmjs.com/aedes-server-factory
 [aedes-persistence]: https://www.npmjs.com/aedes-persistence
 [aedes-persistence-mongodb]: https://www.npmjs.com/aedes-persistence-mongodb
 [aedes-persistence-redis]: https://www.npmjs.com/aedes-persistence-redis

docs/Aedes.md

@@ -24,7 +24,6 @@
   - [aedes.unsubscribe (topic, deliverfunc, callback)](#aedesunsubscribe-topic-deliverfunc-callback)
   - [aedes.publish (packet, callback)](#aedespublish-packet-callback)
   - [aedes.close ([callback])](#aedesclose-callback)
-  - [Handler: decodeProtocol (client, buffer)](#handler-decodeprotocol-client-buffer)
   - [Handler: preConnect (client, packet, callback)](#handler-preconnect-client-packet-callback)
   - [Handler: authenticate (client, username, password, callback)](#handler-authenticate-client-username-password-callback)
   - [Handler: authorizePublish (client, packet, callback)](#handler-authorizepublish-client-packet-callback)
@@ -225,23 +224,6 @@ Close aedes server and disconnects all clients.
 
 `callback` will be invoked when server is closed.
 
-## Handler: decodeProtocol (client, buffer)
-
-- client: [`<Client>`](./Client.md)
-- buffer: `<Buffer>`
-
-Invoked when aedes instance `trustProxy` is `true`
-
-It targets to decode wrapped protocols (e.g. websocket and PROXY) into plain raw mqtt stream.
-
-`aedes-protocol-decoder` is an example to parse https headers (x-real-ip | x-forwarded-for) and proxy protocol v1 and v2 to retrieve information in `client.connDetails`.
-
-```js
-aedes.decodeProtocol = function(client, buffer) {
-  return yourDecoder(client, buffer)
-}
-```
-
 ## Handler: preConnect (client, packet, callback)
 
 - client: [`<Client>`](./Client.md)

docs/Examples.md

@@ -13,6 +13,20 @@ server.listen(port, function () {
 })
 ```
 
+## Simple plain MQTT server using server-factory
+
+```js
+const aedes = require('aedes')()
+const { createServer } = require('aedes-server-factory')
+const port = 1883
+
+const server = createServer(aedes)
+
+server.listen(port, function () {
+  console.log('server started and listening on port ', port)
+})
+```
+
 ## MQTT over TLS / MQTTS
 
 ```js
@@ -47,6 +61,20 @@ httpServer.listen(port, function () {
 })
 ```
 
+## MQTT server over WebSocket using server-factory
+
+```js
+const aedes = require('aedes')()
+const { createServer } = require('aedes-server-factory')
+const port = 8888
+
+const httpServer = createServer(aedes, { ws: true })
+
+httpServer.listen(port, function () {
+  console.log('websocket server listening on port ', port)
+})
+```
+
 ## Clusters
 
 In order to use Aedes in clusters you have to choose a persistence and an mqemitter that supports clusters. Tested persistence/mqemitters that works with clusters are:

lib/client.js

@@ -43,7 +43,7 @@ function Client (broker, conn, req) {
   this._nextId = Math.ceil(Math.random() * 65535)
 
   this.req = req
-  this.connDetails = null
+  this.connDetails = req ? req.connDetails : null
 
   // we use two variables for the will
   // because we store in _will while
@@ -73,14 +73,7 @@ function Client (broker, conn, req) {
     if (that._parsingBatch <= 0) {
       that._parsingBatch = 0
       var buf = client.conn.read(null)
-      if (!client.connackSent && client.broker.decodeProtocol && client.broker.trustProxy && buf) {
-        const { data } = client.broker.decodeProtocol(client, buf)
-        if (data) {
-          client._parser.parse(data)
-        } else {
-          client._parser.parse(buf)
-        }
-      } else if (buf) {
+      if (buf) {
         client._parser.parse(buf)
       }
     }

package.json

@@ -108,15 +108,13 @@
   "dependencies": {
     "aedes-packet": "^2.3.1",
     "aedes-persistence": "^8.1.1",
-    "aedes-protocol-decoder": "^1.0.0",
     "bulk-write-stream": "^2.0.1",
     "end-of-stream": "^1.4.4",
     "fastfall": "^1.5.1",
     "fastparallel": "^2.3.0",
     "fastseries": "^2.0.0",
     "mqemitter": "^4.2.0",
     "mqtt-packet": "^6.3.2",
-    "proxy-protocol-js": "^4.0.4",
     "readable-stream": "^3.6.0",
     "retimer": "^2.0.0",
     "reusify": "^1.0.4",