feat(bun): Update Bun integration to support routes & optional fetch#15978

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

Closed
Jarred-Sumner wants to merge 1 commit into from
Closed

feat(bun): Update Bun integration to support routes & optional fetch #15978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
345 changes: 281 additions & 64 deletions packages/bun/src/integrations/bunserver.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import type { BunRequest, ServeOptions } from 'bun';
import {
SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
Expand DownExpand Up@@ -40,11 +41,17 @@ const _bunServerIntegration = (() => {
*/
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let originalServe: typeof Bun.serve;

/**
* Instruments Bun.serve by patching it's options.
*/
export function instrumentBunServe(): void {
Bun.serve = new Proxy(Bun.serve, {
if (!originalServe) {
originalServe = Bun.serve;
}

Bun.serve = new Proxy(originalServe, {
apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
instrumentBunServeOptions(serveArgs[0]);
const server: ReturnType<typeof Bun.serve> = serveTarget.apply(serveThisArg, serveArgs);
Expand All@@ -53,7 +60,7 @@ 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);
};
Expand All@@ -67,75 +74,285 @@ export function instrumentBunServe(): void {
* Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
*/
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
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);
}
const originalFetch: typeof serveOptions.fetch = serveOptions?.fetch;
// Instrument the fetch handler
if (typeof originalFetch === 'function') {
serveOptions.fetch = new Proxy(originalFetch, {
apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof originalFetch>) {
return withIsolationScope(isolationScope => {
const request = fetchArgs[0];
const upperCaseMethod = request.method.toUpperCase();
if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
return fetchTarget.apply(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;
}
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;
}

const url = getSanitizedUrlString(parsedUrl);
const url = getSanitizedUrlString(parsedUrl);

isolationScope.setSDKProcessingMetadata({
normalizedRequest: {
url,
method: request.method,
headers: request.headers.toJSON(),
query_string: extractQueryParamsFromUrl(url),
} satisfies RequestEventData,
});
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 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 originalFetch
>);
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;
}
return response;
} catch (e) {
captureException(e, {
mechanism: {
type: 'bun',
handled: false,
data: {
function: 'serve',
},
},
});
throw e;
}
},
);
},
);
});
},
});
}

// Instrument routes if present
if (
(typeof serveOptions?.routes === 'object' || typeof serveOptions?.routes === 'function') &&
// Hono routes. This was an issue in Bun.
!Array.isArray(serveOptions?.routes)
) {
serveOptions.routes = instrumentBunServeRoutes(serveOptions.routes) as typeof serveOptions.routes;
}
}

/**
* Instruments the routes option in Bun.serve()
*/
function instrumentBunServeRoutes(
routes: NonNullable<Parameters<typeof Bun.serve>[0]['routes']>,
): Parameters<typeof Bun.serve>[0]['routes'] {
let anyMatches = false;
const instrumentedRoutes: Parameters<typeof Bun.serve>[0]['routes'] = {};

for (const [routePath, handler] of Object.entries(routes)) {
if (handler === null || handler === undefined || !routePath.startsWith('/')) {
instrumentedRoutes[routePath] = handler;
continue;
}

// Case 2: Route handler function
if (typeof handler === 'function') {
anyMatches = true;
instrumentedRoutes[routePath] = new Proxy(handler, {
apply(handlerTarget, handlerThisArg, handlerArgs) {
return withIsolationScope(isolationScope => {
const request = handlerArgs[0] as BunRequest;
const upperCaseMethod = request.method.toUpperCase();
if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
return handlerTarget.apply(handlerThisArg, handlerArgs);
}

const parsedUrl = parseUrl(request.url);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route',
[SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
};
if (parsedUrl.search) {
attributes['http.query'] = parsedUrl.search;
}

const url = getSanitizedUrlString(parsedUrl);

isolationScope.setSDKProcessingMetadata({
normalizedRequest: {
url,
method: request.method,
headers: request.headers.toJSON(),
query_string: extractQueryParamsFromUrl(url),
// For routes with parameters, add them to request data
...(request.params ? { params: request.params } : {}),
} satisfies RequestEventData,
});

return continueTrace(
{ sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
() => {
// Use routePath for the name to capture route parameters
return startSpan(
{
attributes,
op: 'http.server',
name: `${request.method} ${routePath}`,
},
async span => {
try {
const response = await (handlerTarget.apply(handlerThisArg, handlerArgs) as
| Promise<Response>
| Response);
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.route',
},
},
});
throw e;
}
},
);
},
);
},
);
});
},
});
},
});
continue;
}

// Case 3: HTTP method handlers object { GET: fn, POST: fn, ... }
if (typeof handler === 'object') {
const methodHandlers = handler as Record<string, unknown>;
const instrumentedMethodHandlers: Record<string, unknown> = {};

for (const [method, methodHandler] of Object.entries(methodHandlers)) {
if (typeof methodHandler === 'function') {
anyMatches = true;
instrumentedMethodHandlers[method] = new Proxy(methodHandler, {
apply(methodHandlerTarget, methodHandlerThisArg, methodHandlerArgs) {
return withIsolationScope(isolationScope => {
const request = methodHandlerArgs[0] as BunRequest;
const upperCaseMethod = method.toUpperCase();
if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
return methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs);
}

const parsedUrl = parseUrl(request.url);
const attributes: SpanAttributes = {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route.method',
[SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: upperCaseMethod,
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
};
if (parsedUrl.search) {
attributes['http.query'] = parsedUrl.search;
}

const url = getSanitizedUrlString(parsedUrl);

isolationScope.setSDKProcessingMetadata({
normalizedRequest: {
url,
method: upperCaseMethod,
headers: request.headers.toJSON(),
query_string: extractQueryParamsFromUrl(url),
// For routes with parameters, add them to request data
...(request.params ? { params: request.params } : {}),
} satisfies RequestEventData,
});

return continueTrace(
{ sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
() => {
return startSpan(
{
attributes,
op: 'http.server',
name: `${upperCaseMethod} ${routePath}`,
},
async span => {
try {
const response = await (methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs) as
| Promise<Response>
| Response);
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.route.method',
},
},
});
throw e;
}
},
);
},
);
});
},
});
} else {
// If method handler is not a function (e.g., static response), keep it as is
instrumentedMethodHandlers[method] = methodHandler;
}
}

instrumentedRoutes[routePath] = instrumentedMethodHandlers;
continue;
}

// Default case: keep the handler as is if it's not a recognized type
instrumentedRoutes[routePath] = handler;
}

if (!anyMatches) {
return routes;
}

return instrumentedRoutes;
}
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): Update Bun integration to support routes & optional fetch#15978

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

 Closed

Jarred-Sumner
wants to merge
1
commit into

from

 Closed


feat(bun): Update Bun integration to support routes & optional fetch
#15978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


345 changes: 281 additions & 64 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import type { BunRequest, ServeOptions } from 'bun';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
Expand DownExpand Up@@ -40,11 +41,17 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let originalServe: typeof Bun.serve;

/**
 * Instruments Bun.serve by patching it's options.
 */
export function instrumentBunServe(): void {
 Bun.serve = new Proxy(Bun.serve, {
 if (!originalServe) {
 originalServe = Bun.serve;
 }

 Bun.serve = new Proxy(originalServe, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
 const server: ReturnType<typeof Bun.serve> = serveTarget.apply(serveThisArg, serveArgs);
Expand All@@ -53,7 +60,7 @@ 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);
 };
Expand All@@ -67,75 +74,285 @@ export function instrumentBunServe(): void {
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 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);
 }
 const originalFetch: typeof serveOptions.fetch = serveOptions?.fetch;
 // Instrument the fetch handler
 if (typeof originalFetch === 'function') {
 serveOptions.fetch = new Proxy(originalFetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof originalFetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(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;
 }
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;
}

 const url = getSanitizedUrlString(parsedUrl);
const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });
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 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 originalFetch
 >);
 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;
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 }

 // Instrument routes if present
 if (
 (typeof serveOptions?.routes === 'object' || typeof serveOptions?.routes === 'function') &&
 // Hono routes. This was an issue in Bun.
 !Array.isArray(serveOptions?.routes)
 ) {
 serveOptions.routes = instrumentBunServeRoutes(serveOptions.routes) as typeof serveOptions.routes;
 }
}

/**
 * Instruments the routes option in Bun.serve()
 */
function instrumentBunServeRoutes(
 routes: NonNullable<Parameters<typeof Bun.serve>[0]['routes']>,
): Parameters<typeof Bun.serve>[0]['routes'] {
 let anyMatches = false;
 const instrumentedRoutes: Parameters<typeof Bun.serve>[0]['routes'] = {};

 for (const [routePath, handler] of Object.entries(routes)) {
 if (handler === null || handler === undefined || !routePath.startsWith('/')) {
 instrumentedRoutes[routePath] = handler;
 continue;
 }

 // Case 2: Route handler function
 if (typeof handler === 'function') {
 anyMatches = true;
 instrumentedRoutes[routePath] = new Proxy(handler, {
 apply(handlerTarget, handlerThisArg, handlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = handlerArgs[0] as BunRequest;
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return handlerTarget.apply(handlerThisArg, handlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Use routePath for the name to capture route parameters
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routePath}`,
 },
 async span => {
 try {
 const response = await (handlerTarget.apply(handlerThisArg, handlerArgs) as
 | Promise<Response>
 | Response);
 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.route',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 },
);
 });
},
 });
 },
 });
 continue;
 }

 // Case 3: HTTP method handlers object { GET: fn, POST: fn, ... }
 if (typeof handler === 'object') {
 const methodHandlers = handler as Record<string, unknown>;
 const instrumentedMethodHandlers: Record<string, unknown> = {};

 for (const [method, methodHandler] of Object.entries(methodHandlers)) {
 if (typeof methodHandler === 'function') {
 anyMatches = true;
 instrumentedMethodHandlers[method] = new Proxy(methodHandler, {
 apply(methodHandlerTarget, methodHandlerThisArg, methodHandlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = methodHandlerArgs[0] as BunRequest;
 const upperCaseMethod = method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route.method',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: upperCaseMethod,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: upperCaseMethod,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${upperCaseMethod} ${routePath}`,
 },
 async span => {
 try {
 const response = await (methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs) as
 | Promise<Response>
 | Response);
 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.route.method',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 } else {
 // If method handler is not a function (e.g., static response), keep it as is
 instrumentedMethodHandlers[method] = methodHandler;
 }
 }

 instrumentedRoutes[routePath] = instrumentedMethodHandlers;
 continue;
 }

 // Default case: keep the handler as is if it's not a recognized type
 instrumentedRoutes[routePath] = handler;
 }

 if (!anyMatches) {
 return routes;
 }

 return instrumentedRoutes;
}
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): Update Bun integration to support routes & optional fetch#15978

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

 Closed

Jarred-Sumner
wants to merge
1
commit into

from

 Closed


feat(bun): Update Bun integration to support routes & optional fetch
#15978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


345 changes: 281 additions & 64 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import type { BunRequest, ServeOptions } from 'bun';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
Expand DownExpand Up@@ -40,11 +41,17 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let originalServe: typeof Bun.serve;

/**
 * Instruments Bun.serve by patching it's options.
 */
export function instrumentBunServe(): void {
 Bun.serve = new Proxy(Bun.serve, {
 if (!originalServe) {
 originalServe = Bun.serve;
 }

 Bun.serve = new Proxy(originalServe, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
 const server: ReturnType<typeof Bun.serve> = serveTarget.apply(serveThisArg, serveArgs);
Expand All@@ -53,7 +60,7 @@ 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);
 };
Expand All@@ -67,75 +74,285 @@ export function instrumentBunServe(): void {
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 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);
 }
 const originalFetch: typeof serveOptions.fetch = serveOptions?.fetch;
 // Instrument the fetch handler
 if (typeof originalFetch === 'function') {
 serveOptions.fetch = new Proxy(originalFetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof originalFetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(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;
 }
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;
}

 const url = getSanitizedUrlString(parsedUrl);
const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });
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 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 originalFetch
 >);
 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;
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 }

 // Instrument routes if present
 if (
 (typeof serveOptions?.routes === 'object' || typeof serveOptions?.routes === 'function') &&
 // Hono routes. This was an issue in Bun.
 !Array.isArray(serveOptions?.routes)
 ) {
 serveOptions.routes = instrumentBunServeRoutes(serveOptions.routes) as typeof serveOptions.routes;
 }
}

/**
 * Instruments the routes option in Bun.serve()
 */
function instrumentBunServeRoutes(
 routes: NonNullable<Parameters<typeof Bun.serve>[0]['routes']>,
): Parameters<typeof Bun.serve>[0]['routes'] {
 let anyMatches = false;
 const instrumentedRoutes: Parameters<typeof Bun.serve>[0]['routes'] = {};

 for (const [routePath, handler] of Object.entries(routes)) {
 if (handler === null || handler === undefined || !routePath.startsWith('/')) {
 instrumentedRoutes[routePath] = handler;
 continue;
 }

 // Case 2: Route handler function
 if (typeof handler === 'function') {
 anyMatches = true;
 instrumentedRoutes[routePath] = new Proxy(handler, {
 apply(handlerTarget, handlerThisArg, handlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = handlerArgs[0] as BunRequest;
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return handlerTarget.apply(handlerThisArg, handlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Use routePath for the name to capture route parameters
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routePath}`,
 },
 async span => {
 try {
 const response = await (handlerTarget.apply(handlerThisArg, handlerArgs) as
 | Promise<Response>
 | Response);
 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.route',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 },
);
 });
},
 });
 },
 });
 continue;
 }

 // Case 3: HTTP method handlers object { GET: fn, POST: fn, ... }
 if (typeof handler === 'object') {
 const methodHandlers = handler as Record<string, unknown>;
 const instrumentedMethodHandlers: Record<string, unknown> = {};

 for (const [method, methodHandler] of Object.entries(methodHandlers)) {
 if (typeof methodHandler === 'function') {
 anyMatches = true;
 instrumentedMethodHandlers[method] = new Proxy(methodHandler, {
 apply(methodHandlerTarget, methodHandlerThisArg, methodHandlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = methodHandlerArgs[0] as BunRequest;
 const upperCaseMethod = method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route.method',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: upperCaseMethod,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: upperCaseMethod,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${upperCaseMethod} ${routePath}`,
 },
 async span => {
 try {
 const response = await (methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs) as
 | Promise<Response>
 | Response);
 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.route.method',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 } else {
 // If method handler is not a function (e.g., static response), keep it as is
 instrumentedMethodHandlers[method] = methodHandler;
 }
 }

 instrumentedRoutes[routePath] = instrumentedMethodHandlers;
 continue;
 }

 // Default case: keep the handler as is if it's not a recognized type
 instrumentedRoutes[routePath] = handler;
 }

 if (!anyMatches) {
 return routes;
 }

 return instrumentedRoutes;
}
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): Update Bun integration to support routes & optional fetch#15978

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

 Closed

