Refactor: Login cooldown timer by Squidly271 · Pull Request #2303 · unraid/webgui

Squidly271 · 2025-07-22T07:03:48Z

Summary by CodeRabbit

Refactor
- Improved the accuracy and reliability of the login cooldown countdown timer, ensuring the timer displays the correct remaining time and updates more consistently. The message now automatically disappears 10 seconds after the countdown ends.

coderabbitai · 2025-07-22T07:03:56Z

Walkthrough

The JavaScript countdown timer logic for the login cooldown message was refactored from a decrementing seconds counter to a time-based calculation using absolute timestamps. Helper functions were reorganized within the conditional block, but the overall UI update and control flow remain unchanged.

Changes

File(s)	Change Summary
emhttp/plugins/dynamix/include/.login.php	Refactored countdown timer logic from decrementing variable to timestamp-based calculation; reorganized helper functions within conditional block.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant LoginPageScript

    User->>Browser: Triggers login cooldown
    Browser->>LoginPageScript: Loads login page with cooldown
    LoginPageScript->>LoginPageScript: Initialize start and end timestamps
    loop Every second
        LoginPageScript->>LoginPageScript: Calculate remaining time
        LoginPageScript->>Browser: Update countdown message
        alt Time expired
            LoginPageScript->>Browser: Replace with "Wait for this message to disappear"
            LoginPageScript->>LoginPageScript: Set 10s timeout to remove message
        end
    end

Estimated code review effort

2 (~12 minutes)

Possibly related PRs

Feat: Add timer to login screen when cooldown period is active #2264: Both PRs modify the JavaScript countdown timer logic on the login cooldown message in emhttp/plugins/dynamix/include/.login.php, with the main PR refactoring the timer from a decrementing counter to a time-based calculation while the retrieved PR originally introduced the countdown timer feature.

Suggested labels

7.2

Suggested reviewers

zackspear

Poem

A countdown once ticked, second by second,
Now it counts time as the clock is reckoned.
With timestamps precise and logic anew,
The cooldown is smoother for users like you.
A hop and a skip, the login awaits,
While rabbits code time in their clever estates! 🕒🐇

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5c8cd74 and b48736d.

📒 Files selected for processing (1)

emhttp/plugins/dynamix/include/.login.php (1 hunks)

🧠 Learnings (2)

📓 Common learnings

Learnt from: Squidly271
PR: unraid/webgui#2264
File: emhttp/plugins/dynamix/include/.login.php:0-0
Timestamp: 2025-06-18T17:09:35.579Z
Learning: In the Unraid webGUI login system (emhttp/plugins/dynamix/include/.login.php), the cooldown timer restarting on page reload during the cooldown period is intentional behavior, not a bug. When a form is resubmitted during cooldown, the timer should restart to provide consistent user feedback.

Learnt from: Squidly271
PR: unraid/webgui#0
File: :0-0
Timestamp: 2025-05-31T05:10:13.120Z
Learning: Squidly271 prefers not to receive CodeRabbit reviews or feedback while PRs are in draft status. Only provide reviews after PRs are moved out of draft.

emhttp/plugins/dynamix/include/.login.php (1)

Learnt from: Squidly271
PR: #2264
File: emhttp/plugins/dynamix/include/.login.php:0-0
Timestamp: 2025-06-18T17:09:35.579Z
Learning: In the Unraid webGUI login system (emhttp/plugins/dynamix/include/.login.php), the cooldown timer restarting on page reload during the cooldown period is intentional behavior, not a bug. When a form is resubmitted during cooldown, the timer should restart to provide consistent user feedback.

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: Squidly271
PR: unraid/webgui#2264
File: emhttp/plugins/dynamix/include/.login.php:0-0
Timestamp: 2025-06-18T17:09:35.579Z
Learning: In the Unraid webGUI login system (emhttp/plugins/dynamix/include/.login.php), the cooldown timer restarting on page reload during the cooldown period is intentional behavior, not a bug. When a form is resubmitted during cooldown, the timer should restart to provide consistent user feedback.

Learnt from: Squidly271
PR: unraid/webgui#0
File: :0-0
Timestamp: 2025-05-31T05:10:13.120Z
Learning: Squidly271 prefers not to receive CodeRabbit reviews or feedback while PRs are in draft status. Only provide reviews after PRs are moved out of draft.

emhttp/plugins/dynamix/include/.login.php (1)

Learnt from: Squidly271
PR: #2264
File: emhttp/plugins/dynamix/include/.login.php:0-0
Timestamp: 2025-06-18T17:09:35.579Z
Learning: In the Unraid webGUI login system (emhttp/plugins/dynamix/include/.login.php), the cooldown timer restarting on page reload during the cooldown period is intentional behavior, not a bug. When a form is resubmitted during cooldown, the timer should restart to provide consistent user feedback.

🔇 Additional comments (4)

emhttp/plugins/dynamix/include/.login.php (4)

621-621: Clean variable declarations for the refactored timer logic.

The variable declarations properly initialize the new timestamp-based timer variables. The use of let for block-scoped variables is appropriate here.

623-629: Improved timer initialization with timestamp-based approach.

The refactor from a simple decrementing counter to timestamp-based calculation is a solid improvement. Using Math.floor(Date.now() / 1000) provides more accurate timing and eliminates potential drift issues that could occur with repeated setTimeout calls.

631-644: Robust timer tick implementation with proper cleanup.

The tick function correctly calculates remaining seconds by comparing current time to end time. The cleanup logic properly clears the interval and provides user feedback when the cooldown expires. The 10-second delay before completely removing the message gives users appropriate notice.

646-656: Well-structured helper functions maintain code organization.

The updateMessage and prettyTime helper functions are properly encapsulated within the conditional block and maintain their original functionality. The time formatting logic correctly handles minutes and seconds with appropriate zero-padding.

✨ Finishing Touches

📝 Generate Docstrings

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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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 anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

Refactor: Login cooldown timer

b48736d

ljm42 added the 7.2 label Jul 22, 2025

limetech merged commit 25c74a4 into unraid:master Jul 22, 2025
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Refactor: Login cooldown timer#2303

Refactor: Login cooldown timer#2303
limetech merged 1 commit into
unraid:masterfrom
Squidly271:patch-3

Squidly271 commented Jul 22, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 22, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Squidly271 commented Jul 22, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Squidly271 commented Jul 22, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 22, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)