Mission Control — Jobs

If you are using an API-only Rails app, vite_rails, or any pipeline other than Sprockets/Propshaft, you must include an asset pipeline to serve the gem's JavaScript and CSS.

It is recommended to use propshaft:

1. Add gem "propshaft" to your Gemfile and run bundle install.
2. Ensure your deployment pipeline runs rails assets:precompile.

For Docker environments where you might have skipped assets, use SECRET_KEY_BASE_DUMMY=1 to precompile without a master key:

# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile

To make the Mission Control UI accessible, mount the MissionControl::Jobs::Engine in your config/routes.rb file at your preferred path.

Rails.application.routes.draw do
  # ...
  mount MissionControl::Jobs::Engine, at: "/jobs"
end

By default, Mission Control has HTTP basic authentication enabled and closed. You must configure credentials to access the UI.

Option 1: Using the Generator

Run the provided generator to set up credentials in your Rails credentials file:

bin/rails mission_control:jobs:authentication:configure

To target a specific environment:

RAILS_ENV=production bin/rails mission_control:jobs:authentication:configure

Option 2: Manual Configuration

You can set the user and password directly in your application configuration:

Rails.application.configure do
  MissionControl::Jobs.http_basic_auth_user = "dev"
  MissionControl::Jobs.http_basic_auth_password = "secret"
end

Mission Control — Jobs provides console helpers to switch between different applications and adapters. This is useful for managing jobs in environments where the UI is insufficient or for performing destructive actions not exposed in the UI.

To see available job servers and connection instructions, run bin/rails c and type jobs_help.

>> jobs_help
You can connect to a job server with
  connect_to "<app_id>:<server_id>"

Available job servers:
  * bc4:resque_ashburn
  * bc4:resque_chicago
  * hey:resque
  * hey:solid_queue

To add Mission Control — Jobs to your Rails application, add the gem to your Gemfile and run bundle install.

gem "mission_control-jobs"

$ bundle install

To change the default 2-second delay between batches during bulk operations in the console, configure the delay_between_bulk_operation_batches setting on MissionControl::Jobs.

MissionControl::Jobs.delay_between_bulk_operation_batches = 5.seconds

If you want to use your application's existing authentication (e.g., an AdminController), you can specify a custom base controller class. When doing this, you should disable the default HTTP Basic Authentication.

Configure this in application.rb or an environment config:

Rails.application.configure do
  # Set the base controller
  MissionControl::Jobs.base_controller_class = "AdminController"
  
  # Disable default HTTP Basic Auth
  config.mission_control.jobs.http_basic_auth_enabled = false
end

Rails.application.configure do
  MissionControl::Jobs.base_controller_class = "AdminController"
end

# Or via config object:
config.mission_control.jobs.base_controller_class = "AdminController"
config.mission_control.jobs.http_basic_auth_enabled = false

The ActiveJob::QueueAdapters::ResqueExt module extends the standard Resque adapter to provide compatibility with Mission Control — Jobs features. It enables advanced job management capabilities such as queue pausing, job retries, and job discarding directly through the Mission Control interface.

Key capabilities provided by this extension include:

• Queue Management: Checking queue status (active/paused) and size, clearing queues, and pausing/resuming queues.
• Job Operations: Finding, retrying, and discarding individual jobs or batches of jobs.
• Filtering: Support for filtering jobs by queue_name when they are in a pending state.

Mission Control can pause and resume Resque queues if the ResquePauseHelper is defined in your application. This allows you to temporarily stop processing jobs from a specific queue without removing them.

To check if your Resque setup supports pausing, you can use the supports_queue_pausing? method. If supported, the following operations are available:

• pause_queue(queue_name)
• resume_queue(queue_name)
• queue_paused?(queue_name)

When using the Async queue adapter, Mission Control — Jobs operates with limited native capabilities because the Async adapter is an in-memory implementation.

Key limitations include:

• Filtering: No filters are supported natively; non-supported filters are performed in-memory.
• Queue Pausing: The adapter does not support queue pausing (supports_queue_pausing? returns false).
• Queue Management: queues returns an empty list, and queue_size always returns 0.
• Job Operations: While methods like retry_all_jobs, discard_all_jobs, and fetch_jobs are defined to satisfy the Mission Control interface, they provide minimal or no functional support for managing a persistent queue.