crono_trigger 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8410e0b2dd3dc398df839baba03aaec050d3e31
-  data.tar.gz: 945ece057b38511d03324505c4fe960420b9f581
+  metadata.gz: 1f57e39321ff772c9fc7a02d4d63d19e991be0eb
+  data.tar.gz: 72949a4a2b1984e90ff27c0acc0f5fc74818a947
 SHA512:
-  metadata.gz: 76e9b4270e9d9ea439106e88e5e031a2489212f4caaf8dedd0e39c0ba3d64189b0a3c7ecc6e67d9dfbdaffcfcfb27cbe8839a4860268c00fcede1f8c5a4f5fd5
-  data.tar.gz: 5adc3071703de67b4d9a894b32e4ede1677dcc119fdb8fdc021fdae4f232e56d297984363eaf5d4d1eec586226841666bef9ffa6d2713e166ff524fc4c583a74
+  metadata.gz: f537b832ef60d83e107946134f6d112d104e984cb6432ed3fcd9da2f95c38ca800c100bef471d8473f398fe18fab3cf2f21db000f921c0d7f9928a72dfa87a09
+  data.tar.gz: f3268eabf16acfeb54aa39246d0315cc1c01f0668f7674d2f3b6e03607f41984a37d0ba0bd0dc51c33cd5d41b4dc3756df891e6179bd5604ff9243b3dcb944b5

data/README.md

@@ -1,4 +1,7 @@
 # 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)
+[![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.
 
@@ -87,6 +90,7 @@ class MailNotification < ActiveRecord::Base
     throw :retry # break execution and retry task
     throw :abort # break execution and raise AbortExecution. AbortExecution is not retried
     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
 end
 ```
@@ -116,18 +120,22 @@ Usage: crono_trigger [options] MODEL [MODEL..]
 
 ### Columns
 
-|name             |type    |required|description                                                                                                                                                  |
-|-----------------|--------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
-|cron             |string  |no      |Recurring schedule formatted by cron style                                                                                                                   |
-|next_execute_at  |datetime|yes     |Timestamp of next execution. Worker executes task if this column <= now                                                                                      |
-|last_executed_at |datetime|no      |Timestamp of last execution                                                                                                                                  |
-|execute_lock     |integer |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      |Timestamp of schedule activated                                                                                                                              |
-|finished_at      |datetime|no      |Timestamp of schedule deactivated                                                                                                                            |
-|last_error_name  |string  |no      |Class name of last error                                                                                                                                     |
-|last_error_reason|string  |no      |Error message of last error                                                                                                                                  |
-|last_error_time  |datetime|no      |Timestamp of last error occured                                                                                                                              |
-|retry_count      |integer |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                                                                                                  |
+
+You can rename some columns.
+ex. `crono_trigger_options[:next_execute_at_column_name] = "next_time"`
 
 ## Development
 

data/crono_trigger.gemspec

@@ -25,12 +25,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency "chrono"
   spec.add_dependency "serverengine"
   spec.add_dependency "concurrent-ruby"
+  spec.add_dependency "tzinfo"
   spec.add_dependency "activerecord", ">= 4.2"
 
   spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "database_rewinder"
   spec.add_development_dependency "timecop"
+  spec.add_development_dependency "rollbar"
   spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "codecov"
 end

data/lib/crono_trigger.rb

@@ -13,6 +13,7 @@ module CronoTrigger
     polling_interval: 5,
     executor_thread: 25,
     model_names: [],
+    error_handlers: [],
   )
 
   def self.config

data/lib/crono_trigger/exception_handler.rb

@@ -0,0 +1,34 @@
+module CronoTrigger
+  class ExceptionHandler
+    def self.handle_exception(record, ex)
+      new(record).handle_exception(ex)
+    end
+
+    def initialize(record)
+      @record = record
+    end
+
+    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)
+        args = [ex, @record]
+        args = arity < 0 ? args : args.take(arity)
+        callable.call(*args)
+      end
+    rescue Exception => e
+      @record.logger.error("CronoTrigger error handler raises error")
+      @record.logger.error(e)
+    end
+
+    private
+
+    def ensure_callable(callable)
+      if callable.respond_to?(:call)
+        return callable, callable.arity
+      elsif callable.is_a?(Symbol)
+        return @record.method(callable), 1
+      end
+    end
+  end
+end

data/lib/crono_trigger/polling_thread.rb

@@ -15,9 +15,9 @@ module CronoTrigger
             model = @model_queue.pop(true)
             poll(model)
           rescue ThreadError => e
-            logger.error(e) unless e.message == "queue empty"
+            @logger.error(e) unless e.message == "queue empty"
           rescue => e
-            logger.error(e)
+            @logger.error(e)
           ensure
             @model_queue << model if model
           end

data/lib/crono_trigger/rollbar.rb

@@ -0,0 +1,25 @@
+require 'rollbar'
+
+module Rollbar
+  class CronoTrigger
+    def self.handle_exception(ex, record)
+      scope = {
+        framework: "CronoTrigger: #{::CronoTrigger::VERSION}",
+        context: "#{record.class}/#{record.id}"
+      }
+
+      Rollbar.scope(scope).error(ex, use_exception_level_filters: true)
+    end
+  end
+end
+
+Rollbar.plugins.define('crono_trigger') do
+  require_dependency('crono_trigger')
+
+  execute! do
+    CronoTrigger.config.error_handlers << proc do |ex, record|
+      Rollbar.reset_notifier!
+      Rollbar::CronoTrigger.handle_exception(ex, record)
+    end
+  end
+end

data/lib/crono_trigger/schedulable.rb

@@ -1,5 +1,9 @@
 require "active_support/concern"
+require "active_support/core_ext/object"
 require "chrono"
+require "tzinfo"
+
+require "crono_trigger/exception_handler"
 
 module CronoTrigger
   module Schedulable
@@ -13,23 +17,32 @@ module CronoTrigger
     include ActiveSupport::Callbacks
 
     included do
-      class_attribute :crono_trigger_options
-      self.crono_trigger_options = {}
+      class_attribute :crono_trigger_options, :executable_conditions
+      self.crono_trigger_options ||= {}
+      self.executable_conditions ||= []
 
       define_model_callbacks :execute
 
       scope :executables, ->(from: Time.current, primary_key_offset: nil, limit: 1000) do
         t = arel_table
 
-        rel = where(t[:next_execute_at].lteq(from))
-          .where(t[:execute_lock].lteq(from.to_i - (crono_trigger_options[:execute_lock_timeout] || DEFAULT_EXECUTE_LOCK_TIMEOUT)))
+        rel = where(t[crono_trigger_column_name(:next_execute_at)].lteq(from))
+          .where(t[crono_trigger_column_name(:execute_lock)].lteq(from.to_i - execute_lock_timeout))
 
-        rel = rel.where(t[:started_at].lteq(from)) if column_names.include?("started_at")
-        rel = rel.where(t[:finished_at].gt(from).or(t[:finished_at].eq(nil)))  if column_names.include?("finished_at")
+        rel = rel.where(t[crono_trigger_column_name(:started_at)].lteq(from)) if column_names.include?(crono_trigger_column_name(:started_at))
+        rel = rel.where(t[crono_trigger_column_name(:finished_at)].gt(from).or(t[crono_trigger_column_name(:finished_at)].eq(nil)))  if column_names.include?(crono_trigger_column_name(:finished_at))
         rel = rel.where(t[primary_key].gt(primary_key_offset)) if primary_key_offset
 
         rel = rel.order("#{quoted_table_name}.#{quoted_primary_key} ASC").limit(limit)
 
+        rel = executable_conditions.reduce(rel) do |merged, pr|
+          if pr.arity == 0
+            merged.merge(instance_exec(&pr))
+          else
+            merged.merge(instance_exec(from, &pr))
+          end
+        end
+
         rel
       end
 
@@ -42,36 +55,56 @@ module CronoTrigger
         transaction do
           records = executables(primary_key_offset: primary_key_offset, limit: limit).lock.to_a
           unless records.empty?
-            where(id: records).update_all(execute_lock: Time.current.to_i)
+            where(id: records).update_all(crono_trigger_column_name(:execute_lock) => Time.current.to_i)
           end
           records
         end
       end
+
+      def crono_trigger_column_name(name)
+        crono_trigger_options["#{name}_column_name".to_sym].try(:to_s) || name.to_s
+      end
+
+      def execute_lock_timeout
+        (crono_trigger_options[:execute_lock_timeout] || DEFAULT_EXECUTE_LOCK_TIMEOUT)
+      end
+
+      private
+
+      def add_executable_conditions(pr)
+        self.executable_conditions << pr
+      end
+
+      def clear_executable_conditions
+        self.executable_conditions.clear
+      end
     end
 
     def do_execute
       run_callbacks :execute do
-        catch(:ok) do
-          catch(:retry) do
-            catch(:abort) do
-              execute
-              throw :ok
+        catch(:ok_without_reset) do
+          catch(:ok) do
+            catch(:retry) do
+              catch(:abort) do
+                execute
+                throw :ok
+              end
+              raise AbortExecution
             end
-            raise AbortExecution
+            retry!
+            return
           end
-          retry!
-          return
+          reset!
         end
-        reset!(true)
       end
     rescue AbortExecution => ex
       save_last_error_info(ex)
-      reset!
+      reset!(false)
 
       raise
     rescue Exception => ex
       save_last_error_info(ex)
-      retry_or_reset!
+      retry_or_reset!(ex)
 
       raise
     end
@@ -81,7 +114,7 @@ module CronoTrigger
 
       now = Time.current
       wait = crono_trigger_options[:exponential_backoff] ? retry_interval * [2 * (retry_count - 1), 1].max : retry_interval
-      attributes = {next_execute_at: now + wait, execute_lock: 0}
+      attributes = {crono_trigger_column_name(:next_execute_at) => now + wait, crono_trigger_column_name(:execute_lock) => 0}
 
       if self.class.column_names.include?("retry_count")
         attributes.merge!(retry_count: retry_count.to_i + 1)
@@ -90,13 +123,13 @@ module CronoTrigger
       update_columns(attributes)
     end
 
-    def reset!(update_last_executed_at = false)
+    def reset!(update_last_executed_at = true)
       logger.info "Reset execution schedule #{self.class}-#{id}" if logger
 
-      attributes = {next_execute_at: calculate_next_execute_at, execute_lock: 0}
+      attributes = {crono_trigger_column_name(:next_execute_at) => calculate_next_execute_at, crono_trigger_column_name(:execute_lock) => 0}
 
-      if update_last_executed_at && self.class.column_names.include?("last_executed_at")
-        attributes.merge!(last_executed_at: Time.current)
+      if update_last_executed_at && self.class.column_names.include?(crono_trigger_column_name(:last_executed_at))
+        attributes.merge!(crono_trigger_column_name(:last_executed_at) => Time.current)
       end
 
       if self.class.column_names.include?("retry_count")
@@ -106,25 +139,45 @@ module CronoTrigger
       update_columns(attributes)
     end
 
+    def assume_executing?
+      execute_lock_timeout = self.class.execute_lock_timeout
+      locking? &&
+        self[crono_trigger_column_name(:execute_lock)] + execute_lock_timeout >= Time.now.to_i
+    end
+
+    def locking?
+      self[crono_trigger_column_name(:execute_lock)] > 0
+    end
+
+    def idling?
+      !locking?
+    end
+
+    def crono_trigger_column_name(name)
+      self.class.crono_trigger_column_name(name)
+    end
+
     private
 
-    def retry_or_reset!
-      if respond_to?(:retry_count) && retry_count.to_i <= retry_limit
+    def retry_or_reset!(ex)
+      if respond_to?(:retry_count) && retry_count.to_i < retry_limit
         retry!
       else
-        reset!
+        CronoTrigger::ExceptionHandler.handle_exception(self, ex)
+        reset!(false)
       end
     end
 
-    def calculate_next_execute_at
-      if respond_to?(:cron) && cron
-        it = Chrono::Iterator.new(cron)
-        it.next
+    def calculate_next_execute_at(now = Time.current)
+      if self[crono_trigger_column_name(:cron)]
+        tz = self[crono_trigger_column_name(:timezone)].try { |zn| TZInfo::Timezone.get(zn) }
+        now = tz ? now.in_time_zone(tz) : now
+        Chrono::NextTime.new(now: now, source: self[crono_trigger_column_name(:cron)]).to_time
       end
     end
 
     def ensure_next_execute_at
-      self.next_execute_at ||= calculate_next_execute_at || Time.current
+      self[crono_trigger_column_name(:next_execute_at)] ||= calculate_next_execute_at || Time.current
     end
 
     def retry_limit
@@ -152,7 +205,7 @@ module CronoTrigger
         attributes.merge!(last_error_time: now)
       end
 
-      update_columns(attributes)
+      update_columns(attributes) unless attributes.empty?
     end
   end
 end

data/lib/crono_trigger/version.rb

@@ -1,3 +1,3 @@
 module CronoTrigger
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

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

@@ -15,6 +15,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= Rails::VERSION::M
       t.string    :cron
       t.datetime  :next_execute_at
       t.datetime  :last_executed_at
+      t.string    :timezone
       t.integer   :execute_lock, limit: 8, default: 0, null: false
       t.datetime  :started_at, null: false
       t.datetime  :finished_at

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

@@ -4,6 +4,7 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= Rails::VERSION::M
     add_column :<%= table_name %>, :cron, :string
     add_column :<%= table_name %>, :next_execute_at, :datetime
     add_column :<%= table_name %>, :last_executed_at, :datetime
+    add_column :<%= table_name %>, :timezone, :string
     add_column :<%= table_name %>, :execute_lock, :integer, limit: 8, default: 0, null: false
     add_column :<%= table_name %>, :started_at, :datetime, null: false
     add_column :<%= table_name %>, :finished_at, :datetime

data/lib/generators/crono_trigger/model/templates/module.rb

@@ -0,0 +1,7 @@
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join('::') %>
+  def self.table_name_prefix
+    '<%= namespaced? ? namespaced_class_path.join('_') : class_path.join('_') %>_'
+  end
+end
+<% end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crono_trigger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - joker1007
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chrono
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_rewinder
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: rollbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -126,30 +140,44 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: '3.0'
+        version: '0'
 description: In Service Asynchronous Job Scheduler for Rails. This gem handles ActiveRecord
   model as schedule definition.
 email:
@@ -175,8 +203,10 @@ files:
 - gemfiles/activerecord-51.gemfile
 - lib/crono_trigger.rb
 - lib/crono_trigger/cli.rb
+- lib/crono_trigger/exception_handler.rb
 - lib/crono_trigger/polling_thread.rb
 - lib/crono_trigger/railtie.rb
+- lib/crono_trigger/rollbar.rb
 - lib/crono_trigger/schedulable.rb
 - lib/crono_trigger/version.rb
 - lib/crono_trigger/worker.rb
@@ -185,6 +215,7 @@ files:
 - lib/generators/crono_trigger/migration/templates/migration.rb
 - lib/generators/crono_trigger/model/model_generator.rb
 - lib/generators/crono_trigger/model/templates/model.rb
+- lib/generators/crono_trigger/model/templates/module.rb
 homepage: https://github.com/joker1007/crono_trigger
 licenses:
 - MIT