Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 68 commits into
base: feature/programming-exercises/choose-preliminary-feedback-model
Choose a base branch
from

Conversation

LeonWehrhahn
Copy link
Contributor

@LeonWehrhahn LeonWehrhahn commented May 29, 2025

Please test only on TS3
!!! Contains database migrations !!!

Checklist

General

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 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 added authorities to all new routes and checked the course groups for displaying navigation elements (links, buttons).
  • 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.

Changes affecting Programming Exercises

  • High priority: I tested all changes and their related features with all corresponding user types on a test server configured with the integrated lifecycle setup (LocalVC and LocalCI).
  • I tested all changes and their related features with all corresponding user types on a test server configured with LocalVC and Jenkins.

Motivation and Context

This PR addresses current limitations in the feedback handling within the online code editor for programming exercises. At the moment, feedback does not refresh reliably, and once feedback is closed, there is no way to reopen it from the file tree.

Description

This PR adds a feedback refresh mechanism, a “Reopen Feedback” button in the file tree, and updates how remaining Athena feedback requests are counted by using a new server endpoint instead of relying on a limited client-side array.

Note: This PR is based on the branch from a previously closed, unmerged PR. It resolves merge conflicts and adds new functionality, including the corrected handling of the limited-size feedback count.

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.

  1. Navigate to the programming exercise link to exercise
  2. Open the code editor for the exercise.
  3. Submit a change to the repository.
  4. 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.

Exam Mode Testing

  1. Create or navigate to an exam with a programming exercise.
  2. Participate as a student

Verify that:

  1. The "Reopen Feedback" button and other related features are not accessible in exam mode.

Testserver States

You can manage test servers using Helios. Check environment statuses in the environment list. To deploy to a test server, go to the CI/CD page, find your PR or branch, and trigger the deployment.

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

Test Coverage

Screenshots

image

image

dmytropolityka and others added 30 commits November 14, 2024 05:09
…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
…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor
…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor
dmytropolityka and others added 3 commits April 7, 2025 18:51
@github-project-automation github-project-automation bot moved this to Work In Progress in Artemis Development May 29, 2025
@github-actions github-actions bot added tests server Pull requests that update Java code. (Added Automatically!) client Pull requests that update TypeScript code. (Added Automatically!) database Pull requests that update the database. (Added Automatically!). Require a CRITICAL deployment. assessment Pull requests that affect the corresponding module athena Pull requests that affect the corresponding module communication Pull requests that affect the corresponding module core Pull requests that affect the corresponding module exercise Pull requests that affect the corresponding module modeling Pull requests that affect the corresponding module programming Pull requests that affect the corresponding module text Pull requests that affect the corresponding module labels May 29, 2025
@LeonWehrhahn LeonWehrhahn changed the base branch from develop to feature/programming-exercises/choose-preliminary-feedback-model May 30, 2025 12:44
@LeonWehrhahn LeonWehrhahn changed the title Programming exercises: Improve integration of Monaco code editor and Athena Preliminary Feedback Programming exercises: Improve integration of Monaco code editor and Athena Preliminary Feedback May 30, 2025
…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor
@github-actions github-actions bot removed database Pull requests that update the database. (Added Automatically!). Require a CRITICAL deployment. modeling Pull requests that affect the corresponding module text Pull requests that affect the corresponding module labels Jun 2, 2025
LeonWehrhahn and others added 4 commits June 2, 2025 09:01
…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor
…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor
…ck-model' into feature/programming-exercises/athena-feedback-in-code-editor
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
assessment Pull requests that affect the corresponding module athena Pull requests that affect the corresponding module client Pull requests that update TypeScript code. (Added Automatically!) communication Pull requests that affect the corresponding module core Pull requests that affect the corresponding module exercise Pull requests that affect the corresponding module programming Pull requests that affect the corresponding module server Pull requests that update Java code. (Added Automatically!) tests
Projects
Status: Work In Progress
Status: Todo
Development

Successfully merging this pull request may close these issues.

2 participants