src/goDebugConfiguration: use 'dlv' instead of 'dlv-dap' binary

The stable version of dlv includes all the features Delve DAP
mode debug setup requires. We do not need to depend on Delve
built from the master or newer than the stable version.
Use 'dlv' instead of 'dlv-dap', and remove 'dlv-dap' binary
installation/update logic.

The extension presents a warning to the users who configured
`go.alternateTools.dlv-dap` and offers an option to open
the corresponding settings.json.

Fixes #1977

Change-Id: I5ed398c4d85594a6ad26bea4874324a75f96badb
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/374594
Trust: Hyang-Ah Hana Kim <[email protected]>
Run-TryBot: Hyang-Ah Hana Kim <[email protected]>
Reviewed-by: Polina Sokolova <[email protected]>

Author: hyangah

docs/debugging.md

@@ -263,34 +263,34 @@ export class GoDebugConfigurationProvider implements vscode.DebugConfigurationPr
 			}
 		}
 
-		const dlvToolPath = getBinPath(debugAdapter);
+		const dlvToolPath = getBinPath('dlv');
 		if (!path.isAbsolute(dlvToolPath)) {
 			// If user has not already declined to install this tool,
 			// prompt for it. Otherwise continue and have the lack of
 			// dlv binary be caught later.
-			if (!declinedToolInstall(debugAdapter)) {
-				await promptForMissingTool(debugAdapter);
+			if (!declinedToolInstall('dlv')) {
+				await promptForMissingTool('dlv');
 				return;
 			}
 		}
 		debugConfiguration['dlvToolPath'] = dlvToolPath;
 
+		// For dlv-dap mode, check if the dlv is recent enough to support DAP.
 		if (debugAdapter === 'dlv-dap' && !dlvDAPVersionChecked) {
-			const tool = getToolAtVersion('dlv-dap');
+			const tool = getToolAtVersion('dlv');
 			if (await shouldUpdateTool(tool, dlvToolPath)) {
 				// If the user has opted in to automatic tool updates, we can update
 				// without prompting.
 				const toolsManagementConfig = getGoConfig()['toolsManagement'];
 				if (toolsManagementConfig && toolsManagementConfig['autoUpdate'] === true) {
 					const goVersion = await getGoVersion();
-					const toolVersion = { ...tool, version: tool.latestVersion }; // ToolWithVersion
-					await installTools([toolVersion], goVersion, true);
+					await installTools([tool], goVersion, true);
 				} else {
 					await promptForUpdatingTool(tool.name);
 				}
-				// installTools could've failed (e.g. no network access) or the user decliend to install dlv-dap
-				// in promptForUpdatingTool. If dlv-dap doesn't exist or dlv-dap is too old to have MVP features,
-				// the failure will be visible to users when launching the dlv-dap process (crash or error message).
+				// installTools could've failed (e.g. no network access) or the user decliend to install dlv
+				// in promptForUpdatingTool. If dlv doesn't exist or dlv is too old to have MVP features,
+				// the failure will be visible to users when launching the dlv process (crash or error message).
 			}
 			dlvDAPVersionChecked = true;
 		}

src/goDebugConfiguration.ts

@@ -12,7 +12,6 @@ import getPort = require('get-port');
 import path = require('path');
 import * as fs from 'fs';
 import * as net from 'net';
-import { getTool } from './goTools';
 import { Logger, logVerbose, TimestampedLogger } from './goLogging';
 import { DebugProtocol } from 'vscode-debugprotocol';
 import { getWorkspaceFolderPath } from './util';
@@ -578,12 +577,12 @@ function getSpawnConfig(launchAttachArgs: vscode.DebugConfiguration, logErr: (ms
 	// launchArgsEnv is user-requested env vars (envFiles + env).
 	const env = Object.assign(goToolsEnvVars, launchArgsEnv);
 
-	const dlvPath = launchAttachArgs.dlvToolPath ?? getTool('dlv-dap');
+	const dlvPath = launchAttachArgs.dlvToolPath ?? 'dlv';
 
 	if (!fs.existsSync(dlvPath)) {
 		const envPath = process.env['PATH'] || (process.platform === 'win32' ? process.env['Path'] : null);
 		logErr(
-			`Couldn't find dlv-dap at the Go tools path, ${process.env['GOPATH']}${
+			`Couldn't find ${dlvPath} at the Go tools path, ${process.env['GOPATH']}${
 				env['GOPATH'] ? ', ' + env['GOPATH'] : ''
 			} or ${envPath}\n` +
 				'Follow the setup instruction in https://github.com/golang/vscode-go/blob/master/docs/debugging.md#getting-started.\n'

src/goDebugFactory.ts

@@ -235,7 +235,7 @@ export async function installTool(
 	}
 
 	try {
-		if (!modulesOn || goVersion.lt('1.16') || hasModSuffix(tool) || tool.name === 'dlv-dap') {
+		if (!modulesOn || goVersion.lt('1.16') || hasModSuffix(tool)) {
 			await installToolWithGoGet(tool, goVersion, env, modulesOn, importPath);
 		} else {
 			await installToolWithGoInstall(goVersion, env, importPath);
@@ -284,9 +284,9 @@ async function installToolWithGoGet(
 	if (!modulesOn) {
 		args.push('-u');
 	}
-	// dlv-dap or tools with a "mod" suffix can't be installed with
+	// tools with a "mod" suffix can't be installed with
 	// simple `go install` or `go get`. We need to get, build, and rename them.
-	if (hasModSuffix(tool) || tool.name === 'dlv-dap') {
+	if (hasModSuffix(tool)) {
 		args.push('-d'); // get the version, but don't build.
 	}
 	args.push(importPath);
@@ -307,8 +307,8 @@ async function installToolWithGoGet(
 		logVerbose(`$ ${goBinary} ${args.join(' ')} (cwd: ${opts.cwd})`);
 		await execFile(goBinary, args, opts);
 
-		if (hasModSuffix(tool) || tool.name === 'dlv-dap') {
-			// Actual installation of the -gomod tool and dlv-dap is done by running go build.
+		if (hasModSuffix(tool)) {
+			// Actual installation of the -gomod tool is done by running go build.
 			let destDir = env['GOBIN'];
 			if (!destDir) {
 				const gopath0 = env['GOPATH']?.split(path.delimiter)[0];
@@ -383,14 +383,13 @@ export async function promptForMissingTool(toolName: string) {
 		// Offer the option to install all tools.
 		installOptions.push('Install All');
 	}
-	let msg = `The "${tool.name}" command is not available.
-Run "go get -v ${getImportPath(tool, goVersion)}" to install.`;
-	if (tool.name === 'dlv-dap') {
-		msg = `The ["${tool.name}"](https://github.com/golang/vscode-go/blob/master/docs/debugging.md) command is not available.
-Please select "Install", or follow the installation instructions [here](https://github.com/golang/vscode-go/blob/master/docs/debugging.md#updating-dlv-dap).`;
-	}
-
-	const selected = await vscode.window.showErrorMessage(msg, ...installOptions);
+	const cmd = goVersion.lt('1.16')
+		? `go get -v ${getImportPath(tool, goVersion)}`
+		: `go install -v ${getImportPathWithVersion(tool, tool.defaultVersion, goVersion)}`;
+	const selected = await vscode.window.showErrorMessage(
+		`The "${tool.name}" command is not available. Run "${cmd}" to install.`,
+		...installOptions
+	);
 	switch (selected) {
 		case 'Install':
 			await installTools([tool], goVersion);
@@ -436,7 +435,7 @@ export async function promptForUpdatingTool(
 	if (toolName === 'gopls') {
 		choices = ['Always Update', 'Update Once', 'Release Notes'];
 	}
-	if (toolName === 'dlv-dap') {
+	if (toolName === 'dlv') {
 		choices = ['Always Update', 'Update Once'];
 	}
 

src/goInstallTools.ts

@@ -188,6 +188,10 @@ If you would like additional configuration for diagnostics from gopls, please se
 			}
 		}
 	}
+
+	// Present a warning about the deprecation of a 'dlv-dap' binary setting.
+	checkAlternateTools(cfg);
+
 	updateGoVarsFromConfig().then(async () => {
 		suggestUpdates(ctx);
 		offerToInstallLatestGoVersion();
@@ -1030,3 +1034,23 @@ export async function setGOROOTEnvVar(configGOROOT: string) {
 		delete process.env.GOROOT;
 	}
 }
+
+async function checkAlternateTools(goConfig: vscode.WorkspaceConfiguration) {
+	const alternateTools = goConfig ? goConfig['alternateTools'] : {};
+	// TODO(hyangah): delete this check after 2022-03-01.
+	if (alternateTools['dlv-dap']) {
+		const msg = `The extension no longer requires a separate 'dlv-dap' binary but uses the 'dlv' binary.
+The "dlv-dap" property of the "go.alternateTools" setting will be ignored.
+Please use the "dlv" property if you need to override the default Go debugger.`;
+
+		const selected = await vscode.window.showWarningMessage(msg, 'Open settings.json');
+		if (selected === 'Open settings.json') {
+			const { workspaceValue } = goConfig.inspect('alternateTools.dlv-dap');
+			if (workspaceValue !== undefined) {
+				vscode.commands.executeCommand('workbench.action.openWorkspaceSettingsFile');
+			} else {
+				vscode.commands.executeCommand('workbench.action.openSettingsJson');
+			}
+		}
+	}
+}

src/goMain.ts

@@ -157,9 +157,8 @@ export function getConfiguredTools(
 	// Check if the system supports dlv, i.e. is 64-bit.
 	// There doesn't seem to be a good way to check if the mips and s390
 	// families are 64-bit, so just try to install it and hope for the best.
-	if (process.arch.match(/^(arm64|mips|mipsel|ppc64|s390|s390x|x64)$/)) {
+	if (process.arch.match(/^(mips|mipsel|ppc64|s390|s390x|x64)$/)) {
 		maybeAddTool('dlv');
-		maybeAddTool('dlv-dap');
 	}
 
 	// gocode-gomod needed in go 1.11 & higher

src/goTools.ts

@@ -203,10 +203,10 @@ export const allToolsInformation: { [key: string]: Tool } = {
 		description: 'Language Server from Google',
 		usePrereleaseInPreviewMode: true,
 		minimumGoVersion: semver.coerce('1.12'),
-		latestVersion: semver.parse('v0.7.1'),
-		latestVersionTimestamp: moment('2021-08-02', 'YYYY-MM-DD'),
-		latestPrereleaseVersion: semver.parse('v0.7.1'),
-		latestPrereleaseVersionTimestamp: moment('2021-08-02', 'YYYY-MM-DD')
+		latestVersion: semver.parse('v0.7.4'),
+		latestVersionTimestamp: moment('2021-12-09', 'YYYY-MM-DD'),
+		latestPrereleaseVersion: semver.parse('v0.7.4'),
+		latestPrereleaseVersionTimestamp: moment('2021-12-09', 'YYYY-MM-DD')
 	},
 	'dlv': {
 		name: 'dlv',
@@ -215,20 +215,10 @@ export const allToolsInformation: { [key: string]: Tool } = {
 		replacedByGopls: false,
 		isImportant: true,
 		description: 'Go debugger (Delve)',
+		latestVersion: semver.parse('v1.6.1'), // minimum version that supports DAP
+		latestVersionTimestamp: moment('2021-05-19', 'YYYY-MM-DD'),
 		minimumGoVersion: semver.coerce('1.12') // dlv requires 1.12+ for build
 	},
-	'dlv-dap': {
-		name: 'dlv-dap',
-		importPath: 'github.com/go-delve/delve/cmd/dlv',
-		modulePath: 'github.com/go-delve/delve',
-		replacedByGopls: false,
-		isImportant: true,
-		description: 'Go debugger & debug adapter (Delve DAP)',
-		defaultVersion: '2f13672765fe', // pinned version
-		minimumGoVersion: semver.coerce('1.12'), // dlv requires 1.12+ for build
-		latestVersion: semver.parse('v1.7.3-0.20211026171155-b48ceec161d5'),
-		latestVersionTimestamp: moment('2021-10-26', 'YYYY-MM-DD')
-	},
 	'fillstruct': {
 		name: 'fillstruct',
 		importPath: 'github.com/davidrjenni/reftools/cmd/fillstruct',

src/goToolsInformation.ts

@@ -188,7 +188,7 @@ suite('gopls update tests', () => {
 });
 
 suite('version comparison', () => {
-	const tool = getTool('dlv-dap');
+	const tool = getTool('dlv');
 	const latestVersion = tool.latestVersion;
 
 	teardown(() => {
@@ -197,7 +197,7 @@ suite('version comparison', () => {
 
 	async function testShouldUpdateTool(expected: boolean, moduleVersion?: string) {
 		sinon.stub(goInstallTools, 'inspectGoToolVersion').returns(Promise.resolve({ moduleVersion }));
-		const got = await goInstallTools.shouldUpdateTool(tool, '/bin/path/to/dlv-dap');
+		const got = await goInstallTools.shouldUpdateTool(tool, '/bin/path/to/dlv');
 		assert.strictEqual(
 			expected,
 			got,

test/gopls/update.test.ts

@@ -157,12 +157,7 @@ suite('Installation Tests', function () {
 		await runTest(
 			[
 				{ name: 'gopls', versions: ['v0.1.0', 'v1.0.0-pre.1', 'v1.0.0'], wantVersion: 'v1.0.0' },
-				{ name: 'guru', versions: ['v1.0.0'], wantVersion: 'v1.0.0' },
-				{
-					name: 'dlv-dap',
-					versions: ['v1.0.0', getTool('dlv-dap').defaultVersion!],
-					wantVersion: 'v' + getTool('dlv-dap').latestVersion!.toString()
-				}
+				{ name: 'dlv', versions: ['v1.0.0', 'v1.8.0'], wantVersion: 'v1.8.0' }
 			],
 			true
 		);
@@ -172,12 +167,7 @@ suite('Installation Tests', function () {
 		await runTest(
 			[
 				{ name: 'gopls', versions: ['v0.1.0', 'v1.0.0-pre.1', 'v1.0.0'], wantVersion: 'v1.0.0' },
-				{ name: 'guru', versions: ['v1.0.0'], wantVersion: 'v1.0.0' },
-				{
-					name: 'dlv-dap',
-					versions: ['v1.0.0', getTool('dlv-dap').defaultVersion!],
-					wantVersion: 'v' + getTool('dlv-dap').latestVersion!.toString()
-				}
+				{ name: 'dlv', versions: ['v1.0.0', 'v1.8.0'], wantVersion: 'v1.8.0' }
 			],
 			true, // LOCAL PROXY
 			true // GOBIN
@@ -214,7 +204,7 @@ function buildFakeProxy(testCases: installationTestCase[]) {
 
 		versions.map((version) => {
 			if (!version.match(/^v\d+\.\d+\.\d+/)) {
-				// for dlv-dap that retrieves the version from a revision (commit hash)
+				// for tools that retrieve the versions from a revision (commit hash)
 				const resolvedVersion = tool.latestVersion?.toString() || '1.0.0';
 				const infoPath = path.join(dir, `${version}.info`);
 				version = `v${resolvedVersion}`;

test/integration/install.test.ts

@@ -213,20 +213,10 @@ export const allToolsInformation: { [key: string]: Tool } = {
 		replacedByGopls: false,
 		isImportant: true,
 		description: 'Go debugger (Delve)',
+		latestVersion: semver.parse('v1.6.1'), // minimum version that supports DAP
+		latestVersionTimestamp: moment('2021-05-19', 'YYYY-MM-DD'),
 		minimumGoVersion: semver.coerce('1.12') // dlv requires 1.12+ for build
 	},
-	'dlv-dap': {
-		name: 'dlv-dap',
-		importPath: 'github.com/go-delve/delve/cmd/dlv',
-		modulePath: 'github.com/go-delve/delve',
-		replacedByGopls: false,
-		isImportant: true,
-		description: 'Go debugger & debug adapter (Delve DAP)',
-		defaultVersion: '%s', // pinned version
-		minimumGoVersion: semver.coerce('1.12'), // dlv requires 1.12+ for build
-		latestVersion: semver.parse('%s'),
-		latestVersionTimestamp: moment('%s', 'YYYY-MM-DD')
-	},
 	'fillstruct': {
 		name: 'fillstruct',
 		importPath: 'github.com/davidrjenni/reftools/cmd/fillstruct',

tools/allTools.ts.in

@@ -15,7 +15,6 @@ package main
 import (
 	"bytes"
 	"encoding/json"
-	"errors"
 	"flag"
 	"fmt"
 	"io"
@@ -24,7 +23,6 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
-	"regexp"
 	"sort"
 	"strings"
 
@@ -232,18 +230,6 @@ func main() {
 	// Clear so that we can rewrite src/goToolsInformation.ts.
 	b.Reset()
 
-	// Check for latest dlv-dap version.
-	dlvVersion, err := listModuleVersion("github.com/go-delve/delve@master")
-	if err != nil {
-		log.Fatal(err)
-	}
-	// Due to https://github.com/golang/vscode-go/issues/1682, we cannot use
-	// pseudo-version as the pinned version reliably.
-	dlvRevOrStable := dlvVersion.Version
-	if rev, err := pseudoVersionRev(dlvVersion.Version); err == nil { // pseudo-version
-		dlvRevOrStable = rev
-	}
-
 	// Check for the latest gopls version.
 	versions, err := listAllModuleVersions("golang.org/x/tools/gopls")
 	if err != nil {
@@ -277,7 +263,7 @@ func main() {
 	}
 
 	// TODO(suzmue): change input to json and avoid magic string printing.
-	toolsString := fmt.Sprintf(string(data), goplsVersion.Version, goplsVersion.Time[:len("YYYY-MM-DD")], goplsVersionPre.Version, goplsVersionPre.Time[:len("YYYY-MM-DD")], dlvRevOrStable, dlvVersion.Version, dlvVersion.Time[:len("YYYY-MM-DD")])
+	toolsString := fmt.Sprintf(string(data), goplsVersion.Version, goplsVersion.Time[:len("YYYY-MM-DD")], goplsVersionPre.Version, goplsVersionPre.Time[:len("YYYY-MM-DD")])
 
 	// Write tools section.
 	b.WriteString(toolsString)
@@ -693,19 +679,3 @@ func describeDebugProperty(p *Property) string {
 	}
 	return b.String()
 }
-
-// pseudoVersionRev extracts the revision info if the given version is pseudo version.
-// We wanted to use golang.org/x/mod/module.PseudoVersionRev, but couldn't due to
-// an error in the CI. This is a workaround.
-//
-// It assumes the version string came from the proxy, so a valid, canonical version
-// string. Thus, the check for pseudoversion is not as robust as golang.org/x/mod/module
-// offers.
-func pseudoVersionRev(ver string) (rev string, _ error) {
-	var pseudoVersionRE = regexp.MustCompile(`^v[0-9]+\.(0\.0-|\d+\.\d+-([^+]*\.)?0\.)\d{14}-[A-Za-z0-9]+(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$`)
-	if strings.Count(ver, "-") < 2 || !pseudoVersionRE.MatchString(ver) {
-		return "", errors.New("not a pseudo version")
-	}
-	j := strings.LastIndex(ver, "-")
-	return ver[j+1:], nil
-}

tools/generate.go

@@ -31,7 +31,6 @@ var tools = []struct {
 	{"github.com/zmb3/gogetdoc", "", ""},
 	{"honnef.co/go/tools/cmd/staticcheck", "", ""},
 	{"golang.org/x/tools/cmd/gorename", "", ""},
-	{"github.com/go-delve/delve/cmd/dlv", "master", "dlv-dap"},
 	{"github.com/go-delve/delve/cmd/dlv", "", ""},
 }
 
@@ -140,7 +139,3 @@ func binName(toolPath string) string {
 	}
 	return b
 }
-
-func runWithGoInstall() error {
-	return nil
-}