sidekiq-cron 1.12.0 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaa6af217265c4e60b29018b984b43a4316b2618e52ce874db670e41ecadf85b
-  data.tar.gz: f70a50a90508ceb32bad90b8b2b6a880fb460f308dfa81f7380152742bb939cf
+  metadata.gz: dce1f7b341e293e80c0b8981c03b24293c2922f4133f62882bcbee62fa3b12d6
+  data.tar.gz: 210bcfa247b4801bdb86a0d1f5c0454721172abebf0c2e5354be24caee1d6628
 SHA512:
-  metadata.gz: ef95b33d15c1867a3dc6cc096080af6f2fab50c4460d8be24948bcd887c6c278dc3ca1a8c92db8d1ce386d24e0ceb95f53f6add336c3315fec04f808b7451475
-  data.tar.gz: e30e02e3bcc13f8604426d5d9e5f30e24c46a85bfd7679544975a3bdfcc0510631d363ef041f948c8a51e289a02a222fd27bba572cf57ac1697aabb917673a01
+  metadata.gz: cd604c51a98b3b2d1a0af7fdf59afb599f9e9af717043bbbe2816a519be5824694415b59ebd8ec21fa09069798e71bb2d69ae9a62fbf177864f3adcf3c4fc1d3
+  data.tar.gz: '08ebb6f111498fd8f9b377eed43f17be760caace33185fec69b68e7e5f8ef89d5ee0bd34fe91d714d2c4d5af995e7297909a14e827cf4dce43b7974a859ae50f'

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
+## 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 +72,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 +167,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/README.md

@@ -10,7 +10,7 @@
 
 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)).
 
-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.
 
@@ -51,6 +51,7 @@ 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',
   'args' => '[Array or Hash] of arguments which will be passed to perform method',
@@ -63,6 +64,8 @@ gem "sidekiq-cron"
 }
 ```
 
+**NOTE** The `status` of a job does not get changed in Redis when a job gets reloaded unless the `status` property is explicitly set.
+
 ### Time, cron and Sidekiq-Cron
 
 For testing your cron notation you can use [crontab.guru](https://crontab.guru).
@@ -85,6 +88,38 @@ Since sidekiq-cron `v1.7.0`, you can use the natural-language formats supported
 
 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:
@@ -101,6 +136,60 @@ 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.
 
+### Namespacing
+
+#### Default namespace
+
+When not giving a namespace, the `default` one will be used.
+
+In the case you'd like to change this value, create a new initializer like so:
+
+`config/initializers/sidekiq-cron.rb`:
+
+```ruby
+Sidekiq::Cron.configure do |config|
+  config.default_namespace = 'statics'
+end
+```
+
+#### 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 +206,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:
 
@@ -134,7 +225,7 @@ end
 For Active jobs 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,7 +259,7 @@ unless job.save
 end
 ```
 
-Use ActiveRecord models as arguments
+Use ActiveRecord models as arguments:
 
 ```rb
 class Person < ApplicationRecord
@@ -182,7 +273,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 +323,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 (same notation as `Resque-scheduler`) file:
 
 ```yaml
 # config/schedule.yml
@@ -359,6 +451,16 @@ Sidekiq-Cron is checking jobs to be enqueued every 30s by default, you can chang
 Sidekiq::Options[:cron_poll_interval] = 10
 ```
 
+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
+# config/initializers/sidekiq-cron.rb
+
+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.
@@ -383,6 +485,39 @@ You can execute the test suite by running:
 $ bundle exec rake test
 ```
 
+### Using Docker
+
+[Docker](https://www.docker.com) allows you to run things in containers easing the development process.
+
+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.