cron-table 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae408479bf5161e8a60f21fd10758b7bc9790f2e47eb13517127f78ec09d9174
-  data.tar.gz: 70787c17ee8e536bb73c8226162765e5c7bc6a3b888cc6c3686df83f676004cc
+  metadata.gz: 5d3679f2b53e9c33edb30d8eaf43c20fbacb038113f1b5e86c1d495f3a312429
+  data.tar.gz: fffbfde8b3008a9c29de5de2466098f3e5e6116c0b54d9527d1f30784a977da9
 SHA512:
-  metadata.gz: 82b82aa4118fefa72c3896bb3850e281b8987205ecee857a5266c6674c81613ada788f3090b696e15a15761641cc2f471e7c96bafe4d9547fe5d722d8d58e497
-  data.tar.gz: fe33d54efd7eb2036125202dada55394624a81c17d461d512cda2693cedd4c9f943228dbae0b783ac959b474fec9bfc0298d449df9d7e2d66d99581ac0c86e86
+  metadata.gz: ba77e1aadaf57e1035407aba41c9e3ed1d88358d047a04fe2fe9536b907cae1a37dc105560cfe41aa0c6cbb5b32a11e672f34633a23d741428a4d24b52143114
+  data.tar.gz: a36b8ec47e3a1fd8b3fed8b20282ffa522b5b0feb3f287456bac9796a507822b19ee9e43f68d79ccf56573e05ecbe9adc730bfd87a3571954b574532f9f5e60d

data/README.md

@@ -9,7 +9,31 @@ Basic cron-like system to schedule jobs
 ## Usage
 1. Add `include CronTable::Schedule` to the job
 2. Define cron schedule using `crontable(every: <interval>)`
-3. Use block if cron requires params, eg `crontable(every: 1.day) { perform_later(Time.now) }`
+3. Use block if cron requires params, eg `crontable(every: 1.day) { perform_later(Time.current) }`
+
+## Interval specification
+Use `every` to specify when cron should run. Allowed values include:
+1. Positive `ActiveSupport::Duration` like `1.hour`, `2.days`
+2. Predefined intervals
+  - `midnight`
+  - `noon`
+  - `beginning_of_hour`
+3. Custom interval registered in `CronTable.every`, eg
+```
+  # config/initializers/cron_table.rb
+  CronTable.every[:custom] = ->(context) { rand(1.hour..1.day).from_now }
+```
+
+## Middlewares
+Cron execution can be instrumented using middleware, eg
+```
+module CronTableInstrumentation
+  def process(context)
+    ElasticAPM.with_transaction(context.cron.key, "cron") { super }
+  end
+end
+CronTable.register(CronTableInstrumentation)
+```
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/services/cron_table/server.rb

@@ -1,67 +1,84 @@
-class CronTable::Server
-  SLEEP = 1.second..1.day
-  SLEEP_IDLE = 1.hour
+module CronTable
+  class Server
+    SLEEP = 1.second..1.day
+    SLEEP_IDLE = 1.hour
 
-  def initialize
-  end
+    def initialize
+      @middlewares = Middlewares.new
+    end
 
-  def sync!
-    crons = CronTable.all.clone
-    deleted = []
-    CronTable::Item.transaction do
-      CronTable::Item.lock.all.each do |cron|
-        if definition = crons.delete(cron.key)
-          cron.update(next_run_at: definition.next_run_at(Time.now)) if cron.next_run_at.nil?
-        elsif cron.next_run_at.present?
-          deleted << cron.key
+    def sync!
+      crons = CronTable.all.clone
+      deleted = []
+      Item.transaction do
+        Item.lock.all.each do |cron|
+          if definition = crons.delete(cron.key)
+            context = Context.new(last_run_at: nil)
+            cron.update(next_run_at: definition.next_run_at(context)) if cron.next_run_at.nil?
+          elsif cron.next_run_at.present?
+            deleted << cron.key
+          end
+        end
+        Item.where(key: deleted).update(next_run_at: nil)
+        crons.each do |key, definition|
+          context = Context.new(last_run_at: nil)
+          Item.create(key: key, next_run_at: definition.next_run_at(context))
         end
-      end
-      CronTable::Item.where(key: deleted).update(next_run_at: nil)
-      crons.each do |key, definition|
-        CronTable::Item.create(key: key, next_run_at: definition.next_run_at(Time.now))
       end
     end
-  end
 
-  def run!
-    @exit = false
-    next_run_at = CronTable::Item.minimum(:next_run_at) || SLEEP_IDLE.from_now
-    interruptible_sleep(next_run_at.to_f - Time.now.to_f)
+    def run!
+      Item.connection_pool.with_connection do
+        sync!
+      end
 
-    CronTable::Item.lock.where(next_run_at: ..Time.now).each do |cron|
-      process(cron)
+      @exit = false
+
+      run_once! until exit?
     end
-  end
 
-  def exit!
-    @exit = true
-    interrupt!
-  end
+    def exit!
+      @exit = true
+      interrupt!
+    end
 
-  def exit?
-    @exit.present?
-  end
+    def exit?
+      @exit.present?
+    end
 
-  private
+    private
 
-  def process(cron)
-    Rails.application.reloader.wrap do
-      definition = CronTable.all.fetch(cron.key)
-      definition.call
+    def run_once!
+      next_run_at = Item.connection_pool.with_connection do
+        Item.lock.where(next_run_at: ..Time.now).each do |cron|
+          process(cron)
+        end
+        Item.minimum(:next_run_at) || SLEEP_IDLE.from_now
+      end
+      interruptible_sleep(next_run_at.to_f - Time.now.to_f)
+    end
 
-      cron.update(last_run_at: Time.now, next_run_at: definition.next_run_at(Time.now))
+    def process(cron)
+      Rails.application.reloader.wrap do
+        definition = CronTable.all.fetch(cron.key)
+        context = Context.new(last_run_at: cron.next_run_at, cron: definition)
+        @middlewares.process(context) do
+          definition.call
+        end
+        cron.update(last_run_at: Time.now, next_run_at: definition.next_run_at(context))
+      end
+    rescue => e
+      cron.update(next_run_at: nil)
+      Rails.error.report(e, handled: true, severity: :error, context: { cron: cron.id })
     end
-  rescue => e
-    cron.update(next_run_at: nil)
-    Rails.error.report(e, handled: true, severity: :error, context: { cron: cron.id })
-  end
 
-  def interruptible_sleep(seconds)
-    @sleep, @interrupt = IO.pipe
-    IO.select([@sleep], nil, nil, seconds.to_i.clamp(SLEEP))
-  end
+    def interruptible_sleep(seconds)
+      @sleep, @interrupt = IO.pipe
+      IO.select([@sleep], nil, nil, seconds.to_i.clamp(SLEEP))
+    end
 
-  def interrupt!
-    @interrupt&.close
+    def interrupt!
+      @interrupt&.close
+    end
   end
 end

data/db/migrate/20230723000000_create_cron_table.rb

@@ -1,7 +1,7 @@
 class CreateCronTable < ActiveRecord::Migration[7.0]
   def change
     create_table :cron_table do |t|
-      t.string :key, null: false, unique: true
+      t.string :key, null: false, index: { unique: true }
 
       t.datetime :next_run_at, index: true
       t.datetime :last_run_at

data/lib/cron-table/context.rb

@@ -0,0 +1,4 @@
+module CronTable
+  class Context < Struct.new(:last_run_at, :cron, keyword_init: true)
+  end
+end

data/lib/cron-table/definition.rb

@@ -2,8 +2,13 @@ module CronTable
   class Definition < Struct.new(:key, :every, :block, keyword_init: true)
     delegate :call, to: :block
 
