roqua-support 0.1.25 → 0.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c59df394193f13d45c71f26b935f59e890b98f96
-  data.tar.gz: b0f6dc5880a4dfda1d96f554d5460dd180e6fc3b
+  metadata.gz: ecfd7d74378220979e7a8839f07ea9793a37265c
+  data.tar.gz: 8dfb4a419c0d3bc0222a2f743fcad30fc0e43141
 SHA512:
-  metadata.gz: 0ccdada5a2cff7e753ae5e8d0278473a70d4e39b7c0f85f1287811946850f73612ade4bed1d5a081290cc6edde938a4190a32969cad62913e5e401e178a57f68
-  data.tar.gz: 29ea857840bd5f40b59efd2b94eb599909cec72d2e9b58dcd16e71a210935ca9dd6344ad2dee79fda8772257db4edfa2276e9cd57745618d35c143b823474935
+  metadata.gz: d69f343ba3c51be195a532a892d8839eea4bea7cea5ee54f23e790f6fb56c2299c3aa1f94de49a1cad22f342c0feb78d5878d3a0bffed9be143d719224b7497f
+  data.tar.gz: 76a3f96b867e176bf948ea7bab491c1abd319b7eb02faf8dbb1f0aed73eb9c7251cef075ee5f51fca81b6383c35f1c05408aded3fda050bd339e77ddab60a668

data/.gitlab-ci.yml

@@ -3,10 +3,6 @@ image: "registry.roqua.nl/roqua/roqua-build-images:ruby-2.3-rails-base-test"
 variables:
   RAILS_ENV: "test"
 
-stages:
-  - test
-  - publish
-
 cache:
   paths:
     - .gems
@@ -18,26 +14,13 @@ before_script:
   - bundle --jobs 2 --retry 3
 
 rails_41:
-  stage: test
   script:
     - bundle exec appraisal rails41 bundle exec rspec
 
 rails_42:
-  stage: test
   script:
     - bundle exec appraisal rails42 bundle exec rspec
 
 rails_50:
-  stage: test
   script:
     - bundle exec appraisal rails50 bundle exec rspec
-
-build_and_publish_gem:
-  stage: publish
-  dependencies:
-    - rails_41
-    - rails_42
-    - rails_50
-  script:
-    - gem build roqua-support.gemspec
-    - gem push roqua-support-0.1.25.gem

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    roqua-support (0.1.25)
+    roqua-support (0.1.26)
       active_interaction (~> 3.0)
       activesupport (>= 3.2, < 6)
       naught (~> 1.0)
@@ -33,6 +33,10 @@ GEM
       activemodel (>= 4, < 6)
     activemodel (5.0.1)
       activesupport (= 5.0.1)
+    activerecord (5.0.1)
+      activemodel (= 5.0.1)
+      activesupport (= 5.0.1)
+      arel (~> 7.0)
     activesupport (5.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
@@ -44,6 +48,7 @@ GEM
       thor (>= 0.14.0)
     appsignal (2.3.1)
       rack
+    arel (7.1.4)
     ast (2.3.0)
     builder (3.2.3)
     coderay (1.1.1)
@@ -52,6 +57,11 @@ GEM
       railties (>= 3.0.0)
       thor (>= 0.14.6)
     concurrent-ruby (1.0.4)
+    delayed_job (4.1.4)
+      activesupport (>= 3.0, < 5.2)
+    delayed_job_active_record (4.1.2)
+      activerecord (>= 3.0, < 5.2)
+      delayed_job (>= 3.0, < 5)
     diff-lcs (1.3)
     erubis (2.7.0)
     ffi (1.9.17)
@@ -151,8 +161,10 @@ GEM
     ruby_dep (1.5.0)
     shellany (0.0.1)
     slop (3.6.0)
+    sqlite3 (1.3.13)
     thor (0.19.4)
     thread_safe (0.3.5)
+    timecop (0.9.1)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     unicode-display_width (1.3.0)
@@ -167,14 +179,17 @@ DEPENDENCIES
   appsignal
   bundler (~> 1.0)
   combustion (~> 0.5.2)
+  delayed_job_active_record
   guard-rspec (~> 4.2.6)
-  rake (~> 12.1)
+  rake
   responders
   roqua-support!
   roqua_styleguide!
   rspec (>= 2.12.0, < 4.0)
   rspec-instrumentation-matcher
   rspec-rails
+  sqlite3
+  timecop
 
 BUNDLED WITH
-   1.15.4
+   1.16.1

data/README.md

@@ -100,6 +100,16 @@ class ApiAreaController < ApplicationController
   ...
 ```
 
+# AppSignal Probes
+
+roqua-support contains one generic probe to monitor the current delayed job backlog count: `Roqua::Probes::DelayedJobProbe`
+
+Enable it in a project by calling:
+
+```ruby
+Roqua::Probes::DelayedJobProbe.enable
+```
+
 ### ActiveInteraction extensions
 
 ```

data/lib/roqua/probes/base_probe.rb

@@ -0,0 +1,11 @@
+module Roqua
+  module Probes
+    module BaseProbe
+      def enable
+        new.tap do |probe|
+          Appsignal::Minutely.probes << probe unless Appsignal::Minutely.probes.map(&:class).include?(probe.class)
+        end
+      end
+    end
+  end
+end

data/lib/roqua/probes/delayed_job_probe.rb

@@ -0,0 +1,17 @@
+require_relative 'base_probe'
+
+module Roqua
+  module Probes
+    class DelayedJobProbe
+      extend BaseProbe
+
+      def backlog_count
+        Delayed::Job.where(locked_at: nil).where('run_at < ?', Time.zone.now).count
+      end
+
+      def call
+        Appsignal.set_gauge('delayed_job_backlog_count', backlog_count)
+      end
+    end
+  end
+end

data/lib/roqua/support/errors.rb

@@ -69,7 +69,7 @@ module Roqua
         end
 
         def notify_appsignal?(exception)
-          const_defined?(:Appsignal) && !Appsignal.is_ignored_exception?(exception) && Appsignal.active?
+          const_defined?(:Appsignal) && Appsignal.active? && !Appsignal.is_ignored_exception?(exception)
         end
 
         def notify_appsignal(exception, labels, namespace)

data/lib/roqua-support/version.rb

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

data/lib/roqua-support.rb

@@ -2,6 +2,10 @@ require "roqua-support/version"
 require "roqua/support"
 
 module Roqua
+  module Probes
+    autoload :DelayedJobProbe, 'roqua/probes/delayed_job_probe'
+  end
+
   module Responders
     autoload :ApiErrorsResponder, 'roqua/responders/api_errors_responder'
     autoload :ActiveInteractionAwareResponder, 'roqua/responders/active_interaction_aware_responder'

data/roqua-support.gemspec

@@ -23,7 +23,10 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'active_interaction', '~> 3.0'
 
   gem.add_development_dependency 'bundler', '~> 1.0'
-  gem.add_development_dependency 'rake', '~> 12.1'
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '>= 2.12.0', '< 4.0'
-  gem.add_development_dependency 'appsignal', '~> 2.3', '>= 2.3.1'
+  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/core_ext/activerecord/uniq_find_or_create_spec.rb

@@ -1,17 +1,6 @@
-require 'roqua/core_ext/activerecord/uniq_find_or_create'
+require 'spec_helper'
 
-module ActiveRecord
-  class Base
-    def self.find_by(attributes)
-    end
-  end
-
-  class RecordNotUnique < StandardError
-  end
-
-  class RecordInvalid < StandardError
-  end
-end
+require 'roqua/core_ext/activerecord/uniq_find_or_create'
 
 describe ActiveRecord::Base do
   let(:attributes) { double('attributes') }
@@ -32,14 +21,14 @@ describe ActiveRecord::Base do
     it 'returns a concurrenlty created record' do
       allow(ActiveRecord::Base).to receive(:find_by).with(attributes).and_return record
       allow(ActiveRecord::Base).to receive(:find_or_create_by).with(attributes, &block)
-                                                              .and_raise ActiveRecord::RecordNotUnique
+                                                              .and_raise ActiveRecord::RecordNotUnique.new('')
       expect(ActiveRecord::Base.uniq_find_or_create_by attributes, &block).to eq(record)
     end
 
     it 'raises when a concurrent record is detected by the database but could not be queried for unknown reasons' do
       allow(ActiveRecord::Base).to receive(:find_by).with(attributes).and_return nil
       allow(ActiveRecord::Base).to receive(:find_or_create_by).with(attributes, &block)
-                                                              .and_raise ActiveRecord::RecordNotUnique
+                                                              .and_raise ActiveRecord::RecordNotUnique.new('')
       expect do
         ActiveRecord::Base.uniq_find_or_create_by attributes, &block
       end.to raise_error ActiveRecord::RecordNotUnique
@@ -66,21 +55,21 @@ describe ActiveRecord::Base do
     it 'returns a concurrenlty created record' do
       allow(ActiveRecord::Base).to receive(:find_by).with(attributes).and_return record
       allow(ActiveRecord::Base).to receive(:find_or_create_by!).with(attributes, &block)
-                                                               .and_raise ActiveRecord::RecordNotUnique
+                                                               .and_raise ActiveRecord::RecordNotUnique.new('')
       expect(ActiveRecord::Base.uniq_find_or_create_by! attributes, &block).to eq(record)
     end
 
     it 'raises when a concurrent record is detected by the database but could not be queried for unknown reasons' do
       allow(ActiveRecord::Base).to receive(:find_by).with(attributes).and_return nil
       allow(ActiveRecord::Base).to receive(:find_or_create_by!).with(attributes, &block)
-                                                               .and_raise ActiveRecord::RecordNotUnique
+                                                               .and_raise ActiveRecord::RecordNotUnique.new('')
       expect do
         ActiveRecord::Base.uniq_find_or_create_by! attributes, &block
       end.to raise_error ActiveRecord::RecordNotUnique
     end
 
     it 'raises when creating a new record causes validation failures not due to concurrency' do
-      exception = ActiveRecord::RecordInvalid.new 'some_validation_error'
+      exception = StandardError.new('some_validation_error')
       allow(ActiveRecord::Base).to receive(:find_or_create_by!).with(attributes, &block).and_raise exception
       expect { ActiveRecord::Base.uniq_find_or_create_by! attributes, &block }.to raise_error(exception)
     end

data/spec/roqua/probes/delayed_job_probe_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'delayed_job_active_record'
+require 'timecop'
+
+require 'roqua/probes/delayed_job_probe'
+
+describe Roqua::Probes::DelayedJobProbe do
+  before { Timecop.freeze }
+  after { Timecop.return }
+  subject(:probe) { Roqua::Probes::DelayedJobProbe.new }
+
+  describe 'backlog_count' do
+    context 'if a single job unlocked job exists that has a run_at in the past' do
+      def create_jobs
+        Delayed::Job.create!(run_at: 1.second.ago)
+        2.times { Delayed::Job.create!(run_at: 1.second.ago, locked_at: Time.zone.now) }
+        Delayed::Job.create!(run_at: Time.zone.now)
+        Delayed::Job.create!(run_at: 1.second.from_now)
+      end
+
+      it 'returns 1' do
+        expect { create_jobs }.to change { probe.backlog_count }.from(0).to(1)
+      end
+    end
+  end
+
+  describe 'call' do
+    it 'sends the correct metric to Appsignal' do
+      expect(probe).to receive(:backlog_count).and_return(12)
+      expect(Appsignal).to receive(:set_gauge).with('delayed_job_backlog_count', 12)
+      probe.call
+    end
+  end
+
+  context '.enable' do
+    before { Appsignal::Minutely.probes.clear }
+    after { Appsignal::Minutely.probes.clear }
+
+    it 'adds our custom probes to Appsignal' do
+      expect { Roqua::Probes::DelayedJobProbe.enable }
+        .to change { Appsignal::Minutely.probes.count }.by(1)
+
+      expect(Appsignal::Minutely.probes.map(&:class)).to include(Roqua::Probes::DelayedJobProbe)
+    end
+
+    it 'will not add the same probe twice if called multiple times' do
+      expect { 2.times { Roqua::Probes::DelayedJobProbe.enable } }
+        .to change { Appsignal::Minutely.probes.count }.by(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+ENV['RAILS_ENV'] = 'test'
+
 require 'rubygems'
 require 'bundler/setup'
 
@@ -7,3 +9,29 @@ Combustion.initialize! :action_controller
 
 require 'appsignal'
 require 'rspec/rails'
+
+require 'delayed_job_active_record'
+
+Delayed::Worker.logger = Logger.new(Tempfile.new('roqua-support-delayed-job.log'))
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+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
+    t.text     :handler
+    t.text     :last_error
+    t.datetime :run_at
+    t.datetime :locked_at
+    t.datetime :failed_at
+    t.string   :locked_by
+    t.string   :queue
+    t.string   :cron
+    t.timestamps null: false
+  end
+
+  add_index :delayed_jobs, [:priority, :run_at], :name => 'delayed_jobs_priority'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-support
 version: !ruby/object:Gem::Version
-  version: 0.1.25
+  version: 0.1.26
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
+date: 2018-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -76,16 +76,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -110,22 +110,58 @@ dependencies:
   name: appsignal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  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: '2.3'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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'
 description: 'Logging backend, freedom patches, '
 email: marten@roqua.nl
 executables: []
@@ -159,6 +195,8 @@ files:
 - lib/roqua/core_ext/enumerable/sort_by_alphanum.rb
 - lib/roqua/core_ext/fabrication/singleton.rb
 - lib/roqua/core_ext/fixnum/clamp.rb
+- lib/roqua/probes/base_probe.rb
+- lib/roqua/probes/delayed_job_probe.rb
 - lib/roqua/responders/active_interaction_aware_responder.rb
 - lib/roqua/responders/api_errors_responder.rb
 - lib/roqua/support.rb
@@ -179,6 +217,7 @@ files:
 - 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
+- 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/support/errors_spec.rb
@@ -210,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.2
 signing_key: 
 specification_version: 4
 summary: Helper objects and proxies used by a lot of RoQua applications
@@ -223,6 +262,7 @@ test_files:
 - 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
+- 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/support/errors_spec.rb