Fix KeyError in _EncodeCustomFieldNames when field name is a substring - #336
Merged
Merged
Conversation
jameslynnwu
approved these changes
Sep 17, 2026
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
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.
Problem
_EncodeCustomFieldNamespreviously checkedif python_name in encoded_value:(substring membership in the raw serialized JSONstr) instead of checking key membership indecoded_value(dict).When a message has custom JSON field mappings registered via
AddCustomJsonFieldMappingand an unset field'spython_nameappears as a substring of either:service_directory_namevs.metadata_service_directory_name), orpython_name in encoded_valueevaluates toTrue, causingdecoded_value.pop(python_name)to raise aKeyError.Solution
Check
if python_name in decoded_value:so key membership is verified against the decoded dictionary, matching_DecodeCustomFieldNames. Added unit test coverage for both field-name and field-value substring collisions.