xing-gearman-ruby 1.1.0 → 1.2.0

data/Rakefile

@@ -11,7 +11,7 @@ begin
     s.email = "ladislav.martincik@xing.com"
     s.homepage = "http://github.com/xing/gearman-ruby"
     s.description = "Library for the Gearman distributed job system"
-    s.authors = ["Daniel Erat", "Ladislav Martincik"]
+    s.authors = ["Daniel Erat", "Ladislav Martincik", "Pablo Delgado", "Mauro Pompilio", "Antonio Garrote", "Kim Altintop"]
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :patch: 0
 :major: 1
-:minor: 1
+:minor: 2

data/examples/client_exception.rb

@@ -5,14 +5,15 @@ Gearman::Util.debug = true
 servers = ['localhost:4730']
 
 client = Gearman::Client.new(servers)
-#try this out
-client.option_request("exceptions")
-
 taskset = Gearman::TaskSet.new(client)
 
-task = Gearman::Task.new('fail_with_exception', 20)
+task = Gearman::Task.new('fail_with_exception', "void")
+task.retry_count = 2
 task.on_complete {|d| puts d }
-task.on_exception {|message| puts message; false}
+task.on_exception {|ex| puts "This should never be called" }
+task.on_warning {|warning| puts "WARNING: #{warning}" }
+task.on_retry { puts "PRE-RETRY HOOK: retry no. #{task.retries_done}" }
+task.on_fail { puts "TASK FAILED, GIVING UP" }
 
 taskset.add_task(task)
 taskset.wait(100)

data/examples/worker_exception.rb

@@ -9,6 +9,6 @@ w = Gearman::Worker.new(servers)
 # Add a handler for a "sleep" function that takes a single argument, the
 # number of seconds to sleep before reporting success.
 w.add_ability('fail_with_exception') do |data,job|
-  raise Exception.new("fooexception")
+  raise Exception.new("Exception in worker (args: #{data.inspect})")
 end
 loop { w.work }

data/gearman-ruby.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gearman-ruby}
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Daniel Erat", "Ladislav Martincik"]
-  s.date = %q{2009-07-16}
+  s.authors = ["Daniel Erat", "Ladislav Martincik", "Pablo Delgado", "Mauro Pompilio", "Antonio Garrote", "Kim Altintop"]
+  s.date = %q{2009-07-30}
   s.description = %q{Library for the Gearman distributed job system}
   s.email = %q{ladislav.martincik@xing.com}
   s.extra_rdoc_files = [

data/lib/gearman/task.rb

@@ -17,8 +17,8 @@ class Task
   def initialize(func, arg='', opts={})
     @func = func.to_s
     @arg = arg or ''  # TODO: use something more ref-like?
-    %w{uniq on_complete on_fail on_retry on_exception on_status retry_count
-       priority background}.map {|s| s.to_sym }.each do |k|
+    %w{on_complete on_fail on_retry on_exception on_status on_warning 
+       uniq retry_count priority background}.map {|s| s.to_sym }.each do |k|
       instance_variable_set "@#{k}", opts[k]
       opts.delete k
     end
@@ -31,7 +31,7 @@ class Task
     @hash = nil
   end
   attr_accessor :uniq, :retry_count, :priority, :background
-  attr_reader :successful, :func, :arg
+  attr_reader :successful, :func, :arg, :retries_done
 
   ##
   # Internal method to reset this task's state so it can be run again.
@@ -67,6 +67,9 @@ class Task
   # Set a block of code to be executed when a remote exception is sent by a worker.
   # The block will receive the message of the exception passed from the worker.
   # The user can return true for retrying or false to mark it as finished
+  #
+  # NOTE: this is actually deprecated, cf. https://bugs.launchpad.net/gearmand/+bug/405732
+  #
   def on_exception(&f)
     @on_exception = f
   end
@@ -79,6 +82,15 @@ class Task
     @on_status = f
   end
 
+  ##
+  # Set a block of code to be executed when we receive a warning from a worker.
+  # It is recommended for workers to send work_warning, followed by work_fail if
+  # an exception occurs on their side. Don't expect this behavior from workers NOT
+  # using this very library ATM, though. (cf. https://bugs.launchpad.net/gearmand/+bug/405732)
+  def on_warning(&f)
+    @on_warning = f
+  end
+
   ##
   # Handle completion of the task.
   #
@@ -104,17 +116,11 @@ class Task
   end
 
   ##
-  # Record an exception and check whether we should be retried.
+  # Record an exception.
   #
-  # @return  true if we should be resubmitted; false otherwise
   def handle_exception(exception)
-    if @on_exception
-      should_retry = @on_exception.call(exception)
-      @retries_done += 1 if should_retry
-      should_retry
-    else
-      false
-    end
+    @on_exception.call(exception) if @on_exception
+    self
   end
 
   ##
@@ -123,6 +129,14 @@ class Task
     @on_status.call(numerator, denominator) if @on_status
     self
   end
+  
+  ##
+  # Handle a warning.
+  #
+  def handle_warning(message)
+    @on_warning.call(message) if @on_warning
+    self
+  end
 
   ##
   # Return a hash that we can use to execute identical tasks on the same

data/lib/gearman/taskset.rb

@@ -135,21 +135,15 @@ class TaskSet
   # @param hostport  "host:port" of job server
   # @param data      data returned in packet from server
   def handle_work_exception(hostport, data)
-    handle, exception = data.split("\0", 3)
+    handle, exception = data.split("\0", 2)
     Util.log "Got work_exception with handle #{handle} from #{hostport}: '#{exception}'"
     js_handle = Util.handle_to_str(hostport, handle)
-    tasks = @tasks_in_progress.delete(js_handle)
+    tasks = @tasks_in_progress[js_handle]
     if not tasks
-      raise ProtocolError, "Got unexpected work_status with handle " +
+      raise ProtocolError, "Got unexpected work_exception with handle " +
         "#{handle} from #{hostport} (no task by that name)"
     end
-    tasks.each do |t|
-      if t.handle_exception(exception)
-        add_task_internal(t, false)
-      else
-        @finished_tasks << t
-      end
-    end
+    tasks.each {|t| t.handle_exception(exception) }
   end
   private :handle_work_exception
 
@@ -195,6 +189,24 @@ class TaskSet
   end
   private :handle_work_status
 
+  ##
+  # Handle a 'work_warning' response from a job server.
+  #
+  # @param hostport "host:port" of job server
+  # @param data     data returned in packet from server
+  def handle_work_warning(hostport, data)
+    handle, message = data.split("\0", 2)
+    Util.log "Got work_warning with handle #{handle} from #{hostport}: '#{message}'"
+    js_handle = Util.handle_to_str(hostport, handle)
+    tasks = @tasks_in_progress[js_handle]
+    if not tasks
+      raise ProtocolError, "Got unexpected work_warning with handle " +
+        "#{handle} from #{hostport} (no task by that name)"
+    end
+    tasks.each {|t| t.handle_warning(message) }
+  end
+  private :handle_work_warning
+
   ##
   # Read and process a packet from a socket.
   #
@@ -217,6 +229,8 @@ class TaskSet
       handle_work_status(hostport, data)
     when :work_exception
       handle_work_exception(hostport, data)
+    when :work_warning
+      handle_work_warning(hostport, data)
     else
       Util.log "Got #{type.to_s} from #{hostport}"
     end

data/lib/gearman/util.rb

@@ -38,6 +38,7 @@ class Util
     12 => :work_status,     # W->J/C: HANDLE[0]NUMERATOR[0]DENOMINATOR
     13 => :work_complete,   # W->J/C: HANDLE[0]RES
     14 => :work_fail,       # W->J/C: HANDLE
+    29 => :work_warning,    # W->J/C: HANDLE[0]MSG
 
     25 => :work_exception,  # W->J: HANDLE[0]ARG
     26 => :option_req,      # C->J: TEXT

data/lib/gearman/worker.rb

@@ -271,16 +271,17 @@ class Worker
       ret = ret.to_s
       Util.log "Sending work_complete for #{handle} with #{ret.size} byte(s) " +
         "to #{hostport}"
-      Util.pack_request(:work_complete, "#{handle}\0#{ret}")
+      [ Util.pack_request(:work_complete, "#{handle}\0#{ret}") ]
     elsif exception.nil?
       Util.log "Sending work_fail for #{handle} to #{hostport}"
-      Util.pack_request(:work_fail, handle)
+      [ Util.pack_request(:work_fail, handle) ]
     elsif exception
-      Util.log "Sending work_exception for #{handle} to #{hostport}"
-      Util.pack_request(:work_exception, "#{handle}\0#{exception.message}")
+      Util.log "Sending work_warning, work_fail for #{handle} to #{hostport}"
+      [ Util.pack_request(:work_warning, "#{handle}\0#{exception.message}"),
+        Util.pack_request(:work_fail, handle) ]
     end
 
-    Util.send_request(sock, cmd)
+    cmd.each {|p| Util.send_request(sock, p) }
     true
   end
 

metadata

@@ -1,16 +1,20 @@
 --- !ruby/object:Gem::Specification 
 name: xing-gearman-ruby
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Daniel Erat
 - Ladislav Martincik
+- Pablo Delgado
+- Mauro Pompilio
+- Antonio Garrote
+- Kim Altintop
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-07-16 00:00:00 -07:00
+date: 2009-07-30 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -73,6 +77,7 @@ files:
 - test/worker_test.rb
 has_rdoc: false
 homepage: http://github.com/xing/gearman-ruby
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -93,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Library for the Gearman distributed job system