Merge pull request #162 from mountaindude/master

v5.4 RC1

changelog.md

@@ -1,5 +1,32 @@
 # Change log
 
+## 5.4.0
+
+### New features
+
+### Fixes and patches
+
+* Fixed bug occuring when the start-task API was called with an empty PUT body. [#157](https://github.com/ptarmiganlabs/butler/issues/157)
+
+* [Improved documentation](https://butler.ptarmiganlabs.com/docs/getting-started/setup/data-connections/) around the Sense data connections that Butler needs. [#160](https://github.com/ptarmiganlabs/butler/issues/160), [#156](https://github.com/ptarmiganlabs/butler/issues/156).
+
+* Clarified that [Butler requires InfluxDB 1.x](https://butler.ptarmiganlabs.com/docs/getting-started/install/). InfluxDB 2.x is great, but bring breaking features wrt Butler. [#159](https://github.com/ptarmiganlabs/butler/issues/159).
+
+### Changed behavior and/or breaking changes
+
+## 5.3.0
+
+### New features
+
+1. Added REST API endpoint for getting a list of all keys that exist in a given key-value store namespace.
+   Useful when you need to iterate over all KV pairs in a namespace. ([#150](https://github.com/ptarmiganlabs/butler/issues/150))
+
+### Fixes and patches
+
+1. The parsing of the YAML config file is now a bit more robust and tolerant for sections that have a header but no contents. ([#152](https://github.com/ptarmiganlabs/butler/issues/152))
+
+### Changed behavior and/or breaking changes
+
 ## 5.2.0
 
 ### New features

src/.prettierignore

@@ -1 +1,2 @@
-dist
+dist
+node_modules

src/butler.js

@@ -46,17 +46,16 @@ var path = require('path'),
         globals.logger.info(`Codename       : ${globals.hostInfo.si.os.codename}`);
         globals.logger.info(`Virtual        : ${globals.hostInfo.si.system.virtual}`);
         globals.logger.info(`Processors     : ${globals.hostInfo.si.cpu.processors}`);
-        globals.logger.info(`Processors     : ${globals.hostInfo.si.cpu.processors}`);
         globals.logger.info(`Physical cores : ${globals.hostInfo.si.cpu.physicalCores}`);
         globals.logger.info(`Cores          : ${globals.hostInfo.si.cpu.cores}`);
         globals.logger.info(`Docker arch.   : ${globals.hostInfo.si.cpu.hypervizor}`);
         globals.logger.info(`Total memory   : ${globals.hostInfo.si.memory.total}`);
         globals.logger.info('--------------------------------------');
 
         // Log info about what Qlik Sense certificates are being used
-        globals.logger.debug(`Client cert: ${certFile}`);
-        globals.logger.debug(`Client cert key: ${keyFile}`);
-        globals.logger.debug(`CA cert: ${caFile}`);
+        globals.logger.info(`Client cert: ${certFile}`);
+        globals.logger.info(`Client cert key: ${keyFile}`);
+        globals.logger.info(`CA cert: ${caFile}`);
 
         // Set up anon telemetry reports, if enabled
         if (
@@ -355,6 +354,7 @@ if (globals.config.has('Butler.scheduler')) {
         scheduler.loadSchedulesFromDisk();
         // scheduler.launchAllSchedules();
     } else {
+        // eslint-disable-next-line quotes
         globals.logger.info("MAIN: Didn't load schedules from file");
     }
 }
@@ -379,7 +379,7 @@ if (globals.config.get('Butler.dockerHealthCheck.enable') == true) {
 
 // process.on('SIGUSR2', () => {
 //     // Run with
-//     // node -- expose-gc butler.js
+//    // node --expose-gc butler.js
 //     //
 //     // Trigger with
 //     // kill -SIGUSR2 $(pgrep -lfa node | grep butler.js | awk '{print $1}'

src/docker-compose.yaml

@@ -2,7 +2,7 @@
 version: '3.3'
 services:
   butler:
-    image: ptarmiganlabs/butler:5.3.0
+    image: ptarmiganlabs/butler:5.4.0
     container_name: butler
     restart: always
     ports:

src/lib/telemetry.js

@@ -62,7 +62,7 @@ var callRemoteURL = async function () {
             responseType: 'text',
         };
 
-        let response = await axios.request(axiosConfig);
+        await axios.request(axiosConfig);
         globals.logger.debug('TELEMETRY: Sent anonymous telemetry. Thanks for contributing to making Butler better!');
     } catch (err) {
         globals.logger.error('TELEMETRY: Could not send anonymous telemetry.');

src/package.json

@@ -1,6 +1,6 @@
 {
     "name": "butler",
-    "version": "5.3.0",
+    "version": "5.4.0",
     "description": "Superpowers for Qlik Sense. Task scheduling, key-value store, advanced alerting and more.",
     "dependencies": {
         "any-base": "^1.1.0",
@@ -14,7 +14,7 @@
         "fs-extra": "^9.1.0",
         "handlebars": "^4.7.7",
         "influx": "^5.8.0",
-        "js-yaml": "^4.0.0",
+        "js-yaml": "^4.1.0",
         "jshint": "^2.12.0",
         "keyv": "^4.0.3",
         "keyv-file": "^0.2.0",
@@ -41,7 +41,7 @@
         "uuid": "^8.3.2",
         "winston": "^3.3.3",
         "winston-daily-rotate-file": "^4.5.2",
-        "ws": "^7.4.4"
+        "ws": "^7.4.5"
     },
     "devDependencies": {
         "eslint": "7.24.0",

src/rest/senseStartTask.js

@@ -75,7 +75,7 @@ module.exports.respondPUT_senseStartTask = async function (req, res, next) {
             res.send(new errors.MissingParameterError({}, 'Required parameter missing'));
         } else {
             // Check if there is a message body. If there is, process all the items in it.
-            if (req.body) {
+            if (req.body && Object.keys(req.body).length > 0) {
                 for (const item of req.body) {
                     if (item.type == 'keyvaluestore') {
                         if (item.payload.namespace && item.payload.key && item.payload.value) {