Skip to content

Use standardized panel errors for Value stream dashboard

Alex Pennells requested to merge 422470-improve-errors into master

What does this MR do and why?

Replaces the existing VSD error alerts with the common error state used by the other Analytics dashboard panels.

I had to refactor the error event emitted by existing panels to be able to accept an array of errors. In the process it was renamed set-errors to be a bit more explicit.

I also added the fullPanelError option, which allows rendering an error while still showing the panel content. Existing errors assumed that if an error was thrown, the panel content should be hidden. This isn't the case for the Value stream dashboard. Even if a single metric fails to load, there may still be other metrics that succeeded.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

group_analytics_dashboard_dynamic_vsd disabled

Before After
Screenshot_2024-03-18_at_12.17.43_PM Screenshot_2024-03-18_at_12.15.20_PM

group_analytics_dashboard_dynamic_vsd enabled

Before After
Screenshot_2024-03-18_at_12.17.07_PM Screenshot_2024-03-18_at_12.16.17_PM

How to set up and validate locally

  1. Mock a request failure by throwing an exception on this line
  2. Visit VSD for any group:
http://gdk.test:3000/groups/vsa-test-1/-/analytics/dashboards/value_streams_dashboard
  1. Error should render whether the group_analytics_dashboard_dynamic_vsd feature flag is enabled or not

Related to #422470 (closed)

Edited by Alex Pennells

Merge request reports