pwwka 0.22.7.RC → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 965ff1503560b0afd024c39ff93d9e1411e1cd928dd701a3bf41cd5116be5212
-  data.tar.gz: 0f0c8c330746ee727780759649c781aba69aa36d8c42904d9f3bdf8a044e5772
+  metadata.gz: 91b93a22ea33ffd0151667910c29af13adaf2872c28327ae5af4aff03e9beb64
+  data.tar.gz: 7c8bc1db3fcb3045caafbba21d8ca94838756c347951418535543a7045162ade
 SHA512:
-  metadata.gz: 43809503913bf7b18ae45ee3ecbcf26074e9182afb938262777782ff8a433191ed10461a6938a3db0d904e409dcb783df98a27a18d14723407eca56346ce7dd7
-  data.tar.gz: 9b6afecdce66ed9d36536c8f7eea142093fea738dcbc76225c72704d31e5a60e592cb9e3029dd57039dc0b228a39a5a1852ee6696bfbfe0ecfed4761bcdfea1a
+  metadata.gz: ac5525cd3bdf5a162d0979b58b5f750a3bdd59074d703997bfb5b574f864491430148dd9ba84afe95cd13607ed14244e792f22582004122020411cb6498fb047
+  data.tar.gz: ccdd3938884c1f0d247176baa8c919257154e9126d347e0541703d5b2f860b39d425d8ddc96dfe2fd2fd3a18787a425942bfe7f97daa6e5d48e037188f9507fd

data/.circleci/config.yml

@@ -27,6 +27,11 @@ jobs:
     working_directory: "~/pwwka"
     steps:
     - checkout
+    - run:
+        name: Check for Gemfile.lock presence
+        command: ' if (test -f Gemfile.lock) then echo "Dont commit Gemfile.lock (see
+          https://github.com/stitchfix/eng-wiki/blob/master/architecture-decisions/0009-rubygem-dependencies-will-be-managed-more-explicitly.md)"
+          1>&2 ; exit 1 ; else exit 0 ; fi '
     - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
@@ -51,6 +56,11 @@ jobs:
     working_directory: "~/pwwka"
     steps:
     - checkout
+    - run:
+        name: Check for Gemfile.lock presence
+        command: ' if (test -f Gemfile.lock) then echo "Dont commit Gemfile.lock (see
+          https://github.com/stitchfix/eng-wiki/blob/master/architecture-decisions/0009-rubygem-dependencies-will-be-managed-more-explicitly.md)"
+          1>&2 ; exit 1 ; else exit 0 ; fi '
     - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
@@ -75,6 +85,11 @@ jobs:
     working_directory: "~/pwwka"
     steps:
     - checkout
+    - run:
+        name: Check for Gemfile.lock presence
+        command: ' if (test -f Gemfile.lock) then echo "Dont commit Gemfile.lock (see
+          https://github.com/stitchfix/eng-wiki/blob/master/architecture-decisions/0009-rubygem-dependencies-will-be-managed-more-explicitly.md)"
+          1>&2 ; exit 1 ; else exit 0 ; fi '
     - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
@@ -99,6 +114,11 @@ jobs:
     working_directory: "~/pwwka"
     steps:
     - checkout
+    - run:
+        name: Check for Gemfile.lock presence
+        command: ' if (test -f Gemfile.lock) then echo "Dont commit Gemfile.lock (see
+          https://github.com/stitchfix/eng-wiki/blob/master/architecture-decisions/0009-rubygem-dependencies-will-be-managed-more-explicitly.md)"
+          1>&2 ; exit 1 ; else exit 0 ; fi '
     - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
     - run: bundle install --full-index
     - run: bundle exec rspec --format RspecJunitFormatter --out /tmp/test-results/rspec.xml
@@ -126,7 +146,7 @@ workflows:
         - ruby-2.6.6-rails-5.2
         filters:
           tags:
-            only: /^[0-9]+\.[0-9]+\.[0-9]+(\.?(RC|rc)[-\.]?\d*)?$/
+            only: /^[0-9]+\.[0-9]+\.[0-9]+(\.?(RC|rc)[-\.]?\w*)?$/
           branches:
             ignore: /.*/
     - ruby-2.7.1-rails-6.0:

data/README.md

@@ -148,8 +148,8 @@ Pwwka::Transmitter.send_message!(payload, routing_key, on_error: :ignore)
 
 #### Delayed Messages
 
-You might want to delay sending a message (for example, if you have just created a database 
-record and a race condition keeps catching you out). In that case you can use delayed message 
+You might want to delay sending a message (for example, if you have just created a database
+record and a race condition keeps catching you out). In that case you can use delayed message
 options:
 
 ```ruby
@@ -176,7 +176,12 @@ Pwwka.configure do |config|
 end
 ```
 
