change: error message

[kjdev]

Summary by CodeRabbit

• Bug Fixes
  • Improved error messages to display specific details from the zstd library, making warnings clearer and more informative during compression and decompression failures.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes update error handling in the zstd.c file by replacing static error messages with dynamic ones retrieved from ZSTD_getErrorName(result). This affects various compression and decompression functions, ensuring that warnings display specific error details from the zstd library. The control flow and error handling logic remain unchanged.

Changes

File(s)	Change Summary
zstd.c	Replaced static error messages in warnings with ZSTD_getErrorName(result) for more specific error reporting in multiple compression and decompression functions; updated some generic messages for clarity; switched some warnings to use ZSTD_WARNING macro.

Poem

A hop and a skip through error’s domain,
Now warnings are clear, no longer plain.
With ZSTD’s own words, the bugs we shall name,
Each message precise, never the same.
So code may compress, decompress with delight—
For rabbits and humans, errors now bright!
🐇✨

---

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

• 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

[kjdev]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 1

🔭 Outside diff range comments (1)

zstd.c (1)

1107-1113: ⚠️ Potential issue

Fix misleading error message for decompression context.

The error message says "compression context failed" but this code path is for decompression context creation (ZSTD_createDCtx()).

Apply this diff to fix the misleading error message:

-            ZSTD_WARNING("zstd: compression context failed");
+            ZSTD_WARNING("zstd: decompression context failed");

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c6b079e and 01fa565.

📒 Files selected for processing (1)

• zstd.c (16 hunks)

🔇 Additional comments (9)

zstd.c (9)

423-427: LGTM! Improved error specificity.

The change from a static error message to ZSTD_getErrorName(result) provides more specific error details from the zstd library, which will help with debugging.

---

441-447: LGTM! Consistent error handling improvements.

Both changes correctly use ZSTD_getErrorName(result) to provide specific error details from the zstd library instead of generic messages.

Also applies to: 464-470

---

505-517: LGTM! Appropriate error handling for different failure types.

The changes use specific ZSTD error names for compression operations (ZSTD_getErrorName(cSize)) and descriptive generic messages for resource allocation failures (context creation, dictionary loading). This approach provides appropriate detail for each error type.

Also applies to: 526-532

---

657-662: LGTM! Consistent error handling pattern.

The generic error message for context creation failure is appropriate and consistent with similar error handling elsewhere in the code.

---

702-705: LGTM! Appropriate error handling for different error types.

Line 703 uses a descriptive generic message for context validation failure, while line 715 correctly uses ZSTD_getErrorName(res) for ZSTD operation errors. This follows the established pattern of using specific error names for library operations and generic messages for validation/resource errors.

Also applies to: 714-718

---

730-735: LGTM! Consistent error handling across uncompress functions.

The changes maintain the established pattern: generic descriptive messages for context creation and validation failures, and specific ZSTD error details for library operation failures.

Also applies to: 772-775, 789-793

---

854-857: LGTM! Enhanced error reporting in streaming operations.

All three changes correctly use ZSTD_getErrorName(res) with a "zstd: " prefix to provide specific error details in streaming contexts. The prefix helps identify the source of errors in stream operations.

Also applies to: 935-940, 975-980

---

1072-1076: LGTM! Informative compression level validation.

The error message provides specific details about the valid compression level range, which helps users understand the constraint.

---

1090-1095: LGTM! Consistent error handling for context creation.

The generic error message for compression context creation failure is appropriate and consistent with the established pattern.