pwwka 0.13.3 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5850816a9ed3380c65203a45cf751783ce2d0f9b
-  data.tar.gz: 127f3d60d3b4eb92b5d89cdfe39b654cad82d766
+  metadata.gz: 92357bbf204f0558fb03ce13a7f13d8143d5259a
+  data.tar.gz: e10916ec0e829f164c26daa13ea0dcad72076001
 SHA512:
-  metadata.gz: c2526437f0ef055cd6d41aad1cabf7ef81586d4a1508db52fdba924a63ff5d36f3e1030b78230ca4d28e0237d7da58ae8a57de8a269d2f90ed1160a8bdabfd91
-  data.tar.gz: 83a3b9f9b614ac7ea04d25b1742467c21321efcbf64a19fc0e13f43f72f16acfb1d4b8ef901e12d502aad07270e648a6dcd42110e3083eb376e5951c9e8d1bbb
+  metadata.gz: 45252ff1d13c6c001ac445d9e50fea106e0c1043b442391cf71a7c59571a54e560fca9fb638772bb5a78da1455616456ee8ebb3125fba6f95c96c3cb9f08f9ef
+  data.tar.gz: 269ef0814b600537de72bff6033b47e037629430b4108b75f41843adb5d3acc8ab79492b577877e5ea24b7730fd78869f33471cb62f84bc360099ac07533fab5

data/.gitignore

@@ -12,3 +12,4 @@ db
 .rspec
 .bundle
 coverage
+Session.vim

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pwwka (0.13.3)
+    pwwka (0.14.0)
       activemodel
       activesupport
       bunny
@@ -23,21 +23,22 @@ GEM
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
     docile (1.1.5)
-    et-orbi (1.0.4)
+    et-orbi (1.0.7)
       tzinfo
-    i18n (0.8.6)
+    i18n (0.9.0)
+      concurrent-ruby (~> 1.0)
     json (2.1.0)
     minitest (5.10.3)
     mono_logger (1.1.0)
-    multi_json (1.12.1)
-    mustermann (1.0.0)
+    multi_json (1.12.2)
+    mustermann (1.0.1)
     rack (2.0.3)
     rack-protection (2.0.0)
       rack
     rainbow (2.2.2)
       rake
-    rake (12.0.0)
-    redis (3.3.3)
+    rake (12.1.0)
+    redis (3.3.5)
     redis-namespace (1.5.3)
       redis (~> 3.0, >= 3.0.4)
     resque (1.27.4)
@@ -56,33 +57,33 @@ GEM
       rufus-scheduler (~> 3.2)
     resqutils (1.2.1)
       resque
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
     rufus-scheduler (3.4.2)
       et-orbi (~> 1.0)
-    simplecov (0.14.1)
+    simplecov (0.15.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.1)
+    simplecov-html (0.10.2)
     sinatra (2.0.0)
       mustermann (~> 1.0)
       rack (~> 2.0)
       rack-protection (= 2.0.0)
       tilt (~> 2.0)
     thread_safe (0.3.6)
-    tilt (2.0.7)
+    tilt (2.0.8)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
     vegas (0.1.11)

data/README.md

@@ -260,8 +260,8 @@ end
 
 #### Errors From Your Handler
 
-By default, all unhandled errors will crash your handler.  This is good, because it allows you to recover from most intermittent things.  Just be aware of this when configuring your handler so that it gets
-restarted after a crash.
+By default, handlers will log and ignore garbled payloads (basically payloads that fail to be parsed as JSON).  All other errors
+will crash the handler, under the assumption that it will restart.  This is good, because it allows you to recover from most intermittent things.  Just be aware of this when configuring your handler so that it gets restarted after a crash.
 
 What happens to the message you received during the error depends:
 

data/Rakefile

@@ -11,5 +11,14 @@ Gem::PackageTask.new(gemspec) {}
 RSpec::Core::RakeTask.new(:spec)
 Bundler::GemHelper.install_tasks
 
-task :default => :spec
+task default: :spec
 
+task :tag do
+  require "pwwka/version"
+  version = "v#{Pwwka::VERSION}"
+  sh("git tag #{version}")     { |ok,res| fail res.inspect unless ok }
+  sh("git push --tags origin") { |ok,res| fail res.inspect unless ok }
+end
+task release: [ :build, :tag ] do
+  sh("gem push --key rubygems_stitchfix_api_key pkg/pwwka-#{Pwwka::VERSION}.gem") { |ok,res| fail res.inspect unless ok }
+end

