Repository navigation
fix(bson-transpilers): escape apostrophes in Python object keys COMPASS-11398 - #8716
Merged
Merged
Conversation
…le python code when a field name contains a "'"
kmruiz
approved these changes
Nov 20, 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.
Description
ObjectTypeArgsTemplate wraps Python object keys in ' but only escaped ". An apostrophe in a field name ends the literal, and the rest of the key becomes Python code.
The first breaks for any user with an apostrophe in a field name. The second is injection: field names come from server documents, so anyone with write access to the collection, or control of the server, supplies them. Compass never executes the output, the user copies and runs it.
#8334 fixed the value, URI and collection-name paths. Keys bypass StringTypeTemplate entirely, so they were missed. Fixes SECBUG-6921.
Solution
One character in symbols/python/templates.yaml, matching the JavaScript, Ruby and PHP key emitters:
Plus the regenerated lib/symbol-table/shelltopython.js (npm run symbol-table)
Checklist
Motivation and Context