feat(bun): Support new Bun.serve APIs#16035

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
AbhiPrasad merged 3 commits into from
Apr 11, 2025
Merged

feat(bun): Support new Bun.serve APIs #16035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ec1fab
feat(bun): Support new `Bun.serve` APIs
AbhiPrasad Apr 11, 2025
e6a28c1
add bun-types latest
AbhiPrasad Apr 11, 2025
eebf7ac
remove todo and fix yarn.lock
AbhiPrasad Apr 11, 2025
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
2 changes: 1 addition & 1 deletion packages/bun/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
"@sentry/opentelemetry": "9.12.0"
},
"devDependencies": {
"bun-types": "latest"
"bun-types": "^1.2.9"
},
"scripts": {
"build": "run-p build:transpile build:types",
Expand Down
294 changes: 223 additions & 71 deletions packages/bun/src/integrations/bunserver.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
import type { ServeOptions } from 'bun';
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import {
SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
captureException,
continueTrace,
defineIntegration,
extractQueryParamsFromUrl,
getSanitizedUrlString,
parseUrl,
isURLObjectRelative,
setHttpStatus,
defineIntegration,
continueTrace,
startSpan,
withIsolationScope,
parseStringToURLObject,
} from '@sentry/core';

const INTEGRATION_NAME = 'BunServer';
Expand All@@ -28,6 +28,8 @@ const _bunServerIntegration = (() => {
/**
* Instruments `Bun.serve` to automatically create transactions and capture errors.
*
* Does not support instrumenting static routes.
*
* Enabled by default in the Bun SDK.
*
* ```js
Expand All@@ -40,10 +42,18 @@ const _bunServerIntegration = (() => {
*/
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let hasPatchedBunServe = false;

/**
* Instruments Bun.serve by patching it's options.
*
* Only exported for tests.
*/
export function instrumentBunServe(): void {
if (hasPatchedBunServe) {
return;
}

Bun.serve = new Proxy(Bun.serve, {
apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
instrumentBunServeOptions(serveArgs[0]);
Expand All@@ -53,89 +63,231 @@ export function instrumentBunServe(): void {
// We can't use a Proxy for this as Bun does `instanceof` checks internally that fail if we
// wrap the Server instance.
const originalReload: typeof server.reload = server.reload.bind(server);
server.reload = (serveOptions: Parameters<typeof Bun.serve>[0]) => {
server.reload = (serveOptions: ServeOptions) => {
instrumentBunServeOptions(serveOptions);
return originalReload(serveOptions);
};

return server;
},
});

hasPatchedBunServe = true;
}

/**
* Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
* Instruments Bun.serve options.
*
* @param serveOptions - The options for the Bun.serve function.
*/
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
// First handle fetch
instrumentBunServeOptionFetch(serveOptions);
// then handle routes
instrumentBunServeOptionRoutes(serveOptions);
}

/**
* Instruments the `fetch` option of Bun.serve.
*
* @param serveOptions - The options for the Bun.serve function.
*/
function instrumentBunServeOptionFetch(serveOptions: Parameters<typeof Bun.serve>[0]): void {
if (typeof serveOptions.fetch !== 'function') {
return;
}

serveOptions.fetch = new Proxy(serveOptions.fetch, {
apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof serveOptions.fetch>) {
return withIsolationScope(isolationScope => {
const request = fetchArgs[0];
const upperCaseMethod = request.method.toUpperCase();
if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
return fetchTarget.apply(fetchThisArg, fetchArgs);
}
return wrapRequestHandler(fetchTarget, fetchThisArg, fetchArgs);
},
});
}

const parsedUrl = parseUrl(request.url);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
[SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
};
if (parsedUrl.search) {
attributes['http.query'] = parsedUrl.search;
}
/**
* Instruments the `routes` option of Bun.serve.
*
* @param serveOptions - The options for the Bun.serve function.
*/
function instrumentBunServeOptionRoutes(serveOptions: Parameters<typeof Bun.serve>[0]): void {
if (!serveOptions.routes) {
return;
}

const url = getSanitizedUrlString(parsedUrl);

isolationScope.setSDKProcessingMetadata({
normalizedRequest: {
url,
method: request.method,
headers: request.headers.toJSON(),
query_string: extractQueryParamsFromUrl(url),
} satisfies RequestEventData,
});

return continueTrace(
{ sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
() => {
return startSpan(
{
attributes,
op: 'http.server',
name: `${request.method} ${parsedUrl.path || '/'}`,
},
async span => {
try {
const response = await (fetchTarget.apply(fetchThisArg, fetchArgs) as ReturnType<
typeof serveOptions.fetch
>);
if (response?.status) {
setHttpStatus(span, response.status);
isolationScope.setContext('response', {
headers: response.headers.toJSON(),
status_code: response.status,
});
}
return response;
} catch (e) {
captureException(e, {
mechanism: {
type: 'bun',
handled: false,
data: {
function: 'serve',
},
},
});
throw e;
}
if (typeof serveOptions.routes !== 'object') {
return;
}

Object.keys(serveOptions.routes).forEach(route => {
const routeHandler = serveOptions.routes[route];

// Handle route handlers that are an object
if (typeof routeHandler === 'function') {
serveOptions.routes[route] = new Proxy(routeHandler, {
apply: (routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs: Parameters<typeof routeHandler>) => {
return wrapRequestHandler(routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs, route);
},
});
}

// Static routes are not instrumented
if (routeHandler instanceof Response) {
return;
}

// Handle the route handlers that are an object. This means they define a route handler for each method.
if (typeof routeHandler === 'object') {
Object.entries(routeHandler).forEach(([routeHandlerObjectHandlerKey, routeHandlerObjectHandler]) => {
if (typeof routeHandlerObjectHandler === 'function') {
(serveOptions.routes[route] as Record<string, RouteHandler>)[routeHandlerObjectHandlerKey] = new Proxy(
routeHandlerObjectHandler,
{
apply: (
routeHandlerObjectHandlerTarget,
routeHandlerObjectHandlerThisArg,
routeHandlerObjectHandlerArgs: Parameters<typeof routeHandlerObjectHandler>,
) => {
return wrapRequestHandler(
routeHandlerObjectHandlerTarget,
routeHandlerObjectHandlerThisArg,
routeHandlerObjectHandlerArgs,
route,
);
},
);
},
);
},
);
}
});
},
}
});
}

type RouteHandler = Extract<
NonNullable<Parameters<typeof Bun.serve>[0]['routes']>[string],
// eslint-disable-next-line @typescript-eslint/ban-types
Function
>;

function wrapRequestHandler<T extends RouteHandler = RouteHandler>(
target: T,
thisArg: unknown,
args: Parameters<T>,
route?: string,
): ReturnType<T> {
return withIsolationScope(isolationScope => {
const request = args[0];
const upperCaseMethod = request.method.toUpperCase();
if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
return target.apply(thisArg, args);
}

const parsedUrl = parseStringToURLObject(request.url);
const attributes = getSpanAttributesFromParsedUrl(parsedUrl, request);

let routeName = parsedUrl?.pathname || '/';
if (request.params) {
Object.keys(request.params).forEach(key => {
attributes[`url.path.parameter.${key}`] = (request.params as Record<string, string>)[key];
});

// If a route has parameters, it's a parameterized route
if (route) {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
attributes['url.template'] = route;
routeName = route;
}
}

// Handle wildcard routes
if (route?.endsWith('/*')) {
attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
attributes['url.template'] = route;
routeName = route;
}

isolationScope.setSDKProcessingMetadata({
normalizedRequest: {
url: request.url,
method: request.method,
headers: request.headers.toJSON(),
query_string: parsedUrl?.search,
} satisfies RequestEventData,
});

return continueTrace(
{
sentryTrace: request.headers.get('sentry-trace') ?? '',
baggage: request.headers.get('baggage'),
},
() =>
startSpan(
{
attributes,
op: 'http.server',
name: `${request.method} ${routeName}`,
},
async span => {
try {
const response = (await target.apply(thisArg, args)) as Response | undefined;
if (response?.status) {
setHttpStatus(span, response.status);
isolationScope.setContext('response', {
headers: response.headers.toJSON(),
status_code: response.status,
});
}
return response;
} catch (e) {
captureException(e, {
mechanism: {
type: 'bun',
handled: false,
data: {
function: 'serve',
},
},
});
throw e;
}
},
),
);
});
}

function getSpanAttributesFromParsedUrl(
parsedUrl: ReturnType<typeof parseStringToURLObject>,
request: Request,
): SpanAttributes {
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
[SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
};

if (parsedUrl) {
if (parsedUrl.search) {
attributes['url.query'] = parsedUrl.search;
}
if (parsedUrl.hash) {
attributes['url.fragment'] = parsedUrl.hash;
}
if (parsedUrl.pathname) {
attributes['url.path'] = parsedUrl.pathname;
}
if (!isURLObjectRelative(parsedUrl)) {
attributes['url.full'] = parsedUrl.href;
if (parsedUrl.port) {
attributes['url.port'] = parsedUrl.port;
}
if (parsedUrl.protocol) {
attributes['url.scheme'] = parsedUrl.protocol;
}
if (parsedUrl.hostname) {
attributes['url.domain'] = parsedUrl.hostname;
}
}
}

return attributes;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(bun): Support new Bun.serve APIs#16035

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

AbhiPrasad
merged 3 commits into

from

Apr 11, 2025
 Merged


feat(bun): Support new Bun.serve APIs
#16035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
0ec1fab

feat(bun): Support new `Bun.serve` APIs


AbhiPrasad Apr 11, 2025
e6a28c1

add bun-types latest


AbhiPrasad Apr 11, 2025
eebf7ac

remove todo and fix yarn.lock


AbhiPrasad Apr 11, 2025

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


2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
 "@sentry/opentelemetry": "9.12.0"
 },
 "devDependencies": {
 "bun-types": "latest"
 "bun-types": "^1.2.9"
 },
 "scripts": {
 "build": "run-p build:transpile build:types",
Expand Down

294 changes: 223 additions & 71 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
import type { ServeOptions } from 'bun';
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 defineIntegration,
 extractQueryParamsFromUrl,
 getSanitizedUrlString,
 parseUrl,
 isURLObjectRelative,
 setHttpStatus,
 defineIntegration,
 continueTrace,
 startSpan,
 withIsolationScope,
 parseStringToURLObject,
} from '@sentry/core';

const INTEGRATION_NAME = 'BunServer';
Expand All@@ -28,6 +28,8 @@ const _bunServerIntegration = (() => {
/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
 *
 * Does not support instrumenting static routes.
 *
 * Enabled by default in the Bun SDK.
 *
 * ```js
Expand All@@ -40,10 +42,18 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let hasPatchedBunServe = false;

/**
 * Instruments Bun.serve by patching it's options.
 *
 * Only exported for tests.
 */
export function instrumentBunServe(): void {
 if (hasPatchedBunServe) {
 return;
 }

 Bun.serve = new Proxy(Bun.serve, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
Expand All@@ -53,89 +63,231 @@ export function instrumentBunServe(): void {
 // We can't use a Proxy for this as Bun does `instanceof` checks internally that fail if we
 // wrap the Server instance.
 const originalReload: typeof server.reload = server.reload.bind(server);
 server.reload = (serveOptions: Parameters<typeof Bun.serve>[0]) => {
 server.reload = (serveOptions: ServeOptions) => {
 instrumentBunServeOptions(serveOptions);
 return originalReload(serveOptions);
 };

 return server;
 },
 });

 hasPatchedBunServe = true;
}

/**
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 * Instruments Bun.serve options.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 // First handle fetch
 instrumentBunServeOptionFetch(serveOptions);
 // then handle routes
 instrumentBunServeOptionRoutes(serveOptions);
}

/**
 * Instruments the `fetch` option of Bun.serve.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptionFetch(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (typeof serveOptions.fetch !== 'function') {
 return;
 }

 serveOptions.fetch = new Proxy(serveOptions.fetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof serveOptions.fetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(fetchThisArg, fetchArgs);
 }
 return wrapRequestHandler(fetchTarget, fetchThisArg, fetchArgs);
 },
 });
}

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
}
/**
* Instruments the `routes` option of Bun.serve.
*
* @param serveOptions - The options for the Bun.serve function.
*/
function instrumentBunServeOptionRoutes(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (!serveOptions.routes) {
return;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${parsedUrl.path || '/'}`,
 },
 async span => {
 try {
 const response = await (fetchTarget.apply(fetchThisArg, fetchArgs) as ReturnType<
 typeof serveOptions.fetch
 >);
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 if (typeof serveOptions.routes !== 'object') {
 return;
 }

 Object.keys(serveOptions.routes).forEach(route => {
 const routeHandler = serveOptions.routes[route];

 // Handle route handlers that are an object
 if (typeof routeHandler === 'function') {
 serveOptions.routes[route] = new Proxy(routeHandler, {
 apply: (routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs: Parameters<typeof routeHandler>) => {
 return wrapRequestHandler(routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs, route);
 },
 });
 }

 // Static routes are not instrumented
 if (routeHandler instanceof Response) {
 return;
 }

 // Handle the route handlers that are an object. This means they define a route handler for each method.
 if (typeof routeHandler === 'object') {
 Object.entries(routeHandler).forEach(([routeHandlerObjectHandlerKey, routeHandlerObjectHandler]) => {
 if (typeof routeHandlerObjectHandler === 'function') {
 (serveOptions.routes[route] as Record<string, RouteHandler>)[routeHandlerObjectHandlerKey] = new Proxy(
 routeHandlerObjectHandler,
 {
 apply: (
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs: Parameters<typeof routeHandlerObjectHandler>,
 ) => {
 return wrapRequestHandler(
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs,
 route,
 );
 },
);
},
);
},
);
}
 });
 },
 }
 });
}

type RouteHandler = Extract<
 NonNullable<Parameters<typeof Bun.serve>[0]['routes']>[string],
 // eslint-disable-next-line @typescript-eslint/ban-types
 Function
>;

function wrapRequestHandler<T extends RouteHandler = RouteHandler>(
 target: T,
 thisArg: unknown,
 args: Parameters<T>,
 route?: string,
): ReturnType<T> {
 return withIsolationScope(isolationScope => {
 const request = args[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return target.apply(thisArg, args);
 }

 const parsedUrl = parseStringToURLObject(request.url);
 const attributes = getSpanAttributesFromParsedUrl(parsedUrl, request);

 let routeName = parsedUrl?.pathname || '/';
 if (request.params) {
 Object.keys(request.params).forEach(key => {
 attributes[`url.path.parameter.${key}`] = (request.params as Record<string, string>)[key];
 });

 // If a route has parameters, it's a parameterized route
 if (route) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }
 }

 // Handle wildcard routes
 if (route?.endsWith('/*')) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url: request.url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: parsedUrl?.search,
 } satisfies RequestEventData,
 });

 return continueTrace(
 {
 sentryTrace: request.headers.get('sentry-trace') ?? '',
 baggage: request.headers.get('baggage'),
 },
 () =>
 startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routeName}`,
 },
 async span => {
 try {
 const response = (await target.apply(thisArg, args)) as Response | undefined;
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 ),
 );
 });
}

function getSpanAttributesFromParsedUrl(
 parsedUrl: ReturnType<typeof parseStringToURLObject>,
 request: Request,
): SpanAttributes {
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };

 if (parsedUrl) {
 if (parsedUrl.search) {
 attributes['url.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 attributes['url.fragment'] = parsedUrl.hash;
 }
 if (parsedUrl.pathname) {
 attributes['url.path'] = parsedUrl.pathname;
 }
 if (!isURLObjectRelative(parsedUrl)) {
 attributes['url.full'] = parsedUrl.href;
 if (parsedUrl.port) {
 attributes['url.port'] = parsedUrl.port;
 }
 if (parsedUrl.protocol) {
 attributes['url.scheme'] = parsedUrl.protocol;
 }
 if (parsedUrl.hostname) {
 attributes['url.domain'] = parsedUrl.hostname;
 }
 }
 }

 return attributes;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(bun): Support new Bun.serve APIs#16035

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

AbhiPrasad
merged 3 commits into

from

Apr 11, 2025
 Merged


feat(bun): Support new Bun.serve APIs
#16035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
0ec1fab

feat(bun): Support new `Bun.serve` APIs


AbhiPrasad Apr 11, 2025
e6a28c1

add bun-types latest


AbhiPrasad Apr 11, 2025
eebf7ac

remove todo and fix yarn.lock


AbhiPrasad Apr 11, 2025

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


2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
 "@sentry/opentelemetry": "9.12.0"
 },
 "devDependencies": {
 "bun-types": "latest"
 "bun-types": "^1.2.9"
 },
 "scripts": {
 "build": "run-p build:transpile build:types",
Expand Down

294 changes: 223 additions & 71 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
import type { ServeOptions } from 'bun';
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 defineIntegration,
 extractQueryParamsFromUrl,
 getSanitizedUrlString,
 parseUrl,
 isURLObjectRelative,
 setHttpStatus,
 defineIntegration,
 continueTrace,
 startSpan,
 withIsolationScope,
 parseStringToURLObject,
} from '@sentry/core';

const INTEGRATION_NAME = 'BunServer';
Expand All@@ -28,6 +28,8 @@ const _bunServerIntegration = (() => {
/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
 *
 * Does not support instrumenting static routes.
 *
 * Enabled by default in the Bun SDK.
 *
 * ```js
