in src/goDebugConfiguration.ts [119:352]
public async resolveDebugConfiguration(
folder: vscode.WorkspaceFolder | undefined,
debugConfiguration: vscode.DebugConfiguration,
token?: vscode.CancellationToken
): Promise<vscode.DebugConfiguration> {
const activeEditor = vscode.window.activeTextEditor;
if (!debugConfiguration || !debugConfiguration.request) {
// if 'request' is missing interpret this as a missing launch.json
if (!activeEditor || activeEditor.document.languageId !== 'go') {
return;
}
debugConfiguration = Object.assign(debugConfiguration || {}, {
name: 'Launch',
type: this.defaultDebugAdapterType,
request: 'launch',
mode: 'auto',
program: path.dirname(activeEditor.document.fileName) // matches ${fileDirname}
});
}
if (!debugConfiguration.type) {
debugConfiguration['type'] = this.defaultDebugAdapterType;
}
if (!debugConfiguration['mode']) {
if (debugConfiguration.request === 'launch') {
// 'auto' will decide mode by checking file extensions later
debugConfiguration['mode'] = 'auto';
} else if (debugConfiguration.request === 'attach') {
debugConfiguration['mode'] = 'local';
}
}
debugConfiguration['packagePathToGoModPathMap'] = packagePathToGoModPathMap;
const goConfig = getGoConfig(folder && folder.uri);
const dlvConfig = goConfig['delveConfig'];
const defaultConfig = vscode.extensions.getExtension(extensionId).packageJSON.contributes.configuration
.properties['go.delveConfig'].properties;
// Figure out which debugAdapter is being used first, so we can use this to send warnings
// for properties that don't apply.
if (!debugConfiguration.hasOwnProperty('debugAdapter') && dlvConfig.hasOwnProperty('debugAdapter')) {
const { globalValue, workspaceValue } = goConfig.inspect('delveConfig.debugAdapter');
// user configured the default debug adapter through settings.json.
if (globalValue !== undefined || workspaceValue !== undefined) {
debugConfiguration['debugAdapter'] = dlvConfig['debugAdapter'];
}
}
if (!debugConfiguration['debugAdapter']) {
// For local modes, default to dlv-dap. For remote - to legacy for now.
debugConfiguration['debugAdapter'] = debugConfiguration['mode'] !== 'remote' ? 'dlv-dap' : 'legacy';
}
if (debugConfiguration['debugAdapter'] === 'dlv-dap') {
if (debugConfiguration['mode'] === 'remote') {
// This is only possible if a user explicitely requests this combination. Let them, with a warning.
// They need to use dlv at version 'v1.7.3-0.20211026171155-b48ceec161d5' or later,
// but we have no way of detectng that with an external server.
this.showWarning(
'ignoreDlvDAPInRemoteModeWarning',
"Using new 'remote' mode with 'dlv-dap' to connect to an external `dlv --headless` server via DAP."
);
} else if (debugConfiguration['port']) {
this.showWarning(
'ignorePortUsedInDlvDapWarning',
"`port` with 'dlv-dap' debugAdapter connects to [an external `dlv dap` server](https://github.com/golang/vscode-go/blob/master/docs/debugging.md#running-debugee-externally) to launch a program or attach to a process. Remove 'host' and 'port' from your launch.json if you have not launched a 'dlv dap' server."
);
}
}
const debugAdapter = debugConfiguration['debugAdapter'] === 'dlv-dap' ? 'dlv-dap' : 'dlv';
let useApiV1 = false;
if (debugConfiguration.hasOwnProperty('useApiV1')) {
useApiV1 = debugConfiguration['useApiV1'] === true;
} else if (dlvConfig.hasOwnProperty('useApiV1')) {
useApiV1 = dlvConfig['useApiV1'] === true;
}
if (useApiV1) {
debugConfiguration['apiVersion'] = 1;
}
if (!debugConfiguration.hasOwnProperty('apiVersion') && dlvConfig.hasOwnProperty('apiVersion')) {
debugConfiguration['apiVersion'] = dlvConfig['apiVersion'];
}
if (
debugAdapter === 'dlv-dap' &&
(debugConfiguration.hasOwnProperty('dlvLoadConfig') ||
goConfig.inspect('delveConfig.dlvLoadConfig').globalValue !== undefined ||
goConfig.inspect('delveConfig.dlvLoadConfig').workspaceValue !== undefined)
) {
this.showWarning(
'ignoreDebugDlvConfigWithDlvDapWarning',
"'dlvLoadConfig' is deprecated with dlv-dap debug adapter.\n\nDlv-dap loads composite data on demand and uses increased string limits on source code hover, in Debug Console and via Copy Value. Please file an issue if these are not sufficient for your use case."
);
}
// Reflect the defaults set through go.delveConfig setting.
const dlvProperties = [
'showRegisters',
'showGlobalVariables',
'substitutePath',
'showLog',
'logOutput',
'dlvFlags',
'hideSystemGoroutines'
];
if (debugAdapter !== 'dlv-dap') {
dlvProperties.push('dlvLoadConfig');
}
dlvProperties.forEach((p) => {
if (!debugConfiguration.hasOwnProperty(p)) {
if (dlvConfig.hasOwnProperty(p)) {
debugConfiguration[p] = dlvConfig[p];
} else {
debugConfiguration[p] = defaultConfig[p]?.default;
}
}
});
if (debugAdapter !== 'dlv-dap' && debugConfiguration.request === 'attach' && !debugConfiguration['cwd']) {
debugConfiguration['cwd'] = '${workspaceFolder}';
if (vscode.workspace.workspaceFolders?.length > 1) {
debugConfiguration['cwd'] = '${fileWorkspaceFolder}';
}
}
if (debugConfiguration['cwd']) {
// expand 'cwd' folder path containing '~', which would cause dlv to fail
debugConfiguration['cwd'] = resolveHomeDir(debugConfiguration['cwd']);
}
// Remove any '--gcflags' entries and show a warning
if (debugConfiguration['buildFlags']) {
const resp = this.removeGcflags(debugConfiguration['buildFlags']);
if (resp.removed) {
debugConfiguration['buildFlags'] = resp.args;
this.showWarning(
'ignoreDebugGCFlagsWarning',
"User specified build flag '--gcflags' in 'buildFlags' is being ignored (see [debugging with build flags](https://github.com/golang/vscode-go/blob/master/docs/debugging.md#specifying-other-build-flags) documentation)"
);
}
}
if (debugConfiguration['env'] && debugConfiguration['env']['GOFLAGS']) {
const resp = this.removeGcflags(debugConfiguration['env']['GOFLAGS']);
if (resp.removed) {
debugConfiguration['env']['GOFLAGS'] = resp.args;
this.showWarning(
'ignoreDebugGCFlagsWarning',
"User specified build flag '--gcflags' in 'GOFLAGS' is being ignored (see [debugging with build flags](https://github.com/golang/vscode-go/blob/master/docs/debugging.md#specifying-other-build-flags) documentation)"
);
}
}
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('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');
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();
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
// 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;
}
if (debugConfiguration['mode'] === 'auto') {
let filename = activeEditor?.document?.fileName;
if (debugConfiguration['program'] && debugConfiguration['program'].endsWith('.go')) {
// If the 'program' attribute is a file, not a directory, then we will determine the mode from that
// file path instead of the currently active file.
filename = debugConfiguration['program'];
}
debugConfiguration['mode'] = filename?.endsWith('_test.go') ? 'test' : 'debug';
}
if (debugConfiguration['mode'] === 'test' && debugConfiguration['program'].endsWith('_test.go')) {
// Running a test file in file mode does not make sense, so change the program
// to the directory.
debugConfiguration['program'] = path.dirname(debugConfiguration['program']);
}
if (debugConfiguration.request === 'launch' && debugConfiguration['mode'] === 'remote') {
this.showWarning(
'ignoreDebugLaunchRemoteWarning',
"Request type of 'launch' with mode 'remote' is deprecated, please use request type 'attach' with mode 'remote' instead."
);
}
if (
debugAdapter !== 'dlv-dap' &&
debugConfiguration.request === 'attach' &&
debugConfiguration['mode'] === 'remote' &&
debugConfiguration['program']
) {
this.showWarning(
'ignoreUsingRemotePathAndProgramWarning',
"Request type of 'attach' with mode 'remote' does not work with 'program' attribute, please use 'cwd' attribute instead."
);
}
if (debugConfiguration.request === 'attach' && debugConfiguration['mode'] === 'local') {
if (!debugConfiguration['processId'] || debugConfiguration['processId'] === 0) {
// The processId is not valid, offer a quickpick menu of all processes.
debugConfiguration['processId'] = await pickProcess();
} else if (
typeof debugConfiguration['processId'] === 'string' &&
debugConfiguration['processId'] !== '${command:pickProcess}' &&
debugConfiguration['processId'] !== '${command:pickGoProcess}'
) {
debugConfiguration['processId'] = await pickProcessByName(debugConfiguration['processId']);
}
}
return debugConfiguration;
}