[GEM] Extracts opaque-id from elasticsearch-transport into elasticsearch

Author: picandocodigo

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

@@ -113,9 +113,6 @@ class Client
       #   The default is false. Responses will automatically be inflated if they are compressed.
       #   If a custom transport object is used, it must handle the request compression and response inflation.
       #
-      # @option opaque_id_prefix [String] :opaque_id_prefix 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
       # @option enable_meta_header [Boolean] :enable_meta_header Enable sending the meta data header to Cloud.
       #                                                          (Default: true)
       #
@@ -143,7 +140,6 @@ def initialize(arguments = {}, &block)
                                  DEFAULT_HOST)
 
         @send_get_body_as = @arguments[:send_get_body_as] || 'GET'
-        @opaque_id_prefix = @arguments[:opaque_id_prefix] || nil
 
         if @arguments[:request_timeout]
           @arguments[:transport_options][:request] = { timeout: @arguments[:request_timeout] }
@@ -170,11 +166,6 @@ 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 = params.delete(:opaque_id))
-          headers = {} if headers.nil?
-          opaque_id = @opaque_id_prefix ? "#{@opaque_id_prefix}#{opaque_id}" : opaque_id
-          headers.merge!('X-Opaque-Id' => opaque_id)
-        end
         transport.perform_request(method, path, params, body, headers)
       end
 

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

@@ -1196,40 +1196,6 @@
       end
     end
 
-    context 'when x-opaque-id is set' do
-      let(:client) { described_class.new(host: hosts) }
-
-      it 'uses x-opaque-id on a request' do
-        expect(client.perform_request('GET', '/', { opaque_id: '12345' }).headers['x-opaque-id']).to eq('12345')
-      end
-    end
-
-    context 'when an x-opaque-id prefix is set on initialization' do
-      let(:prefix) { 'elastic_cloud' }
-      let(:client) do
-        described_class.new(host: hosts, opaque_id_prefix: prefix)
-      end
-
-      it 'uses x-opaque-id on a request' do
-        expect(client.perform_request('GET', '/', { opaque_id: '12345' }).headers['x-opaque-id']).to eq("#{prefix}12345")
-      end
-
-      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
-
     context 'when Elasticsearch response includes a warning header' do
       let(:client) do
         Elasticsearch::Transport::Client.new(hosts: hosts)

elasticsearch/lib/elasticsearch.rb

@@ -34,7 +34,11 @@ class Client
     # @option arguments [String] :cloud_id - The Cloud ID to connect to Elastic Cloud
     # @option api_key [String, Hash] :api_key Use API Key Authentication, either the base64 encoding of `id` and `api_key`
     #                                         joined by a colon as a String, or a hash with the `id` and `api_key` values.
+    # @option opaque_id_prefix [String] :opaque_id_prefix 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
     def initialize(arguments = {}, &block)
+      @opaque_id_prefix = arguments[:opaque_id_prefix] || nil
       api_key(arguments) if arguments[:api_key]
       if arguments[:cloud_id]
         arguments[:hosts] = setup_cloud_host(
@@ -50,6 +54,15 @@ def initialize(arguments = {}, &block)
     def method_missing(name, *args, &block)
       if methods.include?(name)
         super
+      elsif name == :perform_request
+        # The signature for perform_request is:
+        # method, path, params, body, headers
+        if (opaque_id = args[2]&.delete(:opaque_id))
+          headers = args[4] || {}
+          opaque_id = @opaque_id_prefix ? "#{@opaque_id_prefix}#{opaque_id}" : opaque_id
+          args[4] = headers.merge('X-Opaque-Id' => opaque_id)
+        end
+        @transport.send(name, *args, &block)
       else
         @transport.send(name, *args, &block)
       end

elasticsearch/spec/spec_helper.rb

@@ -21,3 +21,7 @@
 RSpec.configure do |config|
   config.formatter = :documentation
 end
+
+def meta_version
+  client.send(:client_meta_version, Elasticsearch::VERSION)
+end

elasticsearch/spec/unit/api_key_spec.rb

@@ -14,6 +14,7 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+
 require 'spec_helper'
 
 describe Elasticsearch::Client do
@@ -81,9 +82,6 @@
         end
       end
 
-      def meta_version
-        client.send(:client_meta_version, Elasticsearch::VERSION)
-      end
       context 'when using API Key' do
         let(:client) do
           described_class.new(api_key: 'an_api_key')

elasticsearch/spec/unit/opaque_id_spec.rb

@@ -0,0 +1,48 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+require 'spec_helper'
+require 'ostruct'
+
+describe Elasticsearch::Client do
+  let(:transport) { client.instance_variable_get('@transport') }
+  let(:client) { described_class.new }
+
+  before do
+    allow(transport).to receive(:perform_request) { OpenStruct.new(body: '') }
+  end
+
+  context 'when x-opaque-id is set' do
+    it 'uses x-opaque-id on a request' do
+      client.search(opaque_id: '12345')
+      expect(transport).to have_received(:perform_request)
+                             .with('GET', '_search', {}, nil, { 'X-Opaque-Id' => '12345' })
+    end
+  end
+
+  context 'when an x-opaque-id prefix is set on initialization' do
+    let(:prefix) { 'elastic_cloud' }
+    let(:client) do
+      described_class.new(opaque_id_prefix: prefix)
+    end
+
+    it 'uses x-opaque-id on a request' do
+      expect { client.search(opaque_id: '12345') }.not_to raise_error
+      expect(transport).to have_received(:perform_request)
+                             .with('GET', '_search', {}, nil, { 'X-Opaque-Id' => 'elastic_cloud12345' })
+    end
+  end
+end