Expand All@@ -40,10 +42,18 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let hasPatchedBunServe = false;

/**
 * Instruments Bun.serve by patching it's options.
 *
 * Only exported for tests.
 */
export function instrumentBunServe(): void {
 if (hasPatchedBunServe) {
 return;
 }

 Bun.serve = new Proxy(Bun.serve, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
Expand All@@ -53,89 +63,231 @@ export function instrumentBunServe(): void {
 // We can't use a Proxy for this as Bun does `instanceof` checks internally that fail if we
 // wrap the Server instance.
 const originalReload: typeof server.reload = server.reload.bind(server);
 server.reload = (serveOptions: Parameters<typeof Bun.serve>[0]) => {
 server.reload = (serveOptions: ServeOptions) => {
 instrumentBunServeOptions(serveOptions);
 return originalReload(serveOptions);
 };

 return server;
 },
 });

 hasPatchedBunServe = true;
}

/**
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 * Instruments Bun.serve options.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 // First handle fetch
 instrumentBunServeOptionFetch(serveOptions);
 // then handle routes
 instrumentBunServeOptionRoutes(serveOptions);
}

/**
 * Instruments the `fetch` option of Bun.serve.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptionFetch(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (typeof serveOptions.fetch !== 'function') {
 return;
 }

 serveOptions.fetch = new Proxy(serveOptions.fetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof serveOptions.fetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(fetchThisArg, fetchArgs);
 }
 return wrapRequestHandler(fetchTarget, fetchThisArg, fetchArgs);
 },
 });
}

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
}
/**
* Instruments the `routes` option of Bun.serve.
*
* @param serveOptions - The options for the Bun.serve function.
*/
function instrumentBunServeOptionRoutes(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (!serveOptions.routes) {
return;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${parsedUrl.path || '/'}`,
 },
 async span => {
 try {
 const response = await (fetchTarget.apply(fetchThisArg, fetchArgs) as ReturnType<
 typeof serveOptions.fetch
 >);
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 if (typeof serveOptions.routes !== 'object') {
 return;
 }

 Object.keys(serveOptions.routes).forEach(route => {
 const routeHandler = serveOptions.routes[route];

 // Handle route handlers that are an object
 if (typeof routeHandler === 'function') {
 serveOptions.routes[route] = new Proxy(routeHandler, {
 apply: (routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs: Parameters<typeof routeHandler>) => {
 return wrapRequestHandler(routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs, route);
 },
 });
 }

 // Static routes are not instrumented
 if (routeHandler instanceof Response) {
 return;
 }

 // Handle the route handlers that are an object. This means they define a route handler for each method.
 if (typeof routeHandler === 'object') {
 Object.entries(routeHandler).forEach(([routeHandlerObjectHandlerKey, routeHandlerObjectHandler]) => {
 if (typeof routeHandlerObjectHandler === 'function') {
 (serveOptions.routes[route] as Record<string, RouteHandler>)[routeHandlerObjectHandlerKey] = new Proxy(
 routeHandlerObjectHandler,
 {
 apply: (
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs: Parameters<typeof routeHandlerObjectHandler>,
 ) => {
 return wrapRequestHandler(
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs,
 route,
 );
 },
);
},
);
},
);
}
 });
 },
 }
 });
}

type RouteHandler = Extract<
 NonNullable<Parameters<typeof Bun.serve>[0]['routes']>[string],
 // eslint-disable-next-line @typescript-eslint/ban-types
 Function
>;

function wrapRequestHandler<T extends RouteHandler = RouteHandler>(
 target: T,
 thisArg: unknown,
 args: Parameters<T>,
 route?: string,
): ReturnType<T> {
 return withIsolationScope(isolationScope => {
 const request = args[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return target.apply(thisArg, args);
 }

 const parsedUrl = parseStringToURLObject(request.url);
 const attributes = getSpanAttributesFromParsedUrl(parsedUrl, request);

 let routeName = parsedUrl?.pathname || '/';
 if (request.params) {
 Object.keys(request.params).forEach(key => {
 attributes[`url.path.parameter.${key}`] = (request.params as Record<string, string>)[key];
 });

 // If a route has parameters, it's a parameterized route
 if (route) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }
 }

 // Handle wildcard routes
 if (route?.endsWith('/*')) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url: request.url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: parsedUrl?.search,
 } satisfies RequestEventData,
 });

 return continueTrace(
 {
 sentryTrace: request.headers.get('sentry-trace') ?? '',
 baggage: request.headers.get('baggage'),
 },
 () =>
 startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routeName}`,
 },
 async span => {
 try {
 const response = (await target.apply(thisArg, args)) as Response | undefined;
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 ),
 );
 });
}

