Change `ActionDispatch::Response#content_type` returning Content-Type header as it is #36034

y-yagi · 2019-04-19T08:58:50Z

Since #35549, Response#conten_type returns only MIME type correctly.
It is a documented behavior that this method only returns MIME type, so this change seems appropriate.

rails/actionpack/lib/action_dispatch/http/response.rb

Lines 245 to 249 in 39de7fa

    
           # Content type of response. 
        
           # It returns just MIME type and does NOT contain charset part. 
        
           def content_type 
        
             parsed_content_type_header.mime_type 
        
           end

But unfortunately, some users expect this method to return all Content-Type that does not contain charset. This seems to be breaking changes.

We can change this behavior with the deprecate cycle.
But, in that case, a method needs that include Content-Type with additional parameters. And that method name is probably the content_type seems to properly.

So I changed the new behavior to more appropriate another method(mime_type) and restored Response#conten_type to the original behavior.

The original conten_type method seems to have some problems with charset parsing (it implicitly expects charset to be at the end). So I think we should consider the appropriate behavior again later.

Fixes #35709.

rafaelfranca · 2019-04-25T22:17:06Z

See #16018.

I'm not sure how we end up with that much code since I opened that PR but it seems we are doing too much work to get the content_type. Do we need all that code?

rafaelfranca · 2019-04-25T22:23:36Z

Since #35709, Response#conten_type returns only MIME type correctly.

That was always the case. Unless I'm missing something. That was the behavior I found when I opened #16018.

y-yagi · 2019-04-25T23:57:19Z

In my understanding, this not always the case. Until #35709, Response#conten_type returned media type parameters.
Following script passes with Rails 5.2.2.1, but not with Rails 6.0.0.

require "bundler/inline"

gemfile(true) do
  # gem "rails", "6.0.0.rc1"
  gem "rails", "5.2.2.1"
end

require "minitest/autorun"

class BugTest < Minitest::Test
  def test_content_type
    resp = ActionDispatch::Response.new(200, "Content-Type" => "application/fhir+json; fhirVersion=1; charset=utf-8;")
    assert_equal "application/fhir+json; fhirVersion=1", resp.content_type
  end
end

5.2.2.1

$ ruby 36034.rb
Run options: --seed 30174

# Running:

.

Finished in 0.009994s, 100.0630 runs/s, 100.0630 assertions/s.
1 runs, 1 assertions, 0 failures, 0 errors, 0 skips

6.0.0

$ ruby 36034.rb
# Running:

F

Failure:
BugTest#test_content_type [36034.rb:13]:
--- expected
+++ actual
@@ -1 +1 @@
-"application/fhir+json; fhirVersion=1"
+"application/fhir+json"



rails test 36034.rb:11



Finished in 0.021647s, 46.1949 runs/s, 46.1949 assertions/s.
1 runs, 1 assertions, 1 failures, 0 errors, 0 skips

