mission_control-jobs 0.1.1 → 0.2.1

data/lib/mission_control/jobs/adapter.rb

@@ -3,17 +3,21 @@ module MissionControl::Jobs::Adapter
     block.call
   end
 
-  def supported_statuses
+  def supports_job_status?(status)
+    supported_job_statuses.include?(status)
+  end
+
+  def supported_job_statuses
     # All adapters need to support these at a minimum
     [ :pending, :failed ]
   end
 
-  def supports_filter?(jobs_relation, filter)
-    supported_filters(jobs_relation).include?(filter)
+  def supports_job_filter?(jobs_relation, filter)
+    supported_job_filters(jobs_relation).include?(filter)
   end
 
   # List of filters supported natively. Non-supported filters are done in memory.
-  def supported_filters(jobs_relation)
+  def supported_job_filters(jobs_relation)
     []
   end
 
@@ -25,11 +29,38 @@ module MissionControl::Jobs::Adapter
     false
   end
 
+  def supports_recurring_tasks?
+    false
+  end
+
+  # Returns an array with the list of recurring tasks. Each task is represented as a hash
+  # with these attributes:
+  #   {
+  #     id: "periodic-job",
+  #     job_class_name: "MyJob",
+  #     arguments: [ 123, { arg: :value }]
+  #     schedule: "every monday at 9 am",
+  #     last_enqueued_at: Fri, 26 Jan 2024 20:31:09.652174000 UTC +00:00,
+  #   }
+  def recurring_tasks
+    if supports_recurring_tasks?
+      raise_incompatible_adapter_error_from :recurring_tasks
+    end
+  end
+
+  # Returns a recurring task represented by a hash as indicated above
+  def find_recurring_task(recurring_task_id)
+    if supports_recurring_tasks?
+      raise_incompatible_adapter_error_from :find_recurring_task
+    end
+  end
+
+
   # Returns an array with the list of workers. Each worker is represented as a hash
   # with these attributes:
   #   {
   #     id: 123,
-  #     name: "adapter-name",
+  #     name: "worker-name",
   #     hostname: "hey-default-101",
   #     last_heartbeat_at: Fri, 26 Jan 2024 20:31:09.652174000 UTC +00:00,
   #     configuration: { ... }
@@ -37,10 +68,18 @@ module MissionControl::Jobs::Adapter
   #   }
   def workers
     if exposes_workers?
-      raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `workers`")
+      raise_incompatible_adapter_error_from :workers
+    end
+  end
+
+  # Returns a worker represented by a hash as indicated above
+  def find_worker(worker_id)
+    if exposes_workers?
+      raise_incompatible_adapter_error_from :find_worker
     end
   end
 
+
   # Returns an array with the list of queues. Each queue is represented as a hash
   # with these attributes:
   #   {
@@ -49,60 +88,69 @@ module MissionControl::Jobs::Adapter
   #     active: true
   #   }
   def queues
-    raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `queue_names`")
+    raise_incompatible_adapter_error_from :queue_names
   end
 
   def queue_size(queue_name)
-    raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `queue_size`")
+    raise_incompatible_adapter_error_from :queue_size
   end
 
   def clear_queue(queue_name)
-    raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `clear_queue`")
+    raise_incompatible_adapter_error_from :clear_queue
   end
 
   def pause_queue(queue_name)
     if supports_queue_pausing?
-      raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `pause_queue`")
+      raise_incompatible_adapter_error_from :pause_queue
     end
   end
 
   def resume_queue(queue_name)
     if supports_queue_pausing?
-      raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `resume_queue`")
+      raise_incompatible_adapter_error_from :resume_queue
     end
   end
 
   def queue_paused?(queue_name)
     if supports_queue_pausing?
-      raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `queue_paused?`")
+      raise_incompatible_adapter_error_from :queue_paused?
     end
   end
 
   def jobs_count(jobs_relation)
-    raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `jobs_count`")
+    raise_incompatible_adapter_error_from :jobs_count
   end
 
   def fetch_jobs(jobs_relation)
-    raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `fetch_jobs`")
+    raise_incompatible_adapter_error_from :fetch_jobs
   end
 
   def retry_all_jobs(jobs_relation)
-    raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `retry_all_jobs`")
+    raise_incompatible_adapter_error_from :retry_all_jobs
   end
 
   def retry_job(job, jobs_relation)
-    raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `retry_job`")
+    raise_incompatible_adapter_error_from :retry_job
   end
 
   def discard_all_jobs(jobs_relation)
-    raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `discard_all_jobs`")
+    raise_incompatible_adapter_error_from :discard_all_jobs
   end
 
   def discard_job(job, jobs_relation)
-    raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `discard_job`")
+    raise_incompatible_adapter_error_from :discard_job
+  end
+
+  def dispatch_job(job, jobs_relation)
+    raise_incompatible_adapter_error_from :dispatch_job
   end
 
   def find_job(job_id, *)
-    raise MissionControl::Jobs::Errors::IncompatibleAdapter("Adapter must implement `find_job`")
+    raise_incompatible_adapter_error_from :find_job
   end
+
+  private
+    def raise_incompatible_adapter_error_from(method_name)
+      raise MissionControl::Jobs::Errors::IncompatibleAdapter, "Adapter #{ActiveJob.adapter_name(self)} must implement `#{method_name}`"
+    end
 end

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

@@ -11,7 +11,7 @@ module MissionControl::Jobs::Console::Helpers
     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 %(  connect_to "<app_id>:<server_id>"\n\n)
 
     puts "Available job servers:\n"
 

data/lib/mission_control/jobs/engine.rb

@@ -20,8 +20,8 @@ module MissionControl
           MissionControl::Jobs.public_send("#{key}=", value)
         end
 
-        if config.active_job.queue_adapter.present? && MissionControl::Jobs.adapters.empty?
-          MissionControl::Jobs.adapters << config.active_job.queue_adapter
+        if MissionControl::Jobs.adapters.empty?
+          MissionControl::Jobs.adapters << (config.active_job.queue_adapter || :async)
         end
       end
 
@@ -36,6 +36,7 @@ module MissionControl
 
       config.before_initialize do
         if MissionControl::Jobs.adapters.include?(:resque)
+          require "resque/thread_safe_redis"
           ActiveJob::QueueAdapters::ResqueAdapter.prepend ActiveJob::QueueAdapters::ResqueExt
           Resque.prepend Resque::ThreadSafeRedis
         end
@@ -43,6 +44,8 @@ module MissionControl
         if MissionControl::Jobs.adapters.include?(:solid_queue)
           ActiveJob::QueueAdapters::SolidQueueAdapter.prepend ActiveJob::QueueAdapters::SolidQueueExt
         end
+
+        ActiveJob::QueueAdapters::AsyncAdapter.include MissionControl::Jobs::Adapter
       end
 
       config.after_initialize do |app|
@@ -63,6 +66,7 @@ module MissionControl
       end
 
       console do
+        require "irb"
         require "irb/context"
 
         IRB::Context.prepend(MissionControl::Jobs::Console::Context)
@@ -71,7 +75,14 @@ module MissionControl
         MissionControl::Jobs.delay_between_bulk_operation_batches = 2
         MissionControl::Jobs.logger = ActiveSupport::Logger.new(STDOUT)
 
-        puts "\n\nType 'jobs_help' to see how to connect to the available job servers to manage jobs\n\n"
+        if MissionControl::Jobs.applications.one? && (application = MissionControl::Jobs.applications.first) && application.servers.one?
+          MissionControl::Jobs::Current.application = application
+          MissionControl::Jobs::Current.server = application.servers.first
+        end
+
+        if MissionControl::Jobs.show_console_help
+          puts "\n\nType 'jobs_help' to see how to connect to the available job servers to manage jobs\n\n"
+        end
       end
 
       initializer "mission_control-jobs.assets" do |app|

data/lib/mission_control/jobs/server/recurring_tasks.rb

@@ -0,0 +1,15 @@
+module MissionControl::Jobs::Server::RecurringTasks
+  def recurring_tasks
+    queue_adapter.recurring_tasks.collect do |task|
+      MissionControl::Jobs::RecurringTask.new(queue_adapter: queue_adapter, **task)
+    end.sort_by(&:id)
+  end
+
+  def find_recurring_task(task_id)
+    if task = queue_adapter.find_recurring_task(task_id)
+      MissionControl::Jobs::RecurringTask.new(queue_adapter: queue_adapter, **task)
+    else
+      raise MissionControl::Jobs::Errors::ResourceNotFound, "Recurring task with id '#{task_id}' not found"
+    end
+  end
+end

data/lib/mission_control/jobs/server/serializable.rb

@@ -18,7 +18,7 @@ module MissionControl::Jobs::Server::Serializable
   end
 
   def to_global_id
-    suffix = ":#{id}" if application.servers.length > 1
+    suffix = ":#{id}" if application.servers.many?
     "#{application&.id}#{suffix}"
   end
 end

data/lib/mission_control/jobs/server/workers.rb

@@ -1,15 +1,13 @@
 module MissionControl::Jobs::Server::Workers
-  def workers
-    queue_adapter.workers.collect do |worker|
-      MissionControl::Jobs::Worker.new(queue_adapter: queue_adapter, **worker)
-    end
+  def workers_relation
+    MissionControl::Jobs::WorkersRelation.new(queue_adapter: queue_adapter)
   end
 
   def find_worker(worker_id)
     if worker = queue_adapter.find_worker(worker_id)
       MissionControl::Jobs::Worker.new(queue_adapter: queue_adapter, **worker)
     else
-      raise MissionControl::Jobs::Errors::ResourceNotFound, "No worker found with ID #{worker_id}"
+      raise MissionControl::Jobs::Errors::ResourceNotFound, "Worker with id '#{worker_id}' not found"
     end
   end
 end

data/lib/mission_control/jobs/server.rb

@@ -2,7 +2,7 @@ require "active_job/queue_adapter"
 
 class MissionControl::Jobs::Server
   include MissionControl::Jobs::IdentifiedByName
-  include Serializable, Workers
+  include Serializable, RecurringTasks, Workers
 
   attr_reader :name, :queue_adapter, :application
 

data/lib/mission_control/jobs/version.rb

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

data/lib/mission_control/jobs/workers_relation.rb

@@ -0,0 +1,78 @@
+# A relation of workers.
+#
+# Relations are enumerable, so you can use +Enumerable+ methods on them.
+# Notice however that using these methods will imply loading all the relation
+# in memory, which could introduce performance concerns.
+class MissionControl::Jobs::WorkersRelation
+  include Enumerable
+
+  attr_accessor :offset_value, :limit_value
+
+  delegate :last, :[], :to_s, :reverse, to: :to_a
+
+  ALL_WORKERS_LIMIT = 100_000_000 # When no limit value it defaults to "all workers"
+
+  def initialize(queue_adapter:)
+    @queue_adapter = queue_adapter
+
+    set_defaults
+  end
+
+  def offset(offset)
+    clone_with offset_value: offset
+  end
+
+  def limit(limit)
+    clone_with limit_value: limit
+  end
+
+  def each(&block)
+    workers.each(&block)
+  end
+
+  def reload
+    @count = @workers = nil
+    self
+  end
+
+  def count
+    if loaded?
+      to_a.length
+    else
+      query_count
+    end
+  end
+
+  def empty?
+    count == 0
+  end
+
+  alias length count
+  alias size count
+
+  private
+    def set_defaults
+      self.offset_value = 0
+      self.limit_value = ALL_WORKERS_LIMIT
+    end
+
+    def workers
+      @workers ||= @queue_adapter.fetch_workers(self)
+    end
+
+    def query_count
+      @count ||= @queue_adapter.count_workers(self)
+    end
+
+    def loaded?
+      !@workers.nil?
+    end
+
+    def clone_with(**properties)
+      dup.reload.tap do |relation|
+        properties.each do |key, value|
+          relation.send("#{key}=", value)
+        end
+      end
+    end
+end

data/lib/mission_control/jobs.rb

@@ -6,6 +6,7 @@ require "zeitwerk"
 loader = Zeitwerk::Loader.new
 loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
 loader.push_dir(File.expand_path("..", __dir__))
+loader.ignore("#{File.expand_path("..", __dir__)}/resque")
 loader.setup
 
 module MissionControl
@@ -15,5 +16,8 @@ module MissionControl
     mattr_accessor :base_controller_class, default: "::ApplicationController"
     mattr_accessor :delay_between_bulk_operation_batches, default: 0
     mattr_accessor :logger, default: ActiveSupport::Logger.new(nil)
+    mattr_accessor :internal_query_count_limit, default: 500_000 # Hard limit to keep unlimited count queries fast enough
+    mattr_accessor :show_console_help, default: true
+    mattr_accessor :scheduled_job_delay_threshold, default: 1.minute
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mission_control-jobs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Jorge Manrubia
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -154,16 +154,16 @@ dependencies:
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
@@ -207,7 +207,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rails
+  name: rubocop-rails-omakase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -245,9 +287,11 @@ files:
 - app/controllers/mission_control/jobs/bulk_discards_controller.rb
 - app/controllers/mission_control/jobs/bulk_retries_controller.rb
 - app/controllers/mission_control/jobs/discards_controller.rb
+- app/controllers/mission_control/jobs/dispatches_controller.rb
 - app/controllers/mission_control/jobs/jobs_controller.rb
 - app/controllers/mission_control/jobs/queues/pauses_controller.rb
 - app/controllers/mission_control/jobs/queues_controller.rb
+- app/controllers/mission_control/jobs/recurring_tasks_controller.rb
 - app/controllers/mission_control/jobs/retries_controller.rb
 - app/controllers/mission_control/jobs/workers_controller.rb
 - app/helpers/mission_control/jobs/application_helper.rb
@@ -261,11 +305,10 @@ files:
 - app/javascript/mission_control/jobs/controllers/index.js
 - app/javascript/mission_control/jobs/helpers/debounce_helpers.js
 - app/javascript/mission_control/jobs/helpers/index.js
-- app/jobs/mission_control/jobs/application_job.rb
-- app/mailers/mission_control/jobs/application_mailer.rb
 - app/models/mission_control/jobs/application_record.rb
 - app/models/mission_control/jobs/current.rb
 - app/models/mission_control/jobs/page.rb
+- app/models/mission_control/jobs/recurring_task.rb
 - app/models/mission_control/jobs/worker.rb
 - app/views/layouts/mission_control/jobs/_application_selection.html.erb
 - app/views/layouts/mission_control/jobs/_flash.html.erb
@@ -281,12 +324,14 @@ files:
 - app/views/mission_control/jobs/jobs/_raw_data.html.erb
 - app/views/mission_control/jobs/jobs/_title.html.erb
 - app/views/mission_control/jobs/jobs/_toolbar.html.erb
+- app/views/mission_control/jobs/jobs/blocked/_actions.html.erb
 - app/views/mission_control/jobs/jobs/blocked/_job.html.erb
 - app/views/mission_control/jobs/jobs/failed/_actions.html.erb
 - app/views/mission_control/jobs/jobs/failed/_job.html.erb
 - app/views/mission_control/jobs/jobs/finished/_job.html.erb
 - app/views/mission_control/jobs/jobs/in_progress/_job.html.erb
 - app/views/mission_control/jobs/jobs/index.html.erb
+- app/views/mission_control/jobs/jobs/scheduled/_actions.html.erb
 - app/views/mission_control/jobs/jobs/scheduled/_job.html.erb
 - app/views/mission_control/jobs/jobs/show.html.erb
 - app/views/mission_control/jobs/queues/_actions.html.erb
@@ -295,13 +340,19 @@ files:
 - app/views/mission_control/jobs/queues/_queue_title.html.erb
 - app/views/mission_control/jobs/queues/index.html.erb
 - app/views/mission_control/jobs/queues/show.html.erb
+- app/views/mission_control/jobs/recurring_tasks/_general_information.html.erb
+- app/views/mission_control/jobs/recurring_tasks/_recurring_task.html.erb
+- app/views/mission_control/jobs/recurring_tasks/_title.html.erb
+- app/views/mission_control/jobs/recurring_tasks/index.html.erb
+- app/views/mission_control/jobs/recurring_tasks/show.html.erb
+- app/views/mission_control/jobs/shared/_job.html.erb
+- app/views/mission_control/jobs/shared/_jobs.html.erb
 - app/views/mission_control/jobs/shared/_pagination_toolbar.html.erb
 - app/views/mission_control/jobs/workers/_configuration.html.erb
-- app/views/mission_control/jobs/workers/_job.html.erb
-- app/views/mission_control/jobs/workers/_jobs.html.erb
 - app/views/mission_control/jobs/workers/_raw_data.html.erb
 - app/views/mission_control/jobs/workers/_title.html.erb
 - app/views/mission_control/jobs/workers/_worker.html.erb
+- app/views/mission_control/jobs/workers/_workers_page.html.erb
 - app/views/mission_control/jobs/workers/index.html.erb
 - app/views/mission_control/jobs/workers/show.html.erb
 - config/importmap.rb
@@ -318,6 +369,8 @@ files:
 - lib/active_job/queue.rb
 - lib/active_job/queue_adapters/resque_ext.rb
 - lib/active_job/queue_adapters/solid_queue_ext.rb
+- lib/active_job/queue_adapters/solid_queue_ext/recurring_tasks.rb
+- lib/active_job/queue_adapters/solid_queue_ext/workers.rb
 - lib/active_job/queues.rb
 - lib/mission_control/jobs.rb
 - lib/mission_control/jobs/adapter.rb
@@ -331,9 +384,11 @@ files:
 - lib/mission_control/jobs/identified_by_name.rb
 - lib/mission_control/jobs/identified_elements.rb
 - lib/mission_control/jobs/server.rb
+- lib/mission_control/jobs/server/recurring_tasks.rb
 - lib/mission_control/jobs/server/serializable.rb
 - lib/mission_control/jobs/server/workers.rb
 - lib/mission_control/jobs/version.rb
+- 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

data/app/jobs/mission_control/jobs/application_job.rb

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

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

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

data/app/views/mission_control/jobs/workers/_jobs.html.erb

@@ -1,20 +0,0 @@
-<% if @worker.jobs.empty? %>
-  <%= blank_status_notice "This worker is idle" %>
-<% else %>
-  <h2 class="subtitle">Running <%= worker.jobs.size %> jobs</h2>
-
-  <table class="jobs table workers is-hoverable is-fullwidth">
-    <tbody>
-    <thead>
-    <tr>
-      <th style="width: 30%;">Job</th>
-      <th></th>
-      <th style="width: 15%;">Running for</th>
-    </tr>
-    </thead>
-
-    <%= render partial: "mission_control/jobs/workers/job", collection: @worker.jobs %>
-
-    </tbody>
-  </table>
-<% end %>