data/lib/pwwka/configuration.rb

@@ -63,7 +63,7 @@ module Pwwka
 
     def error_handling_chain
       @error_handling_chain ||= begin
-                                  klasses = []
+                                  klasses = [ Pwwka::ErrorHandlers::IgnorePayloadFormatErrors ]
                                   if self.requeue_on_error
                                     klasses << Pwwka::ErrorHandlers::NackAndRequeueOnce
                                   else

data/lib/pwwka/error_handlers/chain.rb

@@ -8,7 +8,7 @@ module Pwwka
         @error_handlers = default_handler_chain
       end
       def handle_error(message_handler_klass,receiver,queue_name,payload,delivery_info,exception)
-        logf "%{message_handler_klass} has received %{exception}", message_handler_klass: message_handler_klass, exception: exception.message
+        logf "Error Processing Message in %{message_handler_klass} due to %{exception} from payload '%{payload}'", at: :error, message_handler_klass: message_handler_klass, exception: exception.message, payload: payload
         if message_handler_klass.respond_to?(:error_handler)
           @error_handlers.unshift(message_handler_klass.send(:error_handler))
         end

data/lib/pwwka/error_handlers/ignore_payload_format_errors.rb

@@ -0,0 +1,17 @@
+require_relative "base_error_handler"
+module Pwwka
+  module ErrorHandlers
+    class IgnorePayloadFormatErrors < BaseErrorHandler
+      def handle_error(receiver,queue_name,payload,delivery_info,exception)
+        if exception.kind_of?(JSON::JSONError)
+          log("Ignoring JSON error",queue_name,payload,delivery_info,exception)
+          receiver.nack(delivery_info.delivery_tag)
+          abort_chain
+        else
+          keep_going
+        end
+      end
+    end
+
+  end
+end

data/lib/pwwka/error_handlers.rb

@@ -8,3 +8,4 @@ require_relative "error_handlers/base_error_handler"
 require_relative "error_handlers/crash"
 require_relative "error_handlers/nack_and_requeue_once"
 require_relative "error_handlers/nack_and_ignore"
+require_relative "error_handlers/ignore_payload_format_errors"

data/lib/pwwka/version.rb

@@ -1,3 +1,3 @@
 module Pwwka
-  VERSION = '0.13.3'
+  VERSION = '0.14.0'
 end

data/spec/integration/unhandled_errors_in_receivers_spec.rb

@@ -1,17 +1,31 @@
-require 'spec_helper.rb'
+require "spec_helper.rb"
+require "logger"
+require "stringio"
 require_relative "support/integration_test_setup"
 require_relative "support/logging_receiver"
 require_relative "support/integration_test_helpers"
 
+class EvilPayload
+  def to_json
+    "This is not JSON by any stretch"
+  end
+end
 describe "receivers with unhandled errors", :integration do
   include IntegrationTestHelpers
 
+  let(:log_data) { StringIO.new }
+  let(:payload) {
+    { "sample" => "payload", "has" =>  { "deeply" => true, "nested" =>  4 }}
+  }
+
   before do
     @testing_setup = IntegrationTestSetup.new
     Pwwka.configuration.instance_variable_set("@error_handling_chain",nil)
     Pwwka.configure do |c|
       c.requeue_on_error = false
       c.keep_alive_on_handler_klass_exceptions = false
+      c.logger = Logger.new(log_data)
+      c.payload_logging = :error
     end
   end
 
@@ -29,25 +43,45 @@ describe "receivers with unhandled errors", :integration do
     end
 
     it "an error in one receiver doesn't prevent others from getting messages" do
-      Pwwka::Transmitter.send_message!({ sample: "payload", has: { deeply: true, nested: 4 }},
-                                       "pwwka.testing.foo")
+      Pwwka::Transmitter.send_message!(payload, "pwwka.testing.foo")
       allow_receivers_to_process_queues
 
       expect(WellBehavedReceiver.messages_received.size).to eq(1)
       expect(ExceptionThrowingReceiver.messages_received.size).to eq(1)
     end
