flight_control 2.0.0.beta.2 → 2.0.0.beta.3

data/app/assets/stylesheets/flight_control/forms.css

@@ -0,0 +1,8 @@
+/* Hide the HTML datalist wonky arrow in Safari and Chrome, since we add it via bulma. */
+[list]::-webkit-calendar-picker-indicator {
+    opacity: 0;
+}
+
+a[disabled] {
+    pointer-events: none;
+}

data/app/assets/stylesheets/flight_control/jobs.css

@@ -0,0 +1,42 @@
+.filter,
+.filter form {
+    max-width: 100%;
+    min-width: 0;
+}
+
+.filter input {
+    width: 15rem;
+}
+
+table.jobs {
+    td {
+        word-break: break-all;
+    }
+    th.job-header{
+        width: 30%;
+    }
+    th.duration-header {
+        width: 20%;
+    }
+    &.queues th.job-header {
+        width: 30%;
+    }
+    &.failed th.job-header {
+        width: 35%;
+    }
+    &.in_progress th.job-header {
+        width: 50%;
+    }
+    &.blocked th.job-header {
+        width: 45%;
+    }
+    &.scheduled th.job-header {
+        width: 40%;
+    }
+    &.finished th.job-header {
+        width: 65%;
+    }
+    &.workers th.job-header {
+        width: 40%;
+    }
+}

data/app/controllers/concerns/flight_control/adapter_features.rb

@@ -0,0 +1,25 @@
+module FlightControl::AdapterFeatures
+  extend ActiveSupport::Concern
+
+  included do
+    helper_method :supported_job_statuses, :queue_pausing_supported?, :workers_exposed?, :recurring_tasks_supported?
+  end
+
+  private
+
+  def supported_job_statuses
+    FlightControl::Current.server.queue_adapter.supported_job_statuses & ActiveJob::JobsRelation::STATUSES
+  end
+
+  def queue_pausing_supported?
+    FlightControl::Current.server.queue_adapter.supports_queue_pausing?
+  end
+
+  def workers_exposed?
+    FlightControl::Current.server.queue_adapter.exposes_workers?
+  end
+
+  def recurring_tasks_supported?
+    FlightControl::Current.server.queue_adapter.supports_recurring_tasks?
+  end
+end

data/app/controllers/concerns/flight_control/application_scoped.rb

@@ -0,0 +1,39 @@
+module FlightControl::ApplicationScoped
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :set_application
+    around_action :activating_job_server
+
+    delegate :applications, to: FlightControl
+  end
+
+  private
+
+  def set_application
+    @application = find_application or raise FlightControl::Errors::ResourceNotFound, "Application not found"
+    FlightControl::Current.application = @application
+  end
+
+  def find_application
+    if params[:application_id]
+      applications[params[:application_id]]
+    else
+      applications.first
+    end
+  end
+
+  def activating_job_server(&block)
+    @server = find_server or raise FlightControl::Errors::ResourceNotFound, "Server not found"
+    FlightControl::Current.server = @server
+    @server.activating(&block)
+  end
+
+  def find_server
+    if params[:server_id]
+      FlightControl::Current.application.servers[params[:server_id]]
+    else
+      @application.servers.first
+    end
+  end
+end

data/app/controllers/concerns/flight_control/basic_authentication.rb

@@ -0,0 +1,34 @@
+module FlightControl::BasicAuthentication
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :authenticate_by_http_basic
+  end
+
+  private
+
+  def authenticate_by_http_basic
+    if http_basic_authentication_enabled?
+      if http_basic_authentication_configured?
+        http_basic_authenticate_or_request_with(**http_basic_authentication_credentials)
+      else
+        head :unauthorized
+      end
+    end
+  end
+
+  def http_basic_authentication_enabled?
+    FlightControl.http_basic_auth_enabled
+  end
+
+  def http_basic_authentication_configured?
+    http_basic_authentication_credentials.values.all?(&:present?)
+  end
+
+  def http_basic_authentication_credentials
+    {
+      name: FlightControl.http_basic_auth_user,
+      password: FlightControl.http_basic_auth_password
+    }.transform_values(&:presence)
+  end
+end

data/app/controllers/concerns/flight_control/failed_jobs_bulk_operations.rb

@@ -0,0 +1,18 @@
+module FlightControl::FailedJobsBulkOperations
+  extend ActiveSupport::Concern
+
+  MAX_NUMBER_OF_JOBS_FOR_BULK_OPERATIONS = 3000
+
+  included do
+    include FlightControl::JobFilters
+  end
+
+  private
+
+  # We set a hard limit to prevent problems with the data store (for example, overloading Redis
+  # or causing replication lag in MySQL). This should be enough for most scenarios. For
+  # cases where we need to retry a huge sets of jobs, we offer a runbook that uses the API.
+  def bulk_limited_filtered_failed_jobs
+    ActiveJob.jobs.failed.where(**@job_filters).limit(MAX_NUMBER_OF_JOBS_FOR_BULK_OPERATIONS)
+  end
+end

data/app/controllers/concerns/flight_control/job_filters.rb

@@ -0,0 +1,44 @@
+module FlightControl::JobFilters
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :set_filters
+
+    helper_method :active_filters?, :jobs_filter_param
+  end
+
+  private
+
+  def set_filters
+    @job_filters = {
+      job_class_name: params.dig(:filter, :job_class_name).to_s.strip.presence,
+      queue_name: params.dig(:filter, :queue_name).to_s.strip.presence,
+      finished_at: date_range_params(:finished_at),
+      scheduled_at: date_range_params(:scheduled_at),
+      enqueued_at: date_range_params(:enqueued_at)
+    }.compact
+  end
+
+  def active_filters?
+    @job_filters.any?
+  end
+
+  def jobs_filter_param
+    if @job_filters&.any?
+      {filter: @job_filters}
+    else
+      {}
+    end
+  end
+
+  def date_range_params(attribute)
+    range_start, range_end = params.dig(:filter, :"#{attribute}_start"), params.dig(:filter, :"#{attribute}_end")
+    if range_start || range_end
+      (parse_with_time_zone(range_start)..parse_with_time_zone(range_end))
+    end
+  end
+
+  def parse_with_time_zone(date)
+    Time.zone.parse(date) if date.present?
+  end
+end

data/app/controllers/concerns/flight_control/job_scoped.rb

@@ -0,0 +1,17 @@
+module FlightControl::JobScoped
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :set_job
+  end
+
+  private
+
+  def set_job
+    @job = jobs_relation.find_by_id!(params[:job_id] || params[:id])
+  end
+
+  def jobs_relation
+    raise NotImplementedError
+  end
+end

data/app/controllers/concerns/flight_control/not_found_redirections.rb

@@ -0,0 +1,36 @@
+module FlightControl::NotFoundRedirections
+  extend ActiveSupport::Concern
+
+  included do
+    rescue_from(ActiveJob::Errors::JobNotFoundError) do |error|
+      redirect_to best_location_for_job_relation(error.job_relation), alert: error.message
+    end
+
+    rescue_from(FlightControl::Errors::ResourceNotFound) do |error|
+      redirect_to best_location_for_resource_not_found_error(error), alert: error.message
+    end
+  end
+
+  private
+
+  def best_location_for_job_relation(job_relation)
+    if job_relation.failed?
+      application_jobs_path(@application, :failed)
+    elsif job_relation.queue_name.present?
+      application_queue_path(@application, job_relation.queue_name)
+    else
+      root_path
+    end
+  end
+
+  def best_location_for_resource_not_found_error(error)
+    case error.message
+    when /recurring task/i
+      application_recurring_tasks_path(@application)
+    when /queue/i
+      application_queues_path(@application)
+    else
+      root_url
+    end
+  end
+end

data/app/controllers/concerns/flight_control/queue_scoped.rb

