klomp 0.0.3 → 0.0.4

data/ChangeLog.md

@@ -1,6 +1,12 @@
 Changes
 --------------------------------------------------------------------------------
 
+0.0.4 (2012/6/22)
+================================================================================
+
+- Add fibonacci-based retry/reconnect back-off logic
+- Add generated UUID message IDs to every message (and log them)
+
 0.0.3 (2012/6/21)
 ================================================================================
 

data/Gemfile

@@ -1,8 +1,9 @@
 source "http://rubygems.org"
 
-gem "onstomp"
+gem "onstomp", "~> 1.0.7"
 # gem 'onstomp', :path => '../onstomp'
 gem "json"
+gem "uuid", "~> 2.3.5"
 
 group :development do
   gem "foreman"

data/Gemfile.lock

@@ -5,9 +5,14 @@ GEM
     foreman (0.46.0)
       thor (>= 0.13.6)
     json (1.7.1)
+    macaddr (1.6.1)
+      systemu (~> 2.5.0)
     onstomp (1.0.7)
     rake (0.9.2.2)
+    systemu (2.5.1)
     thor (0.15.2)
+    uuid (2.3.5)
+      macaddr (~> 1.0)
 
 PLATFORMS
   ruby
@@ -16,5 +21,6 @@ DEPENDENCIES
   ZenTest
   foreman
   json
-  onstomp
+  onstomp (~> 1.0.7)
   rake
+  uuid (~> 2.3.5)

data/README.md

@@ -36,6 +36,21 @@ manages connections. For example, while the `connected?` method normally
 returns a boolean value, Klomp's `connected?` will return an array of booleans
 (i.e. one result for each broker).
 
+### Fibonacci back-off retry behavior
+
+The OnStomp failover client takes `:retry_attempts` and `:retry_delay` options,
+and Klomp supports these too. However, if you do not specify either of these
+values, Klomp's default behavior will be to try to reconnect indefinitely, but
+use a fibonacci backoff approach, i.e., it will wait `fib(N)` seconds before
+trying to reconnect on the Nth attempt.
+
+### Message IDs
+
+Klomp uses the `uuid` gem to generate per-message unique identifiers. To disable
+generated message IDs, pass `:uuid => false` in the options hash. To customize
+to use your own generator, simply pass `:uuid => object` where the object you
+pass implements a `#generate` method that returns a string ID.
+
 ### Additional options for Klomp::Client
 
 <table>
@@ -59,6 +74,11 @@ returns a boolean value, Klomp's `connected?` will return an array of booleans
     <td>false</td>
     <td>Logger object</td>
   </tr>
+  <tr>
+  <td>:uuid</td>
+  <td>UUID.new</td>
+  <td>UUID generator object, responds to :generate and returns an ID</td>
+  </tr>
 </table>
 
 ## Developers

data/klomp.gemspec

@@ -17,4 +17,5 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency("onstomp", "~> 1.0.7")
   gem.add_dependency("json")
+  gem.add_dependency("uuid", "~> 2.3.5")
 end

data/lib/klomp.rb

@@ -1,5 +1,5 @@
 require 'klomp/client'
 
 module Klomp
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/klomp/client.rb

@@ -1,8 +1,14 @@
 require 'onstomp'
 require 'onstomp/failover'
 require 'json'
+require 'uuid'
 require 'logger'
 
+class OnStomp::Failover::Client
+  # Save previous N, N-1 delays for fibonacci backoff
+  attr_accessor :prev_retry_delay
+end
+
 module Klomp
 
   class Client
@@ -13,10 +19,13 @@ module Klomp
       @translate_json = options.fetch(:translate_json, true)
       @auto_reply_to  = options.fetch(:auto_reply_to, true)
       @logger         = options.fetch(:logger, nil)
+      @uuid           = options.fetch(:uuid) { UUID.new }
+
+      @fib_retry_backoff = !options.has_key?(:retry_attempts) && !options.has_key?(:retry_delay)
 
       # defaults for retry delay and attempts
-      options[:retry_delay]    ||= 2
-      options[:retry_attempts] ||= 10
+      options[:retry_delay]    ||= 1
+      options[:retry_attempts] ||= -1
 
       if uri.is_a?(Array)
         @write_conn = OnStomp::Failover::Client.new(uri, options)
@@ -46,16 +55,16 @@ module Klomp
       self
     end
 
-    def send(*args, &block)
-      if @translate_json && args[1].respond_to?(:to_json)
-        args[1] = args[1].to_json
-        args[2] ||= {}
-        args[2][:'content-type'] = 'application/json'
+    def send(dest, body, headers={}, &cb)
+      if @translate_json && body.respond_to?(:to_json)
+        body = body.to_json
+        headers[:'content-type'] = 'application/json'
       else
-        args[1] = args[1].to_s
+        body = body.to_s
       end
-      log.info("[Sending] Destination=#{args[0]} Body=#{args[1]} Headers=#{args[2]}") if log
-      @write_conn.send(*args, &block)
+      uuid = headers[:id] = @uuid.generate if @uuid
+      log.info("[Sending] ID=#{uuid} Destination=#{dest} Body=#{body.inspect} Headers=#{headers.inspect}") if log
+      @write_conn.send(dest, body, headers, &cb)
     end
     alias publish send
 
@@ -63,7 +72,7 @@ module Klomp
       frames = []
       @read_conn.each do |c|
         frames << c.subscribe(*args) do |msg|
-          log.info("[Received] Body=#{msg.body} Headers=#{msg.headers.to_hash.sort}") if log
+          log.info("[Received] ID=#{msg[:id]} Body=#{msg.body.inspect} Headers=#{msg.headers.to_hash.inspect}") if log
           if @translate_json
             msg.body = begin
               JSON.parse(msg.body)
