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