sidekiq-cron 1.12.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaa6af217265c4e60b29018b984b43a4316b2618e52ce874db670e41ecadf85b
-  data.tar.gz: f70a50a90508ceb32bad90b8b2b6a880fb460f308dfa81f7380152742bb939cf
+  metadata.gz: 1d5f570d2d2d72cdb4fc1a2458dc6cae7abfa5a0da1f27915310b5d5dc835e89
+  data.tar.gz: 514d74f88c65af3db1956190ca9092d4f1a95d6bce4b0a9191463e2bb0f9181a
 SHA512:
-  metadata.gz: ef95b33d15c1867a3dc6cc096080af6f2fab50c4460d8be24948bcd887c6c278dc3ca1a8c92db8d1ce386d24e0ceb95f53f6add336c3315fec04f808b7451475
-  data.tar.gz: e30e02e3bcc13f8604426d5d9e5f30e24c46a85bfd7679544975a3bdfcc0510631d363ef041f948c8a51e289a02a222fd27bba572cf57ac1697aabb917673a01
+  metadata.gz: 61f4af041526789dcf51264baa88a5e1855fa124a0fe9f2c5ed04eec36bd4b617aae1152890ab281d5938914725ba9cce812f70bc258a6e4b8d82b642882212a
+  data.tar.gz: 9e82488bd6459b3ce373e52c94fc3607631b5fc67fa58e578d190368a09f4edc3b4502318646d5285e9fb9d139a080d90d560b28ad31a56e9d01d81d1dc0a2f8

data/CHANGELOG.md

@@ -2,6 +2,48 @@
 
 All notable changes to this project will be documented in this file.
 
+## 2.1.0
+
+- Add `available_namespaces` configuration option (https://github.com/sidekiq-cron/sidekiq-cron/pull/524)
+- I18n fixes and enhancements (https://github.com/sidekiq-cron/sidekiq-cron/pull/520, https://github.com/sidekiq-cron/sidekiq-cron/pull/522)
+
+## 2.0.1
+
+- Fix usage of ActiveJob::Base.queue_name (https://github.com/sidekiq-cron/sidekiq-cron/pull/517)
+- Fix: Add quotes to Japanese translations containing multi-byte symbols (https://github.com/sidekiq-cron/sidekiq-cron/pull/515)
+
+## 2.0.0
+
+Sidekiq-Cron v2 is here! In this release we refactored some internals, plus:
+
+- Review web UI translations for all available locales (https://github.com/sidekiq-cron/sidekiq-cron/pull/506)
+- Fix detection of ActiveJob in Sidekiq v7.3.3+ (https://github.com/sidekiq-cron/sidekiq-cron/pull/510)
+- Add retry job configuration option to set Sidekiq retry job option (https://github.com/sidekiq-cron/sidekiq-cron/pull/509)
+
+Please take a look to the RC1 and RC2 changes too if you are coming from the v1.X series.
+
+## 2.0.0.rc2
+
+- Remove support for Sidekiq < 6.5 (https://github.com/sidekiq-cron/sidekiq-cron/pull/480)
+- Require at least Fugit >= 1.11.1 (https://github.com/sidekiq-cron/sidekiq-cron/pull/475)
+- Update how Redis values are stored on save (https://github.com/sidekiq-cron/sidekiq-cron/pull/479)
+- Web extension: Add compatibility with Sidekiq 7.3+ and remove inline styles (https://github.com/sidekiq-cron/sidekiq-cron/pull/480)
+- Remove support for old Redis (< 4.2) (https://github.com/sidekiq-cron/sidekiq-cron/pull/490)
+- Ensure date_as_argument option can be set from true to false in Sidekiq Cron jobs (https://github.com/sidekiq-cron/sidekiq-cron/pull/485)
+- Rename `enque!` to `enqueue!` (https://github.com/sidekiq-cron/sidekiq-cron/pull/494)
+- Refactor gem configuration module (https://github.com/sidekiq-cron/sidekiq-cron/pull/495)
+
+## 2.0.0.rc1
+
+- Introduce `Namespacing` (https://github.com/sidekiq-cron/sidekiq-cron/pull/268)
+- Human readable cron format in UI (https://github.com/sidekiq-cron/sidekiq-cron/pull/445)
+- Add Bahasa Indonesia locale (https://github.com/sidekiq-cron/sidekiq-cron/pull/446)
+- Fetch queue name from ActiveJob class (https://github.com/sidekiq-cron/sidekiq-cron/pull/448)
+- Allows symbol keys in `.load_from_array!` (https://github.com/sidekiq-cron/sidekiq-cron/pull/458)
+- Add natural language parsing mode (https://github.com/sidekiq-cron/sidekiq-cron/pull/459)
+- Add ability to configure the past scheduled time threshold (https://github.com/sidekiq-cron/sidekiq-cron/pull/465)
+- Docs: clarify worker vs process terminology (https://github.com/sidekiq-cron/sidekiq-cron/issues/453)
+
 ## 1.12.0
 
 - Remove Sidekiq.server? check from schedule loader (https://github.com/sidekiq-cron/sidekiq-cron/pull/436)
@@ -61,7 +103,7 @@ All notable changes to this project will be documented in this file.
 
 ## 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)
+- 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
 
@@ -156,6 +198,6 @@ All notable changes to this project will be documented in this file.
 
 ## 0.3.0
 
-- Suport for Active Job
+- Support 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

@@ -4,3 +4,6 @@ gemspec
 
 # To test different Sidekiq versions
 gem "sidekiq", ENV.fetch("SIDEKIQ_VERSION", ">= 6")
+
+# To test different Active Job versions
+gem "activejob", ENV.fetch("ACTIVE_JOB_VERSION", "~> 7")

data/README.md

@@ -1,25 +1,21 @@
 ![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/sidekiq-cron/sidekiq-cron/workflows/CI/badge.svg?branch=master)](https://github.com/sidekiq-cron/sidekiq-cron/actions)
+[![CI](https://github.com/sidekiq-cron/sidekiq-cron/actions/workflows/ci.yml/badge.svg)](https://github.com/sidekiq-cron/sidekiq-cron/actions/workflows/ci.yml)
 [![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/)
 
 🎬 [Introduction video about Sidekiq-Cron by Drifting Ruby](https://www.driftingruby.com/episodes/periodic-tasks-with-sidekiq-cron)
 
-Sidekiq-Cron runs a thread alongside Sidekiq workers to schedule jobs at specified times (using cron notation `* * * * *` parsed by [Fugit](https://github.com/floraison/fugit)).
+Sidekiq-Cron runs a thread alongside Sidekiq workers to schedule jobs at specified times (using cron notation `* * * * *` or natural language, powered by [Fugit](https://github.com/floraison/fugit)).
 
-Checks for new jobs to schedule every 30 seconds and doesn't schedule the same job multiple times when more than one Sidekiq worker is running.
+Checks for new jobs to schedule every 30 seconds and doesn't schedule the same job multiple times when more than one Sidekiq process is running.
 
 Scheduling jobs are added only when at least one Sidekiq process is running, but it is safe to use Sidekiq-Cron in environments where multiple Sidekiq processes or nodes are running.
 
 If you want to know how scheduling work, check out [under the hood](#under-the-hood).
 
-Works with ActiveJob (Rails 4.2+).
-
-You don't need Sidekiq PRO, you can use this gem with plain Sidekiq.
-
 ## Changelog
 
 Before upgrading to a new version, please read our [Changelog](CHANGELOG.md).
@@ -51,18 +47,40 @@ gem "sidekiq-cron"
   'cron' => '1 * * * *',  # execute at 1 minute of every hour, ex: 12:01, 13:01, 14:01, ...
   'class' => 'MyClass',
   # OPTIONAL
+  'namespace' => 'YourNamespace', # groups jobs together in a namespace (Default value is 'default'),
   'source' => 'dynamic', # source of the job, `schedule`/`dynamic` (default: `dynamic`)
   'queue' => 'name of queue',
+  'retry' => '5', # Sidekiq (not supported by ActiveJob) number of retries, or false to discard on first failure
   '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 (default: '_')
+  'active_job' => true,  # enqueue job through Active Job interface
+  'queue_name_prefix' => 'prefix', # Active Job queue with prefix
+  'queue_name_delimiter' => '.', # Active Job queue with custom delimiter (default: '_')
   'description' => 'A sentence describing what work this job performs'
   'status' => 'disabled' # default: enabled
 }
 ```
 
+**NOTE** The `status` of a job does not get changed in Redis when a job gets reloaded unless the `status` property is explicitly set.
+
+### Configuration
+
+All configuration options:
+
+```ruby
+Sidekiq::Cron.configure do |config|
+  config.cron_poll_interval = 10 # Default is 30
+  config.cron_schedule_file = 'config/my_schedule.yml' # Default is 'config/schedule.yml'
+  config.cron_history_size = 20 # Default is 10
+  config.default_namespace = 'statistics' # Default is 'default'
+  config.natural_cron_parsing_mode = :strict # Default is :single
+  config.reschedule_grace_period = 300 # Default is 60
+  config.available_namespaces = %w[maintenance billing] # Default is `nil`
+end
+```
+
+If you are using Rails, you should add the above block inside an initializer (`config/initializers/sidekiq-cron.rb`).
+
 ### Time, cron and Sidekiq-Cron
 
 For testing your cron notation you can use [crontab.guru](https://crontab.guru).
@@ -76,18 +94,50 @@ 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:
+Since Sidekiq-Cron `v1.7.0`, you can use the natural-language formats supported by Fugit, such as:
 
-```rb
+```ruby
 "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.
 
+There are multiple modes that determine how natural-language cron strings will be parsed.
+
+1. `:single` (default)
+
+```ruby
+Sidekiq::Cron.configure do |config|
+  # Note: This doesn't need to be specified since it's the default.
+  config.natural_cron_parsing_mode = :single
+end
+```
+
+This parses the first possible cron line from the given string and then ignores any additional cron lines.
+
+Ex. `every day at 3:15 and 4:30`
+
+- Equivalent to `15 3 * * *`.
+- `30 4 * * *` gets ignored.
+
+2. `:strict`
+
+```ruby
+Sidekiq::Cron.configure do |config|
+  config.natural_cron_parsing_mode = :strict
+end
+```
+
+This throws an error if the given string would be parsed into multiple cron lines.
+
+Ex. `every day at 3:15 and 4:30`
+
+- Would throw an error and the associated cron job would be invalid
+
 #### 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:
+In addition to the standard 5-parameter cronline format, Sidekiq-Cron supports scheduling jobs with second-precision using a modified 6-parameter cronline format:
 
 `Seconds Minutes Hours Days Months DayOfWeek`
 
@@ -96,11 +146,83 @@ 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[:cron_poll_interval] = 10
+Sidekiq::Cron.configure do |config|
+  config.cron_poll_interval = 10
+end
 ```
 
 The default value at time of writing is 30 seconds. See [under the hood](#under-the-hood) for more details.
 
+### Namespacing
+
+#### Default namespace
+
+When not giving a namespace, the `default` one will be used.
+
+In the case you'd like to change this value, you can change it via the following configuration flag:
+
+```ruby
+Sidekiq::Cron.configure do |config|
+  config.default_namespace = 'statics'
+end
+```
+
+#### Renaming namespace
+
+If you rename the namespace of a job that is already running, the gem will not automatically delete the cron job associated with the old namespace. This means you could end up with two cron jobs running simultaneously.
+
+To avoid this, it is recommended to delete all existing cron jobs associated with the old namespace before making the change. You can achieve this with the following code:
+
+```ruby
+Sidekiq::Cron::Job.all('YOUR_OLD_NAMESPACE_NAME').each { |job| job.destroy }
+```
+
+#### Available namespaces
+
+By default, Sidekiq Cron retrieves all existing jobs from Redis to determine the namespaces your application uses. However, this approach may not be suitable for large Redis installations. To address this, you can explicitly specify the list of available namespaces using the `available_namespaces` configuration option.
+
+If `available_namespaces` is set and a job is created with an unexpected namespace, a warning will be printed, and the job will be assigned to the default namespace.
+
+For more details and discussion, see [this issue](https://github.com/sidekiq-cron/sidekiq-cron/issues/516).
+
+#### Usage
+
+When creating a new job, you can optionally give a `namespace` attribute, and then you can pass it too in the `find` or `destroy` methods.
+
+```ruby
+Sidekiq::Cron::Job.create(
+  name: 'Hard worker - every 5min',
+  namespace: 'Foo',
+  cron: '*/5 * * * *',
+  class: 'HardWorker'
+)
+# INFO: Cron Jobs - add job with name Hard worker - every 5min in the namespace Foo
+
+# Without specifying the namespace, Sidekiq::Cron use the `default` one, therefore `count` return 0.
+Sidekiq::Cron::Job.count
+#=> 0
+
+# Searching in the job's namespace returns 1.
+Sidekiq::Cron::Job.count 'Foo'
+#=> 1
+
+# Same applies to `all`. Without a namespace, no jobs found.
+Sidekiq::Cron::Job.all
+
+# But giving the job's namespace returns it.
+Sidekiq::Cron::Job.all 'Foo'
+#=> [#<Sidekiq::Cron::Job:0x00007f7848a326a0 ... @name="Hard worker - every 5min", @namespace="Foo", @cron="*/5 * * * *", @klass="HardWorker", @status="enabled" ... >]
+
+# If you'd like to get all the jobs across all the namespaces then pass an asterisk:
+Sidekiq::Cron::Job.all '*'
+#=> [#<Sidekiq::Cron::Job ...>]
+
+job = Sidekiq::Cron::Job.find('Hard worker - every 5min', 'Foo').first
+job.destroy
+# INFO: Cron Jobs - deleted job with name Hard worker - every 5min from namespace Foo
+#=> true
+```
+
 ### What objects/classes can be scheduled
 
 #### Sidekiq Worker
@@ -117,7 +239,9 @@ class HardWorker
 end
 ```
 
-#### Active Job Worker
+For Sidekiq workers, `symbolize_args: true` in `Sidekiq::Cron::Job.create` or in Hash configuration is gonna be ignored as Sidekiq currently only allows for [simple JSON datatypes](https://github.com/sidekiq/sidekiq/wiki/The-Basics#:~:text=These%20two%20methods,not%20serialize%20properly.).
+
+#### Active Job
 
 You can schedule `ExampleJob` which looks like:
 
@@ -131,10 +255,10 @@ class ExampleJob < ActiveJob::Base
 end
 ```
 
-For Active jobs you can use `symbolize_args: true` in `Sidekiq::Cron::Job.create` or in Hash configuration,
+For Active Job you can use `symbolize_args: true` in `Sidekiq::Cron::Job.create` or in Hash configuration,
 which will ensure that arguments you are passing to it will be symbolized when passed back to `perform` method in worker.
 
-#### Adding Cron job
+### Adding Cron jobs
 
 Refer to [Schedule vs Dynamic jobs](#schedule-vs-dynamic-jobs) to understand the difference.
 
@@ -168,9 +292,9 @@ unless job.save
 end
 ```
 
-Use ActiveRecord models as arguments
+Use ActiveRecord models as arguments:
 
-```rb
+```ruby
 class Person < ApplicationRecord
 end
 
@@ -182,7 +306,6 @@ class HardWorker < ActiveJob::Base
   end
 end
 
-
 person = Person.create(id: 1)
 Sidekiq::Cron::Job.create(name: 'Hard worker - every 5min', cron: '*/5 * * * *', class: 'HardWorker', args: person)
 # => true
@@ -233,7 +356,9 @@ Sidekiq::Cron::Job.load_from_hash! hash
 Sidekiq::Cron::Job.load_from_array! array
 ```
 
-Or from YAML (same notation as Resque-scheduler):
+### Loading jobs from schedule file
+
+You can also load multiple jobs from a YAML file:
 
 ```yaml
 # config/schedule.yml
@@ -254,24 +379,31 @@ second_job:
 There are multiple ways to load the jobs from a YAML file
 
 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"`
+2. When you want to load jobs from a different filename, mention the filename in Sidekiq configuration as follows:
+
+    ```ruby
+    Sidekiq::Cron.configure do |config|
+      config.cron_schedule_file = "config/users_schedule.yml"
+    end
+    ```
+
 3. Load the file manually as follows:
 
-```ruby
-# config/initializers/sidekiq.rb
+    ```ruby
+    # config/initializers/sidekiq.rb
 
-Sidekiq.configure_server do |config|
-  config.on(:startup) do
-    schedule_file = "config/users_schedule.yml"
+    Sidekiq.configure_server do |config|
+      config.on(:startup) do
+        schedule_file = "config/users_schedule.yml"
 
-    if File.exist?(schedule_file)
-      schedule = YAML.load_file(schedule_file)
+        if File.exist?(schedule_file)
+          schedule = YAML.load_file(schedule_file)
 
-      Sidekiq::Cron::Job.load_from_hash!(schedule, source: "schedule")
+          Sidekiq::Cron::Job.load_from_hash!(schedule, source: "schedule")
+        end
+      end
     end
-  end
-end
-```
+    ```
 
 ### Finding jobs
 
@@ -317,7 +449,7 @@ job.status
 # => enabled/disabled
 
 # enqueue job right now!
-job.enque!
+job.enqueue!
 ```
 
 ### Schedule vs Dynamic jobs
@@ -356,12 +488,28 @@ 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[:cron_poll_interval] = 10
+Sidekiq::Cron.configure do |config|
+  config.cron_poll_interval = 10
+end
+```
+
+When Sidekiq (and Sidekiq-Cron) is not used in zero-downtime deployments, after the deployment is done Sidekiq-Cron starts to catch up. It will consider older jobs that missed their schedules during that time. By default, only jobs that should have started less than 1 minute ago are considered. This is problematic for some jobs, e.g., jobs that run once a day. If on average Sidekiq is shut down for 10 minutes during deployments, you can configure Sidekiq-Cron to consider jobs that were about to be scheduled during that time:
+
+```ruby
+Sidekiq::Cron.configure do |config|
+  config.reschedule_grace_period = 600 # 10 minutes in seconds
+end
 ```
 
 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.
+When running with many Sidekiq processes, the polling can add significant load to Redis. You can disable polling on some processes by setting:
+
+```ruby
+Sidekiq::Cron.configure do |config|
+  config.cron_poll_interval = 0
+end
+```
 
 ## Contributing
 
@@ -383,6 +531,39 @@ You can execute the test suite by running:
 $ bundle exec rake test
 ```
 
+### Using Docker
+
+This project uses [Docker Compose](https://docs.docker.com/compose/) in order to orchestrate containers and get the test suite running on you local machine, and here you find the commands to run in order to get a complete environment to build and test this gem:
+
+1. Build the Docker image (only the first time):
+```
+docker compose -f docker/docker-compose.yml build
+```
+
+2. Run the test suite:
+```
+docker compose -f docker/docker-compose.yml run --rm tests
+```
+
+_This command will download the first time the project's dependencies (Redis so far), create the containers and run the default command to run the tests._
+
+**Running other commands**
+
+In the case you need to run a command in the gem's container, you would do it like so:
+
+```
+docker compose -f docker/docker-compose.yml run --rm tests <HERE IS YOUR COMMAND>
+```
+_Note that `tests` is the Docker Compose service name defined in the `docker/docker-compose.yml` file._
+
+**Running a single test file**
+
+Given you only want to run the tests from the `test/unit/web_extension_test.rb` file, you need to pass its path with the `TEST` env variable, so here is the command:
+
+```
+docker compose -f docker/docker-compose.yml run --rm --env TEST=test/unit/web_extension_test.rb tests
+```
+
 ## License
 
 Copyright (c) 2013 Ondrej Bartas. See [LICENSE](LICENSE.txt) for further details.