Skip to content
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

Jump to bottom

x/tools/gopls: add tests for references includeDeclaration setting #36598

Closed
myitcv opened this issue Jan 16, 2020 · 3 comments
Closed

x/tools/gopls: add tests for references includeDeclaration setting #36598

myitcv opened this issue Jan 16, 2020 · 3 comments
Labels
FrozenDueToAge gopls Issues related to the Go language server, gopls. NeedsFix The path to resolution is known, but the work has not been done. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone
gopls/v0.3.0

Comments

@myitcv
Copy link
Member

myitcv commented Jan 16, 2020

What version of Go are you using (go version)?

$ go version
go version devel +693748e9fa Mon Jan 6 11:46:56 2020 +0000 linux/amd64
$ go list -m golang.org/x/tools
golang.org/x/tools v0.0.0-20200116062425-473961ec044c
$ go list -m golang.org/x/tools/gopls
golang.org/x/tools/gopls v0.1.8-0.20200116062425-473961ec044c

Does this issue reproduce with the latest release?

Yes

What operating system and processor architecture are you using (go env)?

go env Output
$ go env
GO111MODULE="on"
GOARCH="amd64"
GOBIN=""
GOCACHE="/home/myitcv/.cache/go-build"
GOENV="/home/myitcv/.config/go/env"
GOEXE=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="linux"
GOINSECURE=""
GONOPROXY=""
GONOSUMDB=""
GOOS="linux"
GOPATH="/home/myitcv/gostuff"
GOPRIVATE=""
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/home/myitcv/gos"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/home/myitcv/gos/pkg/tool/linux_amd64"
GCCGO="gccgo"
AR="ar"
CC="gcc"
CXX="g++"
CGO_ENABLED="1"
GOMOD="/home/myitcv/gostuff/src/github.com/myitcv/govim/go.mod"
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -fmessage-length=0 -fdebug-prefix-map=/tmp/go-build642413689=/tmp/go-build -gno-record-gcc-switches"

What did you do?

Prior to CL 211999, calling References would always return the definition of the identifier in question as the first reference. That appears to have changed with this CL.

Per previous work by Suzy, having the first location be the definition itself then allows the client to do custom sorting relative to the definition location.

I'm assuming this was an unintentional change?

What did you expect to see?

The definition location for an identifier to always be returned as the first item in the returned list.

What did you see instead?

Random locations (because the returned list has no defined order, despite it being a list)

cc @stamblerre @muirdm

FYI @leitzler
@myitcv myitcv added NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. gopls Issues related to the Go language server, gopls. labels Jan 16, 2020
@gopherbot gopherbot added this to the Unreleased milestone Jan 16, 2020
@gopherbot gopherbot added the Tools This label describes issues relating to any tools in the x/tools repository. label Jan 16, 2020
@myitcv myitcv modified the milestones: Unreleased, gopls/v0.3.0 Jan 16, 2020
@gopherbot
Copy link

Change https://golang.org/cl/215057 mentions this issue: internal/lsp/source: return obj decl first in find-references

@stamblerre
Copy link
Contributor

Submitted to fix the behavior ASAP, but re-opening to remind us to add tests for this case.

@stamblerre stamblerre reopened this Jan 16, 2020
@stamblerre stamblerre added NeedsFix The path to resolution is known, but the work has not been done. and removed NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels Jan 16, 2020
@stamblerre stamblerre changed the title x/tools/gopls: CL 211999 breaks logic to return definition location first x/tools/gopls: add tests for references includeDeclaration setting Jan 16, 2020
@gopherbot
Copy link

Change https://golang.org/cl/215777 mentions this issue: internal/lsp: add tests for references includeDeclaration setting

@golang golang locked and limited conversation to collaborators Jan 22, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge gopls Issues related to the Go language server, gopls. NeedsFix The path to resolution is known, but the work has not been done. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Milestone
gopls/v0.3.0
Development

No branches or pull requests
3 participants
@myitcv @stamblerre @gopherbot