Server factory integration

README.md

@@ -14,10 +14,10 @@
 
 Protocol decoder for Aedes MQTT Broker
 
-The purpose of this module is to be used inside [aedes-server-factory](https://github.com/moscajs/aedes-server-factory) `bindConnection` function, which is called when the server receives a connection from client ( before CONNECT packet). The client object state is in default and its connected state is false. 
-The function extract socket details and if aedes-server-factory `trustProxy` option is set to true, it will first parse http headers (x-real-ip | x-forwarded-for) and proxy protocol (v1 and v2) to retrieve information in client.connDetails.
+The purpose of this module is to be used inside [aedes-server-factory](https://github.com/moscajs/aedes-server-factory) `bindConnection` function, which is called when the server receives a connection from client (before CONNECT packet). The client object state is in default and its connected state is false. 
+The function extract socket details and if `aedes-server-factory` `trustProxy` option is set to true, it will first parse http headers (x-real-ip | x-forwarded-for) and/or proxy protocol (v1 and v2), then passing the informations to `aedes` that will assign them to `client.connDetails`.
 
-The function `protocolDecoder` and `extractSocketDetails` returns [ConnectionDetails](./types/index.d.ts), if the object contains data property, it will be parsed as an mqtt-packet.
+The function `protocolDecoder` and `extractSocketDetails` returns [ConnectionDetails](./types/index.d.ts), if the object contains `data` property, it will be parsed as an [mqtt-packet](https://github.com/mqttjs/mqtt-packet).
 
 ## Install
 
@@ -46,8 +46,6 @@ var server = createServer(broker, { trustProxy: true, protocolDecoder })
 server.listen(port, function () {
   console.log('server listening on port', port)
 })
-
-
 ```
 
 ## License

test.js

@@ -250,9 +250,9 @@ test('websocket clients have access to the ipAddress from the socket (if no ip h
   var client = mqtt.connect(`ws://localhost:${port}`)
 
   function finish () {
+    client.end(true)
     broker.close()
     server.close()
-    client.end()
     t.end()
   }
 })
@@ -289,9 +289,9 @@ test('websocket proxied clients have access to the ipAddress from x-real-ip head
   })
 
   function finish () {
+    client.end(true)
     broker.close()
     server.close()
-    client.end()
     t.end()
   }
 })
@@ -328,9 +328,9 @@ test('websocket proxied clients have access to the ipAddress from x-forwarded-fo
   })
 
   function finish () {
+    client.end(true)
     broker.close()
     server.close()
-    client.end()
     t.end()
   }
 })
@@ -356,29 +356,28 @@ test('tcp proxied (protocol v1) clients buffer contains MQTT packet and proxy he
 
   var broker = aedes({
     preConnect: function (client, packet, done) {
-      function cb () {
-        done(null, true)
-        setImmediate(finish)
-      }
-
       if (client.connDetails.data) {
         const parser = mqttPacket.parser({ protocolVersion: 3 })
         parser.on('packet', (parsedPacket) => {
           t.equal(JSON.stringify(parsedPacket), JSON.stringify(packet))
-          cb()
+          done(null, true)
         })
         parser.on('error', () => {
           t.fail('no valid MQTT packet extracted from TCP buffer')
-          cb()
+          done(null, true)
         })
         parser.parse(client.connDetails.data)
       } else {
         t.fail('no MQTT packet extracted from TCP buffer')
-        cb()
+        done(null, true)
       }
     }
   })
 
+  broker.on('clientDisconnect', function () {
+    setImmediate(finish)
+  })
+
   var server = createServer(broker, { trustProxy: true, extractSocketDetails, protocolDecoder })
   server.listen(brokerPort, function (err) {
     t.error(err, 'no error')
@@ -422,7 +421,7 @@ test('tcp proxied (protocol v1) clients buffer contains MQTT packet and proxy he
 
   var client = net.connect({
     port: proxyPort,
-    timeout: 200
+    timeout: 150
   }, function () {
     client.write(buf)
   })