songkick_queue 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75d2f489f41e935f1c16ef27861a7d9044472eb5
-  data.tar.gz: d154004c62f76f7a99cff3841fbccaf863930c8e
+  metadata.gz: 8b51761dcb720a861e59cd35370dd964fbb0393e
+  data.tar.gz: fdcf57c99fa12a9e9e3dbfc9a4c83b8a765486ce
 SHA512:
-  metadata.gz: 815d1add90cd8a2d5adc0922babfb3de115d098ee0d86f45d77fc6c92b1e996da766c8ecb244cd22939976581dcb70490d493cec53b433b18dbd6d115334570d
-  data.tar.gz: 19f0a0f9f4a7dc0f145df5b21f6a96e0fa5ddf1c8e1194fb6810a40878f7e990847fcd3220e5d097d74d6fb3ca7ce37ca4e45281ca9bdd67ef76f12b592e32a6
+  metadata.gz: 78d96fe086dfe7afc88548bdfcae4237ecc8fccc95d6d28d24e643b21c058cfd3eb99b8bf49c4e20bff89770763257ace02c56dc672c7d8c6c900f3ea519fabc
+  data.tar.gz: feb0f64206f09160396154611dd732c8327b86f146d82afae897719ae90e097cb9634d008999b17dc3985eef57be9596c0190d7bc979a9467c8d169e9dcd7251

data/README.md

@@ -40,6 +40,8 @@ SongkickQueue.configure do |config|
   config.username = 'guest'
   config.password = 'guest'
   config.vhost = '/'
