Skip to content

feat(cloudflare): Read SENTRY_RELEASE from env#16201

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 6 commits into from
May 7, 2025
Merged

feat(cloudflare): Read SENTRY_RELEASE from env#16201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fd592c6
feat(cloudflare): Read `SENTRY_RELEASE` from `env`
Lms24 May 5, 2025
49f8f76
ref and extract options merging helper, add to durable objects
Lms24 May 6, 2025
e49219f
simplify getFinalOptions
Lms24 May 6, 2025
858134d
lint
Lms24 May 6, 2025
04a1c54
Merge branch 'develop' into lms/feat-cloudflare-sentry-release-from-env
AbhiPrasad May 6, 2025
e0c18f6
Update packages/cloudflare/tsconfig.json
Lms24 May 6, 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
3 changes: 2 additions & 1 deletion packages/cloudflare/src/durableobject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

Expand DownExpand Up@@ -140,7 +141,7 @@ export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>
construct(target, [context, env]) {
setAsyncLocalStorageAsyncContextStrategy();

const options = optionsCallback(env);
const options = getFinalOptions(optionsCallback(env), env);

const obj = new target(context, env);

Expand Down
8 changes: 6 additions & 2 deletions packages/cloudflare/src/handler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import {
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
Expand All@@ -35,7 +36,9 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
handler.fetch = new Proxy(handler.fetch, {
apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
const [request, env, context] = args;
const options = optionsCallback(env);

const options = getFinalOptions(optionsCallback(env), env);

return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
},
});
Expand All@@ -48,7 +51,8 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
const [event, env, context] = args;
return withIsolationScope(isolationScope => {
const options = optionsCallback(env);
const options = getFinalOptions(optionsCallback(env), env);

const client = init(options);
isolationScope.setClient(client);

Expand Down
20 changes: 20 additions & 0 deletions packages/cloudflare/src/options.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
import type { CloudflareOptions } from './client';

/**
* Merges the options passed in from the user with the options we read from
* the Cloudflare `env` environment variable object.
*
* @param userOptions - The options passed in from the user.
* @param env - The environment variables.
*
* @returns The final options.
*/
export function getFinalOptions(userOptions: CloudflareOptions, env: unknown): CloudflareOptions {
if (typeof env !== 'object' || env === null) {
return userOptions;
}

const release = 'SENTRY_RELEASE' in env && typeof env.SENTRY_RELEASE === 'string' ? env.SENTRY_RELEASE : undefined;

return { release, ...userOptions };
}
109 changes: 109 additions & 0 deletions packages/cloudflare/test/handler.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { withSentry } from '../src/handler';

const MOCK_ENV = {
SENTRY_DSN: 'https://public@dsn.ingest.sentry.io/1337',
SENTRY_RELEASE: '1.1.1',
};

describe('withSentry', () => {
Expand DownExpand Up@@ -51,6 +52,65 @@ describe('withSentry', () => {

expect(result).toBe(response);
});

test('merges options from env and callback', async () => {
const handler = {
fetch(_request, _env, _context) {
throw new Error('test');
},
} satisfies ExportedHandler<typeof MOCK_ENV>;

let sentryEvent: Event = {};

const wrappedHandler = withSentry(
env => ({
dsn: env.SENTRY_DSN,
beforeSend(event) {
sentryEvent = event;
return null;
},
}),
handler,
);

try {
await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
} catch {
// ignore
}

expect(sentryEvent.release).toEqual('1.1.1');
});

test('callback options take precedence over env options', async () => {
const handler = {
fetch(_request, _env, _context) {
throw new Error('test');
},
} satisfies ExportedHandler<typeof MOCK_ENV>;

let sentryEvent: Event = {};

const wrappedHandler = withSentry(
env => ({
dsn: env.SENTRY_DSN,
release: '2.0.0',
beforeSend(event) {
sentryEvent = event;
return null;
},
}),
handler,
);

try {
await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
} catch {
// ignore
}

expect(sentryEvent.release).toEqual('2.0.0');
});
});

describe('scheduled handler', () => {
Expand All@@ -70,6 +130,55 @@ describe('withSentry', () => {
expect(optionsCallback).toHaveBeenLastCalledWith(MOCK_ENV);
});

test('merges options from env and callback', async () => {
const handler = {
scheduled(_controller, _env, _context) {
SentryCore.captureMessage('cloud_resource');
return;
},
} satisfies ExportedHandler<typeof MOCK_ENV>;

let sentryEvent: Event = {};
const wrappedHandler = withSentry(
env => ({
dsn: env.SENTRY_DSN,
beforeSend(event) {
sentryEvent = event;
return null;
},
}),
handler,
);
await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

expect(sentryEvent.release).toBe('1.1.1');
});

test('callback options take precedence over env options', async () => {
const handler = {
scheduled(_controller, _env, _context) {
SentryCore.captureMessage('cloud_resource');
return;
},
} satisfies ExportedHandler<typeof MOCK_ENV>;

let sentryEvent: Event = {};
const wrappedHandler = withSentry(
env => ({
dsn: env.SENTRY_DSN,
release: '2.0.0',
beforeSend(event) {
sentryEvent = event;
return null;
},
}),
handler,
);
await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

expect(sentryEvent.release).toEqual('2.0.0');
});

test('flushes the event after the handler is done using the cloudflare context.waitUntil', async () => {
const handler = {
scheduled(_controller, _env, _context) {
Expand Down
58 changes: 58 additions & 0 deletions packages/cloudflare/test/options.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
import { describe, expect, it } from 'vitest';
import { getFinalOptions } from '../src/options';

describe('getFinalOptions', () => {
it('returns user options when env is not an object', () => {
const userOptions = { dsn: 'test-dsn', release: 'test-release' };
const env = 'not-an-object';

const result = getFinalOptions(userOptions, env);

expect(result).toEqual(userOptions);
});

it('returns user options when env is null', () => {
const userOptions = { dsn: 'test-dsn', release: 'test-release' };
const env = null;

const result = getFinalOptions(userOptions, env);

expect(result).toEqual(userOptions);
});

it('merges options from env with user options', () => {
const userOptions = { dsn: 'test-dsn', release: 'user-release' };
const env = { SENTRY_RELEASE: 'env-release' };

const result = getFinalOptions(userOptions, env);

expect(result).toEqual({ dsn: 'test-dsn', release: 'user-release' });
});

it('uses user options when SENTRY_RELEASE exists but is not a string', () => {
const userOptions = { dsn: 'test-dsn', release: 'user-release' };
const env = { SENTRY_RELEASE: 123 };

const result = getFinalOptions(userOptions, env);

expect(result).toEqual(userOptions);
});

it('uses user options when SENTRY_RELEASE does not exist', () => {
const userOptions = { dsn: 'test-dsn', release: 'user-release' };
const env = { OTHER_VAR: 'some-value' };

const result = getFinalOptions(userOptions, env);

expect(result).toEqual(userOptions);
});

it('takes user options over env options', () => {
const userOptions = { dsn: 'test-dsn', release: 'user-release' };
const env = { SENTRY_RELEASE: 'env-release' };

const result = getFinalOptions(userOptions, env);

expect(result).toEqual(userOptions);
});
});
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(cloudflare): Read `SENTRY_RELEASE` from `env` by Lms24 · Pull Request #16201 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Read SENTRY_RELEASE from env#16201

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 6 commits into

from

May 7, 2025
 Merged


feat(cloudflare): Read SENTRY_RELEASE from env#16201
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fd592c6

feat(cloudflare): Read `SENTRY_RELEASE` from `env`


Lms24 May 5, 2025
49f8f76

ref and extract options merging helper, add to durable objects


Lms24 May 6, 2025
e49219f

simplify getFinalOptions


Lms24 May 6, 2025
858134d

lint


Lms24 May 6, 2025
04a1c54

Merge branch 'develop' into lms/feat-cloudflare-sentry-release-from-env


AbhiPrasad May 6, 2025
e0c18f6

Update packages/cloudflare/tsconfig.json


Lms24 May 6, 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


3 changes: 2 additions & 1 deletion
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

Expand DownExpand Up@@ -140,7 +141,7 @@ export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const obj = new target(context, env);

Expand Down

8 changes: 6 additions & 2 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import {
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
Expand All@@ -35,7 +36,9 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);

 const options = getFinalOptions(optionsCallback(env), env);

 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
Expand All@@ -48,7 +51,8 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const client = init(options);
 isolationScope.setClient(client);

Expand Down

20 changes: 20 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
import type { CloudflareOptions } from './client';

/**
 * Merges the options passed in from the user with the options we read from
 * the Cloudflare `env` environment variable object.
 *
 * @param userOptions - The options passed in from the user.
 * @param env - The environment variables.
 *
 * @returns The final options.
 */
export function getFinalOptions(userOptions: CloudflareOptions, env: unknown): CloudflareOptions {
 if (typeof env !== 'object' || env === null) {
 return userOptions;
 }

 const release = 'SENTRY_RELEASE' in env && typeof env.SENTRY_RELEASE === 'string' ? env.SENTRY_RELEASE : undefined;

 return { release, ...userOptions };
}

109 changes: 109 additions & 0 deletions
packages/cloudflare/test/handler.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { withSentry } from '../src/handler';

const MOCK_ENV = {
 SENTRY_DSN: 'https://public@dsn.ingest.sentry.io/1337',
 SENTRY_RELEASE: '1.1.1',
};

describe('withSentry', () => {
Expand DownExpand Up@@ -51,6 +52,65 @@ describe('withSentry', () => {

 expect(result).toBe(response);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('2.0.0');
 });
 });

 describe('scheduled handler', () => {
Expand All@@ -70,6 +130,55 @@ describe('withSentry', () => {
 expect(optionsCallback).toHaveBeenLastCalledWith(MOCK_ENV);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toBe('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toEqual('2.0.0');
 });

 test('flushes the event after the handler is done using the cloudflare context.waitUntil', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
Expand Down

58 changes: 58 additions & 0 deletions
packages/cloudflare/test/options.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
import { describe, expect, it } from 'vitest';
import { getFinalOptions } from '../src/options';

describe('getFinalOptions', () => {
 it('returns user options when env is not an object', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = 'not-an-object';

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('returns user options when env is null', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = null;

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('merges options from env with user options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual({ dsn: 'test-dsn', release: 'user-release' });
 });

 it('uses user options when SENTRY_RELEASE exists but is not a string', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 123 };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('uses user options when SENTRY_RELEASE does not exist', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { OTHER_VAR: 'some-value' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('takes user options over env options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });
});

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

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 6 commits into

from

May 7, 2025
 Merged


feat(cloudflare): Read SENTRY_RELEASE from env#16201
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fd592c6

feat(cloudflare): Read `SENTRY_RELEASE` from `env`


Lms24 May 5, 2025
49f8f76

ref and extract options merging helper, add to durable objects


Lms24 May 6, 2025
e49219f

simplify getFinalOptions


Lms24 May 6, 2025
858134d

lint


Lms24 May 6, 2025
04a1c54

Merge branch 'develop' into lms/feat-cloudflare-sentry-release-from-env


AbhiPrasad May 6, 2025
e0c18f6

Update packages/cloudflare/tsconfig.json


Lms24 May 6, 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


3 changes: 2 additions & 1 deletion
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

Expand DownExpand Up@@ -140,7 +141,7 @@ export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const obj = new target(context, env);

Expand Down

8 changes: 6 additions & 2 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import {
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
Expand All@@ -35,7 +36,9 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);

 const options = getFinalOptions(optionsCallback(env), env);

 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
Expand All@@ -48,7 +51,8 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const client = init(options);
 isolationScope.setClient(client);

Expand Down

20 changes: 20 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
import type { CloudflareOptions } from './client';

/**
 * Merges the options passed in from the user with the options we read from
 * the Cloudflare `env` environment variable object.
 *
 * @param userOptions - The options passed in from the user.
 * @param env - The environment variables.
 *
 * @returns The final options.
 */
export function getFinalOptions(userOptions: CloudflareOptions, env: unknown): CloudflareOptions {
 if (typeof env !== 'object' || env === null) {
 return userOptions;
 }

 const release = 'SENTRY_RELEASE' in env && typeof env.SENTRY_RELEASE === 'string' ? env.SENTRY_RELEASE : undefined;

 return { release, ...userOptions };
}

109 changes: 109 additions & 0 deletions
packages/cloudflare/test/handler.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { withSentry } from '../src/handler';

const MOCK_ENV = {
 SENTRY_DSN: 'https://public@dsn.ingest.sentry.io/1337',
 SENTRY_RELEASE: '1.1.1',
};

describe('withSentry', () => {
Expand DownExpand Up@@ -51,6 +52,65 @@ describe('withSentry', () => {

 expect(result).toBe(response);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('2.0.0');
 });
 });

 describe('scheduled handler', () => {
Expand All@@ -70,6 +130,55 @@ describe('withSentry', () => {
 expect(optionsCallback).toHaveBeenLastCalledWith(MOCK_ENV);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toBe('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toEqual('2.0.0');
 });

 test('flushes the event after the handler is done using the cloudflare context.waitUntil', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
Expand Down

58 changes: 58 additions & 0 deletions
packages/cloudflare/test/options.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
import { describe, expect, it } from 'vitest';
import { getFinalOptions } from '../src/options';

describe('getFinalOptions', () => {
 it('returns user options when env is not an object', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = 'not-an-object';

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('returns user options when env is null', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = null;

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('merges options from env with user options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual({ dsn: 'test-dsn', release: 'user-release' });
 });

 it('uses user options when SENTRY_RELEASE exists but is not a string', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 123 };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('uses user options when SENTRY_RELEASE does not exist', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { OTHER_VAR: 'some-value' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('takes user options over env options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });
});

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

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 6 commits into

from

May 7, 2025
 Merged


feat(cloudflare): Read SENTRY_RELEASE from env#16201
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fd592c6

feat(cloudflare): Read `SENTRY_RELEASE` from `env`


Lms24 May 5, 2025
49f8f76

ref and extract options merging helper, add to durable objects


Lms24 May 6, 2025
e49219f

simplify getFinalOptions


Lms24 May 6, 2025
858134d

lint


Lms24 May 6, 2025
04a1c54

Merge branch 'develop' into lms/feat-cloudflare-sentry-release-from-env


AbhiPrasad May 6, 2025
e0c18f6

Update packages/cloudflare/tsconfig.json


Lms24 May 6, 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


3 changes: 2 additions & 1 deletion
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

Expand DownExpand Up@@ -140,7 +141,7 @@ export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const obj = new target(context, env);

Expand Down

8 changes: 6 additions & 2 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import {
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
Expand All@@ -35,7 +36,9 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);

 const options = getFinalOptions(optionsCallback(env), env);

 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
Expand All@@ -48,7 +51,8 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const client = init(options);
 isolationScope.setClient(client);

Expand Down

20 changes: 20 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
import type { CloudflareOptions } from './client';

/**
 * Merges the options passed in from the user with the options we read from
 * the Cloudflare `env` environment variable object.
 *
 * @param userOptions - The options passed in from the user.
 * @param env - The environment variables.
 *
 * @returns The final options.
 */
export function getFinalOptions(userOptions: CloudflareOptions, env: unknown): CloudflareOptions {
 if (typeof env !== 'object' || env === null) {
 return userOptions;
 }

 const release = 'SENTRY_RELEASE' in env && typeof env.SENTRY_RELEASE === 'string' ? env.SENTRY_RELEASE : undefined;

 return { release, ...userOptions };
}

109 changes: 109 additions & 0 deletions
packages/cloudflare/test/handler.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { withSentry } from '../src/handler';

const MOCK_ENV = {
 SENTRY_DSN: 'https://public@dsn.ingest.sentry.io/1337',
 SENTRY_RELEASE: '1.1.1',
};

describe('withSentry', () => {
Expand DownExpand Up@@ -51,6 +52,65 @@ describe('withSentry', () => {

 expect(result).toBe(response);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('2.0.0');
 });
 });

 describe('scheduled handler', () => {
Expand All@@ -70,6 +130,55 @@ describe('withSentry', () => {
 expect(optionsCallback).toHaveBeenLastCalledWith(MOCK_ENV);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toBe('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toEqual('2.0.0');
 });

 test('flushes the event after the handler is done using the cloudflare context.waitUntil', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
Expand Down

58 changes: 58 additions & 0 deletions
packages/cloudflare/test/options.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
import { describe, expect, it } from 'vitest';
import { getFinalOptions } from '../src/options';

describe('getFinalOptions', () => {
 it('returns user options when env is not an object', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = 'not-an-object';

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('returns user options when env is null', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = null;

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('merges options from env with user options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual({ dsn: 'test-dsn', release: 'user-release' });
 });

 it('uses user options when SENTRY_RELEASE exists but is not a string', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 123 };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('uses user options when SENTRY_RELEASE does not exist', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { OTHER_VAR: 'some-value' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('takes user options over env options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });
});

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

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 6 commits into

from

May 7, 2025
 Merged


feat(cloudflare): Read SENTRY_RELEASE from env#16201
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fd592c6

feat(cloudflare): Read `SENTRY_RELEASE` from `env`


Lms24 May 5, 2025
49f8f76

ref and extract options merging helper, add to durable objects


Lms24 May 6, 2025
e49219f

simplify getFinalOptions


Lms24 May 6, 2025
858134d

lint


Lms24 May 6, 2025
04a1c54

Merge branch 'develop' into lms/feat-cloudflare-sentry-release-from-env


AbhiPrasad May 6, 2025
e0c18f6

Update packages/cloudflare/tsconfig.json


Lms24 May 6, 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


3 changes: 2 additions & 1 deletion
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

Expand DownExpand Up@@ -140,7 +141,7 @@ export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const obj = new target(context, env);

Expand Down

8 changes: 6 additions & 2 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import {
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
Expand All@@ -35,7 +36,9 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);

 const options = getFinalOptions(optionsCallback(env), env);

 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
Expand All@@ -48,7 +51,8 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const client = init(options);
 isolationScope.setClient(client);

Expand Down

20 changes: 20 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
import type { CloudflareOptions } from './client';

/**
 * Merges the options passed in from the user with the options we read from
 * the Cloudflare `env` environment variable object.
 *
 * @param userOptions - The options passed in from the user.
 * @param env - The environment variables.
 *
 * @returns The final options.
 */
export function getFinalOptions(userOptions: CloudflareOptions, env: unknown): CloudflareOptions {
 if (typeof env !== 'object' || env === null) {
 return userOptions;
 }

 const release = 'SENTRY_RELEASE' in env && typeof env.SENTRY_RELEASE === 'string' ? env.SENTRY_RELEASE : undefined;

 return { release, ...userOptions };
}

109 changes: 109 additions & 0 deletions
packages/cloudflare/test/handler.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { withSentry } from '../src/handler';

const MOCK_ENV = {
 SENTRY_DSN: 'https://public@dsn.ingest.sentry.io/1337',
 SENTRY_RELEASE: '1.1.1',
};

describe('withSentry', () => {
Expand DownExpand Up@@ -51,6 +52,65 @@ describe('withSentry', () => {

 expect(result).toBe(response);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('2.0.0');
 });
 });

 describe('scheduled handler', () => {
Expand All@@ -70,6 +130,55 @@ describe('withSentry', () => {
 expect(optionsCallback).toHaveBeenLastCalledWith(MOCK_ENV);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toBe('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toEqual('2.0.0');
 });

 test('flushes the event after the handler is done using the cloudflare context.waitUntil', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
Expand Down

58 changes: 58 additions & 0 deletions
packages/cloudflare/test/options.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
import { describe, expect, it } from 'vitest';
import { getFinalOptions } from '../src/options';

describe('getFinalOptions', () => {
 it('returns user options when env is not an object', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = 'not-an-object';

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('returns user options when env is null', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = null;

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('merges options from env with user options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual({ dsn: 'test-dsn', release: 'user-release' });
 });

 it('uses user options when SENTRY_RELEASE exists but is not a string', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 123 };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('uses user options when SENTRY_RELEASE does not exist', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { OTHER_VAR: 'some-value' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('takes user options over env options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(cloudflare): Read `SENTRY_RELEASE` from `env` by Lms24 · Pull Request #16201 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Read SENTRY_RELEASE from env#16201

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 6 commits into

from

May 7, 2025
 Merged


feat(cloudflare): Read SENTRY_RELEASE from env#16201
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fd592c6

feat(cloudflare): Read `SENTRY_RELEASE` from `env`


Lms24 May 5, 2025
49f8f76

ref and extract options merging helper, add to durable objects


Lms24 May 6, 2025
e49219f

simplify getFinalOptions


Lms24 May 6, 2025
858134d

lint


Lms24 May 6, 2025
04a1c54

Merge branch 'develop' into lms/feat-cloudflare-sentry-release-from-env


AbhiPrasad May 6, 2025
e0c18f6

Update packages/cloudflare/tsconfig.json


Lms24 May 6, 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


3 changes: 2 additions & 1 deletion
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

Expand DownExpand Up@@ -140,7 +141,7 @@ export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const obj = new target(context, env);

Expand Down

8 changes: 6 additions & 2 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import {
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
Expand All@@ -35,7 +36,9 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);

 const options = getFinalOptions(optionsCallback(env), env);

 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
Expand All@@ -48,7 +51,8 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const client = init(options);
 isolationScope.setClient(client);

Expand Down

20 changes: 20 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
import type { CloudflareOptions } from './client';

/**
 * Merges the options passed in from the user with the options we read from
 * the Cloudflare `env` environment variable object.
 *
 * @param userOptions - The options passed in from the user.
 * @param env - The environment variables.
 *
 * @returns The final options.
 */
export function getFinalOptions(userOptions: CloudflareOptions, env: unknown): CloudflareOptions {
 if (typeof env !== 'object' || env === null) {
 return userOptions;
 }

 const release = 'SENTRY_RELEASE' in env && typeof env.SENTRY_RELEASE === 'string' ? env.SENTRY_RELEASE : undefined;

 return { release, ...userOptions };
}

109 changes: 109 additions & 0 deletions
packages/cloudflare/test/handler.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { withSentry } from '../src/handler';

const MOCK_ENV = {
 SENTRY_DSN: 'https://public@dsn.ingest.sentry.io/1337',
 SENTRY_RELEASE: '1.1.1',
};

describe('withSentry', () => {
Expand DownExpand Up@@ -51,6 +52,65 @@ describe('withSentry', () => {

 expect(result).toBe(response);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('2.0.0');
 });
 });

 describe('scheduled handler', () => {
Expand All@@ -70,6 +130,55 @@ describe('withSentry', () => {
 expect(optionsCallback).toHaveBeenLastCalledWith(MOCK_ENV);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toBe('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toEqual('2.0.0');
 });

 test('flushes the event after the handler is done using the cloudflare context.waitUntil', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
Expand Down

58 changes: 58 additions & 0 deletions
packages/cloudflare/test/options.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
import { describe, expect, it } from 'vitest';
import { getFinalOptions } from '../src/options';

describe('getFinalOptions', () => {
 it('returns user options when env is not an object', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = 'not-an-object';

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('returns user options when env is null', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = null;

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('merges options from env with user options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual({ dsn: 'test-dsn', release: 'user-release' });
 });

 it('uses user options when SENTRY_RELEASE exists but is not a string', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 123 };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('uses user options when SENTRY_RELEASE does not exist', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { OTHER_VAR: 'some-value' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('takes user options over env options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });
});

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(cloudflare): Read `SENTRY_RELEASE` from `env` by Lms24 · Pull Request #16201 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Read SENTRY_RELEASE from env#16201

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 6 commits into

from

May 7, 2025
 Merged


feat(cloudflare): Read SENTRY_RELEASE from env#16201
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fd592c6

feat(cloudflare): Read `SENTRY_RELEASE` from `env`


Lms24 May 5, 2025
49f8f76

ref and extract options merging helper, add to durable objects


Lms24 May 6, 2025
e49219f

simplify getFinalOptions


Lms24 May 6, 2025
858134d

lint


Lms24 May 6, 2025
04a1c54

Merge branch 'develop' into lms/feat-cloudflare-sentry-release-from-env


AbhiPrasad May 6, 2025
e0c18f6

Update packages/cloudflare/tsconfig.json


Lms24 May 6, 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


3 changes: 2 additions & 1 deletion
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

Expand DownExpand Up@@ -140,7 +141,7 @@ export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const obj = new target(context, env);

Expand Down

8 changes: 6 additions & 2 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import {
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
Expand All@@ -35,7 +36,9 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);

 const options = getFinalOptions(optionsCallback(env), env);

 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
Expand All@@ -48,7 +51,8 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const client = init(options);
 isolationScope.setClient(client);

Expand Down

20 changes: 20 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
import type { CloudflareOptions } from './client';

/**
 * Merges the options passed in from the user with the options we read from
 * the Cloudflare `env` environment variable object.
 *
 * @param userOptions - The options passed in from the user.
 * @param env - The environment variables.
 *
 * @returns The final options.
 */
export function getFinalOptions(userOptions: CloudflareOptions, env: unknown): CloudflareOptions {
 if (typeof env !== 'object' || env === null) {
 return userOptions;
 }

 const release = 'SENTRY_RELEASE' in env && typeof env.SENTRY_RELEASE === 'string' ? env.SENTRY_RELEASE : undefined;

 return { release, ...userOptions };
}

109 changes: 109 additions & 0 deletions
packages/cloudflare/test/handler.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { withSentry } from '../src/handler';

const MOCK_ENV = {
 SENTRY_DSN: 'https://public@dsn.ingest.sentry.io/1337',
 SENTRY_RELEASE: '1.1.1',
};

describe('withSentry', () => {
Expand DownExpand Up@@ -51,6 +52,65 @@ describe('withSentry', () => {

 expect(result).toBe(response);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('2.0.0');
 });
 });

 describe('scheduled handler', () => {
Expand All@@ -70,6 +130,55 @@ describe('withSentry', () => {
 expect(optionsCallback).toHaveBeenLastCalledWith(MOCK_ENV);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toBe('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toEqual('2.0.0');
 });

 test('flushes the event after the handler is done using the cloudflare context.waitUntil', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
Expand Down

58 changes: 58 additions & 0 deletions
packages/cloudflare/test/options.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
import { describe, expect, it } from 'vitest';
import { getFinalOptions } from '../src/options';

describe('getFinalOptions', () => {
 it('returns user options when env is not an object', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = 'not-an-object';

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('returns user options when env is null', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = null;

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('merges options from env with user options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual({ dsn: 'test-dsn', release: 'user-release' });
 });

 it('uses user options when SENTRY_RELEASE exists but is not a string', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 123 };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('uses user options when SENTRY_RELEASE does not exist', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { OTHER_VAR: 'some-value' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('takes user options over env options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });
});

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

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 6 commits into

from

May 7, 2025
 Merged


feat(cloudflare): Read SENTRY_RELEASE from env#16201
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fd592c6

feat(cloudflare): Read `SENTRY_RELEASE` from `env`


Lms24 May 5, 2025
49f8f76

ref and extract options merging helper, add to durable objects


Lms24 May 6, 2025
e49219f

simplify getFinalOptions


Lms24 May 6, 2025
858134d

lint


Lms24 May 6, 2025
04a1c54

Merge branch 'develop' into lms/feat-cloudflare-sentry-release-from-env


AbhiPrasad May 6, 2025
e0c18f6

Update packages/cloudflare/tsconfig.json


Lms24 May 6, 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


3 changes: 2 additions & 1 deletion
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

Expand DownExpand Up@@ -140,7 +141,7 @@ export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const obj = new target(context, env);

Expand Down

8 changes: 6 additions & 2 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import {
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getFinalOptions } from './options';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
Expand All@@ -35,7 +36,9 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);

 const options = getFinalOptions(optionsCallback(env), env);

 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
Expand All@@ -48,7 +51,8 @@ export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostM
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const options = getFinalOptions(optionsCallback(env), env);

 const client = init(options);
 isolationScope.setClient(client);

Expand Down

20 changes: 20 additions & 0 deletions
packages/cloudflare/src/options.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
import type { CloudflareOptions } from './client';

/**
 * Merges the options passed in from the user with the options we read from
 * the Cloudflare `env` environment variable object.
 *
 * @param userOptions - The options passed in from the user.
 * @param env - The environment variables.
 *
 * @returns The final options.
 */
export function getFinalOptions(userOptions: CloudflareOptions, env: unknown): CloudflareOptions {
 if (typeof env !== 'object' || env === null) {
 return userOptions;
 }

 const release = 'SENTRY_RELEASE' in env && typeof env.SENTRY_RELEASE === 'string' ? env.SENTRY_RELEASE : undefined;

 return { release, ...userOptions };
}

109 changes: 109 additions & 0 deletions
packages/cloudflare/test/handler.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { withSentry } from '../src/handler';

const MOCK_ENV = {
 SENTRY_DSN: 'https://public@dsn.ingest.sentry.io/1337',
 SENTRY_RELEASE: '1.1.1',
};

describe('withSentry', () => {
Expand DownExpand Up@@ -51,6 +52,65 @@ describe('withSentry', () => {

 expect(result).toBe(response);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 fetch(_request, _env, _context) {
 throw new Error('test');
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};

 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );

 try {
 await wrappedHandler.fetch(new Request('https://example.com'), MOCK_ENV, createMockExecutionContext());
 } catch {
 // ignore
 }

 expect(sentryEvent.release).toEqual('2.0.0');
 });
 });

 describe('scheduled handler', () => {
Expand All@@ -70,6 +130,55 @@ describe('withSentry', () => {
 expect(optionsCallback).toHaveBeenLastCalledWith(MOCK_ENV);
 });

 test('merges options from env and callback', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toBe('1.1.1');
 });

 test('callback options take precedence over env options', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
 SentryCore.captureMessage('cloud_resource');
 return;
 },
 } satisfies ExportedHandler<typeof MOCK_ENV>;

 let sentryEvent: Event = {};
 const wrappedHandler = withSentry(
 env => ({
 dsn: env.SENTRY_DSN,
 release: '2.0.0',
 beforeSend(event) {
 sentryEvent = event;
 return null;
 },
 }),
 handler,
 );
 await wrappedHandler.scheduled(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());

 expect(sentryEvent.release).toEqual('2.0.0');
 });

 test('flushes the event after the handler is done using the cloudflare context.waitUntil', async () => {
 const handler = {
 scheduled(_controller, _env, _context) {
Expand Down

58 changes: 58 additions & 0 deletions
packages/cloudflare/test/options.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
import { describe, expect, it } from 'vitest';
import { getFinalOptions } from '../src/options';

describe('getFinalOptions', () => {
 it('returns user options when env is not an object', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = 'not-an-object';

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('returns user options when env is null', () => {
 const userOptions = { dsn: 'test-dsn', release: 'test-release' };
 const env = null;

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('merges options from env with user options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual({ dsn: 'test-dsn', release: 'user-release' });
 });

 it('uses user options when SENTRY_RELEASE exists but is not a string', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 123 };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('uses user options when SENTRY_RELEASE does not exist', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { OTHER_VAR: 'some-value' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });

 it('takes user options over env options', () => {
 const userOptions = { dsn: 'test-dsn', release: 'user-release' };
 const env = { SENTRY_RELEASE: 'env-release' };

 const result = getFinalOptions(userOptions, env);

 expect(result).toEqual(userOptions);
 });
});