Quiz exercises: Fix short answer quiz template is invalid

[beyzaaltuntas]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• This is a small issue that I tested locally and was confirmed by another developer 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.
• 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.

Motivation and Context

Fixes #7559

Description

When creating a quiz in a quiz practice group with a short answer option, it could not be saved due to "Invalid input" even though it was valid. This problem has been fixed.

Steps for Testing

Prerequisites:

• 1 Instructor
• 1 Quiz

1. Create a quiz
2. Select "Add Short-Answer Question"
3. Enter both the title and question name
4. See that the template input is marked as valid

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
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Exam Mode Test

• Test 1
• Test 2

Test Coverage

Screenshots

Screencast.2024-02-26.13_01_13.mp4

Summary by CodeRabbit

• New Features
  • Short-answer questions in quizzes now support Markdown formatting, enhancing question presentation.

[coderabbitai]

Walkthrough

This update introduces the capability to parse Markdown content in the questionEditorText of short-answer questions and trigger a questionUpdated event post-initialization. This enhancement is aimed at improving the creation and management of short-answer quizzes by ensuring that the input template is automatically validated as valid, addressing the issue of the "Invalid input" error in quiz exercises within exam groups.

Changes

File Path	Change Summary
.../short-answer-question-edit.component.ts	Added functionality to parse Markdown in questionEditorText and emit questionUpdated after initialization.

Assessment against linked issues

Objective	Addressed	Explanation
Fix "Invalid input" error for short-answer quiz in exams (#7559)	✅
Input marked as valid without extra actions (#7559)	✅
Address confusion from invalid template input (#7559)	✅
Recognize template input as valid when generated (#7559)	✅
Automatically validate input and template for short-answer questions (#7559)	✅
Ensure input is validated without manual intervention (#7559)	✅
Test and validate on Chrome for version 6.6.4 of Artemis (#7559)	❌	The PR does not include details on browser-specific testing or version compatibility.

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[pzdr7]

Tested on TS2. The template is now valid when creating a short answer question -> works as expected!

For the pull request description, I'd recommend removing the server / programming exercise / exam mode test sections as their tasks don't apply.

[Strohgelaender]

code lgtm

[rstief]

code looks good.

[egekurt123]

Manually tested on ts2, works as expected

[Gusti2010]

Manually tested on ts11_Legacy. Works as expected!

[AntonGeTUM]

Manually tested, works as described