Merge pull request #20831 from jmbejar/rails-api-json-error-response

Rails API: Ability to return error responses in json format also in development

5 files changed, 90 insertions, 31 deletions

diff --git a/railties/CHANGELOG.md b/railties/CHANGELOG.md
index e6bee302a3..e5ab31005e 100644
--- a/railties/CHANGELOG.md
+++ b/railties/CHANGELOG.md
@@ -1,3 +1,12 @@
+*   `config.debug_exception_response_format` configures the format used
+    in responses when errors occur in development mode.
+
+    Set `config.debug_exception_response_format` to render an HTML page with
+    debug info (using the value `:default`) or render debug info preserving
+    the response format (using the value `:api`).
+
+    *Jorge Bejar*
+
 *   Fix setting exit status code for rake test tasks. The exit status code
     was not set when tests were fired with `rake`. Now, it is being set and it matches
     behavior of running tests via `rails` command (`rails test`), so no matter if
diff --git a/railties/lib/rails/application/configuration.rb b/railties/lib/rails/application/configuration.rb
index 91ed835bd6..a5550df0de 100644
--- a/railties/lib/rails/application/configuration.rb
+++ b/railties/lib/rails/application/configuration.rb
@@ -24,35 +24,36 @@ module Rails
       def initialize(*)
         super
         self.encoding = "utf-8"
-        @allow_concurrency             = nil
-        @consider_all_requests_local   = false
-        @filter_parameters             = []
-        @filter_redirect               = []
-        @helpers_paths                 = []
-        @public_file_server            = ActiveSupport::OrderedOptions.new
-        @public_file_server.enabled    = true
-        @public_file_server.index_name = "index"
-        @force_ssl                     = false
-        @ssl_options                   = {}
-        @session_store                 = :cookie_store
-        @session_options               = {}
-        @time_zone                     = "UTC"
-        @beginning_of_week             = :monday
-        @log_level                     = nil
-        @generators                    = app_generators
-        @cache_store                   = [ :file_store, "#{root}/tmp/cache/" ]
-        @railties_order                = [:all]
-        @relative_url_root             = ENV["RAILS_RELATIVE_URL_ROOT"]
-        @reload_classes_only_on_change = true
-        @file_watcher                  = file_update_checker
-        @exceptions_app                = nil
-        @autoflush_log                 = true
-        @log_formatter                 = ActiveSupport::Logger::SimpleFormatter.new
-        @eager_load                    = nil
-        @secret_token                  = nil
-        @secret_key_base               = nil
-        @api_only                      = false
-        @x                             = Custom.new
+        @allow_concurrency               = nil
+        @consider_all_requests_local     = false
+        @filter_parameters               = []
+        @filter_redirect                 = []
+        @helpers_paths                   = []
+        @public_file_server              = ActiveSupport::OrderedOptions.new
+        @public_file_server.enabled      = true
+        @public_file_server.index_name   = "index"
+        @force_ssl                       = false
+        @ssl_options                     = {}
+        @session_store                   = :cookie_store
+        @session_options                 = {}
+        @time_zone                       = "UTC"
+        @beginning_of_week               = :monday
+        @log_level                       = nil
+        @generators                      = app_generators
+        @cache_store                     = [ :file_store, "#{root}/tmp/cache/" ]
+        @railties_order                  = [:all]
+        @relative_url_root               = ENV["RAILS_RELATIVE_URL_ROOT"]
+        @reload_classes_only_on_change   = true
+        @file_watcher                    = file_update_checker
+        @exceptions_app                  = nil
+        @autoflush_log                   = true
+        @log_formatter                   = ActiveSupport::Logger::SimpleFormatter.new
+        @eager_load                      = nil
+        @secret_token                    = nil
+        @secret_key_base                 = nil
+        @api_only                        = false
+        @debug_exception_response_format = nil
+        @x                               = Custom.new
       end
 
       def static_cache_control=(value)
@@ -95,6 +96,16 @@ module Rails
       def api_only=(value)
         @api_only = value
         generators.api_only = value
+
+        @debug_exception_response_format ||= :api
+      end
+
+      def debug_exception_response_format
+        @debug_exception_response_format || :default
+      end
+
+      def debug_exception_response_format=(value)
+        @debug_exception_response_format = value
       end
 
       def paths
diff --git a/railties/lib/rails/application/default_middleware_stack.rb b/railties/lib/rails/application/default_middleware_stack.rb
index 5cb5bfb8b7..ed6a1f82d3 100644
--- a/railties/lib/rails/application/default_middleware_stack.rb
+++ b/railties/lib/rails/application/default_middleware_stack.rb
@@ -57,7 +57,7 @@ module Rails
           # Must come after Rack::MethodOverride to properly log overridden methods
           middleware.use ::Rails::Rack::Logger, config.log_tags
           middleware.use ::ActionDispatch::ShowExceptions, show_exceptions_app
-          middleware.use ::ActionDispatch::DebugExceptions, app
+          middleware.use ::ActionDispatch::DebugExceptions, app, config.debug_exception_response_format
           middleware.use ::ActionDispatch::RemoteIp, config.action_dispatch.ip_spoofing_check, config.action_dispatch.trusted_proxies
 
           unless config.cache_classes
diff --git a/railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt b/railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt
index 4dd20a9d2e..2778dd8247 100644
--- a/railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt
+++ b/railties/lib/rails/generators/rails/app/templates/config/environments/development.rb.tt
@@ -23,7 +23,6 @@ Rails.application.configure do
     config.action_controller.perform_caching = false
     config.cache_store = :null_store
   end
-
   <%- unless options.skip_action_mailer? -%>
 
   # Don't care if the mailer can't send.
diff --git a/railties/test/application/configuration_test.rb b/railties/test/application/configuration_test.rb
index 5f3d1879eb..49f63d5d31 100644
--- a/railties/test/application/configuration_test.rb
+++ b/railties/test/application/configuration_test.rb
@@ -1393,5 +1393,45 @@ module ApplicationTests
 
       assert_equal 'unicorn', Rails.application.config.my_custom_config['key']
     end
+
+    test "api_only is false by default" do
+      app 'development'
+      refute Rails.application.config.api_only
+    end
+
+    test "api_only generator config is set when api_only is set" do
+      add_to_config <<-RUBY
+        config.api_only = true
+      RUBY
+      app 'development'
+
+      Rails.application.load_generators
+      assert Rails.configuration.api_only
+    end
+
+    test "debug_exception_response_format is :api by default if only_api is enabled" do
+      add_to_config <<-RUBY
+        config.api_only = true
+      RUBY
+      app 'development'
+
+      assert_equal :api, Rails.configuration.debug_exception_response_format
+    end
+
+    test "debug_exception_response_format can be override" do
+      add_to_config <<-RUBY
+        config.api_only = true
+      RUBY
+
+      app_file 'config/environments/development.rb', <<-RUBY
+      Rails.application.configure do
+        config.debug_exception_response_format = :default
+      end
+      RUBY
+
+      app 'development'
+
+      assert_equal :default, Rails.configuration.debug_exception_response_format
+    end
   end
 end