sidekiq-cron 1.5.1 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d138bcaa8a86a88e84e5cd8b5b9188e68217e268a466aef03f2b5dd30a7226d
-  data.tar.gz: 8cae5daa6693161b48b71b40607a0c8182764a82ffc3efd5eb8fd7bd0df65da7
+  metadata.gz: aaa6af217265c4e60b29018b984b43a4316b2618e52ce874db670e41ecadf85b
+  data.tar.gz: f70a50a90508ceb32bad90b8b2b6a880fb460f308dfa81f7380152742bb939cf
 SHA512:
-  metadata.gz: 0dd9f32211d51bbd71fadbd36b30970193fc725408207fe255ff58f88b56dc484815a0f52c788acebbcc6230665cf7c02ccdbd4f7425dd4d9414cd8dd098dbf7
-  data.tar.gz: 73e8040c64d5de227d0077a1d95081d47140ec0481706b16c00e830f421ce8952f0fb48a991f71033c65a115dc0f29f06e2a6c56aae38565ed5dae6bfcaea14d
+  metadata.gz: ef95b33d15c1867a3dc6cc096080af6f2fab50c4460d8be24948bcd887c6c278dc3ca1a8c92db8d1ce386d24e0ceb95f53f6add336c3315fec04f808b7451475
+  data.tar.gz: e30e02e3bcc13f8604426d5d9e5f30e24c46a85bfd7679544975a3bdfcc0510631d363ef041f948c8a51e289a02a222fd27bba572cf57ac1697aabb917673a01

data/CHANGELOG.md

