1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
# frozen_string_literal: true
module ServicePing
class SubmitService
PRODUCTION_BASE_URL = 'https://version.gitlab.com'
STAGING_BASE_URL = 'https://gitlab-services-version-gitlab-com-staging.gs-staging.gitlab.org'
USAGE_DATA_PATH = 'usage_data'
ERROR_PATH = 'usage_ping_errors'
METADATA_PATH = 'usage_ping_metadata'
SubmissionError = Class.new(StandardError)
def initialize(skip_db_write: false, payload: nil)
@skip_db_write = skip_db_write
@payload = payload
end
def execute
return unless ServicePing::ServicePingSettings.product_intelligence_enabled?
start_time = Time.current
begin
response = submit_usage_data_payload
raise SubmissionError, "Unsuccessful response code: #{response.code}" unless response.success?
handle_response(response)
submit_metadata_payload
rescue StandardError => e
submit_error_payload(e, start_time)
raise
end
end
private
attr_reader :payload, :skip_db_write
def metadata(service_ping_payload)
{
metadata: {
uuid: service_ping_payload[:uuid],
metrics: metrics_collection_time(service_ping_payload)
}
}
end
def metrics_collection_time(payload, parents = [])
return [] unless payload.is_a?(Hash)
payload.flat_map do |key, metric_value|
key_path = parents.dup.append(key)
if metric_value.respond_to?(:duration)
{ name: key_path.join('.'), time_elapsed: metric_value.duration }
else
metrics_collection_time(metric_value, key_path)
end
end
end
def submit_payload(payload, path: USAGE_DATA_PATH)
Gitlab::HTTP.post(
URI.join(base_url, path),
body: Gitlab::Json.dump(payload),
allow_local_requests: true,
headers: { 'Content-type' => 'application/json' }
)
end
def submit_usage_data_payload
raise SubmissionError, 'Usage data payload is blank' if payload.blank?
submit_payload(payload)
end
def handle_response(response)
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
return if skip_db_write
raw_usage_data = save_raw_usage_data(payload)
raw_usage_data.update_version_metadata!(usage_data_id: version_usage_data_id)
ServicePing::DevopsReport.new(response).execute
end
def submit_error_payload(error, start_time)
current_time = Time.current
error_payload = {
time: current_time,
uuid: Gitlab::CurrentSettings.uuid,
hostname: Gitlab.config.gitlab.host,
version: Gitlab.version_info.to_s,
message: "#{error.message.presence || error.class} at #{error.backtrace[0]}",
elapsed: (current_time - start_time).round(1)
}
submit_payload({ error: error_payload }, path: ERROR_PATH)
end
def submit_metadata_payload
submit_payload(metadata(payload), path: METADATA_PATH)
end
def save_raw_usage_data(usage_data)
# safe_find_or_create_by! was originally called here.
# We merely switched to `find_or_create_by!`
# rubocop: disable CodeReuse/ActiveRecord
RawUsageData.find_or_create_by(recorded_at: usage_data[:recorded_at]) do |record|
record.payload = usage_data
end
# rubocop: enable CodeReuse/ActiveRecord
end
# See https://gitlab.com/gitlab-org/gitlab/-/issues/233615 for details
def base_url
Rails.env.production? ? PRODUCTION_BASE_URL : STAGING_BASE_URL
end
end
end
ServicePing::SubmitService.prepend_mod
|
