fix: increase websocket payload default max size

[rikublock]

High Level Overview of Change

Certain requests (e.g. LedgerData) may return payloads that exceed the current maximum (2**20).

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Refactor (non-breaking change that only restructures code)
• Tests (You added tests for code that already exists, or your new feature included in this PR)
• Documentation Updates
• Release

Did you update CHANGELOG.md?

• Yes
• No, this change does not impact library users

[coderabbitai]

Walkthrough

The changes introduce a new constant _PAYLOAD_MAX_SIZE set to 2**24 in the WebSocket base client of the XRPL library. This constant defines the maximum size for WebSocket messages and is utilized in the _do_open method when connecting to the WebSocket client. Additionally, the changelog has been updated to reflect an increase in the default maximum payload size for the WebSocket client, enhancing its ability to handle larger data transmissions.

Changes

File	Change Summary
xrpl/asyncio/clients/websocket_base.py	Added _PAYLOAD_MAX_SIZE constant set to 2**24, used in WebSocket connection configuration.
CHANGELOG.md	Updated to include a new entry for an increased default maximum payload size for the WebSocket client under the "Unreleased" section.

Poem

🐰 Websocket whispers, payload bound tight
A rabbit's limit, set just right
Twenty-four bits of data's might
Connecting worlds with measured flight
XRPL's message, crisp and bright! 🌐

Finishing Touches

• 📝 Generate Docstrings

---

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.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

xrpl/asyncio/clients/websocket_base.py (1)

19-19: Clarify usage context for the PAYLOAD_MAX_SIZE.

Providing a short docstring or explanatory comment for the PAYLOAD_MAX_SIZE constant would help maintainers and extend the clarity of its intended usage. Consider adding context on why 16 MB was chosen and how it addresses the larger payload sizes.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8c6b489 and c3d8e84.

📒 Files selected for processing (1)

• xrpl/asyncio/clients/websocket_base.py (2 hunks)

🔇 Additional comments (1)

xrpl/asyncio/clients/websocket_base.py (1)

94-96: Ensure that the environment can handle large payloads.

While raising the max_size parameter to 16 MB fixes the immediate issue, consider verifying that this change does not lead to unintended memory overhead or performance bottlenecks. Ensure there are appropriate tests or monitoring in place for large payload handling.

[mvadari]

Please update the changelog

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

CHANGELOG.md (1)

10-11: Enhance the changelog entry with more details.

The changelog entry could be more informative by including the specific size increase and the motivation. Consider expanding it to:

- - Increase default maximum payload size for websocket client
+ - Increase default maximum payload size for websocket client from 1MB to 16MB to handle larger LedgerData responses

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c3d8e84 and 91cc71f.

📒 Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• xrpl/asyncio/clients/websocket_base.py (2 hunks)

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

• xrpl/asyncio/clients/websocket_base.py

[rikublock]

Added the requested changes.