fix(bun): Includes correct sdk metadata#15459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AbhiPrasad merged 4 commits into from
Feb 20, 2025
Merged

fix(bun): Includes correct sdk metadata #15459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7298f74
fix(bun): Includes correct sdk metadata
timfish Feb 20, 2025
8cbb0dd
doc
timfish Feb 20, 2025
97335ea
Fix serve test
timfish Feb 20, 2025
63fdd55
Biome linting is seperate?
timfish Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions packages/bun/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,7 @@ import { ServerRuntimeClient, applySdkMetadata } from '@sentry/core';
import type { BunClientOptions } from './types';

/**
* The Sentry Bun SDK Client.
*
* @see BunClientOptions for documentation on configuration options.
* @see SentryClient for usage documentation.
* @deprecated This client is no longer used in v9.
*/
export class BunClient extends ServerRuntimeClient<BunClientOptions> {
/**
Expand Down
1 change: 1 addition & 0 deletions packages/bun/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export {

export type { BunOptions } from './types';

// eslint-disable-next-line deprecation/deprecation
export { BunClient } from './client';
export { getDefaultIntegrations, init } from './sdk';
export { bunServerIntegration } from './integrations/bunserver';
Expand Down
15 changes: 12 additions & 3 deletions packages/bun/src/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import * as os from 'node:os';
import {
applySdkMetadata,
functionToStringIntegration,
inboundFiltersIntegration,
linkedErrorsIntegration,
Expand All@@ -18,7 +20,6 @@ import {
onUnhandledRejectionIntegration,
} from '@sentry/node';

import { BunClient } from './client';
import { bunServerIntegration } from './integrations/bunserver';
import { makeFetchTransport } from './transports';
import type { BunOptions } from './types';
Expand DownExpand Up@@ -92,8 +93,16 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
*
* @see {@link BunOptions} for documentation on configuration options.
*/
export function init(options: BunOptions = {}): NodeClient | undefined {
options.clientClass = BunClient;
export function init(userOptions: BunOptions = {}): NodeClient | undefined {
applySdkMetadata(userOptions, 'bun');

const options = {
...userOptions,
platform: 'javascript',
runtime: { name: 'bun', version: Bun.version },
serverName: userOptions.serverName || global.process.env.SENTRY_NAME || os.hostname(),
};

options.transport = options.transport || makeFetchTransport;

if (options.defaultIntegrations === undefined) {
Expand Down
9 changes: 0 additions & 9 deletions packages/bun/src/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import type { ClientOptions, Options, TracePropagationTargets } from '@sentry/core';

import type { BunClient } from './client';
import type { BunTransportOptions } from './transports';

export interface BaseBunOptions {
Expand All@@ -25,14 +24,6 @@ export interface BaseBunOptions {
/** Sets an optional server name (device name) */
serverName?: string;

/**
* Specify a custom BunClient to be used. Must extend BunClient!
* This is not a public, supported API, but used internally only.
*
* @hidden
* */
clientClass?: typeof BunClient;

/** Callback that is executed when a fatal global error occurs. */
onFatalError?(this: void, error: Error): void;
}
Expand Down
21 changes: 10 additions & 11 deletions packages/bun/test/integrations/bunserver.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { afterEach, beforeAll, beforeEach, describe, expect, test } from 'bun:test';
import type { Span } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, setCurrentClient, spanIsSampled, spanToJSON } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, spanIsSampled, spanToJSON } from '@sentry/core';

import { BunClient } from '../../src/client';
import { init } from '../../src';
import type { NodeClient } from '../../src';
import { instrumentBunServe } from '../../src/integrations/bunserver';
import { getDefaultBunClientOptions } from '../helpers';

describe('Bun Serve Integration', () => {
let client: BunClient;
let client: NodeClient | undefined;
// Fun fact: Bun = 2 21 14 :)
let port: number = 22114;

Expand All@@ -17,9 +18,7 @@ describe('Bun Serve Integration', () => {

beforeEach(() => {
const options = getDefaultBunClientOptions({ tracesSampleRate: 1 });
client = new BunClient(options);
setCurrentClient(client);
client.init();
client = init(options);
});

afterEach(() => {
Expand All@@ -31,7 +30,7 @@ describe('Bun Serve Integration', () => {
test('generates a transaction around a request', async () => {
let generatedSpan: Span | undefined;

client.on('spanEnd', span => {
client?.on('spanEnd', span => {
generatedSpan = span;
});

Expand DownExpand Up@@ -66,7 +65,7 @@ describe('Bun Serve Integration', () => {
test('generates a post transaction', async () => {
let generatedSpan: Span | undefined;

client.on('spanEnd', span => {
client?.on('spanEnd', span => {
generatedSpan = span;
});

Expand DownExpand Up@@ -103,7 +102,7 @@ describe('Bun Serve Integration', () => {

let generatedSpan: Span | undefined;

client.on('spanEnd', span => {
client?.on('spanEnd', span => {
generatedSpan = span;
});

Expand DownExpand Up@@ -139,7 +138,7 @@ describe('Bun Serve Integration', () => {
test('does not create transactions for OPTIONS or HEAD requests', async () => {
let generatedSpan: Span | undefined;

client.on('spanEnd', span => {
client?.on('spanEnd', span => {
generatedSpan = span;
});

Expand All@@ -165,7 +164,7 @@ describe('Bun Serve Integration', () => {

test('intruments the server again if it is reloaded', async () => {
let serverWasInstrumented = false;
client.on('spanEnd', () => {
client?.on('spanEnd', () => {
serverWasInstrumented = true;
});

Expand Down
41 changes: 36 additions & 5 deletions packages/bun/test/sdk.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,51 @@
import { describe, expect, test } from 'bun:test';

import type { BaseTransportOptions, Envelope, Event, Transport, TransportMakeRequestResponse } from '@sentry/core';
import type { NodeClient } from '../src/index';
import { init } from '../src/index';

const envelopes: Envelope[] = [];

function testTransport(_options: BaseTransportOptions): Transport {
return {
send(request: Envelope): Promise<TransportMakeRequestResponse> {
envelopes.push(request);
return Promise.resolve({ statusCode: 200 });
},
flush(): PromiseLike<boolean> {
return new Promise(resolve => setTimeout(() => resolve(true), 100));
},
};
}

describe('Bun SDK', () => {
const initOptions = {
dsn: 'https://00000000000000000000000000000000@o000000.ingest.sentry.io/0000000',
tracesSampleRate: 1,
transport: testTransport,
};

test("calling init shouldn't fail", () => {
test('SDK works as expected', async () => {
let client: NodeClient | undefined;
expect(() => {
init(initOptions);
client = init(initOptions);
}).not.toThrow();
});

test('should return client from init', () => {
expect(init(initOptions)).not.toBeUndefined();
expect(client).not.toBeUndefined();

client?.captureException(new Error('test'));
client?.flush();

await new Promise(resolve => setTimeout(resolve, 1000));

expect(envelopes.length).toBe(1);

const envelope = envelopes[0];
const event = envelope?.[1][0][1] as Event;

expect(event.sdk?.name).toBe('sentry.javascript.bun');

expect(event.exception?.values?.[0]?.type).toBe('Error');
expect(event.exception?.values?.[0]?.value).toBe('test');
});
});
, '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
fix(bun): Includes correct sdk metadata#15459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Feb 20, 2025
 Merged


fix(bun): Includes correct sdk metadata
#15459
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7298f74

fix(bun): Includes correct sdk metadata


timfish Feb 20, 2025
8cbb0dd

doc


timfish Feb 20, 2025
97335ea

Fix serve test


timfish Feb 20, 2025
63fdd55

Biome linting is seperate?


timfish Feb 20, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 1 addition & 4 deletions
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,7 @@ import { ServerRuntimeClient, applySdkMetadata } from '@sentry/core';
import type { BunClientOptions } from './types';

/**
 * The Sentry Bun SDK Client.
 *
 * @see BunClientOptions for documentation on configuration options.
 * @see SentryClient for usage documentation.
 * @deprecated This client is no longer used in v9.
 */
export class BunClient extends ServerRuntimeClient<BunClientOptions> {
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export {

export type { BunOptions } from './types';

// eslint-disable-next-line deprecation/deprecation
export { BunClient } from './client';
export { getDefaultIntegrations, init } from './sdk';
export { bunServerIntegration } from './integrations/bunserver';
Expand Down

15 changes: 12 additions & 3 deletions
packages/bun/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import * as os from 'node:os';
import {
 applySdkMetadata,
 functionToStringIntegration,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand All@@ -18,7 +20,6 @@ import {
 onUnhandledRejectionIntegration,
} from '@sentry/node';

import { BunClient } from './client';
import { bunServerIntegration } from './integrations/bunserver';
import { makeFetchTransport } from './transports';
import type { BunOptions } from './types';
Expand DownExpand Up@@ -92,8 +93,16 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
 *
 * @see {@link BunOptions} for documentation on configuration options.
 */
export function init(options: BunOptions = {}): NodeClient | undefined {
 options.clientClass = BunClient;
export function init(userOptions: BunOptions = {}): NodeClient | undefined {
 applySdkMetadata(userOptions, 'bun');

 const options = {
 ...userOptions,
 platform: 'javascript',
 runtime: { name: 'bun', version: Bun.version },
 serverName: userOptions.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };

 options.transport = options.transport || makeFetchTransport;

 if (options.defaultIntegrations === undefined) {
Expand Down

9 changes: 0 additions & 9 deletions
packages/bun/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import type { ClientOptions, Options, TracePropagationTargets } from '@sentry/core';

import type { BunClient } from './client';
import type { BunTransportOptions } from './transports';

export interface BaseBunOptions {
Expand All@@ -25,14 +24,6 @@ export interface BaseBunOptions {
 /** Sets an optional server name (device name) */
 serverName?: string;

 /**
 * Specify a custom BunClient to be used. Must extend BunClient!
 * This is not a public, supported API, but used internally only.
 *
 * @hidden
 * */
 clientClass?: typeof BunClient;

 /** Callback that is executed when a fatal global error occurs. */
 onFatalError?(this: void, error: Error): void;
}
Expand Down

21 changes: 10 additions & 11 deletions
packages/bun/test/integrations/bunserver.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { afterEach, beforeAll, beforeEach, describe, expect, test } from 'bun:test';
import type { Span } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, setCurrentClient, spanIsSampled, spanToJSON } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, spanIsSampled, spanToJSON } from '@sentry/core';

import { BunClient } from '../../src/client';
import { init } from '../../src';
import type { NodeClient } from '../../src';
import { instrumentBunServe } from '../../src/integrations/bunserver';
import { getDefaultBunClientOptions } from '../helpers';

describe('Bun Serve Integration', () => {
 let client: BunClient;
 let client: NodeClient | undefined;
 // Fun fact: Bun = 2 21 14 :)
 let port: number = 22114;

Expand All@@ -17,9 +18,7 @@ describe('Bun Serve Integration', () => {

 beforeEach(() => {
 const options = getDefaultBunClientOptions({ tracesSampleRate: 1 });
 client = new BunClient(options);
 setCurrentClient(client);
 client.init();
 client = init(options);
 });

 afterEach(() => {
Expand All@@ -31,7 +30,7 @@ describe('Bun Serve Integration', () => {
 test('generates a transaction around a request', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -66,7 +65,7 @@ describe('Bun Serve Integration', () => {
 test('generates a post transaction', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -103,7 +102,7 @@ describe('Bun Serve Integration', () => {

 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -139,7 +138,7 @@ describe('Bun Serve Integration', () => {
 test('does not create transactions for OPTIONS or HEAD requests', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand All@@ -165,7 +164,7 @@ describe('Bun Serve Integration', () => {

 test('intruments the server again if it is reloaded', async () => {
 let serverWasInstrumented = false;
 client.on('spanEnd', () => {
 client?.on('spanEnd', () => {
 serverWasInstrumented = true;
 });

Expand Down

41 changes: 36 additions & 5 deletions
packages/bun/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,51 @@
import { describe, expect, test } from 'bun:test';

import type { BaseTransportOptions, Envelope, Event, Transport, TransportMakeRequestResponse } from '@sentry/core';
import type { NodeClient } from '../src/index';
import { init } from '../src/index';

const envelopes: Envelope[] = [];

function testTransport(_options: BaseTransportOptions): Transport {
 return {
 send(request: Envelope): Promise<TransportMakeRequestResponse> {
 envelopes.push(request);
 return Promise.resolve({ statusCode: 200 });
 },
 flush(): PromiseLike<boolean> {
 return new Promise(resolve => setTimeout(() => resolve(true), 100));
 },
 };
}

describe('Bun SDK', () => {
 const initOptions = {
 dsn: 'https://00000000000000000000000000000000@o000000.ingest.sentry.io/0000000',
 tracesSampleRate: 1,
 transport: testTransport,
 };

 test("calling init shouldn't fail", () => {
 test('SDK works as expected', async () => {
 let client: NodeClient | undefined;
 expect(() => {
 init(initOptions);
client = init(initOptions);
 }).not.toThrow();
 });

 test('should return client from init', () => {
 expect(init(initOptions)).not.toBeUndefined();
 expect(client).not.toBeUndefined();

 client?.captureException(new Error('test'));
 client?.flush();

 await new Promise(resolve => setTimeout(resolve, 1000));

 expect(envelopes.length).toBe(1);

 const envelope = envelopes[0];
 const event = envelope?.[1][0][1] as Event;

 expect(event.sdk?.name).toBe('sentry.javascript.bun');

 expect(event.exception?.values?.[0]?.type).toBe('Error');
 expect(event.exception?.values?.[0]?.value).toBe('test');
 });
});

, '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
fix(bun): Includes correct sdk metadata#15459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Feb 20, 2025
 Merged


fix(bun): Includes correct sdk metadata
#15459
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7298f74

fix(bun): Includes correct sdk metadata


timfish Feb 20, 2025
8cbb0dd

doc


timfish Feb 20, 2025
97335ea

Fix serve test


timfish Feb 20, 2025
63fdd55

Biome linting is seperate?


timfish Feb 20, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 1 addition & 4 deletions
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,7 @@ import { ServerRuntimeClient, applySdkMetadata } from '@sentry/core';
import type { BunClientOptions } from './types';

/**
 * The Sentry Bun SDK Client.
 *
 * @see BunClientOptions for documentation on configuration options.
 * @see SentryClient for usage documentation.
 * @deprecated This client is no longer used in v9.
 */
export class BunClient extends ServerRuntimeClient<BunClientOptions> {
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export {

export type { BunOptions } from './types';

// eslint-disable-next-line deprecation/deprecation
export { BunClient } from './client';
export { getDefaultIntegrations, init } from './sdk';
export { bunServerIntegration } from './integrations/bunserver';
Expand Down

15 changes: 12 additions & 3 deletions
packages/bun/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import * as os from 'node:os';
import {
 applySdkMetadata,
 functionToStringIntegration,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand All@@ -18,7 +20,6 @@ import {
 onUnhandledRejectionIntegration,
} from '@sentry/node';

import { BunClient } from './client';
import { bunServerIntegration } from './integrations/bunserver';
import { makeFetchTransport } from './transports';
import type { BunOptions } from './types';
Expand DownExpand Up@@ -92,8 +93,16 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
 *
 * @see {@link BunOptions} for documentation on configuration options.
 */
export function init(options: BunOptions = {}): NodeClient | undefined {
 options.clientClass = BunClient;
export function init(userOptions: BunOptions = {}): NodeClient | undefined {
 applySdkMetadata(userOptions, 'bun');

 const options = {
 ...userOptions,
 platform: 'javascript',
 runtime: { name: 'bun', version: Bun.version },
 serverName: userOptions.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };

 options.transport = options.transport || makeFetchTransport;

 if (options.defaultIntegrations === undefined) {
Expand Down

9 changes: 0 additions & 9 deletions
packages/bun/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import type { ClientOptions, Options, TracePropagationTargets } from '@sentry/core';

import type { BunClient } from './client';
import type { BunTransportOptions } from './transports';

export interface BaseBunOptions {
Expand All@@ -25,14 +24,6 @@ export interface BaseBunOptions {
 /** Sets an optional server name (device name) */
 serverName?: string;

 /**
 * Specify a custom BunClient to be used. Must extend BunClient!
 * This is not a public, supported API, but used internally only.
 *
 * @hidden
 * */
 clientClass?: typeof BunClient;

 /** Callback that is executed when a fatal global error occurs. */
 onFatalError?(this: void, error: Error): void;
}
Expand Down

21 changes: 10 additions & 11 deletions
packages/bun/test/integrations/bunserver.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { afterEach, beforeAll, beforeEach, describe, expect, test } from 'bun:test';
import type { Span } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, setCurrentClient, spanIsSampled, spanToJSON } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, spanIsSampled, spanToJSON } from '@sentry/core';

import { BunClient } from '../../src/client';
import { init } from '../../src';
import type { NodeClient } from '../../src';
import { instrumentBunServe } from '../../src/integrations/bunserver';
import { getDefaultBunClientOptions } from '../helpers';

describe('Bun Serve Integration', () => {
 let client: BunClient;
 let client: NodeClient | undefined;
 // Fun fact: Bun = 2 21 14 :)
 let port: number = 22114;

Expand All@@ -17,9 +18,7 @@ describe('Bun Serve Integration', () => {

 beforeEach(() => {
 const options = getDefaultBunClientOptions({ tracesSampleRate: 1 });
 client = new BunClient(options);
 setCurrentClient(client);
 client.init();
 client = init(options);
 });

 afterEach(() => {
Expand All@@ -31,7 +30,7 @@ describe('Bun Serve Integration', () => {
 test('generates a transaction around a request', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -66,7 +65,7 @@ describe('Bun Serve Integration', () => {
 test('generates a post transaction', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -103,7 +102,7 @@ describe('Bun Serve Integration', () => {

 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -139,7 +138,7 @@ describe('Bun Serve Integration', () => {
 test('does not create transactions for OPTIONS or HEAD requests', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand All@@ -165,7 +164,7 @@ describe('Bun Serve Integration', () => {

 test('intruments the server again if it is reloaded', async () => {
 let serverWasInstrumented = false;
 client.on('spanEnd', () => {
 client?.on('spanEnd', () => {
 serverWasInstrumented = true;
 });

Expand Down

41 changes: 36 additions & 5 deletions
packages/bun/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,51 @@
import { describe, expect, test } from 'bun:test';

import type { BaseTransportOptions, Envelope, Event, Transport, TransportMakeRequestResponse } from '@sentry/core';
import type { NodeClient } from '../src/index';
import { init } from '../src/index';

const envelopes: Envelope[] = [];

function testTransport(_options: BaseTransportOptions): Transport {
 return {
 send(request: Envelope): Promise<TransportMakeRequestResponse> {
 envelopes.push(request);
 return Promise.resolve({ statusCode: 200 });
 },
 flush(): PromiseLike<boolean> {
 return new Promise(resolve => setTimeout(() => resolve(true), 100));
 },
 };
}

describe('Bun SDK', () => {
 const initOptions = {
 dsn: 'https://00000000000000000000000000000000@o000000.ingest.sentry.io/0000000',
 tracesSampleRate: 1,
 transport: testTransport,
 };

 test("calling init shouldn't fail", () => {
 test('SDK works as expected', async () => {
 let client: NodeClient | undefined;
 expect(() => {
 init(initOptions);
client = init(initOptions);
 }).not.toThrow();
 });

 test('should return client from init', () => {
 expect(init(initOptions)).not.toBeUndefined();
 expect(client).not.toBeUndefined();

 client?.captureException(new Error('test'));
 client?.flush();

 await new Promise(resolve => setTimeout(resolve, 1000));

 expect(envelopes.length).toBe(1);

 const envelope = envelopes[0];
 const event = envelope?.[1][0][1] as Event;

 expect(event.sdk?.name).toBe('sentry.javascript.bun');

 expect(event.exception?.values?.[0]?.type).toBe('Error');
 expect(event.exception?.values?.[0]?.value).toBe('test');
 });
});

, '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
fix(bun): Includes correct sdk metadata#15459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Feb 20, 2025
 Merged


fix(bun): Includes correct sdk metadata
#15459
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7298f74

fix(bun): Includes correct sdk metadata


timfish Feb 20, 2025
8cbb0dd

doc


timfish Feb 20, 2025
97335ea

Fix serve test


timfish Feb 20, 2025
63fdd55

Biome linting is seperate?


timfish Feb 20, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 1 addition & 4 deletions
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,7 @@ import { ServerRuntimeClient, applySdkMetadata } from '@sentry/core';
import type { BunClientOptions } from './types';

/**
 * The Sentry Bun SDK Client.
 *
 * @see BunClientOptions for documentation on configuration options.
 * @see SentryClient for usage documentation.
 * @deprecated This client is no longer used in v9.
 */
export class BunClient extends ServerRuntimeClient<BunClientOptions> {
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export {

export type { BunOptions } from './types';

// eslint-disable-next-line deprecation/deprecation
export { BunClient } from './client';
export { getDefaultIntegrations, init } from './sdk';
export { bunServerIntegration } from './integrations/bunserver';
Expand Down

15 changes: 12 additions & 3 deletions
packages/bun/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import * as os from 'node:os';
import {
 applySdkMetadata,
 functionToStringIntegration,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand All@@ -18,7 +20,6 @@ import {
 onUnhandledRejectionIntegration,
} from '@sentry/node';

import { BunClient } from './client';
import { bunServerIntegration } from './integrations/bunserver';
import { makeFetchTransport } from './transports';
import type { BunOptions } from './types';
Expand DownExpand Up@@ -92,8 +93,16 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
 *
 * @see {@link BunOptions} for documentation on configuration options.
 */
export function init(options: BunOptions = {}): NodeClient | undefined {
 options.clientClass = BunClient;
export function init(userOptions: BunOptions = {}): NodeClient | undefined {
 applySdkMetadata(userOptions, 'bun');

 const options = {
 ...userOptions,
 platform: 'javascript',
 runtime: { name: 'bun', version: Bun.version },
 serverName: userOptions.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };

 options.transport = options.transport || makeFetchTransport;

 if (options.defaultIntegrations === undefined) {
Expand Down

9 changes: 0 additions & 9 deletions
packages/bun/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import type { ClientOptions, Options, TracePropagationTargets } from '@sentry/core';

import type { BunClient } from './client';
import type { BunTransportOptions } from './transports';

export interface BaseBunOptions {
Expand All@@ -25,14 +24,6 @@ export interface BaseBunOptions {
 /** Sets an optional server name (device name) */
 serverName?: string;

 /**
 * Specify a custom BunClient to be used. Must extend BunClient!
 * This is not a public, supported API, but used internally only.
 *
 * @hidden
 * */
 clientClass?: typeof BunClient;

 /** Callback that is executed when a fatal global error occurs. */
 onFatalError?(this: void, error: Error): void;
}
Expand Down

21 changes: 10 additions & 11 deletions
packages/bun/test/integrations/bunserver.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { afterEach, beforeAll, beforeEach, describe, expect, test } from 'bun:test';
import type { Span } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, setCurrentClient, spanIsSampled, spanToJSON } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, spanIsSampled, spanToJSON } from '@sentry/core';

import { BunClient } from '../../src/client';
import { init } from '../../src';
import type { NodeClient } from '../../src';
import { instrumentBunServe } from '../../src/integrations/bunserver';
import { getDefaultBunClientOptions } from '../helpers';

describe('Bun Serve Integration', () => {
 let client: BunClient;
 let client: NodeClient | undefined;
 // Fun fact: Bun = 2 21 14 :)
 let port: number = 22114;

Expand All@@ -17,9 +18,7 @@ describe('Bun Serve Integration', () => {

 beforeEach(() => {
 const options = getDefaultBunClientOptions({ tracesSampleRate: 1 });
 client = new BunClient(options);
 setCurrentClient(client);
 client.init();
 client = init(options);
 });

 afterEach(() => {
Expand All@@ -31,7 +30,7 @@ describe('Bun Serve Integration', () => {
 test('generates a transaction around a request', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -66,7 +65,7 @@ describe('Bun Serve Integration', () => {
 test('generates a post transaction', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -103,7 +102,7 @@ describe('Bun Serve Integration', () => {

 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -139,7 +138,7 @@ describe('Bun Serve Integration', () => {
 test('does not create transactions for OPTIONS or HEAD requests', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand All@@ -165,7 +164,7 @@ describe('Bun Serve Integration', () => {

 test('intruments the server again if it is reloaded', async () => {
 let serverWasInstrumented = false;
 client.on('spanEnd', () => {
 client?.on('spanEnd', () => {
 serverWasInstrumented = true;
 });

Expand Down

41 changes: 36 additions & 5 deletions
packages/bun/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,51 @@
import { describe, expect, test } from 'bun:test';

import type { BaseTransportOptions, Envelope, Event, Transport, TransportMakeRequestResponse } from '@sentry/core';
import type { NodeClient } from '../src/index';
import { init } from '../src/index';

const envelopes: Envelope[] = [];

function testTransport(_options: BaseTransportOptions): Transport {
 return {
 send(request: Envelope): Promise<TransportMakeRequestResponse> {
 envelopes.push(request);
 return Promise.resolve({ statusCode: 200 });
 },
 flush(): PromiseLike<boolean> {
 return new Promise(resolve => setTimeout(() => resolve(true), 100));
 },
 };
}

describe('Bun SDK', () => {
 const initOptions = {
 dsn: 'https://00000000000000000000000000000000@o000000.ingest.sentry.io/0000000',
 tracesSampleRate: 1,
 transport: testTransport,
 };

 test("calling init shouldn't fail", () => {
 test('SDK works as expected', async () => {
 let client: NodeClient | undefined;
 expect(() => {
 init(initOptions);
client = init(initOptions);
 }).not.toThrow();
 });

 test('should return client from init', () => {
 expect(init(initOptions)).not.toBeUndefined();
 expect(client).not.toBeUndefined();

 client?.captureException(new Error('test'));
 client?.flush();

 await new Promise(resolve => setTimeout(resolve, 1000));

 expect(envelopes.length).toBe(1);

 const envelope = envelopes[0];
 const event = envelope?.[1][0][1] as Event;

 expect(event.sdk?.name).toBe('sentry.javascript.bun');

 expect(event.exception?.values?.[0]?.type).toBe('Error');
 expect(event.exception?.values?.[0]?.value).toBe('test');
 });
});

, '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
fix(bun): Includes correct sdk metadata#15459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Feb 20, 2025
 Merged


fix(bun): Includes correct sdk metadata
#15459
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7298f74

fix(bun): Includes correct sdk metadata


timfish Feb 20, 2025
8cbb0dd

doc


timfish Feb 20, 2025
97335ea

Fix serve test


timfish Feb 20, 2025
63fdd55

Biome linting is seperate?


timfish Feb 20, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 1 addition & 4 deletions
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,7 @@ import { ServerRuntimeClient, applySdkMetadata } from '@sentry/core';
import type { BunClientOptions } from './types';

/**
 * The Sentry Bun SDK Client.
 *
 * @see BunClientOptions for documentation on configuration options.
 * @see SentryClient for usage documentation.
 * @deprecated This client is no longer used in v9.
 */
export class BunClient extends ServerRuntimeClient<BunClientOptions> {
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export {

export type { BunOptions } from './types';

// eslint-disable-next-line deprecation/deprecation
export { BunClient } from './client';
export { getDefaultIntegrations, init } from './sdk';
export { bunServerIntegration } from './integrations/bunserver';
Expand Down

15 changes: 12 additions & 3 deletions
packages/bun/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import * as os from 'node:os';
import {
 applySdkMetadata,
 functionToStringIntegration,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand All@@ -18,7 +20,6 @@ import {
 onUnhandledRejectionIntegration,
} from '@sentry/node';

import { BunClient } from './client';
import { bunServerIntegration } from './integrations/bunserver';
import { makeFetchTransport } from './transports';
import type { BunOptions } from './types';
Expand DownExpand Up@@ -92,8 +93,16 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
 *
 * @see {@link BunOptions} for documentation on configuration options.
 */
export function init(options: BunOptions = {}): NodeClient | undefined {
 options.clientClass = BunClient;
export function init(userOptions: BunOptions = {}): NodeClient | undefined {
 applySdkMetadata(userOptions, 'bun');

 const options = {
 ...userOptions,
 platform: 'javascript',
 runtime: { name: 'bun', version: Bun.version },
 serverName: userOptions.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };

 options.transport = options.transport || makeFetchTransport;

 if (options.defaultIntegrations === undefined) {
Expand Down

9 changes: 0 additions & 9 deletions
packages/bun/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import type { ClientOptions, Options, TracePropagationTargets } from '@sentry/core';

import type { BunClient } from './client';
import type { BunTransportOptions } from './transports';

export interface BaseBunOptions {
Expand All@@ -25,14 +24,6 @@ export interface BaseBunOptions {
 /** Sets an optional server name (device name) */
 serverName?: string;

 /**
 * Specify a custom BunClient to be used. Must extend BunClient!
 * This is not a public, supported API, but used internally only.
 *
 * @hidden
 * */
 clientClass?: typeof BunClient;

 /** Callback that is executed when a fatal global error occurs. */
 onFatalError?(this: void, error: Error): void;
}
Expand Down

21 changes: 10 additions & 11 deletions
packages/bun/test/integrations/bunserver.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { afterEach, beforeAll, beforeEach, describe, expect, test } from 'bun:test';
import type { Span } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, setCurrentClient, spanIsSampled, spanToJSON } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, spanIsSampled, spanToJSON } from '@sentry/core';

import { BunClient } from '../../src/client';
import { init } from '../../src';
import type { NodeClient } from '../../src';
import { instrumentBunServe } from '../../src/integrations/bunserver';
import { getDefaultBunClientOptions } from '../helpers';

describe('Bun Serve Integration', () => {
 let client: BunClient;
 let client: NodeClient | undefined;
 // Fun fact: Bun = 2 21 14 :)
 let port: number = 22114;

Expand All@@ -17,9 +18,7 @@ describe('Bun Serve Integration', () => {

 beforeEach(() => {
 const options = getDefaultBunClientOptions({ tracesSampleRate: 1 });
 client = new BunClient(options);
 setCurrentClient(client);
 client.init();
 client = init(options);
 });

 afterEach(() => {
Expand All@@ -31,7 +30,7 @@ describe('Bun Serve Integration', () => {
 test('generates a transaction around a request', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -66,7 +65,7 @@ describe('Bun Serve Integration', () => {
 test('generates a post transaction', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -103,7 +102,7 @@ describe('Bun Serve Integration', () => {

 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -139,7 +138,7 @@ describe('Bun Serve Integration', () => {
 test('does not create transactions for OPTIONS or HEAD requests', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand All@@ -165,7 +164,7 @@ describe('Bun Serve Integration', () => {

 test('intruments the server again if it is reloaded', async () => {
 let serverWasInstrumented = false;
 client.on('spanEnd', () => {
 client?.on('spanEnd', () => {
 serverWasInstrumented = true;
 });

Expand Down

41 changes: 36 additions & 5 deletions
packages/bun/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,51 @@
import { describe, expect, test } from 'bun:test';

import type { BaseTransportOptions, Envelope, Event, Transport, TransportMakeRequestResponse } from '@sentry/core';
import type { NodeClient } from '../src/index';
import { init } from '../src/index';

const envelopes: Envelope[] = [];

function testTransport(_options: BaseTransportOptions): Transport {
 return {
 send(request: Envelope): Promise<TransportMakeRequestResponse> {
 envelopes.push(request);
 return Promise.resolve({ statusCode: 200 });
 },
 flush(): PromiseLike<boolean> {
 return new Promise(resolve => setTimeout(() => resolve(true), 100));
 },
 };
}

describe('Bun SDK', () => {
 const initOptions = {
 dsn: 'https://00000000000000000000000000000000@o000000.ingest.sentry.io/0000000',
 tracesSampleRate: 1,
 transport: testTransport,
 };

 test("calling init shouldn't fail", () => {
 test('SDK works as expected', async () => {
 let client: NodeClient | undefined;
 expect(() => {
 init(initOptions);
client = init(initOptions);
 }).not.toThrow();
 });

 test('should return client from init', () => {
 expect(init(initOptions)).not.toBeUndefined();
 expect(client).not.toBeUndefined();

 client?.captureException(new Error('test'));
 client?.flush();

 await new Promise(resolve => setTimeout(resolve, 1000));

 expect(envelopes.length).toBe(1);

 const envelope = envelopes[0];
 const event = envelope?.[1][0][1] as Event;

 expect(event.sdk?.name).toBe('sentry.javascript.bun');

 expect(event.exception?.values?.[0]?.type).toBe('Error');
 expect(event.exception?.values?.[0]?.value).toBe('test');
 });
});

, '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
fix(bun): Includes correct sdk metadata#15459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Feb 20, 2025
 Merged


fix(bun): Includes correct sdk metadata
#15459
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7298f74

fix(bun): Includes correct sdk metadata


timfish Feb 20, 2025
8cbb0dd

doc


timfish Feb 20, 2025
97335ea

Fix serve test


timfish Feb 20, 2025
63fdd55

Biome linting is seperate?


timfish Feb 20, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 1 addition & 4 deletions
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,7 @@ import { ServerRuntimeClient, applySdkMetadata } from '@sentry/core';
import type { BunClientOptions } from './types';

/**
 * The Sentry Bun SDK Client.
 *
 * @see BunClientOptions for documentation on configuration options.
 * @see SentryClient for usage documentation.
 * @deprecated This client is no longer used in v9.
 */
export class BunClient extends ServerRuntimeClient<BunClientOptions> {
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export {

export type { BunOptions } from './types';

// eslint-disable-next-line deprecation/deprecation
export { BunClient } from './client';
export { getDefaultIntegrations, init } from './sdk';
export { bunServerIntegration } from './integrations/bunserver';
Expand Down

15 changes: 12 additions & 3 deletions
packages/bun/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import * as os from 'node:os';
import {
 applySdkMetadata,
 functionToStringIntegration,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand All@@ -18,7 +20,6 @@ import {
 onUnhandledRejectionIntegration,
} from '@sentry/node';

import { BunClient } from './client';
import { bunServerIntegration } from './integrations/bunserver';
import { makeFetchTransport } from './transports';
import type { BunOptions } from './types';
Expand DownExpand Up@@ -92,8 +93,16 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
 *
 * @see {@link BunOptions} for documentation on configuration options.
 */
export function init(options: BunOptions = {}): NodeClient | undefined {
 options.clientClass = BunClient;
export function init(userOptions: BunOptions = {}): NodeClient | undefined {
 applySdkMetadata(userOptions, 'bun');

 const options = {
 ...userOptions,
 platform: 'javascript',
 runtime: { name: 'bun', version: Bun.version },
 serverName: userOptions.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };

 options.transport = options.transport || makeFetchTransport;

 if (options.defaultIntegrations === undefined) {
Expand Down

9 changes: 0 additions & 9 deletions
packages/bun/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import type { ClientOptions, Options, TracePropagationTargets } from '@sentry/core';

import type { BunClient } from './client';
import type { BunTransportOptions } from './transports';

export interface BaseBunOptions {
Expand All@@ -25,14 +24,6 @@ export interface BaseBunOptions {
 /** Sets an optional server name (device name) */
 serverName?: string;

 /**
 * Specify a custom BunClient to be used. Must extend BunClient!
 * This is not a public, supported API, but used internally only.
 *
 * @hidden
 * */
 clientClass?: typeof BunClient;

 /** Callback that is executed when a fatal global error occurs. */
 onFatalError?(this: void, error: Error): void;
}
Expand Down

21 changes: 10 additions & 11 deletions
packages/bun/test/integrations/bunserver.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { afterEach, beforeAll, beforeEach, describe, expect, test } from 'bun:test';
import type { Span } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, setCurrentClient, spanIsSampled, spanToJSON } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, spanIsSampled, spanToJSON } from '@sentry/core';

import { BunClient } from '../../src/client';
import { init } from '../../src';
import type { NodeClient } from '../../src';
import { instrumentBunServe } from '../../src/integrations/bunserver';
import { getDefaultBunClientOptions } from '../helpers';

describe('Bun Serve Integration', () => {
 let client: BunClient;
 let client: NodeClient | undefined;
 // Fun fact: Bun = 2 21 14 :)
 let port: number = 22114;

Expand All@@ -17,9 +18,7 @@ describe('Bun Serve Integration', () => {

 beforeEach(() => {
 const options = getDefaultBunClientOptions({ tracesSampleRate: 1 });
 client = new BunClient(options);
 setCurrentClient(client);
 client.init();
 client = init(options);
 });

 afterEach(() => {
Expand All@@ -31,7 +30,7 @@ describe('Bun Serve Integration', () => {
 test('generates a transaction around a request', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -66,7 +65,7 @@ describe('Bun Serve Integration', () => {
 test('generates a post transaction', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -103,7 +102,7 @@ describe('Bun Serve Integration', () => {

 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -139,7 +138,7 @@ describe('Bun Serve Integration', () => {
 test('does not create transactions for OPTIONS or HEAD requests', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand All@@ -165,7 +164,7 @@ describe('Bun Serve Integration', () => {

 test('intruments the server again if it is reloaded', async () => {
 let serverWasInstrumented = false;
 client.on('spanEnd', () => {
 client?.on('spanEnd', () => {
 serverWasInstrumented = true;
 });

Expand Down

41 changes: 36 additions & 5 deletions
packages/bun/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,51 @@
import { describe, expect, test } from 'bun:test';

import type { BaseTransportOptions, Envelope, Event, Transport, TransportMakeRequestResponse } from '@sentry/core';
import type { NodeClient } from '../src/index';
import { init } from '../src/index';

const envelopes: Envelope[] = [];

function testTransport(_options: BaseTransportOptions): Transport {
 return {
 send(request: Envelope): Promise<TransportMakeRequestResponse> {
 envelopes.push(request);
 return Promise.resolve({ statusCode: 200 });
 },
 flush(): PromiseLike<boolean> {
 return new Promise(resolve => setTimeout(() => resolve(true), 100));
 },
 };
}

describe('Bun SDK', () => {
 const initOptions = {
 dsn: 'https://00000000000000000000000000000000@o000000.ingest.sentry.io/0000000',
 tracesSampleRate: 1,
 transport: testTransport,
 };

 test("calling init shouldn't fail", () => {
 test('SDK works as expected', async () => {
 let client: NodeClient | undefined;
 expect(() => {
 init(initOptions);
client = init(initOptions);
 }).not.toThrow();
 });

 test('should return client from init', () => {
 expect(init(initOptions)).not.toBeUndefined();
 expect(client).not.toBeUndefined();

 client?.captureException(new Error('test'));
 client?.flush();

 await new Promise(resolve => setTimeout(resolve, 1000));

 expect(envelopes.length).toBe(1);

 const envelope = envelopes[0];
 const event = envelope?.[1][0][1] as Event;

 expect(event.sdk?.name).toBe('sentry.javascript.bun');

 expect(event.exception?.values?.[0]?.type).toBe('Error');
 expect(event.exception?.values?.[0]?.value).toBe('test');
 });
});

, '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
fix(bun): Includes correct sdk metadata#15459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Feb 20, 2025
 Merged


fix(bun): Includes correct sdk metadata
#15459
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7298f74

fix(bun): Includes correct sdk metadata


timfish Feb 20, 2025
8cbb0dd

doc


timfish Feb 20, 2025
97335ea

Fix serve test


timfish Feb 20, 2025
63fdd55

Biome linting is seperate?


timfish Feb 20, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 1 addition & 4 deletions
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,7 @@ import { ServerRuntimeClient, applySdkMetadata } from '@sentry/core';
import type { BunClientOptions } from './types';

/**
 * The Sentry Bun SDK Client.
 *
 * @see BunClientOptions for documentation on configuration options.
 * @see SentryClient for usage documentation.
 * @deprecated This client is no longer used in v9.
 */
export class BunClient extends ServerRuntimeClient<BunClientOptions> {
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export {

export type { BunOptions } from './types';

// eslint-disable-next-line deprecation/deprecation
export { BunClient } from './client';
export { getDefaultIntegrations, init } from './sdk';
export { bunServerIntegration } from './integrations/bunserver';
Expand Down

15 changes: 12 additions & 3 deletions
packages/bun/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import * as os from 'node:os';
import {
 applySdkMetadata,
 functionToStringIntegration,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand All@@ -18,7 +20,6 @@ import {
 onUnhandledRejectionIntegration,
} from '@sentry/node';

import { BunClient } from './client';
import { bunServerIntegration } from './integrations/bunserver';
import { makeFetchTransport } from './transports';
import type { BunOptions } from './types';
Expand DownExpand Up@@ -92,8 +93,16 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
 *
 * @see {@link BunOptions} for documentation on configuration options.
 */
export function init(options: BunOptions = {}): NodeClient | undefined {
 options.clientClass = BunClient;
export function init(userOptions: BunOptions = {}): NodeClient | undefined {
 applySdkMetadata(userOptions, 'bun');

 const options = {
 ...userOptions,
 platform: 'javascript',
 runtime: { name: 'bun', version: Bun.version },
 serverName: userOptions.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };

 options.transport = options.transport || makeFetchTransport;

 if (options.defaultIntegrations === undefined) {
Expand Down

9 changes: 0 additions & 9 deletions
packages/bun/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import type { ClientOptions, Options, TracePropagationTargets } from '@sentry/core';

import type { BunClient } from './client';
import type { BunTransportOptions } from './transports';

export interface BaseBunOptions {
Expand All@@ -25,14 +24,6 @@ export interface BaseBunOptions {
 /** Sets an optional server name (device name) */
 serverName?: string;

 /**
 * Specify a custom BunClient to be used. Must extend BunClient!
 * This is not a public, supported API, but used internally only.
 *
 * @hidden
 * */
 clientClass?: typeof BunClient;

 /** Callback that is executed when a fatal global error occurs. */
 onFatalError?(this: void, error: Error): void;
}
Expand Down

21 changes: 10 additions & 11 deletions
packages/bun/test/integrations/bunserver.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { afterEach, beforeAll, beforeEach, describe, expect, test } from 'bun:test';
import type { Span } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, setCurrentClient, spanIsSampled, spanToJSON } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, spanIsSampled, spanToJSON } from '@sentry/core';

import { BunClient } from '../../src/client';
import { init } from '../../src';
import type { NodeClient } from '../../src';
import { instrumentBunServe } from '../../src/integrations/bunserver';
import { getDefaultBunClientOptions } from '../helpers';

describe('Bun Serve Integration', () => {
 let client: BunClient;
 let client: NodeClient | undefined;
 // Fun fact: Bun = 2 21 14 :)
 let port: number = 22114;

Expand All@@ -17,9 +18,7 @@ describe('Bun Serve Integration', () => {

 beforeEach(() => {
 const options = getDefaultBunClientOptions({ tracesSampleRate: 1 });
 client = new BunClient(options);
 setCurrentClient(client);
 client.init();
 client = init(options);
 });

 afterEach(() => {
Expand All@@ -31,7 +30,7 @@ describe('Bun Serve Integration', () => {
 test('generates a transaction around a request', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -66,7 +65,7 @@ describe('Bun Serve Integration', () => {
 test('generates a post transaction', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -103,7 +102,7 @@ describe('Bun Serve Integration', () => {

 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -139,7 +138,7 @@ describe('Bun Serve Integration', () => {
 test('does not create transactions for OPTIONS or HEAD requests', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand All@@ -165,7 +164,7 @@ describe('Bun Serve Integration', () => {

 test('intruments the server again if it is reloaded', async () => {
 let serverWasInstrumented = false;
 client.on('spanEnd', () => {
 client?.on('spanEnd', () => {
 serverWasInstrumented = true;
 });

Expand Down

41 changes: 36 additions & 5 deletions
packages/bun/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,51 @@
import { describe, expect, test } from 'bun:test';

import type { BaseTransportOptions, Envelope, Event, Transport, TransportMakeRequestResponse } from '@sentry/core';
import type { NodeClient } from '../src/index';
import { init } from '../src/index';

const envelopes: Envelope[] = [];

function testTransport(_options: BaseTransportOptions): Transport {
 return {
 send(request: Envelope): Promise<TransportMakeRequestResponse> {
 envelopes.push(request);
 return Promise.resolve({ statusCode: 200 });
 },
 flush(): PromiseLike<boolean> {
 return new Promise(resolve => setTimeout(() => resolve(true), 100));
 },
 };
}

describe('Bun SDK', () => {
 const initOptions = {
 dsn: 'https://00000000000000000000000000000000@o000000.ingest.sentry.io/0000000',
 tracesSampleRate: 1,
 transport: testTransport,
 };

 test("calling init shouldn't fail", () => {
 test('SDK works as expected', async () => {
 let client: NodeClient | undefined;
 expect(() => {
 init(initOptions);
client = init(initOptions);
 }).not.toThrow();
 });

 test('should return client from init', () => {
 expect(init(initOptions)).not.toBeUndefined();
 expect(client).not.toBeUndefined();

 client?.captureException(new Error('test'));
 client?.flush();

 await new Promise(resolve => setTimeout(resolve, 1000));

 expect(envelopes.length).toBe(1);

 const envelope = envelopes[0];
 const event = envelope?.[1][0][1] as Event;

 expect(event.sdk?.name).toBe('sentry.javascript.bun');

 expect(event.exception?.values?.[0]?.type).toBe('Error');
 expect(event.exception?.values?.[0]?.value).toBe('test');
 });
});

, '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
fix(bun): Includes correct sdk metadata#15459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

AbhiPrasad
merged 4 commits into

from

Feb 20, 2025
 Merged


fix(bun): Includes correct sdk metadata
#15459
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
7298f74

fix(bun): Includes correct sdk metadata


timfish Feb 20, 2025
8cbb0dd

doc


timfish Feb 20, 2025
97335ea

Fix serve test


timfish Feb 20, 2025
63fdd55

Biome linting is seperate?


timfish Feb 20, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 1 addition & 4 deletions
packages/bun/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,7 @@ import { ServerRuntimeClient, applySdkMetadata } from '@sentry/core';
import type { BunClientOptions } from './types';

/**
 * The Sentry Bun SDK Client.
 *
 * @see BunClientOptions for documentation on configuration options.
 * @see SentryClient for usage documentation.
 * @deprecated This client is no longer used in v9.
 */
export class BunClient extends ServerRuntimeClient<BunClientOptions> {
 /**
Expand Down

1 change: 1 addition & 0 deletions
packages/bun/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,6 +141,7 @@ export {

export type { BunOptions } from './types';

// eslint-disable-next-line deprecation/deprecation
export { BunClient } from './client';
export { getDefaultIntegrations, init } from './sdk';
export { bunServerIntegration } from './integrations/bunserver';
Expand Down

15 changes: 12 additions & 3 deletions
packages/bun/src/sdk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import * as os from 'node:os';
import {
 applySdkMetadata,
 functionToStringIntegration,
 inboundFiltersIntegration,
 linkedErrorsIntegration,
Expand All@@ -18,7 +20,6 @@ import {
 onUnhandledRejectionIntegration,
} from '@sentry/node';

import { BunClient } from './client';
import { bunServerIntegration } from './integrations/bunserver';
import { makeFetchTransport } from './transports';
import type { BunOptions } from './types';
Expand DownExpand Up@@ -92,8 +93,16 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
 *
 * @see {@link BunOptions} for documentation on configuration options.
 */
export function init(options: BunOptions = {}): NodeClient | undefined {
 options.clientClass = BunClient;
export function init(userOptions: BunOptions = {}): NodeClient | undefined {
 applySdkMetadata(userOptions, 'bun');

 const options = {
 ...userOptions,
 platform: 'javascript',
 runtime: { name: 'bun', version: Bun.version },
 serverName: userOptions.serverName || global.process.env.SENTRY_NAME || os.hostname(),
 };

 options.transport = options.transport || makeFetchTransport;

 if (options.defaultIntegrations === undefined) {
Expand Down

9 changes: 0 additions & 9 deletions
packages/bun/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import type { ClientOptions, Options, TracePropagationTargets } from '@sentry/core';

import type { BunClient } from './client';
import type { BunTransportOptions } from './transports';

export interface BaseBunOptions {
Expand All@@ -25,14 +24,6 @@ export interface BaseBunOptions {
 /** Sets an optional server name (device name) */
 serverName?: string;

 /**
 * Specify a custom BunClient to be used. Must extend BunClient!
 * This is not a public, supported API, but used internally only.
 *
 * @hidden
 * */
 clientClass?: typeof BunClient;

 /** Callback that is executed when a fatal global error occurs. */
 onFatalError?(this: void, error: Error): void;
}
Expand Down

21 changes: 10 additions & 11 deletions
packages/bun/test/integrations/bunserver.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
import { afterEach, beforeAll, beforeEach, describe, expect, test } from 'bun:test';
import type { Span } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, setCurrentClient, spanIsSampled, spanToJSON } from '@sentry/core';
import { getDynamicSamplingContextFromSpan, spanIsSampled, spanToJSON } from '@sentry/core';

import { BunClient } from '../../src/client';
import { init } from '../../src';
import type { NodeClient } from '../../src';
import { instrumentBunServe } from '../../src/integrations/bunserver';
import { getDefaultBunClientOptions } from '../helpers';

describe('Bun Serve Integration', () => {
 let client: BunClient;
 let client: NodeClient | undefined;
 // Fun fact: Bun = 2 21 14 :)
 let port: number = 22114;

Expand All@@ -17,9 +18,7 @@ describe('Bun Serve Integration', () => {

 beforeEach(() => {
 const options = getDefaultBunClientOptions({ tracesSampleRate: 1 });
 client = new BunClient(options);
 setCurrentClient(client);
 client.init();
 client = init(options);
 });

 afterEach(() => {
Expand All@@ -31,7 +30,7 @@ describe('Bun Serve Integration', () => {
 test('generates a transaction around a request', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -66,7 +65,7 @@ describe('Bun Serve Integration', () => {
 test('generates a post transaction', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -103,7 +102,7 @@ describe('Bun Serve Integration', () => {

 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand DownExpand Up@@ -139,7 +138,7 @@ describe('Bun Serve Integration', () => {
 test('does not create transactions for OPTIONS or HEAD requests', async () => {
 let generatedSpan: Span | undefined;

 client.on('spanEnd', span => {
 client?.on('spanEnd', span => {
 generatedSpan = span;
 });

Expand All@@ -165,7 +164,7 @@ describe('Bun Serve Integration', () => {

 test('intruments the server again if it is reloaded', async () => {
 let serverWasInstrumented = false;
 client.on('spanEnd', () => {
 client?.on('spanEnd', () => {
 serverWasInstrumented = true;
 });

Expand Down

41 changes: 36 additions & 5 deletions
packages/bun/test/sdk.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,51 @@
import { describe, expect, test } from 'bun:test';

import type { BaseTransportOptions, Envelope, Event, Transport, TransportMakeRequestResponse } from '@sentry/core';
import type { NodeClient } from '../src/index';
import { init } from '../src/index';

const envelopes: Envelope[] = [];

function testTransport(_options: BaseTransportOptions): Transport {
 return {
 send(request: Envelope): Promise<TransportMakeRequestResponse> {
 envelopes.push(request);
 return Promise.resolve({ statusCode: 200 });
 },
 flush(): PromiseLike<boolean> {
 return new Promise(resolve => setTimeout(() => resolve(true), 100));
 },
 };
}

describe('Bun SDK', () => {
 const initOptions = {
 dsn: 'https://00000000000000000000000000000000@o000000.ingest.sentry.io/0000000',
 tracesSampleRate: 1,
 transport: testTransport,
 };

 test("calling init shouldn't fail", () => {
 test('SDK works as expected', async () => {
 let client: NodeClient | undefined;
 expect(() => {
 init(initOptions);
client = init(initOptions);
 }).not.toThrow();
 });

 test('should return client from init', () => {
 expect(init(initOptions)).not.toBeUndefined();
 expect(client).not.toBeUndefined();

 client?.captureException(new Error('test'));
 client?.flush();

 await new Promise(resolve => setTimeout(resolve, 1000));

 expect(envelopes.length).toBe(1);

 const envelope = envelopes[0];
 const event = envelope?.[1][0][1] as Event;

 expect(event.sdk?.name).toBe('sentry.javascript.bun');

 expect(event.exception?.values?.[0]?.type).toBe('Error');
 expect(event.exception?.values?.[0]?.value).toBe('test');
 });
});