faktory_worker_ruby 0.8.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5ffc1c6d5392fd64f4463ae4a47972f7d2c13ebc
-  data.tar.gz: cc1e0294bc5c333f7ce684f112ee1182e20d2095
+SHA256:
+  metadata.gz: 2a183f21103562c224add2460da73a145a0c12c32a167525fd18dd02fe334241
+  data.tar.gz: b7c76d7001ba133f685427ffcc00bcdd75d026747106fac705b741e57f3d7b94
 SHA512:
-  metadata.gz: 9f2a3b5f59d0a50c77f0f22ec86f291289762ba5e27dc012fa9cce34807883aee616b7ca9b7a937139b67137725f450c0e7fc504909f0a84136ebd4b6e67586e
-  data.tar.gz: 7ef1fd93ff1d803bb7d895d63749a3deb9cd4fe4000936df5b8e1facfca884e22e439574979b821972936b16b1ea15ef31f97c3db306b90b4d7514ea214d1437
+  metadata.gz: 6bae416fa9d2675c586a8a40ccce0005f665eb2ab2bc19e6a5e12405cafee67aef22984d9e84f6db96012143eee87307d81e089fad5fd81d6dd278489fe62437
+  data.tar.gz: 42806775422a7542a1a7c7e912bc373dfe8c0d2b1d47d8cccb3ce8d91a0c1a95f8a835cb99cc1b9da2262d17ac3f50e7447ecefcf4eff6ba3ef0d9672e8b1f06

data/Changes.md

@@ -1,5 +1,31 @@
 # Changes
 
+## 1.0.3
+
+- Fix corruption in `custom` hash elements [#55]
+
+## 1.0.2
+
+- Fix "batch not open" errors
+
+## 1.0.1
+
+- Run client middleware before pushing a job to Faktory [#48]
+- Implement read timeouts for Faktory::Client for faktory#297
+
+## 1.0.0
+
+- Ruby 2.5+ is now required
+- Support for Faktory Enterprise, job batches and job tracking
+- Support for the MUTATE command.
+- Notify Faktory when a worker process is going quiet so that the UI shows this
+- Refactor Faktory::Client error handling for faktory#208
+
+## 0.8.1
+
+- Fix breakage with non-ActiveJobs [#29]
+- Ruby 2.3+ is now required
+
 ## 0.8.0
 
 - Add `-l LABEL` argument for adding labels to a process [#27, jpwinans]

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
+gem 'simplecov', require: false, group: :test
+
 gemspec

data/Gemfile.lock

@@ -1,43 +1,51 @@
 PATH
   remote: .
   specs:
-    faktory_worker_ruby (0.8.0)
-      connection_pool (~> 2.2, >= 2.2.1)
+    faktory_worker_ruby (1.0.2)
+      connection_pool (~> 2.2, >= 2.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (5.2.1)
-      activesupport (= 5.2.1)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
       globalid (>= 0.3.6)
-    activesupport (5.2.1)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    concurrent-ruby (1.0.5)
-    connection_pool (2.2.2)
-    globalid (0.4.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.6)
+    connection_pool (2.2.3)
+    docile (1.3.2)
+    globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.1.0)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
+    minitest (5.14.1)
     minitest-hooks (1.5.0)
       minitest (> 5.3)
-    rake (12.3.1)
+    rake (13.0.1)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activejob (>= 5.1.5)
+  activejob (>= 5.2.0)
   faktory_worker_ruby!
   minitest (~> 5)
   minitest-hooks
-  rake (~> 12)
+  rake
+  simplecov
 
 BUNDLED WITH
-   1.16.3
+   2.1.4

data/README.md

@@ -17,7 +17,7 @@ Faktory background job server.  It is similar to [Sidekiq](http://sidekiq.org).
 +-----------------+                            +-------------------+
 |                 |                            |                   |
 |    Client       |                            |     Worker        |
-|    pushes       |                            |     pulls         |
+|    pushes       |                            |     fetches       |
 |     jobs        |                            |      jobs         |
 |                 |                            |                   |
 |                 |                            |                   |
@@ -32,11 +32,14 @@ Faktory background job server.  It is similar to [Sidekiq](http://sidekiq.org).
 This gem contains only the client and worker parts.  The
 server part is [here](https://github.com/contribsys/faktory/)
 
-## Installation
+## Requirements
+
+* Ruby 2.5 or higher
+* Faktory 1.2 or higher [Installation](https://github.com/contribsys/faktory/wiki/Installation)
 
-First, make sure you have the [Faktory server](https://github.com/contribsys/faktory/#installation) installed.
+Optionally, Rails 5.2+ for ActiveJob.
 
-Next, install this gem:
+## Installation
 
     gem install faktory_worker_ruby
 
@@ -94,4 +97,4 @@ PRs to improve this are very welcome).
 
 ## Author
 
-Mike Perham, @mperham, mike @ contribsys.com
+Mike Perham, @getajobmike, mike @ contribsys.com

data/faktory_worker_ruby.gemspec

@@ -14,11 +14,11 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files | grep -Ev '^(test|myapp|examples)'`.split("\n")
   gem.test_files    = []
   gem.version       = Faktory::VERSION
-  gem.required_ruby_version = ">= 2.2.2"
+  gem.required_ruby_version = ">= 2.5.0"
 
-  gem.add_dependency                  'connection_pool', '~> 2.2', ">= 2.2.1"
-  gem.add_development_dependency      'activejob', '>= 5.1.5'
+  gem.add_dependency                  'connection_pool', '~> 2.2', ">= 2.2.2"
+  gem.add_development_dependency      'activejob', '>= 5.2.0'
   gem.add_development_dependency      'minitest', '~> 5'
   gem.add_development_dependency      'minitest-hooks'
-  gem.add_development_dependency      'rake', '~> 12'
+  gem.add_development_dependency      'rake'
 end

data/lib/active_job/queue_adapters/faktory_adapter.rb

@@ -32,8 +32,12 @@ module ActiveJob
           hash["retry"] = opts.delete("retry") if opts.has_key?("retry")
           hash["custom"] = opts.merge(hash["custom"])
         end
-        # Faktory::Client does not support symbols as keys
-        Faktory::Client.new.push(hash)
+        pool = Thread.current[:faktory_via_pool] || Faktory.server_pool
+        Faktory.client_middleware.invoke(hash, pool) do
+          pool.with do |c|
+            c.push(hash)
+          end
+        end
       end
 
       class JobWrapper #:nodoc:

data/lib/faktory.rb

@@ -52,6 +52,7 @@ module Faktory
   #     config.worker_middleware do |chain|
   #       chain.add MyServerHook
   #     end
+  #     config.default_job_options = { retry: 3 }
   #   end
   def self.configure_worker
     yield self if worker?
@@ -61,7 +62,7 @@ module Faktory
   # Configuration for Faktory client, use like:
   #
   #   Faktory.configure_client do |config|
-  #     config.faktory = { :size => 1, :url => 'myhost:7419' }
+  #     config.default_job_options = { retry: 3 }
   #   end
   def self.configure_client
     yield self unless worker?
@@ -164,3 +165,4 @@ module Faktory
 end
 
 require 'faktory/rails' if defined?(::Rails::Engine)
+require 'faktory/batch'

data/lib/faktory/batch.rb

@@ -0,0 +1,178 @@
+require "faktory/middleware/batch"
+
+module Faktory
+  ##
+  # A Batch is a set of jobs which can be tracked as a group, with
+  # callbacks that can fire after all the jobs are attempted or successful.
+  # Every batch must define at least one callback.
+  #
+  # * The "complete" callback is fired when all jobs in the batch have been attempted.
+  #   Some might have failed.
+  # * The "success" callback is fired when all jobs in the batch have succeeded. This
+  #   might never be fired if a job continues to error until it runs out of retries.
+  #
+  # **Please note that batches are only available in Faktory Enterprise.** This is
+  # the client-side code required to implement batches, it won't work without
+  # the server-side component.
+  #
+  # Simple example:
+  #
+  #   b = Faktory::Batch.new
+  #   b.description = "Process all documents for user 12345"
+  #   # a callback can be defined as just a Ruby job class
+  #   b.success = "MySuccessCallbackJob"
+  #   # or the full job hash...
+  #   b.complete = { jobtype: "MyCompleteCallbackJob", args: [12345], queue: "critical" }
+  #   b.jobs do
+  #     SomeJob.perform_async(xyz)
+  #     AnotherJob.perform_async(user_id)
+  #   end
+  #
+  # At the end of the `jobs` call, the batch is persisted to the Faktory server. It must
+  # not be modified further with one exception: jobs within the batch can "reopen" the batch
+  # in order to dynamically add more jobs or child batches.
+  #
+  # Any job within a batch may "reopen" its own batch to dynamically add more jobs.
+  # A job can get access to its batch by using the `bid` or `batch` accessor on
+  # `Faktory::Job`. You can use the `bid` accessor to test if the job is part of a batch.
+  #
+  # Reopen example:
+  #
+  #  class MyJob
+  #    include Faktory::Job
+  #
+  #    def perform
+  #      batch.jobs do
+  #        SomeOtherJob.perform_async
+  #      end if bid
+  #    end
+  #
+  # Batches may be nested without limit by setting `parent_bid` when creating a
+  # batch. Generally you create child batches if you wish that subset of jobs to have
+  # their own callback for your application logic purposes. Otherwise you can reopen the
+  # current batch and add more jobs.
+  #
+  # Batch parent/child relationship is never implicit: you must manually set
+  # `parent_bid` if you wish to define a child batch.
+  #
+  # Nested example:
+  #
+  #  class MyJob
+  #    include Faktory::Job
+  #
+  #    def perform
+  #      child = Faktory::Batch.new
+  #
+  #      # MyJob is executing as part of a previously defined batch.
+  #      # Add a new child batch to this batch.
+  #      child.parent_bid = bid
+  #      child.success = ...
+  #      child.jobs do |cb|
+  #        SomeJob.perform_async
+  #
+  #        gchild = Faktory::Batch.new
+  #        gchild.parent_bid = cb.bid
+  #        gchild.success = ...
+  #        gchild.jobs do |gcb|
+  #          ChildJob.perform_async
+  #        end
+  #      end
+  #    end
+  #  end
+  #
+  # Callbacks are guaranteed to be called hierarchically: child's success callback
+  # will not be called until gchild's success callback has executed successfully.
+  #
+  class Batch
+    attr_reader :bid
+    attr_accessor :description, :parent_bid
+
+    def initialize(bid=nil)
+      @bid = bid
+    end
+
+    def success=(val)
+      raise "Batch cannot be modified once created" if bid
+      @success = to_callback(val)
+    end
+
+    def complete=(val)
+      raise "Batch cannot be modified once created" if bid
+      @success = to_callback(val)
+    end
+
+    def jobs(&block)
+      Faktory.server do |client|
+        if @bid.nil?
+          @bid = client.create_batch(self, &block)
+        else
+          client.reopen_batch(self, &block)
+        end
+      end
+    end
+
+    def to_h
+      raise ArgumentError, "Callback required" unless defined?(@success) || defined?(@complete)
+
+      hash = {}
+      hash["parent_bid"] = parent_bid if parent_bid
+      hash["description"] = description if description
+      hash["success"] = @success if defined?(@success)
+      hash["complete"] = @complete if defined?(@complete)
+      hash
+    end
+
+    private
+
+    def to_callback(val)
+      case val
+      when String
+        basic_job.merge({ "jobtype" => val })
+      when Class
+        basic_job.merge({ "jobtype" => val })
+      when Hash
+        basic_job.merge(val)
+      else
+        raise ArgumentError, "Unknown callback #{val}"
+      end
+    end
+
+    def basic_job
+      {
+        "jid"   => SecureRandom.hex(12),
+        "args"  => [],
+        "queue" => "default",
+      }
+    end
+  end
+
+  class BatchStatus
+    def initialize(bid)
+      @bid = bid
+    end
+
+    def hash
+      @hash ||= Faktory.server{|c| c.batch_status(@bid) }
+    end
+
+    def created_at
+      hash["created_at"]
+    end
+
+    def description
+      hash["description"]
+    end
+
+    def parent_bid
+      hash["parent_bid"]
+    end
+
+    def total
+      hash["total"]
+    end
+
+    def pending
+      hash["pending"]
+    end
+  end
+end

data/lib/faktory/cli.rb

@@ -8,6 +8,11 @@ require 'optparse'
 require 'erb'
 require 'fileutils'
 
+module Faktory
+  class CLI
+  end
+end
+
 require 'faktory'
 require 'faktory/util'
 

data/lib/faktory/client.rb

@@ -3,14 +3,27 @@ require 'json'
 require 'uri'
 require 'digest'
 require 'securerandom'
+require 'timeout'
+require 'faktory/io'
 
 module Faktory
-  class CommandError < StandardError;end
-  class ParseError < StandardError;end
-
+  class BaseError < StandardError; end
+  class CommandError < BaseError; end
+  class ParseError < BaseError; end
+
+  # Faktory::Client provides a low-level connection to a Faktory server
+  # and APIs which map to Faktory commands.
+  #
+  # Most APIs will return `true` if the operation succeeded or raise a
+  # Faktory::BaseError if there was an unexpected error.
   class Client
+    # provides gets() and read() that respect a read timeout
+    include Faktory::ReadTimeout
+
     @@random_process_wid = ""
 
+    DEFAULT_TIMEOUT = 5.0
+
     HASHER = proc do |iter, pwd, salt|
       sha = Digest::SHA256.new
       hashing = pwd + salt
@@ -36,10 +49,13 @@ module Faktory
     # MY_FAKTORY_URL=tcp://:somepass@my-server.example.com:7419
     #
     # Note above, the URL can contain the password for secure installations.
-    def initialize(url: uri_from_env || 'tcp://localhost:7419', debug: false)
+    def initialize(url: uri_from_env || 'tcp://localhost:7419', debug: false, timeout: DEFAULT_TIMEOUT)
+      super
       @debug = debug
       @location = URI(url)
-      open
+      @timeout = timeout
+
+      open(@timeout)
     end
 
     def close
@@ -53,23 +69,95 @@ module Faktory
     def flush
       transaction do
         command "FLUSH"
-        ok!
+        ok
+      end
+    end
+
+    def create_batch(batch, &block)
+      bid = transaction do
+        command "BATCH NEW", Faktory.dump_json(batch.to_h)
+        result!
+      end
+      batch.instance_variable_set(:@bid, bid)
+
+      old = Thread.current[:faktory_batch]
+      begin
+        Thread.current[:faktory_batch] = batch
+        # any jobs pushed in this block will implicitly have
+        # their `bid` attribute set so they are associated
+        # with the current batch.
+        yield batch
+      ensure
+        Thread.current[:faktory_batch] = old
+      end
+      transaction do
+        command "BATCH COMMIT", bid
+        ok
       end
+      bid
     end
 
+    def batch_status(bid)
+      transaction do
+        command "BATCH STATUS", bid
+        Faktory.load_json result!
+      end
+    end
+
+    def reopen_batch(b)
+      transaction do
+        command "BATCH OPEN", b.bid
+        ok
+      end
+      old = Thread.current[:faktory_batch]
+      begin
+        Thread.current[:faktory_batch] = b
+        # any jobs pushed in this block will implicitly have
+        # their `bid` attribute set so they are associated
+        # with the current batch.
+        yield b
+      ensure
+        Thread.current[:faktory_batch] = old
+      end
+      transaction do
+        command "BATCH COMMIT", b.bid
+        ok
+      end
+    end
+
+    def get_track(jid)
+      transaction do
+        command "TRACK GET", jid
+        hashstr = result!
+        JSON.parse(hashstr)
+      end
+    end
+
+    # hash must include a 'jid' element
+    def set_track(hash)
+      transaction do
+        command("TRACK SET", Faktory.dump_json(hash))
+        ok
+      end
+    end
+
+    # Push a hash corresponding to a job payload to Faktory.
+    # Hash must contain "jid", "jobtype" and "args" elements at minimum.
+    # Returned value will either be the JID String if successful OR
+    # a symbol corresponding to an error.
     def push(job)
       transaction do
-        command "PUSH", JSON.generate(job)
-        ok!
-        job["jid"]
+        command "PUSH", Faktory.dump_json(job)
+        ok(job["jid"])
       end
     end
 
+    # Returns either a job hash or falsy.
     def fetch(*queues)
       job = nil
       transaction do
         command("FETCH", *queues)
-        job = result
+        job = result!
       end
       JSON.parse(job) if job
     end
@@ -77,34 +165,42 @@ module Faktory
     def ack(jid)
       transaction do
         command("ACK", %Q[{"jid":"#{jid}"}])
-        ok!
+        ok
       end
     end
 
     def fail(jid, ex)
       transaction do
-        command("FAIL", JSON.dump({ message: ex.message[0...1000],
+        command("FAIL", Faktory.dump_json({ message: ex.message[0...1000],
                           errtype: ex.class.name,
                           jid: jid,
                           backtrace: ex.backtrace}))
-        ok!
+        ok
       end
     end
 
     # Sends a heartbeat to the server, in order to prove this
     # worker process is still alive.
     #
+    # You can pass in the current_state of the process, for example during shutdown
+    # quiet and/or terminate can be supplied.
+    #
     # Return a string signal to process, legal values are "quiet" or "terminate".
     # The quiet signal is informative: the server won't allow this process to FETCH
     # any more jobs anyways.
-    def beat
+    def beat(current_state = nil)
       transaction do
-        command("BEAT", %Q[{"wid":"#{@@random_process_wid}"}])
-        str = result
+        if current_state.nil?
+          command("BEAT", %Q[{"wid":"#{@@random_process_wid}"}])
+        else
+          command("BEAT", %Q[{"wid":"#{@@random_process_wid}", "current_state":"#{current_state}"}])
+        end
+
+        str = result!
         if str == "OK"
           str
         else
-          hash = JSON.parse(str)
+          hash = Faktory.load_json(str)
           hash["state"]
         end
       end
@@ -113,8 +209,8 @@ module Faktory
     def info
       transaction do
         command("INFO")
-        str = result
-        JSON.parse(str) if str
+        str = result!
+        Faktory.load_json(str) if str
       end
     end
 
@@ -129,12 +225,14 @@ module Faktory
       @location.scheme =~ /tls/
     end
 
-    def open
+    def open(timeout = DEFAULT_TIMEOUT)
       if tls?
         sock = TCPSocket.new(@location.hostname, @location.port)
+        sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+
         ctx = OpenSSL::SSL::SSLContext.new
         ctx.set_params(verify_mode: OpenSSL::SSL::VERIFY_PEER)
-        ctx.ssl_version = :TLSv1_2
+        ctx.min_version = OpenSSL::SSL::TLS1_2_VERSION
 
         @sock = OpenSSL::SSL::SSLSocket.new(sock, ctx).tap do |socket|
           socket.sync_close = true
@@ -176,11 +274,10 @@ module Faktory
         end
       end
 
-      command("HELLO", JSON.dump(payload))
-      ok!
+      command("HELLO", Faktory.dump_json(payload))
+      ok
     end
 
-
     def command(*args)
       cmd = args.join(" ")
       @sock.puts(cmd)
@@ -189,12 +286,22 @@ module Faktory
 
     def transaction
       retryable = true
+
+      # When using Faktory::Testing, you can get a client which does not actually
+      # have an underlying socket.  Now if you disable testing and try to use that
+      # client, it will crash without a socket.  This open() handles that case to
+      # transparently open a socket.
+      open(@timeout) if !@sock
+
       begin
         yield
-      rescue Errno::EPIPE, Errno::ECONNRESET
+      rescue SystemCallError, SocketError, TimeoutError
         if retryable
           retryable = false
-          open
+
+          @sock.close rescue nil
+          @sock = nil
+          open(@timeout)
           retry
         else
           raise
@@ -205,7 +312,7 @@ module Faktory
     # I love pragmatic, simple protocols.  Thanks antirez!
     # https://redis.io/topics/protocol
     def result
-      line = @sock.gets
+      line = gets
       debug "< #{line}" if @debug
       raise Errno::ECONNRESET, "No response" unless line
       chr = line[0]
@@ -214,11 +321,20 @@ module Faktory
       elsif chr == '$'
         count = line[1..-1].strip.to_i
         return nil if count == -1
-        data = @sock.read(count) if count > 0
-        line = @sock.gets # read extra linefeeds
+        data = read(count) if count > 0
+        line = gets # read extra linefeeds
         data
       elsif chr == '-'
-        raise CommandError, line[1..-1]
+        # Server can respond with:
+        #
+        # -ERR Something unexpected
+        # We raise a CommandError
+        #
+        # -NOTUNIQUE Job not unique
+        # We return ["NOTUNIQUE", "Job not unique"]
+        err = line[1..-1].split(" ", 2)
+        raise CommandError, err[1] if err[0] == "ERR"
+        err
       else
         # this is bad, indicates we need to reset the socket
         # and start fresh
@@ -226,10 +342,17 @@ module Faktory
       end
     end
 
-    def ok!
+    def ok(retval=true)
       resp = result
-      raise CommandError, resp if resp != "OK"
-      true
+      return retval if resp == "OK"
+      return resp[0].to_sym
+    end
+
+    def result!
+      resp = result
+      return nil if resp == nil
+      raise CommandError, resp[0] if !resp.is_a?(String)
+      resp
     end
 
     # FAKTORY_PROVIDER=MY_FAKTORY_URL
@@ -253,4 +376,3 @@ module Faktory
 
   end
 end
-