@@ -0,0 +1,13 @@
+module FlightControl::QueueScoped
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :set_queue
+  end
+
+  private
+
+  def set_queue
+    @queue = ActiveJob.queues[params[:queue_id]] or raise FlightControl::Errors::ResourceNotFound, "Queue '#{params[:queue_id]}' not found"
+  end
+end

data/app/controllers/flight_control/application_controller.rb

@@ -0,0 +1,35 @@
+class FlightControl::ApplicationController < FlightControl.base_controller_class.constantize
+  ActionController::Base::MODULES.each do |mod|
+    include mod unless self < mod
+  end
+
+  layout "flight_control/application"
+
+  # Include helpers if not already included
+  helper FlightControl::ApplicationHelper unless self < FlightControl::ApplicationHelper
+  helper Importmap::ImportmapTagsHelper unless self < Importmap::ImportmapTagsHelper
+
+  include FlightControl::HostRouteHelpers
+  include FlightControl::BasicAuthentication
+  include FlightControl::NotFoundRedirections
+  include FlightControl::ApplicationScoped
+  include FlightControl::AdapterFeatures
+  include FlightControl::JobFilters
+
+  around_action :set_current_locale
+
+  private
+
+  def default_url_options
+    super.merge(server_id: FlightControl::Current.server)
+  end
+
+  def set_current_locale(&block)
+    @previous_config = I18n.config
+    I18n.config = FlightControl::I18nConfig.new
+    I18n.with_locale(:en, &block)
+  ensure
+    I18n.config = @previous_config
+    @previous_config = nil
+  end
+end

data/app/controllers/flight_control/bulk_discards_controller.rb

@@ -0,0 +1,21 @@
+class FlightControl::BulkDiscardsController < FlightControl::ApplicationController
+  include FlightControl::FailedJobsBulkOperations
+
+  def create
+    jobs_to_discard_count = jobs_to_discard.count
+    jobs_to_discard.discard_all
+
+    redirect_to application_jobs_url(@application, :failed), notice: "Discarded #{jobs_to_discard_count} jobs"
+  end
+
+  private
+
+  def jobs_to_discard
+    if active_filters?
+      bulk_limited_filtered_failed_jobs
+    else
+      # we don't want to apply any limit since "discarding all" without parameters can be optimized in the adapter as a much faster operation
+      ActiveJob.jobs.failed
+    end
+  end
+end

data/app/controllers/flight_control/bulk_retries_controller.rb

@@ -0,0 +1,10 @@
+class FlightControl::BulkRetriesController < FlightControl::ApplicationController
+  include FlightControl::FailedJobsBulkOperations
+
+  def create
+    jobs_to_retry_count = bulk_limited_filtered_failed_jobs.count
+    bulk_limited_filtered_failed_jobs.retry_all
+
+    redirect_to application_jobs_url(@application, :failed), notice: "Retried #{jobs_to_retry_count} jobs"
+  end
+end

data/app/controllers/flight_control/discards_controller.rb

@@ -0,0 +1,19 @@
+class FlightControl::DiscardsController < FlightControl::ApplicationController
+  include FlightControl::JobScoped
+
+  def create
+    @job.discard
+    redirect_to redirect_location, notice: "Discarded job with id #{@job.job_id}"
+  end
+
+  private
+
+  def jobs_relation
+    ActiveJob.jobs
+  end
+
+  def redirect_location
+    status = @job.status.presence_in(supported_job_statuses) || :failed
+    application_jobs_url(@application, status, **jobs_filter_param)
+  end
+end

data/app/controllers/flight_control/dispatches_controller.rb

@@ -0,0 +1,19 @@
+class FlightControl::DispatchesController < FlightControl::ApplicationController
+  include FlightControl::JobScoped
+
+  def create
+    @job.dispatch
+    redirect_to redirect_location, notice: "Dispatched job with id #{@job.job_id}"
+  end
+
+  private
+
+  def jobs_relation
+    ActiveJob.jobs
+  end
+
+  def redirect_location
+    status = @job.status.presence_in(supported_job_statuses) || :blocked
+    application_jobs_url(@application, status)
+  end
+end

data/app/controllers/flight_control/job_launches_controller.rb

@@ -0,0 +1,28 @@
+class FlightControl::JobLaunchesController < FlightControl::ApplicationController
+  before_action :set_form_options
+
+  def new
+    @job_launch = FlightControl::JobLaunch.new
+  end
+
+  def create
+    @job_launch = FlightControl::JobLaunch.new(job_launch_params)
+
+    if (job = @job_launch.enqueue)
+      redirect_to application_job_path(@application, job.job_id), notice: "Enqueued #{@job_launch.job_class_name} with job id #{job.job_id}"
+    else
+      render :new, status: :unprocessable_entity
+    end
+  end
+
+  private
+
+  def set_form_options
+    @job_classes = FlightControl::JobLaunch.job_classes
+    @queue_names = ActiveJob.queues.map(&:name)
+  end
+
+  def job_launch_params
+    params.require(:job_launch).permit(:job_class_name, :arguments_json, :queue_name)
+  end
+end

data/app/controllers/flight_control/jobs_controller.rb

@@ -0,0 +1,40 @@
+class FlightControl::JobsController < FlightControl::ApplicationController
+  include FlightControl::JobScoped
+
+  skip_before_action :set_job, only: :index
+
+  def index
+    @job_class_names = jobs_with_status.job_class_names
+    @queue_names = ActiveJob.queues.map(&:name)
+
+    @jobs_page = FlightControl::Page.new(filtered_jobs_with_status, page: params[:page].to_i)
+    @jobs_count = @jobs_page.total_count
+  end
+
+  def show
+  end
+
+  private
+
+  def jobs_relation
+    filtered_jobs
+  end
+
+  def filtered_jobs_with_status
+    filtered_jobs.with_status(jobs_status)
+  end
+
+  def jobs_with_status
+    ActiveJob.jobs.with_status(jobs_status)
+  end
+
+  def filtered_jobs
+    ActiveJob.jobs.where(**@job_filters)
+  end
+
+  helper_method :jobs_status
+
+  def jobs_status
+    params[:status].presence&.inquiry
+  end
+end

data/app/controllers/flight_control/queues/pauses_controller.rb

@@ -0,0 +1,15 @@
+class FlightControl::Queues::PausesController < FlightControl::ApplicationController
+  include FlightControl::QueueScoped
+
+  def create
+    @queue.pause
+
+    redirect_back fallback_location: application_queues_url(@application)
+  end
+
+  def destroy
+    @queue.resume
+
+    redirect_back fallback_location: application_queues_url(@application)
+  end
+end

data/app/controllers/flight_control/queues_controller.rb

@@ -0,0 +1,17 @@
+class FlightControl::QueuesController < FlightControl::ApplicationController
+  before_action :set_queue, only: :show
+
+  def index
+    @queues = ActiveJob.queues.sort_by(&:name)
+  end
+
+  def show
+    @jobs_page = FlightControl::Page.new(@queue.jobs, page: params[:page].to_i)
+  end
+
+  private
+
+  def set_queue
+    @queue = ActiveJob.queues[params[:id]] or raise FlightControl::Errors::ResourceNotFound, "Queue '#{params[:id]}' not found"
+  end
+end

data/app/controllers/flight_control/recurring_tasks_controller.rb

@@ -0,0 +1,39 @@
+class FlightControl::RecurringTasksController < FlightControl::ApplicationController
+  before_action :ensure_supported_recurring_tasks
+  before_action :set_recurring_task, only: [:show, :update]
+  before_action :ensure_recurring_task_can_be_enqueued, only: :update
+
+  def index
+    @recurring_tasks = FlightControl::Current.server.recurring_tasks
+  end
+
+  def show
+    @jobs_page = FlightControl::Page.new(@recurring_task.jobs, page: params[:page].to_i)
+  end
+
+  def update
+    if (job = @recurring_task.enqueue) && job.successfully_enqueued?
+      redirect_to application_job_path(@application, job.job_id), notice: "Enqueued recurring task #{@recurring_task.id}"
+    else
+      redirect_to application_recurring_task_path(@application, @recurring_task.id), alert: "Something went wrong enqueuing this recurring task"
+    end
+  end
+
+  private
+
+  def ensure_supported_recurring_tasks
+    unless recurring_tasks_supported?
+      redirect_to root_url, alert: "This server doesn't support recurring tasks"
+    end
+  end
+
+  def set_recurring_task
+    @recurring_task = FlightControl::Current.server.find_recurring_task(params[:id])
+  end
+
+  def ensure_recurring_task_can_be_enqueued
+    unless @recurring_task.runnable?
+      redirect_to application_recurring_task_path(@application, @recurring_task.id), alert: "This task can't be enqueued"
+    end
+  end
+end

data/app/controllers/flight_control/retries_controller.rb

@@ -0,0 +1,14 @@
+class FlightControl::RetriesController < FlightControl::ApplicationController
+  include FlightControl::JobScoped
+
+  def create
+    @job.retry
+    redirect_to application_jobs_url(@application, :failed, **jobs_filter_param), notice: "Retried job with id #{@job.job_id}"
+  end
+
+  private
+
+  def jobs_relation
+    ActiveJob.jobs.failed
+  end
+end

data/app/controllers/flight_control/workers_controller.rb

@@ -0,0 +1,24 @@
+class FlightControl::WorkersController < FlightControl::ApplicationController
+  before_action :ensure_exposed_workers
+
+  def index
+    @workers_page = FlightControl::Page.new(workers_relation, page: params[:page].to_i)
+    @workers_count = @workers_page.total_count
+  end
+
+  def show
+    @worker = FlightControl::Current.server.find_worker(params[:id])
+  end
+
+  private
+
+  def ensure_exposed_workers
+    unless workers_exposed?
+      redirect_to root_url, alert: "This server doesn't expose workers"
+    end
+  end
+
+  def workers_relation
+    FlightControl::Current.server.workers_relation
+  end
+end

data/app/helpers/flight_control/application_helper.rb

@@ -0,0 +1,12 @@
+module FlightControl
+  module ApplicationHelper
+    # Explicit helper inclusion because ApplicationController inherits from the host app.
+    #
+    # We can't rely on +config.action_controller.include_all_helpers = true+ in the host app.
+    include InterfaceHelper
+    include NavigationHelper
+    include JobsHelper
+    include DatesHelper
+    include FlightControl::Engine.routes.url_helpers
+  end
+end

data/app/helpers/flight_control/dates_helper.rb

@@ -0,0 +1,30 @@
+module FlightControl::DatesHelper
+  def time_distance_in_words_with_title(time)
+    tag.span time_ago_in_words_with_default_options(time), title: "Since #{time.to_fs(:long)}"
+  end
+
+  def bidirectional_time_distance_in_words_with_title(time)
+    time_distance = if time.past?
+      "#{time_ago_in_words_with_default_options(time)} ago"
+    else
+      "in #{time_ago_in_words_with_default_options(time)}"
+    end
+
+    tag.span time_distance, title: time.to_fs(:long)
+  end
+
+  # Renders "2026-07-10 12:32:15 UTC (about 4 hours ago)". The local-time
+  # Stimulus controller prepends the timestamp in the browser's timezone,
+  # which the server can't know.
+  def timestamp_with_relative_time(time)
+    time = time.to_time.utc
+    safe_join [
+      tag.span(time.strftime("%Y-%m-%d %H:%M:%S UTC"), data: {controller: "local-time", local_time_datetime_value: time.iso8601}),
+      " (#{time_ago_in_words_with_default_options(time)} ago)"
+    ]
+  end
+
+  def time_ago_in_words_with_default_options(time)
+    time_ago_in_words(time, include_seconds: true, locale: :en)
+  end
+end

data/app/helpers/flight_control/interface_helper.rb

@@ -0,0 +1,23 @@
+module FlightControl::InterfaceHelper
+  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