built-in mime type exclusion list

[pavetheway91]

Hey

I thought it would be a good idea to ship with a built-in list of common and/or obvious cases of these mime type exclusions. With this implemented, user only has to add any types, which might be missing from the built-in one.

List of these built-in exclusions is also printed to phpinfo();

One of the associated tests was modified to use the built-in list, while another one was modified to use the ini list.

I placed the list to a separate header, so it can be easily be replaced too, if someone wants to compile this with their own list.

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Added built-in exclusions for media, font, PDF, archive, and already-compressed MIME types.
  • Output compression can now be skipped based on built-in or configured exclusions, including wildcard patterns.
  • PHP information now displays the built-in exclusion list.
  • SVG content remains eligible for compression unless explicitly excluded.

• Documentation

  • Updated compression documentation with built-in exclusions and configuration guidance.

[coderabbitai]

📝 Walkthrough

Walkthrough

The extension adds built-in MIME types that bypass Zstandard compression. It checks built-in and configured exclusion lists, reports the built-in list through phpinfo(), documents the configuration behavior, and updates exclusion tests.

Changes

MIME exclusion support

Layer / File(s)	Summary
Define and expose built-in exclusions php_zstd_mimetype_exclude.h, zstd.c, README.md	Adds the ZSTD_MIMETYPE_EXCLUDE list. PHP 8+ includes and reports the list. The README documents built-in and configured exclusions.
Apply MIME exclusions during startup zstd.c, tests/ob_exclude_001.phpt, tests/ob_exclude_002.phpt	The MIME matching function accepts an exclusion list. Startup skips compression when either exclusion list matches the response MIME type. The tests remove the configured PDF exclusion and use image/svg for wildcard exclusion coverage.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• kjdev/php-ext-zstd#101: Adds the configured MIME-type exclusion support used by this change.

Sequence Diagram(s)

sequenceDiagram
  participant Startup as Output compression startup
  participant Matcher as php_zstd_output_mimetype_excluded
  participant Lists as Built-in and configured exclusion lists
  Startup->>Matcher: Check response MIME type
  Matcher->>Lists: Test both exclusion lists
  Lists-->>Matcher: Return match result
  Matcher-->>Startup: Skip compression when matched

Loading

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly identifies the main change: adding a built-in MIME type exclusion list.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

zstd.c (1)

1561-1565: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Add a regression test for the built-in exclusion list.

The supplied tests/ob_exclude_002.phpt sets zstd.output_compression_exclude_types=image/*, so it exercises the configured list. It would still pass if the built-in exclusion call were removed. Add a case with an empty INI exclusion setting and Content-Type: image/png.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@zstd.c` around lines 1561 - 1565, Add a regression case covering the built-in
exclusion list in tests/ob_exclude_002.phpt or its related test suite: configure
zstd.output_compression_exclude_types to an empty value, send a response with
Content-Type: image/png, and assert the expected exclusion behavior so the test
fails if php_zstd_output_mimetype_excluded(ZSTD_MIMETYPE_EXCLUDE) is removed.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@php_zstd_mimetype_exclude.h`:
- Line 23: Update the built-in RAR MIME exclusions in the MIME type list to use
the registered application/vnd.rar value, removing application/x-vnd.rar;
include application/x-rar-compressed only if legacy server responses must remain
supported.

---

Nitpick comments:
In `@zstd.c`:
- Around line 1561-1565: Add a regression case covering the built-in exclusion
list in tests/ob_exclude_002.phpt or its related test suite: configure
zstd.output_compression_exclude_types to an empty value, send a response with
Content-Type: image/png, and assert the expected exclusion behavior so the test
fails if php_zstd_output_mimetype_excluded(ZSTD_MIMETYPE_EXCLUDE) is removed.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 775656ab-802e-4d31-a18f-7457fe4d72dd

📥 Commits

Reviewing files that changed from the base of the PR and between 3ef892e and 38d21a7.

📒 Files selected for processing (4)

• README.md
• php_zstd_mimetype_exclude.h
• tests/ob_exclude_001.phpt
• zstd.c

💤 Files with no reviewable changes (1)

• tests/ob_exclude_001.phpt

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@tests/ob_exclude_002.phpt`:
- Line 16: Update the test setup in tests/ob_exclude_002.phpt so
zstd.output_compression_exclude_types no longer matches the image/svg
Content-Type, allowing the test to exercise the built-in exclusion list. Use a
non-matching configured value while preserving configured wildcard coverage in a
separate test.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 466cfe81-0fbc-41f8-bc05-e960e0546544

📥 Commits

Reviewing files that changed from the base of the PR and between 38d21a7 and bc9a945.

📒 Files selected for processing (5)

• README.md
• php_zstd_mimetype_exclude.h
• tests/ob_exclude_001.phpt
• tests/ob_exclude_002.phpt
• zstd.c

💤 Files with no reviewable changes (1)

• tests/ob_exclude_001.phpt

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

• README.md
• zstd.c
• php_zstd_mimetype_exclude.h