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>
86 lines
2.7 KiB
JavaScript
86 lines
2.7 KiB
JavaScript
'use strict';
|
|
const common = require('../common');
|
|
|
|
common.skipIfInspectorDisabled();
|
|
|
|
const { NodeInstance } = require('../common/inspector-helper.js');
|
|
|
|
// Sets up JS bindings session and runs till the "paused" event
|
|
const script = `
|
|
const { Session } = require('inspector');
|
|
const session = new Session();
|
|
let done = false;
|
|
const interval = setInterval(() => {
|
|
if (done)
|
|
clearInterval(interval);
|
|
}, 150);
|
|
session.on('Debugger.paused', () => {
|
|
done = true;
|
|
});
|
|
session.connect();
|
|
session.post('Debugger.enable');
|
|
console.log('Ready');
|
|
`;
|
|
|
|
async function setupSession(node) {
|
|
const session = await node.connectInspectorSession();
|
|
await session.send({ method: 'NodeRuntime.enable' });
|
|
await session.waitForNotification('NodeRuntime.waitingForDebugger');
|
|
await session.send([
|
|
{ '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': [] } },
|
|
]);
|
|
|
|
return session;
|
|
}
|
|
|
|
async function testSuspend(sessionA, sessionB) {
|
|
console.log('[test]', 'Breaking in code and verifying events are fired');
|
|
await Promise.all([
|
|
sessionA.waitForNotification('Debugger.paused', 'Initial sessionA paused'),
|
|
sessionB.waitForNotification('Debugger.paused', 'Initial sessionB paused'),
|
|
]);
|
|
sessionA.send({ 'method': 'Debugger.resume' });
|
|
|
|
await sessionA.waitForNotification('Runtime.consoleAPICalled',
|
|
'Console output');
|
|
sessionA.send({ 'method': 'Debugger.pause' });
|
|
return Promise.all([
|
|
sessionA.waitForNotification('Debugger.paused', 'SessionA paused'),
|
|
sessionB.waitForNotification('Debugger.paused', 'SessionB paused'),
|
|
]);
|
|
}
|
|
|
|
async function runTest() {
|
|
const child = new NodeInstance(undefined, script);
|
|
|
|
const [session1, session2] =
|
|
await Promise.all([setupSession(child), setupSession(child)]);
|
|
await Promise.all([
|
|
session1.send({ method: 'Runtime.runIfWaitingForDebugger' }),
|
|
session2.send({ method: 'Runtime.runIfWaitingForDebugger' }),
|
|
]);
|
|
await Promise.all([
|
|
session1.send({ method: 'NodeRuntime.disable' }),
|
|
session2.send({ method: 'NodeRuntime.disable' }),
|
|
]);
|
|
await testSuspend(session2, session1);
|
|
console.log('[test]', 'Should shut down after both sessions disconnect');
|
|
|
|
await session1.runToCompletion();
|
|
await session2.send({ 'method': 'Debugger.disable' });
|
|
await session2.disconnect();
|
|
return child.expectShutdown();
|
|
}
|
|
|
|
runTest().then(common.mustCall());
|