grape-middleware-logger/lib/grape/middleware/logger.rb

104 lines
2.6 KiB
Ruby

require 'logger'
require 'grape'
class Grape::Middleware::Logger < Grape::Middleware::Globals
BACKSLASH = '/'.freeze
attr_reader :logger
def initialize(_, options = {})
super
@logger = options[:logger]
@logger ||= Rails.logger if defined?(Rails) && Rails.logger.present?
@logger ||= default_logger
end
def before
start_time
# sets env['grape.*']
super
logger.info ''
logger.info %Q(Started %s "%s" at %s) % [
env[Grape::Env::GRAPE_REQUEST].request_method,
env[Grape::Env::GRAPE_REQUEST].path,
start_time.to_s
]
logger.info %Q(Processing by #{processed_by})
logger.info %Q( Parameters: #{parameters})
end
# @note Error and exception handling are required for the +after+ hooks
# Exceptions are logged as a 500 status and re-raised
# Other "errors" are caught, logged and re-thrown
def call!(env)
@env = env
before
error = catch(:error) do
begin
@app_response = @app.call(@env)
rescue => e
after_exception(e)
raise e
end
nil
end
if error
after_failure(error)
throw(:error, error)
else
# Usually a rack response object is returned: https://github.com/ruby-grape/grape/blob/master/UPGRADING.md#changes-in-middleware
# However, rack/auth/abstract/handler.rb still returns an array instead of a rack response object.
if @app_response.is_a?(Array)
after(@app_response[0])
else
after(@app_response.status)
end
end
@app_response
end
def after(status)
logger.info "Completed #{status} in #{((Time.now - start_time) * 1000).round(2)}ms"
logger.info ''
end
#
# Helpers
#
def after_exception(e)
logger.info %Q( Error: #{e.message})
after(500)
end
def after_failure(error)
logger.info %Q( Error: #{error[:message]}) if error[:message]
after(error[:status])
end
def parameters
request_params = env[Grape::Env::GRAPE_REQUEST_PARAMS].to_hash
request_params.merge!(env['action_dispatch.request.request_parameters'.freeze] || {}) # for Rails
if @options[:filter]
@options[:filter].filter(request_params)
else
request_params
end
end
def start_time
@start_time ||= Time.now
end
def processed_by
endpoint = env[Grape::Env::API_ENDPOINT]
endpoint.options[:for].to_s << '#'.freeze << endpoint.options[:path].map { |path| path.to_s.sub(BACKSLASH, '') }.join(BACKSLASH)
end
def default_logger
default = Logger.new(STDOUT)
default.formatter = ->(*args) { args.last.to_s << "\n".freeze }
default
end
end