sidekiq-tasks 1.1.0 → 1.2.0

data/lib/sidekiq/tasks.rb

@@ -3,15 +3,19 @@
 require "rake"
 
 require_relative "tasks/errors"
+require_relative "tasks/validations"
+require_relative "tasks/sidekiq_options_validator"
+require_relative "tasks/magic_comments"
 require_relative "tasks/storage"
 require_relative "tasks/strategies"
-require_relative "tasks/validations"
 require_relative "tasks/version"
 
 module Sidekiq
   module Tasks
     autoload :Config, "sidekiq/tasks/config"
     autoload :Job, "sidekiq/tasks/job"
+    autoload :Report, "sidekiq/tasks/run"
+    autoload :Run, "sidekiq/tasks/run"
     autoload :Set, "sidekiq/tasks/set"
     autoload :Task, "sidekiq/tasks/task"
     autoload :TaskMetadata, "sidekiq/tasks/task_metadata"
@@ -32,6 +36,19 @@ module Sidekiq
       def tasks
         @_tasks ||= Sidekiq::Tasks::Set.new(strategies.flat_map(&:tasks))
       end
+
+      # @return [Sidekiq::Tasks::Run] The run of the task being executed, see Sidekiq::Tasks::Run.current.
+      def current_run
+        Sidekiq::Tasks::Run.current
+      end
+
+      def dry_run?
+        current_run.dry_run?
+      end
+
+      def report
+        current_run.report
+      end
     end
   end
 end

data/web/assets/tasks/css/components/alerts.css

@@ -0,0 +1,25 @@
+.st-alert {
+  display: block;
+  padding: 12px 16px;
+  border-radius: 6px;
+  border: 1px solid transparent;
+  margin: 12px 0;
+  font-size: 13px;
+  line-height: 1.5;
+}
+
+.st-alert.failure {
+  color: var(--badge-failure-text);
+  background-color: var(--badge-failure-bg);
+  border-color: var(--badge-failure-border);
+}
+
+.st-alert-title {
+  font-weight: 600;
+  margin-bottom: 4px;
+}
+
+.st-alert-body code {
+  display: inline-block;
+  word-break: break-all;
+}

data/web/assets/tasks/css/components/report.css

@@ -0,0 +1,70 @@
+:root {
+  --badge-dry-run-text: #5b3a8c;
+  --badge-dry-run-bg: #efe6fb;
+  --badge-dry-run-border: #d3c0f0;
+  --st-warning-text: #8a6d1d;
+}
+
+@media (prefers-color-scheme: dark) {
+  :root {
+    --badge-dry-run-text: #d3c0f0;
+    --badge-dry-run-bg: #2c2140;
+    --badge-dry-run-border: #5b3a8c;
+    --st-warning-text: #f5e6ab;
+  }
+}
+
+.st-status-badge.dry-run {
+  color: var(--badge-dry-run-text);
+  background-color: var(--badge-dry-run-bg);
+  border-color: var(--badge-dry-run-border);
+}
+
+.st-report-value {
+  margin-right: 12px;
+  white-space: nowrap;
+}
+
+.st-report-row details {
+  padding: 4px 0 8px;
+}
+
+.st-report-row summary {
+  cursor: pointer;
+  list-style: none;
+}
+
+.st-report-row summary::-webkit-details-marker {
+  display: none;
+}
+
+.st-report-row summary::before {
+  content: "▸ ";
+}
+
+.st-report-row details[open] > summary::before {
+  content: "▾ ";
+}
+
+.st-report-list {
+  max-height: 400px;
+  overflow-y: auto;
+  margin-bottom: 8px;
+}
+
+.st-report-table {
+  margin: 0;
+}
+
+.st-checkbox-label {
+  display: flex;
+  align-items: center;
+  gap: 8px;
+  font-weight: bold;
+  font-size: 14px;
+}
+
+.st-warning {
+  color: var(--st-warning-text);
+  margin: 0;
+}

data/web/assets/tasks/css/ext.css

@@ -6,3 +6,5 @@
 @import url("components/pagination.css");
 @import url("components/status_badges.css");
 @import url("components/tooltips.css");
+@import url("components/alerts.css");
+@import url("components/report.css");

data/web/locales/en.yml

@@ -27,3 +27,13 @@ en:
   failure: "Failure"
   enqueued_by: "Enqueued by"
   task_time: "%m/%d/%y %H:%M:%S"
+  options: "Options"
+  task_broken_title: "This task cannot be executed"
+  task_broken_message: "One of its magic comments is invalid:"
+  result: "Result"
+  dry_run: "Dry run"
+  dry_run_hint: "Uncheck to execute the task for real."
+  dry_run_unsupported: "This task does not handle dry run mode: it will be executed for real."
+  report_details: "Report details"
+  report_items_shown: "%{shown} displayed out of %{count}"
+  report_truncated: "Report truncated (size limit reached)"

