Feature: Add conditional tooltip for edit button in exam exercise row

[laxerhd]

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 (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 screenshots/screencasts of my UI changes.
• I translated all newly inserted strings into English and German.

Motivation and Context

The Edit button for quizzes in exams should not be clickable while the exam is running.
As discussed in #9865, there was some confusion regarding the disabled Edit button.
To make things clearer, I've added a tooltip for such cases.

Description

Added a conditional ngbTooltip and a translation key examStartedNoEdit for the text.

Steps for Testing

Prerequisites:

• 1 Instructor
• 1 Course with an exam
• Create a quiz exercise in this exercise group

1. Log in to Artemis
2. Navigate the Course
3. Click on Manage -> Exams -> Exercise Groups
4. Take a look at the Edit button of the quiz in the exercise group

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

Test Coverage

Screenshots

Summary by CodeRabbit

• New Features

  • Added tooltips to the edit button for quizzes, indicating that editing is not allowed once the exam has started.
  • Introduced new messages in English and German to inform users about editing restrictions during an ongoing exam.

• Bug Fixes

  • Minor formatting update for consistency in the JSON structure.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the HTML template of the exam-exercise-row-buttons.component.html to add a tooltip feature for the edit button during active exams. The tooltip informs users that editing is not permitted once the exam has started. Additionally, new translation entries for this tooltip have been added to both the German and English quizExercise.json files. The overall structure of the component and its functionality remains unchanged.

Changes

File Path	Change Summary
src/main/webapp/app/exercises/shared/exam-exercise-row-buttons/exam-exercise-row-buttons.component.html	Added a tooltip feature for the edit button that displays a message when the exam has started.
src/main/webapp/i18n/de/quizExercise.json	Added new translation key "examStartedNoEdit" with a message regarding editing restrictions during an exam.
src/main/webapp/i18n/en/quizExercise.json	Added new translation key "examStartedNoEdit" with a message regarding editing restrictions during an exam; added a trailing comma to the existing string.

Possibly related PRs

• Programming exercises: Adjust translations for participation mode tooltips #9468: This PR adds tooltips to participation modes in programming exercises, which relates to the main PR's enhancement of user feedback through tooltips for the edit button in exam exercises.
• Exam mode: Fix an issue where a translation is outdated #9804: This PR updates an outdated translation related to exam participation, which is relevant as the main PR also involves translations for user feedback regarding editing restrictions during exams.

Suggested labels

client, user interface, small, bugfix, ready for review

Suggested reviewers

• edkaya
• JohannesStoehr
• pzdr7
• SimonEntholzer
• az108
• krusche

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

src/main/webapp/app/exercises/shared/exam-exercise-row-buttons/exam-exercise-row-buttons.component.html (1)

111-120: LGTM! Consider adding aria-label for better accessibility.

The tooltip implementation is well done:

• Correctly uses ngbTooltip for conditional tooltip display
• Properly integrates with translation system
• Maintains consistent styling

Consider adding an aria-label to improve accessibility when the button is disabled:

 <a
     [class.disabled]="hasExamStarted()"
+    [attr.aria-label]="hasExamStarted() ? ('artemisApp.quizExercise.edit.examStartedNoEdit' | artemisTranslate) : undefined"
     [routerLink]="['/course-management', course.id, 'exams', exam.id, 'exercise-groups', exerciseGroupId, exercise.type + '-exercises', exercise.id, 'edit']"
     class="btn btn-warning btn-sm me-1"
 >

src/main/webapp/i18n/de/quizExercise.json (1)

47-48: Consider using informal address style in German translation.

While the translation is accurate, it could be more aligned with the coding guidelines that specify using informal address ("dutzen") in German translations.

Consider this more informal version:

-  "examStartedNoEdit": "Die Prüfung hat begonnen. Das Quiz kann für die Dauer der Prüfung nicht bearbeitet werden."
+  "examStartedNoEdit": "Die Prüfung hat begonnen. Du kannst das Quiz während der Prüfung nicht bearbeiten."

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2611d04 and 1ebdd8d.

📒 Files selected for processing (3)

• src/main/webapp/app/exercises/shared/exam-exercise-row-buttons/exam-exercise-row-buttons.component.html (1 hunks)
• src/main/webapp/i18n/de/quizExercise.json (1 hunks)
• src/main/webapp/i18n/en/quizExercise.json (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

src/main/webapp/app/exercises/shared/exam-exercise-row-buttons/exam-exercise-row-buttons.component.html (1)

Pattern src/main/webapp/**/*.html: @if and @for are new and valid Angular syntax replacing *ngIf and *ngFor. They should always be used over the old style.

src/main/webapp/i18n/de/quizExercise.json (1)

Pattern src/main/webapp/i18n/de/**/*.json: German language translations should be informal (dutzen) and should never be formal (sietzen). So the user should always be addressed with "du/dein" and never with "sie/ihr".

🔇 Additional comments (2)

src/main/webapp/app/exercises/shared/exam-exercise-row-buttons/exam-exercise-row-buttons.component.html (1)

Line range hint 1-162: LGTM! Template follows Angular syntax guidelines.

The template consistently uses the new @if syntax instead of *ngIf throughout, adhering to the coding guidelines.

src/main/webapp/i18n/en/quizExercise.json (1)

47-48: LGTM! Translation changes look good.

The new translation key and message are clear, concise, and accurately convey the intended meaning for the tooltip.