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

[laxerhd]

Opening this PR from a branch in the main repository to enable test server deployment, as it wasn't possible with the previous PR from a forked repository (see #9917)

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.
Closes #9865.

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

  • Conditional rendering of an edit button with a tooltip indicating editing restrictions once an exam has started.
  • Added messages in German and English informing users that quizzes cannot be edited during an active exam.

• Bug Fixes

  • Minor formatting adjustments made to existing JSON entries for consistency.

[coderabbitai]

Walkthrough

The pull request introduces changes to improve the user experience when editing quiz exercises during an exam. The modifications include updating the HTML template for exam exercise row buttons to add a tooltip when editing is not allowed, and adding localized messages in German and English translation files to clearly communicate the editing restrictions when an exam has started.

Changes

File	Change Summary
src/main/webapp/app/exercises/shared/exam-exercise-row-buttons/exam-exercise-row-buttons.component.html	Added tooltip wrapper for edit button to provide user feedback when editing is disabled
src/main/webapp/i18n/de/quizExercise.json	Added German translation for exam edit restriction message
src/main/webapp/i18n/en/quizExercise.json	Added English translation for exam edit restriction message

Assessment against linked issues

Objective	Addressed	Explanation
Edit button should not be disabled in exercise groups list [#9865]	❓	The changes suggest a tooltip approach rather than fully enabling the button

Possibly related PRs

• Assessment: Add tool tips for assessment notes  #8552: Adds tooltips for assessment notes
• Programming exercises: Improve template/solution comparison visibility #8745: Improves tooltip visibility for programming exercises
• Programming exercises: Adjust translations for participation mode tooltips #9468: Adds tooltips for participation modes
• Quiz exercises: Improve user interface of quiz header and footer #9744: Adjusts quiz header and footer UI
• Integrated code lifecycle: Show result progress bar in exam overview and exercise details pages #10048: Introduces progress bar for result updates

Suggested labels

user interface, bugfix, documentation, ready for review

Suggested reviewers

• florian-glombik
• 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[laxerhd]

@coderabbitai review

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

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

111-120: Consider enhancing the disabled state implementation

The tooltip implementation looks good and aligns with the PR objectives. However, the disabled state is only implemented via CSS class which might not prevent all interactions.

Consider enhancing the disabled state implementation:

 <span [ngbTooltip]="hasExamStarted() ? ('artemisApp.quizExercise.edit.examStartedNoEdit' | artemisTranslate) : undefined">
     <a
         [class.disabled]="hasExamStarted()"
+        [attr.disabled]="hasExamStarted()"
+        [attr.aria-disabled]="hasExamStarted()"
         [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"
     >
         <fa-icon [icon]="faWrench" />
         <span class="d-none d-md-inline" jhiTranslate="entity.action.edit"></span>
     </a>
 </span>

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d8d2239 and 9d9d141.

📒 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/i18n/en/quizExercise.json (1)

47-48: LGTM! Clear and consistent translations

The translation text is clear, concise, and maintains consistent punctuation.

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

47-48: LGTM! Proper informal German translation

The German translation correctly uses informal language (du-form) as per guidelines and maintains consistent meaning with the English version.

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.