roqua-support 0.1.26 → 0.1.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecfd7d74378220979e7a8839f07ea9793a37265c
-  data.tar.gz: 8dfb4a419c0d3bc0222a2f743fcad30fc0e43141
+  metadata.gz: 4bda6e60469417b289cc6b362240df7943ef3a32
+  data.tar.gz: 8b5a13cfbeddc4eb24f7d1cca3fe5c828df019c5
 SHA512:
-  metadata.gz: d69f343ba3c51be195a532a892d8839eea4bea7cea5ee54f23e790f6fb56c2299c3aa1f94de49a1cad22f342c0feb78d5878d3a0bffed9be143d719224b7497f
-  data.tar.gz: 76a3f96b867e176bf948ea7bab491c1abd319b7eb02faf8dbb1f0aed73eb9c7251cef075ee5f51fca81b6383c35f1c05408aded3fda050bd339e77ddab60a668
+  metadata.gz: 8dbd51457aa872e2684042494741aadc952814266fde183c09a7bf48f8a6d969df495fe3f708c39aa5d6fb3d4ecbcf6ad716037177b69fe65b3da5b205ec60e2
+  data.tar.gz: 7f39013acd584c9faead2d9475c0f8ed8fc74b455b4eb621a0596a2fef41482f0b59b7e5fa41c7bb0b8757ed2f1c44bd24875f6bfcc0b02b9084bdca23851779

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.lock*
 InstalledFiles
 _yardoc
 coverage

data/Gemfile.lock

@@ -12,6 +12,7 @@ PATH
       active_interaction (~> 3.0)
       activesupport (>= 3.2, < 6)
       naught (~> 1.0)
+      with_advisory_lock (~> 3.2)
 
 GEM
   remote: https://rubygems.org/
@@ -168,6 +169,8 @@ GEM
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     unicode-display_width (1.3.0)
+    with_advisory_lock (3.2.0)
+      activerecord (>= 3.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -110,6 +110,35 @@ Enable it in a project by calling:
 Roqua::Probes::DelayedJobProbe.enable
 ```
 
+# Scheduling
+
+For running code in a recurring fashion (for example hourly or daily) a scheduling mechanism is included in roqua-support.
+
+To configure the jobs that need to run you need to create the file `config/schedule.rb` in the Rails project that you want
+to schedule jobs for. An example configuration:
+
+```ruby
+Roqua::Scheduling::Schedule.setup do |cron|
+  cron.add_task 'hourly', run_at: Roqua::Scheduling::Schedule::BEGINNING_OF_EVERY_HOUR do
+    # Put code here that you want to run at the first minute of every hour
+  end
+
+  cron.add_task 'daily', run_at: Roqua::Scheduling::Schedule::BEGINNING_OF_EVERY_DAY do
+    # Put code here that you want to run every day at 0:00
+  end
+
+  cron.add_task 'every_10_minutes', run_at: proc { 10.minutes.from_now } do
+    # Put code here that you want to approximately run every 10 minutes. Because the run_at is calculated after a job
+    # is finished the time between jobs will be 10 minutes plus the time the job itself takes.
+  end
+end
+```
+
+Normally the RoQua infrastructure should be prepared so the jobs automatically are run if the application is correctly
+deployed. An AppSignal probe can be used as a fallback for job triggering. It can be enabled by placing the following
+code in a Rails initializer:
+`Roqua::Probes::SchedulingProbe.enable`
+
 ### ActiveInteraction extensions
 
 ```

data/lib/roqua-support.rb

@@ -1,13 +1,23 @@
 require "roqua-support/version"
+require "roqua-support/railtie" if defined?(Rails)
 require "roqua/support"
 
 module Roqua
   module Probes
     autoload :DelayedJobProbe, 'roqua/probes/delayed_job_probe'
+    autoload :SchedulingProbe, 'roqua/probes/scheduling_probe'
   end
 
   module Responders
     autoload :ApiErrorsResponder, 'roqua/responders/api_errors_responder'
     autoload :ActiveInteractionAwareResponder, 'roqua/responders/active_interaction_aware_responder'
   end
+
+  module Scheduling
+    autoload :CronJob, 'roqua/scheduling/cron_job'
+    autoload :CronJobTable, 'roqua/scheduling/cron_job_table'
+    autoload :Scheduler, 'roqua/scheduling/scheduler'
+    autoload :Schedule, 'roqua/scheduling/schedule'
+    autoload :Task, 'roqua/scheduling/task'
+  end
 end

data/lib/roqua-support/railtie.rb

@@ -0,0 +1,16 @@
+module Roqua
+  # Include global rake tasks
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      namespace :roqua do
+        desc 'Check if cron needs to run on this instance of the application'
+        task :cron_ping do
+          ActiveRecord::Base.establish_connection
+          require_relative Rails.root.join('config', 'schedule.rb')
+          Roqua::Scheduling::Scheduler.new.ping
+        end
+      end
+    end
+  end
+end
+  

data/lib/roqua-support/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module Support
-    VERSION = '0.1.26'.freeze
+    VERSION = '0.1.27'.freeze
   end
 end

data/lib/roqua/probes/scheduling_probe.rb

@@ -0,0 +1,15 @@
+require_relative 'base_probe'
+
+module Roqua
+  module Probes
+    class SchedulingProbe
+      extend BaseProbe
+
+      def call
+        ActiveRecord::Base.establish_connection
+        require_relative Rails.root.join('config', 'schedule.rb')
+        Roqua::Scheduling::Scheduler.new.ping
+      end
+    end
+  end
+end

data/lib/roqua/scheduling/cron_job.rb

@@ -0,0 +1,3 @@
+class Roqua::Scheduling::CronJob < ActiveRecord::Base
+  self.table_name = 'roqua_scheduling_cron_jobs'
+end

data/lib/roqua/scheduling/cron_job_table.rb

@@ -0,0 +1,12 @@
+module Roqua::Scheduling::CronJobTable
+  def self.create_cron_jobs_table(schema)
+    schema.create_table :roqua_scheduling_cron_jobs, force: true do |t|
+      t.string     :name, null: false
+      t.datetime   :next_run_at, null: false
+      t.datetime   :completed_at
+      t.timestamps null: false
+    end
+
+    schema.add_index :roqua_scheduling_cron_jobs, :name, unique: true
+  end
+end

data/lib/roqua/scheduling/schedule.rb

@@ -0,0 +1,34 @@
+class Roqua::Scheduling::Schedule
+  attr_reader :tasks
+
+  BEGINNING_OF_EVERY_DAY = proc { Time.now.beginning_of_day + 1.day }
+  BEGINNING_OF_EVERY_HOUR = proc { Time.now.beginning_of_hour + 1.hour }
+
+  def initialize
+    @tasks = {}
+  end
+
+  def add_task(name, options, &block)
+    @tasks[name] = Roqua::Scheduling::Task.new(name, options, block)
+  end
+
+  def self.setup
+    @schedule = Roqua::Scheduling::Schedule.new.tap do |new_schedule|
+      yield(new_schedule)
+      new_schedule.initialize_cronjob_table
+    end
+  end
+
+  def self.current_schedule
+    @schedule ||= Roqua::Scheduling::Schedule.new
+  end
+
+  def initialize_cronjob_table
+    Roqua::Scheduling::CronJob.where('name NOT IN (?)', tasks.values.map(&:name)).delete_all
+
+    tasks.each_value do |task|
+      cron_job = Roqua::Scheduling::CronJob.find_or_initialize_by(name: task.name)
+      cron_job.update next_run_at: task.next_run_at unless cron_job.persisted?
+    end
+  end
+end

data/lib/roqua/scheduling/scheduler.rb

@@ -0,0 +1,47 @@
+require 'with_advisory_lock'
+
+class Roqua::Scheduling::Scheduler
+  def ping
+    with_advisory_lock do
+      jobs_to_run.each do |cron_job|
+        begin
+          run_task cron_job
+        rescue Exception => ex
+          Roqua::Support::Errors.report(ex)
+          raise ex if Rails.env.test?
+        end
+      end
+    end
+  end
+
+  def jobs_to_run
+    Roqua::Scheduling::CronJob.where('next_run_at <= ?', Time.now)
+  end
+
+  def tasks
+    schedule.tasks
+  end
+
+  def schedule
+    Roqua::Scheduling::Schedule.current_schedule
+  end
+
+  def advisory_lock_name
+    "#{ActiveRecord::Base.connection_config[:database]}_cron_lock"
+  end
+
+  private
+
+  def with_advisory_lock
+    ActiveRecord::Base.with_advisory_lock(advisory_lock_name, timeout_seconds: 0) do
+      yield
+    end
+  end
+
+  def run_task(cron_job)
+    task = schedule.tasks[cron_job.name]
+    task.run
+
+    cron_job.update completed_at: Time.now, next_run_at: task.next_run_at
+  end
+end

data/lib/roqua/scheduling/task.rb

@@ -0,0 +1,23 @@
+module Roqua::Scheduling
+  class Task
+    attr_reader :name, :options
+
+    def initialize(name, options, callback)
+      @name = name
+      @options = options
+      @callback = callback
+    end
+
+    def run_at
+      options[:run_at]
+    end
+
+    def next_run_at
+      run_at.call
+    end
+
+    def run
+      @callback.call
+    end
+  end
+end

data/roqua-support.gemspec

@@ -18,15 +18,16 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_dependency 'active_interaction', '~> 3.0'
   gem.add_dependency 'activesupport', '>= 3.2', '< 6'
   gem.add_dependency 'naught', '~> 1.0'
-  gem.add_dependency 'active_interaction', '~> 3.0'
+  gem.add_dependency 'with_advisory_lock', '~> 3.2'
 
+  gem.add_development_dependency 'appsignal', '>= 2.3.1'
   gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'delayed_job_active_record'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '>= 2.12.0', '< 4.0'
-  gem.add_development_dependency 'appsignal', '>= 2.3.1'
-  gem.add_development_dependency 'delayed_job_active_record'
   gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'timecop'
 end

data/spec/roqua/scheduling/scheduler_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+require 'timecop'
+
+describe Roqua::Scheduling::Scheduler do
+  before do
+    Timecop.freeze
+    Roqua::Scheduling::CronJob.delete_all
+  end
+
+  after { Timecop.return }
+
+  subject { described_class.new }
+
+  def setup_daily_and_hourly_schedule
+    Roqua::Scheduling::Schedule.setup do |cron|
+      cron.add_task 'hourly', run_at: Roqua::Scheduling::Schedule::BEGINNING_OF_EVERY_HOUR do
+      end
+
+      cron.add_task 'daily', run_at: Roqua::Scheduling::Schedule::BEGINNING_OF_EVERY_DAY do
+      end
+    end
+  end
+
+  def setup_hourly_schedule
+    Roqua::Scheduling::Schedule.setup do |cron|
+      cron.add_task 'hourly', run_at: Roqua::Scheduling::Schedule::BEGINNING_OF_EVERY_HOUR do
+      end
+    end
+  end
+
+  it 'creates the correct table rows' do
+    expect { setup_daily_and_hourly_schedule }
+      .to change { Roqua::Scheduling::CronJob.all.pluck(:name, :next_run_at, :completed_at) }
+      .from(
+        []
+      )
+      .to(
+        [
+          ['hourly', Time.now.beginning_of_hour + 1.hour, nil],
+          ['daily', Time.now.beginning_of_day + 1.day, nil]
+        ]
+      )
+  end
+
+  it 'removes unused table rows' do
+    setup_daily_and_hourly_schedule
+
+    expect { setup_hourly_schedule }
+      .to change { Roqua::Scheduling::CronJob.all.pluck(:name).sort }
+      .from(['daily', 'hourly']).to(['hourly'])
+  end
+
+  it 'generates a database specific advisory lock name' do
+    expect(ActiveRecord::Base.connection_config[:database]).to eql(':memory:')
+    expect(subject.advisory_lock_name).to eql ':memory:_cron_lock'
+  end
+
+  describe 'with a run_at in the future' do
+    before do
+      Roqua::Scheduling::Schedule.setup do |cron|
+        cron.add_task 'hourly', run_at: proc { 1.minute.from_now } do
+        end
+      end
+    end
+
+    it 'the task will not be run' do
+      expect(subject.schedule.tasks['hourly']).to_not receive(:run)
+      subject.ping
+    end
+  end
+
+  describe 'callbacks' do
+    let(:callback_spy) { spy(:callback) }
+
+    it 'get executed' do
+      Roqua::Scheduling::Schedule.setup do |cron|
+        cron.add_task 'hourly', run_at: proc { 1.minute.ago } do
+          callback_spy.execute
+        end
+      end
+
+      expect(callback_spy).to receive(:execute)
+      subject.ping
+    end
+  end
+
+  describe 'when running multiple times' do
+    before do
+      Timecop.freeze(60.seconds.ago)
+
+      Roqua::Scheduling::Schedule.setup do |cron|
+        cron.add_task 'task', run_at: proc { 30.seconds.from_now } do
+        end
+      end
+    end
+
+    let(:schedule) { Roqua::Scheduling::Schedule.current_schedule }
+
+    it 'the task is only called once' do
+      expect(schedule.tasks['task']).to receive(:run).once
+
+      Timecop.return
+      3.times { Roqua::Scheduling::Scheduler.new.ping }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -19,9 +19,9 @@ ActiveRecord::Base.logger = Delayed::Worker.logger
 ActiveRecord::Migration.verbose = false
 
 ActiveRecord::Schema.define do
-  create_table :delayed_jobs, :force => true do |t|
-    t.integer  :priority, :default => 0
-    t.integer  :attempts, :default => 0
+  create_table :delayed_jobs, force: true do |t|
+    t.integer  :priority, default: 0
+    t.integer  :attempts, default: 0
     t.text     :handler
     t.text     :last_error
     t.datetime :run_at
@@ -33,5 +33,7 @@ ActiveRecord::Schema.define do
     t.timestamps null: false
   end
 
-  add_index :delayed_jobs, [:priority, :run_at], :name => 'delayed_jobs_priority'
+  add_index :delayed_jobs, [:priority, :run_at], name: 'delayed_jobs_priority'
+
+  Roqua::Scheduling::CronJobTable.create_cron_jobs_table(self)
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: roqua-support
 version: !ruby/object:Gem::Version
-  version: 0.1.26
+  version: 0.1.27
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2018-04-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_interaction
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -45,95 +59,95 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: active_interaction
+  name: with_advisory_lock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: appsignal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.3.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: delayed_job_active_record
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.12.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.12.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: appsignal
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: delayed_job_active_record
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -186,6 +200,7 @@ files:
 - gemfiles/rails42.gemfile
 - gemfiles/rails50.gemfile
 - lib/roqua-support.rb
+- lib/roqua-support/railtie.rb
 - lib/roqua-support/version.rb
 - lib/roqua/core_ext/active_interaction/filters/date_time_as_unix_extension.rb
 - lib/roqua/core_ext/active_interaction/filters/duration_filter.rb
@@ -197,8 +212,14 @@ files:
 - lib/roqua/core_ext/fixnum/clamp.rb
 - lib/roqua/probes/base_probe.rb
 - lib/roqua/probes/delayed_job_probe.rb
+- lib/roqua/probes/scheduling_probe.rb
 - lib/roqua/responders/active_interaction_aware_responder.rb
 - lib/roqua/responders/api_errors_responder.rb
+- lib/roqua/scheduling/cron_job.rb
+- lib/roqua/scheduling/cron_job_table.rb
+- lib/roqua/scheduling/schedule.rb
+- lib/roqua/scheduling/scheduler.rb
+- lib/roqua/scheduling/task.rb
 - lib/roqua/support.rb
 - lib/roqua/support/command_runner.rb
 - lib/roqua/support/errors.rb
@@ -220,6 +241,7 @@ files:
 - spec/roqua/probes/delayed_job_probe_spec.rb
 - spec/roqua/responders/active_interaction_aware_responder_spec.rb
 - spec/roqua/responders/api_errors_responder_spec.rb
+- spec/roqua/scheduling/scheduler_spec.rb
 - spec/roqua/support/errors_spec.rb
 - spec/roqua/support/helpers_spec.rb
 - spec/roqua/support/logwrapper_spec.rb
@@ -265,6 +287,7 @@ test_files:
 - spec/roqua/probes/delayed_job_probe_spec.rb
 - spec/roqua/responders/active_interaction_aware_responder_spec.rb
 - spec/roqua/responders/api_errors_responder_spec.rb
+- spec/roqua/scheduling/scheduler_spec.rb
 - spec/roqua/support/errors_spec.rb
 - spec/roqua/support/helpers_spec.rb
 - spec/roqua/support/logwrapper_spec.rb