+  config.max_reconnect_attempts = 10
+  config.network_recovery_interval = 1.0
 end
 ```
 

data/examples/{environment.rb → consumer.rb}

@@ -1,7 +1,7 @@
-# Example environment file
+# Example consumer
 # Require this file when running `songkick_queue` like so:
 #
-#   $ bin/songkick_queue --require ./examples/environment.rb --consumer TweetConsumer
+#   $ bin/songkick_queue --require ./examples/consumer.rb --consumer TweetConsumer
 #
 require_relative '../lib/songkick_queue'
 

data/examples/producer.rb

@@ -1,3 +1,8 @@
+# Example producer
+# Run this file like so:
+#
+#   $ bundle exec ruby examples/producer.rb
+#
 require_relative '../lib/songkick_queue'
 
 SongkickQueue.configure do |config|

data/lib/songkick_queue.rb

@@ -18,18 +18,22 @@ module SongkickQueue
     :username,
     :password,
     :vhost,
+    :max_reconnect_attempts,
+    :network_recovery_interval,
   )
 
-  ConfigurationError = Class.new(StandardError)
+  TooManyReconnectAttemptsError = Class.new(StandardError)
 
   # Retrieve configuration for SongkickQueue
   #
   # @return [Configuration]
   def self.configuration
-    @configuration ||= Configuration.new(
-      logger: Logger.new(STDOUT),
-      port: 5672,
-    )
+    @configuration ||= Configuration.new.tap do |config|
+      config.logger = Logger.new(STDOUT)
+      config.port = 5672
+      config.max_reconnect_attempts = 10
+      config.network_recovery_interval = 1.0
+    end
   end
 
   # Yields a block, passing the memoized configuration instance

data/lib/songkick_queue/client.rb

@@ -8,36 +8,43 @@ module SongkickQueue
     #
     # @return [Bunny::Channel]
     def channel
-      @channel ||= begin
-        channel = connection.create_channel
-        channel.prefetch(1)
-
-        channel
-      end
+      @channel ||= build_channel
     end
 
     # Creates a memoized connection to RabbitMQ
     #
     # @return [Bunny::Session]
     def connection
-      @connection ||= begin
-        connection = Bunny.new(
-          host: config.host,
-          port: config.port,
-          username: config.username,
-          password: config.password,
-          vhost: config.vhost,
-          heartbeat_interval: 60,
-        )
-
-        connection.start
-
-        connection
-      end
+      @connection ||= build_connection
     end
 
     private
 
+    def build_channel
+      channel = connection.create_channel
+      channel.prefetch(1)
+
+      channel
+    end
+
+    def build_connection
+      connection = Bunny.new(
+        host: config.host,
+        port: config.port,
+        username: config.username,
+        password: config.password,
+        vhost: config.vhost,
+        heartbeat_interval: 10,
+        automatically_recover: true,
+        network_recovery_interval: config.network_recovery_interval,
+        recover_from_connection_close: true,
+      )
+
+      connection.start
+
+      connection
+    end
+
     def config
       SongkickQueue.configuration
     end

data/lib/songkick_queue/producer.rb

@@ -1,16 +1,23 @@
 module SongkickQueue
   class Producer
+    attr_accessor :reconnect_attempts
+
     def initialize
       @client = Client.new
+      @reconnect_attempts = 0
+      @publish_reconnect_delay = 5.0
     end
 
-    # Serializes the given message and publishes it to the default RabbitMQ
-    # exchange
+    # Serializes the given message and publishes it to the default RabbitMQ exchange
     #
     # @param queue_name [String] to publish to
     # @param message [#to_json] to serialize and enqueue
     # @option options [String] :message_id to pass through to the consumer (will be logged)
     # @option options [String] :produced_at time when the message was created, ISO8601 formatted
+    #
+    # @raise [TooManyReconnectAttemptsError] if max reconnect attempts is exceeded
+    #
+    # @return [Bunny::Exchange]
     def publish(queue_name, payload, options = {})
       message_id = options.fetch(:message_id) { SecureRandom.hex(6) }
       produced_at = options.fetch(:produced_at) { Time.now.utc.iso8601 }
@@ -23,26 +30,55 @@ module SongkickQueue
 
       message = JSON.generate(message)
 
-      client
+      exchange = client
         .default_exchange
         .publish(message, routing_key: String(queue_name))
 
       logger.info "Published message #{message_id} to '#{queue_name}' at #{produced_at}"
+
+      exchange
+    rescue Bunny::ConnectionClosedError
+      self.reconnect_attempts += 1
+
+      if (reconnect_attempts > config.max_reconnect_attempts)
+        fail TooManyReconnectAttemptsError, "Attempted to reconnect more than " +
+          "#{config.max_reconnect_attempts} times"
+      end
+
+      logger.info "Attempting to reconnect to RabbitMQ, attempt #{reconnect_attempts} " +
+        "of #{config.max_reconnect_attempts}"
+
+      wait_for_bunny_session_to_reconnect
+
+      retry
     end
 
     private
 
-    # Retrieve the logger defined in the configuration
+    # When retrying publishing of a message after a ConnectionClosedError, we must first wait for
+    # the defined network_recovery_interval and then a bit longer for it to reopen connections and
+    # channels etc...
+    #
+    # If we attempt to publish again before the connection has been reopened we'll catch the
+    # Bunny::ConnectionClosedError exception again and just use another attempt to try and connect.
     #
-    # @raise [ConfigurationError] if not defined
+    # @todo Optimize this to know when the connection is open again, rather than picking an
+    # arbitary time period.
+    #
+    # @return [void]
+    def wait_for_bunny_session_to_reconnect
+      wait_time = config.network_recovery_interval + publish_reconnect_delay
+      sleep wait_time
+    end
+
     def logger
-      config.logger || fail(ConfigurationError, 'No logger configured, see README for more details')
+      config.logger
     end
 
     def config
       SongkickQueue.configuration
     end
 
-    attr_reader :client
+    attr_reader :client, :publish_reconnect_delay
   end
 end

data/lib/songkick_queue/version.rb

@@ -1,3 +1,3 @@
 module SongkickQueue
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/songkick_queue/worker.rb

@@ -103,11 +103,8 @@ module SongkickQueue
       client.channel
     end
 
-    # Retrieve the logger defined in the configuration
-    #
-    # @raise [ConfigurationError] if not defined
     def logger
-      config.logger || fail(ConfigurationError, 'No logger configured, see README for more details')
+      config.logger
     end
 
     def config

data/spec/songkick_queue/producer_spec.rb

@@ -1,3 +1,4 @@
+require 'songkick_queue'
 require 'songkick_queue/producer'
 
 module SongkickQueue
@@ -23,6 +24,28 @@ module SongkickQueue
         producer.publish(:queue_name, { example: 'message', value: true },
           message_id: '92c583bdc248', produced_at: '2015-03-30T15:41:55Z')
       end
+
+      it "should retry when publishing fails" do
+        producer = Producer.new
+
+        exchange = double(:exchange, publish: :published)
+        allow(exchange).to receive(:publish) { raise Bunny::ConnectionClosedError, 'test' }
+        client = instance_double(Client, default_exchange: exchange)
+        allow(producer).to receive(:client) { client }
+
+        logger = double(:logger, info: true)
+        allow(producer).to receive(:logger) { logger }
+
+        allow(producer).to receive(:wait_for_bunny_session_to_reconnect) { true }
+
+        config = double(:config, max_reconnect_attempts: 2)
+        allow(producer).to receive(:config) { config }
+
+        expect { producer.publish(:queue_name, { example: 'message', value: true }) }.to(
+          raise_error(TooManyReconnectAttemptsError, 'Attempted to reconnect more than 2 times'))
+
+        expect(producer.reconnect_attempts).to eq 3
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: songkick_queue
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Dan Lucraft
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -100,7 +100,7 @@ files:
 - README.md
 - Rakefile
 - bin/songkick_queue
-- examples/environment.rb
+- examples/consumer.rb
 - examples/producer.rb
 - lib/songkick_queue.rb
 - lib/songkick_queue/cli.rb