Migrate Dashboard framework to Vue 3

Migrate the Dashboard framework page entrypoint(s) to Vue 3 behind a feature flag, covering the project, group and /explore dashboards.

Scope

This issue covers only the flag-gated rollout switch from Option 1 of the Vue 3 migration guide: add a single feature flag, add a vue3_migration.yml per entrypoint, and smoke test the affected pages. Full Vue 3 compliance (fixing compatibility issues, migrating unit tests) is not required here. Capture anything found during smoke testing in follow-up issues instead.

Implementation plan

1. Add the feature flag

Create vue3_migrate_analytics_dashboards using bin/feature-flag:

  • type: beta, default_enabled: false, group: group::optimize
  • Read the milestone value from the VERSION file
  • Set feature_issue_url to this issue
  • Use user as the feature flag actor during rollout
  • Create a rollout issue from the "Feature Flag Roll Out" template and link it as rollout_issue_url
  • Link the rollout issue to the parent epic gitlab-org&23041

2. Add a vue3_migration.yml per entrypoint

Create this file next to each index.js listed below:

status: rollout
feature_flag: vue3_migrate_analytics_dashboards
group: group::optimize
migration_issue: https://gitlab.com/gitlab-org/gitlab/-/issues/607832

Entrypoints:

  • ee/app/assets/javascripts/pages/groups/analytics/dashboards/index.js (EE, group dashboards)
  • ee/app/assets/javascripts/pages/projects/analytics/dashboards/index.js (EE, project dashboards)
  • app/assets/javascripts/pages/explore/analytics_dashboards/index.js (CE, /explore dashboards)

Note: A single flag covers all three entrypoints. The earlier requirement of one flag per entrypoint was dropped to keep the rollout consistent with the rest of the epic.

3. Document existing test coverage in the MR

  • Add a section to the MR description listing which functionality of the feature is currently tested and where those tests are located, as in this example

4. Smoke test

Enable the flag locally and confirm the browser console logs [gitlab] [V] Using Vue.js 3 on each page, then verify the key workflows:

  • Dashboard list renders at project, group, and /explore level
  • A built-in dashboard (for example the Value Streams Dashboard) renders its panels
  • Create and edit a custom dashboard: add a panel, save, and reload

5. Follow-ups

  • Open follow-up issues for any Vue 3 compatibility problems found during smoke testing and link them here

References

Edited by 🤖 GitLab Bot 🤖