-
Notifications
You must be signed in to change notification settings - Fork 5k
js_printer: fix require("bun") and other printer literals being captured by same-named locals #35739
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.
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
Open
robobun
wants to merge
10
commits into
main
Choose a base branch
from
farm/0c9c6d19/fix-require-bun-shadowed-globalthis
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
js_printer: fix require("bun") and other printer literals being captured by same-named locals #35739
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
290bae6
js_printer: don't rewrite require('bun') to globalThis.Bun at runtime
robobun 7ed11a5
keep the var-destructure lowering for static `import ... from 'bun'` …
robobun d699681
shorten inline comments
robobun 24e027a
lower static `import ... from 'bun'` via import.meta.require at runti…
robobun 5253395
test: run subprocess-spawning #8058 cases concurrently
robobun f5cb2b2
ci: retrigger
robobun 4ead775
Merge remote-tracking branch 'origin/main' into farm/0c9c6d19/fix-req…
robobun b559d25
bundler: also reserve Error/Infinity/NaN/undefined for printer litera…
robobun 7af5142
test: update the builtin-esm-lazy-exports comments for the runtime "b…
robobun c96c43c
test: inspector module graph now lists "bun" in cjs
robobun File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| // https://github.com/oven-sh/bun/issues/8058 | ||
| // | ||
| // The printer used to unconditionally rewrite `require("bun")` / `import("bun")` | ||
| // to the literal `globalThis.Bun` / `Promise.resolve(globalThis.Bun)`. A local | ||
| // `let globalThis` (or `let Promise`) in scope would shadow that literal and | ||
| // change the value of the import. | ||
|
coderabbitai[bot] marked this conversation as resolved.
Outdated
|
||
|
|
||
| import { describe, expect, test } from "bun:test"; | ||
| import { bunEnv, bunExe, tempDir } from "harness"; | ||
| import { itBundled } from "../../bundler/expectBundled"; | ||
|
coderabbitai[bot] marked this conversation as resolved.
Outdated
|
||
|
|
||
| describe("runtime transpiler", () => { | ||
| async function run(src: string) { | ||
| await using proc = Bun.spawn({ | ||
| cmd: [bunExe(), "-e", src], | ||
| env: bunEnv, | ||
| stdout: "pipe", | ||
| stderr: "pipe", | ||
| }); | ||
| const [stdout, stderr, exitCode] = await Promise.all([proc.stdout.text(), proc.stderr.text(), proc.exited]); | ||
| return { stdout, stderr, exitCode }; | ||
| } | ||
|
|
||
| test("require('bun') with a local `globalThis` returns the real Bun object", async () => { | ||
| const { stdout, stderr, exitCode } = await run( | ||
| `{ let globalThis = { Bun: "intercepted" }; console.log(typeof require("bun").serve); }`, | ||
| ); | ||
| expect(stderr).toBe(""); | ||
| expect(stdout).toBe("function\n"); | ||
| expect(exitCode).toBe(0); | ||
| }); | ||
|
|
||
| test("dynamic import('bun') with local `globalThis` / `Promise` returns the real Bun object", async () => { | ||
| const { stdout, stderr, exitCode } = await run( | ||
| `{ let globalThis = { Bun: "intercepted" }; let Promise = null;` + | ||
| ` import("bun").then(b => console.log(typeof b.serve)); }`, | ||
| ); | ||
| expect(stderr).toBe(""); | ||
| expect(stdout).toBe("function\n"); | ||
| expect(exitCode).toBe(0); | ||
| }); | ||
|
|
||
| test("require('bun') in a .cjs file with a local `globalThis`", async () => { | ||
| using dir = tempDir("issue-08058-cjs", { | ||
| "index.cjs": ` | ||
| module.exports = 1; | ||
| { let globalThis = { Bun: "intercepted" }; console.log(typeof require("bun").serve); } | ||
| `, | ||
| }); | ||
| await using proc = Bun.spawn({ | ||
| cmd: [bunExe(), "index.cjs"], | ||
| env: bunEnv, | ||
| cwd: String(dir), | ||
| stdout: "pipe", | ||
| stderr: "pipe", | ||
| }); | ||
| const [stdout, stderr, exitCode] = await Promise.all([proc.stdout.text(), proc.stderr.text(), proc.exited]); | ||
| expect(stderr).toBe(""); | ||
| expect(stdout).toBe("function\n"); | ||
| expect(exitCode).toBe(0); | ||
| }); | ||
|
|
||
| test("`import { env } from 'bun'` does not eagerly reify the Bun object", async () => { | ||
| // `import X from "bun"` is still lowered to `var X = globalThis.Bun` at runtime | ||
| // (not a real ESM import) so that (a) only the requested property is touched and | ||
| // (b) type-only names declared in bun.d.ts don't fail link-time export validation. | ||
| using dir = tempDir("issue-08058-reify", { | ||
| "index.ts": ` | ||
| import { env } from "bun"; | ||
| import { hasNonReifiedStatic } from "bun:internal-for-testing"; | ||
| if (!hasNonReifiedStatic(Bun)) throw new Error("import { env } from 'bun' reified the whole Bun object"); | ||
| void env; | ||
| console.log("pass"); | ||
| `, | ||
| }); | ||
| await using proc = Bun.spawn({ | ||
| cmd: [bunExe(), "index.ts"], | ||
| env: bunEnv, | ||
| cwd: String(dir), | ||
| stdout: "pipe", | ||
| stderr: "pipe", | ||
| }); | ||
| const [stdout, stderr, exitCode] = await Promise.all([proc.stdout.text(), proc.stderr.text(), proc.exited]); | ||
| expect(stderr).toBe(""); | ||
| expect(stdout).toBe("pass\n"); | ||
| expect(exitCode).toBe(0); | ||
| }); | ||
| }); | ||
|
|
||
| describe("bundler", () => { | ||
| itBundled("bun/require-bun-shadowed-globalThis", { | ||
|
coderabbitai[bot] marked this conversation as resolved.
Outdated
|
||
| target: "bun", | ||
| files: { | ||
| "/entry.ts": /* js */ ` | ||
| import * as B from "bun"; | ||
| var globalThis = { Bun: "intercepted" }; | ||
| if (typeof B.serve !== "function") throw new Error("import * from 'bun' was shadowed: " + B); | ||
| { | ||
| let globalThis = { Bun: "intercepted" }; | ||
| const b = require("bun"); | ||
| if (typeof b.serve !== "function") throw new Error("require('bun') was shadowed: " + b); | ||
| const d = await import("bun"); | ||
| if (typeof d.serve !== "function") throw new Error("import('bun') was shadowed: " + d); | ||
| console.log("pass"); | ||
| } | ||
| `, | ||
| }, | ||
| run: { stdout: "pass" }, | ||
| onAfterBundle(api) { | ||
| // The user's local binding should have been renamed away. | ||
| expect(api.readFile("out.js")).not.toContain(`globalThis = { Bun`); | ||
| }, | ||
| }); | ||
|
|
||
| itBundled("bun/require-bun-shadowed-globalThis-cjs", { | ||
| target: "bun", | ||
| format: "cjs", | ||
| files: { | ||
| "/entry.ts": /* js */ ` | ||
| import * as B from "bun"; | ||
| { | ||
| let globalThis = { Bun: "intercepted" }; | ||
| const b = require("bun"); | ||
| if (typeof b.serve !== "function") throw new Error("require('bun') was shadowed: " + b); | ||
| if (typeof B.serve !== "function") throw new Error("import * from 'bun' was shadowed: " + B); | ||
| console.log("pass"); | ||
| } | ||
| `, | ||
| }, | ||
| run: { stdout: "pass" }, | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.