1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
9 class ApiError < StandardError
10 attr_reader :api_response, :api_response_s, :api_status, :request_url
12 def initialize(request_url, errmsg)
13 @request_url = request_url
15 errors = @api_response[:errors]
16 if not errors.is_a?(Array)
17 @api_response[:errors] = [errors || errmsg]
23 class NoApiResponseException < ApiError
24 def initialize(request_url, exception)
25 @api_response_s = exception.to_s
27 "#{exception.class.to_s} error connecting to API server")
31 class InvalidApiResponseException < ApiError
32 def initialize(request_url, api_response)
33 @api_status = api_response.status_code
34 @api_response_s = api_response.content
35 super(request_url, "Unparseable response from API server")
39 class ApiErrorResponseException < ApiError
40 def initialize(request_url, api_response)
41 @api_status = api_response.status_code
42 @api_response_s = api_response.content
43 @api_response = Oj.load(@api_response_s, :symbol_keys => true)
44 errors = @api_response[:errors]
45 if errors.respond_to?(:join)
46 errors = errors.join("\n\n")
50 super(request_url, "#{errors} [API: #{@api_status}]")
54 class AccessForbiddenException < ApiErrorResponseException; end
55 class NotFoundException < ApiErrorResponseException; end
56 class NotLoggedInException < ApiErrorResponseException; end
58 ERROR_CODE_CLASSES = {
59 401 => NotLoggedInException,
60 403 => AccessForbiddenException,
61 404 => NotFoundException,
64 @@profiling_enabled = Rails.configuration.profiling_enabled
67 # An API client object suitable for handling API requests on behalf
68 # of the current thread.
69 def self.new_or_current
70 # If this thread doesn't have an API client yet, *or* this model
71 # has been reloaded since the existing client was created, create
72 # a new client. Otherwise, keep using the latest client created in
74 unless Thread.current[:arvados_api_client].andand.class == self
75 Thread.current[:arvados_api_client] = new
77 Thread.current[:arvados_api_client]
82 @client_mtx = Mutex.new
85 def api(resources_kind, action, data=nil, tokens={})
90 @client_mtx.synchronize do
91 @api_client = HTTPClient.new
92 @api_client.ssl_config.timeout = Rails.configuration.api_client_connect_timeout
93 @api_client.connect_timeout = Rails.configuration.api_client_connect_timeout
94 @api_client.receive_timeout = Rails.configuration.api_client_receive_timeout
95 if Rails.configuration.arvados_insecure_https
96 @api_client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
98 # Use system CA certificates
99 ["/etc/ssl/certs/ca-certificates.crt",
100 "/etc/pki/tls/certs/ca-bundle.crt"]
101 .select { |ca_path| File.readable?(ca_path) }
102 .each { |ca_path| @api_client.ssl_config.add_trust_ca(ca_path) }
104 if Rails.configuration.api_response_compression
105 @api_client.transparent_gzip_decompression = true
110 resources_kind = class_kind(resources_kind).pluralize if resources_kind.is_a? Class
111 url = "#{self.arvados_v1_base}/#{resources_kind}#{action}"
113 # Clean up /arvados/v1/../../discovery/v1 to /discovery/v1
114 url.sub! '/arvados/v1/../../', '/'
117 'api_token' => (tokens[:arvados_api_token] ||
118 Thread.current[:arvados_api_token] ||
120 'reader_tokens' => ((tokens[:reader_tokens] ||
121 Thread.current[:reader_tokens] ||
123 [Rails.configuration.anonymous_user_token]).to_json,
124 'current_request_id' => (Thread.current[:current_request_id] || ''),
128 if v.is_a? String or v.nil?
135 query[k] = Oj.dump(v, mode: :compat)
139 query["_method"] = "GET"
142 if @@profiling_enabled
143 query["_profile"] = "true"
146 header = {"Accept" => "application/json"}
148 profile_checkpoint { "Prepare request #{query["_method"] or "POST"} #{url} #{query[:uuid]} #{query.inspect[0,256]}" }
149 msg = @client_mtx.synchronize do
151 @api_client.post(url, query, header: header)
153 raise NoApiResponseException.new(url, exception)
156 profile_checkpoint 'API transaction'
157 if @@profiling_enabled
158 if msg.headers['X-Runtime']
159 Rails.logger.info "API server: #{msg.headers['X-Runtime']} runtime reported"
161 Rails.logger.info "Content-Encoding #{msg.headers['Content-Encoding'].inspect}, Content-Length #{msg.headers['Content-Length'].inspect}, actual content size #{msg.content.size}"
165 resp = Oj.load(msg.content, :symbol_keys => true)
166 rescue Oj::ParseError
170 if not resp.is_a? Hash
171 raise InvalidApiResponseException.new(url, msg)
172 elsif msg.status_code != 200
173 error_class = ERROR_CODE_CLASSES.fetch(msg.status_code,
174 ApiErrorResponseException)
175 raise error_class.new(url, msg)
179 Rails.logger.info "API client: " \
180 "#{resp.delete(:_profile)[:request_time]} request_time"
182 profile_checkpoint 'Parse response'
186 def self.patch_paging_vars(ary, items_available, offset, limit, links=nil)
188 (class << ary; self; end).class_eval { attr_accessor :items_available }
189 ary.items_available = items_available
192 (class << ary; self; end).class_eval { attr_accessor :offset }
196 (class << ary; self; end).class_eval { attr_accessor :limit }
200 (class << ary; self; end).class_eval { attr_accessor :links }
206 def unpack_api_response(j, kind=nil)
207 if j.is_a? Hash and j[:items].is_a? Array and j[:kind].match(/(_list|List)$/)
208 ary = j[:items].collect { |x| unpack_api_response x, x[:kind] }
209 links = ArvadosResourceList.new Link
210 links.results = (j[:links] || []).collect do |x|
211 unpack_api_response x, x[:kind]
213 self.class.patch_paging_vars(ary, j[:items_available], j[:offset], j[:limit], links)
214 elsif j.is_a? Hash and (kind || j[:kind])
215 oclass = self.kind_class(kind || j[:kind])
218 childkind = j["#{k.to_s}_kind".to_sym]
220 j[k] = self.unpack_api_response(j[k], childkind)
223 oclass.new.private_reload(j)
232 def arvados_login_url(params={})
233 if Rails.configuration.respond_to? :arvados_login_base
234 uri = Rails.configuration.arvados_login_base
236 uri = self.arvados_v1_base.sub(%r{/arvados/v\d+.*}, '/login')
239 uri += '?' << params.collect { |k,v|
240 CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s)
246 def arvados_logout_url(params={})
247 arvados_login_url(params).sub('/login','/logout')
251 Rails.configuration.arvados_v1_base
255 @@discovery ||= api '../../discovery/v1/apis/arvados/v1/rest', ''
259 kind.match(/^arvados\#(.+?)(_list|List)?$/)[1].pluralize.classify.constantize rescue nil
262 def class_kind(resource_class)
263 resource_class.to_s.underscore
266 def self.class_kind(resource_class)
267 resource_class.to_s.underscore
271 def profile_checkpoint label=nil
272 return if !@@profiling_enabled
273 label = yield if block_given?
275 if label and @profile_t0
276 Rails.logger.info "API client: #{t - @profile_t0} #{label}"