From 87c9092580513f8ec4fc7e0e62e1035e451fae2f Mon Sep 17 00:00:00 2001
From: Thomas Randolph <trandolph@gitlab.com>
Date: Tue, 25 Jul 2023 13:51:02 -0600
Subject: [PATCH 1/8] Add tracking for when a saved reply is used

---
 .../markdown/comment_templates_dropdown.vue   |  3 +++
 ..._code_review_saved_replies_use_monthly.yml | 25 +++++++++++++++++++
 ...i_code_review_saved_replies_use_weekly.yml | 25 +++++++++++++++++++
 3 files changed, 53 insertions(+)
 create mode 100644 config/metrics/counts_28d/20230725194658_i_code_review_saved_replies_use_monthly.yml
 create mode 100644 config/metrics/counts_7d/20230725194657_i_code_review_saved_replies_use_weekly.yml

diff --git a/app/assets/javascripts/vue_shared/components/markdown/comment_templates_dropdown.vue b/app/assets/javascripts/vue_shared/components/markdown/comment_templates_dropdown.vue
index 966a5556d243a6..abfb92f772d5e2 100644
--- a/app/assets/javascripts/vue_shared/components/markdown/comment_templates_dropdown.vue
+++ b/app/assets/javascripts/vue_shared/components/markdown/comment_templates_dropdown.vue
@@ -1,6 +1,7 @@
 <script>
 import { GlCollapsibleListbox, GlTooltip, GlButton } from '@gitlab/ui';
 import fuzzaldrinPlus from 'fuzzaldrin-plus';
+import { InternalEvents } from '~/tracking';
 import savedRepliesQuery from './saved_replies.query.graphql';
 
 export default {
@@ -18,6 +19,7 @@ export default {
     GlButton,
     GlTooltip,
   },
+  mixins: [InternalEvents.mixin()],
   props: {
     newCommentTemplatePath: {
       type: String,
@@ -55,6 +57,7 @@ export default {
       const savedReply = this.savedReplies.find((r) => r.id === id);
       if (savedReply) {
         this.$emit('select', savedReply.content);
+        this.track_event('i_code_review_saved_replies_use');
       }
     },
   },
diff --git a/config/metrics/counts_28d/20230725194658_i_code_review_saved_replies_use_monthly.yml b/config/metrics/counts_28d/20230725194658_i_code_review_saved_replies_use_monthly.yml
new file mode 100644
index 00000000000000..5ccc10bb457786
--- /dev/null
+++ b/config/metrics/counts_28d/20230725194658_i_code_review_saved_replies_use_monthly.yml
@@ -0,0 +1,25 @@
+---
+key_path: redis_hll_counters.code_review.i_code_review_saved_replies_use_monthly
+description: Number of unique users per month who use a saved reply
+product_section: dev
+product_stage: create
+product_group: code_review
+value_type: number
+status: active
+milestone: "16.3"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127442
+time_frame: 28d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+performance_indicator_type: []
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate
+options:
+  events:
+  - i_code_review_saved_replies_use
diff --git a/config/metrics/counts_7d/20230725194657_i_code_review_saved_replies_use_weekly.yml b/config/metrics/counts_7d/20230725194657_i_code_review_saved_replies_use_weekly.yml
new file mode 100644
index 00000000000000..6b2684eec2a0ac
--- /dev/null
+++ b/config/metrics/counts_7d/20230725194657_i_code_review_saved_replies_use_weekly.yml
@@ -0,0 +1,25 @@
+---
+key_path: redis_hll_counters.code_review.i_code_review_saved_replies_use_weekly
+description: Number of unique users per week who use a saved reply
+product_section: dev
+product_stage: create
+product_group: code_review
+value_type: number
+status: active
+milestone: "16.3"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127442
+time_frame: 7d
+data_source: redis_hll
+data_category: optional
+instrumentation_class: RedisHLLMetric
+performance_indicator_type: []
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate
+options:
+  events:
+  - i_code_review_saved_replies_use
-- 
GitLab


From 57030da3a583bfa9afad479460bc6afb4cdc501d Mon Sep 17 00:00:00 2001
From: Thomas Randolph <trandolph@gitlab.com>
Date: Tue, 25 Jul 2023 13:55:45 -0600
Subject: [PATCH 2/8] Add a total counter for using saved replies

---
 ..._i_code_review_saved_replies_count_use.yml | 25 +++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 config/metrics/counts_all/20230725195335_i_code_review_saved_replies_count_use.yml

diff --git a/config/metrics/counts_all/20230725195335_i_code_review_saved_replies_count_use.yml b/config/metrics/counts_all/20230725195335_i_code_review_saved_replies_count_use.yml
new file mode 100644
index 00000000000000..e067f5f2be6e3d
--- /dev/null
+++ b/config/metrics/counts_all/20230725195335_i_code_review_saved_replies_count_use.yml
@@ -0,0 +1,25 @@
+---
+key_path: counts.i_code_review_saved_replies_count_use
+description: Total number of times a saved reply comment was used
+product_section: dev
+product_stage: create
+product_group: code_review
+value_type: number
+status: active
+milestone: "16.3"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127442
+time_frame: all
+data_source: redis
+data_category: optional
+instrumentation_class: AggregatedMetric
+performance_indicator_type: []
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate
+options:
+  events:
+  - i_code_review_saved_replies_use
-- 
GitLab


From 7e2a96c2943ccdb7a04816fb063cabd2dd486db8 Mon Sep 17 00:00:00 2001
From: Thomas Randolph <trandolph@gitlab.com>
Date: Tue, 25 Jul 2023 14:32:48 -0600
Subject: [PATCH 3/8] Add the usage event to the known code review events

---
 .../20210427102618_code_review_category_monthly_active_users.yml | 1 +
 .../20210427103119_code_review_group_monthly_active_users.yml    | 1 +
 .../20210427103328_code_review_group_monthly_active_users.yml    | 1 +
 .../20210427103407_code_review_category_monthly_active_users.yml | 1 +
 4 files changed, 4 insertions(+)

diff --git a/config/metrics/counts_28d/20210427102618_code_review_category_monthly_active_users.yml b/config/metrics/counts_28d/20210427102618_code_review_category_monthly_active_users.yml
index b8c5169e93a0ca..8d1f00446d78be 100644
--- a/config/metrics/counts_28d/20210427102618_code_review_category_monthly_active_users.yml
+++ b/config/metrics/counts_28d/20210427102618_code_review_category_monthly_active_users.yml
@@ -140,3 +140,4 @@ options:
     - 'i_code_review_merge_request_widget_security_reports_expand_warning'
     - 'i_code_review_merge_request_widget_security_reports_expand_failed'
     - 'i_code_review_saved_replies_create'
+    - 'i_code_review_saved_replies_use'
diff --git a/config/metrics/counts_28d/20210427103119_code_review_group_monthly_active_users.yml b/config/metrics/counts_28d/20210427103119_code_review_group_monthly_active_users.yml
index 3ec0903e363eed..e19e0965e05443 100644
--- a/config/metrics/counts_28d/20210427103119_code_review_group_monthly_active_users.yml
+++ b/config/metrics/counts_28d/20210427103119_code_review_group_monthly_active_users.yml
@@ -145,3 +145,4 @@ options:
     - 'i_code_review_merge_request_widget_security_reports_expand_warning'
     - 'i_code_review_merge_request_widget_security_reports_expand_failed'
     - 'i_code_review_saved_replies_create'
+    - 'i_code_review_saved_replies_use'
diff --git a/config/metrics/counts_7d/20210427103328_code_review_group_monthly_active_users.yml b/config/metrics/counts_7d/20210427103328_code_review_group_monthly_active_users.yml
index 6a0a14bdc26820..94cf3bcc63c3c6 100644
--- a/config/metrics/counts_7d/20210427103328_code_review_group_monthly_active_users.yml
+++ b/config/metrics/counts_7d/20210427103328_code_review_group_monthly_active_users.yml
@@ -143,3 +143,4 @@ options:
     - 'i_code_review_merge_request_widget_security_reports_expand_warning'
     - 'i_code_review_merge_request_widget_security_reports_expand_failed'
     - 'i_code_review_saved_replies_create'
+    - 'i_code_review_saved_replies_use'
diff --git a/config/metrics/counts_7d/20210427103407_code_review_category_monthly_active_users.yml b/config/metrics/counts_7d/20210427103407_code_review_category_monthly_active_users.yml
index 18d69d8e2f7ef0..a15273b156b759 100644
--- a/config/metrics/counts_7d/20210427103407_code_review_category_monthly_active_users.yml
+++ b/config/metrics/counts_7d/20210427103407_code_review_category_monthly_active_users.yml
@@ -138,3 +138,4 @@ options:
     - 'i_code_review_merge_request_widget_security_reports_expand_warning'
     - 'i_code_review_merge_request_widget_security_reports_expand_failed'
     - 'i_code_review_saved_replies_create'
+    - 'i_code_review_saved_replies_use'
-- 
GitLab


From b4128409ccefda7cde234d14ffa8e3871ad6b3d6 Mon Sep 17 00:00:00 2001
From: Thomas Randolph <trandolph@gitlab.com>
Date: Wed, 26 Jul 2023 07:48:57 -0600
Subject: [PATCH 4/8] Test that the tracking event is sent when selecting a
 comment

---
 .../comment_templates_dropdown_spec.js        | 37 +++++++++++++++----
 1 file changed, 30 insertions(+), 7 deletions(-)

diff --git a/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js b/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js
index 2bef6dd15df273..bc1a7791cec34a 100644
--- a/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js
+++ b/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js
@@ -1,6 +1,7 @@
 import Vue from 'vue';
 import VueApollo from 'vue-apollo';
 import savedRepliesResponse from 'test_fixtures/graphql/comment_templates/saved_replies.query.graphql.json';
+import { mockTracking } from 'helpers/tracking_helper';
 import { mountExtended } from 'helpers/vue_test_utils_helper';
 import createMockApollo from 'helpers/mock_apollo_helper';
 import waitForPromises from 'helpers/wait_for_promises';
@@ -43,16 +44,38 @@ describe('Comment templates dropdown', () => {
     expect(savedRepliesResp).toHaveBeenCalled();
   });
 
-  it('adds emits a select event on selecting a comment', async () => {
-    const mockApollo = createMockApolloProvider(savedRepliesResponse);
-    wrapper = createComponent({ mockApollo });
+  describe('when selecting a comment', () => {
+    let trackingSpy;
+    let mockApollo;
 
-    wrapper.find('.js-comment-template-toggle').trigger('click');
+    beforeEach(() => {
+      trackingSpy = mockTracking(undefined, window.document, jest.spyOn);
+      mockApollo = createMockApolloProvider(savedRepliesResponse);
+      wrapper = createComponent({ mockApollo });
+    });
 
-    await waitForPromises();
+    it('adds emits a select event', async () => {
+      wrapper.find('.js-comment-template-toggle').trigger('click');
+
+      await waitForPromises();
+
+      wrapper.find('.gl-new-dropdown-item').trigger('click');
+
+      expect(wrapper.emitted().select[0]).toEqual(['Saved Reply Content']);
+    });
+
+    it('tracks the usage of the saved comment', async () => {
+      wrapper.find('.js-comment-template-toggle').trigger('click');
+
+      await waitForPromises();
 
-    wrapper.find('.gl-new-dropdown-item').trigger('click');
+      wrapper.find('.gl-new-dropdown-item').trigger('click');
 
-    expect(wrapper.emitted().select[0]).toEqual(['Saved Reply Content']);
+      expect(trackingSpy).toHaveBeenCalledWith(
+        expect.any(String),
+        'i_code_review_saved_replies_use',
+        expect.any(Object),
+      );
+    });
   });
 });
-- 
GitLab


From cd1ab8bff98a64a30cc3873f46a8d300163e9379 Mon Sep 17 00:00:00 2001
From: Thomas Randolph <trandolph@gitlab.com>
Date: Thu, 3 Aug 2023 15:00:28 -0600
Subject: [PATCH 5/8] Fix Ruby class and constructor arguments

---
 ...20230725195335_i_code_review_saved_replies_count_use.yml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/config/metrics/counts_all/20230725195335_i_code_review_saved_replies_count_use.yml b/config/metrics/counts_all/20230725195335_i_code_review_saved_replies_count_use.yml
index e067f5f2be6e3d..40599af67c104c 100644
--- a/config/metrics/counts_all/20230725195335_i_code_review_saved_replies_count_use.yml
+++ b/config/metrics/counts_all/20230725195335_i_code_review_saved_replies_count_use.yml
@@ -11,7 +11,7 @@ introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/127442
 time_frame: all
 data_source: redis
 data_category: optional
-instrumentation_class: AggregatedMetric
+instrumentation_class: RedisMetric
 performance_indicator_type: []
 distribution:
 - ce
@@ -21,5 +21,5 @@ tier:
 - premium
 - ultimate
 options:
-  events:
-  - i_code_review_saved_replies_use
+  event: use
+  prefix: i_code_review_saved_replies
-- 
GitLab


From 025a3fb16f1d2ac83ecd2c3b779f1a15a6b19c67 Mon Sep 17 00:00:00 2001
From: Thomas Randolph <trandolph@gitlab.com>
Date: Mon, 7 Aug 2023 12:48:18 -0600
Subject: [PATCH 6/8] (Review) update test name that was split into a
 describe/it

---
 .../components/markdown/comment_templates_dropdown_spec.js      | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js b/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js
index bc1a7791cec34a..3612083cadbcb6 100644
--- a/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js
+++ b/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js
@@ -54,7 +54,7 @@ describe('Comment templates dropdown', () => {
       wrapper = createComponent({ mockApollo });
     });
 
-    it('adds emits a select event', async () => {
+    it('emits a select event', async () => {
       wrapper.find('.js-comment-template-toggle').trigger('click');
 
       await waitForPromises();
-- 
GitLab


From bbe5c2c29dae32f49d4ffbd8b7536474c817c25b Mon Sep 17 00:00:00 2001
From: Thomas Randolph <trandolph@gitlab.com>
Date: Tue, 8 Aug 2023 08:30:00 -0600
Subject: [PATCH 7/8] (Review) switch to using implementation details instead
 of UI

---
 .../markdown/comment_templates_dropdown_spec.js     | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js b/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js
index 3612083cadbcb6..e8e6a0e3d108a8 100644
--- a/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js
+++ b/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js
@@ -1,3 +1,4 @@
+import { GlCollapsibleListbox } from '@gitlab/ui';
 import Vue from 'vue';
 import VueApollo from 'vue-apollo';
 import savedRepliesResponse from 'test_fixtures/graphql/comment_templates/saved_replies.query.graphql.json';
@@ -32,6 +33,10 @@ function createComponent(options = {}) {
   });
 }
 
+function findDropdownComponent() {
+  return wrapper.findComponent(GlCollapsibleListbox);
+}
+
 describe('Comment templates dropdown', () => {
   it('fetches data when dropdown gets opened', async () => {
     const mockApollo = createMockApolloProvider(savedRepliesResponse);
@@ -65,11 +70,15 @@ describe('Comment templates dropdown', () => {
     });
 
     it('tracks the usage of the saved comment', async () => {
-      wrapper.find('.js-comment-template-toggle').trigger('click');
+      const dropdown = findDropdownComponent();
+
+      dropdown.vm.$emit('shown');
 
       await waitForPromises();
 
-      wrapper.find('.gl-new-dropdown-item').trigger('click');
+      dropdown.vm.$emit('select', 'gid://gitlab/Users::SavedReply/1');
+
+      await waitForPromises();
 
       expect(trackingSpy).toHaveBeenCalledWith(
         expect.any(String),
-- 
GitLab


From f09c41c2dde30ae023028a9532edd8e860eee64b Mon Sep 17 00:00:00 2001
From: Thomas Randolph <trandolph@gitlab.com>
Date: Tue, 8 Aug 2023 18:01:25 -0600
Subject: [PATCH 8/8] Use whatever the first generated saved query is in tests

---
 .../components/markdown/comment_templates_dropdown_spec.js      | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js b/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js
index e8e6a0e3d108a8..e4689a84900488 100644
--- a/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js
+++ b/spec/frontend/vue_shared/components/markdown/comment_templates_dropdown_spec.js
@@ -76,7 +76,7 @@ describe('Comment templates dropdown', () => {
 
       await waitForPromises();
 
-      dropdown.vm.$emit('select', 'gid://gitlab/Users::SavedReply/1');
+      dropdown.vm.$emit('select', savedRepliesResponse.data.currentUser.savedReplies.nodes[0].id);
 
       await waitForPromises();
 
-- 
GitLab