-
Notifications
You must be signed in to change notification settings - Fork 16
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
Display skipped executions warning for metrics #1938
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #1938 +/- ##
===========================================
+ Coverage 40.28% 40.32% +0.03%
===========================================
Files 398 398
Lines 11899 11903 +4
Branches 2879 2880 +1
===========================================
+ Hits 4794 4800 +6
+ Misses 4827 4826 -1
+ Partials 2278 2277 -1 ☔ View full report in Codecov by Sentry. |
If I understand correctly, I feel like the warning is a bit too prominent for the following reasons
Brainstorming:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
technically, looks ok
think warning is a bit too prominent and/or hard to interpret for most users, so may need to consider alternatives
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The term "skipped" makes me think of the run not being executed because the workflow engine decided not to or something like that. I wonder if there's another term or a different way of phrasing it that makes it clearer that we skipped it during the analysis phase.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Random thoughts, just brainstorming:
- I'm wary of too much information being in a tooltip; tooltips should supplement info displayed, not be a substitute, because most users don't know to look for them, IMO.
- How frequently are executions skipped in our current data set? Is this a once in a blue moon sort of thing, or will it be fairly common? If it's reasonably common, I would be tempted to just have another column with the number.
- Does a user need to know in detail that, for example, the memory metric aggregation was skipped 8 times, but the CPU metric was skipped 11 times? I would argue not.
- What if we captured the total number of skipped aggregations at the top along with Total/Successful/Failed/Aborted? I guess the skipped is at different level though, a single execution could have more than one skipped, right?
- Digression, I think the top could be improved; instead of repeating the word "Executions" 4 times, we could have it once.
I'm actually toying with the idea that users with the platform partner role may want to know about skipped executions, I'm not sure regular user types should |
Not frequently -- I don't think we have any skipped executions right now because we've been ingesting data for the platforms. Ideally, the webservice should not let any invalid data get in, which is improved with dockstore/dockstore#5822. So I think the chances are low that there are skipped executions because the webservice would throw an error first.
I included it so the user knows how many executions were used to aggregate the metric. For example, an average over 100 executions is different from an average over 1 execution where the other 99 were skipped.
Yeah, it's scoped to the metric level. So for a single execution, it could be skipped for multiple metrics. |
Updated the PR so that the skipped executions icon is the info icon and only admins, curators, and platform partners can see it. Note that for a platform partner, they can see the warning for other platforms as well. I think this is okay since the warning could also exist at the Also addressed Charles feedback:
See updated screenshots in description. |
Quality Gate failedFailed conditions |
Description
Corresponding PRs:
This PR displays a warning icon if the aggregated metric had executions that were skipped during aggregation. The tool tip displays the number of executions skipped.
Old screenshot
![Screenshot 2024-02-22 at 11-36-26 Dockstore Workflow github com_kathy-t_ghapps-single-workflow](https://github.com/dockstore/dockstore-ui2/assets/25287123/ede73240-04b1-4cb0-b9ba-53916235a998)Review Instructions
Login as a curator, admin or platform partner and verify that this workflow https://qa.dockstore.org/workflows/github.com/kathy-t/ghapps-single-workflow:master?tab=metrics has skipped executions warnings for the CPU, Memory, and Cost metrics.
Logout and view the same workflow. You should not see any skipped executions warnings.
Issue
SEAB-6046
Security
If there are any concerns that require extra attention from the security team, highlight them here.
Please make sure that you've checked the following before submitting your pull request. Thanks!
npm run build
markdown-wrapper
component, which does extra sanitizationnpm audit
and ensure you are not introducing new vulnerabilities