Skip to content

RequestContext: optional key, recordHit() for allow2ban#2

Merged
sascha-egerer merged 1 commit into
mainfrom
feature/request-context-default-key-and-allow2ban
May 29, 2026
Merged

RequestContext: optional key, recordHit() for allow2ban#2
sascha-egerer merged 1 commit into
mainfrom
feature/request-context-default-key-and-allow2ban

Conversation

@sascha-egerer

Copy link
Copy Markdown
Contributor

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.

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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 adds recordHit() as the allow2ban counterpart across docs.
  • Replaces RecordedFailure / getRecordedFailures() references with RecordedSignal / getRecordedSignals() and renames processRecordedFailure() to processRecordedSignal().
  • 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.

@sascha-egerer sascha-egerer merged commit 6b7961f into main May 29, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants