solid_job_monitor 1.0.0

data/app/helpers/mission_control/jobs/jobs_helper.rb

@@ -0,0 +1,94 @@
+module MissionControl::Jobs::JobsHelper
+  def job_title(job)
+    job.job_class_name
+  end
+
+  def job_arguments(job)
+    renderable_job_arguments_for(job).join(", ")
+  end
+
+  def failed_job_error(job)
+    "#{job.last_execution_error.error_class}: #{job.last_execution_error.message}"
+  end
+
+  def clean_backtrace?
+    params["clean_backtrace"] == "true"
+  end
+
+  def failed_job_backtrace(job, server)
+    if clean_backtrace? && server&.backtrace_cleaner
+      server.backtrace_cleaner.clean(job.last_execution_error.backtrace).join("\n")
+    else
+      job.last_execution_error.backtrace.join("\n")
+    end
+  end
+
+  def attribute_names_for_job_status(status)
+    case status.to_s
+    when "failed"      then [ "Error", "" ]
+    when "blocked"     then [ "Queue", "Blocked by", "" ]
+    when "finished"    then [ "Queue", "Finished" ]
+    when "scheduled"   then [ "Queue", "Scheduled", "" ]
+    when "in_progress" then [ "Queue", "Run by", "Running for", "Progress", "" ]
+    else               []
+    end
+  end
+
+  def job_delayed?(job)
+    job.scheduled_at.before?(MissionControl::Jobs.scheduled_job_delay_threshold.ago)
+  end
+
+  def blocked_job_expiration(job)
+    "Expires #{bidirectional_time_distance_in_words_with_title(job.blocked_until)}".html_safe if job.blocked_until
+  end
+
+  def job_progress_enabled?
+    MissionControl::Jobs::Progress.available?
+  end
+
+  def progress_for(job)
+    @progress_by_job_id&.[](job.job_id) || @progress
+  end
+
+  private
+    def renderable_job_arguments_for(job)
+      job.serialized_arguments.collect do |argument|
+        as_renderable_argument(argument)
+      end
+    end
+
+    def as_renderable_argument(argument)
+      case argument
+      when Hash
+        as_renderable_hash(argument)
+      when Array
+        as_renderable_array(argument)
+      else
+        ActiveJob::Arguments.deserialize([ argument ]).first
+      end
+    rescue ActiveJob::DeserializationError
+      argument.to_s
+    end
+
+    def as_renderable_hash(argument)
+      if argument["_aj_globalid"]
+        # don't deserialize as the class might not exist in the host app running the engine
+        argument["_aj_globalid"]
+      elsif argument["_aj_serialized"] == "ActiveJob::Serializers::ModuleSerializer"
+        argument["value"]
+      elsif argument["_aj_serialized"]
+        ActiveJob::Arguments.deserialize([ argument ]).first
+      else
+        MissionControl::Jobs.job_arguments_filter.apply_to(argument)
+          .without("_aj_symbol_keys", "_aj_ruby2_keywords")
+          .transform_values { |v| as_renderable_argument(v) }
+          .map { |k, v| "#{k}: #{v}" }
+          .join(", ")
+          .then { |s| "{#{s}}" }
+      end
+    end
+
+    def as_renderable_array(argument)
+      "[#{argument.collect { |part| as_renderable_argument(part) }.join(", ")}]"
+    end
+end

data/app/helpers/mission_control/jobs/navigation_helper.rb

@@ -0,0 +1,60 @@
+module MissionControl::Jobs::NavigationHelper
+  attr_reader :page_title, :current_section
+
+  def back_to_main_app_path
+    MissionControl::Jobs.back_to_main_app_path.presence || main_app.try(:root_path)
+  end
+
+  def navigation_sections
+    { queues: [ "Queues", application_queues_path(@application) ] }.tap do |sections|
+      supported_job_statuses.without(:pending).each do |status|
+         sections[navigation_section_for_status(status)] = [ "#{status.to_s.titleize} jobs (#{jobs_count_with_status(status)})", application_jobs_path(@application, status) ]
+      end
+
+      sections[:workers] = [ "Workers", application_workers_path(@application) ] if workers_exposed?
+      sections[:recurring_tasks] = [ "Recurring tasks", application_recurring_tasks_path(@application) ] if recurring_tasks_supported?
+    end
+  end
+
+  def navigation_section_for_status(status)
+    if status.nil? || status == :pending
+      :queues
+    else
+      "#{status}_jobs".to_sym
+    end
+  end
+
+  def navigation(title: nil, section: nil)
+    @page_title = title
+    @current_section = section
+  end
+
+  def selected_application?(application)
+    MissionControl::Jobs::Current.application.name == application.name
+  end
+
+  def selectable_applications
+    MissionControl::Jobs.applications.reject { |app| selected_application?(app) }
+  end
+
+  def selected_server?(server)
+    MissionControl::Jobs::Current.server.name == server.name
+  end
+
+  def jobs_count_with_status(status)
+    count = ActiveJob.jobs.with_status(status).count
+    if count.infinite?
+      "..."
+    else
+      number_to_human(count,
+        format: "%n%u",
+        units: {
+          thousand: "K",
+          million: "M",
+          billion: "B",
+          trillion: "T",
+          quadrillion: "Q"
+        })
+    end
+  end
+end

data/app/javascript/mission_control/jobs/application.js

@@ -0,0 +1,4 @@
+// Configure your import map in config/importmap.rb. Read more: https://github.com/rails/importmap-rails
+import "@hotwired/turbo-rails"
+import "controllers"
+import "helpers"

data/app/javascript/mission_control/jobs/controllers/application.js

@@ -0,0 +1,9 @@
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.debug = false
+window.Stimulus   = application
+
+export { application }

data/app/javascript/mission_control/jobs/controllers/form_controller.js

@@ -0,0 +1,21 @@
+import { Controller } from "@hotwired/stimulus"
+import { debounce } from "helpers"
+
+export default class extends Controller {
+  static values = {
+    debounceTimeout: { type: Number, default: 300 }
+  }
+
+  initialize() {
+    this.debouncedSubmit = debounce(this.debouncedSubmit.bind(this), this.debounceTimeoutValue)
+  }
+
+  submit(event) {
+    const form = event.target.form || event.target.closest("form")
+    if (form) form.requestSubmit()
+  }
+
+  debouncedSubmit(event) {
+    this.submit(event)
+  }
+}

data/app/javascript/mission_control/jobs/controllers/index.js

@@ -0,0 +1,11 @@
+// Import and register all your controllers from the importmap under controllers/*
+
+import { application } from "controllers/application"
+
+// Eager load all controllers defined in the import map under controllers/**/*_controller
+import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
+eagerLoadControllersFrom("controllers", application)
+
+// Lazy load controllers as they appear in the DOM (remember not to preload controllers in import map!)
+// import { lazyLoadControllersFrom } from "@hotwired/stimulus-loading"
+// lazyLoadControllersFrom("controllers", application)

data/app/javascript/mission_control/jobs/controllers/progress_controller.js

@@ -0,0 +1,55 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = [ "bar", "label", "stopping" ]
+  static values = {
+    url: String,
+    percent: { type: Number, default: 0 },
+    interval: { type: Number, default: 2000 }
+  }
+
+  connect() {
+    this.apply({ percent: this.percentValue, stop_requested: this.hasStoppingTarget && !this.stoppingTarget.classList.contains("is-hidden") })
+    this.timer = setInterval(() => this.refresh(), this.intervalValue)
+  }
+
+  disconnect() {
+    if (this.timer) clearInterval(this.timer)
+  }
+
+  async refresh() {
+    try {
+      const response = await fetch(this.urlValue, {
+        headers: { Accept: "application/json" }
+      })
+
+      if (!response.ok) {
+        this.disconnect()
+        return
+      }
+
+      const data = await response.json()
+      if (data.missing) {
+        this.disconnect()
+        return
+      }
+
+      this.apply(data)
+
+      if (data.percent === 100) this.disconnect()
+    } catch (_error) {
+      this.disconnect()
+    }
+  }
+
+  apply(data) {
+    const percent = Number.isFinite(data.percent) ? data.percent : 0
+
+    if (this.hasBarTarget) this.barTarget.style.width = `${percent}%`
+    if (this.hasLabelTarget) this.labelTarget.textContent = `${percent}%`
+
+    if (this.hasStoppingTarget) {
+      this.stoppingTarget.classList.toggle("is-hidden", !data.stop_requested)
+    }
+  }
+}

data/app/javascript/mission_control/jobs/helpers/debounce_helpers.js

@@ -0,0 +1,9 @@
+export function debounce(fn, delay = 10) {
+  let timeoutId = null
+
+  return (...args) => {
+    const callback = () => fn.apply(this, args)
+    clearTimeout(timeoutId)
+    timeoutId = setTimeout(callback, delay)
+  }
+}

data/app/javascript/mission_control/jobs/helpers/index.js

@@ -0,0 +1 @@
+export * from "helpers/debounce_helpers"

data/app/models/mission_control/jobs/application_record.rb

@@ -0,0 +1,7 @@
+module MissionControl
+  module Jobs
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/mission_control/jobs/current.rb

@@ -0,0 +1,3 @@
+class MissionControl::Jobs::Current < ActiveSupport::CurrentAttributes
+  attribute :application, :server
+end

data/app/models/mission_control/jobs/job_progress.rb

@@ -0,0 +1,7 @@
+module MissionControl
+  module Jobs
+    class JobProgress < ApplicationRecord
+      self.table_name = "mission_control_job_progresses"
+    end
+  end
+end

data/app/models/mission_control/jobs/page.rb

@@ -0,0 +1,48 @@
+class MissionControl::Jobs::Page
+  DEFAULT_PAGE_SIZE = 10
+
+  attr_reader :records, :index, :page_size
+
+  def initialize(relation, page: 1, page_size: DEFAULT_PAGE_SIZE)
+    @relation = relation
+    @page_size = page_size
+    @index = [ page, 1 ].max
+  end
+
+  def records
+    @relation.limit(page_size).offset(offset)
+  end
+
+  def first?
+    index == 1
+  end
+
+  def last?
+    index == pages_count || empty? || records.empty?
+  end
+
+  def empty?
+    total_count == 0
+  end
+
+  def previous_index
+    [ index - 1, 1 ].max
+  end
+
+  def next_index
+    pages_count ? [ index + 1, pages_count ].min : index + 1
+  end
+
+  def pages_count
+    (total_count.to_f / page_size).ceil unless total_count.infinite?
+  end
+
+  def total_count
+    @total_count ||= @relation.count # Potentially expensive when filtering a lot of records, with the adapter in charge of doing the filtering in memory
+  end
+
+  private
+    def offset
+      (index - 1) * page_size
+    end
+end

data/app/models/mission_control/jobs/recurring_task.rb

@@ -0,0 +1,25 @@
+class MissionControl::Jobs::RecurringTask
+  include ActiveModel::Model
+
+  attr_accessor :id, :job_class_name, :command, :arguments, :schedule, :last_enqueued_at, :next_time, :queue_name, :priority
+
+  def initialize(queue_adapter: ActiveJob::Base.queue_adapter, **kwargs)
+    @queue_adapter = queue_adapter
+    super(**kwargs)
+  end
+
+  def jobs
+    ActiveJob::JobsRelation.new(queue_adapter: queue_adapter).where(recurring_task_id: id)
+  end
+
+  def enqueue
+    queue_adapter.enqueue_recurring_task(id)
+  end
+
+  def runnable?
+    queue_adapter.can_enqueue_recurring_task?(id)
+  end
+
+  private
+    attr_reader :queue_adapter
+end

data/app/models/mission_control/jobs/worker.rb

@@ -0,0 +1,17 @@
+class MissionControl::Jobs::Worker
+  include ActiveModel::Model
+
+  attr_accessor :id, :name, :hostname, :last_heartbeat_at, :configuration, :raw_data
+
+  def initialize(queue_adapter: ActiveJob::Base.queue_adapter, **kwargs)
+    @queue_adapter = queue_adapter
+    super(**kwargs)
+  end
+
+  def jobs
+    @jobs ||= ActiveJob::JobsRelation.new(queue_adapter: queue_adapter).in_progress.where(worker_id: id)
+  end
+
+  private
+    attr_reader :queue_adapter
+end

data/app/views/layouts/mission_control/jobs/_application_selection.html.erb

@@ -0,0 +1,14 @@
+<nav class="navbar" role="navigation" aria-label="main navigation">
+  <div class="navbar-menu is-active mb-4">
+    <div class="navbar-start">
+      <% if (path = back_to_main_app_path) %>
+        <%= link_to "Back to main app", path %>
+      <% end %>
+    </div>
+
+    <div class="navbar-end">
+      <%= render "layouts/mission_control/jobs/application_selection/servers", application: @application %>
+      <%= render "layouts/mission_control/jobs/application_selection/applications" if selectable_applications.any? %>
+    </div>
+  </div>
+</nav>

data/app/views/layouts/mission_control/jobs/_flash.html.erb

@@ -0,0 +1,9 @@
+<% flash.each do |name, message| -%>
+  <% message_class = { notice: "is-success", alert: "is-danger" }[name.to_sym] %>
+
+  <article class="message <%= message_class %>">
+    <div class="message-body">
+      <%= message %>
+    </div>
+  </article>
+<% end -%>

