sidekiq-scheduler 2.0.18 → 2.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c583329738c9061f81e69c8569679aa380195ed
-  data.tar.gz: 8be6d8f440cc5baaedbccf260606e1805dffe319
+  metadata.gz: cd4d7812270a42a1fba60eb58d6bb15e64cea545
+  data.tar.gz: f19980d703c2914483df61357fc3edd7d5fb4887
 SHA512:
-  metadata.gz: 16d39a833ee5a28ae52baf147bd8c0fa289e004dcdd999995b2623c9ab9f2ffdf65d69b6edfc5a9094892cb2b4fe220331e4cee3e419097f73d0fe214c42deb4
-  data.tar.gz: 94afd34d4725a30fa42011295c855147ca8b4f372f852b7a675fbbba551a4f68ef7eff2fe8f210a04f36bd49dc9fff895ab581d563b172117aecdcdeda18c653
+  metadata.gz: 628c7aa26722c33a2744b3239412a307a59d9de62ac5182144eec62098942b5c31b902d24c22089b5bc6c8f5da8141ede0fbc29c42cc72f3f00301d329f929ea
+  data.tar.gz: dc1e2a7c303f10fee40dadb5fa7cdb3ad6b8c6e4c437c478ec1beb65c1f32bf2cb88955b7c7e1c625a5d4a628915d84b71795fe4318585904e4e5ca62fdbabea

data/README.md

@@ -145,6 +145,22 @@ seconds past the minute).
 A big shout out to [rufus-scheduler](http://github.com/jmettraux/rufus-scheduler)
 for handling the heavy lifting of the actual scheduling engine.
 
+### Enabling/Disabling jobs
+
+By default all the jobs are enabled. There is an option at job's configuration to change
+this behavior.
+
+``` yaml
+clear_leaderboards_moderator:
+  every: "30s"
+  class: CheckDaemon
+  enabled: false
+  description: "This job is disabled by default"
+```
+
+However, the flag can be changed through the web interface at the Recurring Jobs tab.
+
+NOTE: Changes made thorugh the UI supersede job's configuration, even after a restart.
 
 ### Loading the schedule
 

data/lib/sidekiq-scheduler/job_presenter.rb

@@ -45,6 +45,10 @@ module SidekiqScheduler
       @attributes[key]
     end
 
+    def enabled?
+      Sidekiq::Scheduler.job_enabled?(@name)
+    end
+
     # Builds the presenter instances for the schedule hash
     #
     # @param schedule_hash [Hash] with the redis schedule

data/lib/sidekiq-scheduler/schedule.rb

@@ -1,5 +1,5 @@
 require 'hashie'
-require 'multi_json'
+require 'json'
 
 module SidekiqScheduler
   module Schedule
@@ -71,7 +71,7 @@ module SidekiqScheduler
         get_all_schedules
       else
         encoded_schedule = Sidekiq.redis { |r| r.hget(:schedules, name) }
-        encoded_schedule.nil? ? nil : MultiJson.decode(encoded_schedule)
+        encoded_schedule.nil? ? nil : JSON(encoded_schedule)
       end
     end
 
@@ -83,7 +83,7 @@ module SidekiqScheduler
 
         Sidekiq.redis { |r| r.hgetall(:schedules) }.tap do |h|
           h.each do |name, config|
-            schedules[name] = MultiJson.decode(config)
+            schedules[name] = JSON(config)
           end
         end
       end
@@ -103,7 +103,7 @@ module SidekiqScheduler
     def set_schedule(name, config)
       existing_config = get_schedule(name)
       unless existing_config && existing_config == config
-        Sidekiq.redis { |r| r.hset(:schedules, name, MultiJson.encode(config)) }
+        Sidekiq.redis { |r| r.hset(:schedules, name, JSON(config)) }
         Sidekiq.redis { |r| r.sadd(:schedules_changed, name) }
       end
       config

data/lib/sidekiq-scheduler/version.rb

@@ -1,5 +1,5 @@
 module SidekiqScheduler
 
-  VERSION = '2.0.18'
+  VERSION = '2.0.19'
 
 end

data/lib/sidekiq-scheduler/web.rb

@@ -18,6 +18,11 @@ module SidekiqScheduler
         Sidekiq::Scheduler.enqueue_job(schedule)
         redirect "#{root_path}recurring-jobs"
       end
+
+      app.get '/recurring-jobs/:name/toggle' do
+        Sidekiq::Scheduler.toggle_job_enabled(params[:name])
+        redirect "#{root_path}recurring-jobs"
+      end
     end
   end
 end

data/lib/sidekiq/scheduler.rb

@@ -2,13 +2,14 @@ require 'rufus/scheduler'
 require 'thwait'
 require 'sidekiq/util'
 require 'sidekiq-scheduler/manager'
+require 'json'
 
 module Sidekiq
   class Scheduler
     extend Sidekiq::Util
 
     REGISTERED_JOBS_THRESHOLD_IN_SECONDS = 24 * 60 * 60
-    RUFUS_METADATA_KEYS = %w(description at cron every in interval)
+    RUFUS_METADATA_KEYS = %w(description at cron every in interval enabled)
 
     # We expect rufus jobs to have #params
     Rufus::Scheduler::Job.module_eval do
@@ -335,10 +336,29 @@ module Sidekiq
 
       # Returns the key of the Redis hash for job's execution times hash
       #
+      # @return [String] with the key
       def next_times_key
         'sidekiq-scheduler:next_times'
       end
 
+      # Returns the Redis's key for saving schedule states.
+      #
+      # @return [String] with the key
+      def schedules_state_key
+        'sidekiq-scheduler:states'
+      end
+
+      def job_enabled?(name)
+        job = Sidekiq.schedule[name]
+        schedule_state(name).fetch('enabled', job.fetch('enabled', true)) if job
+      end
+
+      def toggle_job_enabled(name)
+        state = schedule_state(name)
+        state['enabled'] = !job_enabled?(name)
+        set_schedule_state(name, state)
+      end
+
       private
 
       def new_rufus_scheduler
@@ -353,7 +373,7 @@ module Sidekiq
         opts = { :job => true, :tags => [name] }
 
         rufus_scheduler.send(interval_type, *args, opts) do |job, time|
-          idempotent_job_enqueue(name, time, sanitize_job_config(config))
+          idempotent_job_enqueue(name, time, sanitize_job_config(config)) if job_enabled?(name)
         end
       end
 
@@ -361,6 +381,24 @@ module Sidekiq
         config.reject { |k, _| RUFUS_METADATA_KEYS.include?(k) }
       end
 
+      # Retrieves a schedule state
+      #
+      # @param name [String] with the schedule's name
+      # @return [Hash] with the schedule's state
+      def schedule_state(name)
+        state = Sidekiq.redis { |r| r.hget(schedules_state_key, name) }
+
+        state ? JSON(state) : {}
+      end
+
+      # Saves a schedule state
+      #
+      # @param name [String] with the schedule's name
+      # @param name [Hash] with the schedule's state
+      def set_schedule_state(name, state)
+        Sidekiq.redis { |r| r.hset(schedules_state_key, name, JSON(state)) }
+      end
+
     end
   end
 end

data/web/locales/cs.yml

@@ -9,3 +9,5 @@ cs:
   enqueue_now: Zařadit nyní
   next_time: Příště
   no_next_time: no next execution for this job
+  disable: Zakázat
+  enable: Povolit

data/web/locales/en.yml

@@ -9,3 +9,5 @@ en:
   enqueue_now: Enqueue now
   next_time: Next Time
   no_next_time: no next execution for this job
+  disable: Disable
+  enable: Enable

data/web/locales/es.yml

@@ -9,3 +9,5 @@ es:
   enqueue_now: Encolar ahora
   next_time: Próxima ejecución
   no_next_time: esta tarea no se volverá a ejecutar
+  disable: Inhabilitar
+  enable: Habilitar

data/web/locales/zh-cn.yml

@@ -9,3 +9,5 @@ zh-cn:
   enqueue_now: 立即执行
   next_time: 下次执行时间
   no_next_time: 已无后续作业
+  disable: 禁用
+  enable: 启用

data/web/views/recurring_jobs.erb

@@ -26,11 +26,16 @@
             <a href="<%= root_path %>queues/<%= job.queue %>"><%= job.queue %></a>
           </td>
           <td><%= job['args'] %></td>
-          <td><%= job.next_time || t('no_next_time') %></td>
+          <td><span style="<%= 'text-decoration:line-through' unless job.enabled? %>">
+            <%= job.next_time || t('no_next_time') %>
+          </span></td>
           <td class="text-center">
             <a class="btn btn-warn btn-xs" href="<%= root_path %>recurring-jobs/<%= URI.escape(job.name) %>/enqueue">
               <%= t('enqueue_now') %>
             </a>
+            <a class="btn <%= job.enabled? ? "btn-primary" : "btn-warn"%> btn-xs" href="<%= root_path %>recurring-jobs/<%= URI.escape(job.name) %>/toggle">
+              <%= job.enabled? ? t('disable') : t('enable') %>
+            </a>
           </td>
         </tr>
       <% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-scheduler
 version: !ruby/object:Gem::Version
-  version: 2.0.18
+  version: 2.0.19
 platform: ruby
 authors:
 - Morton Jonuschat
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -67,20 +67,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.8
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -179,6 +165,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement