[vscode-go] src/goDebugConfiguration: use 'dlv' instead of 'dlv-dap' binary
Hyang-Ah Hana Kim (Gerrit)
Hyang-Ah Hana Kim has uploaded this change for review.
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 golang/vscode-go#1977
Change-Id: I5ed398c4d85594a6ad26bea4874324a75f96badb
---
M src/goDebugFactory.ts
M docs/debugging.md
M src/goMain.ts
M src/goTools.ts
M tools/installtools/main.go
M test/integration/install.test.ts
M tools/generate.go
M tools/allTools.ts.in
M src/goInstallTools.ts
M src/goDebugConfiguration.ts
M test/gopls/update.test.ts
M src/goToolsInformation.ts
12 files changed, 99 insertions(+), 126 deletions(-)
diff --git a/docs/debugging.md b/docs/debugging.md
index 4019f80..d5e5045 100644
--- a/docs/debugging.md
+++ b/docs/debugging.md
@@ -4,7 +4,7 @@
These debugging features are possible by using [Delve](https://github.com/go-delve/delve), the Go debugger.
The Go extension has been communicating with Delve through a custom debug adapter program (`legacy` mode).
-As the new [`Delve`'s native debug adapter implementation](https://github.com/go-delve/delve/tree/master/service/dap) has become available, the Go extension is transitioning to deprecate the legacy debug adapter in favor of direct communication with Delve via [DAP](https://microsoft.github.io/debug-adapter-protocol/overview).
+As the new [`Delve`'s native debug adapter implementation](https://github.com/go-delve/delve/tree/master/service/dap) has become available (since Delve v1.6.1), the Go extension is transitioning to deprecate the legacy debug adapter in favor of direct communication with Delve via [DAP](https://microsoft.github.io/debug-adapter-protocol/overview).
📣 **We are happy to announce that now this new mode of Delve integration (_`dlv-dap`_ mode) is enabled for _local_ _debugging_ by default and is available for [_remote_ _debugging_](#remote-debugging) on demand!**
@@ -22,7 +22,7 @@
<p align="center">
<img src="images/dlvdap-install.gif" alt="Delve DAP Install" width="75%">
<br/>
-<em>❗ When you start debugging in `dlv-dap` mode for the first time, the extension will ask to install Delve built from head (`dlv-dap`). Please follow the instructions to install, and then start the debugging session again (i.e. selecting the source file, pressing F5 or click the codelens).</em>
+<em>❗ When you start debugging for the first time or if the `dlv` executable on your system is too old to support DAP, the extension may ask to install or update Delve. Please follow the instructions to install, and then start the debugging session again (i.e. selecting the source file, pressing F5 or click the codelens).</em>
</p>
<div style="text-align: center;"></div>
@@ -32,13 +32,13 @@
Please review [the Features section](#features) that provides an overview of the debug UI and available features.
### Staying Up-To-Date
-[Delve’s native DAP implementation](https://github.com/go-delve/delve/tree/master/service/dap) is under active development, so take advantage of the most recent features and bug fixes by using Delve built from its master branch. The Go extension maintains this newest version of Delve separately from the officially released version of `dlv` and installs it with the name `dlv-dap`.
+[Delve’s native DAP implementation](https://github.com/go-delve/delve/tree/master/service/dap) is under active development, so take advantage of the most recent features and bug fixes by installing the latest version of Delve.
-The easiest way to update `dlv-dap` on demand is to use the `"Go: Install/Update Tools"` command from the Command Palette (Linux/Windows: Ctrl+Shift+P, Mac: ⇧+⌘+P). The command will show `dlv-dap` in the tool list. Select `dlv-dap`, and the extension will build the tool at master.
+The easiest way to update `dlv` on demand is to use the `"Go: Install/Update Tools"` command from the Command Palette (Linux/Windows: Ctrl+Shift+P, Mac: ⇧+⌘+P). The command will show `dlv` in the tool list.
-Once `dlv-dap` is installed on your system, the extension will prompt you for update whenever installing a newer version is necessary (usually after the Go extension upgrade). You can set the `go.toolsManagement.autoUpdate` setting so the extension can update `dlv-dap` automatically for you.
+Once `dlv` is installed on your system, the extension will prompt you for update whenever installing a newer version is necessary (usually after the Go extension upgrade). You can set the `go.toolsManagement.autoUpdate` setting so the extension can update `dlv` automatically for you.
-If you need to install `dlv-dap` manually outside of VS Code (for example, you are building a dev container with necessary tools preinstalled), please see the [Manual Installation](#bookmark=id.xuaxofprncd5) section.
+If you need to install `dlv` manually outside of VS Code (for example, you are building a dev container with necessary tools preinstalled), follow the instruction in [Manually installing `dlv`](https://github.com/golang/vscode-go/blob/master/docs/debugging.md#manually-installing-dlv).
### Switching to legacy debug adapter
@@ -99,7 +99,7 @@
* `local`: attaches to a local process
* `remote`: attaches to an in-progress debug session run by an external server
-You can debug an already running program using the `local` mode type configuration. The Go extension will start `dlv-dap` and configure it to attach to the specified process. Users can select the process to debug with one of the following options:
+You can debug an already running program using the `local` mode type configuration. The Go extension will start `dlv` and configure it to attach to the specified process. Users can select the process to debug with one of the following options:
* Specifying the numeric process id (PID) with the `processId` attribute.
* Specifying the target program name in the `processId` attribute. If there are multiple processes matching the specified program name, the extension will show the list of matching processes at the start of the debug session.
@@ -336,27 +336,23 @@
For information on debugging using the legacy debug adapter, please see the old [Debugging Documentation](https://github.com/golang/vscode-go/blob/master/docs/debugging.md). Note that many new or enhanced features discussed in this document may not be available with the legacy debug adapter.
-### Manually installing `dlv-dap`
+### Manually installing `dlv`
-On rare occasions, you may want to install `dlv-dap` by yourself instead of letting the extension handle its installation.
+On rare occasions, you may want to install `dlv` by yourself instead of letting the extension handle its installation.
-First, find where the Go extension finds tools. Like [other tools the extension uses](https://github.com/golang/vscode-go/blob/master/docs/tools.md#tools), the Go extension searches the `dlv-dap` executable from `${GOPATH}/bin`, `${GOBIN}` and `${PATH}` (or `Path` in Windows). So, install `dlv-dap` in the directory. The easiest way to check the tool installation location the Go extension uses is currently by running the `Go: Locate Configured Go Tools` command from the command palette (⇧+⌘+P or Ctrl+Shift+P).
-
-The following commands download the source of Delve from the master branch, build & store as `dlv-dap` in `~/go/bin/` directory assuming the directory is the place you found from the first step.
+First, find where the Go extension finds tools. Like [other tools the extension uses](https://github.com/golang/vscode-go/blob/master/docs/tools.md#tools), the Go extension searches the `dlv` executable from `${GOPATH}/bin`, `${GOBIN}` and `${PATH}` (or `Path` in Windows). So, install `dlv` in the directory. The easiest way to check the tool installation location the Go extension uses is currently by running the `Go: Locate Configured Go Tools` command from the command palette (⇧+⌘+P or Ctrl+Shift+P).
If your Go version is 1.16 or newer:
```
-$ GOBIN=/tmp/ go install github.com/go-delve/delve/cmd/dlv@master
-$ mv /tmp/dlv $GOPATH/bin/dlv-dap
+$ GOBIN=<dir_to_install_dlv> go install github.com/go-delve/delve/cmd/dlv@latest
```
If your Go version is older than 1.16:
```
$ cd $(mktemp -d)
-$ GO111MODULE=on GOBIN=/tmp/ go get github.com/go-delve/delve/cmd/dlv@master
-$ mv /tmp/dlv $GOPATH/bin/dlv-dap
+$ GO111MODULE=on GOBIN=<dir_to_install_dlv> go get github.com/go-delve/delve/cmd/dlv@latest
```
If you want to explicitly specify the location of the delve binary, use the `go.alternateTools` setting:
@@ -420,7 +416,7 @@
$ dlv-dap dap --listen=:12345
```
-Use the following `launch` configuration to tell `dlv-dap` to execute a binary precompiled with `-gcflags='all=-N -l'`:
+Use the following `launch` configuration to tell `dlv` to execute a binary precompiled with `-gcflags='all=-N -l'`:
```json5
{
@@ -439,7 +435,7 @@
}
```
-Or have the binary compiled by dlv-dap by modifying the above configuration to use:
+Or have the binary compiled by dlv by modifying the above configuration to use:
```json5
"mode": "debug",
@@ -448,7 +444,7 @@
⚠️ Limitations
* Delve DAP does not support `--accept-multiclient` or `--continue` flags, which means after a debug session ends, the dlv-dap process will always exit.
-* If you use `debug` or `test` mode `launch` requests, Delve builds the target binary. Delve tries to build the target from the directory where the `dlv` (or `dlv-dap`) process is running, so make sure to run the `dlv-dap` command from the directory you would run the `go build` or `go test` command.
+* If you use `debug` or `test` mode `launch` requests, Delve builds the target binary. Delve tries to build the target from the directory where the `dlv` process is running, so make sure to run the `dlv` command from the directory you would run the `go build` or `go test` command.
### Running Debugee Externally
diff --git a/src/goDebugConfiguration.ts b/src/goDebugConfiguration.ts
index 3bc9829..f7e7336 100644
--- a/src/goDebugConfiguration.ts
+++ b/src/goDebugConfiguration.ts
@@ -263,34 +263,34 @@
}
}
- 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;
}
diff --git a/src/goDebugFactory.ts b/src/goDebugFactory.ts
index f36bd41..0dd3b2f 100644
--- a/src/goDebugFactory.ts
+++ b/src/goDebugFactory.ts
@@ -12,7 +12,6 @@
import path = require('path');
import * as fs from 'fs';
import * as net from 'net';
-import { getTool } from './goTools';
import { Logger, TimestampedLogger } from './goLogging';
import { DebugProtocol } from 'vscode-debugprotocol';
import { getWorkspaceFolderPath } from './util';
@@ -373,12 +372,12 @@
// 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'
diff --git a/src/goInstallTools.ts b/src/goInstallTools.ts
index 1b02cc5..c6298ff 100644
--- a/src/goInstallTools.ts
+++ b/src/goInstallTools.ts
@@ -235,7 +235,7 @@
}
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 @@
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 @@
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 @@
// 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 @@
if (toolName === 'gopls') {
choices = ['Always Update', 'Update Once', 'Release Notes'];
}
- if (toolName === 'dlv-dap') {
+ if (toolName === 'dlv') {
choices = ['Always Update', 'Update Once'];
}
diff --git a/src/goMain.ts b/src/goMain.ts
index b2cd019..a5326db 100644
--- a/src/goMain.ts
+++ b/src/goMain.ts
@@ -188,6 +188,10 @@
}
}
}
+
+ // Present a warning about the deprecation of a 'dlv-dap' binary setting.
+ checkAlternateTools(cfg);
+
updateGoVarsFromConfig().then(async () => {
suggestUpdates(ctx);
offerToInstallLatestGoVersion();
@@ -1030,3 +1034,23 @@
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.
+The "dlv-dap" property of the "go.alternateTools" setting will be ignored.
+Please use the "dlv" property instead.`;
+
+ 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');
+ }
+ }
+ }
+}
diff --git a/src/goTools.ts b/src/goTools.ts
index a14420d..01289db 100644
--- a/src/goTools.ts
+++ b/src/goTools.ts
@@ -157,9 +157,8 @@
// 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
diff --git a/src/goToolsInformation.ts b/src/goToolsInformation.ts
index aae0d5d..ca68e12 100644
--- a/src/goToolsInformation.ts
+++ b/src/goToolsInformation.ts
@@ -203,10 +203,10 @@
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 @@
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',
diff --git a/test/gopls/update.test.ts b/test/gopls/update.test.ts
index bb36605..150f02c 100644
--- a/test/gopls/update.test.ts
+++ b/test/gopls/update.test.ts
@@ -188,7 +188,7 @@
});
suite('version comparison', () => {
- const tool = getTool('dlv-dap');
+ const tool = getTool('dlv');
const latestVersion = tool.latestVersion;
teardown(() => {
@@ -197,7 +197,7 @@
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,
diff --git a/test/integration/install.test.ts b/test/integration/install.test.ts
index 3602022..6272c8a 100644
--- a/test/integration/install.test.ts
+++ b/test/integration/install.test.ts
@@ -157,12 +157,7 @@
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 @@
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 @@
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}`;
diff --git a/tools/allTools.ts.in b/tools/allTools.ts.in
index e6377b8..b088054 100644
--- a/tools/allTools.ts.in
+++ b/tools/allTools.ts.in
@@ -213,20 +213,10 @@
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',
diff --git a/tools/generate.go b/tools/generate.go
index e3169d1..87e540c 100644
--- a/tools/generate.go
+++ b/tools/generate.go
@@ -15,7 +15,6 @@
import (
"bytes"
"encoding/json"
- "errors"
"flag"
"fmt"
"io"
@@ -24,7 +23,6 @@
"os"
"os/exec"
"path/filepath"
- "regexp"
"sort"
"strings"
@@ -232,18 +230,6 @@
// 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 @@
}
// 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 @@
}
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
-}
diff --git a/tools/installtools/main.go b/tools/installtools/main.go
index 99a2def..d892bd2 100644
--- a/tools/installtools/main.go
+++ b/tools/installtools/main.go
@@ -31,7 +31,6 @@
{"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 @@
}
return b
}
-
-func runWithGoInstall() error {
- return nil
-}
To view, visit change 374594. To unsubscribe, or for help writing mail filters, visit settings.
kokoro (Gerrit)
Kokoro presubmit build finished with status: SUCCESS
Logs at: https://source.cloud.google.com/results/invocations/21e3f7ea-cb1c-467f-b918-b66cdccdbd6a
Patch set 1:TryBot-Result +1
Polina Sokolova (Gerrit)
Attention is currently required from: Hyang-Ah Hana Kim.
18 comments:
Patchset:
Woohoo! Another milestone! :)
This also updates https://github.com/go-delve/delve/issues/2843.
File docs/debugging.md:
Patch Set #1, Line 287:
⚠️ `dlv-dap` needs file or directory values in the launch configuration to be absolute paths. When configuring those values, use [the VS Code variables substitution](https://code.visualstudio.com/docs/editor/variables-reference) - VS Code will resolve the variables inside strings in `launch.json` before passing the configuration to the Go extension and `dlv-dap`. For example, `${workspaceFolder}` will be replaced with the absolute path to the workspace root folder. When appropriate, the Go extension will resolve relative paths or home directory (~) before sending the configuration to `dlv-dap`.replace all dlv-dap in this paragraph with `dlv dap`? I think it would be nice to keep dlv-dap to refer to launch.json mode only.
Also: I don't think "dlv dap" needs file path to be absolute. I think we verified that it resolves them, it just might not resolve them again the desired root. So maybe say "to ensure consistent expansion of relative paths"?
Patch Set #1, Line 23:
<img src="images/dlvdap-install.gif" alt="Delve DAP Install" width="75%">Delve Install?
Patch Set #1, Line 41:
If you need to install `dlv` manually outside of VS Code (for example, you are building a dev container with necessary tools preinstalled), follow the instruction in [Manually installing `dlv`](https://github.com/golang/vscode-go/blob/master/docs/debugging.md#manually-installing-dlv).I think we should have an explicit note explaining what happened to dlv-dap in this doc for users who will notice that it's gone missing and wonder why.
Patch Set #1, Line 102:
You can debug an already running program using the `local` mode type configuration. The Go extension will start `dlv` and configure it to attach to the specified process. Users can select the process to debug with one of the following options:this could also say `dlv dap`
Patch Set #1, Line 361:
"dlv-dap": "<absolute path to your dlv binary>"Take this out or at least add a note that it is being deprecated and to use "dlv"?
Patch Set #1, Line 414:
Start a dlv-dap server ready to accept a client request to launch or attach to a target process:We could continue referring to "dlv dap" (as opposed to headless dlv) server as dlv-dap, but `dlv dap` might be better as it would be distinct from dlv-dap mode.
Patch Set #1, Line 416:
$ dlv-dap dap --listen=:12345dlv
Patch Set #1, Line 438:
Or have the binary compiled by dlv by modifying the above configuration to use:dlv dap?
Patch Set #1, Line 446:
* Delve DAP does not support `--accept-multiclient` or `--continue` flags, which means after a debug session ends, the dlv-dap process will always exit.dlv or dlv dap?
Patch Set #1, Line 447:
* If you use `debug` or `test` mode `launch` requests, Delve builds the target binary. Delve tries to build the target from the directory where the `dlv` process is running, so make sure to run the `dlv` command from the directory you would run the `go build` or `go test` command.extra space left behind where string was removed
Patch Set #1, Line 462:
1. Update Delve (`dlv-dap`) to pick up most recent bug fixes. Follow [the instruction](https://github.com/golang/vscode-go/blob/master/docs/debugging.md#staying-up-to-date).dlv
Patch Set #1, Line 505:
When you are having issues in `dlv-dap` mode, first check if the problems are reproducible after updating `dlv-dap`. It's possible that the problems are already fixed. Follow the instruction for [updating dlv-dap](#updating-dlv-dap)) and [updating extension](https://code.visualstudio.com/docs/editor/extension-gallery#\_extension-autoupdate).Request that users make sure they use the most recent version of dlv binary (not dlv-dap) or even try to install at master?
Patch Set #1, Line 510:
* `go version -m <path/to/dlv-dap>`dlv?
Patch Set #1, Line 546:
"dlv-dap": <path_to_your_delve>Take this out and/or add a deprecation note?
Patch Set #1, Line 554:
$ dlv-dap dap --listen=:12345 --log --log-output=dapdlv
File src/goMain.ts:
Patch Set #1, Line 1038:
async function checkAlternateTools(goConfig: vscode.WorkspaceConfiguration) {how about checkAlternateToolsForDlvDap or checkAlternateToolsForDeprecatedDlvDap?
Patch Set #1, Line 1044:
Please use the "dlv" property instead.`;And "dlv" property will be used instead?
To view, visit change 374594. To unsubscribe, or for help writing mail filters, visit settings.
Hyang-Ah Hana Kim (Gerrit)
Attention is currently required from: Hyang-Ah Hana Kim.
Hyang-Ah Hana Kim uploaded patch set #2 to this change.
12 files changed, 117 insertions(+), 139 deletions(-)
To view, visit change 374594. To unsubscribe, or for help writing mail filters, visit settings.
Hyang-Ah Hana Kim (Gerrit)
Attention is currently required from: Polina Sokolova.
Patch set 1:Run-TryBot +1Trust +1
16 comments:
File docs/debugging.md:
Patch Set #1, Line 287:
⚠️ `dlv-dap` needs file or directory values in the launch configuration to be absolute paths. When configuring those values, use [the VS Code variables substitution](https://code.visualstudio.com/docs/editor/variables-reference) - VS Code will resolve the variables inside strings in `launch.json` before passing the configuration to the Go extension and `dlv-dap`. For example, `${workspaceFolder}` will be replaced with the absolute path to the workspace root folder. When appropriate, the Go extension will resolve relative paths or home directory (~) before sending the configuration to `dlv-dap`.
replace all dlv-dap in this paragraph with `dlv dap`? I think it would be nice to keep dlv-dap to re […]
Done
Patch Set #1, Line 23:
<img src="images/dlvdap-install.gif" alt="Delve DAP Install" width="75%">Delve Install?
Done
Patch Set #1, Line 41:
If you need to install `dlv` manually outside of VS Code (for example, you are building a dev container with necessary tools preinstalled), follow the instruction in [Manually installing `dlv`](https://github.com/golang/vscode-go/blob/master/docs/debugging.md#manually-installing-dlv).
I think we should have an explicit note explaining what happened to dlv-dap in this doc for users wh […]
Done
Patch Set #1, Line 102:
You can debug an already running program using the `local` mode type configuration. The Go extension will start `dlv` and configure it to attach to the specified process. Users can select the process to debug with one of the following options:this could also say `dlv dap`
Done
Patch Set #1, Line 361:
"dlv-dap": "<absolute path to your dlv binary>"Take this out or at least add a note that it is being deprecated and to use "dlv"?
Done
Patch Set #1, Line 414:
Start a dlv-dap server ready to accept a client request to launch or attach to a target process:
We could continue referring to "dlv dap" (as opposed to headless dlv) server as dlv-dap, but `dlv da […]
Done
Patch Set #1, Line 416:
$ dlv-dap dap --listen=:12345dlv
Done
Patch Set #1, Line 438:
Or have the binary compiled by dlv by modifying the above configuration to use:dlv dap?
Done
Patch Set #1, Line 446:
* Delve DAP does not support `--accept-multiclient` or `--continue` flags, which means after a debug session ends, the dlv-dap process will always exit.dlv or dlv dap?
Done
Patch Set #1, Line 447:
* If you use `debug` or `test` mode `launch` requests, Delve builds the target binary. Delve tries to build the target from the directory where the `dlv` process is running, so make sure to run the `dlv` command from the directory you would run the `go build` or `go test` command.extra space left behind where string was removed
Done
Patch Set #1, Line 462:
1. Update Delve (`dlv-dap`) to pick up most recent bug fixes. Follow [the instruction](https://github.com/golang/vscode-go/blob/master/docs/debugging.md#staying-up-to-date).dlv
Done
Patch Set #1, Line 505:
When you are having issues in `dlv-dap` mode, first check if the problems are reproducible after updating `dlv-dap`. It's possible that the problems are already fixed. Follow the instruction for [updating dlv-dap](#updating-dlv-dap)) and [updating extension](https://code.visualstudio.com/docs/editor/extension-gallery#\_extension-autoupdate).
Request that users make sure they use the most recent version of dlv binary (not dlv-dap) or even tr […]
Done
Patch Set #1, Line 510:
* `go version -m <path/to/dlv-dap>`dlv?
Done
Patch Set #1, Line 546:
"dlv-dap": <path_to_your_delve>Take this out and/or add a deprecation note?
changed to `dlv`.
Patch Set #1, Line 554:
$ dlv-dap dap --listen=:12345 --log --log-output=dapdlv
Done
File src/goMain.ts:
Patch Set #1, Line 1038:
async function checkAlternateTools(goConfig: vscode.WorkspaceConfiguration) {how about checkAlternateToolsForDlvDap or checkAlternateToolsForDeprecatedDlvDap?
Too long. And this is for alternateTools config sanity check.
To view, visit change 374594. To unsubscribe, or for help writing mail filters, visit settings.
kokoro (Gerrit)
Attention is currently required from: Polina Sokolova.
Kokoro presubmit build finished with status: SUCCESS
Logs at: https://source.cloud.google.com/results/invocations/5ff6427f-3906-4bee-baed-f52474328fa3
Patch set 2:TryBot-Result +1
Hyang-Ah Hana Kim (Gerrit)
Attention is currently required from: Polina Sokolova.
Hyang-Ah Hana Kim uploaded patch set #3 to this change.
12 files changed, 116 insertions(+), 139 deletions(-)
To view, visit change 374594. To unsubscribe, or for help writing mail filters, visit settings.
Hyang-Ah Hana Kim (Gerrit)
Attention is currently required from: Polina Sokolova.
1 comment:
File src/goMain.ts:
Patch Set #1, Line 1044:
Please use the "dlv" property instead.`;
And "dlv" property will be used instead?
Ack
To view, visit change 374594. To unsubscribe, or for help writing mail filters, visit settings.
kokoro (Gerrit)
Attention is currently required from: Polina Sokolova.
Kokoro presubmit build finished with status: SUCCESS
Logs at: https://source.cloud.google.com/results/invocations/1404623e-afbd-4660-9687-fe7dade102cf
Patch set 3:TryBot-Result +1
Polina Sokolova (Gerrit)
Attention is currently required from: Hyang-Ah Hana Kim.
3 comments:
Commit Message:
Patch Set #2, Line 19:
Fixes golang/vscode-go#1977Also updates https://github.com/go-delve/delve/issues/2843
File docs/debugging.md:
Patch Set #3, Line 360:
You can choose to install a different version of `dlv` by specifying a specific commit hash, a branch name (e.g. `master`), or a released version instead of `latest`.Trailing space
Patch Set #3, Line 360:
You can choose to install a different version of `dlv` by specifying a specific commit hash, a branch name (e.g. `master`), or a released version instead of `latest`.Link to https://github.com/go-delve/delve/tree/master/Documentation/installation
To view, visit change 374594. To unsubscribe, or for help writing mail filters, visit settings.
Hyang-Ah Hana Kim (Gerrit)
Attention is currently required from: Polina Sokolova.
Patch set 4:Trust +1
3 comments:
Commit Message:
Patch Set #2, Line 19:
Fixes golang/vscode-go#1977
Also updates https://github. […]
Made the delve issue to reference the vscode-go issue.
File docs/debugging.md:
Patch Set #3, Line 360:
You can choose to install a different version of `dlv` by specifying a specific commit hash, a branch name (e.g. `master`), or a released version instead of `latest`.
Link to https://github. […]
Done
Patch Set #3, Line 360:
You can choose to install a different version of `dlv` by specifying a specific commit hash, a branch name (e.g. `master`), or a released version instead of `latest`.Trailing space
Done
To view, visit change 374594. To unsubscribe, or for help writing mail filters, visit settings.
Polina Sokolova (Gerrit)
Attention is currently required from: Hyang-Ah Hana Kim.
Patch set 4:Code-Review +2
Hyang-Ah Hana Kim (Gerrit)
Patch set 4:Run-TryBot +1
kokoro (Gerrit)
Kokoro presubmit build finished with status: SUCCESS
Logs at: https://source.cloud.google.com/results/invocations/95a6473e-72b3-419f-a607-6c06f0e22dcb
Patch set 4:TryBot-Result +1
Hyang-Ah Hana Kim (Gerrit)
Hyang-Ah Hana Kim uploaded patch set #5 to this change.
To view, visit change 374594. To unsubscribe, or for help writing mail filters, visit settings.
Hyang-Ah Hana Kim (Gerrit)
Hyang-Ah Hana Kim uploaded patch set #6 to this change.
12 files changed, 117 insertions(+), 139 deletions(-)
To view, visit change 374594. To unsubscribe, or for help writing mail filters, visit settings.