Don't use file GetOrCreateToken for change tracker #2320
Merged
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
jakebailey
approved these changes
Dec 10, 2025
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes the misuse of SourceFile.GetOrCreateToken() in the change tracker. The GetOrCreateToken() method is designed to materialize tokens that already exist in the source file (typically discovered through scanning), not for creating new synthetic tokens during code transformations. The PR replaces these incorrect usages with the proper approach of using NodeFactory.NewToken() and manually setting the token's location and parent fields.
Key changes:
- Replaced three instances of
GetOrCreateToken()withNewToken()for synthetic token creation in the change tracker - Added clarifying documentation to
GetOrCreateToken()explaining its intended use case - The new approach correctly creates synthetic tokens by calling
NewToken(), then manually settingLocandParentfields
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| internal/ls/change/tracker.go | Fixed three locations (InsertModifierBefore, endPosForInsertNodeAfter, InsertNodeInListAfter) to create synthetic tokens using NewToken() instead of misusing GetOrCreateToken() |
| internal/ast/ast.go | Added documentation comment clarifying that GetOrCreateToken() should not be used for creating synthetic tokens |
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.
We shouldn't use
file.GetOrCreateToken()for tokens not already present in the file. That function should be use to materialize tokens from the file that are not in the AST.Noticed this while working on #2308.