@@ -0,0 +1,161 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 1.12.0
+
+- Remove Sidekiq.server? check from schedule loader (https://github.com/sidekiq-cron/sidekiq-cron/pull/436)
+- Parse arguments on `args=` method (https://github.com/sidekiq-cron/sidekiq-cron/pull/442)
+- Only check out a Redis connection if necessary (https://github.com/sidekiq-cron/sidekiq-cron/pull/438)
+
+## 1.11.0
+
+- Differentiates b/w "schedule" vs "dynamic" jobs (https://github.com/sidekiq-cron/sidekiq-cron/pull/431)
+- Clears scheduled jobs upon schedule load (https://github.com/sidekiq-cron/sidekiq-cron/pull/431)
+- Reduce gem size by excluding test files (https://github.com/sidekiq-cron/sidekiq-cron/pull/414)
+
+## 1.10.1
+
+- Use `hset` instead of deprecated `hmset` (https://github.com/sidekiq-cron/sidekiq-cron/pull/410)
+
+## 1.10.0
+
+- Remove EOL Ruby 2.6 support (https://github.com/sidekiq-cron/sidekiq-cron/pull/399)
+- Add a logo for the project! (https://github.com/sidekiq-cron/sidekiq-cron/pull/402)
+- Added support for ActiveRecord serialize/deserialize using GlobalID (https://github.com/sidekiq-cron/sidekiq-cron/pull/395)
+- Allow for keyword args (`embedded: true`) in Poller (https://github.com/sidekiq-cron/sidekiq-cron/pull/398)
+- Make last_enqueue_time be always an instance of Time (https://github.com/sidekiq-cron/sidekiq-cron/pull/354)
+- Fix argument error problem update from 1.6.0 to newer (https://github.com/sidekiq-cron/sidekiq-cron/pull/392)
+- Clear old jobs while loading the jobs from schedule via the schedule loader (https://github.com/sidekiq-cron/sidekiq-cron/pull/405)
+
+## 1.9.1
+
+- Always enqueue via Active Job interface when defined in cron job config (https://github.com/sidekiq-cron/sidekiq-cron/pull/381)
+- Fix schedule.yml YAML load errors on Ruby 3.1 (https://github.com/sidekiq-cron/sidekiq-cron/pull/386)
+- Require Fugit v1.8 to refactor internals (https://github.com/sidekiq-cron/sidekiq-cron/pull/385)
+
+## 1.9.0
+
+- Sidekiq v7 support (https://github.com/sidekiq-cron/sidekiq-cron/pull/369)
+- Add support for ERB templates in the auto schedule loader (https://github.com/sidekiq-cron/sidekiq-cron/pull/373)
+
+## 1.8.0
+
+- Fix deprecation warnings with redis-rb v4.8.0 (https://github.com/sidekiq-cron/sidekiq-cron/pull/356)
+- Fix poller affecting Sidekiq scheduled set poller (https://github.com/sidekiq-cron/sidekiq-cron/pull/359)
+- Fix default polling interval (https://github.com/sidekiq-cron/sidekiq-cron/pull/362)
+- Add italian locale (https://github.com/sidekiq-cron/sidekiq-cron/pull/367)
+- Allow disabling of cron polling (https://github.com/sidekiq-cron/sidekiq-cron/pull/368)
+
+## 1.7.0
+
+- Enable to use cron notation in natural language (ie `every 30 minutes`) (https://github.com/sidekiq-cron/sidekiq-cron/pull/312)
+- Fix `date_as_argument` feature to add timestamp argument at every cron job execution (https://github.com/sidekiq-cron/sidekiq-cron/pull/329)
+- Introduce `Sidekiq::Options` to centralize reading/writing options from different Sidekiq versions (https://github.com/sidekiq-cron/sidekiq-cron/pull/341)
+- Make auto schedule loading compatible with Array format (https://github.com/sidekiq-cron/sidekiq-cron/pull/345)
+
+## 1.6.0
+
+- Adds support for auto-loading the `config/schedule.yml` file (https://github.com/sidekiq-cron/sidekiq-cron/pull/337)
+- Fix `Sidekiq.options` deprecation warning (https://github.com/sidekiq-cron/sidekiq-cron/pull/338)
+
+## 1.5.1
+
+-  Fixes an issue that prevented the gem to work in previous Sidekiq versions (https://github.com/sidekiq-cron/sidekiq-cron/pull/335)
+
+## 1.5.0
+
+- Integrate Sidekiq v6.5 breaking changes (https://github.com/sidekiq-cron/sidekiq-cron/pull/331)
+- Add portuguese translations (https://github.com/sidekiq-cron/sidekiq-cron/pull/332)
+
+## 1.4.0
+
+- Fix buttons order in job show view (https://github.com/sidekiq-cron/sidekiq-cron/pull/302)
+- Dark Mode support in UI (https://github.com/sidekiq-cron/sidekiq-cron/pull/282)
+- Remove invocation of deprecated Redis functionality (https://github.com/sidekiq-cron/sidekiq-cron/pull/318)
+- Internal code cleanup (https://github.com/sidekiq-cron/sidekiq-cron/pull/317)
+- Optimize gem size (https://github.com/sidekiq-cron/sidekiq-cron/pull/322)
+- Fix "Show All" button on cron jobs view with Sidekiq 6.3.0+ (https://github.com/sidekiq-cron/sidekiq-cron/pull/321)
+- Documentation updates
+
+## 1.3.0
+
+- Add confirmation dialog when enquing jobs from UI
+- Start to support Sidekiq `average_scheduled_poll_interval` option (replaced `poll_interval`)
+- Fix deprecation warning for Redis 4.6.x
+- Fix different response from Redis#exists in different Redis versions
+- All PRs:
+  - https://github.com/sidekiq-cron/sidekiq-cron/pull/275
+  - https://github.com/sidekiq-cron/sidekiq-cron/pull/287
+  - https://github.com/sidekiq-cron/sidekiq-cron/pull/309
+  - https://github.com/sidekiq-cron/sidekiq-cron/pull/299
+  - https://github.com/sidekiq-cron/sidekiq-cron/pull/314
+  - https://github.com/sidekiq-cron/sidekiq-cron/pull/288
+
+## 1.2.0
+
+- Updated readme
+- Fix problem with Sidekiq::Launcher and requiring it when not needed
+- Better patching of Sidekiq::Launcher
+- Fixed Dockerfile
+
+## 1.1.0
+
+- Updated readme
+- Fix unit tests - changed argument error when getting invalid cron format
+- When fallbacking old job enqueued time use `Time.parse` without format (so Ruby can decide best method to parse it)
+- Add option `date_as_argument` which will add to your job arguments on last place `Time.now.to_f` when it was eneuqued
+- Add option `description` which will allow you to add notes to your jobs so in web view you can see it
+- Fixed translations
+
+## 1.0.4
+
+- Fix problem with upgrading to 1.0.x - parsing last enqued time didn't count with old time format stored in Redis
+
+## 1.0.0
+
+- Use [fugit](https://github.com/floraison/fugit) instead of [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) - API of cron didn't change (rufus scheduler is using fugit)
+- Better working with Timezones
+- Translations for JA, zh-CN
+- Cron without timezone are considered as UTC, to add Timezone to cron use format `* * * * * Europe/Berlin`
+- Be aware that this release can change when your jobs are enqueued (for me it didn't change but it is in one project, in other it can shift by different timezone setup)
+
+## 0.6.0
+
+- Set poller to check jobs every 30s by default (possible to override by `Sidekiq.options[:poll_interval] = 10`)
+- Add group actions (enqueue, enable, disable, delete) all in web view
+- Fix poller to enqueu all jobs in poll start time
+- Add performance test for enqueue of jobs (10 000 jobs in less than 19s)
+- Fix problem with default queue
+- Remove `redis-namespace` from dependencies
+- Update Ruby versions in Travis
+
+## 0.5.0
+
+- Add Docker support
+- All crons are now evaluated in UTC
+- Fix rufus scheduler & timezones problems
+- Add support for Sidekiq 4.2.1
+- Fix readme
+- Add Russian locale
+- User Rack.env in tests
+- Faster enqueue of jobs
+- Permit to use `ActiveJob::Base.queue_name_delimiter`
+- Fix problem with multiple times enqueue #84
+- Fix problem with enqueue of unknown class
+
+## 0.4.0
+
+- Enable to work with Sidekiq >= 4.0.0
+- Fix readme
+
+## 0.3.1
+
+- Add CSRF tags to forms so it will work with Sidekiq >= 3.4.2
+- Remove Tilt dependency
+
+## 0.3.0
+
+- Suport for Active Job
+- Sidekiq cron web ui needs to be loaded by: require 'sidekiq/cron/web'
+- Add load_from_hash! and load_from_array! which cleanup jobs before adding new ones

data/Gemfile

@@ -1,3 +1,6 @@
 source 'https://rubygems.org'
 
 gemspec
+
+# To test different Sidekiq versions
+gem "sidekiq", ENV.fetch("SIDEKIQ_VERSION", ">= 6")

data/README.md

@@ -1,9 +1,8 @@
-# Sidekiq-Cron
+![Sidekiq-Cron](logos/cover.png)
 
 [![Gem Version](https://badge.fury.io/rb/sidekiq-cron.svg)](https://badge.fury.io/rb/sidekiq-cron)
-[![Build Status](https://github.com/ondrejbartas/sidekiq-cron/workflows/CI/badge.svg?branch=master)](https://github.com/ondrejbartas/sidekiq-cron/actions)
-[![Coverage Status](https://coveralls.io/repos/github/ondrejbartas/sidekiq-cron/badge.svg?branch=master)](https://coveralls.io/github/ondrejbartas/sidekiq-cron?branch=master)
-[![Join the chat at https://gitter.im/ondrejbartas/sidekiq-cron](https://badges.gitter.im/ondrejbartas/sidekiq-cron.svg)](https://gitter.im/ondrejbartas/sidekiq-cron?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Build Status](https://github.com/sidekiq-cron/sidekiq-cron/workflows/CI/badge.svg?branch=master)](https://github.com/sidekiq-cron/sidekiq-cron/actions)
+[![codecov](https://codecov.io/gh/sidekiq-cron/sidekiq-cron/branch/master/graph/badge.svg?token=VK9IVLIaY8)](https://codecov.io/gh/sidekiq-cron/sidekiq-cron)
 
 > A scheduling add-on for [Sidekiq](https://sidekiq.org/)
 
@@ -21,22 +20,12 @@ Works with ActiveJob (Rails 4.2+).
 
 You don't need Sidekiq PRO, you can use this gem with plain Sidekiq.
 
-## Upgrade from < 0.6 to 1.0
-
-Please be aware that Sidekiq-Cron < 1.0 was relying on rufus-scheduler < 3.5. Using those older versions with rufus-scheduler >= 3.5 ends up with jobs failing on creation. Sidekiq-Cron 1.0 includes a patch that switches from rufus-scheduler to rufus-scheduler's core dependency, fugit.
-
 ## 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
 
-### Requirements
-
-- 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:
 
 ```
@@ -53,21 +42,23 @@ gem "sidekiq-cron"
 
 ## Getting Started
 
-**Job properties:**
+### Job properties
 
 ```ruby
 {
+  # MANDATORY
   'name' => 'name_of_job', # must be uniq!
-  'cron' => '1 * * * *',  # execute at 1 minute of every hour, ex: 12:01, 13:01, 14:01, 15:01, ... (HH:MM)
+  'cron' => '1 * * * *',  # execute at 1 minute of every hour, ex: 12:01, 13:01, 14:01, ...
   'class' => 'MyClass',
   # OPTIONAL
+  'source' => 'dynamic', # source of the job, `schedule`/`dynamic` (default: `dynamic`)
   'queue' => 'name of queue',
   'args' => '[Array or Hash] of arguments which will be passed to perform method',
   'date_as_argument' => true, # add the time of execution as last argument of the perform method
-  'active_job' => true,  # enqueue job through rails 4.2+ active job interface
-  'queue_name_prefix' => 'prefix', # rails 4.2+ active job queue with prefix
-  'queue_name_delimiter' => '.',  # rails 4.2+ active job queue with custom delimiter
-  'description' => 'A sentence describing what work this job performs.'
+  'active_job' => true,  # enqueue job through Rails 4.2+ Active Job interface
+  'queue_name_prefix' => 'prefix', # Rails 4.2+ Active Job queue with prefix
+  'queue_name_delimiter' => '.', # Rails 4.2+ Active Job queue with custom delimiter (default: '_')
+  'description' => 'A sentence describing what work this job performs'
   'status' => 'disabled' # default: enabled
 }
 ```
@@ -83,6 +74,17 @@ If using Rails, this is evaluated against the timezone configured in Rails, othe
 If you want to have your jobs enqueued based on a different time zone you can specify a timezone in the cronline,
 like this `'0 22 * * 1-5 America/Chicago'`.
 
+#### Natural-language formats
+
+Since sidekiq-cron `v1.7.0`, you can use the natural-language formats supported by Fugit, such as:
+
+```rb
+"every day at five" # => '0 5 * * *'
+"every 3 hours"     # => '0 */3 * * *'
+```
+
+See [the relevant part of Fugit documentation](https://github.com/floraison/fugit#fugitnat) for details.
+
 #### Second-precision (sub-minute) cronlines
 
 In addition to the standard 5-parameter cronline format, sidekiq-cron supports scheduling jobs with second-precision using a modified 6-parameter cronline format:
@@ -94,7 +96,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::Options[:cron_poll_interval] = 10
 ```
 
 The default value at time of writing is 30 seconds. See [under the hood](#under-the-hood) for more details.
@@ -134,6 +136,8 @@ which will ensure that arguments you are passing to it will be symbolized when p
 
 #### Adding Cron job
 
+Refer to [Schedule vs Dynamic jobs](#schedule-vs-dynamic-jobs) to understand the difference.
+
 ```ruby
 class HardWorker
   include Sidekiq::Worker
@@ -143,7 +147,7 @@ class HardWorker
   end
 end
 
-Sidekiq::Cron::Job.create(name: 'Hard worker - every 5min', cron: '*/5 * * * *', class: 'HardWorker') # execute at every 5 minutes, ex: 12:05, 12:10, 12:15...etc
+Sidekiq::Cron::Job.create(name: 'Hard worker - every 5min', cron: '*/5 * * * *', class: 'HardWorker') # execute at every 5 minutes
 # => true
 ```
 
@@ -164,6 +168,26 @@ unless job.save
 end
 ```
 
+Use ActiveRecord models as arguments
+
+```rb
+class Person < ApplicationRecord
+end
+
+class HardWorker < ActiveJob::Base
+  queue_as :default
+
+  def perform(person)
+    puts "person: #{person}"
+  end
+end
+
+
+person = Person.create(id: 1)
+Sidekiq::Cron::Job.create(name: 'Hard worker - every 5min', cron: '*/5 * * * *', class: 'HardWorker', args: person)
+# => true
+```
+
 Load more jobs from hash:
 
 ```ruby
@@ -202,7 +226,7 @@ array = [
 Sidekiq::Cron::Job.load_from_array array
 ```
 
-Bang-suffixed methods will remove jobs that are not present in the given hash/array, update jobs that have the same names, and create new ones when the names are previously unknown.
+Bang-suffixed methods will remove jobs where source is `schedule` and are not present in the given hash/array, update jobs that have the same names, and create new ones when the names are previously unknown.
 
 ```ruby
 Sidekiq::Cron::Job.load_from_hash! hash
@@ -227,31 +251,28 @@ 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 (it supports ERB)
+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)
+      schedule = YAML.load_file(schedule_file)
+
+      Sidekiq::Cron::Job.load_from_hash!(schedule, source: "schedule")
     end
   end
 end
 ```
 
-Or you can use for loading jobs from yml file [sidekiq-cron-tasks](https://github.com/coverhound/sidekiq-cron-tasks) which will add rake task `bundle exec rake sidekiq_cron:load` to your rails application.
-
 ### Finding jobs
 
 ```ruby
@@ -299,12 +320,22 @@ job.status
 job.enque!
 ```
 
+### Schedule vs Dynamic jobs
+
+There are two potential job sources: `schedule` and `dynamic`.
+Jobs associated with schedule files are labeled as `schedule` as their source,
+whereas jobs created at runtime without the `source=schedule` argument are classified as `dynamic`.
+
+The key distinction lies in how these jobs are managed.
+When a schedule is loaded, any stale `schedule` jobs are automatically removed to ensure synchronization within the schedule.
+The `dynamic` jobs remain unaffected by this process.
+
 ### How to start scheduling?
 
 Just start Sidekiq workers by running:
 
 ```
-$ sidekiq
+$ bundle exec sidekiq
 ```
 
 ### Web UI for Cron Jobs
@@ -314,32 +345,7 @@ add `require 'sidekiq/cron/web'` after `require 'sidekiq/web'`.
 
 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.
+![Web UI](docs/images/web-cron-ui.jpeg)
 
 ## Under the hood
 
@@ -350,14 +356,16 @@ 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::Options[:cron_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.
 
+When running with many Sidekiq processes, the polling can add significant load to Redis. You can disable polling on some processes by setting `Sidekiq::Options[:cron_poll_interval] = 0` on these processes.
+
 ## Contributing
 
-**Thanks to all [contributors](https://github.com/ondrejbartas/sidekiq-cron/graphs/contributors), you’re awesome and this wouldn’t be possible without you!**
+**Thanks to all [contributors](https://github.com/sidekiq-cron/sidekiq-cron/graphs/contributors), you’re awesome and this wouldn’t be possible without you!**
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.