apps/workbench/app/models/arvados_api_client.rb

   1 require 'httpclient'
   2 require 'thread'
   3
   4 class ArvadosApiClient
   5   class ApiError < StandardError
   6     attr_reader :api_response, :api_response_s, :api_status, :request_url
   7
   8     def initialize(request_url, errmsg)
   9       @request_url = request_url
  10       @api_response ||= {}
  11       errors = @api_response[:errors]
  12       if not errors.is_a?(Array)
  13         @api_response[:errors] = [errors || errmsg]
  14       end
  15       super(errmsg)
  16     end
  17   end
  18
  19   class NoApiResponseException < ApiError
  20     def initialize(request_url, exception)
  21       @api_response_s = exception.to_s
  22       super(request_url,
  23             "#{exception.class.to_s} error connecting to API server")
  24     end
  25   end
  26
  27   class InvalidApiResponseException < ApiError
  28     def initialize(request_url, api_response)
  29       @api_status = api_response.status_code
  30       @api_response_s = api_response.content
  31       super(request_url, "Unparseable response from API server")
  32     end
  33   end
  34
  35   class ApiErrorResponseException < ApiError
  36     def initialize(request_url, api_response)
  37       @api_status = api_response.status_code
  38       @api_response_s = api_response.content
  39       @api_response = Oj.load(@api_response_s, :symbol_keys => true)
  40       errors = @api_response[:errors]
  41       if errors.respond_to?(:join)
  42         errors = errors.join("\n\n")
  43       else
  44         errors = errors.to_s
  45       end
  46       super(request_url, "#{errors} [API: #{@api_status}]")
  47     end
  48   end
  49
  50   class AccessForbiddenException < ApiErrorResponseException; end
  51   class NotFoundException < ApiErrorResponseException; end
  52   class NotLoggedInException < ApiErrorResponseException; end
  53
  54   ERROR_CODE_CLASSES = {
  55     401 => NotLoggedInException,
  56     403 => AccessForbiddenException,
  57     404 => NotFoundException,
  58   }
  59
  60   @@profiling_enabled = Rails.configuration.profiling_enabled
  61   @@discovery = nil
  62
  63   # An API client object suitable for handling API requests on behalf
  64   # of the current thread.
  65   def self.new_or_current
  66     # If this thread doesn't have an API client yet, *or* this model
  67     # has been reloaded since the existing client was created, create
  68     # a new client. Otherwise, keep using the latest client created in
  69     # the current thread.
  70     unless Thread.current[:arvados_api_client].andand.class == self
  71       Thread.current[:arvados_api_client] = new
  72     end
  73     Thread.current[:arvados_api_client]
  74   end
  75
  76   def initialize *args
  77     @api_client = nil
  78     @client_mtx = Mutex.new
  79   end
  80
  81   def api(resources_kind, action, data=nil, tokens={})
  82
  83     profile_checkpoint
  84
  85     if not @api_client
  86       @client_mtx.synchronize do
  87         @api_client = HTTPClient.new
  88         if Rails.configuration.arvados_insecure_https
  89           @api_client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
  90         else
  91           # Use system CA certificates
  92           @api_client.ssl_config.add_trust_ca('/etc/ssl/certs')
  93         end
  94       end
  95     end
  96
  97     resources_kind = class_kind(resources_kind).pluralize if resources_kind.is_a? Class
  98     url = "#{self.arvados_v1_base}/#{resources_kind}#{action}"
  99
 100     # Clean up /arvados/v1/../../discovery/v1 to /discovery/v1
 101     url.sub! '/arvados/v1/../../', '/'
 102
 103     query = {
 104       'api_token' => tokens[:arvados_api_token] || Thread.current[:arvados_api_token] || '',
 105       'reader_tokens' => (tokens[:reader_tokens] || Thread.current[:reader_tokens] || []).to_json,
 106     }
 107     if !data.nil?
 108       data.each do |k,v|
 109         if v.is_a? String or v.nil?
 110           query[k] = v
 111         elsif v == true
 112           query[k] = 1
 113         elsif v == false
 114           query[k] = 0
 115         else
 116           query[k] = JSON.dump(v)
 117         end
 118       end
 119     else
 120       query["_method"] = "GET"
 121     end
 122     if @@profiling_enabled
 123       query["_profile"] = "true"
 124     end
 125
 126     header = {"Accept" => "application/json"}
 127
 128     profile_checkpoint { "Prepare request #{url} #{query[:uuid]} #{query[:where]} #{query[:filters]} #{query[:order]}" }
 129     msg = @client_mtx.synchronize do
 130       begin
 131         @api_client.post(url, query, header: header)
 132       rescue => exception
 133         raise NoApiResponseException.new(url, exception)
 134       end
 135     end
 136     profile_checkpoint 'API transaction'
 137
 138     begin
 139       resp = Oj.load(msg.content, :symbol_keys => true)
 140     rescue Oj::ParseError
 141       resp = nil
 142     end
 143     if not resp.is_a? Hash
 144       raise InvalidApiResponseException.new(url, msg)
 145     elsif msg.status_code != 200
 146       error_class = ERROR_CODE_CLASSES.fetch(msg.status_code,
 147                                              ApiErrorResponseException)
 148       raise error_class.new(url, msg)
 149     end
 150
 151     if resp[:_profile]
 152       Rails.logger.info "API client: " \
 153       "#{resp.delete(:_profile)[:request_time]} request_time"
 154     end
 155     profile_checkpoint 'Parse response'
 156     resp
 157   end
 158
 159   def self.patch_paging_vars(ary, items_available, offset, limit, links=nil)
 160     if items_available
 161       (class << ary; self; end).class_eval { attr_accessor :items_available }
 162       ary.items_available = items_available
 163     end
 164     if offset
 165       (class << ary; self; end).class_eval { attr_accessor :offset }
 166       ary.offset = offset
 167     end
 168     if limit
 169       (class << ary; self; end).class_eval { attr_accessor :limit }
 170       ary.limit = limit
 171     end
 172     if links
 173       (class << ary; self; end).class_eval { attr_accessor :links }
 174       ary.links = links
 175     end
 176     ary
 177   end
 178
 179   def unpack_api_response(j, kind=nil)
 180     if j.is_a? Hash and j[:items].is_a? Array and j[:kind].match(/(_list|List)$/)
 181       ary = j[:items].collect { |x| unpack_api_response x, x[:kind] }
 182       links = ArvadosResourceList.new Link
 183       links.results = (j[:links] || []).collect do |x|
 184         unpack_api_response x, x[:kind]
 185       end
 186       self.class.patch_paging_vars(ary, j[:items_available], j[:offset], j[:limit], links)
 187     elsif j.is_a? Hash and (kind || j[:kind])
 188       oclass = self.kind_class(kind || j[:kind])
 189       if oclass
 190         j.keys.each do |k|
 191           childkind = j["#{k.to_s}_kind".to_sym]
 192           if childkind
 193             j[k] = self.unpack_api_response(j[k], childkind)
 194           end
 195         end
 196         oclass.new.private_reload(j)
 197       else
 198         j
 199       end
 200     else
 201       j
 202     end
 203   end
 204
 205   def arvados_login_url(params={})
 206     if Rails.configuration.respond_to? :arvados_login_base
 207       uri = Rails.configuration.arvados_login_base
 208     else
 209       uri = self.arvados_v1_base.sub(%r{/arvados/v\d+.*}, '/login')
 210     end
 211     if params.size > 0
 212       uri += '?' << params.collect { |k,v|
 213         CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s)
 214       }.join('&')
 215     end
 216   end
 217
 218   def arvados_logout_url(params={})
 219     arvados_login_url(params).sub('/login','/logout')
 220   end
 221
 222   def arvados_v1_base
 223     Rails.configuration.arvados_v1_base
 224   end
 225
 226   def discovery
 227     @@discovery ||= api '../../discovery/v1/apis/arvados/v1/rest', ''
 228   end
 229
 230   def kind_class(kind)
 231     kind.match(/^arvados\#(.+?)(_list|List)?$/)[1].pluralize.classify.constantize rescue nil
 232   end
 233
 234   def class_kind(resource_class)
 235     resource_class.to_s.underscore
 236   end
 237
 238   def self.class_kind(resource_class)
 239     resource_class.to_s.underscore
 240   end
 241
 242   protected
 243   def profile_checkpoint label=nil
 244     return if !@@profiling_enabled
 245     label = yield if block_given?
 246     t = Time.now
 247     if label and @profile_t0
 248       Rails.logger.info "API client: #{t - @profile_t0} #{label}"
 249     end
 250     @profile_t0 = t
 251   end
 252 end