Bun's priorities

[Jarred-Sumner]

Bun is a large project and it is early days. I think Bun needs to do a better job communicating what is a priority right now and what isn't.

Bun's top priorities:

1. Improve stability. Bun should not segfault (all segmentation faults are bugs in bun). bun install should work as reliably as npm. We need more testing for error cases throughout Bun's test suite. We need to be running Address Sanitizer regularly and possibly Valgrind as well. We need to do fuzz testing.
2. Improve Node.js compatibility. There are too many cases where Bun either underperforms or is missing a function. Bun's Node.js compatibility has pretty good breadth, but not enough depth.

PRs that fit in the scope of top priorities will be reviewed ASAP. PRs that do not fit in this scope may take awhile to be reviewed

[umararshad4]

how much time do you think this is gonna take?

[PatrickPrakash]

how much time do you think this is gonna take?

It depends! @ohsnap4. It's very hard to predict when these priorities can get done in an open-source environment. Everyone is contributing in their spare time. But I think @Jarred-Sumner has a time-goal set up for this, the only thing we can do is to contribute meaningfully to this project.

[KishanBagaria]

As a user, I'd want:

1. no crashes
2. complete Node.js drop-in replacement
3. complete npm/yarn install replacement

2 > 3 since user experience > developer experience. 2 excites me most since it'll immediately speed up a lot of web apps. A good target should be to get Bun.js working with top 100 npm packages without changes to the packages themselves. This opens up an incremental adoption strategy for everyone to switch from node → bun and then optionally translate compat APIs for Node.js to even faster Bun.js equivalents if present.

[SHIMER-jpg]

I would love to help but feel like I'm to unexperienced yet, any pointers from a more experienced dev as to what to learn to be a little useful?

[factoidforrest]

How high of a priority do you consider expanded documentation and community outreach to be?

[halffunction]

I like to use bun in Termux but it didn't worked.

[jooj123]

@Jarred-Sumner firstly great project 👍 love it.

Im wondering how I could help.

My first thoughts was to structure the documentation a bit more concisely, is that something that would be of interest + inline with priorities?

Feels like a wall of text at the moment, maybe as a starting point:

• Group related things under one heading
• Split up README.md into multiple files (that reside in ~/docs/*)

[EAGLE1309]

@halffunction

I like to use bun in Termux but it didn't worked.

Facing Same issue here!

[ariesclark]

Does Bun instead to expose all apis via the Bun global like how it is currently, if so, it could get disorganized very quickly.

[Nugine]

Crash issues:

• SegmentationFault at 3 when parsing a large JSON file #188
• Segmentation fault on a particular env variable with Apple Silicon  #554
• Assigning process.env.NODE_ENV -> "SyntaxError: Left side of assignment is not a reference" #556
• Bun + Open Runtimes integration issue #684
• Unable to run Next.js app with bun dev #723
• Too many nested for-loops causes segfault #817
• SegmentationFault at 26 when parsing json #826
• Implement http2 #887
• Chevrotain tutorial tracking issue #888
• Can't import gpu.js #1084
• Crash when logging global #1087
• SegmentationFault at 0xBC00000000000000 react-scripts #1088
• InstructionError at 0xF590D60200000000 #1167
• [bun install] SegmentationFault with 443, 502, 404 error code #1211
• Segfault caused by macro oddities #1257
• macOS catalina unsupported in bun 0.1.13 #1266
• Next.js chakraUI segmentation fault #1305
• SegmentationFault at 188 on install #1312
• dyld: Symbol not found: _posix_spawn_file_actions_addchdir_np on MacOS Mojave #1323
• Bun 0.2.0 crashes on MacOS Mojave [check ticket -> #1266] #1330
• Segfault on v0.2.0 with GraphQL Yoga v3 #1331
• "Illegal instruction" in Docker #1342
• Segfault on large number of process spawns #1345
• Bun cannot start without /proc #1360
• SegmentationFault on simple Next server #1361
• ...

[Perodactyl]

Will process.stdin and process.stdout ever be implemented?
I guess they might be added for support with chalk

[sno2]

@Perodactyl There is a not a feature request regarding that so feel free to create it.

[robogeek]

Chokidar is an extremely popular package that is core to other extremely popular packages. It currently does not work because fs.watch is not implemented: #832

[FrameMuse]

Wow, I see so much work and progress going on here, I wish bun the best. I believe it's going to be a breakthrough (if I'm not exaggerating) or at least game changer ^_^

[ryanrussell]

Stability/SegFault improvement update -- #644 appears markedly improved from 1.3.0 -> 1.5.0

More notes in the issue. Incredibly impressive delta in such a short time.

Great work @Jarred-Sumner

[xhyrom]

node.js/polyfill issues:

• No brotli in zlib #267
• Implement Node's "dns" module #288
• Running Bun on TSC fails  #349
• Support vm module #401
• Support process.on("unhandledRejection") and process.on("uncaughtException") #429
• Buffer#toString unexpected / incorrect results with encoding #455
• Implement package.json "#imports" field support #478
• Implement nodejs module "vm" #479
• Node.js child_process compatibility #595 (in progress by @sno2)
• Implement fs.watch #832
• Add process.stdin, process.stdout and process.stderr #894
• Support for worker_threads #901
• Buffer#slice incorrectly handles the start = end = 0 case #960
• Buffer#copy misinterpreting arguments #962
• Buffer#fill should accept string arguments #963
• os.arch() and os.platform() are not correct #173

[ws-rush]

I am totally agree with you in 4, I tried install bun but it fail coz my old cpu

[joeyguerra]

I'd love to help, but don't want to jump in and duplicate work. Are there directly responsible individuals for these 4 items? Perhaps there's a team/squad working on these that I could get in touch with?

[robogeek]

Key modules/features that I see missing from Node.js are:

• fs.watch required by Chokidar
• dns, tls required by various network tools. I see above that net is missing, but I haven't seen that in my testing
• child_process required by Commander which is a very popular framework for CLI applications

[marvelbark2]

Hello, If you need more person involved, I guess you need to create cheat sheet for Zig because it's not popular language or example folder where you can add example about how to add a new Api also how to interact with deps that you choose and code style for better maintenance

[xhyrom]

Hello, If you need more person involved, I guess you need to create cheat sheet for Zig because it's not popular language or example folder where you can add example about how to add a new Api also how to interact with deps that you choose and code style for better maintenance

You can take a look #1115

[izznat]

async_hooks Node.js polyfill is also missing, required for Prisma.

[wenerme]

async_hooks is required for @sequelize/core@7

[vjpr]

From https://nodejs.org/api/async_hooks.html:

Please migrate away from this API, if you can...We strongly discourage the use of the async_hooks API. Other APIs that can cover most of its use cases...

[Zhomart]

It looks like prisma uses only AsyncResource, which is not deprecated based on this docs - https://nodejs.org/api/async_context.html#class-asyncresource

[Mouvedia]

A good target should be to get Bun.js working with top 100 npm packages without changes to the packages themselves.

After #​1266 fix, I cursorily tested these:

• 1 lodash ✓
• 2 chalk ✓
• 3 request ✓
• 4 commander ✓
• 6 express ✓
• 7 debug ✓
• 8 async ✓
• 9 fs-extra ✗ (a TODO popped up for copySync)
• 10 moment ✓
• 14 underscore ✓

During the process, I had some Integrity check failed that required to call bun install twice.
Apart from the fs-extra hiccup, it looks almost stable.

---

offtopic

---

After some digging it seems to be related to

lstatSync: { fn: "lstatSync", length: 1 },

i.e. the TODO means it doesn't support the options argument which has only one property (bigint)

fixed

[Majoramari]

I like the project!

[alexgleason]

Can't wait to run my JS code in based Zig instead of cringe Rust.

[derrickmehaffy]

Would really love to see some love for Koa as well and not just express as I happened across bun and would love to see if I can get it to work with https://github.com/strapi/strapi as I'm quite interested in the performance increases.

Who knows, maybe one day we would see Strapi rewritten in bun instead of Node :)

[alexgleason]

I have a big complicated Node.js Webpack project that I was skeptical would actually run in Bun. I had to nuke my node_modules and fix exactly 3 type errors to make it work. The "drop-in" replacement is not a lie, and for that you get a slow clap. 👏

[reediculous456]

From nodejs.org/api/async_hooks.html:

Please migrate away from this API, if you can...We strongly discourage the use of the async_hooks API. Other APIs that can cover most of its use cases...

While I understand that Node itself recommends not using this API, I think it should be included in bun for compatibility reasons. Sequelize is one of (if not the) biggest JS ORMs so to have it not work in bun make all of my projects incompatible with the bun runtime

[folkol]

I would love to help but feel like I'm to unexperienced yet, any pointers from a more experienced dev as to what to learn to be a little useful?

One thing that is really helpful and can be pretty tedious to produce — but can be done without deep technical expertise — is to produce small test cases that reproduces bugs. See https://en.wikipedia.org/wiki/Minimal_reproducible_example. (For example: someone reports that "it crashes for this repo" -> "these 3 lines of code consistently reproduces the crash".)

[organnerx]

I suggest considering implementing "dgram" from Node.js, since server application should be able to accept and send UDP packets, and not only TCP. Strangely no one yet mentioned it, but UDP is widely used for game servers.

[aleclarson]

When can support for VS Code step debugging be prioritized? Thanks

[acoyfellow]

Any insight as to where Firestore sits on the priority queue?

[touhidurrr]

I know that the amount of issues bun gets might be overwhelming but sometimes I feel like maintainers should read each issue at least once before deciding if an issue needs to be prioritized or not. This is because I sometimes feel like even if an issue is supposed to get priority based on the cases listed here, they often get ignored because the title might not refer to that specifically. But after reading the issue itself you realize that it needs to be addressed sooner.

[mallusrgreatv2]

There are way too many segfaults (on Windows atleast). Simply running some basic code (using the discord.js package, if that's related) ends up in a segfault. Seems like there's already an issue for my exact error (there's no message, just segfault at x address), but upon looking through the other issues, I can see a bunch of other segfaults

[aralroca]

About the missing routemap tasks: CSS Parser, IIFE module export, etc, it would be nice to add a list with a prioritization order. It would help a lot to those of us who are developing libraries/frameworks based on Bun to know also the order in which things are going to arrive, even if it is approximate.

[cjnoname]

It would be great to see Bun support the "debug.javascript.autoAttachFilter": "smart" setting in VS Code.

For long-term planning, a built-in multithread mechanism is preferred.