CHANGELOG.md

Rails 7.1.5.1 (December 10, 2024)

• Add validation to content security policies to disallow spaces and semicolons. Developers should use multiple arguments, and different directive methods instead.

  [CVE-2024-54133]

  Gannon McGibbon

Rails 7.1.5 (October 30, 2024)

• No changes.

Rails 7.1.4.2 (October 23, 2024)

• No changes.

Rails 7.1.4.1 (October 15, 2024)

• Avoid regex backtracking in HTTP Token authentication

  [CVE-2024-47887]

  John Hawthorn

• Avoid regex backtracking in query parameter filtering

  [CVE-2024-41128]

  John Hawthorn

Rails 7.1.4 (August 22, 2024)

• Resolve deprecation warning in latest selenium-webdriver.

  Earlopain

• Don't preload Selenium browser when remote.

  Noah Horton

• Fix crash for invalid Content-Type in ShowExceptions middleware.

  Earlopain

• Fix inconsistent results of params.deep_transform_keys.

  Iago Pimenta

• Do not report rendered errors except 500.

  Nikita Vasilevsky

• Improve routes source location detection.

  Jean Boussier

• Fix Request#raw_post raising NoMethodError when rack.input is nil.

  Hartley McGuire

• Fix url generation in nested engine when script name is empty.

  zzak

• Fix Mime::Type.parse handling type parameters for HTTP Accept headers.

  Taylor Chaparro

• Fix the error page that is displayed when a view template is missing to account for nested controller paths in the suggested correct location for the missing template.

  Joshua Young

• Fix a regression in 7.1.3 passing a to: option without a controller when the controller is already defined by a scope.

  Rails.application.routes.draw do
    controller :home do
      get "recent", to: "recent_posts"
    end
  end

  Étienne Barrié

• Fix ActionDispatch::Executor middleware to report errors handled by ActionDispatch::ShowExceptions

  In the default production environment, ShowExceptions rescues uncaught errors and returns a response. Because of this the executor wouldn't report production errors with the default Rails configuration.

  Jean Boussier

Rails 7.1.3.4 (June 04, 2024)

• Include the HTTP Permissions-Policy on non-HTML Content-Types [CVE-2024-28103]

  Aaron Patterson

Rails 7.1.3.3 (May 16, 2024)

• No changes.

Rails 7.1.3.2 (February 21, 2024)

• Fix raise_on_missing_translations not working correctly with the translate method in controllers after the patch for CVE-2024-26143.

  John Hawthorn

Rails 7.1.3.1 (February 21, 2024)

• Fix possible XSS vulnerability with the translate method in controllers

  CVE-2024-26143

  ooooooo-q + Aaron Patterson

• Fix ReDoS in Accept header parsing

  CVE-2024-26142

  Aaron Patterson

Rails 7.1.3 (January 16, 2024)

• Fix including Rails.application.routes.url_helpers directly in an ActiveSupport::Concern.

  Jonathan Hefner

• Fix system tests when using a Chrome binary that has been downloaded by Selenium.

  Jonathan Hefner

Rails 7.1.2 (November 10, 2023)

• Fix a race condition that could cause a Text file busy - chromedriver error with parallel system tests

  Matt Brictson

• Fix StrongParameters#extract_value to include blank values

  Otherwise composite parameters may not be parsed correctly when one of the component is blank.

  fatkodima, Yasha Krasnou, Matthias Eiglsperger

• Add racc as a dependency since it will become a bundled gem in Ruby 3.4.0

  Hartley McGuire

• Support handling Enumerator for non-buffered responses.

  Zachary Scott

Rails 7.1.1 (October 11, 2023)

• No changes.

Rails 7.1.0 (October 05, 2023)

• No changes.

Rails 7.1.0.rc2 (October 01, 2023)

• No changes.

Rails 7.1.0.rc1 (September 27, 2023)

• Add support for #deep_merge and #deep_merge! to ActionController::Parameters.

  Sean Doyle

