pwwka 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab27810515e8fe7cc03313345d0b5b6b04940f68
-  data.tar.gz: 3d39d267557796bcca834314fc5331049359ba21
+  metadata.gz: 374c2180b982d19cd0dcc1d6dd73abf3d80f493b
+  data.tar.gz: fb315b10d90d96cbb250c034fdf4a8d2f1186ac3
 SHA512:
-  metadata.gz: 7d31540a45dab75922eee680c4a36b5ef9abad467ca095f2bcd0d833c8a7f1ba4f9ab0c436f2d33ae103577f091b8382fb63eb2f1c238d75eec9a68def1eacb4
-  data.tar.gz: e9fc173987511462d63866c54f9b402124c3bf3abf0c2e1e22664a24152c197e046985b89518f984c5f1d3f07ba928a29aa744a48bda23f13ad3e8ea399ce957
+  metadata.gz: c6fa81ed74d72ec9f7739d8e7e4cd6de94ef172b5e7d11900e3ec32f03cc3c7f13a466fefc1107d43668b29a4c123d60838839de4fd8222d2a2284b25befd2b9
+  data.tar.gz: 885daa6a5d3615f113064c5a906d608d76aa1916f6174665221c12dd9270dfb553c4d9c3bbc0a36879a3aec335daeec22a1132f7e7375ab69508faf477146dd8

data/.ruby-version

@@ -1 +1 @@
-2.1.0
+2.3.1

data/.travis.yml

@@ -1,9 +1,8 @@
 language: ruby
 sudo: false
 rvm:
-  - 2.1.0
-  - 2.2.0
-  - 2.0.0
+  - 2.3.1
+  - 2.2.4
   - ruby-head
 services:
   - rabbitmq

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pwwka (0.5.2)
+    pwwka (0.6.0)
       activemodel
       activesupport
       bunny
@@ -10,30 +10,30 @@ PATH
 GEM
   remote: https://www.rubygems.org/
   specs:
-    activemodel (4.2.4)
-      activesupport (= 4.2.4)
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
       builder (~> 3.1)
-    activesupport (4.2.4)
+    activesupport (4.2.6)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    amq-protocol (1.9.2)
+    amq-protocol (2.0.1)
     builder (3.2.2)
-    bunny (2.0.0)
-      amq-protocol (>= 1.9.2)
+    bunny (2.3.1)
+      amq-protocol (>= 2.0.1)
     diff-lcs (1.2.5)
     i18n (0.7.0)
     json (1.8.3)
-    minitest (5.8.1)
+    minitest (5.8.4)
     mono_logger (1.1.0)
     multi_json (1.11.2)
     rack (1.6.4)
     rack-protection (1.5.3)
       rack
-    rake (10.4.2)
-    redis (3.2.1)
+    rake (10.5.0)
+    redis (3.2.2)
     redis-namespace (1.5.2)
       redis (~> 3.0, >= 3.0.4)
     resque (1.25.2)
@@ -42,25 +42,25 @@ GEM
       redis-namespace (~> 1.3)
       sinatra (>= 0.9.2)
       vegas (~> 0.1.2)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
-    sinatra (1.4.6)
-      rack (~> 1.4)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    sinatra (1.4.7)
+      rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
     thread_safe (0.3.5)
-    tilt (2.0.1)
+    tilt (2.0.2)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     vegas (0.1.11)
@@ -76,4 +76,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.10.6
+   1.12.5

data/README.md

