Provide more information to consumable resources

changes/add_cr_extra.md

@@ -0,0 +1 @@
+* Provide more information to consumable resources (the database workflow run creation time and max-in-flight-per-workflow)

vidarr-core/src/main/java/ca/on/oicr/gsi/vidarr/core/ManualOverrideConsumableResource.java

@@ -14,7 +14,9 @@
 import io.undertow.util.Headers;
 import io.undertow.util.PathTemplateMatch;
 import io.undertow.util.StatusCodes;
+import java.time.Instant;
 import java.util.Optional;
+import java.util.OptionalInt;
 import java.util.Set;
 import java.util.TreeSet;
 import java.util.function.BiPredicate;
@@ -77,10 +79,16 @@ public void release(
 
   @Override
   public ConsumableResourceResponse request(
-      String workflowName, String workflowVersion, String vidarrId, Optional<JsonNode> input) {
+      String workflowName,
+      String workflowVersion,
+      String vidarrId,
+      Instant createdTime,
+      OptionalInt workflowMaxInFlight,
+      Optional<JsonNode> input) {
     return allowList.contains(vidarrId)
         ? ConsumableResourceResponse.AVAILABLE
-        : inner.request(workflowName, workflowVersion, vidarrId, input);
+        : inner.request(
+            workflowName, workflowVersion, vidarrId, createdTime, OptionalInt.empty(), input);
   }
 
   public void setInner(ConsumableResource inner) {

vidarr-core/src/main/java/ca/on/oicr/gsi/vidarr/core/MaxInFlightConsumableResource.java

@@ -7,7 +7,9 @@
 import ca.on.oicr.gsi.vidarr.ConsumableResourceResponse;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.databind.JsonNode;
+import java.time.Instant;
 import java.util.Optional;
+import java.util.OptionalInt;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.stream.Stream;
@@ -33,18 +35,28 @@ public Optional<Pair<String, BasicType>> inputFromSubmitter() {
   }
 
   @Override
-  public void recover(String workflowName, String workflowVersion, String vidarrId, Optional<JsonNode> resourceJson) {
+  public void recover(
+      String workflowName,
+      String workflowVersion,
+      String vidarrId,
+      Optional<JsonNode> resourceJson) {
     inFlight.add(vidarrId);
   }
 
   @Override
-  public void release(String workflowName, String workflowVersion, String vidarrId, Optional<JsonNode> input) {
+  public void release(
+      String workflowName, String workflowVersion, String vidarrId, Optional<JsonNode> input) {
     inFlight.remove(vidarrId);
   }
 
   @Override
   public synchronized ConsumableResourceResponse request(
-      String workflowName, String workflowVersion, String vidarrId, Optional<JsonNode> input) {
+      String workflowName,
+      String workflowVersion,
+      String vidarrId,
+      Instant createdTime,
+      OptionalInt workflowMaxInFlight,
+      Optional<JsonNode> input) {
     if (inFlight.size() <= maximum) {
       inFlight.add(vidarrId);
       return ConsumableResourceResponse.AVAILABLE;

vidarr-pluginapi/src/main/java/ca/on/oicr/gsi/vidarr/ConsumableResource.java

@@ -11,9 +11,11 @@
 import com.fasterxml.jackson.databind.jsontype.impl.TypeIdResolverBase;
 import io.undertow.server.HttpHandler;
 import java.io.IOException;
+import java.time.Instant;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Optional;
+import java.util.OptionalInt;
 import java.util.ServiceLoader;
 import java.util.ServiceLoader.Provider;
 import java.util.stream.Collectors;
@@ -121,12 +123,20 @@ void release(
    * @param workflowName the name of the workflow
    * @param workflowVersion the version of the workflow
    * @param vidarrId the identifier of the workflow run
+   * @param createdTime the time the workflow run was created
+   * @param workflowMaxInFlight this is the max-in-flight value stored in the database for this
+   *     workflow
    * @param input the consumable resource information requested from the submitter, if applicable
    *     and provided.
    * @return whether this resource is available
    */
   ConsumableResourceResponse request(
-      String workflowName, String workflowVersion, String vidarrId, Optional<JsonNode> input);
+      String workflowName,
+      String workflowVersion,
+      String vidarrId,
+      Instant createdTime,
+      OptionalInt workflowMaxInFlight,
+      Optional<JsonNode> input);
 
   /**
    * Called to initialise this consumable resource.

vidarr-prometheus/src/main/java/ca/on/oicr/gsi/vidarr/prometheus/AlertmanagerAutoInhibitConsumableResource.java

@@ -10,8 +10,10 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.ObjectReader;
+import java.time.Instant;
 import java.util.List;
 import java.util.Optional;
+import java.util.OptionalInt;
 import java.util.Set;
 import java.util.function.Function;
 import java.util.stream.Collectors;
@@ -110,18 +112,28 @@ public Optional<Pair<String, BasicType>> inputFromSubmitter() {
   }
 
   @Override
-  public void recover(String workflowName, String workflowVersion, String vidarrId, Optional<JsonNode> resourceJson) {
+  public void recover(
+      String workflowName,
+      String workflowVersion,
+      String vidarrId,
+      Optional<JsonNode> resourceJson) {
     // Do nothing, as there's no intermediate state that needs to be tracked
   }
 
   @Override
-  public void release(String workflowName, String workflowVersion, String vidarrId, Optional<JsonNode> input) {
+  public void release(
+      String workflowName, String workflowVersion, String vidarrId, Optional<JsonNode> input) {
     // Do nothing, as this doesn't actually hold onto any resources
   }
 
   @Override
   public ConsumableResourceResponse request(
-      String workflowName, String workflowVersion, String vidarrId, Optional<JsonNode> input) {
+      String workflowName,
+      String workflowVersion,
+      String vidarrId,
+      Instant createdTime,
+      OptionalInt workflowMaxInFlight,
+      Optional<JsonNode> input) {
     String workflowVersionWithUnderscores = workflowVersion.replaceAll("\\.", "_");
     final var matchedAlertValues =
         cache

vidarr-server/src/main/java/ca/on/oicr/gsi/vidarr/server/Candidate.java

@@ -0,0 +1,5 @@
+package ca.on.oicr.gsi.vidarr.server;
+
+import java.time.Instant;
+
+record Candidate(long id, String workflowRun, Instant created) {}

vidarr-server/src/main/java/ca/on/oicr/gsi/vidarr/server/ConsumableResourceChecker.java

@@ -31,12 +31,13 @@ final class ConsumableResourceChecker implements Runnable {
           .register();
 
   private final Map<String, JsonNode> consumableResources;
+  private final Instant createdTime;
   private final HikariDataSource dataSource;
   private final long dbId;
   private final ScheduledExecutorService executor;
   private final AtomicBoolean isLive;
+  private final MaxInFlightByWorkflow maxInFlightByWorkflow;
   private final Runnable next;
-  private final Instant startTime = Instant.now();
   private final Target target;
   private final ObjectNode tracing = Main.MAPPER.createObjectNode();
   private final String vidarrId;
@@ -49,10 +50,12 @@ public ConsumableResourceChecker(
       ScheduledExecutorService executor,
       long dbId,
       AtomicBoolean isLive,
+      MaxInFlightByWorkflow maxInFlightByWorkflow,
       String workflow,
       String workflowVersion,
       String vidarrId,
       Map<String, JsonNode> consumableResources,
+      Instant createdTime,
       Runnable next) {
     this.target = target;
     this.dataSource = dataSource;
@@ -63,7 +66,9 @@ public ConsumableResourceChecker(
     this.workflowVersion = workflowVersion;
     this.vidarrId = vidarrId;
     this.consumableResources = consumableResources;
+    this.createdTime = createdTime;
     this.next = next;
+    this.maxInFlightByWorkflow = maxInFlightByWorkflow;
   }
 
   @Override
@@ -82,6 +87,8 @@ public void run() {
                   workflow,
                   workflowVersion,
                   vidarrId,
+                  createdTime,
+                  maxInFlightByWorkflow.getMaximumFor(workflow),
                   broker.inputFromSubmitter().map(def -> consumableResources.get(def.first())))
               .apply(
                   new Visitor<Optional<String>>() {
@@ -133,7 +140,7 @@ public Optional<String> unavailable() {
         return;
       }
     }
-    final var waiting = Duration.between(startTime, Instant.now()).toSeconds();
+    final var waiting = Duration.between(createdTime, Instant.now()).toSeconds();
     tracing.put("vidarr-waiting", waiting);
     updateBlockedResource(null);
     waitTime.labels(workflow).observe(waiting);