Skip to content

Aggregation: Add aggregation FE pings

Administrator requested to merge vk/add-aggregation-fe-pings into main

Created by: vovakulikov

Closes https://github.com/sourcegraph/sourcegraph/issues/39922

Background

Aggregation Pings RFC Figma design with pings spec

In this PR we add pings event for the aggregation project. To be more specific this PR adds

  • GroupResultsCollapseSection and GroupResultsOpenSection whenever we open/close aggregation panel in the sidebar
  • GroupResults[$filter-name] whenever users click on aggregation controls buttons (from the sidepanel and from the full UI aggregation mode)
    • GroupResultsREPO
    • GroupResultsPATH
    • GroupResultsAUTHOR
    • GroupResultsCAPTURE_GROUP -GroupResults[$filter-name]DisabledHoversimular to above events about aggregation modes. Whenever user hovers any disable aggregation button.
  • GroupResultsChartBarClick whenever user clicks one of the chart bars
  • GroupResultsChartBarHover whenever user hovers one of the chart bars
  • GroupResultsExpandViewOpen whenever users clicks expand button (button that leads to the full aggregation UI)
  • GroupResultsInfoIconHover whenever user hovers info icon in the sidebar panel section heading
  • GroupResultsExpandedViewCollapse whenever user clicks on the collapse button in the full UI mode.

Event that are not in this PR because of we cut of scope or they are no longer needed

  • GroupResultsExpandedViewInfoIconHover we changed our layout and there is no longer tooltip icon (just plain text below the heading see design)

  • GroupResultsExpandedView[$filter-name] instead we use GroupResults[$filter-name] with uiMode body variable resultsScreen

  • GroupResultsExpandedViewChartBarClick instead we use GroupResultsChartBarClick with uiModebody variableresultsScreen`

  • GroupResultsExpandedViewChartBarHover also don't use and use GroupResultsChartBarHover instead

  • GroupResultsExpandedViewListRowClick and GroupResultsExpandedViewListRowHover out of scope. List items are not clickable in the v1 of aggregation UI.

  • GroupResultsSaveInsightDisabledHover and GroupResultsExpandedViewSaveInsight out of scope

  • GroupResultsMemoryHitHover out of scope we don't have any info to show such information in the UI.

TODO

  • Add pings events on the frontend
  • Update BigQuery schema
  • Add newly added pings in the ping documentation

Test plan

  • Make sure that all pings that are listed above in the background section is sent by the frontend with proper event body

App preview:

Check out the client app preview documentation to learn more.

Merge request reports