sidekiq-cron 1.12.0 → 2.0.0.rc1

data/lib/sidekiq/cron/views/cron.erb

@@ -1,22 +1,25 @@
 <header class='row'>
   <div class='col-sm-5 pull-left'>
-    <h3><%= t('CronJobs') %></h3>
+    <h3>
+      <%= t('CronJobs') %>
+      <small><%= @current_namespace %></small>
+    </h3>
   </div>
   <div class='col-sm-7 pull-right' style="margin-top: 20px; margin-bottom: 10px;">
     <% if @cron_jobs.size > 0 %>
-      <form action="<%= root_path %>cron/__all__/delete" method="post" class="pull-right">
+      <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/all/delete" method="post" class="pull-right">
         <%= csrf_tag if respond_to?(:csrf_tag) %>
         <input class="btn btn-danger" type="submit" name="delete" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSureDeleteCronJobs') %>" />
       </form>
-      <form action="<%= root_path %>cron/__all__/disable" method="post" class="pull-right">
+      <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/all/disable" method="post" class="pull-right">
         <%= csrf_tag if respond_to?(:csrf_tag) %>
         <input class="btn btn-warn" type="submit" name="enque" value="<%= t('DisableAll') %>" />
       </form>
-      <form action="<%= root_path %>cron/__all__/enable" method="post" class="pull-right">
+      <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/all/enable" method="post" class="pull-right">
         <%= csrf_tag if respond_to?(:csrf_tag) %>
         <input class="btn btn-warn" type="submit" name="enque" value="<%= t('EnableAll') %>" />
       </form>
-      <form action="<%= root_path %>cron/__all__/enque" method="post" class="pull-right">
+      <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/all/enque" method="post" class="pull-right">
         <%= csrf_tag if respond_to?(:csrf_tag) %>
         <input class="btn btn-warn" type="submit" name="enque" value="<%= t('EnqueueAll') %>" data-confirm="<%= t('AreYouSureEnqueueCronJobs') %>" />
       </form>
@@ -24,8 +27,24 @@
   </div>
 </header>
 
-<% if @cron_jobs.size > 0 %>
+<!-- Namespaces -->
+<div class='row'>
+  <div class="col-sm-12 summary_bar">
+    <ul class="list-unstyled summary row">
+      <% @namespaces.sort_by { |namespace| namespace[:name] } .each do |namespace| %>
+        <li class="col-sm-1">
+          <a href="<%= root_path %>cron/namespaces/<%= namespace[:name] %>">
+            <span class="count"><%= namespace[:count] %></span>
+            <span class="desc"><%= namespace[:name] %></span>
+          </a>
+        </li>
+      <% end %>
+    </ul>
+  </div>
+</div>
+<!-- Namespaces -->
 
+<% if @cron_jobs.size > 0 %>
   <table class="table table-hover table-bordered table-striped table-white">
     <thead>
       <th><%= t('Status') %></th>
@@ -41,7 +60,7 @@
         <tr>
           <td style="<%= style %>"><%= t job.status %></td>
           <td style="<%= style %>">
-            <a href="<%= root_path %>cron/<%= CGI.escape(job.name).gsub('+', '%20') %>">
+            <a href="<%= root_path %>cron/namespaces/<%= @current_namespace %>/jobs/<%= CGI.escape(job.name).gsub('+', '%20') %>" title="<%= job.description %>">
               <b style="<%= style %>"><%= job.name %></b>
             </a>
             <hr style="margin:3px;border:0;">
@@ -61,28 +80,28 @@
             <% end %>
             </small>
           </td>
-          <td style="<%= style %>"><b><%= job.cron.gsub(" ", "&nbsp;") %></b></td>
+          <td style="<%= style %>"><b><%= job.human_cron %><br/><small><%= job.cron.gsub(" ", "&nbsp;") %></small></b></td>
           <td style="<%= style %>"><%= job.last_enqueue_time ? relative_time(job.last_enqueue_time) : "-" %></td>
           <td style="<%= style %>">
             <% if job.status == 'enabled' %>
-              <form action="<%= root_path %>cron/<%= CGI.escape(job.name).gsub('+', '%20') %>/enque" method="post">
+              <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/jobs/<%= CGI.escape(job.name).gsub('+', '%20') %>/enque" method="post">
                 <%= csrf_tag if respond_to?(:csrf_tag) %>
                 <input class='btn btn-warn btn-xs pull-left' type="submit" name="enque" value="<%= t('EnqueueNow') %>" data-confirm="<%= t('AreYouSureEnqueueCronJob', :job => job.name) %>"/>
               </form>
-              <form action="<%= root_path %>cron/<%= CGI.escape(job.name).gsub('+', '%20') %>/disable" method="post">
+              <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/jobs/<%= CGI.escape(job.name).gsub('+', '%20') %>/disable" method="post">
                 <%= csrf_tag if respond_to?(:csrf_tag) %>
                 <input class='btn btn-warn btn-xs pull-left' type="submit" name="disable" value="<%= t('Disable') %>"/>
               </form>
             <% else %>
-              <form action="<%= root_path %>cron/<%= CGI.escape(job.name).gsub('+', '%20') %>/enque" method="post">
+              <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/jobs/<%= CGI.escape(job.name).gsub('+', '%20') %>/enque" method="post">
                 <%= csrf_tag if respond_to?(:csrf_tag) %>
                 <input class='btn btn-warn btn-xs pull-left' type="submit" name="enque" value="<%= t('EnqueueNow') %>"/>
               </form>
-              <form action="<%= root_path %>cron/<%= CGI.escape(job.name).gsub('+', '%20') %>/enable" method="post">
+              <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/jobs/<%= CGI.escape(job.name).gsub('+', '%20') %>/enable" method="post">
                 <%= csrf_tag if respond_to?(:csrf_tag) %>
                 <input class='btn btn-warn btn-xs pull-left' type="submit" name="enable" value="<%= t('Enable') %>"/>
               </form>
-              <form action="<%= root_path %>cron/<%= CGI.escape(job.name).gsub('+', '%20') %>/delete" method="post">
+              <form action="<%= root_path %>cron/namespaces/<%= @current_namespace %>/jobs/<%= CGI.escape(job.name).gsub('+', '%20') %>/delete" method="post">
                 <%= csrf_tag if respond_to?(:csrf_tag) %>
                 <input class='btn btn-xs btn-danger pull-left' type="submit" name="delete" value="<%= t('Delete') %>" data-confirm="<%= t('AreYouSureDeleteCronJob', :job => job.name) %>"/>
               </form>

data/lib/sidekiq/cron/views/cron_show.erb

@@ -6,8 +6,8 @@
     </h3>
   </div>
   <div class="span col-sm-7 pull-right" style="margin-top: 20px; margin-bottom: 10px;">
-    <% cron_job_path = "#{root_path}cron/#{CGI.escape(@job.name).gsub('+', '%20')}" %>
-    <form action="<%= cron_job_path %>/enque?redirect=<%= cron_job_path %>" method="post">
+    <% cron_job_path = "#{root_path}cron/namespaces/#{@current_namespace}/jobs/#{CGI.escape(@job.name).gsub('+', '%20')}" %>
+    <form action="<%= cron_job_path %>/enque?redirect=<%= cron_job_path %>" class="pull-right" method="post">
       <%= csrf_tag if respond_to?(:csrf_tag) %>
       <input class="btn btn-warn pull-left" name="enque" type="submit" value="<%= t('EnqueueNow') %>" data-confirm="<%= t('AreYouSureEnqueueCronJob', :job => @job.name) %>" />
     </form>
@@ -39,6 +39,10 @@
     <th><%= t 'Name' %></th>
     <td><%= @job.name %></td>
   </tr>
+  <tr>
+    <th><%= t 'Namespace' %></th>
+    <td><%= @job.namespace %></td>
+  </tr>
   <tr>
     <th><%= t 'Description' %></th>
     <td><%= @job.description %></td>

data/lib/sidekiq/cron/web_extension.rb

@@ -6,60 +6,99 @@ module Sidekiq
 
         # Index page of cron jobs.
         app.get '/cron' do
