Multiple notification channels in middleware

src/main/java/org/opentripplanner/middleware/controllers/api/OtpUserController.java

@@ -112,7 +112,7 @@ public VerificationResult sendVerificationText(Request req, Response res) {
         if (verification.getStatus().equals("pending")) {
             otpUser.phoneNumber = phoneNumber;
             otpUser.isPhoneNumberVerified = false;
-            otpUser.notificationChannel = "sms";
+            otpUser.notificationChannel.add(OtpUser.Notification.SMS);
             Persistence.otpUsers.replace(otpUser.id, otpUser);
         }
 

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

@@ -1,21 +1,28 @@
 package org.opentripplanner.middleware.models;
 
+import com.fasterxml.jackson.annotation.JsonGetter;
 import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonSetter;
 import org.opentripplanner.middleware.auth.Auth0Users;
 import org.opentripplanner.middleware.auth.RequestingUser;
 import org.opentripplanner.middleware.persistence.Persistence;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.util.ArrayList;
-import java.util.List;
+import java.util.*;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 /**
  * This represents a user of an OpenTripPlanner instance (typically of the standard OTP UI/otp-react-redux).
  * otp-middleware stores these users and associated information (e.g., home/work locations and other favorites). Users
  * can also opt-in to storing their trip planning requests/responses.
  */
 public class OtpUser extends AbstractUser {
+    public enum Notification {
+        EMAIL, PUSH, SMS
+    }
+
     public static final String AUTH0_SCOPE = "otp-user";
     private static final long serialVersionUID = 1L;
     private static final Logger LOG = LoggerFactory.getLogger(OtpUser.class);
@@ -30,11 +37,10 @@ public class OtpUser extends AbstractUser {
     public boolean isPhoneNumberVerified;
 
     /**
-     * Notification preference for this user
-     * ("email", "sms", or "none").
-     * TODO: Convert to enum. See http://mongodb.github.io/mongo-java-driver/3.7/bson/pojos/ for guidance.
+     * Notification preferences for this user
+     * (EMAIL and/or SMS and/or PUSH).
      */
-    public String notificationChannel;
+    public EnumSet<OtpUser.Notification> notificationChannel = EnumSet.noneOf(OtpUser.Notification.class);
 
     /**
      * Verified phone number for SMS notifications, in +15551234 format (E.164 format, includes country code, no spaces).
@@ -105,4 +111,35 @@ public boolean canBeManagedBy(RequestingUser requestingUser) {
         return super.canBeManagedBy(requestingUser);
     }
 
+    /**
+     * Get notification channels as comma-separated list in one string
+     */
+    @JsonGetter(value = "notificationChannel")
+    public String getNotificationChannel() {
+        return notificationChannel.stream()
+            .map(channel -> channel.name().toLowerCase())
+            .collect(Collectors.joining(","));
+    }
+
+    /**
+     * Set notification channels based on comma-separated list in one string
+     */
+    @JsonSetter(value = "notificationChannel")
+    public void setNotificationChannel(String channels) {
+        if (channels.isEmpty() || "none".equals(channels)) {
+            notificationChannel.clear();
+        } else {
+            Stream.of(channels.split(","))
+                .filter(Objects::nonNull)
+                .map(str -> str.trim().toUpperCase())
+                .filter(str -> !str.isEmpty())
+                .forEach(channel -> {
+                    try {
+                        notificationChannel.add(Enum.valueOf(OtpUser.Notification.class, channel));
+                    } catch (Exception e) {
+                        LOG.error("Notification channel \"{}\" is not valid", channel);
+                    }
+                });
+        }
+    }
 }

src/main/java/org/opentripplanner/middleware/tripmonitor/jobs/CheckMonitoredTrip.java

@@ -403,23 +403,18 @@ private void sendNotifications() {
         );
         // FIXME: Change log level
         LOG.info("Sending notification to user {}", trip.userId);
-        boolean success = false;
-        // FIXME: This needs to be an enum.
-        switch (otpUser.notificationChannel.toLowerCase()) {
-            case "sms":
-                success = sendSMS(otpUser, templateData);
-                break;
-            case "email":
-                success = sendEmail(otpUser, templateData);
-                break;
-            case "all":
-                // TODO better handle below when one of the following fails
-                success = sendSMS(otpUser, templateData) && sendEmail(otpUser, templateData);
-                break;
-            default:
-                break;
+        boolean successEmail = false;
+        boolean successSms = false;
+
+        if (otpUser.notificationChannel.contains(OtpUser.Notification.EMAIL)) {
+            successEmail = sendEmail(otpUser, templateData);
+        }
+        if (otpUser.notificationChannel.contains(OtpUser.Notification.SMS)) {
+            successSms = sendSMS(otpUser, templateData);
         }
-        if (success) {
+
+        // TODO: better handle below when one of the following fails
+        if (successEmail || successSms) {
             notificationTimestampMillis = DateTimeUtils.currentTimeMillis();
         }
     }

src/test/java/org/opentripplanner/middleware/testutils/PersistenceTestUtils.java

@@ -41,7 +41,7 @@ public static OtpUser createUser(String email, String phoneNumber) {
         OtpUser user = new OtpUser();
         user.email = email;
         user.phoneNumber = phoneNumber;
-        user.notificationChannel = "email";
+        user.notificationChannel.add(OtpUser.Notification.EMAIL);
         user.hasConsentedToTerms = true;
         user.storeTripHistory = true;
         Persistence.otpUsers.create(user);