RequestContext: optional key, recordHit() for allow2ban#2
Merged
sascha-egerer merged 1 commit intoMay 29, 2026
Merged
Conversation
Mirrors the library change: recordFailure()'s second argument is now optional (the firewall reuses the rule's keyExtractor when omitted) and recordHit() routes signals to allow2ban rules. Updated request-context, fail2ban, common-attacks, examples, faq and architecture pages to the new API and added an Allow2Ban section to the RequestContext page.
There was a problem hiding this comment.
Pull request overview
Documentation updates aligning the Phirewall docs with library changes that make the second argument to recordFailure() optional and introduce recordHit() for allow2ban rules. The Request Context page gains a new Allow2Ban section, and several pages drop manual IP extraction in favor of letting the firewall derive the key from the rule's keyExtractor.
Changes:
- Updates
recordFailure()signature/usage to(string $ruleName, ?string $key = null)and addsrecordHit()as the allow2ban counterpart across docs. - Replaces
RecordedFailure/getRecordedFailures()references withRecordedSignal/getRecordedSignals()and renamesprocessRecordedFailure()toprocessRecordedSignal(). - Adds a new "Recording Hits for Allow2Ban" section to the Request Context page with configuration and handler examples.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/advanced/request-context.md | Documents optional key for recordFailure(), adds Allow2Ban section, renames signal types, updates API tables and examples. |
| docs/advanced/architecture.md | Renames processRecordedFailure() to processRecordedSignal() in the evaluator description. |
| docs/features/fail2ban.md | Updates post-handler flow diagram, simplifies handler example, and adds recordHit() to the API table. |
| docs/common-attacks.md | Drops manual IP extraction in the login-failures example. |
| docs/examples.md | Updates RequestContext example to omit the key and mentions recordHit() for allow2ban. |
| docs/faq.md | Updates the failure-signaling FAQ and notes recordHit() availability. |
💡 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.
Mirrors the library change: recordFailure()'s second argument is now optional (the firewall reuses the rule's keyExtractor when omitted) and recordHit() routes signals to allow2ban rules. Updated request-context, fail2ban, common-attacks, examples, faq and architecture pages to the new API and added an Allow2Ban section to the RequestContext page.