Merge branch 'rename_submit_service_ping_service_and_refactor_332564' into 'master'

Rename SubmitUsagePingService to SubmitServicePingService

See merge request gitlab-org/gitlab!65073

app/services/service_ping/submit_service.rb

+# frozen_string_literal: true
+
+module ServicePing
+  class SubmitService
+    PRODUCTION_URL = 'https://version.gitlab.com/usage_data'
+    STAGING_URL = 'https://gitlab-services-version-gitlab-com-staging.gs-staging.gitlab.org/usage_data'
+
+    METRICS = %w[leader_issues instance_issues percentage_issues leader_notes instance_notes
+                 percentage_notes leader_milestones instance_milestones percentage_milestones
+                 leader_boards instance_boards percentage_boards leader_merge_requests
+                 instance_merge_requests percentage_merge_requests leader_ci_pipelines
+                 instance_ci_pipelines percentage_ci_pipelines leader_environments instance_environments
+                 percentage_environments leader_deployments instance_deployments percentage_deployments
+                 leader_projects_prometheus_active instance_projects_prometheus_active
+                 percentage_projects_prometheus_active leader_service_desk_issues instance_service_desk_issues
+                 percentage_service_desk_issues].freeze
+
+    SubmissionError = Class.new(StandardError)
+
+    def execute
+      return unless Gitlab::CurrentSettings.usage_ping_enabled?
+      return if User.single_user&.requires_usage_stats_consent?
+
+      usage_data = Gitlab::UsageData.data(force_refresh: true)
+
+      raise SubmissionError, 'Usage data is blank' if usage_data.blank?
+
+      raw_usage_data = save_raw_usage_data(usage_data)
+
+      response = Gitlab::HTTP.post(
+        url,
+        body: usage_data.to_json,
+        allow_local_requests: true,
+        headers: { 'Content-type' => 'application/json' }
+      )
+
+      raise SubmissionError, "Unsuccessful response code: #{response.code}" unless response.success?
+
+      version_usage_data_id = response.dig('conv_index', 'usage_data_id') || response.dig('dev_ops_score', 'usage_data_id')
+
+      unless version_usage_data_id.is_a?(Integer) && version_usage_data_id > 0
+        raise SubmissionError, "Invalid usage_data_id in response: #{version_usage_data_id}"
+      end
+
+      raw_usage_data.update_version_metadata!(usage_data_id: version_usage_data_id)
+
+      store_metrics(response)
+    end
+
+    private
+
+    def save_raw_usage_data(usage_data)
+      RawUsageData.safe_find_or_create_by(recorded_at: usage_data[:recorded_at]) do |record|
+        record.payload = usage_data
+      end
+    end
+
+    def store_metrics(response)
+      metrics = response['conv_index'] || response['dev_ops_score'] # leaving dev_ops_score here, as the response data comes from the gitlab-version-com
+
+      return unless metrics.present?
+
+      DevOpsReport::Metric.create!(
+        metrics.slice(*METRICS)
+      )
+    end
+
+    # See https://gitlab.com/gitlab-org/gitlab/-/issues/233615 for details
+    def url
+      if Rails.env.production?
+        PRODUCTION_URL
+      else
+        STAGING_URL
+      end
+    end
+  end
+end
+
+ServicePing::SubmitService.prepend_mod

app/services/submit_usage_ping_service.rb