data/app/views/layouts/mission_control/jobs/_navigation.html.erb

@@ -0,0 +1,9 @@
+<div class="tabs is-boxed">
+  <ul>
+    <% navigation_sections.each do |key, (label, url)| %>
+      <li class="<%= "is-active" if key == current_section %>">
+        <%= link_to label, url %>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/app/views/layouts/mission_control/jobs/application.html.erb

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Mission control - <%= page_title %></title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <meta name="turbo-cache-control" content="no-cache">
+
+  <%= stylesheet_link_tag "mission_control/jobs/bulma.min" %>
+  <%= stylesheet_link_tag "mission_control/jobs/application", "data-turbo-track": "reload" %>
+  <%= javascript_importmap_tags "application", importmap: MissionControl::Jobs.importmap  %>
+</head>
+<body>
+
+<section class="section">
+  <div class="container">
+    <%= render "layouts/mission_control/jobs/application_selection" %>
+    <%= render "layouts/mission_control/jobs/flash" %>
+    <%= render "layouts/mission_control/jobs/navigation" %>
+    <%= yield %>
+  </div>
+</section>
+
+</body>
+</html>

data/app/views/layouts/mission_control/jobs/application_selection/_applications.html.erb

@@ -0,0 +1,13 @@
+<div class="application-selector navbar-item has-dropdown is-hoverable">
+  <a class="navbar-link">
+    <%= MissionControl::Jobs::Current.application.name %>
+  </a>
+
+  <div class="navbar-dropdown">
+    <% selectable_applications.each do |application| %>
+      <%= link_to application_queues_path(application, server_id: nil), class: "navbar-item" do %>
+        <span><%= application.name %></span>
+      <% end %>
+    <% end %>
+  </div>
+</div>

data/app/views/layouts/mission_control/jobs/application_selection/_servers.html.erb

@@ -0,0 +1,15 @@
+<% if application.servers.many? %>
+  <div class="server-selector navbar-item">
+    <div class="tabs is-toggle is-toggle-rounded is-small">
+      <ul>
+        <% application.servers.each do |server| %>
+          <li class="<%= "is-active" if selected_server?(server) %>">
+            <%= link_to application_queues_path(application, server_id: server) do %>
+              <span><%= server.name %></span>
+            <% end %>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  </div>
+<% end %>

data/app/views/mission_control/jobs/jobs/_error_information.html.erb

@@ -0,0 +1,22 @@
+<% if job.failed? %>
+  <h2 class="subtitle">Error information</h2>
+
+  <table class="table">
+    <tbody>
+    <tr>
+      <th>Type</th>
+      <td> <%= job.last_execution_error.error_class %> </td>
+    </tr>
+    <tr>
+      <th>Message</th>
+      <td> <%= job.last_execution_error.try(:message) || job.last_execution_error.inspect %> </td>
+    </tr>
+    </tbody>
+  </table>
+
+  <% if @server.backtrace_cleaner %>
+    <%= render "mission_control/jobs/jobs/failed/backtrace_toggle", application: @application, job: job %>
+  <% end %>
+
+  <pre class="is-family-monospace mb-4 backtrace-content"><%= failed_job_backtrace(job, @server) %></pre>
+<% end %>

data/app/views/mission_control/jobs/jobs/_filters.html.erb

@@ -0,0 +1,55 @@
+<div class="filter level-left">
+  <%= form_for :filter, url: application_jobs_path(MissionControl::Jobs::Current.application, jobs_status), method: :get,
+    data: { controller: "form", action: "input->form#debouncedSubmit" } do |form| %>
+
+    <div class="field is-grouped">
+      <div class="control">
+        <%= form.label :job_class_name, class: "label" %>
+        <div class="select is-rounded">
+          <%= form.text_field :job_class_name, value: @job_filters[:job_class_name], class: "input", list: "job-classes", placeholder: "Filter by job class...", autocomplete: "off" %>
+        </div>
+      </div>
+
+      <div class="control">
+        <%= form.label :queue_name, class: "label" %>
+        <div class="select is-rounded">
+          <%= form.text_field :queue_name, value: @job_filters[:queue_name], class: "input", list: "queue-names", placeholder: "Filter by queue name...", autocomplete: "off" %>
+        </div>
+      </div>
+
+      <% if jobs_status == "finished" %>
+        <div class="control">
+          <%= form.label :finished_at_start, class: "label" %>
+          <div class="select is-rounded">
+            <%= form.datetime_field :finished_at_start, value: @job_filters[:finished_at]&.begin, class: "input", placeholder: "Finished from" %>
+          </div>
+        </div>
+
+        <div class="control">
+          <%= form.label :finished_at_end, class: "label" %>
+          <div class="select is-rounded">
+            <%= form.datetime_field :finished_at_end, value: @job_filters[:finished_at]&.end, class: "input", placeholder: "Finished to" %>
+          </div>
+        </div>
+      <% end %>
+
+      <%= hidden_field_tag :server_id, MissionControl::Jobs::Current.server.id %>
+
+      <datalist id="job-classes" class="is-hidden">
+        <% job_class_names.each do |job_class_name| %>
+          <option value="<%= job_class_name %>"></option>
+        <% end %>
+      </datalist>
+
+      <datalist id="queue-names" class="is-hidden">
+        <% queue_names.each do |queue_name| %>
+          <option value="<%= queue_name %>"></option>
+        <% end %>
+      </datalist>
+
+      <div class="control is-align-self-flex-end">
+        <%= link_to "Clear", application_jobs_path(MissionControl::Jobs::Current.application, jobs_status, job_class_name: nil, queue_name: nil, finished_at: nil..nil), class: "button" %>
+      </div>
+    </div>
+  <% end %>
+</div>

data/app/views/mission_control/jobs/jobs/_general_information.html.erb

@@ -0,0 +1,85 @@
+<table class="table">
+  <tbody>
+  <tr>
+    <th>Arguments</th>
+    <td>
+      <div class="is-family-monospace">
+        <%= job_arguments(job) %>
+      </div>
+    </td>
+  </tr>
+  <tr>
+    <th>Job id</th>
+    <td><%= job.job_id %></td>
+  </tr>
+  <tr>
+    <th>Queue</th>
+    <td>
+      <div class="tag">
+        <%= link_to job.queue_name, application_queue_path(@application, job.queue) %>
+      </div>
+    </td>
+  </tr>
+  <tr>
+    <th>Enqueued</th>
+    <td>
+      <%= time_distance_in_words_with_title(job.enqueued_at.to_datetime) %> ago
+    </td>
+  </tr>
+  <% if job.executions > 0 %>
+    <tr>
+      <th>Retries</th>
+      <td><%= job.executions %></td>
+    </tr>
+  <% end %>
+  <% if job.scheduled? %>
+    <tr>
+      <th>Scheduled</th>
+      <td>
+        <%= bidirectional_time_distance_in_words_with_title(job.scheduled_at) %>
+        <% if job_delayed?(job) %>
+          <div class="is-danger tag ml-4">delayed</div>
+        <% end %>
+      </td>
+    </tr>
+  <% end %>
+  <% if job.failed? %>
+    <tr>
+      <th>Failed</th>
+      <td>
+        <%= time_distance_in_words_with_title(job.failed_at) %> ago
+      </td>
+    </tr>
+  <% end %>
+  <% if job.finished_at.present? %>
+    <tr>
+      <th>Finished</th>
+      <td>
+        <%= time_distance_in_words_with_title(job.finished_at) %> ago
+      </td>
+    </tr>
+    <tr>
+      <th>Duration</th>
+      <td>
+        <%= job.duration.round(3) %> seconds
+      </td>
+    </tr>
+  <% end %>
+  <% if job.worker_id.present? %>
+    <tr>
+      <th>Processed by</th>
+      <td>
+        <%= link_to "worker #{job.worker_id}", application_worker_path(@application, job.worker_id) %>
+      </td>
+    </tr>
+  <% end %>
+  <% if job.in_progress? || progress_for(job) %>
+    <tr>
+      <th>Progress</th>
+      <td>
+        <%= render "mission_control/jobs/jobs/progress_bar", progress: progress_for(job), job: job %>
+      </td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>

data/app/views/mission_control/jobs/jobs/_job.html.erb

@@ -0,0 +1,13 @@
+<tr class="job">
+  <td>
+    <%= link_to job_title(job), application_job_path(@application, job.job_id) %>
+
+    <% if job.serialized_arguments.present? %>
+      <div class="is-family-monospace"><%= job_arguments(job) %></div>
+    <% end %>
+
+    <div class="has-text-grey is-size-7">Enqueued <%= time_distance_in_words_with_title(job.enqueued_at.to_datetime) %> ago</div>
+  </td>
+
+  <%= render "mission_control/jobs/jobs/#{jobs_status}/job", job: job %>
+</tr>