function getSpanAttributesFromParsedUrl(
 parsedUrl: ReturnType<typeof parseStringToURLObject>,
 request: Request,
): SpanAttributes {
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };

 if (parsedUrl) {
 if (parsedUrl.search) {
 attributes['url.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 attributes['url.fragment'] = parsedUrl.hash;
 }
 if (parsedUrl.pathname) {
 attributes['url.path'] = parsedUrl.pathname;
 }
 if (!isURLObjectRelative(parsedUrl)) {
 attributes['url.full'] = parsedUrl.href;
 if (parsedUrl.port) {
 attributes['url.port'] = parsedUrl.port;
 }
 if (parsedUrl.protocol) {
 attributes['url.scheme'] = parsedUrl.protocol;
 }
 if (parsedUrl.hostname) {
 attributes['url.domain'] = parsedUrl.hostname;
 }
 }
 }

 return attributes;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(bun): Support new Bun.serve APIs#16035

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

AbhiPrasad
merged 3 commits into

from

Apr 11, 2025
 Merged


feat(bun): Support new Bun.serve APIs
#16035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
0ec1fab

feat(bun): Support new `Bun.serve` APIs


AbhiPrasad Apr 11, 2025
e6a28c1

add bun-types latest


AbhiPrasad Apr 11, 2025
eebf7ac

remove todo and fix yarn.lock


AbhiPrasad Apr 11, 2025

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


2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
 "@sentry/opentelemetry": "9.12.0"
 },
 "devDependencies": {
 "bun-types": "latest"
 "bun-types": "^1.2.9"
 },
 "scripts": {
 "build": "run-p build:transpile build:types",
Expand Down

294 changes: 223 additions & 71 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
import type { ServeOptions } from 'bun';
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 defineIntegration,
 extractQueryParamsFromUrl,
 getSanitizedUrlString,
 parseUrl,
 isURLObjectRelative,
 setHttpStatus,
 defineIntegration,
 continueTrace,
 startSpan,
 withIsolationScope,
 parseStringToURLObject,
} from '@sentry/core';

