Merge pull request opentripplanner#7318 from HSLdevcom/add-viapoint-to-speedtest

Add categories, complicated areas, and viapoints to Helsinki performance test

Author: VillePihlava

application/src/test/java/org/opentripplanner/transit/speed_test/SpeedTestRequest.java

@@ -62,6 +62,10 @@ RouteRequest toRouteRequest() {
 
     builder.withFrom(input.fromPlace()).withTo(input.toPlace());
 
+    if (input.viaLocation() != null) {
+      builder.withViaLocations(List.of(input.viaLocation()));
+    }
+
     // Filter the results inside the SpeedTest, not in the itineraries filter,
     // when ignoring street results. This will use the default which is 50.
     if (!config.ignoreStreetResults()) {

application/src/test/java/org/opentripplanner/transit/speed_test/model/testcase/TestCaseDefinition.java

@@ -1,8 +1,10 @@
 package org.opentripplanner.transit.speed_test.model.testcase;
 
 import java.time.Duration;
+import javax.annotation.Nullable;
 import org.opentripplanner.api.parameter.QualifiedModeSet;
 import org.opentripplanner.model.GenericLocation;
+import org.opentripplanner.routing.api.request.via.VisitViaLocation;
 import org.opentripplanner.utils.time.DurationUtils;
 import org.opentripplanner.utils.time.TimeUtils;
 import org.opentripplanner.utils.tostring.ValueObjectToStringBuilder;
@@ -15,8 +17,9 @@ public record TestCaseDefinition(
   Duration window,
   GenericLocation fromPlace,
   GenericLocation toPlace,
+  @Nullable VisitViaLocation viaLocation,
   /**
-   * A test cases can be grouped into a category used to group similar cases, like "Flex" or
+   * A test case can be grouped into a category used to group similar cases, like "Flex" or
    * "Long Distance".
    */
   String category,
@@ -25,11 +28,13 @@ public record TestCaseDefinition(
   @Override
   public String toString() {
     return String.format(
-      "#%s %s - %s, %s - %s, %s-%s(%s)",
+      "#%s %s - via:%s - %s, %s - via:%s - %s, %s-%s(%s)",
       id,
       fromPlace.label,
+      viaLocation != null ? viaLocation.label() : null,
       toPlace.label,
       coordinateString(fromPlace),
+      viaLocation != null ? coordinateString(viaLocation.coordinateLocation()) : null,
       coordinateString(toPlace),
       TimeUtils.timeToStrCompact(departureTime, TestCase.NOT_SET),
       TimeUtils.timeToStrCompact(arrivalTime, TestCase.NOT_SET),

application/src/test/java/org/opentripplanner/transit/speed_test/model/testcase/io/TestCaseDefinitionCsvFile.java

@@ -2,9 +2,13 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.util.List;
+import javax.annotation.Nullable;
 import org.opentripplanner.api.parameter.QualifiedModeSet;
 import org.opentripplanner.core.model.id.FeedScopedId;
 import org.opentripplanner.model.GenericLocation;
+import org.opentripplanner.routing.api.request.via.VisitViaLocation;
+import org.opentripplanner.street.geometry.WgsCoordinate;
 import org.opentripplanner.transit.speed_test.model.testcase.TestCaseDefinition;
 
 public class TestCaseDefinitionCsvFile extends AbstractCsvFile<TestCaseDefinition> {
@@ -41,8 +45,23 @@ TestCaseDefinition parseRow() throws IOException {
         parseDouble("toLat"),
         parseDouble("toLon")
       ),
+      parseViaLocation(),
       parseString("category"),
       new QualifiedModeSet(parseCollection("modes").toArray(new String[0]))
     );
   }
+
+  @Nullable
+  private VisitViaLocation parseViaLocation() {
+    try {
+      return new VisitViaLocation(
+        parseString("viaLabel"),
+        parseDuration("viaMinimumWaitTime"),
+        List.of(),
+        new WgsCoordinate(parseDouble("viaLat"), parseDouble("viaLon"))
+      );
+    } catch (Exception e) {
+      return null;
+    }
+  }
 }

test/performance/README.md

@@ -22,6 +22,60 @@ The results will be displayed in the console.
 The test is run after every merge to dev-2.x. Its GitHub Actions workflow is defined
 in [performance-test.yml](/.github/workflows/performance-test.yml).
 
+### Running the test manually
+
+Sometimes it is desirable to run the test configuration in the CI environment manually, for
+example, when making changes to the tests. To do this, perform these steps:
+1. Create a local branch in git that contains the desired performance test configuration.
+2. In [performance-test.yml](/.github/workflows/performance-test.yml) add your test branch name to
+the configuration and change all `profile`s to `core`:
+```diff
+name: Performance test
+
+on:
+  push:
+    branches:
+      - dev-2.x
++     - test-branch-name
+
+jobs:
+  perf-test:
+    if: github.repository_owner == 'opentripplanner' && !startsWith(github.event.head_commit.message ,'Bump serialization version id for') && !startsWith(github.event.head_commit.message ,'Upgrade debug client to version')
+    runs-on: performance-test
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          ...
+          - location: baden-wuerttemberg # German state of Baden-Württemberg: https://en.wikipedia.org/wiki/Baden-W%C3%BCrttemberg
+            iterations: 1
+            jfr-delay: "50s"
+-           profile: extended
++           profile: core
+
+          - location: switzerland
+            iterations: 1
+            jfr-delay: "50s"
+-           profile: extended
++           profile: core
+
+          - location: washington-state
+            iterations: 1
+            jfr-delay: "20s"
+-           profile: extended
++           profile: core
+
+          - location: helsinki
+            iterations: 1
+            jfr-delay: "50s"
+-           profile: extended
++           profile: core
+...
+```
+3. Commit the changes to [performance-test.yml](/.github/workflows/performance-test.yml).
+4. Push the changes to a branch in the **upstream** [OpenTripPlanner](https://github.com/opentripplanner/OpenTripPlanner/) repository with the same name you added to [performance-test.yml](/.github/workflows/performance-test.yml).
+5. The tests will run after the push.
+
 ## Instrumentation
 
 Each run on CI is instrumented with Java Flight Recorder. The results are then saved as an artifact

test/performance/helsinki/build-config.json

@@ -7,8 +7,8 @@
   "maxAreaNodes": 1000,
   "maxTransferDuration": "26m",
   "multiThreadElevationCalculations": true,
-  "transitServiceStart": "2026-01-01",
-  "transitServiceEnd": "2026-01-31",
+  "transitServiceStart": "2026-02-01",
+  "transitServiceEnd": "2026-02-28",
   "transitModelTimeZone": "Europe/Helsinki",
   "fares": "hsl",
   "transferRequests": [
@@ -40,13 +40,13 @@
   "transitFeeds": [
     {
       "type": "gtfs",
-      "source": "https://otp-performance.leonard.io/data/helsinki/hsl-gtfs-2026-01-12.zip",
+      "source": "https://otp-performance.leonard.io/data/helsinki/hsl-gtfs-2026-02-19.zip",
       "feedId": "HSL"
     }
   ],
   "osm": [
     {
-      "source": "https://otp-performance.leonard.io/data/helsinki/hsl-2026-01-12.osm.pbf"
+      "source": "https://otp-performance.leonard.io/data/helsinki/hsl-2026-02-19.osm.pbf"
     }
   ]
 }

test/performance/helsinki/generate_test_cases.py

@@ -1,24 +1,25 @@
 import csv
 
 fieldnames = ["testCaseId", "description", "departure", "arrival", "fromLat",
-              "fromLon", "toLat", "toLon", "origin", "destination", "modes", "category"]
+              "fromLon", "toLat", "toLon", "origin", "destination", "modes", "category",
+              "viaLabel", "viaMinimumWaitTime", "viaLat", "viaLon"]
 
 locations = [
     # Helsinki
     {
-        "coordinates": "60.169665, 24.934652",
+        "coordinates": "60.169665,24.934652",
         "name": "Kamppi"
     },
     {
-        "coordinates":  "60.179022, 24.924151",
+        "coordinates":  "60.179022,24.924151",
         "name": "Töölöntori"
     },
     {
-        "coordinates":  "60.22070, 24.86094",
+        "coordinates":  "60.22070,24.86094",
         "name": "Pitäjänmäki"
     },
     {
-        "coordinates":  "60.20863, 25.07946",
+        "coordinates":  "60.20863,25.07946",
         "name": "Itäkeskus"
     },
     {
@@ -27,46 +28,77 @@
     },
     # Espoo
     {
-        "coordinates":  "60.18234, 24.82531",
+        "coordinates":  "60.18234,24.82531",
         "name": "Otaniemi"
     },
     {
-        "coordinates":  "60.205940, 24.656711",
+        "coordinates":  "60.205940,24.656711",
         "name": "Espoon Keskusta"
     },
     {
-        "coordinates":  "60.15509, 24.74546",
+        "coordinates":  "60.15509,24.74546",
         "name": "Matinkylä"
     },
     {
-        "coordinates":  "60.19586, 24.58912",
+        "coordinates":  "60.19586,24.58912",
         "name": "Kauklahti"
     },
     {
-        "coordinates":  "60.29030, 24.56324",
+        "coordinates":  "60.29030,24.56324",
         "name": "Nuuksio"
     },
     {
-        "coordinates":  "60.17892, 24.65813",
+        "coordinates":  "60.17892,24.65813",
         "name": "Latokaski"
     },
     # Vantaa
     {
-        "coordinates":  "60.29246, 25.03861",
+        "coordinates":  "60.29246,25.03861",
         "name": "Tikkurila"
     },
     # Airport
     {
-        "coordinates":  "60.317508, 24.969089",
+        "coordinates":  "60.317508,24.969089",
         "name": "Airport"
     },
     # Kirkkonummi
     {
-        "coordinates":  "60.12640, 24.43613",
+        "coordinates":  "60.12640,24.43613",
         "name": "Kirkkonummi"
     }
 ]
 
+complicated_area_locations = [
+    # Helsinki
+    {
+        "coordinates": "60.17188,24.93951",
+        "name": "Elielinaukio"
+    },
+    {
+        "coordinates": "60.16758,24.95410",
+        "name": "Kauppatori"
+    },
+    {
+        "coordinates": "60.16968,24.93486",
+        "name": "Narinkkatori"
+    },
+    # Espoo
+    {
+        "coordinates": "60.17685,24.80548",
+        "name": "Tapionraitti"
+    },
+    # Kauniainen
+    {
+        "coordinates": "60.21073,24.72707",
+        "name": "Thurmaninaukio"
+    },
+    # Kirkkonummi
+    {
+        "coordinates": "60.11974,24.43999",
+        "name": "Asema-aukio"
+    }
+]
+
 arrival = "13:00"
 departure = "13:00"
 
@@ -80,6 +112,8 @@ def parse_coords(input):
     }
 
 counter = 0
+
+# depart-after
 for start in locations:
     for end in locations:
         if end["coordinates"] is not start["coordinates"]:
@@ -88,7 +122,6 @@ def parse_coords(input):
             end_coords = parse_coords(end["coordinates"])
 
             counter = counter + 1
-
             rows.append({
                 "testCaseId": counter,
                 "description": f'{start["name"]} to {end["name"]} (transit)',
@@ -100,9 +133,10 @@ def parse_coords(input):
                 "origin": start["name"],
                 "destination": end["name"],
                 "modes": "TRANSIT|WALK",
-                "category": "transit"
+                "category": "depart-after"
             })
 
+# arrive-by
 for start in locations:
     for end in locations:
         if end["coordinates"] is not start["coordinates"]:
@@ -111,7 +145,6 @@ def parse_coords(input):
             end_coords = parse_coords(end["coordinates"])
 
             counter = counter + 1
-
             rows.append({
                 "testCaseId": counter,
                 "description": f'{start["name"]} to {end["name"]} (transit)',
@@ -123,9 +156,60 @@ def parse_coords(input):
                 "origin": start["name"],
                 "destination": end["name"],
                 "modes": "TRANSIT|WALK",
-                "category": "transit"
+                "category": "arrive-by"
             })
 
+# complicated-area
+for start in complicated_area_locations:
+    for end in complicated_area_locations:
+        if end["coordinates"] is not start["coordinates"]:
+
+            start_coords = parse_coords(start["coordinates"])
+            end_coords = parse_coords(end["coordinates"])
+
+            counter = counter + 1
+            rows.append({
+                "testCaseId": counter,
+                "description": f'{start["name"]} to {end["name"]} (transit)',
+                "departure": departure,
+                "fromLat": start_coords["lat"],
+                "fromLon": start_coords["lon"],
+                "toLat": end_coords["lat"],
+                "toLon": end_coords["lon"],
+                "origin": start["name"],
+                "destination": end["name"],
+                "modes": "TRANSIT|WALK",
+                "category": "complicated-area"
+            })
+
+# viapoint
+via_start = complicated_area_locations[0]
+via_end = complicated_area_locations[1]
+via_start_coords = parse_coords(via_start["coordinates"])
+via_end_coords = parse_coords(via_end["coordinates"])
+via_locations = locations
+for via_location in via_locations:
+    via_coords = parse_coords(via_location["coordinates"])
+
+    counter = counter + 1
+    rows.append({
+        "testCaseId": counter,
+        "description": f'{via_start["name"]} to {via_end["name"]} (transit)',
+        "departure": departure,
+        "fromLat": via_start_coords["lat"],
+        "fromLon": via_start_coords["lon"],
+        "toLat": via_end_coords["lat"],
+        "toLon": via_end_coords["lon"],
+        "origin": via_start["name"],
+        "destination": via_end["name"],
+        "modes": "TRANSIT|WALK",
+        "category": "viapoint",
+        "viaLabel": via_location["name"],
+        "viaMinimumWaitTime": "60s",
+        "viaLat": via_coords["lat"],
+        "viaLon": via_coords["lon"]
+    })
+
 with open('travelSearch.csv', 'w', encoding='UTF8', newline='') as f:
     writer = csv.DictWriter(f, fieldnames=fieldnames)
     writer.writeheader()