fear(core): setting idempotency header (googleapis#22517)

Author: shubhangi-google

google-apis-core/lib/google/apis/core/api_command.rb

@@ -18,7 +18,6 @@
 require 'google/apis/errors'
 require 'json'
 require 'retriable'
-require "securerandom"
 
 module Google
   module Apis
@@ -70,6 +69,7 @@ def initialize(method, url, body: nil, client_version: nil)
         def prepare!
           set_api_client_header
           set_user_project_header
+          set_idempotency_token_header 
           if options&.api_format_version
             header['X-Goog-Api-Format-Version'] = options.api_format_version.to_s
           end
@@ -143,6 +143,7 @@ def allow_form_encoding?
         end
 
         private
+        INVOCATION_ID = SecureRandom.uuid
 
         def set_api_client_header
           old_xgac = header
@@ -174,8 +175,12 @@ def set_user_project_header
           header['X-Goog-User-Project'] = quota_project_id if quota_project_id
         end
 
+        def set_idempotency_token_header
+          header['X-Goog-Gcs-Idempotency-Token'] = INVOCATION_ID
+        end
+
         def invocation_id_header
-          "gccl-invocation-id/#{SecureRandom.uuid}"
+          "gccl-invocation-id/#{INVOCATION_ID}"
         end
 
         # Attempt to parse a JSON error message

google-apis-core/spec/google/apis/core/api_command_spec.rb

@@ -34,11 +34,15 @@
 
   let(:client_version) { "1.2.3" }
   let(:x_goog_api_client_value) { "gl-ruby/#{RUBY_VERSION} gdcl/#{client_version}" }
-
   context('with preparation') do
     let(:command) do
       Google::Apis::Core::ApiCommand.new(:get, 'https://www.googleapis.com/zoo/animals', client_version: client_version)
     end
+    let(:invocation_id) { 'test123' }
+
+    before(:example) do
+      Google::Apis::Core::ApiCommand.const_set(:INVOCATION_ID, invocation_id)
+    end
 
     it 'should set X-Goog-Api-Client header if none is set' do
       command.prepare!
@@ -89,6 +93,14 @@
       command.options.add_invocation_id_header = true
       command.prepare!
       expect(command.header["X-Goog-Api-Client"]).to include("gccl-invocation-id")
+      expect(command.header["X-Goog-Api-Client"]).to include(invocation_id)
+
+    end
+
+    it "should set the X-Goog-Gcs-Idempotency-Token header" do
+      command.prepare!
+      expect(command.header['X-Goog-Gcs-Idempotency-Token']).not_to be_nil
+      expect(command.header['X-Goog-Gcs-Idempotency-Token']).to eql invocation_id
     end
   end
 
@@ -250,11 +262,18 @@
       command.options.add_invocation_id_header = true
       result = command.execute(client)
       invocation_id_header = command.header["X-Goog-Api-Client"]
-      
       expect(invocation_id_header).to include("gccl-invocation-id")
       expect(a_request(:get, 'https://www.googleapis.com/zoo/animals')
         .with { |req| req.headers['X-Goog-Api-Client'] == invocation_id_header }).to have_been_made.times(2)
     end
+
+    it 'should keep same idempotency_token across retries' do
+      result = command.execute(client)
+      idempotency_token_header = command.header['X-Goog-Gcs-Idempotency-Token']
+      expect(a_request(:get, 'https://www.googleapis.com/zoo/animals')
+        .with { |req| req.headers['X-Goog-Gcs-Idempotency-Token'] == idempotency_token_header })
+        .to have_been_made.times(2)
+    end
   end
 
   context('with a project not linked response') do

google-apis-core/spec/google/apis/core/service_spec.rb

@@ -25,6 +25,7 @@
   let(:service_ud) { Google::Apis::Core::BaseService.new('https://www.$UNIVERSE_DOMAIN$/', '', client_version: client_version) }
   let(:service_with_base_path) { Google::Apis::Core::BaseService.new('https://www.googleapis.com/', 'my_service/v1/', client_version: client_version) }
   let(:x_goog_api_client_value) { "gl-ruby/#{RUBY_VERSION} gdcl/#{client_version}" }
+  let(:invocation_id) { 'test123' }
 
   before do
     Google::Apis::ClientOptions.default.application_name = 'test'
@@ -374,6 +375,7 @@
 
   context 'with batch uploads' do
     before(:example) do
+      Google::Apis::Core::ApiCommand.const_set(:INVOCATION_ID, invocation_id)
       allow(SecureRandom).to receive(:uuid).and_return('b1981e17-f622-49af-b2eb-203308b1b17d')
       allow(Digest::SHA1).to receive(:hexdigest).and_return('outer', 'inner')
       response = <<EOF.gsub(/\n/, "\r\n")
@@ -430,6 +432,7 @@
 
 POST /upload/zoo/animals\\? HTTP/1\\.1
 X-Goog-Api-Client: #{Regexp.escape(x_goog_api_client_value)}
+X-Goog-Gcs-Idempotency-Token: #{invocation_id}
 Content-Type: multipart/related; boundary=inner
 X-Goog-Upload-Protocol: multipart
 Authorization: Bearer a token