Skip to content

fix(child_process): match Node's promisified exec fn #2128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jarred-Sumner merged 1 commit into from
Feb 22, 2023
Merged

fix(child_process): match Node's promisified exec fn #2128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 72 additions & 43 deletions src/bun.js/child_process.exports.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,47 @@ const {
const {
constants: { signals },
} = import.meta.require("node:os");
const { promisify } = import.meta.require("node:util");

const { ArrayBuffer } = import.meta.primordials;
Copy link
Collaborator

@Jarred-Sumner Jarred-Sumner Feb 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

each of the below globalThis getters can be from primordials


var Uint8Array = globalThis.Uint8Array;
var String = globalThis.String;
var Object = globalThis.Object;
var Buffer = globalThis.Buffer;
var Promise = globalThis.Promise;

var PromiseAll = Promise.all;

var ObjectPrototypeHasOwnProperty = Object.prototype.hasOwnProperty;
var ObjectCreate = Object.create;
var ObjectAssign = Object.assign;
var ObjectDefineProperty = Object.defineProperty;
var BufferConcat = Buffer.concat;
var BufferIsEncoding = Buffer.isEncoding;

var kEmptyObject = ObjectCreate(null);

var ArrayPrototypePush = Array.prototype.push;
var ArrayPrototypeReduce = Array.prototype.reduce;
var ArrayPrototypeFilter = Array.prototype.filter;
var ArrayPrototypeJoin = Array.prototype.join;
var ArrayPrototypeMap = Array.prototype.map;
var ArrayPrototypeIncludes = Array.prototype.includes;
var ArrayPrototypeSlice = Array.prototype.slice;
var ArrayPrototypeUnshift = Array.prototype.unshift;
var ArrayIsArray = Array.isArray;

// var ArrayBuffer = ArrayBuffer;
var ArrayBufferIsView = ArrayBuffer.isView;

var NumberIsInteger = Number.isInteger;
var MathAbs = Math.abs;

var StringPrototypeToUpperCase = String.prototype.toUpperCase;
var StringPrototypeIncludes = String.prototype.includes;
var Uint8ArrayPrototypeIncludes = Uint8Array.prototype.includes;

const MAX_BUFFER = 1024 * 1024;

// General debug vs tracking stdio streams. Useful for stream debugging in particular
Expand All @@ -34,9 +72,8 @@ if (__TRACK_STDIO__) {
// 3. ChildProcess "class"
// 4. ChildProcess helpers
// 5. Validators
// 6. Primordials
// 7. Random utilities
// 8. Node errors / error polyfills
// 6. Random utilities
// 7. Node errors / error polyfills

// TODO:
// Port rest of node tests
Expand Down Expand Up @@ -456,6 +493,35 @@ export function exec(command, options, callback) {
return execFile(opts.file, opts.options, opts.callback);
}

const customPromiseExecFunction = orig => {
return (...args) => {
let resolve;
let reject;
const promise = new Promise((res, rej) => {
resolve = res;
reject = rej;
});

promise.child = orig(...args, (err, stdout, stderr) => {
if (err !== null) {
err.stdout = stdout;
err.stderr = stderr;
reject(err);
} else {
resolve({ stdout, stderr });
}
});

return promise;
};
};

ObjectDefineProperty(exec, promisify.custom, {
__proto__: null,
enumerable: false,
value: customPromiseExecFunction(exec),
});

/**
* Spawns a new process synchronously using the given `file`.
* @param {string} file
Expand Down Expand Up @@ -685,7 +751,7 @@ function normalizeExecFileArgs(file, args, options, callback) {
}

if (options == null) {
options = {};
options = kEmptyObject;
}

if (callback != null) {
Expand Down Expand Up @@ -1439,49 +1505,12 @@ function getValidatedPath(fileURLOrPath, propName = "path") {
return path;
}

//------------------------------------------------------------------------------
// Section 6. Primordials
//------------------------------------------------------------------------------
var Uint8Array = globalThis.Uint8Array;
var String = globalThis.String;
var Object = globalThis.Object;
var Buffer = globalThis.Buffer;
var Promise = globalThis.Promise;

var PromiseAll = Promise.all;

var ObjectPrototypeHasOwnProperty = Object.prototype.hasOwnProperty;
var ObjectCreate = Object.create;
var ObjectAssign = Object.assign;
var BufferConcat = Buffer.concat;
var BufferIsEncoding = Buffer.isEncoding;

var ArrayPrototypePush = Array.prototype.push;
var ArrayPrototypeReduce = Array.prototype.reduce;
var ArrayPrototypeFilter = Array.prototype.filter;
var ArrayPrototypeJoin = Array.prototype.join;
var ArrayPrototypeMap = Array.prototype.map;
var ArrayPrototypeIncludes = Array.prototype.includes;
var ArrayPrototypeSlice = Array.prototype.slice;
var ArrayPrototypeUnshift = Array.prototype.unshift;
var ArrayIsArray = Array.isArray;

// var ArrayBuffer = ArrayBuffer;
var ArrayBufferIsView = ArrayBuffer.isView;

var NumberIsInteger = Number.isInteger;
var MathAbs = Math.abs;

var StringPrototypeToUpperCase = String.prototype.toUpperCase;
var StringPrototypeIncludes = String.prototype.includes;
var Uint8ArrayPrototypeIncludes = Uint8Array.prototype.includes;

function isUint8Array(value) {
return typeof value === "object" && value !== null && value instanceof Uint8Array;
}

//------------------------------------------------------------------------------
// Section 7. Random utilities
// Section 6. Random utilities
//------------------------------------------------------------------------------

function isURLInstance(fileURLOrPath) {
Expand All @@ -1494,7 +1523,7 @@ function toPathIfFileURL(fileURLOrPath) {
}

//------------------------------------------------------------------------------
// Section 8. Node errors / error polyfills
// Section 7. Node errors / error polyfills
//------------------------------------------------------------------------------
var Error = globalThis.Error;
var TypeError = globalThis.TypeError;
Expand Down
12 changes: 12 additions & 0 deletions test/bun.js/child_process.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { describe, it as it_, expect as expect_ } from "bun:test";
import { gcTick } from "gc";
import { ChildProcess, spawn, execFile, exec, fork, spawnSync, execFileSync, execSync } from "node:child_process";
import { tmpdir } from "node:os";
import { promisify } from "node:util";

const expect: typeof expect_ = (actual: unknown) => {
gcTick();
Expand Down Expand Up @@ -263,6 +264,17 @@ describe("exec()", () => {
});
expect(SEMVER_REGEX.test(result.toString().trim())).toBe(true);
});

it("should return an object w/ stdout and stderr when promisified", async () => {
const result = await promisify(exec)("bun -v");
expect(typeof result).toBe("object");
expect(typeof result.stdout).toBe("string");
expect(typeof result.stderr).toBe("string");

const { stdout, stderr } = result;
expect(SEMVER_REGEX.test(stdout.trim())).toBe(true);
expect(stderr.trim()).toBe("");
});
});

describe("fork()", () => {
Expand Down