faktory_worker_ruby 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57f98beb553cb8d38e36d45b1721c15446201a30db101827d277ef7f3b9fb542
-  data.tar.gz: a0d82206d826d345bdcde2271ccf300c8af2ccb7ce4c2140900f00b0330ebeac
+  metadata.gz: fe9fd54ed547e42b198c7cf2e2f056203857f0f16a65aafe7126006102f86b3b
+  data.tar.gz: 9ce604181600566d5991a3e9419f8b48a68d1cf657e8731ef5440eeadff5c4e7
 SHA512:
-  metadata.gz: ed5afdc2c7d07f54b90eb1230d50b1d0bdfb219d3ac6f12d4c2f35c05eb7f0b73c3990c84d65c77567f127c1c082f6e858480165aa0bf1e697bef6aa81517075
-  data.tar.gz: 01ea007ff63b7e91a94cc7134f57d783680b9a2ba88be5677b93a505eb55d8e39d2cec9f53a3503b5270b2cfcf8a16909569082b19c59c6439d7474f402da7db
+  metadata.gz: a344b74590b7e16f361fe2be34b69f1d7b07934f59cad91bc06b21dbc619638ac001591e3a5f3e91dabd57526ce1a612f3f28217fe8b61e28b3a29da3104cb0b
+  data.tar.gz: a23358b7b261355de860f811b33218704e0d1ee760b794dec7977137e3b2996c8badab2bf0d9d420d468ed539c4b07c6b893a7e99c761659187ae081a3343ef4

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.6", "2.7", "3.0", "3.1"]
+        ruby: ["2.7", "3.0", "3.1", "3.2", "3.3"]
     runs-on: ubuntu-latest
     services:
       faktory:

data/.standard.yml

@@ -1,12 +1,9 @@
-ruby_version: 2.5.0
+ruby_version: 2.7.0
 fix: true
 parallel: true
 ignore:
-  - test/**/*
-  - examples/**/*
-  - myapp/**/*
-  - 'lib/faktory.rb':
-    - Lint/InheritException
   - 'lib/**/*':
-    - Lint/RescueException
+    - Style/GlobalVars
+  - 'test/**/*':
+    - Lint/ConstantDefinitionInBlock
     - Style/GlobalVars

data/Changes.md

@@ -1,5 +1,17 @@
 # Changes
 
+## HEAD
+
+- Allow more connections in pool [#455]
+- Minimum Ruby version is now 2.7.
+- Minimum Rails version is now 6.0.
+
+## 1.3.0
+
+- Fix `faktory/testing` [#74]
+- Provide more batch helper methods along with a more complex
+  workflow in `examples/complex_workflow.rb`.
+
 ## 1.2.0
 
 - Dup options before deep merging [#67]

data/Gemfile.lock

@@ -1,69 +1,92 @@
 PATH
   remote: .
   specs:
-    faktory_worker_ruby (1.2.0)
+    faktory_worker_ruby (2.0.0)
       connection_pool (~> 2.2, >= 2.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (7.0.4.2)
-      activesupport (= 7.0.4.2)
+    activejob (7.1.3)
+      activesupport (= 7.1.3)
       globalid (>= 0.3.6)
-    activesupport (7.0.4.2)
+    activesupport (7.1.3)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.2.0)
-    connection_pool (2.3.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
     docile (1.4.0)
-    globalid (1.1.0)
-      activesupport (>= 5.0)
-    i18n (1.12.0)
+    drb (2.2.0)
+      ruby2_keywords
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
+    json (2.7.1)
     language_server-protocol (3.17.0.3)
-    minitest (5.17.0)
-    minitest-hooks (1.5.0)
+    lint_roller (1.1.0)
+    minitest (5.21.2)
+    minitest-hooks (1.5.1)
       minitest (> 5.3)
-    parallel (1.22.1)
-    parser (3.2.0.0)
+    mutex_m (0.2.0)
+    parallel (1.24.0)
+    parser (3.3.0.4)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.6.2)
-    rexml (3.2.5)
-    rubocop (1.42.0)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rubocop (1.59.0)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.1)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.15.2)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
+      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)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.22.1)
+    standard (1.33.0)
       language_server-protocol (~> 3.17.0.2)
