crono_trigger 0.8.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05d21540f13b0418eb7a474a2efe964595c09c4a8ae433843cc33f8ea2861dc8
-  data.tar.gz: 989e4b3eb6e55077de647bd4d8626d4a556537f8d4c92f974d8b7475f36d9e43
+  metadata.gz: 855216016010a5117316cfcdf1554d8873e91605d09bbdb226d69ccfaafec918
+  data.tar.gz: ffd42586870d68941253bad9adcf3cee6da83853bba0d2584ba79941104e0775
 SHA512:
-  metadata.gz: 3176b9ccaa96a5676f6c28fb95968c4838a794a06ebe26b2a6ba4777b03487b0ce97d8b43f8a010bb9fb57336f5a2ada76cea9e21fbd642aad3d875fc1bed836
-  data.tar.gz: 33f6cb3606ced81f3a2e09b46d34ba21c7832de5adb57e1d8f6b0f39961363d6477a6d9e35da3cf4a85ac90048f9f65e221a887b5dcc5a3d2461e19881a9eb02
+  metadata.gz: bfecebefd3fc5c422ddc19db8e61014ee47d87e05ff2c0944504ea9fb0196b5352d1d91a72462778a26f5c8a0ada80dd7a6391a79fc3bfaf5c598488ebc4df11
+  data.tar.gz: 01a7b05d5150b3749520b4d29a50377aada67532c14a34eee64c9067b7b571589750169c0045b50a9f9202a52aff1bfb27ab6892366f97c801334e9544cd0698

data/.github/workflows/rspec.yml

@@ -4,7 +4,6 @@ on:
   schedule:
     - cron: "0 9 * * 1"
   push:
-    branches: [ master ]
   pull_request:
 
 jobs:
@@ -13,18 +12,16 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.1', '3.2', '3.3']
-        gemfile: ["Gemfile", "gemfiles/activerecord-61.gemfile", "gemfiles/activerecord-70.gemfile", "gemfiles/activerecord-71.gemfile"]
-        exclude:
-          - ruby-version: '3.2'
-            gemfile: "gemfiles/activerecord-61.gemfile"
-          - ruby-version: '3.3'
-            gemfile: "gemfiles/activerecord-61.gemfile"
+        ruby-version: ['3.4', '4.0']
+        gemfile:
+          - Gemfile
+          - gemfiles/activerecord-71.gemfile
+          - gemfiles/activerecord-80.gemfile
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
@@ -34,3 +31,89 @@ jobs:
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
       run: bundle exec rake
+
+  test-mysql:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.4', '4.0']
+        gemfile:
+          - Gemfile
+          - gemfiles/activerecord-71.gemfile
+          - gemfiles/activerecord-80.gemfile
+    services:
+      mysql:
+        image: mysql:8.4
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
+          MYSQL_DATABASE: test
+        ports:
+          - 3306:3306
+        options: >-
+          --health-cmd "mysqladmin ping -h 127.0.0.1"
+          --health-interval 5s
+          --health-timeout 5s
+          --health-retries 20
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+      DB: mysql
+      DB_HOST: 127.0.0.1
+      DB_PORT: 3306
+      DB_USERNAME: root
+
+    steps:
+    - uses: actions/checkout@v7
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
+      env:
+        # `job` context is only available in step level
+        MYSQL_RESTART_COMMAND: >-
+          docker restart ${{ job.services.mysql.id }} &&
+          until docker exec ${{ job.services.mysql.id }} mysqladmin ping -h 127.0.0.1 --silent; do sleep 1; done
+
+  test-postgresql:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.4', '4.0']
+        gemfile:
+          - Gemfile
+          - gemfiles/activerecord-71.gemfile
+          - gemfiles/activerecord-80.gemfile
+    services:
+      postgres:
+        image: postgres:18
+        env:
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: test
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd "pg_isready -h 127.0.0.1 -U postgres"
+          --health-interval 5s
+          --health-timeout 5s
+          --health-retries 20
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+      DB: postgresql
+      DB_HOST: 127.0.0.1
+      DB_PORT: 5432
+      DB_USERNAME: postgres
+      DB_PASSWORD: postgres
+
+    steps:
+    - uses: actions/checkout@v7
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -21,3 +21,6 @@ spec/dummy/tmp/
 spec/testdb.sqlite3*
 
 .gem_rbs_collection
