x/tools/gopls: didConfigurationChange does not trigger recalculation of diagnostics #35548

myitcv · 2019-11-12T23:42:18Z

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

$ go version
go version devel +99957b6930 Tue Nov 12 05:35:33 2019 +0000 linux/amd64
$ go list -m golang.org/x/tools
golang.org/x/tools v0.0.0-20191112184959-323f198cedfe
$ go list -m golang.org/x/tools/gopls
golang.org/x/tools/gopls v0.1.8-0.20191112184959-323f198cedfe

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-build837961649=/tmp/go-build -gno-record-gcc-switches"

What did you do?

govim/govim#583 introduces support in govim to set the "env" configuration that is used by gopls. It builds on the didConfigurationChange support added in https://go-review.googlesource.com/c/tools/+/206148.

The test added as part of govim/govim#583 aims to change the environment variable GOFLAGS whilst govim and gopls are running in order to verify that diagnostics etc update accordingly.

The files involved in the test are main.go:

package main

func main() {
	DoIt()
}

and other.go:

// +build other

package main

func DoIt() {
}

govim (and hence gopls) is initially started with no environment. Hence we expect to receive the diagnostic equivalent to:

main.go|4 col 2| undeclared name: DoIt

We receive this diagnostic so all is good.

Then we change the gopls environment, setting GOFLAGS=-tags=other. At this point we wait to receive updated diagnostics to verify that there are no longer any diagnostics for main.go (because the constraint in other.go is now satisfied)

However we do not receive any updated diagnostics, and hence the govim test fails.

gopls log as follows:

gopls.log

What did you expect to see?

Updated diagnostics to be sent when config is changed that might influence that set of diagnostics.

What did you see instead?

No update in diagnostics. Similarly I do not see staticcheck analyses being run if I change the staticcheck config from off to on.

cc @stamblerre @ianthehat

The text was updated successfully, but these errors were encountered:

gopls can be configured with an environment, an environment which is passed to go/packages. For example, setting GOOS and GOARCH, or setting GOFLAGS=-tags=other to set a build tag. Therefore we define a govim config key, "GoplsEnv", for setting this environment. For example: govim#config#Set("GoplsEnv", {"GOFLAGS": "-mod=readonly"}) As part of this add a test that verifies the behaviour of the above setting. Setting of build tags does not current work; that is blocked on golang/go#35548 and will be tested in a follow up PR.

gopls can be configured with an environment, an environment which is passed to go/packages. For example, setting GOOS and GOARCH, or setting GOFLAGS=-tags=other to set a build tag. Therefore we define a govim config key, "GoplsEnv", for setting this environment. For example: govim#config#Set("GoplsEnv", {"GOFLAGS": "-mod=readonly"}) As part of this add a test that verifies the behaviour of the above setting. Setting of build tags does not current work; that is blocked on golang/go#35548 and will be tested in a follow up PR. Fixes #555