Flaky tests PR comment design

[Adal3n3]

The challenge is that developers often investing significant time identifying flaky tests within their failed tests result, which can be a frustrating process as these tests are meaningless and contribute to CI failures. By identifying flaky tests in the pull request comments for customers, they can quickly investigate the cause of the failure and track the history of the flakes, leading to faster addressing of flaky tests.

Describe the solution you'd like
Private beta design:

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Figma: link

[Adal3n3]

Here is the user testing feedback and team discussion: Notion link

Discussion note: (with @rohan-at-sentry @joseph-sentry)

1. PR comment: The feedback is “1/overwhelming test details… 2/developers might not go thru these details and 3/ no one wants to sit here and just wait for the PR” should we consider remove or do something for the two dropdowns for failed and flaky tests details? But then we won’t be able to identify which test is flaky for them.
   1. ok for now but maybe show test name only in the future, and/or can make the tests details configurable, choose to turn on/off. Here’s the on-going supporting works:
   2. [Test Analysis] Error message parsing #1487
   3. [Failed tests] Possibly stack comment horizontally #1233
   4. Parse out test suite name from path #1551
2. PR comment: Should we add a summary table for the number of tests, duration for all tests run and failure rate so developer can get a summary view before dig into details.
   1. Total failed tests run: we can get the duration from the check run, might not be useful bc usually it doesn’t have a big change, and non-actionable piece of info so should not show on the PR.
   2. Failure rate: same as above, so no failure rate on the PR.
3. PR comment: Should we remove the line “To report false or accurate flaky tests detection, please use the 👍 or 👎 icon.” because we heard 1/ customers may not sit and wait for PR, 2/ may not give us the feedback we want.
   1. We will remove the feedback loop in PR
4. We don’t need the Mute and mark as flaky functionalities in the UI for now.
5. Should we explore tests for coverage? Separate discussion
6. Should we prioritize provide tests analytic API?
   1. We want to do this but not sure on the timing. Maybe when we know if we want to GA
7. Shorten the test name?
   1. Parse out test suite name from path #1551
   2. Start by default which is the very long name, but can make it configurable in the future.
8. Failure rate is available in Q2
9. For the tests summary dashboard, we have all the data available, the question is timing on getting these data to Application team. Maybe Application team can use mock data for building the data table, if timing doesn’t align. - Aj to review the dashboard for dev-ready.

[Adal3n3]

I've updated the design. tiny tweak - removed the feedback loop.

[Adal3n3]

@rohan-at-sentry you mentioned you have some small tweak for the PR comment, what is it?

[Adal3n3]

Closed this issue as we have new issues for Q3 #2028