Merge pull request opentripplanner#7289 from leonardehrenfried/remove-overlay

Remove dependency from `Graph` to `DataOverlay` feature

Author: leonardehrenfried

application/src/ext/java/org/opentripplanner/ext/dataoverlay/EdgeUpdaterModule.java

@@ -1,36 +1,29 @@
 package org.opentripplanner.ext.dataoverlay;
 
-import org.opentripplanner.ext.dataoverlay.configuration.DataOverlayParameterBindings;
 import org.opentripplanner.ext.dataoverlay.configuration.TimeUnit;
 import org.opentripplanner.graph_builder.model.GraphBuilderModule;
 import org.opentripplanner.routing.graph.Graph;
 
 /**
  * This class allows updating the graph with the grid data from generic .nc file in accordance with
- * provided json configuration
+ * provided json configuration. The parameter bindings are now provided separately through
+ * DataOverlayParameterBindingsModule.
  *
  * @author Simeon Platonov
  */
 public class EdgeUpdaterModule implements GraphBuilderModule {
 
   private final GenericDataFile dataFile;
   private final TimeUnit timeFormat;
-  private final DataOverlayParameterBindings parameterBindings;
   private final Graph graph;
 
   /**
    * Sets the generic grid data file
    */
-  public EdgeUpdaterModule(
-    Graph graph,
-    GenericDataFile dataFile,
-    TimeUnit timeFormat,
-    DataOverlayParameterBindings parameterBindings
-  ) {
+  public EdgeUpdaterModule(Graph graph, GenericDataFile dataFile, TimeUnit timeFormat) {
     this.graph = graph;
     this.dataFile = dataFile;
     this.timeFormat = timeFormat;
-    this.parameterBindings = parameterBindings;
   }
 
   @Override
@@ -41,7 +34,5 @@ public void buildGraph() {
       graph.getStreetEdges()
     );
     genericEdgeUpdater.updateEdges();
-    // The bindings are needed to build the request context when routing
-    graph.dataOverlayParameterBindings = this.parameterBindings;
   }
 }

application/src/ext/java/org/opentripplanner/ext/dataoverlay/configure/DataOverlayFactory.java

