Opaque-Id: Set it per request instead of with the setter

Author: picandocodigo

elasticsearch-api/lib/elasticsearch/api.rb

@@ -32,7 +32,8 @@ module API
       :format,                        # Search, Cat, ...
       :pretty,                        # Pretty-print the response
       :human,                         # Return numeric values in human readable format
-      :filter_path                    # Filter the JSON response
+      :filter_path,                   # Filter the JSON response
+      :opaque_id                      # Use X-Opaque-Id
     ]
 
     HTTP_GET          = 'GET'.freeze

elasticsearch-transport/README.md

@@ -246,25 +246,21 @@ client = Elasticsearch::Client.new logger: log
 
 ### Identifying running tasks with X-Opaque-Id
 
-The X-Opaque-Id header allows to track certain calls, or associate certain tasks with the client that started them ([more on the Elasticsearch docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html#_identifying_running_tasks)). To use this feature, you need to set an id for `opaque_id` on the client before each request. Example:
+The X-Opaque-Id header allows to track certain calls, or associate certain tasks with the client that started them ([more on the Elasticsearch docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html#_identifying_running_tasks)). To use this feature, you need to set an id for `opaque_id` on the client on each request. Example:
 
 ```ruby
 client = Elasticsearch::Client.new
-client.opaque_id = '123456'
-client.search(index: 'myindex', q: 'title:test')
+client.search(index: 'myindex', q: 'title:test', opaque_id: '123456')
 ```
 The search request will include the following HTTP Header:
 ```
 X-Opaque-Id: 123456
 ```
 
-Please note that `opaque_id` will be set to nil after every request, so you need to set it on the client for every individual request.
-
 You can also set a prefix for X-Opaque-Id when initializing the client. This will be prepended to the id you set before each request if you're using X-Opaque-Id. Example:
 ```ruby
-client = Elasticsearch::Client.new(opaque_id_prefix: 'eu-west1')
-client.opaque_id = '123456'
-client.search(index: 'myindex', q: 'title:test')
+client = Elasticsearch::Client.new(opaque_id_prefix: 'eu-west1_')
+client.search(index: 'myindex', q: 'title:test', opaque_id: '123456')
 ```
 The request will include the following HTTP Header:
 ```

elasticsearch-transport/lib/elasticsearch/transport/client.rb

@@ -162,17 +162,14 @@ def initialize(arguments={}, &block)
       #
       def perform_request(method, path, params = {}, body = nil, headers = nil)
         method = @send_get_body_as if 'GET' == method && body
-        if @opaque_id
+        if (opaque_id = params.delete(:opaque_id))
           headers = {} if headers.nil?
-          opaque_id = @opaque_id_prefix ? "#{@opaque_id_prefix}#{@opaque_id}" : @opaque_id
+          opaque_id = @opaque_id_prefix ? "#{@opaque_id_prefix}#{opaque_id}" : opaque_id
           headers.merge!('X-Opaque-Id' => opaque_id)
-          @opaque_id = nil # Remove Opaque id after each request
         end
         transport.perform_request(method, path, params, body, headers)
       end
 
-      attr_accessor :opaque_id
-
       private
 
       def set_api_key

elasticsearch-transport/spec/elasticsearch/transport/client_spec.rb

@@ -1282,18 +1282,11 @@
       end
     end
 
-    context 'when x-opaque-id is set before calling a method' do
+    context 'when x-opaque-id is set' do
       let(:client) { described_class.new(host: hosts) }
 
       it 'uses x-opaque-id on a request' do
-        client.opaque_id = '12345'
-        expect(client.perform_request('GET', '/').headers['x-opaque-id']).to eq('12345')
-      end
-
-      it 'deletes x-opaque-id on a second request' do
-        client.opaque_id = 'asdfg'
-        expect(client.perform_request('GET', '/').headers['x-opaque-id']).to eq('asdfg')
-        expect(client.perform_request('GET', '/').headers).not_to include('x-opaque-id')
+        expect(client.perform_request('GET', '/', { opaque_id: '12345' }).headers['x-opaque-id']).to eq('12345')
       end
     end
 
@@ -1304,20 +1297,27 @@
       end
 
       it 'uses x-opaque-id on a request' do
-        client.opaque_id = '12345'
-        expect(client.perform_request('GET', '/').headers['x-opaque-id']).to eq("#{prefix}12345")
+        expect(client.perform_request('GET', '/', { opaque_id: '12345' }).headers['x-opaque-id']).to eq("#{prefix}12345")
       end
 
-      it 'deletes x-opaque-id on a second request' do
-        client.opaque_id = 'asdfg'
-        expect(client.perform_request('GET', '/').headers['x-opaque-id']).to eq("#{prefix}_asdfg")
-        expect(client.perform_request('GET', '/').headers).not_to include('x-opaque-id')
+      context 'when using an API call' do
+        let(:client) { described_class.new(host: hosts) }
+
+        it 'doesnae raise an ArgumentError' do
+          expect { client.search(opaque_id: 'no_error') }.not_to raise_error
+        end
+
+        it 'uses X-Opaque-Id in the header' do
+          allow(client).to receive(:perform_request) { OpenStruct.new(body: '') }
+          expect { client.search(opaque_id: 'opaque_id') }.not_to raise_error
+          expect(client).to have_received(:perform_request)
+            .with('GET', '_search', { opaque_id: 'opaque_id' }, nil)
+        end
       end
     end
   end
 
   context 'when the client connects to Elasticsearch' do
-
     let(:logger) do
       Logger.new(STDERR).tap do |logger|
         logger.formatter = proc do |severity, datetime, progname, msg|