Fix stack overflow in inherited JSDoc resolution#4577
Open
johnfav03 wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a language-service stack overflow when resolving inherited JSDoc in the presence of circular/mutually referential inheritance (as seen in nuxt), by adding a visited-guard to the inherited-member walk in getJSDocOrTag() and covering the regression with a new fourslash hover test.
Changes:
- Thread a
seenSymbolsset throughgetJSDocOrTag/getMatchingJSDocTagand use it to stop repeated inherited-member recursion. - Add a fourslash regression test that verifies hover quick info terminates for a self-extending interface scenario.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| internal/ls/hover.go | Adds a seenSymbols recursion guard to prevent infinite inherited-JSDoc resolution loops. |
| internal/fourslash/tests/hoverCircularInheritedDocumentation_test.go | New regression test reproducing the circular base-type scenario and asserting hover does not crash. |
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.
Fixes and issue uncovered in #4380 (comment) (nuxt);
getJSDocOrTag()resolves an inherited JSDoc by recursing with no visited guard. This means that a circular or mutually referential class could recurse indefinitely and cause a stack overflow error.