Daysback in timeline page has off-by-one issue

[Jun Omae]

When submitting form in timeline page with 1 in daysback field, the user expects searching events between yesterday of the from date and the from date (just one day). However, it actually searches events between 2 days ago of the from date and the from date.

Also, entering 0 in the daysback field, the timeline page treat as 1. As the result, it is unable to search events for just one day. Before Trac 1.2, entering 0 in the daysback field is able to search events for just one day.

trac/timeline/web_ui.py

@@ -174 +174 @@
 
         stop = fromdate
         start = to_datetime(stop.replace(tzinfo=None) -
-                            timedelta(days=daysback + 1), req.tz)
+                            timedelta(days=daysback), req.tz)
 
         # create author include and exclude sets
         include = set()

trac/timeline/tests/web_ui.py

@@ -225 +225 @@
                 yield ('test', 'Test')
 
             def get_timeline_events(self, req, start, stop, filters):
-                return iter(self._events or ())
+                for event in self._events:
+                    if start <= event[1] <= stop:
+                        yield event
 
             def render_timeline_event(self, context, field, event):
                 return event[3].render(context, field, event)
@@ -270 +272 @@
             ('test&2', datetime(2018, 3, 19, 23, 56, 12, 987654, utc),
              'Joe <joe@example.org>', Mock(render=render)),
         ]
-        req = MockRequest(self.env, path_info='/timeline',
-                          args={'format': 'rss'})
+        req = MockRequest(self.env, path_info='/timeline', tz=utc,
+                          args={'format': 'rss', 'daysback': '90',
+                                'from': '2018-04-30T00:00:00Z'})
         rv = self._process_request(req)
         self.assertEqual('timeline.rss', rv[0])
         self.assertEqual({'content_type': 'application/rss+xml'}, rv[2])
@@ -307 +310 @@
         self.assertEqual('<?xml version="1.0"?>', output[:21])
         minidom.parseString(output)  # verify valid xml
 
+    def test_daysback(self):
+        provider = self.timeline_event_providers['normal'](self.env)
+        provider._events = [
+            ('test', datetime(2025, 2, 19, 12, tzinfo=utc),
+             'trac', None),
+            ('test', datetime(2025, 2, 18, 12, tzinfo=utc),
+             'trac', None),
+        ]
+        req = MockRequest(self.env, path_info='/timeline', tz=utc,
+                          args={'from': '2025-02-19T00:00:00Z',
+                                'daysback': '1'})
+        rv = self._process_request(req)
+        data = rv[1]
+        events = data['events']
+        self.assertEqual(1, len(events))
+        self.assertEqual(datetime(2025, 2, 19, 12, tzinfo=utc),
+                         events[0]['datetime'])
+
     def _process_request(self, req):
         mod = TimelineModule(self.env)
-        req = MockRequest(self.env, path_info='/timeline',
-                          args={'format': 'rss'})
         self.assertTrue(mod.match_request(req))
         return mod.process_request(req)
 

[Jun Omae]

Proposed changes in [5cd8a7449/jomae.git] (jomae.git@t13871).

The issue is introduced in [14702]. Reconsidering the issue, I think we should simply restore allowing 0 to daysback field in timeline.

[Jun Omae]

Committed in [17887] and merged in [17888].