const INTEGRATION_NAME = 'BunServer';
Expand All@@ -28,6 +28,8 @@ const _bunServerIntegration = (() => {
/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
 *
 * Does not support instrumenting static routes.
 *
 * Enabled by default in the Bun SDK.
 *
 * ```js
Expand All@@ -40,10 +42,18 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let hasPatchedBunServe = false;

/**
 * Instruments Bun.serve by patching it's options.
 *
 * Only exported for tests.
 */
export function instrumentBunServe(): void {
 if (hasPatchedBunServe) {
 return;
 }

 Bun.serve = new Proxy(Bun.serve, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
Expand All@@ -53,89 +63,231 @@ export function instrumentBunServe(): void {
 // We can't use a Proxy for this as Bun does `instanceof` checks internally that fail if we
 // wrap the Server instance.
 const originalReload: typeof server.reload = server.reload.bind(server);
 server.reload = (serveOptions: Parameters<typeof Bun.serve>[0]) => {
 server.reload = (serveOptions: ServeOptions) => {
 instrumentBunServeOptions(serveOptions);
 return originalReload(serveOptions);
 };

 return server;
 },
 });

 hasPatchedBunServe = true;
}

/**
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 * Instruments Bun.serve options.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 // First handle fetch
 instrumentBunServeOptionFetch(serveOptions);
 // then handle routes
 instrumentBunServeOptionRoutes(serveOptions);
}

/**
 * Instruments the `fetch` option of Bun.serve.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptionFetch(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (typeof serveOptions.fetch !== 'function') {
 return;
 }

 serveOptions.fetch = new Proxy(serveOptions.fetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof serveOptions.fetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(fetchThisArg, fetchArgs);
 }
 return wrapRequestHandler(fetchTarget, fetchThisArg, fetchArgs);
 },
 });
}

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
}
/**
* Instruments the `routes` option of Bun.serve.
*
* @param serveOptions - The options for the Bun.serve function.
*/
function instrumentBunServeOptionRoutes(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (!serveOptions.routes) {
return;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${parsedUrl.path || '/'}`,
 },
 async span => {
 try {
 const response = await (fetchTarget.apply(fetchThisArg, fetchArgs) as ReturnType<
 typeof serveOptions.fetch
 >);
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 if (typeof serveOptions.routes !== 'object') {
 return;
 }

 Object.keys(serveOptions.routes).forEach(route => {
 const routeHandler = serveOptions.routes[route];

 // Handle route handlers that are an object
 if (typeof routeHandler === 'function') {
 serveOptions.routes[route] = new Proxy(routeHandler, {
 apply: (routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs: Parameters<typeof routeHandler>) => {
 return wrapRequestHandler(routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs, route);
 },
 });
 }

 // Static routes are not instrumented
 if (routeHandler instanceof Response) {
 return;
 }

 // Handle the route handlers that are an object. This means they define a route handler for each method.
 if (typeof routeHandler === 'object') {
 Object.entries(routeHandler).forEach(([routeHandlerObjectHandlerKey, routeHandlerObjectHandler]) => {
 if (typeof routeHandlerObjectHandler === 'function') {
 (serveOptions.routes[route] as Record<string, RouteHandler>)[routeHandlerObjectHandlerKey] = new Proxy(
 routeHandlerObjectHandler,
 {
 apply: (
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs: Parameters<typeof routeHandlerObjectHandler>,
 ) => {
 return wrapRequestHandler(
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs,
 route,
 );
 },
);
},
);
},
);
}
 });
 },
 }
 });
}

type RouteHandler = Extract<
 NonNullable<Parameters<typeof Bun.serve>[0]['routes']>[string],
 // eslint-disable-next-line @typescript-eslint/ban-types
 Function
>;

