Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show number of successful repos instead of completed repos in variant analysis results view header #2349

Merged
merged 11 commits into from
Apr 27, 2023

Conversation

robertbrignull
Copy link
Contributor

Closes #2239

This PR aims to address the bug spotted in the issue linked above. We were showing the number of completed analyses instead of the number of successful analyses, and this caused confusion when actually looking through the results. This isn't how our original designs were so I think this is a bug and we didn't implement our designs correctly.

I try to generally improve this area by surfacing as many useful states as we can, and adding labels to the icons to explain what they mean. I also rewrite the text that previously said "Succeeded warnings" with something more descriptive and grammatically correct.

Screenshot 2023-04-18 at 15 00 58

To see it in action try running some variant analyses, and to see all the possible states check out the storybook.

Checklist

  • CHANGELOG.md has been updated to incorporate all user visible changes made by this pull request.
  • Issues have been created for any UI or other user-facing changes made by this pull request.
  • [Maintainers only] If this pull request makes user-facing changes that require documentation changes, open a corresponding docs pull request in the github/codeql repo and add the ready-for-doc-review label there.

@robertbrignull robertbrignull requested a review from a team as a code owner April 18, 2023 14:03
@robertbrignull
Copy link
Contributor Author

For those who can't run the code to try this out, I'll try to summarise the various states we can have.

The more "important" states takes precedent too, so if some repos were skipped but also analyses failed, then we'll show the red status and the more important tooltip message.


A fully successful analysis

  • Repositories count shows 5/5 with a green status (tooltip is "Completed")
  • Status text in 4th column says "Succeeded"
Screenshot 2023-04-19 at 11 31 51

Where some analyses succeed but some fail

  • Repositories count shows 98/100 with a red status (tooltip is "Some analyses failed")
    • Left side now only shows successful repositories
  • Status text in 4th column says "Some analyses failed"
Screenshot 2023-04-19 at 11 33 07

Where analysis is canceled

  • Repositories count shows 5/10 with a red status (tooltip is "Some analyses were stopped")
    • Left side now only shows successful repositories
  • Status text in 4th column says "Stopped"
Screenshot 2023-04-19 at 11 35 41

Where some repositories are skipped

  • Repositories count shows 4/4 with a yellow status (tooltip is "Some repositories were skipped")
    • Skipped repositories don't appear in this count, so we analysed 100% of the repos we could
    • The yellow status is just there to prompt you to look at the "No access" or "No database" tabs
  • Status text in 4th column says "Succeeded"
Screenshot 2023-04-19 at 11 38 52

Copy link
Contributor

@elenatanasoiu elenatanasoiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, had one small suggestion for readability, but it's not blocking.

@robertbrignull robertbrignull merged commit 562f926 into main Apr 27, 2023
@robertbrignull robertbrignull deleted the robertbrignull/countSuccessfulRepos branch April 27, 2023 11:58
robertbrignull added a commit that referenced this pull request Apr 28, 2023
robertbrignull added a commit that referenced this pull request Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Variant Analysis Results shows green check mark despite some failures
2 participants