sidekiq-belt 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5e4649a97ccde536e22d2449ec678ccde0b955c0788c223fecd16487e7e9880
-  data.tar.gz: 690b2b57d00bba771275d7143c2104f9b139fc2b883600bf4a95bfbd8b6591b5
+  metadata.gz: 300d0c79beb050fe381ebbc075dc66f59454eda2fa01fc0fdcbb8b1945cd2140
+  data.tar.gz: 875c38988275047a9fb6f3293aa68ac0c1d0ca0733b02025f20397b2980d295a
 SHA512:
-  metadata.gz: dd3e644e8fb40e12809cd5de2744640a46df7695ad2146d7333ac09a7bcc3460168a23ff891d0e60b54fed06986240242f816f2e344d45fc86ead4c9399e350b
-  data.tar.gz: 61dc37a8dd5f5e3b29d7410275b3c2776063ac6e2944a72b01619cbb713e8c24d55dbf21c301781865cc9b8b030d7278d1e521e115742b1d6938fc103d65d377
+  metadata.gz: b8c6e92eeea82ce664ee76a9670561173b927d699dc44cb3bd8bb762c29a95c8f73cfb63fa81a0ce2646896d8bcd4aeaf29cf9ea796a3edf690f3f139198b38e
+  data.tar.gz: bdfc0a9b7662c086c3743e6825e0356ee79f5dd17db3fd24750e9dd8b8b6e34c0ae5589ae2a7ce01ed8d61a852d6fbd1f82c89a55547abb429a43269b442d389

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.3.2] - 2024-01-07
+
+- Feature to sort periodic list by class name
+
 ## [0.3.1] - 2023-11-01
 
 - Added style to pause button

data/README.md

