Merge pull request davidmarkclements#168 from BridgeAR/use-same-node-version

Make sure the same Node.js executable is used

Author: mcollina

cmd.js

@@ -13,7 +13,7 @@ const { version } = require('./package.json')
 
 const defaultBanner = `
   0x ${version}
-  
+
   0x [flags] -- node [nodeFlags] script.js [scriptFlags]
 
 `
@@ -24,10 +24,21 @@ if (module.parent === null) {
     debug(err)
     process.exit(err.code || 1)
   })
-} else module.exports = cmd
+} else {
+  module.exports = cmd
+}
 
 async function cmd (argv, banner = defaultBanner) {
-  var args = minimist(argv, {
+  if (semver.lt(process.version, '8.5.0') === true) {
+    throw Error(
+      `Node version unsupported. Current Node version is ${process.version}\n` +
+      'Support extends from Node 8.5.0 and above.\n\n' +
+      '  npm i -g 0x@3 for Node 6.x.x – 8.4.0\n' +
+      '  npm i -g 0x@2 for Node 4\n'
+    )
+  }
+
+  const args = minimist(argv, {
     stopEarly: true,
     '--': true,
     boolean: [
@@ -55,61 +66,65 @@ async function cmd (argv, banner = defaultBanner) {
     }
   })
 
-  if (semver.lt(process.version, '8.5.0') === true) {
-    throw Error(
-      'Node version unsupported. Current Node version is ' + process.version + '\n' +
-      'Support extends from Node 8.5.0 and above.\n\n' +
-      '  npm i -g 0x@3 for Node 6.x.x – 8.4.0\n' + 
-      '  npm i -g 0x@2 for Node 4\n'
-    )
-  }
-
   if (args.help || argv.length === 0) {
     process.stdout.write(banner)
     return fs.createReadStream(join(__dirname, 'usage.txt')).pipe(process.stdout)
   }
 
-  if (args.version) return console.log('0x ' + version)
+  if (args.version) {
+    return console.log(`0x ${version}`)
+  }
+
   const status = createStatus(args)
+  const { pathToNodeBinary, subprocessArgv } = parseSubprocessCommand(args)
+
   args.workingDir = process.cwd()
   args.status = status
-  const { pathToNodeBinary, subprocessArgv } = parseSubprocessCommand(args)
   args.argv = subprocessArgv
   args.pathToNodeBinary = pathToNodeBinary
 
-  if (args.visualizeOnly) status(`Creating flamegraph from ${args.visualizeOnly}`)
+  if (args.visualizeOnly) {
+    status(`Creating flamegraph from ${args.visualizeOnly}`)
+  }
 
   const assetPath = await zeroEks(args)
 
-  if (args.collectOnly) status(`Stats collected in folder file://${assetPath}\n`)
-  else {
-    status('Flamegraph generated in\n' + assetPath + '\n')
-    if (args.open) launch(assetPath, {wait: false})
+  if (args.collectOnly) {
+    status(`Stats collected in folder file://${assetPath}\n`)
+  } else {
+    status(`Flamegraph generated in\n${assetPath}\n`)
+    if (args.open) {
+      launch(assetPath, { wait: false })
+    }
   }
 
   return assetPath
 }
 
 function parseSubprocessCommand (args) {
   const dashDash = args['--']
-  if (dashDash[0] && dashDash[0][0] === '-') {
-    throw Error(`The node binary must immediately follow double dash (--)
-      0x [flags] -- node [nodeFlags] script.js [scriptFlags]
-    `)
-  }
-  var pathToNodeBinary = false
-  var subprocessArgv = args._
-  if (dashDash[0]) {
-    if (dashDash[0][0] !== 'node') pathToNodeBinary = dashDash[0]
+  let pathToNodeBinary = process.argv[0]
+  let subprocessArgv = args._
+
+  if (dashDash.length !== 0) {
+    const dashEntry = dashDash[0][0];
+    if (dashEntry === '-') {
+      throw Error(
+        'The node binary must immediately follow double dash (--)\n' +
+        '0x [flags] -- node [nodeFlags] script.js [scriptFlags]'
+      )
+    }
+    pathToNodeBinary = dashDash[0]
     dashDash.shift()
     subprocessArgv = dashDash
   }
   return { pathToNodeBinary, subprocessArgv }
 }
 
-function createStatus ({silent, quiet}) {
-  const statusStream = process.stderr
-  if (quiet || silent) return () => {}
-  const status = sll(statusStream)
+function createStatus ({ silent, quiet }) {
+  if (quiet || silent) {
+    return () => {}
+  }
+  const status = sll(process.stderr)
   return hasUnicode ? (s) => status(`🔥  ${s}`) : status
 }

index.js

@@ -4,6 +4,7 @@ const { sun, linux, windows, v8 } = require('./platform')
 const debug = require('debug')('0x')
 const { join, isAbsolute, relative } = require('path')
 const fs = require('fs')
+const { promisify } = require('util')
 const validate = require('./lib/validate')(require('./schema.json'))
 const traceStacksToTicks = require('./lib/trace-stacks-to-ticks')
 const v8LogToTicks = require('./lib/v8-log-to-ticks')
@@ -13,6 +14,8 @@ const render = require('./lib/render')
 const platform = process.platform
 const { tidy, noop, isSudo } = require('./lib/util')
 
+const fsWriteFilePromise = promisify(fs.writeFile)
+
 module.exports = zeroEks
 
 async function zeroEks (args) {
@@ -26,7 +29,7 @@ async function zeroEks (args) {
 
   if (visualizeOnly) return visualize(args)
 
-  args.title = args.title || 'node ' + args.argv.join(' ')
+  args.title = args.title || `node ${args.argv.join(' ')}`
   const binary = args.pathToNodeBinary
   var { ticks, pid, folder, inlined } = await startProcessAndCollectTraceData(args, binary)
 
@@ -35,8 +38,6 @@ async function zeroEks (args) {
     fs.writeFileSync(`${folder}/stacks.${pid}.json`, JSON.stringify(tree, 0, 2))
   }
 
-  fs.writeFileSync(`${folder}/meta.json`, JSON.stringify({...args, inlined}))
-
   if (collectOnly === true) {
     debug('collect-only mode bailing on rendering')
     tidy()
@@ -45,7 +46,10 @@ async function zeroEks (args) {
   }
 
   try {
-    const file = await generateFlamegraph({...args, ticks, inlined, pid, folder})
+    const [file] = await Promise.all([
+      generateFlamegraph({...args, ticks, inlined, pid, folder}),
+      fsWriteFilePromise(`${folder}/meta.json`, JSON.stringify({...args, inlined}))
+    ])
     return file
   } catch (err) {
     tidy()
@@ -68,17 +72,12 @@ async function startProcessAndCollectTraceData (args, binary) {
 }
 
 async function generateFlamegraph (opts) {
-  try {
-    const file = await render(opts)
-    tidy()
-    return file
-  } catch (err) {
-    tidy()
-    throw err
-  }
+  const file = await render(opts)
+  tidy()
+  return file
 }
 
-async function visualize ({ visualizeOnly, treeDebug, workingDir, title, mapFrames, phase, open, name }) {
+async function visualize ({ visualizeOnly, treeDebug, workingDir, title, mapFrames, open, name, pathToNodeBinary }) {
   try {
     const folder = isAbsolute(visualizeOnly)
       ? relative(workingDir, visualizeOnly)
@@ -108,7 +107,7 @@ async function visualize ({ visualizeOnly, treeDebug, workingDir, title, mapFram
     name = name || meta.name
 
     const ticks = (srcType === 'v8')
-      ? await v8LogToTicks(src)
+      ? await v8LogToTicks(src, pathToNodeBinary)
       : traceStacksToTicks(src)
 
     if (treeDebug === true) {
@@ -134,8 +133,10 @@ async function visualize ({ visualizeOnly, treeDebug, workingDir, title, mapFram
   } catch (e) {
     if (e.code === 'ENOENT') {
       throw Error('Invalid data path provided (unable to access/does not exist)')
-    } else if (e.code === 'ENOTDIR') {
+    }
+    if (e.code === 'ENOTDIR') {
       throw Error('Invalid data path provided (not a directory)')
-    } else throw e
+    }
+    throw e
   }
 }

lib/v8-log-to-ticks.js

@@ -9,18 +9,18 @@ const pump = require('pump')
 
 module.exports = v8LogToTicks
 
-function v8LogToTicks (isolateLogPath) {
+function v8LogToTicks (isolateLogPath, node) {
   const isJson = extname(isolateLogPath) === '.json'
-  const sp = isJson || spawn(process.argv[0], [
+  const sp = isJson || spawn(node, [
     '--prof-process', '--preprocess', '-j', isolateLogPath
   ], {stdio: ['ignore', 'pipe', 'pipe']})
   const close = isJson ? () => {} : () => sp.kill()
   const srcStream = isJson ? fs.createReadStream(isolateLogPath) : sp.stdout
   if (!isJson) {
-    // unknown code state errors are mostly harmless, 
+    // unknown code state errors are mostly harmless,
     // and not fixable within 0x at the moment (because
     // it's an error in the V8 internal tick profiler)
-    // ignore them. 
+    // ignore them.
     const ignore = /unknown code state:/
     pump(sp.stderr, through((errMsg, _, cb) => {
       if (ignore.test(errMsg)) cb()

platform/v8.js

@@ -113,7 +113,7 @@ async function v8 (args, binary) {
   const isolateLogPath = path.join(folder, isolateLog)
   await renameSafe(path.join(args.workingDir, isolateLog), isolateLogPath)
   return {
-    ticks: await v8LogToTicks(isolateLogPath),
+    ticks: await v8LogToTicks(isolateLogPath, node),
     inlined: inlined,
     pid: proc.pid,
     folder: folder

visualizer/html.js

@@ -19,8 +19,8 @@ function html (opts) {
       <meta charset="utf-8">
       <style> ${tachyons} </style>
       <style>
-        button:focus { outline:0; } 
-        rect:hover {opacity: 0.9} 
+        button:focus { outline:0; }
+        rect:hover {opacity: 0.9}
       </style>
     </head>
     <body class='m0 bg-white sans-serif overflow-hidden'>