refactor(Various changes to allow bus notification to be sent on firs…

…t trip leg):

src/main/java/org/opentripplanner/middleware/triptracker/ManageTripTracking.java

@@ -2,6 +2,8 @@
 
 import org.eclipse.jetty.http.HttpStatus;
 import org.opentripplanner.middleware.models.TrackedJourney;
+import org.opentripplanner.middleware.otp.response.Itinerary;
+import org.opentripplanner.middleware.otp.response.Leg;
 import org.opentripplanner.middleware.persistence.Persistence;
 import org.opentripplanner.middleware.triptracker.instruction.TripInstruction;
 import org.opentripplanner.middleware.triptracker.interactions.busnotifiers.BusOperatorActions;
@@ -10,6 +12,10 @@
 import spark.Request;
 
 import static org.opentripplanner.middleware.utils.ConfigUtils.getConfigPropertyAsInt;
+import static org.opentripplanner.middleware.utils.ItineraryUtils.getFirstLeg;
+import static org.opentripplanner.middleware.utils.ItineraryUtils.getRouteIdFromLeg;
+import static org.opentripplanner.middleware.utils.ItineraryUtils.isBusLeg;
+import static org.opentripplanner.middleware.utils.ItineraryUtils.legsMatch;
 import static org.opentripplanner.middleware.utils.JsonUtils.logMessageAndHalt;
 
 public class ManageTripTracking {
@@ -145,19 +151,40 @@ private static EndTrackingResponse completeJourney(TripTrackingData tripData, bo
             tripData.trip.journeyState.matchingItinerary,
             Persistence.otpUsers.getById(tripData.trip.userId)
         );
-        BusOperatorActions
-            .getDefault()
-            .handleCancelNotificationAction(travelerPosition);
+        cancelBusNotification(travelerPosition, tripData.trip.journeyState.matchingItinerary);
         TrackedJourney trackedJourney = travelerPosition.trackedJourney;
         trackedJourney.end(isForciblyEnded);
         Persistence.trackedJourneys.updateField(trackedJourney.id, TrackedJourney.END_TIME_FIELD_NAME, trackedJourney.endTime);
         Persistence.trackedJourneys.updateField(trackedJourney.id, TrackedJourney.END_CONDITION_FIELD_NAME, trackedJourney.endCondition);
 
-        // Provide response.
         return new EndTrackingResponse(
             TripInstruction.NO_INSTRUCTION,
             TripStatus.ENDED.name()
         );
+    }
 
+    /**
+     * Cancel bus notifications which will not be fulfilled.
+     */
+    private static void cancelBusNotification(TravelerPosition travelerPosition, Itinerary itinerary) {
+        Leg firstLegOfTrip = getFirstLeg(itinerary);
+        Leg busLeg = getLegToCancel(travelerPosition, firstLegOfTrip);
+        BusOperatorActions
+            .getDefault()
+            .handleCancelNotificationAction(travelerPosition, busLeg);
+    }
+
+    /**
+     * If the traveler is still on the first leg of their trip and bus notification has been sent, cancel notification
+     * related to this first leg. If the traveler is passed the first leg, cancel notification related to the next leg.
+     */
+    public static Leg getLegToCancel(TravelerPosition travelerPosition, Leg firstLegOfTrip) {
+        if (legsMatch(travelerPosition.expectedLeg, firstLegOfTrip) && isBusLeg(travelerPosition.expectedLeg)) {
+            var routeId = getRouteIdFromLeg(travelerPosition.expectedLeg);
+            if (routeId != null && travelerPosition.trackedJourney.busNotificationMessages.containsKey(routeId)) {
+                return firstLegOfTrip;
+            }
+        }
+        return travelerPosition.nextLeg;
     }
 }

src/main/java/org/opentripplanner/middleware/triptracker/TravelerLocator.java

@@ -57,20 +57,20 @@ public static String getInstruction(
     ) {
         if (hasRequiredWalkLeg(travelerPosition)) {
             if (hasRequiredTripStatus(tripStatus)) {
-                TripInstruction tripInstruction = alignTravelerToTrip(travelerPosition, isStartOfTrip, tripStatus);
+                TripInstruction tripInstruction = alignTravelerToTrip(travelerPosition, isStartOfTrip);
                 if (tripInstruction != null) {
                     return tripInstruction.build();
                 }
             }
 
             if (tripStatus.equals(TripStatus.DEVIATED)) {
-                TripInstruction tripInstruction = getBackOnTrack(travelerPosition, isStartOfTrip, tripStatus);
+                TripInstruction tripInstruction = getBackOnTrack(travelerPosition, isStartOfTrip);
                 if (tripInstruction != null) {
                     return tripInstruction.build();
                 }
             }
         } else if (hasRequiredTransitLeg(travelerPosition) && hasRequiredTripStatus(tripStatus)) {
-            TripInstruction tripInstruction = alignTravelerToTransitTrip(travelerPosition);
+            TripInstruction tripInstruction = alignTravelerToTransitTrip(travelerPosition, isStartOfTrip);
             if (tripInstruction != null) {
                 return tripInstruction.build();
             }
@@ -111,10 +111,9 @@ private static boolean hasRequiredTripStatus(TripStatus tripStatus) {
     @Nullable
     private static TripInstruction getBackOnTrack(
         TravelerPosition travelerPosition,
-        boolean isStartOfTrip,
-        TripStatus tripStatus
+        boolean isStartOfTrip
     ) {
-        TripInstruction instruction = alignTravelerToTrip(travelerPosition, isStartOfTrip, tripStatus);
+        TripInstruction instruction = alignTravelerToTrip(travelerPosition, isStartOfTrip);
         if (instruction != null && instruction.hasInstruction()) {
             return instruction;
         }
@@ -130,13 +129,12 @@ private static TripInstruction getBackOnTrack(
     @Nullable
     public static TripInstruction alignTravelerToTrip(
         TravelerPosition travelerPosition,
-        boolean isStartOfTrip,
-        TripStatus tripStatus
+        boolean isStartOfTrip
     ) {
         Locale locale = travelerPosition.locale;
 
         if (isApproachingEndOfLeg(travelerPosition)) {
-            if (sendBusNotification(travelerPosition, isStartOfTrip, tripStatus)) {
+            if (sendBusNotification(travelerPosition, isStartOfTrip)) {
                 // Regardless of whether the notification is sent or qualifies, provide a 'wait for bus' instruction.
                 return new WaitForTransitInstruction(travelerPosition.nextLeg, travelerPosition.currentTime, locale);
             }
@@ -159,13 +157,13 @@ public static TripInstruction alignTravelerToTrip(
      */
     public static boolean sendBusNotification(
         TravelerPosition travelerPosition,
-        boolean isStartOfTrip,
-        TripStatus tripStatus
+        boolean isStartOfTrip
     ) {
-        if (shouldNotifyBusOperator(travelerPosition, isStartOfTrip)) {
+        Leg busLeg = (isStartOfTrip) ? travelerPosition.expectedLeg : travelerPosition.nextLeg;
+        if (shouldNotifyBusOperator(travelerPosition, busLeg)) {
             BusOperatorActions
                 .getDefault()
-                .handleSendNotificationAction(tripStatus, travelerPosition);
+                .handleSendNotificationAction(travelerPosition, busLeg);
             return true;
         }
         return false;
@@ -174,21 +172,37 @@ public static boolean sendBusNotification(
     /**
      * Given the traveler's position and leg type, check if bus notification should be sent.
      */
-    public static boolean shouldNotifyBusOperator(TravelerPosition travelerPosition, boolean isStartOfTrip) {
-        return (isStartOfTrip)
-            ? isBusLeg(travelerPosition.expectedLeg) && isWithinOperationalNotifyWindow(travelerPosition.currentTime, travelerPosition.expectedLeg)
-            : isBusLeg(travelerPosition.nextLeg) && isWithinOperationalNotifyWindow(travelerPosition);
+    public static boolean shouldNotifyBusOperator(TravelerPosition travelerPosition, Leg busLeg) {
+        return isBusLeg(busLeg) && isWithinOperationalNotifyWindow(travelerPosition.currentTime, busLeg);
+    }
+
+    /**
+     * A trip which starts with a transit leg.
+     */
+    private static boolean tripStartsWithTransitLeg(TravelerPosition travelerPosition, boolean isStartOfTrip) {
+        return isStartOfTrip && travelerPosition.expectedLeg.transitLeg;
     }
 
     /**
      * Align the traveler's position to the nearest transit stop or destination.
      */
     @Nullable
-    public static TripInstruction alignTravelerToTransitTrip(TravelerPosition travelerPosition) {
+    public static TripInstruction alignTravelerToTransitTrip(
+        TravelerPosition travelerPosition,
+        boolean isStartOfTrip
+    ) {
         Locale locale = travelerPosition.locale;
         Leg expectedLeg = travelerPosition.expectedLeg;
         String finalStop = expectedLeg.to.name;
 
+        if (
+            tripStartsWithTransitLeg(travelerPosition, isStartOfTrip) &&
+            sendBusNotification(travelerPosition, isStartOfTrip)
+        ) {
+            // Regardless of whether the notification is sent or qualifies, provide a 'wait for bus' instruction.
+            return new WaitForTransitInstruction(expectedLeg, travelerPosition.currentTime, locale);
+        }
+
         if (isApproachingEndOfLeg(travelerPosition)) {
             return new GetOffHereTransitInstruction(finalStop, locale);
         }
@@ -241,10 +255,6 @@ public static boolean isAtEndOfLeg(TravelerPosition travelerPosition) {
         return getDistanceToEndOfLeg(travelerPosition) <= TRIP_INSTRUCTION_IMMEDIATE_RADIUS;
     }
 
-    public static boolean isWithinOperationalNotifyWindow(TravelerPosition travelerPosition) {
-        return isWithinOperationalNotifyWindow(travelerPosition.currentTime, travelerPosition.nextLeg);
-    }
-
     /**
      * Make sure the traveler is on schedule or ahead of schedule (but not too far) to be within an operational window
      * for the bus service.

src/main/java/org/opentripplanner/middleware/triptracker/TravelerPosition.java

@@ -89,6 +89,13 @@ public TravelerPosition(Leg expectedLeg, Leg nextLeg, Instant currentTime) {
         this.currentTime = currentTime;
     }
 
+    /** Used for unit testing. */
+    public TravelerPosition(Leg expectedLeg, Leg nextLeg, TrackedJourney trackedJourney) {
+        this.expectedLeg = expectedLeg;
+        this.nextLeg = nextLeg;
+        this.trackedJourney = trackedJourney;
+    }
+
     /** Computes the current deviation in meters from the expected itinerary. */
     public double getDeviationMeters() {
         return getDistanceFromLine(legSegmentFromPosition.start, legSegmentFromPosition.end, currentPosition);

src/main/java/org/opentripplanner/middleware/triptracker/interactions/busnotifiers/BusOperatorActions.java

@@ -1,8 +1,8 @@
 package org.opentripplanner.middleware.triptracker.interactions.busnotifiers;
 
 import com.fasterxml.jackson.databind.JsonNode;
+import org.opentripplanner.middleware.otp.response.Leg;
 import org.opentripplanner.middleware.triptracker.TravelerPosition;
-import org.opentripplanner.middleware.triptracker.TripStatus;
 import org.opentripplanner.middleware.utils.JsonUtils;
 import org.opentripplanner.middleware.utils.YamlUtils;
 import org.slf4j.Logger;
@@ -48,8 +48,8 @@ public BusOperatorActions(List<AgencyAction> agencyActions) {
     /**
      * Get the action that matches the given agency id.
      */
-    public AgencyAction getAgencyAction(TravelerPosition travelerPosition) {
-        String agencyId = removeAgencyPrefix(getAgencyIdFromLeg(travelerPosition.nextLeg));
+    public AgencyAction getAgencyAction(Leg busLeg) {
+        String agencyId = removeAgencyPrefix(getAgencyIdFromLeg(busLeg));
         if (agencyId != null) {
             for (AgencyAction agencyAction : agencyActions) {
                 if (agencyAction.agencyId.equalsIgnoreCase(agencyId)) {
@@ -63,12 +63,12 @@ public AgencyAction getAgencyAction(TravelerPosition travelerPosition) {
     /**
      * Get the correct action for agency and send notification.
      */
-    public void handleSendNotificationAction(TripStatus tripStatus, TravelerPosition travelerPosition) {
-        AgencyAction action = getAgencyAction(travelerPosition);
+    public void handleSendNotificationAction(TravelerPosition travelerPosition, Leg busLeg) {
+        AgencyAction action = getAgencyAction(busLeg);
         if (action != null) {
             BusOperatorInteraction interaction = getBusOperatorInteraction(action);
             try {
-                interaction.sendNotification(tripStatus, travelerPosition);
+                interaction.sendNotification(travelerPosition, busLeg);
             } catch (Exception e) {
                 LOG.error("Could not trigger class {} for agency {}", action.trigger, action.agencyId, e);
                 throw new RuntimeException(e);
@@ -79,12 +79,12 @@ public void handleSendNotificationAction(TripStatus tripStatus, TravelerPosition
     /**
      * Get the correct action for agency and cancel notification.
      */
-    public void handleCancelNotificationAction(TravelerPosition travelerPosition) {
-        AgencyAction action = getAgencyAction(travelerPosition);
+    public void handleCancelNotificationAction(TravelerPosition travelerPosition, Leg busLeg) {
+        AgencyAction action = getAgencyAction(busLeg);
         if (action != null) {
             BusOperatorInteraction interaction = getBusOperatorInteraction(action);
             try {
-                interaction.cancelNotification(travelerPosition);
+                interaction.cancelNotification(travelerPosition, busLeg);
             } catch (Exception e) {
                 LOG.error("Could not trigger class {} for agency {}", action.trigger, action.agencyId, e);
                 throw new RuntimeException(e);

src/main/java/org/opentripplanner/middleware/triptracker/interactions/busnotifiers/BusOperatorInteraction.java

@@ -1,11 +1,12 @@
 package org.opentripplanner.middleware.triptracker.interactions.busnotifiers;
 
+import org.opentripplanner.middleware.otp.response.Leg;
 import org.opentripplanner.middleware.triptracker.TravelerPosition;
 import org.opentripplanner.middleware.triptracker.TripStatus;
 
 public interface BusOperatorInteraction {
 
-    void sendNotification(TripStatus tripStatus, TravelerPosition travelerPosition);
+    void sendNotification(TravelerPosition travelerPosition, Leg busLeg);
 
-    void cancelNotification(TravelerPosition travelerPosition);
+    void cancelNotification(TravelerPosition travelerPosition, Leg busLeg);
 }

src/main/java/org/opentripplanner/middleware/triptracker/interactions/busnotifiers/UsRideGwinnettNotifyBusOperator.java

@@ -4,8 +4,8 @@
 import org.eclipse.jetty.http.HttpMethod;
 import org.eclipse.jetty.http.HttpStatus;
 import org.opentripplanner.middleware.models.TrackedJourney;
+import org.opentripplanner.middleware.otp.response.Leg;
 import org.opentripplanner.middleware.triptracker.TravelerPosition;
-import org.opentripplanner.middleware.triptracker.TripStatus;
 import org.opentripplanner.middleware.utils.HttpUtils;
 import org.opentripplanner.middleware.utils.JsonUtils;
 import org.slf4j.Logger;
@@ -79,8 +79,8 @@ private static List<String> getBusOperatorNotifierQualifyingRoutes() {
     /**
      * Stage notification to bus operator by making sure all required conditions are met.
      */
-    public void sendNotification(TripStatus tripStatus, TravelerPosition travelerPosition) {
-        var routeId = getRouteIdFromLeg(travelerPosition.nextLeg);
+    public void sendNotification(TravelerPosition travelerPosition, Leg busLeg) {
+        var routeId = getRouteIdFromLeg(busLeg);
         try {
             if (
                 hasNotSentNotificationForRoute(travelerPosition.trackedJourney, routeId) &&
@@ -98,13 +98,13 @@ public void sendNotification(TripStatus tripStatus, TravelerPosition travelerPos
     }
 
     /**
-     * Cancel a previously sent notification for the next bus leg.
+     * Cancel a previously sent notification for the expected or next leg.
      */
-    public void cancelNotification(TravelerPosition travelerPosition) {
-        var routeId = getRouteIdFromLeg(travelerPosition.nextLeg);
+    public void cancelNotification(TravelerPosition travelerPosition, Leg busLeg) {
+        var routeId = getRouteIdFromLeg(busLeg);
         try {
             if (
-                isBusLeg(travelerPosition.nextLeg) && routeId != null &&
+                isBusLeg(busLeg) && routeId != null &&
                 hasNotCanceledNotificationForRoute(travelerPosition.trackedJourney, routeId)
             ) {
                 Map<String, String> busNotificationRequests = travelerPosition.trackedJourney.busNotificationMessages;

src/main/java/org/opentripplanner/middleware/utils/ItineraryUtils.java

@@ -178,7 +178,7 @@ private static boolean isAfterServiceStart(ZonedDateTime time) {
     /**
      * Check whether a new leg of an itinerary matches the previous itinerary leg for the purposes of trip monitoring.
      */
-    private static boolean legsMatch(Leg referenceItineraryLeg, Leg candidateItineraryLeg) {
+    public static boolean legsMatch(Leg referenceItineraryLeg, Leg candidateItineraryLeg) {
         // for now don't analyze non-transit legs
         if (!referenceItineraryLeg.transitLeg) return true;
 
@@ -360,4 +360,15 @@ public static String getStopIdFromPlace(Place place) {
     public static String getRouteShortNameFromLeg(Leg leg) {
         return leg.routeShortName;
     }
+
+    /**
+     * Get the first leg in an itinerary.
+     */
+    public static Leg getFirstLeg(Itinerary itinerary) {
+        if (itinerary != null && itinerary.legs != null && !itinerary.legs.isEmpty()) {
+            return itinerary.legs.get(0);
+        }
+        return null;
+    }
+
 }