Jarred-Sumner
wants to merge
1
commit into

from

 Closed


feat(bun): Update Bun integration to support routes & optional fetch
#15978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


345 changes: 281 additions & 64 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import type { BunRequest, ServeOptions } from 'bun';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
Expand DownExpand Up@@ -40,11 +41,17 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let originalServe: typeof Bun.serve;

/**
 * Instruments Bun.serve by patching it's options.
 */
export function instrumentBunServe(): void {
 Bun.serve = new Proxy(Bun.serve, {
 if (!originalServe) {
 originalServe = Bun.serve;
 }

 Bun.serve = new Proxy(originalServe, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
 const server: ReturnType<typeof Bun.serve> = serveTarget.apply(serveThisArg, serveArgs);
Expand All@@ -53,7 +60,7 @@ 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);
 };
Expand All@@ -67,75 +74,285 @@ export function instrumentBunServe(): void {
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 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);
 }
 const originalFetch: typeof serveOptions.fetch = serveOptions?.fetch;
 // Instrument the fetch handler
 if (typeof originalFetch === 'function') {
 serveOptions.fetch = new Proxy(originalFetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof originalFetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(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;
 }
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;
}

 const url = getSanitizedUrlString(parsedUrl);
const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });
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 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 originalFetch
 >);
 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;
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 }

 // Instrument routes if present
 if (
 (typeof serveOptions?.routes === 'object' || typeof serveOptions?.routes === 'function') &&
 // Hono routes. This was an issue in Bun.
 !Array.isArray(serveOptions?.routes)
 ) {
 serveOptions.routes = instrumentBunServeRoutes(serveOptions.routes) as typeof serveOptions.routes;
 }
}

/**
 * Instruments the routes option in Bun.serve()
 */
function instrumentBunServeRoutes(
 routes: NonNullable<Parameters<typeof Bun.serve>[0]['routes']>,
): Parameters<typeof Bun.serve>[0]['routes'] {
 let anyMatches = false;
 const instrumentedRoutes: Parameters<typeof Bun.serve>[0]['routes'] = {};

 for (const [routePath, handler] of Object.entries(routes)) {
 if (handler === null || handler === undefined || !routePath.startsWith('/')) {
 instrumentedRoutes[routePath] = handler;
 continue;
 }

 // Case 2: Route handler function
 if (typeof handler === 'function') {
 anyMatches = true;
 instrumentedRoutes[routePath] = new Proxy(handler, {
 apply(handlerTarget, handlerThisArg, handlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = handlerArgs[0] as BunRequest;
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return handlerTarget.apply(handlerThisArg, handlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Use routePath for the name to capture route parameters
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routePath}`,
 },
 async span => {
 try {
 const response = await (handlerTarget.apply(handlerThisArg, handlerArgs) as
 | Promise<Response>
 | Response);
 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.route',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 },
);
 });
},
 });
 },
 });
 continue;
 }

 // Case 3: HTTP method handlers object { GET: fn, POST: fn, ... }
 if (typeof handler === 'object') {
 const methodHandlers = handler as Record<string, unknown>;
 const instrumentedMethodHandlers: Record<string, unknown> = {};

 for (const [method, methodHandler] of Object.entries(methodHandlers)) {
 if (typeof methodHandler === 'function') {
 anyMatches = true;
 instrumentedMethodHandlers[method] = new Proxy(methodHandler, {
 apply(methodHandlerTarget, methodHandlerThisArg, methodHandlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = methodHandlerArgs[0] as BunRequest;
 const upperCaseMethod = method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route.method',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: upperCaseMethod,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: upperCaseMethod,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${upperCaseMethod} ${routePath}`,
 },
 async span => {
 try {
 const response = await (methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs) as
 | Promise<Response>
 | Response);
 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.route.method',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 } else {
 // If method handler is not a function (e.g., static response), keep it as is
 instrumentedMethodHandlers[method] = methodHandler;
 }
 }

 instrumentedRoutes[routePath] = instrumentedMethodHandlers;
 continue;
 }

 // Default case: keep the handler as is if it's not a recognized type
 instrumentedRoutes[routePath] = handler;
 }

 if (!anyMatches) {
 return routes;
 }

 return instrumentedRoutes;
}
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): Update Bun integration to support routes & optional fetch#15978

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

 Closed

Jarred-Sumner
wants to merge
1
commit into

from

 Closed


feat(bun): Update Bun integration to support routes & optional fetch
#15978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


345 changes: 281 additions & 64 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import type { BunRequest, ServeOptions } from 'bun';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
Expand DownExpand Up@@ -40,11 +41,17 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let originalServe: typeof Bun.serve;

/**
 * Instruments Bun.serve by patching it's options.
 */
export function instrumentBunServe(): void {
 Bun.serve = new Proxy(Bun.serve, {
 if (!originalServe) {
 originalServe = Bun.serve;
 }

 Bun.serve = new Proxy(originalServe, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
 const server: ReturnType<typeof Bun.serve> = serveTarget.apply(serveThisArg, serveArgs);
Expand All@@ -53,7 +60,7 @@ 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);
 };
Expand All@@ -67,75 +74,285 @@ export function instrumentBunServe(): void {
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 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);
 }
 const originalFetch: typeof serveOptions.fetch = serveOptions?.fetch;
 // Instrument the fetch handler
 if (typeof originalFetch === 'function') {
 serveOptions.fetch = new Proxy(originalFetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof originalFetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(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;
 }
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;
}

 const url = getSanitizedUrlString(parsedUrl);
const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });
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 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 originalFetch
 >);
 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;
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 }

 // Instrument routes if present
 if (
 (typeof serveOptions?.routes === 'object' || typeof serveOptions?.routes === 'function') &&
 // Hono routes. This was an issue in Bun.
 !Array.isArray(serveOptions?.routes)
 ) {
 serveOptions.routes = instrumentBunServeRoutes(serveOptions.routes) as typeof serveOptions.routes;
 }
}

/**
 * Instruments the routes option in Bun.serve()
 */
function instrumentBunServeRoutes(
 routes: NonNullable<Parameters<typeof Bun.serve>[0]['routes']>,
): Parameters<typeof Bun.serve>[0]['routes'] {
 let anyMatches = false;
 const instrumentedRoutes: Parameters<typeof Bun.serve>[0]['routes'] = {};

 for (const [routePath, handler] of Object.entries(routes)) {
 if (handler === null || handler === undefined || !routePath.startsWith('/')) {
 instrumentedRoutes[routePath] = handler;
 continue;
 }

 // Case 2: Route handler function
 if (typeof handler === 'function') {
 anyMatches = true;
 instrumentedRoutes[routePath] = new Proxy(handler, {
 apply(handlerTarget, handlerThisArg, handlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = handlerArgs[0] as BunRequest;
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return handlerTarget.apply(handlerThisArg, handlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Use routePath for the name to capture route parameters
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routePath}`,
 },
 async span => {
 try {
 const response = await (handlerTarget.apply(handlerThisArg, handlerArgs) as
 | Promise<Response>
 | Response);
 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.route',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 },
);
 });
},
 });
 },
 });
 continue;
 }

 // Case 3: HTTP method handlers object { GET: fn, POST: fn, ... }
 if (typeof handler === 'object') {
 const methodHandlers = handler as Record<string, unknown>;
 const instrumentedMethodHandlers: Record<string, unknown> = {};

 for (const [method, methodHandler] of Object.entries(methodHandlers)) {
 if (typeof methodHandler === 'function') {
 anyMatches = true;
 instrumentedMethodHandlers[method] = new Proxy(methodHandler, {
 apply(methodHandlerTarget, methodHandlerThisArg, methodHandlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = methodHandlerArgs[0] as BunRequest;
 const upperCaseMethod = method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route.method',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: upperCaseMethod,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: upperCaseMethod,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${upperCaseMethod} ${routePath}`,
 },
 async span => {
 try {
 const response = await (methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs) as
 | Promise<Response>
 | Response);
 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.route.method',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 } else {
 // If method handler is not a function (e.g., static response), keep it as is
 instrumentedMethodHandlers[method] = methodHandler;
 }
 }

 instrumentedRoutes[routePath] = instrumentedMethodHandlers;
 continue;
 }

 // Default case: keep the handler as is if it's not a recognized type
 instrumentedRoutes[routePath] = handler;
 }

 if (!anyMatches) {
 return routes;
 }

 return instrumentedRoutes;
}
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): Update Bun integration to support routes & optional fetch#15978

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

 Closed

Jarred-Sumner
wants to merge
1
commit into

from

 Closed


feat(bun): Update Bun integration to support routes & optional fetch
#15978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


345 changes: 281 additions & 64 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import type { BunRequest, ServeOptions } from 'bun';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
Expand DownExpand Up@@ -40,11 +41,17 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let originalServe: typeof Bun.serve;

/**
 * Instruments Bun.serve by patching it's options.
 */
export function instrumentBunServe(): void {
 Bun.serve = new Proxy(Bun.serve, {
 if (!originalServe) {
 originalServe = Bun.serve;
 }

 Bun.serve = new Proxy(originalServe, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
 const server: ReturnType<typeof Bun.serve> = serveTarget.apply(serveThisArg, serveArgs);
Expand All@@ -53,7 +60,7 @@ 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);
 };
Expand All@@ -67,75 +74,285 @@ export function instrumentBunServe(): void {
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 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);
 }
 const originalFetch: typeof serveOptions.fetch = serveOptions?.fetch;
 // Instrument the fetch handler
 if (typeof originalFetch === 'function') {
 serveOptions.fetch = new Proxy(originalFetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof originalFetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(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;
 }
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;
}

 const url = getSanitizedUrlString(parsedUrl);
const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });
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 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 originalFetch
 >);
 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;
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 }

 // Instrument routes if present
 if (
 (typeof serveOptions?.routes === 'object' || typeof serveOptions?.routes === 'function') &&
 // Hono routes. This was an issue in Bun.
 !Array.isArray(serveOptions?.routes)
 ) {
 serveOptions.routes = instrumentBunServeRoutes(serveOptions.routes) as typeof serveOptions.routes;
 }
}

/**
 * Instruments the routes option in Bun.serve()
 */
function instrumentBunServeRoutes(
 routes: NonNullable<Parameters<typeof Bun.serve>[0]['routes']>,
): Parameters<typeof Bun.serve>[0]['routes'] {
 let anyMatches = false;
 const instrumentedRoutes: Parameters<typeof Bun.serve>[0]['routes'] = {};

 for (const [routePath, handler] of Object.entries(routes)) {
 if (handler === null || handler === undefined || !routePath.startsWith('/')) {
 instrumentedRoutes[routePath] = handler;
 continue;
 }

 // Case 2: Route handler function
 if (typeof handler === 'function') {
 anyMatches = true;
 instrumentedRoutes[routePath] = new Proxy(handler, {
 apply(handlerTarget, handlerThisArg, handlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = handlerArgs[0] as BunRequest;
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return handlerTarget.apply(handlerThisArg, handlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Use routePath for the name to capture route parameters
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routePath}`,
 },
 async span => {
 try {
 const response = await (handlerTarget.apply(handlerThisArg, handlerArgs) as
 | Promise<Response>
 | Response);
 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.route',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 },
);
 });
},
 });
 },
 });
 continue;
 }

 // Case 3: HTTP method handlers object { GET: fn, POST: fn, ... }
 if (typeof handler === 'object') {
 const methodHandlers = handler as Record<string, unknown>;
 const instrumentedMethodHandlers: Record<string, unknown> = {};

 for (const [method, methodHandler] of Object.entries(methodHandlers)) {
 if (typeof methodHandler === 'function') {
 anyMatches = true;
 instrumentedMethodHandlers[method] = new Proxy(methodHandler, {
 apply(methodHandlerTarget, methodHandlerThisArg, methodHandlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = methodHandlerArgs[0] as BunRequest;
 const upperCaseMethod = method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route.method',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: upperCaseMethod,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: upperCaseMethod,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${upperCaseMethod} ${routePath}`,
 },
 async span => {
 try {
 const response = await (methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs) as
 | Promise<Response>
 | Response);
 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.route.method',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 } else {
 // If method handler is not a function (e.g., static response), keep it as is
 instrumentedMethodHandlers[method] = methodHandler;
 }
 }

 instrumentedRoutes[routePath] = instrumentedMethodHandlers;
 continue;
 }

 // Default case: keep the handler as is if it's not a recognized type
 instrumentedRoutes[routePath] = handler;
 }

 if (!anyMatches) {
 return routes;
 }

 return instrumentedRoutes;
}
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): Update Bun integration to support routes & optional fetch#15978

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

 Closed

Jarred-Sumner
wants to merge
1
commit into

from

 Closed


feat(bun): Update Bun integration to support routes & optional fetch
#15978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


345 changes: 281 additions & 64 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import type { BunRequest, ServeOptions } from 'bun';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
Expand DownExpand Up@@ -40,11 +41,17 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let originalServe: typeof Bun.serve;

/**
 * Instruments Bun.serve by patching it's options.
 */
export function instrumentBunServe(): void {
 Bun.serve = new Proxy(Bun.serve, {
 if (!originalServe) {
 originalServe = Bun.serve;
 }

 Bun.serve = new Proxy(originalServe, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
 const server: ReturnType<typeof Bun.serve> = serveTarget.apply(serveThisArg, serveArgs);
Expand All@@ -53,7 +60,7 @@ 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);
 };
Expand All@@ -67,75 +74,285 @@ export function instrumentBunServe(): void {
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 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);
 }
 const originalFetch: typeof serveOptions.fetch = serveOptions?.fetch;
 // Instrument the fetch handler
 if (typeof originalFetch === 'function') {
 serveOptions.fetch = new Proxy(originalFetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof originalFetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(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;
 }
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;
}

 const url = getSanitizedUrlString(parsedUrl);
const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });
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 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 originalFetch
 >);
 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;
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 }

 // Instrument routes if present
 if (
 (typeof serveOptions?.routes === 'object' || typeof serveOptions?.routes === 'function') &&
 // Hono routes. This was an issue in Bun.
 !Array.isArray(serveOptions?.routes)
 ) {
 serveOptions.routes = instrumentBunServeRoutes(serveOptions.routes) as typeof serveOptions.routes;
 }
}

/**
 * Instruments the routes option in Bun.serve()
 */
function instrumentBunServeRoutes(
 routes: NonNullable<Parameters<typeof Bun.serve>[0]['routes']>,
): Parameters<typeof Bun.serve>[0]['routes'] {
 let anyMatches = false;
 const instrumentedRoutes: Parameters<typeof Bun.serve>[0]['routes'] = {};

 for (const [routePath, handler] of Object.entries(routes)) {
 if (handler === null || handler === undefined || !routePath.startsWith('/')) {
 instrumentedRoutes[routePath] = handler;
 continue;
 }

 // Case 2: Route handler function
 if (typeof handler === 'function') {
 anyMatches = true;
 instrumentedRoutes[routePath] = new Proxy(handler, {
 apply(handlerTarget, handlerThisArg, handlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = handlerArgs[0] as BunRequest;
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return handlerTarget.apply(handlerThisArg, handlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Use routePath for the name to capture route parameters
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routePath}`,
 },
 async span => {
 try {
 const response = await (handlerTarget.apply(handlerThisArg, handlerArgs) as
 | Promise<Response>
 | Response);
 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.route',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 },
);
 });
},
 });
 },
 });
 continue;
 }

 // Case 3: HTTP method handlers object { GET: fn, POST: fn, ... }
 if (typeof handler === 'object') {
 const methodHandlers = handler as Record<string, unknown>;
 const instrumentedMethodHandlers: Record<string, unknown> = {};

 for (const [method, methodHandler] of Object.entries(methodHandlers)) {
 if (typeof methodHandler === 'function') {
 anyMatches = true;
 instrumentedMethodHandlers[method] = new Proxy(methodHandler, {
 apply(methodHandlerTarget, methodHandlerThisArg, methodHandlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = methodHandlerArgs[0] as BunRequest;
 const upperCaseMethod = method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route.method',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: upperCaseMethod,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: upperCaseMethod,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${upperCaseMethod} ${routePath}`,
 },
 async span => {
 try {
 const response = await (methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs) as
 | Promise<Response>
 | Response);
 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.route.method',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 } else {
 // If method handler is not a function (e.g., static response), keep it as is
 instrumentedMethodHandlers[method] = methodHandler;
 }
 }

 instrumentedRoutes[routePath] = instrumentedMethodHandlers;
 continue;
 }

 // Default case: keep the handler as is if it's not a recognized type
 instrumentedRoutes[routePath] = handler;
 }

 if (!anyMatches) {
 return routes;
 }

 return instrumentedRoutes;
}
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): Update Bun integration to support routes & optional fetch#15978

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

 Closed

Jarred-Sumner
wants to merge
1
commit into

from

 Closed


feat(bun): Update Bun integration to support routes & optional fetch
#15978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


345 changes: 281 additions & 64 deletions
packages/bun/src/integrations/bunserver.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { IntegrationFn, RequestEventData, SpanAttributes } from '@sentry/core';
import type { BunRequest, ServeOptions } from 'bun';
import {
 SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
Expand DownExpand Up@@ -40,11 +41,17 @@ const _bunServerIntegration = (() => {
 */
export const bunServerIntegration = defineIntegration(_bunServerIntegration);

let originalServe: typeof Bun.serve;

/**
 * Instruments Bun.serve by patching it's options.
 */
export function instrumentBunServe(): void {
 Bun.serve = new Proxy(Bun.serve, {
 if (!originalServe) {
 originalServe = Bun.serve;
 }

 Bun.serve = new Proxy(originalServe, {
 apply(serveTarget, serveThisArg, serveArgs: Parameters<typeof Bun.serve>) {
 instrumentBunServeOptions(serveArgs[0]);
 const server: ReturnType<typeof Bun.serve> = serveTarget.apply(serveThisArg, serveArgs);
Expand All@@ -53,7 +60,7 @@ 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);
 };
Expand All@@ -67,75 +74,285 @@ export function instrumentBunServe(): void {
 * Instruments Bun.serve `fetch` option to automatically create spans and capture errors.
 */
function instrumentBunServeOptions(serveOptions: Parameters<typeof Bun.serve>[0]): void {
 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);
 }
 const originalFetch: typeof serveOptions.fetch = serveOptions?.fetch;
 // Instrument the fetch handler
 if (typeof originalFetch === 'function') {
 serveOptions.fetch = new Proxy(originalFetch, {
 apply(fetchTarget, fetchThisArg, fetchArgs: Parameters<typeof originalFetch>) {
 return withIsolationScope(isolationScope => {
 const request = fetchArgs[0];
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return fetchTarget.apply(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;
 }
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;
}

 const url = getSanitizedUrlString(parsedUrl);
const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 } satisfies RequestEventData,
 });
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 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 originalFetch
 >);
 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;
 }
 return response;
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'bun',
 handled: false,
 data: {
 function: 'serve',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 }

 // Instrument routes if present
 if (
 (typeof serveOptions?.routes === 'object' || typeof serveOptions?.routes === 'function') &&
 // Hono routes. This was an issue in Bun.
 !Array.isArray(serveOptions?.routes)
 ) {
 serveOptions.routes = instrumentBunServeRoutes(serveOptions.routes) as typeof serveOptions.routes;
 }
}

/**
 * Instruments the routes option in Bun.serve()
 */
function instrumentBunServeRoutes(
 routes: NonNullable<Parameters<typeof Bun.serve>[0]['routes']>,
): Parameters<typeof Bun.serve>[0]['routes'] {
 let anyMatches = false;
 const instrumentedRoutes: Parameters<typeof Bun.serve>[0]['routes'] = {};

 for (const [routePath, handler] of Object.entries(routes)) {
 if (handler === null || handler === undefined || !routePath.startsWith('/')) {
 instrumentedRoutes[routePath] = handler;
 continue;
 }

 // Case 2: Route handler function
 if (typeof handler === 'function') {
 anyMatches = true;
 instrumentedRoutes[routePath] = new Proxy(handler, {
 apply(handlerTarget, handlerThisArg, handlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = handlerArgs[0] as BunRequest;
 const upperCaseMethod = request.method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return handlerTarget.apply(handlerThisArg, handlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: request.method || 'GET',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: request.method,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 // Use routePath for the name to capture route parameters
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${request.method} ${routePath}`,
 },
 async span => {
 try {
 const response = await (handlerTarget.apply(handlerThisArg, handlerArgs) as
 | Promise<Response>
 | Response);
 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.route',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 },
);
 });
},
 });
 },
 });
 continue;
 }

 // Case 3: HTTP method handlers object { GET: fn, POST: fn, ... }
 if (typeof handler === 'object') {
 const methodHandlers = handler as Record<string, unknown>;
 const instrumentedMethodHandlers: Record<string, unknown> = {};

 for (const [method, methodHandler] of Object.entries(methodHandlers)) {
 if (typeof methodHandler === 'function') {
 anyMatches = true;
 instrumentedMethodHandlers[method] = new Proxy(methodHandler, {
 apply(methodHandlerTarget, methodHandlerThisArg, methodHandlerArgs) {
 return withIsolationScope(isolationScope => {
 const request = methodHandlerArgs[0] as BunRequest;
 const upperCaseMethod = method.toUpperCase();
 if (upperCaseMethod === 'OPTIONS' || upperCaseMethod === 'HEAD') {
 return methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs);
 }

 const parsedUrl = parseUrl(request.url);
 const attributes: SpanAttributes = {
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.bun.serve.route.method',
 [SEMANTIC_ATTRIBUTE_HTTP_REQUEST_METHOD]: upperCaseMethod,
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
 };
 if (parsedUrl.search) {
 attributes['http.query'] = parsedUrl.search;
 }

 const url = getSanitizedUrlString(parsedUrl);

 isolationScope.setSDKProcessingMetadata({
 normalizedRequest: {
 url,
 method: upperCaseMethod,
 headers: request.headers.toJSON(),
 query_string: extractQueryParamsFromUrl(url),
 // For routes with parameters, add them to request data
 ...(request.params ? { params: request.params } : {}),
 } satisfies RequestEventData,
 });

 return continueTrace(
 { sentryTrace: request.headers.get('sentry-trace') || '', baggage: request.headers.get('baggage') },
 () => {
 return startSpan(
 {
 attributes,
 op: 'http.server',
 name: `${upperCaseMethod} ${routePath}`,
 },
 async span => {
 try {
 const response = await (methodHandlerTarget.apply(methodHandlerThisArg, methodHandlerArgs) as
 | Promise<Response>
 | Response);
 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.route.method',
 },
 },
 });
 throw e;
 }
 },
 );
 },
 );
 });
 },
 });
 } else {
 // If method handler is not a function (e.g., static response), keep it as is
 instrumentedMethodHandlers[method] = methodHandler;
 }
 }

 instrumentedRoutes[routePath] = instrumentedMethodHandlers;
 continue;
 }

 // Default case: keep the handler as is if it's not a recognized type
 instrumentedRoutes[routePath] = handler;
 }

 if (!anyMatches) {
 return routes;
 }

 return instrumentedRoutes;
}
Loading