Better fixes for #3291 and the underlying exdate issues (#3342)

* Worked around several issues in the RRULE library that were causing
deleted calender events to still show, some initial and recurring events
to not show, and some event times to be off an hour. (#3291)
* Renamed variables in *calendarfetcherutils.js* to be more clear about
use of `moment` and js's `Date` class.
* Added calendar config option `forceUseCurrentTime` (default:`false`)
which will ignore overridden `Date.now` in the config in order to keep
some tests consistent.
* Added several unit tests for crossing DST in different timezones with
excluded events.

CHANGELOG.md

@@ -36,6 +36,13 @@ _This release is scheduled to be released on 2024-04-01._
 
 - Unneeded file headers (#3358)
 
+## [2.27.0] - UNRELEASED
+
+### Fixed
+
+- Worked around several issues in the RRULE library that were causing deleted calender events to still show, some
+  initial and recurring events to not show, and some event times to be off an hour. (#3291)
+
 ## [2.26.0] - 01-01-2024
 
 Thanks to: @bnitkin, @bugsounet, @dependabot, @jkriegshauser, @kaennchenstruggle, @KristjanESPERANTO and @Ybbet.

modules/default/calendar/calendar.js

@@ -36,6 +36,7 @@ Module.register("calendar", {
 		hideDuplicates: true,
 		showTimeToday: false,
 		colored: false,
+		forceUseCurrentTime: false,
 		tableClass: "small",
 		calendars: [
 			{
@@ -567,9 +568,16 @@ Module.register("calendar", {
 		const ONE_HOUR = ONE_MINUTE * 60;
 		const ONE_DAY = ONE_HOUR * 24;
 
-		const now = new Date();
-		const today = moment().startOf("day");
-		const future = moment().startOf("day").add(this.config.maximumNumberOfDays, "days").toDate();
+		let now, today, future;
+		if (this.config.forceUseCurrentTime || this.defaults.forceUseCurrentTime) {
+			now = new Date();
+			today = moment().startOf("day");
+			future = moment().startOf("day").add(this.config.maximumNumberOfDays, "days").toDate();
+		} else {
+			now = new Date(Date.now()); // Can use overridden time
+			today = moment(now).startOf("day");
+			future = moment(now).startOf("day").add(this.config.maximumNumberOfDays, "days").toDate();
+		}
 		let events = [];
 
 		for (const calendarUrl in this.calendarData) {

tests/configs/modules/calendar/custom.js

@@ -7,6 +7,7 @@ let config = {
 			position: "bottom_bar",
 			config: {
 				customEvents: [{ keyword: "CustomEvent", symbol: "dice", eventClass: "undo" }],
+				forceUseCurrentTime: true,
 				calendars: [
 					{
 						maximumEntries: 5,

tests/configs/modules/calendar/exdate_la_at_midnight_dst.js

@@ -0,0 +1,37 @@
+/* MagicMirror² Test calendar exdate
+ *
+ * By jkriegshauser
+ * MIT Licensed.
+ *
+ * See issue #3250
+ * See tests/electron/modules/calendar_spec.js
+ */
+let config = {
+	timeFormat: 12,
+
+	modules: [
+		{
+			module: "calendar",
+			position: "bottom_bar",
+			config: {
+				maximumEntries: 100,
+				calendars: [
+					{
+						maximumEntries: 100,
+						maximumNumberOfDays: 28, // 4 weeks, 2 of which are skipped
+						url: "http://localhost:8080/tests/mocks/exdate_la_at_midnight_dst.ics"
+					}
+				]
+			}
+		}
+	]
+};
+
+Date.now = () => {
+	return new Date("19 Oct 2023 12:30:00 GMT-07:00").valueOf();
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

tests/configs/modules/calendar/exdate_la_at_midnight_std.js

@@ -0,0 +1,37 @@
+/* MagicMirror² Test calendar exdate
+ *
+ * By jkriegshauser
+ * MIT Licensed.
+ *
+ * See issue #3250
+ * See tests/electron/modules/calendar_spec.js
+ */
+let config = {
+	timeFormat: 12,
+
+	modules: [
+		{
+			module: "calendar",
+			position: "bottom_bar",
+			config: {
+				maximumEntries: 100,
+				calendars: [
+					{
+						maximumEntries: 100,
+						maximumNumberOfDays: 28, // 4 weeks, 2 of which are skipped
+						url: "http://localhost:8080/tests/mocks/exdate_la_at_midnight_std.ics"
+					}
+				]
+			}
+		}
+	]
+};
+
+Date.now = () => {
+	return new Date("19 Oct 2023 12:30:00 GMT-07:00").valueOf();
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

tests/configs/modules/calendar/exdate_la_before_midnight.js

@@ -0,0 +1,37 @@
+/* MagicMirror² Test calendar exdate
+ *
+ * By jkriegshauser
+ * MIT Licensed.
+ *
+ * See issue #3250
+ * See tests/electron/modules/calendar_spec.js
+ */
+let config = {
+	timeFormat: 12,
+
+	modules: [
+		{
+			module: "calendar",
+			position: "bottom_bar",
+			config: {
+				maximumEntries: 100,
+				calendars: [
+					{
+						maximumEntries: 100,
+						maximumNumberOfDays: 28, // 4 weeks, 2 of which are skipped
+						url: "http://localhost:8080/tests/mocks/exdate_la_before_midnight.ics"
+					}
+				]
+			}
+		}
+	]
+};
+
+Date.now = () => {
+	return new Date("19 Oct 2023 12:30:00 GMT-07:00").valueOf();
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

tests/configs/modules/calendar/exdate_syd_at_midnight_dst.js

@@ -0,0 +1,37 @@
+/* MagicMirror² Test calendar exdate
+ *
+ * By jkriegshauser
+ * MIT Licensed.
+ *
+ * See issue #3250
+ * See tests/electron/modules/calendar_spec.js
+ */
+let config = {
+	timeFormat: 12,
+
+	modules: [
+		{
+			module: "calendar",
+			position: "bottom_bar",
+			config: {
+				maximumEntries: 100,
+				calendars: [
+					{
+						maximumEntries: 100,
+						maximumNumberOfDays: 28, // 4 weeks, 2 of which are skipped
+						url: "http://localhost:8080/tests/mocks/exdate_syd_at_midnight_dst.ics"
+					}
+				]
+			}
+		}
+	]
+};
+
+Date.now = () => {
+	return new Date("14 Sep 2023 12:30:00 GMT+10:00").valueOf();
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

tests/configs/modules/calendar/exdate_syd_at_midnight_std.js

@@ -0,0 +1,37 @@
+/* MagicMirror² Test calendar exdate
+ *
+ * By jkriegshauser
+ * MIT Licensed.
+ *
+ * See issue #3250
+ * See tests/electron/modules/calendar_spec.js
+ */
+let config = {
+	timeFormat: 12,
+
+	modules: [
+		{
+			module: "calendar",
+			position: "bottom_bar",
+			config: {
+				maximumEntries: 100,
+				calendars: [
+					{
+						maximumEntries: 100,
+						maximumNumberOfDays: 28, // 4 weeks, 2 of which are skipped
+						url: "http://localhost:8080/tests/mocks/exdate_syd_at_midnight_std.ics"
+					}
+				]
+			}
+		}
+	]
+};
+
+Date.now = () => {
+	return new Date("14 Sep 2023 12:30:00 GMT+10:00").valueOf();
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

tests/configs/modules/calendar/exdate_syd_before_midnight.js

@@ -0,0 +1,37 @@
+/* MagicMirror² Test calendar exdate
+ *
+ * By jkriegshauser
+ * MIT Licensed.
+ *
+ * See issue #3250
+ * See tests/electron/modules/calendar_spec.js
+ */
+let config = {
+	timeFormat: 12,
+
+	modules: [
+		{
+			module: "calendar",
+			position: "bottom_bar",
+			config: {
+				maximumEntries: 100,
+				calendars: [
+					{
+						maximumEntries: 100,
+						maximumNumberOfDays: 28, // 4 weeks, 2 of which are skipped
+						url: "http://localhost:8080/tests/mocks/exdate_syd_before_midnight.ics"
+					}
+				]
+			}
+		}
+	]
+};
+
+Date.now = () => {
+	return new Date("14 Sep 2023 12:30:00 GMT+10:00").valueOf();
+};
+
+/*************** DO NOT EDIT THE LINE BELOW ***************/
+if (typeof module !== "undefined") {
+	module.exports = config;
+}

tests/electron/helpers/global-setup.js

@@ -3,11 +3,11 @@
 // https://www.anycodings.com/1questions/958135/can-i-set-the-date-for-playwright-browser
 const { _electron: electron } = require("playwright");
 
-exports.startApplication = async (configFilename, systemDate = null, electronParams = ["js/electron.js"]) => {
+exports.startApplication = async (configFilename, systemDate = null, electronParams = ["js/electron.js"], timezone = "GMT") => {
 	global.electronApp = null;
 	global.page = null;
 	process.env.MM_CONFIG_FILE = configFilename;
-	process.env.TZ = "GMT";
+	process.env.TZ = timezone;
 	global.electronApp = await electron.launch({ args: electronParams });
 
 	await global.electronApp.firstWindow();
@@ -20,7 +20,7 @@ exports.startApplication = async (configFilename, systemDate = null, electronPar
 			if (systemDate) {
 				await global.page.evaluate((systemDate) => {
 					Date.now = () => {
-						return new Date(systemDate);
+						return new Date(systemDate).valueOf();
 					};
 				}, systemDate);
 			}