add err to OnConnectionLost

[insipx]

Summary by CodeRabbit

• New Features

  • Enhanced error handling for connection loss by allowing callbacks to receive error information.

• Bug Fixes

  • Improved clarity in connection loss management, aiding in troubleshooting.

[changeset-bot]

⚠️ No Changeset found

Latest commit: d36d24f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve an update to the OnConnectionLostCallback type in the ApiClient.ts file. The signature of this callback has been modified to optionally accept an Error object, enhancing the callback's ability to provide error information when a connection is lost. No other parts of the code were altered, and the existing error handling functions remain unchanged.

Changes

File Path	Change Summary
sdks/js-sdk/src/ApiClient.ts	Updated OnConnectionLostCallback type signature from () => void to (err?: Error) => void.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ApiClient

    Client->>ApiClient: Attempt to connect
    ApiClient-->>Client: Connection established
    Client->>ApiClient: Connection lost
    ApiClient-->>Client: OnConnectionLostCallback(err)

Loading

🐇 In the meadow, a change took flight,
A callback now with error insight.
When connections fade and signals stray,
An Error whispers what to say.
Hopping forward, we embrace the new,
With better handling, our code will brew! 🌼

---

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

[cloudflare-workers-and-pages]

Deploying xmtp-js-docs with    Cloudflare Pages

Latest commit:	d36d24f
Status:	⚡️  Build in progress...

View logs

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

sdks/js-sdk/src/ApiClient.ts (1)

Line range hint 326-347: Pass the error to OnConnectionLostCallback in the catch block.

The callback is now capable of receiving an error parameter, but it's not being utilized. Consider passing the error to provide valuable context about why the connection was lost:

          console.info("Stream connection closed. Resubscribing");
          if (new Date().getTime() - startTime < 1000) {
            await sleep(1000);
          }

-          onConnectionLost?.();
+          onConnectionLost?.(err);

This change would help consumers better understand and handle connection loss scenarios, especially for error cases that might require different recovery strategies.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 78f2141 and 9322d17.

📒 Files selected for processing (1)

• sdks/js-sdk/src/ApiClient.ts (1 hunks)

🔇 Additional comments (1)

sdks/js-sdk/src/ApiClient.ts (1)

107-107: LGTM! Type signature change maintains backward compatibility.

The addition of an optional Error parameter to OnConnectionLostCallback enhances error handling capabilities while maintaining backward compatibility with existing code.