action_subscriber 4.2.2 → 4.2.3.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 594de0a5e663d38d4e62b13f79397aaa0cfe3ac9
-  data.tar.gz: 6197131691887782ba9954c4b14e28d32e34bfca
+  metadata.gz: 45ae69689291e9fcda93dc4b92648b224add38d0
+  data.tar.gz: 01b00b6b55bd1a4c4995021c6e4843b0707ee756
 SHA512:
-  metadata.gz: f562a6485494250754c8accab507d1a7734461b889bfefd6fda4f51fe02cbdfe58bc26b344a11eaf86804e10cbdfdcbc3ed474755d2b7ad2d7cbe210ebada5b8
-  data.tar.gz: 00921c4ac4c2c366e05b975486609fec0645fb0e60b6fa974154d7c3b6782d00dac4277256e3c3d183e09088ae220b547e0eda73bcd024ab167d86973792d793
+  metadata.gz: 41e3a0fbac6c65b5c7b04abe3f44dcd18132ab2d8cbe24583958c22805a9b285efaf4cc3a60c90d1de2c86559e06a2e33340562a539165f065719a9251f2069f
+  data.tar.gz: 34bba997f2819957baa13da7ac0edf956dd66fc0477ad388fcb43fe99762eeb96d0dd41e8afd08a92058e56c45d3c11e4e9cc92a08841c1481b04218425e3aca

data/README.md

@@ -88,6 +88,29 @@ $ bundle exec action_subscriber start
 
 This will connect your subscribers to the rabbitmq broker and allow it to push messages down to your subscribers.
 
+### Around Filters
+"around" filters are responsible for running their associated actions by yielding, similar to how Rack middlewares work (and Rails around filters work)
+
+```ruby
+class UserSubscriber < ::ActionSubscriber::Base
+  around_filter :log_things
+
+  def created
+    # do something when a user is created
+  end
+
+  private
+
+  def log_things
+    puts "before I do some stuff"
+    yield
+    puts "I did some stuff"
+  end
+end
+```
+
+> Warning: an around filter will only be added once to the chain, duplicate around filters are not supported
+
 Configuration
 -----------------
 ActionSubscriber needs to know how to connect to your rabbit server to start getting messages.
@@ -140,6 +163,30 @@ 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.
 
+### retry
+
+A message can be sent to "retry" with `::ActionSubscriber::MessageRetry.redeliver_message_with_backoff` or the DSL method `retry` and optionally
+takes a "backoff schedule" which is a hash of backoff milliseconds for each retry, the default:
+
+```ruby
+  SCHEDULE = {
+    2  =>        100,
+    3  =>        500,
+    4  =>      2_500,
+    5  =>     12_500,
+    6  =>     62_500,
+    7  =>    312_500,
+    8  =>  1_562_500,
+    9  =>  7_812_500,
+    10 => 39_062_500,
+  }
+```
+
+when the schedule "returns" `nil` the message will not be retried
+
+> Warning: If you use `retry` you need to handle reject/acknowledge according how errors are handled; if an error is caught and the
+> ack/reject is already done then you may duplicate the message in `at_least_once!` mode
+
 Testing
 -----------------
 ActionSubscriber includes support for easy unit testing with RSpec.

data/lib/action_subscriber/base.rb

@@ -59,5 +59,9 @@ module ActionSubscriber
     def reject
       env.reject
     end
+
+    def retry(backoff_schedule = ::ActionSubscriber::MessageRetry::SCHEDULE)
+      ::ActionSubscriber::MessageRetry::redeliver_message_with_backoff(env, backoff_schedule)
+    end
   end
 end

data/lib/action_subscriber/bunny/subscriber.rb

@@ -23,6 +23,9 @@ module ActionSubscriber
             logger.info "    -- routing_key: #{route.routing_key}"
             logger.info "    --    prefetch: #{route.prefetch}"
             logger.error "WARNING having a prefetch lower than your concurrency will prevent your subscriber from fully utilizing its threadpool" if route.prefetch < route.concurrency
+            if route.acknowledgements != subscriber.acknowledge_messages?
+              logger.error "WARNING subscriber has acknowledgements as #{subscriber.acknowledge_messages?} and route has acknowledgements as #{route.acknowledgements}"
+            end
           end
         end
       end

data/lib/action_subscriber/dsl.rb

@@ -23,7 +23,8 @@ module ActionSubscriber
     end
 
     def around_filter(filter_method)
