General: Improve cleanup service

[coolchock]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Server

• Important: I implemented the changes with a very good performance and prevented too many (unnecessary) and too complex database calls.
• I strictly followed the principle of data economy for all database calls.
• I strictly followed the server coding and design guidelines.
• I added multiple integration tests (Spring) related to the features (with a high test coverage).
• I added pre-authorization annotations according to the guidelines and checked the course groups for all new REST Calls (security).
• I documented the Java code using JavaDoc style.

Client

• Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data (e.g. using paging).
• I strictly followed the principle of data economy for all client-server REST calls.
• I strictly followed the client coding and design guidelines.
• Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
• I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
• I documented the TypeScript code using JSDoc style.
• I added multiple screenshots/screencasts of my UI changes.
• I translated all newly inserted strings into English and German.

Motivation and Context

This change enhances the transparency and accountability of cleanup operations within the administration interface. Previously, administrators lacked a clear overview of how many entities would be affected by a cleanup operation before execution, as well as insight into the results of the operation afterward. This feature addresses that gap by providing detailed information to administrators, ensuring they can make informed decisions and verify the outcomes of their actions.

Description

This pull request introduces a CleanupService modal that provides administrators with detailed insights into cleanup operations. The modal displays the number of entities that would be affected by a specific cleanup operation, broken down into relevant categories for better granularity. After the operation is executed, the modal updates to reflect the results, showing how many entities were successfully deleted and if any errors occurred. This feature helps administrators verify the success of the operation and troubleshoot any issues if necessary.

• Pre-execution View: Administrators can see the total number of entities that would be impacted by a cleanup operation, categorized for clarity.
• Post-execution Results: The modal updates to display the actual number of entities deleted

Steps for Testing

Prerequisites:

• 1 test server with admin access (TS3)
• 1 Admin

1. Log in to Artemis.
2. Navigate to Server Administration -> Cleanup Service.
3. Select a time period and click the Execute button.
4. Verify that the modal opens and displays the affected entries.
5. Execute an operation where entities will be deleted.
6. Verify that the numbers update and icons indicating success or failure are displayed.

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Performance Review

• I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance even for very large courses with more than 2000 students.
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Performance Tests

• Test 1
• Test 2

Screenshots

Before execution:

After execution:

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced multiple counting methods for various data types, including orphaned feedback, plagiarism comparisons, non-rated results, and submission versions.
  • Added new modal component for managing cleanup operations within the application.
  • Enhanced localization for cleanup operations with detailed tooltips and confirmation messages.
  • Introduced new endpoints for counting orphaned entities, old submission versions, and non-rated results.
  • Added a new repository for managing submission versions.
  • Implemented new DTOs for encapsulating counts related to various cleanup operations.

• Bug Fixes

  • Improved error handling for unauthorized access to new cleanup count endpoints.

• Documentation

  • Updated localization files to improve user guidance and operational clarity.

• Tests

  • Expanded test coverage for new counting functionalities and modal component behavior.

[github-actions]

⚠️ Unable to deploy to test servers ⚠️

Testserver "artemis-test3.artemis.cit.tum.de" is already in use by PR #10026.

[magaupp]

Tested on TS3. Count of items to be deleted is correctly shown. Confirmation icon is displayed after execution. Only items of the selected time frame are deleted.

[florian-glombik]

Tested on ts3

• I generated some results with the supporting scripts
• Delete old submission versions appears to work fine
• Delete feedback of old rated results appears to work fine
• I did not test the orphans
• I did not test non related results

I have noticed that when opening Delete feedback of old rated results yields a short delay until the translations are loaded - we could add a very low priority issue for that, if it is an issue at all - considering that it is a rarely used admin feature.
It does not need to be changed within this PR

modalABitLaggy.mov