faktory_worker_ruby 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe9fd54ed547e42b198c7cf2e2f056203857f0f16a65aafe7126006102f86b3b
-  data.tar.gz: 9ce604181600566d5991a3e9419f8b48a68d1cf657e8731ef5440eeadff5c4e7
+  metadata.gz: 8df3ceda59c66e2bcb7d04f70fec7de89e6a6219f9159420a9500df7c8a0d35b
+  data.tar.gz: 258295f65b955167b9d89f66aada3b28675368d835362edef694bd50b10f57cd
 SHA512:
-  metadata.gz: a344b74590b7e16f361fe2be34b69f1d7b07934f59cad91bc06b21dbc619638ac001591e3a5f3e91dabd57526ce1a612f3f28217fe8b61e28b3a29da3104cb0b
-  data.tar.gz: a23358b7b261355de860f811b33218704e0d1ee760b794dec7977137e3b2996c8badab2bf0d9d420d468ed539c4b07c6b893a7e99c761659187ae081a3343ef4
+  metadata.gz: 0b02206889ca2ff8b57f3de485a880904b9eb8e422975e78ed23176e753b4cc5ce7d4eca76f65f7f9b0c49c0440503892e26cdc9f960d170a076f8d49570a4d1
+  data.tar.gz: 7e7065afe15d6308245131ab4524fd5d2accdf51590817c91cd83beededd356a3bc4e0132cfc42f1eeb2bfc13bb367eecf8087f6c225d4a939d2f05828709662

data/Changes.md

@@ -1,6 +1,18 @@
 # Changes
 
