Exam mode: Prevent problem statement from closing when viewing changes

[pzdr7]

Checklist

General

• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• I chose a title conforming to the naming conventions for pull requests.

Client

• I strictly followed the client coding and design guidelines.

Motivation and Context

During the second testing session for 7.0.0, we noticed that clicking on the "Show Difference" / "Only show new Version" buttons closed the problem statement for some exercise types.

This was because the problem statement (which collapses when clicked) registered a click when the button was clicked.

Description

• Stops the click from propagating to the problem statement, thus preventing it from collapsing
• Verifies in the tests that this stopPropagation occurs

Steps for Testing

Prerequisites:

• 1 Exam (this change should affect all exercise types except for programming, which doesn't have this issue)
• 1 Student
• 1 Instructor

1. Open the exam as a student, viewing an exercise.
2. In a different browser: As the instructor, edit the problem statement of that exercise.
3. When the option becomes available, click on "Show Difference" / "Only show new Version"
4. Verify that the problem statement does not collapse when you click on the button.
5. Verify that the problem statement still collapses when you click elsewhere on the problem statement.

Testserver States

Note

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

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

[coderabbitai]

Walkthrough

This update enhances the user interaction within an exam context by refining the problem statement update mechanism. Specifically, it modifies how events are handled when toggling the highlighted state of problem statements, ensuring a more intuitive and controlled user experience by preventing event propagation.

Changes

File Path	Change Summary
.../exam-exercise-update-highlighter.component.html	Updated (click) event to pass $event to toggleHighlightedProblemStatement().
.../exam-exercise-update-highlighter.component.ts	Added MouseEvent parameter to toggleHighlightedProblemStatement and implemented event.stopPropagation().
.../spec/.../exam-exercise-update-highlighter.component.spec.ts	Added test for stopPropagation when toggleHighlightedProblemStatement is called with a mouse event.

Possibly related issues

• Exam mode: Problem statement diff view does only show diff to last change #7567: The changes could indirectly support the desired behavior of displaying changes relative to the initial problem statement, as they refine how updates to problem statements are handled and highlighted.
• Highlight differences in Exam Timeline #7197: The update may contribute to the objective of highlighting differences in the Exam Timeline by improving the mechanism for toggling highlighted states, which could be extended or adapted for visualizing submission differences.

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 11d29c3 and 27b39d4.

Files selected for processing (1)

• src/main/webapp/app/exam/participate/exercises/exam-exercise-update-highlighter/exam-exercise-update-highlighter.component.ts (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• src/main/webapp/app/exam/participate/exercises/exam-exercise-update-highlighter/exam-exercise-update-highlighter.component.ts

---

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.

[julian-christl]

code lgtm

[coolchock]

tested during testing session, works as described. Code LGTM

[undernagruzez]

tested during a testing session and works as expected, code also lgtm

[muradium]

Tested during testing session, works as expected

[rstief]

tested in testing session, works as expected.