Merge branch '292253-counts-epic-status-change' into 'master'

Track closing and reopening events

See merge request gitlab-org/gitlab!56246

doc/development/usage_ping/dictionary.md

@@ -9812,6 +9812,30 @@ Status: `implemented`
 
 Tiers: `premium`, `ultimate`
 
+### `redis_hll_counters.epics_usage.g_project_management_epic_closed_monthly`
+
+Counts of MAU closing epics
+
+[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210310163213_g_project_management_epic_closed_monthly.yml)
+
+Group: `group::product planning`
+
+Status: `implemented`
+
+Tiers: `premium`, `ultimate`
+
+### `redis_hll_counters.epics_usage.g_project_management_epic_closed_weekly`
+
+Counts of WAU closing epics
+
+[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_7d/20210310162703_g_project_management_epic_closed_weekly.yml)
+
+Group: `group::product planning`
+
+Status: `implemented`
+
+Tiers: `premium`, `ultimate`
+
 ### `redis_hll_counters.epics_usage.g_project_management_epic_created_monthly`
 
 Count of MAU creating epics
@@ -9860,6 +9884,30 @@ Status: `implemented`
 
 Tiers: `premium`, `ultimate`
 
+### `redis_hll_counters.epics_usage.g_project_management_epic_reopened_monthly`
+
+Counts of MAU closing epics
+
+[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210310164247_g_project_management_epic_reopened_monthly.yml)
+
+Group: `group::product planning`
+
+Status: `implemented`
+
+Tiers: `premium`, `ultimate`
+
+### `redis_hll_counters.epics_usage.g_project_management_epic_reopened_weekly`
+
+Counts of WAU re-opening epics
+
+[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_7d/20210310164112_g_project_management_epic_reopened_weekly.yml)
+
+Group: `group::product planning`
+
+Status: `implemented`
+
+Tiers: `premium`, `ultimate`
+
 ### `redis_hll_counters.epics_usage.g_project_management_users_destroying_epic_notes_monthly`
 
 Counts of MAU destroying epic notes

ee/app/services/epics/close_service.rb

@@ -16,6 +16,7 @@ module Epics
         event_service.close_epic(epic, current_user)
         SystemNoteService.change_status(epic, nil, current_user, epic.state)
         notification_service.close_epic(epic, current_user)
+        ::Gitlab::UsageDataCounters::EpicActivityUniqueCounter.track_epic_closed_action(author: current_user)
       end
     end
   end

ee/app/services/epics/reopen_service.rb

@@ -15,6 +15,7 @@ module Epics
         event_service.reopen_epic(epic, current_user)
         SystemNoteService.change_status(epic, nil, current_user, epic.state)
         notification_service.reopen_epic(epic, current_user)
+        ::Gitlab::UsageDataCounters::EpicActivityUniqueCounter.track_epic_reopened_action(author: current_user)
       end
     end
   end

ee/changelogs/unreleased/292253-counts-epic-status-change.yml

+---
+title: Track epic status change action on usage ping
+merge_request: 56246
+author:
+type: other

ee/config/metrics/counts_28d/20210310163213_g_project_management_epic_closed_monthly.yml

+---
+# Name of this metric contains g_project_management prefix
+# because we are using the same slot from issue_tracking to
+# allow data aggregation.
+key_path: redis_hll_counters.epics_usage.g_project_management_epic_closed_monthly
+description: Counts of MAU closing epics
+product_section: dev
+product_stage: plan
+product_group: group::product planning
+product_category: epics_usage
+value_type: number
+status: implemented
+milestone: "13.11"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/56246
+time_frame: 28d
+data_source: redis_hll
+distribution:
+- ee
+tier:
+- premium
+- ultimate

ee/config/metrics/counts_28d/20210310164247_g_project_management_epic_reopened_monthly.yml

+---
+# Name of this metric contains g_project_management prefix
+# because we are using the same slot from issue_tracking to
+# allow data aggregation.
+key_path: redis_hll_counters.epics_usage.g_project_management_epic_reopened_monthly
+description: Counts of MAU closing epics
+product_section: dev
+product_stage: plan
+product_group: group::product planning
+product_category: epics_usage
+value_type: number
+status: implemented
+milestone: "13.11"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/56246
+time_frame: 28d
+data_source: redis_hll
+distribution:
+- ee
+tier:
+- premium
+- ultimate

ee/config/metrics/counts_7d/20210310162703_g_project_management_epic_closed_weekly.yml

+---
+# Name of this metric contains g_project_management prefix
+# because we are using the same slot from issue_tracking to
+# allow data aggregation.
+key_path: redis_hll_counters.epics_usage.g_project_management_epic_closed_weekly
+description: Counts of WAU closing epics
+product_section: dev
+product_stage: plan
+product_group: group::product planning
+product_category: epics_usage
+value_type: number
+status: implemented
+milestone: "13.10"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/56246
+time_frame: 7d
+data_source: redis_hll
+distribution:
+- ee
+tier:
+- premium
+- ultimate

ee/config/metrics/counts_7d/20210310164112_g_project_management_epic_reopened_weekly.yml

+---
+# Name of this metric contains g_project_management prefix
+# because we are using the same slot from issue_tracking to
+# allow data aggregation.
+key_path: redis_hll_counters.epics_usage.g_project_management_epic_reopened_weekly
+description: Counts of WAU re-opening epics
+product_section: dev
+product_stage: plan
+product_group: group::product planning
+product_category: epics_usage
+value_type: number
+status: implemented
+milestone: "13.11"
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/56246
+time_frame: 7d
+data_source: redis_hll
+distribution:
+- ee
+tier:
+- premium
+- ultimate

