17492: Adds test confirming that req-id is added on exceptions.

[arvados.git] / sdk / ruby / lib / arvados.rb

diff --git a/sdk/ruby/lib/arvados.rb b/sdk/ruby/lib/arvados.rb
index a89c21b017ddfc1943ae8c403ef8d9f871f34388..a72a9f8241f442f20d6c7559baedeb79582cc218 100644 (file)
--- a/sdk/ruby/lib/arvados.rb
+++ b/sdk/ruby/lib/arvados.rb
@@ -16,10 +16,29 @@ ActiveSupport::Inflector.inflections do |inflect|
 end
 
 class Arvados
+  class ArvadosClient < Google::APIClient
+    attr_reader :request_id
+
+    def execute(*args)
+      @request_id = "req-" + Random::DEFAULT.rand(2**128).to_s(36)[0..19]
+      if args.last.is_a? Hash
+        args.last[:headers] ||= {}
+        args.last[:headers]['X-Request-Id'] = @request_id
+      end
+      begin
+        super(*args)
+      rescue => e
+        if !e.message.match(/.*req-[0-9a-zA-Z]{20}.*/)
+          raise $!, "#{$!} (Request ID: #{@request_id})", $!.backtrace
+        end
+        raise e
+      end
+    end
+  end
+
   class TransactionFailedError < StandardError
   end
 
-  @@config = nil
   @@debuglevel = 0
   class << self
     attr_accessor :debuglevel
@@ -31,12 +50,16 @@ class Arvados
 
     @arvados_api_version = opts[:api_version] || 'v1'
 
-    @arvados_api_host = opts[:api_host] ||
-      config['ARVADOS_API_HOST'] or
-      raise "#{$0}: no :api_host or ENV[ARVADOS_API_HOST] provided."
-    @arvados_api_token = opts[:api_token] ||
-      config['ARVADOS_API_TOKEN'] or
-      raise "#{$0}: no :api_token or ENV[ARVADOS_API_TOKEN] provided."
+    @config = nil
+    [[:api_host, 'ARVADOS_API_HOST'],
+     [:api_token, 'ARVADOS_API_TOKEN']].each do |op, en|
+      if opts[op]
+        config[en] = opts[op]
+      end
+      if !config[en]
+        raise "#{$0}: no :#{op} or ENV[#{en}] provided."
+      end
+    end
 
     if (opts[:suppress_ssl_warnings] or
         %w(1 true yes).index(config['ARVADOS_API_HOST_INSECURE'].
@@ -91,17 +114,15 @@ class Arvados
       # result looks like Arvados::A26949680::Job.
       namespace_class.const_set classname, klass
 
-      self.class.class_eval do
-        define_method classname.underscore do
-          klass
-        end
+      self.define_singleton_method classname.underscore do
+        klass
       end
     end
   end
 
   def client
-    @client ||= Google::APIClient.
-      new(:host => @arvados_api_host,
+    @client ||= ArvadosClient.
+      new(:host => config["ARVADOS_API_HOST"],
           :application_name => @application_name,
           :application_version => @application_version.to_s)
   end
@@ -119,7 +140,7 @@ class Arvados
   end
 
   def config(config_file_path="~/.config/arvados/settings.conf")
-    return @@config if @@config
+    return @config if @config
 
     # Initialize config settings with environment variables.
     config = {}
@@ -137,7 +158,7 @@ class Arvados
       # Note: If we start using additional configuration settings from
       # this file in the future, we might have to read the file anyway
       # instead of returning here.
-      return (@@config = config)
+      return (@config = config)
     end
 
     begin
@@ -164,7 +185,7 @@ class Arvados
       debuglog "Ignoring error reading #{config_file_path}: #{e}", 0
     end
 
-    @@config = config
+    @config = config
   end
 
   class Model
@@ -202,10 +223,13 @@ class Arvados
                 :parameters => parameters,
                 :body_object => body,
                 :headers => {
-                  :authorization => 'OAuth2 '+arvados.config['ARVADOS_API_TOKEN']
+                  :authorization => 'Bearer '+arvados.config['ARVADOS_API_TOKEN']
                 })
       resp = JSON.parse result.body, :symbolize_names => true
       if resp[:errors]
+        if !resp[:errors][0].match(/.*req-[0-9a-zA-Z]{20}.*/)
+          resp[:errors][0] += " (#{result.headers['X-Request-Id'] or client.request_id})"
+        end
         raise Arvados::TransactionFailedError.new(resp[:errors])
       elsif resp[:uuid] and resp[:etag]
         self.new(resp)