From 3baba5d90613585685a42e2f54ab34236394368b Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:45:37 +0100 Subject: [PATCH 01/49] add count dtos --- .../core/dto/NonLatestNonRatedResultsCleanupCountDTO.java | 4 ++++ .../core/dto/NonLatestRatedResultsCleanupCountDTO.java | 4 ++++ .../tum/cit/aet/artemis/core/dto/OrphanCleanupCountDTO.java | 6 ++++++ .../core/dto/PlagiarismComparisonCleanupCountDTO.java | 4 ++++ 4 files changed, 18 insertions(+) create mode 100644 src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestNonRatedResultsCleanupCountDTO.java create mode 100644 src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestRatedResultsCleanupCountDTO.java create mode 100644 src/main/java/de/tum/cit/aet/artemis/core/dto/OrphanCleanupCountDTO.java create mode 100644 src/main/java/de/tum/cit/aet/artemis/core/dto/PlagiarismComparisonCleanupCountDTO.java diff --git a/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestNonRatedResultsCleanupCountDTO.java b/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestNonRatedResultsCleanupCountDTO.java new file mode 100644 index 000000000000..2303ed7b9d6b --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestNonRatedResultsCleanupCountDTO.java @@ -0,0 +1,4 @@ +package de.tum.cit.aet.artemis.core.dto; + +public record NonLatestNonRatedResultsCleanupCountDTO(int longFeedbackText, int textBlock, int feedback) { +} diff --git a/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestRatedResultsCleanupCountDTO.java b/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestRatedResultsCleanupCountDTO.java new file mode 100644 index 000000000000..71ac76bc24b4 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestRatedResultsCleanupCountDTO.java @@ -0,0 +1,4 @@ +package de.tum.cit.aet.artemis.core.dto; + +public record NonLatestRatedResultsCleanupCountDTO(int longFeedbackText, int textBlock, int feedback) { +} diff --git a/src/main/java/de/tum/cit/aet/artemis/core/dto/OrphanCleanupCountDTO.java b/src/main/java/de/tum/cit/aet/artemis/core/dto/OrphanCleanupCountDTO.java new file mode 100644 index 000000000000..6037253d88c5 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/core/dto/OrphanCleanupCountDTO.java @@ -0,0 +1,6 @@ +package de.tum.cit.aet.artemis.core.dto; + +public record OrphanCleanupCountDTO(int orphanFeedback, int orphanLongFeedbackText, int orphanTextBlock, int orphanStudentScore, int orphanTeamScore, + int orphanFeedbackForOrphanResults, int orphanLongFeedbackTextForOrphanResults, int orphanTextBlockForOrphanResults, int orphanRating, + int orphanResultsWithoutParticipation) { +} diff --git a/src/main/java/de/tum/cit/aet/artemis/core/dto/PlagiarismComparisonCleanupCountDTO.java b/src/main/java/de/tum/cit/aet/artemis/core/dto/PlagiarismComparisonCleanupCountDTO.java new file mode 100644 index 000000000000..c6d76ec79c5f --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/core/dto/PlagiarismComparisonCleanupCountDTO.java @@ -0,0 +1,4 @@ +package de.tum.cit.aet.artemis.core.dto; + +public record PlagiarismComparisonCleanupCountDTO(int plagiarismComparison, int plagiarismElements, int plagiarismSubmissions, int plagiarismMatches) { +} From c89b8317d6d14ab10cb84e9e58548111738f692d Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:46:11 +0100 Subject: [PATCH 02/49] add count routes to AdminCleanupResource --- .../core/web/admin/AdminCleanupResource.java | 65 +++++++++++++++++++ 1 file changed, 65 insertions(+) diff --git a/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCleanupResource.java b/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCleanupResource.java index 60d865abdb0d..c9f03e6176af 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCleanupResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCleanupResource.java @@ -16,6 +16,10 @@ import org.springframework.web.bind.annotation.RestController; import de.tum.cit.aet.artemis.core.dto.CleanupServiceExecutionRecordDTO; +import de.tum.cit.aet.artemis.core.dto.NonLatestNonRatedResultsCleanupCountDTO; +import de.tum.cit.aet.artemis.core.dto.NonLatestRatedResultsCleanupCountDTO; +import de.tum.cit.aet.artemis.core.dto.OrphanCleanupCountDTO; +import de.tum.cit.aet.artemis.core.dto.PlagiarismComparisonCleanupCountDTO; import de.tum.cit.aet.artemis.core.security.annotations.EnforceAdmin; import de.tum.cit.aet.artemis.core.service.cleanup.DataCleanupService; @@ -50,6 +54,19 @@ public ResponseEntity deleteOrphans() { return ResponseEntity.ok().body(result); } + /** + * GET admin/cleanup/orphans/count + * Counts the number of orphaned data entries that would be deleted. + * + * @return a {@link ResponseEntity} containing the count of orphaned entries + */ + @GetMapping("orphans/count") + public ResponseEntity countOrphans() { + log.info("REST request to count orphaned data in Artemis database"); + OrphanCleanupCountDTO result = dataCleanupService.countOrphans(); + return ResponseEntity.ok().body(result); + } + /** * DELETE admin/cleanup/plagiarism-comparisons * Deletes plagiarism comparisons within the specified date range. @@ -66,6 +83,22 @@ public ResponseEntity deletePlagiarismComparis return ResponseEntity.ok().body(result); } + /** + * GET admin/cleanup/plagiarism-comparisons/count + * Counts the number of plagiarism comparisons and related entries that would be deleted within the specified date range. + * + * @param deleteFrom the start date of the counting range + * @param deleteTo the end date of the counting range + * @return a {@link ResponseEntity} containing the count of affected entries + */ + @GetMapping("plagiarism-comparisons/count") + public ResponseEntity countPlagiarismComparisons(@RequestParam("deleteFrom") ZonedDateTime deleteFrom, + @RequestParam("deleteTo") ZonedDateTime deleteTo) { + log.info("REST request to count plagiarism comparisons between {} and {}", deleteFrom, deleteTo); + PlagiarismComparisonCleanupCountDTO result = dataCleanupService.countPlagiarismComparisons(deleteFrom, deleteTo); + return ResponseEntity.ok().body(result); + } + /** * DELETE admin/cleanup/non-rated-results * Deletes non-rated results within the specified date range. @@ -82,6 +115,22 @@ public ResponseEntity deleteNonRatedResults(@R return ResponseEntity.ok().body(result); } + /** + * GET admin/cleanup/non-rated-results/count + * Counts the number of non-rated results and related entries that would be deleted within the specified date range. + * + * @param deleteFrom the start date of the counting range + * @param deleteTo the end date of the counting range + * @return a {@link ResponseEntity} containing the count of affected entries + */ + @GetMapping("non-rated-results/count") + public ResponseEntity countNonRatedResults(@RequestParam("deleteFrom") ZonedDateTime deleteFrom, + @RequestParam("deleteTo") ZonedDateTime deleteTo) { + log.info("REST request to count non-rated results between {} and {}", deleteFrom, deleteTo); + NonLatestNonRatedResultsCleanupCountDTO result = dataCleanupService.countNonLatestNonRatedResults(deleteFrom, deleteTo); + return ResponseEntity.ok().body(result); + } + /** * DELETE admin/cleanup/old-rated-results * Deletes old rated results within the specified date range. @@ -98,6 +147,22 @@ public ResponseEntity deleteOldRatedResults(@R return ResponseEntity.ok().body(result); } + /** + * GET admin/cleanup/old-rated-results/count + * Counts the number of old rated results and related entries that would be deleted within the specified date range. + * + * @param deleteFrom the start date of the counting range + * @param deleteTo the end date of the counting range + * @return a {@link ResponseEntity} containing the count of affected entries + */ + @GetMapping("old-rated-results/count") + public ResponseEntity countOldRatedResults(@RequestParam("deleteFrom") ZonedDateTime deleteFrom, + @RequestParam("deleteTo") ZonedDateTime deleteTo) { + log.info("REST request to count old rated results between {} and {}", deleteFrom, deleteTo); + NonLatestRatedResultsCleanupCountDTO result = dataCleanupService.countNonLatestRatedResults(deleteFrom, deleteTo); + return ResponseEntity.ok().body(result); + } + /** * GET admin/cleanup/last-executions * Retrieves the last execution records of the data cleanup operations. From a0a7ee4a3ea605bcde21434de95d76ee6172ff79 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:46:31 +0100 Subject: [PATCH 03/49] add count methods to FeedbackCleanupRepository --- .../cleanup/FeedbackCleanupRepository.java | 88 +++++++++++++++++++ 1 file changed, 88 insertions(+) diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/FeedbackCleanupRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/FeedbackCleanupRepository.java index e0fa96965e4a..47e6e2e2f406 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/FeedbackCleanupRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/FeedbackCleanupRepository.java @@ -43,6 +43,23 @@ WHERE f.result IN ( """) int deleteFeedbackForOrphanResults(); + /** + * Counts {@link Feedback} entries where the associated {@link Result} has no submission and no participation. + * + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(f) + FROM Feedback f + WHERE f.result IN ( + SELECT r + FROM Result r + WHERE r.submission IS NULL + AND r.participation IS NULL + ) + """) + int countFeedbackForOrphanResults(); + /** * Deletes {@link Feedback} entries with a {@code null} result. * @@ -56,6 +73,18 @@ WHERE f.result IN ( """) int deleteOrphanFeedback(); + /** + * Counts {@link Feedback} entries with a {@code null} result. + * + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(f) + FROM Feedback f + WHERE f.result IS NULL + """) + int countOrphanFeedback(); + /** * Deletes {@link Feedback} entries associated with rated {@link Result} that are not the latest rated result * for a {@link Participation}, within courses conducted between the specified date range. @@ -89,6 +118,36 @@ SELECT MAX(r2.id) """) int deleteOldFeedbackThatAreNotLatestRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + /** + * Counts {@link Feedback} entries associated with rated {@link Result} that are not the latest rated result + * for a {@link Participation}, within courses conducted between the specified date range. + * + * @param deleteFrom the start date for selecting courses + * @param deleteTo the end date for selecting courses + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(f) + FROM Feedback f + WHERE f.result IN ( + SELECT r + FROM Result r + LEFT JOIN r.participation p + LEFT JOIN p.exercise e + LEFT JOIN e.course c + WHERE r.id NOT IN ( + SELECT MAX(r2.id) + FROM Result r2 + WHERE r2.participation.id = p.id + AND r2.rated = TRUE + ) + AND r.rated = TRUE + AND c.endDate < :deleteTo + AND c.startDate > :deleteFrom + ) + """) + int countOldFeedbackThatAreNotLatestRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + /** * Deletes non-rated {@link Feedback} entries that are not the latest non-rated result, where the associated course's start and end dates * are between the specified date range. @@ -120,4 +179,33 @@ SELECT MAX(r2.id) ) """) int deleteOldNonRatedFeedbackWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + + /** + * Counts non-rated {@link Feedback} entries that are not the latest non-rated result, where the associated course's start and end dates + * are between the specified date range. + * + * @param deleteFrom the start date for selecting courses + * @param deleteTo the end date for selecting courses + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(f) + FROM Feedback f + WHERE f.result IN ( + SELECT r + FROM Result r + LEFT JOIN r.participation p + LEFT JOIN p.exercise e + LEFT JOIN e.course c + WHERE r.id NOT IN ( + SELECT MAX(r2.id) + FROM Result r2 + WHERE r2.participation.id = p.id + ) + AND r.rated = FALSE + AND c.endDate < :deleteTo + AND c.startDate > :deleteFrom + ) + """) + int countOldNonRatedFeedbackWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); } From a90946e3510f0c7bc177adb2fde7928062300565 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:46:53 +0100 Subject: [PATCH 04/49] add count methods to LongFeedbackTextCleanupRepository --- .../LongFeedbackTextCleanupRepository.java | 96 +++++++++++++++++++ 1 file changed, 96 insertions(+) diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/LongFeedbackTextCleanupRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/LongFeedbackTextCleanupRepository.java index 09dbf01baff2..f91bac77e415 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/LongFeedbackTextCleanupRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/LongFeedbackTextCleanupRepository.java @@ -44,6 +44,24 @@ WHERE lft.feedback.id IN ( """) int deleteLongFeedbackTextForOrphanResult(); + /** + * Counts {@link LongFeedbackText} entries linked to {@link Feedback} where the associated + * {@link Result} has no participation and no submission. + * + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(lft) + FROM LongFeedbackText lft + WHERE lft.feedback.id IN ( + SELECT f.id + FROM Feedback f + WHERE f.result.participation IS NULL + AND f.result.submission IS NULL + ) + """) + int countLongFeedbackTextForOrphanResult(); + /** * Deletes {@link LongFeedbackText} linked to {@link Feedback} with a {@code null} result. * @@ -61,6 +79,22 @@ WHERE lft.feedback IN ( """) int deleteLongFeedbackTextForOrphanedFeedback(); + /** + * Counts {@link LongFeedbackText} linked to {@link Feedback} with a {@code null} result. + * + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(lft) + FROM LongFeedbackText lft + WHERE lft.feedback IN ( + SELECT f + FROM Feedback f + WHERE f.result IS NULL + ) + """) + int countLongFeedbackTextForOrphanedFeedback(); + /** * Deletes {@link LongFeedbackText} entries associated with rated {@link Result} that are not the latest rated result * for a {@link Participation}, within courses conducted between the specified date range. @@ -95,6 +129,37 @@ SELECT MAX(r2.id) """) int deleteLongFeedbackTextForRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + /** + * Counts {@link LongFeedbackText} entries associated with rated {@link Result} that are not the latest rated result + * for a {@link Participation}, within courses conducted between the specified date range. + * + * @param deleteFrom the start date for selecting courses + * @param deleteTo the end date for selecting courses + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(lft) + FROM LongFeedbackText lft + WHERE lft.feedback IN ( + SELECT f + FROM Feedback f + LEFT JOIN f.result r + LEFT JOIN r.participation p + LEFT JOIN p.exercise e + LEFT JOIN e.course c + WHERE f.result.id NOT IN ( + SELECT MAX(r2.id) + FROM Result r2 + WHERE r2.participation.id = p.id + AND r2.rated = TRUE + ) + AND c.endDate < :deleteTo + AND c.startDate > :deleteFrom + AND r.rated = TRUE + ) + """) + int countLongFeedbackTextForRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + /** * Deletes {@link LongFeedbackText} entries linked to non-rated {@link Feedback} that are not the latest non-rated result where the associated course's start * and end dates are between the specified date range. @@ -128,4 +193,35 @@ SELECT MAX(r2.id) ) """) int deleteLongFeedbackTextForNonRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + + /** + * Counts {@link LongFeedbackText} entries linked to non-rated {@link Feedback} that are not the latest non-rated result where the associated course's start + * and end dates are between the specified date range. + * + * @param deleteFrom the start date for selecting courses + * @param deleteTo the end date for selecting courses + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(lft) + FROM LongFeedbackText lft + WHERE lft.feedback IN ( + SELECT f + FROM Feedback f + LEFT JOIN f.result r + LEFT JOIN r.participation p + LEFT JOIN p.exercise e + LEFT JOIN e.course c + WHERE f.result.id NOT IN ( + SELECT MAX(r2.id) + FROM Result r2 + WHERE r2.participation.id = p.id + AND r2.rated = FALSE + ) + AND r.rated = FALSE + AND c.endDate < :deleteTo + AND c.startDate > :deleteFrom + ) + """) + int countLongFeedbackTextForNonRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); } From 949762cfa63c1da11a4dafb9488e9e55f8558c30 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:47:10 +0100 Subject: [PATCH 05/49] add count methods to ParticipantScoreCleanupRepository --- .../ParticipantScoreCleanupRepository.java | 104 ++++++++++++++++++ 1 file changed, 104 insertions(+) diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/ParticipantScoreCleanupRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/ParticipantScoreCleanupRepository.java index 50fcdd5b14b3..f4583759ccb5 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/ParticipantScoreCleanupRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/ParticipantScoreCleanupRepository.java @@ -57,6 +57,32 @@ SELECT MAX(r2.id) """) int deleteParticipantScoresForNonLatestLastResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + /** + * Counts {@link ParticipantScore} entries where the associated {@link Result} is not the latest rated result + * for a {@link Participation}, within courses conducted between the specified date range. + */ + @Query(""" + SELECT COUNT(ps) + FROM ParticipantScore ps + WHERE ps.lastResult IN ( + SELECT r + FROM Result r + LEFT JOIN r.participation p + LEFT JOIN p.exercise e + LEFT JOIN e.course c + WHERE r.id NOT IN ( + SELECT MAX(r2.id) + FROM Result r2 + WHERE r2.participation.id = p.id + AND r2.rated = TRUE + ) + AND r.rated = TRUE + AND c.endDate < :deleteTo + AND c.startDate > :deleteFrom + ) + """) + int countParticipantScoresForNonLatestLastResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + /** * Deletes {@link ParticipantScore} entries where the associated last rated {@link Result} is not the latest rated result * for a {@link Participation}, within courses conducted between the specified date range. @@ -90,6 +116,32 @@ SELECT MAX(r2.id) """) int deleteParticipantScoresForNonLatestLastRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + /** + * Counts {@link ParticipantScore} entries where the associated last rated {@link Result} is not the latest rated result + * for a {@link Participation}, within courses conducted between the specified date range. + */ + @Query(""" + SELECT COUNT(ps) + FROM ParticipantScore ps + WHERE ps.lastRatedResult IN ( + SELECT r + FROM Result r + LEFT JOIN r.participation p + LEFT JOIN p.exercise e + LEFT JOIN e.course c + WHERE r.id NOT IN ( + SELECT MAX(r2.id) + FROM Result r2 + WHERE r2.participation.id = p.id + AND r2.rated = TRUE + ) + AND r.rated = TRUE + AND c.endDate < :deleteTo + AND c.startDate > :deleteFrom + ) + """) + int countParticipantScoresForNonLatestLastRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + /** * Deletes {@link ParticipantScore} entries where the associated {@link Result} is not the latest result and is non-rated, * and the course's start and end dates are between the specified date range. @@ -122,6 +174,32 @@ SELECT MAX(r2.id) """) int deleteParticipantScoresForLatestNonRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + /** + * Counts {@link ParticipantScore} entries where the associated {@link Result} is not the latest result and is non-rated, + * and the course's start and end dates are between the specified date range. + */ + @Query(""" + SELECT COUNT(ps) + FROM ParticipantScore ps + WHERE ps.lastResult IN ( + SELECT r + FROM Result r + LEFT JOIN r.participation p + LEFT JOIN p.exercise e + LEFT JOIN e.course c + WHERE r.id NOT IN ( + SELECT MAX(r2.id) + FROM Result r2 + WHERE r2.participation.id = p.id + AND r2.rated = FALSE + ) + AND r.rated = FALSE + AND c.endDate < :deleteTo + AND c.startDate > :deleteFrom + ) + """) + int countParticipantScoresForLatestNonRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + /** * Deletes {@link ParticipantScore} entries where the associated {@link Result} is not latest and is non-rated, even though * it is marked as the last rated result, to prevent potential integrity violations. @@ -155,4 +233,30 @@ SELECT MAX(r2.id) ) """) int deleteParticipantScoresForNonRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + + /** + * Counts {@link ParticipantScore} entries where the associated {@link Result} is not latest and is non-rated, even though + * it is marked as the last rated result. + */ + @Query(""" + SELECT COUNT(ps) + FROM ParticipantScore ps + WHERE ps.lastRatedResult IN ( + SELECT r + FROM Result r + LEFT JOIN r.participation p + LEFT JOIN p.exercise e + LEFT JOIN e.course c + WHERE r.id NOT IN ( + SELECT MAX(r2.id) + FROM Result r2 + WHERE r2.participation.id = p.id + AND r2.rated = FALSE + ) + AND r.rated = FALSE + AND c.endDate < :deleteTo + AND c.startDate > :deleteFrom + ) + """) + int countParticipantScoresForNonRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); } From 0744a0ec477e269137515cf4c714530b1c6d174d Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:47:28 +0100 Subject: [PATCH 06/49] add count methods to PlagiarismComparisonCleanupRepository --- ...PlagiarismComparisonCleanupRepository.java | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/PlagiarismComparisonCleanupRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/PlagiarismComparisonCleanupRepository.java index a93ba9604223..e0742c3b71d9 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/PlagiarismComparisonCleanupRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/PlagiarismComparisonCleanupRepository.java @@ -32,6 +32,13 @@ public interface PlagiarismComparisonCleanupRepository extends ArtemisJpaReposit """) int deleteByIdsIn(@Param("ids") List ids); + @Query(""" + SELECT COUNT(pc) + FROM PlagiarismComparison pc + WHERE pc.id IN :ids + """) + int countByIdsIn(@Param("ids") List ids); + @Modifying @Transactional // ok because of delete @Query(""" @@ -41,6 +48,13 @@ public interface PlagiarismComparisonCleanupRepository extends ArtemisJpaReposit """) int deletePlagiarismSubmissionElementsByComparisonIdsIn(@Param("ids") List ids); + @Query(""" + SELECT COUNT(e) + FROM PlagiarismSubmissionElement e + WHERE e.plagiarismSubmission.plagiarismComparison.id IN :ids + """) + int countPlagiarismSubmissionElementsByComparisonIdsIn(@Param("ids") List ids); + @Modifying @Transactional // ok because of delete @Query(""" @@ -50,6 +64,13 @@ public interface PlagiarismComparisonCleanupRepository extends ArtemisJpaReposit """) int deletePlagiarismSubmissionsByComparisonIdsIn(@Param("ids") List ids); + @Query(""" + SELECT COUNT(s) + FROM PlagiarismSubmission s + WHERE s.plagiarismComparison.id IN :ids + """) + int countPlagiarismSubmissionsByComparisonIdsIn(@Param("ids") List ids); + @Modifying @Transactional // ok because of modifying @Query(""" @@ -59,6 +80,13 @@ public interface PlagiarismComparisonCleanupRepository extends ArtemisJpaReposit """) int setPlagiarismSubmissionsToNullInComparisonsWithIds(@Param("ids") List ids); + @Query(""" + SELECT COUNT(pc) + FROM PlagiarismComparison pc + WHERE pc.id IN :ids AND (pc.submissionA IS NOT NULL OR pc.submissionB IS NOT NULL) + """) + int countPlagiarismSubmissionsNotNullInComparisonsWithIds(@Param("ids") List ids); + @Modifying @Transactional // ok because of delete @Query(nativeQuery = true, value = """ @@ -68,6 +96,13 @@ public interface PlagiarismComparisonCleanupRepository extends ArtemisJpaReposit """) int deletePlagiarismComparisonMatchesByComparisonIdsIn(@Param("ids") List ids); + @Query(nativeQuery = true, value = """ + SELECT COUNT(*) + FROM plagiarism_comparison_matches m + WHERE m.plagiarism_comparison_id IN :ids + """) + int countPlagiarismComparisonMatchesByComparisonIdsIn(@Param("ids") List ids); + /** * Retrieves a list of unnecessary plagiarism comparison IDs based on the associated course's date range. * A plagiarism comparison is considered unnecessary if its status is 'NONE' and the related course's From 1f8cf774d09d3af5f938be7547b27bdf85f907d1 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:48:52 +0100 Subject: [PATCH 07/49] remove redundant method --- .../PlagiarismComparisonCleanupRepository.java | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/PlagiarismComparisonCleanupRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/PlagiarismComparisonCleanupRepository.java index e0742c3b71d9..543c6255639b 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/PlagiarismComparisonCleanupRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/PlagiarismComparisonCleanupRepository.java @@ -32,13 +32,6 @@ public interface PlagiarismComparisonCleanupRepository extends ArtemisJpaReposit """) int deleteByIdsIn(@Param("ids") List ids); - @Query(""" - SELECT COUNT(pc) - FROM PlagiarismComparison pc - WHERE pc.id IN :ids - """) - int countByIdsIn(@Param("ids") List ids); - @Modifying @Transactional // ok because of delete @Query(""" @@ -80,13 +73,6 @@ SELECT COUNT(s) """) int setPlagiarismSubmissionsToNullInComparisonsWithIds(@Param("ids") List ids); - @Query(""" - SELECT COUNT(pc) - FROM PlagiarismComparison pc - WHERE pc.id IN :ids AND (pc.submissionA IS NOT NULL OR pc.submissionB IS NOT NULL) - """) - int countPlagiarismSubmissionsNotNullInComparisonsWithIds(@Param("ids") List ids); - @Modifying @Transactional // ok because of delete @Query(nativeQuery = true, value = """ From cd27c3358bb1df6dcab86bcadae2de83f9b3de13 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:49:17 +0100 Subject: [PATCH 08/49] add count methods in RatingCleanupRepository --- .../cleanup/RatingCleanupRepository.java | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/RatingCleanupRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/RatingCleanupRepository.java index 07f10ec6d3d3..c923cffbcef6 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/RatingCleanupRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/RatingCleanupRepository.java @@ -38,4 +38,21 @@ WHERE rt.result IN ( ) """) int deleteOrphanRating(); + + /** + * Counts {@link Rating} entries where the associated {@link Result} has no submission and no participation. + * + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(rt) + FROM Rating rt + WHERE rt.result IN ( + SELECT r + FROM Result r + WHERE r.submission IS NULL + AND r.participation IS NULL + ) + """) + int countOrphanRating(); } From 1ddb9f12289d28af76df4e623119302345ef3fd7 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:49:36 +0100 Subject: [PATCH 09/49] add count methods in ResultCleanupRepository --- .../cleanup/ResultCleanupRepository.java | 81 +++++++++++++++++++ 1 file changed, 81 insertions(+) diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/ResultCleanupRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/ResultCleanupRepository.java index 7d9e413aa5e7..7bf86fe0c730 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/ResultCleanupRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/ResultCleanupRepository.java @@ -39,6 +39,19 @@ public interface ResultCleanupRepository extends ArtemisJpaRepository :deleteFrom + ) + AND r.id NOT IN ( + SELECT max_id + FROM ( + SELECT MAX(r2.id) AS max_id + FROM Result r2 + WHERE r2.rated = FALSE + GROUP BY r2.participation.id + ) + ) + """) + int countNonLatestNonRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + /** * Deletes rated {@link Result} entries that are not the latest rated result for a {@link Participation}, within courses * conducted between the specified date range. @@ -112,4 +159,38 @@ SELECT MAX(r2.id) AS max_id ) """) int deleteNonLatestRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + + /** + * Counts rated {@link Result} entries that are not the latest rated result for a {@link Participation}, within courses + * conducted between the specified date range. + * + * @param deleteFrom the start date for selecting courses + * @param deleteTo the end date for selecting courses + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(r) + FROM Result r + WHERE r.rated = TRUE + AND r.participation IS NOT NULL + AND r.participation.exercise IS NOT NULL + AND EXISTS ( + SELECT 1 + FROM Course c + LEFT JOIN c.exercises e + WHERE e = r.participation.exercise + AND c.endDate < :deleteTo + AND c.startDate > :deleteFrom + ) + AND r.id NOT IN ( + SELECT max_id + FROM ( + SELECT MAX(r2.id) AS max_id + FROM Result r2 + WHERE r2.rated = TRUE + GROUP BY r2.participation.id + ) + ) + """) + int countNonLatestRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); } From 2443c4537f51e69905b57c9794ffc6dbc0b2dfc1 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:49:56 +0100 Subject: [PATCH 10/49] add count methods in StudentScoreCleanupRepository --- .../cleanup/StudentScoreCleanupRepository.java | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/StudentScoreCleanupRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/StudentScoreCleanupRepository.java index d45bf8243e50..e7c679fe34cd 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/StudentScoreCleanupRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/StudentScoreCleanupRepository.java @@ -31,4 +31,16 @@ public interface StudentScoreCleanupRepository extends ArtemisJpaRepository Date: Sat, 16 Nov 2024 12:50:15 +0100 Subject: [PATCH 11/49] add count methods in TeamScoreCleanupRepository --- .../cleanup/TeamScoreCleanupRepository.java | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/TeamScoreCleanupRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/TeamScoreCleanupRepository.java index 2c1009f481b8..b1a17076fb47 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/TeamScoreCleanupRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/TeamScoreCleanupRepository.java @@ -31,4 +31,16 @@ public interface TeamScoreCleanupRepository extends ArtemisJpaRepository Date: Sat, 16 Nov 2024 12:50:33 +0100 Subject: [PATCH 12/49] add count methods in TextBlockCleanupRepository --- .../cleanup/TextBlockCleanupRepository.java | 100 +++++++++++++++++- 1 file changed, 98 insertions(+), 2 deletions(-) diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/TextBlockCleanupRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/TextBlockCleanupRepository.java index 132fcc4f9726..8e2c7062515e 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/TextBlockCleanupRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/TextBlockCleanupRepository.java @@ -45,6 +45,25 @@ WHERE tb.feedback IN ( """) int deleteTextBlockForOrphanResults(); + /** + * Counts {@link TextBlock} entries linked to {@link Feedback} where the associated {@link Result} + * has no submission and no participation. + * + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(tb) + FROM TextBlock tb + WHERE tb.feedback IN ( + SELECT f + FROM Feedback f + LEFT JOIN f.result r + WHERE r.submission IS NULL + AND r.participation IS NULL + ) + """) + int countTextBlockForOrphanResults(); + /** * Deletes {@link TextBlock} entries linked to {@link Feedback} with a {@code null} result. * @@ -62,11 +81,25 @@ WHERE tb.feedback IN ( """) int deleteTextBlockForEmptyFeedback(); + /** + * Counts {@link TextBlock} entries linked to {@link Feedback} with a {@code null} result. + * + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(tb) + FROM TextBlock tb + WHERE tb.feedback IN ( + SELECT f + FROM Feedback f + WHERE f.result IS NULL + ) + """) + int countTextBlockForEmptyFeedback(); + /** * Deletes {@link TextBlock} entries associated with rated {@link Result} that are not the latest rated result * for a {@link Participation}, within courses conducted between the specified date range. - * This query removes old text blocks that are not part of the latest rated results, for courses whose - * end date is before {@code deleteTo} and start date is after {@code deleteFrom}. * * @param deleteFrom the start date for selecting courses * @param deleteTo the end date for selecting courses @@ -96,6 +129,37 @@ SELECT MAX(r2.id) """) int deleteTextBlockForRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + /** + * Counts {@link TextBlock} entries associated with rated {@link Result} that are not the latest rated result + * for a {@link Participation}, within courses conducted between the specified date range. + * + * @param deleteFrom the start date for selecting courses + * @param deleteTo the end date for selecting courses + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(tb) + FROM TextBlock tb + WHERE tb.feedback IN ( + SELECT f + FROM Feedback f + LEFT JOIN f.result r + LEFT JOIN r.participation p + LEFT JOIN p.exercise e + LEFT JOIN e.course c + WHERE f.result.id NOT IN ( + SELECT MAX(r2.id) + FROM Result r2 + WHERE r2.participation.id = p.id + AND r2.rated = TRUE + ) + AND r.rated = TRUE + AND c.endDate < :deleteTo + AND c.startDate > :deleteFrom + ) + """) + int countTextBlockForRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + /** * Deletes {@link TextBlock} entries linked to non-rated {@link Result} that are not the latest non-rated result * for a {@link Participation}, where the associated course's start and end dates @@ -130,4 +194,36 @@ SELECT MAX(r2.id) ) """) int deleteTextBlockForNonRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + + /** + * Counts {@link TextBlock} entries linked to non-rated {@link Result} that are not the latest non-rated result + * for a {@link Participation}, where the associated course's start and end dates + * are between the specified date range. + * + * @param deleteFrom the start date for selecting courses + * @param deleteTo the end date for selecting courses + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(tb) + FROM TextBlock tb + WHERE tb.feedback IN ( + SELECT f + FROM Feedback f + LEFT JOIN f.result r + LEFT JOIN r.participation p + LEFT JOIN p.exercise e + LEFT JOIN e.course c + WHERE f.result.id NOT IN ( + SELECT MAX(r2.id) + FROM Result r2 + WHERE r2.participation.id = p.id + AND r2.rated = FALSE + ) + AND r.rated = FALSE + AND c.endDate < :deleteTo + AND c.startDate > :deleteFrom + ) + """) + int countTextBlockForNonRatedResultsWhereCourseDateBetween(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); } From 7610d882aec80463717bc1d4067b56bb88d45529 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:51:10 +0100 Subject: [PATCH 13/49] add methods to count affected entities to DataCleanupService --- .../service/cleanup/DataCleanupService.java | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) diff --git a/src/main/java/de/tum/cit/aet/artemis/core/service/cleanup/DataCleanupService.java b/src/main/java/de/tum/cit/aet/artemis/core/service/cleanup/DataCleanupService.java index a89a6f6ef207..611e616c7258 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/service/cleanup/DataCleanupService.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/service/cleanup/DataCleanupService.java @@ -23,6 +23,10 @@ import de.tum.cit.aet.artemis.core.domain.CleanupJobExecution; import de.tum.cit.aet.artemis.core.domain.CleanupJobType; import de.tum.cit.aet.artemis.core.dto.CleanupServiceExecutionRecordDTO; +import de.tum.cit.aet.artemis.core.dto.NonLatestNonRatedResultsCleanupCountDTO; +import de.tum.cit.aet.artemis.core.dto.NonLatestRatedResultsCleanupCountDTO; +import de.tum.cit.aet.artemis.core.dto.OrphanCleanupCountDTO; +import de.tum.cit.aet.artemis.core.dto.PlagiarismComparisonCleanupCountDTO; import de.tum.cit.aet.artemis.core.repository.cleanup.CleanupJobExecutionRepository; @Profile(PROFILE_CORE) @@ -208,6 +212,80 @@ public CleanupServiceExecutionRecordDTO deleteNonLatestRatedResultsFeedback(Zone return CleanupServiceExecutionRecordDTO.of(createCleanupJobExecution(CleanupJobType.RATED_RESULTS, deleteFrom, deleteTo)); } + /** + * Counts orphaned entities that are no longer associated with valid results or participations. + * This includes feedback, text blocks, and scores that reference null results, participations, or submissions. + * + * @return an {@link OrphanCleanupCountDTO} representing the counts of orphaned entities that would be deleted + */ + public OrphanCleanupCountDTO countOrphans() { + int orphanFeedbackCount = feedbackCleanupRepository.countOrphanFeedback(); + int orphanLongFeedbackTextCount = longFeedbackTextCleanupRepository.countLongFeedbackTextForOrphanedFeedback(); + int orphanTextBlockCount = textBlockCleanupRepository.countTextBlockForEmptyFeedback(); + int orphanStudentScoreCount = studentScoreCleanupRepository.countOrphanStudentScore(); + int orphanTeamScoreCount = teamScoreCleanupRepository.countOrphanTeamScore(); + int orphanLongFeedbackTextForOrphanResultsCount = longFeedbackTextCleanupRepository.countLongFeedbackTextForOrphanResult(); + int orphanTextBlockForOrphanResultsCount = textBlockCleanupRepository.countTextBlockForOrphanResults(); + int orphanFeedbackForOrphanResultsCount = feedbackCleanupRepository.countFeedbackForOrphanResults(); + int orphanRatingCount = ratingCleanupRepository.countOrphanRating(); + int orphanResultsWithoutParticipationCount = resultCleanupRepository.countResultWithoutParticipationAndSubmission(); + + return new OrphanCleanupCountDTO(orphanFeedbackCount, orphanLongFeedbackTextCount, orphanTextBlockCount, orphanStudentScoreCount, orphanTeamScoreCount, + orphanFeedbackForOrphanResultsCount, orphanLongFeedbackTextForOrphanResultsCount, orphanTextBlockForOrphanResultsCount, orphanRatingCount, + orphanResultsWithoutParticipationCount); + } + + /** + * Counts plagiarism comparisons with a status of "None" that belong to courses within the specified date range. + * It retrieves the IDs of the plagiarism comparisons matching the criteria and counts the related data, + * including plagiarism elements, submissions, and matches. + * + * @param deleteFrom the start date for selecting plagiarism comparisons + * @param deleteTo the end date for selecting plagiarism comparisons + * @return a {@link PlagiarismComparisonCleanupCountDTO} representing the counts of entities related to plagiarism comparisons + */ + public PlagiarismComparisonCleanupCountDTO countPlagiarismComparisons(ZonedDateTime deleteFrom, ZonedDateTime deleteTo) { + var pcIds = plagiarismComparisonCleanupRepository.findPlagiarismComparisonIdWithStatusNoneThatBelongToCourseWithDates(deleteFrom, deleteTo); + int plagiarismComparisonCount = pcIds.size(); + int plagiarismElementsCount = plagiarismComparisonCleanupRepository.countPlagiarismSubmissionElementsByComparisonIdsIn(pcIds); + int plagiarismSubmissionsCount = plagiarismComparisonCleanupRepository.countPlagiarismSubmissionsByComparisonIdsIn(pcIds); + int plagiarismMatchesCount = plagiarismComparisonCleanupRepository.countPlagiarismComparisonMatchesByComparisonIdsIn(pcIds); + + return new PlagiarismComparisonCleanupCountDTO(plagiarismComparisonCount, plagiarismElementsCount, plagiarismSubmissionsCount, plagiarismMatchesCount); + } + + /** + * Counts non-rated results that are not the latest non-rated result for each participation, within the specified date range. + * This includes associated long feedback texts, text blocks, and feedback items that would be affected. + * + * @param deleteFrom The start of the date range for counting non-rated results. + * @param deleteTo The end of the date range for counting non-rated results. + * @return a {@link NonLatestNonRatedResultsCleanupCountDTO} representing the counts of entities related to non-latest non-rated results + */ + public NonLatestNonRatedResultsCleanupCountDTO countNonLatestNonRatedResults(ZonedDateTime deleteFrom, ZonedDateTime deleteTo) { + int longFeedbackTextCount = longFeedbackTextCleanupRepository.countLongFeedbackTextForNonRatedResultsWhereCourseDateBetween(deleteFrom, deleteTo); + int textBlockCount = textBlockCleanupRepository.countTextBlockForNonRatedResultsWhereCourseDateBetween(deleteFrom, deleteTo); + int feedbackCount = feedbackCleanupRepository.countOldNonRatedFeedbackWhereCourseDateBetween(deleteFrom, deleteTo); + + return new NonLatestNonRatedResultsCleanupCountDTO(longFeedbackTextCount, textBlockCount, feedbackCount); + } + + /** + * Counts rated results that are not the latest rated result for each participation, for courses conducted within the specified date range. + * This includes associated long feedback texts, text blocks, and feedback items that would be affected. + * + * @param deleteFrom The start of the date range for counting rated results. + * @param deleteTo The end of the date range for counting rated results. + * @return a {@link NonLatestRatedResultsCleanupCountDTO} representing the counts of entities related to non-latest rated results + */ + public NonLatestRatedResultsCleanupCountDTO countNonLatestRatedResults(ZonedDateTime deleteFrom, ZonedDateTime deleteTo) { + int longFeedbackTextCount = longFeedbackTextCleanupRepository.countLongFeedbackTextForRatedResultsWhereCourseDateBetween(deleteFrom, deleteTo); + int textBlockCount = textBlockCleanupRepository.countTextBlockForRatedResultsWhereCourseDateBetween(deleteFrom, deleteTo); + int feedbackCount = feedbackCleanupRepository.countOldFeedbackThatAreNotLatestRatedResultsWhereCourseDateBetween(deleteFrom, deleteTo); + + return new NonLatestRatedResultsCleanupCountDTO(longFeedbackTextCount, textBlockCount, feedbackCount); + } + /** * Retrieves the last execution record for each cleanup job type. * This method returns the most recent execution of each cleanup job type by querying From cbb287bf32fce8b8c36fb1e206a7fe35e2b6b51f Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:52:07 +0100 Subject: [PATCH 14/49] add interfaces and http methods in the data-cleanup.service.ts --- .../cleanup-service/data-cleanup.service.ts | 91 +++++++++++++++++++ 1 file changed, 91 insertions(+) diff --git a/src/main/webapp/app/admin/cleanup-service/data-cleanup.service.ts b/src/main/webapp/app/admin/cleanup-service/data-cleanup.service.ts index 4782b5055674..2ba79cabbd8b 100644 --- a/src/main/webapp/app/admin/cleanup-service/data-cleanup.service.ts +++ b/src/main/webapp/app/admin/cleanup-service/data-cleanup.service.ts @@ -9,6 +9,42 @@ export interface CleanupServiceExecutionRecordDTO { jobType: string; } +export interface CleanupCount { + totalCount: number; +} + +export interface OrphanCleanupCountDTO extends CleanupCount { + orphanFeedback: number; + orphanLongFeedbackText: number; + orphanTextBlock: number; + orphanStudentScore: number; + orphanTeamScore: number; + orphanFeedbackForOrphanResults: number; + orphanLongFeedbackTextForOrphanResults: number; + orphanTextBlockForOrphanResults: number; + orphanRating: number; + orphanResultsWithoutParticipation: number; +} + +export interface PlagiarismComparisonCleanupCountDTO extends CleanupCount { + plagiarismComparison: number; + plagiarismElements: number; + plagiarismSubmissions: number; + plagiarismMatches: number; +} + +export interface NonLatestNonRatedResultsCleanupCountDTO extends CleanupCount { + longFeedbackText: number; + textBlock: number; + feedback: number; +} + +export interface NonLatestRatedResultsCleanupCountDTO extends CleanupCount { + longFeedbackText: number; + textBlock: number; + feedback: number; +} + @Injectable({ providedIn: 'root' }) export class DataCleanupService { private readonly adminResourceUrl = 'api/admin/cleanup'; @@ -75,4 +111,59 @@ export class DataCleanupService { observe: 'response', }); } + + /** + * Send GET request to count orphaned data. + * @returns An observable of type HttpResponse. + */ + countOrphans(): Observable> { + return this.http.get(`${this.adminResourceUrl}/orphans/count`, { + observe: 'response', + }); + } + + /** + * Send GET request to count plagiarism comparisons within a specific date range. + * @param deleteFrom the start date for counting + * @param deleteTo the end date for counting + * @returns An observable of type HttpResponse. + */ + countPlagiarismComparisons(deleteFrom: dayjs.Dayjs, deleteTo: dayjs.Dayjs): Observable> { + const deleteFromString = convertDateFromClient(deleteFrom)!; + const deleteToString = convertDateFromClient(deleteTo)!; + return this.http.get(`${this.adminResourceUrl}/plagiarism-comparisons/count`, { + params: { deleteFrom: deleteFromString, deleteTo: deleteToString }, + observe: 'response', + }); + } + + /** + * Send GET request to count non-rated results within a specific date range. + * @param deleteFrom the start date for counting + * @param deleteTo the end date for counting + * @returns An observable of type HttpResponse. + */ + countNonRatedResults(deleteFrom: dayjs.Dayjs, deleteTo: dayjs.Dayjs): Observable> { + const deleteFromString = convertDateFromClient(deleteFrom)!; + const deleteToString = convertDateFromClient(deleteTo)!; + return this.http.get(`${this.adminResourceUrl}/non-rated-results/count`, { + params: { deleteFrom: deleteFromString, deleteTo: deleteToString }, + observe: 'response', + }); + } + + /** + * Send GET request to count old rated results within a specific date range. + * @param deleteFrom the start date for counting + * @param deleteTo the end date for counting + * @returns An observable of type HttpResponse. + */ + countOldRatedResults(deleteFrom: dayjs.Dayjs, deleteTo: dayjs.Dayjs): Observable> { + const deleteFromString = convertDateFromClient(deleteFrom)!; + const deleteToString = convertDateFromClient(deleteTo)!; + return this.http.get(`${this.adminResourceUrl}/old-rated-results/count`, { + params: { deleteFrom: deleteFromString, deleteTo: deleteToString }, + observe: 'response', + }); + } } From 7bf9e5f71c00b4c47e7f7ad9eb3c12b57d3965cf Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:52:34 +0100 Subject: [PATCH 15/49] add cleanup operation modal --- .../cleanup-operation-modal.component.html | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html new file mode 100644 index 000000000000..c183dc28cf6b --- /dev/null +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html @@ -0,0 +1,36 @@ +
+

