Add tracker for unique virtual actions

In this commit we create a module to
track virtual actions (not linked to actual
real Events). This will be included in the
Usage Ping data.

changelogs/unreleased/232824-fj-track-unique-virtual-actions.yml

+---
+title: Add virtual actions tracker for Usage Ping
+merge_request: 39694
+author:
+type: added

config/feature_flags/development/track_editor_edit_actions.yml

+---
+name: track_editor_edit_actions
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39694
+rollout_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/240928
+group: group::editor
+type: development
+default_enabled: false

lib/gitlab/usage_data_counters/editor_unique_counter.rb

+# frozen_string_literal: true
+
+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
+
+      class << self
+        def track_web_ide_edit_action(author:, time: Time.zone.now)
+          track_unique_action(EDIT_BY_WEB_IDE, author, time)
+        end
+
+        def count_web_ide_edit_actions(date_from:, date_to:)
+          count_unique(EDIT_BY_WEB_IDE, date_from, date_to)
+        end
+
+        def track_sfe_edit_action(author:, time: Time.zone.now)
+          track_unique_action(EDIT_BY_SFE, author, time)
+        end
+
+        def count_sfe_edit_actions(date_from:, date_to:)
+          count_unique(EDIT_BY_SFE, date_from, date_to)
+        end
+
+        def track_snippet_editor_edit_action(author:, time: Time.zone.now)
+          track_unique_action(EDIT_BY_SNIPPET_EDITOR, author, time)
+        end
+
+        def count_snippet_editor_edit_actions(date_from:, date_to:)
+          count_unique(EDIT_BY_SNIPPET_EDITOR, date_from, date_to)
+        end
+
+        private
+
+        def track_unique_action(action, author, time)
+          return unless Feature.enabled?(:track_editor_edit_actions)
+
+          Gitlab::UsageDataCounters::TrackUniqueActions.track_action(action: action, author_id: author.id, time: 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)
+        end
+      end
+    end
+  end
+end

lib/gitlab/usage_data_counters/track_unique_actions.rb

+# frozen_string_literal: true
+
+module Gitlab
+  module UsageDataCounters
+    module TrackUniqueActions
+      KEY_EXPIRY_LENGTH = 29.days
+
+      class << self
+        def track_action(action:, author_id:, time: Time.zone.now)
+          return unless Gitlab::CurrentSettings.usage_ping_enabled
+
+          target_key = key(action, time)
+
+          add_key(target_key, author_id)
+        end
+
+        def count_unique(action:, date_from:, date_to:)
+          keys = (date_from.to_date..date_to.to_date).map { |date| key(action, date) }
+
+          Gitlab::Redis::HLL.count(keys: keys)
+        end
+
+        private
+
+        def key(action, date)
+          year_day = date.strftime('%G-%j')
+          "#{year_day}-{#{action}}"
+        end
+
+        def add_key(key, value)
+          Gitlab::Redis::HLL.add(key: key, value: value, expiry: KEY_EXPIRY_LENGTH)
+        end
+      end
+    end
+  end
+end

lib/gitlab/usage_data_counters/track_unique_events.rb

@@ -3,8 +3,6 @@
 module Gitlab
   module UsageDataCounters
     module TrackUniqueEvents
-      KEY_EXPIRY_LENGTH = 29.days
-
       WIKI_ACTION = :wiki_action
       DESIGN_ACTION = :design_action
       PUSH_ACTION = :project_action
@@ -27,21 +25,17 @@ module Gitlab
 
       class << self
         def track_event(event_action:, event_target:, author_id:, time: Time.zone.now)
-          return unless Gitlab::CurrentSettings.usage_ping_enabled
           return unless valid_target?(event_target)
           return unless valid_action?(event_action)
 
           transformed_target = transform_target(event_target)
           transformed_action = transform_action(event_action, transformed_target)
-          target_key = key(transformed_action, time)
 
