activemessaging-kestrel-adapter 0.0.4 → 0.0.5

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+*.swp
+doc

data/History.txt

@@ -1,3 +1,11 @@
+== 0.0.5 / 2011-02-27
+* Clean up retry_policy initialization.  Make sure the logger is set correctly.
+* Avoid reinstantiating a new retry policy object each time through the
+  receive method.  Create and reuse one object when the adapter is created.
+* Make the empty_queues_delay default to nil, or no sleep at all, for cases
+  where the adapter is used outside of the ActiveMessaging::Gateway receive
+  loop
+
 == 0.0.4 / 2011-02-15
 * Add a queue_stats method to get stats on server queues from the adapter.
 

data/README.md

@@ -51,11 +51,18 @@ 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.
 
+empty_queues_delay is provided as a hack for when this adapter is used by the
+ActiveMessaging::Gateway messaging loop.  Without setting this to some
+small non zero value, the messaging loop will consume 100% of CPU if there
+are no messages is subscribed queues.  If you are using this adapter outside
+of the ActiveMessaging::Gateway messaging loop, do not set this key
+
 Requirements
 ------------
 
 * activemessaging >= 0.7.1 
 * memcached-client
+* activesupport
 
 Probably activesupport as well since activemessaging barfs if you do not
 include it at the right time for certain use cases.

data/Rakefile

@@ -17,6 +17,7 @@ Bones {
 
   depend_on 'memcache-client'
   depend_on 'activemessaging', '>= 0.7.1'
+  depend_on 'activesupport', '~>2.3'
 
   rdoc.include << 'README.md'
 

data/lib/active_messaging/adapters/kestrel.rb

@@ -27,11 +27,10 @@ module ActiveMessaging
         # If you want error logging, pass in :logger.  If not provided, ActiveMessaging.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 || {})
+          use_options = {:tries => 3, :delay => 5}.merge(options || {})
           exception = nil
           return_value = nil
-          logger = use_options[:logger]
+          logger = use_options[:logger] || (defined?(::ActiveMessaging) ? ::ActiveMessaging.logger : nil)
           use_options[:tries].times do |try|
             begin
               exception = nil
@@ -62,17 +61,26 @@ module ActiveMessaging
 
         # Create a new Kestrel adapter using the provided config
         def initialize(cfg = {})
+          # Like symbol keys
           cfg = symbolize_keys(cfg)
-          # TODO: Decide on fallback logging ...
+
+          # Create a logger.  Use framework loggers when available.
           @logger = cfg.delete(:logger) || ActiveMessaging.logger || (defined?(::Rails) && ::Rails.logger ? ::Rails.logger : nil) || default_logger
+
+          # Get the retry policy
           @retry_policy = cfg.delete(:retry_policy) || {:strategy => SimpleRetry, :config => {:tries => 1, :delay => 5}}
-          @empty_queues_delay = cfg.delete(:empty_queues_delay) || 0.1
+          # If the retry policy came from the cfg, make sure we set the :logger
+          @retry_policy[:config][:logger] ||= @logger
+          # Turn the strategy into a Class if it is a String
           if @retry_policy[:strategy].is_a?(String)
             # Convert strategy from string to class
-            @retry_policy[:strategy] = Kestrel.const_get(retry_policy[:strategy]) rescue Kestrel.to_class(@retry_policy[:strategy])
+            @retry_policy[:strategy] = Kestrel.const_get(@retry_policy[:strategy]) rescue Kestrel.to_class(@retry_policy[:strategy])
           end
+
+          @empty_queues_delay = cfg.delete(:empty_queues_delay)
           @config = cfg
           @subscriptions = {}
+          retrier
           connect
           nil
         end
@@ -107,10 +115,17 @@ module ActiveMessaging
 
         # Connect to the kestrel server using a Memcached client
         def connect
-          logger.debug("Creating connection to Kestrel using config #{@config.inspect}") if logger.level <= Logger::DEBUG
+          logger.debug("Creating connection to Kestrel using config #{@config.inspect}") if logger && logger.level <= Logger::DEBUG
           @kestrel = MemCache.new(@config)
           @kestrel.servers = @config[:servers]
         end
+
+        # Creates a retrier object according to the @retry_policy
+        def retrier
+          @retrier ||= begin
+            @retry_policy[:strategy].new
+          end
+        end
  
         # Subscribe to the named destination and begin receiving
         # messages from it
@@ -146,10 +161,7 @@ module ActiveMessaging
         def receive
 
           if @subscriptions.size > 0
-            # instantiate a class for doing the retries
-            retrier = @retry_policy[:strategy].new
-
-            retrier.do_work(@retry_policy[:config]) do
+            @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))
@@ -162,7 +174,7 @@ module ActiveMessaging
             end
           end
           # Sleep a little to avoid a spin loop (ActiveMessaging Gateway ought to do this)
-          sleep(@empty_queues_delay)
+          sleep(@empty_queues_delay) if @empty_queues_delay && @empty_queues_delay > 0
           return nil
         end
 

data/test/test_activemessaging-kestrel-adapter.rb

@@ -7,8 +7,9 @@ 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}
+    assert_equal ActiveMessaging::Adapters::Kestrel::SimpleRetry, adapter.instance_variable_get("@retry_policy")[:strategy]
+    assert_equal 1, adapter.instance_variable_get("@retry_policy")[:config][:tries]
+    assert_equal 5, adapter.instance_variable_get("@retry_policy")[:config][:delay]
   end
 
   def test_config_from_yaml
@@ -24,7 +25,8 @@ development:
     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}
+    assert_equal ActiveMessaging::Adapters::Kestrel::SimpleRetry, adapter.instance_variable_get("@retry_policy")[:strategy]
+    assert_equal 1, adapter.instance_variable_get("@retry_policy")[:config][:tries]
+    assert_equal 5, adapter.instance_variable_get("@retry_policy")[:config][:delay]
   end
 end

data/version.txt

@@ -1 +1 @@
-0.0.4
+0.0.5

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: activemessaging-kestrel-adapter
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Douglas A. Seifert
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-15 00:00:00 -08:00
+date: 2011-02-27 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,14 +24,12 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 49
+        hash: 3
         segments: 
-        - 1
-        - 8
-        - 3
-        version: 1.8.3
+        - 0
+        version: "0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -51,21 +49,36 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: bones
+  name: activesupport
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bones
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 21
         segments: 
         - 3
         - 6
-        - 2
-        version: 3.6.2
+        - 5
+        version: 3.6.5
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 description: |-
   This is an adapter to the kestrel messaging server for the ActiveMessaging framework.  It is 
   in the early stages of development.
@@ -75,13 +88,12 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- .README.md.swp
 - History.txt
 - README.md
 - bin/activemessaging-kestrel-adapter
 files: 
-- .README.md.swp
 - .bnsignore
+- .gitignore
 - History.txt
 - README.md
 - Rakefile