Fix JSONEncoder key conversion for CodingKeyRepresentable dictionary keys
#1526
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
ShivaHuang
changed the title
JSONEncoder key conversion for CodingKeyRepresentable dictionary keys
|
@swift-ci please test |
…keys When encoding dictionaries with CodingKeyRepresentable keys (e.g., custom enum or struct keys), JSONEncoder was incorrectly applying key encoding strategies like convertToSnakeCase to the dictionary keys themselves, rather than treating them as semantic keys that should remain unchanged. This change: - Expands _JSONStringDictionaryEncodableMarker protocol coverage from String-keyed dictionaries to any CodingKeyRepresentable-keyed dictionaries - Renames the protocol to _JSONCodingKeyRepresentableDictionaryEncodableMarker to better reflect its expanded scope - Updates the encoding logic to handle CodingKeyRepresentable keys by converting them directly to their string representation Fixes encoding behavior where Dictionary<CustomKey, Value> keys were being transformed (e.g., "leaveMeAlone" -> "leave_me_alone") when they should preserve their original form.
ShivaHuang
force-pushed
the
fix_JSONEncoder_encodingDictionaryCodingKeyRepresentableKeyConversion
branch
from
e67583b to
768aeb6
Compare
|
Hi @itingliu, I rebased the PR and seems the CI work needs to be run again, can you help? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Fixes an issue where
JSONEncoderincorrectly applied key encoding strategies (like.convertToSnakeCase) to dictionary keys that implementCodingKeyRepresentable, when these keys should preserve their semantic meaning and remain unchanged.Problem
When encoding dictionaries with
CodingKeyRepresentablekeys (e.g., custom enum or struct keys),JSONEncoderwas treating them as regular coding key values and applying key conversion strategies. This caused keys like "leaveMeAlone" to be transformed to "leave_me_alone" even when the key itself represents a semantic identifier that should remain unchanged.Solution
_JSONStringDictionaryEncodableMarkerprotocol to cover anyCodingKeyRepresentable-keyed dictionaries, not justString-keyed ones._JSONCodingKeyRepresentableDictionaryEncodableMarkerto reflect its broader scope.CodingKeyRepresentablekeys directly to their string representation without applying encoding transformations.Test Plan
Added test case
encodingDictionaryCodingKeyRepresentableKeyConversionUntouched()that verifies:CodingKeyRepresentablekeys preserves original key names..convertToSnakeCaseare not applied to the dictionary keys.CodingKeyRepresentable.Checklist
This change ensures that dictionaries with semantic keys maintain their intended structure while still allowing key
encoding strategies to work correctly for object properties during regular encoding.