apiV2.js

import {
  aggregateModes,
  getBannedRoutesFromSubmodes,
  populateSettingWithValue
} from '@opentripplanner/trip-form'
import { createAction } from 'redux-actions'
import { decodeQueryParams, DelimitedArrayParam } from 'use-query-params'
import clone from 'clone'
import coreUtils from '@opentripplanner/core-utils'

import { checkForRouteModeOverride } from '../util/config'
import {
  convertToPlace,
  getPersistenceMode,
  getUserWithEmail
} from '../util/user'
import { FETCH_STATUS } from '../util/constants'
import {
  generateModeSettingValues,
  getDefaultNumItineraries,
  getServiceStart
} from '../util/api'
import {
  getActiveItineraries,
  getActiveItinerary,
  getRouteOperator,
  isValidSubsequence,
  queryIsValid
} from '../util/state'
import { getCurrentServiceWeek } from '../util/current-service-week'
import {
  getRouteColorBasedOnSettings,
  getRouteIdForPattern,
  getRouteTextColorBasedOnSettings,
  routeIsValid
} from '../util/viewer'
import { isLastStop } from '../util/stop-times'

import { addToRecentSearches, rememberPlace } from './user'
import { countFlexModes } from './api-utils'
import {
  createQueryAction,
  fetchingStopTimesForStop,
  fetchNearbyError,
  fetchNearbyResponse,
  findGeometryForTrip,
  findRouteError,
  findRouteResponse,
  findRoutesError,
  findRoutesResponse,
  findStopTimesForStopError,
  findStopTimesForStopResponse,
  findStopTimesForTrip,
  findTripError,
  findTripResponse,
  receivedNearbyStopsError,
  receivedNearbyStopsResponse,
  receivedVehiclePositions,
  receivedVehiclePositionsError,
  rememberSearch,
  routingError,
  routingRequest,
  routingResponse,
  updateOtpUrlParams
} from './api'
import { RoutingQueryCallResult } from './api-constants'
import { setViewedNearbyCoords } from './ui'

const { generateCombinations, generateOtp2Query, SIMPLIFICATIONS } =
  coreUtils.queryGen
const { getTripOptionsFromQuery, getUrlParams } = coreUtils.query
const { convertGraphQLResponseToLegacy } = coreUtils.itinerary
const { randId } = coreUtils.storage

const LIGHT_GRAY = '666666'

function formatRecentPlace(place) {
  return convertToPlace({
    ...place,
    icon: 'clock-o',
    id: `recent-${randId()}`,
    timestamp: new Date().getTime(),
    type: 'recent'
  })
}

function formatRecentSearch(state, queryParamData) {
  return {
    id: randId(),
    query: getTripOptionsFromQuery(
      { ...state.otp.currentQuery, queryParamData },
      true
    ),
    timestamp: new Date().getTime()
  }
}

function isStoredPlace(place) {
  return ['home', 'work', 'suggested', 'stop'].indexOf(place.type) !== -1
}

/**
 * Generic helper for crafting GraphQL queries.
 */
function createGraphQLQueryAction(
  query,
  variables,
  responseAction,
  errorAction,
  options
) {
  const fetchOptions = {
    body: JSON.stringify({ batchId: options.batchId, query, variables }),
    headers: { 'Content-Type': 'application/json' },
    method: 'POST'
  }
  return createQueryAction(null, responseAction, errorAction, {
    ...options,
    fetchOptions,
    noThrottle: true,
    url: '/gtfs/v1'
  })
}

const findTrip = (params) =>
  createGraphQLQueryAction(
    `{
        trip(id: "${params.tripId}") {
          id: gtfsId
          route {
            id: gtfsId
            agency {
              id: gtfsId
              name
              url
              timezone
              lang
              phone
              fareUrl
            }
            shortName
            longName
            type
            url
            color
            textColor
            routeBikesAllowed: bikesAllowed
            bikesAllowed
          }
          serviceId
          tripHeadsign
          directionId
          blockId
          shapeId
          wheelchairAccessible
          bikesAllowed
          tripBikesAllowed: bikesAllowed

          stops {
			      id: gtfsId
			      stopId: gtfsId
			      code
			      name
			      lat
			      lon			
		      }

          tripGeometry {
            length
            points
          }
        }
      }`,
    {},
    findTripResponse,
    findTripError,
    {
      noThrottle: true,
      postprocess: (payload, dispatch) => {
        // FIXME: integrate into graphql request
        dispatch(findStopTimesForTrip({ tripId: params.tripId }))
        dispatch(findGeometryForTrip({ tripId: params.tripId }))
      },
      rewritePayload: (payload) => {
        if (!payload?.data?.trip) return {}

        payload.data.trip.geometry = payload.data.trip.tripGeometry
        return payload.data.trip
      }
    }
  )

export const vehicleRentalQuery = (
  params,
  responseAction,
  errorAction,
  options
) =>
  // TODO: ErrorsByNetwork is missing
  createGraphQLQueryAction(
    `{
    rentalVehicles {
      vehicleId
      id
      name
      lat
      lon
      allowPickupNow
      vehicleType {
        formFactor
      }
      network
    }
  }
  `,
    {},
    responseAction,
    errorAction,
    {
      noThrottle: true,
      postprocess: (payload, dispatch) => {
        if (payload.errors) {
          return errorAction(payload.errors)
        }
      },
      // TODO: most of this rewrites the OTP2 response to match OTP1.
      // we should re-write the rest of the UI to match OTP's behavior instead
      rewritePayload: (payload) => {
        return {
          stations: payload?.data?.rentalVehicles?.map((vehicle) => {
            return {
              allowPickup: vehicle.allowPickupNow,
              id: vehicle.vehicleId,
              isFloatingBike: vehicle?.vehicleType?.formFactor === 'BICYCLE',
              isFloatingVehicle: vehicle?.vehicleType?.formFactor === 'SCOOTER',
              name: vehicle.name,
              networks: [vehicle.network],
              x: vehicle.lon,
              y: vehicle.lat
            }
          })
        }
      }
    }
  )

// TODO: numberOfDepartures needs to come from config!
const stopTimeGraphQLQuery = `
stopTimes: stoptimesForPatterns(numberOfDepartures: 3) {
  pattern {
    desc: name
    headsign
    id: code
  }
  times: stoptimes {
    arrivalDelay
    departureDelay
    headsign
    realtime
    realtimeArrival
    realtimeDeparture
    realtimeState
    scheduledArrival
    scheduledDeparture
    serviceDay
    stop {
      id: gtfsId
    }
    timepoint
    trip {
      id
    }
  }
}
`

const stopGraphQLQuery = `
id: gtfsId
code
lat
lon
locationType
name
wheelchairBoarding
zoneId
geometries {
  geoJson
}
routes {
  id: gtfsId
  agency {
    gtfsId
    name
  }
  longName
  mode
  color
  textColor
  shortName
}
${stopTimeGraphQLQuery}
`

const findNearbyStops = ({ focusStopId, lat, lon, radius = 300 }) => {
  if (!focusStopId) return {}
  return createGraphQLQueryAction(
    `{
    stopsByRadius(lat: ${lat}, lon: ${lon}, radius: ${radius}) {
      edges {
        node {
          stop {
            ${stopGraphQLQuery}
          }
        }
      }
    }
  }`,
    {},
    receivedNearbyStopsResponse,
    receivedNearbyStopsError,
    {
      noThrottle: true,
      rewritePayload: (payload) => {
        return {
          focusStopId,
          stops: payload?.data?.stopsByRadius?.edges?.map((edge) => {
            const { stop } = edge.node
            return {
              ...stop,
              agencyId: stop?.route?.agency?.gtfsId,
              agencyName: stop?.route?.agency?.name
            }
          })
        }
      }
    }
  )
}

const mergeSameStops = (nearbyResponse) => {
  return nearbyResponse?.reduce((prev, { node }) => {
    const existingStop = prev.find(
      (stop) => stop.place.code === node.place.code
    )
    // Only merge if the stop has a code at all
    if (existingStop && node.place.code) {
      existingStop.place.stoptimesForPatterns = [
        ...(existingStop.place.stoptimesForPatterns || []),
        ...(node.place.stoptimesForPatterns || [])
      ]
    } else {
      prev.push(node)
    }
    return prev
  }, [])
}

/**
 * Causes the nearby view to be set to the coordinates of a stop
 * @param {stopId} GTFS Stop ID
 */
export const fetchNearbyFromStopId = (stopId) => {
  // Get a single stop based on its ID, i.e. value of field gtfsId (ID format is FeedId:StopId)
  return createGraphQLQueryAction(
    `query Stop(
      $stopId: String!
    ) {
      stop(id: $stopId) {
        lat
        lon
        gtfsId
        code
      }
    }
    `,
    { stopId },
    ({ data }) =>
      (dispatch) => {
        const { gtfsId, lat, lon } = data.stop
        dispatch(setViewedNearbyCoords({ gtfsId, lat, lon }))
      },
    () => () => {
      console.warn(`Error requesting data for stop ID ${stopId}.`)
    },
    {}
  )
}

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 {
          node {
            id
            distance
            place {
              __typename
              id
              lat
              lon
              ...on RentalVehicle {
                network
                name
                lat
                lon
                allowPickupNow
                operative
                rentalUris {
                  android
                  ios
                  web
                }
                vehicleType {
                  formFactor
                }
              }
              ... on VehicleRentalStation {
                network
              }
              ...on BikeRentalStation {
                bikesAvailable
                spacesAvailable
                name
                networks
              }
              ... on VehicleParking {
                carPlaces
                bicyclePlaces
                lat
                lon
                name
              }
              ... on Stop {
                name
                lat
                lon
                code
                gtfsId
                stopRoutes: routes (serviceDates: $currentServiceWeek) {
                  gtfsId
                }
                stoptimesForPatterns {
                  pattern {
                    headsign
                    desc: name
                    route {
                      gtfsId
                      agency {
                        name
                        gtfsId
                      }
                      shortName
                      type
                      mode
                      longName
                      color
                      textColor
                    }
                  }
                  stoptimes {
                    serviceDay
                    departureDelay
                    realtimeState
                    realtimeDeparture
                    scheduledDeparture
                    headsign
                    trip {
                      route {
                        shortName
                      }
                    }
                  }
                }
              }
            }
            distance
          }
        }
      }
    }`,
    { currentServiceWeek, lat, lon, radius },
    fetchNearbyResponse,
    fetchNearbyError,
    {
      rewritePayload: (payload) => {
        // Handle GraphQL error
        if (payload.errors) {
          const error = new Error('GraphQL response error')
          error.message =
            'Check error.cause for more information. Are the OTP server and client on compatible versions?'
          error.cause = payload.errors
          throw error
        }
        return {
          coords: { lat, lon },
          data: mergeSameStops(payload.data?.nearest?.edges)
        }
      }
    }
  )
}

export const findStopTimesForStop = (params) =>
  function (dispatch, getState) {
    // If the stop is already in the store, don't fetch it again, unless we are forcing a refetch
    if (!params.forceFetch && getState().otp.transitIndex.stops[params.stopId])
      return

    dispatch(fetchingStopTimesForStop(params))
    const { date, stopId } = params
    const timeZone = getState().otp.config.homeTimezone

    // Create a service date timestamp from 3:30am local.
    const serviceDay = getServiceStart(date, timeZone).getTime() / 1000

    return dispatch(
      createGraphQLQueryAction(
        `query StopTimes(
          $serviceDay: Long!
          $stopId: String!
        ) {
            stop(id: $stopId) {
              gtfsId
              code
              lat
              lon
              locationType
              name
              wheelchairBoarding
              routes {
                id: gtfsId
                agency {
                  gtfsId
                  name
                }
                longName
                mode
                color
                textColor
                shortName
                patterns {
                  id
                  headsign
                }
              }
              stoptimesForPatterns(numberOfDepartures: 1000, startTime: $serviceDay, omitNonPickups: true, omitCanceled: false) {
                pattern {
                  desc: name
                  headsign
                  id: code
                  route {
                    agency {
                      name
                      gtfsId
                    }
                    gtfsId
                  }
                }
                stoptimes {
                  headsign
                  scheduledDeparture
                  serviceDay
                  trip {
                    blockId
                    id
                    pattern {
                      id
                    }
                    route {
                      gtfsId
                    }
                  }
                }
              }
            }
        }`,
        {
          serviceDay,
          stopId
        },
        findStopTimesForStopResponse,
        findStopTimesForStopError,
        {
          noThrottle: true,
          rewritePayload: (payload) => {
            if (payload.errors) {
              return dispatch(findStopTimesForStopError(payload.errors))
            }
            const stopData = payload.data?.stop
            return {
              ...stopData,
              fetchStatus: FETCH_STATUS.FETCHED,
              stoptimesForPatterns: stopData?.stoptimesForPatterns
                // If this stop is the last stop on this pattern, don't include any stop times from that pattern.
                // (The schedule viewer doesn't show arrival times to a terminus stop.)
                .filter(({ pattern }) => !isLastStop(stopData?.gtfsId, pattern))
                // in some cases, the TriMet transit index will not return all routes
                // that serve a stop. Perhaps it doesn't return some routes if the
                // route only performs a drop-off at the stop... not quite sure. So a
                // check is needed to make sure we don't add data for routes not found
                // from the routes query.
                .filter(({ pattern }) => {
                  const routeId = getRouteIdForPattern(pattern)
                  const route = stopData.routes.find((r) => r.id === routeId)
                  return routeIsValid(route, routeId)
                }),
              stopTimesLastUpdated: new Date().getTime()
            }
          }
        }
      )
    )
  }

const getVehiclePositionsForRoute = (routeId) =>
  function (dispatch, getState) {
    return dispatch(
      createGraphQLQueryAction(
        `{
          route(id: "${routeId}") {
           patterns {
            vehiclePositions {
              vehicleId
              label
              lat
              lon
              stopRelationship {
                 status
                stop {
                  name
                  gtfsId
                }
              }
              speed
              heading
              lastUpdated
              trip {
                pattern {
                  id
                }
              }
            }
           }
         }
         }`,
        {},
        receivedVehiclePositions,
        receivedVehiclePositionsError,
        {
          noThrottle: true,
          rewritePayload: (payload) => {
            const vehicles = payload.data?.route?.patterns
              .reduce((prev, cur) => {
                return prev.concat(
                  cur?.vehiclePositions?.map((position) => {
                    return {
                      heading: position?.heading,
                      label: position?.label,
                      lat: position?.lat,
                      lon: position?.lon,
                      nextStopId: position?.stopRelationship?.stop?.gtfsId,
                      nextStopName: position?.stopRelationship?.stop?.name,
                      patternId: position?.trip?.pattern?.id,
                      seconds: position?.lastUpdated,
                      speed: position?.speed || 0,
                      stopStatus: position?.stopRelationship?.status,
                      vehicleId: position?.vehicleId
                    }
                  })
                )
              }, [])
              .filter((vehicle) => !!vehicle)
            return { routeId, vehicles }
          }
        }
      )
    )
  }

export const findRoute = (params) =>
  function (dispatch, getState) {
    const { routeId } = params
    if (!routeId) return

    return dispatch(
      createGraphQLQueryAction(
        `{
        route(id: "${routeId}") {
          id: gtfsId
          desc
          agency {
            id: gtfsId
            name
            url
            timezone
            lang
            phone
          }
          bikesAllowed
          color
          longName
          mode
          routeBikesAllowed: bikesAllowed
          shortName
          sortOrder
          textColor
          type
          url
      
          patterns {
            id
            headsign
            name
            patternGeometry {
              points
              length
            }
            stops {
              code
              id: gtfsId
              lat
              lon
              name
              locationType
              geometries {
                geoJson
              }
              routes {
                textColor
                color
              }
            }
          }
        }
      }
      `,
        {},
        findRouteResponse,
        findRouteError,
        {
          noThrottle: true,
          // TODO: avoid re-writing OTP2 route object to match OTP1 style
          rewritePayload: (payload) => {
            if (payload.errors) {
              return dispatch(findRouteError(payload.errors))
            }
            const { route } = payload?.data
            if (!route) return

            const newRoute = clone(route)
            const routePatterns = {}

            // Sort patterns by length to make algorithm below more efficient
            const patternsSortedByLength = newRoute.patterns.sort(
              (a, b) => a.stops.length - b.stops.length
            )

            // Remove all patterns that are subsets of larger patterns
            const filteredPatterns = patternsSortedByLength
              // Start with the largest for performance
              .reverse()
              .filter((pattern) => {
                // Compare to all other patterns TODO: make this beat O(n^2)
                return !patternsSortedByLength.find((p) => {
                  // Don't compare against ourself
                  if (p.id === pattern.id) return false

                  // If our pattern is longer, it's not a subset
                  if (p.stops.length <= pattern.stops.length) return false

                  return isValidSubsequence(
                    p.stops.map((s) => s.id),
                    pattern.stops.map((s) => s.id)
                  )
                })
              })

            // Fallback for if the filtering leaves us with a silly number of patterns
            // If this happens, it is not possible to know which pattern to keep
            ;(filteredPatterns.length > 1
              ? filteredPatterns
              : newRoute.patterns
            ).forEach((pattern) => {
              const patternStops = pattern.stops.map((stop) => {
                const color =
                  stop.routes?.length > 0 &&
                  `#${stop.routes[0]?.color || LIGHT_GRAY}`
                if (stop.routes) delete stop.routes
                return { ...stop, color }
              })
              routePatterns[pattern.id] = {
                ...pattern,
                desc: pattern.name,
                geometry: pattern?.patternGeometry || { length: 0, points: '' },
                stops: patternStops
              }
            })
            newRoute.origColor = newRoute.color
            newRoute.color = getRouteColorBasedOnSettings(
              getRouteOperator(
                {
                  agencyId: newRoute?.agency?.id,
                  id: newRoute?.id
                },
                getState().otp.config.transitOperators
              ),
              { color: newRoute?.color, mode: newRoute.mode }
            ).split('#')?.[1]

            newRoute.patterns = routePatterns
            // TODO: avoid explicit behavior shift like this
            newRoute.v2 = true
            newRoute.mode = checkForRouteModeOverride(
              newRoute,
              getState().otp.config?.routeModeOverrides
            )

            return newRoute
          }
        }
      )
    )
  }

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(
        `query Routes(
          $currentServiceWeek: LocalDateRangeInput
         ) {
          routes (serviceDates: $currentServiceWeek) {
            id: gtfsId
            agency {
              id: gtfsId
              name
            }
            color
            longName
            mode
            shortName
            sortOrder
            type
          }
        }
      `,
        { currentServiceWeek },
        findRoutesResponse,
        findRoutesError,
        {
          noThrottle: true,
          // TODO: avoid re-writing OTP2 route object to match OTP1 style
          rewritePayload: (payload) => {
            if (payload.errors) {
              return dispatch(findRoutesError(payload.errors))
            }
            const { routes } = payload?.data
            if (!routes) return

            const { config } = getState().otp
            // To initialize the route viewer,
            // convert the routes array to a dictionary indexed by route ids.
            return routes.reduce((result, route) => {
              const {
                agency,
                color: origColor,
                id,
                longName,
                mode,
                shortName,
                sortOrder,
                type
              } = route
              // Set color overrides if present
              const color = getRouteColorBasedOnSettings(
                getRouteOperator(
                  {
                    agencyId: route?.agency?.id,
                    id: route?.id
                  },
                  config.transitOperators
                ),
                {
                  color: route?.color,
                  mode: route.mode
                }
              ).split('#')?.[1]

              result[id] = {
                agencyId: agency.id,
                agencyName: agency.name,
                color,
                id,
                longName,
                mode: checkForRouteModeOverride(
                  { id, mode },
                  config?.routeModeOverrides
                ),
                origColor,
                shortName,
                sortOrder,
                type,
                v2: true
              }
              return result
            }, {})
          }
        }
      )
    )
  }
}

export const findPatternsForRoute = (params) =>
  function (dispatch, getState) {
    const state = getState()
    const { routeId } = params
    const route = state?.otp?.transitIndex?.routes?.[routeId]
    if (!route.patterns) {
      // TODO: since grabbbing only patterns would basically be the same query and
      // most crucially re-writing as findRoute() already does, we just make that request
      //
      // A proper graphQL implementation will only grab what data is needed when it is needed
      return dispatch(findRoute(params))
    }
  }

const queryParamConfig = { modeButtons: DelimitedArrayParam }

export function routingQuery(searchId = null, updateSearchInReducer) {
  // eslint-disable-next-line complexity
  return function (dispatch, getState) {
    const state = getState()
    const { config, currentQuery, modeSettingDefinitions } = state.otp
    const { planQuery } = config.api
    const { loggedInUser } = state.user
    const persistenceMode = getPersistenceMode(config.persistence)
    const activeItinerary =
      getActiveItinerary(state) ||
      (config.itinerary?.showFirstResultByDefault ? 0 : null)

    const isNewSearch = !searchId
    if (isNewSearch) searchId = randId()
    // Don't permit a routing query if the query is invalid
    if (!queryIsValid(state)) {
      console.warn('Query is invalid. Aborting routing query', currentQuery)
      return RoutingQueryCallResult.INVALID_QUERY
    }

    const {
      bannedTrips,
      date,
      departArrive,
      modes,
      numItineraries,
      routingType,
      time,
      unpreferred
    } = currentQuery
    const arriveBy = departArrive === 'ARRIVE'

    // Retrieve active mode keys from URL parameters or configuration defaults
    const urlSearchParams = new URLSearchParams(getUrlParams())
    const activeModeKeys =
      decodeQueryParams(queryParamConfig, {
        modeButtons: urlSearchParams.get('modeButtons')
      }).modeButtons ||
      config?.modes?.initialState?.enabledModeButtons ||
      {}

    const strictModes = !!config?.itinerary?.strictItineraryFiltering
    const validModeCombinations = config?.itinerary?.validModeCombinations

    // Filter mode definitions based on active mode keys
    const activeModeButtons = config.modes?.modeButtons.filter((mb) =>
      activeModeKeys.includes(mb.key)
    )
    const activeModes = aggregateModes(activeModeButtons)

    // Get mode setting values from the url, or initial state config, or default value in definition
    const modeSettingValues = generateModeSettingValues(
      urlSearchParams,
      modeSettingDefinitions,
      config?.modes?.initialState?.modeSettingValues
    )
    // TODO: walkReluctance is in here, but not when set via setQueryParam
    const modeSettings = modeSettingDefinitions?.map(
      populateSettingWithValue(modeSettingValues)
    )
    // Get the raw query param strings to save for the rider's search history
    const rawModeButtonQP = urlSearchParams.get('modeButtons')
    const queryParamData = {
      modeButtons: rawModeButtonQP,
      ...modeSettingValues
    }

    const excludedRoutes =
      config.routeModeOverrides &&
      getBannedRoutesFromSubmodes(
        modeSettings,
        config.routeModeOverrides
      )?.join(',')

    const baseQuery = {
      arriveBy,
      banned: {
        routes: excludedRoutes || undefined,
        trips: bannedTrips
      },
      date,
      from: currentQuery.from,
      modes: modes || activeModes,
      modeSettings,
      time,
      to: currentQuery.to,
      unpreferred,
      // TODO: Does this break everything?
      ...currentQuery,
      numItineraries: numItineraries || getDefaultNumItineraries(config)
    }
    if (config.mobilityProfile && loggedInUser) {
      baseQuery.mobilityProfile =
        getUserWithEmail(loggedInUser.dependentsInfo, currentQuery.forEmail)
          ?.mobilityMode || loggedInUser.mobilityProfile?.mobilityMode
    }
    // Generate combinations if the modes for query are not specified in the query
    // FIXME: BICYCLE_RENT does not appear in this list unless TRANSIT is also enabled.
    // This is likely due to the fact that BICYCLE_RENT is treated as a transit submode.
    let combinations = modes ? [baseQuery] : generateCombinations(baseQuery)

    // Pre-planConnection API hack: FLEX should always be bundled together.
    // The real solution is to change how we generate mode selections, but for now
    // this removes superfluous flex requests.
    combinations = combinations.filter((c) => {
      const flexCount = countFlexModes(c.modes)
      // We need either all 3 flex modes or none! Anything in-between is invalid
      return flexCount === 0 || flexCount === 3
    })

    if (combinations.length === 0) {
      return RoutingQueryCallResult.INVALID_MODE_SELECTION
    }

    dispatch(
      routingRequest({
        activeItinerary,
        pending: combinations.length,
        routingType,
        searchId,
        updateSearchInReducer
      })
    )

    dispatch(addToRecentSearches(searchId, baseQuery.modes))

    combinations.forEach((combo, index) => {
      const query = generateOtp2Query(combo)
      dispatch(
        createGraphQLQueryAction(
          planQuery || query.query,
          query.variables,
          (response) => {
            const dispatchedRoutingResponse = routingResponse(response)
            // If tracking is enabled, store locations and search after successful
            // search is completed.
            if (
              persistenceMode.isLocalStorage &&
              state.user?.localUser?.storeTripHistory
            ) {
              const { from, to } = currentQuery
              if (!isStoredPlace(from)) {
                dispatch(
                  rememberPlace({
                    location: formatRecentPlace(from),
                    type: 'recent'
                  })
                )
              }
              if (!isStoredPlace(to)) {
                dispatch(
                  rememberPlace({
                    location: formatRecentPlace(to),
                    type: 'recent'
                  })
                )
              }
              dispatch(
                rememberSearch(formatRecentSearch(state, queryParamData))
              )
            }
            return dispatchedRoutingResponse
          },
          (response) => {
            return routingError({ error: response, searchId })
          },
          {
            batchId: searchId,
            rewritePayload: (response, dispatch, getState) => {
              const itineraries = response.data?.plan?.itineraries

              // Convert user-selected transit modes from mode selector into modes recognized by OTP.
              const activeModeStrings = combo.modes.map(
                (am) => SIMPLIFICATIONS[am.mode]
              )

              let filteredItineraries = itineraries
              // If "strictItineraryFiltering" is enabled, only return itineraries that contain at least one explicitly requested mode...
              if (strictModes) {
                filteredItineraries = itineraries?.filter((itin) =>
                  itin.legs.some((leg) =>
                    activeModeStrings.includes(SIMPLIFICATIONS[leg.mode])
                  )
                )
                // If "acceptableValidModeCombos" is provided, filter out itineraries that do not match our list of valid mode combinations
                // (e.g. "WALK" + "DRIVE")
                // TODO: Remove this once we switch to planConnection API
                if (validModeCombinations?.length > 0) {
                  filteredItineraries = filteredItineraries.filter((itin) => {
                    const modeCombo = Array.from(
                      new Set(itin.legs.map((leg) => SIMPLIFICATIONS[leg.mode]))
                    )
                    return validModeCombinations.find(
                      (vc) =>
                        modeCombo.length === vc.length &&
                        vc.every((m) => modeCombo.includes(m))
                    )
                  })
                }

                // ... Otherwise return all itineraries.
              }

              // Filter itineraries to collapse short names and hide unnecessary errors.
              const withCollapsedShortNames = filteredItineraries?.map(
                (itin) => ({
                  ...itin,
                  legs: itin.legs
                    ?.map((leg) => {
                      const routeOperator = getRouteOperator(
                        {
                          agencyId: leg?.agency?.id,
                          id: leg?.route?.id
                        },
                        config.transitOperators
                      )
                      const routeProperties = {
                        color: leg?.route?.color,
                        mode: leg.mode
                      }

                      return {
                        ...leg,
                        origColor: leg?.route?.color,
                        route: {
                          ...leg.route,
                          color: getRouteColorBasedOnSettings(
                            routeOperator,
                            routeProperties
                          ).split('#')?.[1],
                          textColor: getRouteTextColorBasedOnSettings(
                            routeOperator,
                            routeProperties
                          ).split('#')?.[1]
                        }
                      }
                    })
                    ?.map((leg) => ({
                      ...convertGraphQLResponseToLegacy(leg),
                      route: leg.transitLeg ? leg.route : undefined
                    })),
                  otp2QueryParams: query.variables
                })
              )

              /* It is possible for a NO_TRANSIT_CONNECTION error to be
                returned even if trips were returned, since it is on a mode-by-mode basis.
                there is a chance for user confusion! 
                
               We'll reintroduce this error later once all the results are compiled */

              response.data.plan.routingErrors =
                response.data?.plan?.routingErrors.filter(
                  (re) => re?.code !== 'NO_TRANSIT_CONNECTION'
                )
              if (
                getActiveItineraries(getState())?.length > 0 &&
                response?.data?.plan
              ) {
                // Add accessibility error, if it is turned on
                const state = getState()
                const { displayA11yError } = state.otp.config?.itinerary
                if (displayA11yError) {
                  if (
                    response.data.plan.itineraries.find(
                      (itin) => !!itin?.accessibilityScore
                    )
                  ) {
                    if (!response.data.plan?.routingErrors) {
                      response.data.plan.routingErrors = []
                    }
                    response.data.plan.routingErrors.push({
                      code: 'OTP_RR_A11Y_ROUTING_ENABLED'
                    })
                  }
                }
              }

              return {
                index,
                response: {
                  plan: {
                    ...response.data?.plan,
                    itineraries: withCollapsedShortNames
                  },
                  requestId: searchId
                },
                searchId
              }
            }
          }
        )
      )
    })
    // Update OTP URL params if a new search. In other words, if we're
    // performing a search based on query params taken from the URL after a back
    // button press, we don't need to update the OTP URL.
    // TODO: For old searches that we are re-running, should we be **replacing**
    //  the URL params here (instead of **pushing** a new path to history like
    //  what currently happens in updateOtpUrlParams)? That way we could ensure
    //  that the path absolutely accurately reflects the app state.
    const params = getUrlParams()
    if (isNewSearch || params.ui_activeSearch !== searchId) {
      dispatch(updateOtpUrlParams(state, searchId))
    }

    return RoutingQueryCallResult.SUCCESS
  }
}

const requestingServiceTimeRange = createAction('SERVICE_TIME_RANGE_REQUEST')
const receivedServiceTimeRange = createAction('SERVICE_TIME_RANGE_RESPONSE')
const receivedServiceTimeRangeError = createAction('SERVICE_TIME_RANGE_ERROR')

/** Queries for service time range. */
const retrieveServiceTimeRangeIfNeeded = () =>
  function (dispatch, getState) {
    if (getState().otp.serviceTimeRange) return
    dispatch(requestingServiceTimeRange)
    return dispatch(
      createGraphQLQueryAction(
        `{
          serviceTimeRange {
            start
            end
          }
        }`,
        {},
        receivedServiceTimeRange,
        receivedServiceTimeRangeError,
        {}
      )
    )
  }

export default {
  fetchNearby,
  findPatternsForRoute,
  findRoute,
  findRoutes,
  findStopTimesForStop,
  findTrip,
  getVehiclePositionsForRoute,
  retrieveServiceTimeRangeIfNeeded,
  routingQuery,
  vehicleRentalQuery
}