logstash-filter-http 1.4.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cc14c2d1874c8df2c795535e90ee6b7e85070d601039ab0a8f5c91da874af16
-  data.tar.gz: 21c3aa078560f4900fb8db35eca35abb60b71798a224164f2a41cd4682e2f755
+  metadata.gz: cb0e716ca8a625caa16cecf3884f92c979a2fab2b94ff6b868f7b5732da4bd13
+  data.tar.gz: a17253287ebce2ad6bd663b60907dd3ec4c8d646cee9dd35901b8bd2d5fad1da
 SHA512:
-  metadata.gz: aba589b66860997ba29e3edaa5564c04d897ed9502fc46b263a356ae80a7c768aa1570873ced5865aa7c66523e1aa04054ef604d61e68e4c3644f548456d82a1
-  data.tar.gz: 8974fa26e8127e6a7a880d44c8df7be1ac4ec4435dc38a6912f589f1d1f7bc4eae2154f8cd2fdb3307a5a67896df2fd95e692460d182f65f5fb69cc12f2b58e1
+  metadata.gz: ac2c2e11232dbb7d3cc3cc43e3f43cbf2cefcdc71e3f2a7bcb9a421d97a85f96ef75dffa0f1faee97cfb666caae34f75fe87beb161d08fc45a39f7296bd1d9a8
+  data.tar.gz: edc975f2862c3a94baa60b1204d0cc5c07c10629f516076c0380d1b8bdb559e6ca0d06d9df08b6191c931007f98db1cb17078aa0dffaeb1252f9e538406cbbc2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.4.2
+  - Fix: resolve content type when a content-type header contains an array [#46](https://github.com/logstash-plugins/logstash-filter-http/pull/46)
+
+## 1.4.1
+  - Fix: don't process response body for HEAD requests [#41](https://github.com/logstash-plugins/logstash-filter-http/pull/41)
+
 ## 1.4.0
   - Feat: added ssl_supported_protocols option [#38](https://github.com/logstash-plugins/logstash-filter-http/pull/38)
  

data/lib/logstash/filters/http.rb

@@ -88,11 +88,12 @@ class LogStash::Filters::Http < LogStash::Filters::Base
     elsif !code.between?(200, 299)
       @logger.error('error during HTTP request',
                     :url => url_for_event, :code => code,
+                    :headers => response_headers,
                     :response => response_body)
       @tag_on_request_failure.each { |tag| event.tag(tag) }
     else
       @logger.debug? && @logger.debug('success received',
-                                      :code => code, :body => response_body)
+                                      :code => code, :headers => response_headers, :body => response_body)
       process_response(response_body, response_headers, event)
       filter_matched(event)
     end
@@ -132,9 +133,10 @@ EOF
   end
 
   def process_response(body, headers, event)
-    content_type, _ = headers.fetch("content-type", "").split(";")
     event.set(@target_headers, headers)
-    if content_type == "application/json"
+    return if @verb == 'head' # Since HEAD requests will not contain body, we need to set only header
+
+    if headers_has_json_content_type?(headers)
       begin
         parsed = LogStash::Json.load(body)
         event.set(@target_body, parsed)
@@ -151,4 +153,14 @@ EOF
     end
   end
 
+  ##
+  # @param headers [String] or [Array]
+  # @return resolved content-type
+  def headers_has_json_content_type?(headers)
+    # content-type might be an array or string with ; separated
+    headers = headers.fetch("content-type", "")
+    headers = headers.kind_of?(Array) ? headers : headers.split(';')
+    headers.map(&:strip).include?("application/json")
+  end
+
 end # class LogStash::Filters::Rest

data/logstash-filter-http.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-filter-http'
-  s.version = '1.4.0'
+  s.version = '1.4.2'
   s.licenses = ['Apache License (2.0)']
   s.summary = 'This filter requests data from a RESTful Web Service.'
   s.description = 'This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install logstash-filter-http. This gem is not a stand-alone program'

data/spec/filters/http_spec.rb

@@ -118,6 +118,7 @@ describe LogStash::Filters::Http do
           'Server' => 'Apache',
           'Last-Modified' => 'Mon, 18 Jul 2016 02:36:04 GMT',
           'X-Backend-Server' => 'logstash.elastic.co',
+          'Content-Type' => %w[application/json application/xml]
       }
       [200, response_headers, "Bom dia"]
     end
@@ -136,10 +137,12 @@ describe LogStash::Filters::Http do
         if ecs_select.active_mode == :disabled
           expect(event.get('headers')).to include "Server" => "Apache"
           expect(event.get('headers')).to include "X-Backend-Server" => "logstash.elastic.co"
+          expect(event.get('headers')).to include "Content-Type" => %w[application/json application/xml]
         else
           expect(event.include?('headers')).to be false
           expect(event.get('[@metadata][filter][http][response][headers]')).to include "Server" => "Apache"
           expect(event.get('[@metadata][filter][http][response][headers]')).to include "X-Backend-Server" => "logstash.elastic.co"
+          expect(event.get('[@metadata][filter][http][response][headers]')).to include "Content-Type" => %w[application/json application/xml]
         end
       end
 
@@ -172,6 +175,46 @@ describe LogStash::Filters::Http do
         subject.filter(event)
       end
     end
+
+    context "content-type header" do
+      let(:config) { super().merge "headers" => headers }
+
+      describe 'when content-type header is an array' do
+        let(:headers) {{ "Content-type" => %w[application/json logstash/custom-media-type] }}
+
+        it "resolves the content-type" do
+          expect(subject).to receive(:request_http) do |verb, url, options|
+            expect( options.fetch(:headers, {}) ).to include(headers)
+          end.and_return(response)
+
+          expect{ subject.filter(event) }.not_to raise_error
+        end
+      end
+
+      describe 'when content-type header is a string' do
+        let(:headers) {{ "Content-type" => "application/json; logstash/custom-media-type" }}
+
+        it "resolves the content-type" do
+          expect(subject).to receive(:request_http) do |verb, url, options|
+            expect( options.fetch(:headers, {}) ).to include(headers)
+          end.and_return(response)
+
+          expect{ subject.filter(event) }.not_to raise_error
+        end
+      end
+
+      describe 'when content-type header is an empty string' do
+        let(:headers) {{ "Content-type" => "" }}
+
+        it "resolves the content-type" do
+          expect(subject).to receive(:request_http) do |verb, url, options|
+            expect( options.fetch(:headers, {}) ).to include(headers)
+          end.and_return(response)
+
+          expect{ subject.filter(event) }.not_to raise_error
+        end
+      end
+    end
   end
 
   describe "query string parameters" do
@@ -191,7 +234,6 @@ describe LogStash::Filters::Http do
     before(:each) { subject.register }
     let(:response) { [200, {}, "Bom dia"] }
     let(:url) { "http://stringsize.com" }
-    let(:config) { super().merge "body" => body }
 
     describe "format" do
       let(:config) { super().merge "body_format" => body_format, "body" => body }
@@ -277,6 +319,16 @@ describe LogStash::Filters::Http do
         subject.filter(event)
       end
     end
+    context "when the verb is HEAD" do
+      let(:config) { super().merge("verb" => "HEAD") }
+      before(:each) do
+        allow(subject).to receive(:request_http).and_return(response)
+      end
+      it "does not include the body" do
+        subject.filter(event)
+        expect(event).to_not include("body")
+      end
+    end
   end
   describe "verb" do
     let(:response) { [200, {}, "Bom dia"] }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-http
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-28 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement