[API] Updates msearch to not override compatiblity headers

Author: picandocodigo

elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb

@@ -120,9 +120,7 @@ def msearch(arguments = {})
           payload = body
         end
 
-        headers.merge!({
-                         'Content-Type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
-                       })
+        Utils.update_ndjson_headers!(headers, transport.options[:transport_options][:headers])
         Elasticsearch::API::Response.new(
           perform_request(method, path, params, payload, headers, request_opts)
         )

elasticsearch-api/lib/elasticsearch/api/utils.rb

@@ -177,6 +177,22 @@ def rescue_from_not_found(&block)
         end
       end
 
+      # Updates ndjson headers for msearch, bulk, and others
+      #
+      def update_ndjson_headers!(headers, client_headers)
+        current_content = client_headers.keys.find { |c| c.match?(/content-?_?type/i) }
+        current_accept = client_headers.keys.find { |c| c.match?(/accept/i) }
+
+        version = client_headers[current_content].match(/compatible-with=([8-9]{1})/)[1]
+
+        headers.merge!(
+          {
+            current_content => "application/vnd.elasticsearch+x-ndjson; compatible-with=#{version}",
+            current_accept => "application/vnd.elasticsearch+x-ndjson; compatible-with=#{version}"
+          }
+        )
+      end
+
       extend self
     end
   end

elasticsearch-api/spec/unit/actions/msearch_spec.rb

@@ -41,24 +41,21 @@
     {}
   end
 
-  let(:headers) {
-    {
-      'Content-Type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
-    }
-  }
-
-  let(:client) do
-    Class.new { include Elasticsearch::API }.new
+  let(:headers) do
+    {}
   end
 
-  it 'requires the :body argument' do
-    expect {
-      client.msearch
-    }.to raise_exception(ArgumentError)
+  let(:transport_double) do
+    Transport ||= Struct.new('Transport', :options)
+    Transport.new({ transport_options: { headers: {} } })
   end
 
-  context 'when the body is an object' do
+  before do
+    allow(client_double).to receive(:transport).and_return transport_double
+    allow(Elasticsearch::API::Utils).to receive(:update_ndjson_headers!).and_return(headers)
+  end
 
+  context 'when the body is an object' do
     let(:body) do
       <<-PAYLOAD.gsub(/^\s+/, '')
             {"index":"foo"}
@@ -72,15 +69,14 @@
 
     it 'performs the request' do
       expect(client_double.msearch body: [
-          { index: 'foo', search: { query: { match_all: {}  } } },
+          { index: 'foo', search: { query: { match_all: {} } } },
           { index: 'bar', search: { query: { match: { foo: 'bar' } } } },
           { search_type: 'count', search: { facets: { tags: {} } } }
       ])
     end
   end
 
   context 'when the body is a string' do
-
     let(:body) do
       %Q|{"foo":"bar"}\n{"moo":"lam"}|
     end
@@ -141,7 +137,6 @@
   end
 
   context 'when the request needs to be URL-escaped' do
-
     let(:url) do
       'foo%5Ebar/_msearch'
     end
@@ -167,7 +162,6 @@
   end
 
   context 'when the URL params need to be URL-encoded' do
-
     let(:url) do
       '_msearch'
     end

elasticsearch-api/spec/unit/msearch_spec.rb

@@ -0,0 +1,133 @@
+# 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 'elastic/transport'
+
+describe 'msearch custom' do
+  context 'raise exception' do
+    it 'requires the :body argument' do
+      expect do
+        Elasticsearch::Client.new.msearch
+      end.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when not setting headers' do
+    let(:client) do
+      Elasticsearch::Client.new
+    end
+
+    let(:expected_headers) do
+      {
+        'accept' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9',
+        'content-type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9'
+      }
+    end
+
+    it 'does not override headers' do
+      allow(client)
+        .to receive(:perform_request)
+              .with(
+                Elasticsearch::API::HTTP_POST,
+                '_msearch',
+                {},
+                {},
+                expected_headers,
+                { endpoint: 'msearch' }
+              )
+      expect(client.msearch(body: {})).to be_a Elasticsearch::API::Response
+    end
+  end
+
+  context 'when using compatibility headers for version 8' do
+    let(:client) do
+      Elasticsearch::Client.new(
+        transport_options: {
+          headers: custom_headers
+        }
+      )
+    end
+
+    let(:custom_headers) do
+      {
+        accept: 'application/vnd.elasticsearch+json; compatible-with=8',
+        content_type: 'application/vnd.elasticsearch+json; compatible-with=8'
+      }
+    end
+
+    let(:expected_headers) do
+      {
+        accept: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8',
+        content_type: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8'
+      }
+    end
+
+    it 'does not override version in headers' do
+      allow(client)
+        .to receive(:perform_request)
+        .with(
+          Elasticsearch::API::HTTP_POST,
+          '_msearch',
+          {},
+          {},
+          expected_headers,
+          { endpoint: 'msearch' }
+        )
+      expect(client.msearch(body: {})).to be_a Elasticsearch::API::Response
+    end
+  end
+
+  context 'when using custom headers in request' do
+    let(:client) do
+      Elasticsearch::Client.new(
+        transport_options: {
+          headers: custom_headers
+        }
+      )
+    end
+
+    let(:custom_headers) do
+      {
+        accept: 'application/vnd.elasticsearch+json; compatible-with=8',
+        content_type: 'application/vnd.elasticsearch+json; compatible-with=8'
+      }
+    end
+
+    let(:expected_headers) do
+      {
+        accept: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8',
+        content_type: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8',
+        x_custom: 'Custom header'
+      }
+    end
+
+    it 'does not override version in headers' do
+      allow(client)
+        .to receive(:perform_request)
+              .with(
+                Elasticsearch::API::HTTP_POST,
+                '_msearch',
+                {},
+                {},
+                expected_headers,
+                { endpoint: 'msearch' }
+              )
+      expect(client.msearch(body: {}, headers: { x_custom: 'Custom header' })).to be_a Elasticsearch::API::Response
+    end
+  end
+end