Contents

# frozen_string_literal: true

# :markup: markdown

require "securerandom"
require "active_support/core_ext/string/access"

module ActionDispatch
  # # Action Dispatch RequestId
  #
  # Makes a unique request id available to the `action_dispatch.request_id` env
  # variable (which is then accessible through ActionDispatch::Request#request_id
  # or the alias 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, header:)
      @app = app
      @header = header
    end

    def call(env)
      req = ActionDispatch::Request.new env
      req.request_id = make_request_id(req.headers[@header])
      @app.call(env).tap { |_status, headers, _body| headers[@header] = req.request_id }
    end

    private
      def make_request_id(request_id)
        if request_id.presence
          request_id.gsub(/[^\w\-@]/, "").first(255)
        else
          internal_request_id
        end
      end

      def internal_request_id
        SecureRandom.uuid
      end
  end
end

Version data entries

10 entries across 10 versions & 1 rubygems

Version	Path
actionpack-7.2.2.1	lib/action_dispatch/middleware/request_id.rb
actionpack-7.2.2	lib/action_dispatch/middleware/request_id.rb
actionpack-7.2.1.2	lib/action_dispatch/middleware/request_id.rb
actionpack-7.2.1.1	lib/action_dispatch/middleware/request_id.rb
actionpack-7.2.1	lib/action_dispatch/middleware/request_id.rb
actionpack-7.2.0	lib/action_dispatch/middleware/request_id.rb
actionpack-7.2.0.rc1	lib/action_dispatch/middleware/request_id.rb
actionpack-7.2.0.beta3	lib/action_dispatch/middleware/request_id.rb
actionpack-7.2.0.beta2	lib/action_dispatch/middleware/request_id.rb
actionpack-7.2.0.beta1	lib/action_dispatch/middleware/request_id.rb