Integrated code lifecycle: Save and update build job to database at the start of the process

src/main/java/de/tum/cit/aet/artemis/buildagent/dto/BuildJobsStatisticsDTO.java

@@ -4,10 +4,8 @@
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 
-import de.tum.cit.aet.artemis.programming.domain.build.BuildStatus;
-
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
-public record BuildJobsStatisticsDTO(long totalBuilds, long successfulBuilds, long failedBuilds, long cancelledBuilds) {
+public record BuildJobsStatisticsDTO(long totalBuilds, long successfulBuilds, long failedBuilds, long cancelledBuilds, long timeOutBuilds, long missingBuilds) {
 
     /**
      * Create a BuildJobsStatisticsDTO from a list of BuildJobResultCountDTOs.
@@ -20,19 +18,21 @@ public static BuildJobsStatisticsDTO of(List<BuildJobResultCountDTO> resultCount
         long successfulBuilds = 0;
         long failedBuilds = 0;
         long cancelledBuilds = 0;
-        // Switch case would cause an error in the testDTOImplementations test
+        long timeOutBuilds = 0;
+        long missingBuilds = 0;
+        long otherBuilds = 0;
+
         for (BuildJobResultCountDTO resultCountDTO : resultCountDTOList) {
-            if (resultCountDTO.status() == BuildStatus.SUCCESSFUL) {
-                successfulBuilds += resultCountDTO.count();
-            }
-            else if (resultCountDTO.status() == BuildStatus.FAILED || resultCountDTO.status() == BuildStatus.ERROR) {
-                failedBuilds += resultCountDTO.count();
-            }
-            else if (resultCountDTO.status() == BuildStatus.CANCELLED) {
-                cancelledBuilds += resultCountDTO.count();
+            switch (resultCountDTO.status()) {
+                case SUCCESSFUL -> successfulBuilds += resultCountDTO.count();
+                case FAILED, ERROR -> failedBuilds += resultCountDTO.count();
+                case CANCELLED -> cancelledBuilds += resultCountDTO.count();
+                case TIMEOUT -> timeOutBuilds += resultCountDTO.count();
+                case MISSING -> missingBuilds += resultCountDTO.count();
+                default -> otherBuilds += resultCountDTO.count();
             }
         }
-        totalBuilds = successfulBuilds + failedBuilds + cancelledBuilds;
-        return new BuildJobsStatisticsDTO(totalBuilds, successfulBuilds, failedBuilds, cancelledBuilds);
+        totalBuilds = successfulBuilds + failedBuilds + cancelledBuilds + timeOutBuilds + missingBuilds + otherBuilds;
+        return new BuildJobsStatisticsDTO(totalBuilds, successfulBuilds, failedBuilds, cancelledBuilds, timeOutBuilds, missingBuilds);
     }
 }

src/main/java/de/tum/cit/aet/artemis/buildagent/dto/FinishedBuildJobDTO.java

@@ -19,8 +19,8 @@
  */
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
 public record FinishedBuildJobDTO(String id, String name, String buildAgentAddress, long participationId, long courseId, long exerciseId, BuildStatus status,
-        RepositoryType repositoryType, String repositoryName, RepositoryType triggeredByPushTo, ZonedDateTime buildStartDate, ZonedDateTime buildCompletionDate, String commitHash,
-        ResultDTO submissionResult) {
+        RepositoryType repositoryType, String repositoryName, RepositoryType triggeredByPushTo, ZonedDateTime buildSubmissionDate, ZonedDateTime buildStartDate,
+        ZonedDateTime buildCompletionDate, String commitHash, ResultDTO submissionResult) {
 
     /**
      * A DTO representing a result
@@ -65,6 +65,6 @@ public static FinishedBuildJobDTO of(BuildJob buildJob) {
 
         return new FinishedBuildJobDTO(buildJob.getBuildJobId(), buildJob.getName(), buildJob.getBuildAgentAddress(), buildJob.getParticipationId(), buildJob.getCourseId(),
                 buildJob.getExerciseId(), buildJob.getBuildStatus(), buildJob.getRepositoryType(), buildJob.getRepositoryName(), buildJob.getTriggeredByPushTo(),
-                buildJob.getBuildStartDate(), buildJob.getBuildCompletionDate(), buildJob.getCommitHash(), resultDTO);
+                buildJob.getBuildSubmissionDate(), buildJob.getBuildStartDate(), buildJob.getBuildCompletionDate(), buildJob.getCommitHash(), resultDTO);
     }
 }

src/main/java/de/tum/cit/aet/artemis/buildagent/service/BuildJobManagementService.java

@@ -177,10 +177,17 @@ public CompletableFuture<BuildResult> executeBuildJob(BuildJobQueueItem buildJob
                 }
                 else {
                     finishBuildJobExceptionally(buildJobItem.id(), containerName, e);
+
+                    final String msg;
                     if (e instanceof TimeoutException) {
+                        msg = "Build job with id " + buildJobItem.id() + " was timed out";
                         logTimedOutBuildJob(buildJobItem, buildJobTimeoutSeconds);
                     }
-                    throw new CompletionException(e);
+                    else {
+                        msg = "Build job with id " + buildJobItem.id() + " failed";
+                    }
+
+                    throw new CompletionException(msg, e);
                 }
             }
         });

src/main/java/de/tum/cit/aet/artemis/buildagent/service/SharedQueueProcessingService.java

@@ -449,12 +449,22 @@ private void processBuild(BuildJobQueueItem buildJob) {
             BuildJobQueueItem job;
             BuildStatus status;
 
-            if (!(ex.getCause() instanceof CancellationException) || !ex.getMessage().equals("Build job with id " + buildJob.id() + " was cancelled.")) {
-                status = BuildStatus.FAILED;
-                log.error("Error while processing build job: {}", buildJob, ex);
+            String cancelledMsg = "Build job with id " + buildJob.id() + " was cancelled.";
+            String timeoutMsg = "Build job with id " + buildJob.id() + " was timed out";
+            Throwable cause = ex.getCause();
+            String errorMessage = ex.getMessage();
+
+            if ((cause instanceof TimeoutException) || errorMessage.equals(timeoutMsg)) {
+                status = BuildStatus.TIMEOUT;
+                log.info("Build job with id {} was timed out", buildJob.id());
             }
-            else {
+            else if ((cause instanceof CancellationException) && errorMessage.equals(cancelledMsg)) {
                 status = BuildStatus.CANCELLED;
+                log.info("Build job with id {} was cancelled", buildJob.id());
+            }
+            else {
+                status = BuildStatus.FAILED;
+                log.error("Error while processing build job: {}", buildJob, ex);
             }
 
             job = new BuildJobQueueItem(buildJob, completionDate, status);

src/main/java/de/tum/cit/aet/artemis/programming/domain/build/BuildJob.java

@@ -45,6 +45,9 @@ public class BuildJob extends DomainObject {
     @Column(name = "build_agent_address")
     private String buildAgentAddress;
 
+    @Column(name = "build_submission_date")
+    private ZonedDateTime buildSubmissionDate;
+
     @Column(name = "build_start_date")
     private ZonedDateTime buildStartDate;
 
@@ -89,6 +92,7 @@ public BuildJob(BuildJobQueueItem queueItem, BuildStatus buildStatus, Result res
         this.participationId = queueItem.participationId();
         this.result = result;
         this.buildAgentAddress = queueItem.buildAgent().memberAddress();
+        this.buildSubmissionDate = queueItem.jobTimingInfo().submissionDate();
         this.buildStartDate = queueItem.jobTimingInfo().buildStartDate();
         this.buildCompletionDate = queueItem.jobTimingInfo().buildCompletionDate();
         this.repositoryType = queueItem.repositoryInfo().repositoryType();
@@ -157,6 +161,14 @@ public void setBuildAgentAddress(String buildAgentAddress) {
         this.buildAgentAddress = buildAgentAddress;
     }
 
+    public ZonedDateTime getBuildSubmissionDate() {
+        return buildSubmissionDate;
+    }
+
+    public void setBuildSubmissionDate(ZonedDateTime buildSubmissionDate) {
+        this.buildSubmissionDate = buildSubmissionDate;
+    }
+
     public ZonedDateTime getBuildStartDate() {
         return buildStartDate;
     }

src/main/java/de/tum/cit/aet/artemis/programming/domain/build/BuildStatus.java

@@ -5,8 +5,11 @@
  * FAILED: the build failed
  * ERROR: the build produced an error
  * CANCELED: the build was canceled
+ * QUEUED: the build is queued
+ * BUILDING: the build is currently building
+ * MISSING: the build is missing (i.e. it was not found in the queue, not being built or not finished)
  */
 
 public enum BuildStatus {
-    SUCCESSFUL, FAILED, ERROR, CANCELLED
+    SUCCESSFUL, FAILED, ERROR, CANCELLED, QUEUED, BUILDING, TIMEOUT, MISSING
 }

src/main/java/de/tum/cit/aet/artemis/programming/repository/BuildJobRepository.java

@@ -14,9 +14,11 @@
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.jpa.repository.EntityGraph;
 import org.springframework.data.jpa.repository.JpaSpecificationExecutor;
+import org.springframework.data.jpa.repository.Modifying;
 import org.springframework.data.jpa.repository.Query;
 import org.springframework.data.repository.query.Param;
 import org.springframework.stereotype.Repository;
+import org.springframework.transaction.annotation.Transactional;
 
 import de.tum.cit.aet.artemis.buildagent.dto.BuildJobResultCountDTO;
 import de.tum.cit.aet.artemis.buildagent.dto.DockerImageBuild;
@@ -39,8 +41,8 @@ public interface BuildJobRepository extends ArtemisJpaRepository<BuildJob, Long>
                 LEFT JOIN Course c ON b.courseId = c.id
             WHERE (:buildStatus IS NULL OR b.buildStatus = :buildStatus)
                 AND (:buildAgentAddress IS NULL OR b.buildAgentAddress = :buildAgentAddress)
-                AND (CAST(:startDate AS string) IS NULL OR b.buildStartDate >= :startDate)
-                AND (CAST(:endDate AS string) IS NULL OR b.buildStartDate <= :endDate)
+                AND (CAST(:startDate AS string) IS NULL OR b.buildSubmissionDate >= :startDate)
+                AND (CAST(:endDate AS string) IS NULL OR b.buildSubmissionDate <= :endDate)
                 AND (:searchTerm IS NULL OR (b.repositoryName LIKE %:searchTerm% OR c.title LIKE %:searchTerm%))
                 AND (:courseId IS NULL OR b.courseId = :courseId)
                 AND (:durationLower IS NULL OR (b.buildCompletionDate - b.buildStartDate) >= :durationLower)
@@ -77,7 +79,7 @@ Page<Long> findIdsByFilterCriteria(@Param("buildStatus") BuildStatus buildStatus
                 COUNT(b.buildStatus)
             )
             FROM BuildJob b
-            WHERE b.buildStartDate >= :fromDateTime
+            WHERE b.buildSubmissionDate >= :fromDateTime
                 AND (:courseId IS NULL OR b.courseId = :courseId)
             GROUP BY b.buildStatus
             """)
@@ -120,4 +122,37 @@ SELECT COUNT(b)
             WHERE b.exerciseId = :exerciseId AND b.buildStatus = 'SUCCESSFUL'
             """)
     long fetchSuccessfulBuildJobCountByExerciseId(@Param("exerciseId") Long exerciseId);
+
+    @Transactional
+    @Modifying
+    @Query("UPDATE BuildJob b SET b.buildStatus = :newStatus WHERE b.buildJobId = :buildJobId")
+    void updateBuildJobStatus(@Param("buildJobId") String buildJobId, @Param("newStatus") BuildStatus newStatus);
+
+    /**
+     * Update the build job status and set the build start date if it is not set yet. The buildStartDate is required to calculate the statistics and the correctly display in the
+     * build overview.
+     * This is used to update missing jobs that do not have a build start date yet.
+     *
+     * @param buildJobId     the build job id
+     * @param newStatus      the new build status
+     * @param buildStartDate the build start date
+     */
+    @Transactional
+    @Modifying
+    @Query("""
+            UPDATE BuildJob b
+            SET b.buildStatus = :newStatus,
+                b.buildStartDate = CASE WHEN b.buildStartDate IS NULL THEN :buildStartDate ELSE b.buildStartDate END
+            WHERE b.buildJobId = :buildJobId
+            """)
+    void updateBuildJobStatusWithBuildStartDate(@Param("buildJobId") String buildJobId, @Param("newStatus") BuildStatus newStatus,
+            @Param("buildStartDate") ZonedDateTime buildStartDate);
+
+    /**
+     * Find all build jobs with the given build status.
+     *
+     * @param statuses the list of build statuses
+     * @return the list of build jobs
+     */
+    List<BuildJob> findAllByBuildStatusIn(List<BuildStatus> statuses);
 }