Release 2.14.0

.github/workflows/enforce-changelog.yml

@@ -0,0 +1,15 @@
+name: "Enforce Changelog"
+on:
+  pull_request:
+      types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
+
+jobs:
+  # Enforces the update of a changelog file on every pull request 
+  check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: dangoslen/changelog-enforcer@v1.6.1
+      with:
+        changeLogPath: 'CHANGELOG.md'
+        skipLabels: 'Skip Changelog'

.github/workflows/node-ci.js.yml

@@ -0,0 +1,35 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Automated Tests
+
+on:
+  push:
+    branches: [ master, develop ]
+  pull_request:
+    branches: [ master, develop ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: |
+        Xvfb :99 -screen 0 1024x768x16 &
+        export DISPLAY=:99
+        npm install
+        npm run test:prettier
+        npm run test:js
+        npm run test:css
+        npm run test:e2e
+        npm run test:unit

.gitignore

@@ -67,6 +67,10 @@ Temporary Items
 # Ignore changes to the custom css files.
 /css/custom.css
 
+# Ignore users config file but keep the sample.
+/config/*
+!/config/config.js.sample
+
 # Vim
 ## swap
 [._]*.s[a-w][a-z]

.prettierignore

@@ -2,3 +2,4 @@ package-lock.json
 /config/**/*
 /vendor/**/*
 !/vendor/vendor.js
+.github/**/*

CHANGELOG.md

@@ -5,6 +5,70 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/donate) With your help we can continue to improve the MagicMirror²
 
+## [2.14.0] - 2021-01-01
+
+Special thanks to the following contributors: @Alvinger, @AndyPoms, @ashishtank, @bluemanos, @flopp999, @jakemulley, @jakobsarwary1, @marvai-vgtu, @mirontoli, @rejas, @sdetweil, @Snille & @Sub028.
+
+ℹ️ **Note:** This update uses new dependencies. Please update using the following command: `git pull && npm install`.
+
+### Added
+
+- Added new log level "debug" to the logger.
+- Added new parameter "useKmh" to weather module for displaying wind speed as kmh.
+- Chuvash translation.
+- Added Weatherbit as a provider to Weather module.
+- Added SMHI as a provider to Weather module.
+- Added Hindi & Gujarati translation.
+- Added optional support for DEGREE position in Feels like translation.
+- Added support for variables in nunjucks templates for translate filter.
+- Added Chuvash translation.
+- Calendar: new options "limitDays" and "coloredEvents".
+- Added new option "limitDays" - limit the number of discreet days displayed.
+- Added new option "customEvents" - use custom symbol/color based on keyword in event title.
+- Added GitHub workflows for automated testing and changelog enforcement.
+
+### Updated
+
+- Merging .gitignore in the config-folder with the .gitignore in the root-folder.
+- Weather module - forecast now show TODAY and TOMORROW instead of weekday, to make it easier to understand.
+- Update dependencies to latest versions.
+- Update dependencies eslint, feedme, simple-git and socket.io to latest versions.
+- Update lithuanian translation.
+- Update config sample.
+- Highlight required version mismatch.
+- No select Text for TouchScreen use.
+- Corrected logic for timeFormat "relative" and "absolute".
+- Added missing function call in module.show()
+- Translator variables can have falsy values (e.g. empty string)
+- Fix issue with weather module with DEGREE label in FEELS like
+
+### Deleted
+
+- Removed Travis CI intergration.
+
+### Fixed
+
+- JSON Parse translation files with comments crashing UI. (#2149)
+- Calendar parsing where RRULE bug returns wrong date, add Windows timezone name support. (#2145, #2151)
+- Wrong node-ical version installed (package.json) requested version. (#2153)
+- Fix calendar fetcher subsequent timing. (#2160)
+- Rename Greek translation to correct ISO 639-1 alpha-2 code (gr > el). (#2155)
+- Add a space after icons of sunrise and sunset. (#2169)
+- Fix calendar when no DTEND record found in event, startDate overlay when endDate set. (#2177)
+- Fix windspeed convertion error in ukmetoffice weather provider. (#2189)
+- Fix console.debug not having timestamps. (#2199)
+- Fix calendar full day event east of UTC start time. (#2200)
+- Fix non-fullday recurring rule processing. (#2216)
+- Catch errors when parsing calendar data with ical. (#2022)
+- Fix Default Alert Module does not hide black overlay when alert is dismissed manually. (#2228)
+- Weather module - Always displays night icons when local is other then English. (#2221)
+- Update Node-ical 0.12.4 , fix invalid RRULE format in cal entries
+- Fix package.json for optional electron dependency (2378)
+- Update node-ical version again, 0.12.5, change RRULE fix (#2371, #2379)
+- Remove undefined objects from modules array (#2382)
+- Update node-ical version again, 0.12.7, change RRULE fix (#2371, #2379), node-ical now throws error (which we catch)
+- Update simple-git version to 2.31 unhandled promise rejection (#2383)
+
 ## [2.13.0] - 2020-10-01
 
 Special thanks to the following contributors: @bryanzzhu, @bugsounet, @chamakura, @cjbrunner, @easyas314, @larryare, @oemel09, @rejas, @sdetweil & @sthuber90.

README.md

@@ -5,8 +5,7 @@
 	<a href="https://david-dm.org/MichMich/MagicMirror#info=devDependencies"><img src="https://david-dm.org/MichMich/MagicMirror/dev-status.svg" alt="devDependency Status"></a>
 	<a href="https://bestpractices.coreinfrastructure.org/projects/347"><img src="https://bestpractices.coreinfrastructure.org/projects/347/badge"></a>
 	<a href="https://choosealicense.com/licenses/mit"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
-	<a href="https://travis-ci.com/MichMich/MagicMirror"><img src="https://travis-ci.com/MichMich/MagicMirror.svg" alt="Travis"></a>
-	<a href="https://snyk.io/test/github/MichMich/MagicMirror"><img src="https://snyk.io/test/github/MichMich/MagicMirror/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/MichMich/MagicMirror" style="max-width:100%;"></a>
+	<a href="https://github.com/MichMich/MagicMirror/actions?query=workflow%3A%22Automated+Tests%22"><img src="https://github.com/MichMich/MagicMirror/workflows/Automated%20Tests/badge.svg" alt="Tests"></a>
 </p>
 
 **MagicMirror²** is an open source modular smart mirror platform. With a growing list of installable modules, the **MagicMirror²** allows you to convert your hallway or bathroom mirror into your personal assistant. **MagicMirror²** is built by the creator of [the original MagicMirror](https://michaelteeuw.nl/tagged/magicmirror) with the incredible help of a [growing community of contributors](https://github.com/MichMich/MagicMirror/graphs/contributors).
@@ -40,6 +39,6 @@ If we receive enough donations we might even be able to free up some working hou
 To donate, please follow [this](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=G5D8E9MR5DTD2&source=url) link.
 
 <p align="center">
-<br>
+	<br>
 	<a href="https://forum.magicmirror.builders/topic/728/magicmirror-is-voted-number-1-in-the-magpi-top-50"><img src="https://magicmirror.builders/img/magpi-best-watermark-custom.png" width="150" alt="MagPi Top 50"></a>
 </p>

config/config.js.sample

@@ -28,7 +28,7 @@ var config = {
 	httpsCertificate: "", 	// HTTPS Certificate path, only require when useHttps is true
 
 	language: "en",
-	logLevel: ["INFO", "LOG", "WARN", "ERROR"],
+	logLevel: ["INFO", "LOG", "WARN", "ERROR"], // Add "DEBUG" for even more logging
 	timeFormat: 24,
 	units: "metric",
 	// serverOnly:  true/false/"local" ,
@@ -70,7 +70,7 @@ var config = {
 			position: "top_right",
 			config: {
 				location: "New York",
-				locationID: "", //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
+				locationID: "5128581", //ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
 				appid: "YOUR_OPENWEATHER_API_KEY"
 			}
 		},

css/main.css

@@ -2,6 +2,7 @@ html {
   cursor: none;
   overflow: hidden;
   background: #000;
+  user-select: none;
 }
 
 ::-webkit-scrollbar {

js/check_config.js

@@ -46,7 +46,7 @@ function checkConfigFile() {
 	try {
 		fs.accessSync(configFileName, fs.F_OK);
 	} catch (e) {
-		Log.log(Utils.colors.error(e));
+		Log.error(Utils.colors.error(e));
 		throw new Error("No permission to access config file!");
 	}
 

js/logger.js

@@ -10,7 +10,10 @@
 (function (root, factory) {
 	if (typeof exports === "object") {
 		// add timestamps in front of log messages
-		require("console-stamp")(console, "yyyy-mm-dd HH:MM:ss.l");
+		require("console-stamp")(console, {
+			pattern: "yyyy-mm-dd HH:MM:ss.l",
+			include: ["debug", "log", "info", "warn", "error"]
+		});
 
 		// Node, CommonJS-like
 		module.exports = factory(root.config);
@@ -20,10 +23,11 @@
 	}
 })(this, function (config) {
 	const logLevel = {
-		info: Function.prototype.bind.call(console.info, console),
+		debug: Function.prototype.bind.call(console.debug, console),
 		log: Function.prototype.bind.call(console.log, console),
-		error: Function.prototype.bind.call(console.error, console),
+		info: Function.prototype.bind.call(console.info, console),
 		warn: Function.prototype.bind.call(console.warn, console),
+		error: Function.prototype.bind.call(console.error, console),
 		group: Function.prototype.bind.call(console.group, console),
 		groupCollapsed: Function.prototype.bind.call(console.groupCollapsed, console),
 		groupEnd: Function.prototype.bind.call(console.groupEnd, console),

js/main.js

@@ -500,10 +500,7 @@ var MM = (function () {
 		 */
 		modulesStarted: function (moduleObjects) {
 			modules = [];
-			for (var m in moduleObjects) {
-				var module = moduleObjects[m];
-				modules[module.data.index] = module;
-			}
+			moduleObjects.forEach((module) => modules.push(module));
 
 			Log.info("All modules started!");
 			sendNotification("ALL_MODULES_STARTED");

js/module.js

@@ -175,8 +175,8 @@ var Module = Class.extend({
 			lstripBlocks: true
 		});
 
-		this._nunjucksEnvironment.addFilter("translate", function (str) {
-			return self.translate(str);
+		this._nunjucksEnvironment.addFilter("translate", function (str, variables) {
+			return self.translate(str, variables);
 		});
 
 		return this._nunjucksEnvironment;
@@ -228,7 +228,7 @@ var Module = Class.extend({
 	 * Set the module config and combine it with the module defaults.
 	 *
 	 * @param {object} config The combined module config.
-	 * @param {boolean} config Merge module config in deep.
+	 * @param {boolean} deep Merge module config in deep.
 	 */
 	setConfig: function (config, deep) {
 		this.config = deep ? configMerge({}, this.defaults, config) : Object.assign({}, this.defaults, config);
@@ -434,20 +434,22 @@ var Module = Class.extend({
 			speed,
 			function () {
 				self.resume();
-				callback;
+				callback();
 			},
 			options
 		);
 	}
 });
 
-/** Merging MagicMirror (or other) default/config script
- * merge 2 objects or/with array
- * using:
+/**
+ * Merging MagicMirror (or other) default/config script by @bugsounet
+ * Merge 2 objects or/with array
+ *
+ * Usage:
  * -------
  * this.config = configMerge({}, this.defaults, this.config)
  * -------
- * arg1: initial objet
+ * arg1: initial object
  * arg2: config model
  * arg3: config to merge
  * -------
@@ -456,10 +458,12 @@ var Module = Class.extend({
  * it don't merge all thing in deep
  * -> object in object and array is not merging
  * -------
- * @bugsounet
- * @Todo: idea of Mich determinate what do you want to merge or not
+ *
+ * Todo: idea of Mich determinate what do you want to merge or not
+ *
+ * @param {object} result the initial object
+ * @returns {object} the merged config
  */
-
 function configMerge(result) {
 	var stack = Array.prototype.slice.call(arguments, 1);
 	var item;
@@ -506,7 +510,7 @@ Module.register = function (name, moduleDefinition) {
 		if (cmpVersions(window.version, moduleDefinition.requiresVersion) >= 0) {
 			Log.log("Version is ok!");
 		} else {
-			Log.log("Version is incorrect. Skip module: '" + name + "'");
+			Log.warn("Version is incorrect. Skip module: '" + name + "'");
 			return;
 		}
 	}

js/server.js

@@ -37,7 +37,7 @@ var Server = function (config, callback) {
 	server.listen(port, config.address ? config.address : "localhost");
 
 	if (config.ipWhitelist instanceof Array && config.ipWhitelist.length === 0) {
-		Log.info(Utils.colors.warn("You're using a full whitelist configuration to allow for all IPs"));
+		Log.warn(Utils.colors.warn("You're using a full whitelist configuration to allow for all IPs"));
 	}
 
 	app.use(function (req, res, next) {
@@ -49,7 +49,7 @@ var Server = function (config, callback) {
 			res.status(403).send("This device is not allowed to access your mirror. <br> Please check your config.js or config.js.sample to change this.");
 		});
 	});
-	app.use(helmet());
+	app.use(helmet({ contentSecurityPolicy: false }));
 
 	app.use("/js", express.static(__dirname));
 	var directories = ["/config", "/css", "/fonts", "/modules", "/vendor", "/translations", "/tests/configs"];

js/translator.js

@@ -19,7 +19,15 @@ var Translator = (function () {
 		xhr.open("GET", file, true);
 		xhr.onreadystatechange = function () {
 			if (xhr.readyState === 4 && xhr.status === 200) {
-				callback(JSON.parse(xhr.responseText));
+				// needs error handler try/catch at least
+				let fileinfo = null;
+				try {
+					fileinfo = JSON.parse(xhr.responseText);
+				} catch (exception) {
+					// nothing here, but don't die
+					Log.error(" loading json file =" + file + " failed");
+				}
+				callback(fileinfo);
 			}
 		};
 		xhr.send(null);
@@ -60,7 +68,7 @@ var Translator = (function () {
 					template = variables.fallback;
 				}
 				return template.replace(new RegExp("{([^}]+)}", "g"), function (_unused, varName) {
-					return variables[varName] || "{" + varName + "}";
+					return varName in variables ? variables[varName] : "{" + varName + "}";
 				});
 			}
 

modules/default/alert/alert.js

@@ -100,10 +100,13 @@ Module.register("alert", {
 			message: image + message,
 			effect: this.config.alert_effect,
 			ttl: params.timer,
+			onClose: () => this.hide_alert(sender),
 			al_no: "ns-alert"
 		});
+
 		//Show alert
 		this.alerts[sender.name].show();
+
 		//Add timer to dismiss alert and overlay
 		if (params.timer) {
 			setTimeout(() => {