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] ||
 105                       Thread.current[:arvados_api_token] ||
 106                       ''),
 107       'reader_tokens' => ((tokens[:reader_tokens] ||
 108                            Thread.current[:reader_tokens] ||
 109                            []) +
 110                           [Rails.configuration.anonymous_user_token]).to_json,
 111     }
 112     if !data.nil?
 113       data.each do |k,v|
 114         if v.is_a? String or v.nil?
 115           query[k] = v
 116         elsif v == true
 117           query[k] = 1
 118         elsif v == false
 119           query[k] = 0
 120         else
 121           query[k] = JSON.dump(v)
 122         end
 123       end
 124     else
 125       query["_method"] = "GET"
 126     end
 127
 128     if @@profiling_enabled
 129       query["_profile"] = "true"
 130     end
 131
 132     header = {"Accept" => "application/json"}
 133
 134     profile_checkpoint { "Prepare request #{url} #{query[:uuid]} #{query[:where]} #{query[:filters]} #{query[:order]}" }
 135     msg = @client_mtx.synchronize do
 136       begin
 137         @api_client.post(url, query, header: header)
 138       rescue => exception
 139         raise NoApiResponseException.new(url, exception)
 140       end
 141     end
 142     profile_checkpoint 'API transaction'
 143
 144     begin
 145       resp = Oj.load(msg.content, :symbol_keys => true)
 146     rescue Oj::ParseError
 147       resp = nil
 148     end
 149
 150     if not resp.is_a? Hash
 151       raise InvalidApiResponseException.new(url, msg)
 152     elsif msg.status_code != 200
 153       error_class = ERROR_CODE_CLASSES.fetch(msg.status_code,
 154                                              ApiErrorResponseException)
 155       raise error_class.new(url, msg)
 156     end
 157
 158     if resp[:_profile]
 159       Rails.logger.info "API client: " \
 160       "#{resp.delete(:_profile)[:request_time]} request_time"
 161     end
 162     profile_checkpoint 'Parse response'
 163     resp
 164   end
 165
 166   def self.patch_paging_vars(ary, items_available, offset, limit, links=nil)
 167     if items_available
 168       (class << ary; self; end).class_eval { attr_accessor :items_available }
 169       ary.items_available = items_available
 170     end
 171     if offset
 172       (class << ary; self; end).class_eval { attr_accessor :offset }
 173       ary.offset = offset
 174     end
 175     if limit
 176       (class << ary; self; end).class_eval { attr_accessor :limit }
 177       ary.limit = limit
 178     end
 179     if links
 180       (class << ary; self; end).class_eval { attr_accessor :links }
 181       ary.links = links
 182     end
 183     ary
 184   end
 185
 186   def unpack_api_response(j, kind=nil)
 187     if j.is_a? Hash and j[:items].is_a? Array and j[:kind].match(/(_list|List)$/)
 188       ary = j[:items].collect { |x| unpack_api_response x, x[:kind] }
 189       links = ArvadosResourceList.new Link
 190       links.results = (j[:links] || []).collect do |x|
 191         unpack_api_response x, x[:kind]
 192       end
 193       self.class.patch_paging_vars(ary, j[:items_available], j[:offset], j[:limit], links)
 194     elsif j.is_a? Hash and (kind || j[:kind])
 195       oclass = self.kind_class(kind || j[:kind])
 196       if oclass
 197         j.keys.each do |k|
 198           childkind = j["#{k.to_s}_kind".to_sym]
 199           if childkind
 200             j[k] = self.unpack_api_response(j[k], childkind)
 201           end
 202         end
 203         oclass.new.private_reload(j)
 204       else
 205         j
 206       end
 207     else
 208       j
 209     end
 210   end
 211
 212   def arvados_login_url(params={})
 213     if Rails.configuration.respond_to? :arvados_login_base
 214       uri = Rails.configuration.arvados_login_base
 215     else
 216       uri = self.arvados_v1_base.sub(%r{/arvados/v\d+.*}, '/login')
 217     end
 218     if params.size > 0
 219       uri += '?' << params.collect { |k,v|
 220         CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s)
 221       }.join('&')
 222     end
 223     uri
 224   end
 225
 226   def arvados_logout_url(params={})
 227     arvados_login_url(params).sub('/login','/logout')
 228   end
 229
 230   def arvados_v1_base
 231     Rails.configuration.arvados_v1_base
 232   end
 233
 234   def discovery
 235     @@discovery ||= api '../../discovery/v1/apis/arvados/v1/rest', ''
 236   end
 237
 238   def kind_class(kind)
 239     kind.match(/^arvados\#(.+?)(_list|List)?$/)[1].pluralize.classify.constantize rescue nil
 240   end
 241
 242   def class_kind(resource_class)
 243     resource_class.to_s.underscore
 244   end
 245
 246   def self.class_kind(resource_class)
 247     resource_class.to_s.underscore
 248   end
 249
 250   protected
 251   def profile_checkpoint label=nil
 252     return if !@@profiling_enabled
 253     label = yield if block_given?
 254     t = Time.now
 255     if label and @profile_t0
 256       Rails.logger.info "API client: #{t - @profile_t0} #{label}"
 257     end
 258     @profile_t0 = t
 259   end
 260 end