feat(itinerary): add ability to sort itineraries by fare

__tests__/util/state.js

@@ -4,7 +4,8 @@ import '../test-utils/mock-window-url'
 import {
   addToSearches,
   isValidSubsequence,
-  queryIsValid
+  queryIsValid,
+  sortItineraries
 } from '../../lib/util/state'
 
 describe('util > state', () => {
@@ -99,4 +100,76 @@ describe('util > state', () => {
       expect(addToSearches(entries, spaceNeedle)).toEqual(tidiedEntries)
     })
   })
+  describe('sortItineraries', () => {
+    const makeItin = (transitFare) => ({ transitFare })
+
+    const itineraries = [
+      makeItin(100),
+      makeItin(200),
+      makeItin(undefined),
+      makeItin(50),
+      makeItin(null),
+      makeItin(0)
+    ]
+
+    it('sorts by FARE ascending (undefined/null last)', () => {
+      const sorted = [...itineraries].sort((a, b) =>
+        sortItineraries('FARE', 'ASC', a, b)
+      )
+      // Fares: 0, 50, 100, 200, undefined, null
+      expect(sorted.map((i) => i.transitFare)).toEqual([
+        0,
+        50,
+        100,
+        200,
+        undefined,
+        null
+      ])
+    })
+
+    it('sorts by FARE descending (undefined/null last)', () => {
+      const sorted = [...itineraries].sort((a, b) =>
+        sortItineraries('FARE', 'DESC', a, b)
+      )
+      // Fares: 200, 100, 50, 0, undefined, null
+      expect(sorted.map((i) => i.transitFare)).toEqual([
+        200,
+        100,
+        50,
+        0,
+        undefined,
+        null
+      ])
+    })
+
+    it('sorts undefined vs defined correctly', () => {
+      const a = makeItin(undefined)
+      const b = makeItin(100)
+      expect(sortItineraries('FARE', 'ASC', a, b)).toBe(1)
+      expect(sortItineraries('FARE', 'ASC', b, a)).toBe(-1)
+      expect(sortItineraries('FARE', 'DESC', a, b)).toBe(1)
+      expect(sortItineraries('FARE', 'DESC', b, a)).toBe(-1)
+    })
+
+    it('sorts null vs defined correctly', () => {
+      const a = makeItin(null)
+      const b = makeItin(100)
+      expect(sortItineraries('FARE', 'ASC', a, b)).toBe(1)
+      expect(sortItineraries('FARE', 'ASC', b, a)).toBe(-1)
+    })
+
+    it('sorts undefined vs null as equal', () => {
+      const a = makeItin(undefined)
+      const b = makeItin(null)
+      expect(sortItineraries('FARE', 'ASC', a, b)).toBe(0)
+      expect(sortItineraries('FARE', 'DESC', a, b)).toBe(0)
+    })
+
+    it('sorts 0 vs other fares correctly', () => {
+      const a = makeItin(0)
+      const b = makeItin(50)
+      expect(sortItineraries('FARE', 'ASC', a, b)).toBeLessThan(0)
+      expect(sortItineraries('FARE', 'DESC', a, b)).toBeGreaterThan(0)
+    })
+  })
 })

i18n/en-US.yml

@@ -377,6 +377,7 @@ components:
     selectCost: Cost
     selectDepartureTime: Departure time
     selectDuration: Duration
+    selectFare: Transit fare
     selectWalkTime: Walk time
     sortResults: Sort results
     viewAll: View all options

i18n/fr.yml

@@ -386,6 +386,7 @@ components:
     selectCost: Prix
     selectDepartureTime: Heure de départ
     selectDuration: Durée
+    selectFare: Prix du trajet
     selectWalkTime: Temps de marche
     sortResults: Trier les résultats
     viewAll: Toutes les options

lib/components/util/sortOptions.ts

@@ -12,7 +12,8 @@ export const sortOptions = (
     'ARRIVALTIME',
     'WALKTIME',
     'COST',
-    'DEPARTURETIME'
+    'DEPARTURETIME',
+    'FARE'
   ]
 ): SortOptionEntry[] => {
   const sortOptionsArray: SortOptionEntry[] = [
@@ -51,6 +52,12 @@ export const sortOptions = (
         id: 'components.NarrativeItinerariesHeader.selectCost'
       }),
       value: 'COST'
+    },
+    {
+      text: intl.formatMessage({
+        id: 'components.NarrativeItinerariesHeader.selectFare'
+      }),
+      value: 'FARE'
     }
   ]
 

lib/util/config-types.ts

@@ -264,6 +264,7 @@ export type ItinerarySortOption =
   | 'WALKTIME'
   | 'COST'
   | 'DEPARTURETIME'
+  | 'FARE'
 
 export interface ItineraryCostWeights {
   driveReluctance: number

lib/util/itinerary.tsx

@@ -48,6 +48,7 @@ export interface ItineraryWithCO2Info extends Itinerary {
 export interface ItineraryWithSortingCosts extends Itinerary {
   rank: number
   totalFare: number
+  transitFare?: number
 }
 
 export interface ItineraryFareSummary {
@@ -453,10 +454,12 @@ export function addSortingCosts<T extends Itinerary>(
     totalFareResult === null ? Number.MAX_VALUE : totalFareResult
 
   const rank = calculateItineraryCost(itinerary, config)
+  const transitFare = getFare(itinerary).transitFare
   return {
     ...itinerary,
     rank,
-    totalFare
+    totalFare,
+    transitFare
   }
 }
 

lib/util/state.js

@@ -33,6 +33,17 @@ export function getActiveSearch(state) {
   return state.otp.searches[state.otp.activeSearchId]
 }
 
+function compareItineraryFare(a, b, direction = 'ASC') {
+  const aMissing = a === undefined || a === null
+  const bMissing = b === undefined || b === null
+  // Always sort missing values (null/undefined) to the end of the array.
+  if (aMissing && bMissing) return 0
+  if (aMissing) return 1
+  if (bMissing) return -1
+  // If both fares are defined, compare them according to direction
+  return direction === 'ASC' ? a - b : b - a
+}
+
 /**
  * Array sort function for itineraries (in batch routing context) that attempts
  * to sort based on the type/direction specified.
@@ -50,6 +61,8 @@ export function sortItineraries(type, direction, a, b, config) {
       return dirFactor * (a.duration - b.duration)
     case 'COST':
       return dirFactor * (a.totalFare - b.totalFare)
+    case 'FARE':
+      return compareItineraryFare(a.transitFare, b.transitFare, direction)
     default:
       if (type !== 'BEST')
         console.warn(`Sort (${type}) not supported. Defaulting to BEST.`)