forked from microsoft/devicescript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdebugger.ts
More file actions
411 lines (374 loc) · 13.4 KB
/
debugger.ts
File metadata and controls
411 lines (374 loc) · 13.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
import * as vscode from "vscode"
import {
checkDeviceScriptManagerRuntimeVersion,
prepareForDeploy,
} from "./deploy"
import { DeviceScriptExtensionState } from "./state"
import { WorkspaceFolder, DebugConfiguration, CancellationToken } from "vscode"
import {
CHANGE,
DeviceScriptManagerReg,
SRV_DEVICE_SCRIPT_MANAGER,
SRV_ROLE_MANAGER,
} from "jacdac-ts"
import type { StartArgs } from "@devicescript/dap"
import { Utils } from "vscode-uri"
import { checkFileExists } from "./fs"
import { showErrorMessage } from "./telemetry"
export function activateDebugger(extensionState: DeviceScriptExtensionState) {
const { context } = extensionState
const { subscriptions } = context
// register a configuration provider for 'devicescript' debug type
const provider = new DeviceScriptConfigurationProvider(extensionState)
subscriptions.push(
vscode.debug.registerDebugConfigurationProvider(
"devicescript",
provider
)
)
trackRolesAndSimulators(extensionState)
trackDeviceScriptManagers(extensionState)
subscriptions.push(
vscode.commands.registerCommand(
"extension.devicescript.debug.toggleFormatting",
() => {
const ds = vscode.debug.activeDebugSession
if (ds) {
ds.customRequest("toggleFormatting")
}
}
)
)
// register a dynamic configuration provider for 'devicescript' debug type
subscriptions.push(
vscode.debug.registerDebugConfigurationProvider(
"devicescript",
{
provideDebugConfigurations(
folder: WorkspaceFolder | undefined
): vscode.ProviderResult<DebugConfiguration[]> {
return [
{
name: "DeviceScript: Debug",
request: "launch",
type: "devicescript",
stopOnEntry: true,
},
{
name: "DeviceScript: Run",
request: "launch",
type: "devicescript",
stopOnEntry: false,
noDebug: true,
},
]
},
},
vscode.DebugConfigurationProviderTriggerKind.Dynamic
)
)
const debuggerAdapterFactory =
new DeviceScriptAdapterServerDescriptorFactory()
subscriptions.push(
vscode.debug.registerDebugAdapterDescriptorFactory(
"devicescript",
debuggerAdapterFactory
)
)
subscriptions.push(debuggerAdapterFactory)
}
const SETTLE_DELAY = 1500
function trackRolesAndSimulators(extensionState: DeviceScriptExtensionState) {
const { context } = extensionState
const { subscriptions } = context
// track role manager
let unmount: () => void
vscode.debug.onDidStartDebugSession(
session => {
if (session.type !== "devicescript") return
const config = session.configuration
const dsConfig = config as StartArgs
const dev = extensionState.bus.device(dsConfig.deviceId, true)
const srv = dev?.services({
serviceClass: SRV_ROLE_MANAGER,
})?.[0]
if (!srv) return
extensionState.bus.setRoleManagerService(srv)
const mgr = extensionState.bus.roleManager
unmount = mgr.subscribe(CHANGE, () => {
if (!mgr.allRolesBound()) {
// nag user about starting simulators
unmount?.()
unmount = undefined
setTimeout(async () => {
if (mgr.allRolesBound()) return
/*
const start = "Start Simulators"
const res = await vscode.window.showWarningMessage(
"DeviceScript: Would you like to open the simulators view?",
start
)
if (res === start) {
vscode.commands.executeCommand(
"extension.devicescript.openSimulators"
)
}
*/
}, SETTLE_DELAY)
}
})
},
undefined,
subscriptions
)
vscode.debug.onDidTerminateDebugSession(
session => {
if (session.type === "devicescript") {
unmount?.()
unmount = undefined
}
},
undefined,
subscriptions
)
// finaly cleanup
subscriptions.push({
dispose: () => {
extensionState.bus.setRoleManagerService(undefined)
unmount?.()
unmount = undefined
},
})
}
/**
* Stop devicescript managers when debugging session ends
*/
function trackDeviceScriptManagers(extensionState: DeviceScriptExtensionState) {
const { context } = extensionState
const { subscriptions } = context
let deviceId: string
vscode.debug.onDidStartDebugSession(
session => {
if (session.type !== "devicescript") return
const config = session.configuration
const dsConfig = config as StartArgs
deviceId = dsConfig.deviceId
},
undefined,
subscriptions
)
vscode.debug.onDidTerminateDebugSession(
async session => {
if (session.type === "devicescript" && deviceId) {
const dev = extensionState.bus.device(deviceId, true)
const managers = dev?.services({
serviceClass: SRV_DEVICE_SCRIPT_MANAGER,
})
if (managers)
for (const manager of managers) {
const running = manager.register(
DeviceScriptManagerReg.Running
)
await running.sendSetBoolAsync(false)
}
}
},
undefined,
subscriptions
)
}
export class DeviceScriptAdapterServerDescriptorFactory
implements vscode.DebugAdapterDescriptorFactory
{
async createDebugAdapterDescriptor(
session: vscode.DebugSession,
executable: vscode.DebugAdapterExecutable | undefined
) {
return new vscode.DebugAdapterServer(8083, "localhost")
}
dispose() {}
}
export class DeviceScriptConfigurationProvider
implements vscode.DebugConfigurationProvider
{
constructor(readonly extensionState: DeviceScriptExtensionState) {}
get bus() {
return this.extensionState.bus
}
private simsShownOnce = false
private startSimulatorsOnStart() {
const settings = vscode.workspace.getConfiguration(
"devicescript.debugger"
)
if (settings.get("showTerminalOnStart"))
vscode.commands.executeCommand(
"extension.devicescript.terminal.show"
)
if (settings.get("showSimulatorsOnStart")) {
vscode.commands.executeCommand(
"extension.devicescript.openSimulators",
{ askUser: this.simsShownOnce }
)
this.simsShownOnce = true
}
}
async resolveDebugConfigurationWithSubstitutedVariables(
folder: vscode.WorkspaceFolder,
config: vscode.DebugConfiguration,
token?: vscode.CancellationToken
) {
const sessionConfig = config as vscode.DebugSessionOptions
const dsConfig = config as StartArgs
let program: string = config.program
// program can be absolute or relative...
if (!program) {
showErrorMessage(
"debug.programnotfound",
"Debug cancelled\nCannot find a program to debug."
)
return undefined
}
// TODO make sure we're running devtools in the correct folder
// program is a file system path, potentially full path on windows
let programUri = vscode.Uri.file(program)
if (!/^(\/|\w+:\\)/i.test(programUri.fsPath))
programUri = Utils.resolvePath(folder.uri, program)
let dir = programUri
let n = 0
do {
dir = Utils.dirname(dir)
if (await checkFileExists(dir, `devsconfig.json`)) {
await this.extensionState.devtools.setProjectFolder(dir)
program = programUri.path.slice(
this.extensionState.devtools.projectFolder.path.length + 1
)
break
}
if (n++ > 30) {
console.log("devsconfig not found", { dir, folder })
showErrorMessage(
"debug.notrootfolder",
"Debug cancelled\nCould not find root folder (contains 'devsconfig.json')."
)
return undefined
}
} while (dir !== folder.uri)
await this.extensionState.devtools.start()
if (!this.extensionState.devtools.connected) {
showErrorMessage(
"debug.startfailed",
"Debug cancelled\nCannot start development server."
)
return undefined
}
// find device
if (!dsConfig.deviceId) {
const service =
await this.extensionState.resolveDeviceScriptManager({
autoStartSimulator: true,
})
if (service) {
const idx = service.device
.services({ serviceClass: service.serviceClass })
.indexOf(service)
dsConfig.deviceId = service.device.deviceId
dsConfig.serviceInstance = idx
}
}
if (token?.isCancellationRequested) return undefined
if (!dsConfig.deviceId) {
showErrorMessage(
"debug.notdevice",
`Debug cancelled\nNo device selected.`
)
return undefined
}
// expand device short name
if (/^[A-Z][A-Z][0-9][0-9]$/i.test(dsConfig.deviceId)) {
const shortIdDevice = this.bus
.devices({
serviceClass: SRV_DEVICE_SCRIPT_MANAGER,
lost: false,
})
.find(d => d.shortId === dsConfig.deviceId)
if (shortIdDevice) dsConfig.deviceId = shortIdDevice.deviceId
}
// start vm if needed
if (dsConfig.deviceId === this.extensionState.simulatorScriptManagerId)
await this.extensionState.startSimulator()
// find service
const service = this.bus.device(dsConfig.deviceId, true)?.services({
serviceClass: SRV_DEVICE_SCRIPT_MANAGER,
})?.[dsConfig.serviceInstance || 0]
if (!service || service.disposed) {
showErrorMessage(
"debug.nodevicebyid",
`Debug cancelled\nCould not find device ${dsConfig.deviceId}.`
)
return undefined
}
// check version (show it's own error dialogs)
if (
dsConfig.deviceId !== this.extensionState.simulatorScriptManagerId
) {
const versionOk = await checkDeviceScriptManagerRuntimeVersion(
this.extensionState.devtools.runtimeVersion,
service
)
if (!versionOk) {
// don't start debugging
return undefined
}
}
// prepare for deploy
await prepareForDeploy(this.extensionState, service)
// build and deploy
const buildResult = await this.extensionState.devtools.build(
program,
service
)
if (!buildResult?.success) {
// show errors
vscode.commands.executeCommand("workbench.action.problems.focus")
return undefined
}
// save as currently debugged project
await this.extensionState.updateCurrentDeviceScriptManagerId(
service.device.deviceId
)
// show UI
this.startSimulatorsOnStart()
// run, no debug
if (sessionConfig?.noDebug) {
console.debug(`skip debugger`)
return undefined
}
return config
}
/**
* Massage a debug configuration just before a debug session is being launched,
* e.g. add all missing attributes to the debug configuration.
*/
async resolveDebugConfiguration(
folder: WorkspaceFolder | undefined,
config: DebugConfiguration,
token?: CancellationToken
) {
// folder.uri is the root namespace for the auto-generate launch commandß
if (
!config.program &&
((config.request === "launch" && config.type === "devicescript") ||
(!config.request && !config.type))
) {
const file = await this.extensionState.pickDeviceScriptFile({
title: "Pick a file to debug.",
})
if (!file) return undefined
// TODO: support workspace !== projectfolder
config.program = vscode.workspace.asRelativePath(file)
config.request = "launch"
config.type = "devicescript"
}
return config
}
}