Skip to content

Add product analytics specific dashboards to shared listing

What does this MR do and why?

This MR continues the process of moving the product analytics dashboards across from /-/product_analytics/dashboards to /-/analytics/dashboards. There are several MRs which progressively move parts over to make it easier to review:

MR/Issue Purpose Status
Add new analytics dashboards listing route and ... (!112321 - merged) Create new route and view Merged
Create new analytics dashboards app (!112196 - merged) Move basic structure Merged
Add product analytics specific dashboards to sh... (!112298 - merged) Move product analytics specific dashboards and visualizations 👈 You are here
Move the visualization designer and rename from... (!113538 - merged) Move visualization designer and rename from panel designer In dev
Update menu item to point to the shared dashboards listing In dev
Present call-to-actions to configure dashboards... (#388629 - closed) Add new onboarding flow for product analytics dashboards in the list Scheduled
Remove product analytics specific dashboard lis... (#390551 - closed) Remove old product analytics dashboards code Scheduled

This MR specifically:

  • Moves the visualization components
  • Moves the visualization JSON files and fixes formatting errors (no other changes)
  • Move the data sources
  • Moves the analytics dashboard component
  • Generalizes the import of visualization and dashboard JSON files in the analytics dashboard component by setting up some indexes and async imports
    • This approach then allows other groups to follow a similar pattern, removes the need for massive lists in the component, and dynamically imports more
  • Updated specs and moved more mock data methods over

Screenshots or screen recordings

Product Analytics listing before Product Analytics listing after Shared listing
image image image
Product Analytics dashboard before Product Analytics dashboard after Shared product analytics dashboard
image image image

How to set up and validate locally

  1. Visit the projects shared dashboards listing e.g. http://gdk.test:3000/gitlab-org/gitlab-test/-/analytics/dashboards
  2. Validate that the page is rendered with a blank list

To test the product analytics dashboard items are shown, you will need to follow the instructions at https://gitlab.com/gitlab-org/gitlab/-/snippets/2474959 to enable Product Analytics on your GDK.

  1. Visit the projects shared dashboards listing e.g. http://gdk.test:3000/gitlab-org/gitlab-test/-/analytics/dashboards
  2. Validate that the page is rendered with a list of product analytics dashboards
  3. Click on different dashboards and validate that the dashboard is shown
  4. Visit the projects old product analytics dashboards listing e.g. http://gdk.test:3000/gitlab-org/gitlab-test/-/product_analytics/dashboards
  5. Validate that the page is rendered with a list of product analytics dashboards
  6. Click on different dashboards and validate that the dashboard is shown

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 #388557 (closed)

Edited by Robert Hunt

Merge request reports