crono_trigger 0.5.4 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 414c7d5d5bc3a58298ef4cefaaf5dd23e12e6b2af43b2f269b77ddfa4460e3fa
-  data.tar.gz: 8004dcf5504db3f36c6e0548197842eaf3665cb1957ed8400c39338fc94b5539
+  metadata.gz: 50a79e41f2762ce69d2667b8f9af205a30764986f8f7dab39c6ad26539e35e5d
+  data.tar.gz: 8d10f131f42691ee9e8b4f0479f8959d9ac7f8b3ff3b5e33b03d10c5933d49a0
 SHA512:
-  metadata.gz: 7de0e41900387c9c2f66e1df342645080e98d1058a39a7d4553dc9bd38625c640d2f48ccb360052bc31d614022a0c93bd1a08976d4b766f70c6fbf1de3d03133
-  data.tar.gz: e79b4255892a31cfe73bc673705605549b6ab687712e754d0aa790d45d4e09bc98006b86a52fac6901ad4e433951c15ae5f15ba71b88da60b6297884ee8db224
+  metadata.gz: bf08091433a57d26df8e5fc92098e9e9b19a2693394c7006f60cfb86202f3856d848c2781eb1164436e47ba98ac9bb9e07319ca508092668f94b390735f28fdb
+  data.tar.gz: 6d5cba81e1169e57258fbd410aeaf5ab27a12155c93ad4ca7ec1b64b1fce6f7eca9b0fa57aa0dbaa9bcfa68118c67e0fe0dc64b16e9541cbd6ffb7b36b78012f

data/.github/workflows/rspec.yml

@@ -0,0 +1,27 @@
+name: RSpec
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v2
+    - 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):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/README.md

