Skip to content

Rename widget back to WidgetTestSummary

Miranda Fluharty requested to merge 427061-un-rename-test-report-summary-widget into master

What does this MR do and why?

This MR renames the test report/summary widget from WidgetTestReport to WidgetTestSummary (undoing a change made when this widget was migrated to be compatible with v2 of the MR widget framework).

Why? The telemetry events reported by the widget are linked to its name, so when the widget was renamed to WidgetTestReport, it started sending test_report events instead of test_summary events, and we started getting errors like this:

Gitlab::UsageDataCounters::HLLRedisCounter::UnknownEvent: Unknown event i_code_review_merge_request_widget_test_report_view

Renaming the widget back to its original name should stop the flow of errors. 😅

Screenshots or screen recordings

There should be no visual changes to the widget.

Before After
Screenshot_2023-10-31_at_14.40.02 Screenshot_2023-10-31_at_14.36.34

How to set up and validate locally

  1. add this to gdk.yml, then gdk reconfigure && gdk restart (see gdk snowplow micro docs for more info):
snowplow_micro:
  enabled: true
  1. find/clone/make a project with a pipeline that generates test reports (you can use this one if you don't have one already)
  2. open a merge request for the project
  3. run pipelines to generate test reports for the base commit and the head commit of the merge request's branch
  4. navigate to the merge request, and check for the test summary/report widget
  5. open browser devtools and go to the network tab
  6. click to expand the widget, some increment_* requests should appear (these are the events being sent to snowplow micro)
  • on master: the event in the request body contains widget_test_report, i.e. i_code_review_merge_request_widget_test_report_expand, which doesn't match our event definitions (hence the error)
  • on this branch: the event in the request body should contain widget_test_summary instead, i.e. i_code_review_merge_request_widget_test_summary_expand, which matches the event definitions like this one)

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #427061 (closed)

Edited by Miranda Fluharty

Merge request reports