@@ -281,6 +281,14 @@ The transmitter will likewise log an error if you use the `_safely` methods:
 error "Error Transmitting Message on #{routing_key} -> #{payload}: #{e}"
 ```
 
+If your payloads are large, you may not want to log them 2-3 times per message.  In that case, you can adjust `payload_logging` in the configuration:
+
+```ruby
+Pwwka.configuration.payload_logging = :info # The default - payloads appear at INFO and above log levels
+Pwwka.configuration.payload_logging = :error # Only log payloads for ERROR or FATAL messages
+Pwwka.configuration.payload_logging = :fatal # Only log payloads for FATAL messages
+```
+
 ### Manual monitoring
 
 RabbitMQ has a web interface for checking out the health of connections, channels, exchanges and queues. Access it via the Heroku add-ons page for Enigma.

data/lib/pwwka/configuration.rb

@@ -4,7 +4,7 @@ module Pwwka
   class ConfigurationError < StandardError; end
   class Configuration
 
-    attr_accessor :rabbit_mq_host 
+    attr_accessor :rabbit_mq_host
     attr_accessor :topic_exchange_name
     attr_accessor :delayed_exchange_name
     attr_accessor :logger
@@ -22,6 +22,13 @@ module Pwwka
                                                600, 600, 600] # longer-term outage?
     end
 
+    def payload_logging
+      @payload_logging || :info
+    end
+
+    def payload_logging=(new_payload_logging_level)
+      @payload_logging = new_payload_logging_level
+    end
 
     def allow_delayed?
       options[:allow_delayed]

data/lib/pwwka/logging.rb

@@ -7,5 +7,22 @@ module Pwwka
       Pwwka.configuration.logger
     end
 
+    LEVELS = {
+      fatal: 5,
+      error: 4,
+      warn: 3,
+      info: 2,
+      debug: 1,
+    }
+
+    def logf(format,params)
+      level = params.delete(:at) || :info
+      params[:payload] = params["payload"] if params["payload"]
+      params[:payload] = "[omitted]" if params[:payload] && LEVELS[Pwwka.configuration.payload_logging.to_sym] > LEVELS[level.to_sym]
+      message = format % params
+      logger.send(level,message)
+    end
+
+
   end
 end

data/lib/pwwka/receiver.rb

@@ -27,9 +27,9 @@ module Pwwka
             payload = ActiveSupport::HashWithIndifferentAccess.new(JSON.parse(payload))
             handler_klass.handle!(delivery_info, properties, payload)
             receiver.ack(delivery_info.delivery_tag)
-            info "Processed Message on #{queue_name} -> #{payload}, #{delivery_info.routing_key}"
+            logf "Processed Message on %{queue_name} -> %{payload}, %{routing_key}", queue_name: queue_name, payload: payload, routing_key: delivery_info.routing_key
           rescue => e
-            error "Error Processing Message on #{queue_name} -> #{payload}, #{delivery_info.routing_key}: #{e}"
+            logf "Error Processing Message on %{queue_name} -> %{payload}, %{routing_key}: %{exception}", queue_name: queue_name, payload: payload, routing_key: delivery_info.routing_key, exception: e, at: :error
             # no requeue
             receiver.nack(delivery_info.delivery_tag)
           end
@@ -47,7 +47,7 @@ module Pwwka
         queue = channel.queue(queue_name, durable: true)
         queue.bind(topic_exchange, routing_key: routing_key)
         queue
-      end 
+      end
     end
 
     def ack(delivery_tag)

data/lib/pwwka/transmitter.rb

@@ -48,11 +48,11 @@ module Pwwka
       else
         new.send_message!(payload, routing_key)
       end
-      info "AFTER Transmitting Message on #{routing_key} -> #{payload}"
-
+      logf "AFTER Transmitting Message on %{routing_key} -> %{payload}",routing_key: routing_key, payload: payload
+      true
     rescue => e
 
-      error "ERROR Transmitting Message on #{routing_key} -> #{payload}: #{e}"
+      logf "ERROR Transmitting Message on %{routing_key} -> %{payload}", routing_key: routing_key, payload: payload, at: :error
 
       case on_error
 
@@ -92,21 +92,21 @@ module Pwwka
     end
 
     def send_message!(payload, routing_key)
-      info "START Transmitting Message on #{routing_key} -> #{payload}"
+      logf "START Transmitting Message on %{routing_key} -> %{payload}", routing_key: routing_key, payload: payload
       channel_connector.topic_exchange.publish(
           payload.to_json,
           routing_key: routing_key,
           persistent:  true)
       channel_connector.connection_close
       # if it gets this far it has succeeded
-      info "END Transmitting Message on #{routing_key} -> #{payload}"
+      logf "END Transmitting Message on %{routing_key} -> %{payload}", routing_key: routing_key, payload: payload
       true
     end
 
 
     def send_delayed_message!(payload, routing_key, delay_by = DEFAULT_DELAY_BY_MS)
       channel_connector.raise_if_delayed_not_allowed
-      info "START Transmitting Delayed Message on #{routing_key} -> #{payload}"
+      logf "START Transmitting Delayed Message on %{routing_key} -> %{payload}", routing_key: routing_key, payload: payload
       channel_connector.create_delayed_queue
       channel_connector.delayed_exchange.publish(
           payload.to_json,
@@ -115,7 +115,7 @@ module Pwwka
           persistent:  true)
       channel_connector.connection_close
       # if it gets this far it has succeeded
-      info "END Transmitting Delayed Message on #{routing_key} -> #{payload}"
+      logf "END Transmitting Delayed Message on %{routing_key} -> %{payload}", routing_key: routing_key, payload: payload
       true
     end
 

data/lib/pwwka/version.rb

@@ -1,3 +1,3 @@
 module Pwwka
-  VERSION = '0.5.2'
+  VERSION = '0.6.0'
 end

data/spec/logging_spec.rb

@@ -16,4 +16,54 @@ describe Pwwka::Logging do
     end
 
   end
+
+  describe "#logf" do
+    let(:logger) { double(Logger) }
+
+    before do
+      @original_logger = Pwwka.configuration.logger
+      Pwwka.configuration.logger = logger
+      allow(logger).to receive(:info)
+      allow(logger).to receive(:error)
+    end
+
+    after do
+      Pwwka.configuration.logger = @original_logger
+      Pwwka.configuration.payload_logging = @original_payload_logging
+    end
+    it "logs a printf-style string at info" do
+      ForLogging.logf("This is %{test} some %{data}", test: "a test of", data: "data and stuff", ignored: :hopefully)
+      expect(logger).to have_received(:info).with("This is a test of some data and stuff")
+    end
+
+    it "can log an not-info" do
+      ForLogging.logf("This is %{test} some %{data}", test: "a test of", data: "data and stuff", ignored: :hopefully, at: :error)
+      expect(logger).to have_received(:error).with("This is a test of some data and stuff")
+      expect(logger).not_to have_received(:info)
+    end
+
+    context "payload-stripping" do
+      [
+        :payload,
+        "payload",
+      ].each do |name|
+        it "will strip payload (given as a #{name.class}) if configured" do
+          Pwwka.configuration.payload_logging = :error
+          ForLogging.logf("This is the payload: %{payload}", name => { foo: "bar" })
+          ForLogging.logf("This is also the payload: %{payload}", name => { foo: "bar" }, at: :error)
+          expect(logger).to have_received(:info).with("This is the payload: [omitted]")
+          expect(logger).to have_received(:error).with("This is also the payload: {:foo=>\"bar\"}")
+        end
+
+        it "will strip payload (given as a #{name.class}) of errors, too" do
+          Pwwka.configuration.payload_logging = :fatal
+          ForLogging.logf("This is the payload: %{payload}", name => { foo: "bar" })
+          ForLogging.logf("This is also the payload: %{payload}", name => { foo: "bar" }, at: :error)
+          expect(logger).to have_received(:info).with("This is the payload: [omitted]")
+          expect(logger).to have_received(:error).with("This is also the payload: [omitted]")
+        end
+      end
+    end
+
+  end
 end

data/spec/receiver_spec.rb

@@ -8,23 +8,32 @@ describe Pwwka::Receiver do
     end
   end
 
-  let(:payload)     { Hash[:this, "that"] }
+  let(:payload)     { { "this" => "that" } }
   let(:routing_key) { "this.that" }
   let(:queue_name)  { "receiver_test" }
+  let(:logger)      { double(Logger) }
 
   describe "::subscribe" do
 
     before(:each) do
+      @original_logger = Pwwka.configuration.logger
+      Pwwka.configuration.logger = logger
+      allow(logger).to receive(:info)
+      allow(logger).to receive(:error)
       @receiver = Pwwka::Receiver.subscribe(HandyHandler, "receiver_test", block: false)
     end
 
     after(:each) do
-      @receiver.test_teardown
+      Pwwka.configuration.logger = @original_logger
+      @receiver.test_teardown rescue nil
     end
 
-    it "should receive the sent message" do
+    it "should receive the sent message and log about it" do
       expect(HandyHandler).to receive(:handle!).and_return("made it here")
       Pwwka::Transmitter.send_message!(payload, routing_key)
+      expect(logger).to have_received(:info).with(/START Transmitting.*#{Regexp.escape(payload.to_s)}/)
+      expect(logger).to have_received(:info).with(/END Transmitting.*#{Regexp.escape(payload.to_s)}/)
+      expect(logger).to have_received(:info).with(/AFTER Transmitting.*#{Regexp.escape(payload.to_s)}/)
     end
 
     it "should nack the sent message if an error is raised" do
@@ -32,6 +41,11 @@ describe Pwwka::Receiver do
       expect(@receiver).not_to receive(:ack)
       expect(@receiver).to receive(:nack).with(instance_of(Fixnum))
       Pwwka::Transmitter.send_message!(payload, routing_key)
+      @receiver.test_teardown # force the message to be processed and exception handled
+      expect(logger).to have_received(:info).with(/START Transmitting.*#{Regexp.escape(payload.to_s)}/)
+      expect(logger).to have_received(:info).with(/END Transmitting.*#{Regexp.escape(payload.to_s)}/)
+      expect(logger).to have_received(:info).with(/AFTER Transmitting.*#{Regexp.escape(payload.to_s)}/)
+      expect(logger).to have_received(:error).with(/Error Processing Message.*#{Regexp.escape(payload.to_s)}/)
     end
 
   end

data/spec/spec_helper.rb

@@ -10,10 +10,13 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 
-end
+  config.before(:each) do
+    Pwwka.configure do |c|
+      c.topic_exchange_name     = "topics-test"
+      c.logger                  = MonoLogger.new("/dev/null")
+      c.options[:allow_delayed] = true
+    end
+  end
 
-Pwwka.configure do |config|
-  config.topic_exchange_name     = "topics-test"
-  config.logger                  = MonoLogger.new("/dev/null")
-  config.options[:allow_delayed] = true
 end
+

data/spec/transmitter_spec.rb

@@ -10,10 +10,22 @@ describe Pwwka::Transmitter do
   after(:each) { @test_handler.purge_test_queue }
   after(:all) { @test_handler.test_teardown }
 
-  let(:payload) { Hash[:this, "that"] }
+  let(:payload)     { { "this" => "that" } }
   let(:routing_key) { "this.that.and.theother" }
   let(:exception) { RuntimeError.new('blow up')}
+  let(:logger) { double(Logger) }
+
+  before(:each) do
+    @original_logger = Pwwka.configuration.logger
+    Pwwka.configuration.logger = logger
+    allow(logger).to receive(:info)
+    allow(logger).to receive(:warn)
+    allow(logger).to receive(:error)
+  end
 
+  after(:each) do
+    Pwwka.configuration.logger = @original_logger
+  end
 
   describe "#send_message!" do
 
@@ -23,6 +35,8 @@ describe Pwwka::Transmitter do
         expect(success).to be_truthy
         received_payload = @test_handler.pop_message.payload
         expect(received_payload["this"]).to eq("that")
+        expect(logger).to have_received(:info).with("START Transmitting Message on #{routing_key} -> #{payload}")
+        expect(logger).to have_received(:info).with("END Transmitting Message on #{routing_key} -> #{payload}")
       end
 
       it "should deliver on the expected routing key" do
@@ -34,10 +48,12 @@ describe Pwwka::Transmitter do
     end
 
     it "should blow up if exception raised" do
-      expect(Pwwka::ChannelConnector).to receive(:new).and_raise(exception)
+      expect_any_instance_of(Pwwka::ChannelConnector).to receive(:topic_exchange).and_raise(exception)
       expect {
         Pwwka::Transmitter.new.send_message!(payload, routing_key)
       }.to raise_error(exception)
+      expect(logger).to     have_received(:info).with("START Transmitting Message on #{routing_key} -> #{payload}")
+      expect(logger).not_to have_received(:info).with("END Transmitting Message on #{routing_key} -> #{payload}")
     end
 
   end
@@ -53,6 +69,8 @@ describe Pwwka::Transmitter do
         expect(@test_handler.test_queue.message_count).to eq(1)
         received_payload = @test_handler.pop_message.payload
         expect(received_payload["this"]).to eq("that")
+        expect(logger).to have_received(:info).with("START Transmitting Delayed Message on #{routing_key} -> #{payload}")
+        expect(logger).to have_received(:info).with("END Transmitting Delayed Message on #{routing_key} -> #{payload}")
       end
 
       it "should deliver on the expected routing key" do
@@ -65,10 +83,12 @@ describe Pwwka::Transmitter do
     end
 
     it "should blow up if exception raised" do
-      expect(Pwwka::ChannelConnector).to receive(:new).and_raise(exception)
+      expect_any_instance_of(Pwwka::ChannelConnector).to receive(:create_delayed_queue).and_raise(exception)
       expect {
         Pwwka::Transmitter.new.send_delayed_message!(payload, routing_key, 1)
       }.to raise_error(exception)
+      expect(logger).to have_received(:info).with("START Transmitting Delayed Message on #{routing_key} -> #{payload}")
+      expect(logger).not_to have_received(:info).with("END Transmitting Delayed Message on #{routing_key} -> #{payload}")
     end
 
     context "delayed not configured" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pwwka
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -188,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Send and receive messages via RabbitMQ