feat: run script with timeout (#8)

Author: fengmk2

LICENSE.txt

@@ -1,6 +1,6 @@
 This software is licensed under the MIT License.
 
-Copyright (c) 2016 - 2017 node-modules and other contributors
+Copyright (c) 2016 - present node-modules and other contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -43,6 +43,22 @@ runScript('node -v', { stdio: 'pipe' })
   });
 ```
 
+### run with timeout
+
+Run user script for a maximum of 10 seconds.
+
+```js
+const runScript = require('runscript');
+
+runScript('node user-script.js', { stdio: 'pipe' }, { timeout: 10000 })
+  .then(stdio => {
+    console.log(stdio);
+  })
+  .catch(err => {
+    console.error(err);
+  });
+```
+
 ## License
 
 [MIT](LICENSE.txt)

index.js

@@ -12,10 +12,13 @@ const spawn = require('child_process').spawn;
  * @param {String} script - full script string, like `git clone https://github.com/node-modules/runscript.git`
  * @param {Object} [options] - spawn options
  *   @see https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options
+ * @param {Object} [extraOptions] - extra options for running
+ *   - {Number} [extraOptions.timeout] - child process running timeout
  * @return {Object} stdio object, will contains stdio.stdout and stdio.stderr buffer.
  */
-module.exports = function runScript(script, options) {
+module.exports = function runScript(script, options, extraOptions) {
   return new Promise((resolve, reject) => {
+    extraOptions = extraOptions || {};
     options = options || {};
     options.env = options.env || Object.create(process.env);
     options.cwd = options.cwd || process.cwd();
@@ -38,12 +41,16 @@ module.exports = function runScript(script, options) {
       }
     }
 
-    debug('%s %s %s, %j', sh, shFlag, script, options);
+    debug('%s %s %s, %j, %j', sh, shFlag, script, options, extraOptions);
     const proc = spawn(sh, [ shFlag, script ], options);
     const stdout = [];
     const stderr = [];
+    let isEnd = false;
+    let timeoutTimer;
+
     if (proc.stdout) {
       proc.stdout.on('data', buf => {
+        debug('stdout %d bytes', buf.length);
         stdout.push(buf);
       });
       if (options.stdout) {
@@ -52,14 +59,29 @@ module.exports = function runScript(script, options) {
     }
     if (proc.stderr) {
       proc.stderr.on('data', buf => {
+        debug('stderr %d bytes', buf.length);
         stderr.push(buf);
       });
       if (options.stderr) {
         proc.stderr.pipe(options.stderr);
       }
     }
-    proc.on('error', reject);
+
+    proc.on('error', err => {
+      debug('proc emit error: %s', err);
+      if (isEnd) return;
+      isEnd = true;
+      clearTimeout(timeoutTimer);
+
+      reject(err);
+    });
+
     proc.on('close', code => {
+      debug('proc emit close: %s', code);
+      if (isEnd) return;
+      isEnd = true;
+      clearTimeout(timeoutTimer);
+
       const stdio = {
         stdout: null,
         stderr: null,
@@ -72,10 +94,40 @@ module.exports = function runScript(script, options) {
       }
       if (code !== 0) {
         const err = new Error(`Run "${sh} ${shFlag} ${script}" error, exit code ${code}`);
+        err.name = 'RunScriptError';
         err.stdio = stdio;
         return reject(err);
       }
       return resolve(stdio);
     });
+
+    proc.on('exit', code => {
+      debug('proc emit exit: %s', code);
+    });
+
+    if (typeof extraOptions.timeout === 'number' && extraOptions.timeout > 0) {
+      // start timer
+      timeoutTimer = setTimeout(() => {
+        debug('proc run timeout: %dms', extraOptions.timeout);
+        isEnd = true;
+        debug('kill child process %s', proc.pid);
+        proc.kill();
+
+        const err = new Error(`Run "${sh} ${shFlag} ${script}" timeout in ${extraOptions.timeout}ms`);
+        err.name = 'RunScriptTimeoutError';
+        const stdio = {
+          stdout: null,
+          stderr: null,
+        };
+        if (stdout.length > 0) {
+          stdio.stdout = Buffer.concat(stdout);
+        }
+        if (stderr.length > 0) {
+          stdio.stderr = Buffer.concat(stderr);
+        }
+        err.stdio = stdio;
+        return reject(err);
+      }, extraOptions.timeout);
+    }
   });
 };

package.json

@@ -23,8 +23,8 @@
     "autod": "*",
     "egg-bin": "1",
     "egg-ci": "^1.8.0",
-    "eslint": "3",
-    "eslint-config-egg": "3",
+    "eslint": "4",
+    "eslint-config-egg": "6",
     "typescript": "^3.5.1"
   },
   "homepage": "https://github.com/node-modules/runscript",

test/fixtures/timeout-and-exit.js

@@ -0,0 +1,11 @@
+'use strict';
+
+console.error('timer start');
+setInterval(() => {
+  console.error('echo every 500ms');
+}, 500);
+
+setTimeout(() => {
+  console.error('exit');
+  process.exit(0);
+}, 1100);

test/fixtures/timeout-stderr.js

@@ -0,0 +1,6 @@
+'use strict';
+
+console.error('timer start');
+setInterval(() => {
+  console.error('echo every 500ms');
+}, 500);

test/fixtures/timeout.js

@@ -0,0 +1,6 @@
+'use strict';
+
+console.log('timer start');
+setInterval(() => {
+  console.log('echo every 500ms');
+}, 500);

test/runscript.test.js

@@ -22,6 +22,49 @@ describe('test/runscript.test.js', () => {
     return runScript('node -e "process.exit(-1)"')
       .catch(err => {
         console.log(err);
+        assert(err.name === 'RunScriptError');
+      });
+  });
+
+  it('should reject on cmd not exists', () => {
+    return runScript('node-not-exists -e "process.exit(-1)"', {
+      shell: true,
+      stdio: 'pipe',
+    })
+      .catch(err => {
+        console.log(err);
+        assert(err.name === 'RunScriptError');
+      });
+  });
+
+  it('should reject on timeout (stdout)', () => {
+    return runScript(`node ${path.join(__dirname, 'fixtures/timeout.js')}`, {
+      stdio: 'pipe',
+    }, { timeout: 1200 })
+      .catch(err => {
+        console.log(err);
+        assert(err.name === 'RunScriptTimeoutError');
+        assert(err.stdio.stdout.toString() === 'timer start\necho every 500ms\necho every 500ms\n');
+      });
+  });
+
+  it('should reject on timeout (stderr)', () => {
+    return runScript(`node ${path.join(__dirname, 'fixtures/timeout-stderr.js')}`, {
+      stdio: 'pipe',
+    }, { timeout: 1200 })
+      .catch(err => {
+        console.log(err);
+        assert(err.name === 'RunScriptTimeoutError');
+        assert(err.stdio.stderr.toString() === 'timer start\necho every 500ms\necho every 500ms\n');
+      });
+  });
+
+  it('should normal exit before timeout', () => {
+    return runScript(`node ${path.join(__dirname, 'fixtures/timeout-and-exit.js')}`, {
+      stdio: 'pipe',
+    }, { timeout: 1300 })
+      .then(stdio => {
+        assert(stdio.stderr.toString() === 'timer start\necho every 500ms\necho every 500ms\nexit\n');
       });
   });