function wrapRequestHandler<T extends RouteHandler = RouteHandler>(
 target: T,
 thisArg: unknown,
 args: Parameters<T>,
 route?: string,
): ReturnType<T> {
 return withIsolationScope(isolationScope => {
 const request = args[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return target.apply(thisArg, args);
 }

 const parsedUrl = parseStringToURLObject(request.url);
 const attributes = getSpanAttributesFromParsedUrl(parsedUrl, request);

 let routeName = parsedUrl?.pathname || '/';
 if (request.params) {
 Object.keys(request.params).forEach(key => {
 attributes[`url.path.parameter.${key}`] = (request.params as Record<string, string>)[key];
 });

 // If a route has parameters, it's a parameterized route
 if (route) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }
 }

 // Handle wildcard routes
 if (route?.endsWith('/*')) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url: request.url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: parsedUrl?.search,
 } satisfies RequestEventData,
 });

 return continueTrace(
 {
 sentryTrace: request.headers.get('sentry-trace') ?? '',
 baggage: request.headers.get('baggage'),
 },
 () =>
 startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routeName}`,
 },
 async span => {
 try {
 const response = (await target.apply(thisArg, args)) as Response | undefined;
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 ),
 );
 });
}

function getSpanAttributesFromParsedUrl(
 parsedUrl: ReturnType<typeof parseStringToURLObject>,
 request: Request,
): SpanAttributes {
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };

 if (parsedUrl) {
 if (parsedUrl.search) {
 attributes['url.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 attributes['url.fragment'] = parsedUrl.hash;
 }
 if (parsedUrl.pathname) {
 attributes['url.path'] = parsedUrl.pathname;
 }
 if (!isURLObjectRelative(parsedUrl)) {
 attributes['url.full'] = parsedUrl.href;
 if (parsedUrl.port) {
 attributes['url.port'] = parsedUrl.port;
 }
 if (parsedUrl.protocol) {
 attributes['url.scheme'] = parsedUrl.protocol;
 }
 if (parsedUrl.hostname) {
 attributes['url.domain'] = parsedUrl.hostname;
 }
 }
 }

 return attributes;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(bun): Support new Bun.serve APIs#16035

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

AbhiPrasad
merged 3 commits into

from

Apr 11, 2025
 Merged


feat(bun): Support new Bun.serve APIs
#16035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
0ec1fab

feat(bun): Support new `Bun.serve` APIs


AbhiPrasad Apr 11, 2025
e6a28c1

add bun-types latest


AbhiPrasad Apr 11, 2025
eebf7ac

remove todo and fix yarn.lock


AbhiPrasad Apr 11, 2025

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


2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
 "@sentry/opentelemetry": "9.12.0"
 },
 "devDependencies": {
 "bun-types": "latest"
 "bun-types": "^1.2.9"
 },
 "scripts": {
 "build": "run-p build:transpile build:types",
Expand Down

294 changes: 223 additions & 71 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
import type { ServeOptions } from 'bun';
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 defineIntegration,
 extractQueryParamsFromUrl,
 getSanitizedUrlString,
 parseUrl,
 isURLObjectRelative,
 setHttpStatus,
 defineIntegration,
 continueTrace,
 startSpan,
 withIsolationScope,
 parseStringToURLObject,
} from '@sentry/core';

const INTEGRATION_NAME = 'BunServer';
Expand All@@ -28,6 +28,8 @@ const _bunServerIntegration = (() => {
/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
 *
 * Does not support instrumenting static routes.
 *
 * Enabled by default in the Bun SDK.
 *
 * ```js
Expand All@@ -40,10 +42,18 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let hasPatchedBunServe = false;

/**
 * Instruments Bun.serve by patching it's options.
 *
 * Only exported for tests.
 */
export function instrumentBunServe(): void {
 if (hasPatchedBunServe) {
 return;
 }

 Bun.serve = new Proxy(Bun.serve, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
Expand All@@ -53,89 +63,231 @@ export function instrumentBunServe(): void {
 // We can't use a Proxy for this as Bun does `instanceof` checks internally that fail if we
 // wrap the Server instance.
 const originalReload: typeof server.reload = server.reload.bind(server);
 server.reload = (serveOptions: Parameters<typeof Bun.serve>[0]) => {
 server.reload = (serveOptions: ServeOptions) => {
 instrumentBunServeOptions(serveOptions);
 return originalReload(serveOptions);
 };

 return server;
 },
 });

 hasPatchedBunServe = true;
}

/**
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 * Instruments Bun.serve options.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 // First handle fetch
 instrumentBunServeOptionFetch(serveOptions);
 // then handle routes
 instrumentBunServeOptionRoutes(serveOptions);
}

/**
 * Instruments the `fetch` option of Bun.serve.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptionFetch(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (typeof serveOptions.fetch !== 'function') {
 return;
 }

 serveOptions.fetch = new Proxy(serveOptions.fetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof serveOptions.fetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(fetchThisArg, fetchArgs);
 }
 return wrapRequestHandler(fetchTarget, fetchThisArg, fetchArgs);
 },
 });
}

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
}
/**
* Instruments the `routes` option of Bun.serve.
*
* @param serveOptions - The options for the Bun.serve function.
*/
function instrumentBunServeOptionRoutes(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (!serveOptions.routes) {
return;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${parsedUrl.path || '/'}`,
 },
 async span => {
 try {
 const response = await (fetchTarget.apply(fetchThisArg, fetchArgs) as ReturnType<
 typeof serveOptions.fetch
 >);
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 if (typeof serveOptions.routes !== 'object') {
 return;
 }

 Object.keys(serveOptions.routes).forEach(route => {
 const routeHandler = serveOptions.routes[route];

 // Handle route handlers that are an object
 if (typeof routeHandler === 'function') {
 serveOptions.routes[route] = new Proxy(routeHandler, {
 apply: (routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs: Parameters<typeof routeHandler>) => {
 return wrapRequestHandler(routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs, route);
 },
 });
 }

 // Static routes are not instrumented
 if (routeHandler instanceof Response) {
 return;
 }

 // Handle the route handlers that are an object. This means they define a route handler for each method.
 if (typeof routeHandler === 'object') {
 Object.entries(routeHandler).forEach(([routeHandlerObjectHandlerKey, routeHandlerObjectHandler]) => {
 if (typeof routeHandlerObjectHandler === 'function') {
 (serveOptions.routes[route] as Record<string, RouteHandler>)[routeHandlerObjectHandlerKey] = new Proxy(
 routeHandlerObjectHandler,
 {
 apply: (
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs: Parameters<typeof routeHandlerObjectHandler>,
 ) => {
 return wrapRequestHandler(
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs,
 route,
 );
 },
);
},
);
},
);
}
 });
 },
 }
 });
}

type RouteHandler = Extract<
 NonNullable<Parameters<typeof Bun.serve>[0]['routes']>[string],
 // eslint-disable-next-line @typescript-eslint/ban-types
 Function
>;

function wrapRequestHandler<T extends RouteHandler = RouteHandler>(
 target: T,
 thisArg: unknown,
 args: Parameters<T>,
 route?: string,
): ReturnType<T> {
 return withIsolationScope(isolationScope => {
 const request = args[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return target.apply(thisArg, args);
 }

 const parsedUrl = parseStringToURLObject(request.url);
 const attributes = getSpanAttributesFromParsedUrl(parsedUrl, request);

 let routeName = parsedUrl?.pathname || '/';
 if (request.params) {
 Object.keys(request.params).forEach(key => {
 attributes[`url.path.parameter.${key}`] = (request.params as Record<string, string>)[key];
 });

 // If a route has parameters, it's a parameterized route
 if (route) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }
 }

 // Handle wildcard routes
 if (route?.endsWith('/*')) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url: request.url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: parsedUrl?.search,
 } satisfies RequestEventData,
 });

 return continueTrace(
 {
 sentryTrace: request.headers.get('sentry-trace') ?? '',
 baggage: request.headers.get('baggage'),
 },
 () =>
 startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routeName}`,
 },
 async span => {
 try {
 const response = (await target.apply(thisArg, args)) as Response | undefined;
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 ),
 );
 });
}