I have doubts whether this was an intentional behavior, but I'm concerned about incompatibilities due to a change in behavior.
(I missed #16018. It seems to me that it is the good approach.)

rafaelfranca · 2019-04-26T00:44:19Z

👍 I think we should just do what #16018 did. It means that charset will be now in the content_type return, but that will also allow all the methods that I tested in #16018 will work again. With a good CHANGELOG entry and an entry in the upgrade guide I think we can get far with #16018.

kaspth · 2019-04-26T07:08:16Z

@rafaelfranca so that would mean apps should generally use request.media_type instead of request.content_type?

rafaelfranca · 2019-04-26T13:32:39Z

Depends on what they want. If they want all the things they expect in #35709 they should be using content_type. If they only want the mime type like application/json they should be using mime_type.

y-yagi · 2019-05-02T23:45:33Z

I updated PR based on #16018.

… header as it is Since rails#35709, `Response#conten_type` returns only MIME type correctly. It is a documented behavior that this method only returns MIME type, so this change seems appropriate. https://github.com/rails/rails/blob/39de7fac0507070e3c5f8b33fbad6fced84d97ed/actionpack/lib/action_dispatch/http/response.rb#L245-L249 But unfortunately, some users expect this method to return all Content-Type that does not contain charset. This seems to be breaking changes. We can change this behavior with the deprecate cycle. But, in that case, a method needs that include Content-Type with additional parameters. And that method name is probably the `content_type` seems to properly. So I changed the new behavior to more appropriate `media_type` method. And `Response#content_type` changed (as the method name) to return Content-Type header as it is. Fixes rails#35709. [Rafael Mendonça França & Yuuji Yaginuma ]

Change `ActionDispatch::Response#content_type` returning Content-Type header as it is

kamipo · 2019-06-01T10:07:28Z

actionpack/lib/action_dispatch/http/response.rb

    def content_type
+      type = super
+      type&.empty? ? nil : type


This line is a bit hard to understand. Is it not enough super.presence?

👍 I fixed with 22274d3. Thanks!

abhaynikam · 2019-06-02T14:24:35Z

actionpack/test/controller/render_xml_test.rb

@@ -92,11 +92,11 @@ def test_should_render_formatted_xml_erb_template

  def test_should_render_xml_but_keep_custom_content_type


@y-yagi : Should we rename the test description here from content_type to media_type? I made the changes but was not sure to raise PR.

At other places, it looked fine to me. Only test desc here should maybe change.

This is test is to confirm that content_type takes precedence when specifying render and content_type.

rails/actionpack/test/controller/render_xml_test.rb

Line 39 in 90d6237

render xml: "<blah/>", content_type: "application/atomsvc+xml"

So I think the current test name is appropriate.

…rails#36034

cpruitt · 2019-06-04T18:48:31Z

This change just landed into our latest 6-0-stable update at GitHub and turned out to be a breaking change causing quite a few failures. Overall I think the changes to content_type are probably justified, but it's a difficult switch to make for us while we're running our app against 5.2 at the same time. This change means 5.2 and 6.0 have different content_type return values making for a non-trivial number of conditionals. I'm wondering if there's a better way to roll this change out that has a cleaner upgrade path for apps expecting the previous content_type values.

y-yagi · 2019-06-05T02:33:07Z

Thanks for your feedback. I think your point is correct. I will try to add a config to control the behavior.

See: rails/rails#36034

rails/rails#36034 brings this breaking change since Rails 6+ Rails 6.0 release notes: https://github.com/rails/rails/blob/6-0-stable/actionpack/CHANGELOG.md

I changed return value of `ActionDispatch::Response#content_type` in rails#36034. But this change seems to an obstacle to upgrading. rails#36034 (comment) Therefore, I restored the behavior of `ActionDispatch::Response#content_type` to 5.2 and deprecated old behavior. Also, made it possible to control the behavior with the config.

Before Rails 6 RC2, the `ActionDispatch::Response#content_type` method would return only the media part of the `Content-Type` header, without any other parts. Now the `#content_type` method returns the entire header - as it is - and `#media_type` should be used instead to get the previous behavior. Ref: - rails/rails#36034 - rails/rails#36854

* Fix specs on Rails 6 RC2 `ActiveRecord::MigrationContext` now has a `schema_migration` attribute. Ref: https://github.com/rails/rails/pull/36439/files#diff-8d3c44120f7b67ff79e2fbe6a40d0ad6R1018 * Use `media_type` instead of `content_type` Before Rails 6 RC2, the `ActionDispatch::Response#content_type` method would return only the media part of the `Content-Type` header, without any other parts. Now the `#content_type` method returns the entire header - as it is - and `#media_type` should be used instead to get the previous behavior. Ref: - rails/rails#36034 - rails/rails#36854 * Use render template instead of render file Render file will need the full path in order to avoid security breaches. In this particular case, there's no need to use render file, it's ok to use render template. Ref: rails/rails#35688 * Don't set `represent_boolean_as_integer` on Rails 6 * Update comments [ci skip]

Rails 6 changed the usage of content_type. It now includes the complete header in contrary to media_type that only returns the MIME type. See rails/rails#36034

See: rails/rails#36034

rails/rails#36034 brings this breaking change since Rails 6+ Rails 6.0 release notes: https://github.com/rails/rails/blob/6-0-stable/actionpack/CHANGELOG.md

See: rails/rails#36034

themilkman · 2019-09-17T12:00:47Z

I will try to add a config to control the behavior.

@y-yagi is there a way to configure the old behavior? As mentioned in #35709 this has an big impact.

Change `ActionDispatch::Response#content_type` returning Content-Type header as it is rails/rails#36034

rails-bot bot added the actionpack label Apr 19, 2019

prathamesh-sonpatki mentioned this pull request Apr 26, 2019

ActionDispatch response ignores MIME parameters #36095

Closed

y-yagi force-pushed the fixes_35709 branch from 908151d to 6750099 Compare May 2, 2019 03:24

rails-bot bot added actionview docs labels May 2, 2019

y-yagi force-pushed the fixes_35709 branch 3 times, most recently from 5ec5adb to 724b564 Compare May 2, 2019 23:23

y-yagi changed the title ~~Restore Response#content_type to the original behavior~~ Change ActionDispatch::Response#content_type returning Content-Type header as it is May 2, 2019

y-yagi force-pushed the fixes_35709 branch from 724b564 to ea5f509 Compare June 1, 2019 00:21

y-yagi merged commit 2a015f6 into rails:master Jun 1, 2019

y-yagi deleted the fixes_35709 branch June 1, 2019 07:52

y-yagi added a commit that referenced this pull request Jun 1, 2019

Merge pull request #36034 from y-yagi/fixes_35709

f355f92

Change `ActionDispatch::Response#content_type` returning Content-Type header as it is

kamipo reviewed Jun 1, 2019

View reviewed changes

abhaynikam reviewed Jun 2, 2019

View reviewed changes

abhaynikam added a commit to abhaynikam/rails that referenced this pull request Jun 2, 2019

Rename the test description from content_type to media_type. Follow up …

02f14cb

…rails#36034

abhaynikam mentioned this pull request Jun 2, 2019

Remove unnecessary require pathname from actionpack controller specs #36379

Merged

benoittgt added a commit to rspec/rspec-rails that referenced this pull request Jun 5, 2019

Previously expected content_type has been moved to media_type method

a342463

See: rails/rails#36034

benoittgt mentioned this pull request Jun 5, 2019

Expect new ActionDispatch::Response#content_type on Rails 6 rspec/rspec-rails#2135

Merged

benoittgt added a commit to rspec/rspec-rails that referenced this pull request Jun 7, 2019

Previously expected content_type has been moved to media_type method

0e3d689

See: rails/rails#36034

wasifhossain mentioned this pull request Jun 8, 2019

Configure ActionDispatch::Response#content_type behavior on Rails 6+ rails-api/active_model_serializers#2340

Merged

y-yagi mentioned this pull request Jun 15, 2019

Make ActionDispatch::Response#content_type behavior configurable #36490

Merged

tvdeyen mentioned this pull request Aug 19, 2019

Use media_type over content_type in specs AlchemyCMS/alchemy_cms#1615

Merged

benoittgt added a commit to rspec/rspec-rails that referenced this pull request Aug 21, 2019

Previously expected content_type has been moved to media_type method

170b401

See: rails/rails#36034

benoittgt added a commit to benoittgt/rspec-rails that referenced this pull request Aug 24, 2019

Previously expected content_type has been moved to media_type method

2f53164

See: rails/rails#36034

themilkman mentioned this pull request Oct 9, 2019

Rails ignoring provided content-type parameters other than charset #35709

Closed

suketa added a commit to suketa/rails_sandbox that referenced this pull request Oct 14, 2019

try103

ad615a8

Change `ActionDispatch::Response#content_type` returning Content-Type header as it is rails/rails#36034

suketa added a commit to suketa/rails_sandbox that referenced this pull request Oct 14, 2019

try103

2f122d1

Change `ActionDispatch::Response#content_type` returning Content-Type header as it is rails/rails#36034

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change `ActionDispatch::Response#content_type` returning Content-Type header as it is #36034

Change `ActionDispatch::Response#content_type` returning Content-Type header as it is #36034

y-yagi commented Apr 19, 2019 •

edited

rafaelfranca commented Apr 25, 2019

rafaelfranca commented Apr 25, 2019

y-yagi commented Apr 25, 2019

rafaelfranca commented Apr 26, 2019

kaspth commented Apr 26, 2019

rafaelfranca commented Apr 26, 2019

y-yagi commented May 2, 2019

kamipo Jun 1, 2019

y-yagi Jun 1, 2019

abhaynikam Jun 2, 2019

y-yagi Jun 2, 2019

cpruitt commented Jun 4, 2019 •

edited

y-yagi commented Jun 5, 2019

themilkman commented Sep 17, 2019

	# Content type of response.
	# It returns just MIME type and does NOT contain charset part.
	def content_type
	parsed_content_type_header.mime_type
	end

		@@ -92,11 +92,11 @@ def test_should_render_formatted_xml_erb_template

		def test_should_render_xml_but_keep_custom_content_type

Change ActionDispatch::Response#content_type returning Content-Type header as it is #36034

Change ActionDispatch::Response#content_type returning Content-Type header as it is #36034

Conversation

y-yagi commented Apr 19, 2019 • edited

rafaelfranca commented Apr 25, 2019

rafaelfranca commented Apr 25, 2019

y-yagi commented Apr 25, 2019

rafaelfranca commented Apr 26, 2019

kaspth commented Apr 26, 2019

rafaelfranca commented Apr 26, 2019

y-yagi commented May 2, 2019

kamipo Jun 1, 2019

Choose a reason for hiding this comment

y-yagi Jun 1, 2019

Choose a reason for hiding this comment

abhaynikam Jun 2, 2019

Choose a reason for hiding this comment

y-yagi Jun 2, 2019

Choose a reason for hiding this comment

cpruitt commented Jun 4, 2019 • edited

y-yagi commented Jun 5, 2019

themilkman commented Sep 17, 2019

Change `ActionDispatch::Response#content_type` returning Content-Type header as it is #36034

Change `ActionDispatch::Response#content_type` returning Content-Type header as it is #36034

y-yagi commented Apr 19, 2019 •

edited

cpruitt commented Jun 4, 2019 •

edited