2.32.0 Calendar module limitDays and excludedEvents stopped working

mumblebaj

@AndyHazz Do you mind sharing your ICS, anonymized off course.

sdetweil

comparing date AND TIME oops…

edit modules/default/calendar/calendar.js
approx line 708
change the lines marked below with //

		if (this.config.limitDays > 0) {
			let newEvents = [];
			let lastDate = today.clone().subtract(1, "days").startOf('day');  // add .startOf('day'), note dot
			let days = 0;
			for (const ev of events) {
				let eventDate = this.timestampToMoment(ev.startDate).startOf('day'); // add .startOf('day'), note dot

AndyHazz

@sdetweil nice! Yes that’s fixed the limitDays issue for me …

Now, how about part 2 of my issue, the excludedEvents config? The first event showing for me is titled ‘Tutor time’ despite that string being excluded. I’ve tried other terms with/without spaces and nothing seems to work to exclude events any more?

sdetweil

@AndyHazz working on it

sdetweil

@AndyHazz ok, got it too… this one looks like a javascript difference in scopes…
I added the Log.debug lines, they are not important
modules/default/calendar/calendarfetcherutils.js , starting line 18 (4 changes total)
see // change this line

	shouldEventBeExcluded (config, title) {
		let result = {  // change this line
			excluded: false,
			until: null
		};
		for (let f in config.excludedEvents) {
			let filter = config.excludedEvents[f],  // this line uses the same variable name, filter,   now we have two,
				testTitle = title.toLowerCase(),
				until = null,
				useRegex = false,
				regexFlags = "g";

			if (filter instanceof Object) {  
				if (typeof filter.until !== "undefined") {
					until = filter.until;
				}

				if (typeof filter.regex !== "undefined") {
					useRegex = filter.regex;
				}

				// If additional advanced filtering is added in, this section
				// must remain last as we overwrite the filter object with the
				// filterBy string
				if (filter.caseSensitive) {
					filter = filter.filterBy;
					testTitle = title;
				} else if (useRegex) {
					filter = filter.filterBy;
					testTitle = title;
					regexFlags += "i";
				} else {
					filter = filter.filterBy.toLowerCase();
				}
			} else {
				filter = filter.toLowerCase();
			}
			Log.debug("should be excluded ", testTitle, filter, useRegex, regexFlags)
			if (CalendarFetcherUtils.titleFilterApplies(testTitle, filter, useRegex, regexFlags)) {				
				if (until) {
					result.until = until;  // change this line
				} else {
					Log.debug("event should be excluded = true,", testTitle )
					result.excluded = true;  // change this line
				}
				Log.debug("filter applies result =", result)
				break;
			}
		}
		Log.debug("filter applies returning =", result)
		return result;  // change this line 
	},

AndyHazz

@sdetweil perhaps I’m missing something, but that’s not working for me - it’s made no difference, excluded events are still appearing … I’ve double checked and can’t spot anything amiss, I’ve made the 4 changes from ‘filter’ to ‘result’?

sdetweil

@AndyHazz hm…
my config parm for excluded Events

I added one event for saturday… without excluded it shows, with excluded it doesn’t

           excludedEvents: [
                'Birthday'
            ],

I checked the changed lines and only see those 4
- is old line
+ is new line

         * until: the date until the event should be excluded.
         */
        shouldEventBeExcluded (config, title) {
-               let filter = {
+               let result = {
                        excluded: false,
                        until: null
                };
@@ -52,17 +52,20 @@ const CalendarFetcherUtils = {
                        } else {
                                filter = filter.toLowerCase();
                        }
                       if (CalendarFetcherUtils.titleFilterApplies(testTitle, filter, useRegex, regexFlags)) {                         
                                if (until) {
-                                       filter.until = until;
+                                       result.until = until;
                                } else {
-                                       filter.excluded = true;
+                                       result.excluded = true;
                                }
                                break;
                        }
                }
-               return filter;
+               return result;
        },

AndyHazz

@sdetweil yep that’s what I’ve got, copying below in case I’m missing something …

I’ve also added your debug messages back in and changed Log.debug to console.log (as I still can’t get any debug logs from docker but I do get console.log messages from other modules) but nothing comes out in the console log - seems odd that all these changes have had zero effect, am I missing something that might be needed to get these changes to kick in?

        shouldEventBeExcluded (config, title) {
                let result = {  // CHANGED
                        excluded: false,
                        until: null
                };
                for (let f in config.excludedEvents) {
                        let filter = config.excludedEvents[f],
                                testTitle = title.toLowerCase(),
                                until = null,
                                useRegex = false,
                                regexFlags = "g";
                        if (filter instanceof Object) {
                                if (typeof filter.until !== "undefined") {
                                        until = filter.until;
                                }

                                if (typeof filter.regex !== "undefined") {
                                        useRegex = filter.regex;
                                }

                                // If additional advanced filtering is added in, this section
                                // must remain last as we overwrite the filter object with the
                                // filterBy string
                                if (filter.caseSensitive) {
                                        filter = filter.filterBy;
                                        testTitle = title;
                                } else if (useRegex) {
                                        filter = filter.filterBy;
                                        testTitle = title;
                                        regexFlags += "i";
                                } else {
                                        filter = filter.filterBy.toLowerCase();
                                }
                        } else {
                                filter = filter.toLowerCase();
                        }
                        console.log("should be excluded ", testTitle, filter, useRegex, regexFlags)
                        if (CalendarFetcherUtils.titleFilterApplies(testTitle, filter, useRegex, regexFlags)) {
                                if (until) {
                                        result.until = until;  // CHANGED
                                } else {
                                        console.log("event should be excluded = true,", testTitle )
                                        result.excluded = true;  // CHANGED
                                }
                                console.log("filter applies result =", result)
                                break;
                        }
                }
                console.log("filter applies returning =", result)
                return result;  // CHANGED
        },

p.s. just spotted comment on line 12 😅

TODO This seems like an overly complicated way to exclude events based on the title.

sdetweil

@AndyHazz note that the excluded events is an ARRAY (so for loop to look thru them )
test ALL til find one that is true (CalendarFetcherUtils.titleFilterApplies returns true) , or not

AND the item in the array can be an object with more specific controls, or a string

MM doc entries on separate lines

[
'Birthday',     // text 
'Hide This Event',    // text 
{filterBy: 'Payment', until: '6 days', caseSensitive: true},  // complex, but text
{filterBy: '^[0-9]{1,}.*', regex: true} // complex, uses regex
]

AND the list/array can be a MIX of those things,

and the string test is the test string is SOMEWHERE in the title, doesn’t have to BE the entire title

AndyHazz

@sdetweil fair enough, complexity no doubt warranted!

Perhaps is there any reason why shouldEventBeExcluded function might not be getting called at all for me? I’m stumped why after making all these changes including console.log messages, nothing is appearing any different -