+
+.envrc
+.nvim.lua

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in crono_trigger.gemspec
 gemspec
+
+gem "mutex_m"

data/README.md

@@ -25,8 +25,38 @@ Or install it yourself as:
 
     $ gem install crono_trigger
 
+## Requirements
+
+CronoTrigger fetches executable records with `SELECT ... FOR UPDATE SKIP LOCKED`.
+So the database must support `SKIP LOCKED` (MySQL 8.0+ or PostgreSQL 9.5+).
+
+CronoTrigger also requires ActiveRecord 7.1+.
+
+If your database does not support `SKIP LOCKED` or you use ActiveRecord < 7.1, use crono_trigger < 1.0.0.
+
+```ruby
+gem 'crono_trigger', '< 1.0.0'
+```
+
 ## Breaking Changes
 
+### Update from v0.8.x
+
+- The database must support `SKIP LOCKED` (MySQL 8.0+ or PostgreSQL 9.5+).
+  Records locked by other workers are skipped instead of waited for.
+  If your database does not support `SKIP LOCKED`, keep using crono_trigger < 1.0.0.
+- ActiveRecord < 7.1 is no longer supported. If you use it, keep using crono_trigger < 1.0.0.
+- The default value of `fetch_records` is changed from `executor_thread * 3` to `1`.
+  See [Tuning `fetch_records`](#tuning-fetch_records).
+- The `worker_count` argument of `executables_with_lock` and `CronoTrigger::PollingThread#worker_count=` are removed.
+- `exponential_backoff` actually doubles the retry interval on each retry (`retry_interval * 2 ** retry_count`).
+  Previously, it increased the interval linearly after the third retry.
+- `crono_trigger` command without MODEL arguments polls all models including `CronoTrigger::Schedulable` as described in its help.
+  Previously, it polled no models.
+
+Because a locking read locks the index records which it scans, make sure that the index starting with `next_execute_at` (See [Migration sample](#migration-sample)) exists.
+Without the index, a polling query might lock much more records than it fetches.
+
 ### Update from v0.6.x
 
 In previous version, now is `2023-06-07T18:00:00+00:00`, a cron definition is `0 1 * * * *`, and `started_at` is `2023-06-08T1:00:00+00:00`.
@@ -170,7 +200,7 @@ Usage: crono_trigger [options] MODEL [MODEL..]
     -p, --polling-thread=SIZE        Polling thread size (Default: 1)
     -i, --polling-interval=SECOND    Polling interval seconds (Default: 5)
     -c, --concurrency=SIZE           Execute thread size (Default: 25)
-    -r, --fetch-records=SIZE         Record count fetched by polling thread (Default: concurrency * 3)
+    -r, --fetch-records=SIZE         Record count fetched by polling thread at once (Default: 1)
     -l, --log=LOGFILE                Set log output destination (Default: STDOUT or ./crono_trigger.log if daemonize is true)
         --log-level=LEVEL            Set log level (Default: info)
     -d, --daemonize                  Daemon mode
@@ -178,6 +208,18 @@ Usage: crono_trigger [options] MODEL [MODEL..]
     -h, --help                       Prints this help
 ```
 
+#### Tuning `fetch_records`
+
+A polling thread fetches and locks `fetch_records` records in a transaction, and repeats it while it can fetch `fetch_records` records.
+By default, it fetches records one by one. It is enough in most cases, and it keeps locking duration short and distributes records evenly to workers.
+
+If there are many jobs and each job finishes quickly, fetching one by one requires a few round trips to database per record and it can be a bottleneck.
+In such case, increase `fetch_records` (for example, the same value as `--concurrency`).
+
+```
+$ crono_trigger --concurrency=25 --fetch-records=25 MailNotification
+```
+
 #### Handle errors
 
 This gem provides the following options to handle errors:
@@ -228,6 +270,10 @@ CronoTrigger.configure do |config|
 end
 ```
 
+NOTE: If the connection is lost right after the transaction that fetches and locks records is committed, the polling thread cannot know that the records have been locked.
+The retry fetches other records, and the locked records are not executed until `execute_lock_timeout` passes.
+They are executed after that as usual, so they are not lost but delayed.
+
 
 ## Specification
 

data/crono_trigger.gemspec

@@ -28,15 +28,16 @@ Gem::Specification.new do |spec|
   spec.add_dependency "tzinfo"
   spec.add_dependency "sinatra"
   spec.add_dependency "rack-contrib"
-  spec.add_dependency "oj"
-  spec.add_dependency "activerecord", ">= 4.2"
+  spec.add_dependency "activerecord", ">= 7.1"
   spec.add_dependency "retriable"
+  spec.add_dependency "ostruct"
 
-  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "sqlite3", ">= 1.3"
   spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "pg"
   spec.add_development_dependency "timecop"
   spec.add_development_dependency "rollbar"
-  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "bundler", ">= 2.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "simplecov"

data/gemfiles/activerecord-71.gemfile

@@ -1,5 +1,6 @@
 source "https://rubygems.org"
 
 gem "activerecord", "~> 7.1.0"
+gem "sqlite3", "~> 1.7"
 
 gemspec :path => "../"

data/gemfiles/{activerecord-61.gemfile → activerecord-80.gemfile}

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 
-gem "activerecord", "~> 6.1.0"
+gem "activerecord", "~> 8.0.0"
 
 gemspec :path => "../"

data/lib/crono_trigger/cli.rb

@@ -34,7 +34,7 @@ opt_parser = OptionParser.new do |opts|
     options[:executor_thread] = i
   end
 
-  opts.on("-r", "--fetch-records=SIZE", Integer, "Record count fetched by polling thread (Default: concurrency * 3)") do |i|
+  opts.on("-r", "--fetch-records=SIZE", Integer, "Record count fetched by polling thread at once (Default: 1)") do |i|
     options[:fetch_records] = i
   end
 
@@ -75,7 +75,7 @@ CronoTrigger.load_config(options[:config], options[:env]) if options[:config]
   CronoTrigger.config[name] = options[name] if options[name]
 end
 
-CronoTrigger.config.model_names = ARGV
+CronoTrigger.config.model_names = ARGV unless ARGV.empty?
 
 se = ServerEngine.create(nil, CronoTrigger::Worker, {
   daemonize: options[:daemonize],

data/lib/crono_trigger/exception_handler.rb

@@ -10,15 +10,16 @@ module CronoTrigger
 
     def handle_exception(ex)
       handlers = CronoTrigger.config.error_handlers + Array(@record.crono_trigger_options[:error_handlers])
-      handlers.each do |callable|
-        callable, arity = ensure_callable(callable)
+      handlers.each do |handler|
+        callable, arity = ensure_callable(handler)
         args = [ex, @record]
         args = arity < 0 ? args : args.take(arity)
         callable.call(*args)
+      # Rescue each handler so that an error in one handler does not prevent the following handlers
+      rescue Exception => e
+        @record.logger&.error("CronoTrigger error handler raises error")
+        @record.logger&.error(e)
       end
-    rescue Exception => e
-      @record.logger.error("CronoTrigger error handler raises error")
-      @record.logger.error(e)
     end
 
     private
@@ -28,6 +29,8 @@ module CronoTrigger
         return callable, callable.arity
       elsif callable.is_a?(Symbol)
         return @record.method(callable), 1
+      else
+        raise ArgumentError, "error handler must respond to `call` or be a Symbol: #{callable.inspect}"
       end
     end
   end

data/lib/crono_trigger/execution_tracker.rb

@@ -23,7 +23,7 @@ module CronoTrigger
           else
             execution.complete!
           end
-        rescue => e
+        rescue Exception => e
           execution.error!(e)
           raise
         end

data/lib/crono_trigger/global_exception_handler.rb

@@ -6,16 +6,17 @@ module CronoTrigger
 
     def handle_global_exception(ex)
       handlers = CronoTrigger.config.global_error_handlers
-      handlers.each do |callable|
-        callable, arity = ensure_callable(callable)
+      handlers.each do |handler|
+        callable, arity = ensure_callable(handler)
 
         args = [ex]
         args = arity < 0 ? args : args.take(arity)
         callable.call(*args)
+      # Rescue each handler so that an error in one handler does not prevent the following handlers
+      rescue Exception => e
+        ActiveRecord::Base.logger&.error("CronoTrigger error handler raises error")
+        ActiveRecord::Base.logger&.error(e)
       end
-    rescue Exception => e
-      ActiveRecord::Base.logger.error("CronoTrigger error handler raises error")
-      ActiveRecord::Base.logger.error(e)
     end
 
     private
@@ -23,6 +24,8 @@ module CronoTrigger
     def ensure_callable(callable)
       if callable.respond_to?(:call)
         return callable, callable.arity
+      else
+        raise ArgumentError, "global error handler must respond to `call`: #{callable.inspect}"
       end
     end
   end

data/lib/crono_trigger/models/execution.rb

@@ -7,23 +7,13 @@ module CronoTrigger
 
       scope :recently, ->(schedule_type:) { where(schedule_type: schedule_type).order(executed_at: :desc) }
 
-      if ActiveRecord.version >= Gem::Version.new("7.0")
-        enum :status, {
-          executing: "executing",
-          completed: "completed",
-          failed: "failed",
-          retrying: "retrying",
-          aborted: "aborted",
-        }
-      else
-        enum status: {
-          executing: "executing",
-          completed: "completed",
-          failed: "failed",
-          retrying: "retrying",
-          aborted: "aborted",
-        }
-      end
+      enum :status, {
+        executing: "executing",
+        completed: "completed",
+        failed: "failed",
+        retrying: "retrying",
+        aborted: "aborted",
+      }
 
       def self.create_with_timestamp!
         create!(executed_at: Time.current, status: :executing, worker_id: CronoTrigger.config.worker_id)

data/lib/crono_trigger/models/signal.rb

@@ -5,11 +5,7 @@ module CronoTrigger
 
       IGNORE_THRESHOLD = 300
 
-      if ActiveRecord.version >= Gem::Version.new("7.0")
-        enum :signal, {TERM: "TERM", USR1: "USR1", CONT: "CONT", TSTP: "TSTP"}
-      else
-        enum signal: {TERM: "TERM", USR1: "USR1", CONT: "CONT", TSTP: "TSTP"}
-      end
+      enum :signal, {TERM: "TERM", USR1: "USR1", CONT: "CONT", TSTP: "TSTP"}
 
       scope :sent_to_me, proc {
         raise "Must set worker_id" unless CronoTrigger.config.worker_id

data/lib/crono_trigger/models/worker.rb

@@ -7,17 +7,9 @@ module CronoTrigger
 
       ALIVE_THRESHOLD = CronoTrigger::Worker::HEARTBEAT_INTERVAL * 5
 
-      if ActiveRecord.version >= Gem::Version.new("7.0")
-        enum :executor_status, {running: "running", quiet: "quiet", shuttingdown: "shuttingdown", shutdown: "shutdown"}
-      else
-        enum executor_status: {running: "running", quiet: "quiet", shuttingdown: "shuttingdown", shutdown: "shutdown"}
-      end
+      enum :executor_status, {running: "running", quiet: "quiet", shuttingdown: "shuttingdown", shutdown: "shutdown"}
 
-      if ActiveRecord.version >= Gem::Version.new("7.1.0")
-        serialize :polling_model_names, coder: JSON
-      else
-        serialize :polling_model_names, JSON
-      end
+      serialize :polling_model_names, coder: JSON
 
       scope :alive_workers, proc { where(arel_table[:last_heartbeated_at].gteq(Time.current - ALIVE_THRESHOLD)) }
     end

data/lib/crono_trigger/polling_thread.rb

@@ -10,7 +10,6 @@ module CronoTrigger
       end
       @execution_counter = execution_counter
       @quiet = Concurrent::AtomicBoolean.new(false)
-      @worker_count = 1
     end
 
     def run
@@ -60,7 +59,7 @@ module CronoTrigger
       while maybe_has_next && !@stop_flag.set?
         records, maybe_has_next = CronoTrigger.retry_on_db_errors do
           model.connection_pool.with_connection do
-            model.executables_with_lock(limit: CronoTrigger.config.fetch_records || CronoTrigger.config.executor_thread * 3, worker_count: @worker_count)
+            model.executables_with_lock(limit: CronoTrigger.config.fetch_records)
           end
         end
 
@@ -77,11 +76,6 @@ module CronoTrigger
       end
     end
 
-    def worker_count=(n)
-      raise ArgumentError, "worker_count must be greater than 0" if n <= 0
-      @worker_count = n
-    end
-
     private
 
     def process_record(record)

data/lib/crono_trigger/schedulable.rb

@@ -63,31 +63,28 @@ module CronoTrigger
     end
 
     module ClassMethods
-      def executables_with_lock(limit: CronoTrigger.config.executor_thread * 3, worker_count: 1)
-        # Fetch more than `limit` records because other workers might have acquired the lock
-        # and this method might not be able to return enough records for the executor to
-        # make the best use of the CPU.
-        ids = executables(limit: limit * worker_count).pluck(:id)
-        maybe_has_next = !ids.empty?
-        records = []
-        ids.each do |id|
-          transaction do
-            r = all.lock.find(id)
-            unless r.locking?
-              r.crono_trigger_lock!
-              records << r
-            end
-          end
+      # Requires a database that supports `FOR UPDATE SKIP LOCKED` (MySQL 8.0+, PostgreSQL 9.5+).
+      # Rows locked by other workers' transactions are skipped instead of waited for.
+      def executables_with_lock(limit: CronoTrigger.config.fetch_records)
+        now = Time.current
+        attributes = {
+          crono_trigger_column_name(:execute_lock) => now.to_i,
+          crono_trigger_column_name(:locked_by) => CronoTrigger.config.worker_id,
+        }
+        attributes["updated_at"] = now if column_names.include?("updated_at")
 
-          return [records, maybe_has_next] if records.size == limit
+        records = transaction do
+          rs = executables(from: now, limit: limit).lock("FOR UPDATE SKIP LOCKED").to_a
+          unscoped.where(primary_key => rs.map(&:id)).update_all(attributes) unless rs.empty?
+          rs
         end
 
-        [records, maybe_has_next]
-      rescue => e
-        raise if records.empty?
+        records.each do |r|
+          r.assign_attributes(attributes)
+          r.clear_changes_information
+        end
 
-        logger&.warn("Failed to fetching some records but continue processing records: #{e} (#{e.class})")
-        [records, maybe_has_next]
+        [records, records.size >= limit]
       end
 
       def crono_trigger_column_name(name)
@@ -112,16 +109,27 @@ module CronoTrigger
 
       private
 
+      # Reassign instead of mutating because class_attribute shares the same object with subclasses
       def add_executable_conditions(pr)
-        self.executable_conditions << pr
+        self.executable_conditions = executable_conditions + [pr]
       end
 
       def clear_executable_conditions
-        self.executable_conditions.clear
+        self.executable_conditions = []
       end
     end
 
+    # A copy does not hold the lock, but `dup` would share the lock state of the original during an execution
+    private def initialize_dup(other)
+      super
+      @crono_trigger_holding_lock = nil
+    end
+
     def do_execute
+      @crono_trigger_holding_lock = {
+        crono_trigger_column_name(:execute_lock) => self[crono_trigger_column_name(:execute_lock)],
+        crono_trigger_column_name(:locked_by) => self[crono_trigger_column_name(:locked_by)],
+      }
       ExecutionTracker.track(self) do
         do_execute_with_catch
       end
@@ -129,6 +137,8 @@ module CronoTrigger
       logger.error(ex) if logger
       save_last_error_info(ex)
       retry_or_reset!(ex)
+    ensure
+      @crono_trigger_holding_lock = nil
     end
 
     private def do_execute_with_catch
@@ -181,10 +191,12 @@ module CronoTrigger
         logger.info "Retry #{self.class}-#{id}" if logger
 
         now = Time.current
+        has_retry_count = self.class.column_names.include?("retry_count")
+        current_retry_count = has_retry_count ? retry_count.to_i : 0
         if immediately
           wait = 0
         else
-          wait = crono_trigger_options[:exponential_backoff] ? retry_interval * [2 * (retry_count - 1), 1].max : retry_interval
+          wait = crono_trigger_options[:exponential_backoff] ? retry_interval * (2 ** current_retry_count) : retry_interval
         end
         attributes = {
           crono_trigger_column_name(:next_execute_at) => now + wait,
@@ -192,12 +204,12 @@ module CronoTrigger
           crono_trigger_column_name(:locked_by) => nil,
         }
 
-        if self.class.column_names.include?("retry_count")
-          attributes.merge!(retry_count: retry_count.to_i + 1)
+        if has_retry_count
+          attributes.merge!(retry_count: current_retry_count + 1)
         end
 
         merge_updated_at_for_crono_trigger!(attributes, now)
-        update_columns(attributes)
+        update_crono_trigger_columns(attributes)
       end
     end
 
@@ -225,7 +237,7 @@ module CronoTrigger
       end
 
       merge_updated_at_for_crono_trigger!(attributes, now)
-      update_columns(attributes)
+      update_crono_trigger_columns(attributes)
     end
 
     def abort_execution!
@@ -392,7 +404,31 @@ module CronoTrigger
       end
 
       merge_updated_at_for_crono_trigger!(attributes)
-      update_columns(attributes) unless attributes.empty?
+      update_crono_trigger_columns(attributes) unless attributes.empty?
+    end
+
+    # While executing, update only if this record still holds the lock acquired before the execution.
+    # Otherwise, the record has been locked by another worker after execute_lock_timeout, and updating it would
+    # overwrite the schedule which another worker is executing.
+    # Outside of executions (e.g. operations from the admin web), update unconditionally as before.
+    def update_crono_trigger_columns(attributes)
+      return update_columns(attributes) unless @crono_trigger_holding_lock
+
+      updated_count = self.class.unscoped
+        .where(self.class.primary_key => id)
+        .where(@crono_trigger_holding_lock)
+        .update_all(attributes)
+      if updated_count.zero?
+        logger&.warn("Skip updating #{self.class}-#{id} because the record has been deleted or locked by another worker")
+        return false
+      end
+
+      attributes.each { |name, value| self[name] = value }
+      clear_attribute_changes(attributes.keys.map(&:to_s))
+      @crono_trigger_holding_lock.each_key do |name|
+        @crono_trigger_holding_lock[name] = attributes[name] if attributes.key?(name)
+      end
+      true
     end
 
     def merge_updated_at_for_crono_trigger!(attributes, time = Time.current)

data/lib/crono_trigger/version.rb

@@ -1,3 +1,3 @@
 module CronoTrigger
-  VERSION = "0.8.3"
+  VERSION = "1.0.0"
 end

data/lib/crono_trigger/web.rb

@@ -1,7 +1,7 @@
 require "crono_trigger"
 require "sinatra/base"
 require "rack/contrib/post_body_content_type_parser"
-require "oj"
+require "active_support/json"
 
 module CronoTrigger
   class Web < Sinatra::Application
@@ -19,9 +19,9 @@ module CronoTrigger
       if params[:format] == "json"
         content_type :json
         @workers = CronoTrigger::Models::Worker.alive_workers
-        Oj.dump({
+        {
           records: @workers,
-        }, mode: :compat)
+        }.to_json
       else
         raise "unknown format"
       end
@@ -35,16 +35,18 @@ module CronoTrigger
       worker_id = params[:worker_id]
       sig = params[:signal]
       if worker_id && sig
-        if CronoTrigger::Models::Signal.send_signal(sig, worker_id)
+        # Check before creating because assigning an undefined enum value raises ArgumentError
+        if CronoTrigger::Models::Signal.signals.key?(sig)
+          CronoTrigger::Models::Signal.send_signal(sig, worker_id)
           status 200
           body ""
         else
           status 422
-          Oj.dump({error: "#{sig} signal is not supported"}, mode: :compat)
+          {error: "#{sig} signal is not supported"}.to_json
         end
       else
         status 422
-        Oj.dump({error: "Must set worker_id and signal"}, mode: :compat)
+        {error: "Must set worker_id and signal"}.to_json
       end
     end
 
@@ -52,9 +54,9 @@ module CronoTrigger
       if params[:format] == "json"
         content_type :json
         @signals = CronoTrigger::Models::Signal.order(sent_at: :desc).limit(30)
-        Oj.dump({
+        {
           records: @signals,
-        }, mode: :compat)
+        }.to_json
       else
         raise "unknown format"
       end
@@ -136,9 +138,9 @@ module CronoTrigger
               -"delay_sec" => r.locking?(at: now) ? 0 : (now - r[r.crono_trigger_column_name(:next_execute_at)]).to_i,
             }
           end
-          Oj.dump({
+          {
             records: records,
-          }, mode: :compat)
+          }.to_json
         else
           status 404
           "Model Class is not found"
@@ -156,9 +158,9 @@ module CronoTrigger
       if params[:format] == "json"
         content_type :json
         @models = CronoTrigger::Schedulable.included_by.map(&:name).sort
-        Oj.dump({
+        {
           models: @models,
-        }, mode: :compat)
+        }.to_json
       else
         raise "unknown format"
       end
@@ -189,9 +191,9 @@ module CronoTrigger
               -"error_reason" => r.error_reason,
             }
           end
-          Oj.dump({
+          {
             records: records,
-          }, mode: :compat)
+          }.to_json
         else
           status 404
           "Model Class is not found"

data/lib/crono_trigger/worker.rb

@@ -7,7 +7,6 @@ module CronoTrigger
     HEARTBEAT_INTERVAL = 60
     SIGNAL_FETCH_INTERVAL = 10
     MONITOR_INTERVAL = 20
-    WORKER_COUNT_UPDATE_INTERVAL = 60
     EXECUTOR_SHUTDOWN_TIMELIMIT = 300
     OTHER_THREAD_SHUTDOWN_TIMELIMIT = 120
     attr_reader :polling_threads
@@ -19,7 +18,9 @@ module CronoTrigger
       @signal_fetch_stop_flag = ServerEngine::BlockingFlag.new
       @monitor_stop_flag = ServerEngine::BlockingFlag.new
       @model_queue = Queue.new
-      @model_names = CronoTrigger.config.model_names || CronoTrigger::Schedulable.included_by
+      # Model names are used as String in PollingThread (`classify`) and serialized to the workers table,
+      # but `included_by` holds Class objects.
+      @model_names = (CronoTrigger.config.model_names.presence || CronoTrigger::Schedulable.included_by).map(&:to_s)
       @model_names.each do |model_name|
         @model_queue << model_name
       end
@@ -45,8 +46,6 @@ module CronoTrigger
       @polling_threads = polling_threads
       @polling_threads.each(&:run)
 
-      @worker_count_updater_thread = run_worker_count_updater_thread
-
       ServerEngine::SignalThread.new do |st|
         st.trap(:TSTP) do
           @logger.info("[worker_id:#{@crono_trigger_worker_id}] Transit to quiet mode")
@@ -61,7 +60,6 @@ module CronoTrigger
       @executor.wait_for_termination(EXECUTOR_SHUTDOWN_TIMELIMIT)
       @heartbeat_thread.join(OTHER_THREAD_SHUTDOWN_TIMELIMIT)
       @signal_fetcn_thread.join(OTHER_THREAD_SHUTDOWN_TIMELIMIT)
-      @worker_count_updater_thread.join(OTHER_THREAD_SHUTDOWN_TIMELIMIT)
 
       unregister
     end
@@ -108,15 +106,6 @@ module CronoTrigger
       end
     end
 
-    def run_worker_count_updater_thread
-      update_worker_count
-      Thread.start do
-        until @stop_flag.wait_for_set(WORKER_COUNT_UPDATE_INTERVAL)
-          update_worker_count
-        end
-      end
-    end
-
     def heartbeat
       CronoTrigger.retry_on_db_errors do
         CronoTrigger::Models::Worker.connection_pool.with_connection do
@@ -209,18 +198,6 @@ module CronoTrigger
       CronoTrigger::GlobalExceptionHandler.handle_global_exception(ex)
     end
 
-    def update_worker_count
-      CronoTrigger.retry_on_db_errors do
-        CronoTrigger::Models::Worker.connection_pool.with_connection do
-          worker_count = workers_processing_same_models.count
-          return if worker_count.zero?
-          @polling_threads.each { |th| th.worker_count = worker_count }
-        end
-      end
-    rescue => ex
-      CronoTrigger::GlobalExceptionHandler.handle_global_exception(ex)
-    end
-
     def workers_processing_same_models
       CronoTrigger.workers.where("polling_model_names = ?", @model_names.to_json)
     end

data/lib/crono_trigger.rb

@@ -19,7 +19,7 @@ module CronoTrigger
     polling_thread: nil,
     polling_interval: 5,
     executor_thread: 25,
-    fetch_records: nil, # default is executor_thread * 3
+    fetch_records: 1,
     model_names: nil,
     error_handlers: [],
     global_error_handlers: [],

data/lib/generators/crono_trigger/install/templates/install.rb

@@ -1,4 +1,4 @@
-class CreateCronoTriggerSystemTables < ActiveRecord::Migration<%= Rails::VERSION::MAJOR >= 5 ? "[#{ActiveRecord::Migration.current_version}]" : "" %>
+class CreateCronoTriggerSystemTables < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
     create_table :crono_trigger_workers, id: :string, primary_key: :worker_id do |t|
       t.integer  :max_thread_size, null: false

data/lib/generators/crono_trigger/migration/templates/create_table_migration.rb

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration<%= Rails::VERSION::MAJOR >= 5 ? "[#{ActiveRecord::Migration.current_version}]" : "" %>
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
     create_table :<%= table_name %><%= respond_to?(:primary_key_type) ? primary_key_type : "" %> do |t|
 <% attributes.each do |attribute| -%>
@@ -26,7 +26,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= Rails::VERSION::M
       t.integer   :retry_count, default: 0, null: false
 
 <% if options[:timestamps] %>
-      t.timestamps<%= Rails::VERSION::MAJOR >=5 ? " null: false" : "" %>
+      t.timestamps null: false
 <% end -%>
     end
 <% attributes.select { |attribute| attribute.respond_to?(:token?) && attribute.token? }.each do |attribute| -%>

data/lib/generators/crono_trigger/migration/templates/migration.rb

@@ -1,4 +1,4 @@
-class <%= migration_class_name %> < ActiveRecord::Migration<%= Rails::VERSION::MAJOR >= 5 ? "[#{ActiveRecord::Migration.current_version}]" : "" %>
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
     # columns for CronoTrigger::Schedulable
     add_column :<%= table_name %>, :cron, :string

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: crono_trigger
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 1.0.0
 platform: ruby
 authors:
 - joker1007
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chrono
@@ -95,35 +94,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: oj
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: retriable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: retriable
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -140,14 +139,14 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
@@ -164,6 +163,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -196,14 +209,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -284,9 +297,8 @@ files:
 - crono_trigger.gemspec
 - exe/crono_trigger
 - exe/crono_trigger-web
-- gemfiles/activerecord-61.gemfile
-- gemfiles/activerecord-70.gemfile
 - gemfiles/activerecord-71.gemfile
+- gemfiles/activerecord-80.gemfile
 - lib/crono_trigger.rb
 - lib/crono_trigger/cli.rb
 - lib/crono_trigger/events.rb
@@ -353,7 +365,6 @@ homepage: https://github.com/joker1007/crono_trigger
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -368,8 +379,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 4.0.20
 specification_version: 4
 summary: In Service Asynchronous Job Scheduler for Rails
 test_files: []

data/gemfiles/activerecord-70.gemfile

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gem "activerecord", "~> 7.0.0"
-
-gemspec :path => "../"