From: Lucas Di Pentima <lucas.dipentima@curii.com>
Date: Fri, 7 Jan 2022 21:58:54 +0000 (-0300)
Subject: 17492: Implements Arvados::ArvadosClient to set a request-id on every call.
X-Git-Tag: 2.4.0~96^2~1
X-Git-Url: https://git.arvados.org/arvados.git/commitdiff_plain/a0dbcda78d2ce2d78d4b88ce024787a5437e3533

17492: Implements Arvados::ArvadosClient to set a request-id on every call.

Also, add the req-id is not present on response.

Arvados-DCO-1.1-Signed-off-by: Lucas Di Pentima <lucas.dipentima@curii.com>
---

diff --git a/sdk/cli/bin/arv b/sdk/cli/bin/arv
index 9d4a609377..f20268d19a 100755
--- a/sdk/cli/bin/arv
+++ b/sdk/cli/bin/arv
@@ -65,16 +65,6 @@ module Kernel
   end
 end
 
-class ArvadosClient < Google::APIClient
-  def execute(*args)
-    if args.last.is_a? Hash
-      args.last[:headers] ||= {}
-      args.last[:headers]['Accept'] ||= 'application/json'
-    end
-    super(*args)
-  end
-end
-
 def init_config
   # read authentication data from arvados configuration file if present
   lineno = 0
@@ -605,7 +595,7 @@ if ENV['ARVADOS_API_HOST_INSECURE']
 end
 
 begin
-  client = ArvadosClient.new(:host => ENV['ARVADOS_API_HOST'], :application_name => 'arvados-cli', :application_version => '1.0')
+  client = Google::APIClient.new(:host => ENV['ARVADOS_API_HOST'], :application_name => 'arvados-cli', :application_version => '1.0')
   arvados = client.discovered_api('arvados', ENV['ARVADOS_API_VERSION'])
 rescue Exception => e
   puts "Failed to connect to Arvados API server: #{e}"
@@ -708,14 +698,23 @@ else
                           })
 end
 
+request_id = result.headers[:x_request_id]
 begin
   results = JSON.parse result.body
 rescue JSON::ParserError => e
-  abort "Failed to parse server response:\n" + e.to_s
+  err_msg = "Failed to parse server response:\n" + e.to_s
+  if request_id
+    err_msg += "\nRequest ID: #{request_id or client.request_id}"
+  end
+  abort err_msg
 end
 
 if results["errors"] then
-  abort "Error: #{results["errors"][0]}"
+  err_message = results["errors"][0]
+  if request_id and !err_message.match(/.*req-[0-9a-zA-Z]{20}.*/)
+    err_message += " (#{request_id})"
+  end
+  abort "Error: #{err_message}"
 end
 
 case global_opts[:format]
diff --git a/sdk/ruby/lib/arvados.rb b/sdk/ruby/lib/arvados.rb
index d8a6be1b2d..023a1f829c 100644
--- a/sdk/ruby/lib/arvados.rb
+++ b/sdk/ruby/lib/arvados.rb
@@ -16,6 +16,26 @@ 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}.*/)
+          e.message += "\nRequest ID: #{e.headers['X-Request-Id'] or @request_id}"
+        end
+        raise e
+      end
+    end
+  end
+
   class TransactionFailedError < StandardError
   end
 
@@ -101,7 +121,7 @@ class Arvados
   end
 
   def client
-    @client ||= Google::APIClient.
+    @client ||= ArvadosClient.
       new(:host => config["ARVADOS_API_HOST"],
           :application_name => @application_name,
           :application_version => @application_version.to_s)
@@ -207,6 +227,9 @@ class Arvados
                 })
       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)