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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
# frozen_string_literal: true
module BulkImports
module Clients
class HTTP
include Gitlab::Utils::StrongMemoize
API_VERSION = 'v4'
DEFAULT_PAGE = 1
DEFAULT_PER_PAGE = 30
PAT_ENDPOINT_MIN_VERSION = '15.5.0'
SIDEKIQ_REQUEST_TIMEOUT = 60
def initialize(url:, token:, page: DEFAULT_PAGE, per_page: DEFAULT_PER_PAGE, api_version: API_VERSION)
@url = url
@token = token&.strip
@page = page
@per_page = per_page
@api_version = api_version
@compatible_instance_version = false
end
def get(resource, query = {})
request(:get, resource, query: query.reverse_merge(request_query))
end
def post(resource, body = {})
request(:post, resource, body: body)
end
def head(resource)
request(:head, resource)
end
def stream(resource, &block)
request(:get, resource, stream_body: true, &block)
end
def each_page(method, resource, query = {}, &block)
return to_enum(__method__, method, resource, query) unless block
next_page = @page
while next_page
@page = next_page.to_i
response = self.public_send(method, resource, query) # rubocop: disable GitlabSecurity/PublicSend
collection = response.parsed_response
next_page = response.headers['x-next-page'].presence
yield collection
end
end
def resource_url(resource)
Gitlab::Utils.append_path(api_url, resource)
end
def instance_version
Gitlab::VersionInfo.parse(metadata['version'])
end
def instance_enterprise
Gitlab::Utils.to_boolean(metadata['enterprise'], default: true)
end
def compatible_for_project_migration?
instance_version >= BulkImport.min_gl_version_for_project_migration
end
def options
{ headers: { 'Content-Type' => 'application/json' }, query: { private_token: @token } }
end
def validate_import_scopes!
return true unless instance_version >= ::Gitlab::VersionInfo.parse(PAT_ENDPOINT_MIN_VERSION)
response = with_error_handling do
Gitlab::HTTP.get(resource_url("personal_access_tokens/self"), options)
end
return true if response['scopes']&.include?('api')
raise ::BulkImports::Error.scope_or_url_validation_failure
end
def validate_instance_version!
raise ::BulkImports::Error.invalid_url unless instance_version.valid?
return true unless instance_version.major < BulkImport::MIN_MAJOR_VERSION
raise ::BulkImports::Error.unsupported_gitlab_version
end
private
def metadata
response = begin
with_error_handling do
Gitlab::HTTP.get(resource_url(:version), options)
end
rescue BulkImports::NetworkError
# `version` endpoint is not available, try `metadata` endpoint instead
with_error_handling do
Gitlab::HTTP.get(resource_url(:metadata), options)
end
end
response.parsed_response
rescue BulkImports::NetworkError => e
case e&.response&.code
when 401, 403
raise ::BulkImports::Error.scope_or_url_validation_failure
when 404
raise ::BulkImports::Error.invalid_url
else
raise
end
end
strong_memoize_attr :metadata
# rubocop:disable GitlabSecurity/PublicSend
def request(method, resource, options = {}, &block)
with_error_handling do
Gitlab::HTTP.public_send(
method,
resource_url(resource),
request_options(options),
&block
)
end
end
# rubocop:enable GitlabSecurity/PublicSend
def request_options(options)
default_options.merge(options)
end
def default_options
{
query: request_query,
follow_redirects: true,
resend_on_redirect: false,
limit: 2
}.merge(request_timeout.to_h)
end
def request_query
{
page: @page,
per_page: @per_page,
private_token: @token
}
end
def request_timeout
{ timeout: SIDEKIQ_REQUEST_TIMEOUT } if Gitlab::Runtime.sidekiq?
end
# @raise [BulkImports::NetworkError] when unsuccessful
def with_error_handling
response = yield
return response if response.success?
raise ::BulkImports::NetworkError.new("Unsuccessful response #{response.code} from #{response.request.path.path}. Body: #{response.parsed_response}", response: response)
rescue *Gitlab::HTTP::HTTP_ERRORS => e
raise ::BulkImports::NetworkError, e
end
def api_url
Gitlab::Utils.append_path(@url, "/api/#{@api_version}")
end
end
end
end
|