-## HEAD
+## 2.1.1
+
+- Add new `Faktory::Client#queue_latency` API
+- Require OpenSSL for client
+- Bump requirements for Ruby, Rails
+
+## 2.1.0
+
+- Require ActiveJob 7.0+, connection_pool 2.5+
+- Improve support for TLS connections [#84]
+- Gracefully handle OpenSSL errors during transactions [#83]
+
+## 2.0.0
 
 - Allow more connections in pool [#455]
 - Minimum Ruby version is now 2.7.

data/Gemfile.lock

@@ -1,92 +1,100 @@
 PATH
   remote: .
   specs:
-    faktory_worker_ruby (2.0.0)
-      connection_pool (~> 2.2, >= 2.2.2)
+    faktory_worker_ruby (2.1.0)
+      connection_pool (~> 2.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (7.1.3)
-      activesupport (= 7.1.3)
+    activejob (8.0.2)
+      activesupport (= 8.0.2)
       globalid (>= 0.3.6)
-    activesupport (7.1.3)
+    activesupport (8.0.2)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    ast (2.4.2)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    ast (2.4.3)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
-    concurrent-ruby (1.2.3)
-    connection_pool (2.4.1)
-    docile (1.4.0)
-    drb (2.2.0)
-      ruby2_keywords
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    docile (1.4.1)
+    drb (2.2.1)
     globalid (1.2.1)
       activesupport (>= 6.1)
-    i18n (1.14.1)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
+    json (2.11.3)
+    language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
-    minitest (5.21.2)
-    minitest-hooks (1.5.1)
+    logger (1.7.0)
+    minitest (5.25.5)
+    minitest-hooks (1.5.2)
       minitest (> 5.3)
-    mutex_m (0.2.0)
-    parallel (1.24.0)
-    parser (3.3.0.4)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
+    prism (1.4.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rubocop (1.59.0)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rubocop (1.75.5)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.20.2)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
+    securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    standard (1.33.0)
+    standard (1.49.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.59.0)
+      rubocop (~> 1.75.2)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
+      standard-performance (~> 1.8)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.3.1)
+    standard-performance (1.8.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.2)
+      rubocop-performance (~> 1.25.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
 
 PLATFORMS
   ruby

data/README.md

@@ -34,10 +34,10 @@ server part is [here](https://github.com/contribsys/faktory/)
 
 ## Requirements
 
-* Ruby 2.5 or higher
-* Faktory 1.2 or higher [Installation](https://github.com/contribsys/faktory/wiki/Installation)
+* Ruby 3.2 or higher
+* Faktory 1.9 or higher [Installation](https://github.com/contribsys/faktory/wiki/Installation)
 
-Optionally, Rails 5.2+ for ActiveJob.
+Optionally, Rails 7.0+ for ActiveJob.
 
 ## Installation
 
@@ -79,7 +79,7 @@ bundle exec faktory-worker
 
 Sidekiq is awesome; it's stable and useful. It suffers from two design limitations:
 
-1. Sidekiq uses Redis and Redis is dumb datastore, all Sidekiq features are
+1. Sidekiq uses Redis and Redis is a plain datastore, all Sidekiq features are
    implemented in Ruby and have to travel over the network to access data.
 2. Because of (1), Sidekiq is limited to Ruby.  You can't execute jobs
    with, e.g., Python and get the same Sidekiq features.
@@ -97,4 +97,4 @@ PRs to improve this are very welcome).
 
 ## Author
 
-Mike Perham, @getajobmike, mike @ contribsys.com
+Mike Perham, [@getajobmike](https://ruby.social/@getajobmike), mike @ contribsys.com

data/faktory_worker_ruby.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |gem|
     "source_code_uri" => "https://github.com/contribsys/faktory_worker_ruby"
   }
 
-  gem.add_dependency "connection_pool", "~> 2.2", ">= 2.2.2"
-  gem.add_development_dependency "activejob", ">= 6.0.0"
+  gem.add_dependency "connection_pool", "~> 2.5"
+  gem.add_development_dependency "activejob", ">= 7.0.0"
   gem.add_development_dependency "minitest", "~> 5"
   gem.add_development_dependency "minitest-hooks"
   gem.add_development_dependency "rake"

data/lib/faktory/client.rb

@@ -4,8 +4,8 @@ require "uri"
 require "cgi"
 require "digest"
 require "securerandom"
-require "timeout"
 require "faktory/io"
+require "openssl"
 
 module Faktory
   class BaseError < StandardError; end
@@ -55,9 +55,9 @@ module Faktory
       super
       @debug = debug
       @location = URI(url)
-      @timeout = timeout
+      @sock = nil
 
-      open_socket(@timeout)
+      open_socket
     end
 
     def close
@@ -159,6 +159,15 @@ module Faktory
       end
     end
 
+    def queue_latency(*queues)
+      qs = Array(queues)
+      raise ArgumentError, "no queue given" if qs.empty?
+      transaction do
+        command "QUEUE LATENCY", qs.join(" ")
+        JSON.parse(result!)
+      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
@@ -240,7 +249,7 @@ module Faktory
     private
 
     def debug(line)
-      puts line
+      Faktory.logger.info(line)
     end
 
     def tls?
@@ -249,18 +258,22 @@ module Faktory
     end
 
     # NB: aliased by faktory/testing
-    def open_socket(timeout = DEFAULT_TIMEOUT)
+    def open_socket
+      tlserrors = []
       if tls?
-        require "openssl"
+        tlserrors << ::OpenSSL::SSL::SSLError
         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.min_version = OpenSSL::SSL::TLS1_2_VERSION
+        ENV["FAKTORY_DISABLE_HOSTNAME_VERIFICATION"] ?
+          ctx.set_params(verify_mode: OpenSSL::SSL::VERIFY_NONE) :
+          ctx.set_params(verify_mode: OpenSSL::SSL::VERIFY_PEER)
 
         @sock = OpenSSL::SSL::SSLSocket.new(sock, ctx).tap do |socket|
           socket.sync_close = true
+          socket.hostname = @location.hostname
           socket.connect
         end
       else
@@ -302,6 +315,20 @@ module Faktory
 
       command("HELLO", Faktory.dump_json(payload))
       ok
+    rescue Errno::ECONNRESET, Faktory::TimeoutError
+      # A tcp client talking to a TLS server will get ECONNRESET
+      if tls?
+        raise
+      else
+        raise("Server using TLS? Use FAKTORY_URL=tcp+tls://... to enable encryption")
+      end
+    rescue *tlserrors
+      # A TLS client talking to a TCP server will get OpenSSL::SSL::SSLError
+      if tls?
+        raise("Server not using TLS? Use FAKTORY_URL=tcp://... to disable encryption")
+      else
+        raise
+      end
     end
 
     def command(*args)
@@ -317,11 +344,11 @@ module Faktory
       # 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_socket(@timeout) if !@sock
+      open_socket if !@sock
 
       begin
         yield
-      rescue SystemCallError, SocketError, TimeoutError
+      rescue SystemCallError, SocketError, Faktory::TimeoutError, OpenSSL::SSL::SSLError
         if retryable
           retryable = false
 
@@ -331,7 +358,7 @@ module Faktory
             nil
           end
           @sock = nil
-          open_socket(@timeout)
+          open_socket
           retry
         else
           raise

data/lib/faktory/io.rb

@@ -1,4 +1,5 @@
 require "io/wait"
+require "timeout"
 
 # this is the necessary magic to get a line-oriented protocol to
 # respect a read timeout. unfortunately Ruby sockets do not provide any

data/lib/faktory/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Faktory
-  VERSION = "2.0.0"
+  VERSION = "2.1.1"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: faktory_worker_ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Mike Perham
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-20 00:00:00.000000000 Z
+date: 2025-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -16,34 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -139,7 +132,6 @@ metadata:
   documentation_uri: https://github.com/contribsys/faktory_worker_ruby/wiki
   changelog_uri: https://github.com/contribsys/faktory_worker_ruby/blob/master/Changes.md
   source_code_uri: https://github.com/contribsys/faktory_worker_ruby
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,8 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby worker for Faktory
 test_files: []