Merge branch '292822-track-comment-related-metrics-for-a-merge-request-3' into 'master'

Resolve "Track comment related metrics for a merge request"

See merge request gitlab-org/gitlab!51521

app/services/draft_notes/base_service.rb

@@ -8,6 +8,10 @@ module DraftNotes
       @merge_request, @current_user, @params = merge_request, current_user, params.dup
     end
 
+    def merge_request_activity_counter
+      Gitlab::UsageDataCounters::MergeRequestActivityUniqueCounter
+    end
+
     private
 
     def draft_notes

app/services/draft_notes/create_service.rb

@@ -31,6 +31,10 @@ module DraftNotes
         merge_request.diffs.clear_cache
       end
 
+      if draft_note.persisted?
+        merge_request_activity_counter.track_create_review_note_action(user: current_user)
+      end
+
       draft_note
     end
 

app/services/draft_notes/publish_service.rb

@@ -9,6 +9,7 @@ module DraftNotes
         publish_draft_note(draft)
       else
         publish_draft_notes
+        merge_request_activity_counter.track_publish_review_action(user: current_user)
       end
 
       success

changelogs/unreleased/292822-track-comment-related-metrics-for-a-merge-request-3.yml

+---
+title: Add metrics to starting and publishing a review
+merge_request: 51521
+author:
+type: other

config/feature_flags/development/usage_data_i_code_review_user_create_review_note.yml

+---
+name: usage_data_i_code_review_user_create_review_note
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/51521
+rollout_issue_url: 
+milestone: '13.8'
+type: development
+group: group::code review
+default_enabled: true

config/feature_flags/development/usage_data_i_code_review_user_publish_review.yml

+---
+name: usage_data_i_code_review_user_publish_review
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/51351
+rollout_issue_url: 
+milestone: '13.8'
+type: development
+group: group::code review
+default_enabled: true

lib/gitlab/usage_data_counters/known_events/common.yml

@@ -486,6 +486,16 @@
   category: code_review
   aggregation: weekly
   feature_flag: usage_data_i_code_review_user_remove_mr_comment
+- name: i_code_review_user_create_review_note
+  redis_slot: code_review
+  category: code_review
+  aggregation: weekly
+  feature_flag: usage_data_i_code_review_user_create_review_note
+- name: i_code_review_user_publish_review
+  redis_slot: code_review
+  category: code_review
+  aggregation: weekly
+  feature_flag: usage_data_i_code_review_user_publish_review
 # Terraform
 - name: p_terraform_state_api_unique_users
   category: terraform

lib/gitlab/usage_data_counters/merge_request_activity_unique_counter.rb

@@ -13,6 +13,8 @@ module Gitlab
       MR_CREATE_COMMENT_ACTION = 'i_code_review_user_create_mr_comment'
       MR_EDIT_COMMENT_ACTION = 'i_code_review_user_edit_mr_comment'
       MR_REMOVE_COMMENT_ACTION = 'i_code_review_user_remove_mr_comment'
+      MR_CREATE_REVIEW_NOTE_ACTION = 'i_code_review_user_create_review_note'
+      MR_PUBLISH_REVIEW_ACTION = 'i_code_review_user_publish_review'
 
       class << self
         def track_mr_diffs_action(merge_request:)
@@ -52,6 +54,14 @@ module Gitlab
           track_unique_action_by_user(MR_REMOVE_COMMENT_ACTION, user)
         end
 
+        def track_create_review_note_action(user:)
+          track_unique_action_by_user(MR_CREATE_REVIEW_NOTE_ACTION, user)
+        end
+
+        def track_publish_review_action(user:)
+          track_unique_action_by_user(MR_PUBLISH_REVIEW_ACTION, user)
+        end
+
         private
 
         def track_unique_action_by_merge_request(action, merge_request)

spec/lib/gitlab/usage_data_counters/merge_request_activity_unique_counter_spec.rb

@@ -95,4 +95,20 @@ RSpec.describe Gitlab::UsageDataCounters::MergeRequestActivityUniqueCounter, :cl
       let(:action) { described_class::MR_REMOVE_COMMENT_ACTION }
     end
   end
+
+  describe '.track_create_review_note_action' do
+    subject { described_class.track_create_review_note_action(user: user) }
+
+    it_behaves_like 'a tracked merge request unique event' do
+      let(:action) { described_class::MR_CREATE_REVIEW_NOTE_ACTION }
+    end
+  end
+
+  describe '.track_publish_review_action' do
+    subject { described_class.track_publish_review_action(user: user) }
+
+    it_behaves_like 'a tracked merge request unique event' do
+      let(:action) { described_class::MR_PUBLISH_REVIEW_ACTION }
+    end
+  end
 end

spec/services/draft_notes/create_service_spec.rb

@@ -20,6 +20,23 @@ RSpec.describe DraftNotes::CreateService do
     expect(draft.discussion_id).to be_nil
   end
 
+  it 'tracks the start event when the draft is persisted' do
+    expect(Gitlab::UsageDataCounters::MergeRequestActivityUniqueCounter)
+      .to receive(:track_create_review_note_action)
+      .with(user: user)
+
+    draft = create_draft(note: 'This is a test')
+    expect(draft).to be_persisted
+  end
+
+  it 'does not track the start event when the draft is not persisted' do
+    expect(Gitlab::UsageDataCounters::MergeRequestActivityUniqueCounter)
+      .not_to receive(:track_create_review_note_action)
+
+    draft = create_draft(note: 'Not a reply!', resolve_discussion: true)
+    expect(draft).not_to be_persisted
+  end
+
   it 'cannot resolve when there is nothing to resolve' do
     draft = create_draft(note: 'Not a reply!', resolve_discussion: true)
 

spec/services/draft_notes/publish_service_spec.rb

@@ -43,6 +43,13 @@ RSpec.describe DraftNotes::PublishService do
       expect(result[:status]).to eq(:success)
     end
 
+    it 'does not track the publish event' do
+      expect(Gitlab::UsageDataCounters::MergeRequestActivityUniqueCounter)
+        .not_to receive(:track_publish_review_action)
+
+      publish(draft: drafts.first)
+    end
+
     context 'commit_id is set' do
       let(:commit_id) { commit.id }
 
@@ -74,6 +81,13 @@ RSpec.describe DraftNotes::PublishService do
         expect { publish }.not_to change { DraftNote.count }
       end
 
+      it 'does not track the publish event' do
+        expect(Gitlab::UsageDataCounters::MergeRequestActivityUniqueCounter)
+          .not_to receive(:track_publish_review_action)
+
+        publish
+      end
+
       it 'returns an error' do
         result = publish
 
@@ -105,6 +119,14 @@ RSpec.describe DraftNotes::PublishService do
       publish
     end
 
+    it 'tracks the publish event' do
+      expect(Gitlab::UsageDataCounters::MergeRequestActivityUniqueCounter)
+        .to receive(:track_publish_review_action)
+        .with(user: user)
+
+      publish
+    end
+
     context 'commit_id is set' do
       let(:commit_id) { commit.id }