Merge pull request opentripplanner#6631 from leonardehrenfried/simplify-vector-urls

Shorter path for debug vector tiles

Author: leonardehrenfried

.github/workflows/debug-client.yml

@@ -36,7 +36,7 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22
 
       - name: Set version
         run: echo "VERSION=`date +%Y/%m/%Y-%m-%dT%H:%M`" >> $GITHUB_ENV

application/src/main/java/org/opentripplanner/apis/APIEndpoints.java

@@ -20,7 +20,7 @@
 import org.opentripplanner.api.resource.UpdaterStatusResource;
 import org.opentripplanner.apis.gtfs.GtfsGraphQLAPI;
 import org.opentripplanner.apis.transmodel.TransmodelAPI;
-import org.opentripplanner.apis.vectortiles.GraphInspectorVectorTileResource;
+import org.opentripplanner.apis.vectortiles.DebugVectorTilesResource;
 import org.opentripplanner.ext.actuator.ActuatorAPI;
 import org.opentripplanner.ext.debugrastertiles.api.resource.DebugRasterTileResource;
 import org.opentripplanner.ext.geocoder.GeocoderResource;
@@ -41,7 +41,7 @@ private APIEndpoints() {
     // See the OTPFeature enum for details.
     addIfEnabled(APIServerInfo, ServerInfo.class);
     addIfEnabled(APIUpdaterStatus, UpdaterStatusResource.class);
-    addIfEnabled(DebugUi, GraphInspectorVectorTileResource.class);
+    addIfEnabled(DebugUi, DebugVectorTilesResource.class);
     addIfEnabled(GtfsGraphQlApi, GtfsGraphQLAPI.class);
     // scheduled to be removed and only here for backwards compatibility
     addIfEnabled(GtfsGraphQlApi, GtfsGraphQLAPI.GtfsGraphQLAPIOldPath.class);

…es/GraphInspectorVectorTileResource.java …ectortiles/DebugVectorTilesResource.javaapplication/src/main/java/org/opentripplanner/apis/vectortiles/GraphInspectorVectorTileResource.java renamed to application/src/main/java/org/opentripplanner/apis/vectortiles/DebugVectorTilesResource.java application/src/main/java/org/opentripplanner/apis/vectortiles/GraphInspectorVectorTileResource.java renamed to application/src/main/java/org/opentripplanner/apis/vectortiles/DebugVectorTilesResource.java

@@ -49,8 +49,8 @@
  * Slippy map vector tile API for rendering various graph information for inspection/debugging
  * purposes.
  */
-@Path("/routers/{ignoreRouterId}/inspector/vectortile")
-public class GraphInspectorVectorTileResource {
+@Path("/debug/vectortiles")
+public class DebugVectorTilesResource {
 
   private static final LayerParams REGULAR_STOPS = new LayerParams("regularStops", RegularStop);
   private static final LayerParams AREA_STOPS = new LayerParams("areaStops", AreaStop);
@@ -71,20 +71,12 @@ public class GraphInspectorVectorTileResource {
     VERTICES,
     RENTAL
   );
+  public static final String PATH = "/otp/debug/vectortiles/";
 
   private final OtpServerRequestContext serverContext;
-  private final String ignoreRouterId;
 
-  public GraphInspectorVectorTileResource(
-    @Context OtpServerRequestContext serverContext,
-    /**
-     * @deprecated The support for multiple routers are removed from OTP2.
-     * See https://github.com/opentripplanner/OpenTripPlanner/issues/2760
-     */
-    @Deprecated @PathParam("ignoreRouterId") String ignoreRouterId
-  ) {
+  public DebugVectorTilesResource(@Context OtpServerRequestContext serverContext) {
     this.serverContext = serverContext;
-    this.ignoreRouterId = ignoreRouterId;
   }
 
   @GET
@@ -104,7 +96,7 @@ public Response tileGet(
       grizzlyRequest.getLocale(),
       Arrays.asList(requestedLayers.split(",")),
       DEBUG_LAYERS,
-      GraphInspectorVectorTileResource::createLayerBuilder,
+      DebugVectorTilesResource::createLayerBuilder,
       serverContext
     );
   }
@@ -119,15 +111,9 @@ public TileJson getTileJson(
   ) {
     var envelope = serverContext.worldEnvelopeService().envelope().orElseThrow();
     List<FeedInfo> feedInfos = feedInfos();
-    List<String> rlayer = Arrays.asList(requestedLayers.split(","));
+    List<String> layers = Arrays.asList(requestedLayers.split(","));
 
-    var url = TileJson.urlWithDefaultPath(
-      uri,
-      headers,
-      rlayer,
-      ignoreRouterId,
-      "inspector/vectortile"
-    );
+    var url = TileJson.urlFromOverriddenBasePath(uri, headers, PATH, layers);
     return new TileJson(url, envelope, feedInfos, MIN_ZOOM, MAX_ZOOM);
   }
 
@@ -160,16 +146,12 @@ public StyleSpec getTileJson(@Context UriInfo uri, @Context HttpHeaders headers)
     );
   }
 
-  private String tileJsonUrl(String base, List<LayerParameters<LayerType>> layers) {
+  static String tileJsonUrl(String base, List<LayerParameters<LayerType>> layers) {
     final String allLayers = layers
       .stream()
       .map(LayerParameters::name)
       .collect(Collectors.joining(","));
-    return "%s/otp/routers/%s/inspector/vectortile/%s/tilejson.json".formatted(
-        base,
-        ignoreRouterId,
-        allLayers
-      );
+    return "%s%s%s/tilejson.json".formatted(base, PATH, allLayers);
   }
 
   private List<FeedInfo> feedInfos() {

application/src/test/java/org/opentripplanner/apis/vectortiles/DebugVectorTilesResourceTest.java

@@ -0,0 +1,51 @@
+package org.opentripplanner.apis.vectortiles;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.util.List;
+import org.junit.jupiter.api.Test;
+import org.opentripplanner.TestServerContext;
+import org.opentripplanner.apis.vectortiles.model.LayerType;
+import org.opentripplanner.ext.fares.impl.DefaultFareService;
+import org.opentripplanner.inspector.vector.LayerParameters;
+import org.opentripplanner.routing.graph.Graph;
+import org.opentripplanner.test.support.HttpForTest;
+import org.opentripplanner.transit.service.TimetableRepository;
+
+class DebugVectorTilesResourceTest {
+
+  private record LayerParams(String name, LayerType type) implements LayerParameters<LayerType> {
+    @Override
+    public String mapper() {
+      return "type";
+    }
+  }
+
+  private static final List<LayerParameters<LayerType>> LAYERS = List.of(
+    new LayerParams("edge", LayerType.Edge),
+    new LayerParams("areaStop", LayerType.AreaStop)
+  );
+
+  @Test
+  void tileJson() {
+    var resource = new DebugVectorTilesResource(
+      TestServerContext.createServerContext(
+        new Graph(),
+        new TimetableRepository(),
+        new DefaultFareService()
+      )
+    );
+    var req = HttpForTest.containerRequest();
+    var tileJson = resource.getTileJson(req.getUriInfo(), req, "l1,l2");
+    assertEquals(
+      "https://localhost:8080/otp/debug/vectortiles/l1,l2/{z}/{x}/{y}.pbf",
+      tileJson.tiles[0]
+    );
+  }
+
+  @Test
+  void tileJsonUrl() {
+    var url = DebugVectorTilesResource.tileJsonUrl("http://example.com", LAYERS);
+    assertEquals("http://example.com/otp/debug/vectortiles/edge,areaStop/tilejson.json", url);
+  }
+}

client/.env

@@ -1,3 +1,3 @@
 VITE_API_URL=/otp/transmodel/v3
-VITE_DEBUG_STYLE_URL=/otp/routers/default/inspector/vectortile/style.json
+VITE_DEBUG_STYLE_URL=/otp/debug/vectortiles/style.json
 VITE_GRAPHIQL_URL=/graphiql?flavor=transmodel

client/.env.development

@@ -1,3 +1,3 @@
 VITE_API_URL=http://localhost:8080/otp/transmodel/v3
-VITE_DEBUG_STYLE_URL=http://localhost:8080/otp/routers/default/inspector/vectortile/style.json
+VITE_DEBUG_STYLE_URL=http://localhost:8080/otp/debug/vectortiles/style.json
 VITE_GRAPHIQL_URL=http://localhost:8080/graphiql?flavor=transmodel