Как спасти от ActionDispatch:: ParamsParser:: ParseError в Rails 4

Rails 4 добавляет исключение ActionDispatch:: ParamsParser:: ParseError, но, поскольку он находится в стеке промежуточного программного обеспечения, он не может быть спасен в среде обычного контроллера. В json API-приложении я хочу отвечать стандартным форматом ошибок.

В этом gist показана стратегия вставки промежуточного программного обеспечения для перехвата и ответа. Следуя этой схеме, я:

application.rb:

module Traphos
  class Application < Rails::Application
    ....
    config.middleware.insert_before ActionDispatch::ParamsParser, "JSONParseError"
 end
end

И промежуточное ПО:

class JSONParseError
  def initialize(app)
    @app = app
  end

  def call(env)
    begin
      @app.call(env)
    rescue ActionDispatch::ParamsParser::ParseError => e
      [422, {}, ['Parse Error']]
    end
  end
end

Если я запускаю свой тест без промежуточного ПО, я получаю (spec):

Failures:

  1) Photo update attributes with non-parseable json
     Failure/Error: patch update_url, {:description => description}, "CONTENT_TYPE" => content_type, "HTTP_ACCEPT" => accepts, "HTTP_AUTHORIZATION" => @auth
     ActionDispatch::ParamsParser::ParseError:
       399: unexpected token at 'description=Test+New+Description]'

Это именно то, чего я ожидал бы (ParseError, что я не могу спасти_из).

Теперь с единственным изменением для добавления промежуточного программного обеспечения выше:

  2) Photo update attributes with non-parseable json
     Failure/Error: response.status.should eql(422)

       expected: 422
            got: 200

И журнал показывает, что выполняется действие стандартного контроллера и возвращает нормальный ответ (хотя, поскольку он не получил никаких параметров, он ничего не обновлял).

Мои вопросы:

  • Как можно спасти от ParseError и вернуть настраиваемый ответ. Похоже, я на правильном пути, но не совсем там.

  • Я не могу понять, почему, когда исключение создано и спасено, действие контроллера продолжается.

Помогите оценить, --Kip

Ответы

Ответ 1

Оказывается, что в дополнение к стеку промежуточного программного обеспечения ActionDispatch:: ShowExceptions можно настроить с помощью приложения исключений.

module Traphos
  class Application < Rails::Application
    # For the exceptions app
    require "#{config.root}/lib/exceptions/public_exceptions"
    config.exceptions_app = Traphos::PublicExceptions.new(Rails.public_path)
  end
end

Основываясь на Rails, предоставленном мной, я теперь использую:

module Traphos
  class PublicExceptions
    attr_accessor :public_path

    def initialize(public_path)
      @public_path = public_path
    end

    def call(env)
      exception    = env["action_dispatch.exception"]
      status       = code_from_exception(env["PATH_INFO"][1..-1], exception)
      request      = ActionDispatch::Request.new(env)
      content_type = request.formats.first
      body         = {:status => { :code => status, :exception => exception.class.name, :message => exception.message }}
      render(status, content_type, body)
    end

    private

    def render(status, content_type, body)
      format = content_type && "to_#{content_type.to_sym}"
      if format && body.respond_to?(format)
        render_format(status, content_type, body.public_send(format))
      else
        render_html(status)
      end
    end

    def render_format(status, content_type, body)
      [status, {'Content-Type' => "#{content_type}; charset=#{ActionDispatch::Response.default_charset}",
                'Content-Length' => body.bytesize.to_s}, [body]]
    end

    def render_html(status)
      found = false
      path = "#{public_path}/#{status}.#{I18n.locale}.html" if I18n.locale
      path = "#{public_path}/#{status}.html" unless path && (found = File.exist?(path))

      if found || File.exist?(path)
        render_format(status, 'text/html', File.read(path))
      else
        [404, { "X-Cascade" => "pass" }, []]
      end
    end

    def code_from_exception(status, exception)
      case exception
      when ActionDispatch::ParamsParser::ParseError
        "422"
      else
        status
      end
    end
  end
end

Чтобы использовать его в тестовой среде, необходимо установить параметры конфигурации (в противном случае вы получите стандартную обработку исключений при разработке и тестировании). Итак, чтобы проверить, что у меня (отредактировано просто ключевые части):

describe Photo, :type => :api do
  context 'update' do
    it 'attributes with non-parseable json' do 

      Rails.application.config.consider_all_requests_local = false
      Rails.application.config.action_dispatch.show_exceptions = true

      patch update_url, {:description => description}
      response.status.should eql(422)
      result = JSON.parse(response.body)
      result['status']['exception'].should match(/ParseError/)

      Rails.application.config.consider_all_requests_local = true
      Rails.application.config.action_dispatch.show_exceptions = false
    end
  end
end

Что выполняет, как мне нужно, в общедоступном API-интерфейсе и адаптируется для любых других исключений, которые я могу выбрать для настройки.

Ответ 2

Эта статья (также из 2013 года) thinkbot также охватывает эту тему. Они помещают свои ответы в этот сервис промежуточного программного обеспечения, только если вы запросили json

if env['HTTP_ACCEPT'] =~ /application\/json/
    error_output = "There was a problem in the JSON you submitted: #{error}"
    return [
      400, { "Content-Type" => "application/json" },
      [ { status: 400, error: error_output }.to_json ]
    ]
else
 raise error
end