+
+    it "logs the payload in the error in the log" do
+      Pwwka::Transmitter.send_message!(payload, "pwwka.testing.foo")
+      allow_receivers_to_process_queues
+      expect(log_data.string).to match(/ERROR.*error processing message.*#{Regexp.escape(payload.inspect)}/i)
+    end
+
     it "crashes the receiver that received an error" do
-      Pwwka::Transmitter.send_message!({ sample: "payload", has: { deeply: true, nested: 4 }},
-                                       "pwwka.testing.foo")
+      Pwwka::Transmitter.send_message!(payload, "pwwka.testing.foo")
       allow_receivers_to_process_queues
 
       expect(@testing_setup.threads[ExceptionThrowingReceiver].alive?).to eq(false)
     end
-    it "does not crash the receiver that successfully processed a message" do
-      Pwwka::Transmitter.send_message!({ sample: "payload", has: { deeply: true, nested: 4 }},
+
+    it "does not crash the receiver on a borked payload, but doesn't call handlers either" do
+      Pwwka.configure do |c|
+        c.requeue_on_error = true
+      end
+      Pwwka::Transmitter.send_message!(EvilPayload.new,
                                        "pwwka.testing.foo")
       allow_receivers_to_process_queues
 
+      expect(@testing_setup.threads[ExceptionThrowingReceiver].alive?).to eq(true)
+      expect(@testing_setup.threads[WellBehavedReceiver].alive?).to eq(true)
+      expect(@testing_setup.threads[IntermittentErrorReceiver].alive?).to eq(true)
+      expect(WellBehavedReceiver.messages_received.size).to eq(0)
+      expect(ExceptionThrowingReceiver.messages_received.size).to eq(0)
+    end
+
+    it "does not crash the receiver that successfully processed a message" do
+      Pwwka::Transmitter.send_message!(payload, "pwwka.testing.foo")
+      allow_receivers_to_process_queues
+
       expect(@testing_setup.threads[WellBehavedReceiver].alive?).to  eq(true)
     end
 
@@ -55,8 +89,7 @@ describe "receivers with unhandled errors", :integration do
       Pwwka.configure do |c|
         c.requeue_on_error = true
       end
-      Pwwka::Transmitter.send_message!({ sample: "payload", has: { deeply: true, nested: 4 }},
-                                       "pwwka.testing.foo")
+      Pwwka::Transmitter.send_message!(payload, "pwwka.testing.foo")
       allow_receivers_to_process_queues
 
       expect(@testing_setup.threads[IntermittentErrorReceiver].alive?).to eq(false)
@@ -70,17 +103,21 @@ describe "receivers with unhandled errors", :integration do
       ExceptionThrowingReceiver.reset!
       IntermittentErrorReceiver.reset!
       ExceptionThrowingReceiverWithErrorHook.reset!
-    end
-    it "does not crash the receiver that received an error" do
       Pwwka.configure do |c|
         c.keep_alive_on_handler_klass_exceptions = true
       end
-      Pwwka::Transmitter.send_message!({ sample: "payload", has: { deeply: true, nested: 4 }},
-                                       "pwwka.testing.foo")
+    end
+    it "does not crash the receiver that received an error" do
+      Pwwka::Transmitter.send_message!(payload, "pwwka.testing.foo")
       allow_receivers_to_process_queues
 
       expect(@testing_setup.threads[ExceptionThrowingReceiver].alive?).to eq(true)
     end
+    it "logs the payload in the error in the log" do
+      Pwwka::Transmitter.send_message!(payload, "pwwka.testing.foo")
+      allow_receivers_to_process_queues
+      expect(log_data.string).to match(/ERROR.*error processing message.*#{Regexp.escape(payload.inspect)}/i)
+    end
   end
 
   context "configured to requeue failed messages" do
@@ -90,14 +127,13 @@ describe "receivers with unhandled errors", :integration do
       ExceptionThrowingReceiver.reset!
       IntermittentErrorReceiver.reset!
       ExceptionThrowingReceiverWithErrorHook.reset!
-    end
-    it "requeues the message exactly once" do
       Pwwka.configure do |c|
         c.requeue_on_error = true
         c.keep_alive_on_handler_klass_exceptions = true # only so we can check that the requeued message got sent; otherwise the receiver crashes and we can't test that
       end
-      Pwwka::Transmitter.send_message!({ sample: "payload", has: { deeply: true, nested: 4 }},
-                                       "pwwka.testing.foo")
+    end
+    it "requeues the message exactly once" do
+      Pwwka::Transmitter.send_message!(payload, "pwwka.testing.foo")
       allow_receivers_to_process_queues
 
       expect(WellBehavedReceiver.messages_received.size).to eq(1)
@@ -105,6 +141,11 @@ describe "receivers with unhandled errors", :integration do
       expect(ExceptionThrowingReceiver.messages_received[1][0].redelivered).to eq(true)
       expect(ExceptionThrowingReceiver.messages_received[1][2]).to eq(ExceptionThrowingReceiver.messages_received[0][2])
     end
+    it "logs the payload in the error in the log" do
+      Pwwka::Transmitter.send_message!(payload, "pwwka.testing.foo")
+      allow_receivers_to_process_queues
+      expect(log_data.string).to match(/ERROR.*error processing message.*#{Regexp.escape(payload.inspect)}/i)
+    end
   end
 
   context "handler with a custom error handler that ignores the exception" do

data/spec/unit/configuration_spec.rb

@@ -90,14 +90,14 @@ describe Pwwka::Configuration do
           it "is NackAndRequeueOnce" do
             configuration.requeue_on_error = true
             configuration.keep_alive_on_handler_klass_exceptions = true
-            expect(configuration.error_handling_chain).to eq([Pwwka::ErrorHandlers::NackAndRequeueOnce])
+            expect(configuration.error_handling_chain).to eq([Pwwka::ErrorHandlers::IgnorePayloadFormatErrors,Pwwka::ErrorHandlers::NackAndRequeueOnce])
           end
         end
         context "when not keep_alive_on_handler_klass_exceptions" do
           it "is NackAndRequeueOnce,Crash" do
             configuration.requeue_on_error = true
             configuration.keep_alive_on_handler_klass_exceptions = false
-            expect(configuration.error_handling_chain).to eq([Pwwka::ErrorHandlers::NackAndRequeueOnce,Pwwka::ErrorHandlers::Crash])
+            expect(configuration.error_handling_chain).to eq([Pwwka::ErrorHandlers::IgnorePayloadFormatErrors,Pwwka::ErrorHandlers::NackAndRequeueOnce,Pwwka::ErrorHandlers::Crash])
           end
         end
       end
@@ -106,14 +106,14 @@ describe Pwwka::Configuration do
           it "is NackAndIgnore" do
             configuration.requeue_on_error = false
             configuration.keep_alive_on_handler_klass_exceptions = true
-            expect(configuration.error_handling_chain).to eq([Pwwka::ErrorHandlers::NackAndIgnore])
+            expect(configuration.error_handling_chain).to eq([Pwwka::ErrorHandlers::IgnorePayloadFormatErrors,Pwwka::ErrorHandlers::NackAndIgnore])
           end
         end
         context "when not keep_alive_on_handler_klass_exceptions" do
           it "is NackAndIgnore,Crash" do
             configuration.requeue_on_error = false
             configuration.keep_alive_on_handler_klass_exceptions = false
-            expect(configuration.error_handling_chain).to eq([Pwwka::ErrorHandlers::NackAndIgnore,Pwwka::ErrorHandlers::Crash])
+            expect(configuration.error_handling_chain).to eq([Pwwka::ErrorHandlers::IgnorePayloadFormatErrors,Pwwka::ErrorHandlers::NackAndIgnore,Pwwka::ErrorHandlers::Crash])
           end
         end
       end

data/spec/unit/logging_spec.rb

@@ -7,6 +7,9 @@ describe Pwwka::Logging do
   end
 
   it "returns the logger" do
+    Pwwka.configure do |c|
+      c.logger = MonoLogger.new(STDOUT)
+    end
     expect(ForLogging.logger).to be_instance_of(MonoLogger)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pwwka
 version: !ruby/object:Gem::Version
-  version: 0.13.3
+  version: 0.14.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -210,6 +210,7 @@ files:
 - lib/pwwka/error_handlers/base_error_handler.rb
 - lib/pwwka/error_handlers/chain.rb
 - lib/pwwka/error_handlers/crash.rb
+- lib/pwwka/error_handlers/ignore_payload_format_errors.rb
 - lib/pwwka/error_handlers/nack_and_ignore.rb
 - lib/pwwka/error_handlers/nack_and_requeue_once.rb
 - lib/pwwka/handling.rb
@@ -265,7 +266,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: Send and receive messages via RabbitMQ