fix(mqtt): fixed how mqtt library is imported

Because of some issues with some bundlers (namely, Parcel 2)
we have updated the way mqtt.connect is imported in Connection.ts

Minor updates to index.ts (eslint)

Added a changelog section in readme file

Author: csarnataro

README.md

@@ -162,3 +162,31 @@ ArduinoIoTCloud.connect(options)
   })
   .catch(error => console.error(error));
 ```
+
+## Development
+
+### Testing
+In order to test the library you have to export a couple of environment variables and then
+launch a specific `npm` script as follows:
+
+```sh
+$ export CLIENT_ID=<YOUR_CLIENT_ID>
+$ export CLIENT_SECRET=<YOUR_CLIENT_SECRET>
+$ npm run test
+```
+
+## Changelog
+### [0.9.0] - 2023-01-16
+
+#### Changed
+A few development settings have been updated, this should not affect how the library works.
+- 'mqtt' is imported differently if the library is used in the browser or in node.
+  In browser we're using 'mqtt/dist/mqtt' because of some issues with React with some bundlers (namely, Parcel 2)
+  
+  See:
+
+  [https://github.com/mqttjs/MQTT.js/issues/1412#issuecomment-1193363330](https://github.com/mqttjs/MQTT.js/issues/1412#issuecomment-1193363330)
+
+  [https://github.com/mqttjs/MQTT.js/issues/1233](https://github.com/mqttjs/MQTT.js/issues/1233)
+
+- updated README file with this changelog and some instructions about testing

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "arduino-iot-js",
-  "version": "0.7.1",
+  "version": "0.9.0-alpha.1",
   "license": "GPLv3",
   "description": "JS module providing Arduino Create IoT Cloud Connection",
   "main": "./lib/index.js",
@@ -58,7 +58,8 @@
     "clean": "rimraf lib es",
     "build:es": "rollup -c",
     "build:lib": "rollup -c ./rollup.config.lib.js",
-    "build": "npm run clean && npm run build:es && npm run build:lib"
+    "build": "npm run clean && npm run build:es && npm run build:lib",
+    "dev": "rollup -c -w"
   },
   "repository": {
     "type": "git",

package.json

@@ -20,7 +20,7 @@ export default {
     resolve(),
     typescript(),
     commonjs(),
-    terser(),
+    // terser(),
     sizes()
   ]
 };

rollup.config.js

@@ -20,7 +20,7 @@ export default {
     resolve(),
     typescript(),
     commonjs(),
-    terser(),
+    // terser(),
     sizes()
   ]
 };

rollup.config.lib.js

@@ -1,3 +1,4 @@
+import { MqttClient } from 'mqtt';
 import { IHttpClient } from '../http/IHttpClient';
 import { Connection } from '../connection/Connection';
 import { IConnection } from '../connection/IConnection';
@@ -10,8 +11,12 @@ type AccessResponse = {
   token_type: string;
 };
 
+function isApiOptions(options: CloudOptions): options is APIOptions {
+  return !!(options as APIOptions).clientId;
+}
+
 export class APIConnectionBuilder implements IConnectionBuilder {
-  constructor(private client: IHttpClient) {}
+  constructor(private client: IHttpClient, private mqttConnect: (string, IClientOptions) => MqttClient) {}
 
   public canBuild(options: CloudOptions): boolean {
     return isApiOptions(options);
@@ -27,11 +32,7 @@ export class APIConnectionBuilder implements IConnectionBuilder {
     body.append('client_secret', options.clientSecret);
     body.append('audience', options.audience || 'https://api2.arduino.cc/iot');
 
-    const { access_token } = await this.client.post<AccessResponse>(apiUrl, body, headers);
-    return Connection.From(options.host, options.port, access_token);
+    const { access_token: accessToken } = await this.client.post<AccessResponse>(apiUrl, body, headers);
+    return Connection.From(options.host, options.port, accessToken, this.mqttConnect);
   }
 }
-
-function isApiOptions(options: CloudOptions): options is APIOptions {
-  return !!(options as APIOptions).clientId;
-}

src/builder/APIConnectionBuilder.ts

@@ -1,5 +1,5 @@
 import jws from 'jws';
-import mqtt from 'mqtt';
+import mqtt, { MqttClient } from 'mqtt';
 import { Observable, Subject } from 'rxjs';
 
 import SenML from '../senML';
@@ -34,7 +34,12 @@ export class Connection implements IConnection {
     });
   }
 
-  public static async From(host: string, port: string | number, token: string): Promise<IConnection> {
+  public static async From(
+    host: string,
+    port: string | number,
+    token: string,
+    mqttConnect: (string, IClientOptions) => MqttClient
+  ): Promise<IConnection> {
     if (!token) throw new Error('connection failed: you need to provide a valid token');
     if (!host) throw new Error('connection failed: you need to provide a valid host (broker)');
 
@@ -46,7 +51,7 @@ export class Connection implements IConnection {
     };
 
     const connection = new Connection();
-    connection.client = mqtt.connect(`wss://${host}:${port}/mqtt`, {
+    connection.client = mqttConnect(`wss://${host}:${port}/mqtt`, {
       ...BaseConnectionOptions,
       ...options,
     });
@@ -106,7 +111,8 @@ export class Connection implements IConnection {
       else valueToSend = value;
     });
 
-    if (valueToSend !== {}) messages.push({ topic, propertyName: current, value: valueToSend });
+    // the condition `if (valueToSend !== {}) ` has been removed bc it always evaluates to true
+    messages.push({ topic, propertyName: current, value: valueToSend });
 
     return messages;
   }

