Increase default decoder limits to allow baton to list resources with big c1zs.

[ggreer]

Also print the env vars that are needed to change the limits.

Summary by CodeRabbit

• New Features

  • Increased the maximum size for decoding operations from 2 GiB to 3 GiB.
  • Expanded the memory allocated for the decoder from 32 MiB to 128 MiB.

• Improvements

  • Updated error messages for better clarity, providing users with specific instructions on adjusting decoder settings using environment variables.

[coderabbitai]

Walkthrough

The recent updates to the decoder.go file enhance memory allocation and decoding capabilities, increasing the maximum decoded size from 2 GiB to 3 GiB and expanding the decoder's memory limit from 32 MiB to 128 MiB. Additionally, error messages now include detailed instructions for adjusting these limits through environment variables, improving both functionality and user experience for developers.

Changes

Files	Change Summary
pkg/dotc1z/decoder.go	Increased defaultMaxDecodedSize to 3 GiB and defaultDecoderMaxMemory to 128 MiB. Updated error messages to include instructions for using environment variables to adjust limits.

Poem

🐇 In fields of code, where changes bloom,
A decoder grows, dispelling gloom.
With memory vast and limits raised,
Errors now guide, leaving us amazed!
Let's hop with joy, our work in tune,
A brighter path beneath the moon! 🌙✨

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cc896ac and 5b128af.

Files selected for processing (1)

• pkg/dotc1z/decoder.go (2 hunks)

Additional comments not posted (4)

pkg/dotc1z/decoder.go (4)

17-17: Increase in defaultMaxDecodedSize is appropriate.

The increase from 2 GiB to 3 GiB aligns with the PR objectives to handle larger datasets. Ensure that this change does not affect other parts of the system that might depend on the previous limit.

---

18-18: Increase in defaultDecoderMaxMemory is appropriate.

The increase from 32 MiB to 128 MiB supports enhanced memory allocation for decoding operations. Ensure that this change does not affect other parts of the system that might depend on the previous limit.

---

27-27: Updated error message for ErrMaxSizeExceeded improves usability.

Including instructions for using the BATON_DECODER_MAX_DECODED_SIZE_MB environment variable enhances clarity for users. Ensure this variable is documented for user reference.

---

28-28: Updated error message for ErrWindowSizeExceeded improves usability.

Including instructions for using the BATON_DECODER_MAX_MEMORY_MB environment variable enhances clarity for users. Ensure this variable is documented for user reference.