feat(stdio): add child process io options and default logging of piped stdout/err (#3)

Author: zkochan

README.md

@@ -38,6 +38,11 @@ jump in if you'd like to, or even ask us questions if something isn't clear.
 
 #### <a name="lifecycle"></a> `> lifecycle(name, pkg, wd, [opts]) -> Promise`
 
+##### Arguments
+
+* `opts.stdio` - the [stdio](https://nodejs.org/api/child_process.html#child_process_options_stdio)
+passed to the child process. `[0, 1, 2]` by default.
+
 ##### Example
 
 ```javascript

index.js

@@ -12,6 +12,7 @@ const chain = require('slide').chain
 const uidNumber = require('uid-number')
 const umask = require('umask')
 const which = require('which')
+const byline = require('byline')
 
 let PATH = 'PATH'
 
@@ -244,7 +245,7 @@ function runCmd_ (cmd, pkg, env, wd, opts, stage, unsafe, uid, gid, cb_) {
   var conf = {
     cwd: wd,
     env: env,
-    stdio: [ 0, 1, 2 ]
+    stdio: opts.stdio || [ 0, 1, 2 ]
   }
 
   if (!unsafe) {
@@ -282,6 +283,12 @@ function runCmd_ (cmd, pkg, env, wd, opts, stage, unsafe, uid, gid, cb_) {
     }
     procError(er)
   })
+  byline(proc.stdout).on('data', function (data) {
+    opts.log.verbose('lifecycle', logid(pkg, stage), 'stdout', data.toString())
+  })
+  byline(proc.stderr).on('data', function (data) {
+    opts.log.verbose('lifecycle', logid(pkg, stage), 'stderr', data.toString())
+  })
   process.once('SIGTERM', procKill)
   process.once('SIGINT', procInterupt)
 

package-lock.json

@@ -29,6 +29,7 @@
   },
   "homepage": "https://github.com/npm/lifecycle#readme",
   "dependencies": {
+    "byline": "^5.0.0",
     "graceful-fs": "^4.1.11",
     "slide": "^1.1.6",
     "uid-number": "0.0.6",
@@ -37,6 +38,7 @@
   },
   "devDependencies": {
     "nyc": "^11.1.0",
+    "sinon": "^4.0.1",
     "standard": "^10.0.3",
     "standard-version": "^4.2.0",
     "tap": "^10.7.2",

package.json

@@ -0,0 +1,7 @@
+{
+  "name": "count-to-10",
+  "version": "1.0.0",
+  "scripts": {
+    "postinstall": "node postinstall"
+  }
+}

test/fixtures/count-to-10/package.json

@@ -0,0 +1,5 @@
+'use strict'
+
+console.log('line 1')
+console.log('line 2')
+console.error('some error')

test/fixtures/count-to-10/postinstall.js

@@ -1,7 +1,11 @@
 'use strict'
 
 const test = require('tap').test
+const sinon = require('sinon')
 const lifecycle = require('../index.js')
+const path = require('path')
+
+function noop () {}
 
 test('makeEnv', function (t) {
   const pkg = {
@@ -64,3 +68,74 @@ test('_incorrectWorkingDirectory: rejects wd from other packages', function (t)
   t.equal(lifecycle._incorrectWorkingDirectory(wd, pkg), true)
   t.end()
 })
+
+test("reports child's output", function (t) {
+  const fixture = path.join(__dirname, 'fixtures', 'count-to-10')
+
+  const verbose = sinon.spy()
+  const silly = sinon.spy()
+  const log = {
+    level: 'silent',
+    info: noop,
+    warn: noop,
+    silly,
+    verbose,
+    pause: noop,
+    resume: noop,
+    clearProgress: noop,
+    showProgress: noop
+  }
+  const dir = path.join(__dirname, '..')
+
+  const pkg = require(path.join(fixture, 'package.json'))
+
+  lifecycle(pkg, 'postinstall', fixture, {
+    stdio: 'pipe',
+    log,
+    dir,
+    config: {}
+  })
+  .then(() => {
+    t.ok(
+      verbose.calledWithMatch(
+        'lifecycle',
+        'undefined~postinstall:',
+        'stdout',
+        'line 1'
+      ),
+      'stdout reported'
+    )
+    t.ok(
+      verbose.calledWithMatch(
+        'lifecycle',
+        'undefined~postinstall:',
+        'stdout',
+        'line 2'
+      ),
+      'stdout reported'
+    )
+    t.ok(
+      verbose.calledWithMatch(
+        'lifecycle',
+        'undefined~postinstall:',
+        'stderr',
+        'some error'
+      ),
+      'stderr reported'
+    )
+    t.ok(
+      silly.calledWithMatch(
+        'lifecycle',
+        'undefined~postinstall:',
+        'Returned: code:',
+        0,
+        ' signal:',
+        null
+      ),
+      'exit code reported'
+    )
+
+    t.end()
+  })
+  .catch(t.end)
+})