src/connection/Connection.ts

@@ -1,33 +1,38 @@
 /*
-* Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
-* This file is part of arduino-iot-js.
-* Copyright (c) 2020
-* Authors: Fabrizio Mirabito, Francesco Pirrotta
-*
-* This software is released under:
-* The GNU General Public License, which covers the main part of
-* arduino-iot-js
-* The terms of this license can be found at:
-* https://www.gnu.org/licenses/gpl-3.0.en.html
-*
-* You can be released from the requirements of the above licenses by purchasing
-* a commercial license. Buying such a license is mandatory if you want to modify or
-* otherwise use the software for commercial activities involving the Arduino
-* software without disclosing the source code of your own applications. To purchase
-* a commercial license, send an email to license@arduino.cc.
-*
-*/
+ * Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+ * This file is part of arduino-iot-js.
+ * Copyright (c) 2020
+ * Authors: Fabrizio Mirabito, Francesco Pirrotta
+ *
+ * This software is released under:
+ * The GNU General Public License, which covers the main part of
+ * arduino-iot-js
+ * The terms of this license can be found at:
+ * https://www.gnu.org/licenses/gpl-3.0.en.html
+ *
+ * You can be released from the requirements of the above licenses by purchasing
+ * a commercial license. Buying such a license is mandatory if you want to modify or
+ * otherwise use the software for commercial activities involving the Arduino
+ * software without disclosing the source code of your own applications. To purchase
+ * a commercial license, send an email to license@arduino.cc.
+ *
+ */
 
 import SenML from './senML';
-import fetch from "node-fetch";
+import fetch from 'node-fetch';
+import mqtt from 'mqtt';
+
 import { HttpClientFactory } from './http/HttpClientFactory';
-import { CloudClient } from "./client/CloudClient";
-import { APIConnectionBuilder } from "./builder/APIConnectionBuilder";
-import { TokenConnectionBuilder } from "./builder/TokenConnectionBuilder";
+import { CloudClient } from './client/CloudClient';
+import { APIConnectionBuilder } from './builder/APIConnectionBuilder';
+import { TokenConnectionBuilder } from './builder/TokenConnectionBuilder';
 
-const builders = [new TokenConnectionBuilder(), new APIConnectionBuilder(HttpClientFactory.Create(fetch))];
+const builders = [
+  new TokenConnectionBuilder(),
+  new APIConnectionBuilder(HttpClientFactory.Create(fetch), mqtt.connect),
+];
 const ArduinoIoTCloud = new CloudClient(builders);
 
 export { SenML };
 export { ArduinoIoTCloud };
-export { CloudOptions, CloudMessageValue } from "./client/ICloudClient";
+export { CloudOptions, CloudMessageValue } from './client/ICloudClient';

src/index.lib.ts

@@ -1,33 +1,37 @@
 /*
-* Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
-* This file is part of arduino-iot-js.
-* Copyright (c) 2020
-* Authors: Fabrizio Mirabito, Francesco Pirrotta
-*
-* This software is released under:
-* The GNU General Public License, which covers the main part of
-* arduino-iot-js
-* The terms of this license can be found at:
-* https://www.gnu.org/licenses/gpl-3.0.en.html
-*
-* You can be released from the requirements of the above licenses by purchasing
-* a commercial license. Buying such a license is mandatory if you want to modify or
-* otherwise use the software for commercial activities involving the Arduino
-* software without disclosing the source code of your own applications. To purchase
-* a commercial license, send an email to license@arduino.cc.
-*
-*/
+ * Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+ * This file is part of arduino-iot-js.
+ * Copyright (c) 2020
+ * Authors: Fabrizio Mirabito, Francesco Pirrotta
+ *
+ * This software is released under:
+ * The GNU General Public License, which covers the main part of
+ * arduino-iot-js
+ * The terms of this license can be found at:
+ * https://www.gnu.org/licenses/gpl-3.0.en.html
+ *
+ * You can be released from the requirements of the above licenses by purchasing
+ * a commercial license. Buying such a license is mandatory if you want to modify or
+ * otherwise use the software for commercial activities involving the Arduino
+ * software without disclosing the source code of your own applications. To purchase
+ * a commercial license, send an email to license@arduino.cc.
+ *
+ */
 
-import "whatwg-fetch";
+import 'whatwg-fetch';
+import mqtt from 'mqtt/dist/mqtt';
 import SenML from './senML';
 import { HttpClientFactory } from './http/HttpClientFactory';
-import { CloudClient } from "./client/CloudClient";
-import { APIConnectionBuilder } from "./builder/APIConnectionBuilder";
-import { TokenConnectionBuilder } from "./builder/TokenConnectionBuilder";
+import { CloudClient } from './client/CloudClient';
+import { APIConnectionBuilder } from './builder/APIConnectionBuilder';
+import { TokenConnectionBuilder } from './builder/TokenConnectionBuilder';
 
-const builders = [new TokenConnectionBuilder(), new APIConnectionBuilder(HttpClientFactory.Create(fetch))];
+const builders = [
+  new TokenConnectionBuilder(),
+  new APIConnectionBuilder(HttpClientFactory.Create(fetch), mqtt.connect),
+];
 const ArduinoIoTCloud = new CloudClient(builders);
 
 export { SenML };
 export { ArduinoIoTCloud };
-export { CloudOptions, CloudMessageValue } from "./client/ICloudClient";
+export { CloudOptions, CloudMessageValue } from './client/ICloudClient';