Merge branch '240906-rollout-search-track-unique-users' into 'master'

Feature flag rollout `search_track_unique_users`

See merge request gitlab-org/gitlab!41739

app/controllers/concerns/redis_tracking.rb

@@ -8,29 +8,32 @@
 # include RedisTracking
 #
 # track_redis_hll_event :index, :show, name: 'i_analytics_dev_ops_score', feature: :my_feature
+#
+# if the feature flag is enabled by default you should use
+# track_redis_hll_event :index, :show, name: 'i_analytics_dev_ops_score', feature: :my_feature, feature_default_enabled: true
 module RedisTracking
   extend ActiveSupport::Concern
 
   class_methods do
-    def track_redis_hll_event(*controller_actions, name:, feature:)
+    def track_redis_hll_event(*controller_actions, name:, feature:, feature_default_enabled: false)
       after_action only: controller_actions, if: -> { request.format.html? && request.headers['DNT'] != '1' } do
-        track_unique_redis_hll_event(name, feature)
+        track_unique_redis_hll_event(name, feature, feature_default_enabled)
       end
     end
   end
 
   private
 
-  def track_unique_redis_hll_event(event_name, feature)
-    return unless metric_feature_enabled?(feature)
+  def track_unique_redis_hll_event(event_name, feature, feature_default_enabled)
+    return unless metric_feature_enabled?(feature, feature_default_enabled)
     return unless Gitlab::CurrentSettings.usage_ping_enabled?
     return unless visitor_id
 
     Gitlab::UsageDataCounters::HLLRedisCounter.track_event(visitor_id, event_name)
   end
 
-  def metric_feature_enabled?(feature)
-    Feature.enabled?(feature)
+  def metric_feature_enabled?(feature, default_enabled)
+    Feature.enabled?(feature, default_enabled: default_enabled)
   end
 
   def visitor_id

app/controllers/search_controller.rb

@@ -11,7 +11,7 @@ class SearchController < ApplicationController
     issues: :with_web_entity_associations
   }.freeze
 
-  track_redis_hll_event :show, name: 'i_search_total', feature: :search_track_unique_users
+  track_redis_hll_event :show, name: 'i_search_total', feature: :search_track_unique_users, feature_default_enabled: true
 
   around_action :allow_gitaly_ref_name_caching
 

changelogs/unreleased/240906-rollout-search-track-unique-users.yml

+---
+title: Enable unique search users usage ping HLL metric by default
+merge_request: 41739
+author:
+type: added

config/feature_flags/development/search_track_unique_users.yml

@@ -4,4 +4,4 @@ introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/40134
 rollout_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/240906
 group: group::global search
 type: development
-default_enabled: false
+default_enabled: true

doc/development/telemetry/usage_ping.md

@@ -256,13 +256,14 @@ Implemented using Redis methods [PFADD](https://redis.io/commands/pfadd) and [PF
      keys for data storage. For `daily` we keep a key for metric per day of the year, for `weekly` we
      keep a key for metric per week of the year.
 
-1. Track event in controller using `RedisTracking` module with `track_redis_hll_event(*controller_actions, name:, feature:)`.
+1. Track event in controller using `RedisTracking` module with `track_redis_hll_event(*controller_actions, name:, feature:, feature_default_enabled: false)`.
 
    Arguments:
 
    - `controller_actions`: controller actions we want to track.
    - `name`: event name.
    - `feature`: feature name, all metrics we track should be under feature flag.
+   - `feature_default_enabled`: feature flag is disabled by default, set to `true` for it to be enabled by default.
 
    Example usage:
 
@@ -272,7 +273,7 @@ Implemented using Redis methods [PFADD](https://redis.io/commands/pfadd) and [PF
      include RedisTracking
 
      skip_before_action :authenticate_user!, only: :show
-     track_redis_hll_event :index, :show, name: 'i_analytics_dev_ops_score', feature: :g_compliance_dashboard_feature
+     track_redis_hll_event :index, :show, name: 'i_analytics_dev_ops_score', feature: :g_compliance_dashboard_feature, feature_default_enabled: true
 
      def index
        render html: 'index'

ee/app/controllers/ee/search_controller.rb

@@ -5,19 +5,19 @@ module EE
     extend ActiveSupport::Concern
 
     prepended do
-      before_action :track_advanced_search, only: :show, if: -> { ::Feature.enabled?(:search_track_unique_users) && request.format.html? && request.headers['DNT'] != '1' }
+      before_action :track_advanced_search, only: :show, if: -> { ::Feature.enabled?(:search_track_unique_users, default_enabled: true) && request.format.html? && request.headers['DNT'] != '1' }
     end
 
     private
 
     def track_advanced_search
       # track unique users of advanced global search
-      track_unique_redis_hll_event('i_search_advanced', :search_track_unique_users) if search_service.use_elasticsearch?
+      track_unique_redis_hll_event('i_search_advanced', :search_track_unique_users, true) if search_service.use_elasticsearch?
 
       # track unique paid users (users who already use elasticsearch and users who could use it if they enable elasticsearch integration)
       # for gitlab.com we check if the search uses elasticsearch
       # for self-managed we check if the licensed feature available
-      track_unique_redis_hll_event('i_search_paid', :search_track_unique_users) if (::Gitlab.com? && search_service.use_elasticsearch?) || (!::Gitlab.com? && License.feature_available?(:elastic_search))
+      track_unique_redis_hll_event('i_search_paid', :search_track_unique_users, true) if (::Gitlab.com? && search_service.use_elasticsearch?) || (!::Gitlab.com? && License.feature_available?(:elastic_search))
     end
   end
 end

spec/controllers/concerns/redis_tracking_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe RedisTracking do
     include RedisTracking
 
     skip_before_action :authenticate_user!, only: :show
-    track_redis_hll_event :index, :show, name: 'i_analytics_dev_ops_score', feature: :g_compliance_dashboard_feature
+    track_redis_hll_event :index, :show, name: 'i_analytics_dev_ops_score', feature: :g_compliance_dashboard_feature, feature_default_enabled: true
 
     def index
       render html: 'index'
@@ -61,6 +61,14 @@ RSpec.describe RedisTracking do
 
         get :index
       end
+
+      it 'passes default_enabled flag' do
+        sign_in(user)
+
+        expect(controller).to receive(:metric_feature_enabled?).with(feature.to_sym, true)
+
+        get :index
+      end
     end
 
     context 'when user is not logged in and there is a visitor_id' do