action_subscriber 5.0.3 → 5.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 605d2e8c1c46efca8695b90fdefca1b88342bc62
-  data.tar.gz: e6a8b84e0fa197c5e085251964f75a362b7d324b
+  metadata.gz: aa70a7b7308a903e30cb492dc4c334cc76180984
+  data.tar.gz: 552c9aaae558ec3fae519c9fcde87dffbc8a6887
 SHA512:
-  metadata.gz: d138a4b1709e7d0450b8a3c2cf85a9348ed4e4c8acbfbef61f69a9ea25beeba0fc88924ba46cc286a26ad527877d3b51a2b18dc0b5d3930033f3c1aedce5954a
-  data.tar.gz: 566f397bcdbfc28242451be5c6551dc6a013f8e1b7e36aac271ea1afe07ebfbd3ae14d5425f15af2a84645b6d2828a0e33830192f9b1dfd250c30e4823f303fa
+  metadata.gz: e2b5a313624613ae7de8e72dee4cd48b880effecfd7ffcd4472e4d79c4bf4e960e7db09b7574f6a285da8995494fc6618e7b59c1d43865b0fac68df7920ef867
+  data.tar.gz: f3af3c8278b4d886394560bdf404d5487a311635c2232b6e8ae3159cc0f3255c96ff14f60e2ba868c8697500e38cd0eb8e860aa7f9a39a6d832f8d9faba592fd

data/README.md

@@ -160,7 +160,7 @@ This also allows the broker to send messages as quickly as it wants down to your
 
 ### manual_acknowledgement!
 
-This mode leaves it up to the subscriber to handle acknowledging or rejecting messages. In your subscriber you can just call <code>acknowledge</code> or <code>reject</code>.
+This mode leaves it up to the subscriber to handle acknowledging or rejecting messages. In your subscriber you can just call <code>acknowledge</code>, <code>reject</code>, or <code>nack</code>.
 
 ### at_most_once!
 
@@ -172,6 +172,11 @@ Rabbit is told to expect message acknowledgements, but sending the acknowledgeme
 We send the acknowledgement right after calling your subscriber.
 If an error is raised your message will be retried on a sent back to rabbitmq and retried on an exponential backoff schedule.
 
+### safe_nack
+If you turn on acknowledgements and a message is not acknowledged by your code manually or using one of the filters above the `ErrorHandler` middleware
+which wraps the entire block with call <code>nack</code> this is a last resort so the connection does not get backed up in cases of unexpected or
+unhandled errors.
+
 ### redeliver
 
 A message can be sent to "redeliver" with `::ActionSubscriber::MessageRetry.redeliver_message_with_backoff` or the DSL method `redeliver` and optionally

data/action_subscriber.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "active_publisher", "~> 0.1.5"
   spec.add_development_dependency "activerecord", ">= 3.2"
   spec.add_development_dependency "bundler", ">= 1.6"
+  spec.add_development_dependency "pry-coolline"
   spec.add_development_dependency "pry-nav"
   spec.add_development_dependency "rabbitmq_http_api_client", "~> 1.2.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/action_subscriber/bunny/subscriber.rb

@@ -44,6 +44,7 @@ module ActionSubscriber
               :message_id => properties.message_id,
               :routing_key => delivery_info.routing_key,
               :queue => queue.name,
+              :uses_acknowledgements => route.acknowledgements?,
             }
             env = ::ActionSubscriber::Middleware::Env.new(route.subscriber, encoded_payload, properties)
             run_env(env, threadpool)

data/lib/action_subscriber/march_hare/subscriber.rb

@@ -42,6 +42,7 @@ module ActionSubscriber
               :message_id => metadata.message_id,
               :routing_key => metadata.routing_key,
               :queue => queue.name,
+              :uses_acknowledgements => route.acknowledgements?,
             }
             env = ::ActionSubscriber::Middleware::Env.new(route.subscriber, encoded_payload, properties)
             run_env(env, threadpool)

data/lib/action_subscriber/middleware/active_record/connection_management.rb

@@ -38,7 +38,7 @@ module ActionSubscriber
         end
 
         def call(env)
-          def call(env)
+          def call(env) # redefines so it only gets called once
             ::ActiveRecord::Base.connection_pool.with_connection do
               @app.call(env)
             end

data/lib/action_subscriber/middleware/decoder.rb

@@ -18,7 +18,7 @@ module ActionSubscriber
       private
 
       def decoder
-        ActionSubscriber.config.decoder[env.content_type]
+        ::ActionSubscriber.config.decoder[env.content_type]
       end
 
       def decoder?

data/lib/action_subscriber/middleware/env.rb

@@ -33,27 +33,54 @@ module ActionSubscriber
         @delivery_tag = properties.fetch(:delivery_tag)
         @encoded_payload = encoded_payload
         @exchange = properties.fetch(:exchange)
-        @headers = properties.fetch(:headers) || {}
-        @message_id = properties.fetch(:message_id) || ::SecureRandom.hex(3)
+        @has_been_acked = false
+        @has_been_nacked = false
+        @has_been_rejected = false
+        @headers = properties.fetch(:headers, {})
+        @message_id = properties.fetch(:message_id, ::SecureRandom.hex(3))
         @queue = properties.fetch(:queue)
         @routing_key = properties.fetch(:routing_key)
         @subscriber = subscriber
+        @uses_acknowledgements = properties.fetch(:uses_acknowledgements, false)
       end
 
       def acknowledge
         fail ::RuntimeError, "you can't acknowledge messages under the polling API" unless @channel
         acknowledge_multiple_messages = false
+        @has_been_acked = true
         @channel.ack(@delivery_tag, acknowledge_multiple_messages)
         true
       end
 
+      def nack
+        fail ::RuntimeError, "you can't acknowledge messages under the polling API" unless @channel
+        nack_multiple_messages = false
+        requeue_message = true
+        @has_been_nacked = true
+        @channel.nack(@delivery_tag, nack_multiple_messages, requeue_message)
+        true
+      end
+
       def reject
         fail ::RuntimeError, "you can't acknowledge messages under the polling API" unless @channel
         requeue_message = true
+        @has_been_rejected = true
         @channel.reject(@delivery_tag, requeue_message)
         true
       end
 
