sidekiq-cron 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 437dc35edb85224f5e77eaa73be4adac923adb313f755f3029a4037e92a9c523
-  data.tar.gz: 517c8dd23943edb6c1e6e3059b4b6f7044ff85d13594447dbb097ff7438afc63
+  metadata.gz: ccf886f1cd7a1369e8a3dc9a9b9bff96c0742e22e751d9ae61e66f9fa376f873
+  data.tar.gz: 7ad6cd7f4637e0264cdfe529a960891275cd37c03e8bb3eb5e856bfadaa879a1
 SHA512:
-  metadata.gz: 8d943877a3c9577b060ccbc86fca6e256ac6e12e7ab4ef5428091960d82d119b8087264b3fd20afcd2a191dc722f42deab5701557aa5d1fd9e0f2cfe10357b26
-  data.tar.gz: 39f3b04c168c250f0273796fb1c6f20947114d92030d60fed74d2c5087ee401b35f0b3e1fdea00a6c7eac9116d76204ce439dae7a5ba965b60978034ae472d38
+  metadata.gz: 90d285a52788e04f6eb253f9f1b215e82a2ab68dc225eb3a4f4f6e2424cfbc190e629a9fa36238b03510cbcc1e2868d9dbf66efd8adbcd68d0aa48a5362e6ba2
+  data.tar.gz: cb48a228304927385f5ea69da2d233fb338efe85875c1e1bd14c3d8b52bf0cf286c307d0c841b04fc98b71453167cb4e932b7f67a15f27faadef580154be4a1f

data/{Changes.md → CHANGELOG.md}

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.6.0
+
+- Adds support for auto-loading the config/schedule.yml file (https://github.com/ondrejbartas/sidekiq-cron/pull/337)
+- Fix Sidekiq.options deprecation warning (https://github.com/ondrejbartas/sidekiq-cron/pull/338)
+
+## 1.5.1
+
+-  Fixes an issue that prevented the gem to work in previous Sidekiq versions (https://github.com/ondrejbartas/sidekiq-cron/pull/335)
+
+## 1.5.0
+
+- Integrate Sidekiq v6.5 breaking changes (https://github.com/ondrejbartas/sidekiq-cron/pull/331)
+- Add portuguese translations (https://github.com/ondrejbartas/sidekiq-cron/pull/332)
+
 ## 1.4.0
 
 - Fix buttons order in job show view (https://github.com/ondrejbartas/sidekiq-cron/pull/302)

data/README.md

@@ -27,7 +27,7 @@ Please be aware that Sidekiq-Cron < 1.0 was relying on rufus-scheduler < 3.5. Us
 
 ## Changelog
 
-Before upgrading to a new version, please read our [Changelog](Changes.md).
+Before upgrading to a new version, please read our [Changelog](CHANGELOG.md).
 
 ## Installation
 
@@ -35,6 +35,7 @@ Before upgrading to a new version, please read our [Changelog](Changes.md).
 
 - Redis 2.8 or greater is required (Redis 3.0.3 or greater is recommended for large scale use)
 - Sidekiq 4.2 or greater is required (for Sidekiq < 4 use version sidekiq-cron 0.3.1)
+- Sidekiq 6.5 requires Sidekiq-Cron 1.5+
 
 Install the gem:
 
@@ -45,7 +46,7 @@ $ gem install sidekiq-cron
 Or add to your `Gemfile` and run `bundle install`:
 
 ```ruby
-gem "sidekiq-cron", "~> 1.3"
+gem "sidekiq-cron"
 ```
 
 **NOTE** If you are not using Rails, you need to add `require 'sidekiq-cron'` somewhere after `require 'sidekiq'`.
@@ -93,7 +94,7 @@ For example: `"*/30 * * * * *"` would schedule a job to run every 30 seconds.
 Note that if you plan to schedule jobs with second precision you may need to override the default schedule poll interval so it is lower than the interval of your jobs:
 
 ```ruby
-Sidekiq.options[:average_scheduled_poll_interval] = 10
+Sidekiq[:average_scheduled_poll_interval] = 10
 ```
 
 The default value at time of writing is 30 seconds. See [under the hood](#under-the-hood) for more details.
@@ -226,21 +227,19 @@ second_job:
     hard: "stuff"
 ```
 
-```ruby
-# config/initializers/sidekiq.rb
-schedule_file = "config/schedule.yml"
-
-if File.exist?(schedule_file) && Sidekiq.server?
-  Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
-end
-```
+There are multiple ways to load the jobs from a YAML file
 
-From version 3.x it is better not to use separate initializer of schedule instead add `config.on(:startup)` to your Sidekiq configuration:
+1. The gem will automatically load the jobs mentioned in `config/schedule.yml` file.
+2. When you want to load jobs from a different filename, mention the filename in sidekiq configuration,
+i.e. `cron_schedule_file: "config/users_schedule.yml"`
+3. Load the file manually as follows
 
 ```ruby
+# config/initializers/sidekiq.rb
+
 Sidekiq.configure_server do |config|
   config.on(:startup) do
-    schedule_file = "config/schedule.yml"
+    schedule_file = "config/users_schedule.yml"
 
     if File.exist?(schedule_file)
       Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
@@ -315,30 +314,6 @@ With this, you will get:
 
 ![Web UI](examples/web-cron-ui.png)
 
-### Forking Processes or problem with `NotImplementedError`
-
-If you're using a forking web server like Unicorn you may run into an issue where the Redis connection is used
-before the process forks, causing the following exception to occur:
-
-```
-Redis::InheritedError: Tried to use a connection from a child process without reconnecting. You need to reconnect to Redis after forking.
-```
-
-To avoid this, wrap your job creation in the call to `Sidekiq.configure_server`:
-
-```ruby
-Sidekiq.configure_server do |config|
-  config.on(:startup) do
-    schedule_file = "config/schedule.yml"
-
-    if File.exist?(schedule_file)
-      Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
-    end
-  end
-end
-```
-
-**NOTE** This API is only available in Sidekiq 3.x.
 
 ## Under the hood
 
@@ -349,7 +324,7 @@ Sidekiq-Cron adds itself into this start procedure and starts another thread wit
 Sidekiq-Cron is checking jobs to be enqueued every 30s by default, you can change it by setting:
 
 ```ruby
-Sidekiq.options[:average_scheduled_poll_interval] = 10
+Sidekiq[:average_scheduled_poll_interval] = 10
 ```
 
 Sidekiq-Cron is safe to use with multiple Sidekiq processes or nodes. It uses a Redis sorted set to determine that only the first process who asks can enqueue scheduled jobs into the queue.
@@ -364,6 +339,7 @@ Sidekiq-Cron is safe to use with multiple Sidekiq processes or nodes. It uses a
 * Start a feature/bugfix branch.
 * Commit and push until you are happy with your contribution.
 * Make sure to add tests for it. This is important so we don't break it in a future version unintentionally.
+* Open a pull request!
 
 ### Testing
 

data/lib/sidekiq/cron/job.rb

@@ -1,15 +1,10 @@
 require 'fugit'
 require 'sidekiq'
-require 'sidekiq/util'
 require 'sidekiq/cron/support'
 
 module Sidekiq
   module Cron
-
     class Job
-      include Util
-      extend Util
-
       #how long we would like to store informations about previous enqueues
       REMEMBER_THRESHOLD = 24 * 60 * 60
       LAST_ENQUEUE_TIME_FORMAT = '%Y-%m-%d %H:%M:%S %z'
@@ -76,7 +71,7 @@ module Sidekiq
 
         save_last_enqueue_time
         add_jid_history jid
-        logger.debug { "enqueued #{@name}: #{@message}" }
+        Sidekiq.logger.debug { "enqueued #{@name}: #{@message}" }
       end
 
       def is_active_job?
@@ -468,7 +463,7 @@ module Sidekiq
           time = Time.now.utc
           conn.zadd(job_enqueued_key, time.to_f.to_s, formated_last_time(time).to_s) unless conn.public_send(REDIS_EXISTS_METHOD, job_enqueued_key)
         end
-        logger.info { "Cron Jobs - added job with name: #{@name}" }
+        Sidekiq.logger.info { "Cron Jobs - added job with name: #{@name}" }
       end
 
       def save_last_enqueue_time
@@ -483,7 +478,8 @@ module Sidekiq
           jid: jid,
           enqueued: @last_enqueue_time
         }
-        @history_size ||= (Sidekiq.options[:cron_history_size] || 10).to_i - 1
+        cron_history_size = Sidekiq.respond_to?(:[]) ? Sidekiq[:cron_history_size] : Sidekiq.options[:cron_history_size]
+        @history_size ||= (cron_history_size || 10).to_i - 1
         Sidekiq.redis do |conn|
           conn.lpush jid_history_key,
                      Sidekiq.dump_json(jid_history)
@@ -509,7 +505,7 @@ module Sidekiq
           #delete main job
           conn.del redis_key
         end
-        logger.info { "Cron Jobs - deleted job with name: #{@name}" }
+        Sidekiq.logger.info { "Cron Jobs - deleted job with name: #{@name}" }
       end
 
       # remove all job from cron
@@ -517,7 +513,7 @@ module Sidekiq
         all.each do |job|
           job.destroy
         end
-        logger.info { "Cron Jobs - deleted all jobs" }
+        Sidekiq.logger.info { "Cron Jobs - deleted all jobs" }
       end
 
       # remove "removed jobs" between current jobs and new jobs

data/lib/sidekiq/cron/locales/pt.yml

@@ -0,0 +1,22 @@
+pt:
+  Job: Tarefa
+  Cron: Cron
+  CronJobs: Tarefas do Cron
+  EnqueueNow: Enfileirar agora
+  EnableAll: Habilitar todos
+  DisableAll: Desabilitar todos
+  EnqueueAll: Enfileirar todos
+  DeleteAll: Excluir todos
+  'Cron string': Cron
+  AreYouSureEnqueueCronJobs: Tem certeza de que deseja enfileirar TODOS as tarefas?
+  AreYouSureEnqueueCronJob: Tem certeza de que deseja enfileirar a tarefa %{job}?
+  AreYouSureDeleteCronJobs: Tem certeza de que deseja excluir TODOS as tarefas?
+  AreYouSureDeleteCronJob: Tem certeza de que deseja excluir a tarefa %{job}?
+  NoCronJobsWereFound: Nenhuma tarefa foi encontrada
+  Enable: Habilitar
+  Disable: Desabilitar
+  'Last enqueued': Último enfileirado
+  disabled: desabilitado
+  enabled: habilitado
+  NoHistoryWereFound: Nenhum histórico foi encontrado
+  Description: Descrição

data/lib/sidekiq/cron/poller.rb

@@ -1,5 +1,4 @@
 require 'sidekiq'
-require 'sidekiq/util'
 require 'sidekiq/cron'
 require 'sidekiq/scheduled'
 
@@ -9,6 +8,23 @@ module Sidekiq
 
     # The Poller checks Redis every N seconds for sheduled cron jobs
     class Poller < Sidekiq::Scheduled::Poller
+      def initialize
+        Sidekiq.configure_server do |config|
+          if config.respond_to?(:[])
+            config[:poll_interval_average] = config[:average_scheduled_poll_interval] || POLL_INTERVAL
+          else
+            config.options[:poll_interval_average] = config.options[:average_scheduled_poll_interval] || POLL_INTERVAL
+          end
+        end
+
+        if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("6.5.0")
+          # Sidekiq Poller init requires a config argument
+          super(Sidekiq)
+        else
+          super
+        end
+      end
+
       def enqueue
         time = Time.now.utc
         Sidekiq::Cron::Job.all.each do |job|
@@ -32,10 +48,6 @@ module Sidekiq
         Sidekiq.logger.error "CRON JOB: #{ex.backtrace.first}"
         handle_exception(ex) if respond_to?(:handle_exception)
       end
-
-      def poll_interval_average
-         Sidekiq.options[:average_scheduled_poll_interval] || POLL_INTERVAL
-      end
     end
   end
 end

data/lib/sidekiq/cron/schedule_loader.rb

@@ -0,0 +1,14 @@
+require "sidekiq"
+require "sidekiq/cron/job"
+
+if Sidekiq.server?
+  Sidekiq.configure_server do |config|
+    schedule_file = config.options[:cron_schedule_file] || "config/schedule.yml"
+
+    if File.exist?(schedule_file)
+      config.on(:startup) do
+        Sidekiq::Cron::Job.load_from_hash YAML.load_file(schedule_file)
+      end
+    end
+  end
+end

data/lib/sidekiq/cron/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Cron
-    VERSION = "1.4.0"
+    VERSION = "1.6.0"
   end
 end

data/lib/sidekiq/cron.rb

@@ -1,6 +1,7 @@
 require "sidekiq/cron/job"
 require "sidekiq/cron/poller"
 require "sidekiq/cron/launcher"
+require "sidekiq/cron/schedule_loader"
 
 module Sidekiq
   module Cron

data/sidekiq-cron.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name = "sidekiq-cron"
   s.version = Sidekiq::Cron::VERSION
 
-  s.required_ruby_version = ">= 2.5"
+  s.required_ruby_version = ">= 2.6"
   s.require_paths = ["lib"]
   s.authors = ["Ondrej Bartas"]
   s.description = "Enables to set jobs to be run in specified time (using CRON notation)"
@@ -16,14 +16,14 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = Dir.glob('lib/**/*') + Dir.glob('test/**/*') + [
-    "Changes.md",
+    "CHANGELOG.md",
     "Gemfile",
     "LICENSE.txt",
     "Rakefile",
     "README.md",
     "sidekiq-cron.gemspec",
   ]
- 
+
   s.homepage = "https://github.com/ondrejbartas/sidekiq-cron"
   s.licenses = ["MIT"]
   s.summary = "Sidekiq-Cron helps to add repeated scheduled jobs"
@@ -31,11 +31,11 @@ Gem::Specification.new do |s|
   s.add_dependency("fugit", "~> 1")
   s.add_dependency("sidekiq", ">= 4.2.1")
 
-  s.add_development_dependency("minitest")
-  s.add_development_dependency("mocha")
-  s.add_development_dependency("redis-namespace", ">= 1.5.2")
-  s.add_development_dependency("rack", "~> 2.0")
-  s.add_development_dependency("rack-test", "~> 1.0")
+  s.add_development_dependency("minitest", "~> 5.15")
+  s.add_development_dependency("mocha", "~> 1.14")
+  s.add_development_dependency("redis-namespace", "~> 1.8")
+  s.add_development_dependency("rack", "~> 2.2")
+  s.add_development_dependency("rack-test", "~> 1.1")
   s.add_development_dependency("rake", "~> 13.0")
-  s.add_development_dependency("simplecov")
+  s.add_development_dependency("simplecov", "~> 0.21")
 end

data/test/unit/job_test.rb

@@ -1030,6 +1030,16 @@ describe "Cron Job" do
         assert_equal Sidekiq::Cron::Job.all.size, 2, "Should have 2 jobs after load"
       end
 
+      it "duplicate jobs are not loaded" do
+        out = Sidekiq::Cron::Job.load_from_hash @jobs_hash
+        assert_equal out.size, 0, "should have no errors"
+        assert_equal Sidekiq::Cron::Job.all.size, 2, "Should have 2 jobs after load"
+
+        out_2 = Sidekiq::Cron::Job.load_from_hash @jobs_hash
+        assert_equal out_2.size, 0, "should have no errors"
+        assert_equal Sidekiq::Cron::Job.all.size, 2, "Should have 2 jobs after loading again"
+      end
+
       it "return errors on loaded jobs" do
         assert_equal Sidekiq::Cron::Job.all.size, 0, "Should have 0 jobs before load"
         #set something bag to hash

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cron
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Ondrej Bartas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-28 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fugit
@@ -42,72 +42,72 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.15'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +126,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
 description: Enables to set jobs to be run in specified time (using CRON notation)
 email: ondrej@bartas.cz
 executables: []
@@ -144,7 +144,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- Changes.md
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -156,9 +156,11 @@ files:
 - lib/sidekiq/cron/locales/de.yml
 - lib/sidekiq/cron/locales/en.yml
 - lib/sidekiq/cron/locales/ja.yml
+- lib/sidekiq/cron/locales/pt.yml
 - lib/sidekiq/cron/locales/ru.yml
 - lib/sidekiq/cron/locales/zh-CN.yml
 - lib/sidekiq/cron/poller.rb
+- lib/sidekiq/cron/schedule_loader.rb
 - lib/sidekiq/cron/support.rb
 - lib/sidekiq/cron/version.rb
 - lib/sidekiq/cron/views/cron.erb
@@ -183,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="