GitLab Version - Badge Tracking

What does this MR do and why?

Closes #369442 (closed)

This change adds snowplow tracking to the Version Check Badge. The intention is to track the following events:

1. Badge Rendered
   • Where it was rendered (admin, help, help dropdown)
   • Badge Variant (Up to date, Upgrade available, Update ASAP)
2. Badge Clicked
   • Where it was clicked at (admin, help, help dropdown)
   • Badge Variant (Up to date, Upgrade available, Update ASAP)

From what I understand Snowplow always provides page level information in its events so tracking Where should come out of the box. The variant is stored in the this.status property which is passed to the tracking event.

Important I was unable to successfully setup snowplow on my GDK and am fully relying on the jest specs to validate that it works. This was the strategy provided by this Slack Thread (internal only).

Screenshots or screen recordings

Change only adds tracking so there isn't any visual changes.

How to set up and validate locally

Important

1. Ensure Gitlab::CurrentSettings.version_check_enabled is set to true (it defaults to true)
2. Version Check uses ReactiveCache so the first time you navigate to a place where the badge should be, it may not be in the cache and required a single reload.
3. Please read note above in the first section about my issues with setting up snowplow locally.

Testing Instructions

1. Repeat these steps for the following views
   • /help
   • /admin
   • Help Dropdown (? in top nav)
2. Find the Version Check badge
   • /help => At top of page
   • /admin => In the components card
   • Help Dropdown => First list item
3. Ensure that when the badge is rendered the correct tracking event is fired
4. Ensure when clicking the badge the correct tracking event is fired

MR acceptance checklist

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

• I have evaluated the MR acceptance checklist for this MR.

Related to #369442 (closed)

changed milestone to %15.5

added analytics auto updated devopssystems featureenhancement frontend groupdistribution sectioncore platform snowplow tracking events typefeature labels

assigned to @zcuddy

removed auto updated label

	2 Warnings
	featureaddition and featureenhancement merge requests normally have a documentation change. Consider adding a documentation update or confirming the documentation plan with the Technical Writer counterpart. For more information, see: The Handbook page on merge request types. The definition of done documentation.
	This merge request changed undocumented Vue components in vue_shared/. Please consider creating Stories for these components: app/assets/javascripts/vue_shared/components/gitlab_version_check.vue

Reviewer roulette

Changes that require review have been detected!

Please refer to the table below for assigning reviewers and maintainers suggested by Danger in the specified category:

Category	Reviewer	Maintainer
frontend	Laura Meckley (@lmeckley) (UTC-6, 1 hour behind @zcuddy)	Phil Hughes (@iamphill) (UTC+1, 6 hours ahead of @zcuddy)

To spread load more evenly across eligible reviewers, Danger has picked a candidate for each review slot, based on their timezone. Feel free to override these selections if you think someone else would be better-suited or use the GitLab Review Workload Dashboard to find other available reviewers.

To read more on how to use the reviewer roulette, please take a look at the Engineering workflow and code review guidelines. Please consider assigning a reviewer or maintainer who is a domain expert in the area of the merge request.

Once you've decided who will review this merge request, assign them as a reviewer! Danger does not automatically notify them for you.

If needed, you can retry the danger-review job that generated this comment.

Generated by Danger

Bundle size analysis [beta]

This compares changes in bundle size for entry points between the commits 839fb432 and 74e450da

Special assets

Entrypoint / Name	Size before	Size after	Diff	Diff in percent
average	3.59 MB	3.59 MB	-	0.0 %
mainChunk	1.96 MB	1.96 MB	-	0.0 %

---

Note: We do not have exact data for 839fb432. So we have used data from: d6026ca5.
The intended commit has no webpack pipeline, so we chose the last commit with one before it.

Please look at the full report for more details

---

Read more about how this report works.

Generated by Danger

Hey @janis! Do you have capacity for a frontend code review here? This change adds some snowplow tracking events to the version check badge component.

Please take a look at the important note in the description.

Let me know if you have any questions!

requested review from @janis

Allure report

allure-report-publisher generated test report!

e2e-review-qa: test report for 74e450da

expand test summary

+-----------------------------------------------------------------------------------------+
|                                     suites summary                                      |
+------------------------------------+--------+--------+---------+-------+-------+--------+
|                                    | passed | failed | skipped | flaky | total | result |
+------------------------------------+--------+--------+---------+-------+-------+--------+
| Plan                               | 47     | 0      | 1       | 0     | 48    | ✅     |
| Create                             | 28     | 0      | 1       | 0     | 29    | ✅     |
| Manage                             | 52     | 0      | 8       | 3     | 60    | ❗     |
| Verify                             | 12     | 0      | 1       | 1     | 13    | ❗     |
| Feature flag handler sanity checks | 9      | 0      | 0       | 0     | 9     | ✅     |
| Govern                             | 2      | 0      | 0       | 0     | 2     | ✅     |
| Package                            | 0      | 0      | 1       | 0     | 1     | ➖     |
| Version sanity check               | 0      | 0      | 1       | 0     | 1     | ➖     |
| Secure                             | 2      | 0      | 0       | 1     | 2     | ❗     |
| Configure                          | 0      | 0      | 1       | 0     | 1     | ➖     |
+------------------------------------+--------+--------+---------+-------+-------+--------+
| Total                              | 152    | 0      | 14      | 5     | 166   | ❗     |
+------------------------------------+--------+--------+---------+-------+-------+--------+

requested review from @mfluharty and removed review request for @janis

added 279 commits

• a1409e62...231b86bf - 278 commits from branch master
• 70358968 - GitLab Version - Badge Tracking

Compare with previous version

added 146 commits

• 70358968...eee278c5 - 145 commits from branch master
• 80d5b21a - GitLab Version - Badge Tracking

Compare with previous version

Suggested Reviewers (beta)

The individuals below may be good candidates to participate in the review based on various factors.

You can use slash commands in comments to quickly assign /assign_reviewer @user1.

Suggested Reviewers
@oregand, @himkp, @jarka, @pedropombeiro, @ntepluhina

If you do not believe these suggestions are useful, please apply the label Bad Suggested Reviewer. You can also provide feedback for this feature on this issue: https://gitlab.com/gitlab-org/gitlab/-/issues/357923.

Automatically generated by Suggested Reviewers Bot - an experimental ML-based recommendation engine created by ~"group::applied ml".

approved this merge request

removed review request for @mfluharty

@mfluharty, thanks for approving this merge request.

This is the first time the merge request is approved. To ensure full test coverage, a new pipeline will be started shortly.

For more info, please refer to the following links:

• rspec minimal jobs
• jest minimal jobs
• merging a merge request.

added 1 deleted label

requested review from @jannik_lehmann

mentioned in merge request !100340 (merged)

requested review from @jivanvl and removed review request for @jannik_lehmann

approved this merge request

resolved all threads

Looks good to me!

enabled an automatic merge when the pipeline for 53b9769c succeeds

aborted the automatic merge because source branch was updated

added 1297 commits

• 80d5b21a...1aa97037 - 1296 commits from branch master
• 74e450da - GitLab Version - Badge Tracking

Compare with previous version

@jivanvl This MR had gotten pretty far behind master and seemed to be failing unrelated to this change. I went ahead and rebased. We may need to reset MWPS

enabled an automatic merge when the pipeline for d02a3352 succeeds

merged

mentioned in commit 21a6b225

added workflowstaging-canary label

added workflowcanary label and removed workflowstaging-canary label

added workflowstaging label and removed workflowcanary label

added workflowproduction label and removed workflowstaging label

mentioned in issue #369442 (closed)

mentioned in merge request !100978 (merged)

added releasedcandidate label

mentioned in merge request kubitus-project/kubitus-installer!1521 (merged)

added releasedpublished label and removed releasedcandidate label