action_subscriber 5.1.3 → 5.1.4.pre0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f884d601b60838334dce94ba6e08e904df922b0f991f5ecd1a0bfe953c41558b
-  data.tar.gz: b752581b847754666baed507650f90d150ed05f19a7b7166f3ceca9eef0ad92e
+  metadata.gz: be413ce9308a022df33f96d787b50b059bd6700911e1a090f98f454777d14a1f
+  data.tar.gz: c09a951d4f0343dc9cb2e23484333656fae3111b5e558668436d3fbdf63d0379
 SHA512:
-  metadata.gz: '055496ce9efc31b2f86e22e24672859e783a5810d2b36fd55430ac50a1ad3888b09bed824a69678744e579b5542f971d00e3a127f5fb1ffdb22a61f4d3f08683'
-  data.tar.gz: 4a2f7d618dcb62687904ae5d170b4b7efc9f63eedf6d5ee8c81e50e1e2da7aef17a5b691610b51a320be683c67fe46e10fb6ce58be9b25b5bcc0c557187d4bfa
+  metadata.gz: c303e23007ddc09b9bb05d09f269d637ce0e7ac8b7ec0c7325412d9afd84fb81f94590e3230716101c82be2799ae9223745ea8e79595e3bd669e932127588351
+  data.tar.gz: 4920a7deec1c46b47c9de7bd467b16ef8e5995050da4c1244c113115bde344fd1b27781e925d72fa1dfa391f2a6adf40ca22c7cd608f5e47ba8cac834c8caa8f

data/lib/action_subscriber/middleware/env.rb

@@ -3,6 +3,10 @@ require "securerandom"
 module ActionSubscriber
   module Middleware
     class Env
+      ACK_INSTRUMENT_KEY = "message_acked.action_subscriber".freeze
+      NACK_INSTRUMENT_KEY = "message_nacked.action_subscriber".freeze
+      REJECT_INSTRUMENT_KEY = "message_rejected.action_subscriber".freeze
+
       attr_accessor :payload
 
       attr_reader :action,
@@ -50,7 +54,9 @@ module ActionSubscriber
         return true if @has_been_acked
         acknowledge_multiple_messages = false
         @has_been_acked = true
-        @channel.ack(@delivery_tag, acknowledge_multiple_messages)
+        instrument_for(ACK_INSTRUMENT_KEY) do
+          @channel.ack(@delivery_tag, acknowledge_multiple_messages)
+        end
         true
       end
 
@@ -65,7 +71,9 @@ module ActionSubscriber
         nack_multiple_messages = false
         requeue_message = true
         @has_been_nacked = true
-        @channel.nack(@delivery_tag, nack_multiple_messages, requeue_message)
+        instrument_for(NACK_INSTRUMENT_KEY) do
+          @channel.nack(@delivery_tag, nack_multiple_messages, requeue_message)
+        end
         true
       end
 
@@ -74,7 +82,9 @@ module ActionSubscriber
         return true if @has_been_rejected
         requeue_message = true
         @has_been_rejected = true
-        @channel.reject(@delivery_tag, requeue_message)
+        instrument_for(REJECT_INSTRUMENT_KEY) do
+          @channel.reject(@delivery_tag, requeue_message)
+        end
         true
       end
 
@@ -107,6 +117,12 @@ module ActionSubscriber
         @has_been_acked || @has_been_nacked || @has_been_rejected
       end
 
+      def instrument_for(instrumentation_key)
+        ::ActiveSupport::Notifications.instrument(instrumentation_key, :subscriber => subscriber.to_s, :routing_key => routing_key, :queue => queue) do
+          yield
+        end
+      end
+
       def uses_acknowledgements?
         @uses_acknowledgements
       end

data/lib/action_subscriber/version.rb

@@ -1,3 +1,3 @@
 module ActionSubscriber
-  VERSION = "5.1.3"
+  VERSION = "5.1.4.pre0"
 end

data/spec/lib/action_subscriber/middleware/env_spec.rb

@@ -30,6 +30,33 @@ describe ActionSubscriber::Middleware::Env do
       expect(channel).to receive(:ack).with(properties[:delivery_tag], false)
       subject.acknowledge
     end
+
+    it "instruments an acknowedgement" do
+      expect(channel).to receive(:ack).with(properties[:delivery_tag], false)
+      duration = nil
+      work = lambda { |_name, start, finish, _id, _payload|  duration = finish - start }
+      with_instrumentation_subscription("message_acked.action_subscriber", work) do
+        subject.acknowledge
+      end
+      expect(duration).to_not be_nil
+    end
+  end
+
+  describe "#nack" do
+    it "sends a nack to rabbitmq" do
+      expect(channel).to receive(:nack).with(properties[:delivery_tag], false, true)
+      subject.nack
+    end
+
+    it "instruments a nack" do
+      expect(channel).to receive(:nack).with(properties[:delivery_tag], false, true)
+      duration = nil
+      work = lambda { |_name, start, finish, _id, _payload|  duration = finish - start }
+      with_instrumentation_subscription("message_nacked.action_subscriber", work) do |c|
+        subject.nack
+      end
+      expect(duration).to_not be_nil
+    end
   end
 
   describe "#reject" do
@@ -37,6 +64,16 @@ describe ActionSubscriber::Middleware::Env do
       expect(channel).to receive(:reject).with(properties[:delivery_tag], true)
       subject.reject
     end
+
+    it "instruments a rejection" do
+      expect(channel).to receive(:reject).with(properties[:delivery_tag], true)
+      duration = nil
+      work = lambda { |_name, start, finish, _id, _payload|  duration = finish - start }
+      with_instrumentation_subscription("message_rejected.action_subscriber", work) do
+        subject.reject
+      end
+      expect(duration).to_not be_nil
+    end
   end
 
   describe "#to_hash" do

data/spec/spec_helper.rb

@@ -51,3 +51,15 @@ def verify_expectation_within(number_of_seconds, check_every = 0.02)
     end
   end
 end
+
+# This helper method allows us to verify a subscription is cleaned up after every test.
+# Its arguments are the instrumentation key and a proc that contains the work to be
+# performed for each notification.
+def with_instrumentation_subscription(instrumentation_key, work)
+  subscription = ::ActiveSupport::Notifications.subscribe(instrumentation_key) do |name, start, finish, id, payload|
+    work.call(name, start, finish, id, payload)
+  end
+  yield
+ensure
+  ::ActiveSupport::Notifications.unsubscribe(subscription)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_subscriber
 version: !ruby/object:Gem::Version
-  version: 5.1.3
+  version: 5.1.4.pre0
 platform: ruby
 authors:
 - Brian Stien
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-12 00:00:00.000000000 Z
+date: 2018-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -292,12 +292,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: ActionSubscriber is a DSL that allows a rails app to consume messages from