Sha256: 460753496c933aa3231f01cd194a6d33e6c32ddf9729d74476067178942d33f2

Contents?: true

Size: 1.35 KB

Versions: 73

Compression:

Stored size: 1.35 KB

Contents

require 'securerandom'
require 'active_support/core_ext/string/access'

module ActionDispatch
  # Makes a unique request id available to the action_dispatch.request_id env variable (which is then accessible through
  # ActionDispatch::Request#uuid) and sends the same id to the client via the X-Request-Id header.
  #
  # The unique request id is either based off the X-Request-Id header in the request, which would typically be generated
  # by a firewall, load balancer, or the web server, or, if this header is not available, a random uuid. If the
  # header is accepted from the outside world, we sanitize it to a max of 255 chars and alphanumeric and dashes only.
  #
  # The unique request id can be used to trace a request end-to-end and would typically end up being part of log files
  # from multiple pieces of the stack.
  class RequestId
    def initialize(app)
      @app = app
    end

    def call(env)
      env["action_dispatch.request_id"] = external_request_id(env) || internal_request_id
      @app.call(env).tap { |_status, headers, _body| headers["X-Request-Id"] = env["action_dispatch.request_id"] }
    end

    private
      def external_request_id(env)
        if request_id = env["HTTP_X_REQUEST_ID"].presence
          request_id.gsub(/[^\w\-]/, "").first(255)
        end
      end

      def internal_request_id
        SecureRandom.uuid
      end
  end
end

Version data entries

73 entries across 73 versions & 4 rubygems

Version Path
actionpack-4.1.16 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.16.rc1 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.15 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.15.rc1 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.14.2 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.14.1 lib/action_dispatch/middleware/request_id.rb
angular-rails4-templates-0.4.1 vendor/ruby/2.1.0/gems/actionpack-4.1.13/lib/action_dispatch/middleware/request_id.rb
angular-rails4-templates-0.4.0 vendor/ruby/2.1.0/gems/actionpack-4.1.13/lib/action_dispatch/middleware/request_id.rb
angular-rails4-templates-0.3.0 vendor/ruby/2.1.0/gems/actionpack-4.1.13/lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.14 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.14.rc2 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.14.rc1 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.13 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.13.rc1 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.12 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.12.rc1 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.11 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.10 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.10.rc4 lib/action_dispatch/middleware/request_id.rb
actionpack-4.1.10.rc3 lib/action_dispatch/middleware/request_id.rb