sidekiq-scheduler 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46f14eafd933ccc91c36ba3b52babf250a9d17723d8a321b016bad2caaf36262
-  data.tar.gz: d285ce8992b380f98c05860883c54aa504c83df31aeba252297b1c02d35590a6
+  metadata.gz: c16869144651f4193112eb896e092d382af94340b373f11ba92cefbdcc8fa875
+  data.tar.gz: 00b8efaca9cfcfe0379b633f5ca8aa215fa1f382fcd86fd29910b7ac64e6db7f
 SHA512:
-  metadata.gz: fe3a692c9419fe21b60333f4801c519fa9eb96b2c49f4f7ad9f6bb41001ac8c0b9884ffa01c19018fe5101e2419f09af3df93f3efcd4de11b87b108d785a5047
-  data.tar.gz: 264780676f625a002b67b88eb03ee12981a2e222889334799e76c1aefde9ec3d35fad50d645233bd27c195113ea14e5af68ad3d82b4f853e7342f6ae2c3d08c3
+  metadata.gz: 5afc74e4fa2a54d2b00e9d1a1343f64f242d217bee9c0ec170a4fd502cc7d7233598123c769034b7ad830c75eecab1f9aa99513bcac0d42bcaef91d771ddf7d0
+  data.tar.gz: 2e096c861063f78ce359807fd6e58477ca3e8489d645dca3a5c188e5713ed07b61392ddc96ec0d0eb6f5c0c6b3da91aec3c9cf3e27dcd9f4094f37b3185352b1

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 4.0.3
+
+- [**GH Actions**] Add dependabot for GitHub Actions [#390](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/390)
+- [**ENHANCEMENT**] Add «Enable all» and «Disable all» buttons [#398](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/398)
+- [**ENHANCEMENT**] Allow for multiple applications to share a Redis DB [#401](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/401)
+- [**FIX**] Fix metadata for Sidekiq strict_args! [#403](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/403)
+- [**FIX**] Redis 5.0 compatibility [#404](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/404)
+- [**FIX**] Fix the constantize method [#408](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/408)
+
 # 4.0.2
 
 - [**FIX**] Fix sidekiq deprecation warning when Sidekiq 6.5+ [#385](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/385)

data/README.md

@@ -316,6 +316,47 @@ Non-normal conditions that could push a specific job multiple times are:
 
 `every`, `interval` and `in` jobs will be pushed once per host.
 
+### Suggested setup for Multiple Hosts using Heroku and Rails
+
+Configuration options `every`, `interval` and `in` will push once per host. This may be undesirable. One way to achieve single jobs per the schedule would be to manually designate a host as the scheduler. The goal is to have a single scheduler process running across all your hosts. 
+
+This can be achieved by using an environment variable and controlling the number of dynos. In Rails, you can read this variable during initialization and then conditionally load your config file.
+
+Suppose we are using Rails and have the following schedule:
+
+```yaml
+# config/scheduler.yml
+MyRegularJob:
+  description: "We want this job to run very often, but we do not want to run more of them as we scale"
+  interval: ["1m"]
+  queue: default
+```
+
+Then we can conditionally load it via an initializer:
+
+```ruby
+# config/initializer/sidekiq.rb
+if ENV.fetch("IS_SCHEDULER", false)
+  Sidekiq.configure_server do |config|
+    config.on(:startup) do
+      Sidekiq.schedule = YAML.load_file(File.expand_path("../scheduler.yml", File.dirname(__FILE__)))
+      Sidekiq::Scheduler.reload_schedule!
+    end
+  end
+end
+```
+
+Then you would just need to flag the scheduler process when you start it. If you are using a Procfile, it would look like this:
+
+```yaml
+# Procfile
+web: bin/rails server
+worker: bundle exec sidekiq -q default
+scheduler: IS_SCHEDULER=true bundle exec sidekiq -q default
+```
+
+When running via Heroku, you set your `scheduler` process to have 1 dyno. This will ensure you have at most 1 worker loading the schedule. 
+
 ## 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.
@@ -377,6 +418,22 @@ Redis.
 
 See https://github.com/sidekiq-scheduler/sidekiq-scheduler/issues/361 for a more details.
 
+## Notes when running multiple applications in the same Redis database
+
+_NOTE_: **Although we support this option, we recommend having separate redis databases for each application. Choosing this option is at your own risk.**
+
+If you need to run multiple applications with differing schedules, the easiest way is to use a different Redis database per application. Doing that will ensure that each application will have its own schedule, web interface and statistics.
+
+However, you may want to have a set of related applications share the same Redis database in order to aggregate statistics and manage them all in a single web interface. To do this while maintaining a different schedule for each application, you can configure each application to use a different `key_prefix` in Redis. This prevents the applications overwriting each others' schedules and schedule data.
+
+```ruby
+Rails.application.reloader.to_prepare do
+  SidekiqScheduler::RedisManager.key_prefix = "my-app"
+end
+```
+
+Note that this must be set before the schedule is loaded (or it will go into the wrong key). If you are using the web integration, make sure that the prefix is set in the web process so that you see the correct schedule.
+
 ## 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

@@ -7,7 +7,7 @@ Sidekiq::Web.tabs['recurring_jobs'] = 'recurring-jobs'
 Sidekiq::Web.locales << File.expand_path("#{File.dirname(__FILE__)}/../../../web/locales")
 
 if Sidekiq::VERSION >= '6.0.0'
-  Sidekiq::Web.use Rack::Static, urls: ['/stylesheets'],
+  Sidekiq::Web.use Rack::Static, urls: ['/stylesheets-scheduler'],
                                  root: ASSETS_PATH,
                                  cascade: true,
                                  header_rules: [[:all, { 'Cache-Control' => 'public, max-age=86400' }]]

data/lib/sidekiq-scheduler/redis_manager.rb

@@ -9,7 +9,7 @@ module SidekiqScheduler
     #
     # @return [String] schedule in JSON format
     def self.get_job_schedule(name)
-      hget('schedules', name)
+      hget(schedules_key, name)
     end
 
     # Returns the state of a given job
@@ -44,7 +44,7 @@ module SidekiqScheduler
     # @param [String] name The name of the job
     # @param [Hash] config The new schedule for the job
     def self.set_job_schedule(name, config)
-      hset('schedules', name, JSON.generate(config))
+      hset(schedules_key, name, JSON.generate(config))
     end
 
     # Sets the state for a given job
@@ -60,7 +60,7 @@ module SidekiqScheduler
     # @param [String] name The name of the job
     # @param [String] next_time The next time the job has to be executed
     def self.set_job_next_time(name, next_time)
-      hset(next_times_key, name, next_time)
+      hset(next_times_key, name, String(next_time))
     end
 
     # Sets the last execution time for a given job
@@ -68,14 +68,14 @@ module SidekiqScheduler
     # @param [String] name The name of the job
     # @param [String] last_time The last time the job was executed
     def self.set_job_last_time(name, last_time)
-      hset(last_times_key, name, last_time)
+      hset(last_times_key, name, String(last_time))
     end
 
     # Removes the schedule for a given job
     #
     # @param [String] name The name of the job
     def self.remove_job_schedule(name)
-      hdel('schedules', name)
+      hdel(schedules_key, name)
     end
 
     # Removes the next execution time for a given job
@@ -89,14 +89,14 @@ module SidekiqScheduler
     #
     # @return [Hash] hash with all the job schedules
     def self.get_all_schedules
-      Sidekiq.redis { |r| r.hgetall('schedules') }
+      Sidekiq.redis { |r| r.hgetall(schedules_key) }
     end
 
     # Returns boolean value that indicates if the schedules value exists
     #
     # @return [Boolean] true if the schedules key is set, false otherwise
     def self.schedule_exist?
-      Sidekiq.redis { |r| r.exists?('schedules') }
+      Sidekiq.redis { |r| r.exists?(schedules_key) }
     end
 
     # Returns all the schedule changes for a given time range.
@@ -106,19 +106,19 @@ module SidekiqScheduler
     #
     # @return [Array] array with all the changed job names
     def self.get_schedule_changes(from, to)
-      Sidekiq.redis { |r| r.zrangebyscore('schedules_changed', from, "(#{to}") }
+      Sidekiq.redis { |r| r.zrangebyscore(schedules_changed_key, from, "(#{to}") }
     end
 
     # Register a schedule change for a given job
     #
     # @param [String] name The name of the job
     def self.add_schedule_change(name)
-      Sidekiq.redis { |r| r.zadd('schedules_changed', Time.now.to_f, name) }
+      Sidekiq.redis { |r| r.zadd(schedules_changed_key, Time.now.to_f, name) }
     end
 
     # Remove all the schedule changes records
     def self.clean_schedules_changed
-      Sidekiq.redis { |r| r.del('schedules_changed') unless r.type('schedules_changed') == 'zset' }
+      Sidekiq.redis { |r| r.del(schedules_changed_key) unless r.type(schedules_changed_key) == 'zset' }
     end
 
     # Removes a queued job instance
@@ -156,28 +156,57 @@ module SidekiqScheduler
     #
     # @return [String] the pushed job key
     def self.pushed_job_key(job_name)
-      "sidekiq-scheduler:pushed:#{job_name}"
+      "#{key_prefix}sidekiq-scheduler:pushed:#{job_name}"
     end
 
     # Returns the key of the Redis hash for job's execution times hash
     #
     # @return [String] with the key
     def self.next_times_key
-      'sidekiq-scheduler:next_times'
+      "#{key_prefix}sidekiq-scheduler:next_times"
     end
 
     # Returns the key of the Redis hash for job's last execution times hash
     #
     # @return [String] with the key
     def self.last_times_key
-      'sidekiq-scheduler:last_times'
+      "#{key_prefix}sidekiq-scheduler:last_times"
     end
 
     # Returns the Redis's key for saving schedule states.
     #
     # @return [String] with the key
     def self.schedules_state_key
-      'sidekiq-scheduler:states'
+      "#{key_prefix}sidekiq-scheduler:states"
+    end
+
+    # Returns the Redis's key for saving schedules.
+    #
+    # @return [String] with the key
+    def self.schedules_key
+      "#{key_prefix}schedules"
+    end
+
+    # Returns the Redis's key for saving schedule changes.
+    #
+    # @return [String] with the key
+    def self.schedules_changed_key
+      "#{key_prefix}schedules_changed"
+    end
+
+    # Returns the key prefix used to generate all scheduler keys
+    #
+    # @return [String] with the key prefix
+    def self.key_prefix
+      @key_prefix
+    end
+
+    # Sets the key prefix used to scope all scheduler keys
+    #
+    # @param [String] value The string to use as the prefix. A ":" will be appended as a delimiter if needed.
+    def self.key_prefix=(value)
+      value = "#{value}:" if value && !%w[. :].include?(value[-1])
+      @key_prefix = value
     end
 
     private

data/lib/sidekiq-scheduler/schedule.rb

@@ -148,9 +148,7 @@ module SidekiqScheduler
     end
 
     def try_to_constantize(klass)
-      klass.is_a?(String) ? klass.constantize : klass
-    rescue NameError
-      klass
+      SidekiqScheduler::Utils.try_to_constantize(klass)
     end
   end
 end

data/lib/sidekiq-scheduler/scheduler.rb

@@ -158,7 +158,7 @@ module SidekiqScheduler
       config = prepare_arguments(job_config.dup)
 
       if config.delete('include_metadata')
-        config['args'] = arguments_with_metadata(config['args'], scheduled_at: time.to_f)
+        config['args'] = arguments_with_metadata(config['args'], "scheduled_at" => time.to_f)
       end
 
       if SidekiqScheduler::Utils.active_job_enqueue?(config['class'])
@@ -228,6 +228,14 @@ module SidekiqScheduler
       set_schedule_state(name, state)
     end
 
+    def toggle_all_jobs(new_state)
+      Sidekiq.schedule!.keys.each do |name|
+        state = schedule_state(name)
+        state['enabled'] = new_state
+        set_schedule_state(name, state)
+      end
+    end
+
     private
 
     def new_job(name, interval_type, config, schedule, options)

data/lib/sidekiq-scheduler/utils.rb

@@ -49,7 +49,7 @@ module SidekiqScheduler
     #
     # @return [Class] the class corresponding to the klass param
     def self.try_to_constantize(klass)
-      klass.is_a?(String) ? klass.constantize : klass
+      klass.is_a?(String) ? Object.const_get(klass) : klass
     rescue NameError
       klass
     end
@@ -112,8 +112,10 @@ module SidekiqScheduler
     def self.new_rufus_scheduler(options = {})
       Rufus::Scheduler.new(options).tap do |scheduler|
         scheduler.define_singleton_method(:on_post_trigger) do |job, triggered_time|
-          SidekiqScheduler::Utils.update_job_last_time(job.tags[0], triggered_time)
-          SidekiqScheduler::Utils.update_job_next_time(job.tags[0], job.next_time)
+          if (job_name = job.tags[0])
+            SidekiqScheduler::Utils.update_job_last_time(job_name, triggered_time)
+            SidekiqScheduler::Utils.update_job_next_time(job_name, job.next_time)
+          end
         end
       end
     end

data/lib/sidekiq-scheduler/version.rb

@@ -1,3 +1,3 @@
 module SidekiqScheduler
-  VERSION = "4.0.2"
+  VERSION = "4.0.3"
 end

data/lib/sidekiq-scheduler/web.rb

@@ -27,6 +27,11 @@ module SidekiqScheduler
         SidekiqScheduler::Scheduler.instance.toggle_job_enabled(params[:name])
         redirect "#{root_path}recurring-jobs"
       end
+
+      app.post '/recurring-jobs/toggle-all' do
+        SidekiqScheduler::Scheduler.instance.toggle_all_jobs(params[:action] == 'enable')
+        redirect "#{root_path}recurring-jobs"
+      end
     end
   end
 end

data/web/assets/{stylesheets → stylesheets-scheduler}/recurring_jobs.css

@@ -25,3 +25,18 @@
     border: 1px solid #555;
   }
 }
+
+.toggle-all-buttons {
+  margin-top: 20px;
+  margin-bottom: 10px;
+  line-height: 45px;
+  text-align: right;
+}
+
+@media (max-width: 768px) {
+  .toggle-all-buttons {
+    margin-top: 0;
+    text-align: left;
+    line-height: inherit;
+  }
+}

data/web/locales/de.yml

@@ -12,3 +12,5 @@ de:
   no_next_time: Keine zukünftige Ausführung für diesen Job
   disable: Deaktivieren
   enable: Aktivieren
+  disable_all: Alle deaktivieren
+  enable_all: Alle aktivieren

data/web/locales/en.yml

@@ -12,3 +12,5 @@ en:
   no_next_time: no next execution for this job
   disable: Disable
   enable: Enable
+  disable_all: Disable all
+  enable_all: Enable all

data/web/locales/ru.yml

@@ -12,3 +12,5 @@ ru:
   no_next_time: выполнение задачи не запланировано
   disable: Выключить
   enable: Включить
+  disable_all: Выключить все
+  enable_all: Включить все

data/web/views/recurring_jobs.erb

@@ -1,5 +1,5 @@
 <% if Sidekiq::VERSION >= '6.0.0' %>
-  <link href="<%= root_path %>stylesheets/recurring_jobs.css" media="screen" rel="stylesheet" type="text/css" />
+  <link href="<%= root_path %>stylesheets-scheduler/recurring_jobs.css" media="screen" rel="stylesheet" type="text/css" />
 <% else %>
   <style>
     .recurring-jobs { border-top-left-radius: 4px; border-top-right-radius: 4px; }
@@ -21,10 +21,36 @@
     .list-group-item-disabled {
       background-color: #f3d3d3;
     }
+
+    .toggle-all-buttons {
+      margin-top: 20px;
+      margin-bottom: 10px;
+      line-height: 45px;
+      text-align: right;
+    }
+
+    @media (max-width: 768px) {
+      .toggle-all-buttons {
+        margin-top: 0;
+        text-align: left;
+        line-height: inherit;
+      }
+    }
   </style>
 <% end %>
 
-<h3><%= t('recurring_jobs') %></h3>
+<div class="row">
+  <div class="col-sm-6">
+    <h3><%= t('recurring_jobs') %></h3>
+  </div>
+  <div class="col-sm-6 toggle-all-buttons">
+    <form action="<%= root_path %>recurring-jobs/toggle-all" method="post">
+      <%= csrf_tag %>
+      <button type="submit" class="btn btn-warn btn-xs" name="action" value="enable"><%= t('enable_all') %></button>
+      <button type="submit" class="btn btn-warn btn-xs" name="action" value="disable"><%= t('disable_all') %></button>
+    </form>
+  </div>
+</div>
 
 <div class="recurring-jobs">
   <ul class="list-group">

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-scheduler
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
 platform: ruby
 authors:
 - Morton Jonuschat
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-27 00:00:00.000000000 Z
+date: 2022-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -19,6 +19,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,6 +29,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -124,20 +130,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mock_redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.28.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.28.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +226,7 @@ files:
 - lib/sidekiq-scheduler/version.rb
 - lib/sidekiq-scheduler/web.rb
 - lib/sidekiq/scheduler.rb
-- web/assets/stylesheets/recurring_jobs.css
+- web/assets/stylesheets-scheduler/recurring_jobs.css
 - web/locales/cs.yml
 - web/locales/de.yml
 - web/locales/en.yml
@@ -268,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.19
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Light weight job scheduling extension for Sidekiq