feat(bun): Update Bun integration to support routes & optional fetch #15978
Conversation
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
|
Hey @Jarred-Sumner thanks for the PR! I put this on my todo to review and merge, we'll try to get this out with the next release! |
mydea
changed the title
|
I've opened #16035 based on this PR, I think we can close this now. |
AbhiPrasad
added a commit
that referenced
this pull request
Apr 11, 2025
Supercedes #15978 resolves #15941 resolves #15827 resolves #15816 Bun recently updated their `Bun.serve` API with new functionality, which unfortunately broke our existing instrumentation. This is detailed with https://bun.sh/docs/api/http#bun-serve. Specifically, they added a new routing API that looks like so: ```ts Bun.serve({ // `routes` requires Bun v1.2.3+ routes: { // Dynamic routes "/users/:id": req => { return new Response(`Hello User ${req.params.id}!`); }, // Per-HTTP method handlers "/api/posts": { GET: () => new Response("List posts"), POST: async req => { const body = await req.json(); return Response.json({ created: true, ...body }); }, }, // Wildcard route for all routes that start with "/api/" and aren't otherwise matched "/api/*": Response.json({ message: "Not found" }, { status: 404 }), // Redirect from /blog/hello to /blog/hello/world "/blog/hello": Response.redirect("/blog/hello/world"), // Serve a file by buffering it in memory "/favicon.ico": new Response(await Bun.file("./favicon.ico").bytes(), { headers: { "Content-Type": "image/x-icon", }, }), }, // (optional) fallback for unmatched routes: // Required if Bun's version < 1.2.3 fetch(req) { return new Response("Not Found", { status: 404 }); }, }); ``` Because there are now dynamic routes and wildcard routes, we can actually generate `route` transaction source and send parameterized routes to Sentry. The `fetch` API is still supported. The only API we don't support is [static routes/responses](https://bun.sh/docs/api/http#static-responses). This is because these are optimized by Bun itself, and if we turn it into a function (which we need to do to time it), we'll lose out on the optimization. For now they aren't instrumented.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
resolves #15941
This updates the
@sentry/bunpackage to support instrumentingroutesand to no longer throw an error when omittingfetch. This also updatesbun-typesfrom 1.0.1 to 1.2.8 (which includes the types for routes).This does not include the code for updating node:http to support our migration away from wrapping
Request&Responseto support node:http servers better. It was less clear how to handle that, but it will likely involve wrappingnode:httpinstead ofBun.serve.Also, it seems that the tests did not pass previously when running
bun testdue to shared global state between files (probably the sdk test file). It still does not pass when run on multiple files. It does pass individually though.yarn lint) & (yarn test).Additional notes:
import-in-the-middleusage needs in@sentry/nodeneeds to be disabled in Bun for now or else it will throw an error at runtimeFeel free to use this PR as a starting point (or discard) and close if you think that's better