Add Transmodel carpool streetMode (opentripplanner#7084)

* Adds a car_pool streetMode that can be used for directMode in the Transmodel API.

* Changes the new streetmode car_pool to carpool so that it matches the transitmode.

* Adds more extensive descriptions to the transit and street modes for carpooling.

* Clarifies enum descriptions for carpooling.

Co-authored-by: leonardehrenfried <mail@leonard.io>

---------

Co-authored-by: leonardehrenfried <mail@leonard.io>

Author: eibakke

application/src/ext/java/org/opentripplanner/ext/carpooling/internal/DefaultCarpoolingRepository.java

@@ -24,9 +24,9 @@ public Collection<CarpoolTrip> getCarpoolTrips() {
   public void upsertCarpoolTrip(CarpoolTrip trip) {
     CarpoolTrip existingTrip = trips.put(trip.getId(), trip);
     if (existingTrip != null) {
-      LOG.info("Updated carpool trip {} with {} stops", trip.getId(), trip.stops().size());
+      LOG.debug("Updated carpool trip {} with {} stops", trip.getId(), trip.stops().size());
     } else {
-      LOG.info("Added new carpool trip {} with {} stops", trip.getId(), trip.stops().size());
+      LOG.debug("Added new carpool trip {} with {} stops", trip.getId(), trip.stops().size());
     }
   }
 }

application/src/ext/java/org/opentripplanner/ext/carpooling/service/DefaultCarpoolingService.java

@@ -1,6 +1,7 @@
 package org.opentripplanner.ext.carpooling.service;
 
 import java.time.Duration;
+import java.util.Collections;
 import java.util.Comparator;
 import java.util.List;
 import java.util.Objects;
@@ -18,6 +19,7 @@
 import org.opentripplanner.framework.geometry.WgsCoordinate;
 import org.opentripplanner.model.plan.Itinerary;
 import org.opentripplanner.routing.api.request.RouteRequest;
+import org.opentripplanner.routing.api.request.StreetMode;
 import org.opentripplanner.routing.api.response.InputField;
 import org.opentripplanner.routing.api.response.RoutingError;
 import org.opentripplanner.routing.api.response.RoutingErrorCode;
@@ -113,6 +115,10 @@ public DefaultCarpoolingService(
   @Override
   public List<Itinerary> route(RouteRequest request, LinkingContext linkingContext)
     throws RoutingValidationException {
+    if (!StreetMode.CARPOOL.equals(request.journey().direct().mode())) {
+      return Collections.emptyList();
+    }
+
     validateRequest(request);
 
     WgsCoordinate passengerPickup = new WgsCoordinate(request.from().getCoordinate());

application/src/main/java/org/opentripplanner/apis/gtfs/mapping/routerequest/AccessModeMapper.java

@@ -34,7 +34,7 @@ public static GraphQLTypes.GraphQLPlanAccessMode map(StreetMode mode) {
       case CAR_PICKUP -> GraphQLTypes.GraphQLPlanAccessMode.CAR_DROP_OFF;
       case FLEXIBLE -> GraphQLTypes.GraphQLPlanAccessMode.FLEX;
       case SCOOTER_RENTAL -> GraphQLTypes.GraphQLPlanAccessMode.SCOOTER_RENTAL;
-      case WALK, CAR_HAILING, NOT_SET -> GraphQLTypes.GraphQLPlanAccessMode.WALK;
+      case WALK, CAR_HAILING, CARPOOL, NOT_SET -> GraphQLTypes.GraphQLPlanAccessMode.WALK;
     };
   }
 }

application/src/main/java/org/opentripplanner/apis/gtfs/mapping/routerequest/DirectModeMapper.java

@@ -32,7 +32,11 @@ public static GraphQLTypes.GraphQLPlanDirectMode map(StreetMode mode) {
       case CAR_TO_PARK -> GraphQLTypes.GraphQLPlanDirectMode.CAR_PARKING;
       case FLEXIBLE -> GraphQLTypes.GraphQLPlanDirectMode.FLEX;
       case SCOOTER_RENTAL -> GraphQLTypes.GraphQLPlanDirectMode.SCOOTER_RENTAL;
-      case WALK, CAR_HAILING, CAR_PICKUP, NOT_SET -> GraphQLTypes.GraphQLPlanDirectMode.WALK;
+      case WALK,
+        CAR_HAILING,
+        CAR_PICKUP,
+        CARPOOL,
+        NOT_SET -> GraphQLTypes.GraphQLPlanDirectMode.WALK;
     };
   }
 }

application/src/main/java/org/opentripplanner/apis/gtfs/mapping/routerequest/EgressModeMapper.java

@@ -32,6 +32,7 @@ public static GraphQLTypes.GraphQLPlanEgressMode map(StreetMode mode) {
       case SCOOTER_RENTAL -> GraphQLTypes.GraphQLPlanEgressMode.SCOOTER_RENTAL;
       case WALK,
         CAR_HAILING,
+        CARPOOL,
         CAR_TO_PARK,
         BIKE_TO_PARK,
         NOT_SET -> GraphQLTypes.GraphQLPlanEgressMode.WALK;

application/src/main/java/org/opentripplanner/apis/gtfs/mapping/routerequest/StreetModeMapper.java

@@ -103,6 +103,7 @@ private static boolean isAlwaysPresentInLeg(StreetMode mode) {
       mode == StreetMode.BIKE ||
       mode == StreetMode.CAR ||
       mode == StreetMode.WALK ||
+      mode == StreetMode.CARPOOL ||
       mode.includesParking()
     );
   }

application/src/main/java/org/opentripplanner/apis/gtfs/mapping/routerequest/TransferModeMapper.java

@@ -25,6 +25,7 @@ public static GraphQLTypes.GraphQLPlanTransferMode map(StreetMode mode) {
         CAR_HAILING,
         CAR_RENTAL,
         CAR_PICKUP,
+        CARPOOL,
         CAR_TO_PARK,
         BIKE_TO_PARK,
         FLEXIBLE,

application/src/main/java/org/opentripplanner/apis/transmodel/model/EnumTypes.java

@@ -421,6 +421,11 @@ public class EnumTypes {
       "the road, drive to a drop-off point along the road, and walk the rest of the way. " +
       "This can include car rentals at fixed locations or free-floating services."
     )
+    .value(
+      "carpool",
+      StreetMode.CARPOOL,
+      "Share a car ride with a driver and other passengers going in the same direction."
+    )
     .value(
       "flexible",
       StreetMode.FLEXIBLE,

application/src/main/java/org/opentripplanner/routing/algorithm/mapping/StreetModeToFormFactorMapper.java

@@ -22,6 +22,7 @@ public static RentalFormFactor map(StreetMode streetMode) {
         CAR_TO_PARK,
         CAR_PICKUP,
         CAR_HAILING,
+        CARPOOL,
         FLEXIBLE -> throw new IllegalStateException(
         "Cannot convert street mode %s to a form factor".formatted(streetMode)
       );

application/src/main/java/org/opentripplanner/routing/algorithm/mapping/StreetModeToRentalTraverseModeMapper.java

@@ -21,6 +21,7 @@ public static TraverseMode map(StreetMode mode) {
         CAR_TO_PARK,
         CAR_PICKUP,
         CAR_HAILING,
+        CARPOOL,
         FLEXIBLE -> throw new IllegalArgumentException("%s is not a rental mode.".formatted(mode));
     };
   }