action_subscriber 5.1.5 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a596e1dcbba93eacacb9d650f0853ffdb1837a3dc36daf5255409d85a9dd52a4
-  data.tar.gz: f85747ecbb7868d6d0ec0ff01afe9dda45f4fb8ea0a1d8a5f7781cd482e04714
+  metadata.gz: eb97087f5a6958b61a4d441245e224c601dc9cb1424251f86aacca5700e327a8
+  data.tar.gz: de4d85f2ba2e8aab277d07a51966ef60b6a639d0ff0dc65e2bac2adda2cfd389
 SHA512:
-  metadata.gz: 86a8e02b695d8b9a9e8a0cf561b66f2ddcd1a4e8d8471f83143f833db1109b845f0fe42baa20b620628109721d9f1ad059e9ea3e1ac4abfe34548010fd7e3b7c
-  data.tar.gz: 334ca4005d7f67ddf6579b97488fd7220f8b695f7668098f303ae62ea0a68b188f41da60ea093c1c97a5da39cf7962ab74165a61058ff3e3df308151976e742a
+  metadata.gz: 3c1890c8861acdc67a4f6e1d3865980ef497820dd2b02038321bebab9248fee398176097c7f8d4d92332144719ae610d867ddbef93862ecc0e66781992b42036
+  data.tar.gz: d8149dbee4e94533b2bc758addf25f66ef8b0c872d3d919dc685486e482ab5127f54fedccd130dd1532809e4bc847c6e381dc786266edbcf102fea5bb84ed22d

data/.travis.yml

@@ -4,11 +4,10 @@ os:
 dist:
   trusty
 rvm:
- - 2.2.6
- - 2.3.3
- - jruby-9.0.5.0
- - jruby-9.1.7.0
+ - 2.3.8
+ - 2.5.7
  - jruby-9.1.12.0
+ - jruby-9.2.7.0
  - jruby-head
 services:
  - rabbitmq

data/README.md

@@ -135,6 +135,7 @@ Other configuration options include :
 * config.network_recovery_interval - reconnection interval for TCP connection failures (default 1)
 * config.password - RabbitMQ password (default "guest")
 * config.prefetch - number of messages to hold in the local queue in subscriber mode
+* config.resubscribe_on_consumer_cancellation - resubscribe when the consumer is cancelled (queue deleted or cluster fails, default true)
 * config.seconds_to_wait_for_graceful_shutdown - time to wait before force stopping server after shutdown signal
 * config.threadpool_size - set the number of threads available to action_subscriber
 * config.timeout - how many seconds to allow rabbit to respond before timing out

data/lib/action_subscriber/bunny/subscriber.rb

@@ -26,35 +26,52 @@ module ActionSubscriber
 
       def start_subscribers!
         subscriptions.each do |subscription|
-          route = subscription[:route]
-          queue = subscription[:queue]
-          channel = queue.channel
-          threadpool = ::ActionSubscriber::ThreadPools.threadpools.fetch(route.threadpool_name)
-          channel.prefetch(route.prefetch) if route.acknowledgements?
-          consumer = ::Bunny::Consumer.new(channel, queue, channel.generate_consumer_tag, !route.acknowledgements?)
-          consumer.on_delivery do |delivery_info, properties, encoded_payload|
-            ::ActiveSupport::Notifications.instrument "received_event.action_subscriber", :payload_size => encoded_payload.bytesize, :queue => queue.name
-            properties = {
-              :action => route.action,
-              :channel => queue.channel,
-              :content_type => properties.content_type,
-              :delivery_tag => delivery_info.delivery_tag,
-              :exchange => delivery_info.exchange,
-              :headers => properties.headers,
-              :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)
-          end
-          bunny_consumers << consumer
-          queue.subscribe_with(consumer)
+          start_subscriber_for_subscription(subscription)
         end
       end
 
