Report headway-based service in schedule-for-stop frequencies - #1386
Report headway-based service in schedule-for-stop frequencies#1386ARCoder181105 wants to merge 5 commits into
Conversation
The handler returned an empty references block as soon as a stop had no routes, skipping the includeReferences check further down. A valid stop with no routes therefore answered with its own ID in entry.stopId and no matching record in references.stops. The early return was only an optimization. GetScheduleForStopOnDate expands an empty route ID slice to IN (NULL), so the normal path already returns no schedule rows and builds references correctly.
Route and agency references were collected from the schedule rows of the queried date, so both lists emptied out whenever no service was active -- a holiday, a date outside the feed's validity period, or an expired feed. The reference server keeps them populated in that case, since references describe the stop, not the day. Build them from the routes serving the stop instead. GetRoutesForStop already selects every column the route reference needs, so the GetRoutesByIDs round trip goes away, and agencies now derive from those routes rather than being seeded with the queried stop's own agency.
|
Warning Review limit reached
Next review available in: 24 minutes Limit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?Wait for the limit to reset, then comment An organization admin can change what happens after included review limits in Billing. How do review limits work?CodeRabbit enforces per-developer PR review limits within each organization. For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Repository UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (6)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
The no-service case only checked that routes and agencies came back non-empty, which passes just as well if the handler references the wrong routes. Derive the expected sets from the stop's own routes and compare against them, so the test fails if the reference contents drift.
The agency lookup ran first, so an unparseable date on an ID whose agency prefix does not exist answered 404 instead of the field error the reference server returns. The spec requires the field error to come back before any stop lookup is attempted. Check the date's format up front and keep resolving it to a service date below, where the agency's timezone is available.
Frequency-based trips were indistinguishable from fixed-schedule ones: the handler passed nil for a direction group's frequencies, so a stop served only on a headway answered with scheduleFrequencies empty and its headway trips listed as if each ran once. Batch-load each trip's frequency windows and route those trips into scheduleFrequencies instead of scheduleStopTimes, one entry per window, sorted by start time. A trip's headsign now weighs as many votes as the runs it is expected to make, so a frequent route no longer loses the representative-headsign vote to a single scheduled trip. The three parallel maps that carried a direction group's stop times and headsign votes are replaced by one accumulator type, since frequencies would otherwise have added a fourth. The RABA fixture has no frequencies.txt, so the test builds a feed that does and loads it through a new createTestApiWithFeed helper, leaving the shared fixture untouched.
a626167 to
85b6deb
Compare
|



Addresses #1031 (the
exact_times=0half;exact_times=1expansion follows in a separate PR).Stacked on #1385 — its three commits show up in this diff until it merges. Review the last commit here.
What changed
The handler passed
nilfor every direction group's frequencies, soscheduleFrequencieswas always empty and headway-based trips appeared inscheduleStopTimesas if each ran once a day.Each trip's frequency windows are now batch-loaded through the existing
GetFrequenciesForTripsquery, and a trip that has them is reported inscheduleFrequencies— one entry per window, sorted by start time — instead ofscheduleStopTimes. A trip may declare several windows in a day, and a direction group may hold both kinds of service at once.Two follow-on changes:
directionScheduleGroupper direction.Spec
Success Guarantees: "Frequency-based service, where present in the feed, is represented separately from fixed-schedule stop times." Extension 5a specifies such trips contribute to
scheduleFrequenciesinstead ofscheduleStopTimes, and step 7 specifies the run-count weighting for headsigns.No deployed OBA instance was available to verify against — neither the Puget Sound feed nor any other instance checked carries a
frequencies.txt— so this follows the wiki's Java line references rather than observed behaviour.ScheduleFrequencyemitsstopHeadsign,arrivalEnabledanddepartureEnabledas the wiki defines them.testdata/openapi.ymllists only the other six fields but does not forbid extras, so the conformance test passes on the superset.Tests
TestScheduleForStopHandlerFrequenciesruns end to end against a feed with headway service in both directions plus a direction mixing headway and fixed trips. The RABA fixture has nofrequencies.txt, so the test writes its own feed and loads it through a newcreateTestApiWithFeedhelper — the shared fixture is untouched, and no existing test changes behaviour.TestGroupScheduleRowsByRouteAndDirectiongains a case for window ordering, the stop-time/frequency split, and the vote weighting.