mission_control-jobs 0.1.0

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

@@ -0,0 +1,19 @@
+module MissionControl::Jobs::DatesHelper
+  def time_ago_in_words_with_title(time)
+    tag.span time_ago_in_words(time), title: time.to_fs(:long)
+  end
+
+  def time_distance_in_words_with_title(time)
+    tag.span distance_of_time_in_words_to_now(time, include_seconds: true), title: "Since #{time.to_fs(:long)}"
+  end
+
+  def bidirectional_time_distance_in_words_with_title(time)
+    time_distance = if time.past?
+      "#{distance_of_time_in_words_to_now(time, include_seconds: true)} ago"
+    else
+      "in #{distance_of_time_in_words_to_now(time, include_seconds: true)}"
+    end
+
+    tag.span time_distance, title: time.to_fs(:long)
+  end
+end

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

@@ -0,0 +1,63 @@
+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 failed_job_backtrace(job)
+    job.last_execution_error.backtrace.join("\n")
+  end
+
+  def attribute_names_for_job_status(status)
+    case status.to_s
+    when "failed"      then [ "Error", "" ]
+    when "blocked"     then [ "Queue", "Blocked by", "Block expiry" ]
+    when "finished"    then [ "Queue", "Finished" ]
+    when "scheduled"   then [ "Queue", "Scheduled" ]
+    when "in_progress" then [ "Queue", "Run by", "Running for" ]
+    else               []
+    end
+  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 ])
+      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"]
+      else
+        ActiveJob::Arguments.deserialize([ argument ])
+      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,51 @@
+module MissionControl::Jobs::NavigationHelper
+  attr_reader :page_title, :current_section
+
+  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?
+    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_filter_param
+    if @job_filters&.any?
+      { filter: @job_filters }
+    else
+      {}
+    end
+  end
+
+  def jobs_count_with_status(status)
+    count = ApplicationJob.jobs.with_status(status).count
+    count.infinite? ? "..." : number_to_human(count)
+  end
+end

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

@@ -0,0 +1,23 @@
+module MissionControl::Jobs::UiHelper
+  def blank_status_notice(message)
+    tag.div message, class: "mt-6 has-text-centered is-size-3 has-text-grey"
+  end
+
+  def blank_status_emoji(status)
+    case status.to_s
+    when "failed", "blocked" then "😌"
+    else ""
+    end
+  end
+
+  def modifier_for_status(status)
+    case status.to_s
+    when "failed"      then "is-danger"
+    when "blocked"     then "is-warning"
+    when "finished"    then "is-success"
+    when "scheduled"   then "is-info"
+    when "in_progress" then "is-primary"
+    else "is-primary is-light"
+    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/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/jobs/mission_control/jobs/application_job.rb

@@ -0,0 +1,6 @@
+module MissionControl
+  module Jobs
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/mission_control/jobs/application_mailer.rb

@@ -0,0 +1,8 @@
+module MissionControl
+  module Jobs
+    class ApplicationMailer < ActionMailer::Base
+      default from: "from@example.com"
+      layout "mailer"
+    end
+  end
+end

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/page.rb

@@ -0,0 +1,48 @@
+class MissionControl::Jobs::Page
+  DEFAULT_PAGE_SIZE = 10
+
+  attr_reader :jobs_relation, :index, :page_size
+
+  def initialize(jobs_relation, page: 1, page_size: DEFAULT_PAGE_SIZE)
+    @jobs_relation = jobs_relation
+    @page_size = page_size
+    @index = [ page, 1 ].max
+  end
+
+  def jobs
+    jobs_relation.limit(page_size).offset(offset)
+  end
+
+  def first?
+    index == 1
+  end
+
+  def last?
+    index == pages_count || empty? || jobs.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 / 10).ceil unless total_count.infinite?
+  end
+
+  def total_count
+    @total_count ||= jobs_relation.count # Potentially expensive when filtering and a lot of jobs, with 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/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,11 @@
+<nav class="navbar" role="navigation" aria-label="main navigation">
+  <div class="navbar-menu is-active">
+    <div class="navbar-start">
+    </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,25 @@
+<!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">
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.4/css/bulma.min.css">
+  <%= stylesheet_link_tag "mission_control/jobs/application", "data-turbo-track": "reload" %>
+  <%= javascript_importmap_tags "application-mcj" %>
+</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,19 @@
+<% if job.failed? %>
+  <a id="error"></a>
+  <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>
+
+  <pre class="is-family-monospace mb-4"><%= failed_job_backtrace(job) %></pre>
+<% end %>

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

@@ -0,0 +1,35 @@
+<div class="filter level-left">
+  <div class="field is-grouped">
+    <div class="control">
+      <%= 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="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..." %>
+        </div>
+
+        <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..." %>
+        </div>
+
+        <%= hidden_field_tag :server_id, MissionControl::Jobs::Current.server.id %>
+
+        <datalist id="job-classes" style="display: none;">
+          <% job_class_names.each do |job_class_name| %>
+            <option value="<%= job_class_name %>" />
+          <% end %>
+        </datalist>
+
+        <datalist id="queue-names" style="display: none;">
+          <% queue_names.each do |queue_name| %>
+            <option value="<%= queue_name %>" />
+          <% end %>
+        </datalist>
+      <% end %>
+    </div>
+
+    <div class="control">
+      <%= link_to "Clear", application_jobs_path(MissionControl::Jobs::Current.application, jobs_status, job_class_name: nil, queue_name: nil), class: "button" %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,54 @@
+<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_ago_in_words_with_title(job.enqueued_at.to_datetime) %> ago
+    </td>
+  </tr>
+  <% if job.failed? %>
+    <tr>
+      <th>Failed</th>
+      <td>
+        <%= time_ago_in_words_with_title(job.failed_at) %> ago
+      </td>
+    </tr>
+  <% end %>
+  <% if job.finished_at.present? %>
+    <tr>
+      <th>Finished at</th>
+      <td>
+        <%= time_ago_in_words_with_title(job.finished_at) %> ago
+      </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 %>
+  </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_ago_in_words_with_title(job.enqueued_at.to_datetime) %> ago</div>
+  </td>
+
+  <%= render "mission_control/jobs/jobs/#{jobs_status}/job", job: job %>
+</tr>

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