@@ -24,8 +24,7 @@ public static EdgeUpdaterModule create(Graph graph, DataOverlayConfig config) {
       return new EdgeUpdaterModule(
         graph,
         new GenericDataFile(dataFile, config),
-        config.getTimeFormat(),
-        config.getParameterBindings()
+        config.getTimeFormat()
       );
     } else {
       LOG.error("No data input {} found!", dataFile);

application/src/ext/java/org/opentripplanner/ext/dataoverlay/configure/DataOverlayParameterBindingsModule.java

@@ -0,0 +1,23 @@
+package org.opentripplanner.ext.dataoverlay.configure;
+
+import dagger.Module;
+import dagger.Provides;
+import jakarta.inject.Singleton;
+import javax.annotation.Nullable;
+import org.opentripplanner.ext.dataoverlay.configuration.DataOverlayParameterBindings;
+import org.opentripplanner.standalone.config.BuildConfig;
+
+/**
+ * Dagger module that provides DataOverlayParameterBindings from the build configuration. This
+ * module is included in both the graph building and runtime Dagger components.
+ */
+@Module
+public class DataOverlayParameterBindingsModule {
+
+  @Provides
+  @Singleton
+  @Nullable
+  static DataOverlayParameterBindings provideDataOverlayParameterBindings(BuildConfig config) {
+    return config.dataOverlay != null ? config.dataOverlay.getParameterBindings() : null;
+  }
+}

application/src/main/java/org/opentripplanner/graph_builder/module/configure/GraphBuilderFactory.java

@@ -7,6 +7,7 @@
 import java.util.List;
 import javax.annotation.Nullable;
 import org.opentripplanner.ext.dataoverlay.EdgeUpdaterModule;
+import org.opentripplanner.ext.dataoverlay.configure.DataOverlayParameterBindingsModule;
 import org.opentripplanner.ext.edgenaming.configure.EdgeNamerModule;
 import org.opentripplanner.ext.emission.EmissionRepository;
 import org.opentripplanner.ext.emission.configure.EmissionGraphBuilderModule;
@@ -53,6 +54,7 @@
 @Singleton
 @Component(
   modules = {
+    DataOverlayParameterBindingsModule.class,
     EdgeNamerModule.class,
     EmissionGraphBuilderModule.class,
     EmpiricalDelayGraphBuilderModule.class,

application/src/main/java/org/opentripplanner/routing/graph/Graph.java

@@ -15,7 +15,6 @@
 import org.locationtech.jts.geom.Envelope;
 import org.locationtech.jts.geom.Geometry;
 import org.opentripplanner.core.model.id.FeedScopedId;
-import org.opentripplanner.ext.dataoverlay.configuration.DataOverlayParameterBindings;
 import org.opentripplanner.routing.linking.Scope;
 import org.opentripplanner.routing.services.notes.StreetNotesService;
 import org.opentripplanner.street.geometry.CompactElevationProfile;
@@ -108,12 +107,6 @@ public class Graph implements Serializable {
    */
   public long nextSplitNumber = 0;
 
-  /**
-   * DataOverlay Sandbox module parameter bindings configured in the build-config, and needed when
-   * creating the data overlay context when routing.
-   */
-  public DataOverlayParameterBindings dataOverlayParameterBindings;
-
   @Inject
   public Graph(@Nullable OpeningHoursCalendarService openingHoursCalendarService) {
     this.openingHoursCalendarService = openingHoursCalendarService;

application/src/main/java/org/opentripplanner/standalone/api/OtpServerRequestContext.java

@@ -9,6 +9,7 @@
 import org.opentripplanner.apis.transmodel.TransmodelAPIParameters;
 import org.opentripplanner.astar.spi.TraverseVisitor;
 import org.opentripplanner.ext.carpooling.CarpoolingService;
+import org.opentripplanner.ext.dataoverlay.configuration.DataOverlayParameterBindings;
 import org.opentripplanner.ext.dataoverlay.routing.DataOverlayContext;
 import org.opentripplanner.ext.empiricaldelay.EmpiricalDelayService;
 import org.opentripplanner.ext.flex.FlexParameters;
@@ -158,13 +159,16 @@ default GraphFinder graphFinder() {
   @Nullable
   CarpoolingService carpoolingService();
 
+  @Nullable
+  DataOverlayParameterBindings dataOverlayParameterBindings();
+
   @Nullable
   default List<ExtensionRequestContext> listExtensionRequestContexts(RouteRequest request) {
     var list = new ArrayList<ExtensionRequestContext>();
     if (OTPFeature.DataOverlay.isOn()) {
       list.add(
         new DataOverlayContext(
-          graph().dataOverlayParameterBindings,
+          dataOverlayParameterBindings(),
           request.preferences().system().dataOverlay()
         )
       );

application/src/main/java/org/opentripplanner/standalone/configure/ConstructApplicationFactory.java

@@ -13,6 +13,7 @@
 import org.opentripplanner.ext.carpooling.CarpoolingRepository;
 import org.opentripplanner.ext.carpooling.CarpoolingService;
 import org.opentripplanner.ext.carpooling.configure.CarpoolingModule;
+import org.opentripplanner.ext.dataoverlay.configure.DataOverlayParameterBindingsModule;
 import org.opentripplanner.ext.emission.EmissionRepository;
 import org.opentripplanner.ext.emission.configure.EmissionServiceModule;
 import org.opentripplanner.ext.empiricaldelay.EmpiricalDelayRepository;
@@ -77,6 +78,7 @@
     CarpoolingModule.class,
     ConfigModule.class,
     ConstructApplicationModule.class,
+    DataOverlayParameterBindingsModule.class,
     EmissionServiceModule.class,
     EmpiricalDelayServiceModule.class,
     DeduplicatorServiceModule.class,
@@ -138,6 +140,7 @@ public interface ConstructApplicationFactory {
   GraphVisualizer graphVisualizer();
 
   TransitService transitService();
+
   OtpServerRequestContext createServerContext();
 
   MetricsLogging metricsLogging();

application/src/main/java/org/opentripplanner/standalone/configure/ConstructApplicationModule.java

@@ -11,6 +11,7 @@
 import org.opentripplanner.apis.transmodel.configure.TransmodelSchema;
 import org.opentripplanner.astar.spi.TraverseVisitor;
 import org.opentripplanner.ext.carpooling.CarpoolingService;
+import org.opentripplanner.ext.dataoverlay.configuration.DataOverlayParameterBindings;
 import org.opentripplanner.ext.empiricaldelay.EmpiricalDelayService;
 import org.opentripplanner.ext.geocoder.LuceneIndex;
 import org.opentripplanner.ext.interactivelauncher.api.LauncherRequestDecorator;
@@ -61,6 +62,7 @@ OtpServerRequestContext providesServerContext(
     List<RideHailingService> rideHailingServices,
     ViaCoordinateTransferFactory viaTransferResolver,
     @Nullable CarpoolingService carpoolingService,
+    @Nullable DataOverlayParameterBindings dataOverlayParameterBindings,
     @Nullable StopConsolidationService stopConsolidationService,
     StreetLimitationParametersService streetLimitationParametersService,
     @Nullable TraverseVisitor<?, ?> traverseVisitor,
@@ -110,6 +112,7 @@ OtpServerRequestContext providesServerContext(
       worldEnvelopeService,
       // Optional Sandbox services
       carpoolingService,
+      dataOverlayParameterBindings,
       emissionItineraryDecorator,
       streetDetailsService,
       empiricalDelayService,

application/src/main/java/org/opentripplanner/standalone/server/DefaultServerRequestContext.java

@@ -10,6 +10,7 @@
 import org.opentripplanner.apis.transmodel.configure.TransmodelSchema;
 import org.opentripplanner.astar.spi.TraverseVisitor;
 import org.opentripplanner.ext.carpooling.CarpoolingService;
+import org.opentripplanner.ext.dataoverlay.configuration.DataOverlayParameterBindings;
 import org.opentripplanner.ext.empiricaldelay.EmpiricalDelayService;
 import org.opentripplanner.ext.flex.FlexParameters;
 import org.opentripplanner.ext.geocoder.LuceneIndex;
@@ -76,6 +77,9 @@ public class DefaultServerRequestContext implements OtpServerRequestContext {
   @Nullable
   private final CarpoolingService carpoolingService;
 
+  @Nullable
+  private final DataOverlayParameterBindings dataOverlayParameterBindings;
+
   @Nullable
   private final ItineraryDecorator emissionItineraryDecorator;
 
@@ -146,6 +150,7 @@ public DefaultServerRequestContext(
     ViaCoordinateTransferFactory viaTransferResolver,
     WorldEnvelopeService worldEnvelopeService,
     @Nullable CarpoolingService carpoolingService,
+    @Nullable DataOverlayParameterBindings dataOverlayParameterBindings,
     @Nullable ItineraryDecorator emissionItineraryDecorator,
     StreetDetailsService streetDetailsService,
     @Nullable EmpiricalDelayService empiricalDelayService,
@@ -184,6 +189,7 @@ public DefaultServerRequestContext(
 
     // Optional fields
     this.carpoolingService = carpoolingService;
+    this.dataOverlayParameterBindings = dataOverlayParameterBindings;
     this.emissionItineraryDecorator = emissionItineraryDecorator;
     this.streetDetailsService = streetDetailsService;
     this.empiricalDelayService = empiricalDelayService;
@@ -338,6 +344,12 @@ public CarpoolingService carpoolingService() {
     return carpoolingService;
   }
 
+  @Nullable
+  @Override
+  public DataOverlayParameterBindings dataOverlayParameterBindings() {
+    return dataOverlayParameterBindings;
+  }
+
   @Nullable
   @Override
   public LuceneIndex lucenceIndex() {

application/src/test/java/org/opentripplanner/TestServerContext.java

@@ -57,7 +57,7 @@ public class TestServerContext {
 
   private TestServerContext() {}
 
-  /** Create a context for unit testing using default RoutingRequest.*/
+  /** Create a context for unit testing using default RoutingRequest. */
   public static OtpServerRequestContext createServerContext(
     Graph graph,
     TimetableRepository timetableRepository,
@@ -142,6 +142,7 @@ public static OtpServerRequestContext createServerContext(
       createViaTransferResolver(graph, transitService),
       createWorldEnvelopeService(),
       null,
+      null,
       createEmissionsItineraryDecorator(),
       createStreetDetailsService(),
       null,