Return Constraint Results in Run Order

While the constraints are run according to their priority, because the results did not have that guarantee, causing flakiness in E2ETests

Author: Mythicaeda

merlin-server/src/main/java/gov/nasa/jpl/aerie/merlin/server/http/ResponseSerializers.java

@@ -35,6 +35,7 @@
 import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
+import java.util.SortedMap;
 import java.util.function.Function;
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
@@ -287,7 +288,7 @@ public static JsonValue serializeResourceSamples(final Map<String, List<Pair<Dur
         .build();
   }
 
-  public static JsonValue serializeConstraintResults(final int requestId, final Map<ConstraintRecord, Fallible<ConstraintResult, List<? extends Exception>>> resultMap) {
+  public static JsonValue serializeConstraintResults(final int requestId, final SortedMap<ConstraintRecord, Fallible<ConstraintResult, List<? extends Exception>>> resultMap) {
     var results = resultMap.entrySet().stream().map(entry -> {
 
       final var constraint = entry.getKey();
@@ -323,7 +324,7 @@ public static JsonValue serializeConstraintResults(final int requestId, final Ma
       }
 
       // successful runs
-      var constraintResult = (ConstraintResult) fallible.getOptional().get();
+      var constraintResult = fallible.getOptional().get();
       return Json.createObjectBuilder()
                  .add("success", JsonValue.TRUE)
                  .add("constraintId", constraint.constraintId())

merlin-server/src/main/java/gov/nasa/jpl/aerie/merlin/server/models/ConstraintRecord.java

@@ -23,4 +23,10 @@ public record ConstraintRecord(
     String description,
     ConstraintType type,
     Map<String, SerializedValue> arguments
-) {}
+) implements Comparable<ConstraintRecord> {
+
+  @Override
+  public int compareTo(final ConstraintRecord o) {
+    return Long.compare(this.priority, o.priority);
+  }
+}

merlin-server/src/main/java/gov/nasa/jpl/aerie/merlin/server/services/ConstraintAction.java

@@ -89,7 +89,7 @@ public List<BulkConstraintEffectiveArgumentResponse> getConstraintProcedureEffec
    * @throws MissionModelService.NoSuchMissionModelException If the plan's mission model does not exist.
    * @throws SimulationDatasetMismatchException If the specified simulation is not a simulation of the specified plan.
    */
-  public Pair<Integer, Map<ConstraintRecord, Fallible<ConstraintResult, List<? extends Exception>>>> getViolations(
+  public Pair<Integer, SortedMap<ConstraintRecord, Fallible<ConstraintResult, List<? extends Exception>>>> getViolations(
       final PlanId planId,
       final Optional<SimulationDatasetId> simulationDatasetId,
       final boolean force,
@@ -117,7 +117,7 @@ public Pair<Integer, Map<ConstraintRecord, Fallible<ConstraintResult, List<? ext
     final SimulationDatasetId simDatasetId = resultsHandle.getSimulationDatasetId();
 
     final var constraints = new ArrayList<>(this.planService.getConstraintsForPlan(planId));
-    final var constraintResultMap = new HashMap<ConstraintRecord, Fallible<ConstraintResult, List<? extends Exception>>>();
+    final var constraintResultMap = new TreeMap<ConstraintRecord, Fallible<ConstraintResult, List<? extends Exception>>>();
 
     // Load cached results if the force rerun flag is not set
     final var validConstraintRuns = force ? new HashMap<ConstraintRecord, ConstraintResult>() :