Programming exercises: Allow instructors to edit programming exercises in the new code editor

[pzdr7]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• 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.
• I strictly followed the client coding and design guidelines.
• I added multiple screenshots/screencasts of my UI changes.

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 Gitlab and Jenkins.

Motivation and Context

The Monaco editor, which was introduced in PR #8130, is currently only available to students in two views. This PR contributes to our gradual removal of Ace from the Artemis client.

Description

• Monaco editor for instructors: Uses Monaco in the "Edit in Editor" view, which allows instructors to edit the template, solution, assignment, and test repositories.
• Earlier initialization of the monaco editor: The MonacoEditorComponent now initializes its editor in the constructor (rather than ngOnInit) by injecting its container into the DOM using Renderer2. This ensures that the _editor instance is always available when methods of the component are called and avoids having.

Known issues:

• Resizing as mentioned in Development: Change the online code editor for students to monaco #8130
• Pasting is broken on non-Firefox browsers because of an issue involving the process dependency we use in the client. For these browsers, CTRL+Shift+V works for pasting fixed in Development: Delete process polyfill and adjust paste-related e2e tests #8391

Steps for Testing

Prerequisites:

• 1 Instructor
• 1 Programming exercise

1. Log in to Artemis
2. Navigate to Course management > Your course > Exercises
3. Click "Edit in Editor" for your programming exercise
4. Verify that you can switch between & edit each repository: Template, Solution, Tests, and Assignment (create if necessary).
5. Ensure that your changes are saved.

Testserver States

Note

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

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

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

Client

Class/File	Line Coverage	Confirmation (assert/expect)
code-editor-monaco.component.ts	92.7%	✅
monaco-editor.component.ts	97.4%	✅

Screenshots

Summary by CodeRabbit

• New Features

  • Integrated Monaco Editor for enhanced code editing experience in programming exercises.

• Bug Fixes

  • Improved editor reset functionality to ensure consistent behavior when reverting changes.

• Refactor

  • Optimized the initialization and rendering process of the Monaco Editor to improve performance and user interaction.

[coderabbitai]

Walkthrough

This update integrates the Monaco Editor across various components in an Angular application, enhancing the code editor's functionality with conditions for resetting and refreshing the editor, and simplifying the editor's instantiation and configuration.

Changes

Files	Change Summary
.../code-editor-instructor-and-editor-container.component.html	Added attribute to enable Monaco Editor.
.../code-editor/monaco/code-editor-monaco.component.ts	Added condition for resetting the editor based on commitState.
.../shared/monaco-editor/monaco-editor.component.ts	Major refactor including immediate editor creation, simplified readOnly setting, and layout adjustments.
.../integration/code-editor/code-editor-instructor.integration.spec.ts	Updated integration tests to support Monaco Editor components.

Possibly related issues

• Programming Exercise: Changing the short name while importing breaks tests #7188: Although this PR does not directly address the issue of changing exercise names, the enhanced editor functionality could indirectly improve the handling and stability of programming exercises, potentially affecting related files and settings.
• Programming exercises: Add Athena Feedback Suggestions #7094: The integration of Monaco Editor and its enhanced capabilities might indirectly support the development of new features like feedback suggestions by providing a more robust and feature-rich environment for programming exercises, which could be useful for implementing complex functionalities like those described.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[mateusmm01]

tested on ts5. Works as expected

[Jan-Thurner]

Code lgtm

[coolchock]

tested on ts4, works as expected

re-test necessary

[coolchock]

re-tested on ts2, works as expected 👍