@@ -0,0 +1,15 @@
+<table class="jobs <%= jobs_status %> table queues is-hoverable is-fullwidth">
+  <tbody>
+  <thead>
+  <tr>
+    <th style="width: 35%;">Job</th>
+    <% attribute_names_for_job_status(jobs_status).each do |attribute| %>
+      <th><%= attribute %></th>
+    <% end %>
+  </tr>
+  </thead>
+
+  <%= render partial: "mission_control/jobs/jobs/job", collection: jobs_page.jobs %>
+
+  </tbody>
+</table>

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

@@ -0,0 +1,4 @@
+<h2 class="subtitle">Raw data</h2>
+<pre>
+  <%= JSON.pretty_generate(job.raw_data.without("backtrace")) %>
+</pre>

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

@@ -0,0 +1,13 @@
+<h1 class="title">
+  <div class="level">
+    <div class="level-left">
+      <%= job_title(job) %>
+      <div class="<%= modifier_for_status(job.status) %> tag ml-4"><%= job.status %></div>
+    </div>
+    <div class="level-right">
+      <% if job.failed? %>
+        <%= render "mission_control/jobs/jobs/failed/actions", job: job %>
+      <% end %>
+    </div>
+  </div>
+</h1>

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

@@ -0,0 +1,18 @@
+<div class="buttons is-right level-right">
+  <% if active_filters? %>
+    <span class="mr-5">
+      <%= jobs_count %> jobs found
+    </span>
+  <% end %>
+
+  <% if jobs_status.failed? %>
+    <% target = active_filters? ? "selection" : "all" %>
+
+    <%= button_to "Discard #{target}", application_bulk_discards_path(@application, **jobs_filter_param),
+      method: :post, disabled: jobs_count == 0, class: "button is-danger is-light",
+      form: { data: { turbo_confirm: "This will delete #{jobs_count} jobs and can't be undone. Are you sure?" } } %>
+    <%= button_to "Retry #{target}", application_bulk_retries_path(@application, **jobs_filter_param),
+      method: :post, disabled: jobs_count == 0,
+      class: "button is-warning is-light mr-0" %>
+  <% end %>
+</div>

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

@@ -0,0 +1,3 @@
+<td><%= link_to job.queue_name, application_queue_path(@application, job.queue) %></td>
+<td><div class="is-family-monospace is-size-7"><%= job.blocked_by %></div></td>
+<td><%= bidirectional_time_distance_in_words_with_title(job.blocked_until) %></td>

data/app/views/mission_control/jobs/jobs/failed/_actions.html.erb

@@ -0,0 +1,5 @@
+<div class="buttons is-right">
+  <%= button_to "Discard", application_job_discard_path(@application, job.job_id), class: "button is-danger is-light mr-0",
+    form: { data: { turbo_confirm: "This will delete the job and can't be undone. Are you sure?" } } %>
+  <%= button_to "Retry", application_job_retry_path(@application, job.job_id), class: "button is-warning is-light mr-0" %>
+</div>

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

@@ -0,0 +1,7 @@
+<td>
+  <%= link_to failed_job_error(job), application_job_path(@application, job.job_id, anchor: "error") %>
+  <div class="has-text-grey"><%= time_ago_in_words_with_title(job.failed_at) %> ago</div>
+</td>
+<td class="pr-0">
+  <%= render "mission_control/jobs/jobs/failed/actions", job: job %>
+</td>

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

@@ -0,0 +1,2 @@
+<td><%= link_to job.queue_name, application_queue_path(@application, job.queue) %></td>
+<td><div class="has-text-grey"><%= time_ago_in_words_with_title(job.finished_at) %> ago</div></td>

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

@@ -0,0 +1,9 @@
+<td><%= link_to job.queue_name, application_queue_path(@application, job.queue) %></td>
+<td>
+  <% if job.worker_id %>
+    <%= link_to "worker #{job.worker_id}", application_worker_path(@application, job.worker_id) %>
+  <% else %>
+    —
+  <% end %>
+</td>
+<td><div class="has-text-grey"><%= job.started_at ? time_distance_in_words_with_title(job.started_at) : "(Finished)" %></div></td>

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

@@ -0,0 +1,19 @@
+<% navigation(title: "#{jobs_status.titleize} jobs", section: "#{jobs_status}_jobs".to_sym) %>
+
+<% if @jobs_page.empty? && !active_filters? %>
+  <%= blank_status_notice "There are no #{jobs_status.dasherize} jobs #{blank_status_emoji(jobs_status)}" %>
+<% else %>
+  <div class="level">
+    <%= render "mission_control/jobs/jobs/filters", job_class_names: @job_class_names, queue_names: @queue_names %>
+    <%= render "mission_control/jobs/jobs/toolbar", jobs_count: @jobs_count %>
+  </div>
+
+  <% if @jobs_page.empty? %>
+    <%= blank_status_notice "No #{jobs_status.dasherize} jobs found with the given filters" %>
+  <% else %>
+    <%= render "mission_control/jobs/jobs/jobs_page", jobs_page: @jobs_page %>
+
+    <%= render "mission_control/jobs/shared/pagination_toolbar", jobs_page: @jobs_page %>
+  <% end %>
+<% end %>
+