Merge remote-tracking branch 'upstream/dev-2.x' into upstream-merge-2…

…024-11-04

.git-blame-ignore-revs

@@ -9,3 +9,6 @@
 
 # reorder and reformat GTFS GraphQL API schema file with graphql-java
 14051fab312a67cae9a460aaf0bbc77223bec624
+
+# Make OTP a multi-module project
+ead33ffe280dd7caf72cae5ff7a41542e8427636

.github/workflows/cibuild.yml

@@ -151,7 +151,7 @@ jobs:
         if: github.event_name == 'pull_request'
 
       - name: Install Python dependencies
-        run: pip install --break-system-packages -r doc/user/requirements.txt
+        run: pip install -r doc/user/requirements.txt
 
 
       - name: Build main documentation
@@ -277,4 +277,6 @@ jobs:
             echo "Maven version ${version_with_snapshot} contains SNAPSHOT, adding date to container image tag"
           fi
           
-          mvn --batch-mode -P prettierSkip compile com.google.cloud.tools:jib-maven-plugin:build -Djib.to.tags=latest,$image_version
+          MAVEN_SKIP_ARGS="-P prettierSkip -Dmaven.test.skip=true -Dmaven.source.skip=true"
+          
+          mvn --batch-mode $MAVEN_SKIP_ARGS package com.google.cloud.tools:jib-maven-plugin:build -Djib.to.tags=latest,$image_version

.github/workflows/performance-test.yml

@@ -83,7 +83,7 @@ jobs:
         if: matrix.profile == 'core' || github.ref == 'refs/heads/dev-2.x'
         env:
           MAVEN_OPTS: "-Dmaven.repo.local=/home/lenni/.m2/repository/"
-        run: mvn -DskipTests --batch-mode package -P prettierSkip
+        run: mvn -DskipTests --batch-mode install -P prettierSkip
 
       - name: Build graph
         if: matrix.profile == 'core' || github.ref == 'refs/heads/dev-2.x'
@@ -93,24 +93,23 @@ jobs:
 
       - name: Run speed test
         if: matrix.profile == 'core' || github.ref == 'refs/heads/dev-2.x'
-        working-directory: application
         env:
           PERFORMANCE_INFLUX_DB_PASSWORD: ${{ secrets.PERFORMANCE_INFLUX_DB_PASSWORD }}
           SPEEDTEST_LOCATION: ${{ matrix.location }}
           MAVEN_OPTS: "-Xmx50g -XX:StartFlightRecording=delay=${{ matrix.jfr-delay }},duration=30m,filename=${{ matrix.location}}-speed-test.jfr -Dmaven.repo.local=/home/lenni/.m2/repository/"
         run: |
-          mvn exec:java -Dexec.mainClass="org.opentripplanner.transit.speed_test.SpeedTest" -Dexec.classpathScope=test -Dexec.args="--dir=../test/performance/${{ matrix.location }} -p md -n ${{ matrix.iterations }} -i 3 -0" -P prettierSkip
+          mvn --projects application exec:java -Dexec.mainClass="org.opentripplanner.transit.speed_test.SpeedTest" -Dexec.classpathScope=test -Dexec.args="--dir=test/performance/${{ matrix.location }} -p md -n ${{ matrix.iterations }} -i 3 -0"
 
       - name: Archive travel results file
         if: matrix.profile == 'core' || github.ref == 'refs/heads/dev-2.x'
         uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.location }}-travelSearch-results.csv
-          path: test/performance/${{ matrix.location }}/travelSearch-results.csv
+          path: test/performance/${{ matrix.location }}/travelSearch-results-md.csv
 
       - name: Archive Flight Recorder instrumentation file
         if: matrix.profile == 'core' || github.ref == 'refs/heads/dev-2.x'
         uses: actions/upload-artifact@v4
         with:
           name: ${{ matrix.location }}-flight-recorder
-          path: ${{ matrix.location}}-speed-test.jfr
+          path: application/${{ matrix.location }}-speed-test.jfr

.github/workflows/prune-container-images.yml

@@ -18,5 +18,5 @@ jobs:
         run: |
           # remove all snapshot container images that have not been pulled for over a year
           # --keep-semver makes sure that any image with a x.y.z version scheme is unaffected by this
