Fixcaldates2 fix calendar module date processing, using node-ical@0.20.1 (#3587)

here is an updated test version of the fixes for all kinds of calendar
date problems.

NOTE: the changed branch name
NOTE: this used the node-cal@0.19.0 library UNCHANGED

best to make a new folder and git clone there

git clone https://github.com/sdetweil/MagicMirror
cd MagicMirror
git checkout fixcaldates2 // <------ note this is a changed branch name
npm run install-mm
copy your config.js and custom.css from the prior folder
and the non-default modules you have installed…

this ONLY changes the default calendar
but DOES ship an updated node-ical library too

if you need to fall back, just rename the folders around again so that
your original is called MagicMirror

all the testcases for node-ical and MagicMirror execute successfully.

the ‘BIG’ change here is to get the local NON-TZ dates for the
rrule.between()

all the checking and conversion code is commented out or not used
the node-ical fixes are for excluded dates (exdate) values being
adjusted for DST/STD time… waiting to submit that PR

one fix in calendar.js for checking if a past date was too far back,
but it never checked to see IF the event date was in the past… (before
today) so it chopped off too many

and one change in calendarfetcher.js to put out a better diagnostic
message of the parsed data… (exdate was excluded cause JSON stringify
couldn’t convert the complex structure)

I added the tests you all have documented

please re-pull and checkout the new branch (I deleted the old branch)
and npm run install-mm again

---------

Co-authored-by: Veeck <github@veeck.de>

Author: sdetweil

CHANGELOG.md

@@ -21,6 +21,7 @@ _This release is scheduled to be released on 2025-01-01._
 - [linter] Re-add `eslint-plugin-import`now that it supports ESLint v9 (#3586)
 - [linter] Re-activate `eslint-plugin-package-json` to lint `package.json`
 - [core] Add export on animation names
+- [calendar] - added ability to display end date for full date events, where end is not same day (showEnd=true)
 
 ### Removed
 
@@ -38,12 +39,16 @@ _This release is scheduled to be released on 2025-01-01._
 
 - [updatenotification] Fix pm2 using detection when pm2 script is inside or outside MagicMirror root folder (#3576) (#3605) (#3626) (#3628)
 - [core] Fix loading node_helper of modules: avoid black screen, display errors and continue loading with next module (#3578)
-- [weather] Changed default value for weatherEndpoint of provider openweathermap to "/onecall" (#3574)
-- [tests] Fix electron tests with mock dates, the mock on server side was missing (#3597)
-- [tests] Fix test cases with hard coded Date.now (#3597)
+- [weather] changed default value for weatherEndpoint of provider openweathermap to "/onecall" (#3574)
+- [tests] fix electron tests with mock dates, the mock on server side was missing (#3597)
+- [tests] fix testcases with hard coded Date.now (#3597)
 - [core] Fix missing `basePath` where `location.host` is used (#3613)
 - [compliments] croner library changed filenames used in latest version (#3624)
 - [linter] Fix ESLint ignore pattern which caused that default modules not to be linted (#3632)
+- [calendar] - update to resolve issues #3098 #3144 #3351 #3422 #3443 #3467 #3537 related to timezone changes
+- [calendar] - fixes #3267 (styles array), also fixes event with both exdate AND recurrence(and testcase)
+- [calendar] - fix showEndsOnlyWithDuration not working, #3598, applies ONLY to full day events
+- [calendar] - fix showEnd for Full Day events #3602
 - [tests] Suppress "module is not defined" in e2e tests
 
 ## [2.29.0] - 2024-10-01

modules/default/calendar/calendar.js

@@ -168,12 +168,17 @@ Module.register("calendar", {
 
 		this.selfUpdate();
 	},
+	notificationReceived (notification, payload, sender) {
 
-	// Override socket notification handler.
-	socketNotificationReceived (notification, payload) {
 		if (notification === "FETCH_CALENDAR") {
-			this.sendSocketNotification(notification, { url: payload.url, id: this.identifier });
+			if (this.hasCalendarURL(payload.url)) {
+				this.sendSocketNotification(notification, { url: payload.url, id: this.identifier });
+			}
 		}
+	},
+
+	// Override socket notification handler.
+	socketNotificationReceived (notification, payload) {
 
 		if (this.identifier !== payload.id) {
 			return;
@@ -417,18 +422,26 @@ Module.register("calendar", {
 					timeWrapper.innerHTML = CalendarUtils.capFirst(moment(event.startDate, "x").format(this.config.dateFormat));
 					// Add end time if showEnd
 					if (this.config.showEnd) {
-						if (this.config.showEndsOnlyWithDuration && event.startDate === event.endDate) {
-							// no duration here, don't display end
-						} else {
+						// and has a duation
+						if (event.startDate !== event.endDate) {
 							timeWrapper.innerHTML += "-";
 							timeWrapper.innerHTML += CalendarUtils.capFirst(moment(event.endDate, "x").format(this.config.dateEndFormat));
 						}
 					}
+
 					// For full day events we use the fullDayEventDateFormat
 					if (event.fullDayEvent) {
 						//subtract one second so that fullDayEvents end at 23:59:59, and not at 0:00:00 one the next day
 						event.endDate -= ONE_SECOND;
 						timeWrapper.innerHTML = CalendarUtils.capFirst(moment(event.startDate, "x").format(this.config.fullDayEventDateFormat));
+						// only show end if requested and allowed and the dates are different
+						if (this.config.showEnd && !this.config.showEndsOnlyWithDuration && moment(event.startDate, "x").format("YYYYMMDD") !== moment(event.endDate, "x").format("YYYYMMDD")) {
+							timeWrapper.innerHTML += "-";
+							timeWrapper.innerHTML += CalendarUtils.capFirst(moment(event.endDate, "x").format(this.config.fullDayEventDateFormat));
+						} else
+							if ((moment(event.startDate, "x").format("YYYYMMDD") !== moment(event.endDate, "x").format("YYYYMMDD")) && (moment(event.startDate, "x") < moment(now, "x"))) {
+								timeWrapper.innerHTML = CalendarUtils.capFirst(moment(now, "x").format(this.config.fullDayEventDateFormat));
+							}
 					} else if (this.config.getRelative > 0 && event.startDate < now) {
 						// Ongoing and getRelative is set
 						timeWrapper.innerHTML = CalendarUtils.capFirst(
@@ -460,16 +473,18 @@ Module.register("calendar", {
 					if (event.startDate >= now || (event.fullDayEvent && this.eventEndingWithinNextFullTimeUnit(event, ONE_DAY))) {
 						// Use relative time
 						if (!this.config.hideTime && !event.fullDayEvent) {
-							timeWrapper.innerHTML = CalendarUtils.capFirst(moment(event.startDate, "x").calendar(null, { sameElse: this.config.dateFormat }));
+							Log.debug("event not hidden and not fullday");
+							timeWrapper.innerHTML = `${CalendarUtils.capFirst(moment(event.startDate, "x").calendar(null, { sameElse: this.config.dateFormat }))}`;
 						} else {
-							timeWrapper.innerHTML = CalendarUtils.capFirst(
+							Log.debug("event full day or hidden");
+							timeWrapper.innerHTML = `${CalendarUtils.capFirst(
 								moment(event.startDate, "x").calendar(null, {
 									sameDay: this.config.showTimeToday ? "LT" : `[${this.translate("TODAY")}]`,
 									nextDay: `[${this.translate("TOMORROW")}]`,
 									nextWeek: "dddd",
 									sameElse: event.fullDayEvent ? this.config.fullDayEventDateFormat : this.config.dateFormat
 								})
-							);
+							)}`;
 						}
 						if (event.fullDayEvent) {
 							// Full days events within the next two days
@@ -488,9 +503,11 @@ Module.register("calendar", {
 									timeWrapper.innerHTML = CalendarUtils.capFirst(this.translate("DAYAFTERTOMORROW"));
 								}
 							}
+							Log.info("event fullday");
 						} else if (event.startDate - now < this.config.getRelative * ONE_HOUR) {
+							Log.info("not full day but within getrelative size");
 							// If event is within getRelative hours, display 'in xxx' time format or moment.fromNow()
-							timeWrapper.innerHTML = CalendarUtils.capFirst(moment(event.startDate, "x").fromNow());
+							timeWrapper.innerHTML = `${CalendarUtils.capFirst(moment(event.startDate, "x").fromNow())}`;
 						}
 					} else {
 						// Ongoing event
@@ -603,6 +620,7 @@ Module.register("calendar", {
 			const calendar = this.calendarData[calendarUrl];
 			let remainingEntries = this.maximumEntriesForUrl(calendarUrl);
 			let maxPastDaysCompare = now - this.maximumPastDaysForUrl(calendarUrl) * ONE_DAY;
+			let by_url_calevents = [];
 			for (const e in calendar) {
 				const event = JSON.parse(JSON.stringify(calendar[e])); // clone object
 
@@ -620,9 +638,6 @@ Module.register("calendar", {
 					if (this.config.hideDuplicates && this.listContainsEvent(events, event)) {
 						continue;
 					}
-					if (--remainingEntries < 0) {
-						break;
-					}
 				}
 
 				event.url = calendarUrl;
@@ -667,15 +682,21 @@ Module.register("calendar", {
 
 					for (let splitEvent of splitEvents) {
 						if (splitEvent.endDate > now && splitEvent.endDate <= future) {
-							events.push(splitEvent);
+							by_url_calevents.push(splitEvent);
 						}
 					}
 				} else {
-					events.push(event);
+					by_url_calevents.push(event);
 				}
 			}
+			by_url_calevents.sort(function (a, b) {
+				return a.startDate - b.startDate;
+			});
+			Log.debug(`pushing ${by_url_calevents.length} events to total with room for ${remainingEntries}`);
+			events = events.concat(by_url_calevents.slice(0, remainingEntries));
+			Log.debug(`events for calendar=${events.length}`);
 		}
-
+		Log.info(`sorting events count=${events.length}`);
 		events.sort(function (a, b) {
 			return a.startDate - b.startDate;
 		});
@@ -715,7 +736,7 @@ Module.register("calendar", {
 			}
 			events = newEvents;
 		}
-
+		Log.info(`slicing events total maxcount=${this.config.maximumEntries}`);
 		return events.slice(0, this.config.maximumEntries);
 	},
 

modules/default/calendar/calendarfetcher.js

@@ -56,7 +56,7 @@ const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEn
 
 				try {
 					data = ical.parseICS(responseData);
-					Log.debug(`parsed data=${JSON.stringify(data)}`);
+					Log.debug(`parsed data=${JSON.stringify(data, null, 2)}`);
 					events = CalendarFetcherUtils.filterEvents(data, {
 						excludedEvents,
 						includePastEvents,