Add Kind assertions to findInArray and findKeyInMap#2651
Open
jandubois wants to merge 1 commit intomikefarah:masterfrom
Open
Add Kind assertions to findInArray and findKeyInMap#2651jandubois wants to merge 1 commit intomikefarah:masterfrom
jandubois wants to merge 1 commit intomikefarah:masterfrom
Conversation
findInArray and findKeyInMap accept any *CandidateNode but produce wrong results when called on the wrong Kind: findInArray uses stride 1, correct for SequenceNodes but dangerous on MappingNodes (where key-value pairs live at even-odd indices); findKeyInMap uses stride 2, correct for MappingNodes but silently skips elements in SequenceNodes. Commit b0ba958 fixed two call sites that passed MappingNodes to findInArray, but nothing prevents the same mistake from recurring. These assertions make both functions panic immediately on a Kind mismatch, catching misuse in tests rather than producing silent data corruption. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.
findInArrayandfindKeyInMapaccept any*CandidateNodebut produce wrong results when called on the wrongKind:findInArrayuses stride 1, correct forSequenceNodesbut dangerous onMappingNodes(where key-value pairs live at even-odd indices);findKeyInMapuses stride 2, correct forMappingNodesbut silently skips elements inSequenceNodes.Commit b0ba958 fixed two call sites that passed
MappingNodestofindInArray, but nothing prevents the same mistake from recurring. These assertions make both functions panic immediately on aKindmismatch, catching misuse in tests rather than producing silent data corruption.I was tempted to rename
findInArraytofindInSequenceto matchSequenceNode, but didn't want to engage in gratuitous refactoring. But still may be worth harmonizing the terminology.