activemessaging-kestrel-adapter 0.0.1 → 0.0.2

data/History.txt

@@ -1,3 +1,10 @@
+== 0.0.2 / 2011-02-03
+* Implement simple retry in the face of receive errors to avoid log spew
+  by the ActiveMessaging Gateway as it retries over and over.  Extensible
+  with other retry policies.
+* Works with ActiveMessaging up to version 0.7.1
+* Add some configuration tests
+
 == 0.0.1 / 2011-02-02
 * First release, actually works in a Rails application.
 

data/README.md

@@ -19,6 +19,13 @@ Examples
     # development:
     #   adapter: kestrel
     #   servers: localhost:22133
+    #   retry_policy:
+    #     strategy: SimpleRetry
+    #     config: 
+    #       tries: 1
+    #       delay: 5
+    # the retry_policy: second is optional and should be left out under
+    # most circumstances (see below).
     config = YAML.load(File.read("broker.yml"))
 
     adapter = ActiveMessaging::Adapter::Kestrel::Connection.new(config[:development])
@@ -28,12 +35,25 @@ Examples
     adapter.subscribe("queue2")
     adapter.receive # get a message from any of the subscribed queues, or nil if they are all empty
 
+Configuration
+-------------
+
+See the ActiveMessaging project for details of broker configuration.  This
+Kestrel adapter can be configured with a retry_policy, but it is not 
+necessary to do so as a sensible default will be used if the configuration
+is not present.  The default policy is as shown above.  The default
+policy in the face of receive exceptions is to sleep 5 seconds, then retry
+once.  If an exception still occurs, it is raised.  The strategy must
+refer to a class that once instantiated, responds to the do_work() method.
+The method must take a options hash.  The value of the options hash will 
+be the config: key in the configuration file.  For 99% of use cases, you
+should not even bother defining the retry_policy as the default is fine.
+The ability to override the policy is provided for edge cases.
 
 Requirements
 ------------
 
-* depends on memcached-client
-* flesh out the configuration
+* memcached-client
 
 Future
 ------

data/Rakefile

@@ -14,9 +14,9 @@ Bones {
   url      'http://github.org/seifertd/activemessaging-kestrel-adapter'
   ignore_file '.gitignore'
   readme_file 'README.md'
-  version '0.0.1'
 
   depend_on 'memcache-client'
+  depend_on 'activemessaging'
 
   rdoc.include << 'README.md'
 

data/lib/active_messaging/adapters/kestrel.rb

@@ -9,22 +9,60 @@ module ActiveMessaging
       # Simple struct for wrapping received messages
       Message = Struct.new(:headers, :body, :command)
 
+      # Resolve the provided string into a class object
+      def to_class(class_name, initial_scope = Kernel)
+        class_name.split('::').inject(initial_scope) { |scope, const_name| scope.const_get(const_name) }
+      end
+
+      # class for retrying things (should be pulled into a separate gem)
+      class SimpleRetry
+        # Yields to caller's block and retries up to options[:tries] (default 3)
+        # times in the face of exceptions.  Returns return result of block if
+        # successful.  If number of tries is exhausted, the exception is reraised.
+        # Retry loop will sleep options[:delay] seconds between retries (default 5).
+        # If you want error logging, pass in :logger.  If not provided, Rails.logger
+        # is used if defined.
+        def do_work(options = {})
+          logger = defined?(::Rails) ? ::Rails.logger : nil
+          use_options = {:tries => 3, :delay => 5, :logger => logger}.merge(options || {})
+          exception = nil
+          return_value = nil
+          logger = use_options[:logger]
+          use_options[:tries].times do |try|
+            begin
+              exception = nil
+              return_value = yield
+              break
+            rescue Exception => e
+              exception = e
+              logger.warn("Got error on try #{try}: #{exception} retrying after #{use_options[:delay]} seconds") if logger
+            end
+            sleep use_options[:delay]
+          end
+
+          raise exception if exception
+          return return_value
+        end
+      end
+
       # Connection to a kestrel message queue server
-      class Connection < ActiveMessaging::Adapters::Base::Connection
+      class Connection < ActiveMessaging::Adapters::BaseConnection
         include ActiveMessaging::Adapter
         register :kestrel
         attr_accessor :reliable
-        # Time to sleep between polls of empty queues
-        attr_accessor :receive_throttle
         # Reconnect on error
-        attr_accessor :error_policy
+        attr_accessor :retry_policy
 
         def initialize(cfg)
-          @receive_throttle = cfg.delete(:receive_throttle) || 0.1
-          # TODO: Implement error policies
-          @error_policy = cfg.delete(:error_policy) || :reconnect
+          cfg = symbolize_keys(cfg)
+          @retry_policy = cfg.delete(:retry_policy) || {:strategy => SimpleRetry, :config => {:tries => 1, :delay => 5}}
+          if @retry_policy[:strategy].is_a?(String)
+            # TODO: when getting a retry policy strategy from the config file, it will be a string.  Convert it to a class
+            # using the Kestrel module as a context, then Kernel.
+            @retry_policy[:strategy] = Kestrel.const_get(retry_policy[:strategy]) rescue Kestrel.to_class(@retry_policy[:strategy])
+          end
           @config = cfg
-          @queues = {}
+          @subscriptions = {}
           connect
           nil
         end
@@ -39,17 +77,17 @@ module ActiveMessaging
         # messages from it
         def subscribe(destination_name, headers = {})
           headers[:destination] = destination_name
-          if @queues[destination_name]
+          if @subscriptions[destination_name]
             # TODO: Should you get an exception or no?
           else
-            @queues[destination_name] = headers
+            @subscriptions[destination_name] = headers
           end
           nil
         end
 
         # Stop receiving messages from the named destination
         def unsubscribe(destination_name, headers = {})
-          @queues.delete(destination_name)
+          @subscriptions.delete(destination_name)
         end
 
         # Send a message to the named destination.  headers can
@@ -67,10 +105,13 @@ module ActiveMessaging
         # Gets a message from any subscribed destination and returns it as a 
         # ActiveMessaging::Adaptors::Kestrel::Message object
         def receive
-          # TODO: Is this what ActiveMessaging expects: can it handle a nil return?
-          #while (true)
-            # Get a message from a subscribed queue, but don't favor any queue over another
-            queues_to_check = @queues.size > 1 ? @queues.keys.sort_by{rand} : @queues.keys
+          return nil if @subscriptions.size < 1
+
+          # instantiate a class for doing the retries
+          retrier = @retry_policy[:strategy].new
+
+          retrier.do_work(@retry_policy[:config]) do
+            queues_to_check = @subscriptions.size > 1 ? @subscriptions.keys.sort_by{rand} : @subscriptions.keys
             queues_to_check.each do |queue|
               if item = @kestrel.get(normalize(queue))
                 # TODO: ActiveMessaging ought to provide a way to do messaging
@@ -78,9 +119,7 @@ module ActiveMessaging
                 return Message.new({'destination' => queue}, item, 'MESSAGE')
               end
             end
-          #  # Sleep a bit so we don't get into a spinloop
-          #  sleep @receive_throttle
-          #end
+          end
           return nil
         end
 
@@ -91,6 +130,16 @@ module ActiveMessaging
             @normalized_names ||= Hash.new {|h,k| h[k] = k.gsub('/', '--FS--')}
             @normalized_names[name]
           end
+
+          def symbolize_keys(hash)
+            hash.inject({}) do |new_hash, (k, v)|
+              if v.is_a?(Hash)
+                v = symbolize_keys(v)
+              end
+              new_hash[k.to_sym] = v
+              new_hash
+            end
+          end
       end
     end
   end

data/test/test_activemessaging-kestrel-adapter.rb

@@ -0,0 +1,29 @@
+require 'test/unit'
+require 'activemessaging'
+require 'activemessaging-kestrel-adapter'
+
+class TestActiveMessagingKestrelAdapter < Test::Unit::TestCase
+  def test_default_config
+    cfg = {:servers => 'localhost:22133'}
+    adapter = ActiveMessaging::Adapters::Kestrel::Connection.new(cfg)
+    assert_equal adapter.instance_variable_get("@retry_policy")[:strategy], ActiveMessaging::Adapters::Kestrel::SimpleRetry
+    assert_equal adapter.instance_variable_get("@retry_policy")[:config], {:tries => 1, :delay => 5}
+  end
+
+  def test_config_from_yaml
+    yaml = <<-YAML
+development:
+  adapter: kestrel
+  servers: localhost:22133
+  retry_policy:
+    strategy: SimpleRetry
+    config: 
+      tries: 1
+      delay: 5
+    YAML
+    cfg = YAML.load(yaml)['development']
+    adapter = ActiveMessaging::Adapters::Kestrel::Connection.new(cfg)
+    assert_equal adapter.instance_variable_get("@retry_policy")[:strategy], ActiveMessaging::Adapters::Kestrel::SimpleRetry
+    assert_equal adapter.instance_variable_get("@retry_policy")[:config], {:tries => 1, :delay => 5}
+  end
+end

data/version.txt

@@ -1 +1 @@
-0.0.1
+0.0.2

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: activemessaging-kestrel-adapter
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Douglas A. Seifert
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-02 00:00:00 -08:00
+date: 2011-02-04 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,18 +26,34 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 49
+        hash: 61
         segments: 
         - 1
         - 8
-        - 3
-        version: 1.8.3
+        - 5
+        version: 1.8.5
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: bones
+  name: activemessaging
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 7
+        - 1
+        version: 0.7.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bones
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -49,7 +65,7 @@ dependencies:
         - 2
         version: 3.6.2
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 description: |-
   This is an adapter to the kestrel messaging server for the ActiveMessaging framework.  It is 
   in the early stages of development.
@@ -63,7 +79,6 @@ extra_rdoc_files:
 - README.md
 - bin/activemessaging-kestrel-adapter
 files: 
-- .Rakefile.swp
 - .bnsignore
 - History.txt
 - README.md