-    def next_run_at(now)
-      now + every
+    def next_run_at(context)
+      case every
+      when ActiveSupport::Duration
+        (context.last_run_at || Time.current) + every
+      when Symbol
+        CronTable.every.fetch(every).call(context)
+      end
     end
   end
 end

data/lib/cron-table/engine.rb

@@ -2,11 +2,21 @@ module CronTable
   class Engine < ::Rails::Engine
     isolate_namespace CronTable
 
+    config.before_initialize do
+      CronTable.every[:midnight] = ->(context) {
+        (context.last_run_at || Time.current).since(1.day).midnight
+      }
+      CronTable.every[:noon] = ->(context) {
+        (context.last_run_at&.since(1.day) || 12.hours.from_now).noon
+      }
+      CronTable.every[:beginning_of_hour] = ->(context) {
+        (context.last_run_at || Time.current).since(1.hour).beginning_of_hour
+      }
+    end
+
     server do
       Thread.new do
-        cron = CronTable::Server.new
-        cron.sync!
-        cron.run until true
+        CronTable::Server.new.run!
       end if CronTable.attach_to_server
     end
   end

data/lib/cron-table/middlewares.rb

@@ -0,0 +1,10 @@
+module CronTable
+  class BaseMiddleware
+    def process(context)
+      yield
+    end
+  end
+
+  class Middlewares < BaseMiddleware
+  end
+end

data/lib/cron-table/schedule.rb

@@ -14,6 +14,14 @@ module CronTable
       def message = "Provide a block to `crontable(..) { }` with code to execute"
     end
 
+    class InvalidEvery < ArgumentError
+      def initialize(every)
+        @every = every
+      end
+
+      def message = "Invalid every: `#{@every.inspect}`"
+    end
+
     extend ActiveSupport::Concern
 
     included do |_base|
@@ -27,6 +35,13 @@ module CronTable
         block ||= -> { self.perform_later } if self.respond_to?(:perform_later)
         raise MissingBlockError if block.nil?
 
+        case every
+        when ActiveSupport::Duration
+        when *CronTable.every.keys
+        else
+          raise InvalidEvery.new(every)
+        end
+
         CronTable.all[key] = Definition.new(key:, every:, block:)
 
         self

data/lib/cron-table/version.rb

@@ -1,3 +1,3 @@
 module CronTable
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/lib/cron-table.rb

@@ -2,12 +2,16 @@ require "cron-table/version"
 require "cron-table/engine"
 require "cron-table/definition"
 require "cron-table/schedule"
+require "cron-table/context"
+require "cron-table/middlewares"
 
 module CronTable
   mattr_accessor :attach_to_server, default: Rails.env.production?
 
   mattr_accessor :preload_dirs, default: ["app/jobs"]
 
+  mattr_accessor :every, default: {}
+
   @@all = nil
   def self.all
     if @@all.nil?
@@ -20,4 +24,8 @@ module CronTable
 
     @@all
   end
+
+  def self.register(middleware)
+    Middlewares.include(middleware)
+  end
 end

data/lib/tasks/cron_table_tasks.rake

@@ -2,11 +2,10 @@ namespace :cron_table do
   desc "Run cron_table scheduler"
   task run: :environment do
     cron = CronTable::Server.new
-    cron.sync!
 
     Signal.trap("INT") { cron.exit! }
     Signal.trap("TERM") { cron.exit! }
 
-    cron.run! until cron.exit?
+    cron.run!
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cron-table
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - twratajczak
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-25 00:00:00.000000000 Z
+date: 2023-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rufo
   requirement: !ruby/object:Gem::Requirement
@@ -70,8 +70,10 @@ files:
 - config/routes.rb
 - db/migrate/20230723000000_create_cron_table.rb
 - lib/cron-table.rb
+- lib/cron-table/context.rb
 - lib/cron-table/definition.rb
 - lib/cron-table/engine.rb
+- lib/cron-table/middlewares.rb
 - lib/cron-table/schedule.rb
 - lib/cron-table/version.rb
 - lib/tasks/cron_table_tasks.rake