actionpack 7.1.5.1 → 7.2.0.beta1

data/lib/action_dispatch/middleware/cookies.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support/core_ext/hash/keys"
 require "active_support/key_generator"
 require "active_support/message_verifier"
@@ -94,97 +96,100 @@ module ActionDispatch
 
   # Read and write data to cookies through ActionController::Cookies#cookies.
   #
-  # When reading cookie data, the data is read from the HTTP request header, Cookie.
-  # When writing cookie data, the data is sent out in the HTTP response header, +Set-Cookie+.
+  # When reading cookie data, the data is read from the HTTP request header,
+  # Cookie. When writing cookie data, the data is sent out in the HTTP response
+  # header, `Set-Cookie`.
   #
   # Examples of writing:
   #
-  #   # Sets a simple session cookie.
-  #   # This cookie will be deleted when the user's browser is closed.
-  #   cookies[:user_name] = "david"
+  #     # Sets a simple session cookie.
+  #     # This cookie will be deleted when the user's browser is closed.
+  #     cookies[:user_name] = "david"
   #
-  #   # Cookie values are String-based. Other data types need to be serialized.
-  #   cookies[:lat_lon] = JSON.generate([47.68, -122.37])
+  #     # Cookie values are String-based. Other data types need to be serialized.
+  #     cookies[:lat_lon] = JSON.generate([47.68, -122.37])
   #
-  #   # Sets a cookie that expires in 1 hour.
-  #   cookies[:login] = { value: "XJ-122", expires: 1.hour }
+  #     # Sets a cookie that expires in 1 hour.
+  #     cookies[:login] = { value: "XJ-122", expires: 1.hour }
   #
-  #   # Sets a cookie that expires at a specific time.
-  #   cookies[:login] = { value: "XJ-122", expires: Time.utc(2020, 10, 15, 5) }
+  #     # Sets a cookie that expires at a specific time.
+  #     cookies[:login] = { value: "XJ-122", expires: Time.utc(2020, 10, 15, 5) }
   #
-  #   # Sets a signed cookie, which prevents users from tampering with its value.
-  #   # It can be read using the signed method `cookies.signed[:name]`
-  #   cookies.signed[:user_id] = current_user.id
+  #     # Sets a signed cookie, which prevents users from tampering with its value.
+  #     # It can be read using the signed method `cookies.signed[:name]`
+  #     cookies.signed[:user_id] = current_user.id
   #
-  #   # Sets an encrypted cookie value before sending it to the client which
-  #   # prevent users from reading and tampering with its value.
-  #   # It can be read using the encrypted method `cookies.encrypted[:name]`
-  #   cookies.encrypted[:discount] = 45
+  #     # Sets an encrypted cookie value before sending it to the client which
+  #     # prevent users from reading and tampering with its value.
+  #     # It can be read using the encrypted method `cookies.encrypted[:name]`
+  #     cookies.encrypted[:discount] = 45
   #
-  #   # Sets a "permanent" cookie (which expires in 20 years from now).
-  #   cookies.permanent[:login] = "XJ-122"
+  #     # Sets a "permanent" cookie (which expires in 20 years from now).
+  #     cookies.permanent[:login] = "XJ-122"
   #
-  #   # You can also chain these methods:
-  #   cookies.signed.permanent[:login] = "XJ-122"
+  #     # You can also chain these methods:
+  #     cookies.signed.permanent[:login] = "XJ-122"
   #
   # Examples of reading:
   #
-  #   cookies[:user_name]           # => "david"
-  #   cookies.size                  # => 2
-  #   JSON.parse(cookies[:lat_lon]) # => [47.68, -122.37]
-  #   cookies.signed[:login]        # => "XJ-122"
-  #   cookies.encrypted[:discount]  # => 45
+  #     cookies[:user_name]           # => "david"
+  #     cookies.size                  # => 2
+  #     JSON.parse(cookies[:lat_lon]) # => [47.68, -122.37]
+  #     cookies.signed[:login]        # => "XJ-122"
+  #     cookies.encrypted[:discount]  # => 45
   #
   # Example for deleting:
   #
-  #   cookies.delete :user_name
+  #     cookies.delete :user_name
   #
-  # Please note that if you specify a +:domain+ when setting a cookie, you must also specify the domain when deleting the cookie:
+  # Please note that if you specify a `:domain` when setting a cookie, you must
+  # also specify the domain when deleting the cookie:
   #
-  #  cookies[:name] = {
-  #    value: 'a yummy cookie',
-  #    expires: 1.year,
-  #    domain: 'domain.com'
-  #  }
+  #     cookies[:name] = {
+  #       value: 'a yummy cookie',
+  #       expires: 1.year,
+  #       domain: 'domain.com'
+  #     }
   #
-  #  cookies.delete(:name, domain: 'domain.com')
+  #     cookies.delete(:name, domain: 'domain.com')
   #
   # The option symbols for setting cookies are:
   #
-  # * <tt>:value</tt> - The cookie's value.
-  # * <tt>:path</tt> - The path for which this cookie applies. Defaults to the root
-  #   of the application.
-  # * <tt>:domain</tt> - The domain for which this cookie applies so you can
-  #   restrict to the domain level. If you use a schema like www.example.com
-  #   and want to share session with user.example.com set <tt>:domain</tt>
-  #   to <tt>:all</tt>. To support multiple domains, provide an array, and
-  #   the first domain matching <tt>request.host</tt> will be used. Make
-  #   sure to specify the <tt>:domain</tt> option with <tt>:all</tt> or
-  #   <tt>Array</tt> again when deleting cookies. For more flexibility you
-  #   can set the domain on a per-request basis by specifying <tt>:domain</tt>
-  #   with a proc.
+  # *   `:value` - The cookie's value.
+  # *   `:path` - The path for which this cookie applies. Defaults to the root of
+  #     the application.
+  # *   `:domain` - The domain for which this cookie applies so you can restrict
+  #     to the domain level. If you use a schema like www.example.com and want to
+  #     share session with user.example.com set `:domain` to `:all`. To support
+  #     multiple domains, provide an array, and the first domain matching
+  #     `request.host` will be used. Make sure to specify the `:domain` option
+  #     with `:all` or `Array` again when deleting cookies. For more flexibility
+  #     you can set the domain on a per-request basis by specifying `:domain` with
+  #     a proc.
   #
-  #     domain: nil  # Does not set cookie domain. (default)
-  #     domain: :all # Allow the cookie for the top most level
-  #                  # domain and subdomains.
-  #     domain: %w(.example.com .example.org) # Allow the cookie
-  #                                           # for concrete domain names.
-  #     domain: proc { Tenant.current.cookie_domain } # Set cookie domain dynamically
-  #     domain: proc { |req| ".sub.#{req.host}" }     # Set cookie domain dynamically based on request
+  #         domain: nil  # Does not set cookie domain. (default)
+  #         domain: :all # Allow the cookie for the top most level
+  #                      # domain and subdomains.
+  #         domain: %w(.example.com .example.org) # Allow the cookie
+  #                                               # for concrete domain names.
+  #         domain: proc { Tenant.current.cookie_domain } # Set cookie domain dynamically
+  #         domain: proc { |req| ".sub.#{req.host}" }     # Set cookie domain dynamically based on request
   #
+  # *   `:tld_length` - When using `:domain => :all`, this option can be used to
+  #     explicitly set the TLD length when using a short (<= 3 character) domain
+  #     that is being interpreted as part of a TLD. For example, to share cookies
+  #     between user1.lvh.me and user2.lvh.me, set `:tld_length` to 2.
+  # *   `:expires` - The time at which this cookie expires, as a Time or
+  #     ActiveSupport::Duration object.
+  # *   `:secure` - Whether this cookie is only transmitted to HTTPS servers.
+  #     Default is `false`.
+  # *   `:httponly` - Whether this cookie is accessible via scripting or only
+  #     HTTP. Defaults to `false`.
+  # *   `:same_site` - The value of the `SameSite` cookie attribute, which
+  #     determines how this cookie should be restricted in cross-site contexts.
+  #     Possible values are `nil`, `:none`, `:lax`, and `:strict`. Defaults to
+  #     `:lax`.
   #
-  # * <tt>:tld_length</tt> - When using <tt>:domain => :all</tt>, this option can be used to explicitly
-  #   set the TLD length when using a short (<= 3 character) domain that is being interpreted as part of a TLD.
-  #   For example, to share cookies between user1.lvh.me and user2.lvh.me, set <tt>:tld_length</tt> to 2.
-  # * <tt>:expires</tt> - The time at which this cookie expires, as a \Time or ActiveSupport::Duration object.
-  # * <tt>:secure</tt> - Whether this cookie is only transmitted to HTTPS servers.
-  #   Default is +false+.
-  # * <tt>:httponly</tt> - Whether this cookie is accessible via scripting or
-  #   only HTTP. Defaults to +false+.
-  # * <tt>:same_site</tt> - The value of the +SameSite+ cookie attribute, which
-  #   determines how this cookie should be restricted in cross-site contexts.
-  #   Possible values are +nil+, +:none+, +:lax+, and +:strict+. Defaults to
-  #   +:lax+.
   class Cookies
     HTTP_HEADER   = "Set-Cookie"
     GENERATOR_KEY = "action_dispatch.key_generator"
@@ -208,59 +213,69 @@ module ActionDispatch
     # Raised when storing more than 4K of session data.
     CookieOverflow = Class.new StandardError
 
-    # Include in a cookie jar to allow chaining, e.g. +cookies.permanent.signed+.
+    # Include in a cookie jar to allow chaining, e.g. `cookies.permanent.signed`.
     module ChainedCookieJars
-      # Returns a jar that'll automatically set the assigned cookies to have an expiration date 20 years from now. Example:
+      # Returns a jar that'll automatically set the assigned cookies to have an
+      # expiration date 20 years from now. Example:
       #
-      #   cookies.permanent[:prefers_open_id] = true
-      #   # => Set-Cookie: prefers_open_id=true; path=/; expires=Sun, 16-Dec-2029 03:24:16 GMT
+      #     cookies.permanent[:prefers_open_id] = true
+      #     # => Set-Cookie: prefers_open_id=true; path=/; expires=Sun, 16-Dec-2029 03:24:16 GMT
       #
-      # This jar is only meant for writing. You'll read permanent cookies through the regular accessor.
+      # This jar is only meant for writing. You'll read permanent cookies through the
+      # regular accessor.
       #
-      # This jar allows chaining with the signed jar as well, so you can set permanent, signed cookies. Examples:
+      # This jar allows chaining with the signed jar as well, so you can set
+      # permanent, signed cookies. Examples:
       #
-      #   cookies.permanent.signed[:remember_me] = current_user.id
-      #   # => Set-Cookie: remember_me=BAhU--848956038e692d7046deab32b7131856ab20e14e; path=/; expires=Sun, 16-Dec-2029 03:24:16 GMT
+      #     cookies.permanent.signed[:remember_me] = current_user.id
+      #     # => Set-Cookie: remember_me=BAhU--848956038e692d7046deab32b7131856ab20e14e; path=/; expires=Sun, 16-Dec-2029 03:24:16 GMT
       def permanent
         @permanent ||= PermanentCookieJar.new(self)
       end
 
-      # Returns a jar that'll automatically generate a signed representation of cookie value and verify it when reading from
-      # the cookie again. This is useful for creating cookies with values that the user is not supposed to change. If a signed
-      # cookie was tampered with by the user (or a 3rd party), +nil+ will be returned.
+      # Returns a jar that'll automatically generate a signed representation of cookie
+      # value and verify it when reading from the cookie again. This is useful for
+      # creating cookies with values that the user is not supposed to change. If a
+      # signed cookie was tampered with by the user (or a 3rd party), `nil` will be
+      # returned.
       #
-      # This jar requires that you set a suitable secret for the verification on your app's +secret_key_base+.
+      # This jar requires that you set a suitable secret for the verification on your
+      # app's `secret_key_base`.
       #
       # Example:
       #
-      #   cookies.signed[:discount] = 45
-      #   # => Set-Cookie: discount=BAhpMg==--2c1c6906c90a3bc4fd54a51ffb41dffa4bf6b5f7; path=/
+      #     cookies.signed[:discount] = 45
+      #     # => Set-Cookie: discount=BAhpMg==--2c1c6906c90a3bc4fd54a51ffb41dffa4bf6b5f7; path=/
       #
-      #   cookies.signed[:discount] # => 45
+      #     cookies.signed[:discount] # => 45
       def signed
         @signed ||= SignedKeyRotatingCookieJar.new(self)
       end
 
-      # Returns a jar that'll automatically encrypt cookie values before sending them to the client and will decrypt them for read.
-      # If the cookie was tampered with by the user (or a 3rd party), +nil+ will be returned.
+      # Returns a jar that'll automatically encrypt cookie values before sending them
+      # to the client and will decrypt them for read. If the cookie was tampered with
+      # by the user (or a 3rd party), `nil` will be returned.
       #
-      # If +config.action_dispatch.encrypted_cookie_salt+ and +config.action_dispatch.encrypted_signed_cookie_salt+
-      # are both set, legacy cookies encrypted with HMAC AES-256-CBC will be transparently upgraded.
+      # If `config.action_dispatch.encrypted_cookie_salt` and
+      # `config.action_dispatch.encrypted_signed_cookie_salt` are both set, legacy
+      # cookies encrypted with HMAC AES-256-CBC will be transparently upgraded.
       #
-      # This jar requires that you set a suitable secret for the verification on your app's +secret_key_base+.
+      # This jar requires that you set a suitable secret for the verification on your
+      # app's `secret_key_base`.
       #
       # Example:
       #
-      #   cookies.encrypted[:discount] = 45
-      #   # => Set-Cookie: discount=DIQ7fw==--K3n//8vvnSbGq9dA--7Xh91HfLpwzbj1czhBiwOg==; path=/
+      #     cookies.encrypted[:discount] = 45
+      #     # => Set-Cookie: discount=DIQ7fw==--K3n//8vvnSbGq9dA--7Xh91HfLpwzbj1czhBiwOg==; path=/
       #
-      #   cookies.encrypted[:discount] # => 45
+      #     cookies.encrypted[:discount] # => 45
       def encrypted
         @encrypted ||= EncryptedKeyRotatingCookieJar.new(self)
       end
 
-      # Returns the +signed+ or +encrypted+ jar, preferring +encrypted+ if +secret_key_base+ is set.
-      # Used by ActionDispatch::Session::CookieStore to avoid the need to introduce new cookie stores.
+      # Returns the `signed` or `encrypted` jar, preferring `encrypted` if
+      # `secret_key_base` is set. Used by ActionDispatch::Session::CookieStore to
+      # avoid the need to introduce new cookie stores.
       def signed_or_encrypted
         @signed_or_encrypted ||=
           if request.secret_key_base.present?
@@ -324,7 +339,7 @@ module ActionDispatch
         @cookies.each(&block)
       end
 
-      # Returns the value of the cookie by +name+, or +nil+ if no such cookie exists.
+      # Returns the value of the cookie by `name`, or `nil` if no such cookie exists.
       def [](name)
         @cookies[name.to_s]
       end
@@ -357,8 +372,8 @@ module ActionDispatch
         @cookies.map { |k, v| "#{escape(k)}=#{escape(v)}" }.join "; "
       end
 