@@ -126,6 +135,16 @@ module Klomp
     def configure_connections
       klomp_client = self
       @all_conn.each do |c|
+        if @fib_retry_backoff
+          c.before_failover_retry do |conn, attempt|
+            if attempt == 1
+              conn.prev_retry_delay, conn.retry_delay = 0, 1
+            else
+              conn.prev_retry_delay, conn.retry_delay = conn.retry_delay, conn.prev_retry_delay + conn.retry_delay
+            end
+          end
+        end
+
         c.on_failover_connect_failure do
           klomp_client.last_connect_exception = $!
         end

data/test/test_client.rb

@@ -52,15 +52,14 @@ describe Klomp::Client do
 
   it 'has a logger' do
     logger = Logger.new(STDOUT)
-    client = Klomp::Client.new(@uris, :logger=>logger).connect
-
+    client = Klomp::Client.new(@uris, :logger=>logger)
     assert_equal client.log, logger
-
-    client.disconnect
   end
 
   it 'sends heartbeat' do
-    client = Klomp::Client.new(@uris).connect.beat
+    client = Klomp::Client.new(@uris).connect
+    client.beat
+    client.disconnect
   end
 
   it 'sends requests and gets responses' do
@@ -84,7 +83,7 @@ describe Klomp::Client do
     client        = Klomp::Client.new(@uris).connect
     reply_to_body = { 'reply_to_body' => rand(36**128).to_s(36) }
 
-    client.puts(@destination, nil, { 'reply-to' => @destination })
+    client.send(@destination, nil, { 'reply-to' => @destination })
 
     got_message = false
     client.subscribe(@destination) do |msg|
@@ -114,5 +113,120 @@ describe Klomp::Client do
     client = Klomp::Client.new(@uris.first, :haz_cheezburgers => true, :retry_attempts => 42).connect
     assert client.write_conn.connected?
     assert_equal 42, client.write_conn.retry_attempts
+    client.disconnect
+  end
+
+  it 'uses a fibonacci back-off approach to reconnect' do
+    good_client = Object.new
+    def good_client.connect; true; end
+    def good_client.connected?; true; end
+    def good_client.connection; true; end
+
+    bad_client = Object.new
+    def bad_client.connect; raise "could not connect"; end
+    def bad_client.connected?; false; end
+
+    test_context = self
+    attempts = 0
+    conn = nil
+    fib = lambda {|n| (1..n).inject([0, 1]) {|fib,_| [fib[1], fib[0]+fib[1]]}.first}
+
+    pool_class = Class.new do
+      def initialize(*) end
+      def each(&blk) end
+      define_method :next_client do
+        attempts += 1
+        test_context.assert_equal fib[attempts], conn.retry_delay
+        if attempts == 6
+          good_client
+        else
+          bad_client
+        end
+      end
+    end
+
+    client = Klomp::Client.new(@uris.first, :pool => pool_class)
+    conn = client.write_conn
+    def conn.sleep_for_retry(*) end # skip sleep between retries for test
+
+    client.reconnect
+    assert_equal 6, attempts
+  end
+
+  it 'sends messages with uuids in the :id header' do
+    client = Klomp::Client.new(@uris, :translate_json => false).connect
+    client.send(@destination, '')
+
+    received_message = false
+    client.subscribe(@destination) do |msg|
+      received_message = msg
+    end
+    let_background_processor_run
+    assert received_message
+    assert received_message[:id], "message did not have an id"
+    assert received_message[:id] =~ /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
+      "message id did not look like a uuid"
+
+    client.disconnect
+  end
+
+  it 'allows customization of the uuid generator' do
+    generator = Object.new
+    def generator.generate; "42"; end
+
+    client = Klomp::Client.new(@uris, :translate_json => false, :uuid => generator).connect
+    client.send(@destination, '')
+
+    received_message = false
+    client.subscribe(@destination) do |msg|
+      received_message = msg
+    end
+    let_background_processor_run
+    assert received_message
+    assert received_message[:id], "message did not have an id"
+    assert_equal "42", received_message[:id]
+
+    client.disconnect
+  end
+
+  it 'allows disabling generated message ids' do
+    client = Klomp::Client.new(@uris, :translate_json => false, :uuid => false).connect
+    client.send(@destination, '')
+
+    received_message = false
+    client.subscribe(@destination) do |msg|
+      received_message = msg
+    end
+    let_background_processor_run
+    assert received_message
+    refute received_message[:id], "message had an id"
+
+    client.disconnect
+  end
+
+  it 'logs message ids' do
+    logger = Object.new
+    def logger.msgs; @msgs; end
+    def logger.info(msg) (@msgs ||= []) << msg end
+
+    client = Klomp::Client.new(@uris, :translate_json => false, :logger => logger).connect
+    client.send(@destination, '')
+
+    received_message = false
+    client.subscribe(@destination) do |msg|
+      received_message = msg
+    end
+    let_background_processor_run
+    assert received_message
+    assert received_message[:id], "message did not have an id"
+
+    assert_equal 2, logger.msgs.length
+    assert logger.msgs[0] =~ /\[Sending\] ID=([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})/
+    sent_id = $1
+    assert logger.msgs[1] =~ /\[Received\] ID=([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})/
+    received_id = $1
+    assert_equal sent_id, received_id
+
+    client.disconnect
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klomp
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-21 00:00:00.000000000 Z
+date: 2012-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: onstomp
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.5
 description: A simple wrapper around the OnStomp library with additional features
 email:
 - dev.happiness@livingsocial.com
@@ -78,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1591973809162906904
+      hash: 395786091883431087
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: