Support Last Will and Testament.

rovale · Apr 27, 2016 · ad7b86a · ad7b86a
1 parent b34a14f
commit ad7b86a
Show file tree

Hide file tree

Showing 7 changed files with 151 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -20,12 +20,13 @@ An MQTT client for [Espruino](http://www.espruino.com/).
 - [x] Handle receiving multiple Publish packets at once.
 - [x] Respond with PubAck packet when receiving a QoS 1 Publish packet.
 - [x] Support sending retained Publish packets.
-- [ ] Implement Last Will and Testament.
+- [x] Support Last Will and Testament.
 - [ ] Handle not receiving PingResp packets.
 - [ ] Reconnect on lost connection.
 - [ ] Optimize memory usage and size.
 - [ ] Handle not being able to establish connection to host.
 - [ ] Handle receiving long Publish packets.
+- [ ] Create tests for example
 
 ## Technial notes
 - About the [npm-scripts](https://docs.npmjs.com/misc/scripts)

diff --git a/espruino/projects/example.js b/espruino/projects/example.js
@@ -1,17 +1,26 @@
 var MicroMqttClient = require("micro-mqtt").MicroMqttClient;
 
-var mqttClient = new MicroMqttClient({ host: "192.168.2.4", username: "username", password: "password" });
+var mqttClient = new MicroMqttClient({
+    host: "192.168.2.4",
+    clientId: "espruino",
+    username: "username", password: "password",
+    will: {
+        topic: "rovale/espruino/status",
+        message: "offline",
+        qos: 1,
+        retain: true
+    }
+});
 
 mqttClient.on('connected', function () {
-    mqttClient.subscribe("rovale/#");
+    mqttClient.subscribe("rovale/#", 1);
+    mqttClient.publish("rovale/espruino/status", "online", 1, true);
 });
 
-/*
 mqttClient.on('publish', function (pub) {
-  console.log("on publish");
-  console.log(pub);
+    console.log("on publish");
+    console.log(pub);
 });
-*/
 
 mqttClient.on('debug', function (debug) {
     console.log("[debug] " + debug);

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "micro-mqtt",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "description": "An MQTT client for Espruino.",
   "main": "./modules/micro-mqtt.ts",
   "scripts": {

diff --git a/src/module/ConnectionOptions.ts b/src/module/ConnectionOptions.ts
@@ -7,6 +7,14 @@ interface ConnectionOptions {
     username?: string;
     password?: string;
     clientId?: string;
+    will?: ConnectionOptionsWill;
+}
+
+interface ConnectionOptionsWill {
+    topic: string;
+    message: string;
+    qos?: number;
+    retain?: boolean;
 }
 
 export default ConnectionOptions;
diff --git a/src/module/micro-mqtt.ts b/src/module/micro-mqtt.ts
@@ -53,7 +53,7 @@ export interface Network {
  * The MQTT client.
  */
 export class MicroMqttClient {
-    public version = '0.0.15';
+    public version = '0.0.16';
 
     private options: ConnectionOptions;
     private network: Network;
@@ -70,6 +70,11 @@ export class MicroMqttClient {
         options.port = options.port || defaultPort;
         options.clientId = options.clientId || '';
 
+        if (options.will) {
+            options.will.qos = options.will.qos || defaultQos;
+            options.will.retain = options.will.retain || false;
+        }
+
         this.options = options;
         this.network = network;
     }
@@ -214,11 +219,18 @@ export module MqttProtocol {
      * Connect flags
      * http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349229
      */
-    function createConnectionFlags(options: ConnectionOptions) {
+    function createConnectFlags(options: ConnectionOptions) {
         let flags = 0;
         flags |= (options.username) ? ConnectFlags.UserName : 0;
         flags |= (options.username && options.password) ? ConnectFlags.Password : 0;
         flags |= ConnectFlags.CleanSession;
+
+        if (options.will) {
+            flags |= ConnectFlags.Will;
+            flags |= options.will.qos << 3;
+            flags |= (options.will.retain) ? ConnectFlags.WillRetain : 0;
+        }
+
         return flags;
     }
 
@@ -265,11 +277,17 @@ export module MqttProtocol {
 
         const protocolName = createString('MQTT');
         const protocolLevel = String.fromCharCode(4);
-        const flags = String.fromCharCode(createConnectionFlags(options));
+        const flags = String.fromCharCode(createConnectFlags(options));
 
         const keepAlive: string = String.fromCharCode(...keepAliveBytes());
 
         let payload = createString(options.clientId);
+
+        if (options.will) {
+            payload += createString(options.will.topic);
+            payload += createString(options.will.message);
+        }
+
         if (options.username) {
             payload += createString(options.username);
             if (options.password) {

diff --git a/src/test/MicroMqttClientTest.ts b/src/test/MicroMqttClientTest.ts
@@ -59,7 +59,11 @@ describe('MicroMqttClient', () => {
                 host: 'host',
                 clientId: 'some-client',
                 username: 'some-username',
-                password: 'some-password'
+                password: 'some-password',
+                will: {
+                    topic: 'some/willTopic',
+                    message: 'offline'
+                }
             }, network);
 
             networkSocket = new TestNetworkSocket();
@@ -70,8 +74,8 @@ describe('MicroMqttClient', () => {
         it('it should send a Connect packet.', () => {
             networkSocket.sentPackages.should.have.lengthOf(1);
             const packet = new ConnectPacketVerifier(networkSocket.sentPackages[0]);
-            packet.shouldHaveConnectFlags(ConnectFlags.UserName | ConnectFlags.Password | ConnectFlags.CleanSession);
-            packet.shouldHavePayload('some-client', 'some-username', 'some-password');
+            packet.shouldHaveConnectFlags(ConnectFlags.UserName | ConnectFlags.Password | ConnectFlags.CleanSession | ConnectFlags.Will);
+            packet.shouldHavePayload('some-client', 'some/willTopic', 'offline', 'some-username', 'some-password');
         });
     });
 

diff --git a/src/test/MqttProtocolTest.ts b/src/test/MqttProtocolTest.ts
@@ -87,7 +87,8 @@ describe('MqttProtocol', () => {
             beforeEach(() => {
                 packet = new ConnectPacketVerifier(MqttProtocol.createConnectPacket({
                     host: 'host',
-                    clientId: 'some-client', username: 'some-username',
+                    clientId: 'some-client',
+                    username: 'some-username',
                     password: 'some-password'
                 }));
             });
@@ -100,6 +101,101 @@ describe('MqttProtocol', () => {
                 packet.shouldHavePayload('some-client', 'some-username', 'some-password');
             });
         });
+
+        context('specifying the Last Will Testament', () => {
+            context('With QoS 0, not retained', () => {
+                beforeEach(() => {
+                    packet = new ConnectPacketVerifier(MqttProtocol.createConnectPacket({
+                        host: 'host',
+                        clientId: 'some-client',
+                        username: 'some-username',
+                        will: {
+                            topic: 'some/willTopic',
+                            message: 'offline',
+                            qos: 0,
+                            retain: false
+                        }
+                    }));
+                });
+
+                it('it should provide the correct connect flags.', () => {
+                    packet.shouldHaveConnectFlags(ConnectFlags.CleanSession | ConnectFlags.UserName | ConnectFlags.Will);
+                });
+
+                it('it should provide the will topic, and the will message.', () => {
+                    packet.shouldHavePayload('some-client', 'some/willTopic', 'offline', 'some-username');
+                });
+            });
+
+            context('With QoS 1, not retained', () => {
+                beforeEach(() => {
+                    packet = new ConnectPacketVerifier(MqttProtocol.createConnectPacket({
+                        host: 'host',
+                        clientId: 'some-client',
+                        will: {
+                            topic: 'some/willTopic',
+                            message: 'offline',
+                            qos: 1,
+                            retain: false
+                        }
+                    }));
+                });
+
+                it('it should provide the correct connect flags.', () => {
+                    packet.shouldHaveConnectFlags(ConnectFlags.CleanSession | ConnectFlags.Will | ConnectFlags.WillQoS1);
+                });
+
+                it('it should provide the will topic, and will message.', () => {
+                    packet.shouldHavePayload('some-client', 'some/willTopic', 'offline');
+                });
+            });
+
+            context('With QoS 2, not retained', () => {
+                beforeEach(() => {
+                    packet = new ConnectPacketVerifier(MqttProtocol.createConnectPacket({
+                        host: 'host',
+                        clientId: 'some-client',
+                        will: {
+                            topic: 'some/willTopic',
+                            message: 'offline',
+                            qos: 2,
+                            retain: false
+                        }
+                    }));
+                });
+
+                it('it should provide the correct connect flags.', () => {
+                    packet.shouldHaveConnectFlags(ConnectFlags.CleanSession | ConnectFlags.Will | ConnectFlags.WillQoS2);
+                });
+
+                it('it should provide the will topic, and will message.', () => {
+                    packet.shouldHavePayload('some-client', 'some/willTopic', 'offline');
+                });
+            });
+
+            context('With QoS 0, retained', () => {
+                beforeEach(() => {
+                    packet = new ConnectPacketVerifier(MqttProtocol.createConnectPacket({
+                        host: 'host',
+                        clientId: 'some-client',
+                        will: {
+                            topic: 'some/willTopic',
+                            message: 'offline',
+                            qos: 0,
+                            retain: true
+                        }
+                    }));
+                });
+
+                it('it should provide the correct connect flags.', () => {
+                    packet.shouldHaveConnectFlags(ConnectFlags.CleanSession | ConnectFlags.Will | ConnectFlags.WillRetain);
+                });
+
+                it('it should provide the will topic, and will message.', () => {
+                    packet.shouldHavePayload('some-client', 'some/willTopic', 'offline');
+                });
+            });
+        });
     });
 
     context('When creating a Publish packet', () => {