mission_control-jobs 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 879e267e104351dd54398f02ba20ecf92e2c05167103768c7016255e30bfb6e8
-  data.tar.gz: 9e933eb2b1175bf5dd1679ebb8d16531a13970fe856bf3dc4bcd3cbc6183e89f
+  metadata.gz: ced6558306cb1d5dce82b59a848a16904e39600a0b65982b124a9788d4d47989
+  data.tar.gz: 2a973ec0f123903d0ecd42f47d19e2f213d2659fed58f9521ed7f080ca6c9807
 SHA512:
-  metadata.gz: a07aac211f26e471c73d1a49a34dc39b6263fee054163eacfe70ce6c73bdea8f3139361cfea9ea28a50c15a5f3e1ce88a4b28b4730bf1ba6ad71ad1e41aadd2a
-  data.tar.gz: bc5e3905176d583faa2f41f3cfe054db873754dce41a9bca3afea19e9f4b1e9be2872f148d06ff0220b308bdbafc3b40880e49160603d7bc8e3a1d6eb3667762
+  metadata.gz: 8a374110adc1bf32f56c680ce5024dce8f2b4d9812380dbbc0af0a3006b56c25614c92b653d4c9738d92601c610e78a2f566f929456b184cf2f08a9f3920ce62
+  data.tar.gz: 2a7be00afe61ee9f6441e955f85cb4eee5361945c0f6208140cfd0d98883c7d6ec702a4785590c9822c20db9961e7ea089614ec869e37c7571156f0850f2040b

data/README.md

@@ -1,6 +1,6 @@
 # Mission Control — Jobs
 
