Stable encoded parameter order for URLEncodedFormEncoder #2961
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
jshier
commented
Oct 14, 2019
cnoon
approved these changes
Oct 19, 2019
Source/URLEncodedFormEncoder.swift
Outdated
Comment on lines
303
to
307
| /// Whether or not to sort the encoded key value pairs. | ||
| /// | ||
| /// - Note: This setting ensures a consistent ordering for all encodings of the same parameters. When set to `false`, | ||
| /// encoded `Dictionary` values may have a different encoded order each time they're encoded due to | ||
| /// ` Dictionary`'s random storage order. |
There was a problem hiding this comment.
I think this Note is a bit outdated since you've switched over to a tuple array. Isn't it now going to be either the order the parameters were provided or alphabetically sorted?
There was a problem hiding this comment.
No, this note refers to Dictionarys being encoded, which will still have a variable order between app launches. Let me know if there’s a better way to say that here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue Link 🔗
#2957
Goals ⚽
This PR refactors the implementation of
URLEncodedFormEncoderto make the parameter encoding consistent between runs.Implementation Details 🚧
This PR swaps the previous
Dictionarystorage inURLEncodedFormComponent'sobjectcase for a[(key: String, value: URLEncodedFormComponent)], allowing for a constant order at runtime. Additionally, analphabetizeKeyValuePairsparameter was added toURLEncodedFormEncoderwhich controls the sorting of encoded components as they're serialized into the finalString.This PR also turns off
SWIFT_DETERMINISTIC_HASHINGto ensure we're testing with randomizedDictionaryordering. Due to this PR it's no longer necessary to have it turned on.Testing Details 🔍
Tests were updated for new expected ordering and to expect exact matches.