Migrate to ActiveSupport::Notifications

[skatkov]

fixes #15

Refactors Webhukhs observability to emit a single ActiveSupport::Notifications event, webhukhs.event, instead of logging/reporting errors directly from the gem.

Event Payload Schema

{
  operation: :receive | :process,
  outcome: :duplicate | :unknown_handler | :inactive_handler | :error |
           :discarded | :skipped | :started | :completed | :validation_failed,
  severity: :info | :warn | :error,
  error: Exception,          # only present for error events
  service_id: String,        # when available
  handler_class: String,     # when available
  handler_event_id: String,  # when available
  webhook_id: Integer | String # when available
}

Features:

• Initializer got updated with a proposed listener.
• README adjusted, to ensure that people will initialize gem correctly
• Configuration.error_context dropped

[skatkov]

This is a breaking change. So before merging this... maybe @julik has a take on this? :-)

[Copilot]

Pull request overview

Refactors Webhukhs observability to emit a single ActiveSupport::Notifications event (webhukhs.event) with structured payloads, replacing direct logging/error-reporting from within the gem and updating docs/tests accordingly.

Changes:

• Introduces Webhukhs.instrument and replaces logging / Rails.error.report calls with structured webhukhs.event instrumentation.
• Updates test suite helpers and assertions to validate emitted notification payloads instead of captured logs/error reports.
• Updates documentation/changelog and adjusts CI/lint configuration related to docs and mutation testing.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
lib/webhukhs.rb	Adds Webhukhs.instrument and requires active_support/notifications.
lib/webhukhs/controllers/receive_webhooks_controller.rb	Emits webhukhs.event for receive-path errors instead of direct error reporting.
lib/webhukhs/jobs/processing_job.rb	Emits processing lifecycle/error/discard events instead of logging/reporting.
lib/webhukhs/base_handler.rb	Emits duplicate-delivery event; adjusts persisted handler name usage.
lib/webhukhs/models/received_webhook.rb	Clarifies ensure_id comment regarding UUID assignment.
lib/webhukhs/templates/webhukhs.rb	Adds notification subscriber example (currently active code in template).
README.md	Updates install/setup steps and documents notification-based observability.
CHANGELOG.md	Documents the notifications migration and removal of config.error_context.
test/test_helper.rb	Replaces log-capture helper with captured_webhukhs_events notification capture.
test/webhukhs_test.rb	Updates controller/processing assertions to validate notification payloads.
test/processing_job_test.rb	Replaces log/error-report assertions with notification assertions for job behavior.
test/base_handler_test.rb	Updates duplicate-delivery test to assert notification payload.
.yard-lint.yml	Disables Documentation/UndocumentedObjects and normalizes quoting.
.github/workflows/mutant.yml	Limits mutation tests workflow to pull_request events only.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[skatkov]

I'm mainly interested in yard tags for methods, so I can convert those into types. Object description is not that important.

[skatkov]

I should probably include "job" related attributes?