good_job 3.17.4 → 3.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7b833bb3f1b28dca921562c3110e4147d955a98982f2b9481f9f7f2b41aa648
-  data.tar.gz: 4f230602f1f5a2faf5198035f207e6f206bc614078a8bce8f38f71613250a8bd
+  metadata.gz: 2573770a9539b895705eee99e074ec34cc74a1b2fffc491c6b01fe2218792bf3
+  data.tar.gz: 49ae57e1ccfd0cf54421c349b1e0659dab195530f89ecce2bd6f29c37315e86d
 SHA512:
-  metadata.gz: '0990adc9282acc9ad3b387f494b20e716e9f1f6ba37c1ec4da200dd89b53f8dd8d6cac60dc652323127086c837bf08bb02d3c28f1a75d589a1c435a897524b0d'
-  data.tar.gz: 961e5e7e3d522f07572f9031096b940408f3bc7568a46b475d45daeb37ae755e237f497cdbb3221e4419bde4d73a560d743f132359b7ee03ffc8062d24f99b23
+  metadata.gz: aa1cdc0760d2d139acd4f76d95aab2093480930dd04b1a93673510497abb0f5d589ff1d71741d4e6f940d0c983bb003cbadeb06d9702a7b1165ba0f45bb13a47
+  data.tar.gz: 7184e6f9816441a85d2d2574482fbb36ea39a3c0f76bb9a5169df9ee7ad63e7a5f150f110087eba9938bfc87af79745c4a9427391906a04457ed1993b7c2f6f2

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## [v3.18.1](https://github.com/bensheldon/good_job/tree/v3.18.1) (2023-08-30)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.18.0...v3.18.1)
+
+**Implemented enhancements:**
+
+- Respect the configured execution mode, even within the CLI [\#1056](https://github.com/bensheldon/good_job/pull/1056) ([bensheldon](https://github.com/bensheldon))
+
+**Closed issues:**
+
+- Bug: calling `GoodJob.restart` in Puma on\_worker\_boot starts GoodJob regardless of it being in async mode or not [\#1054](https://github.com/bensheldon/good_job/issues/1054)
+- \[Feature Request?\] Config Option to Inline Child-Jobs in Worker Processes [\#1052](https://github.com/bensheldon/good_job/issues/1052)
+- \[Feature Request\] Hook to extend cron schedules [\#1050](https://github.com/bensheldon/good_job/issues/1050)
+
+**Merged pull requests:**
+
+- `GoodJob.restart` should not start capsules \(job execution\) when in a webserver but not in async mode [\#1055](https://github.com/bensheldon/good_job/pull/1055) ([bensheldon](https://github.com/bensheldon))
+
+## [v3.18.0](https://github.com/bensheldon/good_job/tree/v3.18.0) (2023-08-30)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v3.17.4...v3.18.0)
+
+**Implemented enhancements:**
+
+- Support configuring cron schedule dynamically with a block [\#1051](https://github.com/bensheldon/good_job/pull/1051) ([DanielHeath](https://github.com/DanielHeath))
+
 ## [v3.17.4](https://github.com/bensheldon/good_job/tree/v3.17.4) (2023-08-24)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v3.17.3...v3.17.4)

data/README.md

@@ -504,6 +504,10 @@ config.good_job.cron = {
     cron: "0 0,12 * * *",
     class: "AnotherJob",
   },
+  complex_schedule: {
+    class: "ComplexScheduleJob",
+    cron: -> (last_ran) { (last_ran.blank? ? Time.now : last_ran + 14.hours).at_beginning_of_minute }
+  }
   # etc.
 }
 ```

data/app/models/good_job/cron_entry.rb

@@ -27,6 +27,7 @@ module GoodJob # :nodoc:
     def initialize(params = {})
       @params = params
 
+      return if cron_proc?
       raise ArgumentError, "Invalid cron format: '#{cron}'" unless fugit.instance_of?(Fugit::Cron)
     end
 
@@ -41,10 +42,6 @@ module GoodJob # :nodoc:
       params.fetch(:class)
     end
 
-    def cron
-      params.fetch(:cron)
-    end
-
     def set
       params[:set]
     end
@@ -61,16 +58,21 @@ module GoodJob # :nodoc:
       params[:description]
     end
 
-    def next_at
+    def next_at(previously_at: nil)
+      if cron_proc?
+        result = Rails.application.executor.wrap { cron.call(previously_at || last_at) }
+        return Fugit.parse(result).next_time.to_t if result.is_a?(String)
+
+        return result
+
+      end
       fugit.next_time.to_t
     end
 
     def schedule
-      fugit.original
-    end
+      return "Custom schedule" if cron_proc?
 
-    def fugit
-      @_fugit ||= Fugit.parse(cron)
+      fugit.original
     end
 
     def jobs
@@ -80,11 +82,7 @@ module GoodJob # :nodoc:
     def last_at
       return if last_job.blank?
 
-      if GoodJob::Job.column_names.include?('cron_at')
-        (last_job.cron_at || last_job.created_at).localtime
-      else
-        last_job.created_at
-      end
+      (last_job.cron_at || last_job.created_at).localtime
     end
 
     def enabled?
@@ -116,11 +114,7 @@ module GoodJob # :nodoc:
     end
 
     def last_job
-      if GoodJob::Job.column_names.include?('cron_at')
-        jobs.order("cron_at DESC NULLS LAST").first
-      else
-        jobs.order(created_at: :asc).last
-      end
+      jobs.order("cron_at DESC NULLS LAST").first
     end
 
     def display_properties
@@ -138,6 +132,18 @@ module GoodJob # :nodoc:
 
     private
 
+    def cron
+      params.fetch(:cron)
+    end
+
+    def cron_proc?
+      cron.respond_to?(:call)
+    end
+
+    def fugit
+      @_fugit ||= Fugit.parse(cron)
+    end
+
     def set_value
       value = set || {}
       value.respond_to?(:call) ? value.call : value

data/lib/good_job/adapter.rb

@@ -185,7 +185,7 @@ module GoodJob
     # @return [Boolean]
     def execute_async?
       execution_mode == :async_all ||
-        (execution_mode.in?([:async, :async_server]) && in_server_process?)
+        (execution_mode.in?([:async, :async_server]) && GoodJob.configuration.in_webserver?)
     end
 
     # Whether in +:external+ execution mode.
@@ -193,7 +193,7 @@ module GoodJob
     def execute_externally?
       execution_mode.nil? ||
         execution_mode == :external ||
-        (execution_mode.in?([:async, :async_server]) && !in_server_process?)
+        (execution_mode.in?([:async, :async_server]) && !GoodJob.configuration.in_webserver?)
     end
 
     # Whether in +:inline+ execution mode.
@@ -219,21 +219,6 @@ module GoodJob
 
     private
 
-    # Whether running in a web server process.
-    # @return [Boolean, nil]
-    def in_server_process?
-      return @_in_server_process if defined? @_in_server_process
-
-      @_in_server_process = Rails.const_defined?(:Server) || begin
-        self_caller = caller
-
-        self_caller.grep(%r{config.ru}).any? || # EXAMPLE: config.ru:3:in `block in <main>' OR config.ru:3:in `new_from_string'
-          self_caller.grep(%r{puma/request}).any? || # EXAMPLE: puma-5.6.4/lib/puma/request.rb:76:in `handle_request'
-          self_caller.grep(%{/rack/handler/}).any? || # EXAMPLE: iodine-0.7.44/lib/rack/handler/iodine.rb:13:in `start'
-          (Concurrent.on_jruby? && self_caller.grep(%r{jruby/rack/rails_booter}).any?) # EXAMPLE: uri:classloader:/jruby/rack/rails_booter.rb:83:in `load_environment'
-      end
-    end
-
     def send_notify?(active_job)
       return false unless GoodJob.configuration.enable_listen_notify
       return true unless active_job.respond_to?(:good_job_notify)

data/lib/good_job/configuration.rb

@@ -79,6 +79,8 @@ module GoodJob
     def initialize(options, env: ENV)
       @options = options
       @env = env
+
+      @_in_webserver = nil
     end
 
     def validate!
@@ -89,21 +91,24 @@ module GoodJob
     # for more details on possible values.
     # @return [Symbol]
     def execution_mode
-      mode = if GoodJob::CLI.within_exe?
-               :external
-             else
-               options[:execution_mode] ||
-                 rails_config[:execution_mode] ||
-                 env['GOOD_JOB_EXECUTION_MODE']
-             end
+      mode = options[:execution_mode] ||
+             rails_config[:execution_mode] ||
+             env['GOOD_JOB_EXECUTION_MODE']
+      mode = mode.to_sym if mode
 
       if mode
-        mode.to_sym
+        if GoodJob::CLI.within_exe? && [:async, :async_server].include?(mode)
+          :external
+        else
+          mode
+        end
+      elsif GoodJob::CLI.within_exe?
+        :external
       elsif Rails.env.development?
         :async
       elsif Rails.env.test?
         :inline
-      else
+      else # rubocop:disable Lint/DuplicateBranch
         :external
       end
     end
@@ -173,7 +178,7 @@ module GoodJob
 
     # The number of seconds to wait for jobs to finish when shutting down
     # before stopping the thread. +-1+ is forever.
-    # @return [Numeric]
+    # @return [Float]
     def shutdown_timeout
       (
         options[:shutdown_timeout] ||
@@ -245,7 +250,7 @@ module GoodJob
 
     # Number of jobs a {Scheduler} will execute before automatically cleaning up preserved jobs.
     # Positive values will clean up after that many jobs have run, false or 0 will disable, and -1 will clean up after every job.
-    # @return [Integer, nil]
+    # @return [Integer, Boolean, nil]
     def cleanup_interval_jobs
       if rails_config.key?(:cleanup_interval_jobs)
         value = rails_config[:cleanup_interval_jobs]
@@ -349,6 +354,20 @@ module GoodJob
       rails_config[:dashboard_default_locale] || DEFAULT_DASHBOARD_DEFAULT_LOCALE
     end
 
+    # Whether running in a web server process.
+    # @return [Boolean, nil]
+    def in_webserver?
+      return @_in_webserver unless @_in_webserver.nil?
+
+      @_in_webserver = Rails.const_defined?(:Server) || begin
+        self_caller = caller
+        self_caller.grep(%r{config.ru}).any? || # EXAMPLE: config.ru:3:in `block in <main>' OR config.ru:3:in `new_from_string'
+          self_caller.grep(%r{puma/request}).any? || # EXAMPLE: puma-5.6.4/lib/puma/request.rb:76:in `handle_request'
+          self_caller.grep(%{/rack/handler/}).any? || # EXAMPLE: iodine-0.7.44/lib/rack/handler/iodine.rb:13:in `start'
+          (Concurrent.on_jruby? && self_caller.grep(%r{jruby/rack/rails_booter}).any?) # EXAMPLE: uri:classloader:/jruby/rack/rails_booter.rb:83:in `load_environment'
+      end || false
+    end
+
     private
 
     def rails_config

data/lib/good_job/cron_manager.rb

@@ -82,12 +82,13 @@ module GoodJob # :nodoc:
 
     # Enqueues a scheduled task
     # @param cron_entry [CronEntry] the CronEntry object to schedule
-    def create_task(cron_entry)
-      cron_at = cron_entry.next_at
+    # @param previously_at [Date, Time, ActiveSupport::TimeWithZone, nil] the last, +in-memory+, scheduled time the cron task was intended to run
+    def create_task(cron_entry, previously_at: nil)
+      cron_at = cron_entry.next_at(previously_at: previously_at)
       delay = [(cron_at - Time.current).to_f, 0].max
       future = Concurrent::ScheduledTask.new(delay, args: [self, cron_entry, cron_at], executor: @executor) do |thr_scheduler, thr_cron_entry, thr_cron_at|
         # Re-schedule the next cron task before executing the current task
-        thr_scheduler.create_task(thr_cron_entry)
+        thr_scheduler.create_task(thr_cron_entry, previously_at: thr_cron_at)
 
         Rails.application.executor.wrap do
           cron_entry.enqueue(thr_cron_at) if thr_cron_entry.enabled?

data/lib/good_job/version.rb

@@ -2,7 +2,7 @@
 
 module GoodJob
   # GoodJob gem version.
-  VERSION = '3.17.4'
+  VERSION = '3.18.1'
 
   # GoodJob version as Gem::Version object
   GEM_VERSION = Gem::Version.new(VERSION)

data/lib/good_job.rb

@@ -151,6 +151,8 @@ module GoodJob
   # @param timeout [Numeric] Seconds to wait for active threads to finish.
   # @return [void]
   def self.restart(timeout: -1)
+    return if configuration.execution_mode != :async && configuration.in_webserver?
+
     _shutdown_all(Capsule.instances, :restart, timeout: timeout)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 3.17.4
+  version: 3.18.1
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-24 00:00:00.000000000 Z
+date: 2023-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob