feat(deployment): notify users when deployment to OTP finishes or fails

refs catalogueglobal/datatools-ui#18

Author: landonreed

src/main/java/com/conveyal/datatools/common/status/MonitorableJob.java

@@ -6,6 +6,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.io.Serializable;
 import java.time.LocalDateTime;
 import java.time.format.DateTimeFormatter;
 import java.util.*;
@@ -14,8 +15,8 @@
 /**
  * Created by landon on 6/13/16.
  */
-public abstract class MonitorableJob implements Runnable {
-
+public abstract class MonitorableJob implements Runnable, Serializable {
+    private static final long serialVersionUID = 1L;
     private static final Logger LOG = LoggerFactory.getLogger(MonitorableJob.class);
     protected final String owner;
 
@@ -204,8 +205,8 @@ public void addNextJob(MonitorableJob ...jobs) {
     /**
      * Represents the current status of this job.
      */
-    public static class Status implements Cloneable {
-
+    public static class Status implements Serializable {
+        private static final long serialVersionUID = 1L;
         /** What message (defined in messages.<lang>) should be displayed to the user? */
         public String message;
 

src/main/java/com/conveyal/datatools/manager/jobs/DeployJob.java

@@ -12,6 +12,7 @@
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.Serializable;
 import java.net.HttpURLConnection;
 import java.net.MalformedURLException;
 import java.net.URL;
@@ -24,6 +25,7 @@
 import com.conveyal.datatools.common.status.MonitorableJob;
 import com.conveyal.datatools.manager.models.Deployment;
 import com.conveyal.datatools.manager.persistence.FeedStore;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -58,6 +60,11 @@ public class DeployJob extends MonitorableJob {
     /** This hides the status field on the parent class, providing additional fields. */
     public DeployStatus status;
 
+    @JsonProperty
+    public String getDeploymentId () {
+        return deployment.id;
+    }
+
     public DeployJob(Deployment deployment, String owner, List<String> targets, String publicUrl, String s3Bucket, String s3CredentialsFilename) {
         // TODO add new job type or get rid of enum in favor of just using class names
         super(owner, "Deploying " + deployment.name, JobType.DEPLOY_TO_OTP);
@@ -92,7 +99,7 @@ public void jobLogic () {
 
         LOG.info("Created deployment bundle file: " + deploymentTempFile.getAbsolutePath());
 
-        // dump the deployment bundle
+        // Dump the deployment bundle to the temp file.
         try {
             status.message = "Creating OTP Bundle";
             this.deployment.dump(deploymentTempFile, true, true, true);
@@ -106,10 +113,10 @@ public void jobLogic () {
         }
 
         status.percentComplete = 100.0 * (double) tasksCompleted / totalTasks;
-        System.out.println("pctComplete = " + status.percentComplete);
+        LOG.info("Deployment pctComplete = {}", status.percentComplete);
         status.built = true;
 
-        // upload to S3, if applicable
+        // Upload to S3, if applicable
         if(this.s3Bucket != null) {
             status.message = "Uploading to S3";
             status.uploadingS3 = true;
@@ -147,7 +154,7 @@ public void jobLogic () {
             status.uploadingS3 = false;
         }
 
-        // if no OTP targets (i.e. we're only deploying to S3), we're done
+        // If there are no OTP targets (i.e. we're only deploying to S3), we're done.
         if(this.targets == null) {
             status.completed = true;
             return;
@@ -156,7 +163,7 @@ public void jobLogic () {
         // figure out what router we're using
         String router = deployment.routerId != null ? deployment.routerId : "default";
 
-        // load it to OTP
+        // Send the deployment file over the wire to each OTP server.
         for (String rawUrl : this.targets) {
             status.message = "Deploying to " + rawUrl;
             status.uploading = true;
@@ -253,6 +260,7 @@ public void jobLogic () {
                 input.close();
             } catch (IOException e) {
                 // do nothing
+                LOG.warn("Could not close input stream for deployment file.");
             }
 
             status.uploading = false;
@@ -301,32 +309,26 @@ public void jobFinished () {
         if (!deleted) {
             LOG.error("Deployment {} not deleted! Disk space in danger of filling up.", deployment.id);
         }
-
+        String message;
         if (!status.error) {
             // Update status with successful completion state only if no error was encountered.
             status.update(false, "Deployment complete!", 100, true);
+            message = String.format("Deployment %s successfully deployed to %s", deployment.name, publicUrl);
+        } else {
+            message = String.format("WARNING: Deployment %s failed to deploy to %s", deployment.name, publicUrl);
         }
+        // Send notification to those subscribed to updates for the deployment.
+        NotifyUsersForSubscriptionJob.createNotification("deployment-updated", deployment.id, message);
     }
 
     /**
      * Represents the current status of this job.
      */
     public static class DeployStatus extends Status {
-//        /** What error message (defined in messages.<lang>) should be displayed to the user? */
-//        public String message;
-//
-//        /** Is this deployment completed (successfully or unsuccessfully) */
-//        public boolean completed;
-
-//        /** Was there an error? */
-//        public boolean error;
-
+        private static final long serialVersionUID = 1L;
         /** Did the manager build the bundle successfully */
         public boolean built;
 
-//        /** Is the bundle currently being uploaded to the server? */
-//        public boolean uploading;
-
         /** Is the bundle currently being uploaded to an S3 bucket? */
         public boolean uploadingS3;
 

src/main/java/com/conveyal/datatools/manager/jobs/NotifyUsersForSubscriptionJob.java

@@ -1,6 +1,7 @@
 package com.conveyal.datatools.manager.jobs;
 
 import com.conveyal.datatools.manager.DataManager;
+import com.conveyal.datatools.manager.models.Deployment;
 import com.conveyal.datatools.manager.models.FeedSource;
 import com.conveyal.datatools.manager.models.Project;
 import com.conveyal.datatools.manager.persistence.Persistence;
@@ -106,6 +107,21 @@ private void notifyUsersForSubscription() {
                             // Add action text.
                             html += String.format("<p>View <a href='%s/project/%s'>this project</a>.</p>", APPLICATION_URL, p.id);
                             break;
+                        case "deployment":
+                            Deployment deployment = Persistence.deployments.getById(this.target);
+                            // Format subject header
+                            subject = String.format(
+                                    "%s Notification: %s (%s)",
+                                    applicationName,
+                                    subscriptionToString,
+                                    deployment.name);
+                            // Add action text.
+                            html += String.format(
+                                    "<p>View <a href='%s/project/%s/deployments/%s'>this deployment</a>.</p>",
+                                    APPLICATION_URL,
+                                    deployment.projectId,
+                                    deployment.id);
+                            break;
                         default:
                             LOG.warn("Notifications not supported for subscription type {}", subType[0]);
                             return;