-Regardless of which processor you use, the name of the queue created is `pwwka_send_message_async`.
+Regardless of which processor you use, the name of the queue created is `pwwka_send_message_async`. You will need to start a worker process to work the queue. For a `Procfile` setup, with Resque as the processor, that could look something like this:
+
+```ruby
+pwwka_send_message_async_worker: rake resque:work QUEUE=pwwka_send_message_async
+```
+
 
 You can also configure Pwwka to use your own custom job using the `async_job_klass` configuration option. An example might be:
 ```
@@ -191,7 +196,7 @@ If you are using Resque and `Resque::Plugins::ExponentialBackoff` is available,
 
 #### Message Queuer
 
-You can queue up messages and send them in a batch. This is most useful when multiple messages 
+You can queue up messages and send them in a batch. This is most useful when multiple messages
 need to sent from within a transaction block.
 
 For example:
@@ -255,7 +260,7 @@ Here is an example:
 
 ```ruby
 class ClientIndexMessageHandler
-  
+
   def self.handle!(delivery_info, properties, payload)
     handler.do_a_thing(payload)
   end
@@ -430,7 +435,7 @@ If you use [Resque][resque], and you wish to handle messages in a resque job, yo
 
    Note that you must provide `@queue` in your job.  `QueueResqueJobHandler` doesn't support setting a custom queue at enqueue-time (PRs welcome :).
 
-   Note that if you were using this library before version 0.12.0, your job would only be given the payload.  If you change your job to accept exatly three arguments, you will be given the payload, routing key, and message properties.  If any of those arguments are optional, you will need to set `PWWKA_QUEUE_EXTENDED_INFO` to `"true"` to force pwwka to pass those along.  Without it, your job only gets the payload to avoid breaking legacy consumers. 
+   Note that if you were using this library before version 0.12.0, your job would only be given the payload.  If you change your job to accept exactly three arguments, you will be given the payload, routing key, and message properties.  If any of those arguments are optional, you will need to set `PWWKA_QUEUE_EXTENDED_INFO` to `"true"` to force pwwka to pass those along.  Without it, your job only gets the payload to avoid breaking legacy consumers.
 
 3. Profit!
 
@@ -454,9 +459,9 @@ describe "my integration test" do
     @test_handler.test_setup
   end
 
-  after(:all) do 
+  after(:all) do
     # this clears out any messages, so you have a clean test environment next time
-    @test_handler.test_teardown 
+    @test_handler.test_teardown
   end
 
   it "uses the message bus" do