ee/lib/gitlab/usage_data_counters/epic_activity_unique_counter.rb

@@ -13,6 +13,8 @@ module Gitlab
       EPIC_START_DATE_SET_AS_FIXED = 'g_project_management_users_setting_epic_start_date_as_fixed'
       EPIC_START_DATE_SET_AS_INHERITED = 'g_project_management_users_setting_epic_start_date_as_inherited'
       EPIC_ISSUE_ADDED = 'g_project_management_epic_issue_added'
+      EPIC_CLOSED = 'g_project_management_epic_closed'
+      EPIC_REOPENED = 'g_project_management_epic_reopened'
 
       class << self
         def track_epic_created_action(author:, time: Time.zone.now)
@@ -39,6 +41,14 @@ module Gitlab
           track_unique_action(EPIC_ISSUE_ADDED, author, time)
         end
 
+        def track_epic_closed_action(author:, time: Time.zone.now)
+          track_unique_action(EPIC_CLOSED, author, time)
+        end
+
+        def track_epic_reopened_action(author:, time: Time.zone.now)
+          track_unique_action(EPIC_REOPENED, author, time)
+        end
+
         private
 
         def track_unique_action(action, author, time)

ee/spec/lib/gitlab/usage_data_counters/epic_activity_unique_counter_spec.rb

@@ -28,8 +28,6 @@ RSpec.describe Gitlab::UsageDataCounters::EpicActivityUniqueCounter, :clean_gitl
     it_behaves_like 'a daily tracked issuable event' do
       let(:action) { described_class::EPIC_NOTE_UPDATED }
     end
-
-    it_behaves_like 'does not track when feature flag is disabled', :track_epics_activity
   end
 
   context 'for epic note destroyed event' do
@@ -40,6 +38,28 @@ RSpec.describe Gitlab::UsageDataCounters::EpicActivityUniqueCounter, :clean_gitl
     it_behaves_like 'a daily tracked issuable event' do
       let(:action) { described_class::EPIC_NOTE_DESTROYED }
     end
+  end
+
+  context 'for epic closing event' do
+    def track_action(params)
+      described_class.track_epic_closed_action(**params)
+    end
+
+    it_behaves_like 'a daily tracked issuable event' do
+      let(:action) { described_class::EPIC_CLOSED }
+    end
+
+    it_behaves_like 'does not track when feature flag is disabled', :track_epics_activity
+  end
+
+  context 'for epic reopening event' do
+    def track_action(params)
+      described_class.track_epic_reopened_action(**params)
+    end
+
+    it_behaves_like 'a daily tracked issuable event' do
+      let(:action) { described_class::EPIC_REOPENED }
+    end
 
     it_behaves_like 'does not track when feature flag is disabled', :track_epics_activity
   end

ee/spec/services/epics/close_service_spec.rb

@@ -59,9 +59,16 @@ RSpec.describe Epics::CloseService do
             subject.execute(epic)
           end
 
-          it "creates new event" do
+          it 'creates new event' do
             expect { subject.execute(epic) }.to change { Event.count }
           end
+
+          it 'tracks closing the epic' do
+            expect(::Gitlab::UsageDataCounters::EpicActivityUniqueCounter)
+              .to receive(:track_epic_closed_action).with(author: user)
+
+            subject.execute(epic)
+          end
         end
 
         context 'when trying to close a closed epic' do
@@ -94,6 +101,12 @@ RSpec.describe Epics::CloseService do
           it "does not create an event" do
             expect { subject.execute(epic) }.not_to change { Event.count }
           end
+
+          it 'does not track closing the epic' do
+            expect(::Gitlab::UsageDataCounters::EpicActivityUniqueCounter).not_to receive(:track_epic_closed_action)
+
+            subject.execute(epic)
+          end
         end
       end
 

ee/spec/services/epics/reopen_service_spec.rb

@@ -59,9 +59,16 @@ RSpec.describe Epics::ReopenService do
             subject.execute(epic)
           end
 
-          it "creates new event" do
+          it 'creates new event' do
             expect { subject.execute(epic) }.to change { Event.count }
           end
+
+          it 'tracks reopening the epic' do
+            expect(::Gitlab::UsageDataCounters::EpicActivityUniqueCounter)
+              .to receive(:track_epic_reopened_action).with(author: user)
+
+            subject.execute(epic)
+          end
         end
 
         context 'when trying to reopen an opened epic' do
@@ -91,9 +98,15 @@ RSpec.describe Epics::ReopenService do
             subject.execute(epic)
           end
 
-          it "does not create an event" do
+          it 'does not create an event' do
             expect { subject.execute(epic) }.not_to change { Event.count }
           end
+
+          it 'does not track reopening the epic' do
+            expect(::Gitlab::UsageDataCounters::EpicActivityUniqueCounter).not_to receive(:track_epic_reopened_action)
+
+            subject.execute(epic)
+          end
         end
       end
 

lib/gitlab/usage_data_counters/known_events/epic_events.yml

@@ -38,3 +38,15 @@
   redis_slot: project_management
   aggregation: daily
   feature_flag: track_epics_activity
+
+- name: g_project_management_epic_closed
+  category: epics_usage
+  redis_slot: project_management
+  aggregation: daily
+  feature_flag: track_epics_activity
+  
+- name: g_project_management_epic_reopened
+  category: epics_usage
+  redis_slot: project_management
+  aggregation: daily
+  feature_flag: track_epics_activity