Merge pull request #199 from rails/dispatch-scheduled-and-recurring

rosa · web-flow · commit d36e5df2ee5f · 2024-11-08T14:01:16.000+01:00
Allow enqueuing scheduled jobs and recurring tasks right away
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -241,7 +241,7 @@ GEM
       rack-session (>= 2.0.0, < 3)
       tilt (~> 2.0)
     smart_properties (1.17.0)
-    solid_queue (1.0.0)
+    solid_queue (1.0.1)
       activejob (>= 7.1)
       activerecord (>= 7.1)
       concurrent-ruby (>= 1.3.1)
@@ -306,7 +306,7 @@ DEPENDENCIES
   rubocop-performance
   rubocop-rails-omakase
   selenium-webdriver
-  solid_queue (~> 1.0)
+  solid_queue (~> 1.0.1)
   sprockets-rails
   sqlite3
 
diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ This library extends Active Job with a querying interface and the following sett
 ## Adapter Specifics
 
 - **Resque**: Queue pausing is supported only if you have `resque-pause` installed in your project
-- **Solid Queue**: Requires version >= 0.9.
+- **Solid Queue**: Requires version >= 1.0.1.
 
 ## Advanced configuration
 
diff --git a/app/assets/stylesheets/mission_control/jobs/jobs.css b/app/assets/stylesheets/mission_control/jobs/jobs.css
@@ -25,7 +25,7 @@ table.jobs {
         width: 45%;
     }
     &.scheduled th.job-header {
-        width: 60%;
+        width: 40%;
     }
     &.finished th.job-header {
         width: 65%;
diff --git a/app/controllers/mission_control/jobs/discards_controller.rb b/app/controllers/mission_control/jobs/discards_controller.rb
@@ -8,7 +8,7 @@ def create
 
   private
     def jobs_relation
-      ActiveJob.jobs.failed
+      ActiveJob.jobs
     end
 
     def redirect_location
diff --git a/app/controllers/mission_control/jobs/dispatches_controller.rb b/app/controllers/mission_control/jobs/dispatches_controller.rb
@@ -3,11 +3,16 @@ class MissionControl::Jobs::DispatchesController < MissionControl::Jobs::Applica
 
   def create
     @job.dispatch
-    redirect_to application_jobs_url(@application, :blocked), notice: "Dispatched job with id #{@job.job_id}"
+    redirect_to redirect_location, notice: "Dispatched job with id #{@job.job_id}"
   end
 
   private
-  def jobs_relation
-    ApplicationJob.jobs.blocked
-  end
+    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
diff --git a/app/controllers/mission_control/jobs/recurring_tasks_controller.rb b/app/controllers/mission_control/jobs/recurring_tasks_controller.rb
@@ -1,6 +1,6 @@
 class MissionControl::Jobs::RecurringTasksController < MissionControl::Jobs::ApplicationController
   before_action :ensure_supported_recurring_tasks
-  before_action :set_recurring_task, only: :show
+  before_action :set_recurring_task, only: [ :show, :update ]
 
   def index
     @recurring_tasks = MissionControl::Jobs::Current.server.recurring_tasks
@@ -10,6 +10,14 @@ def show
     @jobs_page = MissionControl::Jobs::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), alert: "Something went wrong enqueuing this recurring task"
+    end
+  end
+
   private
     def ensure_supported_recurring_tasks
       unless recurring_tasks_supported?
diff --git a/app/helpers/mission_control/jobs/jobs_helper.rb b/app/helpers/mission_control/jobs/jobs_helper.rb
@@ -26,7 +26,7 @@ def failed_job_backtrace(job, server)
   def attribute_names_for_job_status(status)
     case status.to_s
     when "failed"      then [ "Error", "" ]
-    when "blocked"     then [ "Queue", "Blocked by", "Block expiry", "" ]
+    when "blocked"     then [ "Queue", "Blocked by", "" ]
     when "finished"    then [ "Queue", "Finished" ]
     when "scheduled"   then [ "Queue", "Scheduled", "" ]
     when "in_progress" then [ "Queue", "Run by", "Running since" ]
diff --git a/app/models/mission_control/jobs/recurring_task.rb b/app/models/mission_control/jobs/recurring_task.rb
@@ -12,6 +12,10 @@ def jobs
     ActiveJob::JobsRelation.new(queue_adapter: queue_adapter).where(recurring_task_id: id)
   end
 
+  def enqueue
+    queue_adapter.enqueue_recurring_task(id)
+  end
+
   private
     attr_reader :queue_adapter
 end
diff --git a/app/views/mission_control/jobs/jobs/_general_information.html.erb b/app/views/mission_control/jobs/jobs/_general_information.html.erb
@@ -26,6 +26,17 @@
       <%= formatted_time(job.enqueued_at.to_datetime) %>
     </td>
   </tr>
+  <% if job.scheduled? %>
+    <tr>
+      <th>Scheduled</th>
+      <td>
+        <%= formatted_time(job.scheduled_at) %>
+        <% if job_delayed?(job) %>
+          <div class="is-danger tag ml-4">delayed</div>
+        <% end %>
+      </td>
+    </tr>
+  <% end %>
   <% if job.failed? %>
     <tr>
       <th>Failed</th>
diff --git a/app/views/mission_control/jobs/jobs/blocked/_actions.html.erb b/app/views/mission_control/jobs/jobs/blocked/_actions.html.erb
@@ -1,3 +1,3 @@
 <div class="buttons is-right">
-  <%= button_to "Dispatch", application_job_dispatch_path(@application, job.job_id), class: "button is-warning is-light mr-0" %>
+  <%= button_to "Run now", application_job_dispatch_path(@application, job.job_id), class: "button is-warning is-light mr-0" %>
 </div>
diff --git a/app/views/mission_control/jobs/jobs/blocked/_job.html.erb b/app/views/mission_control/jobs/jobs/blocked/_job.html.erb
@@ -1,6 +1,7 @@
 <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><%= formatted_time(job.blocked_until) %></td>
+<td><div class="is-family-monospace is-size-7"><%= job.blocked_by %></div>
+    <div class="has-text-grey is-size-7">Until <%= formatted_time(job.blocked_until) %></div>
+</td>
 <td class="pr-0">
   <%= render "mission_control/jobs/jobs/blocked/actions", job: job %>
 </td>
diff --git a/app/views/mission_control/jobs/jobs/scheduled/_actions.html.erb b/app/views/mission_control/jobs/jobs/scheduled/_actions.html.erb
@@ -1,4 +1,5 @@
 <div class="buttons is-right">
+  <%= button_to "Run now", application_job_dispatch_path(@application, job.job_id), class: "button is-warning is-light mr-0" %>
   <%= 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?" } } %>
 </div>
diff --git a/app/views/mission_control/jobs/recurring_tasks/_actions.html.erb b/app/views/mission_control/jobs/recurring_tasks/_actions.html.erb
@@ -0,0 +1,3 @@
+<div class="buttons is-right">
+  <%= button_to "Run now", application_recurring_task_path(@application, recurring_task.id), class: "button is-warning is-light mr-0", method: :put %>
+</div>
diff --git a/app/views/mission_control/jobs/recurring_tasks/_recurring_task.html.erb b/app/views/mission_control/jobs/recurring_tasks/_recurring_task.html.erb
@@ -16,4 +16,7 @@
   <td> <%= recurring_task.schedule %> </td>
   <td><div class="has-text-grey"><%= recurring_task.last_enqueued_at ? formatted_time(recurring_task.last_enqueued_at) : "Never" %></div></td>
   <td class="next_time"><div class="has-text-grey"><%= formatted_time(recurring_task.next_time) %></div></td>
+  <td class="pr-0">
+    <%= render "mission_control/jobs/recurring_tasks/actions", recurring_task: recurring_task %>
+  </td>
 </tr>
diff --git a/app/views/mission_control/jobs/recurring_tasks/_title.html.erb b/app/views/mission_control/jobs/recurring_tasks/_title.html.erb
@@ -3,5 +3,8 @@
     <div class="level-left">
       <%= recurring_task.id %>
     </div>
+    <div class="level-right">
+      <%= render "mission_control/jobs/recurring_tasks/actions", recurring_task: recurring_task %>
+    </div>
   </div>
 </h1>
diff --git a/app/views/mission_control/jobs/recurring_tasks/index.html.erb b/app/views/mission_control/jobs/recurring_tasks/index.html.erb
@@ -7,8 +7,9 @@
     <th></th>
     <th>Job</th>
     <th>Schedule</th>
-    <th>Last enqueued at</th>
-    <th>Next run</th>
+    <th>Last enqueued</th>
+    <th>Next</th>
+    <th></th>
   </tr>
   </thead>
 
diff --git a/config/routes.rb b/config/routes.rb
@@ -20,7 +20,7 @@
     resources :jobs, only: :index, path: ":status/jobs"
 
     resources :workers, only: [ :index, :show ]
-    resources :recurring_tasks, only: [ :index, :show ]
+    resources :recurring_tasks, only: [ :index, :show, :update ]
   end
 
   # Allow referencing urls without providing an application_id. It will default to the first one.
diff --git a/lib/active_job/executing.rb b/lib/active_job/executing.rb
@@ -25,7 +25,7 @@ def discard
   end
 
   def dispatch
-    ActiveJob.jobs.blocked.dispatch_job(self)
+    ActiveJob.jobs.dispatch_job(self)
   end
 
   private
diff --git a/lib/active_job/jobs_relation.rb b/lib/active_job/jobs_relation.rb
@@ -154,7 +154,12 @@ def discard_job(job)
   end
 
   # Dispatch the provided job.
+  #
+  # This operation is only valid for blocked or scheduled jobs. It will
+  # raise an error +ActiveJob::Errors::InvalidOperation+ otherwise.
   def dispatch_job(job)
+    raise ActiveJob::Errors::InvalidOperation, "This operation can only be performed on blocked or scheduled jobs, but this job is #{job.status}" unless job.blocked? || job.scheduled?
+
     queue_adapter.dispatch_job(job, self)
   end
 
diff --git a/lib/active_job/queue_adapters/solid_queue_ext.rb b/lib/active_job/queue_adapters/solid_queue_ext.rb
@@ -123,9 +123,13 @@ def execution_error_from_solid_queue_job(solid_queue_job)
     end
 
     def dispatch_immediately(job)
-      SolidQueue::Job.transaction do
-        job.dispatch_bypassing_concurrency_limits
-        job.blocked_execution.destroy!
+      if job.blocked?
+        SolidQueue::Job.transaction do
+          job.dispatch_bypassing_concurrency_limits
+          job.blocked_execution.destroy!
+        end
+      else
+        job.scheduled_execution.update!(scheduled_at: Time.now)
       end
     end
 
diff --git a/lib/active_job/queue_adapters/solid_queue_ext/recurring_tasks.rb b/lib/active_job/queue_adapters/solid_queue_ext/recurring_tasks.rb
@@ -20,6 +20,12 @@ def find_recurring_task(task_id)
     end
   end
 
+  def enqueue_recurring_task(task_id)
+    if task = SolidQueue::RecurringTask.find_by(key: task_id)
+      task.enqueue(at: Time.now)
+    end
+  end
+
   private
     def recurring_task_attributes_from_solid_queue_recurring_task(task)
       {
diff --git a/mission_control-jobs.gemspec b/mission_control-jobs.gemspec
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "irb", "~> 1.13"
 
   spec.add_development_dependency "resque"
-  spec.add_development_dependency "solid_queue", "~> 1.0"
+  spec.add_development_dependency "solid_queue", "~> 1.0.1"
   spec.add_development_dependency "selenium-webdriver"
   spec.add_development_dependency "resque-pause"
   spec.add_development_dependency "mocha"
diff --git a/test/controllers/recurring_tasks_controller_test.rb b/test/controllers/recurring_tasks_controller_test.rb
@@ -52,4 +52,17 @@ class MissionControl::Jobs::RecurringTasksControllerTest < ActionDispatch::Integ
       assert_select "article.is-danger", /Recurring task with id 'invalid_key' not found/
     end
   end
+
+  test "enqueue recurring task successfully" do
+    schedule_recurring_tasks_async(wait: 0.1.seconds)
+
+    assert_difference -> { ActiveJob.jobs.pending.count } do
+      put mission_control_jobs.application_recurring_task_url(@application, "periodic_pause_job")
+      assert_response :redirect
+    end
+
+    job = ActiveJob.jobs.pending.last
+    assert_equal "PauseJob", job.job_class_name
+    assert_match /jobs\/#{job.job_id}\?server_id=solid_queue\z/, response.location
+  end
 end
diff --git a/test/dummy/db/seeds.rb b/test/dummy/db/seeds.rb
@@ -10,7 +10,7 @@ def clean_database
 end
 
 class JobsLoader
-  attr_reader :application, :server, :failed_jobs_count, :pending_jobs_count, :finished_jobs_count, :blocked_jobs_count
+  attr_reader :application, :server, :failed_jobs_count, :pending_jobs_count, :finished_jobs_count, :blocked_jobs_count, :scheduled_jobs_count
 
   def initialize(application, server, failed_jobs_count: 100, pending_jobs_count: 50)
     @application = application
@@ -19,6 +19,7 @@ def initialize(application, server, failed_jobs_count: 100, pending_jobs_count:
     @pending_jobs_count = randomize(pending_jobs_count)
     @finished_jobs_count = randomize(pending_jobs_count)
     @blocked_jobs_count = randomize(pending_jobs_count)
+    @scheduled_jobs_count = randomize(pending_jobs_count)
   end
 
   def load
@@ -27,6 +28,7 @@ def load
       load_failed_jobs
       load_pending_jobs
       load_blocked_jobs
+      load_scheduled_jobs
       load_recurring_tasks
     end
   end
@@ -64,6 +66,15 @@ def load_blocked_jobs
       end
     end
 
+    def load_scheduled_jobs
+      return unless supported_status?(:scheduled)
+
+      puts "Generating #{scheduled_jobs_count} scheduled jobs for #{application} - #{server}..."
+      scheduled_jobs_count.times do |index|
+        DummyJob.set(wait: randomize(60).minutes).perform_later(index)
+      end
+    end
+
     def load_recurring_tasks
       return unless server.queue_adapter.supports_recurring_tasks?
 

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ table.jobs {`
`25`	`25`	`width: 45%;`
`26`	`26`	`}`
`27`	`27`	`&.scheduled th.job-header {`
`28`		`- width: 60%;`
	`28`	`+ width: 40%;`
`29`	`29`	`}`
`30`	`30`	`&.finished th.job-header {`
`31`	`31`	`width: 65%;`