@@ -80,6 +80,41 @@ Sidekiq::Belt.use!([:failed_batch_remove])
 ```
 ![failed_batch_remove](https://github.com/dannnylo/sidekiq-belt/assets/20794/e285a8b2-4626-48e1-b04a-5190ae51d43b)
 
+### Create a list of jobs to run (sidekiq)
+This feature is a manual job manager where you can list jobs. These jobs are grouped and organized in a `Run Jobs` tab.
+You can easily and quickly select which job you want to run manually.
+
+To enable this feature, pass the `run_job` option:
+```ruby
+Sidekiq::Belt.use!([:run_job])
+```
+
+![List jobs to run](https://github.com/dannnylo/sidekiq-belt/assets/20794/ed32dac7-46e2-4c44-b3de-69983c3b990c)
+
+To configure the list of jobs
+
+```ruby
+Sidekiq::Belt.configure do |config|
+  config.run_jobs = [
+    { class: "ManualClearDataWorker", args: ['a'] },
+    { class: "ManualDoSomethingWorker", args: ['b'] },
+    { class: "FirstOperationalWorker", args: ['c'], group: 'Operational' },
+    { class: "SecondOperationalWorker", args: ['d'], group: 'Operational' },
+    { class: "AnotherGroupWorker", args: ['e'], group: 'Group with a long name' }
+  ]
+end
+```
+Or
+
+```ruby
+Sidekiq::Belt.configure do |config|
+  config.run_jobs.push({ class: "AWorker", args: ["a"] })
+  config.run_jobs.push({ class: "BWorker" })
+
+  config.run_jobs << { class: "CWorker", args: ["a"], group: "Etc" }
+  config.run_jobs << { class: "DWorker", args: ["a"], group: "Etc" }
+end
+```
 
 ## Development
 

data/lib/sidekiq/belt/community/files.rb

@@ -1,18 +1,22 @@
 # frozen_string_literal: true
 
 require "sidekiq"
-# require_relative "feature"
+
+require_relative "run_job"
 
 module Sidekiq
   module Belt
     module Community
       module Files
-        def self.use!(_options = [:all])
-          # all = options.include?(:all)
-          # Sidekiq::Belt::Pro::Feature.load! if all || options.include?(:feature)
+        def self.use!(options = [:all])
+          Sidekiq::Belt::Community::RunJob.use! if should_use?(:run_job, options)
 
           true
         end
+
+        def self.should_use?(key, options)
+          options.include?(:all) || options.include?(key)
+        end
       end
     end
   end

data/lib/sidekiq/belt/community/run_job.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "sidekiq/web"
+require "sidekiq/web/helpers"
+
+module Sidekiq
+  module Belt
+    module Community
+      module RunJob
+        def self.list_grouped_jobs
+          jobs = {}
+          Sidekiq::Belt.config.run_jobs.each_with_index do |job, i|
+            job.transform_keys(&:to_sym)
+            job[:id] = i
+
+            jobs[job[:group].to_s] ||= []
+            jobs[job[:group].to_s] << job
+          end
+
+          jobs
+        end
+
+        def self.run_job(job_id)
+          job = Sidekiq::Belt.config.run_jobs[job_id.to_i]
+          job.transform_keys(&:to_sym)
+
+          Module.const_get(job[:class]).perform_async(*job.fetch(:args, []))
+        end
+
+        module SidekiqRunJob
+          def self.registered(app)
+            app.tabs["Run Jobs"] = "run_jobs"
+
+            app.get("/run_jobs") do
+              @jobs = Sidekiq::Belt::Community::RunJob.list_grouped_jobs
+
+              render(:erb, File.read(File.join(__dir__, "views/run_jobs.erb")))
+            end
+
+            app.post("/run_jobs/:rjid/run") do
+              Sidekiq::Belt::Community::RunJob.run_job(params[:rjid].to_i)
+
+              return redirect "#{root_path}run_jobs"
+            end
+          end
+        end
+
+        def self.use!
+          Sidekiq::Web.register(Sidekiq::Belt::Community::RunJob::SidekiqRunJob)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/belt/community/views/run_jobs.erb

@@ -0,0 +1,30 @@
+<% @jobs.each do |group, jobs| %>
+  <div class="header-container">
+    <h1><%= group %></h1>
+  </div>
+
+  <div class="table_container">
+    <table class="queues table table-hover table-bordered table-striped">
+      <thead>
+        <th><%= t('Class') %></th>
+        <th><%= t('Args') %></th>
+        <th><%= t('Run') %></th>
+      </thead>
+      <tbody>
+      <% jobs.each do |job| %>
+        <tr>
+          <td><%= job[:class] %></td>
+          <td><%= job[:args].inspect %></td>
+          <td style='width: 100px'>
+            <form action="<%= root_path %>run_jobs/<%= job[:id] %>/run" method="post">
+              <%= csrf_tag %>
+              <input class="btn btn-danger" type="submit" name="run" value="<%= t('Run') %>"
+                data-confirm="Run the job <%= job[:klass] %>? <%= t('AreYouSure') %>" />
+            </form>
+          </td>
+        </tr>
+      <% end %>
+      </tbody>
+    </table>
+  </div>
+<% end %>

data/lib/sidekiq/belt/ent/files.rb

@@ -4,6 +4,7 @@ require "sidekiq"
 
 require_relative "periodic_pause"
 require_relative "periodic_run"
+require_relative "periodic_sort"
 
 module Sidekiq
   module Belt
@@ -12,13 +13,16 @@ module Sidekiq
         def self.use!(options = [:all])
           return unless Sidekiq.ent?
 
-          all = options.include?(:all)
-
-          Sidekiq::Belt::Ent::PeriodicPause.use! if all || options.include?(:periodic_pause)
-          Sidekiq::Belt::Ent::PeriodicRun.use! if all || options.include?(:periodic_run)
+          Sidekiq::Belt::Ent::PeriodicPause.use! if should_use?(:periodic_pause, options)
+          Sidekiq::Belt::Ent::PeriodicRun.use! if should_use?(:periodic_run, options)
+          Sidekiq::Belt::Ent::PeriodicSort.use! if should_use?(:periodic_sort, options)
 
           true
         end
+
+        def self.should_use?(key, options)
+          options.include?(:all) || options.include?(key)
+        end
       end
     end
   end

data/lib/sidekiq/belt/ent/periodic_sort.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "sidekiq/web/helpers"
+
+module Sidekiq
+  module Belt
+    module Ent
+      module PeriodicSort
+        module SidekiqLoopsPeriodicSort
+          def each(&block)
+            @lids.map { |lid| Sidekiq::Periodic::Loop.new(lid) }.sort_by(&:klass).each(&block)
+          end
+        end
+
+        def self.use!
+          require("sidekiq-ent/periodic")
+          require("sidekiq-ent/periodic/static_loop")
+
+          Sidekiq::Periodic::LoopSet.prepend(Sidekiq::Belt::Ent::PeriodicSort::SidekiqLoopsPeriodicSort)
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/belt/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Belt
-    VERSION = "0.3.1"
+    VERSION = "0.3.3"
   end
 end

data/lib/sidekiq/belt.rb

@@ -19,5 +19,13 @@ module Sidekiq
       Sidekiq::Belt::Pro::Files.use!(options)
       Sidekiq::Belt::Ent::Files.use!(options)
     end
+
+    def self.configure
+      yield config
+    end
+
+    def self.config
+      @config ||= Struct.new(:run_jobs).new([])
+    end
   end
 end

data/lib/sidekiq/web_action_helper.rb

@@ -14,7 +14,9 @@ module Sidekiq
 
       path_info ||= ::Rack::Utils.unescape(env["PATH_INFO"])
 
-      Sidekiq::Config::DEFAULTS[:replace_views].fetch(path_info.to_s, []).each do |content_block|
+      replace_views = Sidekiq::Config::DEFAULTS[:replace_views] || {}
+
+      replace_views.fetch(path_info.to_s, []).each do |content_block|
         content_block.call(content)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-belt
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Danilo Jeremias da Silva
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-01 00:00:00.000000000 Z
+date: 2024-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -42,9 +42,12 @@ files:
 - lib/sidekiq-belt.rb
 - lib/sidekiq/belt.rb
 - lib/sidekiq/belt/community/files.rb
+- lib/sidekiq/belt/community/run_job.rb
+- lib/sidekiq/belt/community/views/run_jobs.erb
 - lib/sidekiq/belt/ent/files.rb
 - lib/sidekiq/belt/ent/periodic_pause.rb
 - lib/sidekiq/belt/ent/periodic_run.rb
+- lib/sidekiq/belt/ent/periodic_sort.rb
 - lib/sidekiq/belt/pro/failed_batch_remove.rb
 - lib/sidekiq/belt/pro/files.rb
 - lib/sidekiq/belt/version.rb
@@ -73,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: This Ruby gem enhances the capabilities of Sidekiq, Sidekiq Pro, and Sidekiq