refactor: change use BrotliEncoderCompressStream() in brotli_compress()

[kjdev]

Summary by CodeRabbit

• Refactor
  • Improved the internal compression process for better efficiency and reliability when compressing data using Brotli. No changes to the user interface or function signatures.

[coderabbitai]

Walkthrough

The brotli_compress function in brotli.c was refactored from a single-call compression approach to a streaming compression loop using BrotliEncoderCompressStream. The new implementation manages compression in chunks, accumulating the output incrementally with a smart_string, and utilizes a php_brotli_context for encoder state. Error handling was updated to account for encoder creation and streaming failures, ensuring proper resource management. No changes were made to the signatures of exported or public entities; all modifications are internal to the function's implementation.

Changes

File(s)	Change Summary
brotli.c	Refactored brotli_compress to use a streaming compression loop with BrotliEncoderCompressStream, replaced single-call compression, added chunked output accumulation, updated error handling, and removed unused variables.

Sequence Diagram(s)

sequenceDiagram
    participant PHP_User
    participant brotli_compress
    participant php_brotli_context
    participant BrotliEncoder

    PHP_User->>brotli_compress: Call with input data, quality, mode
    brotli_compress->>php_brotli_context: Initialize context with encoder
    brotli_compress->>BrotliEncoder: Create encoder instance
    alt Encoder creation fails
        brotli_compress-->>PHP_User: Return false
    else Encoder created
        loop While compression not finished
            brotli_compress->>BrotliEncoder: Compress chunk (BrotliEncoderCompressStream)
            BrotliEncoder-->>brotli_compress: Return compressed output
            brotli_compress->>brotli_compress: Accumulate output in smart_string
        end
        brotli_compress->>php_brotli_context: Free context
        brotli_compress-->>PHP_User: Return compressed PHP string
    end

Loading

Possibly related PRs

• refactor: php_brotli_context struct #60: Refactored and centralized the php_brotli_context struct, which is now directly used in the new streaming implementation of brotli_compress.
• Refactor/coder create #62: Introduced context-based encoder management, enabling the streaming approach adopted in the refactored brotli_compress.
• refactor: php_brotli_stream_data struct #61: Refactored stream data structures to embed php_brotli_context, paralleling the context-based changes in compression.

Poem

In brotli’s warren, code hops anew,
From single squeeze to streaming through—
Chunks compressed, a string grows strong,
With context guiding all along.
No buffer lost, no data stray,
The rabbit’s code now hops this way!
🐇✨

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e450471 and a14f7e0.

📒 Files selected for processing (1)

• brotli.c (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (18)

• GitHub Check: ci (7.3-alpine, ghcr.io/kjdev/php, linux/amd64)
• GitHub Check: ci (8.0-alpine, ghcr.io/kjdev/php, linux/amd64)
• GitHub Check: ci (8.1-zts-alpine, system, apcu, php, linux/amd64)
• GitHub Check: ci (8.1-alpine, apcu, php, linux/amd64)
• GitHub Check: ci (8.1-alpine, php, linux/amd64)
• GitHub Check: ci (8.2-zts-alpine, system, php, linux/amd64)
• GitHub Check: ci (8.4-zts-alpine, apcu, php, linux/amd64)
• GitHub Check: ci (8.3-alpine, apcu, php, linux/amd64)
• GitHub Check: ci (8.3, x86, ts, vs16, false)
• GitHub Check: ci (8.1, x86, ts, vs16, true)
• GitHub Check: ci (8.1, x86, ts, vs16, false)
• GitHub Check: ci (8.2, x86, nts, vs16, false)
• GitHub Check: ci (8.1, x86, nts, vs16, false)
• GitHub Check: ci (8.2, x86, ts, vs16, true)
• GitHub Check: ci (8.2, x64, ts, vs16, true)
• GitHub Check: ci (8.2, x64, nts, vs16, false)
• GitHub Check: ci (8.3, x86, nts, vs16, false)
• GitHub Check: ci (8.3, x86, nts, vs16, true)

🔇 Additional comments (4)

brotli.c (4)

1152-1157: Nicely implemented initialization and error handling

The refactored code properly initializes the brotli context, creates an encoder with the specified parameters, and includes appropriate error handling.

---

1159-1164: Good buffer sizing approach

Setting a minimum buffer size of 64 bytes is a sensible choice to ensure efficient memory usage for small inputs, while still allowing for appropriate sizing for larger inputs.

---

1165-1185: Well-implemented streaming compression loop

The refactoring from a single-call compression approach to a streaming compression loop is well-implemented. The code properly:

1. Sets up input/output pointers and buffers
2. Compresses in chunks with proper error handling
3. Accumulates compressed output in a smart_string
4. Handles failures with appropriate resource cleanup

This streaming approach provides better control over the compression process and memory usage.

---

1187-1193: Clean resource management

The code properly cleans up all allocated resources - closing the context, returning the compressed data as a string, and freeing the buffer and smart_string to prevent memory leaks.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

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.