Better exception_type=2 handing of calendar_dates

Author: brendannee

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Updated
+- Exclude calendar_dates.txt exception_type=2 if all dates within timetable are excluded
+
 ## [2.12.2] - 2025-12-04
 
 ### Fixed

src/lib/time-utils.ts

@@ -1,5 +1,9 @@
 import moment from 'moment';
 
+type CalendarBit = '0' | '1';
+export type CalendarCode =
+  `${CalendarBit}${CalendarBit}${CalendarBit}${CalendarBit}${CalendarBit}${CalendarBit}${CalendarBit}`;
+
 /*
  * Convert a GTFS formatted time string into a moment less than 24 hours.
  */
@@ -23,26 +27,26 @@ export function toGTFSTime(time) {
 /*
  * Convert a object of weekdays into a a string containing 1s and 0s.
  */
-export function calendarToCalendarCode(c: {
+export function calendarToCalendarCode(calendar: {
   monday?: null | 0 | 1;
   tuesday?: null | 0 | 1;
   wednesday?: null | 0 | 1;
   thursday?: null | 0 | 1;
   friday?: null | 0 | 1;
   saturday?: null | 0 | 1;
   sunday?: null | 0 | 1;
-}) {
-  if (Object.values(c).every((value) => value === null)) {
+}): CalendarCode | '' {
+  if (Object.values(calendar).every((value) => value === null)) {
     return '';
   }
 
-  return `${c.monday}${c.tuesday}${c.wednesday}${c.thursday}${c.friday}${c.saturday}${c.sunday}`;
+  return `${calendar.monday ?? '0'}${calendar.tuesday ?? '0'}${calendar.wednesday ?? '0'}${calendar.thursday ?? '0'}${calendar.friday ?? '0'}${calendar.saturday ?? '0'}${calendar.sunday ?? '0'}`;
 }
 
 /*
  * Convert a string of 1s and 0s representing a weekday to an object.
  */
-export function calendarCodeToCalendar(code) {
+export function calendarCodeToCalendar(code: CalendarCode) {
   const days = [
     'monday',
     'tuesday',
@@ -52,7 +56,15 @@ export function calendarCodeToCalendar(code) {
     'saturday',
     'sunday',
   ];
-  const calendar = {};
+  const calendar: {
+    monday?: null | 0 | 1;
+    tuesday?: null | 0 | 1;
+    wednesday?: null | 0 | 1;
+    thursday?: null | 0 | 1;
+    friday?: null | 0 | 1;
+    saturday?: null | 0 | 1;
+    sunday?: null | 0 | 1;
+  } = {};
 
   for (const [index, day] of days.entries()) {
     calendar[day] = code[index];
@@ -61,6 +73,54 @@ export function calendarCodeToCalendar(code) {
   return calendar;
 }
 
+/* Concert an object of weekdays and a date range into a list of dates. */
+export function calendarToDateList(
+  calendar: {
+    monday?: null | 0 | 1;
+    tuesday?: null | 0 | 1;
+    wednesday?: null | 0 | 1;
+    thursday?: null | 0 | 1;
+    friday?: null | 0 | 1;
+    saturday?: null | 0 | 1;
+    sunday?: null | 0 | 1;
+  },
+  startDate: number,
+  endDate: number | null,
+) {
+  if (!startDate || !endDate) {
+    return [];
+  }
+
+  const activeWeekdays = [
+    calendar.monday === 1 ? 1 : null,
+    calendar.tuesday === 1 ? 2 : null,
+    calendar.wednesday === 1 ? 3 : null,
+    calendar.thursday === 1 ? 4 : null,
+    calendar.friday === 1 ? 5 : null,
+    calendar.saturday === 1 ? 6 : null,
+    calendar.sunday === 1 ? 7 : null,
+  ].filter((weekday): weekday is number => weekday !== null);
+
+  if (activeWeekdays.length === 0) {
+    return [];
+  }
+
+  const activeWeekdaySet = new Set(activeWeekdays);
+  const dates = new Set<number>();
+  const date = moment(startDate.toString(), 'YYYYMMDD');
+  const endDateMoment = moment(endDate.toString(), 'YYYYMMDD');
+
+  while (date.isSameOrBefore(endDateMoment)) {
+    const isoWeekday = date.isoWeekday();
+    if (activeWeekdaySet.has(isoWeekday)) {
+      dates.add(parseInt(date.format('YYYYMMDD'), 10));
+    }
+    date.add(1, 'day');
+  }
+
+  return Array.from(dates);
+}
+
 /*
  * Get number of seconds after midnight of a GTFS formatted time string.
  */

src/lib/utils.ts

@@ -80,6 +80,7 @@ import {
   secondsAfterMidnight,
   fromGTFSTime,
   calendarCodeToCalendar,
+  calendarToDateList,
 } from './time-utils.js';
 import { formatTripNameForCSV } from './template-functions.js';
 
@@ -1022,14 +1023,14 @@ const getCalendarsFromTimetable = (timetable: Timetable) => {
 };
 
 /*
- * Get all calendar date service ids for an agency between two dates.
+ * Get all calendar dates for an agency between two dates.
  */
-const getCalendarDatesServiceIds = (
+const getCalendarDatesForDateRange = (
   startDate?: number | null,
   endDate?: number | null,
 ) => {
   const db = openDb();
-  const whereClauses = ['exception_type = 1'];
+  const whereClauses = [];
 
   if (endDate) {
     whereClauses.push(`date <= ${sqlString.escape(endDate)}`);
@@ -1041,12 +1042,12 @@ const getCalendarDatesServiceIds = (
 
   const calendarDates: CalendarDate[] = db
     .prepare(
-      `SELECT DISTINCT service_id FROM calendar_dates WHERE ${whereClauses.join(
+      `SELECT service_id, date, exception_type FROM calendar_dates WHERE ${whereClauses.join(
         ' AND ',
       )}`,
     )
     .all();
-  return calendarDates.map((calendarDate) => calendarDate.service_id);
+  return calendarDates;
 };
 
 /*
@@ -1398,14 +1399,73 @@ const formatTimetables = (timetables: Timetable[], config: Config) => {
     timetable.warnings = [];
     const dayList = formatDays(timetable, config);
     const calendars = getCalendarsFromTimetable(timetable);
-    let serviceIds = calendars.map((calendar: Calendar) => calendar.service_id);
+    const serviceIds = new Set();
+
+    // Add all service IDs from calendars
+    for (const calendar of calendars) {
+      serviceIds.add(calendar.service_id);
+    }
 
     if (timetable.include_exceptions === 1) {
-      const calendarDatesServiceIds = getCalendarDatesServiceIds(
+      const calendarDates = getCalendarDatesForDateRange(
         timetable.start_date,
         timetable.end_date,
       );
-      serviceIds = uniq([...serviceIds, ...calendarDatesServiceIds]);
+
+      const calendarDateGroups = groupBy(calendarDates, 'service_id');
+
+      for (const [serviceId, calendarDateGroup] of Object.entries(
+        calendarDateGroups,
+      )) {
+        // Check if there is a corresponding calendar.txt entry for this service_id
+        const calendar = calendars.find(
+          (c: Calendar) => c.service_id === serviceId,
+        );
+
+        // Add service_id if any dates are added
+        if (
+          calendarDateGroup.some(
+            (calendarDate) => calendarDate.exception_type === 1,
+          )
+        ) {
+          serviceIds.add(serviceId);
+        }
+
+        const calendarDateGroupExceptionType2 = calendarDateGroup.filter(
+          (calendarDate) => calendarDate.exception_type === 2,
+        );
+
+        // Check if ALL dates are excluded
+        if (
+          timetable.start_date &&
+          timetable.end_date &&
+          calendar &&
+          calendarDateGroupExceptionType2.length > 0
+        ) {
+          const datesDuringDateRange = calendarToDateList(
+            calendar,
+            timetable.start_date,
+            timetable.end_date,
+          );
+
+          // If no dates are are within the date range, remove service_id
+          if (datesDuringDateRange.length === 0) {
+            serviceIds.delete(serviceId);
+          }
+
+          // Check if every date is excluded and remove service_id if so
+          const everyDateIsExcluded = datesDuringDateRange.every(
+            (dateDuringDateRange) =>
+              calendarDateGroupExceptionType2.some(
+                (calendarDate) => calendarDate.date === dateDuringDateRange,
+              ),
+          );
+
+          if (everyDateIsExcluded) {
+            serviceIds.delete(serviceId);
+          }
+        }
+      }
     }
 
     Object.assign(timetable, {
@@ -1424,7 +1484,7 @@ const formatTimetables = (timetables: Timetable[], config: Config) => {
       noPickupSymbol: config.noPickupSymbol,
       interpolatedStopSymbol: config.interpolatedStopSymbol,
       orientation: timetable.orientation || config.defaultOrientation,
-      service_ids: serviceIds,
+      service_ids: Array.from(serviceIds),
       dayList,
       dayListLong: formatDaysLong(dayList, config),
     });