action_subscriber 5.2.2 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 341fae9698b9a950fe6dcbc2263fcfba9f8f2b87de7156753714a2f5459dc6d0
-  data.tar.gz: 4ee41e85aab759a85339aaa174b499d34ba3967b90220ddfee3e43ada8191282
+  metadata.gz: 7e335eb0bfa75bf17d2a27db0851b383dc9e624a621d3e18f1779bd50208a53e
+  data.tar.gz: 2d55858d1ebf03f5c42fcb04f7d4ad0e236b5859df9db510db334d9b73524ea3
 SHA512:
-  metadata.gz: b21075dc61f36ba0b20923178524030f95d4a62be67275ae5fb16db18175e63e27224640f96a9a11e5e624c0a145d37b092d6b627e1f7fa779c07c6b0ea9229d
-  data.tar.gz: ea278d62aee15c5bb1d01832c104e33ff1f305aecf373e547a8ff11929b2771167c51e5a4d029e915065113ffc8bfb1a7d445506abb94e0d0026c8dcd045335d
+  metadata.gz: c819570924299aa0d39ebced23078bdc48133f125e76e59dd62d408c014919b380862c3ad22c2505f4a379fa66f973ae31c3ff803abf63d2976e75d44204cee8
+  data.tar.gz: 1ef6ba00566fa31c58c3eb5dc4fbfc21a30da2810156c0e9f87bf4cb829bc3e408643861fc3a3d8058cb6f3bd8343644e303f596ef71f09b4038e1c6e30eead6

data/.circleci/config.yml

@@ -0,0 +1,61 @@
+# Inspired by: http://mikebian.co/running-tests-against-multiple-ruby-versions-using-circleci/
+
+version: 2.1
+
+orbs:
+  ruby: circleci/ruby@1.1
+
+
+  # If you want to work on `action_subscriber` you will need to have a rabbitmq instance running locally on port 5672 with a management plugin enabled on port 15672. Usually the easiest way to accomplish this is to use docker and run the command:
+
+  # ```
+
+jobs:
+  test:
+    parallelism: 1
+    parameters:
+      ruby-image:
+        type: string
+    docker:
+      - image: << parameters.ruby-image >>
+      - image: rabbitmq:3.6.6-management
+
+    steps:
+      - checkout
+      - run:
+          name: install dockerize
+          command: wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz && sudo tar -C /usr/local/bin -xzvf dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz && rm dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz
+          environment:
+            DOCKERIZE_VERSION: v0.3.0
+      # - run:
+      #     name: Wait for rabbitmq
+      #     command: dockerize -wait tcp://localhost:5672 -timeout 1m
+      - run:
+          name: Install bundler
+          command: gem install bundler
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - run:
+          name: bundle install
+          command: bundle install
+      - run:
+          name: rspec
+          command: bundle exec rspec
+
+# strangely, there seems to be very little documentation about exactly how martix builds work.
+# By defining a param inside your job definition, Circle CI will automatically spawn a job for
+# unique param value passed via `matrix`. Neat!
+# https://circleci.com/blog/circleci-matrix-jobs/
+workflows:
+  build_and_test:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              ruby-image:
+                - circleci/ruby:2.5
+                - circleci/ruby:2.6
+                - circleci/ruby:2.7
+                - circleci/jruby:9.2
+                - circleci/jruby:9.3

data/action_subscriber.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
 
   if ENV['PLATFORM'] == "java" || ::RUBY_PLATFORM == 'java'
     spec.platform = "java"
-    spec.add_dependency 'march_hare', '>= 2.7.0'
+    spec.add_dependency 'march_hare', '~> 4.4'
   else
     spec.add_dependency 'bunny', '>= 1.5.0'
   end
@@ -33,9 +33,9 @@ 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"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
 end

data/lib/action_subscriber/babou.rb

@@ -1,3 +1,5 @@
+require "active_support/notifications"
+
 module ActionSubscriber
   module Babou
     ##
@@ -10,7 +12,7 @@ module ActionSubscriber
       ::ActionSubscriber.print_subscriptions
       ::ActionSubscriber.start_subscribers!
       logger.info "Action Subscriber connected"
-
+      ::ActiveSupport::Notifications.instrument("action_subscriber:server_started")
       while true
         sleep 1.0 #just hang around waiting for messages
         break if shutting_down?
@@ -21,6 +23,7 @@ module ActionSubscriber
       logger.info "Shutting down"
       ::ActionSubscriber::RabbitConnection.subscriber_disconnect!
       logger.info "Shutdown complete"
+      ::ActiveSupport::Notifications.instrument("action_subscriber:server_stopped")
       exit(0)
     end
 

data/lib/action_subscriber/bunny/subscriber.rb

@@ -2,6 +2,7 @@ module ActionSubscriber
   module Bunny
     module Subscriber
       include ::ActionSubscriber::Logging
+      include ::ActionSubscriber::Subscriber
 
       def bunny_consumers
         @bunny_consumers ||= []
@@ -43,11 +44,10 @@ module ActionSubscriber
         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..."
+            ::ActionSubscriber.logger.warn "Cancellation 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)
+            safely_restart_subscriber(subscription)
           end
         end
 

data/lib/action_subscriber/march_hare/subscriber.rb

@@ -2,6 +2,7 @@ module ActionSubscriber
   module MarchHare
     module Subscriber
       include ::ActionSubscriber::Logging
+      include ::ActionSubscriber::Subscriber
 
       def cancel_consumers!
         # Cancel any non-cancelled consumers.
@@ -43,11 +44,10 @@ module ActionSubscriber
         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..."
+            ::ActionSubscriber.logger.warn "Cancellation 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)
+            safely_restart_subscriber(subscription)
           end
         end
 

data/lib/action_subscriber/subscriber.rb

@@ -0,0 +1,18 @@
+module ActionSubscriber
+  module Subscriber
+    # resubscribes to queue, continuously retrying to subscribe in the event of a potentially recoverable error while
+    # also calling the error handler to surface that a subscription failure happened
+    def safely_restart_subscriber(subscription)
+      subscription[:queue] = setup_queue(subscription[:route])
+      start_subscriber_for_subscription(subscription)
+    rescue StandardError => e
+      ::ActionSubscriber.configuration.error_handler.call(e)
+      raise e unless e.message =~ /queue .* process is stopped by supervisor/
+
+      nap_time = rand(2.0..5.0)
+      ::ActionSubscriber.logger.error("Failed to resubscribe to #{subscription[:queue].name}, retrying again in #{nap_time} seconds...")
+      sleep(nap_time)
+      retry
+    end
+  end
+end

data/lib/action_subscriber/version.rb

@@ -1,3 +1,3 @@
 module ActionSubscriber
-  VERSION = "5.2.2"
+  VERSION = "5.3.0"
 end

data/lib/action_subscriber.rb

@@ -21,6 +21,7 @@ require "action_subscriber/message_retry"
 require "action_subscriber/middleware"
 require "action_subscriber/rabbit_connection"
 require "action_subscriber/subscribable"
+require "action_subscriber/subscriber"
 require "action_subscriber/thread_pools"
 require "action_subscriber/bunny/subscriber"
 require "action_subscriber/march_hare/subscriber"
@@ -86,6 +87,18 @@ module ActionSubscriber
     route_set.wait_to_finish_with_timeout(timeout)
   end
 
+  def self.after_server_start(&block)
+    ::ActiveSupport::Notifications.subscribe("action_subscriber:server_started") do |*args|
+      block.call(*args)
+    end
+  end
+
+  def self.after_server_stop(&block)
+    ::ActiveSupport::Notifications.subscribe("action_subscriber:server_stopped") do |*args|
+      block.call(*args)
+    end
+  end
+
   # Execution is delayed until after app loads when used with bin/action_subscriber
   require "action_subscriber/railtie" if defined?(Rails)
   ::ActiveSupport.run_load_hooks(:action_subscriber, Base)

data/spec/integration/automatic_reconnect_spec.rb

@@ -7,36 +7,36 @@ class GusSubscriber < ActionSubscriber::Base
 end
 
 describe "Automatically reconnect on connection failure", :integration => true, :slow => true do
- let(:draw_routes) do
-   ::ActionSubscriber.draw_routes do
-     default_routes_for GusSubscriber
-   end
- end
- let(:http_client) { RabbitMQ::HTTP::Client.new("http://127.0.0.1:15672") }
- let(:subscriber) { GusSubscriber }
+  let(:draw_routes) do
+    ::ActionSubscriber.draw_routes do
+      default_routes_for GusSubscriber
+    end
+  end
+  let(:http_client) { RabbitMQ::HTTP::Client.new("http://127.0.0.1:15672") }
+  let(:subscriber) { GusSubscriber }
 
- it "reconnects when a connection drops" do
-   ::ActionSubscriber::start_subscribers!
-   ::ActivePublisher.publish("gus.spoke", "First", "events")
-   verify_expectation_within(5.0) do
-     expect($messages).to eq(Set.new(["First"]))
-   end
+  it "reconnects when a connection drops" do
+    ::ActionSubscriber::start_subscribers!
+    ::ActivePublisher.publish("gus.spoke", "First", "events")
+    verify_expectation_within(5.0) do
+      expect($messages).to eq(Set.new(["First"]))
+    end
 
