Skip to content

Commit 678ee5b

Browse files
joyeecheungjoyeecheung
committed
test: normalize known inspector crash as completion
This works around a pre-existing inspector issue: if the debuggee exits too quickly the inspector can segfault while tearing down. For now normalize the trailing segfault as completion to keep the CI green until the upstream bug is fixed, since it only reproduces on some slow CI machines and is not what the probe tests care about.
1 parent 14e16db commit 678ee5b

10 files changed

Lines changed: 69 additions & 33 deletions

‎test/common/debugger-probe.js‎

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,54 @@
11
'use strict';
22

3+
const assert = require('assert');
34
const fixtures = require('./fixtures');
45
const path = require('path');
56

7+
const probeTargetExitSignal = 'SIGSEGV';
8+
const probeTargetExitMessage =
9+
`Target exited with signal ${probeTargetExitSignal} before target completion`;
10+
611
function debuggerFixturePath(name) {
712
return path.relative(process.cwd(), fixtures.path('debugger', name));
813
}
914

10-
function escapeRegex(string) {
11-
return string.replace(/[-/\\^$*+?.()|[\]{}]/g, '\\$&');
15+
// Work around a pre-existing inspector issue: if the debuggee exits too quickly
16+
// the inspector can segfault while tearing down. For now normalize the
17+
// trailing segfault as completion until the upstream bug is fixed.
18+
// See https://github.com/nodejs/node/issues/62765
19+
// https://github.com/nodejs/node/issues/58245
20+
function assertProbeJson(output, expected) {
21+
const normalized = JSON.parse(output);
22+
const lastResult = normalized.results?.[normalized.results.length - 1];
23+
24+
if (lastResult?.event === 'error' &&
25+
lastResult.error?.code === 'probe_target_exit' &&
26+
lastResult.error?.signal === probeTargetExitSignal &&
27+
lastResult.error?.message === probeTargetExitMessage) {
28+
// Log to facilitate debugging if this normalization is occurring.
29+
console.log('Normalizing trailing SIGSEGV in JSON probe output');
30+
normalized.results[normalized.results.length - 1] = { event: 'completed' };
31+
}
32+
33+
assert.deepStrictEqual(normalized, expected);
34+
}
35+
36+
function assertProbeText(output, expected) {
37+
const idx = output.indexOf(probeTargetExitMessage);
38+
let normalized;
39+
if (idx !== -1) {
40+
// Log to facilitate debugging if this normalization is occurring.
41+
console.log('Normalizing trailing SIGSEGV in text probe output');
42+
normalized = output.slice(0, output.lastIndexOf('\n', idx)) + '\nCompleted';
43+
} else {
44+
normalized = output;
45+
}
46+
assert.strictEqual(normalized, expected);
1247
}
1348

1449
module.exports = {
15-
escapeRegex,
50+
assertProbeJson,
51+
assertProbeText,
1652
missScript: debuggerFixturePath('probe-miss.js'),
1753
probeScript: debuggerFixturePath('probe.js'),
1854
throwScript: debuggerFixturePath('probe-throw.js'),

‎test/parallel/test-debugger-probe-child-inspect-port-zero.js‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
const common = require('../common');
55
common.skipIfInspectorDisabled();
66

7-
const assert = require('assert');
87
const { spawnSyncAndAssert } = require('../common/child_process');
9-
const { probeScript } = require('../common/debugger-probe');
8+
const { assertProbeJson, probeScript } = require('../common/debugger-probe');
109

1110
spawnSyncAndAssert(process.execPath, [
1211
'inspect',
@@ -18,7 +17,7 @@ spawnSyncAndAssert(process.execPath, [
1817
probeScript,
1918
], {
2019
stdout(output) {
21-
assert.deepStrictEqual(JSON.parse(output), {
20+
assertProbeJson(output, {
2221
v: 1,
2322
probes: [{
2423
expr: 'finalValue',

‎test/parallel/test-debugger-probe-global-option-order.js‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
const common = require('../common');
55
common.skipIfInspectorDisabled();
66

7-
const assert = require('assert');
87
const { spawnSyncAndAssert } = require('../common/child_process');
9-
const { probeScript } = require('../common/debugger-probe');
8+
const { assertProbeJson, probeScript } = require('../common/debugger-probe');
109

1110
spawnSyncAndAssert(process.execPath, [
1211
'inspect',
@@ -16,7 +15,7 @@ spawnSyncAndAssert(process.execPath, [
1615
probeScript,
1716
], {
1817
stdout(output) {
19-
assert.deepStrictEqual(JSON.parse(output), {
18+
assertProbeJson(output, {
2019
v: 1,
2120
probes: [{
2221
expr: 'finalValue',

‎test/parallel/test-debugger-probe-json-preview.js‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44
const common = require('../common');
55
common.skipIfInspectorDisabled();
66

7-
const assert = require('assert');
87
const { spawnSyncAndAssert } = require('../common/child_process');
9-
const { probeTypesScript } = require('../common/debugger-probe');
8+
const {
9+
assertProbeJson,
10+
probeTypesScript,
11+
} = require('../common/debugger-probe');
1012

1113
const location = `${probeTypesScript}:17`;
1214

@@ -23,7 +25,7 @@ spawnSyncAndAssert(process.execPath, [
2325
probeTypesScript,
2426
], {
2527
stdout(output) {
26-
assert.deepStrictEqual(JSON.parse(output), {
28+
assertProbeJson(output, {
2729
v: 1,
2830
probes: [
2931
{ expr: 'objectValue', target: [probeTypesScript, 17] },

‎test/parallel/test-debugger-probe-json-special-values.js‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44
const common = require('../common');
55
common.skipIfInspectorDisabled();
66

7-
const assert = require('assert');
87
const { spawnSyncAndAssert } = require('../common/child_process');
9-
const { probeTypesScript } = require('../common/debugger-probe');
8+
const {
9+
assertProbeJson,
10+
probeTypesScript,
11+
} = require('../common/debugger-probe');
1012

1113
const location = `${probeTypesScript}:17`;
1214

@@ -38,7 +40,7 @@ spawnSyncAndAssert(process.execPath, [
3840
probeTypesScript,
3941
], {
4042
stdout(output) {
41-
assert.deepStrictEqual(JSON.parse(output), {
43+
assertProbeJson(output, {
4244
v: 1,
4345
probes: [
4446
{ expr: 'stringValue', target: [probeTypesScript, 17] },

‎test/parallel/test-debugger-probe-json.js‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
const common = require('../common');
55
common.skipIfInspectorDisabled();
66

7-
const assert = require('assert');
87
const { spawnSyncAndAssert } = require('../common/child_process');
9-
const { probeScript } = require('../common/debugger-probe');
8+
const { assertProbeJson, probeScript } = require('../common/debugger-probe');
109

1110
spawnSyncAndAssert(process.execPath, [
1211
'inspect',
@@ -20,7 +19,7 @@ spawnSyncAndAssert(process.execPath, [
2019
probeScript,
2120
], {
2221
stdout(output) {
23-
assert.deepStrictEqual(JSON.parse(output), {
22+
assertProbeJson(output, {
2423
v: 1,
2524
probes: [
2625
{ expr: 'index', target: [probeScript, 8] },

‎test/parallel/test-debugger-probe-miss.js‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
const common = require('../common');
55
common.skipIfInspectorDisabled();
66

7-
const assert = require('assert');
87
const { spawnSyncAndAssert } = require('../common/child_process');
9-
const { missScript } = require('../common/debugger-probe');
8+
const { assertProbeJson, missScript } = require('../common/debugger-probe');
109

1110
spawnSyncAndAssert(process.execPath, [
1211
'inspect',
@@ -16,7 +15,7 @@ spawnSyncAndAssert(process.execPath, [
1615
missScript,
1716
], {
1817
stdout(output) {
19-
assert.deepStrictEqual(JSON.parse(output), {
18+
assertProbeJson(output, {
2019
v: 1,
2120
probes: [{ expr: '42', target: [missScript, 99] }],
2221
results: [{

‎test/parallel/test-debugger-probe-text-special-values.js‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44
const common = require('../common');
55
common.skipIfInspectorDisabled();
66

7-
const assert = require('assert');
87
const { spawnSyncAndAssert } = require('../common/child_process');
9-
const { probeTypesScript } = require('../common/debugger-probe');
8+
const {
9+
assertProbeText,
10+
probeTypesScript,
11+
} = require('../common/debugger-probe');
1012

1113
const location = `${probeTypesScript}:17`;
1214

@@ -37,7 +39,7 @@ spawnSyncAndAssert(process.execPath, [
3739
probeTypesScript,
3840
], {
3941
stdout(output) {
40-
assert.strictEqual(output, [
42+
assertProbeText(output, [
4143
`Hit 1 at ${location}`,
4244
' stringValue = "hello"',
4345
`Hit 1 at ${location}`,

‎test/parallel/test-debugger-probe-text.js‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
const common = require('../common');
55
common.skipIfInspectorDisabled();
66

7-
const assert = require('assert');
87
const { spawnSyncAndAssert } = require('../common/child_process');
9-
const { probeScript } = require('../common/debugger-probe');
8+
const { assertProbeText, probeScript } = require('../common/debugger-probe');
109

1110
spawnSyncAndAssert(process.execPath, [
1211
'inspect',
@@ -15,10 +14,10 @@ spawnSyncAndAssert(process.execPath, [
1514
probeScript,
1615
], {
1716
stdout(output) {
18-
assert.strictEqual(output,
19-
`Hit 1 at ${probeScript}:12\n` +
20-
' finalValue = 81\n' +
21-
'Completed');
17+
assertProbeText(output,
18+
`Hit 1 at ${probeScript}:12\n` +
19+
' finalValue = 81\n' +
20+
'Completed');
2221
},
2322
trim: true,
2423
});

‎test/parallel/test-debugger-probe-timeout.js‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
const common = require('../common');
55
common.skipIfInspectorDisabled();
66

7-
const assert = require('assert');
87
const { spawnSyncAndExit } = require('../common/child_process');
9-
const { timeoutScript } = require('../common/debugger-probe');
8+
const { assertProbeJson, timeoutScript } = require('../common/debugger-probe');
109

1110
spawnSyncAndExit(process.execPath, [
1211
'inspect',
@@ -19,7 +18,7 @@ spawnSyncAndExit(process.execPath, [
1918
signal: null,
2019
status: 1,
2120
stdout(output) {
22-
assert.deepStrictEqual(JSON.parse(output), {
21+
assertProbeJson(output, {
2322
v: 1,
2423
probes: [{ expr: '1', target: [timeoutScript, 99] }],
2524
results: [{

0 commit comments

Comments
 (0)