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

dmytropolityka · 2025-03-05T03:47:46Z

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

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

Verify that:

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

Testing in Exam Mode

Create or navigate to an exam with a programming exercise.
Participate as a student.
Verify that:
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

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor # Conflicts: # src/main/java/de/tum/cit/aet/artemis/programming/service/ProgrammingExerciseCodeReviewFeedbackService.java # src/main/webapp/app/exercises/programming/participate/code-editor-student-container.component.html # src/main/webapp/app/exercises/programming/participate/code-editor-student-container.component.ts # src/main/webapp/app/exercises/shared/result/updating-result.component.ts

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor

…g-exercises/athena-feedback-in-code-editor # Conflicts: # src/main/webapp/app/exercises/modeling/manage/modeling-exercise.module.ts # src/main/webapp/app/exercises/programming/assess/code-editor-tutor-assessment-inline-feedback.component.ts # src/main/webapp/app/exercises/programming/shared/code-editor/container/code-editor-container.component.ts # src/main/webapp/app/exercises/programming/shared/code-editor/file-browser/code-editor-file-browser-node.component.ts # src/main/webapp/app/exercises/programming/shared/lifecycle/programming-exercise-lifecycle.module.ts # src/main/webapp/app/exercises/shared/feedback-suggestion/exercise-feedback-suggestion-options.component.ts # src/main/webapp/app/exercises/text/manage/text-exercise/text-exercise.module.ts # src/main/webapp/app/overview/exercise-details/exercise-details-student-actions.component.html # src/main/webapp/i18n/de/exercise.json # src/test/javascript/spec/component/code-editor/code-editor-file-browser.component.spec.ts # src/test/javascript/spec/component/exercises/shared/feedback/feedback-suggestion-option.component.spec.ts # src/test/javascript/spec/component/modeling-exercise/modeling-exercise-update.component.spec.ts # src/test/javascript/spec/component/overview/exercise-details/exercise-details-student-actions.component.spec.ts # src/test/javascript/spec/component/overview/exercise-details/request-feedback-button/request-feedback-button.component.spec.ts # src/test/javascript/spec/component/programming-assessment/code-editor-tutor-assessment-inline-feedback.component.spec.ts # src/test/javascript/spec/component/programming-exercise/programming-exercise-lifecycle.component.spec.ts # src/test/javascript/spec/component/text-exercise/text-exercise-update.component.spec.ts # src/test/javascript/spec/integration/code-editor/code-editor-container.integration.spec.ts

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor # Conflicts: # src/main/webapp/app/exercises/shared/feedback-suggestion/exercise-feedback-suggestion-options.component.ts # src/main/webapp/app/exercises/shared/preliminary-feedback/exercise-preliminary-feedback-options.component.ts # src/test/javascript/spec/component/overview/exercise-details/exercise-details-student-actions.component.spec.ts # src/test/javascript/spec/component/programming-exercise/programming-exercise-lifecycle.component.spec.ts

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor

github-actions · 2025-03-31T12:06:17Z

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

…hena-feedback-in-code-editor' into feature/programming-exercises/athena-feedback-in-code-editor

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor

…hena-feedback-in-code-editor' into feature/programming-exercises/athena-feedback-in-code-editor

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor

github-actions · 2025-04-04T18:07:23Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ☑️	Skipped ⚠️	Failed ❌️	Time ⏱
End-to-End (E2E) Test Report	201 ran	197 passed	3 skipped	1 failed	44m 20s 642ms

Test	Result	Time ⏱
End-to-End (E2E) Test Report
e2e/exercise/programming/ProgrammingExerciseStaticCodeAnalysis.spec.ts
ts.Static code analysis tests › Configures SCA grading and makes a successful submission with SCA errors	❌ failure	1m 43s 580ms

github-actions · 2025-04-04T18:45:19Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ☑️	Skipped ⚠️	Failed ❌️	Time ⏱
End-to-End (E2E) Test Report	201 ran	197 passed	3 skipped	1 failed	47m 9s 602ms

Test	Result	Time ⏱
End-to-End (E2E) Test Report
e2e/exercise/programming/ProgrammingExerciseStaticCodeAnalysis.spec.ts
ts.Static code analysis tests › Configures SCA grading and makes a successful submission with SCA errors	❌ failure	1m 45s 878ms

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor

github-actions · 2025-04-04T19:44:25Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ☑️	Skipped ⚠️	Failed ❌️	Time ⏱
End-to-End (E2E) Test Report	201 ran	197 passed	3 skipped	1 failed	46m 28s 875ms

Test	Result	Time ⏱
End-to-End (E2E) Test Report
e2e/exercise/programming/ProgrammingExerciseStaticCodeAnalysis.spec.ts
ts.Static code analysis tests › Configures SCA grading and makes a successful submission with SCA errors	❌ failure	1m 44s 488ms

…hena-feedback-in-code-editor' into feature/programming-exercises/athena-feedback-in-code-editor

github-actions · 2025-04-07T15:45:01Z

End-to-End (E2E) Test Results Summary

	Tests	Passed ☑️	Skipped ⚠️	Failed ❌️	Time ⏱
End-to-End (E2E) Test Report	201 ran	197 passed	3 skipped	1 failed	47m 30s 242ms

Test	Result	Time ⏱
End-to-End (E2E) Test Report
e2e/exercise/programming/ProgrammingExerciseStaticCodeAnalysis.spec.ts
ts.Static code analysis tests › Configures SCA grading and makes a successful submission with SCA errors	❌ failure	1m 47s 82ms

…ditor'

github-actions · 2025-04-17T12:06:22Z

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

krusche

The PR has merge conflicts and for some reason deletes many files. I am pretty sure you made a mistake while resolving a merge conflict

github-actions · 2025-04-25T12:06:25Z

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

dmytropolityka added 16 commits November 14, 2024 05:09

improve integration of monaco code editor and preliminary feedback

539ab1d

Merge branch 'feature/programming-exercises/choose-preliminary-feedba…

6fa0d09

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor

move reload feedback button

3436aad

styling issues

24b5437

fix test

e764299

add new tests

d4e2569

eslint

0fca59f

eslint

4122b29

change component.item to partial

ef723dd

change component.item to unknown

61d4b38

resolve merge conflict issues

27ba875

fix deployment issue

e770a34

Merge branch 'feature/programming-exercises/choose-preliminary-feedba…

b1d0035

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor

github-project-automation bot added this to Artemis Development Mar 5, 2025

github-project-automation bot moved this to Work In Progress in Artemis Development Mar 5, 2025

github-actions bot assigned dmytropolityka Mar 5, 2025

github-actions bot added tests server Pull requests that update Java code. (Added Automatically!) client Pull requests that update TypeScript code. (Added Automatically!) programming Pull requests that affect the corresponding module labels Mar 5, 2025

Merge branch 'feature/programming-exercises/choose-preliminary-feedba…

6fdf2b4

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor

dmytropolityka changed the title ~~Feature/programming exercises/athena feedback in code editor~~ Programming exercises: Improve integration of Monaco code editor and Athena Preliminary Feedback Mar 5, 2025

dmytropolityka and others added 4 commits March 5, 2025 06:22

Merge branch 'feature/programming-exercises/choose-preliminary-feedba…

e1ef392

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor

fix styling in tests

017c4f2

fix styling in tests

5e42e1d

Update exercise.json

1d25704

helios-aet bot temporarily deployed to artemis-test3.artemis.cit.tum.de March 5, 2025 12:34 Inactive

Merge branch 'feature/programming-exercises/choose-preliminary-feedba…

1c62a9d

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor

github-actions bot added stale and removed ready for review labels Mar 31, 2025

dmytropolityka added 2 commits April 4, 2025 19:15

Merge base branch

f3e68b6

Merge remote-tracking branch 'origin/feature/programming-exercises/at…

0c4d0ec

…hena-feedback-in-code-editor' into feature/programming-exercises/athena-feedback-in-code-editor

dmytropolityka requested review from a team and krusche as code owners April 4, 2025 17:16

github-actions bot added the assessment Pull requests that affect the corresponding module label Apr 4, 2025

dmytropolityka and others added 5 commits April 4, 2025 19:19

Merge branch 'feature/programming-exercises/choose-preliminary-feedba…

756018e

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor

fix merge conflict issues

e8b5644

Merge remote-tracking branch 'origin/feature/programming-exercises/at…

aa01e3f

…hena-feedback-in-code-editor' into feature/programming-exercises/athena-feedback-in-code-editor

fix another merge conflict issue

b1697c6

Merge branch 'feature/programming-exercises/choose-preliminary-feedba…

65dcd57

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor

Merge branch 'feature/programming-exercises/choose-preliminary-feedba…

9f4985d

…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor

github-actions bot removed the stale label Apr 5, 2025

dmytropolityka added 2 commits April 7, 2025 16:57

increase test coverage

ac6502d

Merge remote-tracking branch 'origin/feature/programming-exercises/at…

0177640

…hena-feedback-in-code-editor' into feature/programming-exercises/athena-feedback-in-code-editor

dmytropolityka and others added 2 commits April 7, 2025 18:49

Merge branch 'feature/programming-exercises/athena-feedback-in-code-e…

84c6a2d

…ditor'

Create pre-commit

aabdf01

github-actions bot added the stale label Apr 17, 2025

krusche requested changes Apr 18, 2025

View reviewed changes

github-actions bot removed the stale label Apr 18, 2025

github-actions bot added the stale label Apr 25, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

dmytropolityka commented Mar 5, 2025 •

edited

Loading

github-actions bot commented Mar 31, 2025

github-actions bot commented Apr 4, 2025

github-actions bot commented Apr 4, 2025

github-actions bot commented Apr 4, 2025

github-actions bot commented Apr 7, 2025

github-actions bot commented Apr 17, 2025

krusche left a comment

github-actions bot commented Apr 25, 2025

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

Are you sure you want to change the base?

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

Conversation

dmytropolityka commented Mar 5, 2025 • edited Loading

Checklist

General

Client

Motivation and Context

Description

Steps for Testing

Testserver States

Review Progress

Performance Review

Code Review

Manual Tests

Exam Mode Test

Performance Tests

Screenshots

github-actions bot commented Mar 31, 2025

github-actions bot commented Apr 4, 2025

End-to-End (E2E) Test Results Summary

github-actions bot commented Apr 4, 2025

End-to-End (E2E) Test Results Summary

github-actions bot commented Apr 4, 2025

End-to-End (E2E) Test Results Summary

github-actions bot commented Apr 7, 2025

End-to-End (E2E) Test Results Summary

github-actions bot commented Apr 17, 2025

krusche left a comment

Choose a reason for hiding this comment

github-actions bot commented Apr 25, 2025

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

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

dmytropolityka commented Mar 5, 2025 •

edited

Loading