Files
bun.sh/test/bundler/compile-argv.test.ts
Dylan Conway d8d8182e8e fix(compile): apply BUN_OPTIONS env var to standalone executables (#26346)
## Summary
- Fixed `BUN_OPTIONS` environment variable not being applied as runtime
options for standalone executables (`bun build --compile`). Previously,
args from `BUN_OPTIONS` were incorrectly passed through to
`process.argv` instead of being parsed as Bun runtime options
(`process.execArgv`).
- Removed `BUN_CPU_PROFILE`, `BUN_CPU_PROFILE_DIR`, and
`BUN_CPU_PROFILE_NAME` env vars since `BUN_OPTIONS="--cpu-prof
--cpu-prof-dir=... --cpu-prof-name=..."` now works correctly with
standalone executables.
- Made `cpu_prof.name` and `cpu_prof.dir` non-optional with empty string
defaults.

fixes #21496

## Test plan
- [x] Added tests for `BUN_OPTIONS` with standalone executables (no
`compile-exec-argv`)
- [x] Added tests for `BUN_OPTIONS` combined with `--compile-exec-argv`
- [x] Added tests for `BUN_OPTIONS` with user passthrough args
- [x] Verified existing `compile-argv` tests still pass
- [x] Verified existing `bun-options` tests still pass

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Jarred Sumner <jarred@jarredsumner.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Claude Bot <claude-bot@bun.sh>
2026-01-23 00:24:18 -08:00

391 lines
13 KiB
TypeScript

import { describe } from "bun:test";
import { itBundled } from "./expectBundled";
describe("bundler", () => {
// Test that the --compile-exec-argv flag works for both runtime processing and execArgv
itBundled("compile/CompileExecArgvDualBehavior", {
compile: {
execArgv: ["--title=CompileExecArgvDualBehavior", "--smol"],
},
backend: "cli",
files: {
"/entry.ts": /* js */ `
// Test that --compile-exec-argv both processes flags AND populates execArgv
console.log("execArgv:", JSON.stringify(process.execArgv));
console.log("argv:", JSON.stringify(process.argv));
if (process.argv.findIndex(arg => arg === "runtime") === -1) {
console.error("FAIL: runtime not found in argv");
process.exit(1);
}
if (process.argv.findIndex(arg => arg === "test") === -1) {
console.error("FAIL: test not found in argv");
process.exit(1);
}
if (process.execArgv.findIndex(arg => arg === "--title=CompileExecArgvDualBehavior") === -1) {
console.error("FAIL: --title=CompileExecArgvDualBehavior not found in execArgv");
process.exit(1);
}
if (process.execArgv.findIndex(arg => arg === "--smol") === -1) {
console.error("FAIL: --smol not found in execArgv");
process.exit(1);
}
if (process.title !== "CompileExecArgvDualBehavior") {
console.error("FAIL: process.title mismatch. Expected: CompileExecArgvDualBehavior, Got:", process.title);
process.exit(1);
}
console.log("SUCCESS: process.title and process.execArgv are both set correctly");
`,
},
run: {
args: ["runtime", "test"],
stdout: /SUCCESS: process.title and process.execArgv are both set correctly/,
},
});
// Test that exec argv options don't leak into process.argv when no user arguments are provided
itBundled("compile/CompileExecArgvNoLeak", {
compile: {
execArgv: ["--user-agent=test-agent", "--smol"],
},
backend: "cli",
files: {
"/entry.ts": /* js */ `
// Test that compile-exec-argv options don't appear in process.argv
console.log("execArgv:", JSON.stringify(process.execArgv));
console.log("argv:", JSON.stringify(process.argv));
// Check that execArgv contains the expected options
if (process.execArgv.length !== 2) {
console.error("FAIL: Expected exactly 2 items in execArgv, got", process.execArgv.length);
process.exit(1);
}
if (process.execArgv[0] !== "--user-agent=test-agent") {
console.error("FAIL: Expected --user-agent=test-agent in execArgv[0], got", process.execArgv[0]);
process.exit(1);
}
if (process.execArgv[1] !== "--smol") {
console.error("FAIL: Expected --smol in execArgv[1], got", process.execArgv[1]);
process.exit(1);
}
// Check that argv only contains the executable and script name, NOT the exec argv options
if (process.argv.length !== 2) {
console.error("FAIL: Expected exactly 2 items in argv (executable and script), got", process.argv.length, "items:", process.argv);
process.exit(1);
}
// argv[0] should be "bun" for standalone executables
if (process.argv[0] !== "bun") {
console.error("FAIL: Expected argv[0] to be 'bun', got", process.argv[0]);
process.exit(1);
}
// argv[1] should be the script path (contains the bundle path)
if (!process.argv[1].includes("bunfs")) {
console.error("FAIL: Expected argv[1] to contain 'bunfs' path, got", process.argv[1]);
process.exit(1);
}
// Make sure exec argv options are NOT in process.argv
for (const arg of process.argv) {
if (arg.includes("--user-agent") || arg === "--smol") {
console.error("FAIL: exec argv option leaked into process.argv:", arg);
process.exit(1);
}
}
console.log("SUCCESS: exec argv options are properly separated from process.argv");
`,
},
run: {
// No user arguments provided - this is the key test case
args: [],
stdout: /SUCCESS: exec argv options are properly separated from process.argv/,
},
});
// Test that user arguments are properly passed through when exec argv is present
itBundled("compile/CompileExecArgvWithUserArgs", {
compile: {
execArgv: ["--user-agent=test-agent", "--smol"],
},
backend: "cli",
files: {
"/entry.ts": /* js */ `
// Test that user arguments are properly included when exec argv is present
console.log("execArgv:", JSON.stringify(process.execArgv));
console.log("argv:", JSON.stringify(process.argv));
// Check execArgv
if (process.execArgv.length !== 2) {
console.error("FAIL: Expected exactly 2 items in execArgv, got", process.execArgv.length);
process.exit(1);
}
if (process.execArgv[0] !== "--user-agent=test-agent" || process.execArgv[1] !== "--smol") {
console.error("FAIL: Unexpected execArgv:", process.execArgv);
process.exit(1);
}
// Check argv contains executable, script, and user arguments
if (process.argv.length !== 4) {
console.error("FAIL: Expected exactly 4 items in argv, got", process.argv.length, "items:", process.argv);
process.exit(1);
}
if (process.argv[0] !== "bun") {
console.error("FAIL: Expected argv[0] to be 'bun', got", process.argv[0]);
process.exit(1);
}
if (!process.argv[1].includes("bunfs")) {
console.error("FAIL: Expected argv[1] to contain 'bunfs' path, got", process.argv[1]);
process.exit(1);
}
if (process.argv[2] !== "user-arg1") {
console.error("FAIL: Expected argv[2] to be 'user-arg1', got", process.argv[2]);
process.exit(1);
}
if (process.argv[3] !== "user-arg2") {
console.error("FAIL: Expected argv[3] to be 'user-arg2', got", process.argv[3]);
process.exit(1);
}
// Make sure exec argv options are NOT mixed with user arguments
if (process.argv.includes("--user-agent=test-agent") || process.argv.includes("--smol")) {
console.error("FAIL: exec argv options leaked into process.argv");
process.exit(1);
}
console.log("SUCCESS: user arguments properly passed with exec argv present");
`,
},
run: {
args: ["user-arg1", "user-arg2"],
stdout: /SUCCESS: user arguments properly passed with exec argv present/,
},
});
// Test that --version and --help flags are passed through to user code (issue #26082)
// When compile-exec-argv is used, user flags like --version should NOT be intercepted by Bun
itBundled("compile/CompileExecArgvVersionHelpPassthrough", {
compile: {
execArgv: ["--smol"],
},
backend: "cli",
files: {
"/entry.ts": /* js */ `
// Test that --version and --help are passed through to user code, not intercepted by Bun
const args = process.argv.slice(2);
console.log("User args:", JSON.stringify(args));
if (args.includes("--version")) {
console.log("APP_VERSION:1.0.0");
} else if (args.includes("-v")) {
console.log("APP_VERSION:1.0.0");
} else if (args.includes("--help")) {
console.log("APP_HELP:This is my app help");
} else if (args.includes("-h")) {
console.log("APP_HELP:This is my app help");
} else {
console.log("NO_FLAG_MATCHED");
}
`,
},
run: {
args: ["--version"],
stdout: /APP_VERSION:1\.0\.0/,
},
});
// Test with -v short flag
itBundled("compile/CompileExecArgvShortVersionPassthrough", {
compile: {
execArgv: ["--smol"],
},
backend: "cli",
files: {
"/entry.ts": /* js */ `
const args = process.argv.slice(2);
if (args.includes("-v")) {
console.log("APP_VERSION:1.0.0");
} else {
console.log("FAIL: -v not found in args:", args);
process.exit(1);
}
`,
},
run: {
args: ["-v"],
stdout: /APP_VERSION:1\.0\.0/,
},
});
// Test with --help flag
itBundled("compile/CompileExecArgvHelpPassthrough", {
compile: {
execArgv: ["--smol"],
},
backend: "cli",
files: {
"/entry.ts": /* js */ `
const args = process.argv.slice(2);
if (args.includes("--help")) {
console.log("APP_HELP:my custom help");
} else {
console.log("FAIL: --help not found in args:", args);
process.exit(1);
}
`,
},
run: {
args: ["--help"],
stdout: /APP_HELP:my custom help/,
},
});
// Test with -h short flag
itBundled("compile/CompileExecArgvShortHelpPassthrough", {
compile: {
execArgv: ["--smol"],
},
backend: "cli",
files: {
"/entry.ts": /* js */ `
const args = process.argv.slice(2);
if (args.includes("-h")) {
console.log("APP_HELP:my custom help");
} else {
console.log("FAIL: -h not found in args:", args);
process.exit(1);
}
`,
},
run: {
args: ["-h"],
stdout: /APP_HELP:my custom help/,
},
});
// Test that BUN_OPTIONS env var is applied to standalone executables
itBundled("compile/BunOptionsEnvApplied", {
compile: true,
backend: "cli",
files: {
"/entry.ts": /* js */ `
console.log("execArgv:", JSON.stringify(process.execArgv));
console.log("argv:", JSON.stringify(process.argv));
if (process.execArgv.findIndex(arg => arg === "--smol") === -1) {
console.error("FAIL: --smol not found in execArgv:", process.execArgv);
process.exit(1);
}
// BUN_OPTIONS args should NOT appear in process.argv
for (const arg of process.argv) {
if (arg === "--smol") {
console.error("FAIL: --smol leaked into process.argv:", process.argv);
process.exit(1);
}
}
console.log("SUCCESS: BUN_OPTIONS applied to standalone executable");
`,
},
run: {
env: { BUN_OPTIONS: "--smol" },
stdout: /SUCCESS: BUN_OPTIONS applied to standalone executable/,
},
});
// Test BUN_OPTIONS combined with compile-exec-argv
itBundled("compile/BunOptionsEnvWithCompileExecArgv", {
compile: {
execArgv: ["--conditions=production"],
},
backend: "cli",
files: {
"/entry.ts": /* js */ `
console.log("execArgv:", JSON.stringify(process.execArgv));
console.log("argv:", JSON.stringify(process.argv));
if (process.execArgv.findIndex(arg => arg === "--conditions=production") === -1) {
console.error("FAIL: --conditions=production not found in execArgv:", process.execArgv);
process.exit(1);
}
if (process.execArgv.findIndex(arg => arg === "--smol") === -1) {
console.error("FAIL: --smol not found in execArgv:", process.execArgv);
process.exit(1);
}
// Neither BUN_OPTIONS nor compile-exec-argv args should be in process.argv
for (const arg of process.argv) {
if (arg === "--smol" || arg === "--conditions=production") {
console.error("FAIL: exec option leaked into process.argv:", arg);
process.exit(1);
}
}
console.log("SUCCESS: BUN_OPTIONS and compile-exec-argv both applied");
`,
},
run: {
env: { BUN_OPTIONS: "--smol" },
stdout: /SUCCESS: BUN_OPTIONS and compile-exec-argv both applied/,
},
});
// Test BUN_OPTIONS with user passthrough args
itBundled("compile/BunOptionsEnvWithPassthroughArgs", {
compile: true,
backend: "cli",
files: {
"/entry.ts": /* js */ `
console.log("execArgv:", JSON.stringify(process.execArgv));
console.log("argv:", JSON.stringify(process.argv));
if (process.execArgv.findIndex(arg => arg === "--smol") === -1) {
console.error("FAIL: --smol not found in execArgv:", process.execArgv);
process.exit(1);
}
if (process.argv.findIndex(arg => arg === "user-arg1") === -1) {
console.error("FAIL: user-arg1 not found in argv:", process.argv);
process.exit(1);
}
if (process.argv.findIndex(arg => arg === "user-arg2") === -1) {
console.error("FAIL: user-arg2 not found in argv:", process.argv);
process.exit(1);
}
// BUN_OPTIONS args should NOT be in process.argv
for (const arg of process.argv) {
if (arg === "--smol") {
console.error("FAIL: --smol leaked into process.argv:", process.argv);
process.exit(1);
}
}
console.log("SUCCESS: BUN_OPTIONS separated from passthrough args");
`,
},
run: {
env: { BUN_OPTIONS: "--smol" },
args: ["user-arg1", "user-arg2"],
stdout: /SUCCESS: BUN_OPTIONS separated from passthrough args/,
},
});
});