zack 0.3.3 → 0.3.4

data/History.txt

@@ -1,3 +1,11 @@
+= 0.3.5 / ??? (next version)
+
+= 0.3.4 / 23Feb2012
+
+  + Reconnecting server 
+  
+  + Client notifies called of lost connection, reconnects automatically.
+
 = 0.3.3 / 29Nov2011
   + Updates to the cod rewrite, this eliminates the dependency on 
     beanstalk-client.

data/Rakefile

@@ -7,6 +7,9 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
 task :default => :spec
 
+require 'yard'
+YARD::Rake::YardocTask.new
+
 # This task actually builds the gem. 
 task :gem => :spec
 spec = eval(File.read('zack.gemspec'))
@@ -14,4 +17,7 @@ spec = eval(File.read('zack.gemspec'))
 desc "Generate the gem package."
 Gem::PackageTask.new(spec) do |pkg|
   # pkg.need_tar = true
-end
+end
+
+CLEAN << 'doc'
+CLEAN << 'pkg'

data/lib/zack.rb

@@ -6,6 +6,15 @@ module Zack
   # timeout for a message that waits for an answer. 
   #
   class ServiceTimeout < StandardError; end
+  
+  # Gets raised when the connection to the beanstalk server is lost during a
+  # client call. In some cases you might not loose an answer, but you might
+  # have lost the request itself. 
+  #
+  # The client object reconnects and will work as soon as the beanstalkd
+  # server comes back.
+  #
+  class AnswerLost < StandardError; end
 end
 
 require 'zack/unique_name'

data/lib/zack/client.rb

@@ -1,4 +1,4 @@
-
+require 'timeout'
 
 module Zack
   # Client for a simple client-server RPC connection. 
@@ -6,13 +6,14 @@ module Zack
   class Client
     attr_reader :service
 
-    # Constructs a client for the service given by tube_name. Optional
-    # arguments are: 
+    # Constructs a client for the service given by tube_name. 
     #
-    # :server :: beanstalkd server location url
-    # :only :: ignores all messages not in this hash
-    # :with_answer :: these messages wait for an answer from the service
-    # :timeout :: How long to wait for an answer
+    # @param tube_name [String] the tube to communicate with
+    # @option opts [String] :server beanstalkd server location url
+    # @option opts [Array<Symbol>] :only ignores all messages not in this hash
+    # @option opts [Array<Symbol>] :with_answer these messages wait for an 
+    #   answer from the service
+    # @option opts [Fixint] :timeout How long to wait for an answer
     #
     def initialize(tube_name, opts={})
       # Only respond to these messages
@@ -26,15 +27,18 @@ module Zack
 
       connect
     end
-  
+    
+    # @private
     def respond_to?(msg)
       !! @only[msg]
     end
-
+    
+    # @private
     def has_answer?(sym)
       @with_answer.include?(sym.to_sym)
     end
 
+    # @private
     def method_missing(sym, *args, &block)
       super unless respond_to?(sym)
  
@@ -48,8 +52,17 @@ module Zack
         service.notify [sym, args]
         return nil
       end
+      
+    rescue Cod::ConnectionLost
+      # Don't resend, just reconnect. This might loose one or two messages, 
+      # but we don't make such guarantees at this protocol level.
+      reconnect
+      
+      raise Zack::AnswerLost
+      
     rescue Timeout::Error => ex
-      raise Zack::ServiceTimeout, "The service took too long to answer (>#{@timeout || 1}s)."
+      raise Zack::ServiceTimeout, 
+        "The service took too long to answer (>#{@timeout || 1}s)."
     end
     
     def close

data/lib/zack/server.rb

@@ -11,22 +11,19 @@ module Zack
     # of the RPC call, you must either give the :factory or the :simple
     # argument. 
     #
-    # :simple expects a class. This class will be constructed each time a
-    # request is made. Then the method will be called on the class. 
-    #
-    # :factory expects a callable (a block or something that has #call) and is
-    # passed the control object for the request (see Cod for an explanation of
-    # this). You can chose to ignore the control and just use the block to
-    # produce an object that is linked to the rest of your program. Or you can
-    # link to the rest of the program and the control at the same time. 
-    #
     # Note that in any case, one object instance _per call_ is created. This
-    # is to discourage creating stateful servers. If you still want to do
-    # that, well you will just have to code around the limitation, now won't
-    # you. 
+    # is to discourage creating stateful servers. 
     #
+    # @param tube_name [String] the tube to communicate with
+    # @option opts [Class] :simple class will be constructed for each request.
+    #   The request will then be handed to the class.
+    # @option opts [#call] :factory factory for request handler instances. One
+    #   parameter gets passed to this call, the control structure for the 
+    #   beanstalk connection.
+    #   
     def initialize(tube_name, opts={})
       @server = opts[:server]
+      @tube_name = tube_name
 
       if opts.has_key? :factory
         @factory = opts[:factory]
@@ -36,12 +33,12 @@ module Zack
       else
         raise ArgumentError, "Either :factory or :simple argument must be given." 
       end
- 
-      channel = Cod.beanstalk(tube_name, server)
-      @service = channel.service
+
+      reconnect
     end 
    
     # Handles exactly one request. 
+    # @private
     #
     def handle_request(exception_handler=nil)
       service.one { |(sym, args), control|
@@ -50,10 +47,18 @@ module Zack
           process_request(control, sym, args)
         end
       }
+      
+    # Reconnect when the connection is lost  
+    rescue Cod::ConnectionLost
+      @channel.close
+      reconnect
+      
+      retry 
     end
     
     # Processes exactly one request, but doesn't define how the request gets
     # here. 
+    # @private
     #
     def process_request(control, sym, args)
       instance = factory.call(control)
@@ -78,6 +83,10 @@ module Zack
     # If you don't reraise exceptions from the exception handler block, they
     # will be caught and the server will stay running. 
     #
+    # @param messages [Number] how many messages to process, or nil for endless
+    #   operation
+    # @yield [Exception, Cod::Beanstalk::Service::Control]
+    #
     def run(messages=nil, &exception_handler)
       loop do
         handle_request(exception_handler)
@@ -89,12 +98,19 @@ module Zack
       end
     end
 
+    # Closes the connection and shuts down the server. 
+    #
+    def close
+      @channel.close
+    end
+
   private
     # Defines how the server handles exception. 
     #
     def exception_handling(exception_handler, control)
       begin
         yield
+      
       rescue => exception
         # If we have an exception handler, it gets handed all the exceptions. 
         # No exceptions stop the operation. 
@@ -105,5 +121,10 @@ module Zack
         end
       end
     end
+
+    def reconnect
+      @channel = Cod.beanstalk(@tube_name, @server)
+      @service = @channel.service
+    end
   end
 end

data/spec/acceptance/reconnect_handling_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+require 'tcp_proxy'
+
+describe "Connection interruption:" do
+  # Clear old messages (test isolation)
+  before(:each) { 
+    conn = Beanstalk::Connection.new(BEANSTALK_CONNECTION, 'reconnect')
+    while conn.peek_ready
+      conn.reserve.delete
+    end
+    conn.close
+  }
+
+  class SimpleFlagServer
+    def signal
+      @signalled = true
+    end
+    
+    def clear
+      @signalled = false
+    end
+    
+    def signalled?
+      @signalled
+    end
+  end
+  
+  def sub_port(connstr, new_port)
+    parts = BEANSTALK_CONNECTION.split(':')
+    parts[1] = new_port
+    parts.join(':')
+  end
+
+  let(:flag_server) { SimpleFlagServer.new }
+  let(:client) { Zack::Client.new('reconnect', server: BEANSTALK_CONNECTION) }
+  let(:server) { Zack::Server.new('reconnect', 
+    server: BEANSTALK_CONNECTION, 
+    factory: proc { |c| flag_server }) }
+        
+  after(:each) { client.close; server.close }
+
+  it "smoke test to verify the setup" do
+    client.signal
+    server.run(1)
+    
+    flag_server.should be_signalled
+  end
+  
+  describe 'when the connection between the client and the beanstalkd server disappears' do
+    let!(:proxy) { TCPProxy.new('localhost', 11301, 11300) }
+    after(:each) { proxy.close }
+    
+    let(:client) { Zack::Client.new('reconnect', 
+      server: sub_port(BEANSTALK_CONNECTION, 11301)) }
+    
+    # Try out the connection before interrupting it  
+    before(:each) { 
+      client.signal
+      server.run(1)
+
+      flag_server.should be_signalled
+      flag_server.clear
+    }
+    
+    it "reconnects automatically" do
+      proxy.drop_all
+      
+      expect {
+        client.signal
+      }.to raise_error(Zack::AnswerLost)
+      
+      # The client should have reconnected, so this should now work: 
+      client.signal
+      server.run(1)
+
+      flag_server.should be_signalled
+    end 
+  end
+  describe 'when the connection between the server and the beanstalkd server disappears' do
+    let!(:proxy) { TCPProxy.new('localhost', 11301, 11300) }
+    after(:each) { proxy.close }
+    
+    let(:server) { Zack::Server.new('reconnect', 
+      server: sub_port(BEANSTALK_CONNECTION, 11301), 
+      factory: proc { |c| flag_server }) }
+    
+    # Try out the connection before interrupting it  
+    before(:each) { 
+      client.signal
+      server.run(1)
+
+      flag_server.should be_signalled
+
+      flag_server.clear
+    }
+    
+    it "reconnects automatically" do
+      # Post one message to the queue
+      client.signal
+      proxy.drop_all
+
+      # Try to process a message (connection is interrupted)
+      server.run(1)
+      
+      flag_server.should be_signalled
+    end 
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zack
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,22 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-29 00:00:00.000000000Z
+date: 2012-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cod
-  requirement: &70152213379200 !ruby/object:Gem::Requirement
+  requirement: &70158540161560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.4.3
   type: :runtime
   prerelease: false
-  version_requirements: *70152213379200
+  version_requirements: *70158540161560
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &70152213378720 !ruby/object:Gem::Requirement
+  requirement: &70158540160960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '2.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70152213378720
+  version_requirements: *70158540160960
 - !ruby/object:Gem::Dependency
   name: beanstalk-client
-  requirement: &70152213378240 !ruby/object:Gem::Requirement
+  requirement: &70158540160360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,7 +44,95 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70152213378240
+  version_requirements: *70158540160360
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70158540159960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158540159960
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70158540159360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158540159360
+- !ruby/object:Gem::Dependency
+  name: flexmock
+  requirement: &70158540158900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158540158900
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70158540158440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158540158440
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70158540158020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158540158020
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: &70158540174660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158540174660
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &70158540174180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158540174180
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70158540173560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158540173560
 description: 
 email:
 - kaspar.schiess@absurd.li
@@ -63,6 +151,7 @@ files:
 - lib/zack/unique_name.rb
 - lib/zack.rb
 - spec/acceptance/exception_handling_spec.rb
+- spec/acceptance/reconnect_handling_spec.rb
 - spec/acceptance/regression_spec.rb
 - spec/acceptance/server_runner_spec.rb
 - spec/lib/zack/client_spec.rb
@@ -86,16 +175,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2009193566488392526
+      hash: -4472510661863580508
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4472510661863580508
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Ruby RPC calls via Cod