Merge branch 'develop' into feature/add-error-to-callback

CHANGELOG.md

@@ -19,7 +19,9 @@ _This release is scheduled to be released on 2021-04-01._
 - Portuguese translations for "MODULE_CONFIG_CHANGED" and PRECIP.
 - Respect parameter ColoredSymbolOnly also for custom events
 - Added a new parameter to hide time portion on relative times
-- [`module.show` has now the option for a callback on error.](https://github.com/MichMich/MagicMirror/pull/2439)
+- `module.show` has now the option for a callback on error.
+- Added locale to sample config file
+- Added support for self-signed certificates for the default calendar module (#466)
 
 ### Updated
 
@@ -32,7 +34,8 @@ _This release is scheduled to be released on 2021-04-01._
 - Moving weather provider specific code and configuration into each provider and making hourly part of the interface.
 - Bump electron to v11.
 - Dont update the DOM when a module is not displayed.
-- Cleaned up jsdoc.
+- Cleaned up jsdoc and tests.
+- Exposed logger as node module for easier access for 3rd party modules
 
 ### Removed
 

config/config.js.sample

@@ -28,6 +28,7 @@ var config = {
 	httpsCertificate: "", 	// HTTPS Certificate path, only require when useHttps is true
 
 	language: "en",
+	locale: "en-US",
 	logLevel: ["INFO", "LOG", "WARN", "ERROR"], // Add "DEBUG" for even more logging
 	timeFormat: 24,
 	units: "metric",

js/app.js

@@ -4,16 +4,17 @@
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-const fs = require("fs");
-const path = require("path");
-const Log = require(`${__dirname}/logger`);
-const Server = require(`${__dirname}/server`);
-const Utils = require(`${__dirname}/utils`);
-const defaultModules = require(`${__dirname}/../modules/default/defaultmodules`);
 
 // Alias modules mentioned in package.js under _moduleAliases.
 require("module-alias/register");
 
+const fs = require("fs");
+const path = require("path");
+const Log = require("logger");
+const Server = require(`${__dirname}/server`);
+const Utils = require(`${__dirname}/utils`);
+const defaultModules = require(`${__dirname}/../modules/default/defaultmodules`);
+
 // Get version number.
 global.version = require(`${__dirname}/../package.json`).version;
 Log.log("Starting MagicMirror: v" + global.version);

js/electron.js

@@ -2,7 +2,7 @@
 
 const electron = require("electron");
 const core = require("./app.js");
-const Log = require("./logger.js");
+const Log = require("logger");
 
 // Config
 let config = process.env.config ? JSON.parse(process.env.config) : {};

js/node_helper.js

@@ -5,7 +5,7 @@
  * MIT Licensed.
  */
 const Class = require("./class.js");
-const Log = require("./logger.js");
+const Log = require("logger");
 const express = require("express");
 
 const NodeHelper = Class.extend({

js/server.js

@@ -11,7 +11,7 @@ const ipfilter = require("express-ipfilter").IpFilter;
 const fs = require("fs");
 const helmet = require("helmet");
 
-const Log = require("./logger.js");
+const Log = require("logger");
 const Utils = require("./utils.js");
 
 /**

modules/default/calendar/calendar.js

@@ -58,7 +58,8 @@ Module.register("calendar", {
 		excludedEvents: [],
 		sliceMultiDayEvents: false,
 		broadcastPastEvents: false,
-		nextDaysRelative: false
+		nextDaysRelative: false,
+		selfSignedCert: false
 	},
 
 	requiresVersion: "2.1.0",
@@ -101,7 +102,8 @@ Module.register("calendar", {
 			var calendarConfig = {
 				maximumEntries: calendar.maximumEntries,
 				maximumNumberOfDays: calendar.maximumNumberOfDays,
-				broadcastPastEvents: calendar.broadcastPastEvents
+				broadcastPastEvents: calendar.broadcastPastEvents,
+				selfSignedCert: calendar.selfSignedCert
 			};
 			if (calendar.symbolClass === "undefined" || calendar.symbolClass === null) {
 				calendarConfig.symbolClass = "";
@@ -372,8 +374,8 @@ Module.register("calendar", {
 						} else {
 							timeWrapper.innerHTML = this.capFirst(
 								moment(event.startDate, "x").calendar(null, {
-									sameDay: "[Today]",
-									nextDay: "[Tomorrow]",
+									sameDay: "[" + this.translate("TODAY") + "]",
+									nextDay: "[" + this.translate("TOMORROW") + "]",
 									nextWeek: "dddd"
 								})
 							);
@@ -606,7 +608,8 @@ Module.register("calendar", {
 			titleClass: calendarConfig.titleClass,
 			timeClass: calendarConfig.timeClass,
 			auth: auth,
-			broadcastPastEvents: calendarConfig.broadcastPastEvents || this.config.broadcastPastEvents
+			broadcastPastEvents: calendarConfig.broadcastPastEvents || this.config.broadcastPastEvents,
+			selfSignedCert: calendarConfig.selfSignedCert || this.config.selfSignedCert
 		});
 	},
 

modules/default/calendar/calendarfetcher.js

@@ -4,7 +4,7 @@
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-const Log = require("../../../js/logger.js");
+const Log = require("logger");
 const ical = require("node-ical");
 const request = require("request");
 
@@ -25,9 +25,10 @@ const moment = require("moment");
  * @param {number} maximumNumberOfDays The maximum number of days an event should be in the future.
  * @param {object} auth The object containing options for authentication against the calendar.
  * @param {boolean} includePastEvents If true events from the past maximumNumberOfDays will be fetched too
+ * @param {boolean} selfSignedCert If true, the server certificate is not verified against the list of supplied CAs.
  * @class
  */
-const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, includePastEvents) {
+const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, includePastEvents, selfSignedCert) {
 	const self = this;
 
 	let reloadTimer = null;
@@ -51,6 +52,13 @@ const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEn
 			gzip: true
 		};
 
+		if (selfSignedCert) {
+			var agentOptions = {
+				rejectUnauthorized: false
+			};
+			opts.agentOptions = agentOptions;
+		}
+
 		if (auth) {
 			if (auth.method === "bearer") {
 				opts.auth = {

modules/default/calendar/node_helper.js

@@ -7,7 +7,7 @@
 const NodeHelper = require("node_helper");
 const validUrl = require("valid-url");
 const CalendarFetcher = require("./calendarfetcher.js");
-const Log = require("../../../js/logger");
+const Log = require("logger");
 
 module.exports = NodeHelper.create({
 	// Override start method.
@@ -19,7 +19,7 @@ module.exports = NodeHelper.create({
 	// Override socketNotificationReceived method.
 	socketNotificationReceived: function (notification, payload) {
 		if (notification === "ADD_CALENDAR") {
-			this.createFetcher(payload.url, payload.fetchInterval, payload.excludedEvents, payload.maximumEntries, payload.maximumNumberOfDays, payload.auth, payload.broadcastPastEvents, payload.id);
+			this.createFetcher(payload.url, payload.fetchInterval, payload.excludedEvents, payload.maximumEntries, payload.maximumNumberOfDays, payload.auth, payload.broadcastPastEvents, payload.selfSignedCert, payload.id);
 		}
 	},
 
@@ -34,9 +34,10 @@ module.exports = NodeHelper.create({
 	 * @param {number} maximumNumberOfDays The maximum number of days an event should be in the future.
 	 * @param {object} auth The object containing options for authentication against the calendar.
 	 * @param {boolean} broadcastPastEvents If true events from the past maximumNumberOfDays will be included in event broadcasts
+	 * @param {boolean} selfSignedCert If true, the server certificate is not verified against the list of supplied CAs.
 	 * @param {string} identifier ID of the module
 	 */
-	createFetcher: function (url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents, identifier) {
+	createFetcher: function (url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents, selfSignedCert, identifier) {
 		var self = this;
 
 		if (!validUrl.isUri(url)) {
@@ -47,7 +48,7 @@ module.exports = NodeHelper.create({
 		var fetcher;
 		if (typeof self.fetchers[identifier + url] === "undefined") {
 			Log.log("Create new calendar fetcher for url: " + url + " - Interval: " + fetchInterval);
-			fetcher = new CalendarFetcher(url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents);
+			fetcher = new CalendarFetcher(url, fetchInterval, excludedEvents, maximumEntries, maximumNumberOfDays, auth, broadcastPastEvents, selfSignedCert);
 
 			fetcher.onReceive(function (fetcher) {
 				self.sendSocketNotification("CALENDAR_EVENTS", {

modules/default/currentweather/node_helper.js

@@ -1,5 +1,5 @@
 const NodeHelper = require("node_helper");
-const Log = require("../../../js/logger");
+const Log = require("logger");
 
 module.exports = NodeHelper.create({
 	// Override start method.

modules/default/newsfeed/newsfeedfetcher.js

@@ -4,7 +4,7 @@
  * By Michael Teeuw https://michaelteeuw.nl
  * MIT Licensed.
  */
-const Log = require("../../../js/logger.js");
+const Log = require("logger");
 const FeedMe = require("feedme");
 const request = require("request");
 const iconv = require("iconv-lite");

modules/default/newsfeed/node_helper.js

@@ -8,7 +8,7 @@
 const NodeHelper = require("node_helper");
 const validUrl = require("valid-url");
 const NewsfeedFetcher = require("./newsfeedfetcher.js");
-const Log = require("../../../js/logger");
+const Log = require("logger");
 
 module.exports = NodeHelper.create({
 	// Override start method.

modules/default/updatenotification/node_helper.js

@@ -3,7 +3,7 @@ const simpleGits = [];
 const fs = require("fs");
 const path = require("path");
 const defaultModules = require(__dirname + "/../defaultmodules.js");
-const Log = require(__dirname + "/../../../js/logger.js");
+const Log = require("logger");
 const NodeHelper = require("node_helper");
 
 module.exports = NodeHelper.create({

modules/default/weatherforecast/node_helper.js

@@ -1,5 +1,5 @@
 const NodeHelper = require("node_helper");
-const Log = require("../../../js/logger");
+const Log = require("logger");
 
 module.exports = NodeHelper.create({
 	// Override start method.

package.json

@@ -89,7 +89,8 @@
 		"valid-url": "^1.0.9"
 	},
 	"_moduleAliases": {
-		"node_helper": "js/node_helper.js"
+		"node_helper": "js/node_helper.js",
+		"logger": "js/logger.js"
 	},
 	"engines": {
 		"node": ">=10"

serveronly/index.js

@@ -1,5 +1,5 @@
 const app = require("../js/app.js");
-const Log = require("../js/logger.js");
+const Log = require("logger");
 
 app.start(function (config) {
 	var bindAddress = config.address ? config.address : "localhost";

tests/configs/modules/calendar/auth-default.js

@@ -26,7 +26,7 @@ var config = {
 				calendars: [
 					{
 						maximumNumberOfDays: 10000,
-						url: "http://localhost:8011/tests/configs/data/calendar_test.ics",
+						url: "http://localhost:8080/tests/configs/data/calendar_test.ics",
 						auth: {
 							user: "MagicMirror",
 							pass: "CallMeADog"

tests/configs/modules/calendar/basic-auth.js

@@ -26,7 +26,7 @@ var config = {
 				calendars: [
 					{
 						maximumNumberOfDays: 10000,
-						url: "http://localhost:8010/tests/configs/data/calendar_test.ics",
+						url: "http://localhost:8080/tests/configs/data/calendar_test.ics",
 						auth: {
 							user: "MagicMirror",
 							pass: "CallMeADog",

tests/configs/modules/calendar/changed-port.js

@@ -0,0 +1,44 @@
+/* Magic Mirror Test config default calendar with auth by default
+ *
+ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com
+ * MIT Licensed.
+ */
+
+var config = {
+	port: 8080,
+	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"],
+
+	language: "en",
+	timeFormat: 12,
+	units: "metric",
+	electronOptions: {
+		webPreferences: {
+			nodeIntegration: true,
+			enableRemoteModule: true
+		}
+	},
+
+	modules: [
+		{
+			module: "calendar",
+			position: "bottom_bar",
+			config: {
+				calendars: [
+					{
+						maximumNumberOfDays: 10000,
+						url: "http://localhost:8010/tests/configs/data/calendar_test.ics",
+						auth: {
+							user: "MagicMirror",
+							pass: "CallMeADog"
+						}
+					}
+				]
+			}
+		}
+	]
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

tests/configs/modules/calendar/old-basic-auth.js

@@ -26,7 +26,7 @@ var config = {
 				calendars: [
 					{
 						maximumNumberOfDays: 10000,
-						url: "http://localhost:8012/tests/configs/data/calendar_test.ics",
+						url: "http://localhost:8080/tests/configs/data/calendar_test.ics",
 						user: "MagicMirror",
 						pass: "CallMeADog"
 					}

tests/e2e/global-setup.js

@@ -20,7 +20,7 @@ global.before(function () {
 });
 
 exports.getElectronPath = function () {
-	var electronPath = path.join(__dirname, "..", "..", "node_modules", ".bin", "electron");
+	let electronPath = path.join(__dirname, "..", "..", "node_modules", ".bin", "electron");
 	if (process.platform === "win32") {
 		electronPath += ".cmd";
 	}
@@ -42,9 +42,9 @@ exports.startApplication = function (options) {
 		options.startTimeout = 30000;
 	}
 
-	var app = new Application(options);
+	const app = new Application(options);
 	return app.start().then(function () {
-		assert.equal(app.isRunning(), true);
+		assert.strictEqual(app.isRunning(), true);
 		chaiAsPromised.transferPromiseness = app.transferPromiseness;
 		return app;
 	});
@@ -56,6 +56,6 @@ exports.stopApplication = function (app) {
 	}
 
 	return app.stop().then(function () {
-		assert.equal(app.isRunning(), false);
+		assert.strictEqual(app.isRunning(), false);
 	});
 };

tests/e2e/modules/calendar_spec.js

@@ -76,11 +76,11 @@ describe("Calendar module", function () {
 		});
 	});
 
-	describe("Basic auth", function () {
+	describe("Changed port", function () {
 		before(function () {
 			serverBasicAuth.listen(8010);
 			// Set config sample for use in test
-			process.env.MM_CONFIG_FILE = "tests/configs/modules/calendar/basic-auth.js";
+			process.env.MM_CONFIG_FILE = "tests/configs/modules/calendar/changed-port.js";
 		});
 
 		after(function (done) {
@@ -92,17 +92,23 @@ describe("Calendar module", function () {
 		});
 	});
 
+	describe("Basic auth", function () {
+		before(function () {
+			// Set config sample for use in test
+			process.env.MM_CONFIG_FILE = "tests/configs/modules/calendar/basic-auth.js";
+		});
+
+		it("should return TestEvents", function () {
+			return app.client.waitUntilTextExists(".calendar", "TestEvent", 10000);
+		});
+	});
+
 	describe("Basic auth by default", function () {
 		before(function () {
-			serverBasicAuth.listen(8011);
 			// Set config sample for use in test
 			process.env.MM_CONFIG_FILE = "tests/configs/modules/calendar/auth-default.js";
 		});
 
-		after(function (done) {
-			serverBasicAuth.close(done());
-		});
-
 		it("should return TestEvents", function () {
 			return app.client.waitUntilTextExists(".calendar", "TestEvent", 10000);
 		});
@@ -110,15 +116,10 @@ describe("Calendar module", function () {
 
 	describe("Basic auth backward compatibility configuration: DEPRECATED", function () {
 		before(function () {
-			serverBasicAuth.listen(8012);
 			// Set config sample for use in test
 			process.env.MM_CONFIG_FILE = "tests/configs/modules/calendar/old-basic-auth.js";
 		});
 
-		after(function (done) {
-			serverBasicAuth.close(done());
-		});
-
 		it("should return TestEvents", function () {
 			return app.client.waitUntilTextExists(".calendar", "TestEvent", 10000);
 		});

tests/e2e/modules/weather_spec.js

@@ -15,7 +15,8 @@ describe("Weather module", function () {
 
 	async function setup(responses) {
 		app = await helpers.startApplication({
-			args: ["js/electron.js"]
+			args: ["js/electron.js"],
+			waitTimeout: 100000
 		});
 
 		wdajaxstub.init(app.client, responses);
@@ -101,16 +102,7 @@ describe("Weather module", function () {
 				const weather = generateWeather();
 				await setup({ template, data: weather });
 
-				const wait = (time) => new Promise((resolve) => setTimeout(resolve, time));
-
-				var text = "";
-				do {
-					await wait(3000);
-					elem = await app.client.$(".compliments");
-					text = await elem.getText(".compliments .module-content span");
-				} while (text === "");
-
-				return expect(text.trim()).to.equal("snow");
+				return app.client.waitUntilTextExists(".compliments .module-content span", "snow");
 			});
 		});
 

tests/e2e/vendor_spec.js

@@ -28,7 +28,7 @@ describe("Vendors", function () {
 	});
 
 	describe("Get list vendors", function () {
-		var vendors = require(__dirname + "/../../vendor/vendor.js");
+		const vendors = require(__dirname + "/../../vendor/vendor.js");
 		Object.keys(vendors).forEach((vendor) => {
 			it(`should return 200 HTTP code for vendor "${vendor}"`, function () {
 				var urlVendor = "http://localhost:8080/vendor/" + vendors[vendor];