Skip to content

x/tools/gopls: Completion: nil deref panic in addFieldItems #72828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
adonovan opened this issue Mar 12, 2025 · 3 comments
Closed

x/tools/gopls: Completion: nil deref panic in addFieldItems #72828

adonovan opened this issue Mar 12, 2025 · 3 comments
Assignees
Labels
BugReport Issues describing a possible bug in the Go implementation. gopls/telemetry-wins gopls Issues related to the Go language server, gopls. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone

Comments

@adonovan
Copy link
Member

adonovan commented Mar 12, 2025

#!stacks
"sigpanic" && "completion.(*completer).addFieldItems:+5"

Issue created by stacks.

// adds struct fields, interface methods, function declaration fields to completion
func (c *completer) addFieldItems(fields *ast.FieldList) {
	if fields == nil {
		return
	}

	cursor := c.surrounding.cursor <--- panic

From the calling context, it's clear that c is non-nil, so c.surrounding must be nil. This can happen if the various setSurrounding* functions are not called or return early. The fix is to make the panicking statement defensive.

This stack tANNhQ was reported by telemetry:

golang.org/x/tools/gopls@v0.18.1 go1.23.5 darwin/arm64 neovim,vscode (1)

Dups: k4iQ0g

@adonovan adonovan added gopls Issues related to the Go language server, gopls. gopls/telemetry-wins NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Tools This label describes issues relating to any tools in the x/tools repository. labels Mar 12, 2025
@gopherbot gopherbot added this to the Unreleased milestone Mar 12, 2025
@gabyhelp gabyhelp added the BugReport Issues describing a possible bug in the Go implementation. label Mar 12, 2025
@findleyr findleyr self-assigned this Mar 19, 2025
@findleyr findleyr modified the milestones: Unreleased, gopls/v0.19.0 Mar 19, 2025
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/659237 mentions this issue: gopls/internal/golang/completion: avoid crash in addFieldItems

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BugReport Issues describing a possible bug in the Go implementation. gopls/telemetry-wins gopls Issues related to the Go language server, gopls. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Development

No branches or pull requests

4 participants