roqua-support 0.1.31 → 0.1.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed3f4fd495ac70793c3205d0ef1d26c30660c7e8
-  data.tar.gz: 673b3bee6a8251f9cb0f2c8700f9e42c0444a5c9
+  metadata.gz: a9d0ec0470625062a0df4edb555e4147b66ad68d
+  data.tar.gz: 7a6a0a0a4724b6c669d33f270c287440c0aa854f
 SHA512:
-  metadata.gz: cc14ae28e46cc910743f30789d8aa133a662353272b1a2650dabb905cf69b39fd1feb5a3b8b71db03655d0bdc5246b806ac5c616f1154815dc2702b1e55b6a91
-  data.tar.gz: e4bdbcae705a0c8b1879602ed920c1798106b0c9458ea6a55b3e4f4cb52602466ba7a5db78faccbd823cbdeb96daaf7673ce117cb580fdd091d4a01bb30edd0c
+  metadata.gz: cbd3b91615e9541dbef76167809a7fe2e50134a810605d9aa46aafa75d3f16bfc192f037dbebc34b4919b09950060b5014d925022ed9d15fa1ace34acf259317
+  data.tar.gz: 96ffc851835f35ff9a866fff1c9d7152a85d14ae93599759d554bace1e8352f364099233cb6549d5e7c619cc25d6bda1211efd9412e0ccd689ac562a0339dbde

data/.gitlab-ci.yml

@@ -1,26 +1,52 @@
-image: "registry.roqua.nl/roqua/roqua-build-images:ruby-2.3-rails-base-test"
-
 variables:
   RAILS_ENV: "test"
 
-cache:
-  paths:
-    - .gems
-
 before_script:
   - export BUNDLE_PATH=$CI_PROJECT_DIR/.gems
   - bundle --jobs 2 --retry 3
   - bundle exec appraisal
   - bundle --jobs 2 --retry 3
 
-rails_41:
+.ruby_23: &ruby_23
+  image: registry.roqua.nl/roqua/roqua-build-images:ruby-2.3-rails-base-test
+  cache:
+    key: ruby_23
+    paths:
+      - .gems
+
+.ruby_24: &ruby_24
+  image: registry.roqua.nl/roqua/roqua-build-images:ruby-2.4-rails-base-test
+  cache:
+    key: ruby_24
+    paths:
+      - .gems
+
+rails_41_ruby_23:
+  <<: *ruby_23
   script:
     - bundle exec appraisal rails41 bundle exec rspec
 
-rails_42:
+rails_42_ruby_23:
+  <<: *ruby_23
   script:
     - bundle exec appraisal rails42 bundle exec rspec
 
-rails_50:
+rails_50_ruby_23:
+  <<: *ruby_23
   script:
     - bundle exec appraisal rails50 bundle exec rspec
+
+rails_50_ruby_24:
+  <<: *ruby_24
+  script:
+    - bundle exec appraisal rails50 bundle exec rspec
+
+rails_51_ruby_23:
+  <<: *ruby_23
+  script:
+    - bundle exec appraisal rails51 bundle exec rspec
+
+rails_51_ruby_24:
+  <<: *ruby_24
+  script:
+    - bundle exec appraisal rails51 bundle exec rspec

data/Appraisals

@@ -9,3 +9,7 @@ end
 appraise "rails50" do
   gem "activesupport", "5.0"
 end
+
+appraise "rails51" do
+  gem "activesupport", "5.1"
+end

data/Gemfile

@@ -11,6 +11,7 @@ group :test do
   gem 'active_interaction', '~> 3.0'
   gem 'appsignal'
   gem 'combustion', '~> 0.5.2'
+  gem 'fakefs', require: 'fakefs/safe'
   gem 'guard-rspec', '~> 4.2.6'
   gem 'responders'
   gem 'rspec-instrumentation-matcher'

data/Gemfile.lock

@@ -65,6 +65,7 @@ GEM
       delayed_job (>= 3.0, < 5)
     diff-lcs (1.3)
     erubis (2.7.0)
+    fakefs (0.15.0)
     ffi (1.9.17)
     formatador (0.2.5)
     guard (2.14.0)
@@ -183,6 +184,7 @@ DEPENDENCIES
   bundler (~> 1.0)
   combustion (~> 0.5.2)
   delayed_job_active_record
+  fakefs
   guard-rspec (~> 4.2.6)
   rake
   responders
@@ -195,4 +197,4 @@ DEPENDENCIES
   timecop
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -100,6 +100,14 @@ class ApiAreaController < ApplicationController
   ...
 ```
 
+# Delayed Job activity monitoring
+
+To add monitoring of whether Delayed Job keeps picking up jobs or checking for new jobs, add the following line to an initializer:
+
+```ruby
+require 'roqua/core_ext/delayed_job/activity_monitoring'
+```
+
 # AppSignal Probes
 
 roqua-support contains one generic probe to monitor the current delayed job backlog count: `Roqua::Probes::DelayedJobProbe`

data/gemfiles/rails41.gemfile

@@ -3,11 +3,13 @@
 source "https://rubygems.org"
 
 gem "appraisal"
+gem "roqua_styleguide", :git => "https://gitlab.roqua.nl/roqua/styleguide.git"
 gem "activesupport", "4.1"
 
 group :test do
   gem "actionpack", ">= 4.0"
   gem "active_interaction", "~> 3.0"
+  gem "appsignal"
   gem "combustion", "~> 0.5.2"
   gem "guard-rspec", "~> 4.2.6"
   gem "responders"

data/gemfiles/rails42.gemfile

@@ -3,11 +3,13 @@
 source "https://rubygems.org"
 
 gem "appraisal"
+gem "roqua_styleguide", :git => "https://gitlab.roqua.nl/roqua/styleguide.git"
 gem "activesupport", "4.2"
 
 group :test do
   gem "actionpack", ">= 4.0"
   gem "active_interaction", "~> 3.0"
+  gem "appsignal"
   gem "combustion", "~> 0.5.2"
   gem "guard-rspec", "~> 4.2.6"
   gem "responders"

data/gemfiles/rails50.gemfile

@@ -3,11 +3,13 @@
 source "https://rubygems.org"
 
 gem "appraisal"
+gem "roqua_styleguide", :git => "https://gitlab.roqua.nl/roqua/styleguide.git"
 gem "activesupport", "5.0"
 
 group :test do
   gem "actionpack", ">= 4.0"
   gem "active_interaction", "~> 3.0"
+  gem "appsignal"
   gem "combustion", "~> 0.5.2"
   gem "guard-rspec", "~> 4.2.6"
   gem "responders"

data/gemfiles/rails51.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "roqua_styleguide", :git => "https://gitlab.roqua.nl/roqua/styleguide.git"
+gem "activesupport", "5.1"
+
+group :test do
+  gem "actionpack", ">= 4.0"
+  gem "active_interaction", "~> 3.0"
+  gem "appsignal"
+  gem "combustion", "~> 0.5.2"
+  gem "guard-rspec", "~> 4.2.6"
+  gem "responders"
+  gem "rspec-instrumentation-matcher"
+  gem "rspec-rails"
+end
+
+gemspec :path => "../"

data/lib/roqua-support/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module Support
-    VERSION = '0.1.31'.freeze
+    VERSION = '0.1.32'.freeze
   end
 end

data/lib/roqua/core_ext/delayed_job/activity_monitoring.rb

@@ -0,0 +1,32 @@
+require 'delayed_job'
+
+#
+# Updates the modification time of the file $RAILS_ROOT/tmp/delayed_job_activity when
+# relevant worker activity occurs. To be used for monitoring whether a DelayedJob
+# worker is still picking up new work in a timely fashion.
+#
+# A file based approach is used so it is easy to add a health check to a Docker container
+# with the following command:
+# `find /app/tmp -mmin -$MAXIMUM_AGE_OF_FILE_IN_MINUTES -type f -print | grep delayed_job_activity`
+#
+module DelayedJobActivityMonitoring
+  def work_off(num = 100)
+    FileUtils.touch(Rails.root.join('tmp', 'delayed_job_activity'))
+    super(num)
+  end
+
+  protected
+
+  def reserve_job
+    super.tap do |job|
+      if job
+        FileUtils.touch(
+          Rails.root.join('tmp', 'delayed_job_activity'),
+          mtime: job.max_run_time.from_now
+        )
+      end
+    end
+  end
+end
+
+Delayed::Worker.send(:prepend, DelayedJobActivityMonitoring) if defined?(Delayed) && defined?(Delayed::Worker)

data/spec/roqua/core_ext/delayed_job/activity_monitoring_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'pathname'
+require 'timecop'
+require 'fakefs/safe'
+
+require 'roqua/core_ext/delayed_job/activity_monitoring'
+
+describe DelayedJobActivityMonitoring do
+  after do
+    Timecop.return
+  end
+
+  def initialize_fake_rails_root
+    FileUtils.mkdir_p(File.join('/app', 'tmp'))
+    allow(Rails).to receive(:root).and_return(Pathname.new('/app'))
+  end
+
+  let(:monitoring_filename) { Rails.root.join('tmp', 'delayed_job_activity').to_s }
+
+  it 'creates a file' do
+    FakeFS.with_fresh do
+      initialize_fake_rails_root
+      expect { Delayed::Worker.new.work_off }
+        .to change { File.exist?(monitoring_filename) }
+
+      expect(File.mtime(monitoring_filename))
+        .to be_within(1.second).of(Time.now)
+    end
+  end
+
+  it 'updates the file modification time' do
+    FakeFS.with_fresh do
+      initialize_fake_rails_root
+
+      Delayed::Worker.new.work_off
+
+      Timecop.travel(1.minute)
+
+      expect { Delayed::Worker.new.work_off }
+        .to change { File.mtime(monitoring_filename) }
+
+      expect(File.mtime(monitoring_filename))
+        .to be_within(1.second).of(Time.now)
+    end
+  end
+
+  describe 'when a job is reserved' do
+    let(:max_run_time) { 2.hours }
+    let(:job) do
+      double(
+        name: 'name',
+        id: 123,
+        queue: 'queue',
+        max_run_time: max_run_time,
+        invoke_job: nil,
+        destroy: nil
+      )
+    end
+
+    it 'creates a file with a modification time in the future' do
+      FakeFS.with_fresh do
+        initialize_fake_rails_root
+
+        worker = Delayed::Worker.new
+        expect(Delayed::Job).to receive(:reserve).and_return(job)
+
+        expect { worker.send(:reserve_and_run_one_job) }
+          .to change { File.exist?(monitoring_filename) }
+
+        expect(File.mtime(monitoring_filename))
+          .to be_within(1.second).of(max_run_time.from_now)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-support
 version: !ruby/object:Gem::Version
-  version: 0.1.31
+  version: 0.1.32
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-19 00:00:00.000000000 Z
+date: 2018-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_interaction
@@ -199,6 +199,7 @@ files:
 - gemfiles/rails41.gemfile
 - gemfiles/rails42.gemfile
 - gemfiles/rails50.gemfile
+- gemfiles/rails51.gemfile
 - lib/roqua-support.rb
 - lib/roqua-support/railtie.rb
 - lib/roqua-support/version.rb
@@ -207,6 +208,7 @@ files:
 - lib/roqua/core_ext/active_interaction/rails_instrumentation.rb
 - lib/roqua/core_ext/activerecord/uniq_find_or_create.rb
 - lib/roqua/core_ext/array/stable_sort_by.rb
+- lib/roqua/core_ext/delayed_job/activity_monitoring.rb
 - lib/roqua/core_ext/enumerable/sort_by_alphanum.rb
 - lib/roqua/core_ext/fabrication/singleton.rb
 - lib/roqua/core_ext/fixnum/clamp.rb
@@ -241,6 +243,7 @@ files:
 - spec/roqua/core_ext/active_interaction/rails_intrumentation_spec.rb
 - spec/roqua/core_ext/activerecord/uniq_find_or_create_spec.rb
 - spec/roqua/core_ext/array/stable_sort_by_spec.rb
+- spec/roqua/core_ext/delayed_job/activity_monitoring_spec.rb
 - spec/roqua/core_ext/enumerable/sort_by_alphanum_spec.rb
 - spec/roqua/core_ext/fabrication/singleton_spec.rb
 - spec/roqua/core_ext/fixnum/clamp_spec.rb
@@ -293,6 +296,7 @@ test_files:
 - spec/roqua/core_ext/active_interaction/rails_intrumentation_spec.rb
 - spec/roqua/core_ext/activerecord/uniq_find_or_create_spec.rb
 - spec/roqua/core_ext/array/stable_sort_by_spec.rb
+- spec/roqua/core_ext/delayed_job/activity_monitoring_spec.rb
 - spec/roqua/core_ext/enumerable/sort_by_alphanum_spec.rb
 - spec/roqua/core_ext/fabrication/singleton_spec.rb
 - spec/roqua/core_ext/fixnum/clamp_spec.rb