x/tools/gopls: crash in testFuncs with *error argument

[findleyr]

Reported by a user in golang/vscode-go#3617. I can reproduce this with a function that takes *error as its first argument.

(how many times has this caught us out...?)

Here's the panic output:

panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x2 addr=0x8 pc=0x100d91b7c]

goroutine 17404 gp=0x14018776700 m=17 mp=0x14016f04008 [running]:
panic({0x101357da0?, 0x101b51f40?})
	/Users/beingnoble/go/pkg/mod/golang.org/toolchain@v0.0.1-go1.23.4.darwin-arm64/src/runtime/panic.go:804 +0x154 fp=0x14018b0d8e0 sp=0x14018b0d830 pc=0x10064f724
runtime.panicmem(...)
	/Users/beingnoble/go/pkg/mod/golang.org/toolchain@v0.0.1-go1.23.4.darwin-arm64/src/runtime/panic.go:262
runtime.sigpanic()
	/Users/beingnoble/go/pkg/mod/golang.org/toolchain@v0.0.1-go1.23.4.darwin-arm64/src/runtime/signal_unix.go:917 +0x300 fp=0x14018b0d940 sp=0x14018b0d8e0 pc=0x100651bf0
go/types.(*Package).Path(...)
	/Users/beingnoble/go/pkg/mod/golang.org/toolchain@v0.0.1-go1.23.4.darwin-arm64/src/go/types/package.go:34
golang.org/x/tools/gopls/internal/cache/testfuncs.testKind(0x0?)
	/Users/beingnoble/go/pkg/mod/golang.org/x/tools/gopls@v0.17.0/internal/cache/testfuncs/tests.go:284 +0xcc fp=0x14018b0d970 sp=0x14018b0d950 pc=0x100d91b7c
golang.org/x/tools/gopls/internal/cache/testfuncs.isTestOrExample(0x140157c4a80)
	/Users/beingnoble/go/pkg/mod/golang.org/x/tools/gopls@v0.17.0/internal/cache/testfuncs/tests.go:254 +0xc8 fp=0x14018b0d9f0 sp=0x14018b0d970 pc=0x100d91908
golang.org/x/tools/gopls/internal/cache/testfuncs.(*indexBuilder).build(0x14018b0db78, {0x1401898a108, 0x3, 0x3}, 0x1401384d8c0)
	/Users/beingnoble/go/pkg/mod/golang.org/x/tools/gopls@v0.17.0/internal/cache/testfuncs/tests.go:85 +0x240 fp=0x14018b0db20 sp=0x14018b0d9f0 pc=0x100d90890
golang.org/x/tools/gopls/internal/cache/testfuncs.NewIndex(...)
	/Users/beingnoble/go/pkg/mod/golang.org/x/tools/gopls@v0.17.0/internal/cache/testfuncs/tests.go:60
golang.org/x/tools/gopls/internal/cache.(*syntaxPackage).tests.func1()
	/Users/beingnoble/go/pkg/mod/golang.org/x/tools/gopls@v0.17.0/internal/cache/package.go:86 +0x80 fp=0x14018b0dbb0 sp=0x14018b0db20 pc=0x100dbd690
sync.(*Once).doSlow(0x14016f04008?, 0x14016f04580?)
	/Users/beingnoble/go/pkg/mod/golang.org/toolchain@v0.0.1-go1.23.4.darwin-arm64/src/sync/once.go:76 +0xf8 fp=0x14018b0dc10 sp=0x14018b0dbb0 pc=0x100664eb8
sync.(*Once).Do(...)
	/Users/beingnoble/go/pkg/mod/golang.org/toolchain@v0.0.1-go1.23.4.darwin-arm64/src/sync/once.go:67
golang.org/x/tools/gopls/internal/cache.(*syntaxPackage).tests(0x14012eb3d40)
	/Users/beingnoble/go/pkg/mod/golang.org/x/tools/gopls@v0.17.0/internal/cache/package.go:85 +0x4c fp=0x14018b0dc40 sp=0x14018b0dc10 pc=0x100dbd5dc
golang.org/x/tools/gopls/internal/cache.storePackageResults({0x101497ea8, 0x140160c7350}, 0x140120970e0, 0x1401b593c20)
	/Users/beingnoble/go/pkg/mod/golang.org/x/tools/gopls@v0.17.0/internal/cache/check.go:438 +0x1b4 fp=0x14018b0dfa0 sp=0x14018b0dc40 pc=0x100d9e514
golang.org/x/tools/gopls/internal/cache.(*typeCheckBatch).getPackage.func1.gowrap1()
	/Users/beingnoble/go/pkg/mod/golang.org/x/tools/gopls@v0.17.0/internal/cache/check.go:426 +0x34 fp=0x14018b0dfd0 sp=0x14018b0dfa0 pc=0x100d9e164
runtime.goexit({})
	/Users/beingnoble/go/pkg/mod/golang.org/toolchain@v0.0.1-go1.23.4.darwin-arm64/src/runtime/asm_arm64.s:1223 +0x4 fp=0x14018b0dfd0 sp=0x14018b0dfd0 pc=0x1006588f4
created by golang.org/x/tools/gopls/internal/cache.(*typeCheckBatch).getPackage.func1 in goroutine 14636
	/Users/beingnoble/go/pkg/mod/golang.org/x/tools/gopls@v0.17.0/internal/cache/check.go:426 +0x334

I am using gopls v0.17.0

Originally posted by @beingnoble03 in golang/vscode-go#3617 (comment)

[gopherbot]

Change https://go.dev/cl/637815 mentions this issue: gopls/internal/cache/testfuncs: fix crash with *error argument

[gopherbot]

Change https://go.dev/cl/637736 mentions this issue: [gopls-release-branch.0.17] gopls/internal/cache/testfuncs: fix crash with *error argument

[gabyhelp]

Related Issues

• x/tools/gopls: panic in analysis #60551
• x/tools/gopls: invalid memory address or nil pointer dereference on highlight #68927 (closed)
• x/tools/gopls: automated issue report (crash) #40449 (closed)
• x/tools/gopls: panic every time at Error() function, when 'error' inherited by another interface #48400 (closed)
• x/tools/gopls: panic in internal/lsp/cache.(*View).RunProcessEnvFunc #40121 (closed)
• x/tools/gopls: panic during internal/cache.(*analysisNode).typeCheck (crash) #67595 (closed)
• x/tools/go/packages: nil pointer dereference #69524 (closed)
• go/types: SIGSEGV in (*Checker).exprInternal #37602
• x/tools/gopls: panic in internal/lsp/cache.typeCheckBatch.importMap #61512 (closed)
• x/tools/gopls: error checking package #34298 (closed)

_{(Emoji vote if this was helpful or unhelpful; more detailed feedback welcome in this discussion.)}

[beingnoble03]

Thanks for the fix @findleyr!