Sha256: 0ef489efb481c575ea7483e3683a912637153a133d6a210fa1f2135c637dedb7

Contents?: true

Size: 1.35 KB

Versions: 52

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 on 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

52 entries across 51 versions & 8 rubygems

Version Path
actionpack-4.2.11.3 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.11.2 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.11.1 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.11 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.10 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.10.rc1 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.9 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.9.rc2 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.9.rc1 lib/action_dispatch/middleware/request_id.rb
enju_leaf-1.2.1 vendor/bundle/ruby/2.3/gems/actionpack-4.2.8/lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.8 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.8.rc1 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.7.1 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.7 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.7.rc1 lib/action_dispatch/middleware/request_id.rb
ish_lib_manager-0.0.1 test/dummy/vendor/bundle/ruby/2.3.0/gems/actionpack-4.2.6/lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.6 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.6.rc1 lib/action_dispatch/middleware/request_id.rb
actionpack-4.2.5.2 lib/action_dispatch/middleware/request_id.rb
activejob-lock-0.0.2 rails/actionpack/lib/action_dispatch/middleware/request_id.rb