good_job 2.14.4 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34be72b94928721447a6409e5a63aea86bc371ddcdcfa4c30316ee28dfefe59f
-  data.tar.gz: 4ca6c70f5456cb79440577c4493f17662930e7e2a259d8077248beb2e7742406
+  metadata.gz: b978264b509be9bd83e1e5e67f291b2889deff86c8316f876ab9def8264a7dd0
+  data.tar.gz: 9b4172f97c1c7406d3c51ec81f926adaca801baa004aed743a8cac757bb2ce86
 SHA512:
-  metadata.gz: 2e0d5ba7b3c0f1adee5491633292424e3e99dd8a27d4f1d3d324f6e1701c68b51042bd11ace9982b3f4c084e1f1b8a84e81d9a2642e02a5a1da4f4187883e69b
-  data.tar.gz: b22e9d91946eba8363c6c87ceb62d2cbd4e6fd29438eefd17686c42c4ef81c46e1590631326e1e0b4b376d27464ef4bf9bf3fb2573df1fd741fa6a7a0a749810
+  metadata.gz: a2696f821699ea080d2b77bb7704192222e6347d1b2be7fcf7a5e049d7b8979ceea3f5236c165fb27bb17fa5f9d8c7d2e5bb863b9c7298de9efb892facb6bca7
+  data.tar.gz: 0ab7a37d403e1bec9c0638835c903aff4a1168f33143c7c27acd87c07bf95a61c1475c3e61bea0a7590d167144761cc64b7bc81566746c854c2ae9698aa999fe

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [v2.15.0](https://github.com/bensheldon/good_job/tree/v2.15.0) (2022-05-18)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v2.14.4...v2.15.0)
+
+**Implemented enhancements:**
+
+- Adds the ability to delete jobs on the dashboard; add `cleanup_discarded_jobs` option to retain discarded jobs during cleanup [\#597](https://github.com/bensheldon/good_job/pull/597) ([TAGraves](https://github.com/TAGraves))
+- Dashboard: show more details about jobs [\#575](https://github.com/bensheldon/good_job/pull/575) ([bkeepers](https://github.com/bkeepers))
+
+**Closed issues:**
+
+- Show status on jobs\#show page [\#547](https://github.com/bensheldon/good_job/issues/547)
+
+**Merged pull requests:**
+
+- Remove ability to destroy individual Executions from Dashboard; rename "Toggle" to "Inspect" everywhere [\#601](https://github.com/bensheldon/good_job/pull/601) ([bensheldon](https://github.com/bensheldon))
+- Disable ActiveRecord Connection Reaper in test [\#600](https://github.com/bensheldon/good_job/pull/600) ([bensheldon](https://github.com/bensheldon))
+- Update README dashboard screenshot [\#599](https://github.com/bensheldon/good_job/pull/599) ([aried3r](https://github.com/aried3r))
+
 ## [v2.14.4](https://github.com/bensheldon/good_job/tree/v2.14.4) (2022-05-15)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v2.14.3...v2.14.4)

data/README.md

@@ -185,7 +185,7 @@ separate isolated execution pools with semicolons and threads with colons.
 
 #### `good_job cleanup_preserved_jobs`
 
-`good_job cleanup_preserved_jobs` deletes preserved job records. See `GoodJob.preserve_job_records` for when this command is useful.
+`good_job cleanup_preserved_jobs` destroys preserved job records. See `GoodJob.preserve_job_records` for when this command is useful.
 
 ```bash
 $ bundle exec good_job help cleanup_preserved_jobs
@@ -194,11 +194,11 @@ Usage:
   good_job cleanup_preserved_jobs
 
 Options:
-  [--before-seconds-ago=SECONDS] # Delete records finished more than this many seconds ago (env var:  GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO, default: 86400)
+  [--before-seconds-ago=SECONDS] # Destroy records finished more than this many seconds ago (env var:  GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO, default: 86400)
 
-Deletes preserved job records.
+Destroys preserved job records.
 
-By default, GoodJob deletes job records when the job is performed and this
+By default, GoodJob destroys job records when the job is performed and this
 command is not necessary.
 
 However, when `GoodJob.preserve_job_records = true`, the jobs will be
@@ -206,7 +206,7 @@ preserved in the database. This is useful when wanting to analyze or
 inspect job performance.
 
 If you are preserving job records this way, use this command regularly
-to delete old records and preserve space in your database.
+to destroy old records and preserve space in your database.
 ```
 
 ### Configuration options
@@ -269,6 +269,7 @@ Available configuration options are:
 - `shutdown_timeout` (float) number of seconds to wait for jobs to finish when shutting down before stopping the thread. Defaults to forever: `-1`. You can also set this with the environment variable `GOOD_JOB_SHUTDOWN_TIMEOUT`.
 - `enable_cron` (boolean) whether to run cron process. Defaults to `false`. You can also set this with the environment variable `GOOD_JOB_ENABLE_CRON`.
 - `cron` (hash) cron configuration. Defaults to `{}`. You can also set this as a JSON string with the environment variable `GOOD_JOB_CRON`
+- `cleanup_discarded_jobs` (boolean) whether to destroy discarded jobs when cleaning up preserved jobs using the `$ good_job cleanup_preserved_jobs` CLI command or calling `GoodJob.cleanup_preserved_jobs`. Defaults to `true`. Can also be set with  the environment variable `GOOD_JOB_CLEANUP_DISCARDED_JOBS`. _This configuration is only used when {GoodJob.preserve_job_records} is `true`._
 - `cleanup_preserved_jobs_before_seconds_ago` (integer) number of seconds to preserve jobs when using the `$ good_job cleanup_preserved_jobs` CLI command or calling `GoodJob.cleanup_preserved_jobs`. Defaults to `86400` (1 day). Can also be set with  the environment variable `GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO`.  _This configuration is only used when {GoodJob.preserve_job_records} is `true`._
 - `cleanup_interval_jobs` (integer) Number of jobs a Scheduler will execute before cleaning up preserved jobs. Defaults to `nil`. Can also be set with  the environment variable `GOOD_JOB_CLEANUP_INTERVAL_JOBS`.
 - `cleanup_interval_seconds` (integer) Number of seconds a Scheduler will wait before cleaning up preserved jobs. Defaults to `nil`. Can also be set with  the environment variable `GOOD_JOB_CLEANUP_INTERVAL_SECONDS`.
@@ -826,7 +827,7 @@ If your application is already using an ActiveJob backend, you will need to inst
 
 GoodJob is fully instrumented with [`ActiveSupport::Notifications`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#introduction-to-instrumentation).
 
-By default, GoodJob will delete job records after they are run, regardless of whether they succeed or not (raising a kind of `StandardError`), unless they are interrupted (raising a kind of `Exception`).
+By default, GoodJob will destroy job records after they are run, regardless of whether they succeed or not (raising a kind of `StandardError`), unless they are interrupted (raising a kind of `Exception`).
 
 To preserve job records for later inspection, set an initializer:
 
@@ -835,7 +836,7 @@ To preserve job records for later inspection, set an initializer:
 GoodJob.preserve_job_records = true
 ```
 
-It is also necessary to delete these preserved jobs from the database after a certain time period:
+It is also necessary to destroy these preserved jobs from the database after a certain time period:
 
 - For example, in a Rake task:
 

data/engine/app/controllers/good_job/jobs_controller.rb

@@ -7,6 +7,7 @@ module GoodJob
       discard: "discarded",
       reschedule: "rescheduled",
       retry: "retried",
+      destroy: "destroyed",
     }.freeze
 
     rescue_from GoodJob::ActiveJobJob::AdapterNotGoodJobError,
@@ -36,6 +37,8 @@ module GoodJob
           job.reschedule_job
         when :retry
           job.retry_job
+        when :destroy
+          job.destroy_job
         end
 
         job
@@ -53,9 +56,7 @@ module GoodJob
     end
 
     def show
-      @executions = GoodJob::Execution.active_job_id(params[:id])
-                                      .order(Arel.sql("COALESCE(scheduled_at, created_at) DESC"))
-      redirect_to jobs_path, alert: "Executions for Active Job #{params[:id]} not found" if @executions.empty?
+      @job = ActiveJobJob.find(params[:id])
     end
 
     def discard
@@ -76,6 +77,12 @@ module GoodJob
       redirect_back(fallback_location: jobs_path, notice: "Job has been retried")
     end
 
+    def destroy
+      @job = ActiveJobJob.find(params[:id])
+      @job.destroy_job
+      redirect_back(fallback_location: jobs_path, notice: "Job has been destroyed")
+    end
+
     private
 
     def redirect_on_error(exception)

data/engine/app/helpers/good_job/application_helper.rb

@@ -1,24 +1,54 @@
 # frozen_string_literal: true
 module GoodJob
   module ApplicationHelper
-    def relative_time(timestamp)
-      text = timestamp.future? ? "in #{time_ago_in_words(timestamp)}" : "#{time_ago_in_words(timestamp)} ago"
+    def format_duration(sec)
+      return unless sec
+
+      if sec < 1
+        t 'duration.milliseconds', ms: (sec * 1000).floor
+      elsif sec < 10
+        t 'duration.less_than_10_seconds', sec: sec.floor
+      elsif sec < 60
+        t 'duration.seconds', sec: sec.floor
+      elsif sec < 3600
+        t 'duration.minutes', min: (sec / 60).floor, sec: (sec % 60).floor
+      else
+        t 'duration.hours', hour: (sec / 3600).floor, min: ((sec % 3600) / 60).floor
+      end
+    end
+
+    def relative_time(timestamp, **args)
+      text = timestamp.future? ? "in #{time_ago_in_words(timestamp, **args)}" : "#{time_ago_in_words(timestamp, **args)} ago"
       tag.time(text, datetime: timestamp, title: timestamp)
     end
 
+    STATUS_ICONS = {
+      discarded: "exclamation",
+      finished: "check",
+      queued: "dash_circle",
+      retried: "arrow_clockwise",
+      running: "play",
+      scheduled: "clock",
+    }.freeze
+
+    STATUS_COLOR = {
+      discarded: "danger",
+      finished: "success",
+      queued: "warning",
+      retried: "secondary",
+      running: "primary",
+      scheduled: "secondary",
+    }.freeze
+
     def status_badge(status)
-      classes = case status
-                when :finished
-                  "badge rounded-pill bg-success"
-                when :queued, :scheduled, :retried
-                  "badge rounded-pill bg-secondary"
-                when :running
-                  "badge rounded-pill bg-primary"
-                when :discarded
-                  "badge rounded-pill bg-danger"
-                end
+      content_tag :span, status_icon(status, class: "text-white") + t(status, scope: '.status'),
+                  class: "badge rounded-pill bg-#{STATUS_COLOR.fetch(status)} d-inline-flex gap-2 ps-1 pe-3 align-items-center"
+    end
 
-      content_tag :span, status.to_s, class: classes
+    def status_icon(status, **options)
+      options[:class] ||= "text-#{STATUS_COLOR.fetch(status)}"
+      icon = render_icon STATUS_ICONS.fetch(status)
+      content_tag :span, icon, **options
     end
 
     def render_icon(name)

data/engine/app/views/good_job/cron_entries/index.html.erb

@@ -27,7 +27,7 @@
               <td class="font-monospace"><%= cron_entry.key %></td>
               <td class="font-monospace"><%= cron_entry.schedule %></td>
               <td>
-                <%= tag.button("Preview", type: "button", class: "btn btn-sm btn-outline-primary", role: "button",
+                <%= tag.button("Inspect", type: "button", class: "btn btn-sm btn-outline-primary", role: "button",
                         data: { bs_toggle: "collapse", bs_target: "##{dom_id(cron_entry, 'properties')}" },
                         aria: { expanded: false, controls: dom_id(cron_entry, 'properties') }) %>
                 <%= tag.pre(JSON.pretty_generate(cron_entry.display_properties), id: dom_id(cron_entry, 'properties'), class: "collapse cron-entry-properties") %>

data/engine/app/views/good_job/jobs/_executions.erb

@@ -0,0 +1,46 @@
+<h5>Executions</h5>
+<div class="card mb-4" data-live-poll-region="executions-table">
+  <div class="list-group list-group-flush">
+    <% executions.each do |execution| %>
+      <%= tag.div id: dom_id(execution), class: "list-group-item py-3" do %>
+        <div class="d-md-flex">
+          <div class="flex-fill">
+            <div class="small text-muted">
+              #<%= execution.number %>:
+              <%= tag.code link_to(execution.id, "##{dom_id(execution)}", class: "text-muted text-decoration-none") %>
+            </div>
+            <div class="d-flex gap-2 align-items-center text-muted mt-1">
+              <%= status_badge execution.status %>
+              <%= relative_time execution.last_status_at, include_seconds: true %>
+
+              <% if execution.runtime_latency %>
+                • <div><%= format_duration execution.runtime_latency %> runtime</div>
+              <% end %>
+              <% if execution.queue_latency %>
+                • <div><%= format_duration execution.queue_latency %> in queue</div>
+              <% end %>
+            </div>
+          </div>
+          <div>
+            <div class="mt-4 d-flex gap-2">
+              <%= tag.button type: "button", class: "btn btn-sm btn-outline-primary", role: "button",
+                data: { bs_toggle: "collapse", bs_target: "##{dom_id(execution, 'params')}" },
+                aria: { expanded: false, controls: dom_id(execution, "params") } do %>
+                Inspect
+              <% end %>
+            </div>
+          </div>
+        </div>
+        <% if execution.error %>
+          <div class="mt-3">
+            <strong class="small">Error:</strong>
+            <pre class="text-wrap text-break m-0"><%= execution.error %></pre>
+          </div>
+        <% end %>
+        <div>
+          <%= tag.pre JSON.pretty_generate(execution.serialized_params), id: dom_id(execution, "params"), class: "collapse bg-light card card-body p-3 my-3" %>
+        </div>
+      <% end %>
+    <% end %>
+  </div>
+</div>

data/engine/app/views/good_job/jobs/_table.erb

@@ -34,6 +34,10 @@
                 <%= form.button type: 'submit', name: 'mass_action', value: 'retry', class: 'btn btn-sm btn-outline-primary', title: "Retry all", data: { confirm: "Confirm retry all", disable: true } do %>
                   <%= render_icon "arrow_clockwise" %> All
                 <% end %>
+
+                <%= form.button type: 'submit', name: 'mass_action', value: 'destroy', class: 'btn btn-sm btn-outline-primary', title: "Destroy all", data: { confirm: "Confirm destroy all", disable: true } do %>
+                  <%= render_icon "trash" %> All
+                <% end %>
               </div>
             </th>
           </tr>
@@ -63,7 +67,7 @@
                 <td><%= job.executions_count %></td>
                 <td class="text-break"><%= truncate(job.recent_error, length: 1_000) %></td>
                 <td>
-                  <%= tag.button "Preview", type: "button", class: "btn btn-sm btn-outline-primary", role: "button",
+                  <%= tag.button "Inspect", type: "button", class: "btn btn-sm btn-outline-primary", role: "button",
                                  data: { bs_toggle: "collapse", bs_target: "##{dom_id(job, 'params')}" },
                                  aria: { expanded: false, controls: dom_id(job, "params") }
                   %>
@@ -94,6 +98,14 @@
                     <% else %>
                       <button class="btn btn-sm btn-outline-secondary" disabled><%= render_icon "arrow_clockwise" %></button>
                     <% end %>
+
+                    <% if job.status.in? [:discarded, :finished] %>
+                      <%= link_to job_path(job.id), method: :delete, class: "btn btn-sm btn-outline-primary", title: "Destroy job", data: { confirm: "Confirm destroy", disable: true } do %>
+                        <%= render_icon "trash" %>
+                      <% end %>
+                    <% else %>
+                      <button class="btn btn-sm btn-outline-secondary" disabled><%= render_icon "trash" %></button>
+                    <% end %>
                   </div>
                 </td>
               </tr>

data/engine/app/views/good_job/jobs/show.html.erb

@@ -1,3 +1,57 @@
-<h1 class="mb-3">ActiveJob ID: <code><%= @executions.first.id %></code></h1>
+<div class="break-out bg-light border-bottom py-2 mb-3">
+  <div class="container-fluid pt-2">
+    <div class="d-flex align-items-center">
+      <div class="flex-fill">
+        <nav aria-label="breadcrumb">
+          <ol class="breadcrumb small mb-0">
+            <li class="breadcrumb-item"><%= link_to "Jobs", jobs_path %></li>
+            <li class="breadcrumb-item active" aria-current="page">ActiveJob ID: <%= tag.code @job.id %></li>
+          </ol>
+        </nav>
+        <h2 class="mb-1"><%= tag.code @job.job_class %></h2>
+        <div class="text-muted small d-flex gap-2">
+            <div>Queue: <%= tag.strong @job.queue_name %></div>
+            •
+            <div>Priority: <%= tag.strong @job.priority %></div>
+        </div>
+      </div>
+      <div>
+        <% job_reschedulable = @job.status.in? [:scheduled, :retried, :queued] %>
+        <%= button_to reschedule_job_path(@job.id), method: :put,
+            class: "btn btn-sm #{job_reschedulable ? 'btn-outline-primary' : 'btn-outline-secondary'}",
+            form_class: "d-inline-block",
+            disabled: !job_reschedulable,
+            aria: { label: "Reschedule job" },
+            title: "Reschedule job",
+            data: { confirm: "Confirm reschedule" } do %>
+          <%= render_icon "skip_forward" %>
+          Reschedule
+        <% end %>
 
-<%= render 'good_job/executions/table', executions: @executions %>
+        <% job_discardable = @job.status.in? [:scheduled, :retried, :queued] %>
+        <%= button_to discard_job_path(@job.id), method: :put, class: "btn btn-sm #{job_discardable ? 'btn-outline-primary' : 'btn-outline-secondary'}", form_class: "d-inline-block", disabled: !job_discardable, aria: { label: "Discard job" }, title: "Discard job", data: { confirm: "Confirm discard" } do %>
+          <%= render_icon "stop" %>
+          Discard
+        <% end %>
+
+        <%= button_to retry_job_path(@job.id), method: :put, class: "btn btn-sm #{@job.status == :discarded ? 'btn-outline-primary' : 'btn-outline-secondary'}", form_class: "d-inline-block", disabled: @job.status != :discarded, aria: { label: "Retry job" }, title: "Retry job", data: { confirm: "Confirm retry" } do %>
+          <%= render_icon "arrow_clockwise" %>
+          Retry
+        <% end %>
+
+        <% job_destroyable = @job.status.in? [:discarded, :finished] %>
+        <%= button_to job_path(@job.id), method: :delete, class: "btn btn-sm #{job_destroyable ? 'btn-outline-primary' : 'btn-outline-secondary'}", form_class: "d-inline-block", disabled: !job_destroyable, aria: { label: "Destroy job" }, title: "Destroy job", data: { confirm: "Confirm destroy" } do %>
+          <%= render_icon "trash" %>
+          Destroy
+        <% end %>
+      </div>
+    </div>
+  </div>
+</div>
+
+<div class="my-4">
+  <h5>Arguments</h5>
+  <%= tag.pre @job.serialized_params["arguments"].map(&:inspect).join(', ') %>
+</div>
+
+<%= render 'executions', executions: @job.executions.reverse %>

data/engine/app/views/good_job/shared/_filter.erb

@@ -10,7 +10,7 @@
       <% filter.states.each do |name, count| %>
         <li class="nav-item">
           <%= link_to url_for({state: name}), class: "nav-link #{"active" if params[:state] == name}" do %>
-            <%= name.titleize %>
+            <%= t(name, scope: '.status') %>
             <span class="badge bg-primary rounded-pill <%= "bg-secondary" if count == 0 %>"><%= count %></span>
           <% end %>
         </li>

data/engine/app/views/good_job/shared/icons/_check.html.erb

@@ -1,4 +1,5 @@
-<!-- https://icons.getbootstrap.com/icons/check-circle-fill/ -->
-<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-check-circle-fill <%= local_assigns[:class] %>" viewBox="0 0 16 16">
-  <path d="M16 8A8 8 0 1 1 0 8a8 8 0 0 1 16 0zm-3.97-3.03a.75.75 0 0 0-1.08.022L7.477 9.417 5.384 7.323a.75.75 0 0 0-1.06 1.06L6.97 11.03a.75.75 0 0 0 1.079-.02l3.992-4.99a.75.75 0 0 0-.01-1.05z" />
+<!-- https://icons.getbootstrap.com/icons/check-circle/ -->
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-check-circle" viewBox="0 0 16 16">
+  <path d="M8 15A7 7 0 1 1 8 1a7 7 0 0 1 0 14zm0 1A8 8 0 1 0 8 0a8 8 0 0 0 0 16z" />
+  <path d="M10.97 4.97a.235.235 0 0 0-.02.022L7.477 9.417 5.384 7.323a.75.75 0 0 0-1.06 1.06L6.97 11.03a.75.75 0 0 0 1.079-.02l3.992-4.99a.75.75 0 0 0-1.071-1.05z" />
 </svg>

data/engine/app/views/good_job/shared/icons/_clock.html.erb

@@ -0,0 +1,5 @@
+<!-- https://icons.getbootstrap.com/icons/clock/ -->
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clock" viewBox="0 0 16 16">
+  <path d="M8 3.5a.5.5 0 0 0-1 0V9a.5.5 0 0 0 .252.434l3.5 2a.5.5 0 0 0 .496-.868L8 8.71V3.5z" />
+  <path d="M8 16A8 8 0 1 0 8 0a8 8 0 0 0 0 16zm7-8A7 7 0 1 1 1 8a7 7 0 0 1 14 0z" />
+</svg>

data/engine/app/views/good_job/shared/icons/_dash_circle.html.erb

@@ -0,0 +1,5 @@
+<!-- https://icons.getbootstrap.com/icons/dash-circle/ -->
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-dash-circle" viewBox="0 0 16 16">
+  <path d="M8 15A7 7 0 1 1 8 1a7 7 0 0 1 0 14zm0 1A8 8 0 1 0 8 0a8 8 0 0 0 0 16z" />
+  <path d="M4 8a.5.5 0 0 1 .5-.5h7a.5.5 0 0 1 0 1h-7A.5.5 0 0 1 4 8z" />
+</svg>

data/engine/app/views/good_job/shared/icons/_exclamation.html.erb

@@ -1,4 +1,5 @@
-<!-- https://icons.getbootstrap.com/icons/exclamation-triangle-fill/ -->
-<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-exclamation-triangle-fill <%= local_assigns[:class] %>" viewBox="0 0 16 16">
-  <path d="M8.982 1.566a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535 0 .954.462.9.995l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 5.995A.905.905 0 0 1 8 5zm.002 6a1 1 0 1 1 0 2 1 1 0 0 1 0-2z" />
+<!-- https://icons.getbootstrap.com/icons/exclamation-circle/ -->
+<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-exclamation-circle" viewBox="0 0 16 16">
+  <path d="M8 15A7 7 0 1 1 8 1a7 7 0 0 1 0 14zm0 1A8 8 0 1 0 8 0a8 8 0 0 0 0 16z" />
+  <path d="M7.002 11a1 1 0 1 1 2 0 1 1 0 0 1-2 0zM7.1 4.995a.905.905 0 1 1 1.8 0l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 4.995z" />
 </svg>

data/engine/config/locales/en.yml

@@ -39,6 +39,12 @@ en:
       x_years:
         one: 1 year
         other: "%{count} years"
+  duration:
+    hours: "%{hour}h %{min}m"
+    less_than_10_seconds: "%{sec}s"
+    milliseconds: "%{ms}ms"
+    minutes: "%{min}m %{sec}s"
+    seconds: "%{sec}s"
   good_job:
     shared:
       footer:
@@ -50,3 +56,10 @@ en:
         live_poll: Live Poll
         name: "GoodJob 👍"
         processes: Processes
+    status:
+      discarded: Discarded
+      finished: Finished
+      queued: Queued
+      retried: Retried
+      running: Running
+      scheduled: Scheduled

data/engine/config/locales/es.yml

@@ -39,6 +39,12 @@ es:
       x_years:
         one: 1 año
         other: "%{count} años"
+  duration:
+    hours: "%{hour}h %{min}m"
+    less_than_10_seconds: "%{sec}s"
+    milliseconds: "%{ms}ms"
+    minutes: "%{min}m %{sec}s"
+    seconds: "%{sec}s"
   good_job:
     shared:
       footer:
@@ -50,3 +56,10 @@ es:
         live_poll: En vivo
         name: "GoodJob 👍"
         processes: Procesos
+    status:
+      discarded: Descartado
+      finished: Acabado
+      queued: Puesto en cola
+      retried: reintentado
+      running: Corriendo
+      scheduled: Programado

data/engine/config/locales/nl.yml

@@ -39,6 +39,12 @@ nl:
       x_years:
         one: 1 jaar
         other: "%{count} jaren"
+  duration:
+    hours: "%{hour}h %{min}m"
+    less_than_10_seconds: "%{sec}s"
+    milliseconds: "%{ms}ms"
+    minutes: "%{min}m %{sec}s"
+    seconds: "%{sec}s"
   good_job:
     shared:
       footer:
@@ -50,3 +56,10 @@ nl:
         live_poll: Live Poll
         name: "GoodJob 👍"
         processes: Processen
+    status:
+      discarded: weggegooid
+      finished: Afgewerkt
+      queued: In de wachtrij
+      retried: Opnieuw geprobeerd
+      running: Rennen
+      scheduled: Gepland

data/engine/config/locales/ru.yml

@@ -63,6 +63,12 @@ ru:
         many: "%{count} лет"
         one: 1 год
         other: "%{count} года"
+  duration:
+    hours: "%{hour}h %{min}m"
+    less_than_10_seconds: "%{sec}s"
+    milliseconds: "%{ms}мс"
+    minutes: "%{min}м %{sec}с"
+    seconds: "%{sec}s"
   good_job:
     shared:
       footer:
@@ -74,3 +80,10 @@ ru:
         live_poll: Живой Опрос
         name: "GoodJob 👍"
         processes: Процессы
+    status:
+      discarded: Отброшено
+      finished: Законченный
+      queued: В очереди
+      retried: Повторная попытка
+      running: Бег
+      scheduled: по расписанию

data/engine/config/routes.rb

@@ -2,9 +2,7 @@
 GoodJob::Engine.routes.draw do
   root to: redirect(path: 'jobs')
 
-  resources :executions, only: %i[destroy]
-
-  resources :jobs, only: %i[index show] do
+  resources :jobs, only: %i[index show destroy] do
     collection do
       get :mass_update, to: redirect(path: 'jobs')
       put :mass_update

data/lib/good_job/active_job_job.rb

@@ -54,9 +54,11 @@ module GoodJob
     # Advisory locked and executing
     scope :running, -> { where(finished_at: nil).joins_advisory_locks.where.not(pg_locks: { locktype: nil }) }
     # Completed executing successfully
-    scope :finished, -> { where.not(finished_at: nil).where(error: nil) }
+    scope :finished, -> { not_discarded.where.not(finished_at: nil) }
     # Errored but will not be retried
     scope :discarded, -> { where.not(finished_at: nil).where.not(error: nil) }
+    # Not errored
+    scope :not_discarded, -> { where(error: nil) }
 
     # The job's ActiveJob UUID
     # @return [String]
@@ -71,38 +73,8 @@ module GoodJob
     end
 
     # The status of the Job, based on the state of its most recent execution.
-    # There are 3 buckets of non-overlapping statuses:
-    #   1. The job will be executed
-    #     - queued: The job will execute immediately when an execution thread becomes available.
-    #     - scheduled: The job is scheduled to execute in the future.
-    #     - retried: The job previously errored on execution and will be re-executed in the future.
-    #   2. The job is being executed
-    #     - running: the job is actively being executed by an execution thread
-    #   3. The job will not execute
-    #     - finished: The job executed successfully
-    #     - discarded: The job previously errored on execution and will not be re-executed in the future.
-    #
     # @return [Symbol]
-    def status
-      execution = head_execution
-      if execution.finished_at.present?
-        if execution.error.present?
-          :discarded
-        else
-          :finished
-        end
-      elsif (execution.scheduled_at || execution.created_at) > DateTime.current
-        if execution.serialized_params.fetch('executions', 0) > 1
-          :retried
-        else
-          :scheduled
-        end
-      elsif running?
-        :running
-      else
-        :queued
-      end
-    end
+    delegate :status, :last_status_at, to: :head_execution
 
     # This job's most recent {Execution}
     # @param reload [Booelan] whether to reload executions
@@ -225,6 +197,18 @@ module GoodJob
       end
     end
 
+    # Destroy all of a discarded or finished job's executions from the database so that it will no longer appear on the dashboard.
+    # @return [void]
+    def destroy_job
+      with_advisory_lock do
+        execution = head_execution(reload: true)
+
+        raise ActionForStateMismatchError if execution.finished_at.blank?
+
+        destroy
+      end
+    end
+
     # Utility method to determine which execution record is used to represent this job
     # @return [String]
     def _execution_id

data/lib/good_job/cli.rb

@@ -120,11 +120,11 @@ module GoodJob
     default_task :start
 
     # @!macro thor.desc
-    desc :cleanup_preserved_jobs, "Deletes preserved job records."
+    desc :cleanup_preserved_jobs, "Destroys preserved job records."
     long_desc <<~DESCRIPTION
-      Deletes preserved job records.
+      Destroys preserved job records.
 
-      By default, GoodJob deletes job records when the job is performed and this
+      By default, GoodJob destroys job records when the job is performed and this
       command is not necessary.
 
       However, when `GoodJob.preserve_job_records = true`, the jobs will be
@@ -132,13 +132,13 @@ module GoodJob
       inspect job performance.
 
       If you are preserving job records this way, use this command regularly
-      to delete old records and preserve space in your database.
+      to destroy old records and preserve space in your database.
 
     DESCRIPTION
     method_option :before_seconds_ago,
                   type: :numeric,
                   banner: 'SECONDS',
-                  desc: "Delete records finished more than this many seconds ago (env var: GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO, default: 86400)"
+                  desc: "Destroy records finished more than this many seconds ago (env var: GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO, default: 86400)"
 
     def cleanup_preserved_jobs
       set_up_application!

data/lib/good_job/configuration.rb

@@ -171,6 +171,16 @@ module GoodJob
       cron.map { |cron_key, params| GoodJob::CronEntry.new(params.merge(key: cron_key)) }
     end
 
+    # Whether to destroy discarded jobs when cleaning up preserved jobs.
+    # This configuration is only used when {GoodJob.preserve_job_records} is +true+.
+    # @return [Boolean]
+    def cleanup_discarded_jobs?
+      return rails_config[:cleanup_discarded_jobs] unless rails_config[:cleanup_discarded_jobs].nil?
+      return ActiveModel::Type::Boolean.new.cast(env['GOOD_JOB_CLEANUP_DISCARDED_JOBS']) unless env['GOOD_JOB_CLEANUP_DISCARDED_JOBS'].nil?
+
+      true
+    end
+
     # Number of seconds to preserve jobs when using the +good_job cleanup_preserved_jobs+ CLI command.
     # This configuration is only used when {GoodJob.preserve_job_records} is +true+.
     # @return [Integer]

data/lib/good_job/execution.rb

@@ -88,7 +88,7 @@ module GoodJob
     # @return [ActiveRecord::Relation]
     scope :priority_ordered, -> { order('priority DESC NULLS LAST') }
 
-    # Order jobs by scheduled (unscheduled or soonest first).
+    # Order jobs by scheduled or created (oldest first).
     # @!method schedule_ordered
     # @!scope class
     # @return [ActiveRecord::Relation]
@@ -96,7 +96,7 @@ module GoodJob
 
     # Get Jobs were completed before the given timestamp. If no timestamp is
     # provided, get all jobs that have been completed. By default, GoodJob
-    # deletes jobs after they are completed and this will find no jobs.
+    # destroys jobs after they are completed and this will find no jobs.
     # However, if you have changed {GoodJob.preserve_job_records}, this may
     # find completed Jobs.
     # @!method finished(timestamp = nil)
@@ -272,6 +272,65 @@ module GoodJob
       end
     end
 
+    # There are 3 buckets of non-overlapping statuses:
+    #   1. The job will be executed
+    #     - queued: The job will execute immediately when an execution thread becomes available.
+    #     - scheduled: The job is scheduled to execute in the future.
+    #     - retried: The job previously errored on execution and will be re-executed in the future.
+    #   2. The job is being executed
+    #     - running: the job is actively being executed by an execution thread
+    #   3. The job will not execute
+    #     - finished: The job executed successfully
+    #     - discarded: The job previously errored on execution and will not be re-executed in the future.
+    #
+    # @return [Symbol]
+    def status
+      if finished_at.present?
+        if error.present?
+          :discarded
+        else
+          :finished
+        end
+      elsif (scheduled_at || created_at) > DateTime.current
+        if serialized_params.fetch('executions', 0) > 1
+          :retried
+        else
+          :scheduled
+        end
+      elsif running?
+        :running
+      else
+        :queued
+      end
+    end
+
+    def running?
+      performed_at? && !finished_at?
+    end
+
+    def number
+      serialized_params.fetch('executions', 0) + 1
+    end
+
+    # The last relevant timestamp for this execution
+    def last_status_at
+      finished_at || performed_at || scheduled_at || created_at
+    end
+
+    # Time between when this job was expected to run and when it started running
+    def queue_latency
+      now = Time.zone.now
+      expected_start = scheduled_at || created_at
+      actual_start = performed_at || now
+
+      actual_start - expected_start unless expected_start >= now
+    end
+
+    # Time between when this job started and finished
+    def runtime_latency
+      (finished_at || Time.zone.now) - performed_at if performed_at
+    end
+
     private
 
     def active_job_data

data/lib/good_job/job_performer.rb

@@ -57,7 +57,7 @@ module GoodJob
       job_query.next_scheduled_at(after: after, limit: limit, now_limit: now_limit)
     end
 
-    # Delete expired preserved jobs
+    # Destroy expired preserved jobs
     # @return [void]
     def cleanup
       GoodJob.cleanup_preserved_jobs

data/lib/good_job/log_subscriber.rb

@@ -140,10 +140,10 @@ module GoodJob
     # @!macro notification_responder
     def cleanup_preserved_jobs(event)
       timestamp = event.payload[:timestamp]
-      deleted_records_count = event.payload[:deleted_records_count]
+      destroyed_records_count = event.payload[:destroyed_records_count]
 
       info do
-        "GoodJob deleted #{deleted_records_count} preserved #{'job'.pluralize(deleted_records_count)} finished before #{timestamp}."
+        "GoodJob destroyed #{destroyed_records_count} preserved #{'job'.pluralize(destroyed_records_count)} finished before #{timestamp}."
       end
     end
 

data/lib/good_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module GoodJob
   # GoodJob gem version.
-  VERSION = '2.14.4'
+  VERSION = '2.15.0'
 end

data/lib/good_job.rb

@@ -43,7 +43,7 @@ module GoodJob
   # @!attribute [rw] preserve_job_records
   #   @!scope class
   #   Whether to preserve job records in the database after they have finished (default: +false+).
-  #   By default, GoodJob deletes job records after the job is completed successfully.
+  #   By default, GoodJob destroys job records after the job is completed successfully.
   #   If you want to preserve jobs for latter inspection, set this to +true+.
   #   If you want to preserve only jobs that finished with error for latter inspection, set this to +:on_unhandled_error+.
   #   If +true+, you will need to clean out jobs using the +good_job cleanup_preserved_jobs+ CLI command or
@@ -126,25 +126,28 @@ module GoodJob
     end
   end
 
-  # Deletes preserved job records.
-  # By default, GoodJob deletes job records when the job is performed and this
+  # Destroys preserved job records.
+  # By default, GoodJob destroys job records when the job is performed and this
   # method is not necessary. However, when `GoodJob.preserve_job_records = true`,
   # the jobs will be preserved in the database. This is useful when wanting to
   # analyze or inspect job performance.
   # If you are preserving job records this way, use this method regularly to
-  # delete old records and preserve space in your database.
-  # @params older_than [nil,Numeric,ActiveSupport::Duration] Jobs older than this will be deleted (default: +86400+).
-  # @return [Integer] Number of jobs that were deleted.
+  # destroy old records and preserve space in your database.
+  # @params older_than [nil,Numeric,ActiveSupport::Duration] Jobs older than this will be destroyed (default: +86400+).
+  # @return [Integer] Number of jobs that were destroyed.
   def self.cleanup_preserved_jobs(older_than: nil)
-    older_than ||= GoodJob::Configuration.new({}).cleanup_preserved_jobs_before_seconds_ago
+    configuration = GoodJob::Configuration.new({})
+    older_than ||= configuration.cleanup_preserved_jobs_before_seconds_ago
     timestamp = Time.current - older_than
+    include_discarded = configuration.cleanup_discarded_jobs?
 
     ActiveSupport::Notifications.instrument("cleanup_preserved_jobs.good_job", { older_than: older_than, timestamp: timestamp }) do |payload|
       old_jobs = GoodJob::ActiveJobJob.where('finished_at <= ?', timestamp)
+      old_jobs = old_jobs.not_discarded unless include_discarded
       old_jobs_count = old_jobs.count
 
-      GoodJob::Execution.where(job: old_jobs).delete_all
-      payload[:deleted_records_count] = old_jobs_count
+      GoodJob::Execution.where(job: old_jobs).destroy_all
+      payload[:destroyed_records_count] = old_jobs_count
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 2.14.4
+  version: 2.15.0
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-15 00:00:00.000000000 Z
+date: 2022-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -377,7 +377,6 @@ files:
 - engine/app/controllers/good_job/application_controller.rb
 - engine/app/controllers/good_job/assets_controller.rb
 - engine/app/controllers/good_job/cron_entries_controller.rb
-- engine/app/controllers/good_job/executions_controller.rb
 - engine/app/controllers/good_job/jobs_controller.rb
 - engine/app/controllers/good_job/processes_controller.rb
 - engine/app/filters/good_job/base_filter.rb
@@ -385,7 +384,7 @@ files:
 - engine/app/helpers/good_job/application_helper.rb
 - engine/app/views/good_job/cron_entries/index.html.erb
 - engine/app/views/good_job/cron_entries/show.html.erb
-- engine/app/views/good_job/executions/_table.erb
+- engine/app/views/good_job/jobs/_executions.erb
 - engine/app/views/good_job/jobs/_table.erb
 - engine/app/views/good_job/jobs/index.html.erb
 - engine/app/views/good_job/jobs/show.html.erb
@@ -397,6 +396,8 @@ files:
 - engine/app/views/good_job/shared/_navbar.erb
 - engine/app/views/good_job/shared/icons/_arrow_clockwise.html.erb
 - engine/app/views/good_job/shared/icons/_check.html.erb
+- engine/app/views/good_job/shared/icons/_clock.html.erb
+- engine/app/views/good_job/shared/icons/_dash_circle.html.erb
 - engine/app/views/good_job/shared/icons/_exclamation.html.erb
 - engine/app/views/good_job/shared/icons/_play.html.erb
 - engine/app/views/good_job/shared/icons/_skip_forward.html.erb

data/engine/app/controllers/good_job/executions_controller.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-module GoodJob
-  class ExecutionsController < GoodJob::ApplicationController
-    def destroy
-      deleted_count = GoodJob::Execution.where(id: params[:id]).delete_all
-      message = deleted_count.positive? ? { notice: "Job execution deleted" } : { alert: "Job execution not deleted" }
-      redirect_back fallback_location: jobs_path, **message
-    end
-  end
-end

data/engine/app/views/good_job/executions/_table.erb

@@ -1,62 +0,0 @@
-<div class="my-3" data-live-poll-region="executions-table">
-  <div class="table-responsive">
-    <table class="table table-hover table-sm mb-0" id="executions_index_table">
-      <thead>
-        <tr>
-          <th>ActiveJob ID</th>
-          <th>Execution ID</th>
-          <th>Job Class</th>
-          <th>Queue</th>
-          <th>Scheduled At</th>
-          <th>Error</th>
-          <th>
-            ActiveJob Params&nbsp;
-            <%= tag.button "Toggle", type: "button", class: "btn btn-sm btn-outline-primary", role: "button",
-                           data: { bs_toggle: "collapse", bs_target: ".job-params" },
-                           aria: { expanded: false, controls: executions.map { |execution| "##{dom_id(execution, "params")}" }.join(" ") }
-            %>
-          </th>
-          <th>Actions</th>
-        </tr>
-      </thead>
-      <tbody>
-        <% if executions.present? %>
-          <% executions.each do |execution| %>
-            <tr id="<%= dom_id(execution) %>">
-              <td>
-                <%= link_to job_path(execution.serialized_params['job_id']) do %>
-                  <code><%= execution.active_job_id %></code>
-                <% end %>
-              </td>
-              <td>
-                <%= link_to job_path(execution.active_job_id, anchor: dom_id(execution)) do %>
-                  <code><%= execution.id %></code>
-                <% end %>
-              </td>
-              <td><%= execution.serialized_params['job_class'] %></td>
-              <td><%= execution.queue_name %></td>
-              <td><%= relative_time(execution.scheduled_at || execution.created_at) %></td>
-              <td class="text-break"><%= truncate(execution.error, length: 1_000) %></td>
-              <td>
-                <%= tag.button "Preview", type: "button", class: "btn btn-sm btn-outline-primary", role: "button",
-                  data: { bs_toggle: "collapse", bs_target: "##{dom_id(execution, 'params')}" },
-                  aria: { expanded: false, controls: dom_id(execution, "params") }
-                %>
-                <%= tag.pre JSON.pretty_generate(execution.serialized_params), id: dom_id(execution, "params"), class: "collapse job-params" %>
-              </td>
-              <td>
-                <%= button_to execution_path(execution.id), method: :delete, class: "btn btn-sm btn-outline-danger", title: "Delete execution", data: { confirm: "Confirm delete" } do %>
-                  <%= render_icon "trash" %>
-                <% end %>
-              </td>
-            </tr>
-          <% end %>
-        <% else %>
-          <tr>
-            <td colspan="8" class="py-2 text-center text-muted">No executions found.</td>
-          </tr>
-        <% end %>
-      </tbody>
-    </table>
-  </div>
-</div>