fix: Prevent duplicate page loads on rapid keyboard shortcut use (fixes #198).

[Henry8192]

Description

Fixes #198.

Checklist

• The PR satisfies the contribution guidelines.
• This is a breaking change and that has been indicated in the PR title, OR this isn't a
  breaking change.
• Necessary docs have been updated, OR no docs need to be updated.

Validation performed

1. Open log viewer and load a log file using the provided link.
2. Set the page size to 10000 or less, open the console.
3. Press and hold Ctrl/ Cmd + [ and observe that each page gets loaded only once.

Summary by CodeRabbit

Summary by CodeRabbit

• Bug Fixes
  • Improved navigation stability by ensuring that rapid page requests are paused during high-speed loading, preventing accidental multiple transitions.
  • Added a safeguard to prevent navigation actions when the UI is not ready, enhancing overall control flow.

[coderabbitai]

Walkthrough

This PR modifies the loadPageByAction function in the StateContextProvider component. A new conditional check is added to detect when the UI state is UI_STATE.READY. If this condition is not met, a warning is logged, and the function returns early, preventing further navigation actions during an inappropriate UI state. Additionally, a redundant blank line is removed for improved code readability.

Changes

File	Change Summary
src/contexts/StateContextProvider.tsx	Added a conditional check in loadPageByAction to log a warning and return early if the UI is not in UI_STATE.READY; removed an extra blank line.

Sequence Diagram(s)

sequenceDiagram
    participant UI as User Interface
    participant SCP as StateContextProvider
    participant Console as Console

    UI->>SCP: Trigger navigation action
    SCP->>SCP: Check UI state (READY?)
    alt UI_STATE is not READY
        SCP->>Console: Log warning "Page load in progress"
        SCP-->>UI: Return early (skip navigation)
    else
        SCP->>SCP: Set UI state to READY
        SCP->>Other: Continue with navigation actions
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Lock keybindings during page loading to prevent duplicate loads (198)	✅

Possibly related PRs

• new-log-viewer: Add event cursor, refactor state context, and redesign load page methods to support discontinuous log event numbers in preparation for log level filtering. #76: Contains changes in the loadPageByAction method, showing a direct code-level connection with the conditional logic introduced in this PR.
• feat(settings): Reload file instead of the whole app when applying settings. #185: Related to modifications in the loadPageByAction function, indicating a direct connection in their functionality.

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 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 2dbfded and b966521.

📒 Files selected for processing (1)

• src/contexts/StateContextProvider.tsx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/contexts/StateContextProvider.tsx

---

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

[junhaoliao]

The descriptions in Conventional Messages are usually in imperative mood.

for the PR title, how about:

fix: Prevent duplicate page loads on rapid keyboard shortcut use (fixes #198).

[davemarco]

I looked briefly

Couple questions.

• does it make sense to lift the state check to here. Not sure if better or not but will block all actions not just page load.
• Consider checking if state != ready, vs state == fastloading

[Henry8192]

• does it make sense to lift the state check to here. Not sure if better or not but will block all actions not just page load.

If you mean add the state check right after the first four case checks, I believe it is identical right?

• Consider checking if state != ready, vs state == fastloading

Good one.

[davemarco]

If you mean add the state check right after the first four case checks, I believe it is identical right?

I think if just 4 then identical, but maybe we want to block all actions.
like handleCopyLogEventAction(editor, beginLineNumToLogEventNumRef.current); might have some weird behavior with log level filter

anyways we'll see what @junhaoliao thinks

[Henry8192]

ah, I see what you mean now. I agree with that then, it would make a lot of sense for editors to check uiStates before performing any actions.

[Henry8192]

But what the cons for this approach is that whenever uiState changes, this callback function gets re-rendered. Do we want to do that?

[davemarco]

But what the cons for this approach is that whenever uiState changes, this callback function gets re-rendered. Do we want to do that?

It's probably fine, but if you want you can test that nothing really slow happens. Or you can try and just pass the uiState ref instead?

[junhaoliao]

• i agree it's better to check against READY

• regarding the modification in loadPageByAction:

  • whether we block actions or not in the editor, i believe we want to constrain the request queue to only allow one page-load request at a time (unless you mean we want to queue page load requests?). that's to say, modifying loadPageByAction is the minimum we want to do.
  • that said, i believe we can move the check after we know the action is not a RELOAD one. a RELOAD action reloads the file by calling loadFile, which destroys the existing worker and as a result drops all previous requests. since loading a file is the end result and any previous requests won't cause confusion / conflicts, i think it's better to respect the RELOAD action call.

• regarding whether we want to prevent other editor actions when the app is loading:

  • probably not. currently we don't disable inputs on the editor when the app is loading, which means users are allowed to select / copy any text when loading. if we want to disable those editor actions, which for example includes copying some log event, we might want to disable the other inputs as well for consistency. and that's probably not what we want