-          view_path    = File.join(File.expand_path("..", __FILE__), "views")
+          view_path = File.join(File.expand_path("..", __FILE__), "views")
+
+          @current_namespace = 'default'
+
+          @namespaces = Sidekiq::Cron::Namespace.all_with_count
 
+          # Not passing namespace takes all the jobs from the default one.
           @cron_jobs = Sidekiq::Cron::Job.all
 
           render(:erb, File.read(File.join(view_path, "cron.erb")))
         end
 
+        app.get '/cron/namespaces/:name' do
+          view_path = File.join(File.expand_path("..", __FILE__), "views")
+
+          @current_namespace = route_params[:name]
+
+          @namespaces = Sidekiq::Cron::Namespace.all_with_count
+
+          @cron_jobs = Sidekiq::Cron::Job.all(@current_namespace)
+
+          render(:erb, File.read(File.join(view_path, "cron.erb")))
+        end
+
         # Display job detail + jid history.
-        app.get '/cron/:name' do
+        app.get '/cron/namespaces/:namespace/jobs/:name' do
           view_path = File.join(File.expand_path("..", __FILE__), "views")
 
-          @job = Sidekiq::Cron::Job.find(route_params[:name])
+          @current_namespace = route_params[:namespace]
+          @job_name = route_params[:name]
+
+          @namespaces = Sidekiq::Cron::Namespace.all_with_count
+
+          @job = Sidekiq::Cron::Job.find(@job_name, @current_namespace)
+
           if @job
             render(:erb, File.read(File.join(view_path, "cron_show.erb")))
           else
-            redirect "#{root_path}cron"
+            redirect "#{root_path}cron/namespaces/#{route_params[:namespace]}"
           end
         end
 
+        # Enque all cron jobs.
+        app.post '/cron/namespaces/:namespace/all/enque' do
+          Sidekiq::Cron::Job.all(route_params[:namespace]).each(&:enque!)
+          redirect params['redirect'] || "#{root_path}cron/namespaces/#{route_params[:namespace]}"
+        end
+
         # Enqueue cron job.
-        app.post '/cron/:name/enque' do
-          if route_params[:name] === '__all__'
-            Sidekiq::Cron::Job.all.each(&:enque!)
-          elsif job = Sidekiq::Cron::Job.find(route_params[:name])
+        app.post '/cron/namespaces/:namespace/jobs/:name/enque' do
+          if job = Sidekiq::Cron::Job.find(route_params[:name], route_params[:namespace])
             job.enque!
           end
           redirect params['redirect'] || "#{root_path}cron"
         end
 
+        # Delete all schedules.
+        app.post '/cron/namespaces/:namespace/all/delete' do
+          Sidekiq::Cron::Job.all(route_params[:namespace]).each(&:destroy)
+          redirect "#{root_path}cron/namespaces/#{route_params[:namespace]}"
+        end
+
         # Delete schedule.
-        app.post '/cron/:name/delete' do
-          if route_params[:name] === '__all__'
-            Sidekiq::Cron::Job.all.each(&:destroy)
-          elsif job = Sidekiq::Cron::Job.find(route_params[:name])
+        app.post '/cron/namespaces/:namespace/jobs/:name/delete' do
+          if job = Sidekiq::Cron::Job.find(route_params[:name], route_params[:namespace])
             job.destroy
           end
           redirect "#{root_path}cron"
         end
 
+        # Enable all jobs.
+        app.post '/cron/namespaces/:namespace/all/enable' do
+          Sidekiq::Cron::Job.all(route_params[:namespace]).each(&:enable!)
+          redirect params['redirect'] || "#{root_path}cron/namespaces/#{route_params[:namespace]}"
+        end
+
         # Enable job.
-        app.post '/cron/:name/enable' do
-          if route_params[:name] === '__all__'
-            Sidekiq::Cron::Job.all.each(&:enable!)
-          elsif job = Sidekiq::Cron::Job.find(route_params[:name])
+        app.post '/cron/namespaces/:namespace/jobs/:name/enable' do
+          if job = Sidekiq::Cron::Job.find(route_params[:name], route_params[:namespace])
             job.enable!
           end
           redirect params['redirect'] || "#{root_path}cron"
         end
 