-   close_all_connections!
-   sleep 5.0
-   verify_expectation_within(5.0) do
-     expect(::ActionSubscriber::RabbitConnection.with_connection{|connection| connection.open?}).to eq(true)
-   end
+    close_all_connections!
+    sleep 5.0
+    verify_expectation_within(5.0) do
+      expect(::ActionSubscriber::RabbitConnection.with_connection{|connection| connection.open?}).to eq(true)
+    end
 
-   ::ActivePublisher.publish("gus.spoke", "Second", "events")
-   verify_expectation_within(5.0) do
-     expect($messages).to eq(Set.new(["First", "Second"]))
-   end
- end
+    ::ActivePublisher.publish("gus.spoke", "Second", "events")
+    verify_expectation_within(5.0) do
+      expect($messages).to eq(Set.new(["First", "Second"]))
+    end
+  end
 
- def close_all_connections!
-   http_client.list_connections.each do |conn_info|
-     http_client.close_connection(conn_info.name)
-   end
- end
+  def close_all_connections!
+    http_client.list_connections.each do |conn_info|
+      http_client.close_connection(conn_info.name)
+    end
+  end
 end

data/spec/integration/consumer_cancellation_spec.rb

@@ -8,76 +8,116 @@ class YoloSubscriber < ActionSubscriber::Base
 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
+  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
+
+  describe "resubscription logic" do
+    let(:subscription) { subject.send(:subscriptions).first }
+    subject { ::ActionSubscriber.send(:route_set) }
+
+    it "sets up consumers" do
+      if ::RUBY_PLATFORM == "java"
+        expect { subject.safely_restart_subscriber(subscription) }.to change { subject.march_hare_consumers.count }.from(0).to(1)
+      else
+        expect { subject.safely_restart_subscriber(subscription) }.to change { subject.bunny_consumers.count }.from(0).to(1)
+      end
+    end
+
+    context "when error is raised during resubscription process" do
+      context "and error is one that can be retried" do
+        let(:error) { ::RuntimeError.new("queue 're.created' in vhost '/' process is stopped by supervisor") }
+
+        it "retries resubscription process" do
+          expect(subject).to receive(:setup_queue).and_raise(error).ordered
+          expect(subject).to receive(:setup_queue).and_raise(error).ordered
+          expect(subject).to receive(:setup_queue).and_call_original.ordered
+          expect(::ActionSubscriber.config.error_handler).to receive(:call).with(error).twice
+          expect(::ActionSubscriber.logger).to receive(:error).twice
+          expect(subject).to receive(:sleep).twice # mostly to skip the delay
+          subject.safely_restart_subscriber(subscription)
+        end
+      end
+
+      context "and error is one that can't be retried" do
+        let(:error) { ::RuntimeError.new("kaBOOM") }
+
+        it "calls error handler and raises" do
+          expect(subject).to receive(:setup_queue).and_raise(error).ordered
+          expect(::ActionSubscriber.config.error_handler).to receive(:call).with(error).once
+          expect(subject).to_not receive(:sleep)
+          expect { subject.safely_restart_subscriber(subscription) }.to raise_error(error)
+        end
+      end
+    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

data/spec/spec_helper.rb

@@ -1,6 +1,14 @@
 require 'rubygems'
 require 'bundler'
 
+unless ENV["NO_COV"]
+  require "simplecov"
+  ::SimpleCov.start do
+    enable_coverage :branch
+    add_filter "spec"
+  end
+end
+
 ENV['APP_NAME'] = 'Alice'
 
 Bundler.require(:default, :development, :test)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_subscriber
 version: !ruby/object:Gem::Version
-  version: 5.2.2
+  version: 5.3.0
 platform: ruby
 authors:
 - Brian Stien
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -126,20 +126,6 @@ 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
@@ -196,6 +182,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
 description: ActionSubscriber is a DSL that allows a rails app to consume messages
   from a RabbitMQ broker.
 email:
@@ -209,6 +209,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -249,6 +250,7 @@ files:
 - lib/action_subscriber/router.rb
 - lib/action_subscriber/rspec.rb
 - lib/action_subscriber/subscribable.rb
+- lib/action_subscriber/subscriber.rb
 - lib/action_subscriber/thread_pools.rb
 - lib/action_subscriber/uri.rb
 - lib/action_subscriber/version.rb
@@ -298,7 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: ActionSubscriber is a DSL that allows a rails app to consume messages from