-
Notifications
You must be signed in to change notification settings - Fork 29.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The original heap prof tests can take too long to complete on azure Windows machines, resulting in timeouts. Split them into smaller tests and move them into the parallel directory to speed up the execution. PR-URL: #44388 Refs: nodejs/reliability#356 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
- Loading branch information
1 parent
b0d4431
commit 6e1abf4
Showing
13 changed files
with
592 additions
and
375 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
'use strict'; | ||
|
||
const assert = require('assert'); | ||
const fs = require('fs'); | ||
const path = require('path'); | ||
|
||
function getHeapProfiles(dir) { | ||
const list = fs.readdirSync(dir); | ||
return list | ||
.filter((file) => file.endsWith('.heapprofile')) | ||
.map((file) => path.join(dir, file)); | ||
} | ||
|
||
function findFirstFrameInNode(root, func) { | ||
const first = root.children.find( | ||
(child) => child.callFrame.functionName === func | ||
); | ||
if (first) { | ||
return first; | ||
} | ||
for (const child of root.children) { | ||
const first = findFirstFrameInNode(child, func); | ||
if (first) { | ||
return first; | ||
} | ||
} | ||
return undefined; | ||
} | ||
|
||
function findFirstFrame(file, func) { | ||
const data = fs.readFileSync(file, 'utf8'); | ||
const profile = JSON.parse(data); | ||
const first = findFirstFrameInNode(profile.head, func); | ||
return { frame: first, roots: profile.head.children }; | ||
} | ||
|
||
function verifyFrames(output, file, func) { | ||
const { frame, roots } = findFirstFrame(file, func); | ||
if (!frame) { | ||
// Show native debug output and the profile for debugging. | ||
console.log(output.stderr.toString()); | ||
console.log(roots); | ||
} | ||
assert.notStrictEqual(frame, undefined); | ||
} | ||
|
||
// We need to set --heap-prof-interval to a small enough value to make | ||
// sure we can find our workload in the samples, so we need to set | ||
// TEST_ALLOCATION > kHeapProfInterval. | ||
const kHeapProfInterval = 128; | ||
const TEST_ALLOCATION = kHeapProfInterval * 2; | ||
|
||
const env = { | ||
...process.env, | ||
TEST_ALLOCATION, | ||
NODE_DEBUG_NATIVE: 'INSPECTOR_PROFILER' | ||
}; | ||
|
||
// TODO(joyeecheung): share the fixutres with v8 coverage tests | ||
module.exports = { | ||
getHeapProfiles, | ||
verifyFrames, | ||
findFirstFrame, | ||
kHeapProfInterval, | ||
TEST_ALLOCATION, | ||
env | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
'use strict'; | ||
|
||
// Tests --heap-prof without --heap-prof-interval. Here we just verify that | ||
// we manage to generate a profile. | ||
|
||
const common = require('../common'); | ||
|
||
const fixtures = require('../common/fixtures'); | ||
common.skipIfInspectorDisabled(); | ||
|
||
const assert = require('assert'); | ||
const { spawnSync } = require('child_process'); | ||
|
||
const tmpdir = require('../common/tmpdir'); | ||
|
||
const { | ||
getHeapProfiles, | ||
env | ||
} = require('../common/prof'); | ||
|
||
{ | ||
tmpdir.refresh(); | ||
const output = spawnSync(process.execPath, [ | ||
'--heap-prof', | ||
fixtures.path('workload', 'allocation.js'), | ||
], { | ||
cwd: tmpdir.path, | ||
env | ||
}); | ||
if (output.status !== 0) { | ||
console.log(output.stderr.toString()); | ||
console.log(output); | ||
} | ||
assert.strictEqual(output.status, 0); | ||
const profiles = getHeapProfiles(tmpdir.path); | ||
assert.strictEqual(profiles.length, 1); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
'use strict'; | ||
|
||
// This tests that --heap-prof, --heap-prof-dir and --heap-prof-name works. | ||
|
||
const common = require('../common'); | ||
|
||
const fixtures = require('../common/fixtures'); | ||
common.skipIfInspectorDisabled(); | ||
|
||
const assert = require('assert'); | ||
const fs = require('fs'); | ||
const path = require('path'); | ||
const { spawnSync } = require('child_process'); | ||
|
||
const tmpdir = require('../common/tmpdir'); | ||
|
||
const { | ||
getHeapProfiles, | ||
verifyFrames, | ||
kHeapProfInterval, | ||
env | ||
} = require('../common/prof'); | ||
|
||
// Tests absolute --heap-prof-dir | ||
{ | ||
tmpdir.refresh(); | ||
const dir = path.join(tmpdir.path, 'prof'); | ||
const output = spawnSync(process.execPath, [ | ||
'--heap-prof', | ||
'--heap-prof-dir', | ||
dir, | ||
'--heap-prof-interval', | ||
kHeapProfInterval, | ||
fixtures.path('workload', 'allocation.js'), | ||
], { | ||
cwd: tmpdir.path, | ||
env | ||
}); | ||
if (output.status !== 0) { | ||
console.log(output.stderr.toString()); | ||
} | ||
assert.strictEqual(output.status, 0); | ||
assert(fs.existsSync(dir)); | ||
const profiles = getHeapProfiles(dir); | ||
assert.strictEqual(profiles.length, 1); | ||
verifyFrames(output, profiles[0], 'runAllocation'); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
'use strict'; | ||
|
||
// Tests --heap-prof-dir and --heap-prof-name work together. | ||
|
||
const common = require('../common'); | ||
|
||
const fixtures = require('../common/fixtures'); | ||
common.skipIfInspectorDisabled(); | ||
|
||
const assert = require('assert'); | ||
const fs = require('fs'); | ||
const path = require('path'); | ||
const { spawnSync } = require('child_process'); | ||
|
||
const tmpdir = require('../common/tmpdir'); | ||
|
||
const { | ||
getHeapProfiles, | ||
verifyFrames, | ||
kHeapProfInterval, | ||
env | ||
} = require('../common/prof'); | ||
|
||
{ | ||
tmpdir.refresh(); | ||
const dir = path.join(tmpdir.path, 'prof'); | ||
const file = path.join(dir, 'test.heapprofile'); | ||
const output = spawnSync(process.execPath, [ | ||
'--heap-prof', | ||
'--heap-prof-name', | ||
'test.heapprofile', | ||
'--heap-prof-dir', | ||
dir, | ||
'--heap-prof-interval', | ||
kHeapProfInterval, | ||
fixtures.path('workload', 'allocation.js'), | ||
], { | ||
cwd: tmpdir.path, | ||
env | ||
}); | ||
if (output.status !== 0) { | ||
console.log(output.stderr.toString()); | ||
} | ||
assert.strictEqual(output.status, 0); | ||
assert(fs.existsSync(dir)); | ||
const profiles = getHeapProfiles(dir); | ||
assert.deepStrictEqual(profiles, [file]); | ||
verifyFrames(output, file, 'runAllocation'); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
'use strict'; | ||
|
||
// Tests relative --heap-prof-dir works. | ||
|
||
const common = require('../common'); | ||
|
||
const fixtures = require('../common/fixtures'); | ||
common.skipIfInspectorDisabled(); | ||
|
||
const assert = require('assert'); | ||
const fs = require('fs'); | ||
const path = require('path'); | ||
const { spawnSync } = require('child_process'); | ||
|
||
const tmpdir = require('../common/tmpdir'); | ||
|
||
const { | ||
getHeapProfiles, | ||
verifyFrames, | ||
kHeapProfInterval, | ||
env | ||
} = require('../common/prof'); | ||
|
||
{ | ||
tmpdir.refresh(); | ||
const output = spawnSync(process.execPath, [ | ||
'--heap-prof', | ||
'--heap-prof-dir', | ||
'prof', | ||
'--heap-prof-interval', | ||
kHeapProfInterval, | ||
fixtures.path('workload', 'allocation.js'), | ||
], { | ||
cwd: tmpdir.path, | ||
env | ||
}); | ||
if (output.status !== 0) { | ||
console.log(output.stderr.toString()); | ||
} | ||
assert.strictEqual(output.status, 0); | ||
const dir = path.join(tmpdir.path, 'prof'); | ||
assert(fs.existsSync(dir)); | ||
const profiles = getHeapProfiles(dir); | ||
assert.strictEqual(profiles.length, 1); | ||
verifyFrames(output, profiles[0], 'runAllocation'); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
'use strict'; | ||
|
||
// Tests --heap-prof generates a heap profile from worker | ||
// when execArgv is set. | ||
|
||
const common = require('../common'); | ||
|
||
const fixtures = require('../common/fixtures'); | ||
common.skipIfInspectorDisabled(); | ||
|
||
const assert = require('assert'); | ||
const { spawnSync } = require('child_process'); | ||
|
||
const tmpdir = require('../common/tmpdir'); | ||
|
||
const { | ||
getHeapProfiles, | ||
verifyFrames, | ||
} = require('../common/prof'); | ||
|
||
{ | ||
tmpdir.refresh(); | ||
const output = spawnSync(process.execPath, [ | ||
fixtures.path('workload', 'allocation-worker-argv.js'), | ||
], { | ||
cwd: tmpdir.path, | ||
env: { | ||
...process.env, | ||
HEAP_PROF_INTERVAL: '128' | ||
} | ||
}); | ||
if (output.status !== 0) { | ||
console.log(output.stderr.toString()); | ||
} | ||
assert.strictEqual(output.status, 0); | ||
const profiles = getHeapProfiles(tmpdir.path); | ||
assert.strictEqual(profiles.length, 1); | ||
verifyFrames(output, profiles[0], 'runAllocation'); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
'use strict'; | ||
|
||
// Tests --heap-prof generates a heap profile when process.exit(55) exits | ||
// process. | ||
|
||
const common = require('../common'); | ||
|
||
const fixtures = require('../common/fixtures'); | ||
common.skipIfInspectorDisabled(); | ||
|
||
const assert = require('assert'); | ||
const { spawnSync } = require('child_process'); | ||
|
||
const tmpdir = require('../common/tmpdir'); | ||
|
||
const { | ||
getHeapProfiles, | ||
verifyFrames, | ||
kHeapProfInterval, | ||
env | ||
} = require('../common/prof'); | ||
|
||
{ | ||
tmpdir.refresh(); | ||
const output = spawnSync(process.execPath, [ | ||
'--heap-prof', | ||
'--heap-prof-interval', | ||
kHeapProfInterval, | ||
fixtures.path('workload', 'allocation-exit.js'), | ||
], { | ||
cwd: tmpdir.path, | ||
env | ||
}); | ||
if (output.status !== 55) { | ||
console.log(output.stderr.toString()); | ||
} | ||
assert.strictEqual(output.status, 55); | ||
const profiles = getHeapProfiles(tmpdir.path); | ||
assert.strictEqual(profiles.length, 1); | ||
verifyFrames(output, profiles[0], 'runAllocation'); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
'use strict'; | ||
|
||
// Tests multiple profiles generated by --heap-prof-interval are valid. | ||
|
||
const common = require('../common'); | ||
|
||
const fixtures = require('../common/fixtures'); | ||
common.skipIfInspectorDisabled(); | ||
|
||
const assert = require('assert'); | ||
const fs = require('fs'); | ||
const path = require('path'); | ||
const { spawnSync } = require('child_process'); | ||
|
||
const tmpdir = require('../common/tmpdir'); | ||
|
||
const { | ||
getHeapProfiles, | ||
findFirstFrame, | ||
kHeapProfInterval, | ||
env | ||
} = require('../common/prof'); | ||
|
||
{ | ||
tmpdir.refresh(); | ||
const output = spawnSync(process.execPath, [ | ||
'--heap-prof-interval', | ||
kHeapProfInterval, | ||
'--heap-prof-dir', | ||
'prof', | ||
'--heap-prof', | ||
fixtures.path('workload', 'allocation-worker.js'), | ||
], { | ||
cwd: tmpdir.path, | ||
env | ||
}); | ||
if (output.status !== 0) { | ||
console.log(output.stderr.toString()); | ||
} | ||
assert.strictEqual(output.status, 0); | ||
const dir = path.join(tmpdir.path, 'prof'); | ||
assert(fs.existsSync(dir)); | ||
const profiles = getHeapProfiles(dir); | ||
assert.strictEqual(profiles.length, 2); | ||
const profile1 = findFirstFrame(profiles[0], 'runAllocation'); | ||
const profile2 = findFirstFrame(profiles[1], 'runAllocation'); | ||
if (!profile1.frame && !profile2.frame) { | ||
// Show native debug output and the profile for debugging. | ||
console.log(output.stderr.toString()); | ||
console.log('heap path: ', profiles[0]); | ||
console.log(profile1.roots); | ||
console.log('heap path: ', profiles[1]); | ||
console.log(profile2.roots); | ||
} | ||
assert(profile1.frame || profile2.frame); | ||
} |
Oops, something went wrong.