data/web/locales/fr.yml

@@ -27,3 +27,13 @@ fr:
   failure: "Echec"
   enqueued_by: "Lancée par"
   task_time: "%d/%m/%y %H:%M:%S"
+  options: "Options"
+  task_broken_title: "Cette tâche ne peut pas être exécutée"
+  task_broken_message: "Un de ses magic comments est invalide :"
+  result: "Résultat"
+  dry_run: "Simulation"
+  dry_run_hint: "Décocher pour exécuter réellement la tâche."
+  dry_run_unsupported: "Cette tâche ne gère pas le mode simulation : elle sera exécutée réellement."
+  report_details: "Détail du rapport"
+  report_items_shown: "%{shown} affichés sur %{count}"
+  report_truncated: "Rapport tronqué (limite de taille atteinte)"

data/web/views/task.erb

@@ -14,6 +14,17 @@
   <h1><%= t("task") %></h1>
 </header>
 
+<% if task.error? %>
+  <div class="st-alert failure">
+    <div class="st-alert-title"><%= t("task_broken_title") %></div>
+    <div class="st-alert-body">
+      <%= t("task_broken_message") %>
+      <br>
+      <code><%= task.error %></code>
+    </div>
+  </div>
+<% end %>
+
 <table class="st-table">
   <tbody>
     <tr>
@@ -28,6 +39,12 @@
       <th><%= t("strategy") %></th>
       <td><%= task.strategy.name %></td>
     </tr>
+    <% unless task.error? || task.sidekiq_options.empty? %>
+      <tr>
+        <th><%= t("options") %></th>
+        <td><code><%= format_task_sidekiq_options(task) %></code></td>
+      </tr>
+    <% end %>
     <tr>
       <th><%= t("last_enqueued") %></th>
       <td><%= task.last_enqueue_at ? relative_time(task.last_enqueue_at) : "-" %></td>
@@ -57,18 +74,20 @@
         <th><%= t("executed") %></th>
         <th><%= t("duration") %></th>
         <th><%= t("status") %></th>
+        <th><%= t("result") %></th>
       </tr>
       </thead>
       <tbody>
-        <% history_entries.each do |jid_history| %>
+        <% history_entries.each_with_index do |jid_history, index| %>
+          <% report = jid_history["report"] || {} %>
           <tr>
             <td><%= jid_history["jid"] %></td>
             <td>
-              <code><%= jid_history["args"] %></code>
+              <code><%= ERB::Util.html_escape(jid_history["args"]) %></code>
             </td>
             <% if Sidekiq::Tasks.config.current_user %>
               <td>
-                <code><%= jid_history["user"] || "-" %></code>
+                <code><%= ERB::Util.html_escape(jid_history["user"] || "-") %></code>
               </td>
             <% end %>
             <td>
@@ -87,8 +106,59 @@
                 class: "st-status-badge #{task_status(jid_history)}",
                 "data-tooltip": jid_history["error"]
               ) %>
+              <% if jid_history["dry_run"] %>
+                <span class="st-status-badge dry-run"><%= t("dry_run") %></span>
+              <% end %>
+            </td>
+            <td class="st-report-values">
+              <% (report["values"] || {}).each do |key, value| %>
+                <span class="st-report-value">
+                  <strong><%= ERB::Util.html_escape(key) %></strong> <%= ERB::Util.html_escape(value) %>
+                </span>
+              <% end %>
+              <% if report["truncated"] %>
+                <small class="st-warning"><%= t("report_truncated") %></small>
+              <% end %>
             </td>
           </tr>
+          <% if report["lists"]&.any? %>
+            <tr class="st-report-row">
+              <td colspan="<%= Sidekiq::Tasks.config.current_user ? 8 : 7 %>">
+                <details <%= "open" if index.zero? && history_page == 1 %>>
+                  <summary><%= t("report_details") %></summary>
+                  <% report["lists"].each do |key, list| %>
+                    <% columns = report_list_columns(list["items"]) %>
+                    <h4>
+                      <%= ERB::Util.html_escape(key) %> (<%= list["count"] %>)
+                      <% if list["items"].size < list["count"] %>
+                        <small><%= t("report_items_shown", shown: list["items"].size, count: list["count"]) %></small>
+                      <% end %>
+                    </h4>
+                    <div class="st-report-list">
+                    <table class="st-table st-report-table">
+                      <% if columns %>
+                        <thead>
+                          <tr><% columns.each do |column| %><th><%= ERB::Util.html_escape(column) %></th><% end %></tr>
+                        </thead>
+                      <% end %>
+                      <tbody>
+                        <% list["items"].each do |item| %>
+                          <tr>
+                            <% if columns %>
+                              <% columns.each do |column| %><td><%= ERB::Util.html_escape(item[column]) %></td><% end %>
+                            <% else %>
+                              <td><%= ERB::Util.html_escape(item) %></td>
+                            <% end %>
+                          </tr>
+                        <% end %>
+                      </tbody>
+                    </table>
+                    </div>
+                  <% end %>
+                </details>
+              </td>
+            </tr>
+          <% end %>
         <% end %>
       </tbody>
     </table>
@@ -106,6 +176,7 @@
   <% end %>
 </div>
 
+<% unless task.error? %>
 <header class="">
   <div class="">
     <h2><%= t("run_task") %></h2>
@@ -124,6 +195,18 @@
     <% end %>
   </div>
 
+  <div class="st-form-group-full">
+    <% if task.dry_run_supported? %>
+      <label class="st-checkbox-label">
+        <input type="checkbox" id="dryRunInput" name="dry_run" value="1" checked>
+        <%= t("dry_run") %>
+      </label>
+      <small><%= t("dry_run_hint") %></small>
+    <% else %>
+      <p class="st-warning"><%= t("dry_run_unsupported") %></p>
+    <% end %>
+  </div>
+
   <div class="st-form-group-full">
     <label for="envConfirmationInput" class="st-label">
       <%= t("env_confirmation", current_env: current_env) %>
@@ -143,6 +226,7 @@
     <%= t("enqueue") %>
   </button>
 </form>
+<% end %>
 
 <% if Sidekiq::Tasks::Web::SIDEKIQ_GTE_7_3_0 %>
   <%= script_tag "tasks/js/env_confirmation.js" %>

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-tasks
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
-- Victor
+- Capsens
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -223,7 +237,7 @@ description: |
   Sidekiq Tasks is an extension for Sidekiq that provides an interface for launching tasks.
   Natively supports rake tasks and can be easily extended to support other task execution systems.
 email:
-- authiatv@gmail.com
+- contact@capsens.eu
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -243,7 +257,20 @@ files:
 - lib/sidekiq/tasks/config.rb
 - lib/sidekiq/tasks/errors.rb
 - lib/sidekiq/tasks/job.rb
+- lib/sidekiq/tasks/magic_comments.rb
+- lib/sidekiq/tasks/magic_comments/comment.rb
+- lib/sidekiq/tasks/magic_comments/comments.rb
+- lib/sidekiq/tasks/magic_comments/handlers/base.rb
+- lib/sidekiq/tasks/magic_comments/handlers/disable.rb
+- lib/sidekiq/tasks/magic_comments/handlers/dry_run.rb
+- lib/sidekiq/tasks/magic_comments/handlers/enable.rb
+- lib/sidekiq/tasks/magic_comments/handlers/sidekiq_options.rb
+- lib/sidekiq/tasks/magic_comments/registration.rb
+- lib/sidekiq/tasks/magic_comments/registry.rb
+- lib/sidekiq/tasks/magic_comments/scanner.rb
+- lib/sidekiq/tasks/run.rb
 - lib/sidekiq/tasks/set.rb
+- lib/sidekiq/tasks/sidekiq_options_validator.rb
 - lib/sidekiq/tasks/storage.rb
 - lib/sidekiq/tasks/storage/base.rb
 - lib/sidekiq/tasks/storage/redis.rb
@@ -270,9 +297,11 @@ files:
 - lib/sidekiq/tasks/web/params.rb
 - lib/sidekiq/tasks/web/search.rb
 - sig/sidekiq/tasks.rbs
+- web/assets/tasks/css/components/alerts.css
 - web/assets/tasks/css/components/buttons.css
 - web/assets/tasks/css/components/forms.css
 - web/assets/tasks/css/components/pagination.css
+- web/assets/tasks/css/components/report.css
 - web/assets/tasks/css/components/status_badges.css
 - web/assets/tasks/css/components/tables.css
 - web/assets/tasks/css/components/tooltips.css
@@ -286,13 +315,14 @@ files:
 - web/views/_pagination.erb
 - web/views/task.erb
 - web/views/tasks.erb
-homepage: https://github.com/victorauthiat/sidekiq-tasks
+homepage: https://github.com/CapSens/sidekiq-tasks
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/victorauthiat/sidekiq-tasks
-  source_code_uri: https://github.com/victorauthiat/sidekiq-tasks/blob/master
-  changelog_uri: https://github.com/victorauthiat/sidekiq-tasks/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/CapSens/sidekiq-tasks
+  source_code_uri: https://github.com/CapSens/sidekiq-tasks/blob/master
+  changelog_uri: https://github.com/CapSens/sidekiq-tasks/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib