From 83b4e9073f0852afc065ef398bd3ad9b5a6db29c Mon Sep 17 00:00:00 2001 From: Jorge Bejar Date: Mon, 6 Jul 2015 21:33:19 -0300 Subject: Response when error should be formatted properly in Rails API if local request --- railties/lib/rails/application/default_middleware_stack.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'railties/lib') diff --git a/railties/lib/rails/application/default_middleware_stack.rb b/railties/lib/rails/application/default_middleware_stack.rb index 5cb5bfb8b7..9201395091 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.api_only middleware.use ::ActionDispatch::RemoteIp, config.action_dispatch.ip_spoofing_check, config.action_dispatch.trusted_proxies unless config.cache_classes -- cgit v1.2.3 From 668d94fff644e87d49004e4f48143f5561e8c9a0 Mon Sep 17 00:00:00 2001 From: Jorge Bejar Date: Mon, 20 Jul 2015 16:37:19 -0300 Subject: Add debug_exception_response_format config to configure DebugException behavior --- railties/lib/rails/application/configuration.rb | 61 +++++++++++----------- .../config/environments/development.rb.tt | 8 +++ 2 files changed, 39 insertions(+), 30 deletions(-) (limited to 'railties/lib') diff --git a/railties/lib/rails/application/configuration.rb b/railties/lib/rails/application/configuration.rb index 91ed835bd6..bb5f0a21d8 100644 --- a/railties/lib/rails/application/configuration.rb +++ b/railties/lib/rails/application/configuration.rb @@ -19,40 +19,41 @@ module Rails :beginning_of_week, :filter_redirect, :x attr_writer :log_level - attr_reader :encoding, :api_only, :static_cache_control + attr_reader :encoding, :api_only, :static_cache_control, :debug_exception_response_format 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 = :default + @x = Custom.new end def static_cache_control=(value) 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..eaa885671b 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,15 @@ Rails.application.configure do config.action_controller.perform_caching = false config.cache_store = :null_store end + <%- if options[:api] -%> + # Return error responses in the format requested by the client + # or default to JSON format. + # This option is useful for Rails API only applications developers + # who prefer to render errors in the expected format instead of + # rendering a HTML page with debug info and web-console. + config.debug_exception_response_format = :api + <%- end -%> <%- unless options.skip_action_mailer? -%> # Don't care if the mailer can't send. -- cgit v1.2.3 From 6fa2023c816e8dc8d2735a5fe87098ef5d8253f9 Mon Sep 17 00:00:00 2001 From: Jorge Bejar Date: Mon, 20 Jul 2015 16:38:09 -0300 Subject: DebugException initialize with a response_format value --- railties/lib/rails/application/default_middleware_stack.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'railties/lib') diff --git a/railties/lib/rails/application/default_middleware_stack.rb b/railties/lib/rails/application/default_middleware_stack.rb index 9201395091..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, config.api_only + 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 -- cgit v1.2.3 From cd27e1fe35e02c2059c18327749f2372191bb65e Mon Sep 17 00:00:00 2001 From: Jorge Bejar Date: Tue, 21 Jul 2015 12:01:18 -0300 Subject: Fix indent in generated Rails API env file --- .../app/templates/config/environments/development.rb.tt | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'railties/lib') 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 eaa885671b..238f45251e 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 @@ -25,12 +25,12 @@ Rails.application.configure do end <%- if options[:api] -%> - # Return error responses in the format requested by the client - # or default to JSON format. - # This option is useful for Rails API only applications developers - # who prefer to render errors in the expected format instead of - # rendering a HTML page with debug info and web-console. - config.debug_exception_response_format = :api + # Return error responses in the format requested by the client + # or default to JSON format. + # This option is useful for Rails API only applications developers + # who prefer to render errors in the expected format instead of + # rendering a HTML page with debug info and web-console. + config.debug_exception_response_format = :api <%- end -%> <%- unless options.skip_action_mailer? -%> -- cgit v1.2.3 From c97e71616b1689367d07044bbb67be12d7922a0d Mon Sep 17 00:00:00 2001 From: Jorge Bejar Date: Tue, 21 Jul 2015 12:09:59 -0300 Subject: debug_exception_response_format needs to be writeable in Configuration --- railties/lib/rails/application/configuration.rb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'railties/lib') diff --git a/railties/lib/rails/application/configuration.rb b/railties/lib/rails/application/configuration.rb index bb5f0a21d8..071677848e 100644 --- a/railties/lib/rails/application/configuration.rb +++ b/railties/lib/rails/application/configuration.rb @@ -16,10 +16,10 @@ module Rails :railties_order, :relative_url_root, :secret_key_base, :secret_token, :ssl_options, :public_file_server, :session_options, :time_zone, :reload_classes_only_on_change, - :beginning_of_week, :filter_redirect, :x + :beginning_of_week, :filter_redirect, :debug_exception_response_format, :x attr_writer :log_level - attr_reader :encoding, :api_only, :static_cache_control, :debug_exception_response_format + attr_reader :encoding, :api_only, :static_cache_control def initialize(*) super -- cgit v1.2.3 From fa092512a00f6055326ae22e7b0d3218e8921a99 Mon Sep 17 00:00:00 2001 From: Jorge Bejar Date: Tue, 11 Aug 2015 14:26:35 -0300 Subject: Adjust comment in development.rb template file for app generator --- .../rails/app/templates/config/environments/development.rb.tt | 3 --- 1 file changed, 3 deletions(-) (limited to 'railties/lib') 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 238f45251e..f91512b3af 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 @@ -27,9 +27,6 @@ Rails.application.configure do # Return error responses in the format requested by the client # or default to JSON format. - # This option is useful for Rails API only applications developers - # who prefer to render errors in the expected format instead of - # rendering a HTML page with debug info and web-console. config.debug_exception_response_format = :api <%- end -%> <%- unless options.skip_action_mailer? -%> -- cgit v1.2.3 From a0343d11f1bf80a79e273c1d0cf9934ef2601e98 Mon Sep 17 00:00:00 2001 From: Jorge Bejar Date: Fri, 4 Dec 2015 18:05:45 -0300 Subject: Make debug_exception_response_format config depends on api_only when is not set --- railties/lib/rails/application/configuration.rb | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'railties/lib') diff --git a/railties/lib/rails/application/configuration.rb b/railties/lib/rails/application/configuration.rb index 071677848e..a5550df0de 100644 --- a/railties/lib/rails/application/configuration.rb +++ b/railties/lib/rails/application/configuration.rb @@ -16,7 +16,7 @@ module Rails :railties_order, :relative_url_root, :secret_key_base, :secret_token, :ssl_options, :public_file_server, :session_options, :time_zone, :reload_classes_only_on_change, - :beginning_of_week, :filter_redirect, :debug_exception_response_format, :x + :beginning_of_week, :filter_redirect, :x attr_writer :log_level attr_reader :encoding, :api_only, :static_cache_control @@ -52,7 +52,7 @@ module Rails @secret_token = nil @secret_key_base = nil @api_only = false - @debug_exception_response_format = :default + @debug_exception_response_format = nil @x = Custom.new end @@ -96,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 -- cgit v1.2.3 From 34bfca2fee65bc7b6bf8b64a890bd423595554c9 Mon Sep 17 00:00:00 2001 From: Jorge Bejar Date: Wed, 9 Dec 2015 10:48:59 -0300 Subject: We don't need to set config.debug_exception_response_format given that :api is the default value for only API apps --- .../rails/app/templates/config/environments/development.rb.tt | 6 ------ 1 file changed, 6 deletions(-) (limited to 'railties/lib') 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 f91512b3af..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,12 +23,6 @@ Rails.application.configure do config.action_controller.perform_caching = false config.cache_store = :null_store end - <%- if options[:api] -%> - - # Return error responses in the format requested by the client - # or default to JSON format. - config.debug_exception_response_format = :api - <%- end -%> <%- unless options.skip_action_mailer? -%> # Don't care if the mailer can't send. -- cgit v1.2.3