@@ -527,6 +532,12 @@ Pwwka.configuration.payload_logging = :error # Only log payloads for ERROR or FA
 Pwwka.configuration.payload_logging = :fatal # Only log payloads for FATAL messages
 ```
 
+You can also hook into logging by passing a hash containing keys of strings to match and corresponding `Proc` objects for the logger to execute instead of logging a message. The `Proc` will be called with the original message string that was to be logged and the params specific for that log event. So, if for instance, you wanted to emit a count metric to your monitoring system instead of logging each processed message you could set the configuration:
+
+```ruby
+Pwwka.configuration.log_hooks = { 'Processed Message on' => ->(message, params){ $stats.count('message_processed') } }
+```
+
 #### Manual monitoring
 
 RabbitMQ has a web interface for checking out the health of connections, channels, exchanges and queues. Your RabbitMQ provider should

data/lib/pwwka/configuration.rb

@@ -10,6 +10,7 @@ module Pwwka
     attr_accessor :delayed_exchange_name
     attr_accessor :logger
     attr_accessor :log_level
+    attr_accessor :log_hooks
     attr_accessor :options
     attr_accessor :background_job_processor
     attr_accessor :send_message_resque_backoff_strategy
@@ -26,6 +27,7 @@ module Pwwka
       @delayed_exchange_name = "pwwka.delayed.#{Pwwka.environment}"
       @logger                = MonoLogger.new(STDOUT)
       @log_level             = :info
+      @log_hooks             = {}
       @options               = {}
       @send_message_resque_backoff_strategy = [5,                  #intermittent glitch?
                                                60,                 # quick interruption

data/lib/pwwka/logging.rb

@@ -22,7 +22,10 @@ module Pwwka
         params[:payload] = "[omitted]" if params[:payload]
       end
       message = format % params
-      logger.send(level,message)
+
+      if Pwwka.configuration.log_hooks.select { |key, _value| message.match key }.each { |_key, value| value.call(message, params) }.empty?
+        logger.send(level,message)
+      end
     end
   end
 end

data/lib/pwwka/transmitter.rb

@@ -23,10 +23,17 @@ module Pwwka
 
     DEFAULT_DELAY_BY_MS = 5000
 
+    attr_reader :caller_manages_connector
     attr_reader :channel_connector
 
-    def initialize
-      @channel_connector = ChannelConnector.new(connection_name: "p: #{Pwwka.configuration.app_id} #{Pwwka.configuration.process_name}".strip)
+    def initialize(channel_connector: nil)
+      if channel_connector
+        @caller_manages_connector = true
+        @channel_connector = channel_connector
+      else
+        @caller_manages_connector = false
+        @channel_connector = ChannelConnector.new(connection_name: "p: #{Pwwka.configuration.app_id} #{Pwwka.configuration.process_name}".strip)
+      end
     end
 
     # Send an important message that must go through.  This method allows any raised exception
@@ -54,11 +61,13 @@ module Pwwka
                            delay_by: nil,
                            type: nil,
                            message_id: :auto_generate,
-                           headers: nil)
+                           headers: nil,
+                           channel_connector: nil
+                          )
       if delayed
-        new.send_delayed_message!(*[payload, routing_key, delay_by].compact, type: type, headers: headers, message_id: message_id)
+        new(channel_connector: channel_connector).send_delayed_message!(*[payload, routing_key, delay_by].compact, type: type, headers: headers, message_id: message_id)
       else
-        new.send_message!(payload, routing_key, type: type, headers: headers, message_id: message_id)
+        new(channel_connector: channel_connector).send_message!(payload, routing_key, type: type, headers: headers, message_id: message_id)
       end
       logf "AFTER Transmitting Message on %{routing_key} -> %{payload}",routing_key: routing_key, payload: payload
       true
@@ -147,7 +156,9 @@ module Pwwka
       logf "END Transmitting Message on id[%{id}] %{routing_key} -> %{payload}", id: publish_options.message_id, routing_key: routing_key, payload: payload
       true
     ensure
-      channel_connector.connection_close
+      unless caller_manages_connector
+        channel_connector.connection_close
+      end
     end
 
 
@@ -167,7 +178,9 @@ module Pwwka
       logf "END Transmitting Delayed Message on id[%{id}] %{routing_key} -> %{payload}", id: publish_options.message_id, routing_key: routing_key, payload: payload
       true
     ensure
-      channel_connector.connection_close
+      unless caller_manages_connector
+        channel_connector.connection_close
+      end
     end
 
   end

data/lib/pwwka/version.rb

@@ -1,4 +1,4 @@
 module Pwwka
-  VERSION = '0.22.7.RC'
+  VERSION = '0.24.0'
 end
 

data/spec/unit/logging_spec.rb

@@ -93,6 +93,44 @@ describe Pwwka::Logging do
           expect(logger).to have_received(:error).with("This is also the payload: [omitted]")
         end
       end
+
+      context "log_hook matching" do
+        def test_func(message, params)
+        end
+
+        before do
+          Pwwka.configuration.log_hooks = { "test message" => ->(message, params){ test_func(message, params) } }
+        end
+
+        after do
+          Pwwka.configuration.log_hooks = {}
+        end
+
+        context "message matches hook" do
+          it "overrides logging" do
+            ForLogging.logf("test message", {})
+
+            expect(logger).not_to have_received(:info)
+          end
+
+          it "calls the hook" do
+            allow(self).to receive(:test_func)
+            test_params = { param: :test }
+
+            ForLogging.logf("test message", test_params)
+
+            expect(self).to have_received(:test_func).with("test message", test_params)
+          end
+        end
+
+        context "message doesn't match hook" do
+          it "logs as normal" do
+            ForLogging.logf("other message", {})
+
+            expect(logger).to have_received(:info).with("other message")
+          end
+        end
+      end
     end
 
   end

data/spec/unit/transmitter_spec.rb

@@ -576,5 +576,41 @@ describe Pwwka::Transmitter do
       end
     end
   end
-end
 
+  context "application manages connection" do
+    let(:managed_connector) { instance_double(Pwwka::ChannelConnector,
+                                              topic_exchange: double(:topic_exchange).as_null_object,
+                                              delayed_exchange: double(:delayed_exchange).as_null_object
+                                             ).as_null_object }
+    describe ".send_message!" do
+
+      context "send immediate" do
+        it "doesn't open a new connection" do
+          described_class.send_message!(payload, routing_key, delayed: false, channel_connector: managed_connector)
+
+          expect(Pwwka::ChannelConnector).not_to have_received(:new)
+        end
+
+        it "doesn't close a passed in connection" do
+          described_class.send_message!(payload, routing_key, delayed: false, channel_connector: managed_connector)
+
+          expect(managed_connector).not_to have_received(:connection_close)
+        end
+      end
+
+      context "send delayed" do
+        it "doesn't open a new connection" do
+          described_class.send_message!(payload, routing_key, delayed: true, channel_connector: managed_connector)
+
+          expect(Pwwka::ChannelConnector).not_to have_received(:new)
+        end
+
+        it "doesn't close a passed in connection" do
+          described_class.send_message!(payload, routing_key, delayed: true, channel_connector: managed_connector)
+
+          expect(managed_connector).not_to have_received(:connection_close)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pwwka
 version: !ruby/object:Gem::Version
-  version: 0.22.7.RC
+  version: 0.24.0
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -315,9 +315,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: