Merge pull request #1313 from Shopify/give-concurrent-running-a-message

Give `ConcurrentTaskRunning` a clear error message
Shopify · Jul 14, 2023 · 764f2db · 764f2db
2 parents 3121ad1 + 7e7c331
commit 764f2db
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/app/controllers/shipit/api/base_controller.rb b/app/controllers/shipit/api/base_controller.rb
@@ -93,8 +93,8 @@ def not_found(_error)
         render(status: :not_found, json: { status: '404', error: 'Not Found' })
       end
 
-      def conflict(_error)
-        render(status: :conflict, json: { status: '409', error: 'Conflict' })
+      def conflict(error)
+        render(status: :conflict, json: { status: '409', error: error.message })
       end
     end
   end

diff --git a/app/models/shipit/task.rb b/app/models/shipit/task.rb
@@ -3,7 +3,11 @@ module Shipit
   class Task < Record
     include DeferredTouch
 
-    ConcurrentTaskRunning = Class.new(StandardError)
+    class ConcurrentTaskRunning < StandardError
+      def message
+        "A task is already running."
+      end
+    end
 
     PRESENCE_CHECK_TIMEOUT = 30
     ACTIVE_STATUSES = %w(pending running aborting).freeze

diff --git a/test/controllers/api/deploys_controller_test.rb b/test/controllers/api/deploys_controller_test.rb
@@ -81,6 +81,7 @@ class DeploysControllerTest < ApiControllerTestCase
         end
 
         assert_response :conflict
+        assert_json 'error', 'A task is already running.'
       end
 
       test "#create refuses to deploy unsuccessful commits if the require_ci flag is passed" do