Programming exercises: Improve integration of Monaco code editor and Athena Preliminary Feedback

[dmytropolityka]

Test only on ts3.

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.

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 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 PR addresses the need for better feedback handling in the code editor for programming exercises. It improves the feedback refresh mechanism and introduces a feature to reopen closed feedback directly from the file tree. These changes enhance usability and provide instructors and students with a more streamlined feedback experience.

Description

This PR introduces enhancements to the feedback management system in the programming exercise code editor. It focuses on improving the user experience when working with feedback items by implementing a feedback refresh mechanism and adding a "Reopen Feedback" button in the file tree. The changes aim to provide a more intuitive and seamless workflow for managing feedback, particularly during active programming assignments.

Steps for Testing

Prerequisites
1 Instructor
1 Student

A programming exercise with feedback enabled.
Testing Feedback Updates in the Programming Editor

1. Log in to Artemis.
2. Navigate to the programming exercise [link to exercise].
3. Open the code editor for the exercise.
4. Submit a change to the repository.
5. Request feedback.

Verify that:

1. Feedback updates are reflected in real-time in the code editor.
2. The correct number of feedback badges appears in the file tree next to the relevant files.
3. Close one or more feedback items.
4. Use the "Reopen Feedback" button in the file tree to restore the closed feedback.
5. Confirm that the feedback is restored in the code editor and matches the count indicated in the file tree.

Testing in Exam Mode

1. Create or navigate to an exam with a programming exercise.
2. Participate as a student.
   Verify that:
3. The "Reopen Feedback" button and other related features are not accessible in exam mode.

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

Exam Mode Test

• Test 1
• Test 2

Performance Tests

• Test 1
• Test 2

Screenshots

[magaupp]

Tested on TS3. Behavior as described.

Feedback items appear in the editor and icons appear in the file tree.
Multiple feedback items on the same line render correctly.
Items can be reopened from the file tree.

Tested in exam mode. Described features are not visible.
Request feedback button not shown.
File tree has no feedback icons.

[BBesrour]

code

[coolchock]

code

[EneaGore]

Tested on TS3. Works as described.

[N0W0RK]

Tested on TS3
Getting Feedback on changes works as expected. Feedback gets correctly replaced and is able to be closed and reopened.

In the UI however the close button displays 2 X icons.(See below)

[ahmetsenturk]

Tested on T3, works as expected