Fead/add dict args

[kjdev]

Summary by CodeRabbit

• New Features

  • Added optional dictionary support to compression and decompression functions, allowing you to use custom dictionaries for improved performance.
  • Both one-shot and incremental compression/decompression functions now accept an optional dictionary parameter.

• Documentation

  • Updated documentation to describe the new dictionary parameter and its usage in relevant functions.

• Tests

  • Introduced new and updated tests to verify dictionary-based compression and decompression, including edge cases and named argument support.

• Deprecation

  • Marked older dictionary-specific functions as deprecated in the documentation.

[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

This change adds an optional dictionary parameter to the main compression and decompression functions in the PHP Zstd extension, updating their signatures, documentation, and argument info. Multiple new and updated tests verify dictionary-based compression and decompression, both in one-shot and incremental modes. Deprecated dictionary-specific functions are marked as such.

Changes

Cohort / File(s)	Change Summary
Function Signatures, Argument Info, Deprecation zstd.c, zstd.stub.php	Added optional ?string $dict = null parameter to zstd_compress, zstd_uncompress, zstd_compress_init, and zstd_uncompress_init (both global and namespaced). Updated argument info. Marked zstd_compress_dict and zstd_uncompress_dict as deprecated.
Documentation README.md	Updated documentation to describe the new optional dictionary parameter for relevant functions and added usage notes.
New Tests: Dictionary Compression/Decompression tests/dictionary_b.phpt, tests/dictionary_01_b.phpt, tests/inc_dictionary.phpt	Added new tests to verify dictionary-based compression and decompression, including incremental and various compression levels.
Updated Tests: Named Arguments and Error Handling tests/named_args.phpt, tests/inc_named_args.phpt, tests/005_b.phpt	Updated and extended tests to cover dictionary argument usage, named arguments, and revised error messages for argument count.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PHP_Zstd_Ext
    participant Zstd_Lib

    User->>PHP_Zstd_Ext: zstd_compress(data, level, dict)
    PHP_Zstd_Ext->>Zstd_Lib: Compress data with optional dict
    Zstd_Lib-->>PHP_Zstd_Ext: Compressed output
    PHP_Zstd_Ext-->>User: Return compressed data

    User->>PHP_Zstd_Ext: zstd_uncompress(data, dict)
    PHP_Zstd_Ext->>Zstd_Lib: Decompress data with optional dict
    Zstd_Lib-->>PHP_Zstd_Ext: Decompressed output
    PHP_Zstd_Ext-->>User: Return decompressed data

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 minutes

Possibly related PRs

• kjdev/php-ext-zstd#81: Refactors and fixes streaming decompression with dictionaries, affecting related functionality but focusing on zstd_uncompress_dict.
• kjdev/php-ext-zstd#86: Refactors internal context initialization and dictionary handling, which directly relates to the new optional dictionary parameter support in public APIs.

Poem

In the warren of code, a new path we see,
Where dictionaries hop with compressing glee.
Old ways deprecated, new tests abound,
Now Zstd with context and dict can be found!
With every byte zipped, a bunny’s delight—
Compression with dictionaries, working just right! 🐇✨

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fead/add-dict-args

---

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 generate unit tests to generate unit tests for 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.