a PR about issue #230

[zinsserzc]

I am using wechaty on my Mac Pc and I run into the error below.

16:52:32 ERR PuppetWeChatBridge start() exception: TimeoutError: Navigation timeout of 60000 ms exceeded
16:52:32 SILL StateSwitch <PuppetWeChatBridge> inactive() is false
16:52:32 VERB StateSwitch <PuppetWeChatBridge> inactive(true) <- (false)
16:52:32 ERR PuppetWeChat initBridge() exception: Navigation timeout of 60000 ms exceeded
16:52:32 VERB PuppetWeChatBridge stop()
16:52:32 SILL StateSwitch <PuppetWeChatBridge> inactive() is true
16:52:32 VERB StateSwitch <PuppetWeChatBridge> inactive(pending) <- (true)
16:52:32 WARN PuppetWeChatBridge stop() page.close() exception: Error: Protocol error: Connection closed. Most likely the page has been closed.
16:52:32 SILL PuppetWeChatBridge stop() browser.close()-ed
16:52:32 SILL StateSwitch <PuppetWeChatBridge> inactive() is pending
16:52:32 VERB StateSwitch <PuppetWeChatBridge> inactive(true) <- (pending)

I have checked the issues and find https://github.com/wechaty/puppet-wechat/issues/230 has the same situation. So I analyzed the start process of this puppet, and I assume the polling request on wx.qq.com prevents the page.goto() from reaching the 'load' state. I tested myself by using puppeteer to open 'wx.qq.com' and the page cannot reach the state of 'load'.
As a result, I tried to modify two parts of the code Bridge.ts about the waiting state of the Puppeteer.Page of opening the url 'wx.qq.com'. And it works.

---

[!IMPORTANT] Fix navigation timeout in PuppetWeChatBridge by using networkidle2 and changing load event listener to domcontentloaded in bridge.ts.

• Behavior:
  • Fix navigation timeout in initPage() in bridge.ts by setting waitUntil: 'networkidle2' in page.goto().
  • Change page load event listener from load to domcontentloaded in initPage() to handle polling requests on wx.qq.com.

^{This description was created by for 9e4df4f0f1a8ea5c9710e2078f1349c61486826d. It will automatically update as commits are pushed.}

Summary by CodeRabbit

• New Features
  • Improved page loading behavior by ensuring navigation waits for the network to be idle.
  • Updated event listener to respond to the domcontentloaded event for better control during page initialization.

[CLAassistant]

All committers have signed the CLA.

[coderabbitai[bot]]

Walkthrough

The pull request introduces modifications to the Bridge class in src/bridge.ts, focusing on improving page initialization and load handling. The changes address specific loading behaviors encountered on wx.qq.com by adjusting the page navigation method and event listener. The primary modifications include updating the page.goto() method to wait for network idle state and switching the event listener from 'load' to 'domcontentloaded' to better manage page loading dynamics.

Changes

File	Change Summary
src/bridge.ts	- Updated page.goto() to include { waitUntil: 'networkidle2' } option - Replaced 'load' event listener with 'domcontentloaded' event listener

Sequence Diagram

sequenceDiagram
    participant Browser
    participant Bridge
    participant Page

    Browser->>Page: Navigate to URL
    Page-->>Browser: Network idle state
    Browser->>Bridge: Emit 'domcontentloaded' event
    Bridge->>Bridge: Process page load

Poem

🐰 A Rabbit's Ode to Page Loading Grace 🌐

Network idle, content loaded light, No more waiting through the polling's might Smooth navigation, events aligned A bridge that knows just what to find Wx.qq.com, we've solved your plight! 🚀

[!TIP] CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 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 09fedb147bebee1e28ac03c50debb7267af4b3d9 and 9e4df4f0f1a8ea5c9710e2078f1349c61486826d.

📒 Files selected for processing (1)

• src/bridge.ts (2 hunks)

🔇 Additional comments (2)

src/bridge.ts (2)

255-258: Good use of 'networkidle2' mode for controlling page load completion.

This ensures the navigation call completes only after ongoing network requests have settled, which helps avoid timeouts caused by long-running polls on wx.qq.com. Just confirm that this works reliably across different network conditions.

---

269-271: Switching from 'load' event to 'domcontentloaded' is valid, but ensure downstream listeners are updated.

The 'domcontentloaded' event fires before all resources are loaded, so if any logic depends on fully loaded assets (e.g., images, scripts), verify no unexpected side effects occur. Otherwise, this approach can shorten loading times and resolve the previous hang.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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