sidekiq-scheduler 3.2.1 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f30ce85a9aba1cfa5987dbbd3ec24715b4d6adeadd3e36079be8425d0d673b7
-  data.tar.gz: 92b27fba4b1405a4466ff180ebd60fc981e07cbc15d2497a63af9ae8d1c2ab2b
+  metadata.gz: 1106fa4b63b6bb5d15759e20a1bdfb617a4fe53adb3c8041455e80aee14a2bde
+  data.tar.gz: f4f954b22fa9f6f36ff9fe664a962ab40b75b279ebd292fb64e06f917e3b050a
 SHA512:
-  metadata.gz: 211ec1b0efa783fec645f9afb598225456a9d2e61a17318e95eb9c3eec71cfb061606829667e51e49badb9b23aca46d905e500eda4d09704af959749eba5b651
-  data.tar.gz: d832b58c8b2526774dd7b54ec7295c89da87b000b105cca465631c628941a7b21e9f864f29c2360d2203f7463412d0c7eab2ee2b7d69f566598a46f56ca94428
+  metadata.gz: 39c7aedbbf5260a184c7507f5fa0f84c0178a45465ff662f253fe23a1828d9d33e457ce9c5f1abbfd6a6d0d4a4d9915b4422dcef80f8d89e4856c80333fbeff1
+  data.tar.gz: c04e172346a179aea9d22ee45d9a4546e44d241016ce012063d72005e6e9d10ff99364e7b34b11311c339c0a5894a737dea01fb16783883a2aa37b52f504ddd4

data/CHANGELOG.md

@@ -1,7 +1,20 @@
-# 3.2.1
-  - Fix CSS not loading on Rails app when Sidekiq < 6 https://github.com/moove-it/sidekiq-scheduler/pull/377
-# 3.2.0
+# 4.0.1
 
