sidekiq-scheduler 3.0.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a5dc23147c3734bd7b7a0e4807c6dcf6ed445bf556fbfd8a467f00995df3464
-  data.tar.gz: a4cb767f222114219389a01741a6fb9f62f6b9bc5a1621eb6e6da653c2e0c179
+  metadata.gz: b8bddb1a9c6aeffceb3a1efde76cc88285a5a4ef2ea1e7e1ef85ac35b4e311f4
+  data.tar.gz: b88000d6771e9a5d88754dd753bf96dc142453ff170bf2fd11bbe1afc50de3fd
 SHA512:
-  metadata.gz: 5b0e12484ddb14ba56b003176a664815982529823068753a32cadb8a19eb6b7eb6b6b15ce439ffef8186f02f259b444cab253dc1e0e2bad20deaed1325def388
-  data.tar.gz: 3fe2d0ca59b5eaf22898082cb287daec90b89a9f63364419a9c07b1359f5f748ce90ce81cd2806d4083e672e9cc546e90b8a07d289cc15b6107149c73c459447
+  metadata.gz: 444aa2319dfe4a4817348ed7cd8d92d3f11ca16ed04ac9b8c4b590c68d2c86ef7df27cab0a81d0c78c0a26000cdaaa332870d0ec644a59241d96c34ddc80b5e0
+  data.tar.gz: 32ecf78f608fbec6a2b017a88d1bd332f4af20931d55751ea44499af77a2df664ff71a57a3bce55dac2c8ded981fc960b96b67eb3076f7ab7c7d3b59baa77fc5

data/README.md

@@ -179,6 +179,14 @@ Cron, every, and interval types push jobs into sidekiq in a recurrent manner.
     every: '45m'    # Runs every 45 minutes
 ```
 
+The value is parsed by [`Fugit::Duration.parse`](https://github.com/floraison/fugit#fugitduration). It understands quite a number of formats, including human-readable ones:
+
+``` yaml
+    every: 45 minutes
+    every: 2 hours and 30 minutes
+    every: 1.5 hours
+```
+
 `interval` is similar to `every`, the difference between them is that `interval` type schedules the
 next execution after the interval has elapsed counting from its last job enqueue.
 
@@ -272,8 +280,9 @@ Sidekiq.get_schedule
 
 ## Time zones
 
-Note that if you use the cron syntax, this will be interpreted as in the server time zone
-rather than the `config.time_zone` specified in Rails.
+Note that if you use the cron syntax and are not running a Rails app, this will be interpreted in the server time zone.
+
+In a Rails app, [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) (>= 3.3.3) will use the `config.time_zone` specified in Rails.
 
 You can explicitly specify the time zone that rufus-scheduler will use:
 
@@ -312,6 +321,19 @@ Non-normal conditions that could push a specific job multiple times are:
 
 `every`, `interval` and `in` jobs will be pushed once per host.
 
+## Notes on when sidekiq worker is down
+
+For a `cron`/`at` (and all other) job to be successfully enqueued, you need at least one sidekiq worker with scheduler to be up at that moment. Handling this is up to you and depends on your application.
+
+Possible solutions include:
+- Simply ignoring this fact, if you only run frequent periodic jobs, that can tolerate some increased interval
+- Abstaining from deploys/restarts during time when critical jobs are usually scheduled
+- Making your infrequent jobs idempotent (so that they can be enqueued multiple times but still produce result as if was run once) and scheduling them multiple times to reduce likelihood of not being run
+- Zero downtime deploy for sidekiq workers: keep at least one worker up during whole deploy and only restart/shut it down after when new one has started
+- Running scheduler inside your unicorn/rails processes (if you already have zero downtime deploy set up for these)
+
+Each option has it's own pros and cons. 
+
 ## Sidekiq Web Integration
 
 sidekiq-scheduler provides an extension to the Sidekiq web interface that adds a `Recurring Jobs` page.

data/lib/sidekiq-scheduler/extensions/web.rb

@@ -1,5 +1,11 @@
 require 'sidekiq/web' unless defined?(Sidekiq::Web)
 
+ASSETS_PATH = File.expand_path('../../../web/assets', __dir__)
+
 Sidekiq::Web.register(SidekiqScheduler::Web)
 Sidekiq::Web.tabs['recurring_jobs'] = 'recurring-jobs'
-Sidekiq::Web.locales << File.expand_path(File.dirname(__FILE__) + '/../../../web/locales')
+Sidekiq::Web.locales << File.expand_path("#{File.dirname(__FILE__)}/../../../web/locales")
+Sidekiq::Web.use Rack::Static, urls: ['/stylesheets'],
+                               root: ASSETS_PATH,
+                               cascade: true,
+                               header_rules: [[:all, { 'Cache-Control' => 'public, max-age=86400' }]]

data/lib/sidekiq-scheduler/manager.rb

@@ -37,10 +37,6 @@ module SidekiqScheduler
       @scheduler_instance.load_schedule!
     end
 
-    def reset
-      clear_scheduled_work
-    end
-
     private
 
     def load_scheduler_options(options)

data/lib/sidekiq-scheduler/redis_manager.rb

@@ -96,7 +96,14 @@ module SidekiqScheduler
     #
     # @return [Boolean] true if the schedules key is set, false otherwise
     def self.schedule_exist?
-      Sidekiq.redis { |r| r.exists(:schedules) }
+      Sidekiq.redis do |r|
+        case r.exists(:schedules)
+        when true, 1
+          true
+        else
+          false
+        end
+      end
     end
 
     # Returns all the schedule changes for a given time range.
@@ -130,9 +137,9 @@ module SidekiqScheduler
     def self.register_job_instance(job_name, time)
       job_key = pushed_job_key(job_name)
       registered, _ = Sidekiq.redis do |r|
-        r.pipelined do
-          r.zadd(job_key, time.to_i, time.to_i)
-          r.expire(job_key, REGISTERED_JOBS_THRESHOLD_IN_SECONDS)
+        r.pipelined do |pipeline|
+          pipeline.zadd(job_key, time.to_i, time.to_i)
+          pipeline.expire(job_key, REGISTERED_JOBS_THRESHOLD_IN_SECONDS)
         end
       end
 

data/lib/sidekiq-scheduler/schedule.rb

@@ -140,7 +140,9 @@ module SidekiqScheduler
     def infer_queue(klass)
       klass = try_to_constantize(klass)
 
-      if klass.respond_to?(:sidekiq_options)
+      # ActiveJob uses queue_as when the job is created
+      # to determine the queue
+      if klass.respond_to?(:sidekiq_options) && !SidekiqScheduler::Utils.active_job_enqueue?(klass)
         klass.sidekiq_options['queue']
       end
     end

data/lib/sidekiq-scheduler/scheduler.rb

@@ -2,7 +2,6 @@ require 'rufus/scheduler'
 require 'thwait'
 require 'sidekiq/util'
 require 'json'
-require 'sidekiq-scheduler/manager'
 require 'sidekiq-scheduler/rufus_utils'
 require 'sidekiq-scheduler/redis_manager'
 
@@ -162,7 +161,7 @@ module SidekiqScheduler
         config['args'] = arguments_with_metadata(config['args'], scheduled_at: time.to_f)
       end
 
-      if active_job_enqueue?(config['class'])
+      if SidekiqScheduler::Utils.active_job_enqueue?(config['class'])
         SidekiqScheduler::Utils.enqueue_with_active_job(config)
       else
         SidekiqScheduler::Utils.enqueue_with_sidekiq(config)
@@ -308,17 +307,6 @@ module SidekiqScheduler
       queues.empty? || queues.include?(job_queue)
     end
 
-    # Returns true if the enqueuing needs to be done for an ActiveJob
-    #  class false otherwise.
-    #
-    # @param [Class] klass the class to check is decendant from ActiveJob
-    #
-    # @return [Boolean]
-    def active_job_enqueue?(klass)
-      klass.is_a?(Class) && defined?(ActiveJob::Enqueuing) &&
-        klass.included_modules.include?(ActiveJob::Enqueuing)
-    end
-
     # Convert the given arguments in the format expected to be enqueued.
     #
     # @param [Hash] config the options to be converted

data/lib/sidekiq-scheduler/utils.rb

@@ -68,6 +68,17 @@ module SidekiqScheduler
       end
     end
 
+    # Returns true if the enqueuing needs to be done for an ActiveJob
+    #  class false otherwise.
+    #
+    # @param [Class] klass the class to check is decendant from ActiveJob
+    #
+    # @return [Boolean]
+    def self.active_job_enqueue?(klass)
+      klass.is_a?(Class) && defined?(ActiveJob::Enqueuing) &&
+        klass.included_modules.include?(ActiveJob::Enqueuing)
+    end
+
     # Enqueues the job using the Sidekiq client.
     #
     # @param [Hash] config The job configuration

data/lib/sidekiq-scheduler/version.rb

@@ -1,5 +1,5 @@
 module SidekiqScheduler
 
-  VERSION = '3.0.1'
+  VERSION = '3.2.0'
 
 end

data/lib/sidekiq-scheduler/web.rb

@@ -15,13 +15,13 @@ module SidekiqScheduler
         erb File.read(File.join(VIEW_PATH, 'recurring_jobs.erb'))
       end
 
-      app.get '/recurring-jobs/:name/enqueue' do
+      app.post '/recurring-jobs/:name/enqueue' do
         schedule = Sidekiq.get_schedule(params[:name])
         SidekiqScheduler::Scheduler.instance.enqueue_job(schedule)
         redirect "#{root_path}recurring-jobs"
       end
 
-      app.get '/recurring-jobs/:name/toggle' do
+      app.post '/recurring-jobs/:name/toggle' do
         Sidekiq.reload_schedule!
 
         SidekiqScheduler::Scheduler.instance.toggle_job_enabled(params[:name])

data/web/assets/stylesheets/recurring_jobs.css

@@ -0,0 +1,27 @@
+.recurring-jobs { border-top-left-radius: 4px; border-top-right-radius: 4px; }
+.recurring-jobs .title { margin-bottom: 5px; }
+.recurring-jobs .title .name { font-weight: bold;}
+.recurring-jobs .info,
+.recurring-jobs .description { margin-bottom: 5px; }
+.recurring-jobs .actions { margin-bottom: 5px; }
+.recurring-jobs .status,
+.recurring-jobs .description { font-size: 12px; }
+.recurring-jobs .enqueue { margin-bottom: 0.5rem }
+
+.list-group-item {
+  background-color: #f3f3f3;
+  color: #585454;
+  border: 1px solid rgba(0, 0, 0, 0.1);
+}
+
+.list-group-item-disabled {
+  background-color: #f3d3d3;
+}
+
+@media (prefers-color-scheme: dark) {
+  .list-group-item {
+    background-color: #222;
+    color: white;
+    border: 1px solid #555;
+  }
+}

data/web/views/recurring_jobs.erb

@@ -1,48 +1,50 @@
-<h3><%= t('recurring_jobs') %></h3>
+<link href="<%= root_path %>stylesheets/recurring_jobs.css" media="screen" rel="stylesheet" type="text/css" />
 
-<div class="table_container">
-  <table class="table table-hover table-bordered table-striped table-white">
-    <thead>
-      <tr>
-        <th><%= t('name') %></th>
-        <th><%= t('description') %></th>
-        <th><%= t('interval') %></th>
-        <th><%= t('class') %></th>
-        <th><%= t('queue') %></th>
-        <th><%= t('arguments') %></th>
-        <th><%= t('last_time') %></th>
-        <th><%= t('next_time') %></th>
-        <th></th>
-      </tr>
-    </thead>
+<h3><%= t('recurring_jobs') %></h3>
 
-    <tbody>
-      <% @presented_jobs.each do |job| %>
-        <tr>
-          <td><%= job.name %></td>
-          <td><%= job['description'] %></td>
-          <td><%= job.interval %></td>
-          <td><%= job['class'] %></td>
-          <td>
-            <a href="<%= root_path %>queues/<%= job.queue %>"><%= job.queue %></a>
-          </td>
-          <td><%= job['args'] %></td>
-          <td><%= job.last_time %></td>
-          <td>
-            <span style="<%= 'text-decoration:line-through' unless job.enabled? %>">
-              <%= job.next_time || t('no_next_time') %>
+<div class="recurring-jobs">
+  <ul class="list-group">
+    <% @presented_jobs.each do |job| %>
+      <li class="list-group-item <%= !job.enabled? && "list-group-item-disabled" %>">
+        <div class="title">
+          <div class="row">
+            <div class="col-xs-6">
+              <span class="name"><%= job.name %></span>
+            </div>
+            <div class="col-xs-6 text-right">
+              <a href="<%= root_path %>queues/<%= job.queue %>"><%= job.queue %></a>
+            </div>
+          </div>
+        </div>
+        <div class="description"><%= job['description'] %></div>
+        <div class="info">
+          <div class="row">
+            <div class="col-md-4 class"><%= job['class'] %></div>
+            <div class="col-md-4 interval text-left"><%= t('interval') %>: <%= job.interval %></div>
+            <div class="col-md-4 args"><%= t('arguments') %>: <%= job['args'] %></div>
+          </div>
+        </div>
+        <div class="status row">
+          <div class="col-md-4 actions">
+            <form action="<%= root_path %>recurring-jobs/<%= ERB::Util.url_encode(job.name) %>/enqueue" method="post" class="enqueue">
+              <%= csrf_tag %>
+              <input type="submit" class="btn btn-warn btn-xs" value="<%= t('enqueue_now') %>" />
+            </form>
+            <form action="<%= root_path %>recurring-jobs/<%= ERB::Util.url_encode(job.name) %>/toggle" method="post">
+              <%= csrf_tag %>
+              <input type="submit" class="btn <%= job.enabled? ? "btn-primary" : "btn-warn"%> btn-xs" value="<%= job.enabled? ? t('disable') : t('enable') %>" />
+            </form>
+          </div>
+          <div class="col-md-4">
+            <span class="last_time"><%= t('last_time') %>: <%= job.last_time %></span>
+          </div>
+          <div class="col-md-4">
+            <span class="next_time text-right" style="<%= 'text-decoration:line-through' unless job.enabled? %>">
+              <%= t('next_time') %>: <%= 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 %>
-    </tbody>
-  </table>
+          </div>
+        </div>
+      </li>
+    <% end %>
+  </ul>
 </div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-scheduler
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Morton Jonuschat
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-03 00:00:00.000000000 Z
+date: 2022-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -279,6 +279,7 @@ files:
 - lib/sidekiq-scheduler/version.rb
 - lib/sidekiq-scheduler/web.rb
 - lib/sidekiq/scheduler.rb
+- web/assets/stylesheets/recurring_jobs.css
 - web/locales/cs.yml
 - web/locales/de.yml
 - web/locales/en.yml
@@ -312,7 +313,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.19
 signing_key: 
 specification_version: 4
 summary: Light weight job scheduling extension for Sidekiq