sidekiq-scheduler 5.0.3 → 5.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d26f3947b1ef031bc393203e79975cfcc5159d32f7ff3d07a1b3858621d167d4
-  data.tar.gz: f921936d4d0a8f9942e98cc67da8404738af852042e2f8b23e9c818be14c8b26
+  metadata.gz: 17e9ebdeaa24ce323d7b3f94c7481d741e0f0f6d3daeded5eaef94f8b1e09f37
+  data.tar.gz: c8e1d62c30406b7928444bdd05a0668aac6bbb47c1bc6a752ff795dbf67b8bb2
 SHA512:
-  metadata.gz: 1fdea51e227d0eafcce6cc6973e9e9349788ffd3ff947c3967ca4eceae7fe4c47ec485a72194c36e11b623a3cfa372ba583d6305df57896d7c39fc6c3f687618
-  data.tar.gz: c217f9992d5cb3fcb78d11dae5273cccdae276fd2d6a7c1166b4faf6aae92ad3b8c2253af2f4f94fffca4027fe0c9ca6720386cb7406d592baa514b63ee5f6ef
+  metadata.gz: f94c5008ef8a2ec39837adc8a25145b27c15abf2514ba22f9c2341b1306431aecfcceb877f8b07fe05c0daa09e26e6b4df3f6e10c118893fe78b11ca6b6751cb
+  data.tar.gz: 61e7f37615f1c575d51c0e55593c4a82362829e21533182e60ec7a125fe76273e44bc055f6449a43185c083370eb1e416a0f1031671e537b6b85cec0ff3a218b

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# 5.0.4
+  - [**FIX**] Ensure rufus-scheduler has a default rufus_scheduler_options value [#434](https://github.com/sidekiq-scheduler/sidekiq-scheduler/issues/426)
+  - [**ENHANCEMENT**] Remove code related to sidekiq < 6 [#443](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/443)
+  - [**ENHANCEMENT**] Change cache-control to `private` [#446](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/446)
+  - [**ENHANCEMENT**] Increase compatibility range with tilt dependency [#458](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/458)
+  - [**ENHANCEMENT**] Ensure we support Ruby 3.3 [#461](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/461)
+  - [**ENHANCEMENT**] Use Redis MULTI command (https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/464)
+  - [**ENHANCEMENT**] Don't attempt to set jon next_time when job is nil [#466](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/466)
+  - [**ENHANCEMENT**] Improvements to prevent jobs been enqueued multiple times due to a delay in job execution [#463](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/463)
+  - [**FIX**] Prevent stack level too deep error by implementing `to_hash` method [#470](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/470)
+  - [**ENHANCEMENT**] Support new Sidekiq model for registering UI plugins [#472](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/472)
+  - [**ENHANCEMENT**] Stop testing against Ruby 2.7 and 3.0 [#472](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/472#discussion_r1663197863)
+  - [**ENHANCEMENT**] Display `at` and `in` in the dashboard [#291](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/291)  
+  - [**ENHANCEMENT**] Docs enhancements [#442](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/442), [#449](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/449), [#457](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/457), [#465](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/465), [58e1835](https://github.com/sidekiq-scheduler/sidekiq-scheduler/commit/58e18351054fc3c264b2b5a684173316f674c386)
+
+
 # 5.0.3
 
   - [**FIX**] Fix "uppercase character in header name: Cache-Control" [#432](https://github.com/sidekiq-scheduler/sidekiq-scheduler/pull/432)

data/README.md

@@ -45,6 +45,8 @@ class HelloWorld
 end
 ```
 
+__Note:__ In Sidekiq v6.3 `Sidekiq::Job` was introduced as an alias for `Sidekiq::Worker`. `Sidekiq::Worker` has been officially deprecated in Sidekiq v7 although it still exists for backwards compatibility. It is therefore recommended to use `include Sidekiq::Job` in the above example unless an older version of Sidekiq is required.
+
 ``` yaml
 # config/sidekiq.yml
 
@@ -55,6 +57,9 @@ end
       class: HelloWorld
 ```
 
+> [!NOTE]
+> sidekiq-scheduler uses [fugit](https://github.com/floraison/fugit) under the hood, which supports up to six arguments as the cron string, [see](https://github.com/floraison/fugit?tab=readme-ov-file#the-second-extension). 
+
 Run sidekiq:
 
 ``` sh
@@ -122,7 +127,7 @@ The schedule is configured through the `:scheduler:` -> `:schedule` config entry
 
       # Deconstructs a hash defined as the `args` to keyword arguments. 
       #
-      # `flase` by default.
+      # `false` by default.
       # 
       # Example
       # 
@@ -208,7 +213,7 @@ At, and in types push jobs only once. `at` schedules in a point in time:
     at: '3001/01/01'
 ```
 
-You can specify any string that `DateTime.parse` and `Chronic` understand. To enable Chronic
+You can specify any string that `DateTime.parse` and `Chronic` understand. To enable [Chronic](https://github.com/mojombo/chronic)
 strings, you must add it as a dependency.
 
 `in` triggers after a time duration has elapsed:
@@ -359,7 +364,7 @@ MyRegularJob:
 Then we can conditionally load it via an initializer:
 
 ```ruby
-# config/initializer/sidekiq.rb
+# config/initializers/sidekiq.rb
 if ENV.fetch("IS_SCHEDULER", false)
   Sidekiq.configure_server do |config|
     config.on(:startup) do

data/lib/sidekiq-scheduler/config.rb

@@ -59,6 +59,17 @@ module SidekiqScheduler
       SidekiqScheduler::SidekiqAdapter.sidekiq_queues(sidekiq_config)
     end
 
+    def to_hash
+      {
+        enabled: enabled?,
+        dynamic: dynamic?,
+        dynamic_every: dynamic_every?,
+        shedule: schedule,
+        listened_queues_only: listened_queues_only?,
+        rufus_scheduler_options: rufus_scheduler_options
+      }
+    end
+
     private
 
     attr_reader :scheduler_config

data/lib/sidekiq-scheduler/extensions/web.rb

@@ -1,14 +1,27 @@
 require 'sidekiq/web' unless defined?(Sidekiq::Web)
 
-ASSETS_PATH = File.expand_path('../../../web/assets', __dir__)
+if SidekiqScheduler::SidekiqAdapter::SIDEKIQ_GTE_7_3_0
 
-Sidekiq::Web.register(SidekiqScheduler::Web)
-Sidekiq::Web.tabs['recurring_jobs'] = 'recurring-jobs'
-Sidekiq::Web.locales << File.expand_path("#{File.dirname(__FILE__)}/../../../web/locales")
+  # Locale and asset cache is configured in `.regiester`
+  Sidekiq::Web.register(SidekiqScheduler::Web,
+    name: "recurring_jobs",
+    tab: ["Recurring Jobs"],
+    index: ["recurring-jobs"],
+    root_dir: File.expand_path("../../../web", File.dirname(__FILE__)),
+    asset_paths: ["stylesheets-scheduler"]) do |app|
+    # add middleware or additional settings here
+  end
+
+else
+
+  ASSETS_PATH = File.expand_path('../../../web/assets', __dir__)
+
+  Sidekiq::Web.register(SidekiqScheduler::Web)
+  Sidekiq::Web.tabs['recurring_jobs'] = 'recurring-jobs'
+  Sidekiq::Web.locales << File.expand_path("#{File.dirname(__FILE__)}/../../../web/locales")
 
-if Sidekiq::VERSION >= '6.0.0'
   Sidekiq::Web.use Rack::Static, urls: ['/stylesheets-scheduler'],
                                  root: ASSETS_PATH,
                                  cascade: true,
-                                 header_rules: [[:all, { 'cache-control' => 'public, max-age=86400' }]]
+                                 header_rules: [[:all, { 'cache-control' => 'private, max-age=86400' }]]
 end

data/lib/sidekiq-scheduler/job_presenter.rb

@@ -38,7 +38,7 @@ module SidekiqScheduler
     #
     # @return [String] with the job's interval
     def interval
-      @attributes['cron'] || @attributes['interval'] || @attributes['every']
+      @attributes['cron'] || @attributes['interval'] || @attributes['every'] || @attributes['at'] || @attributes['in']
     end
 
     # Returns the queue of the job

data/lib/sidekiq-scheduler/manager.rb

@@ -24,6 +24,15 @@ module SidekiqScheduler
       @scheduler_instance.load_schedule!
     end
 
+    # This method is needed to avoid exposing unnecessary information.
+    # Because ActiveSupport's `as_json` traverses instance values to convert the object to a hash
+    # unless it responds to `to_hash`.
+    def to_hash
+      {
+        scheduler: @scheduler_instance.to_hash
+      }
+    end
+
     private
 
     def set_current_scheduler_options(config)

data/lib/sidekiq-scheduler/redis_manager.rb

@@ -130,9 +130,9 @@ module SidekiqScheduler
     def self.register_job_instance(job_name, time)
       job_key = pushed_job_key(job_name)
       registered, _ = Sidekiq.redis do |r|
-        r.pipelined do |pipeline|
-          pipeline.zadd(job_key, time.to_i, time.to_i)
-          pipeline.expire(job_key, REGISTERED_JOBS_THRESHOLD_IN_SECONDS)
+        r.multi do |m|
+          m.zadd(job_key, time.to_i, time.to_i)
+          m.expire(job_key, REGISTERED_JOBS_THRESHOLD_IN_SECONDS)
         end
       end
 

data/lib/sidekiq-scheduler/scheduler.rb

@@ -58,7 +58,7 @@ module SidekiqScheduler
       self.dynamic = config.dynamic?
       self.dynamic_every = config.dynamic_every?
       self.listened_queues_only = config.listened_queues_only?
-      self.rufus_scheduler_options = config.rufus_scheduler_options
+      self.rufus_scheduler_options = config.rufus_scheduler_options || {}
     end
 
     # the Rufus::Scheduler jobs that are scheduled
@@ -128,6 +128,8 @@ module SidekiqScheduler
             schedule, options = SidekiqScheduler::RufusUtils.normalize_schedule_options(config_interval_type)
 
             rufus_job = new_job(name, interval_type, config, schedule, options)
+            return unless rufus_job
+
             @scheduled_jobs[name] = rufus_job
             SidekiqScheduler::Utils.update_job_next_time(name, rufus_job.next_time)
 
@@ -248,6 +250,12 @@ module SidekiqScheduler
       end
     end
 
+    def to_hash
+      {
+        scheduler_config: @scheduler_config.to_hash
+      }
+    end
+
     private
 
     attr_reader :scheduler_config
@@ -256,7 +264,15 @@ module SidekiqScheduler
       options = options.merge({ :job => true, :tags => [name] })
 
       rufus_scheduler.send(interval_type, schedule, options) do |job, time|
-        idempotent_job_enqueue(name, time, SidekiqScheduler::Utils.sanitize_job_config(config)) if job_enabled?(name)
+        if job_enabled?(name)
+          conf = SidekiqScheduler::Utils.sanitize_job_config(config)
+
+          if job.is_a?(Rufus::Scheduler::CronJob)
+            idempotent_job_enqueue(name, SidekiqScheduler::Utils.calc_cron_run_time(job.cron_line, time.utc), conf)
+          else
+            idempotent_job_enqueue(name, time, conf)
+          end
+        end
       end
     end
 

data/lib/sidekiq-scheduler/sidekiq_adapter.rb

@@ -4,6 +4,7 @@ module SidekiqScheduler
   class SidekiqAdapter
     SIDEKIQ_GTE_6_5_0 = Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new('6.5.0')
     SIDEKIQ_GTE_7_0_0 = Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new('7.0.0')
+    SIDEKIQ_GTE_7_3_0 = Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new('7.3.0')
 
     def self.fetch_scheduler_config_from_sidekiq(sidekiq_config)
       return {} if sidekiq_config.nil?

data/lib/sidekiq-scheduler/utils.rb

@@ -141,5 +141,39 @@ module SidekiqScheduler
     def self.update_job_last_time(name, last_time)
       SidekiqScheduler::RedisManager.set_job_last_time(name, last_time) if last_time
     end
+
+    # Try to figure out when the cron job was supposed to run.
+    #
+    # Rufus calls the scheduler block with the current time and not the time the block was scheduled to run.
+    # This means under certain conditions you could have a job get scheduled multiple times because `time.to_i` is used
+    # to key the job in redis. If one server is under load and Rufus tries to run the jobs 1 seconds after the other
+    # server then the job will be queued twice.
+    # This method essentially makes a best guess at when this job was supposed to run and return that.
+    #
+    # @param [Fugit::Cron] cron
+    # @param [Time] time
+    #
+    # @return [Time]
+    def self.calc_cron_run_time(cron, time)
+      time = time.round # remove sub seconds to prevent rounding errors.
+      next_t = cron.next_time(time).utc
+      previous_t = cron.previous_time(time).utc
+      # The `time` var is some point between `previous_t` and `next_t`.
+      # Figure out how far off we are from each side in seconds.
+      next_diff = next_t - time
+      previous_diff = time - previous_t
+
+      if next_diff == previous_diff
+        # In the event `time` is exactly between `previous_t` and `next_t` the diff will not be equal to
+        # `cron.rough_frequency`. In that case we round down.
+        cron.rough_frequency == next_diff ? time : previous_t
+      elsif next_diff > previous_diff
+        # We are closer to the previous run time so return that.
+        previous_t
+      else
+        # We are closer to the next run time so return that.
+        next_t
+      end
+    end
   end
 end

data/lib/sidekiq-scheduler/version.rb

@@ -1,3 +1,3 @@
 module SidekiqScheduler
-  VERSION = "5.0.3"
+  VERSION = "5.0.4"
 end

data/web/locales/cs.yml

@@ -1,4 +1,5 @@
 cs:
+  "Recurring Jobs": Pravidelně opakované
   recurring_jobs: Pravidelně opakované
   name: Jméno
   description: Popis

data/web/locales/de.yml

@@ -1,4 +1,5 @@
 de:
+  "Recurring Jobs": Wiederkehrende Jobs
   recurring_jobs: Wiederkehrende Jobs
   name: Name
   description: Beschreibung

data/web/locales/en.yml

@@ -1,4 +1,5 @@
 en:
+  "Recurring Jobs": Recurring Jobs
   recurring_jobs: Recurring Jobs
   name: Name
   description: Description

data/web/locales/es.yml

@@ -1,4 +1,5 @@
 es:
+  "Recurring Jobs": Tareas Recurrentes
   recurring_jobs: Tareas Recurrentes
   name: Nombre
   description: Descripción

data/web/locales/fr.yml

@@ -1,4 +1,5 @@
 fr:
+  "Recurring Jobs": Tâches récurrentes
   recurring_jobs: Tâches récurrentes
   name: Nom
   description: Description

data/web/locales/gd.yml

@@ -1,4 +1,5 @@
 gd:
+  "Recurring Jobs": Obraichean ath-chùrsach
   recurring_jobs: Obraichean ath-chùrsach
   name: Ainm
   description: Tuairisgeul

data/web/locales/it.yml

@@ -1,4 +1,5 @@
 it:
+  "Recurring Jobs": Job ricorrenti
   recurring_jobs: Job ricorrenti
   name: Nome
   description: Descrizione

data/web/locales/ja.yml

@@ -1,4 +1,5 @@
 ja:
+  "Recurring Jobs": 定期ジョブ
   recurring_jobs: 定期ジョブ
   name: 名前
   description: 説明

data/web/locales/nl.yml

@@ -1,4 +1,5 @@
 nl:
+  "Recurring Jobs": Herhalende taken
   recurring_jobs: Herhalende taken
   name: Naam
   description: Beschrijving

data/web/locales/pl.yml

@@ -1,4 +1,5 @@
 pl:
+  "Recurring Jobs": Okresowe
   recurring_jobs: Okresowe
   name: Nazwa
   description: Opis

data/web/locales/pt-BR.yml

@@ -1,4 +1,5 @@
 pt-BR:
+  "Recurring Jobs": Jobs Recorrentes
   recurring_jobs: Jobs Recorrentes
   name: Nome
   description: Descrição
@@ -6,7 +7,7 @@ pt-BR:
   class: Classe
   queue: Fila
   arguments: Argumentos
-  enqueue_now: Enfileirar agora 
+  enqueue_now: Enfileirar agora
   last_time: Última execução
   next_time: Próxima execução
   no_next_time: Não há mais execuçoẽs

data/web/locales/ru.yml

@@ -1,4 +1,5 @@
 ru:
+  "Recurring Jobs": Расписание задач
   recurring_jobs: Расписание задач
   name: Название
   description: Описание

data/web/locales/sv.yml

@@ -1,4 +1,5 @@
 sv:
+  "Recurring Jobs": Återkommande jobb
   recurring_jobs: Återkommande jobb
   name: Namn
   description: Beskrivning

data/web/locales/zh-cn.yml

@@ -1,4 +1,5 @@
 zh-cn:
+  "Recurring Jobs": 周期作业
   recurring_jobs: 周期作业
   name: 名称
   description: 描述

data/web/views/recurring_jobs.erb

@@ -1,42 +1,7 @@
-<% if Sidekiq::VERSION >= '6.0.0' %>
-  <link href="<%= root_path %>stylesheets-scheduler/recurring_jobs.css" media="screen" rel="stylesheet" type="text/css" />
+<% if SidekiqScheduler::SidekiqAdapter::SIDEKIQ_GTE_7_3_0 %>
+<%= style_tag "stylesheets-scheduler/recurring_jobs.css" %>
 <% else %>
-  <style>
-    .recurring-jobs { border-top-left-radius: 4px; border-top-right-radius: 4px; }
-    .recurring-jobs .title { margin-bottom: 5px; }
-    .recurring-jobs .title .name { font-weight: bold;}
-    .recurring-jobs .info,
-    .recurring-jobs .description { margin-bottom: 5px; }
-    .recurring-jobs .actions { margin-bottom: 5px; }
-    .recurring-jobs .status,
-    .recurring-jobs .description { font-size: 12px; }
-    .recurring-jobs .enqueue { margin-bottom: 0.5rem }
-
-    .list-group-item {
-      background-color: #f3f3f3;
-      color: #585454;
-      border: 1px solid rgba(0, 0, 0, 0.1);
-    }
-
-    .list-group-item-disabled {
-      background-color: #f3d3d3;
-    }
-
-    .toggle-all-buttons {
-      margin-top: 20px;
-      margin-bottom: 10px;
-      line-height: 45px;
-      text-align: right;
-    }
-
-    @media (max-width: 768px) {
-      .toggle-all-buttons {
-        margin-top: 0;
-        text-align: left;
-        line-height: inherit;
-      }
-    }
-  </style>
+<link href="<%= root_path %>stylesheets-scheduler/recurring_jobs.css" media="screen" rel="stylesheet" type="text/css" />
 <% end %>
 
 <div class="row">

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-scheduler
 version: !ruby/object:Gem::Version
-  version: 5.0.3
+  version: 5.0.4
 platform: ruby
 authors:
 - Morton Jonuschat
 - Moove-it
 - Marcelo Lauxen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -53,6 +53,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -60,6 +63,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +240,7 @@ homepage: https://sidekiq-scheduler.github.io/sidekiq-scheduler/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -249,8 +255,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Light weight job scheduling extension for Sidekiq
 test_files: []