function getSpanAttributesFromParsedUrl(
 parsedUrl: ReturnType<typeof parseStringToURLObject>,
 request: Request,
): SpanAttributes {
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };

 if (parsedUrl) {
 if (parsedUrl.search) {
 attributes['url.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 attributes['url.fragment'] = parsedUrl.hash;
 }
 if (parsedUrl.pathname) {
 attributes['url.path'] = parsedUrl.pathname;
 }
 if (!isURLObjectRelative(parsedUrl)) {
 attributes['url.full'] = parsedUrl.href;
 if (parsedUrl.port) {
 attributes['url.port'] = parsedUrl.port;
 }
 if (parsedUrl.protocol) {
 attributes['url.scheme'] = parsedUrl.protocol;
 }
 if (parsedUrl.hostname) {
 attributes['url.domain'] = parsedUrl.hostname;
 }
 }
 }

 return attributes;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(bun): Support new Bun.serve APIs#16035

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

AbhiPrasad
merged 3 commits into

from

Apr 11, 2025
 Merged


feat(bun): Support new Bun.serve APIs
#16035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
0ec1fab

feat(bun): Support new `Bun.serve` APIs


AbhiPrasad Apr 11, 2025
e6a28c1

add bun-types latest


AbhiPrasad Apr 11, 2025
eebf7ac

remove todo and fix yarn.lock


AbhiPrasad Apr 11, 2025

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


2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
 "@sentry/opentelemetry": "9.12.0"
 },
 "devDependencies": {
 "bun-types": "latest"
 "bun-types": "^1.2.9"
 },
 "scripts": {
 "build": "run-p build:transpile build:types",
Expand Down

294 changes: 223 additions & 71 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
import type { ServeOptions } from 'bun';
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 defineIntegration,
 extractQueryParamsFromUrl,
 getSanitizedUrlString,
 parseUrl,
 isURLObjectRelative,
 setHttpStatus,
 defineIntegration,
 continueTrace,
 startSpan,
 withIsolationScope,
 parseStringToURLObject,
} from '@sentry/core';

const INTEGRATION_NAME = 'BunServer';
Expand All@@ -28,6 +28,8 @@ const _bunServerIntegration = (() => {
/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
 *
 * Does not support instrumenting static routes.
 *
 * Enabled by default in the Bun SDK.
 *
 * ```js
Expand All@@ -40,10 +42,18 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let hasPatchedBunServe = false;

/**
 * Instruments Bun.serve by patching it's options.
 *
 * Only exported for tests.
 */
export function instrumentBunServe(): void {
 if (hasPatchedBunServe) {
 return;
 }

 Bun.serve = new Proxy(Bun.serve, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
Expand All@@ -53,89 +63,231 @@ export function instrumentBunServe(): void {
 // We can't use a Proxy for this as Bun does `instanceof` checks internally that fail if we
 // wrap the Server instance.
 const originalReload: typeof server.reload = server.reload.bind(server);
 server.reload = (serveOptions: Parameters<typeof Bun.serve>[0]) => {
 server.reload = (serveOptions: ServeOptions) => {
 instrumentBunServeOptions(serveOptions);
 return originalReload(serveOptions);
 };

 return server;
 },
 });

 hasPatchedBunServe = true;
}

/**
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 * Instruments Bun.serve options.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 // First handle fetch
 instrumentBunServeOptionFetch(serveOptions);
 // then handle routes
 instrumentBunServeOptionRoutes(serveOptions);
}

/**
 * Instruments the `fetch` option of Bun.serve.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptionFetch(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (typeof serveOptions.fetch !== 'function') {
 return;
 }

 serveOptions.fetch = new Proxy(serveOptions.fetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof serveOptions.fetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(fetchThisArg, fetchArgs);
 }
 return wrapRequestHandler(fetchTarget, fetchThisArg, fetchArgs);
 },
 });
}

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
}
/**
* Instruments the `routes` option of Bun.serve.
*
* @param serveOptions - The options for the Bun.serve function.
*/
function instrumentBunServeOptionRoutes(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (!serveOptions.routes) {
return;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${parsedUrl.path || '/'}`,
 },
 async span => {
 try {
 const response = await (fetchTarget.apply(fetchThisArg, fetchArgs) as ReturnType<
 typeof serveOptions.fetch
 >);
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 if (typeof serveOptions.routes !== 'object') {
 return;
 }

 Object.keys(serveOptions.routes).forEach(route => {
 const routeHandler = serveOptions.routes[route];

 // Handle route handlers that are an object
 if (typeof routeHandler === 'function') {
 serveOptions.routes[route] = new Proxy(routeHandler, {
 apply: (routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs: Parameters<typeof routeHandler>) => {
 return wrapRequestHandler(routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs, route);
 },
 });
 }

 // Static routes are not instrumented
 if (routeHandler instanceof Response) {
 return;
 }

 // Handle the route handlers that are an object. This means they define a route handler for each method.
 if (typeof routeHandler === 'object') {
 Object.entries(routeHandler).forEach(([routeHandlerObjectHandlerKey, routeHandlerObjectHandler]) => {
 if (typeof routeHandlerObjectHandler === 'function') {
 (serveOptions.routes[route] as Record<string, RouteHandler>)[routeHandlerObjectHandlerKey] = new Proxy(
 routeHandlerObjectHandler,
 {
 apply: (
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs: Parameters<typeof routeHandlerObjectHandler>,
 ) => {
 return wrapRequestHandler(
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs,
 route,
 );
 },
);
},
);
},
);
}
 });
 },
 }
 });
}

type RouteHandler = Extract<
 NonNullable<Parameters<typeof Bun.serve>[0]['routes']>[string],
 // eslint-disable-next-line @typescript-eslint/ban-types
 Function
>;

function wrapRequestHandler<T extends RouteHandler = RouteHandler>(
 target: T,
 thisArg: unknown,
 args: Parameters<T>,
 route?: string,
): ReturnType<T> {
 return withIsolationScope(isolationScope => {
 const request = args[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return target.apply(thisArg, args);
 }

 const parsedUrl = parseStringToURLObject(request.url);
 const attributes = getSpanAttributesFromParsedUrl(parsedUrl, request);

 let routeName = parsedUrl?.pathname || '/';
 if (request.params) {
 Object.keys(request.params).forEach(key => {
 attributes[`url.path.parameter.${key}`] = (request.params as Record<string, string>)[key];
 });

 // If a route has parameters, it's a parameterized route
 if (route) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }
 }

 // Handle wildcard routes
 if (route?.endsWith('/*')) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url: request.url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: parsedUrl?.search,
 } satisfies RequestEventData,
 });

 return continueTrace(
 {
 sentryTrace: request.headers.get('sentry-trace') ?? '',
 baggage: request.headers.get('baggage'),
 },
 () =>
 startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routeName}`,
 },
 async span => {
 try {
 const response = (await target.apply(thisArg, args)) as Response | undefined;
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 ),
 );
 });
}

function getSpanAttributesFromParsedUrl(
 parsedUrl: ReturnType<typeof parseStringToURLObject>,
 request: Request,
): SpanAttributes {
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };

 if (parsedUrl) {
 if (parsedUrl.search) {
 attributes['url.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 attributes['url.fragment'] = parsedUrl.hash;
 }
 if (parsedUrl.pathname) {
 attributes['url.path'] = parsedUrl.pathname;
 }
 if (!isURLObjectRelative(parsedUrl)) {
 attributes['url.full'] = parsedUrl.href;
 if (parsedUrl.port) {
 attributes['url.port'] = parsedUrl.port;
 }
 if (parsedUrl.protocol) {
 attributes['url.scheme'] = parsedUrl.protocol;
 }
 if (parsedUrl.hostname) {
 attributes['url.domain'] = parsedUrl.hostname;
 }
 }
 }

 return attributes;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(bun): Support new Bun.serve APIs#16035

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

AbhiPrasad
merged 3 commits into

from

Apr 11, 2025
 Merged


feat(bun): Support new Bun.serve APIs
#16035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
0ec1fab

feat(bun): Support new `Bun.serve` APIs


AbhiPrasad Apr 11, 2025
e6a28c1

add bun-types latest


AbhiPrasad Apr 11, 2025
eebf7ac

remove todo and fix yarn.lock


AbhiPrasad Apr 11, 2025

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


2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
 "@sentry/opentelemetry": "9.12.0"
 },
 "devDependencies": {
 "bun-types": "latest"
 "bun-types": "^1.2.9"
 },
 "scripts": {
 "build": "run-p build:transpile build:types",
Expand Down

294 changes: 223 additions & 71 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
import type { ServeOptions } from 'bun';
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 defineIntegration,
 extractQueryParamsFromUrl,
 getSanitizedUrlString,
 parseUrl,
 isURLObjectRelative,
 setHttpStatus,
 defineIntegration,
 continueTrace,
 startSpan,
 withIsolationScope,
 parseStringToURLObject,
} from '@sentry/core';

const INTEGRATION_NAME = 'BunServer';
Expand All@@ -28,6 +28,8 @@ const _bunServerIntegration = (() => {
/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
 *
 * Does not support instrumenting static routes.
 *
 * Enabled by default in the Bun SDK.
 *
 * ```js
