Пользовательская обработка ошибок с Rails 4.0
Я строю API Ruby on Rails, используя Ruby 2.0 и Rails 4.0. Мое приложение - это почти исключительно JSON API, поэтому в случае возникновения ошибки (500, 404) я хочу зафиксировать эту ошибку и вернуть красиво отформатированное сообщение об ошибке JSON.
Я пробовал это, а также:
rescue_from ActionController::RoutingError, :with => :error_render_method
def error_render_method
puts "HANDLING ERROR"
render :json => { :errors => "Method not found." }, :status => :not_found
true
end
В моем ApplicationController.
Ни один из них не делает трюк (исключения не фиксируются вообще). Мой поиск в Google показывает, что это сильно изменилось между 3.1, 3.2, и я не могу найти хорошую документацию о том, как это сделать в Rails 4.0.
Кто-нибудь знает?
Редактировать Вот трассировка стека, когда я иду на страницу 404:
Started GET "/testing" for 127.0.0.1 at 2013-08-21 09:50:42 -0400
ActionController::RoutingError (No route matches [GET] "/testing"):
actionpack (4.0.0) lib/action_dispatch/middleware/debug_exceptions.rb:21:in `call'
actionpack (4.0.0) lib/action_dispatch/middleware/show_exceptions.rb:30:in `call'
railties (4.0.0) lib/rails/rack/logger.rb:38:in `call_app'
railties (4.0.0) lib/rails/rack/logger.rb:21:in `block in call'
activesupport (4.0.0) lib/active_support/tagged_logging.rb:67:in `block in tagged'
activesupport (4.0.0) lib/active_support/tagged_logging.rb:25:in `tagged'
activesupport (4.0.0) lib/active_support/tagged_logging.rb:67:in `tagged'
railties (4.0.0) lib/rails/rack/logger.rb:21:in `call'
actionpack (4.0.0) lib/action_dispatch/middleware/request_id.rb:21:in `call'
rack (1.5.2) lib/rack/methodoverride.rb:21:in `call'
rack (1.5.2) lib/rack/runtime.rb:17:in `call'
activesupport (4.0.0) lib/active_support/cache/strategy/local_cache.rb:83:in `call'
rack (1.5.2) lib/rack/lock.rb:17:in `call'
actionpack (4.0.0) lib/action_dispatch/middleware/static.rb:64:in `call'
railties (4.0.0) lib/rails/engine.rb:511:in `call'
railties (4.0.0) lib/rails/application.rb:97:in `call'
rack (1.5.2) lib/rack/lock.rb:17:in `call'
rack (1.5.2) lib/rack/content_length.rb:14:in `call'
rack (1.5.2) lib/rack/handler/webrick.rb:60:in `service'
/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/webrick/httpserver.rb:138:in `service'
/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/webrick/httpserver.rb:94:in `run'
/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/webrick/server.rb:295:in `block in start_thread'
Rendered /Library/Ruby/Gems/2.0.0/gems/actionpack-4.0.0/lib/action_dispatch/middleware/templates/rescues/_trace.erb (1.0ms)
Rendered /Library/Ruby/Gems/2.0.0/gems/actionpack-4.0.0/lib/action_dispatch/middleware/templates/routes/_route.html.erb (2.9ms)
Rendered /Library/Ruby/Gems/2.0.0/gems/actionpack-4.0.0/lib/action_dispatch/middleware/templates/routes/_route.html.erb (0.9ms)
Rendered /Library/Ruby/Gems/2.0.0/gems/actionpack-4.0.0/lib/action_dispatch/middleware/templates/routes/_table.html.erb (1.1ms)
Rendered /Library/Ruby/Gems/2.0.0/gems/actionpack-4.0.0/lib/action_dispatch/middleware/templates/rescues/routing_error.erb within rescues/layout (38.3ms)
Я не думаю, что я хочу, чтобы это когда-либо заходило так далеко, что-то должно его поймать и вернуть соответствующий ответ об ошибке json.
5 ответов
Запрос даже не попадает в ваше приложение.
Вам нужно определить универсальный маршрут, чтобы Rails отправлял запрос вашему приложению, а не отображал ошибку (в разработке) или отображал страницу public/404.html (в разработке)
Измените ваш файл rout.RB, чтобы включить следующее
match "*path", to: "errors#catch_404", via: :all
И в вашем контроллере
class ErrorsController < ApplicationController
def catch_404
raise ActionController::RoutingError.new(params[:path])
end
end
И ваш rescue_from
должен поймать ошибку тогда.
Попробовав несколько вариантов, я остановился на этом как на простейшем способе обработки API 404:
# Passing request spec
describe 'making a request to an unrecognised path' do
before { host! 'api.example.com' }
it 'returns 404' do
get '/nowhere'
expect(response.status).to eq(404)
end
end
# routing
constraints subdomain: 'api' do
namespace :api, path: '', defaults: { format: 'json' } do
scope module: :v1, constraints: ApiConstraints.new(1) do
# ... actual routes omitted ...
end
match "*path", to: -> (env) { [404, {}, ['{"error": "not_found"}']] }, via: :all
end
end
Это работает в rails4, таким образом, вы можете напрямую управлять всеми ошибками: например, вы можете отобразить error_info как json, когда происходит ошибка из вызова API.
application_controller.rb
class ApplicationController < ActionController::Base
protect_from_forgery
# CUSTOM EXCEPTION HANDLING
rescue_from StandardError do |e|
error(e)
end
def routing_error
raise ActionController::RoutingError.new(params[:path])
end
protected
def error(e)
#render :template => "#{Rails::root}/public/404.html"
if env["ORIGINAL_FULLPATH"] =~ /^\/api/
error_info = {
:error => "internal-server-error",
:exception => "#{e.class.name} : #{e.message}",
}
error_info[:trace] = e.backtrace[0,10] if Rails.env.development?
render :json => error_info.to_json, :status => 500
else
#render :text => "500 Internal Server Error", :status => 500 # You can render your own template here
raise e
end
end
# ...
end
routes.rb
MyApp::Application.routes.draw do
# ...
# Any other routes are handled here (as ActionDispatch prevents RoutingError from hitting ApplicationController::rescue_action).
match "*path", :to => "application#routing_error", :via => :all
end
Я использовал 404.html из общей папки, и это в среде разработчика.
Я на самом деле получил ответ от:
Тем не менее, я немного поэкспериментировал с тем, какие фрагменты кода на самом деле заставляли его работать Вот фрагменты кода, которые я только добавил.
конфиг / routes.rb
Rails.application.routes.draw do
// other routes
match "*path", to: "application#catch_404", via: :all
end
приложение / контроллеры / application_controller.rb
class ApplicationController < ActionController::Base
def catch_404
render :file => 'public/404.html', :status => :not_found
end
end
Буду признателен за любые комментарии и разъяснения о том, почему некоторые из оригинала необходимы. Например, используя эту строку кода
raise ActionController::RoutingError.new(params[:path])
и это
rescue_from ActionController::RoutingError, :with => :error_render_method
Так как rescue_from
а также raise ActionController::RoutingError
кажется популярным ответом из старых версий Rails.
Попробуйте это, если хотите одинаково реагировать на все типы ошибок.
rescue_from StandardError, :with => :error_render_method
Если вам не нужно это поведение в режиме разработки, добавьте приведенный выше код в
unless Rails.application.config.consider_all_requests_local