Merge branch '238964-fj-track-global-editing-actions' into 'master'

Track edit by editor action for Usage Ping

See merge request gitlab-org/gitlab!40232

changelogs/unreleased/238964-fj-track-global-editing-actions.yml

+---
+title: Track edit by editor action for Usage Ping
+merge_request: 40232
+author:
+type: changed

lib/gitlab/usage_data_counters/editor_unique_counter.rb

@@ -3,9 +3,10 @@
 module Gitlab
   module UsageDataCounters
     module EditorUniqueCounter
-      EDIT_BY_SNIPPET_EDITOR = :edit_by_snippet_editor
-      EDIT_BY_SFE = :edit_by_sfe
-      EDIT_BY_WEB_IDE = :edit_by_web_ide
+      EDIT_BY_SNIPPET_EDITOR = 'g_edit_by_snippet_ide'
+      EDIT_BY_SFE = 'g_edit_by_sfe'
+      EDIT_BY_WEB_IDE = 'g_edit_by_web_ide'
+      EDIT_CATEGORY = 'ide_edit'
 
       class << self
         def track_web_ide_edit_action(author:, time: Time.zone.now)
@@ -32,16 +33,22 @@ module Gitlab
           count_unique(EDIT_BY_SNIPPET_EDITOR, date_from, date_to)
         end
 
+        def count_edit_using_editor(date_from:, date_to:)
+          events = Gitlab::UsageDataCounters::HLLRedisCounter.events_for_category(EDIT_CATEGORY)
+          count_unique(events, date_from, date_to)
+        end
+
         private
 
         def track_unique_action(action, author, time)
           return unless Feature.enabled?(:track_editor_edit_actions)
+          return unless author
 
-          Gitlab::UsageDataCounters::TrackUniqueActions.track_action(action: action, author_id: author.id, time: time)
+          Gitlab::UsageDataCounters::HLLRedisCounter.track_event(author.id, action, time)
         end
 
-        def count_unique(action, date_from, date_to)
-          Gitlab::UsageDataCounters::TrackUniqueActions.count_unique(action: action, date_from: date_from, date_to: date_to)
+        def count_unique(actions, date_from, date_to)
+          Gitlab::UsageDataCounters::HLLRedisCounter.unique_events(event_names: actions, start_date: date_from, end_date: date_to)
         end
       end
     end

lib/gitlab/usage_data_counters/known_events.yml

@@ -69,3 +69,18 @@
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+- name: g_edit_by_web_ide
+  category: ide_edit
+  redis_slot: edit
+  expiry: 29
+  aggregation: daily
+- name: g_edit_by_sfe
+  category: ide_edit
+  redis_slot: edit
+  expiry: 29
+  aggregation: daily
+- name: g_edit_by_snippet_ide
+  category: ide_edit
+  redis_slot: edit
+  expiry: 29
+  aggregation: daily

spec/lib/gitlab/usage_data_counters/editor_unique_counter_spec.rb

@@ -3,15 +3,17 @@
 require 'spec_helper'
 
 RSpec.describe Gitlab::UsageDataCounters::EditorUniqueCounter, :clean_gitlab_redis_shared_state do
-  shared_examples 'tracks and counts action' do
-    let(:user1) { build(:user, id: 1) }
-    let(:user2) { build(:user, id: 2) }
-    let(:user3) { build(:user, id: 3) }
-    let(:time) { Time.zone.now }
+  let(:user1) { build(:user, id: 1) }
+  let(:user2) { build(:user, id: 2) }
+  let(:user3) { build(:user, id: 3) }
+  let(:time) { Time.zone.now }
 
-    specify do
+  shared_examples 'tracks and counts action' do
+    before do
       stub_application_setting(usage_ping_enabled: true)
+    end
 
+    specify do
       aggregate_failures do
         expect(track_action(author: user1)).to be_truthy
         expect(track_action(author: user1)).to be_truthy
@@ -23,6 +25,10 @@ RSpec.describe Gitlab::UsageDataCounters::EditorUniqueCounter, :clean_gitlab_red
       end
     end
 
+    it 'does not track edit actions if author is not present' do
+      expect(track_action(author: nil)).to be_nil
+    end
+
     context 'when feature flag track_editor_edit_actions is disabled' do
       it 'does not track edit actions' do
         stub_feature_flags(track_editor_edit_actions: false)
@@ -67,4 +73,17 @@ RSpec.describe Gitlab::UsageDataCounters::EditorUniqueCounter, :clean_gitlab_red
       end
     end
   end
+
+  it 'can return the count of actions per user deduplicated ' do
+    described_class.track_web_ide_edit_action(author: user1)
+    described_class.track_snippet_editor_edit_action(author: user1)
+    described_class.track_sfe_edit_action(author: user1)
+    described_class.track_web_ide_edit_action(author: user2, time: time - 2.days)
+    described_class.track_web_ide_edit_action(author: user3, time: time - 3.days)
+    described_class.track_snippet_editor_edit_action(author: user3, time: time - 3.days)
+    described_class.track_sfe_edit_action(author: user3, time: time - 3.days)
+
+    expect(described_class.count_edit_using_editor(date_from: time, date_to: Date.today)).to eq(1)
+    expect(described_class.count_edit_using_editor(date_from: time - 5.days, date_to: Date.tomorrow)).to eq(3)
+  end
 end