Rails 7.1.0.beta1 (September 13, 2023)

• AbstractController::Translation.raise_on_missing_translations removed

  This was a private API, and has been removed in favour of a more broadly applicable config.i18n.raise_on_missing_translations. See the upgrading guide for more information.

  Alex Ghiculescu

• Add ActionController::Parameters#extract_value method to allow extracting serialized values from params

  params = ActionController::Parameters.new(id: "1_123", tags: "ruby,rails")
  params.extract_value(:id) # => ["1", "123"]
  params.extract_value(:tags, delimiter: ",") # => ["ruby", "rails"]

  Nikita Vasilevsky

• Parse JSON response.parsed_body with ActiveSupport::HashWithIndifferentAccess

  Integrate with Minitest's new assert_pattern by parsing the JSON contents of response.parsed_body with ActiveSupport::HashWithIndifferentAccess, so that it's pattern-matching compatible.

  Sean Doyle

• Add support for Playwright as a driver for system tests.

  Yuki Nishijima

• Fix HostAuthorization potentially displaying the value of the X_FORWARDED_HOST header when the HTTP_HOST header is being blocked.

  Hartley McGuire, Daniel Schlosser

• Rename fixture_file_upload method to file_fixture_upload

  Declare an alias to preserve the backwards compatibility of fixture_file_upload

  Sean Doyle

• ActionDispatch::SystemTesting::TestHelpers::ScreenshotHelper saves the screenshot path in test metadata on failure.

  Matija Čupić

• config.dom_testing_default_html_version controls the HTML parser used by ActionDispatch::Assertions#html_document.

  The Rails 7.1 default configuration opts into the HTML5 parser when it is supported, to better represent what the DOM would be in a browser user agent. Previously this test helper always used Nokogiri's HTML4 parser.

  Mike Dalessio

• Ensure an uncaught exception when rendering a Turbo Frame properly breaks out of the Frame and shows the DebugView error page in development.

  Joé Dupuis

• The with_routing helper can now be called at the class level. When called at the class level, the routes will be setup before each test, and reset after every test. For example:

  class RoutingTest < ActionController::TestCase
    with_routing do |routes|
      routes.draw do
        resources :articles
        resources :authors
      end
    end
  
    def test_articles_route
      assert_routing("/articles", controller: "articles", action: "index")
    end
  
     def test_authors_route
      assert_routing("/authors", controller: "authors", action: "index")
    end
  end

  Andrew Novoselac

• The Mime::Type now supports handling types with parameters and correctly handles quotes. When parsing the accept header, the parameters before the q-parameter are kept and if a matching mime-type exists it is used. To keep the current functionality, a fallback is created to look for the media-type without the parameters.

  This change allows for custom MIME-types that are more complex like application/vnd.api+json; profile="https://jsonapi.org/profiles/ethanresnick/cursor-pagination/" ext="https://jsonapi.org/ext/atomic" for the JSON API.

  Nicolas Erni

• The url_for helpers now support a new option called path_params. This is very useful in situations where you only want to add a required param that is part of the route's URL but for other route not append an extraneous query param.

  Given the following router...

  Rails.application.routes.draw do
    scope ":account_id" do
      get "dashboard" => "pages#dashboard", as: :dashboard
      get "search/:term" => "search#search", as: :search
    end
    delete "signout" => "sessions#destroy", as: :signout
  end

  And given the following ApplicationController

  class ApplicationController < ActionController::Base
    def default_url_options
      { path_params: { account_id: "foo" } }
    end
  end

  The standard url_for helper and friends will now behave as follows:

  dashboard_path # => /foo/dashboard
  dashboard_path(account_id: "bar") # => /bar/dashboard
  
  signout_path # => /signout
  signout_path(account_id: "bar") # => /signout?account_id=bar
  signout_path(account_id: "bar", path_params: { account_id: "baz" }) # => /signout?account_id=bar
  search_path("quin") # => /foo/search/quin

  Jason Meller, Jeremy Beker

• Change action_dispatch.show_exceptions to one of :all, :rescuable, or :none. :all and :none behave the same as the previous true and false respectively. The new :rescuable option will only show exceptions that can be rescued (e.g. ActiveRecord::RecordNotFound). :rescuable is now the default for the test environment.

  Jon Dufresne

• config.action_dispatch.cookies_serializer now accepts :message_pack and :message_pack_allow_marshal as serializers. These serializers require the msgpack gem (>= 1.7.0).

  The Message Pack format can provide improved performance and smaller payload sizes. It also supports roundtripping some Ruby types that are not supported by JSON. For example:

  cookies.encrypted[:foo] = [{ a: 1 }, { b: 2 }.with_indifferent_access, 1.to_d, Time.at(0, 123)]
  
  # BEFORE with config.action_dispatch.cookies_serializer = :json
  cookies.encrypted[:foo]
  # => [{"a"=>1}, {"b"=>2}, "1.0", "1969-12-31T18:00:00.000-06:00"]
  cookies.encrypted[:foo].map(&:class)
  # => [Hash, Hash, String, String]
  
  # AFTER with config.action_dispatch.cookies_serializer = :message_pack
  cookies.encrypted[:foo]
  # => [{:a=>1}, {"b"=>2}, 0.1e1, 1969-12-31 18:00:00.000123 -0600]
  cookies.encrypted[:foo].map(&:class)
  # => [Hash, ActiveSupport::HashWithIndifferentAccess, BigDecimal, Time]

  The :message_pack serializer can fall back to deserializing with ActiveSupport::JSON when necessary, and the :message_pack_allow_marshal serializer can fall back to deserializing with Marshal as well as ActiveSupport::JSON. Additionally, the :marshal, :json, and :json_allow_marshal (AKA :hybrid) serializers can now fall back to deserializing with ActiveSupport::MessagePack when necessary. These behaviors ensure old cookies can still be read so that migration is easier.

  Jonathan Hefner

• Remove leading dot from domains on cookies set with domain: :all, to meet RFC6265 requirements

  Gareth Adams

• Include source location in routes extended view.

  $ bin/rails routes --expanded
  
  ...
  --[ Route 14 ]----------
  Prefix            | new_gist
  Verb              | GET
  URI               | /gist(.:format)
  Controller#Action | gists/gists#new
  Source Location   | config/routes/gist.rb:3

  Luan Vieira, John Hawthorn and Daniel Colson

• Add without as an alias of except on ActiveController::Parameters.

  Hidde-Jan Jongsma

• Expand search field on rails/info/routes to also search route name, http verb and controller#action.

  Jason Kotchoff

• Remove deprecated poltergeist and webkit (capybara-webkit) driver registration for system testing.

  Rafael Mendonça França

• Remove deprecated ability to assign a single value to config.action_dispatch.trusted_proxies.

  Rafael Mendonça França

• Deprecate config.action_dispatch.return_only_request_media_type_on_content_type.

  Rafael Mendonça França

• Remove deprecated behavior on Request#content_type.

  Rafael Mendonça França

• Change ActionController::Instrumentation to pass filtered_path instead of fullpath in the event payload to filter sensitive query params

  get "/posts?password=test"
  request.fullpath         # => "/posts?password=test"
  request.filtered_path    # => "/posts?password=[FILTERED]"

  Ritikesh G

• Deprecate AbstractController::Helpers::MissingHelperError

  Hartley McGuire

• Change ActionDispatch::Testing::TestResponse#parsed_body to parse HTML as a Nokogiri document

  get "/posts"
  response.content_type         # => "text/html; charset=utf-8"
  response.parsed_body.class    # => Nokogiri::HTML5::Document
  response.parsed_body.to_html  # => "<!DOCTYPE html>\n<html>\n..."

  Sean Doyle

• Deprecate ActionDispatch::IllegalStateError.

  Samuel Williams

• Add HTTP::Request#route_uri_pattern that returns URI pattern of matched route.

  Joel Hawksley, Kate Higa

• Add ActionDispatch::AssumeSSL middleware that can be turned on via config.assume_ssl. It makes the application believe that all requests are arriving over SSL. This is useful when proxying through a load balancer that terminates SSL, the forwarded request will appear as though its HTTP instead of HTTPS to the application. This makes redirects and cookie security target HTTP instead of HTTPS. This middleware makes the server assume that the proxy already terminated SSL, and that the request really is HTTPS.

  DHH

• Only use HostAuthorization middleware if config.hosts is not empty

  Hartley McGuire

• Allow raising an error when a callback's only/unless symbols aren't existing methods.

  When before_action :callback, only: :action_name is declared on a controller that doesn't respond to action_name, raise an exception at request time. This is a safety measure to ensure that typos or forgetfulness don't prevent a crucial callback from being run when it should.

  For new applications, raising an error for undefined actions is turned on by default. If you do not want to opt-in to this behavior set config.action_controller.raise_on_missing_callback_actions to false in your application configuration. See #43487 for more details.

  Jess Bees

• Allow cookie options[:domain] to accept a proc to set the cookie domain on a more flexible per-request basis

  RobL

• When a host is not specified for an ActionController::Renderer's env, the host and related options will now be derived from the routes' default_url_options and ActionDispatch::Http::URL.secure_protocol.

  This means that for an application with a configuration like:

  Rails.application.default_url_options = { host: "rubyonrails.org" }
  Rails.application.config.force_ssl = true

  rendering a URL like:

  ApplicationController.renderer.render inline: "<%= blog_url %>"

  will now return "https://rubyonrails.org/blog" instead of "http://example.org/blog".

  Jonathan Hefner

• Add details of cookie name and size to CookieOverflow exception.

  Andy Waite

• Don't double log the controller, action, or namespaced_controller when using ActiveRecord::QueryLog

  Previously if you set config.active_record.query_log_tags to an array that included :controller, :namespaced_controller, or :action, that item would get logged twice. This bug has been fixed.

  Alex Ghiculescu

• Add the following permissions policy directives: hid, idle-detection, screen-wake-lock, serial, sync-xhr, web-share.

  Guillaume Cabanel

• The speaker, vibrate, and vr permissions policy directives are now deprecated.

  There is no browser support for these directives, and no plan for browser support in the future. You can just remove these directives from your application.

  Jonathan Hefner

• Added the :status option to assert_redirected_to to specify the precise HTTP status of the redirect. Defaults to :redirect for backwards compatibility.

  Jon Dufresne

• Rescue JSON::ParserError in Cookies JSON deserializer to discards marshal dumps:

  Without this change, if action_dispatch.cookies_serializer is set to :json and the app tries to read a :marshal serialized cookie, it would error out which wouldn't clear the cookie and force app users to manually clear it in their browser.

  (See #45127 for original bug discussion)

  Nathan Bardoux

• Add HTTP_REFERER when following redirects on integration tests

  This makes follow_redirect! a closer simulation of what happens in a real browser

  Felipe Sateler

• Added exclude? method to ActionController::Parameters.

  Ian Neubert

• Rescue EOFError exception from rack on a multipart request.

  Nikita Vasilevsky

• Log redirects from routes the same way as redirects from controllers.

  Dennis Paagman

• Prevent ActionDispatch::ServerTiming from overwriting existing values in Server-Timing. Previously, if another middleware down the chain set Server-Timing header, it would overwritten by ActionDispatch::ServerTiming.

  Jakub Malinowski

• Allow opting out of the SameSite cookie attribute when setting a cookie.

  You can opt out of SameSite by passing same_site: nil.

  cookies[:foo] = { value: "bar", same_site: nil }

  Previously, this incorrectly set the SameSite attribute to the value of the cookies_same_site_protection setting.

  Alex Ghiculescu

• Allow using helper_methods in content_security_policy and permissions_policy

  Previously you could access basic helpers (defined in helper modules), but not helper methods defined using helper_method. Now you can use either.

  content_security_policy do |p|
    p.default_src "https://example.com"
    p.script_src "https://example.com" if helpers.script_csp?
  end

  Alex Ghiculescu

• Reimplement ActionController::Parameters#has_value? and #value? to avoid parameters and hashes comparison.

  Deprecated equality between parameters and hashes is going to be removed in Rails 7.2. The new implementation takes care of conversions.

  Seva Stefkin

• Allow only String and Symbol keys in ActionController::Parameters. Raise ActionController::InvalidParameterKey when initializing Parameters with keys that aren't strings or symbols.

  Seva Stefkin

• Add the ability to use custom logic for storing and retrieving CSRF tokens.

  By default, the token will be stored in the session. Custom classes can be defined to specify arbitrary behavior, but the ability to store them in encrypted cookies is built in.

  Andrew Kowpak

• Make ActionController::Parameters#values cast nested hashes into parameters.

  Gannon McGibbon

• Introduce html: and screenshot: kwargs for system test screenshot helper

  Use these as an alternative to the already-available environment variables.

  For example, this will display a screenshot in iTerm, save the HTML, and output its path.

  take_screenshot(html: true, screenshot: "inline")

  Alex Ghiculescu

• Allow ActionController::Parameters#to_h to receive a block.

  Bob Farrell

• Allow relative redirects when raise_on_open_redirects is enabled

  Tom Hughes

• Allow Content Security Policy DSL to generate for API responses.

  Tim Wade

• Fix authenticate_with_http_basic to allow for missing password.

  Before Rails 7.0 it was possible to handle basic authentication with only a username.

  authenticate_with_http_basic do |token, _|
    ApiClient.authenticate(token)
  end

  This ability is restored.

  Jean Boussier

• Fix content_security_policy returning invalid directives.

  Directives such as self, unsafe-eval and few others were not single quoted when the directive was the result of calling a lambda returning an array.

  content_security_policy do |policy|
    policy.frame_ancestors lambda { [:self, "https://example.com"] }
  end

  With this fix the policy generated from above will now be valid.

  Edouard Chin

• Fix skip_forgery_protection to run without raising an error if forgery protection has not been enabled / verify_authenticity_token is not a defined callback.

  This fix prevents the Rails 7.0 Welcome Page (/) from raising an ArgumentError if default_protect_from_forgery is false.

  Brad Trick

• Make redirect_to return an empty response body.

  Application controllers that wish to add a response body after calling redirect_to can continue to do so.

  Jon Dufresne

• Use non-capturing group for subdomain matching in ActionDispatch::HostAuthorization

  Since we do nothing with the captured subdomain group, we can use a non-capturing group instead.

  Sam Bostock

• Fix ActionController::Live to copy the IsolatedExecutionState in the ephemeral thread.

  Since its inception ActionController::Live has been copying thread local variables to keep things such as CurrentAttributes set from middlewares working in the controller action.

  With the introduction of IsolatedExecutionState in 7.0, some of that global state was lost in ActionController::Live controllers.

  Jean Boussier

• Fix setting trailing_slash: true in route definition.

  get '/test' => "test#index", as: :test, trailing_slash: true
  
  test_path() # => "/test/"

  Jean Boussier

• Make Session#merge! stringify keys.

  Previously Session#update would, but merge! wouldn't.

  Drew Bragg

• Add :unsafe_hashes mapping for content_security_policy

  # Before
  policy.script_src  :strict_dynamic, "'unsafe-hashes'", "'sha256-rRMdkshZyJlCmDX27XnL7g3zXaxv7ei6Sg+yt4R3svU='"
  
  # After
  policy.script_src  :strict_dynamic, :unsafe_hashes, "'sha256-rRMdkshZyJlCmDX27XnL7g3zXaxv7ei6Sg+yt4R3svU='"

  Igor Morozov

Please check 7-0-stable for previous changes.