-          Gitlab::Redis::HLL.add(key: target_key, value: author_id, expiry: KEY_EXPIRY_LENGTH)
+          Gitlab::UsageDataCounters::TrackUniqueActions.track_action(action: transformed_action, author_id: author_id, time: time)
         end
 
         def count_unique_events(event_action:, date_from:, date_to:)
-          keys = (date_from.to_date..date_to.to_date).map { |date| key(event_action, date) }
-
-          Gitlab::Redis::HLL.count(keys: keys)
+          Gitlab::UsageDataCounters::TrackUniqueActions.count_unique(action: event_action, date_from: date_from, date_to: date_to)
         end
 
         private
@@ -61,11 +55,6 @@ module Gitlab
         def valid_action?(action)
           Event.actions.key?(action)
         end
-
-        def key(event_action, date)
-          year_day = date.strftime('%G-%j')
-          "#{year_day}-{#{event_action}}"
-        end
       end
     end
   end

spec/lib/gitlab/usage_data_counters/editor_unique_counter_spec.rb

+# frozen_string_literal: true
+
+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 }
+
+    specify do
+      stub_application_setting(usage_ping_enabled: true)
+
+      aggregate_failures do
+        expect(track_action(author: user1)).to be_truthy
+        expect(track_action(author: user1)).to be_truthy
+        expect(track_action(author: user2)).to be_truthy
+        expect(track_action(author: user3, time: time - 3.days)).to be_truthy
+
+        expect(count_unique(date_from: time, date_to: Date.today)).to eq(2)
+        expect(count_unique(date_from: time - 5.days, date_to: Date.tomorrow)).to eq(3)
+      end
+    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)
+
+        expect(track_action(author: user1)).to be_nil
+      end
+    end
+  end
+
+  context 'for web IDE edit actions' do
+    it_behaves_like 'tracks and counts action' do
+      def track_action(params)
+        described_class.track_web_ide_edit_action(params)
+      end
+
+      def count_unique(params)
+        described_class.count_web_ide_edit_actions(params)
+      end
+    end
+  end
+
+  context 'for SFE edit actions' do
+    it_behaves_like 'tracks and counts action' do
+      def track_action(params)
+        described_class.track_sfe_edit_action(params)
+      end
+
+      def count_unique(params)
+        described_class.count_sfe_edit_actions(params)
+      end
+    end
+  end
+
+  context 'for snippet editor edit actions' do
+    it_behaves_like 'tracks and counts action' do
+      def track_action(params)
+        described_class.track_snippet_editor_edit_action(params)
+      end
+
+      def count_unique(params)
+        described_class.count_snippet_editor_edit_actions(params)
+      end
+    end
+  end
+end

spec/lib/gitlab/usage_data_counters/track_unique_actions_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gitlab::UsageDataCounters::TrackUniqueActions, :clean_gitlab_redis_shared_state do
+  let(:time) { Time.zone.now }
+  let(:action) { 'example_action' }
+
+  def track_action(params)
+    described_class.track_action(params)
+  end
+
+  def count_unique(params)
+    described_class.count_unique(params)
+  end
+
+  context 'tracking an event' do
+    context 'when tracking successfully' do
+      it 'tracks and counts the events as expected' do
+        stub_application_setting(usage_ping_enabled: true)
+
+        aggregate_failures do
+          expect(track_action(action: action, author_id: 1)).to be_truthy
+          expect(track_action(action: action, author_id: 1)).to be_truthy
+          expect(track_action(action: action, author_id: 2)).to be_truthy
+          expect(track_action(action: action, author_id: 3, time: time - 3.days)).to be_truthy
+
+          expect(count_unique(action: action, date_from: time, date_to: Date.today)).to eq(2)
+          expect(count_unique(action: action, date_from: time - 5.days, date_to: Date.tomorrow)).to eq(3)
+        end
+      end
+    end
+
+    context 'when tracking unsuccessfully' do
+      it 'does not track the event' do
+        stub_application_setting(usage_ping_enabled: false)
+
+        expect(track_action(action: action, author_id: 2)).to be_nil
+        expect(count_unique(action: action, date_from: time, date_to: Date.today)).to eq(0)
+      end
+    end
+  end
+end