Programming exercises: Send the correction round to the client

The assessment endpoints for text, file upload and programming answer
with DTOs, and those never carried a correction round because the round
used to be the position of the result in the submission's list. Now
that the client matches on the round itself, it found no result for the
round it asked for and the assessment editor stayed empty, which broke
assessing an exam submission for those three types. Modeling was not
affected because it answers with the entity.

Also add a test for the serialized form: the DTOs omit empty values,
and a zero being treated as empty would drop the first correction round
while leaving the second one working.

Author: krusche

src/main/java/de/tum/cit/aet/artemis/assessment/dto/ResultDTO.java

@@ -22,8 +22,8 @@
  */
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public record ResultDTO(Long id, ZonedDateTime completionDate, Boolean successful, Double score, Boolean rated, SubmissionDTO submission, ParticipationDTO participation,
-        List<FeedbackDTO> feedbacks, AssessmentType assessmentType, Boolean hasComplaint, Boolean exampleResult, UserNameDTO assessor, AssessmentNoteDTO assessmentNote)
-        implements Serializable {
+        List<FeedbackDTO> feedbacks, AssessmentType assessmentType, Integer correctionRound, Boolean hasComplaint, Boolean exampleResult, UserNameDTO assessor,
+        AssessmentNoteDTO assessmentNote) implements Serializable {
 
     /**
      * Converts a Result into a ResultDTO.
@@ -53,6 +53,6 @@ public static ResultDTO of(Result result) {
         }
         AssessmentNoteDTO assessmentNoteDTO = AssessmentNoteDTO.of(result.getAssessmentNote());
         return new ResultDTO(result.getId(), result.getCompletionDate(), result.isSuccessful(), result.getScore(), result.isRated(), submissionDTO, participationDTO, feedbackDTOs,
-                result.getAssessmentType(), result.hasComplaint(), result.isExampleResult(), assessorDTO, assessmentNoteDTO);
+                result.getAssessmentType(), result.getCorrectionRound(), result.hasComplaint(), result.isExampleResult(), assessorDTO, assessmentNoteDTO);
     }
 }

src/main/java/de/tum/cit/aet/artemis/exercise/service/ParticipationFilterService.java

@@ -3,7 +3,7 @@
 import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE;
 
 import java.util.Comparator;
-import java.util.HashSet;
+import java.util.LinkedHashSet;
 import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Collectors;
@@ -95,7 +95,7 @@ public void filterParticipationForCourseDashboard(StudentParticipation participa
                     latestResult.filterSensitiveInformation();
                 }
             }
-            submission.setResults(new HashSet<>(results));
+            submission.setResults(new LinkedHashSet<>(results));
         }
         else {
             // A quiz that has not ended yet intentionally exposes neither its submission's answers nor its result (see
@@ -130,7 +130,7 @@ private Optional<Submission> getSanitizedSubmittedQuizSubmission(StudentParticip
                     sanitizedSubmission.setId(submission.getId());
                     sanitizedSubmission.setSubmitted(true);
                     sanitizedSubmission.setSubmissionDate(submission.getSubmissionDate());
-                    sanitizedSubmission.setResults(new HashSet<>());
+                    sanitizedSubmission.setResults(new LinkedHashSet<>());
                     return sanitizedSubmission;
                 });
     }

src/main/java/de/tum/cit/aet/artemis/fileupload/dto/FileUploadResultDTO.java

@@ -19,23 +19,25 @@
 /**
  * DTO representing a result / assessment of a file upload submission.
  *
- * @param id             the ID of the result
- * @param completionDate the date and time when the assessment was completed
- * @param successful     whether the result is considered successful
- * @param score          the score achieved (in percent or points depending on context)
- * @param rated          whether the result is rated (counts for the final score)
- * @param assessmentType the type of assessment (e.g. MANUAL, AUTOMATIC)
- * @param hasComplaint   whether a complaint has been filed for this result
- * @param exampleResult  whether this result belongs to an example submission
- * @param assessmentNote the assessment note associated with the result
- * @param assessor       the tutor/instructor who assessed the submission
- * @param feedbacks      the feedbacks generated for this result
- * @param submission     the submission context if requested
+ * @param id              the ID of the result
+ * @param completionDate  the date and time when the assessment was completed
+ * @param successful      whether the result is considered successful
+ * @param score           the score achieved (in percent or points depending on context)
+ * @param rated           whether the result is rated (counts for the final score)
+ * @param assessmentType  the type of assessment (e.g. MANUAL, AUTOMATIC)
+ * @param hasComplaint    whether a complaint has been filed for this result
+ * @param exampleResult   whether this result belongs to an example submission
+ * @param correctionRound which correction round the result belongs to
+ * @param assessmentNote  the assessment note associated with the result
+ * @param assessor        the tutor/instructor who assessed the submission
+ * @param feedbacks       the feedbacks generated for this result
+ * @param submission      the submission context if requested
  */
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public record FileUploadResultDTO(Long id, @Nullable ZonedDateTime completionDate, @Nullable Boolean successful, @Nullable Double score, boolean rated,
-        @Nullable AssessmentType assessmentType, @Nullable Boolean hasComplaint, @Nullable Boolean exampleResult, @Nullable FileUploadAssessmentNoteDTO assessmentNote,
-        @Nullable FileUploadUserDTO assessor, @Nullable List<FileUploadFeedbackDTO> feedbacks, @Nullable FileUploadSubmissionDTO submission) {
+        @Nullable AssessmentType assessmentType, @Nullable Integer correctionRound, @Nullable Boolean hasComplaint, @Nullable Boolean exampleResult,
+        @Nullable FileUploadAssessmentNoteDTO assessmentNote, @Nullable FileUploadUserDTO assessor, @Nullable List<FileUploadFeedbackDTO> feedbacks,
+        @Nullable FileUploadSubmissionDTO submission) {
 
     /**
      * Factory method to map a {@link Result} entity to a nested {@link FileUploadResultDTO} (without including submission loop).
@@ -86,6 +88,6 @@ public record FileUploadResultDTO(Long id, @Nullable ZonedDateTime completionDat
         }
 
         return new FileUploadResultDTO(result.getId(), result.getCompletionDate(), result.isSuccessful(), result.getScore(), result.isRated(), result.getAssessmentType(),
-                result.hasComplaint(), result.isExampleResult(), assessmentNoteDTO, assessorDTO, feedbackDTOs, submissionDTO);
+                result.getCorrectionRound(), result.hasComplaint(), result.isExampleResult(), assessmentNoteDTO, assessorDTO, feedbackDTOs, submissionDTO);
     }
 }

src/main/java/de/tum/cit/aet/artemis/programming/dto/ResultDTO.java

@@ -26,8 +26,8 @@
 // this would also simplify the logic in result.component.ts and and result.service.ts and make the experience more consistent among different clients (webapp, ios, android)
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public record ResultDTO(Long id, ZonedDateTime completionDate, Boolean successful, Double score, Boolean rated, SubmissionDTO submission, ParticipationDTO participation,
-        List<FeedbackDTO> feedbacks, AssessmentType assessmentType, Boolean hasComplaint, Boolean exampleResult, Integer testCaseCount, Integer passedTestCaseCount,
-        Integer codeIssueCount) implements Serializable {
+        List<FeedbackDTO> feedbacks, AssessmentType assessmentType, Integer correctionRound, Boolean hasComplaint, Boolean exampleResult, Integer testCaseCount,
+        Integer passedTestCaseCount, Integer codeIssueCount) implements Serializable {
 
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public record FeedbackDTO(Long id, String text, String detailText, boolean hasLongFeedbackText, String reference, Double credits, Boolean positive, FeedbackType type,
@@ -68,7 +68,7 @@ public static ResultDTO of(Result result, Collection<Feedback> filteredFeedback)
         }
         var feedbackDTOs = filteredFeedback.stream().map(FeedbackDTO::of).toList();
         return new ResultDTO(result.getId(), result.getCompletionDate(), result.isSuccessful(), result.getScore(), result.isRated(), submissionDTO,
-                ParticipationDTO.of(result.getSubmission().getParticipation()), feedbackDTOs, result.getAssessmentType(), result.hasComplaint(), result.isExampleResult(),
-                result.getTestCaseCount(), result.getPassedTestCaseCount(), result.getCodeIssueCount());
+                ParticipationDTO.of(result.getSubmission().getParticipation()), feedbackDTOs, result.getAssessmentType(), result.getCorrectionRound(), result.hasComplaint(),
+                result.isExampleResult(), result.getTestCaseCount(), result.getPassedTestCaseCount(), result.getCodeIssueCount());
     }
 }

src/test/java/de/tum/cit/aet/artemis/assessment/ResultDTOSerializationTest.java

@@ -0,0 +1,48 @@
+package de.tum.cit.aet.artemis.assessment;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.time.ZonedDateTime;
+
+import org.junit.jupiter.api.Test;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+
+import de.tum.cit.aet.artemis.assessment.domain.AssessmentType;
+import de.tum.cit.aet.artemis.assessment.domain.Result;
+import de.tum.cit.aet.artemis.assessment.dto.ResultDTO;
+
+class ResultDTOSerializationTest {
+
+    private final ObjectMapper objectMapper = new ObjectMapper().registerModule(new JavaTimeModule());
+
+    /**
+     * The client matches a result to a correction round by this field, so it has to survive serialization. Round 0 is
+     * the interesting case: the DTOs carry {@code @JsonInclude(NON_EMPTY)}, and a zero being treated as empty would
+     * silently drop the first correction round.
+     */
+    @Test
+    void shouldSerializeCorrectionRoundZero() throws Exception {
+        Result result = new Result();
+        result.setId(1L);
+        result.setAssessmentType(AssessmentType.MANUAL);
+        result.setCompletionDate(ZonedDateTime.now());
+        result.setCorrectionRound(0);
+
+        String json = objectMapper.writeValueAsString(ResultDTO.of(result));
+
+        assertThat(json).contains("\"correctionRound\":0");
+    }
+
+    @Test
+    void shouldOmitCorrectionRoundWhenAbsent() throws Exception {
+        Result result = new Result();
+        result.setId(1L);
+        result.setAssessmentType(AssessmentType.AUTOMATIC);
+
+        String json = objectMapper.writeValueAsString(ResultDTO.of(result));
+
+        assertThat(json).doesNotContain("correctionRound");
+    }
+}