Add toggle to disable task list auto-refresh

README.md

@@ -856,6 +856,11 @@ end
 
 You can run your new Task by accessing the Web UI and clicking on "Run".
 
+A Task's page auto-refreshes in the background while it has active runs, so the
+progress and run statuses stay up to date. You can turn this off with the
+"Disable auto-refresh" toggle on the Task page, which adds a `?refresh=false`
+parameter to the URL. Use "Enable auto-refresh" to turn it back on.
+
 #### Running a Task from the command line
 
 Alternatively, you can run your Task in the command line:

app/controllers/maintenance_tasks/tasks_controller.rb

@@ -7,7 +7,7 @@ module MaintenanceTasks
   #
   # @api private
   class TasksController < ApplicationController
-    before_action :set_refresh, only: [:index]
+    before_action :set_refresh, only: [:index, :show]
 
     # Renders the maintenance_tasks/tasks page, displaying
     # available tasks to users, grouped by category.
@@ -28,7 +28,7 @@ def show
     private
 
     def set_refresh
-      @refresh = true
+      @refresh = params[:refresh] != "false"
     end
   end
 end

app/views/maintenance_tasks/tasks/show.html.erb

@@ -42,7 +42,16 @@
 </details>
 <% end %>
 
-<%= tag.div(data: { refresh: @task.refresh? || "" }) do %>
+<% if @task.refresh? %>
+  <div class="is-flex is-justify-content-flex-end mb-2">
+    <% if @refresh %>
+      <%= link_to "Disable auto-refresh", task_path(@task, refresh: false), class: "button is-small" %>
+    <% else %>
+      <%= link_to "Enable auto-refresh", task_path(@task), class: "button is-small" %>
+    <% end %>
+  </div>
+<% end %>
+<%= tag.div(data: { refresh: (@task.refresh? && @refresh) || "" }) do %>
   <% if @task.active_runs.any? %>
     <hr>
 

test/integration/maintenance_tasks/tasks_controller_test.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+module MaintenanceTasks
+  class TasksControllerTest < ActionDispatch::IntegrationTest
+    # Maintenance::UpdatePostsTask has a paused (active) run, so its show page
+    # refreshes by default.
+    ACTIVE_TASK = "Maintenance::UpdatePostsTask"
+
+    test "task page auto-refreshes by default when there are active runs" do
+      get maintenance_tasks.task_path(ACTIVE_TASK)
+
+      assert_response :success
+      assert_select "[data-refresh=true]"
+    end
+
+    test "task page does not auto-refresh when refresh=false is passed" do
+      get maintenance_tasks.task_path(ACTIVE_TASK), params: { refresh: "false" }
+
+      assert_response :success
+      assert_select "[data-refresh=true]", false
+    end
+
+    test "task page shows a link to disable auto-refresh when refreshing" do
+      get maintenance_tasks.task_path(ACTIVE_TASK)
+
+      assert_response :success
+      assert_select "a[href*='refresh=false']", text: "Disable auto-refresh"
+    end
+
+    test "task page shows a link to enable auto-refresh when not refreshing" do
+      get maintenance_tasks.task_path(ACTIVE_TASK), params: { refresh: "false" }
+
+      assert_response :success
+      assert_select "a", text: "Enable auto-refresh"
+    end
+
+    test "task page shows no auto-refresh toggle when there are no active runs" do
+      get maintenance_tasks.task_path("Maintenance::ImportPostsTask")
+
+      assert_response :success
+      assert_select "a", text: "Disable auto-refresh", count: 0
+      assert_select "a", text: "Enable auto-refresh", count: 0
+    end
+  end
+end