-      # Sets the cookie named +name+. The second argument may be the cookie's
-      # value or a hash of options as documented above.
+      # Sets the cookie named `name`. The second argument may be the cookie's value or
+      # a hash of options as documented above.
       def []=(name, options)
         if options.is_a?(Hash)
           options.symbolize_keys!
@@ -379,11 +394,11 @@ module ActionDispatch
         value
       end
 
-      # Removes the cookie on the client machine by setting the value to an empty string
-      # and the expiration date in the past. Like <tt>[]=</tt>, you can pass in
-      # an options hash to delete cookies with extra data such as a <tt>:path</tt>.
+      # Removes the cookie on the client machine by setting the value to an empty
+      # string and the expiration date in the past. Like `[]=`, you can pass in an
+      # options hash to delete cookies with extra data such as a `:path`.
       #
-      # Returns the value of the cookie, or +nil+ if the cookie does not exist.
+      # Returns the value of the cookie, or `nil` if the cookie does not exist.
       def delete(name, options = {})
         return unless @cookies.has_key? name.to_s
 
@@ -395,16 +410,16 @@ module ActionDispatch
         value
       end
 
-      # Whether the given cookie is to be deleted by this CookieJar.
-      # Like <tt>[]=</tt>, you can pass in an options hash to test if a
-      # deletion applies to a specific <tt>:path</tt>, <tt>:domain</tt> etc.
+      # Whether the given cookie is to be deleted by this CookieJar. Like `[]=`, you
+      # can pass in an options hash to test if a deletion applies to a specific
+      # `:path`, `:domain` etc.
       def deleted?(name, options = {})
         options.symbolize_keys!
         handle_options(options)
         @delete_cookies[name.to_s] == options
       end
 
-      # Removes all cookies on the client machine by calling <tt>delete</tt> for each cookie.
+      # Removes all cookies on the client machine by calling `delete` for each cookie.
       def clear(options = {})
         @cookies.each_key { |k| delete(k, options) }
       end
@@ -447,8 +462,8 @@ module ActionDispatch
             cookie_domain = ""
             dot_splitted_host = request.host.split(".", -1)
 
-            # Case where request.host is not an IP address or it's an invalid domain
-            # (ip confirms to the domain structure we expect so we explicitly check for ip)
+            # Case where request.host is not an IP address or it's an invalid domain (ip
+            # confirms to the domain structure we expect so we explicitly check for ip)
             if request.host.match?(/^[\d.]+$/) || dot_splitted_host.include?("") || dot_splitted_host.length == 1
               options[:domain] = nil
               return

data/lib/action_dispatch/middleware/debug_exceptions.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "action_dispatch/middleware/exception_wrapper"
 require "action_dispatch/routing/inspector"
 
 require "action_view"
 
 module ActionDispatch
-  # = Action Dispatch \DebugExceptions
+  # # Action Dispatch DebugExceptions
   #
-  # This middleware is responsible for logging exceptions and
-  # showing a debugging page in case the request is local.
+  # This middleware is responsible for logging exceptions and showing a debugging
+  # page in case the request is local.
   class DebugExceptions
     cattr_reader :interceptors, instance_accessor: false, default: []
 
@@ -115,8 +117,8 @@ module ActionDispatch
         DebugView.new(
           request: request,
           exception_wrapper: wrapper,
-          # Everything should use the wrapper, but we need to pass
-          # `exception` for legacy code.
+          # Everything should use the wrapper, but we need to pass `exception` for legacy
+          # code.
           exception: wrapper.exception,
           traces: wrapper.traces,
           show_source_idx: wrapper.source_to_show_id,
@@ -141,6 +143,12 @@ module ActionDispatch
         message = []
         message << "  "
         message << "#{wrapper.exception_class_name} (#{wrapper.message}):"
+        if wrapper.has_cause?
+          message << "\nCauses:"
+          wrapper.wrapped_causes.each do |wrapped_cause|
+            message << "#{wrapped_cause.exception_class_name} (#{wrapped_cause.message})"
+          end
+        end
         message.concat(wrapper.annotated_source_code)
         message << "  "
         message.concat(trace)

data/lib/action_dispatch/middleware/debug_locks.rb

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
-  # = Action Dispatch \DebugLocks
+  # # Action Dispatch DebugLocks
   #
   # This middleware can be used to diagnose deadlocks in the autoload interlock.
   #
   # To use it, insert it near the top of the middleware stack, using
-  # <tt>config/application.rb</tt>:
+  # `config/application.rb`:
   #
   #     config.middleware.insert_before Rack::Sendfile, ActionDispatch::DebugLocks
   #
-  # After restarting the application and re-triggering the deadlock condition,
-  # the route <tt>/rails/locks</tt> will show a summary of all threads currently
-  # known to the interlock, which lock level they are holding or awaiting, and
-  # their current backtrace.
+  # After restarting the application and re-triggering the deadlock condition, the
+  # route `/rails/locks` will show a summary of all threads currently known to the
+  # interlock, which lock level they are holding or awaiting, and their current
+  # backtrace.
   #
   # Generally a deadlock will be caused by the interlock conflicting with some
   # other external lock or blocking I/O call. These cannot be automatically
@@ -46,14 +48,14 @@ module ActionDispatch
     private
       def render_details(req)
         threads = ActiveSupport::Dependencies.interlock.raw_state do |raw_threads|
-          # The Interlock itself comes to a complete halt as long as this block
-          # is executing. That gives us a more consistent picture of everything,
-          # but creates a pretty strong Observer Effect.
+          # The Interlock itself comes to a complete halt as long as this block is
+          # executing. That gives us a more consistent picture of everything, but creates
+          # a pretty strong Observer Effect.
           #
-          # Most directly, that means we need to do as little as possible in
-          # this block. More widely, it means this middleware should remain a
-          # strictly diagnostic tool (to be used when something has gone wrong),
-          # and not for any sort of general monitoring.
+          # Most directly, that means we need to do as little as possible in this block.
+          # More widely, it means this middleware should remain a strictly diagnostic tool
+          # (to be used when something has gone wrong), and not for any sort of general
+          # monitoring.
 
           raw_threads.each.with_index do |(thread, info), idx|
             info[:index] = idx

data/lib/action_dispatch/middleware/debug_view.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "pp"
 
 require "action_view"

data/lib/action_dispatch/middleware/exception_wrapper.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "active_support/core_ext/module/attribute_accessors"
 require "active_support/syntax_error_proxy"
 require "active_support/core_ext/thread/backtrace/location"
@@ -175,23 +177,15 @@ module ActionDispatch
     end
 
     def show?(request)
-      # We're treating `nil` as "unset", and we want the default setting to be
-      # `:all`. This logic should be extracted to `env_config` and calculated
-      # once.
+      # We're treating `nil` as "unset", and we want the default setting to be `:all`.
+      # This logic should be extracted to `env_config` and calculated once.
       config = request.get_header("action_dispatch.show_exceptions")
 
-      # Include true and false for backwards compatibility.
       case config
       when :none
         false
       when :rescuable
         rescue_response?
-      when true
-        ActionDispatch.deprecator.warn("Setting action_dispatch.show_exceptions to true is deprecated. Set to :all instead.")
-        true
-      when false
-        ActionDispatch.deprecator.warn("Setting action_dispatch.show_exceptions to false is deprecated. Set to :none instead.")
-        false
       else
         true
       end
@@ -208,7 +202,8 @@ module ActionDispatch
     end
 
     def error_highlight_available?
-      # ErrorHighlight.spot with backtrace_location keyword is available since error_highlight 0.4.0
+      # ErrorHighlight.spot with backtrace_location keyword is available since
+      # error_highlight 0.4.0
       defined?(ErrorHighlight) && Gem::Version.new(ErrorHighlight::VERSION) >= Gem::Version.new("0.4.0")
     end
 

data/lib/action_dispatch/middleware/executor.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "rack/body_proxy"
 
 module ActionDispatch