-          pip install prune-container-repo==0.0.4 --break-system-packages
+          pip install prune-container-repo==0.0.4
           prune-container-repo -u ${CONTAINER_REGISTRY_USER} -r ${CONTAINER_REPO} --days=365 --keep-semver --activate

.gitignore

@@ -29,6 +29,7 @@ o_o_standalone_config_IncludeFileDirectiveTest_part.json
 .venv/
 _site/
 build/
+!/application/src/build/
 dist/
 doc/user/_build/
 gen-java/

ARCHITECTURE.md

@@ -40,22 +40,22 @@ examples. The Transit model is more complex than the VehiclePosition model.
 Below is a list of documented components in OTP. Not every component is documented at a high level,
 but this is a start and we would like to expand this list in the future.
 
-### [OTP Configuration design](src/main/java/org/opentripplanner/standalone/config/package.md)
+### [OTP Configuration design](application/src/main/java/org/opentripplanner/standalone/config/package.md)
 
 The Configuration module is responsible for loading and parsing OTP configuration files and map them
 into Plan Old Java Objects (POJOs). These POJOs are injected into the other components.
 
-### [GTFS import module](src/main/java/org/opentripplanner/gtfs/package.md)
+### [GTFS import module](application/src/main/java/org/opentripplanner/gtfs/package.md)
 
 Used to import GTFS transit data files.
 
-### [NeTEx import module](src/main/java/org/opentripplanner/netex/package.md)
+### [NeTEx import module](application/src/main/java/org/opentripplanner/netex/package.md)
 
 Used to import NeTEx transit data files.
 
 ### Transit Routing
 
-#### [Raptor transit routing](src/main/java/org/opentripplanner/raptor/package.md)
+#### [Raptor transit routing](application/src/main/java/org/opentripplanner/raptor/package.md)
 
 This is the OTP2 new transit routing engine implemented using the Raptor algorithm. It explains how
 Raptor works, the important concepts and the design. It might be worth reading even if you are not a
@@ -68,35 +68,35 @@ dependencies from Raptor to other parts of OTP code, only to utility classes not
 Also, the code follows a stricter object-oriented design, than most other parts of OTP. The Raptor
 implementation is highly critical code, hence we set the bar higher with respect to code quality.
 
-OTP provides transit data to Raptor by implementing the _raptor/api/transit_ model. The
-[RoutingService](src/main/java/org/opentripplanner/routing/RoutingService.java)
+OTP provides transit data to Raptor by implementing the _raptor/spi_. The 
+[RoutingService](application/src/main/java/org/opentripplanner/routing/service/DefaultRoutingService.java)
 is responsible for mapping from the OTP context to a
-[RaptorRequest](src/main/java/org/opentripplanner/raptor/api/request/RaptorRequest.java)
+[RaptorRequest](application/src/main/java/org/opentripplanner/raptor/api/request/RaptorRequest.java)
 and then map the
-result, [Raptor Path](src/main/java/org/opentripplanner/raptor/api/path/Path.java), back to
+result, [Raptor Path](application/src/main/java/org/opentripplanner/raptor/api/path/RaptorPath.java), back to
 the OTP internal domain. This might seem like a lot of unnecessary mapping, but mapping is simple -
 routing is not.
 
 The performance of Raptor is important, and we care about every millisecond. All changes to the
 existing Raptor coded should be tested with the
-[SpeedTest](src/test/java/org/opentripplanner/transit/raptor/speed_test/package.md) and compared
+[SpeedTest](application/src/test/java/org/opentripplanner/transit/speed_test/package.md) and compared
 with an earlier version of the code to make sure the performance is NOT degraded.
 
-#### [Transfer path optimization](src/main/java/org/opentripplanner/routing/algorithm/transferoptimization/package.md)
+#### [Transfer path optimization](application/src/main/java/org/opentripplanner/routing/algorithm/transferoptimization/package.md)
 
 Describes the transfer functionality, the design and the implementation. The logic for finding the
 best transfer is distributed to the Raptor and
-the [OptimizeTransferService](src/main/java/org/opentripplanner/routing/algorithm/transferoptimization/OptimizeTransferService.java)
+the [OptimizeTransferService](application/src/main/java/org/opentripplanner/routing/algorithm/transferoptimization/OptimizeTransferService.java)
 .
 
-#### [Itinerary list filter chain](src/main/java/org/opentripplanner/routing/algorithm/filterchain/package.md)
+#### [Itinerary list filter chain](application/src/main/java/org/opentripplanner/routing/algorithm/filterchain/package.md)
 
 Describes the itinerary list filter chain, used to post-process the itineraries returned from the
-routers in [RoutingWorker](src/main/java/org/opentripplanner/routing/algorithm/RoutingWorker.java),
+routers in [RoutingWorker](application/src/main/java/org/opentripplanner/routing/algorithm/RoutingWorker.java),
 in order to sort and reduce the number of returned itineraries. It can also be used to decorate the
 returned itineraries, especially if it requires more complex calculations, which would be unfeasible
 to do during the routing process.
 
-### [Service](src/main/java/org/opentripplanner/service/package.md)
+### [Service](application/src/main/java/org/opentripplanner/service/package.md)
 The service package contains small services usually specific to one or a few use-cases. In contrast 
-to a domain model they may use one or many domain models and other services. 
+to a domain model they may use one or many domain models and other services. 

README.md

@@ -31,11 +31,10 @@ We run a speed test (included in the code) to measure the performance for every
 
 ## Repository layout
 
-The main Java server code is in `src/main/`. OTP also includes a Javascript client based on the
-Leaflet mapping library in `src/client/`. This client is now primarily used for testing, with most
-major deployments building custom clients from reusable components. The Maven build produces a
-unified ("shaded") JAR file at `target/otp-VERSION.jar` containing all necessary code and
-dependencies to run OpenTripPlanner.
+The main Java server code is in `application/src/main/`. OTP also includes a Javascript client based on the
+MapLibre mapping library in `client/src/`. This client is now used for testing, with most major
+deployments building custom clients from reusable components. The Maven build produces a unified ("shaded")
+JAR file at `application/target/otp-VERSION.jar` containing all necessary code and dependencies to run OpenTripPlanner.
 
 Additional information and instructions are available in
 the [main documentation](http://docs.opentripplanner.org/en/dev-2.x/), including a

application/pom.xml

@@ -12,6 +12,14 @@
     <name>OpenTripPlanner - Application</name>
 
     <dependencies>
+        <!-- project dependencies -->
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>gtfs-realtime-protobuf</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+
+        <!-- 3rd party dependencies -->
         <dependency>
             <groupId>net.sf.trove4j</groupId>
             <artifactId>trove4j</artifactId>
@@ -161,7 +169,7 @@
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-core</artifactId>
-            <version>5.13.0</version>
+            <version>5.14.2</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -323,7 +331,7 @@
         <dependency>
             <groupId>org.apache.httpcomponents.client5</groupId>
             <artifactId>httpclient5</artifactId>
-            <version>5.4</version>
+            <version>5.4.1</version>
         </dependency>
         <dependency>
             <groupId>commons-cli</groupId>
@@ -519,6 +527,29 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>com.github.bohnman</groupId>
+                <artifactId>package-info-maven-plugin</artifactId>
+                <version>1.1.0</version>
+                <configuration>
+                    <!-- Couldn't get this to work for main and ext code at the same time. -->
+                    <sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>
+                    <outputDirectory>${project.basedir}/target/generated-sources</outputDirectory>
+                    <packages>
+                        <package>
+                            <pattern>**</pattern>
+                            <template>${project.basedir}/src/build/templates/package-info-template.java</template>
+                        </package>
+                    </packages>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>generate</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 </project>

application/src/build/templates/package-info-template.java

@@ -0,0 +1,4 @@
+@ParametersAreNonnullByDefault
+package org.opentripplanner;
+
+import javax.annotation.ParametersAreNonnullByDefault;

application/src/client/index.html

@@ -5,8 +5,8 @@
     <link rel="icon" type="image/svg+xml" href="/img/otp-logo.svg" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>OTP Debug Client</title>
-    <script type="module" crossorigin src="https://cdn.jsdelivr.net/gh/opentripplanner/debug-client-assets@main/2024/10/2024-10-09T18:54/assets/index-C6b5LCY-.js"></script>
-    <link rel="stylesheet" crossorigin href="https://cdn.jsdelivr.net/gh/opentripplanner/debug-client-assets@main/2024/10/2024-10-09T18:54/assets/index-BcsxnGE8.css">
+    <script type="module" crossorigin src="https://cdn.jsdelivr.net/gh/opentripplanner/debug-client-assets@main/2024/11/2024-11-04T12:49/assets/index-DPdUtdaa.js"></script>
+    <link rel="stylesheet" crossorigin href="https://cdn.jsdelivr.net/gh/opentripplanner/debug-client-assets@main/2024/11/2024-11-04T12:49/assets/index-CaBThmWm.css">
   </head>
   <body>
     <div id="root"></div>

application/src/ext-test/java/org/opentripplanner/ext/emissions/EmissionsTest.java

@@ -3,7 +3,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.opentripplanner.model.plan.Itinerary.createScheduledTransitItinerary;
-import static org.opentripplanner.transit.model._data.TransitModelForTest.id;
+import static org.opentripplanner.transit.model._data.TimetableRepositoryForTest.id;
 
 import java.time.OffsetDateTime;
 import java.time.ZonedDateTime;
@@ -21,7 +21,7 @@
 import org.opentripplanner.model.plan.ScheduledTransitLegBuilder;
 import org.opentripplanner.model.plan.StreetLeg;
 import org.opentripplanner.street.search.TraverseMode;
-import org.opentripplanner.transit.model._data.TransitModelForTest;
+import org.opentripplanner.transit.model._data.TimetableRepositoryForTest;
 import org.opentripplanner.transit.model.basic.TransitMode;
 import org.opentripplanner.transit.model.framework.Deduplicator;
 import org.opentripplanner.transit.model.framework.FeedScopedId;
@@ -46,9 +46,13 @@ class EmissionsTest {
     .withEndTime(TIME.plusHours(1))
     .build();
 
-  private static final Route ROUTE_WITH_EMISSIONS = TransitModelForTest.route(id("1")).build();
-  private static final Route ROUTE_WITH_ZERO_EMISSIONS = TransitModelForTest.route(id("2")).build();
-  private static final Route ROUTE_WITHOUT_EMISSIONS_CONFIGURED = TransitModelForTest
+  private static final Route ROUTE_WITH_EMISSIONS = TimetableRepositoryForTest
+    .route(id("1"))
+    .build();
+  private static final Route ROUTE_WITH_ZERO_EMISSIONS = TimetableRepositoryForTest
+    .route(id("2"))
+    .build();
+  private static final Route ROUTE_WITHOUT_EMISSIONS_CONFIGURED = TimetableRepositoryForTest
     .route(id("3"))
     .build();
 
@@ -119,12 +123,15 @@ private ScheduledTransitLeg createTransitLeg(Route route) {
     var stoptime = new StopTime();
     var stopTimes = new ArrayList<StopTime>();
     stopTimes.add(stoptime);
-    var testModel = TransitModelForTest.of();
+    var testModel = TimetableRepositoryForTest.of();
     var stopOne = testModel.stop("1:stop1", 60, 25).build();
     var stopTwo = testModel.stop("1:stop1", 61, 25).build();
     var stopThree = testModel.stop("1:stop1", 62, 25).build();
-    var stopPattern = TransitModelForTest.stopPattern(stopOne, stopTwo, stopThree);
-    var pattern = TransitModelForTest.tripPattern("1", route).withStopPattern(stopPattern).build();
+    var stopPattern = TimetableRepositoryForTest.stopPattern(stopOne, stopTwo, stopThree);
+    var pattern = TimetableRepositoryForTest
+      .tripPattern("1", route)
+      .withStopPattern(stopPattern)
+      .build();
     var trip = Trip
       .of(FeedScopedId.parse("FOO:BAR"))
       .withMode(TransitMode.BUS)

application/src/ext-test/java/org/opentripplanner/ext/fares/FaresFilterTest.java

@@ -2,7 +2,7 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.opentripplanner.model.plan.TestItineraryBuilder.newItinerary;
-import static org.opentripplanner.transit.model._data.TransitModelForTest.id;
+import static org.opentripplanner.transit.model._data.TimetableRepositoryForTest.id;
 
 import java.util.List;
 import org.junit.jupiter.api.Test;
@@ -13,12 +13,12 @@
 import org.opentripplanner.model.plan.Place;
 import org.opentripplanner.model.plan.PlanTestConstants;
 import org.opentripplanner.routing.fares.FareService;
-import org.opentripplanner.transit.model._data.TransitModelForTest;
+import org.opentripplanner.transit.model._data.TimetableRepositoryForTest;
 import org.opentripplanner.transit.model.basic.Money;
 
 public class FaresFilterTest implements PlanTestConstants {
 
-  private final TransitModelForTest testModel = TransitModelForTest.of();
+  private final TimetableRepositoryForTest testModel = TimetableRepositoryForTest.of();
 
   @Test
   void shouldAddFare() {

application/src/ext-test/java/org/opentripplanner/ext/fares/impl/AtlantaFareServiceTest.java

@@ -32,7 +32,7 @@
 import org.opentripplanner.transit.model.network.Route;
 import org.opentripplanner.transit.model.organization.Agency;
 import org.opentripplanner.transit.model.site.RegularStop;
-import org.opentripplanner.transit.service.StopModel;
+import org.opentripplanner.transit.service.SiteRepository;
 
 public class AtlantaFareServiceTest implements PlanTestConstants {
 
@@ -262,20 +262,20 @@ private static Leg createLeg(String agencyId, String shortName, long startTimeMi
   }
 
   private static Itinerary createItinerary(String agencyId, String shortName, long startTimeMins) {
-    var stopModelBuilder = StopModel.of();
+    var siteRepositoryBuilder = SiteRepository.of();
     Agency agency = Agency
       .of(new FeedScopedId(FEED_ID, agencyId))
       .withName(agencyId)
       .withTimezone(ZoneIds.NEW_YORK.getId())
       .build();
 
     // Set up stops
-    RegularStop firstStop = stopModelBuilder
+    RegularStop firstStop = siteRepositoryBuilder
       .regularStop(new FeedScopedId(FEED_ID, "1"))
       .withCoordinate(new WgsCoordinate(1, 1))
       .withName(new NonLocalizedString("first stop"))
       .build();
-    RegularStop lastStop = stopModelBuilder
+    RegularStop lastStop = siteRepositoryBuilder
       .regularStop(new FeedScopedId(FEED_ID, "2"))
       .withCoordinate(new WgsCoordinate(1, 2))
       .withName(new NonLocalizedString("last stop"))

application/src/ext-test/java/org/opentripplanner/ext/fares/impl/CombinedInterlinedLegsFareServiceTest.java

@@ -22,13 +22,13 @@
 import org.opentripplanner.model.plan.Place;
 import org.opentripplanner.model.plan.PlanTestConstants;
 import org.opentripplanner.routing.core.FareType;
-import org.opentripplanner.transit.model._data.TransitModelForTest;
+import org.opentripplanner.transit.model._data.TimetableRepositoryForTest;
 import org.opentripplanner.transit.model.basic.Money;
 import org.opentripplanner.transit.model.network.Route;
 
 class CombinedInterlinedLegsFareServiceTest implements PlanTestConstants {
 
-  static final Route route = TransitModelForTest.route("route-1").build();
+  static final Route route = TimetableRepositoryForTest.route("route-1").build();
   static final Itinerary interlinedWithDifferentRoute = newItinerary(
     Place.forStop(AIRPORT_STOP),
     T11_00

application/src/ext-test/java/org/opentripplanner/ext/fares/impl/DefaultFareServiceTest.java

@@ -24,7 +24,7 @@
 import org.opentripplanner.model.plan.Place;
 import org.opentripplanner.model.plan.PlanTestConstants;
 import org.opentripplanner.routing.core.FareType;
-import org.opentripplanner.transit.model._data.TransitModelForTest;
+import org.opentripplanner.transit.model._data.TimetableRepositoryForTest;
 import org.opentripplanner.transit.model.basic.Money;
 
 class DefaultFareServiceTest implements PlanTestConstants {
@@ -116,7 +116,7 @@ void shouldNotCombineInterlinedLegs() {
     var itin = newItinerary(Place.forStop(AIRPORT_STOP), T11_00)
       .bus(1, T11_05, T11_12, Place.forStop(CITY_CENTER_A_STOP))
       .staySeatedBus(
-        TransitModelForTest.route("123").build(),
+        TimetableRepositoryForTest.route("123").build(),
         2,
         T11_12,
         T11_16,