Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

laxerhd
Copy link
Contributor

@laxerhd laxerhd commented Feb 28, 2025

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), and reopened again because old PR was open for too long #10082.

Checklist

General

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

image
image

Summary by CodeRabbit

  • New Features
    • Enhanced the exercise edit button with a conditional tooltip to inform users that editing is disabled once an exam has started.
    • Updated localized messages in English and German to clearly indicate that quiz editing is not permitted during an active exam.

@laxerhd laxerhd requested a review from a team as a code owner February 28, 2025 16:44
@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Feb 28, 2025
@helios-aet helios-aet bot temporarily deployed to artemis-test1.artemis.cit.tum.de March 4, 2025 12:50 Inactive
Copy link
Contributor

@AjayvirS AjayvirS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this functionality, tested on TS1 and it works as intended
image

Copy link

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.

@github-actions github-actions bot added the stale label Mar 12, 2025
Copy link

coderabbitai bot commented Mar 12, 2025

Walkthrough

The changes update the exam exercise row buttons component by wrapping the edit button in a <span> that conditionally shows a tooltip if the exam has started. Additionally, localization files for both German and English receive a new key (examStartedNoEdit) with a message indicating that the quiz cannot be edited once the exam has begun.

Changes

File(s) Change Summary
src/…/exam-exercise-row-buttons.component.html Wrapped the edit button in a <span> that conditionally displays a tooltip based on the return value of hasExamStarted(), informing the user that editing is disabled after the exam starts.
src/…/i18n/*/quizExercise.json Added a new key-value pair (examStartedNoEdit) in the “edit” section to display messages in German and English when quiz editing is restricted after the exam begins.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ExamComponent
    User->>ExamComponent: Hover over edit button
    ExamComponent->>ExamComponent: Call hasExamStarted()
    alt Exam has started
        ExamComponent->>User: Display tooltip with exam restriction message
    else
        ExamComponent->>User: Display normal edit button
    end

Possibly related PRs

Suggested labels

user interface, bugfix, ready for review

Suggested reviewers

  • EneaGore
  • SimonEntholzer
  • krusche
  • HawKhiem
  • florian-glombik

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
  • @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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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: Conditional Tooltip Implementation and Accessibility Enhancement
The added <span> wrapping the edit button with a conditional tooltip using ngbTooltip is clear and correctly leverages the hasExamStarted() function. This cleanly disables the edit function when the exam is running.

To further improve accessibility, consider adding an aria-disabled attribute on the anchor element so that assistive technologies understand the button’s disabled state.

-                <a
-                    [class.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"
-                >
+                <a
+                    [class.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"
+                >
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 93eba08 and 8c4d7c6.

📒 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/**/*.html`: @if and @for are new and valid ...

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/app/exercises/shared/exam-exercise-row-buttons/exam-exercise-row-buttons.component.html
`src/main/webapp/i18n/de/**/*.json`: German language transla...

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".

  • src/main/webapp/i18n/de/quizExercise.json
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Codacy Static Code Analysis
🔇 Additional comments (2)
src/main/webapp/i18n/en/quizExercise.json (1)

46-48: New Translation Key for Exam Edit Restriction (English)
The new key "examStartedNoEdit" has been added under the "edit" section with clear, concise messaging:

"examStartedNoEdit": "The exam has started. The quiz cannot be edited for the duration of the exam."

This matches the UI requirement to inform users when editing is disabled during an exam.

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

47-48: New Translation Key for Exam Edit Restriction (German)
The new key "examStartedNoEdit" is correctly added under the "edit" section with the translation:

"examStartedNoEdit": "Die Prüfung hat begonnen. Das Quiz kann für die Dauer der Prüfung nicht bearbeitet werden."

This message is clear and consistent with the English version while adhering to the informal tone guidelines.

@github-actions github-actions bot removed the stale label Mar 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!)
Projects
Status: Work In Progress
Development

Successfully merging this pull request may close these issues.

Quiz exercises: Edit button is disabled in exercise groups list
2 participants