fix(aria): Improved Aria snapshot diffing #36101
Draft
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.
Fixes #34555.
The current implementation of Aria Snapshots is tailored towards automated workflows and doesn't handle well when humans have to interact with failures. In particular, the result of our snapshotting algorithm is naively diffed by the Jest string comparison function. Aria snapshots support more complex constructs like embedded regex (via
/some\wregex/
), and thus any failure in a snapshot will flag all regular expressions as a diff, highlighting them in red. In any situation this is hard to parse, but on larger snapshots it requires manual evaluation of every regex in the template to find the actual line that's causing your failure.This solution annotates our match result with the actual lines in the final rendered "template" string we know are matching. For a given matched line, the
toMatchAriaSnapshot()
matcher copies the actual received string over to the expected template string, which is passed to the Jest differ as before.The result is that any lines we considered to be matching will also be considered matching by Jest, therefore not notifying the user of fake problems.