Repository navigation
Fix InlayHint.is throwing on undefined and accepting invalid hints - #1877
Open
Alexandre Kohler (kwy404) wants to merge 1 commit into
Open
Alexandre Kohler (kwy404) wants to merge 1 commit into
Alexandre Kohler (kwy404) wants to merge 1 commit into
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
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.
InlayHint.ishas a misplaced parenthesis on thetextEditscheck:&& (candidate.textEdits === undefined) || Is.typedArray(candidate.textEdits, TextEdit.is). Because&&binds tighter than||, this splits the whole guard into two halves joined by||. WhentextEditsis undefined, thetooltip,paddingLeftandpaddingRightchecks are ignored. WhentextEditsis an array, the object literal,position,labelandkindchecks are ignored. Forundefinedornull, the second half readscandidate.textEditsand throws. For exampleInlayHint.is({ textEdits: [] })returnstrue, andInlayHint.is(undefined)throwsTypeError: Cannot read properties of undefined (reading 'textEdits')instead of returningfalse.The fix moves the closing parenthesis so the check reads
(candidate.textEdits === undefined || Is.typedArray(candidate.textEdits, TextEdit.is)), like the other optional property checks in the same function.I added an
InlayHint.issuite totypes/src/test/typeguards.test.ts. Before the change theinvalid paddingLeftandmissing position and labelcases fail withtrue !== falseand theundefinedcase fails with theTypeErrorabove. After it they pass, and a validInlayHint.create(...)is still accepted. The full types test suite (45 tests) passes and eslint is clean.