Merge pull request #1259 from opentripplanner/date-restricted-requests

only show routes from current service week

Author: miles-grant-ibigroup

__tests__/components/viewers/__snapshots__/nearby-view.js.snap

@@ -677,6 +677,8 @@ disableSingleItineraryDays: false
 #   maxRealtimeVehicleAge: 60
 #   # Interval for refreshing vehicle positions
 #   vehiclePositionRefreshSeconds: 30 # defaults to 30 seconds.
+#   # Enable this to restrict listing to routes active within the last to next Sunday
+#   onlyShowCurrentServiceWeek: true
 
 # API key to make Mapillary API calls. These are used to show street imagery.
 # Mapillary calls these "Client Tokens". They can be created at https://www.mapillary.com/dashboard/developers

example-config.yml

@@ -370,8 +370,8 @@ export function vehicleRentalQuery(
 export const fetchNearbyResponse = createAction('FETCH_NEARBY_RESPONSE')
 export const fetchNearbyError = createAction('FETCH_NEARBY_ERROR')
 
-export function fetchNearby(coords, map) {
-  return executeOTPAction('fetchNearby', coords, map)
+export function fetchNearby(coords, map, currentServiceWeek) {
+  return executeOTPAction('fetchNearby', coords, map, currentServiceWeek)
 }
 
 // Single trip lookup query

lib/actions/api.js

@@ -23,6 +23,7 @@ import {
   isValidSubsequence,
   queryIsValid
 } from '../util/state'
+import { getCurrentServiceWeek } from '../util/current-service-week'
 import {
   getRouteColorBasedOnSettings,
   getRouteIdForPattern,
@@ -380,14 +381,15 @@ export const fetchNearbyFromStopId = (stopId) => {
   )
 }
 
-export const fetchNearby = (position, radius) => {
+export const fetchNearby = (position, radius, currentServiceWeek) => {
   const { lat, lon } = position
 
   return createGraphQLQueryAction(
     `query Nearby(
       $lat: Float!
       $lon: Float!
       $radius: Int
+      $currentServiceWeek: LocalDateRangeInput
     ) {
       nearest(lat:$lat, lon:$lon, maxDistance: $radius, first: 100, filterByPlaceTypes: [STOP, VEHICLE_RENT, BIKE_PARK, CAR_PARK]) {
         edges {
@@ -437,11 +439,15 @@ export const fetchNearby = (position, radius) => {
                 lon
                 code
                 gtfsId
+                stopRoutes: routes (serviceDates: $currentServiceWeek) {
+                  gtfsId
+                }
                 stoptimesForPatterns {
                   pattern {
                     headsign
                     desc: name
                     route {
+                      gtfsId
                       agency {
                         name
                         gtfsId
@@ -475,7 +481,7 @@ export const fetchNearby = (position, radius) => {
         }
       }
     }`,
-    { lat, lon, radius },
+    { currentServiceWeek, lat, lon, radius },
     fetchNearbyResponse,
     fetchNearbyError,
     {
@@ -858,10 +864,18 @@ export const findRoute = (params) =>
 
 export function findRoutes() {
   return function (dispatch, getState) {
+    // Only calculate current service week if the setting for it is enabled
+    const currentServiceWeek =
+      getState().otp?.config?.routeViewer?.onlyShowCurrentServiceWeek === true
+        ? getCurrentServiceWeek()
+        : undefined
+
     dispatch(
       createGraphQLQueryAction(
-        `{
-          routes {
+        `query Routes(
+          $currentServiceWeek: LocalDateRangeInput
+         ) {
+          routes (serviceDates: $currentServiceWeek) {
             id: gtfsId
             agency {
               id: gtfsId
@@ -876,7 +890,7 @@ export function findRoutes() {
           }
         }
       `,
-        {},
+        { currentServiceWeek },
         findRoutesResponse,
         findRoutesError,
         {

lib/actions/apiV2.js

@@ -8,6 +8,7 @@ import * as apiActions from '../../../actions/api'
 import * as mapActions from '../../../actions/map'
 import * as uiActions from '../../../actions/ui'
 import { AppReduxState } from '../../../util/state-types'
+import { getCurrentServiceWeek } from '../../../util/current-service-week'
 import { SetLocationHandler, ZoomToPlaceHandler } from '../../util/types'
 import Loading from '../../narrative/loading'
 import MobileContainer from '../../mobile/container'
@@ -31,13 +32,19 @@ const AUTO_REFRESH_INTERVAL = 15000
 // TODO: use lonlat package
 type LatLonObj = { lat: number; lon: number }
 type CurrentPosition = { coords?: { latitude: number; longitude: number } }
+type ServiceWeek = { end: string; start: string }
 
 type Props = {
   currentPosition?: CurrentPosition
+  currentServiceWeek?: ServiceWeek
   defaultLatLon: LatLonObj | null
   displayedCoords?: LatLonObj
   entityId?: string
-  fetchNearby: (latLon: LatLonObj, radius?: number) => void
+  fetchNearby: (
+    latLon: LatLonObj,
+    radius?: number,
+    currentServiceWeek?: ServiceWeek
+  ) => void
   hideBackButton?: boolean
   location: string
   mobile?: boolean
@@ -102,6 +109,7 @@ function getNearbyCoordsFromUrlOrLocationOrMapCenter(
 
 function NearbyView({
   currentPosition,
+  currentServiceWeek,
   defaultLatLon,
   displayedCoords,
   entityId,
@@ -175,10 +183,10 @@ function NearbyView({
       firstItemRef.current?.scrollIntoView({ behavior: 'smooth' })
     }
     if (finalNearbyCoords) {
-      fetchNearby(finalNearbyCoords, radius)
+      fetchNearby(finalNearbyCoords, radius, currentServiceWeek)
       setLoading(true)
       const interval = setInterval(() => {
-        fetchNearby(finalNearbyCoords, radius)
+        fetchNearby(finalNearbyCoords, radius, currentServiceWeek)
         setLoading(true)
       }, AUTO_REFRESH_INTERVAL)
       return function cleanup() {
@@ -204,6 +212,16 @@ function NearbyView({
     finalNearbyCoords?.lat !== displayedCoords?.lat ||
     finalNearbyCoords?.lon !== displayedCoords?.lon
 
+  // Build list of nearby routes for filtering within the stop card
+  const nearbyRoutes = Array.from(
+    new Set(
+      nearby
+        ?.map((n: any) =>
+          n.place?.stopRoutes?.map((sr: { gtfsId?: string }) => sr?.gtfsId)
+        )
+        .flat(Infinity)
+    )
+  )
   const nearbyItemList =
     nearby?.map &&
     nearby?.map((n: any) => (
@@ -223,7 +241,7 @@ function NearbyView({
           /* eslint-disable-next-line jsx-a11y/no-noninteractive-tabindex */
           tabIndex={0}
         >
-          {getNearbyItem({ ...n.place, distance: n.distance })}
+          {getNearbyItem({ ...n.place, distance: n.distance, nearbyRoutes })}
         </div>
       </li>
     ))
@@ -290,15 +308,22 @@ function NearbyView({
 
 const mapStateToProps = (state: AppReduxState) => {
   const { config, location, transitIndex, ui } = state.otp
-  const { map } = state.otp.config
+  const { map, routeViewer } = config
   const { nearbyViewCoords } = ui
   const { nearby } = transitIndex
   const { entityId } = state.router.location.query
   const { currentPosition } = location
   const defaultLatLon =
     map?.initLat && map?.initLon ? { lat: map.initLat, lon: map.initLon } : null
+
+  const currentServiceWeek =
+    routeViewer?.onlyShowCurrentServiceWeek === true
+      ? getCurrentServiceWeek()
+      : undefined
+
   return {
     currentPosition,
+    currentServiceWeek,
     defaultLatLon,
     displayedCoords: nearby?.coords,
     entityId: entityId && decodeURIComponent(entityId),

lib/components/viewers/nearby/nearby-view.tsx

@@ -1,7 +1,6 @@
 import { Calendar } from '@styled-icons/fa-solid'
 import { connect } from 'react-redux'
 import { FormattedMessage } from 'react-intl'
-import { TransitOperator } from '@opentripplanner/types'
 import coreUtils from '@opentripplanner/core-utils'
 import React from 'react'
 
@@ -25,7 +24,7 @@ type Props = {
   homeTimezone: string
   nearbyViewConfig?: NearbyViewConfig
   routeSortComparator: (a: PatternStopTime, b: PatternStopTime) => number
-  stopData: StopData
+  stopData: StopData & { nearbyRoutes?: string[] }
 }
 
 const Stop = ({
@@ -70,6 +69,14 @@ const Stop = ({
       const sortedStopTimes = st.stoptimes.sort(
         (a: StopTime, b: StopTime) => fullTimestamp(a) - fullTimestamp(b)
       )
+      if (
+        // NearbyRoutes if present is populated with a list of routes that appear
+        // in the current service period.
+        stopData.nearbyRoutes &&
+        !stopData.nearbyRoutes.includes(st?.pattern?.route?.gtfsId)
+      ) {
+        return <></>
+      }
       return (
         <PatternRow
           alwaysShowLongName={nearbyViewConfig?.alwaysShowLongName}

lib/components/viewers/nearby/stop.tsx

@@ -360,6 +360,8 @@ export interface RouteViewerConfig {
   hideRouteShapesWithinFlexZones?: boolean
   /** Remove vehicles from the map if they haven't sent an update in a number of seconds */
   maxRealtimeVehicleAge?: number
+  /** Use OTP date limiting to only show current service week in list */
+  onlyShowCurrentServiceWeek?: boolean
   /** Disable vehicle highlight if necessary (e.g. custom or inverted icons) */
   vehicleIconHighlight?: boolean
   /** Customize vehicle icon padding (the default iconPadding is 2px in otp-ui) */

lib/util/config-types.ts

@@ -0,0 +1,10 @@
+import { addDays, nextSunday, previousSunday } from 'date-fns'
+/** Gets the current service week */
+export const getCurrentServiceWeek = (): {
+  end: string
+  start: string
+} => {
+  const start = previousSunday(new Date()).toISOString().split('T')[0]
+  const end = addDays(nextSunday(new Date()), 1).toISOString().split('T')[0]
+  return { end, start }
+}