Request Priority API

SingularityBase/src/main/java/com/hubspot/singularity/SingularityAction.java

@@ -3,6 +3,7 @@
 public enum SingularityAction {
   BOUNCE_REQUEST(true),
   SCALE_REQUEST(true),
+  PRIORITIZE_REQUEST(true),
   REMOVE_REQUEST(true),
   CREATE_REQUEST(true),
   UPDATE_REQUEST(true),

SingularityBase/src/main/java/com/hubspot/singularity/SingularityRequestHistory.java

@@ -31,7 +31,9 @@ public enum RequestHistoryType {
     DEPLOYED_TO_UNPAUSE,
     BOUNCED,
     SCALED,
-    SCALE_REVERTED
+    SCALE_REVERTED,
+    PRIORITIZED,
+    PRIORITY_REVERTED
   }
 
   @JsonCreator

SingularityBase/src/main/java/com/hubspot/singularity/SingularityUserFacingAction.java

@@ -5,6 +5,7 @@ public enum SingularityUserFacingAction {
   BOUNCE,
   PAUSE,
   SCALE,
+  PRIORITIZE,
   KILL_TASK,
   DELETE_SCHEDULED_TASK,
   RUN_SHELL_COMMAND

SingularityBase/src/main/java/com/hubspot/singularity/api/SingularityExpiringRequestParent.java

@@ -11,6 +11,7 @@
     SingularityMachineChangeRequest.class,
     SingularityExpiringParent.class,
     SingularityScaleRequest.class,
+    SingularityPriorityRequest.class,
     SingularityBounceRequest.class,
     SingularityExpiringSkipHealthchecks.class
   }

SingularityBase/src/main/java/com/hubspot/singularity/api/SingularityPriorityRequest.java

@@ -0,0 +1,27 @@
+package com.hubspot.singularity.api;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.hubspot.singularity.SingularityRequest;
+import io.swagger.v3.oas.annotations.media.Schema;
+import java.util.Optional;
+
+@Schema(description = "Describes the new priority (0 to 1) for a request")
+public class SingularityPriorityRequest extends SingularityExpiringRequestParent {
+  /** see {@link SingularityRequest#getTaskPriorityLevel()} */
+  private final Optional<Double> priority;
+
+  public SingularityPriorityRequest(
+    @JsonProperty("durationMillis") Optional<Long> durationMillis,
+    @JsonProperty("actionId") Optional<String> actionId,
+    @JsonProperty("message") Optional<String> message,
+    @JsonProperty("priority") Optional<Double> priority,
+    @JsonProperty("skipEmailNotification") Optional<Boolean> skipEmailNotification
+  ) {
+    super(durationMillis, actionId, message);
+    this.priority = priority;
+  }
+
+  public Optional<Double> getPriority() {
+    return priority;
+  }
+}

SingularityBase/src/main/java/com/hubspot/singularity/expiring/SingularityExpiringPriority.java

@@ -0,0 +1,38 @@
+package com.hubspot.singularity.expiring;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.hubspot.singularity.api.SingularityPriorityRequest;
+import com.hubspot.singularity.api.SingularityScaleRequest;
+import io.swagger.v3.oas.annotations.media.Schema;
+import java.util.Optional;
+
+@Schema(description = "Details about a scale action that will eventually revert")
+public class SingularityExpiringPriority
+  extends SingularityExpiringRequestActionParent<SingularityPriorityRequest> {
+  private final Optional<Double> revertToPriority;
+
+  public SingularityExpiringPriority(
+    @JsonProperty("requestId") String requestId,
+    @JsonProperty("user") Optional<String> user,
+    @JsonProperty("startMillis") long startMillis,
+    @JsonProperty("expiringAPIRequestObject") SingularityPriorityRequest request,
+    @JsonProperty("revertToPriority") Optional<Double> revertToPriority,
+    @JsonProperty("actionId") String actionId
+  ) {
+    super(request, user, startMillis, actionId, requestId);
+    this.revertToPriority = revertToPriority;
+  }
+
+  @Schema(
+    description = "The scheduling priority to update to when time has elapsed",
+    nullable = true
+  )
+  public Optional<Double> getRevertToPriority() {
+    return revertToPriority;
+  }
+
+  @Override
+  public String toString() {
+    return "SingularityExpiringPriority{" + "revertToPriority=" + revertToPriority + '}';
+  }
+}

SingularityService/src/main/java/com/hubspot/singularity/data/RequestManager.java

@@ -29,6 +29,7 @@
 import com.hubspot.singularity.event.SingularityEventListener;
 import com.hubspot.singularity.expiring.SingularityExpiringBounce;
 import com.hubspot.singularity.expiring.SingularityExpiringPause;
+import com.hubspot.singularity.expiring.SingularityExpiringPriority;
 import com.hubspot.singularity.expiring.SingularityExpiringRequestActionParent;
 import com.hubspot.singularity.expiring.SingularityExpiringScale;
 import com.hubspot.singularity.expiring.SingularityExpiringSkipHealthchecks;
@@ -79,6 +80,8 @@ public class RequestManager extends CuratorAsyncManager {
     EXPIRING_ACTION_PATH_ROOT + "/pause";
   private static final String EXPIRING_SCALE_PATH_ROOT =
     EXPIRING_ACTION_PATH_ROOT + "/scale";
+  private static final String EXPIRING_PRIORITY_PATH_ROOT =
+    EXPIRING_ACTION_PATH_ROOT + "/priority";
   private static final String EXPIRING_SKIP_HC_PATH_ROOT =
     EXPIRING_ACTION_PATH_ROOT + "/skipHc";
 
@@ -90,7 +93,9 @@ public class RequestManager extends CuratorAsyncManager {
     SingularityExpiringScale.class,
     EXPIRING_SCALE_PATH_ROOT,
     SingularityExpiringSkipHealthchecks.class,
-    EXPIRING_SKIP_HC_PATH_ROOT
+    EXPIRING_SKIP_HC_PATH_ROOT,
+    SingularityExpiringPriority.class,
+    EXPIRING_PRIORITY_PATH_ROOT
   );
 
   private final Map<Class<? extends SingularityExpiringRequestActionParent<? extends SingularityExpiringRequestParent>>, Transcoder<? extends SingularityExpiringRequestActionParent<? extends SingularityExpiringRequestParent>>> expiringTranscoderMap;

SingularityService/src/main/java/com/hubspot/singularity/resources/RequestResource.java

@@ -46,6 +46,7 @@
 import com.hubspot.singularity.api.SingularityDeleteRequestRequest;
 import com.hubspot.singularity.api.SingularityExitCooldownRequest;
 import com.hubspot.singularity.api.SingularityPauseRequest;
+import com.hubspot.singularity.api.SingularityPriorityRequest;
 import com.hubspot.singularity.api.SingularityRunNowRequest;
 import com.hubspot.singularity.api.SingularityScaleRequest;
 import com.hubspot.singularity.api.SingularitySkipHealthchecksRequest;
@@ -61,6 +62,7 @@
 import com.hubspot.singularity.data.TaskManager;
 import com.hubspot.singularity.expiring.SingularityExpiringBounce;
 import com.hubspot.singularity.expiring.SingularityExpiringPause;
+import com.hubspot.singularity.expiring.SingularityExpiringPriority;
 import com.hubspot.singularity.expiring.SingularityExpiringRequestActionParent;
 import com.hubspot.singularity.expiring.SingularityExpiringScale;
 import com.hubspot.singularity.expiring.SingularityExpiringSkipHealthchecks;
@@ -1648,6 +1650,97 @@ public SingularityRequest deleteRequest(
     return request;
   }
 
+  @PUT
+  @Path("/request/{requestId}/priority")
+  @Consumes({ MediaType.APPLICATION_JSON })
+  @Operation(
+    summary = "Set the task scheduling priority for the request",
+    responses = {
+      @ApiResponse(responseCode = "404", description = "No Request with that ID")
+    }
+  )
+  public SingularityRequestParent setPriority(
+    @Parameter(hidden = true) @Auth SingularityUser user,
+    @Parameter(
+      required = true,
+      description = "The Request ID to modify priority for"
+    ) @PathParam("requestId") String requestId,
+    @Context HttpServletRequest requestContext,
+    @RequestBody(
+      description = "Request priority (0.0 to 1.0)"
+    ) SingularityPriorityRequest priorityRequest
+  ) {
+    return maybeProxyToLeader(
+      requestContext,
+      SingularityRequestParent.class,
+      priorityRequest,
+      () -> setPriority(requestId, priorityRequest, user)
+    );
+  }
+
+  public SingularityRequestParent setPriority(
+    String requestId,
+    SingularityPriorityRequest priorityRequest,
+    SingularityUser user
+  ) {
+    SingularityRequestWithState oldRequestWithState = fetchRequestWithState(
+      requestId,
+      user
+    );
+
+    SingularityRequest oldRequest = oldRequestWithState.getRequest();
+    authorizationHelper.checkForAuthorization(
+      oldRequest,
+      user,
+      SingularityAuthorizationScope.WRITE,
+      SingularityUserFacingAction.PRIORITIZE
+    );
+    validator.checkActionEnabled(SingularityAction.PRIORITIZE_REQUEST);
+
+    SingularityRequest newRequest = oldRequest
+      .toBuilder()
+      .setTaskPriorityLevel(priorityRequest.getPriority())
+      .build();
+    String message = String.format(
+      "Scaling from %d -> %d",
+      oldRequest.getTaskPriorityLevel(),
+      newRequest.getTaskPriorityLevel()
+    );
+    if (priorityRequest.getMessage().isPresent()) {
+      message = String.format("%s -- %s", priorityRequest.getMessage().get(), message);
+    } else {
+      message = String.format("%s", message);
+    }
+
+    submitRequest(
+      newRequest,
+      Optional.of(oldRequestWithState),
+      Optional.of(RequestHistoryType.PRIORITIZED),
+      Optional.of(false),
+      Optional.of(message),
+      Optional.empty(),
+      user
+    );
+
+    if (priorityRequest.getDurationMillis().isPresent()) {
+      requestManager.saveExpiringObject(
+        new SingularityExpiringPriority(
+          requestId,
+          user.getEmail(),
+          System.currentTimeMillis(),
+          priorityRequest,
+          oldRequest.getTaskPriorityLevel(),
+          priorityRequest.getActionId().orElse(UUID.randomUUID().toString())
+        )
+      );
+    } else {
+      requestManager.deleteExpiringObject(SingularityExpiringPriority.class, requestId);
+    }
+
+    // TODO - email
+    return fillEntireRequest(fetchRequestWithState(requestId, user));
+  }
+
   @PUT
   @Path("/request/{requestId}/scale")
   @Consumes({ MediaType.APPLICATION_JSON })

SingularityService/src/main/java/com/hubspot/singularity/scheduler/SingularityExpiringUserActionPoller.java

@@ -33,6 +33,7 @@
 import com.hubspot.singularity.expiring.SingularityExpiringMachineState;
 import com.hubspot.singularity.expiring.SingularityExpiringParent;
 import com.hubspot.singularity.expiring.SingularityExpiringPause;
+import com.hubspot.singularity.expiring.SingularityExpiringPriority;
 import com.hubspot.singularity.expiring.SingularityExpiringRequestActionParent;
 import com.hubspot.singularity.expiring.SingularityExpiringScale;
 import com.hubspot.singularity.expiring.SingularityExpiringSkipHealthchecks;
@@ -95,6 +96,7 @@ public class SingularityExpiringUserActionPoller extends SingularityLeaderOnlyPo
         new SingularityExpiringBounceHandler(),
         new SingularityExpiringPauseHandler(),
         new SingularityExpiringScaleHandler(),
+        new SingularityExpiringPriorityHandler(),
         new SingularityExpiringSkipHealthchecksHandler(),
         new SingularityExpiringSlaveStateHandler(),
         new SingularityExpiringRackStateHandler()
@@ -207,6 +209,53 @@ protected void checkExpiringObjects() {
     }
   }
 
+  private class SingularityExpiringPriorityHandler
+    extends SingularityExpiringRequestActionHandler<SingularityExpiringPriority> {
+
+    private SingularityExpiringPriorityHandler() {
+      super(SingularityExpiringPriority.class);
+    }
+
+    @Override
+    protected String getActionName() {
+      return "Priority";
+    }
+
+    @Override
+    protected void handleExpiringObject(
+      SingularityExpiringPriority expiringObject,
+      SingularityRequestWithState requestWithState,
+      String message
+    ) {
+      final SingularityRequest oldRequest = requestWithState.getRequest();
+      final SingularityRequest newRequest = oldRequest
+        .toBuilder()
+        .setTaskPriorityLevel(expiringObject.getRevertToPriority())
+        .build();
+
+      try {
+        requestHelper.updateRequest(
+          newRequest,
+          Optional.of(oldRequest),
+          requestWithState.getState(),
+          Optional.of(RequestHistoryType.PRIORITY_REVERTED),
+          expiringObject.getUser(),
+          Optional.empty(),
+          Optional.of(message),
+          Optional.empty()
+        );
+        // TODO - email
+      } catch (WebApplicationException wae) {
+        LOG.error(
+          "While trying to apply {} for {}",
+          expiringObject,
+          expiringObject.getRequestId(),
+          wae
+        );
+      }
+    }
+  }
+
   private class SingularityExpiringBounceHandler
     extends SingularityExpiringRequestActionHandler<SingularityExpiringBounce> {