OTP-1382 GMAP Push notifications for leg transition

src/main/java/org/opentripplanner/middleware/i18n/Message.java

@@ -19,7 +19,10 @@ public enum Message {
     ACCEPT_DEPENDENT_EMAIL_SUBJECT,
     ACCEPT_DEPENDENT_EMAIL_MANAGE,
     ACCEPT_DEPENDENT_ERROR,
+    ARRIVED_NOTIFICATION,
+    DEPARTED_NOTIFICATION,
     LABEL_AND_CONTENT,
+    MODE_CHANGE_NOTIFICATION,
     SMS_STOP_NOTIFICATIONS,
     TRIP_EMAIL_SUBJECT,
     TRIP_EMAIL_SUBJECT_FOR_USER,
@@ -47,6 +50,7 @@ public enum Message {
     TRIP_INVITE_COMPANION,
     TRIP_INVITE_PRIMARY_TRAVELER,
     TRIP_INVITE_OBSERVER,
+    TRIP_NAME_UNDEFINED,
     TRIP_NOT_FOUND_NOTIFICATION,
     TRIP_NO_LONGER_POSSIBLE_NOTIFICATION,
     TRIP_REMINDER_NOTIFICATION,

src/main/java/org/opentripplanner/middleware/models/LegTransitionNotification.java

@@ -0,0 +1,154 @@
+package org.opentripplanner.middleware.models;
+
+import org.opentripplanner.middleware.i18n.Message;
+import org.opentripplanner.middleware.otp.response.Leg;
+import org.opentripplanner.middleware.persistence.Persistence;
+import org.opentripplanner.middleware.tripmonitor.jobs.CheckMonitoredTrip;
+import org.opentripplanner.middleware.tripmonitor.jobs.NotificationType;
+import org.opentripplanner.middleware.triptracker.TravelerPosition;
+import org.opentripplanner.middleware.triptracker.TripStatus;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.annotation.Nullable;
+import java.util.HashSet;
+import java.util.Locale;
+import java.util.Set;
+
+import static com.mongodb.client.model.Filters.eq;
+import static org.opentripplanner.middleware.tripmonitor.jobs.NotificationType.MODE_CHANGE_NOTIFICATION;
+import static org.opentripplanner.middleware.tripmonitor.jobs.NotificationType.ARRIVED_NOTIFICATION;
+import static org.opentripplanner.middleware.tripmonitor.jobs.NotificationType.DEPARTED_NOTIFICATION;
+import static org.opentripplanner.middleware.triptracker.TravelerLocator.hasRequiredTransitLeg;
+import static org.opentripplanner.middleware.triptracker.TravelerLocator.hasRequiredTripStatus;
+import static org.opentripplanner.middleware.triptracker.TravelerLocator.hasRequiredWalkLeg;
+import static org.opentripplanner.middleware.triptracker.TravelerLocator.isApproachingEndOfLeg;
+import static org.opentripplanner.middleware.triptracker.TravelerLocator.isAtStartOfLeg;
+
+public class LegTransitionNotification {
+    private static final Logger LOG = LoggerFactory.getLogger(LegTransitionNotification.class);
+
+    public String travelerName;
+    public NotificationType notificationType;
+    public TravelerPosition travelerPosition;
+    public Locale observerLocale;
+    public TripMonitorNotification tripMonitorNotification;
+
+    public LegTransitionNotification(
+        String travelerName,
+        NotificationType notificationType,
+        TravelerPosition travelerPosition,
+        Locale observerLocale
+    ) {
+        this.travelerName = travelerName;
+        this.notificationType = notificationType;
+        this.travelerPosition = travelerPosition;
+        this.observerLocale = observerLocale;
+        this.tripMonitorNotification = createTripMonitorNotification(notificationType);
+    }
+
+    /**
+     * Create {@link TripMonitorNotification} for leg transition based on notification type.
+     */
+    @Nullable
+    private TripMonitorNotification createTripMonitorNotification(NotificationType notificationType) {
+        String body;
+        switch (notificationType) {
+            case MODE_CHANGE_NOTIFICATION:
+                body = String.format(
+                    Message.MODE_CHANGE_NOTIFICATION.get(observerLocale),
+                    travelerName,
+                    travelerPosition.expectedLeg.to.name
+                );
+                break;
+            case DEPARTED_NOTIFICATION:
+                body = String.format(
+                    Message.DEPARTED_NOTIFICATION.get(observerLocale),
+                    travelerName,
+                    travelerPosition.expectedLeg.from.name
+                );
+                break;
+            case ARRIVED_NOTIFICATION:
+                body = String.format(
+                    Message.ARRIVED_NOTIFICATION.get(observerLocale),
+                    travelerName,
+                    travelerPosition.expectedLeg.to.name
+                );
+                break;
+            default:
+                body = null;
+        }
+        return (body != null) ? new TripMonitorNotification(notificationType, body) : null;
+    }
+
+    /**
+     * Get a list of users that should be notified of a traveler's leg transition.
+     */
+    public static Set<OtpUser> getLegTransitionNotifyUsers(MonitoredTrip trip) {
+        Set<OtpUser> notifyUsers = new HashSet<>();
+
+        if (trip.ownedByPrimary() && trip.companion != null) {
+            notifyUsers.add(Persistence.otpUsers.getOneFiltered(eq("email", trip.companion.email)));
+        } else if (trip.ownedByCompanion() && trip.primary != null) {
+            notifyUsers.add(Persistence.otpUsers.getById(trip.primary.userId));
+        }
+
+        trip.observers.forEach(observer -> {
+            if (observer.isConfirmed()) {
+                notifyUsers.add(Persistence.otpUsers.getOneFiltered(eq("email", observer.email)));
+            }
+        });
+
+        return notifyUsers;
+    }
+
+    /**
+     * If a traveler is on the route (not deviated), check for possible leg transition notification.
+     */
+    public static void checkForLegTransition(
+        TripStatus tripStatus,
+        TravelerPosition travelerPosition,
+        MonitoredTrip trip
+    ) {
+        if (
+            hasRequiredTripStatus(tripStatus) &&
+            (hasRequiredWalkLeg(travelerPosition) || hasRequiredTransitLeg(travelerPosition))
+        ) {
+            NotificationType notificationType = getLegTransitionNotificationType(travelerPosition);
+            if (notificationType != null) {
+                try {
+                    new CheckMonitoredTrip(trip).processLegTransition(notificationType, travelerPosition);
+                } catch (CloneNotSupportedException e) {
+                    LOG.error("Error encountered while checking leg transition.", e);
+                }
+            }
+        }
+    }
+
+    /**
+     * Depending on the traveler's proximity to the start/end of a leg, return the appropriate notification type.
+     */
+    private static NotificationType getLegTransitionNotificationType(TravelerPosition travelerPosition) {
+        if (isAtStartOfLeg(travelerPosition)) {
+            return DEPARTED_NOTIFICATION;
+        } else if (isApproachingEndOfLeg(travelerPosition)) {
+            if (hasModeChanged(travelerPosition)) {
+                return MODE_CHANGE_NOTIFICATION;
+            }
+            return ARRIVED_NOTIFICATION;
+        }
+        return null;
+    }
+
+    /**
+     * The traveler is at the end of the current leg and the mode has changed between this and the next leg.
+     */
+    private static boolean hasModeChanged(TravelerPosition travelerPosition) {
+        Leg nextLeg = travelerPosition.nextLeg;
+        Leg expectedLeg = travelerPosition.expectedLeg;
+        return
+            isApproachingEndOfLeg(travelerPosition) &&
+            nextLeg != null &&
+            !nextLeg.mode.equalsIgnoreCase(expectedLeg.mode);
+    }
+}

src/main/java/org/opentripplanner/middleware/models/MonitoredTrip.java

@@ -32,6 +32,8 @@
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
+import static com.mongodb.client.model.Filters.eq;
+
 /**
  * A monitored trip represents a trip a user would like to receive notification on if affected by a delay and/or route
  * change.
@@ -510,4 +512,19 @@ public TripUsers(MobilityProfileLite primary, RelatedUser companion, List<Relate
             this.observers = observers;
         }
     }
+
+    /**
+     * Trip created by primary user.
+     */
+    public boolean ownedByPrimary() {
+        return primary != null && primary.userId.equalsIgnoreCase(userId);
+    }
+
+    /**
+     * Trip created by companion user.
+     */
+    public boolean ownedByCompanion() {
+        OtpUser tripOwner = Persistence.otpUsers.getById(userId);
+        return tripOwner != null && companion != null && companion.email.equalsIgnoreCase(tripOwner.email);
+    }
 }

src/main/java/org/opentripplanner/middleware/models/OtpUser.java

@@ -4,6 +4,7 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonSetter;
 import org.apache.logging.log4j.util.Strings;
+import org.bson.codecs.pojo.annotations.BsonIgnore;
 import org.opentripplanner.middleware.auth.Auth0Users;
 import org.opentripplanner.middleware.auth.RequestingUser;
 import org.opentripplanner.middleware.persistence.Persistence;
@@ -212,6 +213,15 @@ public Optional<TripSurveyNotification> findLastTripSurveyNotificationSent() {
         return tripSurveyNotifications.stream().max(Comparator.comparingLong(n -> n.timeSent.getTime()));
     }
 
+    /**
+     * Use name if available, if not fallback on email (which is a required field).
+     */
+    @JsonIgnore
+    @BsonIgnore
+    public String getDisplayedName() {
+        return Strings.isBlank(name) ? email.replace("@", " at ") : name;
+    }
+
     /** Obtains a notification with the given id, if available. */
     public Optional<TripSurveyNotification> findNotification(String id) {
         if (tripSurveyNotifications == null || Strings.isBlank(id)) return Optional.empty();

src/main/java/org/opentripplanner/middleware/models/TripMonitorNotification.java

@@ -8,6 +8,7 @@
 
 import java.util.Date;
 import java.util.Locale;
+import java.util.Objects;
 
 /**
  * Contains information about the type and details of messages to be sent to users about their {@link MonitoredTrip}s.
@@ -16,8 +17,8 @@ public class TripMonitorNotification extends Model {
     private static final Logger LOG = LoggerFactory.getLogger(TripMonitorNotification.class);
     public static final String STOPWATCH_ICON = "⏱";
 
-    public final NotificationType type;
-    public final String body;
+    public NotificationType type;
+    public String body;
 
     /** Getter functions are used by HTML template renderer */
     public String getBody() {
@@ -28,6 +29,12 @@ public NotificationType getType() {
         return type;
     }
 
+    /**
+     * This no-arg constructor exists to make MongoDB happy.
+     */
+    public TripMonitorNotification() {
+    }
+
     public TripMonitorNotification(NotificationType type, String body) {
         this.type = type;
         this.body = body;
@@ -110,4 +117,22 @@ public static TripMonitorNotification createInitialReminderNotification(
             )
         );
     }
-}
+
+    /**
+     * Checks for equality excluding the parent {@link Model} class.
+     */
+    @Override
+    public boolean equals(Object o) {
+        if (o == null || getClass() != o.getClass()) return false;
+        TripMonitorNotification that = (TripMonitorNotification) o;
+        return type == that.type && Objects.equals(body, that.body);
+    }
+
+    /**
+     * Creates a hash code from fields in this class only excluding fields within the parent {@link Model} class.
+     */
+    @Override
+    public int hashCode() {
+        return Objects.hash(type, body);
+    }
+}

src/main/java/org/opentripplanner/middleware/tripmonitor/JourneyState.java

@@ -40,7 +40,6 @@ public class JourneyState implements Cloneable {
 
     /**
      * The notifications already sent.
-     * FIXME this is never set, so it has no effect.
      */
     public Set<TripMonitorNotification> lastNotifications = new HashSet<>();
 

src/main/java/org/opentripplanner/middleware/tripmonitor/TrustedCompanion.java

@@ -184,7 +184,6 @@ private static boolean sendAcceptDependentEmail(OtpUser dependentUser, OtpUser r
 
         String acceptDependentLinkLabel = Message.ACCEPT_DEPENDENT_EMAIL_LINK_TEXT.get(locale);
         String acceptDependentUrl = getAcceptDependentUrl(acceptKey, locale);
-        String addressee = (Strings.isBlank(dependentUser.name)) ? dependentUser.email : dependentUser.name;
 
         // A HashMap is needed instead of a Map for template data to be serialized to the template renderer.
         Map<String, Object> templateData = new HashMap<>(
@@ -193,7 +192,7 @@ private static boolean sendAcceptDependentEmail(OtpUser dependentUser, OtpUser r
                 "acceptDependentLinkLabelAndUrl", label(acceptDependentLinkLabel, acceptDependentUrl, locale),
                 "acceptDependentUrl", acceptDependentUrl,
                 "emailFooter", Message.ACCEPT_DEPENDENT_EMAIL_FOOTER.get(locale),
-                "emailGreeting", String.format(Message.ACCEPT_DEPENDENT_EMAIL_GREETING.get(locale), addressee),
+                "emailGreeting", String.format(Message.ACCEPT_DEPENDENT_EMAIL_GREETING.get(locale), dependentUser.getDisplayedName()),
                 "manageLinkUrl", String.format("%s%s", OTP_UI_URL, SETTINGS_PATH),
                 "manageLinkText", Message.ACCEPT_DEPENDENT_EMAIL_MANAGE.get(locale)
             )