-      rubocop (= 1.42.0)
-      rubocop-performance (= 1.15.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.59.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
@@ -76,3 +99,6 @@ DEPENDENCIES
   rake
   simplecov
   standard
+
+BUNDLED WITH
+   2.4.22

data/bin/faktory-worker

@@ -4,7 +4,7 @@
 # RUBYOPT=-w bundle exec faktory
 $TESTING = false
 
-require_relative '../lib/faktory/cli'
+require_relative "../lib/faktory/cli"
 
 begin
   cli = Faktory::CLI.instance
@@ -12,7 +12,7 @@ begin
   cli.run
 rescue => e
   raise e if $DEBUG
-  STDERR.puts e.message
-  STDERR.puts e.backtrace.join("\n")
+  warn e.message
+  warn e.backtrace.join("\n")
   exit 1
 end

data/faktory_worker_ruby.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.executables = ["faktory-worker"]
   gem.files = `git ls-files | grep -Ev '^(test|myapp|examples)'`.split("\n")
   gem.version = Faktory::VERSION
-  gem.required_ruby_version = ">= 2.5.0"
+  gem.required_ruby_version = ">= 2.7.0"
 
   gem.metadata = {
     "homepage_uri" => "https://contribsys.com/faktory",
@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
   }
 
   gem.add_dependency "connection_pool", "~> 2.2", ">= 2.2.2"
-  gem.add_development_dependency "activejob", ">= 5.2.0"
+  gem.add_development_dependency "activejob", ">= 6.0.0"
   gem.add_development_dependency "minitest", "~> 5"
   gem.add_development_dependency "minitest-hooks"
   gem.add_development_dependency "rake"

data/lib/faktory/batch.rb

@@ -91,6 +91,10 @@ module Faktory
       @bid = bid
     end
 
+    def parent=(parent)
+      @parent_bid = parent.bid
+    end
+
     def success=(val)
       raise "Batch cannot be modified once created" if bid
       @success = to_callback(val)

data/lib/faktory/client.rb

@@ -163,7 +163,9 @@ module 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.
+    # NB: aliased by faktory/testing
     def push(job)
+      job = job.transform_keys(&:to_s)
       job["jid"] ||= SecureRandom.hex(12)
       job["queue"] ||= "default"
       raise ArgumentError, "Missing `jobtype` attribute: #{job.inspect}" unless job["jobtype"]
@@ -246,6 +248,7 @@ module Faktory
       @location.scheme =~ /tls/
     end
 
+    # NB: aliased by faktory/testing
     def open_socket(timeout = DEFAULT_TIMEOUT)
       if tls?
         require "openssl"
@@ -344,9 +347,9 @@ module Faktory
       raise Errno::ECONNRESET, "No response" unless line
       chr = line[0]
       if chr == "+"
-        line[1..-1].strip
+        line[1..].strip
       elsif chr == "$"
-        count = line[1..-1].strip.to_i
+        count = line[1..].strip.to_i
         return nil if count == -1
         data = read(count) if count > 0
         _ = gets # read extra linefeeds
@@ -359,7 +362,7 @@ module Faktory
         #
         # -NOTUNIQUE Job not unique
         # We return ["NOTUNIQUE", "Job not unique"]
-        err = line[1..-1].split(" ", 2)
+        err = line[1..].split(" ", 2)
         raise CommandError, err[1] if err[0] == "ERR"
         err
       else

data/lib/faktory/connection.rb

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

data/lib/faktory/job.rb

@@ -23,6 +23,7 @@ module Faktory
   module Job
     attr_accessor :jid
     attr_accessor :bid
+    attr_accessor :_custom
 
     include Faktory::Trackable
 
@@ -37,12 +38,26 @@ module Faktory
       Setter.new(options)
     end
 
+    # this method is typically called within a batch job to reopen
+    # the batch in order to add more jobs.
     def batch
       if bid
         @batch ||= Faktory::Batch.new(bid)
       end
     end
 
+    # this method is typically called within a child batch callback to reopen
+    # the parent batch in order to add more jobs or workflow steps.
+    def parent_batch
+      if parent_bid
+        @parent_batch ||= Faktory::Batch.new(parent_bid)
+      end
+    end
+
+    def parent_bid
+      _custom["_pbid"]
+    end
+
     def logger
       Faktory.logger
     end
@@ -158,7 +173,7 @@ module Faktory
             m = "#{name}="
             undef_method(m) if method_defined?(m) || private_method_defined?(m)
           end
-          define_singleton_method("#{name}=") do |val|
+          define_singleton_method(:"#{name}=") do |val|
             singleton_class.class_eval do
               undef_method(name) if method_defined?(name) || private_method_defined?(name)
               define_method(name) { val }

data/lib/faktory/job_logger.rb

@@ -5,7 +5,7 @@ module Faktory
       logger.info("start".freeze)
       yield
       logger.info("done: #{elapsed(start)} sec")
-    rescue Exception
+    rescue Exception # rubocop:disable Lint/RescueException
       logger.info("fail: #{elapsed(start)} sec")
       raise
     end

data/lib/faktory/logging.rb

@@ -62,7 +62,7 @@ module Faktory
     end
 
     def self.logger=(log)
-      @logger = (log || Logger.new(File::NULL))
+      @logger = log || Logger.new(File::NULL)
     end
 
     def logger

data/lib/faktory/processor.rb

@@ -73,7 +73,7 @@ module Faktory
       @mgr.processor_stopped(self)
     rescue Faktory::Shutdown
       @mgr.processor_stopped(self)
-    rescue Exception => ex
+    rescue Exception => ex # rubocop:disable Lint/RescueException
       @mgr.processor_died(self, ex)
     end
 
@@ -131,6 +131,7 @@ module Faktory
             klass = constantize(payload["jobtype"])
             jobinst = klass.new
             jobinst.jid = payload["jid"]
+            jobinst._custom = payload["custom"]
             yield jobinst
           end
         end
@@ -151,7 +152,7 @@ module Faktory
         # the timeout.  Fail it so we can release any locks server-side
         # and immediately restart it.
         work.fail(shut)
-      rescue Exception => ex
+      rescue Exception => ex # rubocop:disable Lint/RescueException
         handle_exception(ex, {context: "Job raised exception", job: work.job})
         work.fail(ex)
         raise ex

data/lib/faktory/rails.rb

@@ -22,7 +22,7 @@ module Faktory
         # None of this matters on the client-side, only within the Faktory executor itself.
         #
         Faktory.configure_worker do |_|
-          if ::Rails::VERSION::MAJOR < 5
+          if ::Rails::VERSION::MAJOR < 6
             raise "Your current version of Rails, #{::Rails::VERSION::STRING}, is not supported"
           end
 
@@ -58,9 +58,9 @@ module Faktory
     end
   end
 
-  if defined?(::Rails) && ::Rails::VERSION::MAJOR < 5
+  if defined?(::Rails) && ::Rails::VERSION::MAJOR < 6
     warn("**************************************************")
-    warn("🚫 ERROR: Faktory Worker does not support Rails versions under 5.x - please ensure your workers are updated")
+    warn("🚫 ERROR: Faktory Worker does not support Rails version < 6.x")
     warn("**************************************************")
     warn("")
   end

data/lib/faktory/testing.rb

@@ -76,7 +76,7 @@ module Faktory
 
   class Client
     alias_method :real_push, :push
-    alias_method :real_open, :open
+    alias_method :real_open_socket, :open_socket
 
     def push(job)
       if Faktory::Testing.inline?
@@ -94,9 +94,9 @@ module Faktory
       end
     end
 
-    def open(*args)
+    def open_socket(*args)
       unless Faktory::Testing.enabled?
-        real_open(*args)
+        real_open_socket(*args)
       end
     end
   end

data/lib/faktory/util.rb

@@ -15,7 +15,7 @@ module Faktory
 
     def watchdog(last_words)
       yield
-    rescue Exception => ex
+    rescue Exception => ex # rubocop:disable Lint/RescueException
       handle_exception(ex, {context: last_words})
       raise ex
     end

data/lib/faktory/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faktory_worker_ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Mike Perham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-02 00:00:00.000000000 Z
+date: 2024-01-20 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.2.0
+        version: 6.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -147,14 +147,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.4
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Ruby worker for Faktory