+ +
+
+

+
+

+
    + @for (key of cleanupKeys(beforeExecutionCounts); track key) { +
  • + + : {{ beforeExecutionCounts[key] }} + @if (afterExecutionCounts) { + @if (beforeExecutionCounts[key] > afterExecutionCounts[key]) { + + } @else { + + } + } +
    • + } +
+
+
+
+ + +
From 177e192ed21301977cd5c12834a56a005c628e11 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:53:53 +0100 Subject: [PATCH 16/49] add cleanup operation modal component --- .../cleanup-operation-modal.component.ts | 114 ++++++++++++++++++ 1 file changed, 114 insertions(+) create mode 100644 src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts new file mode 100644 index 000000000000..445997dd88be --- /dev/null +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts @@ -0,0 +1,114 @@ +import { HttpErrorResponse, HttpResponse } from '@angular/common/http'; +import { Component, Input, OnInit, inject } from '@angular/core'; +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; +import { CleanupOperation } from 'app/admin/cleanup-service/cleanup-operation.model'; +import { CleanupCount, CleanupServiceExecutionRecordDTO, DataCleanupService } from 'app/admin/cleanup-service/data-cleanup.service'; +import { TranslateDirective } from 'app/shared/language/translate.directive'; +import { ArtemisSharedModule } from 'app/shared/shared.module'; +import { convertDateFromServer } from 'app/utils/date.utils'; +import { Observable, Observer, Subject } from 'rxjs'; +import { faCheckCircle, faTimes } from '@fortawesome/free-solid-svg-icons'; + +@Component({ + selector: 'jhi-cleanup-operation-modal', + templateUrl: './cleanup-operation-modal.component.html', + standalone: true, + imports: [TranslateDirective, ArtemisSharedModule], +}) +export class CleanupOperationModalComponent implements OnInit { + @Input() operation: CleanupOperation; + beforeExecutionCounts: CleanupCount; + afterExecutionCounts: CleanupCount | undefined = undefined; + + private dialogErrorSource = new Subject(); + dialogError = this.dialogErrorSource.asObservable(); + + public activeModal: NgbActiveModal = inject(NgbActiveModal); + private dataCleanupService: DataCleanupService = inject(DataCleanupService); + + // Icons + faTimes = faTimes; + faCheckCircle = faCheckCircle; + + cleanupKeys(counts: CleanupCount): (keyof CleanupCount)[] { + return Object.keys(counts) as (keyof CleanupCount)[]; + } + + close(): void { + this.activeModal.close(); + } + + ngOnInit(): void { + this.fetchOperationCounts(this.operation).subscribe({ + next: (response: HttpResponse) => { + this.beforeExecutionCounts = response.body!; + }, + error: () => this.dialogErrorSource.next('An unexpected error occurred.'), + }); + } + + executeCleanupOperation(): void { + const subscriptionHandler = this.handleResponse(this.operation); + + switch (this.operation.name) { + case 'deleteOrphans': + this.dataCleanupService.deleteOrphans().subscribe(subscriptionHandler); + break; + case 'deletePlagiarismComparisons': + this.dataCleanupService.deletePlagiarismComparisons(this.operation.deleteFrom, this.operation.deleteTo).subscribe(subscriptionHandler); + break; + case 'deleteNonRatedResults': + this.dataCleanupService.deleteNonRatedResults(this.operation.deleteFrom, this.operation.deleteTo).subscribe(subscriptionHandler); + break; + case 'deleteOldRatedResults': + this.dataCleanupService.deleteOldRatedResults(this.operation.deleteFrom, this.operation.deleteTo).subscribe(subscriptionHandler); + break; + } + } + + private fetchOperationCounts(operation: CleanupOperation): Observable> { + switch (operation.name) { + case 'deleteOrphans': + return this.dataCleanupService.countOrphans(); + case 'deletePlagiarismComparisons': + return this.dataCleanupService.countPlagiarismComparisons(operation.deleteFrom, operation.deleteTo); + case 'deleteNonRatedResults': + return this.dataCleanupService.countNonRatedResults(operation.deleteFrom, operation.deleteTo); + case 'deleteOldRatedResults': + return this.dataCleanupService.countOldRatedResults(operation.deleteFrom, operation.deleteTo); + default: + throw new Error(`Unsupported operation name: ${operation.name}`); + } + } + + private handleResponse(operation: CleanupOperation): Observer> { + return { + next: (response: HttpResponse) => { + this.dialogErrorSource.next(''); + const executionDateFromServer = convertDateFromServer(response.body!.executionDate); + operation.lastExecuted = executionDateFromServer; + this.fetchOperationCounts(operation).subscribe({ + next: (countResponse: HttpResponse) => { + if (this.afterExecutionCounts) { + this.beforeExecutionCounts = this.afterExecutionCounts; + } + this.afterExecutionCounts = countResponse.body!; + }, + error: () => { + this.dialogErrorSource.next('An error occurred while fetching post-execution counts.'); + }, + }); + }, + error: (error: any) => { + if (error instanceof HttpErrorResponse) { + this.dialogErrorSource.next(error.message); + } else { + this.dialogErrorSource.next('An unexpected error occurred.'); + } + }, + complete: () => {}, + }; + } + + protected readonly Object = Object; +} From ab18d1308e8ed39bf66bd13473e17be9eb0926c6 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:54:14 +0100 Subject: [PATCH 17/49] add tooltip in the cleanup-service --- .../cleanup-service.component.html | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.html b/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.html index aa1e021f066e..f53a572ae74c 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.html +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.html @@ -18,6 +18,7 @@

+ @if (operation.name !== 'deleteOrphans') { @@ -60,17 +61,9 @@

} - + } From a2072207d1b936562175a4d71f9abccd7cd74ee6 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:54:42 +0100 Subject: [PATCH 18/49] move methods from cleanup-service.component.ts --- .../cleanup-service.component.ts | 54 +++++-------------- 1 file changed, 14 insertions(+), 40 deletions(-) diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.ts b/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.ts index fab6e37e6217..ddc20979a251 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.ts +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.ts @@ -3,23 +3,26 @@ import dayjs from 'dayjs/esm'; import { CleanupOperation } from 'app/admin/cleanup-service/cleanup-operation.model'; import { convertDateFromServer } from 'app/utils/date.utils'; import { Subject } from 'rxjs'; -import { HttpErrorResponse, HttpResponse } from '@angular/common/http'; +import { HttpResponse } from '@angular/common/http'; import { CleanupServiceExecutionRecordDTO, DataCleanupService } from 'app/admin/cleanup-service/data-cleanup.service'; -import { Observer } from 'rxjs'; import { FormDateTimePickerModule } from 'app/shared/date-time-picker/date-time-picker.module'; import { ArtemisSharedModule } from 'app/shared/shared.module'; +import { ArtemisSharedComponentModule } from 'app/shared/components/shared-component.module'; +import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; +import { CleanupOperationModalComponent } from 'app/admin/cleanup-service/cleanup-operation-modal.component'; @Component({ selector: 'jhi-cleanup-service', templateUrl: './cleanup-service.component.html', standalone: true, - imports: [FormDateTimePickerModule, ArtemisSharedModule], + imports: [FormDateTimePickerModule, ArtemisSharedModule, ArtemisSharedComponentModule], }) export class CleanupServiceComponent implements OnInit { private dialogErrorSource = new Subject(); dialogError = this.dialogErrorSource.asObservable(); private dataCleanupService: DataCleanupService = inject(DataCleanupService); + private modalService: NgbModal = inject(NgbModal); cleanupOperations: CleanupOperation[] = [ { @@ -70,45 +73,16 @@ export class CleanupServiceComponent implements OnInit { }); } - executeCleanupOperation(operation: CleanupOperation): void { - const subscriptionHandler = this.handleResponse(operation); - - switch (operation.name) { - case 'deleteOrphans': - this.dataCleanupService.deleteOrphans().subscribe(subscriptionHandler); - break; - case 'deletePlagiarismComparisons': - this.dataCleanupService.deletePlagiarismComparisons(operation.deleteFrom, operation.deleteTo).subscribe(subscriptionHandler); - break; - case 'deleteNonRatedResults': - this.dataCleanupService.deleteNonRatedResults(operation.deleteFrom, operation.deleteTo).subscribe(subscriptionHandler); - break; - case 'deleteOldRatedResults': - this.dataCleanupService.deleteOldRatedResults(operation.deleteFrom, operation.deleteTo).subscribe(subscriptionHandler); - break; - } - } - - private handleResponse(operation: CleanupOperation): Observer> { - return { - next: (response: HttpResponse) => { - this.dialogErrorSource.next(''); - const executionDateFromServer = convertDateFromServer(response.body!.executionDate); - operation.lastExecuted = executionDateFromServer; - }, - error: (error: any) => { - if (error instanceof HttpErrorResponse) { - this.dialogErrorSource.next(error.message); - } else { - this.dialogErrorSource.next('An unexpected error occurred.'); - } - }, - complete: () => {}, - }; - } - validateDates(operation: CleanupOperation): void { const datesValid = operation.deleteFrom && operation.deleteTo && dayjs(operation.deleteTo).isAfter(dayjs(operation.deleteFrom)); operation.datesValid.set(datesValid); } + + /** + * Handles displaying the modal with operation details and counts. + */ + openCleanupOperationModal(operation: CleanupOperation): void { + const modalRef = this.modalService.open(CleanupOperationModalComponent, { size: 'lg', backdrop: 'static' }); + modalRef.componentInstance.operation = operation; + } } From 211cc9ebd4cc0bd8e37561e441adcc0835cad6ef Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Sat, 16 Nov 2024 12:55:09 +0100 Subject: [PATCH 19/49] add english translations --- src/main/webapp/i18n/en/cleanupService.json | 40 +++++++++++++++++++-- 1 file changed, 37 insertions(+), 3 deletions(-) diff --git a/src/main/webapp/i18n/en/cleanupService.json b/src/main/webapp/i18n/en/cleanupService.json index 569ca3932aa1..40230bbecdcc 100644 --- a/src/main/webapp/i18n/en/cleanupService.json +++ b/src/main/webapp/i18n/en/cleanupService.json @@ -10,18 +10,52 @@ "operation": { "deleteOrphans": "Delete orphans", "deletePlagiarismComparisons": "Delete plagiarism comparisons", - "deleteNonRatedResults": "Delete non-rated results", - "deleteOldRatedResults": "Delete old rated results", + "deleteNonRatedResults": "Delete feedback of old non-rated results", + "deleteOldRatedResults": "Delete feedback of old rated results", + "deleteOldSubmissionVersions": "Delete old submission versions", + "deleteOldFeedback": "Delete old feedback versions" + }, + "tooltip": { + "deleteOrphans": "Deletes orphaned entities that are no longer associated with valid results or participations. This includes feedback, text blocks, and scores that reference null results, participations, or submissions", + "deletePlagiarismComparisons": "Deletes plagiarism comparisons with a status of \"None\" that belong to courses within the specified date range.", + "deleteNonRatedResults": "Deletes non-rated results, excluding the latest non-rated result for each participation (to be able to compute Competencies Scores), within the specified date range, along with associated long feedback texts, text blocks, feedback items, and participant scores.", + "deleteOldRatedResults": "Deletes rated results, excluding the latest rated result for each participation, for courses conducted within the specified date range. Also deletes associated long feedback texts, text blocks, feedback items, and participant scores.", "deleteOldSubmissionVersions": "Delete old submission versions", "deleteOldFeedback": "Delete old feedback versions" }, "execute": { - "question": "Are you sure you want to execute the operation {{ title }}? This action can NOT be undone!", + "question": "Are you sure you want to execute the operation {{ operationName }} for the period from {{deleteFrom}} to {{deleteTo}}? This action cannot be undone!? This action can NOT be undone!", "typeOperationNameToConfirm": "Please type in the name of the operation to confirm." }, + "modal": { + "affectedEntities": "This operation will delete the following entities:" + }, "notRunYet": "This operation has not been run yet", "error": { "datesInvalid": "'Delete to' must be after 'Delete from'" + }, + "entities": { + "orphanFeedback": "Orphan feedback", + "orphanLongFeedbackText": "Orphan long feedback text", + "orphanTextBlock": "Orphan text block", + "orphanStudentScore": "Orphan student score", + "orphanTeamScore": "Orphan team score", + "orphanFeedbackForOrphanResults": "Orphan feedback for orphan results", + "orphanLongFeedbackTextForOrphanResults": "Orphan long feedback text for orphan results", + "orphanTextBlockForOrphanResults": "Orphan text block for orphan results", + "orphanRating": "Orphan rating", + "orphanResultsWithoutParticipation": "Orphan results without participation", + "plagiarismComparison": "Plagiarism comparisons", + "plagiarismElements": "Plagiarism elements", + "plagiarismSubmissions": "Plagiarism submissions", + "plagiarismMatches": "Plagiarism matches", + "longFeedbackText": "Long feedback text", + "textBlock": "Text block", + "feedback": "Feedback" + }, + "button": { + "execute": "Execute", + "close": "Close" } } } From cee76927cf3d2e64f1f27f806ad9185c41b139f6 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Tue, 26 Nov 2024 22:15:52 +0100 Subject: [PATCH 20/49] add german translations --- src/main/webapp/i18n/de/cleanupService.json | 38 ++++++++++++++++++++- src/main/webapp/i18n/en/cleanupService.json | 6 ++-- 2 files changed, 41 insertions(+), 3 deletions(-) diff --git a/src/main/webapp/i18n/de/cleanupService.json b/src/main/webapp/i18n/de/cleanupService.json index aa509515921c..2eae50b5df54 100644 --- a/src/main/webapp/i18n/de/cleanupService.json +++ b/src/main/webapp/i18n/de/cleanupService.json @@ -15,13 +15,49 @@ "deleteOldSubmissionVersions": "Alte Teilnahmeversionen löschen", "deleteOldFeedback": "Altes Feedback löschen" }, + "tooltip": { + "deleteOrphans": "Löscht verwaiste Entitäten, die nicht mehr mit gültigen Ergebnissen oder Teilnahmen verbunden sind. Dazu gehören Feedback, Textblöcke und Bewertungen, die sich auf ungültige Ergebnisse, Teilnahmen oder Einreichungen beziehen.", + "deletePlagiarismComparisons": "Löscht Plagiatsvergleiche mit dem Status 'Keine', die zu Kursen innerhalb des angegebenen Datumsbereichs gehören.", + "deleteNonRatedResults": "Löscht nicht bewertete Ergebnisse, mit Ausnahme des neuesten nicht bewerteten Ergebnisses für jede Teilnahme (um Kompetenzergebnisse berechnen zu können), innerhalb des angegebenen Datumsbereichs, zusammen mit zugehörigen langen Feedback-Texten, Textblöcken, Feedback-Elementen und Teilnehmerbewertungen.", + "deleteOldRatedResults": "Löscht bewertete Ergebnisse, mit Ausnahme des neuesten bewerteten Ergebnisses für jede Teilnahme, für Kurse, die innerhalb des angegebenen Datumsbereichs durchgeführt wurden. Löscht auch zugehörige lange Feedback-Texte, Textblöcke, Feedback-Elemente und Teilnehmerbewertungen.", + "deleteOldSubmissionVersions": "Löscht alte Teilnahmeversionen.", + "deleteOldFeedback": "Löscht alte Feedback-Versionen." + }, "execute": { - "question": "Bist du sicher, dass du die Operation {{ title }} ausführen möchtest? Diese Aktion kann NICHT rückgängig gemacht werden!", + "question": "Bist du sicher, dass du die Operation {{ operationName }} für den Zeitraum von {{deleteFrom}} bis {{deleteTo}} ausführen möchtest? Diese Aktion kann NICHT rückgängig gemacht werden!", + "questionWithoutDates": "Bist du sicher, dass du die Operation {{ operationName }} ausführen möchtest? Diese Aktion kann NICHT rückgängig gemacht werden!", "typeOperationNameToConfirm": "Bitte gib den Namen der Operation ein, um zu bestätigen." }, + "modal": { + "affectedEntities": "Diese Operation wird die folgenden Entitäten löschen:", + "noEntriesToDelete": "Keine Einträge zum Löschen vorhanden." + }, "notRunYet": "Diese Operation wurde noch nicht ausgeführt", "error": { "datesInvalid": "'Löschen bis' muss nach 'Löschen von' liegen" + }, + "entities": { + "orphanFeedback": "Verwaistes Feedback", + "orphanLongFeedbackText": "Verwaister langer Feedback-Text", + "orphanTextBlock": "Verwaister Textblock", + "orphanStudentScore": "Verwaiste Studentenbewertung", + "orphanTeamScore": "Verwaiste Teambewertung", + "orphanFeedbackForOrphanResults": "Verwaistes Feedback für verwaiste Ergebnisse", + "orphanLongFeedbackTextForOrphanResults": "Verwaister langer Feedback-Text für verwaiste Ergebnisse", + "orphanTextBlockForOrphanResults": "Verwaister Textblock für verwaiste Ergebnisse", + "orphanRating": "Verwaiste Bewertung", + "orphanResultsWithoutParticipation": "Verwaiste Ergebnisse ohne Teilnahme", + "plagiarismComparison": "Plagiatsvergleiche", + "plagiarismElements": "Plagiatselemente", + "plagiarismSubmissions": "Plagiatseingaben", + "plagiarismMatches": "Plagiatsübereinstimmungen", + "longFeedbackText": "Langer Feedback-Text", + "textBlock": "Textblock", + "feedback": "Feedback" + }, + "button": { + "execute": "Ausführen", + "close": "Schließen" } } } diff --git a/src/main/webapp/i18n/en/cleanupService.json b/src/main/webapp/i18n/en/cleanupService.json index 40230bbecdcc..601af4cb3fc7 100644 --- a/src/main/webapp/i18n/en/cleanupService.json +++ b/src/main/webapp/i18n/en/cleanupService.json @@ -24,11 +24,13 @@ "deleteOldFeedback": "Delete old feedback versions" }, "execute": { - "question": "Are you sure you want to execute the operation {{ operationName }} for the period from {{deleteFrom}} to {{deleteTo}}? This action cannot be undone!? This action can NOT be undone!", + "question": "Are you sure you want to execute the operation {{ operationName }} for the period from {{deleteFrom}} to {{deleteTo}}? This action cannot be undone!", + "questionWithoutDates": "Are you sure you want to execute the operation {{ operationName }}? This action cannot be undone!", "typeOperationNameToConfirm": "Please type in the name of the operation to confirm." }, "modal": { - "affectedEntities": "This operation will delete the following entities:" + "affectedEntities": "This operation will delete the following entities:", + "noEntriesToDelete": "No entries to delete." }, "notRunYet": "This operation has not been run yet", "error": { From be7224cd59b2227d748687bf4db92ff1d236abfd Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Tue, 26 Nov 2024 22:16:12 +0100 Subject: [PATCH 21/49] disable button if there are no entities to delete --- .../cleanup-operation-modal.component.html | 42 ++++--- .../cleanup-operation-modal.component.ts | 104 +++++++++--------- 2 files changed, 81 insertions(+), 65 deletions(-) diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html index c183dc28cf6b..99149b61e4a0 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html @@ -3,34 +3,46 @@

-

+ @if (operation.name === 'deleteOrphans') { +

+ } @else { +

+ }

    - @for (key of cleanupKeys(beforeExecutionCounts); track key) { + @for (key of cleanupKeys(counts); track key) {
  • - : {{ beforeExecutionCounts[key] }} - @if (afterExecutionCounts) { - @if (beforeExecutionCounts[key] > afterExecutionCounts[key]) { - + : {{ counts[key] }} + @if (operationExecuted) { + @if (counts[key] > 0) { + } @else { - + } }
    • }
+ @if (!hasEntriesToDelete) { +

+ }
- +
diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts index 445997dd88be..f6369c4fd80a 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts @@ -2,11 +2,10 @@ import { HttpErrorResponse, HttpResponse } from '@angular/common/http'; import { Component, Input, OnInit, inject } from '@angular/core'; import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; import { CleanupOperation } from 'app/admin/cleanup-service/cleanup-operation.model'; -import { CleanupCount, CleanupServiceExecutionRecordDTO, DataCleanupService } from 'app/admin/cleanup-service/data-cleanup.service'; +import { CleanupCount, DataCleanupService } from 'app/admin/cleanup-service/data-cleanup.service'; import { TranslateDirective } from 'app/shared/language/translate.directive'; import { ArtemisSharedModule } from 'app/shared/shared.module'; -import { convertDateFromServer } from 'app/utils/date.utils'; -import { Observable, Observer, Subject } from 'rxjs'; +import { Observable, Subject } from 'rxjs'; import { faCheckCircle, faTimes } from '@fortawesome/free-solid-svg-icons'; @Component({ @@ -17,8 +16,8 @@ import { faCheckCircle, faTimes } from '@fortawesome/free-solid-svg-icons'; }) export class CleanupOperationModalComponent implements OnInit { @Input() operation: CleanupOperation; - beforeExecutionCounts: CleanupCount; - afterExecutionCounts: CleanupCount | undefined = undefined; + counts: CleanupCount; + operationExecuted = false; // Tracks whether the operation has been executed. private dialogErrorSource = new Subject(); dialogError = this.dialogErrorSource.asObservable(); @@ -26,89 +25,94 @@ export class CleanupOperationModalComponent implements OnInit { public activeModal: NgbActiveModal = inject(NgbActiveModal); private dataCleanupService: DataCleanupService = inject(DataCleanupService); - // Icons faTimes = faTimes; faCheckCircle = faCheckCircle; + /** + * Fetch keys from the CleanupCount object for iteration. + */ cleanupKeys(counts: CleanupCount): (keyof CleanupCount)[] { return Object.keys(counts) as (keyof CleanupCount)[]; } + /** + * Close the modal. + */ close(): void { this.activeModal.close(); } + /** + * Initialize component: fetch initial counts for the operation. + */ ngOnInit(): void { - this.fetchOperationCounts(this.operation).subscribe({ - next: (response: HttpResponse) => { - this.beforeExecutionCounts = response.body!; - }, - error: () => this.dialogErrorSource.next('An unexpected error occurred.'), - }); + this.updateCounts(); } + /** + * Execute the cleanup operation and update counts afterward. + */ executeCleanupOperation(): void { - const subscriptionHandler = this.handleResponse(this.operation); + const operationHandler = { + next: () => { + this.operationExecuted = true; // Mark operation as executed. + this.updateCounts(); + }, + error: (error: any) => { + this.dialogErrorSource.next(error instanceof HttpErrorResponse ? error.message : 'An unexpected error occurred.'); + }, + }; switch (this.operation.name) { case 'deleteOrphans': - this.dataCleanupService.deleteOrphans().subscribe(subscriptionHandler); + this.dataCleanupService.deleteOrphans().subscribe(operationHandler); break; case 'deletePlagiarismComparisons': - this.dataCleanupService.deletePlagiarismComparisons(this.operation.deleteFrom, this.operation.deleteTo).subscribe(subscriptionHandler); + this.dataCleanupService.deletePlagiarismComparisons(this.operation.deleteFrom, this.operation.deleteTo).subscribe(operationHandler); break; case 'deleteNonRatedResults': - this.dataCleanupService.deleteNonRatedResults(this.operation.deleteFrom, this.operation.deleteTo).subscribe(subscriptionHandler); + this.dataCleanupService.deleteNonRatedResults(this.operation.deleteFrom, this.operation.deleteTo).subscribe(operationHandler); break; case 'deleteOldRatedResults': - this.dataCleanupService.deleteOldRatedResults(this.operation.deleteFrom, this.operation.deleteTo).subscribe(subscriptionHandler); + this.dataCleanupService.deleteOldRatedResults(this.operation.deleteFrom, this.operation.deleteTo).subscribe(operationHandler); break; } } - private fetchOperationCounts(operation: CleanupOperation): Observable> { - switch (operation.name) { + /** + * Fetch counts for the operation. + */ + private fetchCounts(): Observable> { + switch (this.operation.name) { case 'deleteOrphans': return this.dataCleanupService.countOrphans(); case 'deletePlagiarismComparisons': - return this.dataCleanupService.countPlagiarismComparisons(operation.deleteFrom, operation.deleteTo); + return this.dataCleanupService.countPlagiarismComparisons(this.operation.deleteFrom, this.operation.deleteTo); case 'deleteNonRatedResults': - return this.dataCleanupService.countNonRatedResults(operation.deleteFrom, operation.deleteTo); + return this.dataCleanupService.countNonRatedResults(this.operation.deleteFrom, this.operation.deleteTo); case 'deleteOldRatedResults': - return this.dataCleanupService.countOldRatedResults(operation.deleteFrom, operation.deleteTo); + return this.dataCleanupService.countOldRatedResults(this.operation.deleteFrom, this.operation.deleteTo); default: - throw new Error(`Unsupported operation name: ${operation.name}`); + throw new Error(`Unsupported operation: ${this.operation.name}`); } } - private handleResponse(operation: CleanupOperation): Observer> { - return { - next: (response: HttpResponse) => { - this.dialogErrorSource.next(''); - const executionDateFromServer = convertDateFromServer(response.body!.executionDate); - operation.lastExecuted = executionDateFromServer; - this.fetchOperationCounts(operation).subscribe({ - next: (countResponse: HttpResponse) => { - if (this.afterExecutionCounts) { - this.beforeExecutionCounts = this.afterExecutionCounts; - } - this.afterExecutionCounts = countResponse.body!; - }, - error: () => { - this.dialogErrorSource.next('An error occurred while fetching post-execution counts.'); - }, - }); - }, - error: (error: any) => { - if (error instanceof HttpErrorResponse) { - this.dialogErrorSource.next(error.message); - } else { - this.dialogErrorSource.next('An unexpected error occurred.'); - } + /** + * Fetch updated counts after operation execution. + */ + private updateCounts(): void { + this.fetchCounts().subscribe({ + next: (response: HttpResponse) => { + this.counts = response.body!; }, - complete: () => {}, - }; + error: () => this.dialogErrorSource.next('An error occurred while fetching updated counts.'), + }); } - protected readonly Object = Object; + /** + * Getter to check if there are any entries to delete. + */ + get hasEntriesToDelete(): boolean { + return Object.values(this.counts).some((count) => count > 0); + } } From 61ea65fdde131f850f2ce436372f6cc4e4e57f79 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Tue, 26 Nov 2024 23:29:10 +0100 Subject: [PATCH 22/49] add count methods integration tests --- .../artemis/core/CleanupIntegrationTest.java | 47 +++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/src/test/java/de/tum/cit/aet/artemis/core/CleanupIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/core/CleanupIntegrationTest.java index 9b0fc4767270..3fe8d4ab7486 100644 --- a/src/test/java/de/tum/cit/aet/artemis/core/CleanupIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/core/CleanupIntegrationTest.java @@ -38,6 +38,10 @@ import de.tum.cit.aet.artemis.core.domain.Language; import de.tum.cit.aet.artemis.core.domain.User; import de.tum.cit.aet.artemis.core.dto.CleanupServiceExecutionRecordDTO; +import de.tum.cit.aet.artemis.core.dto.NonLatestNonRatedResultsCleanupCountDTO; +import de.tum.cit.aet.artemis.core.dto.NonLatestRatedResultsCleanupCountDTO; +import de.tum.cit.aet.artemis.core.dto.OrphanCleanupCountDTO; +import de.tum.cit.aet.artemis.core.dto.PlagiarismComparisonCleanupCountDTO; import de.tum.cit.aet.artemis.core.repository.cleanup.CleanupJobExecutionRepository; import de.tum.cit.aet.artemis.core.test_repository.CourseTestRepository; import de.tum.cit.aet.artemis.exercise.domain.Submission; @@ -214,6 +218,20 @@ void testDeleteOrphans() throws Exception { orphanRating.setResult(orphanResult); orphanRating = ratingRepository.save(orphanRating); + var counts = request.get("/api/admin/cleanup/orphans/count", HttpStatus.OK, OrphanCleanupCountDTO.class); + + assertThat(counts).isNotNull(); + assertThat(counts.orphanFeedback()).isEqualTo(0); + assertThat(counts.orphanLongFeedbackText()).isEqualTo(0); + assertThat(counts.orphanTextBlock()).isEqualTo(0); + assertThat(counts.orphanStudentScore()).isEqualTo(1); + assertThat(counts.orphanTeamScore()).isEqualTo(1); + assertThat(counts.orphanFeedbackForOrphanResults()).isEqualTo(1); + assertThat(counts.orphanLongFeedbackTextForOrphanResults()).isEqualTo(1); + assertThat(counts.orphanTextBlockForOrphanResults()).isEqualTo(1); + assertThat(counts.orphanRating()).isEqualTo(1); + assertThat(counts.orphanResultsWithoutParticipation()).isEqualTo(1); + var responseBody = request.delete("/api/admin/cleanup/orphans", new LinkedMultiValueMap<>(), null, CleanupServiceExecutionRecordDTO.class, HttpStatus.OK); assertThat(responseBody.jobType()).isEqualTo("deleteOrphans"); @@ -268,6 +286,15 @@ void testDeletePlagiarismComparisons() throws Exception { LinkedMultiValueMap params = new LinkedMultiValueMap<>(); params.add("deleteFrom", DELETE_FROM.toString()); params.add("deleteTo", DELETE_TO.toString()); + + var counts = request.get("/api/admin/cleanup/plagiarism-comparisons/count", HttpStatus.OK, PlagiarismComparisonCleanupCountDTO.class, params); + + assertThat(counts).isNotNull(); + assertThat(counts.plagiarismComparison()).isEqualTo(1); + assertThat(counts.plagiarismElements()).isEqualTo(0); + assertThat(counts.plagiarismMatches()).isEqualTo(1); + assertThat(counts.plagiarismSubmissions()).isEqualTo(2); + var responseBody = request.delete("/api/admin/cleanup/plagiarism-comparisons", params, null, CleanupServiceExecutionRecordDTO.class, HttpStatus.OK); assertThat(responseBody.jobType()).isEqualTo("deletePlagiarismComparisons"); @@ -385,6 +412,14 @@ void testDeleteNonRatedResults() throws Exception { LinkedMultiValueMap params = new LinkedMultiValueMap<>(); params.add("deleteFrom", DELETE_FROM.toString()); params.add("deleteTo", DELETE_TO.toString()); + + var counts = request.get("/api/admin/cleanup/non-rated-results/count", HttpStatus.OK, NonLatestNonRatedResultsCleanupCountDTO.class, params); + + assertThat(counts).isNotNull(); + assertThat(counts.longFeedbackText()).isEqualTo(1); + assertThat(counts.textBlock()).isEqualTo(1); + assertThat(counts.feedback()).isEqualTo(1); + var responseBody = request.delete("/api/admin/cleanup/non-rated-results", params, null, CleanupServiceExecutionRecordDTO.class, HttpStatus.OK); assertThat(responseBody.jobType()).isEqualTo("deleteNonRatedResults"); @@ -475,6 +510,14 @@ void testDeleteOldRatedResults() throws Exception { LinkedMultiValueMap params = new LinkedMultiValueMap<>(); params.add("deleteFrom", DELETE_FROM.toString()); params.add("deleteTo", DELETE_TO.toString()); + + var counts = request.get("/api/admin/cleanup/old-rated-results/count", HttpStatus.OK, NonLatestRatedResultsCleanupCountDTO.class, params); + + assertThat(counts).isNotNull(); + assertThat(counts.longFeedbackText()).isEqualTo(1); + assertThat(counts.textBlock()).isEqualTo(1); + assertThat(counts.feedback()).isEqualTo(1); + var responseBody = request.delete("/api/admin/cleanup/old-rated-results", params, null, CleanupServiceExecutionRecordDTO.class, HttpStatus.OK); assertThat(responseBody.jobType()).isEqualTo("deleteRatedResults"); @@ -529,9 +572,13 @@ void testGetLastExecutions() throws Exception { @WithMockUser(roles = "USER") void testUnauthorizedAccess() throws Exception { request.postWithoutResponseBody("/api/admin/cleanup/orphans", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); + request.postWithoutResponseBody("/api/admin/cleanup/orphans/count", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); request.postWithoutResponseBody("/api/admin/cleanup/plagiarism-comparisons", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); + request.postWithoutResponseBody("/api/admin/cleanup/plagiarism-comparisons/count", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); request.postWithoutResponseBody("/api/admin/cleanup/non-rated-results", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); + request.postWithoutResponseBody("/api/admin/cleanup/non-rated-results/count", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); request.postWithoutResponseBody("/api/admin/cleanup/old-rated-results", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); + request.postWithoutResponseBody("/api/admin/cleanup/old-rated-results/count", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); request.get("/api/admin/cleanup/last-executions", HttpStatus.FORBIDDEN, List.class); } From e21f8eb21adececb2f5eb399a8eb1e9dc5455f73 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Wed, 27 Nov 2024 11:33:20 +0100 Subject: [PATCH 23/49] update clenaup-service.service.spec.ts --- .../cleanup-service.service.spec.ts | 111 +++++++++++++++++- 1 file changed, 110 insertions(+), 1 deletion(-) diff --git a/src/test/javascript/spec/component/admin/cleanup-service/cleanup-service.service.spec.ts b/src/test/javascript/spec/component/admin/cleanup-service/cleanup-service.service.spec.ts index f64609872275..a19ef923b0fe 100644 --- a/src/test/javascript/spec/component/admin/cleanup-service/cleanup-service.service.spec.ts +++ b/src/test/javascript/spec/component/admin/cleanup-service/cleanup-service.service.spec.ts @@ -1,7 +1,14 @@ import { TestBed } from '@angular/core/testing'; import { HttpTestingController, provideHttpClientTesting } from '@angular/common/http/testing'; import dayjs from 'dayjs/esm'; -import { CleanupServiceExecutionRecordDTO, DataCleanupService } from 'app/admin/cleanup-service/data-cleanup.service'; +import { + CleanupServiceExecutionRecordDTO, + DataCleanupService, + NonLatestNonRatedResultsCleanupCountDTO, + NonLatestRatedResultsCleanupCountDTO, + OrphanCleanupCountDTO, + PlagiarismComparisonCleanupCountDTO, +} from 'app/admin/cleanup-service/data-cleanup.service'; import { provideHttpClient } from '@angular/common/http'; describe('DataCleanupService', () => { @@ -10,6 +17,41 @@ describe('DataCleanupService', () => { const mockDate = dayjs(); const mockExecutionRecord: CleanupServiceExecutionRecordDTO = { executionDate: mockDate, jobType: 'deleteOrphans' }; + const mockOrphanCount: OrphanCleanupCountDTO = { + totalCount: 10, + orphanFeedback: 2, + orphanLongFeedbackText: 3, + orphanTextBlock: 1, + orphanStudentScore: 1, + orphanTeamScore: 1, + orphanFeedbackForOrphanResults: 0, + orphanLongFeedbackTextForOrphanResults: 0, + orphanTextBlockForOrphanResults: 0, + orphanRating: 2, + orphanResultsWithoutParticipation: 0, + }; + + const mockPlagiarismCount: PlagiarismComparisonCleanupCountDTO = { + totalCount: 5, + plagiarismComparison: 3, + plagiarismElements: 1, + plagiarismSubmissions: 1, + plagiarismMatches: 0, + }; + + const mockNonRatedResultsCount: NonLatestNonRatedResultsCleanupCountDTO = { + totalCount: 4, + longFeedbackText: 1, + textBlock: 2, + feedback: 1, + }; + + const mockRatedResultsCount: NonLatestRatedResultsCleanupCountDTO = { + totalCount: 7, + longFeedbackText: 2, + textBlock: 3, + feedback: 2, + }; beforeEach(() => { TestBed.configureTestingModule({ @@ -103,4 +145,71 @@ describe('DataCleanupService', () => { expect(req.request.method).toBe('GET'); req.flush(mockExecutionRecords); }); + + it('should send GET request to count orphans', () => { + service.countOrphans().subscribe((res) => { + expect(res.body).toEqual(mockOrphanCount); + }); + + const req = httpMock.expectOne({ method: 'GET', url: 'api/admin/cleanup/orphans/count' }); + expect(req.request.method).toBe('GET'); + req.flush(mockOrphanCount); + }); + + it('should send GET request to count plagiarism comparisons with date range', () => { + const deleteFrom = '2024-03-07T13:06:36.100Z'; + const deleteTo = '2024-03-08T13:06:36.100Z'; + + service.countPlagiarismComparisons(dayjs(deleteFrom), dayjs(deleteTo)).subscribe((res) => { + expect(res.body).toEqual(mockPlagiarismCount); + }); + + const req = httpMock.expectOne({ + method: 'GET', + url: `api/admin/cleanup/plagiarism-comparisons/count?deleteFrom=${deleteFrom}&deleteTo=${deleteTo}`, + }); + + expect(req.request.method).toBe('GET'); + expect(req.request.params.get('deleteFrom')).toBe(deleteFrom); + expect(req.request.params.get('deleteTo')).toBe(deleteTo); + req.flush(mockPlagiarismCount); + }); + + it('should send GET request to count non-rated results with date range', () => { + const deleteFrom = '2024-03-07T13:06:36.100Z'; + const deleteTo = '2024-03-08T13:06:36.100Z'; + + service.countNonRatedResults(dayjs(deleteFrom), dayjs(deleteTo)).subscribe((res) => { + expect(res.body).toEqual(mockNonRatedResultsCount); + }); + + const req = httpMock.expectOne({ + method: 'GET', + url: `api/admin/cleanup/non-rated-results/count?deleteFrom=${deleteFrom}&deleteTo=${deleteTo}`, + }); + + expect(req.request.method).toBe('GET'); + expect(req.request.params.get('deleteFrom')).toBe(deleteFrom); + expect(req.request.params.get('deleteTo')).toBe(deleteTo); + req.flush(mockNonRatedResultsCount); + }); + + it('should send GET request to count old rated results with date range', () => { + const deleteFrom = '2024-03-07T13:06:36.100Z'; + const deleteTo = '2024-03-08T13:06:36.100Z'; + + service.countOldRatedResults(dayjs(deleteFrom), dayjs(deleteTo)).subscribe((res) => { + expect(res.body).toEqual(mockRatedResultsCount); + }); + + const req = httpMock.expectOne({ + method: 'GET', + url: `api/admin/cleanup/old-rated-results/count?deleteFrom=${deleteFrom}&deleteTo=${deleteTo}`, + }); + + expect(req.request.method).toBe('GET'); + expect(req.request.params.get('deleteFrom')).toBe(deleteFrom); + expect(req.request.params.get('deleteTo')).toBe(deleteTo); + req.flush(mockRatedResultsCount); + }); }); From f74abe9e14dd49ad166ecd92b2801b817f3d6b79 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Wed, 27 Nov 2024 12:19:10 +0100 Subject: [PATCH 24/49] adjust cleanup-service.component.spec.ts --- .../cleanup-service.component.spec.ts | 58 +++---------------- 1 file changed, 7 insertions(+), 51 deletions(-) diff --git a/src/test/javascript/spec/component/admin/cleanup-service/cleanup-service.component.spec.ts b/src/test/javascript/spec/component/admin/cleanup-service/cleanup-service.component.spec.ts index 271315ee64a0..22d1de73d878 100644 --- a/src/test/javascript/spec/component/admin/cleanup-service/cleanup-service.component.spec.ts +++ b/src/test/javascript/spec/component/admin/cleanup-service/cleanup-service.component.spec.ts @@ -1,6 +1,6 @@ import { ComponentFixture, TestBed } from '@angular/core/testing'; -import { of, throwError } from 'rxjs'; -import { HttpErrorResponse, HttpResponse } from '@angular/common/http'; +import { of } from 'rxjs'; +import { HttpResponse } from '@angular/common/http'; import dayjs from 'dayjs/esm'; import { ArtemisTestModule } from '../../../test.module'; @@ -17,24 +17,16 @@ describe('CleanupServiceComponent', () => { beforeEach(() => { const mockCleanupService = { getLastExecutions: jest.fn(), - deleteOrphans: jest.fn(), - deletePlagiarismComparisons: jest.fn(), - deleteNonRatedResults: jest.fn(), - deleteOldRatedResults: jest.fn(), - deleteOldSubmissionVersions: jest.fn(), - deleteOldFeedback: jest.fn(), }; TestBed.configureTestingModule({ imports: [ArtemisTestModule, CleanupServiceComponent], providers: [{ provide: DataCleanupService, useValue: mockCleanupService }], - }) - .compileComponents() - .then(() => { - fixture = TestBed.createComponent(CleanupServiceComponent); - comp = fixture.componentInstance; - cleanupService = TestBed.inject(DataCleanupService); - }); + }).compileComponents(); + + fixture = TestBed.createComponent(CleanupServiceComponent); + comp = fixture.componentInstance; + cleanupService = TestBed.inject(DataCleanupService); }); it('should load last executions on init', () => { @@ -51,42 +43,6 @@ describe('CleanupServiceComponent', () => { expect(comp.cleanupOperations[0].lastExecuted).toEqual(dayjs(executionRecord[0].executionDate)); }); - it('should execute a cleanup operation successfully', () => { - const operation = comp.cleanupOperations[0]; - const response = new HttpResponse({ - body: { executionDate: dayjs(), jobType: 'deleteOrphans' }, - }); - - jest.spyOn(cleanupService, 'deleteOrphans').mockReturnValue(of(response)); - - comp.executeCleanupOperation(operation); - - expect(cleanupService.deleteOrphans).toHaveBeenCalledOnce(); - expect(operation.lastExecuted).toEqual(dayjs(response.body!.executionDate)); - }); - - it('should handle error when executing cleanup operation', () => { - const operation = comp.cleanupOperations[0]; - const errorResponse = new HttpErrorResponse({ - status: 500, - statusText: 'Internal Server Error', - error: 'Some error message', - url: 'https://artemis.ase.in.tum.de/api/admin/orphans', // Adding a mock URL - }); - - jest.spyOn(cleanupService, 'deleteOrphans').mockReturnValue(throwError(() => errorResponse)); - - let errorMessage: string | undefined; - comp.dialogError.subscribe((error) => { - errorMessage = error; - }); - - comp.executeCleanupOperation(operation); - - expect(cleanupService.deleteOrphans).toHaveBeenCalledOnce(); - expect(errorMessage).toBe('Http failure response for https://artemis.ase.in.tum.de/api/admin/orphans: 500 Internal Server Error'); - }); - it('should validate date ranges correctly', () => { const validOperation: CleanupOperation = { name: 'deleteOrphans', From 6c74d9679c438c0a81e98afcbda60f20ca247fa5 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Wed, 27 Nov 2024 12:20:43 +0100 Subject: [PATCH 25/49] change @Input to input<> --- .../cleanup-service/cleanup-operation-modal.component.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts index f6369c4fd80a..da10f78e4626 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts @@ -1,5 +1,5 @@ import { HttpErrorResponse, HttpResponse } from '@angular/common/http'; -import { Component, Input, OnInit, inject } from '@angular/core'; +import { Component, OnInit, inject, input } from '@angular/core'; import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; import { CleanupOperation } from 'app/admin/cleanup-service/cleanup-operation.model'; import { CleanupCount, DataCleanupService } from 'app/admin/cleanup-service/data-cleanup.service'; @@ -15,7 +15,7 @@ import { faCheckCircle, faTimes } from '@fortawesome/free-solid-svg-icons'; imports: [TranslateDirective, ArtemisSharedModule], }) export class CleanupOperationModalComponent implements OnInit { - @Input() operation: CleanupOperation; + operation = input; counts: CleanupCount; operationExecuted = false; // Tracks whether the operation has been executed. @@ -55,7 +55,7 @@ export class CleanupOperationModalComponent implements OnInit { executeCleanupOperation(): void { const operationHandler = { next: () => { - this.operationExecuted = true; // Mark operation as executed. + this.operationExecuted = true; this.updateCounts(); }, error: (error: any) => { From 30198256ea931132dd3853dfba275a4d695170cc Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Wed, 27 Nov 2024 12:21:14 +0100 Subject: [PATCH 26/49] add modal test --- .../cleanup-oparation-modal.component.spec.ts | 145 ++++++++++++++++++ 1 file changed, 145 insertions(+) create mode 100644 src/test/javascript/spec/component/admin/cleanup-service/cleanup-oparation-modal.component.spec.ts diff --git a/src/test/javascript/spec/component/admin/cleanup-service/cleanup-oparation-modal.component.spec.ts b/src/test/javascript/spec/component/admin/cleanup-service/cleanup-oparation-modal.component.spec.ts new file mode 100644 index 000000000000..4e6ca9b88576 --- /dev/null +++ b/src/test/javascript/spec/component/admin/cleanup-service/cleanup-oparation-modal.component.spec.ts @@ -0,0 +1,145 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { HttpErrorResponse, HttpResponse } from '@angular/common/http'; +import { of, throwError } from 'rxjs'; +import dayjs from 'dayjs/esm'; +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; +import { CleanupOperationModalComponent } from 'app/admin/cleanup-service/cleanup-operation-modal.component'; +import { CleanupCount, DataCleanupService } from 'app/admin/cleanup-service/data-cleanup.service'; +import { TranslateDirective } from 'app/shared/language/translate.directive'; +import { ArtemisSharedModule } from 'app/shared/shared.module'; +import { signal } from '@angular/core'; +import { MockDirective } from 'ng-mocks'; +import { MockTranslateService } from '../../../helpers/mocks/service/mock-translate.service'; +import { TranslateService } from '@ngx-translate/core'; + +describe('CleanupOperationModalComponent', () => { + let comp: CleanupOperationModalComponent; + let fixture: ComponentFixture; + let cleanupService: DataCleanupService; + let activeModal: NgbActiveModal; + + const mockCleanupService = { + deleteOrphans: jest.fn(), + deletePlagiarismComparisons: jest.fn(), + deleteNonRatedResults: jest.fn(), + deleteOldRatedResults: jest.fn(), + countOrphans: jest.fn(), + countPlagiarismComparisons: jest.fn(), + countNonRatedResults: jest.fn(), + countOldRatedResults: jest.fn(), + }; + + const mockActiveModal = { + close: jest.fn(), + }; + + beforeEach(() => { + TestBed.configureTestingModule({ + imports: [CleanupOperationModalComponent, ArtemisSharedModule], + declarations: [MockDirective(TranslateDirective)], + providers: [ + { provide: DataCleanupService, useValue: mockCleanupService }, + { provide: NgbActiveModal, useValue: mockActiveModal }, + { provide: TranslateService, useClass: MockTranslateService }, + ], + }) + .compileComponents() + .then(() => { + fixture = TestBed.createComponent(CleanupOperationModalComponent); + comp = fixture.componentInstance; + cleanupService = TestBed.inject(DataCleanupService); + activeModal = TestBed.inject(NgbActiveModal); + }); + }); + + afterEach(() => { + jest.clearAllMocks(); + }); + + it('should initialize and fetch counts on init', () => { + const mockCounts: CleanupCount = { totalCount: 10 }; + jest.spyOn(cleanupService, 'countOrphans').mockReturnValue(of(new HttpResponse({ body: mockCounts }))); + + comp.operation = { + name: 'deleteOrphans', + deleteFrom: dayjs().subtract(6, 'months'), + deleteTo: dayjs(), + lastExecuted: undefined, + datesValid: signal(true), + }; + fixture.detectChanges(); + + expect(cleanupService.countOrphans).toHaveBeenCalledOnce(); + expect(comp.counts).toEqual(mockCounts); + }); + + it('should execute cleanup operation successfully', () => { + const mockResponse: HttpResponse = new HttpResponse({ + body: { executionDate: dayjs(), jobType: 'deleteOrphans' }, + }); + + const mockCounts: CleanupCount = { totalCount: 5 }; + jest.spyOn(cleanupService, 'deleteOrphans').mockReturnValue(of(mockResponse)); + jest.spyOn(cleanupService, 'countOrphans').mockReturnValue(of(new HttpResponse({ body: mockCounts }))); + + comp.operation = { + name: 'deleteOrphans', + deleteFrom: dayjs().subtract(6, 'months'), + deleteTo: dayjs(), + lastExecuted: undefined, + datesValid: signal(true), + }; + + comp.executeCleanupOperation(); + + expect(cleanupService.deleteOrphans).toHaveBeenCalledOnce(); + expect(cleanupService.countOrphans).toHaveBeenCalledOnce(); + expect(comp.operationExecuted).toBeTrue(); + expect(comp.counts).toEqual(mockCounts); + }); + + it('should handle error during cleanup operation', () => { + const errorResponse = new HttpErrorResponse({ + status: 500, + statusText: 'Internal Server Error', + error: 'Some error message', + url: 'https://artemis.ase.in.tum.de/api/admin/orphans', // Adding a mock URL + }); + + jest.spyOn(cleanupService, 'deleteOrphans').mockReturnValue(throwError(() => errorResponse)); + + let errorMessage: string | undefined; + comp.dialogError.subscribe((error) => { + errorMessage = error; + }); + + comp.operation = { + name: 'deleteOrphans', + deleteFrom: dayjs().subtract(6, 'months'), + deleteTo: dayjs(), + lastExecuted: undefined, + datesValid: signal(true), + }; + + comp.executeCleanupOperation(); + + expect(cleanupService.deleteOrphans).toHaveBeenCalledOnce(); + expect(errorMessage).toBe('Http failure response for https://artemis.ase.in.tum.de/api/admin/orphans: 500 Internal Server Error'); + }); + + it('should close the modal', () => { + comp.close(); + + expect(activeModal.close).toHaveBeenCalledOnce(); + }); + + it('should compute hasEntriesToDelete correctly', () => { + comp.counts = { totalCount: 0 }; + + expect(comp.hasEntriesToDelete).toBeFalse(); + + comp.counts = { totalCount: 5 }; + + expect(comp.hasEntriesToDelete).toBeTrue(); + }); +}); From 6088378d15682b88202c166eb0c8243a73f54246 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Wed, 27 Nov 2024 12:22:29 +0100 Subject: [PATCH 27/49] update javadoc --- .../ParticipantScoreCleanupRepository.java | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/ParticipantScoreCleanupRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/ParticipantScoreCleanupRepository.java index f4583759ccb5..7770731b4d25 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/ParticipantScoreCleanupRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/ParticipantScoreCleanupRepository.java @@ -60,6 +60,11 @@ SELECT MAX(r2.id) /** * Counts {@link ParticipantScore} entries where the associated {@link Result} is not the latest rated result * for a {@link Participation}, within courses conducted between the specified date range. + * + * @param deleteFrom the start date for selecting courses + * @param deleteTo the end date for selecting courses + * @return the number of entities that would be deleted upon execution of the cleanup operation + * */ @Query(""" SELECT COUNT(ps) @@ -119,6 +124,10 @@ SELECT MAX(r2.id) /** * Counts {@link ParticipantScore} entries where the associated last rated {@link Result} is not the latest rated result * for a {@link Participation}, within courses conducted between the specified date range. + * + * @param deleteFrom the start date for selecting courses + * @param deleteTo the end date for selecting courses + * @return the number of entities that would be deleted upon execution of the cleanup operation */ @Query(""" SELECT COUNT(ps) @@ -177,6 +186,10 @@ SELECT MAX(r2.id) /** * Counts {@link ParticipantScore} entries where the associated {@link Result} is not the latest result and is non-rated, * and the course's start and end dates are between the specified date range. + * + * @param deleteFrom the start date for selecting courses + * @param deleteTo the end date for selecting courses + * @return the number of entities that would be deleted upon execution of the cleanup operation */ @Query(""" SELECT COUNT(ps) @@ -237,6 +250,10 @@ SELECT MAX(r2.id) /** * Counts {@link ParticipantScore} entries where the associated {@link Result} is not latest and is non-rated, even though * it is marked as the last rated result. + * + * @param deleteFrom the start date for selecting courses + * @param deleteTo the end date for selecting courses + * @return the number of entities that would be deleted upon execution of the cleanup operation */ @Query(""" SELECT COUNT(ps) From 14bf289e983fd16dedc98f32d8ba5b647d5c650e Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Wed, 27 Nov 2024 13:18:56 +0100 Subject: [PATCH 28/49] revert change --- .../cleanup-service/cleanup-operation-modal.component.ts | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts index da10f78e4626..28a9415222b4 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts @@ -1,5 +1,5 @@ import { HttpErrorResponse, HttpResponse } from '@angular/common/http'; -import { Component, OnInit, inject, input } from '@angular/core'; +import { Component, Input, OnInit, inject } from '@angular/core'; import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; import { CleanupOperation } from 'app/admin/cleanup-service/cleanup-operation.model'; import { CleanupCount, DataCleanupService } from 'app/admin/cleanup-service/data-cleanup.service'; @@ -15,9 +15,10 @@ import { faCheckCircle, faTimes } from '@fortawesome/free-solid-svg-icons'; imports: [TranslateDirective, ArtemisSharedModule], }) export class CleanupOperationModalComponent implements OnInit { - operation = input; + @Input() + operation: CleanupOperation; counts: CleanupCount; - operationExecuted = false; // Tracks whether the operation has been executed. + operationExecuted = false; private dialogErrorSource = new Subject(); dialogError = this.dialogErrorSource.asObservable(); From db9b4b67f147f7c7ec85a1323413e51db12e2494 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Wed, 27 Nov 2024 16:25:06 +0100 Subject: [PATCH 29/49] adjust translation --- src/main/webapp/i18n/de/cleanupService.json | 2 +- src/main/webapp/i18n/en/cleanupService.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/webapp/i18n/de/cleanupService.json b/src/main/webapp/i18n/de/cleanupService.json index 2eae50b5df54..98a0b0907367 100644 --- a/src/main/webapp/i18n/de/cleanupService.json +++ b/src/main/webapp/i18n/de/cleanupService.json @@ -30,7 +30,7 @@ }, "modal": { "affectedEntities": "Diese Operation wird die folgenden Entitäten löschen:", - "noEntriesToDelete": "Keine Einträge zum Löschen vorhanden." + "noEntriesToDelete": "Keine Einträge zum Löschen vorhanden" }, "notRunYet": "Diese Operation wurde noch nicht ausgeführt", "error": { diff --git a/src/main/webapp/i18n/en/cleanupService.json b/src/main/webapp/i18n/en/cleanupService.json index 601af4cb3fc7..3866bd88cf62 100644 --- a/src/main/webapp/i18n/en/cleanupService.json +++ b/src/main/webapp/i18n/en/cleanupService.json @@ -30,7 +30,7 @@ }, "modal": { "affectedEntities": "This operation will delete the following entities:", - "noEntriesToDelete": "No entries to delete." + "noEntriesToDelete": "No entries to delete" }, "notRunYet": "This operation has not been run yet", "error": { From 1632130b34e285bc7b7f20146626c4e8a6887f11 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Wed, 27 Nov 2024 16:28:29 +0100 Subject: [PATCH 30/49] migrate to new input --- .../cleanup-operation-modal.component.html | 14 +++++------ .../cleanup-operation-modal.component.ts | 23 +++++++++---------- .../cleanup-service.component.ts | 2 +- 3 files changed, 19 insertions(+), 20 deletions(-) diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html index 99149b61e4a0..57e004ce2983 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html @@ -1,22 +1,22 @@
-

+

- @if (operation.name === 'deleteOrphans') { + @if (operation().name === 'deleteOrphans') {

} @else {

} @@ -38,7 +38,7 @@

+

}

diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts index 28a9415222b4..11bafb8269f9 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts @@ -1,5 +1,5 @@ import { HttpErrorResponse, HttpResponse } from '@angular/common/http'; -import { Component, Input, OnInit, inject } from '@angular/core'; +import { Component, OnInit, inject, input } from '@angular/core'; import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; import { CleanupOperation } from 'app/admin/cleanup-service/cleanup-operation.model'; import { CleanupCount, DataCleanupService } from 'app/admin/cleanup-service/data-cleanup.service'; @@ -15,8 +15,7 @@ import { faCheckCircle, faTimes } from '@fortawesome/free-solid-svg-icons'; imports: [TranslateDirective, ArtemisSharedModule], }) export class CleanupOperationModalComponent implements OnInit { - @Input() - operation: CleanupOperation; + operation = input.required(); counts: CleanupCount; operationExecuted = false; @@ -64,18 +63,18 @@ export class CleanupOperationModalComponent implements OnInit { }, }; - switch (this.operation.name) { + switch (this.operation().name) { case 'deleteOrphans': this.dataCleanupService.deleteOrphans().subscribe(operationHandler); break; case 'deletePlagiarismComparisons': - this.dataCleanupService.deletePlagiarismComparisons(this.operation.deleteFrom, this.operation.deleteTo).subscribe(operationHandler); + this.dataCleanupService.deletePlagiarismComparisons(this.operation().deleteFrom, this.operation().deleteTo).subscribe(operationHandler); break; case 'deleteNonRatedResults': - this.dataCleanupService.deleteNonRatedResults(this.operation.deleteFrom, this.operation.deleteTo).subscribe(operationHandler); + this.dataCleanupService.deleteNonRatedResults(this.operation().deleteFrom, this.operation().deleteTo).subscribe(operationHandler); break; case 'deleteOldRatedResults': - this.dataCleanupService.deleteOldRatedResults(this.operation.deleteFrom, this.operation.deleteTo).subscribe(operationHandler); + this.dataCleanupService.deleteOldRatedResults(this.operation().deleteFrom, this.operation().deleteTo).subscribe(operationHandler); break; } } @@ -84,17 +83,17 @@ export class CleanupOperationModalComponent implements OnInit { * Fetch counts for the operation. */ private fetchCounts(): Observable> { - switch (this.operation.name) { + switch (this.operation().name) { case 'deleteOrphans': return this.dataCleanupService.countOrphans(); case 'deletePlagiarismComparisons': - return this.dataCleanupService.countPlagiarismComparisons(this.operation.deleteFrom, this.operation.deleteTo); + return this.dataCleanupService.countPlagiarismComparisons(this.operation().deleteFrom, this.operation().deleteTo); case 'deleteNonRatedResults': - return this.dataCleanupService.countNonRatedResults(this.operation.deleteFrom, this.operation.deleteTo); + return this.dataCleanupService.countNonRatedResults(this.operation().deleteFrom, this.operation().deleteTo); case 'deleteOldRatedResults': - return this.dataCleanupService.countOldRatedResults(this.operation.deleteFrom, this.operation.deleteTo); + return this.dataCleanupService.countOldRatedResults(this.operation().deleteFrom, this.operation().deleteTo); default: - throw new Error(`Unsupported operation: ${this.operation.name}`); + throw new Error(`Unsupported operation: ${this.operation().name}`); } } diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.ts b/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.ts index ddc20979a251..4e43954740c3 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.ts +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.ts @@ -83,6 +83,6 @@ export class CleanupServiceComponent implements OnInit { */ openCleanupOperationModal(operation: CleanupOperation): void { const modalRef = this.modalService.open(CleanupOperationModalComponent, { size: 'lg', backdrop: 'static' }); - modalRef.componentInstance.operation = operation; + modalRef.componentInstance.operation = signal(operation); } } From bc66696c1c9542a5f8d0b7c3ccbed180045b0120 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Wed, 27 Nov 2024 18:27:41 +0100 Subject: [PATCH 31/49] migrate tests to input<> --- .../cleanup-oparation-modal.component.spec.ts | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/test/javascript/spec/component/admin/cleanup-service/cleanup-oparation-modal.component.spec.ts b/src/test/javascript/spec/component/admin/cleanup-service/cleanup-oparation-modal.component.spec.ts index 4e6ca9b88576..3a6ca43b2e84 100644 --- a/src/test/javascript/spec/component/admin/cleanup-service/cleanup-oparation-modal.component.spec.ts +++ b/src/test/javascript/spec/component/admin/cleanup-service/cleanup-oparation-modal.component.spec.ts @@ -60,13 +60,14 @@ describe('CleanupOperationModalComponent', () => { const mockCounts: CleanupCount = { totalCount: 10 }; jest.spyOn(cleanupService, 'countOrphans').mockReturnValue(of(new HttpResponse({ body: mockCounts }))); - comp.operation = { + const operation = { name: 'deleteOrphans', deleteFrom: dayjs().subtract(6, 'months'), deleteTo: dayjs(), lastExecuted: undefined, datesValid: signal(true), }; + fixture.componentRef.setInput('operation', operation); fixture.detectChanges(); expect(cleanupService.countOrphans).toHaveBeenCalledOnce(); @@ -82,13 +83,14 @@ describe('CleanupOperationModalComponent', () => { jest.spyOn(cleanupService, 'deleteOrphans').mockReturnValue(of(mockResponse)); jest.spyOn(cleanupService, 'countOrphans').mockReturnValue(of(new HttpResponse({ body: mockCounts }))); - comp.operation = { + const operation = { name: 'deleteOrphans', deleteFrom: dayjs().subtract(6, 'months'), deleteTo: dayjs(), lastExecuted: undefined, datesValid: signal(true), }; + fixture.componentRef.setInput('operation', operation); comp.executeCleanupOperation(); @@ -113,13 +115,14 @@ describe('CleanupOperationModalComponent', () => { errorMessage = error; }); - comp.operation = { + const operation = { name: 'deleteOrphans', deleteFrom: dayjs().subtract(6, 'months'), deleteTo: dayjs(), lastExecuted: undefined, datesValid: signal(true), }; + fixture.componentRef.setInput('operation', operation); comp.executeCleanupOperation(); From 530914e6c65ef189dfef898ecd5c98ac97252c3a Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Wed, 27 Nov 2024 19:25:16 +0100 Subject: [PATCH 32/49] fix modal test --- .../cleanup-oparation-modal.component.spec.ts | 58 +++++++++++-------- 1 file changed, 33 insertions(+), 25 deletions(-) diff --git a/src/test/javascript/spec/component/admin/cleanup-service/cleanup-oparation-modal.component.spec.ts b/src/test/javascript/spec/component/admin/cleanup-service/cleanup-oparation-modal.component.spec.ts index 3a6ca43b2e84..492764985607 100644 --- a/src/test/javascript/spec/component/admin/cleanup-service/cleanup-oparation-modal.component.spec.ts +++ b/src/test/javascript/spec/component/admin/cleanup-service/cleanup-oparation-modal.component.spec.ts @@ -4,7 +4,7 @@ import { of, throwError } from 'rxjs'; import dayjs from 'dayjs/esm'; import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'; import { CleanupOperationModalComponent } from 'app/admin/cleanup-service/cleanup-operation-modal.component'; -import { CleanupCount, DataCleanupService } from 'app/admin/cleanup-service/data-cleanup.service'; +import { DataCleanupService, PlagiarismComparisonCleanupCountDTO } from 'app/admin/cleanup-service/data-cleanup.service'; import { TranslateDirective } from 'app/shared/language/translate.directive'; import { ArtemisSharedModule } from 'app/shared/shared.module'; import { signal } from '@angular/core'; @@ -19,14 +19,8 @@ describe('CleanupOperationModalComponent', () => { let activeModal: NgbActiveModal; const mockCleanupService = { - deleteOrphans: jest.fn(), deletePlagiarismComparisons: jest.fn(), - deleteNonRatedResults: jest.fn(), - deleteOldRatedResults: jest.fn(), - countOrphans: jest.fn(), countPlagiarismComparisons: jest.fn(), - countNonRatedResults: jest.fn(), - countOldRatedResults: jest.fn(), }; const mockActiveModal = { @@ -57,11 +51,17 @@ describe('CleanupOperationModalComponent', () => { }); it('should initialize and fetch counts on init', () => { - const mockCounts: CleanupCount = { totalCount: 10 }; - jest.spyOn(cleanupService, 'countOrphans').mockReturnValue(of(new HttpResponse({ body: mockCounts }))); + const mockCounts: PlagiarismComparisonCleanupCountDTO = { + totalCount: 10, + plagiarismComparison: 5, + plagiarismElements: 3, + plagiarismSubmissions: 1, + plagiarismMatches: 1, + }; + jest.spyOn(cleanupService, 'countPlagiarismComparisons').mockReturnValue(of(new HttpResponse({ body: mockCounts }))); const operation = { - name: 'deleteOrphans', + name: 'deletePlagiarismComparisons', deleteFrom: dayjs().subtract(6, 'months'), deleteTo: dayjs(), lastExecuted: undefined, @@ -70,21 +70,27 @@ describe('CleanupOperationModalComponent', () => { fixture.componentRef.setInput('operation', operation); fixture.detectChanges(); - expect(cleanupService.countOrphans).toHaveBeenCalledOnce(); + expect(cleanupService.countPlagiarismComparisons).toHaveBeenCalledOnce(); expect(comp.counts).toEqual(mockCounts); }); it('should execute cleanup operation successfully', () => { const mockResponse: HttpResponse = new HttpResponse({ - body: { executionDate: dayjs(), jobType: 'deleteOrphans' }, + body: { executionDate: dayjs(), jobType: 'deletePlagiarismComparisons' }, }); - const mockCounts: CleanupCount = { totalCount: 5 }; - jest.spyOn(cleanupService, 'deleteOrphans').mockReturnValue(of(mockResponse)); - jest.spyOn(cleanupService, 'countOrphans').mockReturnValue(of(new HttpResponse({ body: mockCounts }))); + const mockCounts: PlagiarismComparisonCleanupCountDTO = { + totalCount: 5, + plagiarismComparison: 2, + plagiarismElements: 1, + plagiarismSubmissions: 1, + plagiarismMatches: 1, + }; + jest.spyOn(cleanupService, 'deletePlagiarismComparisons').mockReturnValue(of(mockResponse)); + jest.spyOn(cleanupService, 'countPlagiarismComparisons').mockReturnValue(of(new HttpResponse({ body: mockCounts }))); const operation = { - name: 'deleteOrphans', + name: 'deletePlagiarismComparisons', deleteFrom: dayjs().subtract(6, 'months'), deleteTo: dayjs(), lastExecuted: undefined, @@ -94,8 +100,8 @@ describe('CleanupOperationModalComponent', () => { comp.executeCleanupOperation(); - expect(cleanupService.deleteOrphans).toHaveBeenCalledOnce(); - expect(cleanupService.countOrphans).toHaveBeenCalledOnce(); + expect(cleanupService.deletePlagiarismComparisons).toHaveBeenCalledOnce(); + expect(cleanupService.countPlagiarismComparisons).toHaveBeenCalledOnce(); expect(comp.operationExecuted).toBeTrue(); expect(comp.counts).toEqual(mockCounts); }); @@ -105,10 +111,10 @@ describe('CleanupOperationModalComponent', () => { status: 500, statusText: 'Internal Server Error', error: 'Some error message', - url: 'https://artemis.ase.in.tum.de/api/admin/orphans', // Adding a mock URL + url: 'https://artemis.ase.in.tum.de/api/admin/plagiarism-comparisons', // Mock URL }); - jest.spyOn(cleanupService, 'deleteOrphans').mockReturnValue(throwError(() => errorResponse)); + jest.spyOn(cleanupService, 'deletePlagiarismComparisons').mockReturnValue(throwError(() => errorResponse)); let errorMessage: string | undefined; comp.dialogError.subscribe((error) => { @@ -116,7 +122,7 @@ describe('CleanupOperationModalComponent', () => { }); const operation = { - name: 'deleteOrphans', + name: 'deletePlagiarismComparisons', deleteFrom: dayjs().subtract(6, 'months'), deleteTo: dayjs(), lastExecuted: undefined, @@ -126,8 +132,8 @@ describe('CleanupOperationModalComponent', () => { comp.executeCleanupOperation(); - expect(cleanupService.deleteOrphans).toHaveBeenCalledOnce(); - expect(errorMessage).toBe('Http failure response for https://artemis.ase.in.tum.de/api/admin/orphans: 500 Internal Server Error'); + expect(cleanupService.deletePlagiarismComparisons).toHaveBeenCalledOnce(); + expect(errorMessage).toBe('Http failure response for https://artemis.ase.in.tum.de/api/admin/plagiarism-comparisons: 500 Internal Server Error'); }); it('should close the modal', () => { @@ -137,11 +143,13 @@ describe('CleanupOperationModalComponent', () => { }); it('should compute hasEntriesToDelete correctly', () => { - comp.counts = { totalCount: 0 }; + let mockCounts: PlagiarismComparisonCleanupCountDTO = { totalCount: 0, plagiarismComparison: 0, plagiarismElements: 0, plagiarismSubmissions: 0, plagiarismMatches: 0 }; + comp.counts = mockCounts; expect(comp.hasEntriesToDelete).toBeFalse(); - comp.counts = { totalCount: 5 }; + mockCounts = { totalCount: 5, plagiarismComparison: 2, plagiarismElements: 1, plagiarismSubmissions: 1, plagiarismMatches: 1 }; + comp.counts = mockCounts; expect(comp.hasEntriesToDelete).toBeTrue(); }); From ed9afbf62f7ef14915d0c06e0f1e7efe60a67c67 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Mon, 9 Dec 2024 21:42:45 +0100 Subject: [PATCH 33/49] add routes for submission versions --- .../core/web/admin/AdminCleanupResource.java | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCleanupResource.java b/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCleanupResource.java index c9f03e6176af..5a2e4c8c9dc8 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCleanupResource.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/web/admin/AdminCleanupResource.java @@ -20,6 +20,7 @@ import de.tum.cit.aet.artemis.core.dto.NonLatestRatedResultsCleanupCountDTO; import de.tum.cit.aet.artemis.core.dto.OrphanCleanupCountDTO; import de.tum.cit.aet.artemis.core.dto.PlagiarismComparisonCleanupCountDTO; +import de.tum.cit.aet.artemis.core.dto.SubmissionVersionsCleanupCountDTO; import de.tum.cit.aet.artemis.core.security.annotations.EnforceAdmin; import de.tum.cit.aet.artemis.core.service.cleanup.DataCleanupService; @@ -163,6 +164,38 @@ public ResponseEntity countOldRatedResults return ResponseEntity.ok().body(result); } + /** + * DELETE admin/cleanup/old-submission-versions + * Deletes old submission versions within the specified date range. + * + * @param deleteFrom the start date of the deletion range + * @param deleteTo the end date of the deletion range + * @return a {@link ResponseEntity} containing the result of the cleanup operation + */ + @DeleteMapping("old-submission-versions") + public ResponseEntity deleteOldSubmissionVersions(@RequestParam("deleteFrom") ZonedDateTime deleteFrom, + @RequestParam("deleteTo") ZonedDateTime deleteTo) { + log.info("REST request to delete old submission versions between {} and {}", deleteFrom, deleteTo); + CleanupServiceExecutionRecordDTO result = dataCleanupService.deleteSubmissionVersions(deleteFrom, deleteTo); + return ResponseEntity.ok().body(result); + } + + /** + * GET admin/cleanup/old-submission-versions/count + * Counts the number of submission versions entries that would be deleted within the specified date range. + * + * @param deleteFrom the start date of the counting range + * @param deleteTo the end date of the counting range + * @return a {@link ResponseEntity} containing the count of affected entries + */ + @GetMapping("old-submission-versions/count") + public ResponseEntity countOldSubmissionVersions(@RequestParam("deleteFrom") ZonedDateTime deleteFrom, + @RequestParam("deleteTo") ZonedDateTime deleteTo) { + log.info("REST request to count old submission versions between {} and {}", deleteFrom, deleteTo); + SubmissionVersionsCleanupCountDTO result = dataCleanupService.countSubmissionVersions(deleteFrom, deleteTo); + return ResponseEntity.ok().body(result); + } + /** * GET admin/cleanup/last-executions * Retrieves the last execution records of the data cleanup operations. From 5cfb68a7ca8858af40a5c7712692a1f778dd2572 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Mon, 9 Dec 2024 21:43:51 +0100 Subject: [PATCH 34/49] add submission versions dto --- .../artemis/core/dto/SubmissionVersionsCleanupCountDTO.java | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 src/main/java/de/tum/cit/aet/artemis/core/dto/SubmissionVersionsCleanupCountDTO.java diff --git a/src/main/java/de/tum/cit/aet/artemis/core/dto/SubmissionVersionsCleanupCountDTO.java b/src/main/java/de/tum/cit/aet/artemis/core/dto/SubmissionVersionsCleanupCountDTO.java new file mode 100644 index 000000000000..55871770bee9 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/core/dto/SubmissionVersionsCleanupCountDTO.java @@ -0,0 +1,4 @@ +package de.tum.cit.aet.artemis.core.dto; + +public record SubmissionVersionsCleanupCountDTO(int submissionVersions) { +} From 7b05e4c4790c580ad9e54dead69978e0e56872a9 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Mon, 9 Dec 2024 21:44:48 +0100 Subject: [PATCH 35/49] add submission version cleanup repository --- .../SubmissionVersionCleanupRepository.java | 58 +++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/SubmissionVersionCleanupRepository.java diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/SubmissionVersionCleanupRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/SubmissionVersionCleanupRepository.java new file mode 100644 index 000000000000..f87a7f50c762 --- /dev/null +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/SubmissionVersionCleanupRepository.java @@ -0,0 +1,58 @@ +package de.tum.cit.aet.artemis.assessment.repository.cleanup; + +import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; + +import java.time.ZonedDateTime; + +import org.springframework.context.annotation.Profile; +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.core.repository.base.ArtemisJpaRepository; +import de.tum.cit.aet.artemis.exercise.domain.SubmissionVersion; + +/** + * Spring Data JPA repository for cleaning up old submission versions. + * THE FOLLOWING METHODS ARE USED FOR CLEANUP PURPOSES AND SHOULD NOT BE USED IN OTHER CASES. + */ +@Profile(PROFILE_CORE) +@Repository +public interface SubmissionVersionCleanupRepository extends ArtemisJpaRepository { + + /** + * Deletes {@link SubmissionVersion} entities where the created date is after {@code deleteFrom} + * and before {@code deleteTo}. + * + * @param deleteFrom the start date for selecting submissions + * @param deleteTo the end date for selecting submissions + * @return the number of deleted entities + */ + @Modifying + @Transactional // ok because of delete + @Query(""" + DELETE FROM SubmissionVersion sv + WHERE sv.createdDate > :deleteFrom + AND sv.createdDate < :deleteTo + """) + int deleteSubmissionVersionsByCreatedDateRange(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + + /** + * Counts {@link SubmissionVersion} entities where the created date is after {@code deleteFrom} + * and before {@code deleteTo}. + * + * @param deleteFrom the start date for selecting submissions + * @param deleteTo the end date for selecting submissions + * @return the number of entities that would be deleted + */ + @Query(""" + SELECT COUNT(sv) + FROM SubmissionVersion sv + WHERE sv.createdDate > :deleteFrom + AND sv.createdDate < :deleteTo + """) + int countSubmissionVersionsByCreatedDateRange(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + +} From 39a0900c5dc7724c05c518ca1d8b1157ca0925d1 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Mon, 9 Dec 2024 21:46:14 +0100 Subject: [PATCH 36/49] add cleanup methods for submission versions --- .../service/cleanup/DataCleanupService.java | 41 ++++++++----------- 1 file changed, 18 insertions(+), 23 deletions(-) diff --git a/src/main/java/de/tum/cit/aet/artemis/core/service/cleanup/DataCleanupService.java b/src/main/java/de/tum/cit/aet/artemis/core/service/cleanup/DataCleanupService.java index d3faa78703a4..8ad47c4365a8 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/service/cleanup/DataCleanupService.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/service/cleanup/DataCleanupService.java @@ -17,6 +17,7 @@ import de.tum.cit.aet.artemis.assessment.repository.cleanup.RatingCleanupRepository; import de.tum.cit.aet.artemis.assessment.repository.cleanup.ResultCleanupRepository; import de.tum.cit.aet.artemis.assessment.repository.cleanup.StudentScoreCleanupRepository; +import de.tum.cit.aet.artemis.assessment.repository.cleanup.SubmissionVersionCleanupRepository; import de.tum.cit.aet.artemis.assessment.repository.cleanup.TeamScoreCleanupRepository; import de.tum.cit.aet.artemis.assessment.repository.cleanup.TextBlockCleanupRepository; import de.tum.cit.aet.artemis.core.domain.CleanupJobExecution; @@ -26,6 +27,7 @@ import de.tum.cit.aet.artemis.core.dto.NonLatestRatedResultsCleanupCountDTO; import de.tum.cit.aet.artemis.core.dto.OrphanCleanupCountDTO; import de.tum.cit.aet.artemis.core.dto.PlagiarismComparisonCleanupCountDTO; +import de.tum.cit.aet.artemis.core.dto.SubmissionVersionsCleanupCountDTO; import de.tum.cit.aet.artemis.core.repository.cleanup.CleanupJobExecutionRepository; @Profile(PROFILE_CORE) @@ -52,10 +54,13 @@ public class DataCleanupService { private final TeamScoreCleanupRepository teamScoreCleanupRepository; + private final SubmissionVersionCleanupRepository submissionVersionCleanupRepository; + public DataCleanupService(CleanupJobExecutionRepository cleanupJobExecutionRepository, PlagiarismComparisonCleanupRepository plagiarismComparisonCleanupRepository, ResultCleanupRepository resultCleanupRepository, RatingCleanupRepository ratingCleanupRepository, FeedbackCleanupRepository feedbackCleanupRepository, TextBlockCleanupRepository textBlockCleanupRepository, LongFeedbackTextCleanupRepository longFeedbackTextCleanupRepository, - StudentScoreCleanupRepository studentScoreCleanupRepository, TeamScoreCleanupRepository teamScoreCleanupRepository) { + StudentScoreCleanupRepository studentScoreCleanupRepository, TeamScoreCleanupRepository teamScoreCleanupRepository, + SubmissionVersionCleanupRepository submissionVersionCleanupRepository) { this.resultCleanupRepository = resultCleanupRepository; this.ratingCleanupRepository = ratingCleanupRepository; this.feedbackCleanupRepository = feedbackCleanupRepository; @@ -65,10 +70,9 @@ public DataCleanupService(CleanupJobExecutionRepository cleanupJobExecutionRepos this.teamScoreCleanupRepository = teamScoreCleanupRepository; this.cleanupJobExecutionRepository = cleanupJobExecutionRepository; this.plagiarismComparisonCleanupRepository = plagiarismComparisonCleanupRepository; + this.submissionVersionCleanupRepository = submissionVersionCleanupRepository; } - // TODO: offer the possibility to delete old submission versions - /** * Deletes orphaned entities that are no longer associated with valid results or participations. * This includes feedback, text blocks, and scores that reference null results, participations, or submissions. @@ -162,16 +166,6 @@ public CleanupServiceExecutionRecordDTO deleteNonLatestNonRatedResultsFeedback(Z int deletedFeedback = feedbackCleanupRepository.deleteOldNonRatedFeedbackWhereCourseDateBetween(deleteFrom, deleteTo); log.info("Deleted {} feedback entries for non-rated results between {} and {}", deletedFeedback, deleteFrom, deleteTo); - // TODO: old results and participant scores should not be deleted automatically: if at all this could be offered as an option for the admin - // int deletedParticipantScoresForLatest = participantScoreCleanupRepository.deleteParticipantScoresForLatestNonRatedResultsWhereCourseDateBetween(deleteFrom, deleteTo); - // log.info("Deleted {} participant scores for latest non-rated results between {} and {}", deletedParticipantScoresForLatest, deleteFrom, deleteTo); - // - // int deletedParticipantScores = participantScoreCleanupRepository.deleteParticipantScoresForNonRatedResultsWhereCourseDateBetween(deleteFrom, deleteTo); - // log.info("Deleted {} participant scores for non-rated results between {} and {}", deletedParticipantScores, deleteFrom, deleteTo); - - // int deletedNonLatestNonRatedResults = resultCleanupRepository.deleteNonLatestNonRatedResultsWhereCourseDateBetween(deleteFrom, deleteTo); - // log.info("Deleted {} non-latest non-rated results between {} and {}", deletedNonLatestNonRatedResults, deleteFrom, deleteTo); - return CleanupServiceExecutionRecordDTO.of(createCleanupJobExecution(CleanupJobType.NON_RATED_RESULTS, deleteFrom, deleteTo)); } @@ -193,18 +187,14 @@ public CleanupServiceExecutionRecordDTO deleteNonLatestRatedResultsFeedback(Zone int deletedFeedback = feedbackCleanupRepository.deleteOldFeedbackThatAreNotLatestRatedResultsWhereCourseDateBetween(deleteFrom, deleteTo); log.info("Deleted {} feedback entries for rated results between {} and {}", deletedFeedback, deleteFrom, deleteTo); - // TODO: old results and participant scores should not be deleted automatically: if at all this could be offered as an option for the admin - // int deletedParticipantScoresForNonLatest = participantScoreCleanupRepository.deleteParticipantScoresForNonLatestLastResultsWhereCourseDateBetween(deleteFrom, deleteTo); - // log.info("Deleted {} participant scores for non-latest rated results between {} and {}", deletedParticipantScoresForNonLatest, deleteFrom, deleteTo); - // - // int deletedParticipantScoresForNonLatestLast = participantScoreCleanupRepository.deleteParticipantScoresForNonLatestLastRatedResultsWhereCourseDateBetween(deleteFrom, - // deleteTo); - // log.info("Deleted {} participant scores for non-latest last rated results between {} and {}", deletedParticipantScoresForNonLatestLast, deleteFrom, deleteTo); + return CleanupServiceExecutionRecordDTO.of(createCleanupJobExecution(CleanupJobType.RATED_RESULTS, deleteFrom, deleteTo)); + } - // int deletedNonLatestRatedResults = resultCleanupRepository.deleteNonLatestRatedResultsWhereCourseDateBetween(deleteFrom, deleteTo); - // log.info("Deleted {} non-latest rated results between {} and {}", deletedNonLatestRatedResults, deleteFrom, deleteTo); + public CleanupServiceExecutionRecordDTO deleteSubmissionVersions(ZonedDateTime deleteFrom, ZonedDateTime deleteTo) { + int deletedSubmissionVersions = submissionVersionCleanupRepository.deleteSubmissionVersionsByCreatedDateRange(deleteFrom, deleteTo); + log.info("Deleted {} submission versions entries between {} and {}", deletedSubmissionVersions, deleteFrom, deleteTo); - return CleanupServiceExecutionRecordDTO.of(createCleanupJobExecution(CleanupJobType.RATED_RESULTS, deleteFrom, deleteTo)); + return CleanupServiceExecutionRecordDTO.of(createCleanupJobExecution(CleanupJobType.SUBMISSION_VERSIONS, deleteFrom, deleteTo)); } /** @@ -281,6 +271,11 @@ public NonLatestRatedResultsCleanupCountDTO countNonLatestRatedResults(ZonedDate return new NonLatestRatedResultsCleanupCountDTO(longFeedbackTextCount, textBlockCount, feedbackCount); } + public SubmissionVersionsCleanupCountDTO countSubmissionVersions(ZonedDateTime deleteFrom, ZonedDateTime deleteTo) { + int submissionVersionsCount = this.submissionVersionCleanupRepository.countSubmissionVersionsByCreatedDateRange(deleteFrom, deleteTo); + return new SubmissionVersionsCleanupCountDTO(submissionVersionsCount); + } + /** * Retrieves the last execution record for each cleanup job type. * This method returns the most recent execution of each cleanup job type by querying From e6aaa46936c3e6acbc797b0549bf9b3d0579508e Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Mon, 9 Dec 2024 21:46:44 +0100 Subject: [PATCH 37/49] add requests for submission version cleanup methods --- .../cleanup-service/data-cleanup.service.ts | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/src/main/webapp/app/admin/cleanup-service/data-cleanup.service.ts b/src/main/webapp/app/admin/cleanup-service/data-cleanup.service.ts index 2ba79cabbd8b..4988c1c903ab 100644 --- a/src/main/webapp/app/admin/cleanup-service/data-cleanup.service.ts +++ b/src/main/webapp/app/admin/cleanup-service/data-cleanup.service.ts @@ -45,6 +45,10 @@ export interface NonLatestRatedResultsCleanupCountDTO extends CleanupCount { feedback: number; } +export interface SubmissionVersionsCleanupCountDTO extends CleanupCount { + submissionVersions: number; +} + @Injectable({ providedIn: 'root' }) export class DataCleanupService { private readonly adminResourceUrl = 'api/admin/cleanup'; @@ -102,6 +106,20 @@ export class DataCleanupService { }); } + /** + * Send DELETE request to delete old submission versions within a specific date range. + * @param deleteFrom the start date from which old rated results should be deleted + * @param deleteTo the end date until which old rated results should be deleted + */ + deleteOldSubmissionVersions(deleteFrom: dayjs.Dayjs, deleteTo: dayjs.Dayjs): Observable> { + const deleteFromString = convertDateFromClient(deleteFrom)!; + const deleteToString = convertDateFromClient(deleteTo)!; + return this.http.delete(`${this.adminResourceUrl}/old-submission-versions`, { + params: { deleteFrom: deleteFromString, deleteTo: deleteToString }, + observe: 'response', + }); + } + /** * Send GET request to get the last executions. * @returns An observable of type HttpResponse. @@ -166,4 +184,19 @@ export class DataCleanupService { observe: 'response', }); } + + /** + * Send GET request to count old submission versions within a specific date range. + * @param deleteFrom the start date for counting + * @param deleteTo the end date for counting + * @returns An observable of type HttpResponse. + */ + countOldSubmissionVersions(deleteFrom: dayjs.Dayjs, deleteTo: dayjs.Dayjs): Observable> { + const deleteFromString = convertDateFromClient(deleteFrom)!; + const deleteToString = convertDateFromClient(deleteTo)!; + return this.http.get(`${this.adminResourceUrl}/old-submission-versions/count`, { + params: { deleteFrom: deleteFromString, deleteTo: deleteToString }, + observe: 'response', + }); + } } From 020bc205c47db080f0f4e633a41f6bfe745cf831 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Mon, 9 Dec 2024 21:47:25 +0100 Subject: [PATCH 38/49] add submission versions operation to component --- .../app/admin/cleanup-service/cleanup-service.component.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.ts b/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.ts index 4e43954740c3..00a6965915d5 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.ts +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-service.component.ts @@ -53,6 +53,13 @@ export class CleanupServiceComponent implements OnInit { lastExecuted: undefined, datesValid: signal(true), }, + { + name: 'deleteOldSubmissionVersions', + deleteFrom: dayjs().subtract(12, 'months'), + deleteTo: dayjs().subtract(6, 'months'), + lastExecuted: undefined, + datesValid: signal(true), + }, ]; ngOnInit(): void { From dadbf9e421d67a41111be46ba11768f4ce85fd0b Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Mon, 9 Dec 2024 21:47:53 +0100 Subject: [PATCH 39/49] add submission versions methods to modal --- .../cleanup-service/cleanup-operation-modal.component.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts index 11bafb8269f9..79294481f0e1 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts @@ -76,6 +76,9 @@ export class CleanupOperationModalComponent implements OnInit { case 'deleteOldRatedResults': this.dataCleanupService.deleteOldRatedResults(this.operation().deleteFrom, this.operation().deleteTo).subscribe(operationHandler); break; + case 'deleteOldSubmissionVersions': + this.dataCleanupService.deleteOldSubmissionVersions(this.operation().deleteFrom, this.operation().deleteTo).subscribe(operationHandler); + break; } } @@ -92,6 +95,8 @@ export class CleanupOperationModalComponent implements OnInit { return this.dataCleanupService.countNonRatedResults(this.operation().deleteFrom, this.operation().deleteTo); case 'deleteOldRatedResults': return this.dataCleanupService.countOldRatedResults(this.operation().deleteFrom, this.operation().deleteTo); + case 'deleteOldSubmissionVersions': + return this.dataCleanupService.countOldSubmissionVersions(this.operation().deleteFrom, this.operation().deleteTo); default: throw new Error(`Unsupported operation: ${this.operation().name}`); } From 3c2273a7352abcf66a6d07ad68b3dc8ecddc02b8 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Mon, 9 Dec 2024 21:55:36 +0100 Subject: [PATCH 40/49] resolve translations issues --- src/main/webapp/i18n/de/cleanupService.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/webapp/i18n/de/cleanupService.json b/src/main/webapp/i18n/de/cleanupService.json index 98a0b0907367..2bcb3a5b483e 100644 --- a/src/main/webapp/i18n/de/cleanupService.json +++ b/src/main/webapp/i18n/de/cleanupService.json @@ -17,7 +17,7 @@ }, "tooltip": { "deleteOrphans": "Löscht verwaiste Entitäten, die nicht mehr mit gültigen Ergebnissen oder Teilnahmen verbunden sind. Dazu gehören Feedback, Textblöcke und Bewertungen, die sich auf ungültige Ergebnisse, Teilnahmen oder Einreichungen beziehen.", - "deletePlagiarismComparisons": "Löscht Plagiatsvergleiche mit dem Status 'Keine', die zu Kursen innerhalb des angegebenen Datumsbereichs gehören.", + "deletePlagiarismComparisons": "Löscht Plagiatsvergleiche mit dem Status \"None\", die zu Kursen innerhalb des angegebenen Datumsbereichs gehören.", "deleteNonRatedResults": "Löscht nicht bewertete Ergebnisse, mit Ausnahme des neuesten nicht bewerteten Ergebnisses für jede Teilnahme (um Kompetenzergebnisse berechnen zu können), innerhalb des angegebenen Datumsbereichs, zusammen mit zugehörigen langen Feedback-Texten, Textblöcken, Feedback-Elementen und Teilnehmerbewertungen.", "deleteOldRatedResults": "Löscht bewertete Ergebnisse, mit Ausnahme des neuesten bewerteten Ergebnisses für jede Teilnahme, für Kurse, die innerhalb des angegebenen Datumsbereichs durchgeführt wurden. Löscht auch zugehörige lange Feedback-Texte, Textblöcke, Feedback-Elemente und Teilnehmerbewertungen.", "deleteOldSubmissionVersions": "Löscht alte Teilnahmeversionen.", From f67ab93a55aaffea5977a691e9a4c7a6b05278a9 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Mon, 9 Dec 2024 22:55:31 +0100 Subject: [PATCH 41/49] convert ZonedDateTime to Instant --- .../cleanup/SubmissionVersionCleanupRepository.java | 6 +++--- .../artemis/core/service/cleanup/DataCleanupService.java | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/SubmissionVersionCleanupRepository.java b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/SubmissionVersionCleanupRepository.java index f87a7f50c762..c43bbd052377 100644 --- a/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/SubmissionVersionCleanupRepository.java +++ b/src/main/java/de/tum/cit/aet/artemis/assessment/repository/cleanup/SubmissionVersionCleanupRepository.java @@ -2,7 +2,7 @@ import static de.tum.cit.aet.artemis.core.config.Constants.PROFILE_CORE; -import java.time.ZonedDateTime; +import java.time.Instant; import org.springframework.context.annotation.Profile; import org.springframework.data.jpa.repository.Modifying; @@ -37,7 +37,7 @@ public interface SubmissionVersionCleanupRepository extends ArtemisJpaRepository WHERE sv.createdDate > :deleteFrom AND sv.createdDate < :deleteTo """) - int deleteSubmissionVersionsByCreatedDateRange(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + int deleteSubmissionVersionsByCreatedDateRange(@Param("deleteFrom") Instant deleteFrom, @Param("deleteTo") Instant deleteTo); /** * Counts {@link SubmissionVersion} entities where the created date is after {@code deleteFrom} @@ -53,6 +53,6 @@ SELECT COUNT(sv) WHERE sv.createdDate > :deleteFrom AND sv.createdDate < :deleteTo """) - int countSubmissionVersionsByCreatedDateRange(@Param("deleteFrom") ZonedDateTime deleteFrom, @Param("deleteTo") ZonedDateTime deleteTo); + int countSubmissionVersionsByCreatedDateRange(@Param("deleteFrom") Instant deleteFrom, @Param("deleteTo") Instant deleteTo); } diff --git a/src/main/java/de/tum/cit/aet/artemis/core/service/cleanup/DataCleanupService.java b/src/main/java/de/tum/cit/aet/artemis/core/service/cleanup/DataCleanupService.java index 8ad47c4365a8..1a48825b0267 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/service/cleanup/DataCleanupService.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/service/cleanup/DataCleanupService.java @@ -191,7 +191,7 @@ public CleanupServiceExecutionRecordDTO deleteNonLatestRatedResultsFeedback(Zone } public CleanupServiceExecutionRecordDTO deleteSubmissionVersions(ZonedDateTime deleteFrom, ZonedDateTime deleteTo) { - int deletedSubmissionVersions = submissionVersionCleanupRepository.deleteSubmissionVersionsByCreatedDateRange(deleteFrom, deleteTo); + int deletedSubmissionVersions = submissionVersionCleanupRepository.deleteSubmissionVersionsByCreatedDateRange(deleteFrom.toInstant(), deleteTo.toInstant()); log.info("Deleted {} submission versions entries between {} and {}", deletedSubmissionVersions, deleteFrom, deleteTo); return CleanupServiceExecutionRecordDTO.of(createCleanupJobExecution(CleanupJobType.SUBMISSION_VERSIONS, deleteFrom, deleteTo)); @@ -272,7 +272,7 @@ public NonLatestRatedResultsCleanupCountDTO countNonLatestRatedResults(ZonedDate } public SubmissionVersionsCleanupCountDTO countSubmissionVersions(ZonedDateTime deleteFrom, ZonedDateTime deleteTo) { - int submissionVersionsCount = this.submissionVersionCleanupRepository.countSubmissionVersionsByCreatedDateRange(deleteFrom, deleteTo); + int submissionVersionsCount = this.submissionVersionCleanupRepository.countSubmissionVersionsByCreatedDateRange(deleteFrom.toInstant(), deleteTo.toInstant()); return new SubmissionVersionsCleanupCountDTO(submissionVersionsCount); } From 5050da99fbf27117c6ce8b01634988a82d6e1421 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Mon, 9 Dec 2024 22:56:18 +0100 Subject: [PATCH 42/49] add translations for submission versions --- src/main/webapp/i18n/de/cleanupService.json | 3 ++- src/main/webapp/i18n/en/cleanupService.json | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/main/webapp/i18n/de/cleanupService.json b/src/main/webapp/i18n/de/cleanupService.json index 2bcb3a5b483e..79b7bdf3ecfb 100644 --- a/src/main/webapp/i18n/de/cleanupService.json +++ b/src/main/webapp/i18n/de/cleanupService.json @@ -53,7 +53,8 @@ "plagiarismMatches": "Plagiatsübereinstimmungen", "longFeedbackText": "Langer Feedback-Text", "textBlock": "Textblock", - "feedback": "Feedback" + "feedback": "Feedback", + "submissionVersions": "Teilnahmeversionen" }, "button": { "execute": "Ausführen", diff --git a/src/main/webapp/i18n/en/cleanupService.json b/src/main/webapp/i18n/en/cleanupService.json index 3866bd88cf62..9bcb4c6b40b2 100644 --- a/src/main/webapp/i18n/en/cleanupService.json +++ b/src/main/webapp/i18n/en/cleanupService.json @@ -53,7 +53,8 @@ "plagiarismMatches": "Plagiarism matches", "longFeedbackText": "Long feedback text", "textBlock": "Text block", - "feedback": "Feedback" + "feedback": "Feedback", + "submissionVersions": "Submission versions" }, "button": { "execute": "Execute", From 6c8b4a9f58732678c4290fc0df1ab67cd8c419c8 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Thu, 12 Dec 2024 19:09:53 +0100 Subject: [PATCH 43/49] add tests --- .../artemis/core/CleanupIntegrationTest.java | 61 ++++++++++++++++--- .../cleanup-service.service.spec.ts | 44 +++++++++++++ 2 files changed, 97 insertions(+), 8 deletions(-) diff --git a/src/test/java/de/tum/cit/aet/artemis/core/CleanupIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/core/CleanupIntegrationTest.java index 3fe8d4ab7486..8ed47fd90f4c 100644 --- a/src/test/java/de/tum/cit/aet/artemis/core/CleanupIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/core/CleanupIntegrationTest.java @@ -42,13 +42,17 @@ import de.tum.cit.aet.artemis.core.dto.NonLatestRatedResultsCleanupCountDTO; import de.tum.cit.aet.artemis.core.dto.OrphanCleanupCountDTO; import de.tum.cit.aet.artemis.core.dto.PlagiarismComparisonCleanupCountDTO; +import de.tum.cit.aet.artemis.core.dto.SubmissionVersionsCleanupCountDTO; import de.tum.cit.aet.artemis.core.repository.cleanup.CleanupJobExecutionRepository; import de.tum.cit.aet.artemis.core.test_repository.CourseTestRepository; import de.tum.cit.aet.artemis.exercise.domain.Submission; +import de.tum.cit.aet.artemis.exercise.domain.SubmissionVersion; import de.tum.cit.aet.artemis.exercise.domain.Team; import de.tum.cit.aet.artemis.exercise.participation.util.ParticipationFactory; import de.tum.cit.aet.artemis.exercise.participation.util.ParticipationUtilService; import de.tum.cit.aet.artemis.exercise.repository.ExerciseTestRepository; +import de.tum.cit.aet.artemis.exercise.repository.SubmissionRepository; +import de.tum.cit.aet.artemis.exercise.repository.SubmissionVersionRepository; import de.tum.cit.aet.artemis.exercise.repository.TeamRepository; import de.tum.cit.aet.artemis.plagiarism.domain.PlagiarismComparison; import de.tum.cit.aet.artemis.plagiarism.domain.PlagiarismMatch; @@ -61,6 +65,7 @@ import de.tum.cit.aet.artemis.shared.base.AbstractSpringIntegrationJenkinsGitlabTest; import de.tum.cit.aet.artemis.text.domain.TextBlock; import de.tum.cit.aet.artemis.text.domain.TextExercise; +import de.tum.cit.aet.artemis.text.domain.TextSubmission; import de.tum.cit.aet.artemis.text.repository.TextExerciseRepository; import de.tum.cit.aet.artemis.text.util.TextExerciseFactory; import de.tum.cit.aet.artemis.text.util.TextExerciseUtilService; @@ -124,6 +129,12 @@ class CleanupIntegrationTest extends AbstractSpringIntegrationJenkinsGitlabTest @Autowired private TeamRepository teamRepository; + @Autowired + private SubmissionRepository submissionRepository; + + @Autowired + private SubmissionVersionRepository submissionVersionRepository; + private Course oldCourse; private Course newCourse; @@ -544,6 +555,38 @@ void testDeleteOldRatedResults() throws Exception { assertThat(textBlockRepository.findById(newTextBlock2.getId())).isNotEmpty(); } + @Test + @WithMockUser(roles = "ADMIN") + void testDeleteOldSubmissionVersions() throws Exception { + + TextSubmission submission = ParticipationFactory.generateTextSubmission("submissionText", Language.ENGLISH, true); + submission = submissionRepository.save(submission); + SubmissionVersion submissionVersion1 = ParticipationFactory.generateSubmissionVersion("test1", submission, student); + submissionVersion1 = submissionVersionRepository.save(submissionVersion1); + SubmissionVersion submissionVersion2 = ParticipationFactory.generateSubmissionVersion("test2", submission, student); + submissionVersion2 = submissionVersionRepository.save(submissionVersion2); + SubmissionVersion submissionVersion3 = ParticipationFactory.generateSubmissionVersion("test2", submission, student); + submissionVersion3 = submissionVersionRepository.save(submissionVersion3); + + LinkedMultiValueMap params = new LinkedMultiValueMap<>(); + params.add("deleteFrom", ZonedDateTime.now().minusMonths(1).toString()); + params.add("deleteTo", ZonedDateTime.now().plusMonths(1).toString()); + + var counts = request.get("/api/admin/cleanup/old-submission-versions/count", HttpStatus.OK, SubmissionVersionsCleanupCountDTO.class, params); + + assertThat(counts).isNotNull(); + assertThat(counts.submissionVersions()).isEqualTo(3); + + var responseBody = request.delete("/api/admin/cleanup/old-submission-versions", params, null, CleanupServiceExecutionRecordDTO.class, HttpStatus.OK); + + assertThat(responseBody.jobType()).isEqualTo("deleteSubmissionVersions"); + assertThat(responseBody.executionDate()).isNotNull(); + + assertThat(submissionVersionRepository.findById(submissionVersion1.getId())).isEmpty(); + assertThat(submissionVersionRepository.findById(submissionVersion2.getId())).isEmpty(); + assertThat(submissionVersionRepository.findById(submissionVersion3.getId())).isEmpty(); + } + @Test @WithMockUser(roles = "ADMIN") void testGetLastExecutions() throws Exception { @@ -571,14 +614,16 @@ void testGetLastExecutions() throws Exception { @Test @WithMockUser(roles = "USER") void testUnauthorizedAccess() throws Exception { - request.postWithoutResponseBody("/api/admin/cleanup/orphans", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); - request.postWithoutResponseBody("/api/admin/cleanup/orphans/count", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); - request.postWithoutResponseBody("/api/admin/cleanup/plagiarism-comparisons", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); - request.postWithoutResponseBody("/api/admin/cleanup/plagiarism-comparisons/count", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); - request.postWithoutResponseBody("/api/admin/cleanup/non-rated-results", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); - request.postWithoutResponseBody("/api/admin/cleanup/non-rated-results/count", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); - request.postWithoutResponseBody("/api/admin/cleanup/old-rated-results", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); - request.postWithoutResponseBody("/api/admin/cleanup/old-rated-results/count", HttpStatus.FORBIDDEN, new LinkedMultiValueMap<>()); + request.delete("/api/admin/cleanup/orphans", HttpStatus.FORBIDDEN, CleanupServiceExecutionRecordDTO.class); + request.get("/api/admin/cleanup/orphans/count", HttpStatus.FORBIDDEN, OrphanCleanupCountDTO.class); + request.delete("/api/admin/cleanup/plagiarism-comparisons", HttpStatus.FORBIDDEN, CleanupServiceExecutionRecordDTO.class); + request.get("/api/admin/cleanup/plagiarism-comparisons/count", HttpStatus.FORBIDDEN, PlagiarismComparisonCleanupCountDTO.class); + request.delete("/api/admin/cleanup/non-rated-results", HttpStatus.FORBIDDEN, CleanupServiceExecutionRecordDTO.class); + request.get("/api/admin/cleanup/non-rated-results/count", HttpStatus.FORBIDDEN, NonLatestRatedResultsCleanupCountDTO.class); + request.delete("/api/admin/cleanup/old-rated-results", HttpStatus.FORBIDDEN, CleanupServiceExecutionRecordDTO.class); + request.get("/api/admin/cleanup/old-rated-results/count", HttpStatus.FORBIDDEN, NonLatestRatedResultsCleanupCountDTO.class); + request.delete("/api/admin/cleanup/old-rated-results", HttpStatus.FORBIDDEN, CleanupServiceExecutionRecordDTO.class); + request.get("/api/admin/cleanup/old-rated-results/count", HttpStatus.FORBIDDEN, SubmissionVersionsCleanupCountDTO.class); request.get("/api/admin/cleanup/last-executions", HttpStatus.FORBIDDEN, List.class); } diff --git a/src/test/javascript/spec/component/admin/cleanup-service/cleanup-service.service.spec.ts b/src/test/javascript/spec/component/admin/cleanup-service/cleanup-service.service.spec.ts index a19ef923b0fe..eafad72faed6 100644 --- a/src/test/javascript/spec/component/admin/cleanup-service/cleanup-service.service.spec.ts +++ b/src/test/javascript/spec/component/admin/cleanup-service/cleanup-service.service.spec.ts @@ -8,6 +8,7 @@ import { NonLatestRatedResultsCleanupCountDTO, OrphanCleanupCountDTO, PlagiarismComparisonCleanupCountDTO, + SubmissionVersionsCleanupCountDTO, } from 'app/admin/cleanup-service/data-cleanup.service'; import { provideHttpClient } from '@angular/common/http'; @@ -53,6 +54,11 @@ describe('DataCleanupService', () => { feedback: 2, }; + const mockSubmissionVersionsCount: SubmissionVersionsCleanupCountDTO = { + totalCount: 8, + submissionVersions: 8, + }; + beforeEach(() => { TestBed.configureTestingModule({ imports: [], @@ -212,4 +218,42 @@ describe('DataCleanupService', () => { expect(req.request.params.get('deleteTo')).toBe(deleteTo); req.flush(mockRatedResultsCount); }); + + it('should send DELETE request to delete old submission versions with date range', () => { + const deleteFrom = '2024-03-07T13:06:36.100Z'; + const deleteTo = '2024-03-08T13:06:36.100Z'; + + service.deleteOldSubmissionVersions(dayjs(deleteFrom), dayjs(deleteTo)).subscribe((res) => { + expect(res.body).toEqual(mockExecutionRecord); + }); + + const req = httpMock.expectOne({ + method: 'DELETE', + url: `api/admin/cleanup/old-submission-versions?deleteFrom=${deleteFrom}&deleteTo=${deleteTo}`, + }); + + expect(req.request.method).toBe('DELETE'); + expect(req.request.params.get('deleteFrom')).toBe(deleteFrom); + expect(req.request.params.get('deleteTo')).toBe(deleteTo); + req.flush(mockExecutionRecord); + }); + + it('should send GET request to count old submission versions with date range', () => { + const deleteFrom = '2024-03-07T13:06:36.100Z'; + const deleteTo = '2024-03-08T13:06:36.100Z'; + + service.countOldSubmissionVersions(dayjs(deleteFrom), dayjs(deleteTo)).subscribe((res) => { + expect(res.body).toEqual(mockSubmissionVersionsCount); + }); + + const req = httpMock.expectOne({ + method: 'GET', + url: `api/admin/cleanup/old-submission-versions/count?deleteFrom=${deleteFrom}&deleteTo=${deleteTo}`, + }); + + expect(req.request.method).toBe('GET'); + expect(req.request.params.get('deleteFrom')).toBe(deleteFrom); + expect(req.request.params.get('deleteTo')).toBe(deleteTo); + req.flush(mockSubmissionVersionsCount); + }); }); From aaae31d406802f99ddaaf41b52f893114c656023 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Thu, 12 Dec 2024 20:39:45 +0100 Subject: [PATCH 44/49] fix style issues --- .../tum/cit/aet/artemis/core/CleanupIntegrationTest.java | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/test/java/de/tum/cit/aet/artemis/core/CleanupIntegrationTest.java b/src/test/java/de/tum/cit/aet/artemis/core/CleanupIntegrationTest.java index 8ed47fd90f4c..af69bee0e039 100644 --- a/src/test/java/de/tum/cit/aet/artemis/core/CleanupIntegrationTest.java +++ b/src/test/java/de/tum/cit/aet/artemis/core/CleanupIntegrationTest.java @@ -51,9 +51,9 @@ import de.tum.cit.aet.artemis.exercise.participation.util.ParticipationFactory; import de.tum.cit.aet.artemis.exercise.participation.util.ParticipationUtilService; import de.tum.cit.aet.artemis.exercise.repository.ExerciseTestRepository; -import de.tum.cit.aet.artemis.exercise.repository.SubmissionRepository; import de.tum.cit.aet.artemis.exercise.repository.SubmissionVersionRepository; import de.tum.cit.aet.artemis.exercise.repository.TeamRepository; +import de.tum.cit.aet.artemis.exercise.test_repository.SubmissionTestRepository; import de.tum.cit.aet.artemis.plagiarism.domain.PlagiarismComparison; import de.tum.cit.aet.artemis.plagiarism.domain.PlagiarismMatch; import de.tum.cit.aet.artemis.plagiarism.domain.PlagiarismSubmission; @@ -130,7 +130,7 @@ class CleanupIntegrationTest extends AbstractSpringIntegrationJenkinsGitlabTest private TeamRepository teamRepository; @Autowired - private SubmissionRepository submissionRepository; + private SubmissionTestRepository submissionRepository; @Autowired private SubmissionVersionRepository submissionVersionRepository; @@ -622,8 +622,8 @@ void testUnauthorizedAccess() throws Exception { request.get("/api/admin/cleanup/non-rated-results/count", HttpStatus.FORBIDDEN, NonLatestRatedResultsCleanupCountDTO.class); request.delete("/api/admin/cleanup/old-rated-results", HttpStatus.FORBIDDEN, CleanupServiceExecutionRecordDTO.class); request.get("/api/admin/cleanup/old-rated-results/count", HttpStatus.FORBIDDEN, NonLatestRatedResultsCleanupCountDTO.class); - request.delete("/api/admin/cleanup/old-rated-results", HttpStatus.FORBIDDEN, CleanupServiceExecutionRecordDTO.class); - request.get("/api/admin/cleanup/old-rated-results/count", HttpStatus.FORBIDDEN, SubmissionVersionsCleanupCountDTO.class); + request.delete("/api/admin/cleanup/old-submission-versions", HttpStatus.FORBIDDEN, CleanupServiceExecutionRecordDTO.class); + request.get("/api/admin/cleanup/old-submission-versions/count", HttpStatus.FORBIDDEN, SubmissionVersionsCleanupCountDTO.class); request.get("/api/admin/cleanup/last-executions", HttpStatus.FORBIDDEN, List.class); } From 5247af8d08e2d48bee84f18b96d2c4f5b3fb42a7 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Mon, 16 Dec 2024 23:43:33 +0100 Subject: [PATCH 45/49] fix console errors --- .../cleanup-service/cleanup-operation-modal.component.html | 2 +- .../cleanup-service/cleanup-operation-modal.component.ts | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html index 57e004ce2983..4acf17ef1a61 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.html @@ -23,7 +23,7 @@

    - @for (key of cleanupKeys(counts); track key) { + @for (key of cleanupKeys; track key) {
  • : {{ counts[key] }} diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts index 79294481f0e1..be86838b307c 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts @@ -31,8 +31,8 @@ export class CleanupOperationModalComponent implements OnInit { /** * Fetch keys from the CleanupCount object for iteration. */ - cleanupKeys(counts: CleanupCount): (keyof CleanupCount)[] { - return Object.keys(counts) as (keyof CleanupCount)[]; + get cleanupKeys(): (keyof CleanupCount)[] { + return this.counts ? (Object.keys(this.counts) as (keyof CleanupCount)[]) : []; } /** @@ -118,6 +118,6 @@ export class CleanupOperationModalComponent implements OnInit { * Getter to check if there are any entries to delete. */ get hasEntriesToDelete(): boolean { - return Object.values(this.counts).some((count) => count > 0); + return this.counts ? Object.values(this.counts).some((count) => count > 0) : false; } } From cee41c69e9250047cd7ed344a763bd3b53a5bc32 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Tue, 17 Dec 2024 00:28:01 +0100 Subject: [PATCH 46/49] make tooltips more descriptive --- src/main/webapp/i18n/de/cleanupService.json | 2 +- src/main/webapp/i18n/en/cleanupService.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/webapp/i18n/de/cleanupService.json b/src/main/webapp/i18n/de/cleanupService.json index 79b7bdf3ecfb..dd45f56ba441 100644 --- a/src/main/webapp/i18n/de/cleanupService.json +++ b/src/main/webapp/i18n/de/cleanupService.json @@ -20,7 +20,7 @@ "deletePlagiarismComparisons": "Löscht Plagiatsvergleiche mit dem Status \"None\", die zu Kursen innerhalb des angegebenen Datumsbereichs gehören.", "deleteNonRatedResults": "Löscht nicht bewertete Ergebnisse, mit Ausnahme des neuesten nicht bewerteten Ergebnisses für jede Teilnahme (um Kompetenzergebnisse berechnen zu können), innerhalb des angegebenen Datumsbereichs, zusammen mit zugehörigen langen Feedback-Texten, Textblöcken, Feedback-Elementen und Teilnehmerbewertungen.", "deleteOldRatedResults": "Löscht bewertete Ergebnisse, mit Ausnahme des neuesten bewerteten Ergebnisses für jede Teilnahme, für Kurse, die innerhalb des angegebenen Datumsbereichs durchgeführt wurden. Löscht auch zugehörige lange Feedback-Texte, Textblöcke, Feedback-Elemente und Teilnehmerbewertungen.", - "deleteOldSubmissionVersions": "Löscht alte Teilnahmeversionen.", + "deleteOldSubmissionVersions": "Löscht alte Teilnahmeversionen. Die letzte Teilnahmeversion wird nicht gelöscht, da sie immer in der entsprechenden Unterklasse von Submission gespeichert wird", "deleteOldFeedback": "Löscht alte Feedback-Versionen." }, "execute": { diff --git a/src/main/webapp/i18n/en/cleanupService.json b/src/main/webapp/i18n/en/cleanupService.json index 9bcb4c6b40b2..209c9b1ac972 100644 --- a/src/main/webapp/i18n/en/cleanupService.json +++ b/src/main/webapp/i18n/en/cleanupService.json @@ -20,7 +20,7 @@ "deletePlagiarismComparisons": "Deletes plagiarism comparisons with a status of \"None\" that belong to courses within the specified date range.", "deleteNonRatedResults": "Deletes non-rated results, excluding the latest non-rated result for each participation (to be able to compute Competencies Scores), within the specified date range, along with associated long feedback texts, text blocks, feedback items, and participant scores.", "deleteOldRatedResults": "Deletes rated results, excluding the latest rated result for each participation, for courses conducted within the specified date range. Also deletes associated long feedback texts, text blocks, feedback items, and participant scores.", - "deleteOldSubmissionVersions": "Delete old submission versions", + "deleteOldSubmissionVersions": "Deletes old submission versions. The last submission will not be deleted, as it is always stored in the corresponding Submission subclass", "deleteOldFeedback": "Delete old feedback versions" }, "execute": { From f7f021e30ca3c25446c268cf6ce2f1e9d3317996 Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Tue, 17 Dec 2024 09:51:03 +0100 Subject: [PATCH 47/49] replace null checks --- .../cleanup-service/cleanup-operation-modal.component.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts index be86838b307c..be398b021798 100644 --- a/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts +++ b/src/main/webapp/app/admin/cleanup-service/cleanup-operation-modal.component.ts @@ -16,7 +16,7 @@ import { faCheckCircle, faTimes } from '@fortawesome/free-solid-svg-icons'; }) export class CleanupOperationModalComponent implements OnInit { operation = input.required(); - counts: CleanupCount; + counts: CleanupCount = { totalCount: 0 }; operationExecuted = false; private dialogErrorSource = new Subject(); @@ -32,7 +32,7 @@ export class CleanupOperationModalComponent implements OnInit { * Fetch keys from the CleanupCount object for iteration. */ get cleanupKeys(): (keyof CleanupCount)[] { - return this.counts ? (Object.keys(this.counts) as (keyof CleanupCount)[]) : []; + return Object.keys(this.counts) as (keyof CleanupCount)[]; } /** @@ -118,6 +118,6 @@ export class CleanupOperationModalComponent implements OnInit { * Getter to check if there are any entries to delete. */ get hasEntriesToDelete(): boolean { - return this.counts ? Object.values(this.counts).some((count) => count > 0) : false; + return Object.values(this.counts).some((count) => count > 0); } } From 8fcf1dbe41bb5dea4de45c7b8869a182f126561e Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Tue, 17 Dec 2024 19:22:44 +0100 Subject: [PATCH 48/49] improve tooltips --- src/main/webapp/i18n/de/cleanupService.json | 2 +- src/main/webapp/i18n/en/cleanupService.json | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/main/webapp/i18n/de/cleanupService.json b/src/main/webapp/i18n/de/cleanupService.json index dd45f56ba441..6eb73b1a8bfc 100644 --- a/src/main/webapp/i18n/de/cleanupService.json +++ b/src/main/webapp/i18n/de/cleanupService.json @@ -17,7 +17,7 @@ }, "tooltip": { "deleteOrphans": "Löscht verwaiste Entitäten, die nicht mehr mit gültigen Ergebnissen oder Teilnahmen verbunden sind. Dazu gehören Feedback, Textblöcke und Bewertungen, die sich auf ungültige Ergebnisse, Teilnahmen oder Einreichungen beziehen.", - "deletePlagiarismComparisons": "Löscht Plagiatsvergleiche mit dem Status \"None\", die zu Kursen innerhalb des angegebenen Datumsbereichs gehören.", + "deletePlagiarismComparisons": "Löscht Plagiatsvergleiche mit dem Status \"None\", die zu Kursen innerhalb des angegebenen Datumsbereichs gehören. Ein Status von \"None\" bedeutet, dass der Plagiatsfall noch nicht überprüft wurde.", "deleteNonRatedResults": "Löscht nicht bewertete Ergebnisse, mit Ausnahme des neuesten nicht bewerteten Ergebnisses für jede Teilnahme (um Kompetenzergebnisse berechnen zu können), innerhalb des angegebenen Datumsbereichs, zusammen mit zugehörigen langen Feedback-Texten, Textblöcken, Feedback-Elementen und Teilnehmerbewertungen.", "deleteOldRatedResults": "Löscht bewertete Ergebnisse, mit Ausnahme des neuesten bewerteten Ergebnisses für jede Teilnahme, für Kurse, die innerhalb des angegebenen Datumsbereichs durchgeführt wurden. Löscht auch zugehörige lange Feedback-Texte, Textblöcke, Feedback-Elemente und Teilnehmerbewertungen.", "deleteOldSubmissionVersions": "Löscht alte Teilnahmeversionen. Die letzte Teilnahmeversion wird nicht gelöscht, da sie immer in der entsprechenden Unterklasse von Submission gespeichert wird", diff --git a/src/main/webapp/i18n/en/cleanupService.json b/src/main/webapp/i18n/en/cleanupService.json index 209c9b1ac972..1f8452d4874a 100644 --- a/src/main/webapp/i18n/en/cleanupService.json +++ b/src/main/webapp/i18n/en/cleanupService.json @@ -16,11 +16,11 @@ "deleteOldFeedback": "Delete old feedback versions" }, "tooltip": { - "deleteOrphans": "Deletes orphaned entities that are no longer associated with valid results or participations. This includes feedback, text blocks, and scores that reference null results, participations, or submissions", - "deletePlagiarismComparisons": "Deletes plagiarism comparisons with a status of \"None\" that belong to courses within the specified date range.", + "deleteOrphans": "Deletes orphaned entities that are no longer associated with valid results or participations. This includes feedback, text blocks, and scores that reference null results, participations, or submissions.", + "deletePlagiarismComparisons": "Deletes plagiarism comparisons with a status of \"None\" that belong to courses within the specified date range. A status of \"None\" indicates that the plagiarism incident has not yet been reviewed.", "deleteNonRatedResults": "Deletes non-rated results, excluding the latest non-rated result for each participation (to be able to compute Competencies Scores), within the specified date range, along with associated long feedback texts, text blocks, feedback items, and participant scores.", "deleteOldRatedResults": "Deletes rated results, excluding the latest rated result for each participation, for courses conducted within the specified date range. Also deletes associated long feedback texts, text blocks, feedback items, and participant scores.", - "deleteOldSubmissionVersions": "Deletes old submission versions. The last submission will not be deleted, as it is always stored in the corresponding Submission subclass", + "deleteOldSubmissionVersions": "Deletes old submission versions. The last submission will not be deleted, as it is always stored in the corresponding Submission subclass.", "deleteOldFeedback": "Delete old feedback versions" }, "execute": { From b29036c1769d9554de81bac023196f69a00c39be Mon Sep 17 00:00:00 2001 From: Michal Kawka Date: Tue, 17 Dec 2024 19:22:57 +0100 Subject: [PATCH 49/49] add annotation to DTOs --- .../core/dto/NonLatestNonRatedResultsCleanupCountDTO.java | 3 +++ .../artemis/core/dto/NonLatestRatedResultsCleanupCountDTO.java | 3 +++ .../de/tum/cit/aet/artemis/core/dto/OrphanCleanupCountDTO.java | 3 +++ .../artemis/core/dto/PlagiarismComparisonCleanupCountDTO.java | 3 +++ .../artemis/core/dto/SubmissionVersionsCleanupCountDTO.java | 3 +++ 5 files changed, 15 insertions(+) diff --git a/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestNonRatedResultsCleanupCountDTO.java b/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestNonRatedResultsCleanupCountDTO.java index 2303ed7b9d6b..1f76bf550c21 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestNonRatedResultsCleanupCountDTO.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestNonRatedResultsCleanupCountDTO.java @@ -1,4 +1,7 @@ package de.tum.cit.aet.artemis.core.dto; +import com.fasterxml.jackson.annotation.JsonInclude; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) public record NonLatestNonRatedResultsCleanupCountDTO(int longFeedbackText, int textBlock, int feedback) { } diff --git a/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestRatedResultsCleanupCountDTO.java b/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestRatedResultsCleanupCountDTO.java index 71ac76bc24b4..988077e66314 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestRatedResultsCleanupCountDTO.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/dto/NonLatestRatedResultsCleanupCountDTO.java @@ -1,4 +1,7 @@ package de.tum.cit.aet.artemis.core.dto; +import com.fasterxml.jackson.annotation.JsonInclude; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) public record NonLatestRatedResultsCleanupCountDTO(int longFeedbackText, int textBlock, int feedback) { } diff --git a/src/main/java/de/tum/cit/aet/artemis/core/dto/OrphanCleanupCountDTO.java b/src/main/java/de/tum/cit/aet/artemis/core/dto/OrphanCleanupCountDTO.java index 6037253d88c5..00e61959a0ec 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/dto/OrphanCleanupCountDTO.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/dto/OrphanCleanupCountDTO.java @@ -1,5 +1,8 @@ package de.tum.cit.aet.artemis.core.dto; +import com.fasterxml.jackson.annotation.JsonInclude; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) public record OrphanCleanupCountDTO(int orphanFeedback, int orphanLongFeedbackText, int orphanTextBlock, int orphanStudentScore, int orphanTeamScore, int orphanFeedbackForOrphanResults, int orphanLongFeedbackTextForOrphanResults, int orphanTextBlockForOrphanResults, int orphanRating, int orphanResultsWithoutParticipation) { diff --git a/src/main/java/de/tum/cit/aet/artemis/core/dto/PlagiarismComparisonCleanupCountDTO.java b/src/main/java/de/tum/cit/aet/artemis/core/dto/PlagiarismComparisonCleanupCountDTO.java index c6d76ec79c5f..0c18b3dc19b2 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/dto/PlagiarismComparisonCleanupCountDTO.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/dto/PlagiarismComparisonCleanupCountDTO.java @@ -1,4 +1,7 @@ package de.tum.cit.aet.artemis.core.dto; +import com.fasterxml.jackson.annotation.JsonInclude; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) public record PlagiarismComparisonCleanupCountDTO(int plagiarismComparison, int plagiarismElements, int plagiarismSubmissions, int plagiarismMatches) { } diff --git a/src/main/java/de/tum/cit/aet/artemis/core/dto/SubmissionVersionsCleanupCountDTO.java b/src/main/java/de/tum/cit/aet/artemis/core/dto/SubmissionVersionsCleanupCountDTO.java index 55871770bee9..29261e752188 100644 --- a/src/main/java/de/tum/cit/aet/artemis/core/dto/SubmissionVersionsCleanupCountDTO.java +++ b/src/main/java/de/tum/cit/aet/artemis/core/dto/SubmissionVersionsCleanupCountDTO.java @@ -1,4 +1,7 @@ package de.tum.cit.aet.artemis.core.dto; +import com.fasterxml.jackson.annotation.JsonInclude; + +@JsonInclude(JsonInclude.Include.NON_EMPTY) public record SubmissionVersionsCleanupCountDTO(int submissionVersions) { }