Merge pull request #34788 from gsamokovarov/actionable-errors

Introduce Actionable Errors

3 files changed, 112 insertions, 0 deletions

diff --git a/actionpack/test/abstract_unit.rb b/actionpack/test/abstract_unit.rb
index 6460ca6f8d..32a0b8efeb 100644
--- a/actionpack/test/abstract_unit.rb
+++ b/actionpack/test/abstract_unit.rb
@@ -96,6 +96,7 @@ class ActionDispatch::IntegrationTest < ActiveSupport::TestCase
     RoutedRackApp.new(routes || ActionDispatch::Routing::RouteSet.new) do |middleware|
       middleware.use ActionDispatch::ShowExceptions, ActionDispatch::PublicExceptions.new("#{FIXTURE_LOAD_PATH}/public")
       middleware.use ActionDispatch::DebugExceptions
+      middleware.use ActionDispatch::ActionableExceptions
       middleware.use ActionDispatch::Callbacks
       middleware.use ActionDispatch::Cookies
       middleware.use ActionDispatch::Flash
diff --git a/actionpack/test/dispatch/actionable_exceptions_test.rb b/actionpack/test/dispatch/actionable_exceptions_test.rb
new file mode 100644
index 0000000000..9215a91e9c
--- /dev/null
+++ b/actionpack/test/dispatch/actionable_exceptions_test.rb
@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "abstract_unit"
+
+class ActionableExceptionsTest < ActionDispatch::IntegrationTest
+  Actions = []
+
+  class ActionError < StandardError
+    include ActiveSupport::ActionableError
+
+    action "Successful action" do
+      Actions << "Action!"
+    end
+
+    action "Failed action" do
+      raise "Inaction!"
+    end
+  end
+
+  Noop = -> env { [200, {}, [""]] }
+
+  setup do
+    @app = ActionDispatch::ActionableExceptions.new(Noop)
+
+    Actions.clear
+  end
+
+  test "dispatches an actionable error" do
+    post ActionDispatch::ActionableExceptions.endpoint, params: {
+      error: ActionError.name,
+      action: "Successful action",
+      location: "/",
+    }
+
+    assert_equal ["Action!"], Actions
+
+    assert_equal 302, response.status
+    assert_equal "/", response.headers["Location"]
+  end
+
+  test "cannot dispatch errors if not allowed" do
+    post ActionDispatch::ActionableExceptions.endpoint, params: {
+      error: ActionError.name,
+      action: "Successful action",
+      location: "/",
+    }, headers: { "action_dispatch.show_exceptions" => false }
+
+    assert_empty Actions
+  end
+
+  test "dispatched action can fail" do
+    assert_raise RuntimeError do
+      post ActionDispatch::ActionableExceptions.endpoint, params: {
+        error: ActionError.name,
+        action: "Failed action",
+        location: "/",
+      }
+    end
+  end
+
+  test "cannot dispatch non-actionable errors" do
+    assert_raise ActiveSupport::ActionableError::NonActionable do
+      post ActionDispatch::ActionableExceptions.endpoint, params: {
+        error: RuntimeError.name,
+        action: "Inexistent action",
+        location: "/",
+      }
+    end
+  end
+
+  test "cannot dispatch Inexistent errors" do
+    assert_raise ActiveSupport::ActionableError::NonActionable do
+      post ActionDispatch::ActionableExceptions.endpoint, params: {
+        error: "",
+        action: "Inexistent action",
+        location: "/",
+      }
+    end
+  end
+end
diff --git a/actionpack/test/dispatch/debug_exceptions_test.rb b/actionpack/test/dispatch/debug_exceptions_test.rb
index 2812b1b614..5ae8a20ae4 100644
--- a/actionpack/test/dispatch/debug_exceptions_test.rb
+++ b/actionpack/test/dispatch/debug_exceptions_test.rb
@@ -5,6 +5,18 @@ require "abstract_unit"
 class DebugExceptionsTest < ActionDispatch::IntegrationTest
   InterceptedErrorInstance = StandardError.new
 
+  class CustomActionableError < StandardError
+    include ActiveSupport::ActionableError
+
+    action "Action 1" do
+      nil
+    end
+
+    action "Action 2" do
+      nil
+    end
+  end
+
   class Boomer
     attr_accessor :closed
 
@@ -92,6 +104,8 @@ class DebugExceptionsTest < ActionDispatch::IntegrationTest
         method_that_raises
       when "/nested_exceptions"
         raise_nested_exceptions
+      when %r{/actionable_error}
+        raise CustomActionableError
       else
         raise "puke!"
       end
@@ -589,4 +603,21 @@ class DebugExceptionsTest < ActionDispatch::IntegrationTest
       end
     end
   end
+
+  test "shows a buttons for every action in an actionable error" do
+    @app = DevelopmentApp
+    Rails.stub :root, Pathname.new(".") do
+      cleaner = ActiveSupport::BacktraceCleaner.new.tap do |bc|
+        bc.add_silencer { |line| line !~ %r{test/dispatch/debug_exceptions_test.rb} }
+      end
+
+      get "/actionable_error", headers: { "action_dispatch.backtrace_cleaner" => cleaner }
+
+      # Assert correct error
+      assert_response 500
+
+      assert_select 'input[value="Action 1"]'
+      assert_select 'input[value="Action 2"]'
+    end
+  end
 end