cmd/compile, go/types2: for case sensitive mismatches in function/method/attribute lookups please suggest "but does have $<CASE_INSENSITIVE_EQUIVALENT>"

[odeke-em]

Go version

go version devel go1.24-2b33434287 Fri Nov 8 01:06:04 2024 +0000 linux/amd64

Output of go env in your module/workspace:

GO111MODULE=''
GOARCH='amd64'
GOAUTH='netrc'
GOBIN='/home/emmanuel/go/src/go.googlesource.com/go/bin'
GOCACHE='/home/emmanuel/.cache/go-build'
GOENV='/home/emmanuel/.config/go/env'
GOEXE=''
GOEXPERIMENT=''
GOFLAGS=''
GOHOSTARCH='amd64'
GOHOSTOS='linux'
GOINSECURE=''
GOMODCACHE='/home/emmanuel/go/pkg/mod'
GONOPROXY=''
GONOSUMDB=''
GOOS='linux'
GOPATH='/home/emmanuel/go'
GOPRIVATE=''
GOPROXY='https://proxy.golang.org,direct'
GOROOT='/home/emmanuel/go/src/go.googlesource.com/go'
GOSUMDB='sum.golang.org'
GOTMPDIR=''
GOTOOLCHAIN='auto'
GOTOOLDIR='/home/emmanuel/go/src/go.googlesource.com/go/pkg/tool/linux_amd64'
GOVCS=''
GOVERSION='devel go1.24-2b33434287 Fri Nov 8 01:06:04 2024 +0000'
GODEBUG=''
GOTELEMETRY='local'
GOTELEMETRYDIR='/home/emmanuel/.config/go/telemetry'
GCCGO='gccgo'
GOAMD64='v1'
AR='ar'
CC='gcc'
CXX='g++'
CGO_ENABLED='1'
GOMOD='/home/emmanuel/go/src/github.com/googleapis/google-cloud-go/spanner/go.mod'
GOWORK='/home/emmanuel/go/src/github.com/googleapis/google-cloud-go/go.work'
CGO_CFLAGS='-O2 -g'
CGO_CPPFLAGS=''
CGO_CXXFLAGS='-O2 -g'
CGO_FFLAGS='-O2 -g'
CGO_LDFLAGS='-O2 -g'
PKG_CONFIG='pkg-config'
GOGCCFLAGS='-fPIC -m64 -pthread -Wl,--no-gc-sections -fmessage-length=0 -ffile-prefix-map=/tmp/go-build825742400=/tmp/go-build -gno-record-gcc-switches'

What did you do?

While working on some terse library with a ton of symbols/functions, in which the nomenclature for a bunch of symbols at times defies expectations in case, I had such code

// Add a unaryClientInterceptor and streamClientInterceptor.
        reqIDInjector := new(requestIDHeaderInjector)
        opts = append(opts,
            option.WithGRPCDialOption(grpc.WithchainStreamInterceptor(reqIDInjector.interceptStream)),
            option.WithGRPCDialOption(grpc.WithchainUnaryInterceptor(reqIDInjector.interceptUnary)),
        )

to reference https://pkg.go.dev/google.golang.org/grpc#WithChainStreamInterceptor and https://pkg.go.dev/google.golang.org/grpc#WithChainUnaryInterceptor

What did you see happen?

$ go test -run=TestRequestID
# cloud.google.com/go/spanner [cloud.google.com/go/spanner.test]
./client.go:414:35: undefined: grpc.WithchainStreamInterceptor
./client.go:415:35: undefined: grpc.WithchainUnaryInterceptor
FAIL	cloud.google.com/go/spanner [build failed]

What did you expect to see?

$ go test -run=TestRequestID
# cloud.google.com/go/spanner [cloud.google.com/go/spanner.test]
./client.go:414:35: undefined: grpc.WithchainStreamInterceptor, did you mean "grpc.WithChainStreamInterceptor"?
./client.go:415:35: undefined: grpc.WithchainUnaryInterceptor, did you mean "grpc.WithChainUnaryInterceptor"?
FAIL	cloud.google.com/go/spanner [build failed]

If there is a case insensitve mismatch, kindly please suggest the first one so that the user can trivially fix their code instead of
having to eye-ball to figure out their typo.

[gabyhelp]

Related Issues

• cmd/go: inconsistent vendoring #47575 (closed)
• cmd/compile: ICE with `assertion failed` when using `GODEBUG=gotypesalias=1` #65893 (closed)
• cmd/compile: failed to build github.com/hashicorp/cap/oidc due to internal compiler error: unexpected Defn: #45743 (closed)
• gccgo: ICE in mangled_name for packagepath with .0 #33871 (closed)
• cmd/go: "get -u" stumbles over repos imported via non-canonical paths #30831
• cmd/compile: internal compiler error #15961 (closed)
• cmd/compile/internal/types: types.Type.LinkString has collisions for anonymous struct types with blank fields #47087 (closed)
• cmd/compile: internal compiler error: bad Sym: have M, want foo #49017 (closed)

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

[gopherbot]

Change https://go.dev/cl/631356 mentions this issue: cmd/compile, go/types: suggest for case-insensitive matches on undefined symbols

[GoVeronicaGo]

CC: @golang/compiler

[timothy-king]

Thanks. This is a plausible usability improvement for the compiler.

If we open this door, it would be nice to try to identify a good enough and helpful subset once. It seems like a lot of details need to be ironed out.

• What about near misspellings of function names? How near?
• What about near misses to unexported symbols? Different error message?
• What about near matches for package names?
• What about near matches for variable names that could select a method?
• What about 2 or more near matches? What is the error message then? What is the priority between them?

cc @griesemer

[ianlancetaylor]

Note that we already do matches if the case of the first letter differs.

	fmt.Println(bytes.NewReader(nil).len())

foo.go:9:35: bytes.NewReader(nil).len undefined (type *bytes.Reader has no field or method len, but does have method Len)

[gopherbot]

Change https://go.dev/cl/662775 mentions this issue: go/types, types2: better error messages for invalid qualified identifiers

[griesemer]

Thanks @odeke-em for this issue and your CL. After reviewing your CL and also thinking about @timothy-king 's questions, we decided to borrow from @odeke-em 's code (thank you!) but go with a slightly simpler approach. We can always refine as needed.

cc: @mrkfrmn

[odeke-em]

Anytime @griesemer, gladly and thank you for picking it up!