x/tools/gopls: SQL code highlighted as website URLs

[DmitriyVTitov]

For asking questions, see:

• GitHub Discussions (Q&A)
• #vscode channel in Gophers Slack

Before filing an issue, please review our troubleshooting guides

• Troubleshooting problems with debugging
• Troubleshooting other problems

Please answer these questions before submitting your issue. Thanks!

What version of Go, VS Code & VS Code Go extension are you using?

• Run go version to get version of Go from the VS Code integrated terminal.

  • go version go1.15.6 windows/amd64

• Run gopls -v version to get version of Gopls from the VS Code integrated terminal.

  • golang.org/x/tools/gopls v0.6.4

• Run code -v or code-insiders -v to get version of VS Code or VS Code Insiders.

  • 1.52.1 ea3859d4ba2f3e577a159bc91e3074c5d85c0523 x64

• Check your installed extensions to get the version of the VS Code Go extension

  • 0.22.0

• Run Ctrl+Shift+P (Cmd+Shift+P on Mac OS) > Go: Locate Configured Go Tools command.
  GOBIN: undefined
  toolsGopath:
  gopath: C:\Users\dtsp\YandexDisk\go
  GOROOT: c:\go
  PATH: C:\Program Files (x86)\Common Files\Oracle\Java\javapath;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;C:\WINDOWS\System32\WindowsPowerShell\v1.0;C:\WINDOWS\System32\OpenSSH;C:\Program Files\Git\cmd;C:\Program Files\nodejs;C:\Program Files\Graphviz 2.44.1\bin;C:\Go\bin;C:\Users\dtsp\AppData\Local\Microsoft\WindowsApps;C:\Users\dtsp\AppData\Roaming\npm;C:\Users\dtsp\go\bin;C:\Users\dtsp\YandexDisk\go\bin;C:\Users\dtsp\AppData\Local\GitHubDesktop\bin;c:\flutter\bin;C:\msys64\mingw64\bin;C:\Users\dtsp\AppData\Local\Microsoft\WindowsApps;C:\Users\dtsp\AppData\Local\Programs\Microsoft VS Code\bin;C:\Users\dtsp\go\bin

  gopkgs: C:\Users\dtsp\YandexDisk\go\bin\gopkgs.exe installed
  go-outline: C:\Users\dtsp\YandexDisk\go\bin\go-outline.exe installed
  gotests: C:\Users\dtsp\YandexDisk\go\bin\gotests.exe installed
  gomodifytags: C:\Users\dtsp\YandexDisk\go\bin\gomodifytags.exe installed
  impl: C:\Users\dtsp\YandexDisk\go\bin\impl.exe installed
  goplay: C:\Users\dtsp\YandexDisk\go\bin\goplay.exe installed
  dlv: C:\Users\dtsp\YandexDisk\go\bin\dlv.exe installed
  golint: C:\Users\dtsp\YandexDisk\go\bin\golint.exe installed
  gopls: C:\Users\dtsp\YandexDisk\go\bin\gopls.exe installed

Share the Go related settings you have added/edited

Run Preferences: Open Settings (JSON) command to open your settings.json file.
Share all the settings with the go. or ["go"] or gopls prefixes.

Describe the bug

I have SQL query:

	SELECT
    	        users.id,
    	        users.email,
    	        users.name,
		users.last_login,
		users.private,
		users.info,
		roles.name,
		roles.is_contractor,
		roles.contractor_id,
		contractors.name

Some of field names are treated as website names such as https://roles.name/ and so on.

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. See error

Screenshots or recordings

If applicable, add screenshots or recordings to help explain your problem.

[hyangah]

@stamblerre These links are coming from gopls. Transferring to the gopls issue tracker.

minimal repro:

package main

func main() {
	s := `SELECT
	users.id,
	users.email,
	users.name,
users.last_login,
users.private,
users.info,
roles.name,
roles.is_contractor,
roles.contractor_id,
contractors.name`

	println(s)
}

Gopls trace:

...
[Trace - 09:40:20.904 AM] Sending request 'textDocument/documentLink - (2)'.
Params: {"textDocument":{"uri":"file:///Users/hakim/tmp/w/main.go"}}

...

[Trace - 09:40:21.998 AM] Received response 'textDocument/documentLink - (2)' in 1093ms.
Result: [{"range":{"start":{"line":4,"character":1},"end":{"line":4,"character":9}},"target":"https://users.id"},
{"range":{"start":{"line":5,"character":1},"end":{"line":5,"character":12}},"target":"https://users.email"},
{"range":{"start":{"line":6,"character":1},"end":{"line":6,"character":11}},"target":"https://users.name"},
{"range":{"start":{"line":9,"character":0},"end":{"line":9,"character":10}},"target":"https://users.info"},
{"range":{"start":{"line":10,"character":0},"end":{"line":10,"character":10}},"target":"https://roles.name"},
{"range":{"start":{"line":13,"character":0},"end":{"line":13,"character":16}},"target":"https://contractors.name"}]

[stamblerre]

Thanks for the report. gopls uses https://github.com/mvdan/xurls for detecting links, with the relaxed configuration. The benefit is that gopls recognizes links like "golang.org/x/tools" (without https:// in front), but it clearly cannot be perfect and sometimes mislabels strings as links. I would be curious to hear from others in the community about how much of a problem this is, and if it is, perhaps we can make some adjustments.

/cc @mvdan, in case some of these cases are unexpected

[DmitriyVTitov]

I don't think we really need theese links in code. Is it possible to detect URLs in comments only? Why would I need active link in source code?
Another place where links seems appropriate - import statement. Maybe somewhere else, not sure.

[DmitriyVTitov]

And btw the main problem for me is that ugly highlighting not the underlined text itself.

[hyangah]

For syntax highlighting, either file an issue in https://github.com/jeff-hykin/better-go-syntax
or if you are adventurous, try https://github.com/golang/vscode-go/blob/master/docs/settings.md#uisemantictokens

    "gopls": {
        "ui.semanticTokens": true
    }

[stamblerre]

I don't think that's caused by the semantic highlighting--I expect there is a bug in the way we calculate the positions within this string. Likely it's a mistake in calculating positions on Windows with CRLF line endings. Can you please share a gopls log from when you see this? Information on how to capture them can be found here.

[DmitriyVTitov]

I don't think that's caused by the semantic highlighting--I expect there is a bug in the way we calculate the positions within this string. Likely it's a mistake in calculating positions on Windows with CRLF line endings. Can you please share a gopls log from when you see this? Information on how to capture them can be found here.

I think this is the log:

[Info  - 19:48:49] 2021/01/29 19:48:49 go env for C:\Users\dtsp\YandexDisk\go\src\transflow
(root C:\Users\dtsp\YandexDisk\go\src\transflow)
(go version go version go1.15.2 windows/amd64)
(valid build configuration = true)
(build flags: [])
GOSUMDB=sum.golang.org
GOCACHE=C:\Users\dtsp\AppData\Local\go-build
GOPRIVATE=
GOPROXY=https://proxy.golang.org,direct
GOROOT=c:\go
GO111MODULE=
GOINSECURE=
GOFLAGS=
GOMOD=C:\Users\dtsp\YandexDisk\go\src\transflow\go.mod
GONOPROXY=
GOPATH=C:\Users\dtsp\YandexDisk\go
GOMODCACHE=C:\Users\dtsp\YandexDisk\go\pkg\mod
GONOSUMDB=

[Info  - 19:48:59] 2021/01/29 19:48:59 go/packages.Load
	snapshot=0
	directory=C:\tmp
	query=[./ builtin]
	packages=2