Як перспектифікувати функції child_process.exec та child_process.execFile Node за допомогою Bluebird?

Я використовую бібліотеку обіцянок Bluebird під Node.js, це здорово! Але у мене питання:

Якщо ви подивитесь на документацію Node's child_process.exec та child_process.execFile, ви побачите, що обидві ці функції повертають об'єкт ChildProcess.

Отже, який рекомендований спосіб оптимізації таких функцій?

Зверніть увагу, що працює наступне (я отримую об’єкт Promise):

var Promise = require('bluebird');
var execAsync = Promise.promisify(require('child_process').exec);
var execFileAsync = Promise.promisify(require('child_process').execFile);

Але як можна отримати доступ до вихідного значення повернення оригінальних функцій Node.js? (У цих випадках мені потрібно було б мати доступ до спочатку повернутих об’єктів ChildProcess.)

Будь-яка пропозиція буде вдячна!

РЕДАГУВАТИ:

Ось приклад коду, який використовує повернене значення функції child_process.exec:

var exec = require('child_process').exec;
var child = exec('node ./commands/server.js');
child.stdout.on('data', function(data) {
    console.log('stdout: ' + data);
});
child.stderr.on('data', function(data) {
    console.log('stderr: ' + data);
});
child.on('close', function(code) {
    console.log('closing code: ' + code);
});

Але якби я використав би перспективну версію функції exec (execAsync зверху), тоді повернене значення буде обіцянкою, а не об’єктом ChildProcess. Це справжня проблема, про яку я кажу.

Здається, ви хочете повернути дві речі із дзвінка:

• ChildProcess
• обіцянка, яка вирішується, коли ChildProcess завершується

Тож "рекомендований спосіб оптимізації таких функцій"? Не робіть .

Ви поза межами конвенції. Очікується, що функції повернення обіцянок повернуть обіцянку, і все. Ви можете повернути об’єкт із двома членами (ChildProcess та обіцянка), але це просто заплутає людей.

Я б запропонував викликати непрофілізовану функцію та створити обіцянку на основі поверненого childProcess. (Можливо, оберніть це у допоміжну функцію)

Таким чином, це досить чітко для наступної людини, яка читає код.

Щось на зразок:

var Promise = require('bluebird');
var exec = require('child_process').execFile;

function promiseFromChildProcess(child) {
    return new Promise(function (resolve, reject) {
        child.addListener("error", reject);
        child.addListener("exit", resolve);
    });
}

var child = exec('ls');

promiseFromChildProcess(child).then(function (result) {
    console.log('promise complete: ' + result);
}, function (err) {
    console.log('promise rejected: ' + err);
});

child.stdout.on('data', function (data) {
    console.log('stdout: ' + data);
});
child.stderr.on('data', function (data) {
    console.log('stderr: ' + data);
});
child.on('close', function (code) {
    console.log('closing code: ' + code);
});

Я б рекомендував використовувати стандартні обіцянки JS, вбудовані в мову, над додатковою бібліотечною залежністю, такою як Bluebird.

Якщо ви використовуєте Node 10+, документи Node.js рекомендують використовувати, util.promisifyякий повертає Promise<{ stdout, stderr }>об'єкт. Дивіться приклад нижче:

const util = require('util');
const exec = util.promisify(require('child_process').exec);

async function lsExample() {
  try {
    const { stdout, stderr } = await exec('ls');
    console.log('stdout:', stdout);
    console.log('stderr:', stderr);
  } catch (e) {
    console.error(e); // should contain code (exit code) and signal (that caused the termination).
  }
}
lsExample()

Обробляти помилки першими з stderr.

Ось ще один спосіб:

function execPromise(command) {
    return new Promise(function(resolve, reject) {
        exec(command, (error, stdout, stderr) => {
            if (error) {
                reject(error);
                return;
            }

            resolve(stdout.trim());
        });
    });
}

Використовуйте функцію:

execPromise(command).then(function(result) {
    console.log(result);
}).catch(function(e) {
    console.error(e.message);
});

Або з async / await:

try {
    var result = await execPromise(command);
} catch (e) {
    console.error(e.message);
}

Починаючи з Node v12, вбудований util.promisifyдозволяє отримати доступ до ChildProcessоб'єкта у повернутих Promiseдля вбудованих функцій, де він був би повернутий за допомогою непроміфікованого виклику. З документів :

Повернений ChildProcessекземпляр приєднується до Promiseяк childвластивість.

Це правильно та просто задовольняє потребу доступу ChildProcessу вихідному питанні та робить інші відповіді застарілими за умови, що можна використовувати Node v12 +.

Адаптуючи приклад (і стислий стиль), який надає запитувач, доступ до ChildProcessбанку можна досягти, як:

const util = require('util');
const exec = util.promisify(require('child_process').exec);
const promise = exec('node ./commands/server.js');
const child = promise.child; 

child.stdout.on('data', function(data) {
    console.log('stdout: ' + data);
});
child.stderr.on('data', function(data) {
    console.log('stderr: ' + data);
});
child.on('close', function(code) {
    console.log('closing code: ' + code);
});

// i.e. can then await for promisified exec call to complete
const { stdout, stderr } = await promise;

Напевно, немає способу зробити добре, який би охоплював усі випадки використання. Але для обмежених випадків ви можете зробити щось подібне:

/**
 * Promisified child_process.exec
 *
 * @param cmd
 * @param opts See child_process.exec node docs
 * @param {stream.Writable} opts.stdout If defined, child process stdout will be piped to it.
 * @param {stream.Writable} opts.stderr If defined, child process stderr will be piped to it.
 *
 * @returns {Promise<{ stdout: string, stderr: stderr }>}
 */
function execp(cmd, opts) {
    opts || (opts = {});
    return new Promise((resolve, reject) => {
        const child = exec(cmd, opts,
            (err, stdout, stderr) => err ? reject(err) : resolve({
                stdout: stdout,
                stderr: stderr
            }));

        if (opts.stdout) {
            child.stdout.pipe(opts.stdout);
        }
        if (opts.stderr) {
            child.stderr.pipe(opts.stderr);
        }
    });
}

Це приймає opts.stdoutта opts.stderrаргументує, щоб stdio можна було захопити з дочірнього процесу.

Наприклад:

execp('ls ./', {
    stdout: new stream.Writable({
        write: (chunk, enc, next) => {
            console.log(chunk.toString(enc));
            next();
        }
    }),
    stderr: new stream.Writable({
        write: (chunk, enc, next) => {
            console.error(chunk.toString(enc));
            next();
        }
    })
}).then(() => console.log('done!'));

Або просто:

execp('ls ./', {
    stdout: process.stdout,
    stderr: process.stderr
}).then(() => console.log('done!'));

Просто хочу зазначити, що є хороший інструмент, який повністю вирішить вашу проблему:

https://www.npmjs.com/package/core-worker

Цей пакет значно полегшує обробку процесів.

import { process } from "CoreWorker";
import fs from "fs";

const result = await process("node Server.js", "Server is ready.").ready(1000);
const result = await process("cp path/to/file /newLocation/newFile").death();

або об'єднати ці функції:

import { process } from "core-worker";

const simpleChat = process("node chat.js", "Chat ready");

setTimeout(() => simpleChat.kill(), 360000); // wait an hour and close the chat

simpleChat.ready(500)
    .then(console.log.bind(console, "You are now able to send messages."))
    .then(::simpleChat.death)
    .then(console.log.bind(console, "Chat closed"))
    .catch(() => /* handle err */);

Ось моя. Це не стосується stdin чи stdout, тому, якщо вони вам потрібні, скористайтесь однією з інших відповідей на цій сторінці. :)

// promisify `child_process`
// This is a very nice trick :-)
this.promiseFromChildProcess = function (child) {
    return new Promise((resolve, reject) => {
        child.addListener('error', (code, signal) => {
            console.log('ChildProcess error', code, signal);
            reject(code);
        });
        child.addListener('exit', (code, signal) => {
            if (code === 0) {
                resolve(code);
            } else {
                console.log('ChildProcess error', code, signal);
                reject(code);
            }
        });
    });
};