mirror of
https://github.com/nodejs/node.git
synced 2024-11-21 10:59:27 +00:00
0161ad0baf
`NodeRuntime.waitingForDebugger` is a new Inspector Protocol event that will fire when the process being inspected is waiting for the debugger (for example, when `inspector.waitForDebugger()` is called). This allows inspecting processes to know when the inspected process is waiting for a `Runtime.runIfWaitingForDebugger` message to resume execution. It allows tooling to resume execution of the inspected process as soon as it deems necessary, without having to guess if the inspected process is waiting or not, making the workflow more deterministic. With a more deterministic workflow, it is possible to update Node.js core tests to avoid race conditions that can cause flakiness. Therefore, tests were also changed as following: * Remove no-op Runtime.runIfWaitingForDebugger from tests that don't need it * Use NodeRuntime.waitingForDebugger in all tests that need Runtime.runIfWaitingForDebugger, to ensure order of operations is predictable and correct * Simplify test-inspector-multisession-ws There might be value in adding `NodeWorker.waitingForDebugger` in a future patch, but as of right now, no Node.js core inspector tests using worker threads are not failing due to race conditions. Fixes: https://github.com/nodejs/node/issues/34730 PR-URL: https://github.com/nodejs/node/pull/51560 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
115 lines
3.8 KiB
JavaScript
115 lines
3.8 KiB
JavaScript
'use strict';
|
|
const common = require('../common');
|
|
|
|
common.skipIfInspectorDisabled();
|
|
|
|
const assert = require('assert');
|
|
const { resolve: UrlResolve } = require('url');
|
|
const fixtures = require('../common/fixtures');
|
|
const { NodeInstance } = require('../common/inspector-helper.js');
|
|
|
|
function assertScopeValues({ result }, expected) {
|
|
const unmatched = new Set(Object.keys(expected));
|
|
for (const actual of result) {
|
|
const value = expected[actual.name];
|
|
assert.strictEqual(actual.value.value, value);
|
|
unmatched.delete(actual.name);
|
|
}
|
|
assert.deepStrictEqual(Array.from(unmatched.values()), []);
|
|
}
|
|
|
|
async function testBreakpointOnStart(session) {
|
|
console.log('[test]',
|
|
'Verifying debugger stops on start (--inspect-brk option)');
|
|
const commands = [
|
|
{ 'method': 'Runtime.enable' },
|
|
{ 'method': 'Debugger.enable' },
|
|
{ 'method': 'Debugger.setPauseOnExceptions',
|
|
'params': { 'state': 'none' } },
|
|
{ 'method': 'Debugger.setAsyncCallStackDepth',
|
|
'params': { 'maxDepth': 0 } },
|
|
{ 'method': 'Profiler.enable' },
|
|
{ 'method': 'Profiler.setSamplingInterval',
|
|
'params': { 'interval': 100 } },
|
|
{ 'method': 'Debugger.setBlackboxPatterns',
|
|
'params': { 'patterns': [] } },
|
|
{ 'method': 'Runtime.runIfWaitingForDebugger' },
|
|
];
|
|
|
|
await session.send({ method: 'NodeRuntime.enable' });
|
|
await session.waitForNotification('NodeRuntime.waitingForDebugger');
|
|
await session.send(commands);
|
|
await session.send({ method: 'NodeRuntime.disable' });
|
|
await session.waitForBreakOnLine(
|
|
0, UrlResolve(session.scriptURL().toString(), 'message.mjs'));
|
|
}
|
|
|
|
async function testBreakpoint(session) {
|
|
console.log('[test]', 'Setting a breakpoint and verifying it is hit');
|
|
const commands = [
|
|
{ 'method': 'Debugger.setBreakpointByUrl',
|
|
'params': { 'lineNumber': 7,
|
|
'url': session.scriptURL(),
|
|
'columnNumber': 0,
|
|
'condition': '' } },
|
|
{ 'method': 'Debugger.resume' },
|
|
];
|
|
await session.send(commands);
|
|
const { scriptSource } = await session.send({
|
|
'method': 'Debugger.getScriptSource',
|
|
'params': { 'scriptId': session.mainScriptId },
|
|
});
|
|
assert(scriptSource && (scriptSource.includes(session.script())),
|
|
`Script source is wrong: ${scriptSource}`);
|
|
|
|
await session.waitForConsoleOutput('log', ['A message', 5]);
|
|
const paused = await session.waitForBreakOnLine(7, session.scriptURL());
|
|
const scopeId = paused.params.callFrames[0].scopeChain[0].object.objectId;
|
|
|
|
console.log('[test]', 'Verify we can read current application state');
|
|
const response = await session.send({
|
|
'method': 'Runtime.getProperties',
|
|
'params': {
|
|
'objectId': scopeId,
|
|
'ownProperties': false,
|
|
'accessorPropertiesOnly': false,
|
|
'generatePreview': true
|
|
}
|
|
});
|
|
assertScopeValues(response, { t: 1001, k: 1, message: 'A message' });
|
|
|
|
let { result } = await session.send({
|
|
'method': 'Debugger.evaluateOnCallFrame', 'params': {
|
|
'callFrameId': session.pausedDetails().callFrames[0].callFrameId,
|
|
'expression': 'k + t',
|
|
'objectGroup': 'console',
|
|
'includeCommandLineAPI': true,
|
|
'silent': false,
|
|
'returnByValue': false,
|
|
'generatePreview': true
|
|
}
|
|
});
|
|
|
|
assert.strictEqual(result.value, 1002);
|
|
|
|
result = (await session.send({
|
|
'method': 'Runtime.evaluate', 'params': {
|
|
'expression': '5 * 5'
|
|
}
|
|
})).result;
|
|
assert.strictEqual(result.value, 25);
|
|
}
|
|
|
|
async function runTest() {
|
|
const child = new NodeInstance(['--inspect-brk=0'], '',
|
|
fixtures.path('es-modules/loop.mjs'));
|
|
|
|
const session = await child.connectInspectorSession();
|
|
await testBreakpointOnStart(session);
|
|
await testBreakpoint(session);
|
|
await session.runToCompletion();
|
|
assert.strictEqual((await child.expectShutdown()).exitCode, 55);
|
|
}
|
|
|
|
runTest().then(common.mustCall());
|