Merge pull request #771 from carrythebanner/event-ranges

Event range request improvements

Author: carrythebanner

app/endpoints/events.js

@@ -28,6 +28,8 @@ const config = require("../config");
 const { fromYMDString, to24HourString, toYMDString } = require("../util/dateTime");
 const { CalEvent } = require("../models/calEvent");
 const { CalDaily } = require("../models/calDaily");
+const { EventsRange } = require("../models/calConst");
+
 
 // the events endpoint:
 exports.get = function(req, res, next) {
@@ -58,11 +60,13 @@ exports.get = function(req, res, next) {
     if (!start.isValid() || !end.isValid()) {
       res.textError("need valid start and end times");
     } else {
-      const range = end.diff(start, 'day');
-      if (range < 0) {
-        res.textError("start date should be before end date");
-      } else if (range > 100) {
-        res.textError(`event range too large: ${range} days requested; max 100 days`);
+      // add 1 so days in range is inclusive
+      // e.g. (2025-06-10 - 2025-06-01 = 9 days difference) + 1 day = 10 day range
+      const range = end.diff(start, 'day') + 1;
+      if (range < 1) {
+        res.textError("end date cannot be before start date");
+      } else if (range > EventsRange.MaxDays) {
+        res.textError(`event range too large: ${range} days requested; max ${EventsRange.MaxDays} days`);
       } else {
         return CalDaily.getRangeVisible(start, end, includeAllEvents).then((dailies) => {
           return getSummaries(dailies).then((events) => {
@@ -113,16 +117,23 @@ function specialSummary(evt) {
 // expects days are dayjs objects
 // and count is the number of events between the two
 function getPagination(firstDay, lastDay, count) {
-  const range = lastDay.diff(firstDay, 'day');
-  const nextRangeStart = firstDay.add(range + 1, 'day');
-  const nextRangeEnd = lastDay.add(range + 1, 'day');
+  // add 1 so days in range is inclusive
+  const range = lastDay.diff(firstDay, 'day') + 1;
+
+  const prevRangeStart = firstDay.subtract(range, 'day');
+  const prevRangeEnd = lastDay.subtract(range, 'day');
+  const prev = getEventRangeUrl(prevRangeStart, prevRangeEnd);
+
+  const nextRangeStart = firstDay.add(range, 'day');
+  const nextRangeEnd = lastDay.add(range, 'day');
   const next = getEventRangeUrl(nextRangeStart, nextRangeEnd);
 
   return {
     start: toYMDString(firstDay),
     end: toYMDString(lastDay),
     range, // tbd: do we need to send this? can client determine from start, end?
     events: count,
+    prev,
     next,
   };
 }

app/models/calConst.js

@@ -42,5 +42,9 @@ const Review = Object.freeze({
   Revised   : 'R',
 });
 
+const EventsRange = Object.freeze({
+  MaxDays : 100,
+});
+
 //
-module.exports = { Area, Audience, DatesType, EventStatus, Review };
+module.exports = { Area, Audience, DatesType, EventStatus, Review, EventsRange };

site/themes/s2b_hugo_theme/assets/js/cal/helpers.js

@@ -31,6 +31,10 @@ const DEFAULT_AREA = 'P';
 const DEFAULT_AUDIENCE = 'G';
 const DEFAULT_LENGTH = '--';
 
+// total number of days to fetch, inclusive of start and end dates;
+// minimum of 1, maximum set by server
+const DEFAULT_DAYS_TO_FETCH = 10;
+
 const SITE_TITLE = "Shift";
 
 const API_VERSION = '3';

site/themes/s2b_hugo_theme/assets/js/cal/main.js

@@ -82,9 +82,6 @@ $(document).ready(function() {
         });
     }
 
-    // default range of days to show.
-    const dayRange = 10;
-
     // compute range and details settings from the url options.
     // the returned object gets passed to getEventHTML().
     function getInitialView(options) {
@@ -103,7 +100,8 @@ $(document).ready(function() {
           // 'from' is today; for other PP pages it's options startdate.
           startdate: from,
           // if there was an enddate, use it; otherwise use a fixed number of days.
-          enddate: options.enddate ? end : from.add(dayRange, 'day'),
+          // subtract 1 so range is inclusive
+          enddate: options.enddate ? end : from.add( (DEFAULT_DAYS_TO_FETCH - 1), 'day'),
           // pass this on to the events listing.
           show_details: options.show_details,
         };
@@ -130,9 +128,13 @@ $(document).ready(function() {
              lazyLoadEventImages();
              $(document).off('click', '#load-more')
                   .on('click', '#load-more', function(e) {
+                      // if there is a user-provided enddate, use that to set the day range (and add 1 so date range is inclusive);
+                      // otherwise, use the default range
+                      range = options.enddate ? (view.enddate.diff(view.startdate, 'day') + 1) : DEFAULT_DAYS_TO_FETCH;
+
                       // the next day to view is one day after the previous last
                       view.startdate = view.enddate.add(1, 'day');
-                      view.enddate = view.startdate.add(dayRange, 'day');
+                      view.enddate = view.startdate.add(range - 1, 'day');
                       // add new events to the end of those we've already added.
                       getEventHTML(view, function(eventHTML) {
                           $('#load-more').before(eventHTML);