Document the CompiledDataCache for preset data - #15
Merged
Conversation
Correct the stale 'no need to cache the CoreRuleSet' note and show the lazy CoreRuleSetMatcher factory plus setCompiledDataCache in the OWASP CRS page; add the same for the bad-IP snapshot.
sascha-egerer
force-pushed
the
docs/compiled-data-cache
branch
from
July 28, 2026 07:45
b224eac to
eef3b36
Compare
There was a problem hiding this comment.
Pull request overview
Updates the documentation to explain when and how to use Flowd\Phirewall\Support\CompiledDataCache to avoid repeated parsing/compilation costs for preset data under PHP-FPM (and similar runtimes), and links the feature pages back to a central “Presets” explanation.
Changes:
- Expanded OWASP CRS docs to recommend caching parsed rule-file data via
CompiledDataCache. - Added Bad-IP preset guidance for caching the compiled IP snapshot tables.
- Introduced a new “Caching expensive preset data” section in the Presets advanced docs, including usage and operational notes.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/features/owasp-crs.md | Documents caching parsed CRS rule files using CompiledDataCache and links to Presets caching section. |
| docs/features/bad-ip-preset.md | Documents caching the compiled Bad-IP snapshot data using CompiledDataCache. |
| docs/advanced/presets.md | Adds central documentation for CompiledDataCache, its behavior, and integration pattern. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.