logstash-input-github 3.0.5 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba608dbc24c637abe5b3de51a2931987955a75c53efa0e4829002f415ba75aaa
-  data.tar.gz: 194d819280ea46808d1124f81fc0f3ed969ec6f709e43b7aaba83e9df8c34bb0
+  metadata.gz: 89741b6fc51325a40f005b06e565f3d031f324ed945287b903ec78c6bbe71bdb
+  data.tar.gz: 0bcc0471434fa5ba5b53b629d6c9522a7a3c86eae55d30e2be361db3e41efb1c
 SHA512:
-  metadata.gz: 45a3030e7bcb4ce5ffd216e618d04f314990f31cf8b9b9c869b3493e81ff29921ed549442851e13c637adcfb4c48b7d36e84b7a748dbaec3e34c2b277c10d1df
-  data.tar.gz: 179a5e50072f2442f4d1bb1e6d021ef0ca9735ed1d8464cba5dc53642e40f18a3ab485c9a8c22af15bdd8b1562abc82daf4c921bfce76d402b62b7a7b14fcae0
+  metadata.gz: 0a2997975c0f9c08728c1f464ff1c21177d4be29cd88d54d892220f46aa5a1575aec894668d99884a508eef72636896ed7b7048e36e91580a438f3252566ac41
+  data.tar.gz: '099e04e6b110a62da462e8472e7480943d75e6a45664e669194803afd421696b050f1edb67deec4af3c289426d84eeeb5ec4fa076e74fcce8b60d7fa2ab0c5a0'

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.0.6
+  - Improve malformed-input handling by using updated FTW
+  - Improve webserver crash recovery
+  - Properly support plugin stopping & reloading
+
 ## 3.0.5
   - Update gemspec summary
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
+Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/logstash/inputs/github.rb

@@ -42,6 +42,13 @@ class LogStash::Inputs::GitHub < LogStash::Inputs::Base
         response.body = "Accepted!"
     end
     @server.run
+  rescue Exception => original_exception
+    # If our server crashes, it may not have cleaned up after itself;
+    # since `FTW::WebServer#stop` is idempotent, make one last attempt
+    # before propagating the original exception.
+    @server && @server.stop rescue logger.error("Error while stopping FTW::WebServer", exception: $!.message, backtrace: $!.backtrace)
+
+    raise original_exception
   end # def run
 
   def build_event_from_request(body, headers)
@@ -69,8 +76,8 @@ class LogStash::Inputs::GitHub < LogStash::Inputs::Base
     return is_valid
   end
 
-  def close
-    @server.stop
-  end # def close
+  def stop
+    @server && @server.stop
+  end # def stop
 
 end # class LogStash::Inputs::Github

data/logstash-input-github.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-github'
-  s.version         = '3.0.5'
+  s.version         = '3.0.6'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Reads events from a GitHub webhook"
   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 gemname. This gem is not a stand-alone program"
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'addressable'
   s.add_runtime_dependency 'logstash-codec-plain'
-  s.add_runtime_dependency 'ftw', '~> 0.0.42'
+  s.add_runtime_dependency 'ftw', '~> 0.0.48'
 
   s.add_development_dependency 'logstash-devutils'
 end

data/spec/inputs/github_spec.rb

@@ -55,4 +55,51 @@ describe  LogStash::Inputs::GitHub do
     end
 
   end
+
+  describe 'graceful shutdown' do
+    context 'when underlying webserver crashes' do
+
+      # Stubbing out our FTW::WebServer allows us to force it to raise an exception when we try to run it.
+      let(:mock_webserver_class) { double('FTW::WebServer::class').as_null_object }
+      let(:mock_webserver) { double('FTW::WebServer').as_null_object }
+      before(:each) do
+        stub_const('FTW::WebServer', mock_webserver_class)
+        allow(mock_webserver_class).to receive(:new).and_return(mock_webserver)
+        expect(mock_webserver).to receive(:run).and_raise('testing: intentional uncaught exception')
+      end
+
+      it 'makes an attempt to stop the webserver' do
+        expect(mock_webserver).to receive(:stop)
+
+        plugin.run([]) rescue nil
+      end
+
+      it 'propagates the original exception' do
+        expect do
+          plugin.run([])
+        end.to raise_exception('testing: intentional uncaught exception')
+      end
+
+      context 'and an attempt to stop the webserver also crashes' do
+        let(:mock_logger) { double('Logger').as_null_object }
+        before(:each) do
+          allow(plugin).to receive(:logger).and_return(mock_logger)
+          allow(mock_webserver).to receive(:stop).and_raise('yo dawg')
+        end
+
+        it 'logs helpfully' do
+          expect(mock_logger).to receive(:error).with("Error while stopping FTW::WebServer",
+                                                      exception: 'yo dawg', backtrace: instance_of(Array))
+
+          plugin.run([]) rescue nil
+        end
+
+        it 'propagates the original exception' do
+          expect do
+            plugin.run([])
+          end.to raise_exception('testing: intentional uncaught exception')
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-github
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.0.6
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2018-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -63,7 +63,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.42
+        version: 0.0.48
   name: ftw
   prerelease: false
   type: :runtime
@@ -71,7 +71,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.42
+        version: 0.0.48
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: Reads events from a GitHub webhook