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

Exam mode: Warn user before reloading the page #10193

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

Conversation

badkeyy
Copy link
Contributor

@badkeyy badkeyy commented Jan 22, 2025

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 principle of data economy for all client-server REST calls.
  • 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 #10142

Exam Mode Testing

Prerequisites:

  • 1 Instructor
  • 1 Students
  • 1 Exam with a Programming Exercise
  1. Log in to Artemis
  2. Participate in the exam as a student
  3. Try to reload the page
  4. Find that your browser warns you of unsaved changes before it reloads

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

Summary by CodeRabbit

  • New Features
    • Added a browser warning mechanism to prevent accidental page exits during an exam, enhancing user experience and exam integrity.
    • Introduced localized warning messages for unsaved changes in both English and German.

@badkeyy badkeyy requested a review from a team as a code owner January 22, 2025 18:07
@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Jan 22, 2025
Copy link

coderabbitai bot commented Jan 22, 2025

Walkthrough

The pull request introduces a new functionality to the ExamParticipationComponent by adding a @HostListener that listens for the beforeunload event. This triggers a method to check if the exam is ongoing, preventing the default action and displaying a warning message if the user attempts to leave or reload the page. Additionally, new warning messages are added in both English and German language JSON files to inform users about potential data loss.

Changes

File Change Summary
src/main/webapp/app/exam/participate/exam-participation.component.ts - Added HostListener import from @angular/core
- Implemented beforeUnloadHandler method for page unload warning
src/main/webapp/i18n/de/exam.json - Added reloadWarning message in German for page reload alert
src/main/webapp/i18n/en/exam.json - Added reloadWarning message in English for page reload alert

Assessment against linked issues

Objective Addressed Explanation
Warn user before reload when in exam mode [#10142]

Possibly related PRs

Suggested Labels

tests, bugfix, documentation, small

Suggested Reviewers

  • BBesrour
  • krusche
  • coolchock
  • SimonEntholzer
  • EneaGore
  • JohannesStoehr

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 60b172c and 9f9c080.

📒 Files selected for processing (3)
  • src/main/webapp/app/exam/participate/exam-participation.component.ts (2 hunks)
  • src/main/webapp/i18n/de/exam.json (1 hunks)
  • src/main/webapp/i18n/en/exam.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/main/webapp/app/exam/participate/exam-participation.component.ts
🧰 Additional context used
📓 Path-based instructions (1)
src/main/webapp/i18n/de/exam.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".

⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: client-tests
  • GitHub Check: server-tests
  • GitHub Check: Build and Push Docker Image
  • GitHub Check: Analyse
🔇 Additional comments (2)
src/main/webapp/i18n/en/exam.json (1)

343-344: LGTM! Clear and well-structured warning message.

The English translation effectively communicates:

  1. The action being taken ("reload the page")
  2. The consequences ("unsaved changes will be lost")
  3. Request for confirmation ("Are you sure")
src/main/webapp/i18n/de/exam.json (1)

343-344: LGTM! German translation follows guidelines and matches English meaning.

The German translation:

  1. Correctly uses informal "du" form as required
  2. Maintains the same meaning as the English version
  3. Follows proper German grammar and structure

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

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: 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 dd3bda4 and 60b172c.

📒 Files selected for processing (1)
  • src/main/webapp/app/exam/participate/exam-participation.component.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
src/main/webapp/app/exam/participate/exam-participation.component.ts (1)

Pattern src/main/webapp/**/*.ts: angular_style:https://angular.io/guide/styleguide;methods_in_html:false;lazy_loading:true;code_reuse:true;tests:meaningful;types:PascalCase;enums:PascalCase;funcs:camelCase;props:camelCase;no_priv_prefix:true;strings:single_quotes;localize:true;btns:functionality;links:navigation;icons_text:newline;labels:associate;code_style:arrow_funcs,curly_braces,open_braces_same_line,indent_4;memory_leak_prevention:true;routes:naming_schema;chart_framework:ngx-charts;responsive_layout:true

⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: client-tests
  • GitHub Check: server-tests
  • GitHub Check: Build and Push Docker Image
  • GitHub Check: Analyse
🔇 Additional comments (1)
src/main/webapp/app/exam/participate/exam-participation.component.ts (1)

1-1: LGTM!

The HostListener import is correctly added to the existing @angular/core imports.

Comment on lines 263 to 268
//Make sure to warn the user before leaving the page in exam mode
@HostListener('window:beforeunload', ['$event'])
beforeUnloadHandler(event: BeforeUnloadEvent) {
event.preventDefault();
}

Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Enhance the reload warning implementation.

The current implementation prevents the default behavior but doesn't show a confirmation dialog. To properly warn users before reloading:

  1. Return a string message to show the browser's default confirmation dialog.
  2. Add a guard to only show the warning during active exams.

Apply this diff to improve the implementation:

 //Make sure to warn the user before leaving the page in exam mode
 @HostListener('window:beforeunload', ['$event'])
 beforeUnloadHandler(event: BeforeUnloadEvent) {
+    // Only show warning if exam is active and not over
+    if (this.examStartConfirmed && !this.isOver()) {
         event.preventDefault();
+        // Return a string to show browser's default confirmation dialog
+        return this.translateService.instant('artemisApp.examParticipation.reloadWarning');
+    }
+    return true;
 }

Committable suggestion skipped: line range outside the PR's diff.

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: Ready For Review
Development

Successfully merging this pull request may close these issues.

Warn user before reload when in exam mode
1 participant