Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
src: allow setting a dir for all diagnostic output
Add a flag that allows for the setting of a directory where all diagnostic output will be written to. e.g. --redirect-warnings Refs: #33010 (comment) PR-URL: #33584 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
- Loading branch information
1 parent
74da2c4
commit 5c94358
Showing
7 changed files
with
260 additions
and
2 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
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
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
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
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
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,76 @@ | ||
| 'use strict'; | ||
|
|
||
| // This test is to ensure that --diagnostic-dir does not change the directory | ||
| // for --cpu-prof when --cpu-prof-dir is specified | ||
|
|
||
| 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 { | ||
| getCpuProfiles, | ||
| kCpuProfInterval, | ||
| env, | ||
| verifyFrames | ||
| } = require('../common/cpu-prof'); | ||
|
|
||
| // Test --diagnostic-dir changes the default for --cpu-prof | ||
|
|
||
| { | ||
| tmpdir.refresh(); | ||
| const dir = path.join(tmpdir.path, 'prof'); | ||
| const output = spawnSync(process.execPath, [ | ||
| '--cpu-prof', | ||
| '--cpu-prof-interval', | ||
| kCpuProfInterval, | ||
| '--diagnostic-dir', | ||
| dir, | ||
| fixtures.path('workload', 'fibonacci.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 = getCpuProfiles(dir); | ||
| assert.strictEqual(profiles.length, 1); | ||
| verifyFrames(output, profiles[0], 'fibonacci.js'); | ||
| } | ||
|
|
||
| // Test --cpu-prof-dir overwrites --diagnostic-dir | ||
|
|
||
| { | ||
| tmpdir.refresh(); | ||
| const dir = path.join(tmpdir.path, 'diag'); | ||
| const dir2 = path.join(tmpdir.path, 'prof'); | ||
| const output = spawnSync(process.execPath, [ | ||
| '--cpu-prof', | ||
| '--cpu-prof-interval', | ||
| kCpuProfInterval, | ||
| '--diagnostic-dir', | ||
| dir, | ||
| '--cpu-prof-dir', | ||
| dir2, | ||
| fixtures.path('workload', 'fibonacci.js'), | ||
| ], { | ||
| cwd: tmpdir.path, | ||
| env | ||
| }); | ||
| if (output.status !== 0) { | ||
| console.log(output.stderr.toString()); | ||
| } | ||
| assert.strictEqual(output.status, 0); | ||
| assert(fs.existsSync(dir2)); | ||
| const profiles = getCpuProfiles(dir2); | ||
| assert.strictEqual(profiles.length, 1); | ||
| verifyFrames(output, profiles[0], 'fibonacci.js'); | ||
| } |
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,117 @@ | ||
| 'use strict'; | ||
|
|
||
| // This test is to ensure that --diagnostic-dir does not change the directory | ||
| // for --cpu-prof when --cpu-prof-dir is specified | ||
|
|
||
| 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'); | ||
|
|
||
| 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.notDeepStrictEqual(frame, undefined); | ||
| } | ||
|
|
||
| const kHeapProfInterval = 128; | ||
| const TEST_ALLOCATION = kHeapProfInterval * 2; | ||
|
|
||
| const env = { | ||
| ...process.env, | ||
| TEST_ALLOCATION, | ||
| NODE_DEBUG_NATIVE: 'INSPECTOR_PROFILER' | ||
| }; | ||
|
|
||
| function getHeapProfiles(dir) { | ||
| const list = fs.readdirSync(dir); | ||
| return list | ||
| .filter((file) => file.endsWith('.heapprofile')) | ||
| .map((file) => path.join(dir, file)); | ||
| } | ||
|
|
||
| // Test --diagnostic-dir changes the default for --cpu-prof | ||
| { | ||
| tmpdir.refresh(); | ||
| const dir = path.join(tmpdir.path, 'prof'); | ||
| const output = spawnSync(process.execPath, [ | ||
| '--heap-prof', | ||
| '--diagnostic-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'); | ||
| } | ||
|
|
||
| // Test --heap-prof-dir overwrites --diagnostic-dir | ||
| { | ||
| tmpdir.refresh(); | ||
| const dir = path.join(tmpdir.path, 'diag'); | ||
| const dir2 = path.join(tmpdir.path, 'prof'); | ||
| const output = spawnSync(process.execPath, [ | ||
| '--heap-prof', | ||
| '--heap-prof-interval', | ||
| kHeapProfInterval, | ||
| '--diagnostic-dir', | ||
| dir, | ||
| '--heap-prof-dir', | ||
| dir2, | ||
| 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(dir2)); | ||
| const profiles = getHeapProfiles(dir2); | ||
| assert.strictEqual(profiles.length, 1); | ||
| verifyFrames(output, profiles[0], 'runAllocation'); | ||
| } |