Integrate with Active Support instrumentation #33
Conversation
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
seanpdoyle
force-pushed
the
as-notifications
branch
5 times, most recently
from
9f95ae6 to
a75ecbf
Compare
Capybara Accessibility Audit integrates with [Active Support's instrumentation][] through publishing [ActiveSupport::Notifications][]. `audit.capybara_accessibility_audit` notification --- Subscribe to `audit.capybara_accessibility_audit` notifications emitted when an accessibility audit is automatically conducted. In addition to the metadata provided by default (like `name`, `duration`, and `allocations`, etc.), the `payload` includes additional information: | Payload | Type | Description | | ------------- | ---------------------------------- | ----------- | | method | Symbol | The Capybara method that triggered the audit | options | [ActiveSupport::OrderedOptions][] | The audit's configuration | test | [ActionDispatch::SystemTestCase][] | The test case that triggered the audit > [!NOTE] > The `audit.capybara_accessibility_audit` notifications are only published when > an audit is conducted automatically. No `audit.capybara_accessibility_audit` > notifications will be published when `assert_no_accessibility_violations` is > invoked directly. [Active Support's instrumentation]: https://guides.rubyonrails.org/active_support_instrumentation.html [ActiveSupport::Notifications]: https://api.rubyonrails.org/classes/ActiveSupport/Notifications.html [ActiveSupport::OrderedOptions]: https://api.rubyonrails.org/classes/ActiveSupport/OrderedOptions.html [ActionDispatch::SystemTestCase]: https://api.rubyonrails.org/classes/ActionDispatch/SystemTestCase.html
seanpdoyle
force-pushed
the
as-notifications
branch
from
a75ecbf to
f000b09
Compare
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.
Capybara Accessibility Audit integrates with Active Support's instrumentation through publishing ActiveSupport::Notifications.
audit.capybara_accessibility_auditnotificationSubscribe to
audit.capybara_accessibility_auditnotifications emitted when an accessibility audit is automatically conducted. In addition to the metadata provided by default (likename,duration, andallocations, etc.), thepayloadincludes additional information:Note
The
audit.capybara_accessibility_auditnotifications are only published whenan audit is conducted automatically. No
audit.capybara_accessibility_auditnotifications will be published when
assert_no_accessibility_violationsisinvoked directly.