Run jobs with dynamic args (#21)

* Allow to run jobs with dynamic args

* Added documentation

* Fix rubocop warnings

* Added dynamic args enum to run jobs

* Better doc

* Added changelog and Update version

* Rollback

Author: dannnylo

CHANGELOG.md

@@ -1,4 +1,8 @@
 ## [Unreleased]
+
+## [2.0.2] - 2025-03-23
+- Dynamic args on Jobs Run
+
 ## [2.0.1] - 2025-03-11
 - Fix Support to Sidekiq-ent and Sidekiq-pro v8
 

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq-belt (2.0.1)
+    sidekiq-belt (2.0.2)
       sidekiq (>= 7.3.8)
 
 GEM
@@ -88,4 +88,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.5.23
+   2.6.3

README.md

@@ -113,6 +113,16 @@ Sidekiq::Belt.configure do |config|
 
   config.run_jobs << { class: "CWorker", args: ["a"], group: "Etc" }
   config.run_jobs << { class: "DWorker", args: ["a"], group: "Etc" }
+
+  config.run_jobs << { class: "EWorker", args: [
+      { dynamic: 'text', title: 'Observation' },
+      { dynamic: 'integer', title: 'Number of test' },
+      'fixed value A',
+      { dynamic: 'boolean', title: 'Boolean data' },
+      { dynamic: 'enum', title: 'Enum data', options: ['option1', 'option2', 'option3'], default: 'option2' },
+      'fixed value B'
+    ], group: "Etc" }
+  config.run_jobs << { class: "FWorker", args: ["a"], group: "Etc" }
 end
 ```
 

lib/sidekiq/belt/community/run_job.rb

@@ -20,11 +20,32 @@ def self.list_grouped_jobs
           jobs
         end
 
-        def self.run_job(job_id)
+        def self.dynamic_type?(arg, type)
+          return false unless arg.is_a?(Hash)
+
+          arg[:dynamic].to_s == type
+        end
+
+        def self.run_job(job_id, extra_args = {})
           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, []))
+          args = job.fetch(:args, [])
+
+          new_args = []
+          args.each_with_index do |arg, i|
+            if dynamic_type?(arg, "text") || dynamic_type?(arg, "enum")
+              new_args[i] = extra_args.shift
+            elsif dynamic_type?(arg, "integer")
+              new_args[i] = extra_args.shift.to_i
+            elsif dynamic_type?(arg, "boolean")
+              new_args[i] = extra_args.shift == "true"
+            else
+              new_args << arg
+            end
+          end
+
+          Module.const_get(job[:class]).perform_async(*new_args)
         end
 
         module SidekiqRunJob
@@ -36,7 +57,9 @@ def self.registered(app)
             end
 
             app.post("/run_jobs/:rjid/run") do
-              Sidekiq::Belt::Community::RunJob.run_job(route_params(:rjid).to_i)
+              args = url_params("args")
+
+              Sidekiq::Belt::Community::RunJob.run_job(route_params(:rjid).to_i, args)
 
               return redirect "#{root_path}run_jobs"
             end

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

@@ -14,10 +14,35 @@
       <% 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">
+          <td colspan="2">
+            <form action="<%= root_path %>run_jobs/<%= job[:id] %>/run" class="force-run-form" method="post">
+              <%= '[' %>
+              <% (job[:args] || []).each_with_index do |arg, i| %>
+                <% if Sidekiq::Belt::Community::RunJob.dynamic_type?(arg, 'text') %>
+                  <input type="text" class="form-control" name="args[]" title="<%= arg[:title] %>" required='true' placeholder="<%= arg[:title] %>" value="<%= arg[:default] %>"  />
+                <% elsif Sidekiq::Belt::Community::RunJob.dynamic_type?(arg, 'integer') %>
+                 <input type="number" class="form-control" name="args[]" title="<%= arg[:title] %>" required='true' placeholder="<%= arg[:title] %>" value="<%= arg[:default] %>" />
+                <% elsif Sidekiq::Belt::Community::RunJob.dynamic_type?(arg, 'boolean') %>
+                  <select class="form-control" name="args[]" required='true' title="<%= arg[:title] %>" placeholder="<%= arg[:title] %>">
+                    <option value="true" <%= arg[:default] == 'true' ? 'selected' : '' %>>true</option>
+                    <option value="false" <%= arg[:default] == 'false' ? 'selected' : '' %>>false</option>
+                  </select>
+                <% elsif Sidekiq::Belt::Community::RunJob.dynamic_type?(arg, 'enum') %>
+                  <select class="form-control" name="args[]" required='true' title="<%= arg[:title] %>" placeholder="<%= arg[:title] %>">
+                    <% arg[:options].each do |option| %>
+                      <option value="<%= option %>" <%= arg[:default].to_s == option.to_s ? 'selected' : '' %>><%= option %></option>
+                    <% end %>
+                  </select>
+                <% else %>
+                  <input type="hidden" name="args[]" value="<%= arg %>" />
+                  <%= arg.inspect %>
+                <% end %>
+                <%= ',' if i < (job[:args] || []).size - 1 %>
+              <% end %>
+              <%= ']' %>
+
               <%= csrf_tag %>
+
               <input class="btn btn-danger" type="submit" name="run" value="<%= t('Run') %>"
                 data-confirm="Run the job <%= job[:klass] %>? <%= t('AreYouSure') %>" />
             </form>

lib/sidekiq/belt/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Belt
-    VERSION = "2.0.1"
+    VERSION = "2.0.2"
   end
 end