`jQuery.param`’s behaviour differs with the one described in the docs #3023

sowcow · Mar 29, 2016

docs

http://api.jquery.com/jQuery.param/

As of jQuery 1.8, the $.param() method no longer uses jQuery.ajaxSettings.traditional as its default setting and will default to false. For best compatibility across versions, call $.param() with an explicit value for the second argument and do not use defaults.

actual

https://github.com/jquery/jquery/blob/master/src/serialize.js#L65

    // Set traditional to true for jQuery <= 1.3.2 behavior.
    if ( traditional === undefined ) {
        traditional = jQuery.ajaxSettings && jQuery.ajaxSettings.traditional;
    }

gibson042 · Mar 29, 2016

Nice catch, @sowcow! Would you like to submit a PR?

sowcow · Mar 30, 2016

Yes, I'm looking forward to it.

sowcow · Mar 31, 2016

Probably I should also modify ajax.js, i will check that tomorrow.

sowcow · Apr 3, 2016

I think i'm done, comment if any fixes are needed.

dmethvin · Apr 14, 2016

Everyone agrees this is ready to land? If so I'll land it for master/3.0, update the 3.0 upgrade guide, and submit a docs ticket to change the version to 3.0. Ugh, I guess we'll also need a Migrate ticket.

timmywil · Apr 14, 2016

@dmethvin 👍

dmethvin · Apr 14, 2016

One thing I just realized, the tests here were covering the case for jQuery.ajax() where it uses traditional. We should add a test or two in test/unit/ajax.js that asserts setting traditional will encode the parameters properly.

@sowcow would you be able to do that? You can use this test as a template because it does something very similar. Just pass in traditional: true as one of the ajax parameters and ensure it encodes correctly, you can swipe the encoding cases from the existing tests here.

sowcow · Apr 18, 2016

I'll do that tomorrow.

mgol · Apr 25, 2016

For reference, PR is in #3030.

dmethvin · Apr 25, 2016

sorry @sowcow should have pinged you here since the action item was here.

sowcow · Apr 26, 2016

sorry, I'm a bit irrational about tests, so i can't do that ⛄️

sowcow pushed a commit to sowcow/jquery that referenced this issue Mar 31, 2016

Alexander Koynov serialize: .param - don't use ajaxSettings.traditional as a default v…
…alue. Closes gh-3023
0449df5

sowcow added a commit to sowcow/jquery that referenced this issue Apr 1, 2016

sowcow Serialize: .param - don't use ajaxSettings.traditional
Closes gh-3023
c5c3860

sowcow referenced this issue Apr 4, 2016
Closed
serialize: .param - don't use ajaxSettings.traditional as a default value #3030

mgol added the Serialize label Apr 25, 2016

mgol added this to the 3.0.0 milestone Apr 25, 2016

mgol added Blocker Has Pull Request labels Apr 25, 2016

dmethvin was assigned by mgol Apr 25, 2016

dmethvin added a commit to dmethvin/jquery that referenced this issue Apr 26, 2016

sowcow + dmethvin Serialize: .param - don't use ajaxSettings.traditional
Ref gh-3023 Closes gh-3030
61d0d1a

dmethvin added a commit to dmethvin/jquery that referenced this issue Apr 26, 2016

dmethvin Ajax: Ensure ajaxSettings.traditional is still honored
Fixes gh-3023 Since .param() no longer looks at this setting we need unit tests to ensure it is still honored by $.ajax().
2299592

dmethvin added a commit that referenced this issue Apr 27, 2016

sowcow + dmethvin Serialize: .param - don't use ajaxSettings.traditional
Ref gh-3023 Closes gh-3030
4f27042

dmethvin added a commit that closed this issue Apr 27, 2016

dmethvin Ajax: Ensure ajaxSettings.traditional is still honored
Fixes gh-3023 Closes gh-3081 Since .param() no longer looks at this setting we need unit tests to ensure it is still honored by $.ajax().
df2051c

dmethvin closed this in df2051c Apr 27, 2016

jquery/jquery

`jQuery.param`’s behaviour differs with the one described in the docs #3023

Assignees

Labels

Projects

Milestone

5 participants

serialize: .param - don't use ajaxSettings.traditional as a default value #3030