-      private
+    private
+
+      def start_subscriber_for_subscription(subscription)
+        route = subscription[:route]
+        queue = subscription[:queue]
+        channel = queue.channel
+        threadpool = ::ActionSubscriber::ThreadPools.threadpools.fetch(route.threadpool_name)
+        channel.prefetch(route.prefetch) if route.acknowledgements?
+        consumer = ::Bunny::Consumer.new(channel, queue, channel.generate_consumer_tag, !route.acknowledgements?)
+
+        if ::ActionSubscriber.configuration.resubscribe_on_consumer_cancellation
+          # Add cancellation callback to rebuild subscriber on cancel.
+          consumer.on_cancellation do
+            ::ActionSubscriber.logger.warn "Cancelation received for queue consumer: #{queue.name}, rebuilding subscription..."
+            bunny_consumers.delete(consumer)
+            channel.close
+            queue = subscription[:queue] = setup_queue(route)
+            start_subscriber_for_subscription(subscription)
+          end
+        end
+
+        consumer.on_delivery do |delivery_info, properties, encoded_payload|
+          ::ActiveSupport::Notifications.instrument "received_event.action_subscriber", :payload_size => encoded_payload.bytesize, :queue => queue.name
+          properties = {
+            :action => route.action,
+            :channel => queue.channel,
+            :content_type => properties.content_type,
+            :delivery_tag => delivery_info.delivery_tag,
+            :exchange => delivery_info.exchange,
+            :headers => properties.headers,
+            :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)
+        end
+
+        bunny_consumers << consumer
+        queue.subscribe_with(consumer)
+      end
 
       def setup_queue(route)
         channel = ::ActionSubscriber::RabbitConnection.with_connection{|connection| connection.create_channel(nil, 1) }

data/lib/action_subscriber/configuration.rb

@@ -16,6 +16,7 @@ module ActionSubscriber
                   :password,
                   :port,
                   :prefetch,
+                  :resubscribe_on_consumer_cancellation,
                   :seconds_to_wait_for_graceful_shutdown,
                   :threadpool_size,
                   :timeout,
@@ -42,6 +43,7 @@ module ActionSubscriber
       :password => "guest",
       :port => 5672,
       :prefetch => 2,
+      :resubscribe_on_consumer_cancellation => true,
       :seconds_to_wait_for_graceful_shutdown => 30,
       :threadpool_size => 8,
       :timeout => 1,

data/lib/action_subscriber/march_hare/subscriber.rb

@@ -4,7 +4,8 @@ module ActionSubscriber
       include ::ActionSubscriber::Logging
 
       def cancel_consumers!
-        march_hare_consumers.each(&:cancel)
+        # Cancel any non-cancelled consumers.
+        march_hare_consumers.reject(&:cancelled?).each(&:cancel)
         ::ActionSubscriber::ThreadPools.threadpools.each do |name, threadpool|
           threadpool.shutdown
         end
@@ -26,33 +27,50 @@ module ActionSubscriber
 
       def start_subscribers!
         subscriptions.each do |subscription|
-          route = subscription[:route]
-          queue = subscription[:queue]
-          queue.channel.prefetch = route.prefetch if route.acknowledgements?
-          threadpool = ::ActionSubscriber::ThreadPools.threadpools.fetch(route.threadpool_name)
-          consumer = queue.subscribe(route.queue_subscription_options) do |metadata, encoded_payload|
-            ::ActiveSupport::Notifications.instrument "received_event.action_subscriber", :payload_size => encoded_payload.bytesize, :queue => queue.name
-            properties = {
-              :action => route.action,
-              :channel => queue.channel,
-              :content_type => metadata.content_type,
-              :delivery_tag => metadata.delivery_tag,
-              :exchange => metadata.exchange,
-              :headers => _normalized_headers(metadata),
-              :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)
+          start_subscriber_for_subscription(subscription)
+        end
+      end
+
+    private
+
+      def start_subscriber_for_subscription(subscription)
+        route = subscription[:route]
+        queue = subscription[:queue]
+        queue.channel.prefetch = route.prefetch if route.acknowledgements?
+        threadpool = ::ActionSubscriber::ThreadPools.threadpools.fetch(route.threadpool_name)
+        opts = route.queue_subscription_options
+
+        if ::ActionSubscriber.configuration.resubscribe_on_consumer_cancellation
+          # Add cancellation callback to rebuild subscriber on cancel.
+          opts[:on_cancellation] = lambda do |the_consumer|
+            ::ActionSubscriber.logger.warn "Cancelation received for queue consumer: #{queue.name}, rebuilding subscription..."
+            march_hare_consumers.delete(the_consumer)
+            queue.channel.close
+            queue = subscription[:queue] = setup_queue(route)
+            start_subscriber_for_subscription(subscription)
           end
+        end
 
-          march_hare_consumers << consumer
+        consumer = queue.subscribe(opts) do |metadata, encoded_payload|
+          ::ActiveSupport::Notifications.instrument "received_event.action_subscriber", :payload_size => encoded_payload.bytesize, :queue => queue.name
+          properties = {
+            :action => route.action,
+            :channel => queue.channel,
+            :content_type => metadata.content_type,
+            :delivery_tag => metadata.delivery_tag,
+            :exchange => metadata.exchange,
+            :headers => _normalized_headers(metadata),
+            :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)
         end