@@ -1,6 +1,6 @@
 # CronoTrigger
 [![Gem Version](https://badge.fury.io/rb/crono_trigger.svg)](https://badge.fury.io/rb/crono_trigger)
-[![Build Status](https://travis-ci.org/joker1007/crono_trigger.svg?branch=master)](https://travis-ci.org/joker1007/crono_trigger)
+![rspec](https://github.com/joker1007/crono_trigger/actions/workflows/rspec.yml/badge.svg)
 [![codecov](https://codecov.io/gh/joker1007/crono_trigger/branch/master/graph/badge.svg)](https://codecov.io/gh/joker1007/crono_trigger)
 
 Asynchronous Job Scheduler for Rails.
@@ -111,7 +111,7 @@ class MailNotification < ActiveRecord::Base
     send_mail
 
     throw :retry # break execution and retry task
-    throw :abort # break execution and raise AbortExecution. AbortExecution is not retried
+    throw :abort # break execution
     throw :ok    # break execution and handle task as success
     throw :ok_without_reset    # break execution and handle task as success but without schedule reseting and unlocking
   end
@@ -137,10 +137,17 @@ mail.next_execute_at # => next 13:00 with Asia/Japan
 
 #### Run Worker
 
+ues `crono_trigger` command.
+`crono_trigger` command accepts model class names.
+
+For example,
+
 ```
 $ crono_trigger MailNotification
 ```
 
+And other options is following.
+
 ```
 $ crono_trigger --help
 Usage: crono_trigger [options] MODEL [MODEL..]
@@ -160,19 +167,20 @@ Usage: crono_trigger [options] MODEL [MODEL..]
 
 ### Columns
 
-|name             |type    |required|rename|description                                                                                                                                                  |
-|-----------------|--------|--------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
-|cron             |string  |no      |no    |Recurring schedule formatted by cron style                                                                                                                   |
-|next_execute_at  |datetime|yes     |yes   |Timestamp of next execution. Worker executes task if this column <= now                                                                                      |
-|last_executed_at |datetime|no      |yes   |Timestamp of last execution                                                                                                                                  |
-|timezone         |datetime|no      |yes   |Timezone name (Parsed by tzinfo)                                                                                                                             |
-|execute_lock     |integer |yes     |yes   |Timestamp of fetching record in order to hide record from other transaction during execute lock timeout. <br> when execution complete this column is reset to 0|
-|started_at       |datetime|no      |yes   |Timestamp of schedule activated                                                                                                                              |
-|finished_at      |datetime|no      |yes   |Timestamp of schedule deactivated                                                                                                                            |
-|last_error_name  |string  |no      |no    |Class name of last error                                                                                                                                     |
-|last_error_reason|string  |no      |no    |Error message of last error                                                                                                                                  |
-|last_error_time  |datetime|no      |no    |Timestamp of last error occured                                                                                                                              |
-|retry_count      |integer |no      |no    |Retry count. <br> If execution succeed retry_count is reset to 0                                                                                                  |
+| name              | type     | required | rename | description                                                                                                                                                     |
+| ----------------- | -------- | -------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------   |
+| cron              | string   | no       | no     | Recurring schedule formatted by cron style                                                                                                                      |
+| next_execute_at   | datetime | yes      | yes    | Timestamp of next execution. Worker executes task if this column <= now                                                                                         |
+| last_executed_at  | datetime | no       | yes    | Timestamp of last execution                                                                                                                                     |
+| timezone          | datetime | no       | yes    | Timezone name (Parsed by tzinfo)                                                                                                                                |
+| execute_lock      | integer  | yes      | yes    | Timestamp of fetching record in order to hide record from other transaction during execute lock timeout. <br> when execution complete this column is reset to 0 |
+| started_at        | datetime | no       | yes    | Timestamp of schedule activated                                                                                                                                 |
+| finished_at       | datetime | no       | yes    | Timestamp of schedule deactivated                                                                                                                               |
+| last_error_name   | string   | no       | no     | Class name of last error                                                                                                                                        |
+| last_error_reason | string   | no       | no     | Error message of last error                                                                                                                                     |
+| last_error_time   | datetime | no       | no     | Timestamp of last error occured                                                                                                                                 |
+| retry_count       | integer  | no       | no     | Retry count. <br> If execution succeed retry_count is reset to 0                                                                                                |
+| current_cycle_id  | string   | no       | yes    | UUID that is updated when the schedule is resetted successfully                                                                                                 |
 
 You can rename some columns.
 ex. `crono_trigger_options[:next_execute_at_column_name] = "next_time"`

data/lib/crono_trigger/cli.rb

@@ -31,7 +31,7 @@ opt_parser = OptionParser.new do |opts|
   end
 
   opts.on("-c", "--concurrency=SIZE", Integer, "Execute thread size (Default: 25)") do |i|
-    options[:execute_thread] = i
+    options[:executor_thread] = i
   end
 
   opts.on("-l", "--log=LOGFILE", "Set log output destination (Default: STDOUT or ./crono_trigger.log if daemonize is true)") do |log|
@@ -67,7 +67,7 @@ end
 
 CronoTrigger.load_config(options[:config], options[:env]) if options[:config]
 
-%i(polling_thread polling_interval execute_thread).each do |name|
+%i(worker_id polling_thread polling_interval executor_thread).each do |name|
   CronoTrigger.config[name] = options[name] if options[name]
 end
 

data/lib/crono_trigger/execution_tracker.rb

@@ -4,12 +4,25 @@ module CronoTrigger
       @schedulable = schedulable
     end
 
+    def self.track(schedulable, &pr)
+      new(schedulable).track(&pr)
+    end
+
     def track(&pr)
       if @schedulable.track_execution
         begin
           execution = @schedulable.crono_trigger_executions.create_with_timestamp!
-          pr.call
-          execution.complete!
+          result = pr.call
+          case result
+          when :ok
+            execution.complete!
+          when :retry
+            execution.retrying!
+          when :abort
+            execution.aborted!
+          else
+            execution.complete!
+          end
         rescue => e
           execution.error!(e)
           raise

data/lib/crono_trigger/global_exception_handler.rb

@@ -0,0 +1,29 @@
+module CronoTrigger
+  class GlobalExceptionHandler
+    def self.handle_global_exception(ex)
+      new.handle_global_exception(ex)
+    end
+
+    def handle_global_exception(ex)
+      handlers = CronoTrigger.config.global_error_handlers
+      handlers.each do |callable|
+        callable, arity = ensure_callable(callable)
+
+        args = [ex]
+        args = arity < 0 ? args : args.take(arity)
+        callable.call(*args)
+      end
+    rescue Exception => e
+      ActiveRecord::Base.logger.error("CronoTrigger error handler raises error")
+      ActiveRecord::Base.logger.error(e)
+    end
+
+    private
+
+    def ensure_callable(callable)
+      if callable.respond_to?(:call)
+        return callable, callable.arity
+      end
+    end
+  end
+end

data/lib/crono_trigger/models/execution.rb

@@ -11,6 +11,8 @@ module CronoTrigger
         executing: "executing", 
         completed: "completed",
         failed: "failed",
+        retrying: "retrying",
+        aborted: "aborted",
       }
 
       def self.create_with_timestamp!

data/lib/crono_trigger/polling_thread.rb

@@ -22,8 +22,9 @@ module CronoTrigger
               poll(model)
             rescue ThreadError => e
               @logger.error(e) unless e.message == "queue empty"
-            rescue => e
-              @logger.error(e)
+            rescue => ex
+              @logger.error(ex)
+              CronoTrigger::GlobalExceptionHandler.handle_global_exception(ex)
             ensure
               @model_queue << model_name if model_name
             end
@@ -63,14 +64,7 @@ module CronoTrigger
             @executor.post do
               @execution_counter.increment
               begin
-                model.connection_pool.with_connection do
-                  @logger.info "(executor-thread-#{Thread.current.object_id}) Execute #{record.class}-#{record.id}"
-                  begin
-                    record.do_execute
-                  rescue Exception => e
-                    @logger.error(e)
-                  end
-                end
+                process_record(record)
               ensure
                 @execution_counter.decrement
               end
@@ -83,7 +77,19 @@ module CronoTrigger
       end while overflowed_record_ids.empty? && records.any?
     end
 
-    private def unlock_overflowed_records(model, overflowed_record_ids)
+    private 
+
+    def process_record(record)
+      record.class.connection_pool.with_connection do
+        @logger.info "(executor-thread-#{Thread.current.object_id}) Execute #{record.class}-#{record.id}"
+        record.do_execute
+      end
+    rescue Exception => ex
+      @logger.error(ex)
+      CronoTrigger::GlobalExceptionHandler.handle_global_exception(ex)
+    end
+
+    def unlock_overflowed_records(model, overflowed_record_ids)
       model.connection_pool.with_connection do
         unless overflowed_record_ids.empty?
           model.where(id: overflowed_record_ids).crono_trigger_unlock_all!

data/lib/crono_trigger/rollbar.rb

@@ -2,12 +2,15 @@ require 'rollbar'
 
 module Rollbar
   class CronoTrigger
-    def self.handle_exception(ex, record)
+    def self.handle_exception(ex, record = nil)
       scope = {
         framework: "CronoTrigger: #{::CronoTrigger::VERSION}",
-        context: "#{record.class}/#{record.id}"
       }
 
+      if record
+        scope.merge!({context: "#{record.class}/#{record.id}"})
+      end
+
       Rollbar.scope(scope).error(ex, use_exception_level_filters: true)
     end
   end
@@ -18,8 +21,11 @@ Rollbar.plugins.define('crono_trigger') do
 
   execute! do
     CronoTrigger.config.error_handlers << proc do |ex, record|
-      Rollbar.reset_notifier!
       Rollbar::CronoTrigger.handle_exception(ex, record)
     end
+
+    CronoTrigger.config.global_error_handlers << proc do |ex|
+      Rollbar::CronoTrigger.handle_exception(ex)
+    end
   end
 end

data/lib/crono_trigger/schedulable.rb

@@ -20,9 +20,6 @@ module CronoTrigger
       @included_by
     end
 
-    class AbortExecution < StandardError; end
-    class RetryExecution < StandardError; end
-
     extend ActiveSupport::Concern
     include ActiveSupport::Callbacks
 
@@ -59,6 +56,7 @@ module CronoTrigger
         rel
       end
 
+      before_create :set_current_cycle_id
       before_update :update_next_execute_at_if_update_cron
 
       validate :validate_cron_format
@@ -112,37 +110,34 @@ module CronoTrigger
     end
 
     def do_execute
-      execution_tracker = ExecutionTracker.new(self)
-      run_callbacks :execute do
-        execution_tracker.track do
-          catch(:ok_without_reset) do
-            catch(:ok) do
-              catch(:retry) do
-                catch(:abort) do
-                  execute
-                  throw :ok
-                end
-                raise AbortExecution
-              end
-              retry!
-              raise RetryExecution
-            end
-            reset!
-          end
-        end
+      ExecutionTracker.track(self) do
+        do_execute_with_catch
       end
-    rescue AbortExecution => ex
-      save_last_error_info(ex)
-      reset!(false)
-
-      raise
-    rescue RetryExecution => ex
-      save_last_error_info(ex)
     rescue Exception => ex
+      logger.error(ex) if logger
       save_last_error_info(ex)
       retry_or_reset!(ex)
+    end
 
-      raise
+    private def do_execute_with_catch
+      catch(:ok_without_reset) do
+        catch(:ok) do
+          catch(:retry) do
+            catch(:abort) do
+              run_callbacks :execute do
+                execute
+              end
+              throw :ok
+            end
+            abort_execution!
+            return :abort
+          end
+          retry!
+          return :retry
+        end
+        reset!
+        return :ok
+      end
     end
 
     def activate_schedule!(at: Time.current)
@@ -213,10 +208,18 @@ module CronoTrigger
         attributes.merge!(retry_count: 0)
       end
 
+      if self.class.column_names.include?(crono_trigger_column_name(:current_cycle_id))
+        attributes.merge!(crono_trigger_column_name(:current_cycle_id) => SecureRandom.uuid)
+      end
+
       merge_updated_at_for_crono_trigger!(attributes, now)
       update_columns(attributes)
     end
 
+    def abort_execution!
+      reset!(false)
+    end
+
     def crono_trigger_lock!(**attributes)
       attributes = {
         crono_trigger_column_name(:execute_lock) => Time.current.to_i,
@@ -259,7 +262,7 @@ module CronoTrigger
     end
 
     def locking?(at: Time.now)
-      self[crono_trigger_column_name(:execute_lock)] > 0 && 
+      self[crono_trigger_column_name(:execute_lock)] > 0 &&
         self[crono_trigger_column_name(:execute_lock)] >= at.to_f - self.class.execute_lock_timeout
     end
 
@@ -293,7 +296,19 @@ module CronoTrigger
         tz = self[crono_trigger_column_name(:timezone)].try { |zn| TZInfo::Timezone.get(zn) }
         base = [now, self[crono_trigger_column_name(:started_at)]].compact.max
         cron_now = tz ? base.in_time_zone(tz) : base
-        Chrono::NextTime.new(now: cron_now, source: self[crono_trigger_column_name(:cron)]).to_time
+        calculated = Chrono::NextTime.new(now: cron_now, source: self[crono_trigger_column_name(:cron)]).to_time
+
+        return calculated unless self[crono_trigger_column_name(:finished_at)]
+        return if calculated > self[crono_trigger_column_name(:finished_at)]
+
+        calculated
+      end
+    end
+
+    def set_current_cycle_id
+      if self.class.column_names.include?(crono_trigger_column_name(:current_cycle_id)) &&
+          self[crono_trigger_column_name(:current_cycle_id)].nil?
+        self[crono_trigger_column_name(:current_cycle_id)] = SecureRandom.uuid
       end
     end
 

data/lib/crono_trigger/version.rb

@@ -1,3 +1,3 @@
 module CronoTrigger
-  VERSION = "0.5.4"
+  VERSION = "0.6.2"
 end

data/lib/crono_trigger/worker.rb

@@ -1,5 +1,7 @@
 require "active_support/core_ext/string"
 
+require "crono_trigger/global_exception_handler"
+
 module CronoTrigger
   module Worker
     HEARTBEAT_INTERVAL = 60
@@ -100,9 +102,9 @@ module CronoTrigger
           worker_record.polling_model_names = @model_names
           worker_record.last_heartbeated_at = Time.current
           @logger.info("[worker_id:#{@crono_trigger_worker_id}] Send heartbeat to database")
-          worker_record.save
+          worker_record.save!
         rescue => ex
-          p ex
+          CronoTrigger::GlobalExceptionHandler.handle_global_exception(ex)
           stop
         end
       end
@@ -128,6 +130,8 @@ module CronoTrigger
       CronoTrigger::Models::Worker.connection_pool.with_connection do
         CronoTrigger::Models::Worker.find_by(worker_id: @crono_trigger_worker_id)&.destroy
       end
+    rescue => ex
+      CronoTrigger::GlobalExceptionHandler.handle_global_exception(ex)
     end
 
     def handle_signal_from_rdb
@@ -137,6 +141,8 @@ module CronoTrigger
           s.kill_me(to_supervisor: s.signal != "TSTP")
         end
       end
+    rescue => ex
+      CronoTrigger::GlobalExceptionHandler.handle_global_exception(ex)
     end
   end
 end

data/lib/crono_trigger.rb

@@ -19,6 +19,7 @@ module CronoTrigger
     executor_thread: 25,
     model_names: nil,
     error_handlers: [],
+    global_error_handlers: [],
   )
 
   def self.config

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crono_trigger
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.2
 platform: ruby
 authors:
 - joker1007
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chrono
@@ -244,6 +244,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -263,6 +264,7 @@ files:
 - lib/crono_trigger/cli.rb
 - lib/crono_trigger/exception_handler.rb
 - lib/crono_trigger/execution_tracker.rb
+- lib/crono_trigger/global_exception_handler.rb
 - lib/crono_trigger/models/execution.rb
 - lib/crono_trigger/models/signal.rb
 - lib/crono_trigger/models/worker.rb
@@ -323,7 +325,7 @@ homepage: https://github.com/joker1007/crono_trigger
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -338,8 +340,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: In Service Asynchronous Job Scheduler for Rails
 test_files: []