-- Fix deprecated uses of Redis#pipelined https://github.com/moove-it/sidekiq-scheduler/pull/357
-- Prevent sidekiq_options from overriding ActiveJob queue settings https://github.com/moove-it/sidekiq-scheduler/pull/367
-- Highlight disabled jobs https://github.com/moove-it/sidekiq-scheduler/pull/369
+- [**FIX**] Add support for sidekiq 6.5 [#382](https://github.com/moove-it/sidekiq-scheduler/pull/382)
+
+# 4.0.0
+
+- [**FIX**] Fix CSS not loading on Rails app when Sidekiq < 6 [#377](https://github.com/moove-it/sidekiq-scheduler/pull/377)
+- [**BREAKING CHANGE**] Drop support for Sidekiq 3 [f15e7ca1a5f3ab5b6fd3d7664d67723dba1fa1f1](https://github.com/moove-it/sidekiq-scheduler/commit/f15e7ca1a5f3ab5b6fd3d7664d67723dba1fa1f1)
+
+# 4.0.0.alpha1
+
+- [**FIX**] Fix deprecated uses of Redis#pipelined [#357](https://github.com/moove-it/sidekiq-scheduler/pull/357)
+- [**DOCS**] Add docs for running multi-sidekiq configurations [#362](https://github.com/moove-it/sidekiq-scheduler/pull/362)
+- [**FIX**] Prevent sidekiq_options from overriding ActiveJob queue settings [#367](https://github.com/moove-it/sidekiq-scheduler/pull/367)
+- [**ENHANCEMENT**] Highlight disabled jobs [#369](https://github.com/moove-it/sidekiq-scheduler/pull/369)
+- [**BREAKING CHANGE**] Require redis 4.2.0 [#370](https://github.com/moove-it/sidekiq-scheduler/pull/370)
+- [**FIX**] Fixes redis deprecation warning regarding `exists` [#370](https://github.com/moove-it/sidekiq-scheduler/pull/370)
+- [**BREAKING CHANGE**] Remove dependecy on thwait and e2mmap [#371](https://github.com/moove-it/sidekiq-scheduler/pull/371)
+- Support Ruby 3.1 [#373](https://github.com/moove-it/sidekiq-scheduler/pull/373)
+- [**BREAKING CHANGE**] Set rufus_scheduler_options via sidekiq.yml file as configuration option [#375](https://github.com/moove-it/sidekiq-scheduler/pull/375)

data/README.md

@@ -30,7 +30,7 @@
 `sidekiq-scheduler` is an extension to [Sidekiq](http://github.com/mperham/sidekiq) that
 pushes jobs in a scheduled way, mimicking cron utility.
 
-__Note:__ If you are looking for version 2.2.*, go to [2.2-stable branch](https://github.com/moove-it/sidekiq-scheduler/tree/2.2-stable).
+__Note:__ Current branch contains work of the V4 release, if you are looking for version 2.2.* or 3.*, go to [2.2-stable branch](https://github.com/moove-it/sidekiq-scheduler/tree/2.2-stable) / [v3-stable](https://github.com/moove-it/sidekiq-scheduler/tree/v3-stable).
 
 ## Installation
 
@@ -100,6 +100,7 @@ Available options are:
 :enabled: <enables scheduler if true [true by default]>
 :scheduler:
   :listened_queues_only: <push jobs whose queue is being listened by sidekiq [false by default]>
+:rufus_scheduler_options: <Set custom options for rufus scheduler, like max_work_threads [{} by default]>
 ```
 
 ## Schedule configuration
@@ -304,10 +305,16 @@ If you're configuring your own Redis connection pool, you need to make sure the
 
 That's a minimum of `concurrency` + 5 (per the [Sidekiq wiki](https://github.com/mperham/sidekiq/wiki/Using-Redis#complete-control)) + `Rufus::Scheduler::MAX_WORK_THREADS` (28 as of this writing; per the [Rufus README](https://github.com/jmettraux/rufus-scheduler#max_work_threads)), for a total of 58 with the default `concurrency` of 25.
 
-You can also override the thread pool size in Rufus Scheduler by setting e.g.:
+You can also override the thread pool size in Rufus Scheduler by setting the following in your `sidekiq.yml` config:
 
-```
-SidekiqScheduler::Scheduler.instance.rufus_scheduler_options = { max_work_threads: 5 }
+```yaml
+---
+...
+
+rufus_scheduler_options:
+  max_work_threads: 5
+
+...
 ```
 
 ## Notes about running on Multiple Hosts
@@ -321,7 +328,7 @@ 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
+## 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.
 
@@ -334,6 +341,54 @@ Possible solutions include:
 
 Each option has it's own pros and cons. 
 
+## Notes when running multiple Sidekiq processors on the same Redis
+
+### TL;DR
+
+Be **sure** to include the `:enabled: false` top-level key on any additional
+configurations to avoid any possibility of the `schedules` definition being
+wiped by the second Sidekiq process.
+
+To illustrate what we mean:
+
+Say you have one process with the schedule:
+```yaml
+# e.g., config/sidekiq.yml
+
+:queues:
+  - default
+:schedule:
+  do_something_every_minute:
+    class: DoSomethingJob
+    args: matey
+    queue: :scheduler
+    cron: '0 * * * * * America/Los_Angeles'
+```
+
+And a separate separate configured process without one:
+```yaml
+# e.g., config/sidekiq_other.yml
+:queues:
+  - scheduler
+
+## NOTE Disable the Scheduler
+:enabled: false
+```
+
+### Details
+
+This gem stores the configured schedule in Redis on boot. It's used, primarily,
+to display in the Web Integration, and allow you to interact with that schedule
+via that integration.
+
+If you're running multiple Sidekiq processes on the same Redis namespace with
+different configurations, **you'll want to explicitly _disable_ Sidekiq
+Scheduler** for the other processes not responsible for the schedule. If you
+don't, the last booted Sidekiq processes' schedule will be what is stored in
+Redis.
+
+See https://github.com/moove-it/sidekiq-scheduler/issues/361 for a more details.
+
 ## Sidekiq Web Integration
 
 sidekiq-scheduler provides an extension to the Sidekiq web interface that adds a `Recurring Jobs` page.
@@ -408,6 +463,7 @@ MIT License
 
 ## Copyright
 
-Copyright 2013 - 2018 Moove-IT.
-Copyright 2012 Morton Jonuschat.
-Some parts copyright 2010 Ben VandenBos.
+- Copyright 2021 - 2022 Marcelo Lauxen.
+- Copyright 2013 - 2022 Moove-IT.
+- Copyright 2012 Morton Jonuschat.
+- Some parts copyright 2010 Ben VandenBos.

data/lib/sidekiq-scheduler/manager.rb

@@ -1,7 +1,5 @@
 require 'redis'
 
-require 'sidekiq/util'
-
 require 'sidekiq-scheduler/schedule'
 require 'sidekiq-scheduler/scheduler'
 
@@ -12,8 +10,6 @@ module SidekiqScheduler
   # from Redis onto the work queues
   #
   class Manager
-    include Sidekiq::Util
-
     DEFAULT_SCHEDULER_OPTIONS = {
       enabled: true,
       dynamic: false,

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', 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', name, JSON.generate(config))
     end
 
     # Sets the state for a given job
@@ -75,7 +75,7 @@ module SidekiqScheduler
     #
     # @param [String] name The name of the job
     def self.remove_job_schedule(name)
-      hdel(:schedules, name)
+      hdel('schedules', name)
     end
 
     # Removes the next execution time for a given job
@@ -89,21 +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') }
     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 do |r|
-        case r.exists(:schedules)
-        when true, 1
-          true
-        else
-          false
-        end
-      end
+      Sidekiq.redis { |r| r.exists?('schedules') }
     end
 
     # Returns all the schedule changes for a given time range.
@@ -113,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', 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', 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') unless r.type('schedules_changed') == 'zset' }
     end
 
     # Removes a queued job instance
@@ -188,7 +181,7 @@ module SidekiqScheduler
     end
 
     private
-
+    
     # Returns the value of a Redis stored hash field
     #
     # @param [String] hash_key The key name of the hash

data/lib/sidekiq-scheduler/scheduler.rb

@@ -1,14 +1,10 @@
 require 'rufus/scheduler'
-require 'thwait'
-require 'sidekiq/util'
 require 'json'
 require 'sidekiq-scheduler/rufus_utils'
 require 'sidekiq-scheduler/redis_manager'
 
 module SidekiqScheduler
   class Scheduler
-    extend Sidekiq::Util
-
     # We expect rufus jobs to have #params
     Rufus::Scheduler::Job.module_eval do
       alias_method :params, :opts
@@ -26,6 +22,9 @@ module SidekiqScheduler
     # Set to schedule jobs only when will be pushed to queues listened by sidekiq
     attr_accessor :listened_queues_only
 
+    # Set custom options for rufus scheduler, like max_work_threads.
+    attr_accessor :rufus_scheduler_options
+
     class << self
 
       def instance
@@ -47,6 +46,7 @@ module SidekiqScheduler
       self.dynamic = options[:dynamic]
       self.dynamic_every = options[:dynamic_every]
       self.listened_queues_only = options[:listened_queues_only]
+      self.rufus_scheduler_options = options[:rufus_scheduler_options] || {}
     end
 
     # the Rufus::Scheduler jobs that are scheduled
@@ -168,14 +168,6 @@ module SidekiqScheduler
       end
     end
 
-    def rufus_scheduler_options
-      @rufus_scheduler_options ||= {}
-    end
-
-    def rufus_scheduler_options=(options)
-      @rufus_scheduler_options = options
-    end
-
     def rufus_scheduler
       @rufus_scheduler ||= SidekiqScheduler::Utils.new_rufus_scheduler(rufus_scheduler_options)
     end

data/lib/sidekiq-scheduler/version.rb

@@ -1,5 +1,3 @@
 module SidekiqScheduler
-
-  VERSION = '3.2.1'
-
+  VERSION = "4.0.1"
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-scheduler
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 4.0.1
 platform: ruby
 authors:
 - Morton Jonuschat
 - Moove-it
+- Marcelo Lauxen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-27 00:00:00.000000000 Z
+date: 2022-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -17,34 +18,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
   requirement: !ruby/object:Gem::Requirement
@@ -73,34 +68,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.0
-- !ruby/object:Gem::Dependency
-  name: thwait
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: e2mmap
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -119,28 +86,28 @@ dependencies:
   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'
 - !ruby/object:Gem::Dependency
   name: mocha
   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
@@ -163,30 +130,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.28.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.28.0
 - !ruby/object:Gem::Dependency
   name: simplecov
-  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: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -200,7 +153,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activejob
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -214,7 +167,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -259,6 +212,7 @@ description: Light weight job scheduling extension for Sidekiq that adds support
   queueing jobs in a recurring way.
 email:
 - sidekiq-scheduler@moove-it.com
+- marcelolauxen16@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -307,7 +261,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="