+      def safe_acknowledge
+        acknowledge if uses_acknowledgements? && @channel && !has_used_delivery_tag?
+      end
+
+      def safe_nack
+        nack if uses_acknowledgements? && @channel && !has_used_delivery_tag?
+      end
+
+      def safe_reject
+        reject if uses_acknowledgements? && @channel && !has_used_delivery_tag?
+      end
+
       def to_hash
         {
           :action => action,
@@ -65,6 +92,15 @@ module ActionSubscriber
       end
       alias_method :to_h, :to_hash
 
+    private
+
+      def has_used_delivery_tag?
+        @has_been_acked || @has_been_nacked || @has_been_rejected
+      end
+
+      def uses_acknowledgements?
+        @uses_acknowledgements
+      end
     end
   end
 end

data/lib/action_subscriber/middleware/error_handler.rb

@@ -9,8 +9,8 @@ module ActionSubscriber
 
       def call(env)
         @app.call(env)
-      rescue => error
-        logger.error "FAILED #{env.message_id}"
+      rescue Exception => error # make sure we capture any exception from the top of the hierarchy
+        logger.error { "FAILED #{env.message_id}" }
 
         # There is more to this rescue than meets the eye. MarchHare's java library will rescue errors
         # and attempt to close the channel with its default exception handler. To avoid this, we will
@@ -18,9 +18,11 @@ module ActionSubscriber
         # it should not re-raise. As a bonus, not killing these threads is better for your runtime :).
         begin
           ::ActionSubscriber.configuration.error_handler.call(error, env.to_h)
-        rescue => error
-          logger.error "ActionSubscriber error handler raised error, but should never raise. Error: #{error}"
+        rescue Exception => inner_error
+          logger.error { "ActionSubscriber error handler raised error, but should never raise. Error: #{inner_error}" }
         end
+      ensure
+        env.safe_nack # Make sure we attempt to `nack` a message that did not get processed if something fails
       end
     end
   end

data/lib/action_subscriber/middleware/router.rb

@@ -1,6 +1,7 @@
 module ActionSubscriber
   module Middleware
     class Router
+      INSTRUMENT_KEY = "process_event.action_subscriber".freeze
       include ::ActionSubscriber::Logging
 
       def initialize(app)
@@ -8,11 +9,27 @@ module ActionSubscriber
       end
 
       def call(env)
-        logger.info { "START #{env.message_id} #{env.subscriber}##{env.action}" }
-        ::ActiveSupport::Notifications.instrument "process_event.action_subscriber", :subscriber => env.subscriber.to_s, :routing_key => env.routing_key, :queue => env.queue do
-          env.subscriber.run_action_with_filters(env, env.action)
+        action = env.action
+        message_id = env.message_id
+        queue = env.queue
+        routing_key = env.routing_key
+        subscriber = env.subscriber
+
+        logger.info { "START #{message_id} #{subscriber}##{action}" }
+
+        instrument_call(subscriber, routing_key, queue) do
+          subscriber.run_action_with_filters(env, action)
+        end
+
+        logger.info { "FINISHED #{message_id}" }
+      end
+
+    private
+
+      def instrument_call(subscriber, routing_key, queue)
+        ::ActiveSupport::Notifications.instrument INSTRUMENT_KEY, :subscriber => subscriber.to_s, :routing_key => routing_key, :queue => queue do
+          yield
         end
-        logger.info { "FINISHED #{env.message_id}" }
       end
     end
   end

data/lib/action_subscriber/middleware.rb

@@ -1,3 +1,4 @@
+require "action_subscriber/logging"
 require "action_subscriber/middleware/decoder"
 require "action_subscriber/middleware/env"
 require "action_subscriber/middleware/error_handler"
@@ -6,11 +7,26 @@ require "action_subscriber/middleware/runner"
 
 module ActionSubscriber
   module Middleware
+
+    class Builder < ::Middleware::Builder
+      include ::ActionSubscriber::Logging
+
+      def print_middleware_stack
+        logger.info "Middlewares ["
+
+        stack.each do |middleware|
+          logger.info "#{middleware}"
+        end
+
+        logger.info "]"
+      end
+    end
+
     def self.initialize_stack
-      builder = ::Middleware::Builder.new(:runner_class => ::ActionSubscriber::Middleware::Runner)
+      builder = ::ActionSubscriber::Middleware::Builder.new(:runner_class => ::ActionSubscriber::Middleware::Runner)
 
-      builder.use ErrorHandler
-      builder.use Decoder
+      builder.use ::ActionSubscriber::Middleware::ErrorHandler
+      builder.use ::ActionSubscriber::Middleware::Decoder
 
       builder
     end

data/lib/action_subscriber/railtie.rb

@@ -6,8 +6,8 @@ module ActionSubscriber
       require "action_subscriber/middleware/active_record/connection_management"
       require "action_subscriber/middleware/active_record/query_cache"
 
-      ::ActionSubscriber.config.middleware.use ::ActionSubscriber::Middleware::ActiveRecord::ConnectionManagement
-      ::ActionSubscriber.config.middleware.use ::ActionSubscriber::Middleware::ActiveRecord::QueryCache
+      ::ActionSubscriber.config.middleware.insert_after ::ActionSubscriber::Middleware::Decoder, ::ActionSubscriber::Middleware::ActiveRecord::ConnectionManagement
+      ::ActionSubscriber.config.middleware.insert_after ::ActionSubscriber::Middleware::ActiveRecord::ConnectionManagement, ::ActionSubscriber::Middleware::ActiveRecord::QueryCache
     end
   end
 end

data/lib/action_subscriber/route_set.rb

@@ -12,7 +12,12 @@ module ActionSubscriber
       @routes = routes
     end
 
+    def print_middleware_stack
+      ::ActionSubscriber.config.middleware.print_middleware_stack
+    end
+
     def print_subscriptions
+      print_middleware_stack
       routes.group_by(&:subscriber).each do |subscriber, routes|
         logger.info subscriber.name
         routes.each do |route|
@@ -39,15 +44,20 @@ module ActionSubscriber
     end
 
     def wait_to_finish_with_timeout(timeout)
+      finisher_threads = []
+
       ::ActionSubscriber::ThreadPools.threadpools.map do |name, threadpool|
         logger.info "  -- Threadpool #{name} (queued: #{threadpool.queue_length})"
-        ::Thread.new do
-          completed = threadpool.wait_for_termination(timeout)
+        finisher_threads << ::Thread.new(threadpool, timeout, name) do |internal_pool, internal_timeout, internal_name|
+          completed = internal_pool.wait_for_termination(internal_timeout)
+
           unless completed
-            logger.error "  -- FAILED #{name} did not finish shutting down within #{timeout}sec"
+            logger.error "  -- FAILED #{internal_name} did not finish shutting down within #{internal_timeout}sec"
           end
         end
-      end.each(&:join)
+      end
+
+      finisher_threads.each(&:join)
     end
 
   private

data/lib/action_subscriber/rspec.rb

@@ -7,6 +7,10 @@ module ActionSubscriber
         true
       end
 
+      def nack(delivery_tag, acknowledge_multiple, requeue_message)
+        true
+      end
+
       def reject(delivery_tag, requeue_message)
         true
       end
@@ -22,6 +26,7 @@ module ActionSubscriber
       :message_id => "MSG-123",
       :routing_key => "amigo.user.created",
       :queue => "test.amigo.user.created",
+      :uses_acknoledgements => false,
     }.freeze
 
     # Create a new subscriber instance. Available options are:

data/lib/action_subscriber/version.rb

@@ -1,3 +1,3 @@
 module ActionSubscriber
-  VERSION = "5.0.3"
+  VERSION = "5.1.0.pre"
 end

data/spec/integration/manual_acknowledgement_spec.rb

@@ -3,8 +3,10 @@ class BaconSubscriber < ActionSubscriber::Base
 
   def served
     $messages << "#{payload}::#{$messages.size}"
-    if $messages.size > 2
+    if $messages.size > 3
       acknowledge
+    elsif $messages.size > 2
+      nack
     else
       reject
     end
@@ -20,12 +22,12 @@ describe "Manual Message Acknowledgment", :integration => true do
   end
   let(:subscriber) { BaconSubscriber }
 
-  it "retries rejected messages and stops retrying acknowledged messages" do
+  it "retries rejected/nacked messages and stops retrying acknowledged messages" do
     ::ActionSubscriber.start_subscribers!
     ::ActivePublisher.publish("bacon.served", "BACON!", "events")
 
-    verify_expectation_within(2.0) do
-      expect($messages).to eq(Set.new(["BACON!::0", "BACON!::1", "BACON!::2"]))
+    verify_expectation_within(2.5) do
+      expect($messages).to eq(Set.new(["BACON!::0", "BACON!::1", "BACON!::2", "BACON!::3"]))
     end
   end
 end

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

@@ -7,14 +7,32 @@ describe ActionSubscriber::Middleware::ErrorHandler do
 
   it_behaves_like 'an action subscriber middleware'
 
-  let(:error) { ::RuntimeError.new("Boom!") }
+  let(:load_error) { ::LoadError.new("Boom!") }
+  let(:runtime_error) { ::RuntimeError.new("Boom!") }
 
   context "when an exception occurs" do
-    before { allow(app).to receive(:call).and_raise(error) }
+    context "LoadError" do
+      before { allow(app).to receive(:call).and_raise(load_error) }
+      it "calls the exception handler with a LoadError" do
+        handler = ::ActionSubscriber.configuration.error_handler
+        expect(handler).to receive(:call).with(load_error, env.to_h)
 
-    it "calls the exception handler" do
-      handler = ::ActionSubscriber.configuration.error_handler
-      expect(handler).to receive(:call).with(error, env.to_h)
+        subject.call(env)
+      end
+    end
+
+    context "RuntimError" do
+      before { allow(app).to receive(:call).and_raise(runtime_error) }
+      it "calls the exception handler with a RuntimeError" do
+        handler = ::ActionSubscriber.configuration.error_handler
+        expect(handler).to receive(:call).with(runtime_error, env.to_h)
+
+        subject.call(env)
+      end
+    end
+
+    it "calls safe_nack after execution" do
+      expect(env).to receive(:safe_nack)
 
       subject.call(env)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_subscriber
 version: !ruby/object:Gem::Version
-  version: 5.0.3
+  version: 5.1.0.pre
 platform: ruby
 authors:
 - Brian Stien
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -126,6 +126,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: pry-coolline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
@@ -278,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.6.13
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: ActionSubscriber is a DSL that allows a rails app to consume messages from