sidekiq-cron 1.10.1 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1413d9d3418c71f816ea65bb6656c3053535d181ce22fbbc82daa3dca223f524
-  data.tar.gz: aecf5bb82af028c08f458a93aa8d96d6cc7c58ffe5b7a0380c33ecd5f02e42ae
+  metadata.gz: aaa6af217265c4e60b29018b984b43a4316b2618e52ce874db670e41ecadf85b
+  data.tar.gz: f70a50a90508ceb32bad90b8b2b6a880fb460f308dfa81f7380152742bb939cf
 SHA512:
-  metadata.gz: b135afb05139d833320da0efd60f76d1a55771f2bf3adfcf5fdcbe6f9e5bdd9c23ca3339bc354ee7ee9a5fe77da93eb73e2043ef1b37c7d78e7df1da9365a482
-  data.tar.gz: a1cfe3438ebd8eaec2bce2eac18f7f42983bdc5ed93e8dbf5810cf6eb01942847582a2b50526dcb36854ab6385555f41983aaad9bd85a89699c745d4c5196bd6
+  metadata.gz: ef95b33d15c1867a3dc6cc096080af6f2fab50c4460d8be24948bcd887c6c278dc3ca1a8c92db8d1ce386d24e0ceb95f53f6add336c3315fec04f808b7451475
+  data.tar.gz: e30e02e3bcc13f8604426d5d9e5f30e24c46a85bfd7679544975a3bdfcc0510631d363ef041f948c8a51e289a02a222fd27bba572cf57ac1697aabb917673a01

data/CHANGELOG.md

@@ -2,9 +2,21 @@
 
 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)
+- Use `hset` instead of deprecated `hmset` (https://github.com/sidekiq-cron/sidekiq-cron/pull/410)
 
 ## 1.10.0
 
@@ -59,7 +71,7 @@ All notable changes to this project will be documented in this file.
 ## 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/317/282)
+- 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)

data/README.md

@@ -42,7 +42,7 @@ gem "sidekiq-cron"
 
 ## Getting Started
 