Expand All@@ -40,10 +42,18 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let hasPatchedBunServe = false;

/**
 * Instruments Bun.serve by patching it's options.
 *
 * Only exported for tests.
 */
export function instrumentBunServe(): void {
 if (hasPatchedBunServe) {
 return;
 }

 Bun.serve = new Proxy(Bun.serve, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
Expand All@@ -53,89 +63,231 @@ export function instrumentBunServe(): void {
 // We can't use a Proxy for this as Bun does `instanceof` checks internally that fail if we
 // wrap the Server instance.
 const originalReload: typeof server.reload = server.reload.bind(server);
 server.reload = (serveOptions: Parameters<typeof Bun.serve>[0]) => {
 server.reload = (serveOptions: ServeOptions) => {
 instrumentBunServeOptions(serveOptions);
 return originalReload(serveOptions);
 };

 return server;
 },
 });

 hasPatchedBunServe = true;
}

/**
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 * Instruments Bun.serve options.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 // First handle fetch
 instrumentBunServeOptionFetch(serveOptions);
 // then handle routes
 instrumentBunServeOptionRoutes(serveOptions);
}

/**
 * Instruments the `fetch` option of Bun.serve.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptionFetch(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (typeof serveOptions.fetch !== 'function') {
 return;
 }

 serveOptions.fetch = new Proxy(serveOptions.fetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof serveOptions.fetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(fetchThisArg, fetchArgs);
 }
 return wrapRequestHandler(fetchTarget, fetchThisArg, fetchArgs);
 },
 });
}

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
}
/**
* Instruments the `routes` option of Bun.serve.
*
* @param serveOptions - The options for the Bun.serve function.
*/
function instrumentBunServeOptionRoutes(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (!serveOptions.routes) {
return;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${parsedUrl.path || '/'}`,
 },
 async span => {
 try {
 const response = await (fetchTarget.apply(fetchThisArg, fetchArgs) as ReturnType<
 typeof serveOptions.fetch
 >);
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 if (typeof serveOptions.routes !== 'object') {
 return;
 }

 Object.keys(serveOptions.routes).forEach(route => {
 const routeHandler = serveOptions.routes[route];

 // Handle route handlers that are an object
 if (typeof routeHandler === 'function') {
 serveOptions.routes[route] = new Proxy(routeHandler, {
 apply: (routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs: Parameters<typeof routeHandler>) => {
 return wrapRequestHandler(routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs, route);
 },
 });
 }

 // Static routes are not instrumented
 if (routeHandler instanceof Response) {
 return;
 }

 // Handle the route handlers that are an object. This means they define a route handler for each method.
 if (typeof routeHandler === 'object') {
 Object.entries(routeHandler).forEach(([routeHandlerObjectHandlerKey, routeHandlerObjectHandler]) => {
 if (typeof routeHandlerObjectHandler === 'function') {
 (serveOptions.routes[route] as Record<string, RouteHandler>)[routeHandlerObjectHandlerKey] = new Proxy(
 routeHandlerObjectHandler,
 {
 apply: (
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs: Parameters<typeof routeHandlerObjectHandler>,
 ) => {
 return wrapRequestHandler(
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs,
 route,
 );
 },
);
},
);
},
);
}
 });
 },
 }
 });
}

type RouteHandler = Extract<
 NonNullable<Parameters<typeof Bun.serve>[0]['routes']>[string],
 // eslint-disable-next-line @typescript-eslint/ban-types
 Function
>;

function wrapRequestHandler<T extends RouteHandler = RouteHandler>(
 target: T,
 thisArg: unknown,
 args: Parameters<T>,
 route?: string,
): ReturnType<T> {
 return withIsolationScope(isolationScope => {
 const request = args[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return target.apply(thisArg, args);
 }

 const parsedUrl = parseStringToURLObject(request.url);
 const attributes = getSpanAttributesFromParsedUrl(parsedUrl, request);

 let routeName = parsedUrl?.pathname || '/';
 if (request.params) {
 Object.keys(request.params).forEach(key => {
 attributes[`url.path.parameter.${key}`] = (request.params as Record<string, string>)[key];
 });

 // If a route has parameters, it's a parameterized route
 if (route) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }
 }

 // Handle wildcard routes
 if (route?.endsWith('/*')) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url: request.url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: parsedUrl?.search,
 } satisfies RequestEventData,
 });

 return continueTrace(
 {
 sentryTrace: request.headers.get('sentry-trace') ?? '',
 baggage: request.headers.get('baggage'),
 },
 () =>
 startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routeName}`,
 },
 async span => {
 try {
 const response = (await target.apply(thisArg, args)) as Response | undefined;
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 ),
 );
 });
}

function getSpanAttributesFromParsedUrl(
 parsedUrl: ReturnType<typeof parseStringToURLObject>,
 request: Request,
): SpanAttributes {
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };

 if (parsedUrl) {
 if (parsedUrl.search) {
 attributes['url.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 attributes['url.fragment'] = parsedUrl.hash;
 }
 if (parsedUrl.pathname) {
 attributes['url.path'] = parsedUrl.pathname;
 }
 if (!isURLObjectRelative(parsedUrl)) {
 attributes['url.full'] = parsedUrl.href;
 if (parsedUrl.port) {
 attributes['url.port'] = parsedUrl.port;
 }
 if (parsedUrl.protocol) {
 attributes['url.scheme'] = parsedUrl.protocol;
 }
 if (parsedUrl.hostname) {
 attributes['url.domain'] = parsedUrl.hostname;
 }
 }
 }

 return attributes;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(bun): Support new Bun.serve APIs#16035

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

AbhiPrasad
merged 3 commits into

from

Apr 11, 2025
 Merged


feat(bun): Support new Bun.serve APIs
#16035
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
0ec1fab

feat(bun): Support new `Bun.serve` APIs


AbhiPrasad Apr 11, 2025
e6a28c1

add bun-types latest


AbhiPrasad Apr 11, 2025
eebf7ac

remove todo and fix yarn.lock


AbhiPrasad Apr 11, 2025

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


2 changes: 1 addition & 1 deletion
packages/bun/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,7 +44,7 @@
 "@sentry/opentelemetry": "9.12.0"
 },
 "devDependencies": {
 "bun-types": "latest"
 "bun-types": "^1.2.9"
 },
 "scripts": {
 "build": "run-p build:transpile build:types",
Expand Down

294 changes: 223 additions & 71 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
import type { ServeOptions } from 'bun';
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
 captureException,
 continueTrace,
 defineIntegration,
 extractQueryParamsFromUrl,
 getSanitizedUrlString,
 parseUrl,
 isURLObjectRelative,
 setHttpStatus,
 defineIntegration,
 continueTrace,
 startSpan,
 withIsolationScope,
 parseStringToURLObject,
} from '@sentry/core';