-This gem provides a Rails-based frontend to Active Job adapters. It currently supports [Resque](https://github.com/resque/resque/) and [Solid Queue](https://github.com/basecamp/solid_queue). Its features depend on those offered by the adapter itself. At a minimum, it allows you to inspect job queues and jobs currently waiting in those queues and inspect and retry or discard failed jobs.
+This gem provides a Rails-based frontend to Active Job adapters. It currently supports [Resque](https://github.com/resque/resque/) and [Solid Queue](https://github.com/rails/solid_queue). Its features depend on those offered by the adapter itself. At a minimum, it allows you to inspect job queues and jobs currently waiting in those queues and inspect and retry or discard failed jobs.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -56,10 +56,16 @@ Besides `base_controller_class`, you can also set the following for `MissionCont
 - `adapters`: a list of adapters that you want Mission Control to use and extend. By default this will be the adapter you have set for `active_job.queue_adapter`.
 - `internal_query_count_limit`: in count queries, the maximum number of records that will be counted if the adapter needs to limit these queries. True counts above this number will be returned as `INFINITY`. This keeps count queries fast—defaults to `500,000`
 - `scheduled_job_delay_threshold`: the time duration before a scheduled job is considered delayed. Defaults to `1.minute` (a job is considered delayed if it hasn't transitioned from the `scheduled` status 1 minute after the scheduled time).
+- `show_console_help`: whether to show the console help. If you don't want the console help message, set this to `false`—defaults to `true`.
 
 This library extends Active Job with a querying interface and the following setting:
 - `config.active_job.default_page_size`: the internal batch size that Active Job will use when sending queries to the underlying adapter and the batch size for the bulk operations defined above—defaults to `1000`.
 
+
+## Adapter Specifics
+
+- **Resque**: Queue pausing is supported only if you have `resque-pause` installed in your project
+
 ## Advanced configuration
 
 When we built Mission Control Jobs, we did it with the idea of managing multiple apps' job backends from a single, centralized app that we used for monitoring, alerts and other tools that related to all our apps. Some of our apps run in more than one datacenter, and we run different Resque instances with different Redis configurations in each. Because of this, we added support for multiple apps and multiple adapters per app. Even when running Mission Control Job within the app it manages, and a single DC, as we migrated from Resque to Solid Queue, we needed to manage both adapters from Mission Control.
@@ -109,7 +115,7 @@ end
 
 This is an example for two different apps, BC4 and HEY, each one with two servers. BC4 has two Resque servers with two different configurations, and HEY has one Resque server and one Solid Queue server.
 
-Currently, only one Solid Queue configuration is supported, but support for several Solid Queue backends (with different databases) [is planned](https://github.com/basecamp/mission_control-jobs/issues/35).
+Currently, only one Solid Queue configuration is supported, but support for several Solid Queue backends (with different databases) [is planned](https://github.com/rails/mission_control-jobs/issues/35).
 
 This is how we set Resque and Solid Queue together when we migrated from one to the other:
 
@@ -128,7 +134,7 @@ When you have multiple apps and servers configured, you can choose between them
 
 ## Basic UI usage
 
-As mentioned, the features available in Mission Control depend on the adapter you're using, as each adapter supports different features. Besides inspecting the queues and the jobs in them, and discarding and retrying failed jobs, you can inspect jobs in different statuses supported by each adapter, filter them by _queue name_ and _job class name_ (with the idea of [adding more filters in the future](https://github.com/basecamp/mission_control-jobs/issues/30)), pause and un-pause queues (if the adapter allows that), inspect workers, know which jobs are being run by what worker, checking a specific job or a specific worker...
+As mentioned, the features available in Mission Control depend on the adapter you're using, as each adapter supports different features. Besides inspecting the queues and the jobs in them, and discarding and retrying failed jobs, you can inspect jobs in different statuses supported by each adapter, filter them by _queue name_ and _job class name_ (with the idea of [adding more filters in the future](https://github.com/rails/mission_control-jobs/issues/30)), pause and un-pause queues (if the adapter allows that), inspect workers, know which jobs are being run by what worker, checking a specific job or a specific worker...
 
 ![Default queue tab](docs/images/default-queue.png)
 

data/app/controllers/mission_control/jobs/application_controller.rb

@@ -4,8 +4,14 @@ class MissionControl::Jobs::ApplicationController < MissionControl::Jobs.base_co
   include MissionControl::Jobs::ApplicationScoped, MissionControl::Jobs::NotFoundRedirections
   include MissionControl::Jobs::AdapterFeatures
 
+  around_action :set_current_locale
+
   private
     def default_url_options
       { server_id: MissionControl::Jobs::Current.server }
     end
+
+    def set_current_locale(&block)
+      I18n.with_locale(:en, &block)
+    end
 end

data/app/controllers/mission_control/jobs/queues_controller.rb

@@ -2,7 +2,7 @@ class MissionControl::Jobs::QueuesController < MissionControl::Jobs::Application
   before_action :set_queue, only: :show
 
   def index
-    @queues = filtered_queues.sort_by(&:name)
+    @queues = ActiveJob.queues.sort_by(&:name)
   end
 
   def show
@@ -13,12 +13,4 @@ class MissionControl::Jobs::QueuesController < MissionControl::Jobs::Application
     def set_queue
       @queue = ActiveJob.queues[params[:id]]
     end
-
-    def filtered_queues
-      if prefix = ActiveJob::Base.queue_name_prefix
-        ActiveJob.queues.select { |queue| queue.name.start_with?(prefix) }
-      else
-        ActiveJob.queues
-      end
-    end
 end

data/lib/active_job/queue_adapters/resque_ext.rb

@@ -81,6 +81,10 @@ module ActiveJob::QueueAdapters::ResqueExt
     resque_jobs_for(jobs_relation).find_job(job_id)
   end
 
+  def supports_queue_pausing?
+    defined?(ResquePauseHelper)
+  end
+
   private
     attr_reader :redis
 

data/lib/mission_control/jobs/console/connect_to.rb

@@ -0,0 +1,15 @@
+require "irb/command"
+
+module MissionControl::Jobs::Console
+  class ConnectTo < IRB::Command::Base
+    category "Mission control jobs"
+    description "Connect to a job server"
+
+    def execute(server_locator)
+      server = MissionControl::Jobs::Server.from_global_id(server_locator)
+      MissionControl::Jobs::Current.server = server
+
+      puts "Connected to #{server_locator}"
+    end
+  end
+end

data/lib/mission_control/jobs/console/jobs_help.rb

@@ -0,0 +1,23 @@
+require "irb/command"
+
+module MissionControl::Jobs::Console
+  class JobsHelp < IRB::Command::Base
+    category "Mission control jobs"
+    description "Show help for managing jobs"
+
+    def execute(*)
+      puts "You are currently connected to #{MissionControl::Jobs::Current.server}" if MissionControl::Jobs::Current.server
+
+      puts "You can connect to a job server with"
+      puts %(  connect_to <app_id>:<server_id>\n\n)
+
+      puts "Available job servers:\n"
+
+      MissionControl::Jobs.applications.each do |application|
+        application.servers.each do |server|
+          puts "  * #{server.to_global_id}"
+        end
+      end
+    end
+  end
+end

data/lib/mission_control/jobs/engine.rb

@@ -67,10 +67,11 @@ module MissionControl
 
       console do
         require "irb"
-        require "irb/context"
+
+        IRB::Command.register :connect_to, Console::ConnectTo
+        IRB::Command.register :jobs_help, Console::JobsHelp
 
         IRB::Context.prepend(MissionControl::Jobs::Console::Context)
-        Rails::ConsoleMethods.include(MissionControl::Jobs::Console::Helpers)
 
         MissionControl::Jobs.delay_between_bulk_operation_batches = 2
         MissionControl::Jobs.logger = ActiveSupport::Logger.new(STDOUT)

data/lib/mission_control/jobs/version.rb

@@ -1,5 +1,5 @@
 module MissionControl
   module Jobs
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: mission_control-jobs
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jorge Manrubia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.1'
 - !ruby/object:Gem::Dependency
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
@@ -376,8 +390,9 @@ files:
 - lib/mission_control/jobs/adapter.rb
 - lib/mission_control/jobs/application.rb
 - lib/mission_control/jobs/applications.rb
+- lib/mission_control/jobs/console/connect_to.rb
 - lib/mission_control/jobs/console/context.rb
-- lib/mission_control/jobs/console/helpers.rb
+- lib/mission_control/jobs/console/jobs_help.rb
 - lib/mission_control/jobs/engine.rb
 - lib/mission_control/jobs/errors/incompatible_adapter.rb
 - lib/mission_control/jobs/errors/resource_not_found.rb
@@ -391,12 +406,12 @@ files:
 - lib/mission_control/jobs/workers_relation.rb
 - lib/resque/thread_safe_redis.rb
 - lib/tasks/mission_control/jobs_tasks.rake
-homepage: https://github.com/basecamp/mission_control-jobs
+homepage: https://github.com/rails/mission_control-jobs
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/basecamp/mission_control-jobs
-  source_code_uri: https://github.com/basecamp/mission_control-jobs
+  homepage_uri: https://github.com/rails/mission_control-jobs
+  source_code_uri: https://github.com/rails/mission_control-jobs
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -412,7 +427,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Operational controls for Active Job

data/lib/mission_control/jobs/console/helpers.rb

@@ -1,26 +0,0 @@
-module MissionControl::Jobs::Console::Helpers
-  def connect_to(server_locator)
-    server = MissionControl::Jobs::Server.from_global_id(server_locator)
-    MissionControl::Jobs::Current.server = server
-
-    puts "Connected to #{server_locator}"
-    nil
-  end
-
-  def jobs_help
-    puts "You are currently connected to #{MissionControl::Jobs::Current.server}" if MissionControl::Jobs::Current.server
-
-    puts "You can connect to a job server with"
-    puts %(  connect_to "<app_id>:<server_id>"\n\n)
-
-    puts "Available job servers:\n"
-
-    MissionControl::Jobs.applications.each do |application|
-      application.servers.each do |server|
-        puts "  * #{server.to_global_id}"
-      end
-    end
-
-    nil
-  end
-end