- ### Job properties
+### Job properties
 
 ```ruby
 {
@@ -51,12 +51,13 @@ gem "sidekiq-cron"
   '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
+  '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
 }
@@ -135,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
@@ -223,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
@@ -262,7 +265,9 @@ Sidekiq.configure_server do |config|
     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
@@ -315,6 +320,16 @@ 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:

data/lib/sidekiq/cron/job.rb

@@ -21,11 +21,12 @@ module Sidekiq
 
       # Crucial part of whole enqueuing job.
       def should_enque? time
+        return false unless status == "enabled"
+        return false unless not_past_scheduled_time?(time)
+        return false unless not_enqueued_after?(time)
+
         enqueue = Sidekiq.redis do |conn|
-          status == "enabled" &&
-            not_past_scheduled_time?(time) &&
-            not_enqueued_after?(time) &&
-            conn.zadd(job_enqueued_key, formatted_enqueue_time(time), formatted_last_time(time))
+          conn.zadd(job_enqueued_key, formatted_enqueue_time(time), formatted_last_time(time))
         end
         enqueue == true || enqueue == 1
       end
@@ -162,19 +163,19 @@ module Sidekiq
       #   }
       # }
       #
-      def self.load_from_hash hash
+      def self.load_from_hash(hash, options = {})
         array = hash.map do |key, job|
           job['name'] = key
           job
         end
-        load_from_array array
+        load_from_array(array, options)
       end
 
       # Like #load_from_hash.
       # If exists old jobs in Redis but removed from args, destroy old jobs.
-      def self.load_from_hash! hash
+      def self.load_from_hash!(hash, options = {})
         destroy_removed_jobs(hash.keys)
-        load_from_hash(hash)
+        load_from_hash(hash, options)
       end
 
       # Load cron jobs from Array.
@@ -194,10 +195,10 @@ module Sidekiq
       #   }
       # ]
       #
-      def self.load_from_array array
+      def self.load_from_array(array, options = {})
         errors = {}
         array.each do |job_data|
-          job = new(job_data)
+          job = new(job_data.merge(options))
           errors[job.name] = job.errors unless job.save
         end
         errors
@@ -205,10 +206,10 @@ module Sidekiq
 
       # Like #load_from_array.
       # If exists old jobs in Redis but removed from args, destroy old jobs.
-      def self.load_from_array! array
+      def self.load_from_array!(array, options = {})
         job_names = array.map { |job| job["name"] }
         destroy_removed_jobs(job_names)
-        load_from_array(array)
+        load_from_array(array, options)
       end
 
       # Get all cron jobs.
@@ -239,12 +240,11 @@ module Sidekiq
       def self.find name
         # If name is hash try to get name from it.
         name = name[:name] || name['name'] if name.is_a?(Hash)
+        return unless exists? name
 
         output = nil
         Sidekiq.redis do |conn|
-          if exists? name
-            output = Job.new conn.hgetall( redis_key(name) )
-          end
+          output = Job.new conn.hgetall( redis_key(name) )
         end
         output if output && output.valid?
       end
@@ -267,7 +267,7 @@ module Sidekiq
       end
 
       attr_accessor :name, :cron, :description, :klass, :args, :message
-      attr_reader   :last_enqueue_time, :fetch_missing_args
+      attr_reader   :last_enqueue_time, :fetch_missing_args, :source
 
       def initialize input_args = {}
         args = Hash[input_args.map{ |k, v| [k.to_s, v] }]
@@ -277,6 +277,7 @@ module Sidekiq
         @name = args["name"]
         @cron = args["cron"]
         @description = args["description"] if args["description"]
+        @source = args["source"] == "schedule" ? "schedule" : "dynamic"
 
         # Get class from klass or class.
         @klass = args["klass"] || args["class"]
@@ -293,7 +294,7 @@ module Sidekiq
 
         # Get right arguments for job.
         @symbolize_args = args["symbolize_args"] == true || ("#{args["symbolize_args"]}" =~ (/^(true|t|yes|y|1)$/i)) == 0 || false
-        @args = args["args"].nil? ? [] : parse_args( args["args"] )
+        @args = parse_args(args["args"])
 
         @date_as_argument = args["date_as_argument"] == true || ("#{args["date_as_argument"]}" =~ (/^(true|t|yes|y|1)$/i)) == 0 || false
 
@@ -408,6 +409,7 @@ module Sidekiq
           klass: @klass.to_s,
           cron: @cron,
           description: @description,
+          source: @source,
           args: @args.is_a?(String) ? @args : Sidekiq.dump_json(@args || []),
           message: @message.is_a?(String) ? @message : Sidekiq.dump_json(@message || {}),
           status: @status,
@@ -529,7 +531,7 @@ module Sidekiq
 
       # Remove "removed jobs" between current jobs and new jobs
       def self.destroy_removed_jobs new_job_names
-        current_job_names = Sidekiq::Cron::Job.all.map(&:name)
+        current_job_names = Sidekiq::Cron::Job.all.filter_map { |j| j.name if j.source == "schedule" }
         removed_job_names = current_job_names - new_job_names
         removed_job_names.each { |j| Sidekiq::Cron::Job.destroy(j) }
         removed_job_names
@@ -564,6 +566,10 @@ module Sidekiq
         "#{status == "enabled" ? 0 : 1}_#{name}".downcase
       end
 
+      def args=(args)
+        @args = parse_args(args)
+      end
+
       private
 
       def parsed_cron

data/lib/sidekiq/cron/schedule_loader.rb

@@ -2,20 +2,18 @@ require 'sidekiq'
 require 'sidekiq/cron/job'
 require 'sidekiq/options'
 
-if Sidekiq.server?
-  Sidekiq.configure_server do |config|
-    schedule_file = Sidekiq::Options[:cron_schedule_file] || 'config/schedule.yml'
+Sidekiq.configure_server do |config|
+  schedule_file = Sidekiq::Options[:cron_schedule_file] || 'config/schedule.yml'
 
-    if File.exist?(schedule_file)
-      config.on(:startup) do
-        schedule = Sidekiq::Cron::Support.load_yaml(ERB.new(IO.read(schedule_file)).result)
-        if schedule.kind_of?(Hash)
-          Sidekiq::Cron::Job.load_from_hash! schedule
-        elsif schedule.kind_of?(Array)
-          Sidekiq::Cron::Job.load_from_array! schedule
-        else
-          raise "Not supported schedule format. Confirm your #{schedule_file}"
-        end
+  if File.exist?(schedule_file)
+    config.on(:startup) do
+      schedule = Sidekiq::Cron::Support.load_yaml(ERB.new(IO.read(schedule_file)).result)
+      if schedule.kind_of?(Hash)
+        Sidekiq::Cron::Job.load_from_hash!(schedule, source: "schedule")
+      elsif schedule.kind_of?(Array)
+        Sidekiq::Cron::Job.load_from_array!(schedule, source: "schedule")
+      else
+        raise "Not supported schedule format. Confirm your #{schedule_file}"
       end
     end
   end

data/lib/sidekiq/cron/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Cron
-    VERSION = "1.10.1"
+    VERSION = "1.12.0"
   end
 end

data/lib/sidekiq/options.rb

@@ -3,11 +3,15 @@ require 'sidekiq'
 module Sidekiq
   module Options
     def self.[](key)
-      options_field ? Sidekiq.public_send(options_field)[key] : Sidekiq[key]
+      self.config[key]
     end
 
     def self.[]=(key, value)
-      options_field ? Sidekiq.public_send(options_field)[key] = value : Sidekiq[key] = value
+      self.config[key] = value
+    end
+
+    def self.config
+      options_field ? Sidekiq.public_send(options_field) : Sidekiq
     end
 
     def self.options_field

data/sidekiq-cron.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
     "LICENSE.txt",
     "README.md"
   ]
-  s.files = Dir.glob('lib/**/*') + Dir.glob('test/**/*') + [
+  s.files = Dir.glob('lib/**/*') + [
     "CHANGELOG.md",
     "Gemfile",
     "LICENSE.txt",
@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.add_dependency("globalid", ">= 1.0.1")
 
   s.add_development_dependency("minitest", "~> 5.15")
-  s.add_development_dependency("mocha", "~> 1.14")
+  s.add_development_dependency("mocha", "~> 2.1")
   s.add_development_dependency("rack", "~> 2.2")
   s.add_development_dependency("rack-test", "~> 1.1")
   s.add_development_dependency("rake", "~> 13.0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cron
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.12.0
 platform: ruby
 authors:
 - Ondrej Bartas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fugit
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -185,18 +185,6 @@ files:
 - lib/sidekiq/cron/web_extension.rb
 - lib/sidekiq/options.rb
 - sidekiq-cron.gemspec
-- test/integration/performance_test.rb
-- test/models/person.rb
-- test/test_helper.rb
-- test/unit/fixtures/schedule_array.yml
-- test/unit/fixtures/schedule_erb.yml
-- test/unit/fixtures/schedule_hash.yml
-- test/unit/fixtures/schedule_string.yml
-- test/unit/job_test.rb
-- test/unit/launcher_test.rb
-- test/unit/poller_test.rb
-- test/unit/schedule_loader_test.rb
-- test/unit/web_extension_test.rb
 homepage: https://github.com/sidekiq-cron/sidekiq-cron
 licenses:
 - MIT
@@ -216,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Scheduler/Cron for Sidekiq jobs

data/test/integration/performance_test.rb

@@ -1,46 +0,0 @@
-require './test/test_helper'
-require 'benchmark'
-
-describe 'Performance Poller' do
-  JOBS_NUMBER = 10_000
-  MAX_SECONDS = 60
-
-  before do
-    # Clear all previous saved data from Redis.
-    Sidekiq.redis do |conn|
-      conn.flushdb
-    end
-
-    args = {
-      queue: "default",
-      cron: "*/2 * * * *",
-      klass: "CronTestClass"
-    }
-
-    JOBS_NUMBER.times do |i|
-      Sidekiq::Cron::Job.create(args.merge(name: "Test#{i}"))
-    end
-
-    @poller = Sidekiq::Cron::Poller.new(Sidekiq.const_defined?(:Config) ? Sidekiq::Config.new : {})
-    now = Time.now.utc + 3600
-    enqueued_time = Time.new(now.year, now.month, now.day, now.hour, 10, 5)
-    Time.stubs(:now).returns(enqueued_time)
-  end
-
-  it "should enqueue #{JOBS_NUMBER} jobs in less than #{MAX_SECONDS}s" do
-    Sidekiq.redis do |conn|
-      assert_equal 0, conn.llen("queue:default"), 'Queue should be empty'
-    end
-
-    bench = Benchmark.measure {
-      @poller.enqueue
-    }
-
-    Sidekiq.redis do |conn|
-      assert_equal JOBS_NUMBER, conn.llen("queue:default"), 'Queue should be full'
-    end
-
-    puts "Performance test finished in #{bench.real}"
-    assert_operator bench.real, :<, MAX_SECONDS
-  end
-end

data/test/models/person.rb

@@ -1,21 +0,0 @@
-class Person
-  include GlobalID::Identification
-
-  attr_reader :id
-
-  def self.find(id)
-    new(id)
-  end
-
-  def initialize(id)
-    @id = id
-  end
-
-  def to_global_id(options = {})
-    super app: "app"
-  end
-
-  def ==(other_person)
-    other_person.is_a?(Person) && id.to_s == other_person.id.to_s
-  end
-end

data/test/test_helper.rb

@@ -1,93 +0,0 @@
-$TESTING = true
-ENV['RACK_ENV'] = 'test'
-
-require 'simplecov'
-
-if ENV['CI']
-  require 'simplecov-cobertura'
-  SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
-end
-
-SimpleCov.start do
-  add_filter "test/"
-  add_group 'Sidekiq-Cron', 'lib/'
-end
-
-require "minitest/autorun"
-require "rack/test"
-require 'mocha/minitest'
-require 'sidekiq'
-require 'sidekiq/web'
-require "sidekiq/cli"
-require 'sidekiq-cron'
-require 'sidekiq/cron/web'
-
-Sidekiq.logger.level = Logger::ERROR
-Sidekiq.configure_client do |config|
-  config.redis = { url: ENV['REDIS_URL'] || 'redis://0.0.0.0:6379' }
-end
-
-# For testing symbolize args
-class Hash
-  def symbolize_keys
-    transform_keys { |key| key.to_sym rescue key }
-  end
-end
-
-class CronTestClass
-  include Sidekiq::Worker
-  sidekiq_options retry: true
-
-  def perform args = {}
-    puts "super croned job #{args}"
-  end
-end
-
-class CronTestClassWithQueue
-  include Sidekiq::Worker
-  sidekiq_options queue: :super, retry: false, backtrace: true
-
-  def perform args = {}
-    puts "super croned job #{args}"
-  end
-end
-
-module ActiveJob
-  class Base
-    attr_accessor *%i[job_class provider_job_id queue_name arguments]
-
-    def initialize
-      yield self if block_given?
-      self.provider_job_id ||= SecureRandom.hex(12)
-    end
-
-    def self.queue_name_prefix
-      @queue_name_prefix
-    end
-
-    def self.queue_name_prefix=(queue_name_prefix)
-      @queue_name_prefix = queue_name_prefix
-    end
-
-    def self.set(options)
-      @queue = options['queue']
-
-      self
-    end
-
-    def try(method, *args, &block)
-      send method, *args, &block if respond_to? method
-    end
-
-    def self.perform_later(*args)
-      new do |instance|
-        instance.job_class = self.class.name
-        instance.queue_name = @queue
-        instance.arguments = [*args]
-      end
-    end
-  end
-end
-
-class ActiveJobCronTestClass < ActiveJob::Base
-end

data/test/unit/fixtures/schedule_array.yml

@@ -1,13 +0,0 @@
----
--
-  name: "my_first_job"
-  cron: "*/5 * * * *"
-  class: "HardWorker"
-  queue: "hard_worker"
--
-  name: "second_job"
-  cron: "*/30 * * * *"
-  class: "HardWorker"
-  queue: "hard_worker_long"
-  args:
-    hard: "stuff"

data/test/unit/fixtures/schedule_erb.yml

@@ -1,6 +0,0 @@
----
-default: &default
-  cron: <%= "every day at 5 pm" %>
-  class: <%= "DailyJob" %>
-
-daily_job: *default

data/test/unit/fixtures/schedule_hash.yml

@@ -1,12 +0,0 @@
----
-my_first_job:
-  cron: "*/5 * * * *"
-  class: "HardWorker"
-  queue: hard_worker
-
-second_job:
-  cron: "*/30 * * * *"
-  class: "HardWorker"
-  queue: hard_worker_long
-  args:
-    hard: "stuff"

data/test/unit/fixtures/schedule_string.yml

@@ -1 +0,0 @@
---- string