sidekiq-cron 1.9.1 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d751ce0280b4d30f1f43a1e0ed973166c2f398d7ac976e6fea267e66e999bb8
-  data.tar.gz: 352b64238d89eb4eedb0e9c046f9d54f6f298c376804de1066cbdad3481c43af
+  metadata.gz: 1413d9d3418c71f816ea65bb6656c3053535d181ce22fbbc82daa3dca223f524
+  data.tar.gz: aecf5bb82af028c08f458a93aa8d96d6cc7c58ffe5b7a0380c33ecd5f02e42ae
 SHA512:
-  metadata.gz: ee7843b8dd62b31954de3db17c4cef76229050d2c4590bde276c77d6ad2c96bbb523620631ad41574d4b976ace4da6425130b1aa5c4a20986c4d42fdcdde1ef4
-  data.tar.gz: 95e74c836bdae7eb10fe1fe540fdc91ecb730c3a73bc1dd7e578d9324cf448e32054e9ad1b487036119076e966b0df1011978aa34b9215a334d996759d4bb684
+  metadata.gz: b135afb05139d833320da0efd60f76d1a55771f2bf3adfcf5fdcbe6f9e5bdd9c23ca3339bc354ee7ee9a5fe77da93eb73e2043ef1b37c7d78e7df1da9365a482
+  data.tar.gz: a1cfe3438ebd8eaec2bce2eac18f7f42983bdc5ed93e8dbf5810cf6eb01942847582a2b50526dcb36854ab6385555f41983aaad9bd85a89699c745d4c5196bd6

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file.
 
+## 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)

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,8 +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/sidekiq-cron/sidekiq-cron/workflows/CI/badge.svg?branch=master)](https://github.com/sidekiq-cron/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)
+[![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/)
 
@@ -26,12 +26,6 @@ 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:
 
 ```
@@ -171,6 +165,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
@@ -316,7 +330,7 @@ add `require 'sidekiq/cron/web'` after `require 'sidekiq/web'`.
 
 With this, you will get:
 
-![Web UI](examples/web-cron-ui.jpeg)
+![Web UI](docs/images/web-cron-ui.jpeg)
 
 ## Under the hood
 

data/lib/sidekiq/cron/job.rb

@@ -1,4 +1,5 @@
 require 'fugit'
+require 'globalid'
 require 'sidekiq'
 require 'sidekiq/cron/support'
 require 'sidekiq/options'
@@ -15,6 +16,9 @@ module Sidekiq
       # Use the exists? method if we're on a newer version of Redis.
       REDIS_EXISTS_METHOD = Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new("7.0.0") || Gem.loaded_specs['redis'].version < Gem::Version.new('4.2') ? :exists : :exists?
 
+      # Use serialize/deserialize key of GlobalID.
+      GLOBALID_KEY = "_sc_globalid"
+
       # Crucial part of whole enqueuing job.
       def should_enque? time
         enqueue = Sidekiq.redis do |conn|
@@ -45,7 +49,7 @@ module Sidekiq
 
       # Enqueue cron job to queue.
       def enque! time = Time.now.utc
-        @last_enqueue_time = time.strftime(LAST_ENQUEUE_TIME_FORMAT)
+        @last_enqueue_time = time
 
         klass_const =
             begin
@@ -85,7 +89,8 @@ module Sidekiq
       end
 
       def enqueue_args
-        date_as_argument? ? @args + [Time.now.to_f] : @args
+        args = date_as_argument? ? @args + [Time.now.to_f] : @args
+        deserialize_argument(args)
       end
 
       def enqueue_active_job(klass_const)
@@ -398,21 +403,26 @@ module Sidekiq
 
       # Export job data to hash.
       def to_hash
-        {
+        hash = {
           name: @name,
           klass: @klass.to_s,
           cron: @cron,
           description: @description,
           args: @args.is_a?(String) ? @args : Sidekiq.dump_json(@args || []),
-          date_as_argument: date_as_argument? ? "1" : "0",
           message: @message.is_a?(String) ? @message : Sidekiq.dump_json(@message || {}),
           status: @status,
           active_job: @active_job ? "1" : "0",
           queue_name_prefix: @active_job_queue_name_prefix,
           queue_name_delimiter: @active_job_queue_name_delimiter,
-          last_enqueue_time: @last_enqueue_time.to_s,
+          last_enqueue_time: serialized_last_enqueue_time,
           symbolize_args: symbolize_args? ? "1" : "0",
         }
+
+        if date_as_argument?
+          hash.merge!(date_as_argument: "1")
+        end
+
+        hash
       end
 
       def errors
@@ -459,7 +469,7 @@ module Sidekiq
           conn.sadd self.class.jobs_key, [redis_key]
 
           # Add informations for this job!
-          conn.hmset redis_key, *hash_to_redis(to_hash)
+          conn.hset redis_key, to_hash.transform_values! { |v| v || "" }
 
           # Add information about last time! - don't enque right after scheduler poller starts!
           time = Time.now.utc
@@ -472,7 +482,7 @@ module Sidekiq
       def save_last_enqueue_time
         Sidekiq.redis do |conn|
           # Update last enqueue time.
-          conn.hset redis_key, 'last_enqueue_time', @last_enqueue_time
+          conn.hset redis_key, 'last_enqueue_time', serialized_last_enqueue_time
         end
       end
 
@@ -569,6 +579,8 @@ module Sidekiq
       # try to load JSON, then failover to string array.
       def parse_args(args)
         case args
+        when GlobalID::Identification
+          [convert_to_global_id_hash(args)]
         when String
           begin
             parsed_args = Sidekiq.load_json(args)
@@ -577,8 +589,10 @@ module Sidekiq
             [*args]
           end
         when Hash
+          args = serialize_argument(args)
           symbolize_args? ? [symbolize_args(args)] : [args]
         when Array
+          args = serialize_argument(args)
           symbolize_args? ? symbolize_args(args) : args
         else
           [*args]
@@ -649,9 +663,55 @@ module Sidekiq
         self.class.jid_history_key @name
       end
 
-      # Give Hash returns array for using it for redis.hmset
-      def hash_to_redis hash
-        hash.flat_map{ |key, value| [key, value || ""] }
+      def serialized_last_enqueue_time
+        @last_enqueue_time&.strftime(LAST_ENQUEUE_TIME_FORMAT)
+      end
+      
+      def convert_to_global_id_hash(argument)
+        { GLOBALID_KEY => argument.to_global_id.to_s }
+      rescue URI::GID::MissingModelIdError
+        raise "Unable to serialize #{argument.class} " \
+          "without an id. (Maybe you forgot to call save?)"
+      end
+
+      def deserialize_argument(argument)
+        case argument
+        when String
+          argument
+        when Array
+          argument.map { |arg| deserialize_argument(arg) }
+        when Hash
+          if serialized_global_id?(argument)
+            deserialize_global_id argument
+          else
+            argument.transform_values { |v| deserialize_argument(v) }
+          end
+        else
+          argument
+        end
+      end
+
+      def serialized_global_id?(hash)
+        hash.size == 1 && hash.include?(GLOBALID_KEY)
+      end
+
+      def deserialize_global_id(hash)
+        GlobalID::Locator.locate hash[GLOBALID_KEY]
+      end
+
+      def serialize_argument(argument)
+        case argument
+        when GlobalID::Identification
+          convert_to_global_id_hash(argument)
+        when Array
+          argument.map { |arg| serialize_argument(arg) }
+        when Hash
+          argument.each_with_object({}) do |(key, value), hash|
+            hash[key] = serialize_argument(value)
+          end
+        else
+          argument
+        end
       end
     end
   end

data/lib/sidekiq/cron/launcher.rb

@@ -14,7 +14,7 @@ module Sidekiq
       attr_reader :cron_poller
 
       # Add cron poller and execute normal initialize of Sidekiq launcher.
-      def initialize(config)
+      def initialize(config, **kwargs)
         config[:cron_poll_interval] = DEFAULT_POLL_INTERVAL if config[:cron_poll_interval].nil?
 
         @cron_poller = Sidekiq::Cron::Poller.new(config) if config[:cron_poll_interval] > 0

data/lib/sidekiq/cron/schedule_loader.rb

@@ -10,9 +10,9 @@ if Sidekiq.server?
       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
+          Sidekiq::Cron::Job.load_from_hash! schedule
         elsif schedule.kind_of?(Array)
-          Sidekiq::Cron::Job.load_from_array schedule
+          Sidekiq::Cron::Job.load_from_array! schedule
         else
           raise "Not supported schedule format. Confirm your #{schedule_file}"
         end

data/lib/sidekiq/cron/version.rb

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

data/sidekiq-cron.gemspec

@@ -24,10 +24,11 @@ Gem::Specification.new do |s|
     "sidekiq-cron.gemspec",
   ]
 
-  s.required_ruby_version = ">= 2.6"
+  s.required_ruby_version = ">= 2.7"
 
   s.add_dependency("fugit", "~> 1.8")
-  s.add_dependency("sidekiq", ">= 4.2.1")
+  s.add_dependency("sidekiq", ">= 6")
+  s.add_dependency("globalid", ">= 1.0.1")
 
   s.add_development_dependency("minitest", "~> 5.15")
   s.add_development_dependency("mocha", "~> 1.14")
@@ -35,4 +36,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rack-test", "~> 1.1")
   s.add_development_dependency("rake", "~> 13.0")
   s.add_development_dependency("simplecov", "~> 0.21")
+  s.add_development_dependency("simplecov-cobertura", "~> 2.1")
 end

data/test/models/person.rb

@@ -0,0 +1,21 @@
+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

@@ -2,6 +2,12 @@ $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/'

data/test/unit/job_test.rb

@@ -1,4 +1,5 @@
 require './test/test_helper'
+require "./test/models/person"
 
 describe "Cron Job" do
   before do
@@ -338,6 +339,45 @@ describe "Cron Job" do
         assert args[-1].between?(Time.now.to_f - 1, Time.now.to_f)
       end
     end
+
+    describe 'with GlobalID::Identification args' do      
+      before do
+        @args.merge!(args: Person.new(1))
+        @job = Sidekiq::Cron::Job.new(@args)
+      end
+
+      let(:args) { @job.sidekiq_worker_message['args'] }
+
+      it 'should add timestamp to args' do
+        assert_equal args[0], Person.new(1)
+      end
+    end
+
+    describe 'with GlobalID::Identification args in Array' do      
+      before do
+        @args.merge!(args: [Person.new(1)])
+        @job = Sidekiq::Cron::Job.new(@args)
+      end
+
+      let(:args) { @job.sidekiq_worker_message['args'] }
+
+      it 'should add timestamp to args' do
+        assert_equal args[0], Person.new(1)
+      end
+    end
+
+    describe 'with GlobalID::Identification args in Hash' do      
+      before do
+        @args.merge!(args: {person: Person.new(1)})
+        @job = Sidekiq::Cron::Job.new(@args)
+      end
+
+      let(:args) { @job.sidekiq_worker_message['args'] }
+
+      it 'should add timestamp to args' do
+        assert_equal args[0], {person: Person.new(1)}
+      end
+    end
   end
 
   describe '#sidekiq_worker_message settings overwrite queue name' do
@@ -777,6 +817,58 @@ describe "Cron Job" do
     end
   end
 
+  # @note sidekiq-cron 1.6.0 cannot process options correctly if any date_as_argument evaluates to true.
+  # This has been tested to resolve issues in environments where multiple sidekiq-cron versions are running when updating from 1.6.0
+  # See https://github.com/sidekiq-cron/sidekiq-cron/issues/350#issuecomment-1409798837 for more information.
+  describe "compat with sidekiq cron 1.6.0" do
+    describe "#to_hash with date_as_argument false" do
+      before do
+        @args = {
+          name: "Test",
+          cron: "* * * * *",
+          klass: "CronTestClass",
+          date_as_argument: false,
+        }
+        @job = Sidekiq::Cron::Job.new(@args)
+      end
+
+      it "should not have date_as_argument property" do
+        assert !@job.to_hash.key?(:date_as_argument)
+      end
+    end
+
+    describe "#to_hash with no date_as_argument option" do
+      before do
+        @args = {
+          name: "Test",
+          cron: "* * * * *",
+          klass: "CronTestClass",
+        }
+        @job = Sidekiq::Cron::Job.new(@args)
+      end
+
+      it "should not have date_as_argument property" do
+        assert !@job.to_hash.key?(:date_as_argument)
+      end
+    end
+
+    describe "#to_hash with date_as_argument" do
+      before do
+        @args = {
+          name: "Test",
+          cron: "* * * * *",
+          klass: "CronTestClass",
+          date_as_argument: true,
+        }
+        @job = Sidekiq::Cron::Job.new(@args)
+      end
+
+      it "should have date_as_argument property with value '1'" do
+        assert_equal @job.to_hash[:date_as_argument], '1'
+      end
+    end
+  end
+
   describe "save" do
     before do
       @args = {
@@ -918,6 +1010,42 @@ describe "Cron Job" do
         assert_equal job.name, "Test"
       end
     end
+
+    it "from GlobalID::Identification" do
+      args = {
+        name: "Test",
+        cron: "* * * * *",
+        klass: "CronTestClass",
+        args: Person.new(1)
+      }
+      Sidekiq::Cron::Job.new(args).tap do |job|
+        assert_equal job.args, [{"_sc_globalid"=>"gid://app/Person/1"}]
+      end
+    end
+
+    it "from GlobalID::Identification in Array" do
+      args = {
+        name: "Test",
+        cron: "* * * * *",
+        klass: "CronTestClass",
+        args: [Person.new(1)]
+      }
+      Sidekiq::Cron::Job.new(args).tap do |job|
+        assert_equal job.args, [{"_sc_globalid"=>"gid://app/Person/1"}]
+      end
+    end
+
+    it "from GlobalID::Identification in Hash" do
+      args = {
+        name: "Test",
+        cron: "* * * * *",
+        klass: "CronTestClass",
+        args: {person: Person.new(1)}
+      }
+      Sidekiq::Cron::Job.new(args).tap do |job|
+        assert_equal job.args, [{person: {"_sc_globalid"=>"gid://app/Person/1"}}]
+      end
+    end
   end
 
   describe "create & find methods" do
@@ -1145,11 +1273,11 @@ describe "Cron Job" do
       end
 
       it "duplicate jobs are not loaded" do
-        out = Sidekiq::Cron::Job.load_from_hash @jobs_hash
+        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
+        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

data/test/unit/schedule_loader_test.rb

@@ -12,7 +12,7 @@ describe 'ScheduleLoader' do
     end
 
     it 'calls Sidekiq::Cron::Job.load_from_hash' do
-      Sidekiq::Cron::Job.expects(:load_from_hash)
+      Sidekiq::Cron::Job.expects(:load_from_hash!)
       Sidekiq::Options[:lifecycle_events][:startup].first.call
     end
   end
@@ -24,7 +24,7 @@ describe 'ScheduleLoader' do
     end
 
     it 'calls Sidekiq::Cron::Job.load_from_array' do
-      Sidekiq::Cron::Job.expects(:load_from_array)
+      Sidekiq::Cron::Job.expects(:load_from_array!)
       Sidekiq::Options[:lifecycle_events][:startup].first.call
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cron
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.1
 platform: ruby
 authors:
 - Ondrej Bartas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-21 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fugit
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: globalid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: Enables to set jobs to be run in specified time (using CRON notation
   or natural language)
 email: ondrej@bartas.cz
@@ -158,6 +186,7 @@ files:
 - 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
@@ -180,14 +209,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Scheduler/Cron for Sidekiq jobs