minotor 11.1.2 → 11.2.0

package/src/__e2e__/router.test.ts

@@ -3,44 +3,144 @@ import { describe, it } from 'node:test';
 
 import fs from 'fs';
 
-import { Query, Router, StopsIndex, Timetable } from '../router.js';
-import { timeFromString } from '../timetable/time.js';
+import {
+  Query,
+  RangeQuery,
+  Route,
+  Router,
+  Stop,
+  StopsIndex,
+  Timetable,
+} from '../router.js';
+import { timeFromString, timeToString } from '../timetable/time.js';
 
-const routes = [
+type StopRef = { name: string; platform?: string };
+
+type ExpectedVehicleLeg = {
+  from: StopRef;
+  to: StopRef;
+  departure: string;
+  arrival: string;
+  route: { type: string; name: string };
+};
+
+type ExpectedTransferLeg = {
+  from: StopRef;
+  to: StopRef;
+  type: string;
+  minTransferTime?: number;
+};
+
+type ExpectedAccessLeg = {
+  from: StopRef;
+  to: StopRef;
+  duration: number;
+};
+
+type ExpectedLeg = ExpectedVehicleLeg | ExpectedTransferLeg | ExpectedAccessLeg;
+
+const stopsPath = new URL('./timetable/stops.bin', import.meta.url).pathname;
+const timetablePath = new URL('./timetable/timetable.bin', import.meta.url)
+  .pathname;
+
+const stopsIndex = StopsIndex.fromData(fs.readFileSync(stopsPath));
+const timetable = Timetable.fromData(fs.readFileSync(timetablePath));
+const router = new Router(timetable, stopsIndex);
+
+/**
+ * Finds a station by its exact name. Asserts that exactly one STATION-type
+ * stop with that name exists so a typo in a test causes an immediate failure.
+ */
+function findStation(name: string): Stop {
+  const match = stopsIndex
+    .findStopsByName(name, 20)
+    .find((s) => s.name === name && s.locationType === 'STATION');
+  assert.ok(match, `Station not found: "${name}"`);
+  return match;
+}
+
+/**
+ * Converts an internal Stop to a StopRef used in expected leg data.
+ * Platform is omitted when the stop has none, keeping assertions concise.
+ */
+function toStopRef(stop: Stop): StopRef {
+  return stop.platform
+    ? { name: stop.name, platform: stop.platform }
+    : { name: stop.name };
+}
+
+/**
+ * Converts a Route's legs to the name-based format used in assertions.
+ */
+function toExpectedLegs(route: Route): ExpectedLeg[] {
+  return route.legs.map((leg) => {
+    if ('route' in leg) {
+      return {
+        from: toStopRef(leg.from),
+        to: toStopRef(leg.to),
+        departure: timeToString(leg.departureTime),
+        arrival: timeToString(leg.arrivalTime),
+        route: leg.route,
+      };
+    } else if ('type' in leg) {
+      return {
+        from: toStopRef(leg.from),
+        to: toStopRef(leg.to),
+        type: leg.type,
+        ...(leg.minTransferTime !== undefined && {
+          minTransferTime: leg.minTransferTime,
+        }),
+      };
+    } else {
+      return {
+        from: toStopRef(leg.from),
+        to: toStopRef(leg.to),
+        duration: leg.duration,
+      };
+    }
+  });
+}
+
+const pointRoutes: {
+  from: string;
+  to: string;
+  at: string;
+  legs: ExpectedLeg[];
+}[] = [
   {
-    from: 'Parent8504100',
-    to: 'Parent8504880',
+    from: 'Fribourg/Freiburg',
+    to: 'Moléson-sur-Gruyères',
     at: '08:30',
-    route: [
+    legs: [
       {
-        from: '8504100:0:2',
-        to: '8504086:0:2',
+        from: { name: 'Fribourg/Freiburg', platform: '2' },
+        to: { name: 'Bulle', platform: '2' },
         departure: '08:34',
         arrival: '09:10',
         route: { type: 'RAIL', name: 'RE2' },
       },
       {
-        from: '8504086:0:2',
-        to: '8504086:0:4',
+        from: { name: 'Bulle', platform: '2' },
+        to: { name: 'Bulle', platform: '4' },
         type: 'REQUIRES_MINIMAL_TIME',
         minTransferTime: 3,
       },
       {
-        from: '8504086:0:4',
-        to: '8504077:0:1',
+        from: { name: 'Bulle', platform: '4' },
+        to: { name: 'Gruyères', platform: '1' },
         departure: '09:20',
         arrival: '09:28',
         route: { type: 'RAIL', name: 'S51' },
       },
       {
-        from: '8504077:0:1',
-        to: '8577737:0:B',
+        from: { name: 'Gruyères', platform: '1' },
+        to: { name: 'Gruyères, gare', platform: 'B' },
         type: 'REQUIRES_MINIMAL_TIME',
         minTransferTime: 2,
       },
       {
-        from: '8577737:0:B',
-        to: '8504880:0:10000',
+        from: { name: 'Gruyères, gare', platform: 'B' },
+        to: { name: 'Moléson-sur-Gruyères' },
         departure: '09:33',
         arrival: '09:44',
         route: { type: 'BUS', name: '263' },
@@ -48,39 +148,39 @@ const routes = [
     ],
   },
   {
-    from: 'Parent8507000',
-    to: 'Parent8509253',
+    from: 'Bern',
+    to: 'St. Moritz',
     at: '12:30',
-    route: [
+    legs: [
       {
-        from: '8507000:0:8',
-        to: '8503000:0:33',
+        from: { name: 'Bern', platform: '8' },
+        to: { name: 'Zürich HB', platform: '33' },
         departure: '12:31',
         arrival: '13:28',
         route: { type: 'RAIL', name: 'IC1' },
       },
       {
-        from: '8503000:0:33',
-        to: '8503000:0:6',
+        from: { name: 'Zürich HB', platform: '33' },
+        to: { name: 'Zürich HB', platform: '6' },
         type: 'REQUIRES_MINIMAL_TIME',
         minTransferTime: 7,
       },
       {
-        from: '8503000:0:6',
-        to: '8509000:0:9',
+        from: { name: 'Zürich HB', platform: '6' },
+        to: { name: 'Chur', platform: '9' },
         departure: '13:38',
         arrival: '14:52',
         route: { type: 'RAIL', name: 'IC3' },
       },
       {
-        from: '8509000:0:9',
-        to: '8509000:0:10',
+        from: { name: 'Chur', platform: '9' },
+        to: { name: 'Chur', platform: '10' },
         type: 'REQUIRES_MINIMAL_TIME',
         minTransferTime: 3,
       },
       {
-        from: '8509000:0:10',
-        to: '8509253:0:1',
+        from: { name: 'Chur', platform: '10' },
+        to: { name: 'St. Moritz', platform: '1' },
         departure: '14:58',
         arrival: '16:55',
         route: { type: 'RAIL', name: 'IR38' },
@@ -88,20 +188,20 @@ const routes = [
     ],
   },
   {
-    from: 'Parent8500010',
-    to: 'Parent8721202',
+    from: 'Basel SBB',
+    to: 'Strasbourg',
     at: '16:50',
-    route: [
+    legs: [
       {
-        from: '8500010:0:33',
-        to: '8718213',
+        from: { name: 'Basel SBB', platform: '33' },
+        to: { name: 'Saint-Louis (Haut-Rhin)' },
         departure: '17:08',
         arrival: '17:16',
         route: { type: 'RAIL', name: 'TER' },
       },
       {
-        from: '8718213',
-        to: '8721202',
+        from: { name: 'Saint-Louis (Haut-Rhin)' },
+        to: { name: 'Strasbourg' },
         departure: '17:30',
         arrival: '18:39',
         route: { type: 'RAIL', name: 'K200' },
@@ -109,52 +209,52 @@ const routes = [
     ],
   },
   {
-    from: 'Parent8504100',
-    to: 'Parent8509073',
+    from: 'Fribourg/Freiburg',
+    to: 'Davos Platz',
     at: '08:30',
-    route: [
+    legs: [
       {
-        from: '8504100:0:3',
-        to: '8507000:0:10',
+        from: { name: 'Fribourg/Freiburg', platform: '3' },
+        to: { name: 'Bern', platform: '10' },
         departure: '08:33',
         arrival: '08:56',
         route: { type: 'RAIL', name: 'IR15' },
       },
       {
-        from: '8507000:0:10',
-        to: '8507000:0:2',
+        from: { name: 'Bern', platform: '10' },
+        to: { name: 'Bern', platform: '2' },
         type: 'REQUIRES_MINIMAL_TIME',
         minTransferTime: 6,
       },
       {
-        from: '8507000:0:2',
-        to: '8503000:0:34',
+        from: { name: 'Bern', platform: '2' },
+        to: { name: 'Zürich HB', platform: '34' },
         departure: '09:02',
         arrival: '09:58',
         route: { type: 'RAIL', name: 'IC81' },
       },
       {
-        from: '8503000:0:34',
-        to: '8503000:0:10',
+        from: { name: 'Zürich HB', platform: '34' },
+        to: { name: 'Zürich HB', platform: '10' },
         type: 'REQUIRES_MINIMAL_TIME',
         minTransferTime: 7,
       },
       {
-        from: '8503000:0:10',
-        to: '8509002:0:2',
+        from: { name: 'Zürich HB', platform: '10' },
+        to: { name: 'Landquart', platform: '2' },
         departure: '10:07',
         arrival: '11:11',
         route: { type: 'RAIL', name: 'IC3' },
       },
       {
-        from: '8509002:0:2',
-        to: '8509002:0:6',
+        from: { name: 'Landquart', platform: '2' },
+        to: { name: 'Landquart', platform: '6' },
         type: 'REQUIRES_MINIMAL_TIME',
         minTransferTime: 4,
       },
       {
-        from: '8509002:0:6',
-        to: '8509073:0:2',
+        from: { name: 'Landquart', platform: '6' },
+        to: { name: 'Davos Platz', platform: '2' },
         departure: '11:20',
         arrival: '12:27',
         route: { type: 'RAIL', name: 'RE13' },
@@ -162,123 +262,357 @@ const routes = [
     ],
   },
   {
-    from: 'Parent8504100',
-    to: 'Parent8504749',
+    from: 'Fribourg/Freiburg',
+    to: 'Plan-Francey',
     at: '09:00',
-    route: [
+    legs: [
       {
-        from: '8504100:0:2',
-        to: '8504086:0:2',
+        from: { name: 'Fribourg/Freiburg', platform: '2' },
+        to: { name: 'Bulle', platform: '2' },
         departure: '09:04',
         arrival: '09:40',
-        route: {
-          type: 'RAIL',
-          name: 'RE3',
-        },
+        route: { type: 'RAIL', name: 'RE3' },
       },
       {
-        from: '8504086:0:2',
-        to: '8504086:0:4',
+        from: { name: 'Bulle', platform: '2' },
+        to: { name: 'Bulle', platform: '4' },
         type: 'REQUIRES_MINIMAL_TIME',
         minTransferTime: 3,
       },
       {
-        from: '8504086:0:4',
-        to: '8504077:0:2',
+        from: { name: 'Bulle', platform: '4' },
+        to: { name: 'Gruyères', platform: '2' },
         departure: '09:50',
         arrival: '09:57',
-        route: {
-          type: 'RAIL',
-          name: 'S50',
-        },
+        route: { type: 'RAIL', name: 'S50' },
       },
       {
-        from: '8504077:0:2',
-        to: '8577737:0:B',
+        from: { name: 'Gruyères', platform: '2' },
+        to: { name: 'Gruyères, gare', platform: 'B' },
         type: 'REQUIRES_MINIMAL_TIME',
         minTransferTime: 2,
       },
       {
-        from: '8577737:0:B',
-        to: '8504880:0:10000',
+        from: { name: 'Gruyères, gare', platform: 'B' },
+        to: { name: 'Moléson-sur-Gruyères' },
         departure: '10:33',
         arrival: '10:44',
-        route: {
-          type: 'BUS',
-          name: '263',
-        },
+        route: { type: 'BUS', name: '263' },
       },
       {
-        from: '8504880:0:10000',
-        to: '8530024',
+        from: { name: 'Moléson-sur-Gruyères' },
+        to: { name: 'Moléson-sur-Gruyères (funi)' },
         type: 'REQUIRES_MINIMAL_TIME',
         minTransferTime: 2,
       },
       {
-        from: '8530024',
-        to: '8504749',
+        from: { name: 'Moléson-sur-Gruyères (funi)' },
+        to: { name: 'Plan-Francey' },
         departure: '11:00',
         arrival: '11:05',
-        route: {
-          type: 'FUNICULAR',
-          name: 'FUN',
-        },
+        route: { type: 'FUNICULAR', name: 'FUN' },
       },
     ],
   },
 ];
 
-const stopsPath = new URL('./timetable/stops.bin', import.meta.url).pathname;
-const timetablePath = new URL('./timetable/timetable.bin', import.meta.url)
-  .pathname;
+const rangeRoutes: {
+  from: string;
+  to: string;
+  earliest: string;
+  latest: string;
+  // Runs are listed latest-departure-first, matching Range RAPTOR's natural order.
+  runs: { departureTime: string; legs: ExpectedLeg[] }[];
+}[] = [
+  {
+    from: 'Fribourg/Freiburg',
+    to: 'Moléson-sur-Gruyères',
+    earliest: '08:00',
+    latest: '10:00',
+    runs: [
+      {
+        departureTime: '09:34',
+        legs: [
+          {
+            from: { name: 'Fribourg/Freiburg', platform: '2' },
+            to: { name: 'Bulle', platform: '2' },
+            departure: '09:34',
+            arrival: '10:10',
+            route: { type: 'RAIL', name: 'RE2' },
+          },
+          {
+            from: { name: 'Bulle', platform: '2' },
+            to: { name: 'Bulle', platform: '4' },
+            type: 'REQUIRES_MINIMAL_TIME',
+            minTransferTime: 3,
+          },
+          {
+            from: { name: 'Bulle', platform: '4' },
+            to: { name: 'Gruyères', platform: '1' },
+            departure: '10:20',
+            arrival: '10:28',
+            route: { type: 'RAIL', name: 'S51' },
+          },
+          {
+            from: { name: 'Gruyères', platform: '1' },
+            to: { name: 'Gruyères, gare', platform: 'B' },
+            type: 'REQUIRES_MINIMAL_TIME',
+            minTransferTime: 2,
+          },
+          {
+            from: { name: 'Gruyères, gare', platform: 'B' },
+            to: { name: 'Moléson-sur-Gruyères' },
+            departure: '10:33',
+            arrival: '10:44',
+            route: { type: 'BUS', name: '263' },
+          },
+        ],
+      },
+      {
+        departureTime: '08:34',
+        legs: [
+          {
+            from: { name: 'Fribourg/Freiburg', platform: '2' },
+            to: { name: 'Bulle', platform: '2' },
+            departure: '08:34',
+            arrival: '09:10',
+            route: { type: 'RAIL', name: 'RE2' },
+          },
+          {
+            from: { name: 'Bulle', platform: '2' },
+            to: { name: 'Bulle', platform: '4' },
+            type: 'REQUIRES_MINIMAL_TIME',
+            minTransferTime: 3,
+          },
+          {
+            from: { name: 'Bulle', platform: '4' },
+            to: { name: 'Gruyères', platform: '1' },
+            departure: '09:20',
+            arrival: '09:28',
+            route: { type: 'RAIL', name: 'S51' },
+          },
+          {
+            from: { name: 'Gruyères', platform: '1' },
+            to: { name: 'Gruyères, gare', platform: 'B' },
+            type: 'REQUIRES_MINIMAL_TIME',
+            minTransferTime: 2,
+          },
+          {
+            from: { name: 'Gruyères, gare', platform: 'B' },
+            to: { name: 'Moléson-sur-Gruyères' },
+            departure: '09:33',
+            arrival: '09:44',
+            route: { type: 'BUS', name: '263' },
+          },
+        ],
+      },
+    ],
+  },
+  {
+    from: 'Basel SBB',
+    to: 'Strasbourg',
+    earliest: '16:00',
+    latest: '18:00',
+    runs: [
+      {
+        departureTime: '17:21',
+        legs: [
+          {
+            from: { name: 'Basel SBB', platform: '31' },
+            to: { name: 'Strasbourg' },
+            departure: '17:21',
+            arrival: '18:39',
+            route: { type: 'RAIL', name: 'TER' },
+          },
+        ],
+      },
+      {
+        departureTime: '16:38',
+        legs: [
+          {
+            from: { name: 'Basel SBB', platform: '33' },
+            to: { name: 'Saint-Louis (Haut-Rhin)' },
+            departure: '16:38',
+            arrival: '16:46',
+            route: { type: 'RAIL', name: 'TER' },
+          },
+          {
+            from: { name: 'Saint-Louis (Haut-Rhin)' },
+            to: { name: 'Strasbourg' },
+            departure: '16:54',
+            arrival: '18:09',
+            route: { type: 'RAIL', name: 'K200' },
+          },
+        ],
+      },
+    ],
+  },
+  {
+    from: 'Fribourg/Freiburg',
+    to: 'Davos Platz',
+    earliest: '08:00',
+    latest: '09:00',
+    runs: [
+      {
+        departureTime: '08:33',
+        legs: [
+          {
+            from: { name: 'Fribourg/Freiburg', platform: '3' },
+            to: { name: 'Bern', platform: '10' },
+            departure: '08:33',
+            arrival: '08:56',
+            route: { type: 'RAIL', name: 'IR15' },
+          },
+          {
+            from: { name: 'Bern', platform: '10' },
+            to: { name: 'Bern', platform: '2' },
+            type: 'REQUIRES_MINIMAL_TIME',
+            minTransferTime: 6,
+          },
+          {
+            from: { name: 'Bern', platform: '2' },
+            to: { name: 'Zürich HB', platform: '34' },
+            departure: '09:02',
+            arrival: '09:58',
+            route: { type: 'RAIL', name: 'IC81' },
+          },
+          {
+            from: { name: 'Zürich HB', platform: '34' },
+            to: { name: 'Zürich HB', platform: '10' },
+            type: 'REQUIRES_MINIMAL_TIME',
+            minTransferTime: 7,
+          },
+          {
+            from: { name: 'Zürich HB', platform: '10' },
+            to: { name: 'Landquart', platform: '2' },
+            departure: '10:07',
+            arrival: '11:11',
+            route: { type: 'RAIL', name: 'IC3' },
+          },
+          {
+            from: { name: 'Landquart', platform: '2' },
+            to: { name: 'Landquart', platform: '6' },
+            type: 'REQUIRES_MINIMAL_TIME',
+            minTransferTime: 4,
+          },
+          {
+            from: { name: 'Landquart', platform: '6' },
+            to: { name: 'Davos Platz', platform: '2' },
+            departure: '11:20',
+            arrival: '12:27',
+            route: { type: 'RAIL', name: 'RE13' },
+          },
+        ],
+      },
+      {
+        departureTime: '08:03',
+        legs: [
+          {
+            from: { name: 'Fribourg/Freiburg', platform: '3' },
+            to: { name: 'Zürich HB', platform: '33' },
+            departure: '08:03',
+            arrival: '09:28',
+            route: { type: 'RAIL', name: 'IC1' },
+          },
+          {
+            from: { name: 'Zürich HB', platform: '33' },
+            to: { name: 'Zürich HB', platform: '4' },
+            type: 'REQUIRES_MINIMAL_TIME',
+            minTransferTime: 7,
+          },
+          {
+            from: { name: 'Zürich HB', platform: '4' },
+            to: { name: 'Landquart', platform: '2' },
+            departure: '09:38',
+            arrival: '10:41',
+            route: { type: 'RAIL', name: 'IC3' },
+          },
+          {
+            from: { name: 'Landquart', platform: '2' },
+            to: { name: 'Landquart', platform: '6' },
+            type: 'REQUIRES_MINIMAL_TIME',
+            minTransferTime: 4,
+          },
+          {
+            from: { name: 'Landquart', platform: '6' },
+            to: { name: 'Davos Platz', platform: '1' },
+            departure: '10:49',
+            arrival: '12:03',
+            route: { type: 'RAIL', name: 'RE24' },
+          },
+        ],
+      },
+    ],
+  },
+];
 
 describe('E2E Tests for Transit Router', () => {
-  const stopsIndex = StopsIndex.fromData(fs.readFileSync(stopsPath));
-  const timetable = Timetable.fromData(fs.readFileSync(timetablePath));
+  describe('point queries', () => {
+    for (const { from, to, at, legs } of pointRoutes) {
+      it(`${from} → ${to} at ${at}`, () => {
+        const fromStation = findStation(from);
+        const toStation = findStation(to);
 
-  const router = new Router(timetable, stopsIndex);
+        const result = router.route(
+          new Query.Builder()
+            .from(fromStation.id)
+            .to(toStation.id)
+            .departureTime(timeFromString(at))
+            .maxTransfers(5)
+            .build(),
+        );
 
-  routes.forEach(({ from, to, at, route }) => {
-    it(`Route from ${from} to ${to} at ${at}`, () => {
-      const fromStop = stopsIndex.findStopBySourceStopId(from);
-      const toStop = stopsIndex.findStopBySourceStopId(to);
+        const bestRoute = result.bestRoute(toStation.id);
+        assert.ok(bestRoute, 'No route found');
+        assert.deepStrictEqual(toExpectedLegs(bestRoute), legs);
+      });
+    }
+  });
 
-      assert.ok(fromStop, `Stop not found: ${from}`);
-      assert.ok(toStop, `Stop not found: ${to}`);
+  describe('range queries', () => {
+    for (const { from, to, earliest, latest, runs } of rangeRoutes) {
+      it(`${from} → ${to} [${earliest}–${latest}]`, () => {
+        const fromStation = findStation(from);
+        const toStation = findStation(to);
 
-      const departureTime = timeFromString(at);
+        const result = router.rangeRoute(
+          new RangeQuery.Builder()
+            .from(fromStation.id)
+            .to(toStation.id)
+            .departureTime(timeFromString(earliest))
+            .lastDepartureTime(timeFromString(latest))
+            .maxTransfers(5)
+            .build(),
+        );
 
-      const queryObject = new Query.Builder()
-        .from(fromStop.id)
-        .to(toStop.id)
-        .departureTime(departureTime)
-        .maxTransfers(5)
-        .build();
+        assert.strictEqual(
+          result.size,
+          runs.length,
+          `Expected ${runs.length} Pareto-optimal run(s), got ${result.size}`,
+        );
 
-      const result = router.route(queryObject);
-      const bestRoute = result.bestRoute(toStop.id);
-      console.log();
-      assert.ok(bestRoute, 'No route found');
-      const actualRoute = bestRoute.asJson();
-      const actualRouteWithSourceIds = actualRoute.map((segment) => {
-        const fromStop = stopsIndex.findStopById(segment.from);
-        const toStop = stopsIndex.findStopById(segment.to);
+        const actualRuns = [...result];
+        for (let i = 0; i < runs.length; i++) {
+          const actualRun = actualRuns[i];
+          const expectedRun = runs[i];
+          assert.ok(actualRun, `Run ${i}: missing actual run`);
+          assert.ok(expectedRun, `Run ${i}: missing expected run`);
 
-        assert.ok(fromStop?.sourceStopId, `Stop not found: ${segment.from}`);
-        assert.ok(toStop?.sourceStopId, `Stop not found: ${segment.to}`);
+          assert.strictEqual(
+            timeToString(actualRun.departureTime),
+            expectedRun.departureTime,
+            `Run ${i}: departure time mismatch`,
+          );
 
-        return {
-          ...segment,
-          from: fromStop.sourceStopId,
-          to: toStop.sourceStopId,
-        };
+          const route = actualRun.result.bestRoute(toStation.id);
+          assert.ok(route, `Run ${i}: no route found`);
+          assert.deepStrictEqual(
+            toExpectedLegs(route),
+            expectedRun.legs,
+            `Run ${i}: legs mismatch`,
+          );
+        }
       });
-
-      assert.deepStrictEqual(
-        actualRouteWithSourceIds,
-        route,
-        `Route mismatch for query from ${from} to ${to} at ${at}`,
-      );
-    });
+    }
   });
 });