sqeduler 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a64cee1c9810e71e1f579df8e1a6a57b2f6b3f63
-  data.tar.gz: d1b27b846003b95fbc8d46cca571ea84f4924e1a
+  metadata.gz: 952cafb156a1da8df0f3bece128b8578e4f83e97
+  data.tar.gz: 21f4293a4f7f5a5d03a316d29b6a483c6f0a9094
 SHA512:
-  metadata.gz: 68767817edc816cbe2f72cc09b1df71e6df7700be3c9de3946d4cc39a47cef0d2b9f7b0bfb7fae1708dd653deb9d94ca287aadd2b294e5159fedc010d9f40bb6
-  data.tar.gz: 7c2980641c62840d39711f9a98c09aa60f81aa8ab43357ae3ae6c9a4fa7e39e168ddef7602cde5ede14d1e10b231fb512096b367c2f4b4eb640bda103fe9f682
+  metadata.gz: 0dcd6a303e7b45925f053f96a9ab12ce511d41309c5df2256e54bba1d9fb48b8184db844c72b0e61b910716a34d447bb14070e7eeeff8e069e676f42c730ca7c
+  data.tar.gz: 5f97beb03984fafe2ab8e536f1e1d382f544f19908f6af8fd7ef4e42e41864ffd516a98bb8a484d611e9e4f9701253c28132ab08df5a4ac4bfef172f8e3b0e58

data/.gitignore

@@ -3,4 +3,4 @@
 /Gemfile.lock
 /doc/
 /pkg/
-/vendor/cache/*.gem
+*.gem

data/.rubocop.yml

@@ -1,10 +1,9 @@
-AllCops:
-  RunRailsCops: true
-  DisplayCopNames: true
-
 Lint/EndAlignment:
   AlignWith: variable
 
+Metrics/AbcSize:
+  Enabled: false
+
 Metrics/ClassLength:
   Max: 150
 

data/lib/sqeduler/middleware/kill_switch.rb

@@ -0,0 +1,34 @@
+require "active_support/inflector/methods"
+
+module Sqeduler
+  module Middleware
+    # Verifies that a worker class is enabled before pushing the job into Redis.
+    # Prevents disabled jobs from getting enqueued. To disable a worker, use
+    # Sqeduler::Worker::KillSwitch.
+    class KillSwitch
+      def call(worker, _msg, _queue, _redis_pool)
+        worker_klass = normalized_worker_klass(worker)
+        if worker_enabled?(worker_klass)
+          yield
+        else
+          Service.logger.warn "#{worker_klass.name} is currently disabled. Will not be enqueued."
+          false
+        end
+      end
+
+      def normalized_worker_klass(worker)
+        # worker_class can be String or a Class
+        # SEE: https://github.com/mperham/sidekiq/wiki/Middleware
+        if worker.is_a?(String)
+          worker.constantize
+        else
+          worker
+        end
+      end
+
+      def worker_enabled?(worker_klass)
+        !worker_klass.respond_to?(:enabled?) || worker_klass.enabled?
+      end
+    end
+  end
+end

data/lib/sqeduler/service.rb

@@ -39,6 +39,11 @@ module Sqeduler
             end
           end
 
+          # the server can also enqueue jobs
+          config.client_middleware do |chain|
+            chain.add(Sqeduler::Middleware::KillSwitch)
+          end
+
           Service.config.on_server_start.call(config) if Service.config.on_server_start
         end
       end
@@ -50,6 +55,10 @@ module Sqeduler
           if Service.config.on_client_start
             Service.config.on_client_start.call(config)
           end
+
+          config.client_middleware do |chain|
+            chain.add(Sqeduler::Middleware::KillSwitch)
+          end
         end
       end
 

data/lib/sqeduler/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Sqeduler
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/lib/sqeduler/worker/callbacks.rb

@@ -18,13 +18,13 @@ module Sqeduler
       # provides an oppurtunity to log when the job has started (maybe create a
       # stateful db record for this job run?)
       def before_start
-        Service.logger.info "Starting #{self.class.name} at #{Time.new.utc} in process ID #{Process.pid}"
+        Service.logger.info "Starting #{self.class.name} at #{Time.now} in process ID #{Process.pid}"
         super if defined?(super)
       end
 
       # callback for successful run of this job
       def on_success(total_time)
-        Service.logger.info "#{self.class.name} completed at #{Time.new.utc}. Total time #{total_time}"
+        Service.logger.info "#{self.class.name} completed at #{Time.now}. Total time #{total_time}"
         super if defined?(super)
       end
 

data/lib/sqeduler.rb

@@ -1,10 +1,12 @@
 # encoding: utf-8
+require "active_support"
 require "sqeduler/version"
 require "sqeduler/config"
 require "sqeduler/redis_scripts"
 require "sqeduler/lock_value"
 require "sqeduler/redis_lock"
 require "sqeduler/trigger_lock"
+require "sqeduler/middleware/kill_switch"
 require "sqeduler/service"
 require "sqeduler/worker/callbacks"
 require "sqeduler/worker/synchronization"

data/spec/fixtures/env.rb

@@ -3,7 +3,8 @@ require_relative "fake_worker"
 
 REDIS_CONFIG = {
   :host => "localhost",
-  :db => 1
+  :db => 1,
+  :namespace => "sqeduler-tests"
 }
 Sidekiq.logger = Logger.new(STDOUT).tap { |l| l.level = Logger::DEBUG }
 

data/spec/integration_spec.rb

@@ -1,11 +1,11 @@
 require "spec_helper"
 require "./spec/fixtures/fake_worker"
 
-def maybe_cleanup_file(file_path)
-  File.delete(file_path) if File.exist?(file_path)
-end
-
 RSpec.describe "Sidekiq integration" do
+  def maybe_cleanup_file(file_path)
+    File.delete(file_path) if File.exist?(file_path)
+  end
+
   before do
     maybe_cleanup_file(FakeWorker::JOB_RUN_PATH)
     maybe_cleanup_file(FakeWorker::JOB_SUCCESS_PATH)
@@ -20,8 +20,8 @@ RSpec.describe "Sidekiq integration" do
     pid = Process.spawn "bundle exec sidekiq -r #{path}"
     puts "Spawned process #{pid}"
     timeout = 30
-    start = Time.new
-    while (Time.new - start) < timeout
+    start = Time.now
+    while (Time.now - start) < timeout
       break if File.exist?(FakeWorker::JOB_RUN_PATH)
       sleep 0.5
     end

data/spec/middleware/kill_switch_spec.rb

@@ -0,0 +1,87 @@
+require "spec_helper"
+
+RSpec.describe Sqeduler::Middleware::KillSwitch do
+  before do
+    Sqeduler::Service.config = Sqeduler::Config.new(
+      :redis_hash => REDIS_CONFIG,
+      :logger     => Logger.new(STDOUT).tap { |l| l.level = Logger::DEBUG }
+    )
+  end
+
+  describe "#call" do
+    shared_examples_for "job is enqueued" do
+      it "should enqueue the job" do
+        expect do |b|
+          described_class.new.call(worker_klass, nil, nil, nil, &b)
+        end.to yield_control
+      end
+    end
+
+    shared_examples_for "job is not enqueued" do
+      it "should not enqueue the job" do
+        expect do |b|
+          described_class.new.call(worker_klass, nil, nil, nil, &b)
+        end.to_not yield_control
+      end
+    end
+
+    let(:worker_klass) { MyWorker }
+
+    context "job does not prepend KillSwitch" do
+      before do
+        stub_const(
+          "MyWorker",
+          Class.new do
+            include Sidekiq::Worker
+            def perform; end
+          end
+        )
+      end
+
+      it_behaves_like "job is enqueued"
+
+      context "worker_klass is a string" do
+        let(:worker_klass) { "MyWorker" }
+
+        it_behaves_like "job is enqueued"
+      end
+    end
+
+    context "job prepends KillSwitch" do
+      before do
+        stub_const(
+          "MyWorker",
+          Class.new do
+            include Sidekiq::Worker
+            prepend Sqeduler::Worker::KillSwitch
+            def perform; end
+          end
+        )
+      end
+
+      context "job is disabled" do
+        before { MyWorker.disable }
+
+        it_behaves_like "job is not enqueued"
+
+        context "worker_klass is a string" do
+          let(:worker_klass) { "MyWorker" }
+
+          it_behaves_like "job is not enqueued"
+        end
+      end
+
+      context "job is enabled" do
+        before { MyWorker.enable }
+
+        it_behaves_like "job is enqueued"
+
+        context "worker_klass is a string" do
+          let(:worker_klass) { "MyWorker" }
+
+          it_behaves_like "job is enqueued"
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -15,7 +15,7 @@ Timecop.safe_mode = true
 RSpec.configure do |config|
   config.before(:each) do
     TEST_REDIS.flushdb
+    Sqeduler::Service.config = nil
   end
-
   config.disable_monkey_patching!
 end

data/spec/worker_spec.rb

@@ -2,20 +2,20 @@
 require "spec_helper"
 require "./spec/fixtures/fake_worker"
 
-def verify_callback_occured(file_path, times = 1)
-  expect(File).to exist(file_path)
-  expect(File.read(file_path).length).to eq(times)
-end
+RSpec.describe Sqeduler::Worker do
+  def verify_callback_occured(file_path, times = 1)
+    expect(File).to exist(file_path)
+    expect(File.read(file_path).length).to eq(times)
+  end
 
-def verify_callback_skipped(file_path)
-  expect(File).to_not exist(file_path)
-end
+  def verify_callback_skipped(file_path)
+    expect(File).to_not exist(file_path)
+  end
 
-def maybe_cleanup_file(file_path)
-  File.delete(file_path) if File.exist?(file_path)
-end
+  def maybe_cleanup_file(file_path)
+    File.delete(file_path) if File.exist?(file_path)
+  end
 
-RSpec.describe Sqeduler::Worker do
   before do
     Sqeduler::Service.config = Sqeduler::Config.new(
       :redis_hash => REDIS_CONFIG,

data/sqeduler.gemspec

@@ -15,8 +15,8 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://rubygems.org/gems/sqeduler"
 
   gem.files         = `git ls-files`.split($RS)
-  gem.executables   = gem.files.grep(/^bin\//).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{(test|spec|features)/})
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency "sidekiq"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sqeduler
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - '["Jared Jenkins"]'
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -173,6 +173,7 @@ files:
 - lib/sqeduler.rb
 - lib/sqeduler/config.rb
 - lib/sqeduler/lock_value.rb
+- lib/sqeduler/middleware/kill_switch.rb
 - lib/sqeduler/redis_lock.rb
 - lib/sqeduler/redis_scripts.rb
 - lib/sqeduler/service.rb
@@ -187,6 +188,7 @@ files:
 - spec/fixtures/fake_worker.rb
 - spec/fixtures/schedule.yaml
 - spec/integration_spec.rb
+- spec/middleware/kill_switch_spec.rb
 - spec/service_spec.rb
 - spec/spec_helper.rb
 - spec/sqeduler_spec.rb
@@ -214,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Common Sidekiq infrastructure for multi-host applications.
@@ -224,6 +226,7 @@ test_files:
 - spec/fixtures/fake_worker.rb
 - spec/fixtures/schedule.yaml
 - spec/integration_spec.rb
+- spec/middleware/kill_switch_spec.rb
 - spec/service_spec.rb
 - spec/spec_helper.rb
 - spec/sqeduler_spec.rb