-      around_filters << filter_method
+      around_filters << filter_method unless around_filters.include?(filter_method)
+      around_filters
     end
 
     def around_filters

data/lib/action_subscriber/march_hare/subscriber.rb

@@ -23,6 +23,9 @@ module ActionSubscriber
             logger.info "    --       queue: #{route.queue}"
             logger.info "    -- routing_key: #{route.routing_key}"
             logger.info "    --    prefetch: #{route.prefetch} per consumer (#{route.prefetch * route.concurrency} total)"
+            if route.acknowledgements != subscriber.acknowledge_messages?
+              logger.error "WARNING subscriber has acknowledgements as #{subscriber.acknowledge_messages?} and route has acknowledgements as #{route.acknowledgements}"
+            end
           end
         end
       end

data/lib/action_subscriber/message_retry.rb

@@ -12,9 +12,9 @@ module ActionSubscriber
       10 => 39_062_500,
     }.freeze
 
-    def self.redeliver_message_with_backoff(env)
+    def self.redeliver_message_with_backoff(env, backoff_schedule = SCHEDULE)
       next_attempt = get_last_attempt_number(env) + 1
-      ttl = SCHEDULE[next_attempt]
+      ttl = backoff_schedule[next_attempt]
       return unless ttl
       retry_queue_name = "#{env.queue}.retry_#{ttl}"
       with_exchange(env, ttl, retry_queue_name) do |exchange|

data/lib/action_subscriber/router.rb

@@ -47,6 +47,20 @@ module ActionSubscriber
       end
     end
 
+    def local_application_name
+      @_local_application_name ||= begin
+        local_application_name = case
+                                 when ENV['APP_NAME'] then
+                                   ENV['APP_NAME'].to_s.dup
+                                 when defined?(::Rails) then
+                                   ::Rails.application.class.parent_name.dup
+                                 else
+                                   raise "Define an application name (ENV['APP_NAME'])"
+                                 end
+        local_application_name.downcase
+      end
+    end
+
     def resource_name(route_settings)
       route_settings[:subscriber].name.underscore.gsub(/_subscriber/, "").to_s
     end
@@ -61,19 +75,5 @@ module ActionSubscriber
     def routes
       @routes ||= []
     end
-
-    def local_application_name
-      @_local_application_name ||= begin
-        local_application_name = case
-                                 when ENV['APP_NAME'] then
-                                   ENV['APP_NAME'].to_s.dup
-                                 when defined?(::Rails) then
-                                   ::Rails.application.class.parent_name.dup
-                                 else
-                                   raise "Define an application name (ENV['APP_NAME'])"
-                                 end
-        local_application_name.downcase
-      end
-    end
   end
 end

data/lib/action_subscriber/version.rb

@@ -1,3 +1,3 @@
 module ActionSubscriber
-  VERSION = "4.2.2"
+  VERSION = "4.2.3.pre"
 end

data/spec/integration/around_filters_spec.rb

@@ -1,6 +1,9 @@
 class InstaSubscriber < ActionSubscriber::Base
   around_filter :whisper
   around_filter :yell
+  around_filter :whisper
+  around_filter :whisper
+  around_filter :yell
 
   def first
     $messages << payload
@@ -29,6 +32,10 @@ describe "subscriber filters", :integration => true do
   end
   let(:subscriber) { InstaSubscriber }
 
+  it "does not allow an around filter to be pushed on twice" do
+    expect(InstaSubscriber.around_filters).to eq([:whisper, :yell])
+  end
+
   it "runs multiple around filters" do
     $messages = []  #testing the order of things
     ::ActionSubscriber.start_subscribers!

data/spec/lib/action_subscriber/middleware/active_record/query_cache_spec.rb

@@ -11,7 +11,8 @@ describe ActionSubscriber::Middleware::ActiveRecord::QueryCache do
     allow(connection).to receive(:enable_query_cache!)
 
     allow(ActiveRecord::Base).to receive(:connection).and_return(connection)
-    allow(ActiveRecord::Base).to receive(:connection_id)
+    # Rails 5 "compat"
+    allow(ActiveRecord::Base).to receive(:connection_id) if ::ActiveRecord::Base.respond_to?(:connection_id)
   end
 
   subject { described_class.new(app) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_subscriber
 version: !ruby/object:Gem::Version
-  version: 4.2.2
+  version: 4.2.3.pre
 platform: ruby
 authors:
 - Brian Stien
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-20 00:00:00.000000000 Z
+date: 2017-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -277,9 +277,9 @@ 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.10