-# frozen_string_literal: true
-
-class SubmitUsagePingService
-  PRODUCTION_URL = 'https://version.gitlab.com/usage_data'
-  STAGING_URL = 'https://gitlab-services-version-gitlab-com-staging.gs-staging.gitlab.org/usage_data'
-
-  METRICS = %w[leader_issues instance_issues percentage_issues leader_notes instance_notes
-               percentage_notes leader_milestones instance_milestones percentage_milestones
-               leader_boards instance_boards percentage_boards leader_merge_requests
-               instance_merge_requests percentage_merge_requests leader_ci_pipelines
-               instance_ci_pipelines percentage_ci_pipelines leader_environments instance_environments
-               percentage_environments leader_deployments instance_deployments percentage_deployments
-               leader_projects_prometheus_active instance_projects_prometheus_active
-               percentage_projects_prometheus_active leader_service_desk_issues instance_service_desk_issues
-               percentage_service_desk_issues].freeze
-
-  SubmissionError = Class.new(StandardError)
-
-  def execute
-    return unless Gitlab::CurrentSettings.usage_ping_enabled?
-    return if User.single_user&.requires_usage_stats_consent?
-
-    usage_data = Gitlab::UsageData.data(force_refresh: true)
-
-    raise SubmissionError, 'Usage data is blank' if usage_data.blank?
-
-    raw_usage_data = save_raw_usage_data(usage_data)
-
-    response = Gitlab::HTTP.post(
-      url,
-      body: usage_data.to_json,
-      allow_local_requests: true,
-      headers: { 'Content-type' => 'application/json' }
-    )
-
-    raise SubmissionError, "Unsuccessful response code: #{response.code}" unless response.success?
-
-    version_usage_data_id = response.dig('conv_index', 'usage_data_id') || response.dig('dev_ops_score', 'usage_data_id')
-
-    unless version_usage_data_id.is_a?(Integer) && version_usage_data_id > 0
-      raise SubmissionError, "Invalid usage_data_id in response: #{version_usage_data_id}"
-    end
-
-    raw_usage_data.update_version_metadata!(usage_data_id: version_usage_data_id)
-
-    store_metrics(response)
-  end
-
-  private
-
-  def save_raw_usage_data(usage_data)
-    RawUsageData.safe_find_or_create_by(recorded_at: usage_data[:recorded_at]) do |record|
-      record.payload = usage_data
-    end
-  end
-
-  def store_metrics(response)
-    metrics = response['conv_index'] || response['dev_ops_score'] # leaving dev_ops_score here, as the response data comes from the gitlab-version-com
-
-    return unless metrics.present?
-
-    DevOpsReport::Metric.create!(
-      metrics.slice(*METRICS)
-    )
-  end
-
-  # See https://gitlab.com/gitlab-org/gitlab/-/issues/233615 for details
-  def url
-    if Rails.env.production?
-      PRODUCTION_URL
-    else
-      STAGING_URL
-    end
-  end
-end
-
-SubmitUsagePingService.prepend_mod

app/workers/gitlab_usage_ping_worker.rb

@@ -22,7 +22,7 @@ class GitlabUsagePingWorker # rubocop:disable Scalability/IdempotentWorker
       # Splay the request over a minute to avoid thundering herd problems.
       sleep(rand(0.0..60.0).round(3))
 
-      SubmitUsagePingService.new.execute
+      ServicePing::SubmitService.new.execute
     end
   end
 end

spec/services/submit_usage_ping_service_spec.rb → spec/services/service_ping/submit_service_ping_service_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-RSpec.describe SubmitUsagePingService do
+RSpec.describe ServicePing::SubmitService do
   include StubRequests
   include UsageDataHelpers
 

spec/workers/gitlab_usage_ping_worker_spec.rb

@@ -4,19 +4,19 @@ require 'spec_helper'
 
 RSpec.describe GitlabUsagePingWorker, :clean_gitlab_redis_shared_state do
   before do
-    allow_next_instance_of(SubmitUsagePingService) { |service| allow(service).to receive(:execute) }
+    allow_next_instance_of(ServicePing::SubmitService) { |service| allow(service).to receive(:execute) }
     allow(subject).to receive(:sleep)
   end
 
   it 'does not run for GitLab.com' do
     allow(Gitlab).to receive(:com?).and_return(true)
-    expect(SubmitUsagePingService).not_to receive(:new)
+    expect(ServicePing::SubmitService).not_to receive(:new)
 
     subject.perform
   end
 
-  it 'delegates to SubmitUsagePingService' do
-    expect_next_instance_of(SubmitUsagePingService) { |service| expect(service).to receive(:execute) }
+  it 'delegates to ServicePing::SubmitService' do
+    expect_next_instance_of(ServicePing::SubmitService) { |service| expect(service).to receive(:execute) }
 
     subject.perform
   end
@@ -41,8 +41,8 @@ RSpec.describe GitlabUsagePingWorker, :clean_gitlab_redis_shared_state do
       Gitlab::ExclusiveLease.new(described_class::LEASE_KEY, timeout: described_class::LEASE_TIMEOUT).try_obtain
     end
 
-    it 'does not invoke SubmitUsagePingService' do
-      allow_next_instance_of(SubmitUsagePingService) { |service| expect(service).not_to receive(:execute) }
+    it 'does not invoke ServicePing::SubmitService' do
+      allow_next_instance_of(ServicePing::SubmitService) { |service| expect(service).not_to receive(:execute) }
 
       expect { subject.perform }.to raise_error(Gitlab::ExclusiveLeaseHelpers::FailedToObtainLockError)
     end