11import * as vscode from 'vscode' ;
2+
23import {
34 BazelConfiguration ,
45 BzlConfiguration ,
78} from './configuration' ;
89import { CommandName } from './constants' ;
910import { Settings } from './settings' ;
10- import { LaunchableComponent , LaunchArgs , Status } from './status' ;
11+ import { LaunchableComponent , LaunchArgs , Status , StatusError } from './status' ;
1112import { SocketDebugClient , LogLevel } from "node-debugprotocol-client" ;
13+ import { isDefined } from 'vscode-common/out/types' ;
1214
1315
1416export class StarlarkDebugger
@@ -25,39 +27,34 @@ export class StarlarkDebugger
2527
2628 this . disposables . push ( vscode . debug . registerDebugAdapterDescriptorFactory ( 'starlark' , this ) ) ;
2729 this . disposables . push ( vscode . debug . registerDebugConfigurationProvider ( 'starlark' , this ) ) ;
30+
31+ vscode . commands . registerCommand ( CommandName . AskForDebugTargetLabel , this . handleCommandAskForDebugTargetLabel , this . disposables ) ;
32+ }
33+
34+ async handleCommandAskForDebugTargetLabel ( ) : Promise < string | undefined > {
35+ return vscode . window . showInputBox ( {
36+ placeHolder : 'Please enter the label of bazel build target for the debug session' ,
37+ value : '//:your_build_target_here'
38+ } ) ;
2839 }
2940
3041 /**
31- * Invoke is typically triggered from a 'debug' code action click. It tries to check
32- * that the debug adapter is running and then starts a debug session.
42+ * Invoke is typically triggered from a 'debug' code action click. It tries
43+ * to check that the debug adapter is running and then starts a debug session.
3344 * @param command
3445 * @param label
3546 * @returns
3647 */
3748 async invoke ( command : string , label : string ) : Promise < boolean > {
38- const bazelSettings = await this . bazelSettings . get ( ) ;
3949 const debugSettings = await this . settings . get ( ) ;
4050
41- const action = await vscode . window . showInformationMessage ( debugInfoMessage ( ) , 'OK' , 'Cancel' ) ;
42- if ( action !== 'OK' ) {
43- return false ;
44- }
45-
46- const args = [ command , label ] ;
47- args . push ( ...bazelSettings . buildFlags , ...bazelSettings . starlarkDebugFlags ) ;
48-
49- if ( this . status !== Status . READY && this . status !== Status . DISABLED ) {
50- await this . handleCommandLaunch ( ) ;
51- }
52-
53- await vscode . commands . executeCommand ( CommandName . Invoke , args ) ;
54-
5551 return vscode . debug . startDebugging (
5652 vscode . workspace . getWorkspaceFolder ( this . workspaceFolder ) ,
5753 {
5854 type : 'starlark' ,
59- name : 'Attach to a Starlark Debug Session' ,
60- request : 'attach' ,
55+ name : 'Launch to a Starlark Debug Session for ' + label ,
56+ request : 'launch' ,
57+ targetLabel : label ,
6158 debugServerHost : debugSettings . debugAdapterHost ,
6259 debugServerPort : debugSettings . debugAdapterPort
6360 } ,
@@ -69,7 +66,8 @@ export class StarlarkDebugger
6966 * @override
7067 */
7168 async shouldLaunch ( e : Error ) : Promise < boolean > {
72- return false ;
69+ const cfg = await this . settings . get ( ) ;
70+ return cfg . autoLaunch ;
7371 }
7472
7573 /**
@@ -89,7 +87,7 @@ export class StarlarkDebugger
8987 await client . connectAdapter ( ) ;
9088 } catch ( e ) {
9189 if ( isTCPConnectionError ( e ) && e . code === 'ECONNREFUSED' ) {
92- throw new Error ( `Debug Adapter is not running` ) ;
90+ throw new StatusError ( `Debug Adapter is not running` , Status . STOPPED ) ;
9391 } else {
9492 throw e ;
9593 }
@@ -118,7 +116,7 @@ export class StarlarkDebugger
118116
119117 return {
120118 command : args . map ( a => a . replace ( '${workspaceFolder}' , this . workspaceFolder . fsPath ) ) ,
121- showSuccessfulLaunchTerminal : true ,
119+ showSuccessfulLaunchTerminal : false ,
122120 showFailedLaunchTerminal : true ,
123121 } ;
124122 }
@@ -140,7 +138,7 @@ export class StarlarkDebugger
140138 * Massage a debug configuration just before a debug session is being
141139 * launched, e.g. add all missing attributes to the debug configuration.
142140 */
143- resolveDebugConfiguration ( folder : vscode . WorkspaceFolder | undefined , config : vscode . DebugConfiguration , token ?: vscode . CancellationToken ) : vscode . ProviderResult < vscode . DebugConfiguration > {
141+ async resolveDebugConfiguration ( folder : vscode . WorkspaceFolder | undefined , config : vscode . DebugConfiguration , token ?: vscode . CancellationToken ) : Promise < vscode . DebugConfiguration | null | undefined > {
144142 return config ;
145143 }
146144
@@ -163,18 +161,36 @@ export class StarlarkDebugger
163161 * @param token A cancellation token.
164162 * @return The resolved debug configuration or undefined or null.
165163 */
166- resolveDebugConfigurationWithSubstitutedVariables ( folder : vscode . WorkspaceFolder | undefined , debugConfiguration : vscode . DebugConfiguration , token ?: vscode . CancellationToken ) : vscode . ProviderResult < vscode . DebugConfiguration > {
167- return debugConfiguration ;
168- }
164+ async resolveDebugConfigurationWithSubstitutedVariables ( folder : vscode . WorkspaceFolder | undefined , config : vscode . DebugConfiguration , token ?: vscode . CancellationToken ) : Promise < vscode . DebugConfiguration | undefined > {
165+ let targetLabel = config . targetLabel ;
166+ if ( ! targetLabel ) {
167+ targetLabel = await this . handleCommandAskForDebugTargetLabel ( ) ;
168+ }
169+ if ( ! targetLabel ) {
170+ vscode . window . showInformationMessage ( `A label for the "bazel build" command is required. Please add it to your launch configuration.` ) ;
171+ return ;
172+ }
169173
170- }
174+ // launch the bazel debugger if this is a launch config
175+ if ( config . request === 'launch' ) {
176+ const bazelSettings = await this . bazelSettings . get ( ) ;
177+ const flags = bazelSettings . starlarkDebugFlags || [ ] ;
178+ const extraFlags = config . extraBazelFlags || [ ] ;
179+
180+ await vscode . commands . executeCommand ( CommandName . Invoke ,
181+ [ 'build' , targetLabel , ...flags , ...extraFlags ] . filter ( arg => isDefined ( arg ) ) ) ;
182+ }
183+
184+ // launch the debug adapter if it not already running
185+ if ( this . status !== Status . READY && this . status !== Status . DISABLED ) {
186+ // this needs to wait until the thing is actually running!
187+ await this . handleCommandLaunch ( ) ;
188+ this . restart ( ) ;
189+ }
190+
191+ return config ;
192+ }
171193
172- function debugInfoMessage ( ) : string {
173- return (
174- 'Running Bazel in debug mode blocks until the debug adapter client attaches. ' +
175- "It is recommended to make changes to BUILD/bzl files in the area of interest to defeat Bazel's aggressive caching mechanism. " +
176- 'Are you sure you want to continue?'
177- ) ;
178194}
179195
180196interface TCPConnectionError {
0 commit comments