-      end
 
-      private
+        march_hare_consumers << consumer
+      end
 
       def setup_queue(route)
         channel = ::ActionSubscriber::RabbitConnection.with_connection{|connection| connection.create_channel }

data/lib/action_subscriber/version.rb

@@ -1,3 +1,3 @@
 module ActionSubscriber
-  VERSION = "5.1.5"
+  VERSION = "5.2.0"
 end

data/spec/integration/consumer_cancellation_spec.rb

@@ -0,0 +1,83 @@
+require "spec_helper"
+require "rabbitmq/http/client"
+
+class YoloSubscriber < ActionSubscriber::Base
+  def created
+    $messages << payload
+  end
+end
+
+describe "Automatically handles consumer cancellation", :integration => true, :slow => true do
+ let(:draw_routes) do
+   ::ActionSubscriber.draw_routes do
+     default_routes_for ::YoloSubscriber
+   end
+ end
+ let(:http_client) { ::RabbitMQ::HTTP::Client.new("http://127.0.0.1:15672") }
+ let(:subscriber) { ::YoloSubscriber }
+
+ it "resubscribes on cancellation" do
+   ::ActionSubscriber::start_subscribers!
+   ::ActivePublisher.publish("yolo.created", "First", "events")
+   verify_expectation_within(5.0) do
+     expect($messages).to eq(::Set.new(["First"]))
+   end
+
+   consumers = rabbit_consumers.dup
+
+   # Signal a cancellation event to all subscribers.
+   delete_all_queues!
+
+   # Give consumers a chance to restart.
+   sleep 2.0
+
+   expect(rabbit_consumers).to_not eq(consumers)
+
+   ::ActivePublisher.publish("yolo.created", "Second", "events")
+   verify_expectation_within(5.0) do
+     expect($messages).to eq(Set.new(["First", "Second"]))
+   end
+ end
+
+ context "when resubscribe on consumer cancellation is disabled" do
+   before do
+     allow(::ActionSubscriber.configuration).to receive(:resubscribe_on_consumer_cancellation).and_return(false)
+   end
+
+   it "does not resubscribe on cancellation" do
+     ::ActionSubscriber::start_subscribers!
+     ::ActivePublisher.publish("yolo.created", "First", "events")
+     verify_expectation_within(5.0) do
+       expect($messages).to eq(::Set.new(["First"]))
+     end
+
+     consumers = rabbit_consumers.dup
+
+     # Signal a cancellation event to all subscribers.
+     delete_all_queues!
+
+     # Give consumers a chance to restart.
+     sleep 2.0
+
+     # Verify the consumers did not change.
+     expect(rabbit_consumers).to eq(consumers)
+
+     ::ActivePublisher.publish("yolo.created", "Second", "events")
+
+     # Force sleep 2 seconds to ensure a resubscribe did not happen and messages were not processed.
+     sleep 2.0
+     expect($messages).to eq(Set.new(["First"]))
+   end
+ end
+
+ def rabbit_consumers
+   route_set = ::ActionSubscriber.send(:route_set)
+   route_set.try(:bunny_consumers) || route_set.try(:march_hare_consumers)
+ end
+
+ def delete_all_queues!
+   http_client.list_queues.each do |queue|
+     http_client.delete_queue(queue.vhost, queue.name)
+   end
+ end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_subscriber
 version: !ruby/object:Gem::Version
-  version: 5.1.5
+  version: 5.2.0
 platform: ruby
 authors:
 - Brian Stien
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-10 00:00:00.000000000 Z
+date: 2020-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -258,6 +258,7 @@ files:
 - spec/integration/at_most_once_spec.rb
 - spec/integration/automatic_reconnect_spec.rb
 - spec/integration/basic_subscriber_spec.rb
+- spec/integration/consumer_cancellation_spec.rb
 - spec/integration/custom_actions_spec.rb
 - spec/integration/custom_headers_spec.rb
 - spec/integration/decoding_payloads_spec.rb
@@ -296,7 +297,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: ActionSubscriber is a DSL that allows a rails app to consume messages from
@@ -307,6 +309,7 @@ test_files:
 - spec/integration/at_most_once_spec.rb
 - spec/integration/automatic_reconnect_spec.rb
 - spec/integration/basic_subscriber_spec.rb
+- spec/integration/consumer_cancellation_spec.rb
 - spec/integration/custom_actions_spec.rb
 - spec/integration/custom_headers_spec.rb
 - spec/integration/decoding_payloads_spec.rb