feat!: enforce default fieldNestingDepth of 32 - #1433
Open
UlisesGascon wants to merge 1 commit into
Open
Conversation
The v3 constructor already enforces default values for fieldNameSize, fieldSize, fields, fileSize, files, and headerPairs. fieldNestingDepth was the last documented limit without an enforced default, gated by `?? Infinity` in the constructor. This adds a default of 32, matching the shape of the other limits. The value is generous compared to legitimate form nesting (typically 3-5 levels) and small enough to bound the per-bracket allocation cost in append-field. BREAKING CHANGE: applications relying on unbounded field name nesting must now set `limits.fieldNestingDepth` explicitly to a higher value.
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.
The v3 constructor already enforces default values for
fieldNameSize,fieldSize,fields,fileSize,files, andheaderPairs.fieldNestingDepthwas the last documented limit without an enforced default (gated by?? Infinityin the constructor), leaving deeply-nested field names as the one unbounded per-field allocation path.This adds a default of
32, matching the shape of the other limits:append-fieldallocation cost.limits.fieldNestingDepth.The existing "should allow unlimited nesting by default" test is replaced with two tests: one asserting the default is enforced (33 brackets rejects), and one asserting explicit opt-in to a higher limit still works.
Breaking change for next major. Consumers relying on unbounded nesting must set
limits.fieldNestingDepthexplicitly.