[5.5] Prevent empty dictionary with non-String keys from encoding as a JSON object. #3136
Conversation
This file contains hidden or 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
… object.
Darwin encodes these as an empty array (`[]`), but SCF was encoding an empty JSON object instead (`{}`). Fixes https://bugs.swift.org/browse/SR-15781.
|
@swift-ci please test |
This was referenced Feb 1, 2022
parkera
approved these changes
Feb 1, 2022
vlm
reviewed
Feb 1, 2022
| let toEncode = Something(dict: [:]) | ||
| let data = try JSONEncoder().encode(toEncode) | ||
| let result = try JSONDecoder().decode(Something.self, from: data) | ||
| XCTAssertEqual(result.dict.count, 0) |
There was a problem hiding this comment.
Would it make sense to test the actual encoding too, to ensure the JSON array is produced? ([] vs {}).
There was a problem hiding this comment.
That makes sense. I'll add it in a follow-up.
vlm
reviewed
Feb 1, 2022
| let result = try JSONDecoder().decode(Something.self, from: data) | ||
| XCTAssertEqual(result.dict.count, 0) | ||
| } | ||
|
|
||
| // MARK: - Helper Functions | ||
| private var _jsonEmptyDictionary: Data { | ||
| return "{}".data(using: .utf8)! |
There was a problem hiding this comment.
Do we guarantee the empty dictionary is always encoded as {} regardless of type? If not, the variable name might be misleading.
There was a problem hiding this comment.
The empty dictionary is not always encoded as [] regardless of type. Specifically, <T: Encodable> [String: T] are encoded as JSON objects, and an empty dictionary of that type is encoded as {}.
vlm
approved these changes
Feb 1, 2022
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.
Darwin encodes these as an empty array (
[]), but SCF was encoding an empty JSON object instead ({}). Fixes https://bugs.swift.org/browse/SR-15781.