faktory_worker_ruby 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52c0a1a508d1d2451f4c350b71f0d4091e7c134b8c4b57b802023e0f1527bd1d
-  data.tar.gz: 98fedca04b49b7ab68d8ce398099cfeb92b74d4bd4d3b8951c4f2a15d8d27d10
+  metadata.gz: 7739220174ff556abdf6a357cbcd260b6290c732628b27c8dc01ad00be727dd9
+  data.tar.gz: 3c87db6e71078419a761c6b34dbdcdd3914d5551f4b42f04140a1621c6568b50
 SHA512:
-  metadata.gz: e3a1766171e19dd6750a558dd93eb4734529412674aac18f18b792c716643d5d09e668f0e5ddaf5b291a0c861729a9a29a7918db6b56ac314bbd6d761ab31b6f
-  data.tar.gz: 5c1f3c6d16d42ecb2e90e82ff926d147526ce483cc5b4ac178459935e4b22c6bf4e9816038f82fa317871c53df54ee631a817ebbfc47c42f85a519e12cccee55
+  metadata.gz: b2fc14441abfab58c7cde5401e42adcfe3bb558cd5d5dbf8f6a5db6b176cf2b1d9057370dd0b1daf3d3ca629bb829495bc53167e56e02f0543ec4f89556792ba
+  data.tar.gz: 12b5d2fc13701e3c221b9ef8301bdb5b43806b1058336298393b66fc3f8020eb01d9569a43884a9f789a5df754bd24e987a340a74f12f055ae71a244d0d0763d

data/Changes.md

@@ -1,5 +1,10 @@
 # Changes
 
+## 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

data/Gemfile.lock

@@ -1,48 +1,51 @@
 PATH
   remote: .
   specs:
-    faktory_worker_ruby (1.0.0)
+    faktory_worker_ruby (1.0.1)
       connection_pool (~> 2.2, >= 2.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (5.2.2)
-      activesupport (= 5.2.2)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
       globalid (>= 0.3.6)
-    activesupport (5.2.2)
+    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.1.4)
-    connection_pool (2.2.2)
-    docile (1.3.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.5.3)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    json (2.1.0)
-    minitest (5.11.3)
+    minitest (5.14.1)
     minitest-hooks (1.5.0)
       minitest (> 5.3)
-    rake (12.3.1)
-    simplecov (0.16.1)
+    rake (13.0.1)
+    simplecov (0.18.5)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+      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
+   2.1.4

data/README.md

@@ -34,8 +34,10 @@ server part is [here](https://github.com/contribsys/faktory/)
 
 ## Requirements
 
-* Ruby 2.3 or higher
-* Faktory 0.9 or higher [Installation](https://github.com/contribsys/faktory/wiki/Installation)
+* Ruby 2.5 or higher
+* Faktory 1.2 or higher [Installation](https://github.com/contribsys/faktory/wiki/Installation)
+
+Optionally, Rails 5.2+ for ActiveJob.
 
 ## Installation
 
@@ -95,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

@@ -17,8 +17,8 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = ">= 2.5.0"
 
   gem.add_dependency                  'connection_pool', '~> 2.2', ">= 2.2.2"
-  gem.add_development_dependency      'activejob', '>= 5.1.5'
+  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/client.rb

@@ -3,6 +3,8 @@ require 'json'
 require 'uri'
 require 'digest'
 require 'securerandom'
+require 'timeout'
+require 'faktory/io'
 
 module Faktory
   class BaseError < StandardError; end
@@ -15,6 +17,9 @@ module Faktory
   # 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
@@ -45,6 +50,7 @@ module Faktory
     #
     # Note above, the URL can contain the password for secure installations.
     def initialize(url: uri_from_env || 'tcp://localhost:7419', debug: false, timeout: DEFAULT_TIMEOUT)
+      super
       @debug = debug
       @location = URI(url)
       @timeout = timeout
@@ -220,19 +226,13 @@ module Faktory
     end
 
     def open(timeout = DEFAULT_TIMEOUT)
-      # this is the read/write timeout, not open.
-      secs = Integer(timeout)
-      usecs = Integer((timeout - secs) * 1_000_000)
-      optval = [secs, usecs].pack("l_2")
       if tls?
         sock = TCPSocket.new(@location.hostname, @location.port)
         sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
-        sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, optval)
-        sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDTIMEO, optval)
 
         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
@@ -241,8 +241,6 @@ module Faktory
       else
         @sock = TCPSocket.new(@location.hostname, @location.port)
         @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
-        @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_RCVTIMEO, optval)
-        @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_SNDTIMEO, optval)
       end
 
       payload = {
@@ -297,9 +295,12 @@ module Faktory
 
       begin
         yield
-      rescue Errno::EPIPE, Errno::ECONNRESET
+      rescue SystemCallError, SocketError, TimeoutError
         if retryable
           retryable = false
+
+          @sock.close rescue nil
+          @sock = nil
           open(@timeout)
           retry
         else
@@ -311,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]
@@ -320,8 +321,8 @@ 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 == '-'
         # Server can respond with:

data/lib/faktory/connection.rb

@@ -7,7 +7,7 @@ module Faktory
       def create(options={})
         size = Faktory.worker? ? (Faktory.options[:concurrency] + 2) : 5
         ConnectionPool.new(:timeout => options[:pool_timeout] || 1, :size => size) do
-          Faktory::Client.new(options)
+          Faktory::Client.new(**options)
         end
       end
     end

data/lib/faktory/io.rb

@@ -0,0 +1,51 @@
+require "io/wait"
+
+# this is the necessary magic to get a line-oriented protocol to
+# respect a read timeout. unfortunately Ruby sockets do not provide any
+# timeout support directly, delegating that to the IO reactor.
+module Faktory
+  class TimeoutError < Timeout::Error; end
+
+  module ReadTimeout
+    CRLF = "\r\n"
+    BUFSIZE = 16_384
+
+    # Ruby's TCP sockets do not implement timeouts.
+    # We have to implement them ourselves by using
+    # nonblocking IO and IO.select.
+    def initialize(**opts)
+      @buf = "".dup
+      @timeout = opts[:timeout] || 5
+    end
+
+    def gets
+      while (crlf = @buf.index(CRLF)).nil?
+        @buf << read_timeout(BUFSIZE)
+      end
+
+      @buf.slice!(0, crlf + 2)
+    end
+
+    def read(nbytes)
+      result = @buf.slice!(0, nbytes)
+      result << read_timeout(nbytes - result.bytesize) while result.bytesize < nbytes
+      result
+    end
+
+    private
+    def read_timeout(nbytes)
+      loop do
+        result = @sock.read_nonblock(nbytes, exception: false)
+        if result == :wait_readable
+          raise Faktory::TimeoutError unless @sock.wait_readable(@timeout)
+        elsif result == :wait_writable
+          raise Faktory::TimeoutError unless @sock.wait_writeable(@timeout)
+        elsif result == nil
+          raise Errno::ECONNRESET
+        else
+          return result
+        end
+      end
+    end
+  end
+end

data/lib/faktory/rails.rb

@@ -23,9 +23,19 @@ module Faktory
         if ::Rails::VERSION::MAJOR < 5
           raise "Your current version of Rails, #{::Rails::VERSION::STRING}, is not supported"
         end
-        
+
         Faktory.options[:reloader] = Faktory::Rails::Reloader.new
       end
+
+      begin
+        # https://github.com/rails/rails/pull/41248
+        if defined?(::Mail::SMTP)
+          ::Mail::SMTP::DEFAULTS[:read_timeout] ||= 5
+          ::Mail::SMTP::DEFAULTS[:open_timeout] ||= 5
+        end
+      rescue => ex
+        # ignore
+      end
     end
 
     class Reloader

data/lib/faktory/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Faktory
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faktory_worker_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mike Perham
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.5
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.5
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -76,16 +76,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '0'
 description: Ruby worker for Faktory.
 email:
 - mike@contribsys.com
@@ -112,6 +112,7 @@ files:
 - lib/faktory/connection.rb
 - lib/faktory/exception_handler.rb
 - lib/faktory/fetch.rb
+- lib/faktory/io.rb
 - lib/faktory/job.rb
 - lib/faktory/job_logger.rb
 - lib/faktory/launcher.rb
@@ -132,7 +133,7 @@ homepage: https://github.com/contribsys/faktory_worker_ruby
 licenses:
 - LGPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,8 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.6
+signing_key:
 specification_version: 4
 summary: Ruby worker for Faktory
 test_files: []