rabbit_feed 2.1.5 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58c69d09c8fed13331610e7015a5dcbe19e282cd
-  data.tar.gz: fd29cc489c1bb251ab1e16bf35eda04728cc839e
+  metadata.gz: 573abf58e4399420f0328ebfa8d58213ebacd7f2
+  data.tar.gz: 4aa80a039f9849ea8058502b96887c46d967b651
 SHA512:
-  metadata.gz: 5389a17aa4bffe0bacbf21f170a86fad67dc23349082502e11fff40b5bb404c405d92c6cfad9e2039bf1d1e00f83c0ccac7d12bf72bd02c2b102520199468511
-  data.tar.gz: 458a801d1631ee4be89aa3a5c59f2fd861e810a93117d536b64b2a1d725f0cc5c4162b5c4648601b81a70c03a1ae341b2926715d4865f1e1dc639ed46ac8831f
+  metadata.gz: 942ab068d1c1b6b5c4a0006aeeb8eaf41e19f0d39f2702113701c92bc3fe2e74e23d1172ead1e3085cb41c1c9938b355aec3938d1b9ff3e6d60efecdabb3c917
+  data.tar.gz: 74108418645bb5e8aaf5e0a4ca9364834ee2f8b625d0c8cf6237105e3920aa5b65c927e8c14b22590f151e4aa4d1cc6a4f345d23d768b9d7fab681d60a5cab17

data/Gemfile.lock

@@ -1,12 +1,11 @@
 PATH
   remote: .
   specs:
-    rabbit_feed (2.1.5)
+    rabbit_feed (2.3.0)
       activemodel (>= 3.2.0, < 5.0.0)
       activesupport (>= 3.2.0, < 5.0.0)
       avro (>= 1.5.4, < 1.8.0)
-      bunny (>= 1.1.9, < 1.8.0)
-      connection_pool (< 2.2.0)
+      bunny (= 2.0.0.rc2)
       pidfile
 
 GEM
@@ -28,13 +27,12 @@ GEM
       debug_inspector (>= 0.0.1)
     bond (0.5.1)
     builder (3.2.2)
-    bunny (1.7.0)
+    bunny (2.0.0.rc2)
       amq-protocol (>= 1.9.2)
     codeclimate-test-reporter (0.4.6)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
     columnize (0.9.0)
-    connection_pool (2.1.3)
     debug_inspector (0.0.2)
     debugger (1.6.8)
       columnize (>= 0.3.1)

data/README.md

@@ -90,6 +90,14 @@ RabbitFeed.instance_eval do
 end
 ```
 
+#### Logging in JSON
+
+RabbitFeed log messages are constructed in such a way that they are friendly to JSON log formats. This is done to simplify log aggregation with tools like [Kibana](https://www.elastic.co/products/kibana). To log in JSON format, set the RabbitFeed log to use the JSON formatter, e.g.
+
+```ruby
+RabbitFeed.log.formatter = RabbitFeed::JsonLogFormatter
+```
+
 ## Producing events
 
 The producer defines the events and their payloads using the [Event Definitions DSL](https://github.com/simplybusiness/rabbit_feed#event-definitions-dsl). In a rails app, this can be defined in the [initialiser](https://github.com/simplybusiness/rabbit_feed#initialisation).

data/example/non_rails_app/Gemfile.lock

@@ -1,12 +1,11 @@
 PATH
   remote: ../../
   specs:
-    rabbit_feed (2.1.5)
+    rabbit_feed (2.3.0)
       activemodel (>= 3.2.0, < 5.0.0)
       activesupport (>= 3.2.0, < 5.0.0)
       avro (>= 1.5.4, < 1.8.0)
-      bunny (>= 1.1.9, < 1.8.0)
-      connection_pool (< 2.2.0)
+      bunny (= 2.0.0.rc2)
       pidfile
 
 GEM
@@ -25,14 +24,13 @@ GEM
     avro (1.7.7)
       multi_json
     builder (3.2.2)
-    bunny (1.7.0)
+    bunny (2.0.0.rc2)
       amq-protocol (>= 1.9.2)
-    connection_pool (2.1.3)
     diff-lcs (1.2.5)
     i18n (0.7.0)
     json (1.8.3)
     minitest (5.7.0)
-    multi_json (1.11.1)
+    multi_json (1.11.2)
     pidfile (0.3.0)
     rake (10.4.2)
     rspec (3.2.0)

data/example/non_rails_app/lib/non_rails_app.rb

@@ -1,6 +1,9 @@
 require 'rabbit_feed'
 require_relative 'non_rails_app/event_handler'
 
+RabbitFeed.log = Logger.new('log/rabbit_feed.log')
+RabbitFeed.log.formatter = RabbitFeed::JsonLogFormatter
+
 EventRouting do
   accept_from('rails_app') do
     event('user_creates_beaver') do |event|

data/example/non_rails_app/spec/spec_helper.rb

@@ -19,5 +19,6 @@ RSpec.configure do |config|
 end
 
 RabbitFeed.log = Logger.new('log/rabbit_feed.log')
+RabbitFeed.log.formatter = RabbitFeed::JsonLogFormatter
 RabbitFeed.environment = 'test'
 RabbitFeed.configuration_file_path = 'config/rabbit_feed.yml'

data/example/rails_app/Gemfile.lock

@@ -1,12 +1,11 @@
 PATH
   remote: ../../
   specs:
-    rabbit_feed (2.1.5)
+    rabbit_feed (2.3.0)
       activemodel (>= 3.2.0, < 5.0.0)
       activesupport (>= 3.2.0, < 5.0.0)
       avro (>= 1.5.4, < 1.8.0)
-      bunny (>= 1.1.9, < 1.8.0)
-      connection_pool (< 2.2.0)
+      bunny (= 2.0.0.rc2)
       pidfile
 
 GEM
@@ -52,7 +51,7 @@ GEM
     avro (1.7.7)
       multi_json
     builder (3.2.2)
-    bunny (1.7.0)
+    bunny (2.0.0.rc2)
       amq-protocol (>= 1.9.2)
     coffee-rails (4.0.1)
       coffee-script (>= 2.2.0)
@@ -61,7 +60,6 @@ GEM
       coffee-script-source
       execjs
     coffee-script-source (1.9.1)
-    connection_pool (2.1.3)
     diff-lcs (1.2.5)
     erubis (2.7.0)
     execjs (2.3.0)

data/example/rails_app/config/initializers/rabbit_feed.rb

@@ -1,3 +1,6 @@
+RabbitFeed.log = Logger.new('log/rabbit_feed.log')
+RabbitFeed.log.formatter = RabbitFeed::JsonLogFormatter
+
 EventDefinitions do
   define_event('user_creates_beaver', version: '1.0.0') do
     defined_as do

data/example/rails_app/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'rabbit_feed'
+require 'logger'
+
 RSpec.configure do |config|
 
   # Run specs in random order to surface order dependencies. If you find an
@@ -6,3 +9,6 @@ RSpec.configure do |config|
   #     --seed 1234
   config.order = 'random'
 end
+
+RabbitFeed.log = Logger.new('log/rabbit_feed.log')
+RabbitFeed.log.formatter = RabbitFeed::JsonLogFormatter

data/lib/rabbit_feed/client.rb

@@ -86,8 +86,9 @@ module RabbitFeed
     end
 
     def set_logging
-      RabbitFeed.log       = Logger.new(options[:logfile])
-      RabbitFeed.log.level = verbose? ? Logger::DEBUG : Logger::INFO
+      RabbitFeed.log           = Logger.new options[:logfile]
+      RabbitFeed.log.level     = verbose? ? Logger::DEBUG : Logger::INFO
+      RabbitFeed.log.formatter = RabbitFeed::JsonLogFormatter
     end
 
     def set_configuration

data/lib/rabbit_feed/configuration.rb

@@ -2,19 +2,18 @@ module RabbitFeed
   class Configuration
     include ActiveModel::Validations
 
-    attr_reader :host, :hosts, :port, :user, :password, :application, :environment, :exchange, :pool_size, :pool_timeout, :heartbeat, :connect_timeout, :network_recovery_interval, :auto_delete_queue, :auto_delete_exchange
-    validates_presence_of :application, :environment, :exchange, :pool_timeout
+    attr_reader :host, :hosts, :port, :user, :password, :application, :environment, :exchange, :heartbeat, :connect_timeout, :network_recovery_interval, :auto_delete_queue, :auto_delete_exchange
+    validates_presence_of :application, :environment, :exchange
 
     def initialize options
-      RabbitFeed.log.debug "RabbitFeed initialising with options: #{options}..."
+      RabbitFeed.log.info {{ event: :initialize_configuration, options: options.merge({password: :redacted}) }}
 
       @host                      = options[:host]
       @hosts                     = options[:hosts]
       @port                      = options[:port]
       @user                      = options[:user]
       @password                  = options[:password]
-      @exchange                  = options[:exchange]     || 'amq.topic'
-      @pool_timeout              = options[:pool_timeout] || 120
+      @exchange                  = options[:exchange] || 'amq.topic'
       @heartbeat                 = options[:heartbeat]
       @connect_timeout           = options[:connect_timeout]
       @network_recovery_interval = options[:network_recovery_interval]
@@ -26,7 +25,7 @@ module RabbitFeed
     end
 
     def self.load file_path, environment, application
-      RabbitFeed.log.debug "Reading configurations from #{file_path} in #{environment} for application #{application}..."
+      RabbitFeed.log.info {{ event: :load_configuration_file, file_path: file_path, environment: environment, application: application }}
 
       raise ConfigurationError.new "The RabbitFeed configuration file path specified does not exist: #{file_path}" unless (File.exist? file_path)
 

data/lib/rabbit_feed/connection.rb

@@ -0,0 +1,28 @@
+module RabbitFeed
+  class Connection
+    include Singleton
+
+    def initialize
+      RabbitFeed.log.info {{ event: :connecting_to_rabbitmq, options: RabbitFeed.configuration.connection_options.merge({password: :redacted, logger: :redacted}) }}
+      @connection = Bunny.new RabbitFeed.configuration.connection_options
+      @connection.start
+      RabbitFeed.log.info {{ event: :connected_to_rabbitmq }}
+      @channel = @connection.create_channel
+      @mutex = Mutex.new
+    end
+
+    private
+
+    attr_reader :channel, :mutex
+
+    def synchronized &block
+      mutex.synchronize do
+        yield
+      end
+    end
+
+    def connection_in_use?
+      mutex.locked?
+    end
+  end
+end

data/lib/rabbit_feed/consumer.rb

@@ -5,9 +5,11 @@ module RabbitFeed
     attr_accessor :event_routing
 
     def run
-      ConsumerConnection.consume do |raw_event|
+      ConsumerConnection.instance.consume do |raw_event|
         event = Event.deserialize raw_event
+        RabbitFeed.log.info {{ event: :message_received, metadata: event.metadata }}
         event_routing.handle_event event
+        RabbitFeed.log.info {{ event: :message_processed, metadata: event.metadata }}
       end
     end
   end

data/lib/rabbit_feed/consumer_connection.rb

@@ -1,6 +1,5 @@
 module RabbitFeed
-  class ConsumerConnection
-    include ConnectionConcern
+  class ConsumerConnection < RabbitFeed::Connection
 
     SUBSCRIPTION_OPTIONS = {
       consumer_tag: Socket.gethostname, # Use the host name of the server
@@ -19,37 +18,37 @@ module RabbitFeed
         },
     }.freeze
 
-    attr_reader :queue
-
-    def initialize channel
-      channel.prefetch(1) # Fetch one message at a time to preserve order
-      RabbitFeed.log.debug "Declaring queue on #{self.to_s} (channel #{channel.id}) named: #{RabbitFeed.configuration.queue} with options: #{queue_options}..."
+    def initialize
+      super
+      channel.prefetch(1)
       @queue = channel.queue RabbitFeed.configuration.queue, queue_options
+      RabbitFeed.log.info {{ event: :queue_declared, queue: RabbitFeed.configuration.queue, options: queue_options }}
       bind_on_accepted_routes
     end
 
-    def self.consume &block
-      with_connection do |consumer_connection|
-        consumer_connection.consume(&block)
-      end
-    end
-
     def consume &block
-      RabbitFeed.log.info "Consuming messages on #{self.to_s} from queue: #{RabbitFeed.configuration.queue}..."
-
-      consumer = queue.subscribe(SUBSCRIPTION_OPTIONS) do |delivery_info, properties, payload|
-        handle_message delivery_info, payload, &block
+      raise 'This connection already has a consumer subscribed' if connection_in_use?
+      synchronized do
+        begin
+          RabbitFeed.log.info {{ event: :subscribe_to_queue, queue: RabbitFeed.configuration.queue }}
+
+          consumer = queue.subscribe(SUBSCRIPTION_OPTIONS) do |delivery_info, properties, payload|
+            handle_message delivery_info, payload, &block
+          end
+
+          sleep # Sleep indefinitely, as the consumer runs in its own thread
+        rescue SystemExit, Interrupt
+          RabbitFeed.log.info {{ event: :unsubscribe_from_queue, queue: RabbitFeed.configuration.queue }}
+        ensure
+          (cancel_consumer consumer) if consumer.present?
+        end
       end
-
-      sleep # Sleep indefinitely, as the consumer runs in its own thread
-    rescue SystemExit, Interrupt
-      RabbitFeed.log.info "Consumer #{self.to_s} received exit request, exiting..."
-    ensure
-      (cancel_consumer consumer) if consumer.present?
     end
 
     private
 
+    attr_reader :queue
+
     def queue_options
       {
         auto_delete: RabbitFeed.configuration.auto_delete_queue,
@@ -60,20 +59,21 @@ module RabbitFeed
       if RabbitFeed::Consumer.event_routing.present?
         RabbitFeed::Consumer.event_routing.accepted_routes.each do |accepted_route|
           queue.bind(RabbitFeed.configuration.exchange, { routing_key: accepted_route })
+          RabbitFeed.log.info {{ event: :queue_bound, queue: RabbitFeed.configuration.queue, exchange: RabbitFeed.configuration.exchange, routing_key: accepted_route }}
         end
       else
         queue.bind(RabbitFeed.configuration.exchange)
+        RabbitFeed.log.info {{ event: :queue_bound, queue: RabbitFeed.configuration.queue, exchange: RabbitFeed.configuration.exchange }}
       end
     end
 
     def acknowledge delivery_info
       queue.channel.ack(delivery_info.delivery_tag)
-      RabbitFeed.log.debug "Message acknowledged on #{self.to_s} from queue: #{RabbitFeed.configuration.queue}..."
+      RabbitFeed.log.debug {{ event: :acknowledge, delivery_tag: delivery_info.delivery_tag }}
     end
 
     def handle_message delivery_info, payload, &block
-      RabbitFeed.log.debug "Message received on #{self.to_s} from queue: #{RabbitFeed.configuration.queue}..."
-
+      RabbitFeed.log.debug {{ event: :handling_message, delivery_tag: delivery_info.delivery_tag }}
       begin
         yield payload
         acknowledge delivery_info
@@ -84,19 +84,19 @@ module RabbitFeed
 
     def cancel_consumer consumer
       cancel_ok = consumer.cancel
-      RabbitFeed.log.debug "Consumer: #{cancel_ok.consumer_tag} cancelled on #{self.to_s} from queue: #{RabbitFeed.configuration.queue}..."
+      RabbitFeed.log.debug {{ event: :consumer_cancelled, status: cancel_ok, queue: RabbitFeed.configuration.queue }}
     end
 
     def negative_acknowledge delivery_info
       # Tell rabbit that we were unable to process the message
       # This will re-queue the message
       queue.channel.nack(delivery_info.delivery_tag, false, true)
-      RabbitFeed.log.debug "Message negatively acknowledged on #{self.to_s} from queue: #{RabbitFeed.configuration.queue}..."
+      RabbitFeed.log.debug {{ event: :negative_acknowledge, delivery_tag: delivery_info.delivery_tag }}
     end
 
     def handle_processing_exception delivery_info, exception
       negative_acknowledge delivery_info
-      RabbitFeed.log.error "Exception encountered while consuming message on #{self.to_s} from queue #{RabbitFeed.configuration.queue}: #{exception.message} #{exception.backtrace}"
+      RabbitFeed.log.error {{ event: :processing_exception, delivery_tag: delivery_info.delivery_tag, message: exception.message, backtrace: exception.backtrace.join(',') }}
       RabbitFeed.exception_notify exception
     end
   end

data/lib/rabbit_feed/json_log_formatter.rb

@@ -0,0 +1,12 @@
+module RabbitFeed
+  class JsonLogFormatter < Logger::Formatter
+    def self.call(severity, time, progname, msg)
+      {
+        severity: severity,
+        time: time.utc.iso8601(6),
+        progname: progname,
+        message: msg,
+      }.to_json + "\n"
+    end
+  end
+end

data/lib/rabbit_feed/producer.rb

@@ -10,7 +10,9 @@ module RabbitFeed
       timestamp        = Time.now.utc
       metadata         = (metadata event_definition.version, name, timestamp)
       event            = Event.new metadata, payload, event_definition.schema, event_definition.sensitive_fields
-      ProducerConnection.publish event.serialize, (options name, timestamp)
+      RabbitFeed.log.info {{ event: :publish_start, metadata: event.metadata }}
+      ProducerConnection.instance.publish event.serialize, (options name, timestamp)
+      RabbitFeed.log.info {{ event: :publish_end, metadata: event.metadata }}
       event
     end
 

data/lib/rabbit_feed/producer_connection.rb

@@ -1,6 +1,5 @@
 module RabbitFeed
-  class ProducerConnection
-    include ConnectionConcern
+  class ProducerConnection < RabbitFeed::Connection
 
     PUBLISH_OPTIONS = {
       persistent: true, # Persist the message to disk
@@ -13,53 +12,36 @@ module RabbitFeed
       no_declare:  false,  # Create the exchange if it does not exist
     }.freeze
 
-    attr_reader :exchange
-
     def self.handle_returned_message return_info, content
-      RabbitFeed.log.error "Handling returned message on #{self.to_s} details: #{return_info}..."
+      RabbitFeed.log.error {{ event: :returned_message, return_info: return_info }}
       RabbitFeed.exception_notify (ReturnedMessageError.new return_info)
     end
 
-    def initialize channel
-      RabbitFeed.log.debug "Declaring exchange on #{self.to_s} (channel #{channel.id}) named: #{RabbitFeed.configuration.exchange} with options: #{exchange_options}..."
+    def initialize
+      super
       @exchange = channel.exchange RabbitFeed.configuration.exchange, exchange_options
-
+      RabbitFeed.log.info {{ event: :exchange_declared, exchange: RabbitFeed.configuration.exchange, options: exchange_options }}
       exchange.on_return do |return_info, properties, content|
         RabbitFeed::ProducerConnection.handle_returned_message return_info, content
       end
     end
 
-    def self.publish message, options
-      retry_on_closed_connection do
-        with_connection do |producer_connection|
-          retry_on_exception do
-            producer_connection.publish message, options
-          end
-        end
-      end
-    end
-
     def publish message, options
-      # It's critical to dup the options for the sake of retries, as bunny modifies this hash
-      bunny_options = (options.merge PUBLISH_OPTIONS)
-
-      RabbitFeed.log.debug "Publishing message on #{self.to_s} with options: #{options} to exchange: #{RabbitFeed.configuration.exchange}..."
-
-      exchange.publish message, bunny_options
+      synchronized do
+        bunny_options = (options.merge PUBLISH_OPTIONS)
+        RabbitFeed.log.debug {{ event: :publish, options: options, exchange: RabbitFeed.configuration.exchange }}
+        exchange.publish message, bunny_options
+      end
     end
 
     private
 
+    attr_reader :exchange
+
     def exchange_options
       {
         auto_delete: RabbitFeed.configuration.auto_delete_exchange,
       }.merge EXCHANGE_OPTIONS
     end
-
-    def self.connection_options
-      super.merge({
-        threaded: false, # With threading enabled, there is a chance of losing an event during connection recovery
-      })
-    end
   end
 end

data/lib/rabbit_feed/testing_support.rb

@@ -18,7 +18,7 @@ module RabbitFeed
 
         TestingSupport.published_events = []
 
-        allow(RabbitFeed::ProducerConnection).to receive(:publish) do |serialized_event, routing_key|
+        allow(RabbitFeed::ProducerConnection.instance).to receive(:publish) do |serialized_event, routing_key|
           TestingSupport.published_events << (Event.deserialize serialized_event)
         end
       end

data/lib/rabbit_feed/version.rb

@@ -1,3 +1,3 @@
 module RabbitFeed
-  VERSION = '2.1.5'
+  VERSION = '2.3.0'
 end

data/lib/rabbit_feed.rb

@@ -2,14 +2,13 @@ require 'active_support/all'
 require 'active_model'
 require 'avro'
 require 'bunny'
-require 'connection_pool'
 require 'yaml'
 require_relative './dsl'
 require 'rabbit_feed/version'
 require 'rabbit_feed/client'
 require 'rabbit_feed/configuration'
-require 'rabbit_feed/connection_concern'
 require 'rabbit_feed/event'
+require 'rabbit_feed/connection'
 require 'rabbit_feed/consumer_connection'
 require 'rabbit_feed/consumer'
 require 'rabbit_feed/event_routing'
@@ -18,6 +17,7 @@ require 'rabbit_feed/producer'
 require 'rabbit_feed/event_definitions'
 require 'rabbit_feed/testing_support'
 require 'rabbit_feed/version'
+require 'rabbit_feed/json_log_formatter'
 
 module RabbitFeed
   extend self

data/rabbit_feed.gemspec

@@ -19,13 +19,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Gem for interfacing with RabbitMq
-  spec.add_dependency 'bunny', '>= 1.1.9', '< 1.8.0'
+  spec.add_dependency 'bunny', '2.0.0.rc2'
   # We use some helpers from ActiveSupport
   spec.add_dependency 'activesupport', '>= 3.2.0', '< 5.0.0'
   # We use validations from ActiveModel
   spec.add_dependency 'activemodel', '>= 3.2.0', '< 5.0.0'
-  # Provides connection pooling for the producer connections
-  spec.add_dependency 'connection_pool', '< 2.2.0'
   # Manages process pidfile
   spec.add_dependency 'pidfile'
   # Schema definitions and serialization for events

data/spec/features/connectivity.feature

@@ -1,3 +1,4 @@
+@connectivity
 Feature:
   As a developer
   I want to be able to publish and consume events
@@ -6,8 +7,5 @@ Scenario: I can publish and consume events
   Given I am consuming
    When I publish an event
    Then I receive that event
-
-Scenario: When an event cannot be consumed it remains on the queue
-  Given I am consuming
    When I publish an event that cannot be processed by the consumer
    Then the event remains on the queue

data/spec/features/step_definitions/connectivity_steps.rb

@@ -2,12 +2,12 @@ require 'spec_helper'
 
 step 'I am consuming' do
   set_event_routing
-  initialize_queue
+  set_event_definitions
+  RabbitFeed::ConsumerConnection.instance # Bind the queue
   @consumer_thread = Thread.new{ RabbitFeed::Consumer.run }
 end
 
 step 'I publish an event' do
-  set_event_definitions
   publish 'test'
 end
 
@@ -17,7 +17,6 @@ step 'I receive that event' do
 end
 
 step 'I publish an event that cannot be processed by the consumer' do
-  set_event_definitions
   publish 'test_failure'
 end
 
@@ -29,11 +28,6 @@ end
 
 module Turnip::Steps
 
-  def initialize_queue
-    RabbitFeed::ProducerConnection.with_connection{|connection|}
-    RabbitFeed::ConsumerConnection.with_connection{|connection|}
-  end
-
   def publish event_name
     @event_text = "#{event_name}_#{Time.now.iso8601(6)}"
     RabbitFeed::Producer.publish_event event_name, { 'field' => @event_text }
@@ -46,7 +40,7 @@ module Turnip::Steps
 
   def wait_for_event
     begin
-      Timeout::timeout(5.0) do
+      Timeout::timeout(2.0) do
         until @consumed_events.any? do
           sleep 0.1
         end

data/spec/fixtures/configuration.yml

@@ -1,11 +1,17 @@
 test:
+  host: localhost
+  port: 5672
+  user: guest
+  password: guest
+  application: rabbit_feed
+  auto_delete_queue: true
+test_config:
   host: localhost
   port: 5672
   user: guest
   password: guest
   application: rabbit_feed
   exchange: rabbit_feed_exchange
-  pool_timeout: 1
   heartbeat: 60
   connect_timeout: 1
   network_recovery_interval: 0.1

data/spec/lib/rabbit_feed/configuration_spec.rb

@@ -68,7 +68,7 @@ module RabbitFeed
 
     describe '.load' do
       let(:file_path)   { 'spec/fixtures/configuration.yml' }
-      let(:environment) { 'test' }
+      let(:environment) { 'test_config' }
       let(:application) { }
       subject { described_class.load file_path, environment, application }
 
@@ -95,9 +95,8 @@ module RabbitFeed
         its(:user)                      { should eq 'guest' }
         its(:password)                  { should eq 'guest' }
         its(:application)               { should eq 'rabbit_feed' }
-        its(:environment)               { should eq 'test' }
+        its(:environment)               { should eq 'test_config' }
         its(:exchange)                  { should eq 'rabbit_feed_exchange' }
-        its(:pool_timeout)              { should eq 1 }
         its(:heartbeat)                 { should eq 60 }
         its(:connect_timeout)           { should eq 1 }
         its(:network_recovery_interval) { should eq 0.1 }
@@ -142,7 +141,6 @@ module RabbitFeed
         its(:heartbeat)                 { should be_nil }
         its(:network_recovery_interval) { should be_nil }
         its(:exchange)                  { should eq 'amq.topic' }
-        its(:pool_timeout)              { should eq 120 }
         its(:connect_timeout)           { should be_nil }
         its(:auto_delete_queue)         { should be_falsey }
         its(:auto_delete_exchange)      { should be_falsey }
@@ -159,7 +157,6 @@ module RabbitFeed
             application:               'rabbit_feed',
             environment:               'test',
             exchange:                  'exchange_name',
-            pool_timeout:              6,
             heartbeat:                 3,
             connect_timeout:           4,
             network_recovery_interval: 2,
@@ -176,7 +173,6 @@ module RabbitFeed
         its(:application)               { should eq 'rabbit_feed' }
         its(:environment)               { should eq 'test' }
         its(:exchange)                  { should eq 'exchange_name' }
-        its(:pool_timeout)              { should eq 6 }
         its(:heartbeat)                 { should eq 3 }
         its(:connect_timeout)           { should eq 4 }
         its(:network_recovery_interval) { should eq 2 }

data/spec/lib/rabbit_feed/consumer_connection_spec.rb

@@ -9,7 +9,9 @@ module RabbitFeed
       allow(Bunny).to receive(:new).and_return(bunny_connection)
       allow(bunny_queue).to receive(:channel).and_return(bunny_channel)
     end
-    subject{ described_class.new bunny_channel }
+    subject do
+      Class.new(described_class).instance
+    end
 
     describe '#new' do
       before do
@@ -21,27 +23,16 @@ module RabbitFeed
       end
 
       it 'binds the queue to the exchange' do
-        expect(bunny_queue).to receive(:bind).with('rabbit_feed_exchange', { routing_key: 'test.rabbit_feed.test'})
+        expect(bunny_queue).to receive(:bind).with('amq.topic', { routing_key: 'test.rabbit_feed.test'})
         subject
       end
 
-      it 'assigns the queue' do
-        expect(subject.queue).to eq bunny_queue
-      end
-
       it 'preserves message order' do
         expect(bunny_channel).to receive(:prefetch).with(1)
         subject
       end
     end
 
-    describe '#connection_options' do
-
-      it 'uses a threaded connection' do
-        expect(described_class.connection_options).to include(threaded: true)
-      end
-    end
-
     describe '#consume' do
       before do
         allow(bunny_queue).to receive(:subscribe).and_yield(double(:delivery_info, delivery_tag: :tag), 'properties', 'payload')
@@ -58,11 +49,24 @@ module RabbitFeed
         subject.consume { }
       end
 
+      it 'is synchronized' do
+        expect(subject).to receive(:synchronized).and_call_original
+        subject.consume { }
+      end
+
       it 'cancels the consumer' do
         expect_any_instance_of(described_class).to receive(:cancel_consumer)
         subject.consume { }
       end
 
+      context 'when consuming' do
+        before { allow(subject.send(:mutex)).to receive(:locked?).and_return(true) }
+
+        it 'raises when attempting to consume in parallel' do
+          expect{ subject.consume { } }.to raise_error 'This connection already has a consumer subscribed'
+        end
+      end
+
       context 'when an exception is raised' do
 
         context 'when Airbrake is defined' do

data/spec/lib/rabbit_feed/producer_connection_spec.rb

@@ -9,7 +9,7 @@ module RabbitFeed
       allow(Bunny).to receive(:new).and_return(bunny_connection)
     end
     subject do
-      described_class.new bunny_channel
+      Class.new(described_class).instance
     end
 
     describe '#new' do
@@ -18,10 +18,6 @@ module RabbitFeed
         expect(bunny_exchange).to receive(:on_return).and_yield('return_info', 'properties', 'content')
         subject
       end
-
-      it 'assigns the exchange' do
-        expect(subject.exchange).to eq bunny_exchange
-      end
     end
 
     describe '#handle_returned_message' do
@@ -42,30 +38,18 @@ module RabbitFeed
       end
     end
 
-    describe '#connection_options' do
-
-      it 'does not use a threaded connection' do
-        expect(described_class.connection_options).to include(threaded: false)
-      end
-    end
-
     describe '#publish' do
       let(:message) { 'the message' }
       let(:options) { {routing_key: 'routing_key'} }
 
       it 'publishes the message as mandatory and persistent' do
         expect(bunny_exchange).to receive(:publish).with(message, { persistent: true, mandatory: true, routing_key: 'routing_key' })
-        described_class.publish message, options
-      end
-
-      it 'retries on closed connections' do
-        expect(described_class).to receive(:retry_on_closed_connection).and_call_original
-        described_class.publish message, options
+        subject.publish message, options
       end
 
-      it 'retries on exception' do
-        expect(described_class).to receive(:retry_on_exception).twice.and_call_original
-        described_class.publish message, options
+      it 'is synchronized' do
+        expect(subject).to receive(:synchronized).and_call_original
+        subject.publish message, options
       end
     end
   end

data/spec/lib/rabbit_feed/producer_spec.rb

@@ -59,7 +59,7 @@ module RabbitFeed
 
       it 'serializes the event and provides message metadata' do
         Timecop.freeze do
-          expect(ProducerConnection).to receive(:publish).with(
+          expect(ProducerConnection.instance).to receive(:publish).with(
             an_instance_of(String),
             {
               routing_key: 'test.rabbit_feed.event_name',

data/spec/spec_helper.rb

@@ -30,34 +30,18 @@ RSpec.configure do |config|
     reset_environment
   end
 
-  config.after do
-    reset_environment
-    # Ensure the consumer thread exists between tests
-    kill_consumer_thread
-    # Ensure that connections don't persist between tests
-    close_connections
-    # Clear event routing
-    RabbitFeed::Consumer.event_routing = nil
-    # Clear event definitions
-    RabbitFeed::Producer.event_definitions = nil
+  config.after(connectivity: true) do
+    Thread.kill @consumer_thread if @consumer_thread.present?
   end
 
   RabbitFeed::TestingSupport.include_support config
 end
 
-def kill_consumer_thread
-  if @consumer_thread.present?
-    Thread.kill @consumer_thread
-  end
-end
-
-def close_connections
-  RabbitFeed::ProducerConnection.close
-  RabbitFeed::ConsumerConnection.close
-end
-
 def reset_environment
-  RabbitFeed.log                     = Logger.new('test.log')
-  RabbitFeed.environment             = 'test'
-  RabbitFeed.configuration_file_path = 'spec/fixtures/configuration.yml'
+  RabbitFeed.log                         = Logger.new('test.log')
+  RabbitFeed.log.formatter               = RabbitFeed::JsonLogFormatter
+  RabbitFeed.environment                 = 'test'
+  RabbitFeed.configuration_file_path     = 'spec/fixtures/configuration.yml'
+  RabbitFeed::Consumer.event_routing     = nil
+  RabbitFeed::Producer.event_definitions = nil
 end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rabbit_feed
 version: !ruby/object:Gem::Version
-  version: 2.1.5
+  version: 2.3.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.9
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 2.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.9
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 2.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -70,20 +64,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 5.0.0
-- !ruby/object:Gem::Dependency
-  name: connection_pool
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: pidfile
   requirement: !ruby/object:Gem::Requirement
@@ -258,12 +238,13 @@ files:
 - lib/rabbit_feed.rb
 - lib/rabbit_feed/client.rb
 - lib/rabbit_feed/configuration.rb
-- lib/rabbit_feed/connection_concern.rb
+- lib/rabbit_feed/connection.rb
 - lib/rabbit_feed/consumer.rb
 - lib/rabbit_feed/consumer_connection.rb
 - lib/rabbit_feed/event.rb
 - lib/rabbit_feed/event_definitions.rb
 - lib/rabbit_feed/event_routing.rb
+- lib/rabbit_feed/json_log_formatter.rb
 - lib/rabbit_feed/producer.rb
 - lib/rabbit_feed/producer_connection.rb
 - lib/rabbit_feed/testing_support.rb
@@ -281,7 +262,6 @@ files:
 - spec/fixtures/configuration.yml
 - spec/lib/rabbit_feed/client_spec.rb
 - spec/lib/rabbit_feed/configuration_spec.rb
-- spec/lib/rabbit_feed/connection_concern_spec.rb
 - spec/lib/rabbit_feed/consumer_connection_spec.rb
 - spec/lib/rabbit_feed/event_definitions_spec.rb
 - spec/lib/rabbit_feed/event_routing_spec.rb
@@ -291,7 +271,6 @@ files:
 - spec/lib/rabbit_feed/testing_support/rspec_matchers/publish_event_spec.rb
 - spec/lib/rabbit_feed/testing_support/testing_helper_spec.rb
 - spec/spec_helper.rb
-- spec/support/shared_examples_for_connections.rb
 homepage: https://github.com/simplybusiness/rabbit_feed
 licenses:
 - MIT
@@ -323,7 +302,6 @@ test_files:
 - spec/fixtures/configuration.yml
 - spec/lib/rabbit_feed/client_spec.rb
 - spec/lib/rabbit_feed/configuration_spec.rb
-- spec/lib/rabbit_feed/connection_concern_spec.rb
 - spec/lib/rabbit_feed/consumer_connection_spec.rb
 - spec/lib/rabbit_feed/event_definitions_spec.rb
 - spec/lib/rabbit_feed/event_routing_spec.rb
@@ -333,5 +311,4 @@ test_files:
 - spec/lib/rabbit_feed/testing_support/rspec_matchers/publish_event_spec.rb
 - spec/lib/rabbit_feed/testing_support/testing_helper_spec.rb
 - spec/spec_helper.rb
-- spec/support/shared_examples_for_connections.rb
 has_rdoc: 

data/lib/rabbit_feed/connection_concern.rb

@@ -1,86 +0,0 @@
-module RabbitFeed
-  module ConnectionConcern
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-
-      def connection_options
-        RabbitFeed.configuration.connection_options
-      end
-
-      def with_connection &block
-        connection_pool.with do |connection|
-          yield connection
-        end
-      end
-
-      def retry_on_exception tries=3, &block
-        yield
-      rescue Bunny::ConnectionClosedError
-        raise # There is no point in retrying if the connection is closed
-      rescue => e
-        RabbitFeed.log.warn "Exception encountered; #{tries - 1} tries remaining. #{self.to_s}: #{e.message} #{e.backtrace}"
-        unless (tries -= 1).zero?
-          retry
-        end
-        raise
-      end
-
-      def retry_on_closed_connection tries=3, &block
-        yield
-      rescue Bunny::ConnectionClosedError => e
-        RabbitFeed.log.warn "Closed connection exception encountered; #{tries - 1} tries remaining. #{self.to_s}: #{e.message} #{e.backtrace}"
-        unless (tries -= 1).zero?
-          unset_connection
-          sleep 1
-          retry
-        end
-        raise
-      end
-
-      def close
-        RabbitFeed.log.debug "Closing connection: #{self.to_s}..."
-        @bunny_connection.close if @bunny_connection.present? && !closed?
-        unset_connection
-      rescue => e
-        RabbitFeed.log.warn "Exception encountered whilst closing #{self.to_s}: #{e.message} #{e.backtrace}"
-      end
-
-      def bunny_connection
-        if @bunny_connection.nil?
-          retry_on_exception do
-            RabbitFeed.log.debug "Opening connection: #{self.to_s}..."
-            @bunny_connection = Bunny.new connection_options
-            @bunny_connection.start
-          end
-        end
-
-        @bunny_connection
-      end
-      private :bunny_connection
-
-      def connection_pool
-        @connection_pool ||= ConnectionPool.new(
-          size:    1,
-          timeout: RabbitFeed.configuration.pool_timeout
-        ) do
-          new bunny_connection.create_channel
-        end
-      end
-      private :connection_pool
-
-      def closed?
-        @bunny_connection.present? && @bunny_connection.closed?
-      end
-      private :closed?
-
-      def unset_connection
-        RabbitFeed.log.debug "Unsetting connection: #{self.to_s}..."
-        @connection_pool  = nil
-        @bunny_connection = nil
-      end
-      private :unset_connection
-
-    end
-  end
-end

data/spec/lib/rabbit_feed/connection_concern_spec.rb

@@ -1,127 +0,0 @@
-require 'spec_helper'
-
-module RabbitFeed
-  describe ConnectionConcern do
-    let(:bunny_exchange)    { double(:bunny_exchange, on_return: nil) }
-    let(:connection_closed) { false }
-    let(:bunny_channel)     { double(:bunny_channel, exchange: bunny_exchange, id: 1) }
-    let(:bunny_connection)  { double(:bunny_connection, start: nil, closed?: connection_closed, close: nil, create_channel: bunny_channel) }
-    before { allow(Bunny).to receive(:new).and_return(bunny_connection) }
-    after do
-      subject.instance_variable_set(:@bunny_connection, nil)
-      subject.instance_variable_set(:@connection_pool, nil)
-    end
-    subject { RabbitFeed::ProducerConnection }
-
-    describe '.with_connection' do
-
-      it 'retries on exception' do
-        expect(subject).to receive(:retry_on_exception).and_call_original
-        subject.with_connection{|connection| connection }
-      end
-
-      it 'assigns the connection' do
-        subject.with_connection{|connection| connection }
-        expect(subject.instance_variable_get(:@bunny_connection)).to eq bunny_connection
-      end
-
-      it 'assigns the connection pool' do
-        subject.with_connection{|connection| connection }
-        expect(subject.instance_variable_get(:@connection_pool)).to be_a ConnectionPool
-      end
-
-      it 'creates a connection pool of one connection' do
-        expect(ConnectionPool).to receive(:new).with(hash_including({size: 1})).and_call_original
-        subject.with_connection{|connection| connection }
-      end
-
-      it 'provides an instance of the class' do
-        actual = subject.with_connection{|connection| connection }
-        expect(actual).to be_a subject
-      end
-    end
-
-    describe '.close' do
-
-      context 'when the connection is nil' do
-
-        it 'does not close the connection' do
-          expect(bunny_connection).not_to receive(:close)
-          subject.close
-        end
-      end
-
-      context 'when the connection is not nil' do
-        before do
-          subject.with_connection{|connection| connection }
-        end
-
-        context 'when the connection is closed' do
-          let(:connection_closed) { true }
-
-          it 'does not close the connection' do
-            expect(bunny_connection).not_to receive(:close)
-            subject.close
-          end
-        end
-
-        context 'when the connection is not closed' do
-          let(:connection_closed) { false }
-
-          it 'closes the connection' do
-            expect(bunny_connection).to receive(:close)
-            subject.close
-          end
-
-          context 'when closing raises an exception' do
-
-            it 'does not propogate the exception' do
-              allow(bunny_connection).to receive(:close).and_raise 'error'
-              expect{ subject.close }.not_to raise_error
-            end
-          end
-        end
-
-        it 'unsets the connection' do
-          subject.close
-          expect(subject.instance_variable_get(:@bunny_connection)).to be_nil
-        end
-
-        it 'unsets the connection pool' do
-          subject.close
-          expect(subject.instance_variable_get(:@connection_pool)).to be_nil
-        end
-      end
-    end
-
-    describe '.retry_on_exception' do
-      it_behaves_like 'an operation that retries on exception', :retry_on_exception, RuntimeError
-      it_behaves_like 'an operation that does not retry on exception', :retry_on_exception, Bunny::ConnectionClosedError
-    end
-
-    describe '.retry_on_closed_connection' do
-      before do
-        subject.with_connection{|connection| connection }
-        allow(subject).to receive(:sleep).at_least(:once)
-      end
-
-      it_behaves_like 'an operation that retries on exception', :retry_on_closed_connection, Bunny::ConnectionClosedError
-      it_behaves_like 'an operation that does not retry on exception', :retry_on_closed_connection, RuntimeError
-
-      it 'unsets the connection' do
-        expect { subject.retry_on_closed_connection { raise Bunny::ConnectionClosedError.new 'blah' } }.to raise_error
-        expect(subject.instance_variable_get(:@bunny_connection)).to be_nil
-      end
-
-      it 'unsets the connection pool' do
-        expect { subject.retry_on_closed_connection { raise Bunny::ConnectionClosedError.new 'blah' } }.to raise_error
-        expect(subject.instance_variable_get(:@connection_pool)).to be_nil
-      end
-
-      it 'waits between retries' do
-        expect(subject).to receive(:sleep).with(1).twice
-        begin; subject.retry_on_closed_connection { raise Bunny::ConnectionClosedError.new 'blah' }; rescue; end
-      end
-    end
-  end
-end

data/spec/support/shared_examples_for_connections.rb

@@ -1,40 +0,0 @@
-RSpec.shared_examples 'an operation that retries on exception' do |operation, exception_class|
-
-  context 'less than three times' do
-
-    it 'traps the exception' do
-      tries = 0
-      expect do
-        subject.send(operation) do
-          (tries += 1) < 3 ? (raise exception_class.new 'blah') : nil
-        end
-      end.to_not raise_error
-    end
-  end
-
-  context 'three or more times' do
-
-    it 'raises the exception' do
-      tries = 0
-      expect do
-        subject.send(operation) do
-          tries += 1
-          raise exception_class.new 'blah'
-        end
-      end.to raise_error exception_class
-      expect(tries).to eq 3
-    end
-  end
-end
-
-RSpec.shared_examples 'an operation that does not retry on exception' do |operation, exception_class|
-
-  it 'does not retry when the error is received' do
-      tries = 0
-      expect do
-        subject.send(operation) do
-          (tries += 1) < 3 ? (raise exception_class.new 'blah') : nil
-        end
-      end.to raise_error
-  end
-end