x/tools/gopls: Rename: crash due to Info.Defs[id]=nil bug in checkStructField

[adonovan]

#!stacks
"runtime.sigpanic" && "checkStructField:+36"

Issue created by stacks.

named := r.pkg.TypesInfo().Defs[spec.Name].Type()

This stack Zepg4g was reported by telemetry:

• crash/crash
• runtime.gopanic:+69
• runtime.panicmem:=262
• runtime.sigpanic:+19
• golang.org/x/tools/gopls/internal/golang.(*renamer).checkStructField:+36
• golang.org/x/tools/gopls/internal/golang.(*renamer).check:+14
• golang.org/x/tools/gopls/internal/golang.(*renamer).checkInLexicalScope:+62
• golang.org/x/tools/gopls/internal/golang.(*renamer).checkInPackageBlock:+47
• golang.org/x/tools/gopls/internal/golang.(*renamer).check:+12
• golang.org/x/tools/gopls/internal/golang.renameObjects:+24
• golang.org/x/tools/gopls/internal/golang.renameExported:+56
• golang.org/x/tools/gopls/internal/golang.renameOrdinary:+157
• golang.org/x/tools/gopls/internal/golang.Rename:+24
• golang.org/x/tools/gopls/internal/server.(*server).Rename:+17
• golang.org/x/tools/gopls/internal/protocol.serverDispatch:+489
• golang.org/x/tools/gopls/internal/lsprpc.(*streamServer).ServeStream.ServerHandler.func3:+5
• golang.org/x/tools/gopls/internal/lsprpc.(*streamServer).ServeStream.handshaker.func4:+52
• golang.org/x/tools/gopls/internal/protocol.Handlers.MustReplyHandler.func1:+2

golang.org/x/tools/gopls@v0.17.0 go1.23.3 darwin/arm64 other,vscode (1)

Dups: _A3zlQ

[gabyhelp]

Related Issues

• x/tools/gopls: "edit does not belong to syntax of package %q" bug in golang.Rename #70049
• x/tools/gopls: rename crashes in objectpath #60789 (closed)
• x/tools/gopls: nil pointer on rename #32974 (closed)
• x/tools/gopls: crash when renaming in a package using builtins with type parameters #52940 (closed)
• x/tools/gopls: rename crashes on builtin types #32992 (closed)
• x/tools/gopls: crash in Hover (telemetry) #69362
• x/tools/gopls: Hover: panic in lookup{ObjectByName,DocLinkSymbol} #69616
• x/tools/gopls: rename fails on struct method that references bad struct field #32882 (closed)
• x/tools/gopls: gopls fails to rename all uses of instantiated struct field #61640 (closed)
• x/tools/gopls: rename crashes on single segment import path #33768 (closed)

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

[adonovan]

This has essentially the same root cause as #69362.

[findleyr]

Thanks. Let's put this in v0.18.0 for now.

Since it is in rename (and likely in the context of a broken build), I think it is not too disruptive to leave it until the v0.18.0 release. Can re-evaluate if we see this frequently.

Of course, we still have no idea how this scenario arises...

[adonovan]

This stack _A3zlQ was reported by telemetry:

• crash/crash
• runtime.gopanic:+69
• runtime.panicmem:=262
• runtime.sigpanic:+19
• golang.org/x/tools/gopls/internal/golang.(*renamer).checkStructField:+36
• golang.org/x/tools/gopls/internal/golang.(*renamer).check:+14
• golang.org/x/tools/gopls/internal/golang.renameObjects:+24
• golang.org/x/tools/gopls/internal/golang.renameOrdinary:+99
• golang.org/x/tools/gopls/internal/golang.Rename:+24
• golang.org/x/tools/gopls/internal/server.(*server).Rename:+17
• golang.org/x/tools/gopls/internal/protocol.serverDispatch:+489
• golang.org/x/tools/gopls/internal/lsprpc.(*streamServer).ServeStream.ServerHandler.func3:+5
• golang.org/x/tools/gopls/internal/lsprpc.(*streamServer).ServeStream.handshaker.func4:+52
• golang.org/x/tools/gopls/internal/protocol.Handlers.MustReplyHandler.func1:+2
• golang.org/x/tools/gopls/internal/protocol.Handlers.AsyncHandler.func2.2:+3
• runtime.goexit:+0

golang.org/x/tools/gopls@v0.17.1 go1.23.4 darwin/amd64 other,vscode (1)
golang.org/x/tools/gopls@v0.17.1 go1.23.3 darwin/arm64 vscode (1)