+        # Disable all jobs.
+        app.post '/cron/namespaces/:namespace/all/disable' do
+          Sidekiq::Cron::Job.all(route_params[:namespace]).each(&:disable!)
+          redirect params['redirect'] || "#{root_path}cron/namespaces/#{route_params[:namespace]}"
+        end
+
         # Disable job.
-        app.post '/cron/:name/disable' do
-          if route_params[:name] === '__all__'
-            Sidekiq::Cron::Job.all.each(&:disable!)
-          elsif job = Sidekiq::Cron::Job.find(route_params[:name])
+        app.post '/cron/namespaces/:namespace/jobs/:name/disable' do
+          if job = Sidekiq::Cron::Job.find(route_params[:name], route_params[:namespace])
             job.disable!
           end
           redirect params['redirect'] || "#{root_path}cron"

data/lib/sidekiq/cron.rb

@@ -1,9 +1,53 @@
 require "sidekiq/cron/job"
+require "sidekiq/cron/namespace"
 require "sidekiq/cron/poller"
 require "sidekiq/cron/launcher"
 require "sidekiq/cron/schedule_loader"
 
 module Sidekiq
   module Cron
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+
+    class Configuration
+      # The default namespace is used when no namespace is specified.
+      attr_accessor :default_namespace
+
+      # The parsing mode when using the natural language cron syntax from the `fugit` gem.
+      #
+      # :single -- use the first parsed cron line and ignore the rest (default)
+      # :strict -- raise an error if multiple cron lines are parsed from one string
+      attr_reader :natural_cron_parsing_mode
+
+      # The poller will not enqueue jobs that are late by more than this amount of seconds.
+      # Defaults to 60 seconds.
+      #
+      # This is useful when sidekiq (and sidekiq-cron) is not used in zero downtime deployments and
+      # when the deployment is done and sidekiq-cron starts to catch up, it will consider older
+      # jobs that missed their schedules during the deployment. E.g., jobs that run once a day.
+      attr_accessor :reschedule_grace_period
+
+      def initialize
+        @default_namespace = 'default'
+        @natural_cron_parsing_mode = :single
+        @reschedule_grace_period = 60
+      end
+
+      def natural_cron_parsing_mode=(mode)
+        unless %i[single strict].include?(mode)
+          raise ArgumentError, "Unknown natural cron parsing mode: #{mode.inspect}"
+        end
+
+        @natural_cron_parsing_mode = mode
+      end
+    end
   end
 end
+
+Sidekiq::Cron.configure

data/sidekiq-cron.gemspec

@@ -26,9 +26,10 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 2.7"
 
+  s.add_dependency("cronex", ">= 0.13.0")
   s.add_dependency("fugit", "~> 1.8")
-  s.add_dependency("sidekiq", ">= 6")
   s.add_dependency("globalid", ">= 1.0.1")
+  s.add_dependency("sidekiq", ">= 6")
 
   s.add_development_dependency("minitest", "~> 5.15")
   s.add_development_dependency("mocha", "~> 2.1")

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-cron
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 2.0.0.rc1
 platform: ruby
 authors:
 - Ondrej Bartas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cronex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: fugit
   requirement: !ruby/object:Gem::Requirement
@@ -25,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: sidekiq
+  name: globalid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: globalid
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -170,11 +184,13 @@ files:
 - lib/sidekiq/cron/launcher.rb
 - lib/sidekiq/cron/locales/de.yml
 - lib/sidekiq/cron/locales/en.yml
+- lib/sidekiq/cron/locales/id.yml
 - lib/sidekiq/cron/locales/it.yml
 - lib/sidekiq/cron/locales/ja.yml
 - lib/sidekiq/cron/locales/pt.yml
 - lib/sidekiq/cron/locales/ru.yml
 - lib/sidekiq/cron/locales/zh-CN.yml
+- lib/sidekiq/cron/namespace.rb
 - lib/sidekiq/cron/poller.rb
 - lib/sidekiq/cron/schedule_loader.rb
 - lib/sidekiq/cron/support.rb
@@ -200,9 +216,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.10
 signing_key: