internal/lsp: fix nil pointer in hover when (types.Object).Pkg() is nil

stamblerre · stamblerre · commit ffc207509abf · 2021-02-16T20:53:32.000Z
We haven't been able to reproduce this scenario, but it may be possible when the user is in a broken state. Avoid panicking by gating every use of obj.Pkg() with nil checks. Fixes golang/go#44300 Change-Id: Ia0c56a7fd5d6b89795dded1efdf05838f3de8209 Reviewed-on: https://go-review.googlesource.com/c/tools/+/292671 Trust: Rebecca Stambler <rstambler@golang.org> Run-TryBot: Rebecca Stambler <rstambler@golang.org> gopls-CI: kokoro <noreply+kokoro@google.com> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Heschi Kreinick <heschi@google.com>
diff --git a/internal/lsp/source/hover.go b/internal/lsp/source/hover.go
@@ -187,6 +187,10 @@ func HoverIdentifier(ctx context.Context, i *IdentifierInfo) (*HoverInformation,
 			}
 		}
 	}
+	if obj.Pkg() == nil {
+		event.Log(ctx, fmt.Sprintf("nil package for %s", obj))
+		return h, nil
+	}
 	h.importPath = obj.Pkg().Path()
 	h.LinkPath = h.importPath
 	if mod, version, ok := moduleAtVersion(h.LinkPath, i); ok {

Original file line number	Diff line number	Diff line change
`@@ -187,6 +187,10 @@ func HoverIdentifier(ctx context.Context, i IdentifierInfo) (HoverInformation,`
`187`	`187`	`}`
`188`	`188`	`}`
`189`	`189`	`}`
	`190`	`+ if obj.Pkg() == nil {`
	`191`	`+ event.Log(ctx, fmt.Sprintf("nil package for %s", obj))`
	`192`	`+ return h, nil`
	`193`	`+ }`
`190`	`194`	`h.importPath = obj.Pkg().Path()`
`191`	`195`	`h.LinkPath = h.importPath`
`192`	`196`	`if mod, version, ok := moduleAtVersion(h.LinkPath, i); ok {`