Skip to content

fix: add page closed condition for highlighter #558

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

Merged
merged 1 commit into from
Apr 29, 2025

Conversation

amhsirak
Copy link
Member

@amhsirak amhsirak commented Apr 26, 2025

closes #559

Summary by CodeRabbit

  • Bug Fixes
    • Improved stability by ensuring mouse movement actions and related data generation do not occur on closed pages, preventing potential errors and unnecessary operations.

Copy link

coderabbitai bot commented Apr 26, 2025

Walkthrough

The handleMousemove function in the input handlers module was updated to include checks that prevent mouse movement actions and highlighter data generation if the associated page is closed. Specifically, before performing mouse movement or invoking the highlighter data generator, the function now verifies that the page is still open, logging a debug message and returning early if it is closed. No changes were made to public interfaces or exported function signatures.

Changes

File(s) Change Summary
server/src/browser-management/inputHandlers.ts Added checks in handleMousemove to ensure actions are not performed if the page is closed.

Poem

In the warren of code, a wise rabbit decreed,
"Don’t move the mouse if the page’s not in need!"
With careful new checks, our actions are sound,
No more lost events when the page can’t be found.
A hop and a skip, our handlers refined—
Bugs stay behind, and stability shines!
🐇✨

✨ 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.
    • 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 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.

@amhsirak amhsirak changed the title fix(cloud): add page closed condition for highlighter fix: add page closed condition for highlighter Apr 26, 2025
@amhsirak amhsirak added Type: Bug Something isn't working Priority: High Needs to be resolved ASAP labels Apr 26, 2025
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

🔭 Outside diff range comments (1)
server/src/browser-management/inputHandlers.ts (1)

225-242: 💡 Verification agent

🧩 Analysis chain

Consider applying similar checks to other handler functions

The handleWheel function already has a similar check for closed pages, but other handlers like handleKeydown, handleKeyup, etc. might benefit from the same pattern to ensure robust handling of browser state.


🏁 Script executed:

#!/bin/bash
# Check for other handlers that might benefit from page.isClosed() checks

# Look for handler functions that don't have isClosed checks
echo "Handler functions without isClosed checks:"
rg "const handle\w+ = async \(generator: WorkflowGenerator, page: Page" -A 5 | \
  rg -v "if \(page\.isClosed\(\)\)" | \
  rg "await page\." -B 5

# Count how many handler functions check for closed pages
echo -e "\nCount of handlers that check for page.isClosed():"
rg "if \(page\.isClosed\(\)\)" --count

Length of output: 3340


Apply page.isClosed() guards to all input handlers

Several other handlers in server/src/browser-management/inputHandlers.ts don’t check whether the target page is closed before performing operations. To prevent unhandled errors and no-ops against a closed page, add the same if (page.isClosed()) { logger.log('debug', …); return; } guard at the top of each handler:

• handleMousedown
• handleKeydown
• handleKeyup
• handleChangeUrl
• handleRefresh
• handleGoBack
• handleGoForward

You can copy the pattern from handleMousemove (or factor out a small HOC/helper) to keep the code DRY.

🧹 Nitpick comments (1)
server/src/browser-management/inputHandlers.ts (1)

232-236: Consider optimizing the throttle implementation

The throttled function is always created and called, even when the page is closed. While the inner function now has a guard clause, it would be slightly more efficient to check if the page is closed before setting up the throttle at all.

- throttle(async () => {
-     if (!page.isClosed()) {
-         await generator.generateDataForHighlighter(page, { x, y });
-     }
- }, 100)();
+ if (!page.isClosed()) {
+     throttle(async () => {
+         await generator.generateDataForHighlighter(page, { x, y });
+     }, 100)();
+ }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b0e8abe and cbc77f0.

📒 Files selected for processing (1)
  • server/src/browser-management/inputHandlers.ts (2 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
server/src/browser-management/inputHandlers.ts (1)
src/helpers/inputHelpers.ts (1)
  • throttle (9-20)
🔇 Additional comments (2)
server/src/browser-management/inputHandlers.ts (2)

227-230: Good defensive programming!

Adding this check to prevent mouse movement actions on closed pages is an excellent improvement. This will help avoid potential errors when attempting to interact with a page that's no longer available.


233-235: Good enhancement to prevent unnecessary processing

Wrapping the highlighter data generation in a condition that checks if the page is still open prevents unnecessary work and potential errors when the page has been closed between the mouse move and the throttled callback execution.

@amhsirak amhsirak requested a review from RohitR311 April 26, 2025 12:05
@amhsirak amhsirak merged commit 80be828 into develop Apr 29, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: High Needs to be resolved ASAP Type: Bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: mouse movement occurs on closed pages
1 participant