scheddy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f3ff142fb2059d543a17e05efa0e607e1a762419a1e14bd6c79c82eb4806872
-  data.tar.gz: a3a1a9a1975148811f85bdc36a92df7d83bada860e2ca9ad7a1f06eabacac40e
+  metadata.gz: adecf31e5c9eb6a72d45ea6b58ea0fa4a3788e32e9fe823d967f1881d4d54016
+  data.tar.gz: 68815c4b88e800c59b72f9fadb359b73ac4eea34db23ea03b7b8f6825f158f0f
 SHA512:
-  metadata.gz: 95d9325b4fa7985dc777b0d722a0a4b5a81ac13a382e0d73e1547c16182442d6f5a073bd17f16d81332876f85c344e2a4180108546fee39f383fcd3dd8d3b03b
-  data.tar.gz: 16cff8b03fc9d4c608f61d41db7d624e532e4e77d92d1e9bb6233c0603b627f38ad2964a5fee39dd4a136679f0b7f38bf1ba34708f1f70925f872ca5596fc54f
+  metadata.gz: 9d9ccdbf34b264d353bdcdf95a9edc8f3780dcfd344c138ceb82692a046cd6a9311774e2c94dc1478fdbbfff3db6ea088f9cca41f46a3a638bbe3bf8a0dee1cb
+  data.tar.gz: 9b58cc75e7d3306350d3dc5a5a8a9ff7beb8216ee094ce0d707494f0e6c064eae886cf517bbb9bd66a76d4b2c758684c0a5c6a894d9099f5541af7100cdf887b

data/README.md

@@ -6,7 +6,7 @@ Scheddy is a batteries-included task scheduler for Rails. It is intended as a re
 * Tiny intervals are great for scheduling workload specific jobs (database field `next_run_at`).
 * Catch up missed tasks. Designed for environments with frequent deploys. Also useful in dev where the scheduler isn't always running.
 * Job-queue agnostic. Works great with various ActiveJob adapters and non-ActiveJob queues too.
-* Minimal dependencies. Uses your existing database; doesn't require Redis.
+* Minimal dependencies. Uses your existing database (or no database at all). Redis not required either.
 * Tasks and their schedules are versioned as part of your code.
 
 
@@ -72,7 +72,7 @@ Scheddy.config do
     # track_runs false    # when run_every is >= 15.minutes, defaults to true; else to false
     perform do
       User.where(welcome_email_at: nil).find_each(batch_size: 100) do |user|
-        WelcomeMailer.welcome_email.with(user: user).deliver_later
+        WelcomeMailer.with(user: user).welcome_email.deliver_later
       end
     end
   end
@@ -136,7 +136,7 @@ A given task will only ever be executed once at a time. Mostly relevant when usi
 
 Tasks may receive an optional context to check if they need to stop for pending shutdown or to know the deadline for completing work before the next cycle would begin.
 
-Deadlines (`finish_before`) are mostly useful if there is occasionally a large block of work combined with tiny intervals. The deadline is calculated with a near 2 second buffer. Only if that's inadequate do you need to adjust further. As already mentioned, Scheddy is smart enough to skip the next cycle if the prior cycle is still running, so handling deadlines is entirely optional.
+Deadlines (`finish_before`) are mostly useful if there is occasionally a large block of work combined with tiny intervals. It may be necessary to calculate your own buffer when comparing against `finish_before` (1 second is shown below). As already mentioned, Scheddy is smart enough to skip the next cycle if the prior cycle is still running, so handling deadlines is entirely optional.
 
 ```ruby
 task 'iterating task' do
@@ -145,7 +145,7 @@ task 'iterating task' do
     Model.where(...).find_each do |model|
       SomeJob.perform_later model.id if model.run_job?
       break if context.stop? # the scheduler has requested to shutdown
-      break if context.finish_before < Time.now # the next cycle is imminent
+      break if context.finish_before < 1.second.from_now # the next cycle is imminent
     end
   end
 end

data/lib/scheddy/cli.rb

@@ -38,6 +38,12 @@ module Scheddy
     end
 
 
+    desc :version, 'Show version'
+    def version
+      puts "Scheddy v#{Scheddy::VERSION}"
+    end
+
+
     no_commands do
 
       def load_app!

data/lib/scheddy/context.rb

@@ -1,9 +1,9 @@
 module Scheddy
   class Context
 
-    def initialize(scheduler, finish_before)
+    def initialize(scheduler, task)
       @scheduler = scheduler
-      @finish_before = finish_before
+      @finish_before = task.finish_before
     end
 
     delegate :stop?, to: :@scheduler

data/lib/scheddy/scheduler.rb

@@ -19,7 +19,7 @@ module Scheddy
       running = tasks.select(&:running?).count
       if running > 0
         puts "[Scheddy] Waiting for #{running} tasks to complete"
-        wait_until(45.seconds.from_now) do
+        wait_until(45.seconds.from_now, skip_stop: true) do
           tasks.none?(&:running?)
         end
         tasks.select(&:running?).each do |task|
@@ -73,9 +73,9 @@ module Scheddy
     end
 
     # &block - optional block - return truthy to end prematurely
-    def wait_until(time)
+    def wait_until(time, skip_stop: false)
       while (now = Time.current) < time
-        return if stop?
+        return if stop? && !skip_stop
         return if block_given? && yield
         sleep [time-now, 1].min
       end

data/lib/scheddy/task.rb

@@ -12,12 +12,16 @@ module Scheddy
         logger.error "Scheddy task '#{name}' already running; skipping this cycle"
         return next_cycle!
       end
-      context = Context.new(scheduler, finish_before)
+      context = Context.new(scheduler, self)
       self.thread =
         Thread.new do
           logger.tagged tag do
             Rails.application.reloader.wrap do
-              task.call(*[context].take(task.arity.abs))
+              if context.finish_before < Time.current
+                logger.info "Rails dev-mode reloader locked for entire task interval; skipping this run"
+              else
+                task.call(*[context].take(task.arity.abs))
+              end
             rescue Exception => e
               if h = Scheddy.error_handler
                 h.call(*[e, self].take(h.arity.abs))
@@ -28,6 +32,12 @@ module Scheddy
           self.thread = nil
         end
       next_cycle!
+    rescue Exception => e
+      logger.error "Scheddy: error scheduling task '#{name}'; retrying in 5 seconds"
+      if h = Scheddy.error_handler
+        h.call(*[e, self].take(h.arity.abs))
+      end
+      return self.next_cycle = 5.seconds.from_now
     end
 
     def kill
@@ -55,7 +65,7 @@ module Scheddy
       }
       case type
       when :interval
-        attrs[:initial_delay] = ActiveSupport::Duration.build(delay) unless track_runs
+        attrs[:initial_delay] = ActiveSupport::Duration.build(delay) unless track_runs && last_run
         attrs[:interval] = ActiveSupport::Duration.build(interval)
       when :cron
         attrs[:cron] = cron.original
@@ -129,14 +139,15 @@ module Scheddy
         end
     end
 
-    def finish_before
+    def finish_before(grace: 0.1.seconds)
       case type
       when :interval
-        Time.current + interval - 2.seconds
+        Time.current + interval - grace
       when :cron
-        cron.next_time.to_utc_time - 2.seconds
+        cron.next_time.to_utc_time - grace
       end
     end
+    public :finish_before
 
 
     def last_run

data/lib/scheddy/version.rb

@@ -1,3 +1,3 @@
 module Scheddy
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scheddy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - thomas morgan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-08 00:00:00.000000000 Z
+date: 2023-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fugit
@@ -85,6 +85,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/zarqman/scheddy
   source_code_uri: https://github.com/zarqman/scheddy
+  changelog_uri: https://github.com/zarqman/scheddy/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: