Create CompareAcccessibilityReports and add API to fetch MR a11y reports diffs
Problem to solve
We want to add a merge request widget for listing a11y
violations between two branches, but there's no API to fetch a comparison of two accessibility reports.
Proposal
Build a CompareAccessibilityReports
service to handle comparing two a11y
artifacts and rendering the diff. We do the same thing with CodeQuality reports already, and we can use that exat architectural model for this purpose.
It's possible that we'll consolidate some service classes later to keep code DRY and efficient, but not for now. We're okay with the duplication to get the API available, and we can consider refactoring afterward. #39425 (comment 297431022)
Testing
- Service classes should be accompanied by unit tests
- The API endpoint should be accompanied by a request spec that asserts the correct diff is rendered bewteen two mock artifacts.
What does success look like, and how can we measure that?
Acceptance Criteria
- a11y reports diffs are returned from an
accessibility_reports
endpoint on theMergeRequestsController
- Track usage of the feature
- Provide a count of how many times the MR widget is displayed to be queried in Periscope
- Provide a count of how many times the MR Widget is expanded to be queried in Periscope
What is the type of buyer?
An internal frontend developer, or anyone else who wants to integrate accessibility scanning data into their development and/or deployment workflow.
This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.