const INTEGRATION_NAME = 'BunServer';
Expand All@@ -28,6 +28,8 @@ const _bunServerIntegration = (() => {
/**
 * Instruments `Bun.serve` to automatically create transactions and capture errors.
 *
 * Does not support instrumenting static routes.
 *
 * Enabled by default in the Bun SDK.
 *
 * ```js
Expand All@@ -40,10 +42,18 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let hasPatchedBunServe = false;

/**
 * Instruments Bun.serve by patching it's options.
 *
 * Only exported for tests.
 */
export function instrumentBunServe(): void {
 if (hasPatchedBunServe) {
 return;
 }

 Bun.serve = new Proxy(Bun.serve, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
Expand All@@ -53,89 +63,231 @@ export function instrumentBunServe(): void {
 // We can't use a Proxy for this as Bun does `instanceof` checks internally that fail if we
 // wrap the Server instance.
 const originalReload: typeof server.reload = server.reload.bind(server);
 server.reload = (serveOptions: Parameters<typeof Bun.serve>[0]) => {
 server.reload = (serveOptions: ServeOptions) => {
 instrumentBunServeOptions(serveOptions);
 return originalReload(serveOptions);
 };

 return server;
 },
 });

 hasPatchedBunServe = true;
}

/**
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 * Instruments Bun.serve options.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 // First handle fetch
 instrumentBunServeOptionFetch(serveOptions);
 // then handle routes
 instrumentBunServeOptionRoutes(serveOptions);
}

/**
 * Instruments the `fetch` option of Bun.serve.
 *
 * @param serveOptions - The options for the Bun.serve function.
 */
function instrumentBunServeOptionFetch(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (typeof serveOptions.fetch !== 'function') {
 return;
 }

 serveOptions.fetch = new Proxy(serveOptions.fetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof serveOptions.fetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(fetchThisArg, fetchArgs);
 }
 return wrapRequestHandler(fetchTarget, fetchThisArg, fetchArgs);
 },
 });
}

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
}
/**
* Instruments the `routes` option of Bun.serve.
*
* @param serveOptions - The options for the Bun.serve function.
*/
function instrumentBunServeOptionRoutes(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 if (!serveOptions.routes) {
return;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${parsedUrl.path || '/'}`,
 },
 async span => {
 try {
 const response = await (fetchTarget.apply(fetchThisArg, fetchArgs) as ReturnType<
 typeof serveOptions.fetch
 >);
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 if (typeof serveOptions.routes !== 'object') {
 return;
 }

 Object.keys(serveOptions.routes).forEach(route => {
 const routeHandler = serveOptions.routes[route];

 // Handle route handlers that are an object
 if (typeof routeHandler === 'function') {
 serveOptions.routes[route] = new Proxy(routeHandler, {
 apply: (routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs: Parameters<typeof routeHandler>) => {
 return wrapRequestHandler(routeHandlerTarget, routeHandlerThisArg, routeHandlerArgs, route);
 },
 });
 }

 // Static routes are not instrumented
 if (routeHandler instanceof Response) {
 return;
 }

 // Handle the route handlers that are an object. This means they define a route handler for each method.
 if (typeof routeHandler === 'object') {
 Object.entries(routeHandler).forEach(([routeHandlerObjectHandlerKey, routeHandlerObjectHandler]) => {
 if (typeof routeHandlerObjectHandler === 'function') {
 (serveOptions.routes[route] as Record<string, RouteHandler>)[routeHandlerObjectHandlerKey] = new Proxy(
 routeHandlerObjectHandler,
 {
 apply: (
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs: Parameters<typeof routeHandlerObjectHandler>,
 ) => {
 return wrapRequestHandler(
 routeHandlerObjectHandlerTarget,
 routeHandlerObjectHandlerThisArg,
 routeHandlerObjectHandlerArgs,
 route,
 );
 },
);
},
);
},
);
}
 });
 },
 }
 });
}

type RouteHandler = Extract<
 NonNullable<Parameters<typeof Bun.serve>[0]['routes']>[string],
 // eslint-disable-next-line @typescript-eslint/ban-types
 Function
>;

function wrapRequestHandler<T extends RouteHandler = RouteHandler>(
 target: T,
 thisArg: unknown,
 args: Parameters<T>,
 route?: string,
): ReturnType<T> {
 return withIsolationScope(isolationScope => {
 const request = args[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return target.apply(thisArg, args);
 }

 const parsedUrl = parseStringToURLObject(request.url);
 const attributes = getSpanAttributesFromParsedUrl(parsedUrl, request);

 let routeName = parsedUrl?.pathname || '/';
 if (request.params) {
 Object.keys(request.params).forEach(key => {
 attributes[`url.path.parameter.${key}`] = (request.params as Record<string, string>)[key];
 });

 // If a route has parameters, it's a parameterized route
 if (route) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }
 }

 // Handle wildcard routes
 if (route?.endsWith('/*')) {
 attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
 attributes['url.template'] = route;
 routeName = route;
 }

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url: request.url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: parsedUrl?.search,
 } satisfies RequestEventData,
 });

 return continueTrace(
 {
 sentryTrace: request.headers.get('sentry-trace') ?? '',
 baggage: request.headers.get('baggage'),
 },
 () =>
 startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routeName}`,
 },
 async span => {
 try {
 const response = (await target.apply(thisArg, args)) as Response | undefined;
 if (response?.status) {
 setHttpStatus(span, response.status);
 isolationScope.setContext('response', {
 headers: response.headers.toJSON(),
 status_code: response.status,
 });
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 ),
 );
 });
}

function getSpanAttributesFromParsedUrl(
 parsedUrl: ReturnType<typeof parseStringToURLObject>,
 request: Request,
): SpanAttributes {
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };

 if (parsedUrl) {
 if (parsedUrl.search) {
 attributes['url.query'] = parsedUrl.search;
 }
 if (parsedUrl.hash) {
 attributes['url.fragment'] = parsedUrl.hash;
 }
 if (parsedUrl.pathname) {
 attributes['url.path'] = parsedUrl.pathname;
 }
 if (!isURLObjectRelative(parsedUrl)) {
 attributes['url.full'] = parsedUrl.href;
 if (parsedUrl.port) {
 attributes['url.port'] = parsedUrl.port;
 }
 if (parsedUrl.protocol) {
 attributes['url.scheme'] = parsedUrl.protocol;
 }
 if (parsedUrl.hostname) {
 attributes['url.domain'] = parsedUrl.hostname;
 }
 }
 }

 return attributes;
}
Loading