Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';

interface Env {
SENTRY_DSN: string;
TEST_DURABLE_OBJECT: DurableObjectNamespace;
}

class SyncKvDurableObjectBase extends DurableObject<Env> {
public constructor(ctx: DurableObjectState, env: Env) {
super(ctx, env);
}

async fetch(): Promise<Response> {
this.ctx.storage.kv.put('test-key', { value: 'hello' });
const val = this.ctx.storage.kv.get('test-key');
const entries = [...this.ctx.storage.kv.list()];
const deleted = this.ctx.storage.kv.delete('test-key');

return Response.json({ get: val, listSize: entries.length, deleted });
}
}

export const TestDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
SyncKvDurableObjectBase,
);

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
{
async fetch(request: Request, env: Env): Promise<Response> {
const url = new URL(request.url);

if (url.pathname === '/flush-marker') {
Sentry.captureMessage('flush-marker');
return new Response(JSON.stringify({ ok: true }), { headers: { 'Content-Type': 'application/json' } });
}

const id = env.TEST_DURABLE_OBJECT.idFromName('test');
const stub = env.TEST_DURABLE_OBJECT.get(id);
return stub.fetch(request);
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
import type { Envelope } from '@sentry/core';
import { expect, it } from 'vitest';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import { createRunner } from '../../../runner';

const flushMarkerMatcher = (envelope: Envelope): void => {
const [, items] = envelope;
const [itemHeader, itemBody] = items[0] as [{ type: string }, Record<string, unknown>];

expect(itemHeader.type).toBe('event');
expect(itemBody.message).toBe('flush-marker');
};

it('instruments sync KV operations on Durable Object storage', async ({ signal }) => {
const runner = createRunner(__dirname)
.expect(envelope => {
const transactionEvent = envelope[1]?.[0]?.[1];
const spans = transactionEvent?.spans ?? [];

expect(transactionEvent).toEqual(
expect.objectContaining({
type: 'transaction',
transaction: 'GET /',
}),
);

expect(spans).toHaveLength(4);
expect(spans).toEqual(
expect.arrayContaining([
expect.objectContaining({
description: 'durable_object_storage_kv_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'db',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'put',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_list',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'list',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_delete',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'delete',
}),
}),
]),
);
})
.expect(flushMarkerMatcher)
.start(signal);

await runner.makeRequest('get', '/');
await runner.makeRequest('get', '/flush-marker');
await runner.completed();
Comment thread
cursor[bot] marked this conversation as resolved.
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
{
"name": "worker-name",
"main": "index.ts",
"compatibility_date": "2025-06-17",
"migrations": [
{
"new_sqlite_classes": ["TestDurableObject"],
"tag": "v1",
},
],
"durable_objects": {
"bindings": [
{
"class_name": "TestDurableObject",
"name": "TEST_DURABLE_OBJECT",
},
],
},
"compatibility_flags": ["nodejs_als"],
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import type { DurableObjectStorage, SyncKvStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';

const STORAGE_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list', 'setAlarm', 'getAlarm', 'deleteAlarm'] as const;

Expand DownExpand Up@@ -35,6 +36,10 @@ export function instrumentDurableObjectStorage(
// reference" errors.
const original = Reflect.get(target, prop, target);

if (prop === 'kv' && original != null && 'get' in original && 'put' in original) {
return instrumentDurableObjectSyncKvStorage(original as SyncKvStorage);
}

if (typeof original !== 'function') {
return original;
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import type { SyncKvStorage } from '@cloudflare/workers-types';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';

const SYNC_KV_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list'] as const;

type SyncKvMethod = (typeof SYNC_KV_METHODS_TO_INSTRUMENT)[number];

export function instrumentDurableObjectSyncKvStorage(syncKv: SyncKvStorage): SyncKvStorage {
return new Proxy(syncKv, {
get(target, prop, _receiver) {
const original = Reflect.get(target, prop, target);

if (typeof original !== 'function') {
return original;
}

const methodName = prop as SyncKvMethod;

if (!SYNC_KV_METHODS_TO_INSTRUMENT.includes(methodName)) {
return (original as (...args: unknown[]) => unknown).bind(target);
}

return function (this: unknown, ...args: unknown[]) {
return startSpan(
{
name: `durable_object_storage_kv_${methodName}`,
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
// keeping the value as close as possible to the Cloudflare Worker KV instrumentation
// https://github.com/cloudflare/workerd/blob/6b8b11787e2b2a800ab0edd0690bfab3857b0529/src/workerd/api/sync-kv.c%2B%2B#L19
'db.system.name': 'cloudflare-durable-object-sql',
Comment thread
JPeer264 marked this conversation as resolved.
'db.operation.name': methodName,
},
},
() => {
return (original as (...args: unknown[]) => unknown).apply(target, args);
},
);
};
},
});
}
29 changes: 29 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import * as sentryCore from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { instrumentDurableObjectStorage } from '../src/instrumentations/instrumentDurableObjectStorage';
Expand DownExpand Up@@ -304,6 +305,28 @@ describe('instrumentDurableObjectStorage', () => {
});
});

describe('sync KV instrumentation', () => {
it('instruments the kv property with a proxy', () => {
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

instrumented.kv.get('myKey');

expect(sentryCore.startSpan).toHaveBeenCalledWith(
{
name: 'durable_object_storage_kv_get',
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
},
},
expect.any(Function),
);
});
});

describe('native getter preservation', () => {
it('preserves native getter `this` binding through the proxy', () => {
// Private fields simulate workerd's native brand check —
Expand DownExpand Up@@ -349,5 +372,11 @@ function createMockStorage(): any {
sql: {
exec: vi.fn(),
},
kv: {
get: vi.fn().mockReturnValue(undefined),
put: vi.fn().mockReturnValue(undefined),
delete: vi.fn().mockReturnValue(false),
list: vi.fn().mockReturnValue([]),
},
};
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';

interface Env {
SENTRY_DSN: string;
TEST_DURABLE_OBJECT: DurableObjectNamespace;
}

class SyncKvDurableObjectBase extends DurableObject<Env> {
public constructor(ctx: DurableObjectState, env: Env) {
super(ctx, env);
}

async fetch(): Promise<Response> {
this.ctx.storage.kv.put('test-key', { value: 'hello' });
const val = this.ctx.storage.kv.get('test-key');
const entries = [...this.ctx.storage.kv.list()];
const deleted = this.ctx.storage.kv.delete('test-key');

return Response.json({ get: val, listSize: entries.length, deleted });
}
}

export const TestDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
SyncKvDurableObjectBase,
);

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
{
async fetch(request: Request, env: Env): Promise<Response> {
const url = new URL(request.url);

if (url.pathname === '/flush-marker') {
Sentry.captureMessage('flush-marker');
return new Response(JSON.stringify({ ok: true }), { headers: { 'Content-Type': 'application/json' } });
}

const id = env.TEST_DURABLE_OBJECT.idFromName('test');
const stub = env.TEST_DURABLE_OBJECT.get(id);
return stub.fetch(request);
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
import type { Envelope } from '@sentry/core';
import { expect, it } from 'vitest';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import { createRunner } from '../../../runner';

const flushMarkerMatcher = (envelope: Envelope): void => {
const [, items] = envelope;
const [itemHeader, itemBody] = items[0] as [{ type: string }, Record<string, unknown>];

expect(itemHeader.type).toBe('event');
expect(itemBody.message).toBe('flush-marker');
};

it('instruments sync KV operations on Durable Object storage', async ({ signal }) => {
const runner = createRunner(__dirname)
.expect(envelope => {
const transactionEvent = envelope[1]?.[0]?.[1];
const spans = transactionEvent?.spans ?? [];

expect(transactionEvent).toEqual(
expect.objectContaining({
type: 'transaction',
transaction: 'GET /',
}),
);

expect(spans).toHaveLength(4);
expect(spans).toEqual(
expect.arrayContaining([
expect.objectContaining({
description: 'durable_object_storage_kv_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'db',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'put',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_list',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'list',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_delete',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'delete',
}),
}),
]),
);
})
.expect(flushMarkerMatcher)
.start(signal);

await runner.makeRequest('get', '/');
await runner.makeRequest('get', '/flush-marker');
await runner.completed();
Comment thread
cursor[bot] marked this conversation as resolved.
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
{
"name": "worker-name",
"main": "index.ts",
"compatibility_date": "2025-06-17",
"migrations": [
{
"new_sqlite_classes": ["TestDurableObject"],
"tag": "v1",
},
],
"durable_objects": {
"bindings": [
{
"class_name": "TestDurableObject",
"name": "TEST_DURABLE_OBJECT",
},
],
},
"compatibility_flags": ["nodejs_als"],
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import type { DurableObjectStorage, SyncKvStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';

const STORAGE_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list', 'setAlarm', 'getAlarm', 'deleteAlarm'] as const;

Expand DownExpand Up@@ -35,6 +36,10 @@ export function instrumentDurableObjectStorage(
// reference" errors.
const original = Reflect.get(target, prop, target);

if (prop === 'kv' && original != null && 'get' in original && 'put' in original) {
return instrumentDurableObjectSyncKvStorage(original as SyncKvStorage);
}

if (typeof original !== 'function') {
return original;
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import type { SyncKvStorage } from '@cloudflare/workers-types';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';

const SYNC_KV_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list'] as const;

type SyncKvMethod = (typeof SYNC_KV_METHODS_TO_INSTRUMENT)[number];

export function instrumentDurableObjectSyncKvStorage(syncKv: SyncKvStorage): SyncKvStorage {
return new Proxy(syncKv, {
get(target, prop, _receiver) {
const original = Reflect.get(target, prop, target);

if (typeof original !== 'function') {
return original;
}

const methodName = prop as SyncKvMethod;

if (!SYNC_KV_METHODS_TO_INSTRUMENT.includes(methodName)) {
return (original as (...args: unknown[]) => unknown).bind(target);
}

return function (this: unknown, ...args: unknown[]) {
return startSpan(
{
name: `durable_object_storage_kv_${methodName}`,
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
// keeping the value as close as possible to the Cloudflare Worker KV instrumentation
// https://github.com/cloudflare/workerd/blob/6b8b11787e2b2a800ab0edd0690bfab3857b0529/src/workerd/api/sync-kv.c%2B%2B#L19
'db.system.name': 'cloudflare-durable-object-sql',
Comment thread
JPeer264 marked this conversation as resolved.
'db.operation.name': methodName,
},
},
() => {
return (original as (...args: unknown[]) => unknown).apply(target, args);
},
);
};
},
});
}
29 changes: 29 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import * as sentryCore from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { instrumentDurableObjectStorage } from '../src/instrumentations/instrumentDurableObjectStorage';
Expand DownExpand Up@@ -304,6 +305,28 @@ describe('instrumentDurableObjectStorage', () => {
});
});

describe('sync KV instrumentation', () => {
it('instruments the kv property with a proxy', () => {
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

instrumented.kv.get('myKey');

expect(sentryCore.startSpan).toHaveBeenCalledWith(
{
name: 'durable_object_storage_kv_get',
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
},
},
expect.any(Function),
);
});
});

describe('native getter preservation', () => {
it('preserves native getter `this` binding through the proxy', () => {
// Private fields simulate workerd's native brand check —
Expand DownExpand Up@@ -349,5 +372,11 @@ function createMockStorage(): any {
sql: {
exec: vi.fn(),
},
kv: {
get: vi.fn().mockReturnValue(undefined),
put: vi.fn().mockReturnValue(undefined),
delete: vi.fn().mockReturnValue(false),
list: vi.fn().mockReturnValue([]),
},
};
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';

interface Env {
SENTRY_DSN: string;
TEST_DURABLE_OBJECT: DurableObjectNamespace;
}

class SyncKvDurableObjectBase extends DurableObject<Env> {
public constructor(ctx: DurableObjectState, env: Env) {
super(ctx, env);
}

async fetch(): Promise<Response> {
this.ctx.storage.kv.put('test-key', { value: 'hello' });
const val = this.ctx.storage.kv.get('test-key');
const entries = [...this.ctx.storage.kv.list()];
const deleted = this.ctx.storage.kv.delete('test-key');

return Response.json({ get: val, listSize: entries.length, deleted });
}
}

export const TestDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
SyncKvDurableObjectBase,
);

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
{
async fetch(request: Request, env: Env): Promise<Response> {
const url = new URL(request.url);

if (url.pathname === '/flush-marker') {
Sentry.captureMessage('flush-marker');
return new Response(JSON.stringify({ ok: true }), { headers: { 'Content-Type': 'application/json' } });
}

const id = env.TEST_DURABLE_OBJECT.idFromName('test');
const stub = env.TEST_DURABLE_OBJECT.get(id);
return stub.fetch(request);
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
import type { Envelope } from '@sentry/core';
import { expect, it } from 'vitest';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import { createRunner } from '../../../runner';

const flushMarkerMatcher = (envelope: Envelope): void => {
const [, items] = envelope;
const [itemHeader, itemBody] = items[0] as [{ type: string }, Record<string, unknown>];

expect(itemHeader.type).toBe('event');
expect(itemBody.message).toBe('flush-marker');
};

it('instruments sync KV operations on Durable Object storage', async ({ signal }) => {
const runner = createRunner(__dirname)
.expect(envelope => {
const transactionEvent = envelope[1]?.[0]?.[1];
const spans = transactionEvent?.spans ?? [];

expect(transactionEvent).toEqual(
expect.objectContaining({
type: 'transaction',
transaction: 'GET /',
}),
);

expect(spans).toHaveLength(4);
expect(spans).toEqual(
expect.arrayContaining([
expect.objectContaining({
description: 'durable_object_storage_kv_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'db',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'put',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_list',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'list',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_delete',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'delete',
}),
}),
]),
);
})
.expect(flushMarkerMatcher)
.start(signal);

await runner.makeRequest('get', '/');
await runner.makeRequest('get', '/flush-marker');
await runner.completed();
Comment thread
cursor[bot] marked this conversation as resolved.
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
{
"name": "worker-name",
"main": "index.ts",
"compatibility_date": "2025-06-17",
"migrations": [
{
"new_sqlite_classes": ["TestDurableObject"],
"tag": "v1",
},
],
"durable_objects": {
"bindings": [
{
"class_name": "TestDurableObject",
"name": "TEST_DURABLE_OBJECT",
},
],
},
"compatibility_flags": ["nodejs_als"],
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import type { DurableObjectStorage, SyncKvStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';

const STORAGE_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list', 'setAlarm', 'getAlarm', 'deleteAlarm'] as const;

Expand DownExpand Up@@ -35,6 +36,10 @@ export function instrumentDurableObjectStorage(
// reference" errors.
const original = Reflect.get(target, prop, target);

if (prop === 'kv' && original != null && 'get' in original && 'put' in original) {
return instrumentDurableObjectSyncKvStorage(original as SyncKvStorage);
}

if (typeof original !== 'function') {
return original;
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import type { SyncKvStorage } from '@cloudflare/workers-types';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';

const SYNC_KV_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list'] as const;

type SyncKvMethod = (typeof SYNC_KV_METHODS_TO_INSTRUMENT)[number];

export function instrumentDurableObjectSyncKvStorage(syncKv: SyncKvStorage): SyncKvStorage {
return new Proxy(syncKv, {
get(target, prop, _receiver) {
const original = Reflect.get(target, prop, target);

if (typeof original !== 'function') {
return original;
}

const methodName = prop as SyncKvMethod;

if (!SYNC_KV_METHODS_TO_INSTRUMENT.includes(methodName)) {
return (original as (...args: unknown[]) => unknown).bind(target);
}

return function (this: unknown, ...args: unknown[]) {
return startSpan(
{
name: `durable_object_storage_kv_${methodName}`,
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
// keeping the value as close as possible to the Cloudflare Worker KV instrumentation
// https://github.com/cloudflare/workerd/blob/6b8b11787e2b2a800ab0edd0690bfab3857b0529/src/workerd/api/sync-kv.c%2B%2B#L19
'db.system.name': 'cloudflare-durable-object-sql',
Comment thread
JPeer264 marked this conversation as resolved.
'db.operation.name': methodName,
},
},
() => {
return (original as (...args: unknown[]) => unknown).apply(target, args);
},
);
};
},
});
}
29 changes: 29 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import * as sentryCore from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { instrumentDurableObjectStorage } from '../src/instrumentations/instrumentDurableObjectStorage';
Expand DownExpand Up@@ -304,6 +305,28 @@ describe('instrumentDurableObjectStorage', () => {
});
});

describe('sync KV instrumentation', () => {
it('instruments the kv property with a proxy', () => {
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

instrumented.kv.get('myKey');

expect(sentryCore.startSpan).toHaveBeenCalledWith(
{
name: 'durable_object_storage_kv_get',
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
},
},
expect.any(Function),
);
});
});

describe('native getter preservation', () => {
it('preserves native getter `this` binding through the proxy', () => {
// Private fields simulate workerd's native brand check —
Expand DownExpand Up@@ -349,5 +372,11 @@ function createMockStorage(): any {
sql: {
exec: vi.fn(),
},
kv: {
get: vi.fn().mockReturnValue(undefined),
put: vi.fn().mockReturnValue(undefined),
delete: vi.fn().mockReturnValue(false),
list: vi.fn().mockReturnValue([]),
},
};
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';

interface Env {
SENTRY_DSN: string;
TEST_DURABLE_OBJECT: DurableObjectNamespace;
}

class SyncKvDurableObjectBase extends DurableObject<Env> {
public constructor(ctx: DurableObjectState, env: Env) {
super(ctx, env);
}

async fetch(): Promise<Response> {
this.ctx.storage.kv.put('test-key', { value: 'hello' });
const val = this.ctx.storage.kv.get('test-key');
const entries = [...this.ctx.storage.kv.list()];
const deleted = this.ctx.storage.kv.delete('test-key');

return Response.json({ get: val, listSize: entries.length, deleted });
}
}

export const TestDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
SyncKvDurableObjectBase,
);

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
{
async fetch(request: Request, env: Env): Promise<Response> {
const url = new URL(request.url);

if (url.pathname === '/flush-marker') {
Sentry.captureMessage('flush-marker');
return new Response(JSON.stringify({ ok: true }), { headers: { 'Content-Type': 'application/json' } });
}

const id = env.TEST_DURABLE_OBJECT.idFromName('test');
const stub = env.TEST_DURABLE_OBJECT.get(id);
return stub.fetch(request);
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
import type { Envelope } from '@sentry/core';
import { expect, it } from 'vitest';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import { createRunner } from '../../../runner';

const flushMarkerMatcher = (envelope: Envelope): void => {
const [, items] = envelope;
const [itemHeader, itemBody] = items[0] as [{ type: string }, Record<string, unknown>];

expect(itemHeader.type).toBe('event');
expect(itemBody.message).toBe('flush-marker');
};

it('instruments sync KV operations on Durable Object storage', async ({ signal }) => {
const runner = createRunner(__dirname)
.expect(envelope => {
const transactionEvent = envelope[1]?.[0]?.[1];
const spans = transactionEvent?.spans ?? [];

expect(transactionEvent).toEqual(
expect.objectContaining({
type: 'transaction',
transaction: 'GET /',
}),
);

expect(spans).toHaveLength(4);
expect(spans).toEqual(
expect.arrayContaining([
expect.objectContaining({
description: 'durable_object_storage_kv_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'db',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'put',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_list',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'list',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_delete',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'delete',
}),
}),
]),
);
})
.expect(flushMarkerMatcher)
.start(signal);

await runner.makeRequest('get', '/');
await runner.makeRequest('get', '/flush-marker');
await runner.completed();
Comment thread
cursor[bot] marked this conversation as resolved.
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
{
"name": "worker-name",
"main": "index.ts",
"compatibility_date": "2025-06-17",
"migrations": [
{
"new_sqlite_classes": ["TestDurableObject"],
"tag": "v1",
},
],
"durable_objects": {
"bindings": [
{
"class_name": "TestDurableObject",
"name": "TEST_DURABLE_OBJECT",
},
],
},
"compatibility_flags": ["nodejs_als"],
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import type { DurableObjectStorage, SyncKvStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';

const STORAGE_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list', 'setAlarm', 'getAlarm', 'deleteAlarm'] as const;

Expand DownExpand Up@@ -35,6 +36,10 @@ export function instrumentDurableObjectStorage(
// reference" errors.
const original = Reflect.get(target, prop, target);

if (prop === 'kv' && original != null && 'get' in original && 'put' in original) {
return instrumentDurableObjectSyncKvStorage(original as SyncKvStorage);
}

if (typeof original !== 'function') {
return original;
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import type { SyncKvStorage } from '@cloudflare/workers-types';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';

const SYNC_KV_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list'] as const;

type SyncKvMethod = (typeof SYNC_KV_METHODS_TO_INSTRUMENT)[number];

export function instrumentDurableObjectSyncKvStorage(syncKv: SyncKvStorage): SyncKvStorage {
return new Proxy(syncKv, {
get(target, prop, _receiver) {
const original = Reflect.get(target, prop, target);

if (typeof original !== 'function') {
return original;
}

const methodName = prop as SyncKvMethod;

if (!SYNC_KV_METHODS_TO_INSTRUMENT.includes(methodName)) {
return (original as (...args: unknown[]) => unknown).bind(target);
}

return function (this: unknown, ...args: unknown[]) {
return startSpan(
{
name: `durable_object_storage_kv_${methodName}`,
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
// keeping the value as close as possible to the Cloudflare Worker KV instrumentation
// https://github.com/cloudflare/workerd/blob/6b8b11787e2b2a800ab0edd0690bfab3857b0529/src/workerd/api/sync-kv.c%2B%2B#L19
'db.system.name': 'cloudflare-durable-object-sql',
Comment thread
JPeer264 marked this conversation as resolved.
'db.operation.name': methodName,
},
},
() => {
return (original as (...args: unknown[]) => unknown).apply(target, args);
},
);
};
},
});
}
29 changes: 29 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import * as sentryCore from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { instrumentDurableObjectStorage } from '../src/instrumentations/instrumentDurableObjectStorage';
Expand DownExpand Up@@ -304,6 +305,28 @@ describe('instrumentDurableObjectStorage', () => {
});
});

describe('sync KV instrumentation', () => {
it('instruments the kv property with a proxy', () => {
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

instrumented.kv.get('myKey');

expect(sentryCore.startSpan).toHaveBeenCalledWith(
{
name: 'durable_object_storage_kv_get',
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
},
},
expect.any(Function),
);
});
});

describe('native getter preservation', () => {
it('preserves native getter `this` binding through the proxy', () => {
// Private fields simulate workerd's native brand check —
Expand DownExpand Up@@ -349,5 +372,11 @@ function createMockStorage(): any {
sql: {
exec: vi.fn(),
},
kv: {
get: vi.fn().mockReturnValue(undefined),
put: vi.fn().mockReturnValue(undefined),
delete: vi.fn().mockReturnValue(false),
list: vi.fn().mockReturnValue([]),
},
};
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';

interface Env {
SENTRY_DSN: string;
TEST_DURABLE_OBJECT: DurableObjectNamespace;
}

class SyncKvDurableObjectBase extends DurableObject<Env> {
public constructor(ctx: DurableObjectState, env: Env) {
super(ctx, env);
}

async fetch(): Promise<Response> {
this.ctx.storage.kv.put('test-key', { value: 'hello' });
const val = this.ctx.storage.kv.get('test-key');
const entries = [...this.ctx.storage.kv.list()];
const deleted = this.ctx.storage.kv.delete('test-key');

return Response.json({ get: val, listSize: entries.length, deleted });
}
}

export const TestDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
SyncKvDurableObjectBase,
);

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
{
async fetch(request: Request, env: Env): Promise<Response> {
const url = new URL(request.url);

if (url.pathname === '/flush-marker') {
Sentry.captureMessage('flush-marker');
return new Response(JSON.stringify({ ok: true }), { headers: { 'Content-Type': 'application/json' } });
}

const id = env.TEST_DURABLE_OBJECT.idFromName('test');
const stub = env.TEST_DURABLE_OBJECT.get(id);
return stub.fetch(request);
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
import type { Envelope } from '@sentry/core';
import { expect, it } from 'vitest';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import { createRunner } from '../../../runner';

const flushMarkerMatcher = (envelope: Envelope): void => {
const [, items] = envelope;
const [itemHeader, itemBody] = items[0] as [{ type: string }, Record<string, unknown>];

expect(itemHeader.type).toBe('event');
expect(itemBody.message).toBe('flush-marker');
};

it('instruments sync KV operations on Durable Object storage', async ({ signal }) => {
const runner = createRunner(__dirname)
.expect(envelope => {
const transactionEvent = envelope[1]?.[0]?.[1];
const spans = transactionEvent?.spans ?? [];

expect(transactionEvent).toEqual(
expect.objectContaining({
type: 'transaction',
transaction: 'GET /',
}),
);

expect(spans).toHaveLength(4);
expect(spans).toEqual(
expect.arrayContaining([
expect.objectContaining({
description: 'durable_object_storage_kv_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'db',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'put',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_list',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'list',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_delete',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'delete',
}),
}),
]),
);
})
.expect(flushMarkerMatcher)
.start(signal);

await runner.makeRequest('get', '/');
await runner.makeRequest('get', '/flush-marker');
await runner.completed();
Comment thread
cursor[bot] marked this conversation as resolved.
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
{
"name": "worker-name",
"main": "index.ts",
"compatibility_date": "2025-06-17",
"migrations": [
{
"new_sqlite_classes": ["TestDurableObject"],
"tag": "v1",
},
],
"durable_objects": {
"bindings": [
{
"class_name": "TestDurableObject",
"name": "TEST_DURABLE_OBJECT",
},
],
},
"compatibility_flags": ["nodejs_als"],
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import type { DurableObjectStorage, SyncKvStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';

const STORAGE_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list', 'setAlarm', 'getAlarm', 'deleteAlarm'] as const;

Expand DownExpand Up@@ -35,6 +36,10 @@ export function instrumentDurableObjectStorage(
// reference" errors.
const original = Reflect.get(target, prop, target);

if (prop === 'kv' && original != null && 'get' in original && 'put' in original) {
return instrumentDurableObjectSyncKvStorage(original as SyncKvStorage);
}

if (typeof original !== 'function') {
return original;
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import type { SyncKvStorage } from '@cloudflare/workers-types';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';

const SYNC_KV_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list'] as const;

type SyncKvMethod = (typeof SYNC_KV_METHODS_TO_INSTRUMENT)[number];

export function instrumentDurableObjectSyncKvStorage(syncKv: SyncKvStorage): SyncKvStorage {
return new Proxy(syncKv, {
get(target, prop, _receiver) {
const original = Reflect.get(target, prop, target);

if (typeof original !== 'function') {
return original;
}

const methodName = prop as SyncKvMethod;

if (!SYNC_KV_METHODS_TO_INSTRUMENT.includes(methodName)) {
return (original as (...args: unknown[]) => unknown).bind(target);
}

return function (this: unknown, ...args: unknown[]) {
return startSpan(
{
name: `durable_object_storage_kv_${methodName}`,
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
// keeping the value as close as possible to the Cloudflare Worker KV instrumentation
// https://github.com/cloudflare/workerd/blob/6b8b11787e2b2a800ab0edd0690bfab3857b0529/src/workerd/api/sync-kv.c%2B%2B#L19
'db.system.name': 'cloudflare-durable-object-sql',
Comment thread
JPeer264 marked this conversation as resolved.
'db.operation.name': methodName,
},
},
() => {
return (original as (...args: unknown[]) => unknown).apply(target, args);
},
);
};
},
});
}
29 changes: 29 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import * as sentryCore from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { instrumentDurableObjectStorage } from '../src/instrumentations/instrumentDurableObjectStorage';
Expand DownExpand Up@@ -304,6 +305,28 @@ describe('instrumentDurableObjectStorage', () => {
});
});

describe('sync KV instrumentation', () => {
it('instruments the kv property with a proxy', () => {
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

instrumented.kv.get('myKey');

expect(sentryCore.startSpan).toHaveBeenCalledWith(
{
name: 'durable_object_storage_kv_get',
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
},
},
expect.any(Function),
);
});
});

describe('native getter preservation', () => {
it('preserves native getter `this` binding through the proxy', () => {
// Private fields simulate workerd's native brand check —
Expand DownExpand Up@@ -349,5 +372,11 @@ function createMockStorage(): any {
sql: {
exec: vi.fn(),
},
kv: {
get: vi.fn().mockReturnValue(undefined),
put: vi.fn().mockReturnValue(undefined),
delete: vi.fn().mockReturnValue(false),
list: vi.fn().mockReturnValue([]),
},
};
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';

interface Env {
SENTRY_DSN: string;
TEST_DURABLE_OBJECT: DurableObjectNamespace;
}

class SyncKvDurableObjectBase extends DurableObject<Env> {
public constructor(ctx: DurableObjectState, env: Env) {
super(ctx, env);
}

async fetch(): Promise<Response> {
this.ctx.storage.kv.put('test-key', { value: 'hello' });
const val = this.ctx.storage.kv.get('test-key');
const entries = [...this.ctx.storage.kv.list()];
const deleted = this.ctx.storage.kv.delete('test-key');

return Response.json({ get: val, listSize: entries.length, deleted });
}
}

export const TestDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
SyncKvDurableObjectBase,
);

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
{
async fetch(request: Request, env: Env): Promise<Response> {
const url = new URL(request.url);

if (url.pathname === '/flush-marker') {
Sentry.captureMessage('flush-marker');
return new Response(JSON.stringify({ ok: true }), { headers: { 'Content-Type': 'application/json' } });
}

const id = env.TEST_DURABLE_OBJECT.idFromName('test');
const stub = env.TEST_DURABLE_OBJECT.get(id);
return stub.fetch(request);
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
import type { Envelope } from '@sentry/core';
import { expect, it } from 'vitest';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import { createRunner } from '../../../runner';

const flushMarkerMatcher = (envelope: Envelope): void => {
const [, items] = envelope;
const [itemHeader, itemBody] = items[0] as [{ type: string }, Record<string, unknown>];

expect(itemHeader.type).toBe('event');
expect(itemBody.message).toBe('flush-marker');
};

it('instruments sync KV operations on Durable Object storage', async ({ signal }) => {
const runner = createRunner(__dirname)
.expect(envelope => {
const transactionEvent = envelope[1]?.[0]?.[1];
const spans = transactionEvent?.spans ?? [];

expect(transactionEvent).toEqual(
expect.objectContaining({
type: 'transaction',
transaction: 'GET /',
}),
);

expect(spans).toHaveLength(4);
expect(spans).toEqual(
expect.arrayContaining([
expect.objectContaining({
description: 'durable_object_storage_kv_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'db',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'put',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_list',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'list',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_delete',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'delete',
}),
}),
]),
);
})
.expect(flushMarkerMatcher)
.start(signal);

await runner.makeRequest('get', '/');
await runner.makeRequest('get', '/flush-marker');
await runner.completed();
Comment thread
cursor[bot] marked this conversation as resolved.
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
{
"name": "worker-name",
"main": "index.ts",
"compatibility_date": "2025-06-17",
"migrations": [
{
"new_sqlite_classes": ["TestDurableObject"],
"tag": "v1",
},
],
"durable_objects": {
"bindings": [
{
"class_name": "TestDurableObject",
"name": "TEST_DURABLE_OBJECT",
},
],
},
"compatibility_flags": ["nodejs_als"],
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import type { DurableObjectStorage, SyncKvStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';

const STORAGE_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list', 'setAlarm', 'getAlarm', 'deleteAlarm'] as const;

Expand DownExpand Up@@ -35,6 +36,10 @@ export function instrumentDurableObjectStorage(
// reference" errors.
const original = Reflect.get(target, prop, target);

if (prop === 'kv' && original != null && 'get' in original && 'put' in original) {
return instrumentDurableObjectSyncKvStorage(original as SyncKvStorage);
}

if (typeof original !== 'function') {
return original;
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import type { SyncKvStorage } from '@cloudflare/workers-types';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';

const SYNC_KV_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list'] as const;

type SyncKvMethod = (typeof SYNC_KV_METHODS_TO_INSTRUMENT)[number];

export function instrumentDurableObjectSyncKvStorage(syncKv: SyncKvStorage): SyncKvStorage {
return new Proxy(syncKv, {
get(target, prop, _receiver) {
const original = Reflect.get(target, prop, target);

if (typeof original !== 'function') {
return original;
}

const methodName = prop as SyncKvMethod;

if (!SYNC_KV_METHODS_TO_INSTRUMENT.includes(methodName)) {
return (original as (...args: unknown[]) => unknown).bind(target);
}

return function (this: unknown, ...args: unknown[]) {
return startSpan(
{
name: `durable_object_storage_kv_${methodName}`,
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
// keeping the value as close as possible to the Cloudflare Worker KV instrumentation
// https://github.com/cloudflare/workerd/blob/6b8b11787e2b2a800ab0edd0690bfab3857b0529/src/workerd/api/sync-kv.c%2B%2B#L19
'db.system.name': 'cloudflare-durable-object-sql',
Comment thread
JPeer264 marked this conversation as resolved.
'db.operation.name': methodName,
},
},
() => {
return (original as (...args: unknown[]) => unknown).apply(target, args);
},
);
};
},
});
}
29 changes: 29 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import * as sentryCore from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { instrumentDurableObjectStorage } from '../src/instrumentations/instrumentDurableObjectStorage';
Expand DownExpand Up@@ -304,6 +305,28 @@ describe('instrumentDurableObjectStorage', () => {
});
});

describe('sync KV instrumentation', () => {
it('instruments the kv property with a proxy', () => {
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

instrumented.kv.get('myKey');

expect(sentryCore.startSpan).toHaveBeenCalledWith(
{
name: 'durable_object_storage_kv_get',
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
},
},
expect.any(Function),
);
});
});

describe('native getter preservation', () => {
it('preserves native getter `this` binding through the proxy', () => {
// Private fields simulate workerd's native brand check —
Expand DownExpand Up@@ -349,5 +372,11 @@ function createMockStorage(): any {
sql: {
exec: vi.fn(),
},
kv: {
get: vi.fn().mockReturnValue(undefined),
put: vi.fn().mockReturnValue(undefined),
delete: vi.fn().mockReturnValue(false),
list: vi.fn().mockReturnValue([]),
},
};
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';

interface Env {
SENTRY_DSN: string;
TEST_DURABLE_OBJECT: DurableObjectNamespace;
}

class SyncKvDurableObjectBase extends DurableObject<Env> {
public constructor(ctx: DurableObjectState, env: Env) {
super(ctx, env);
}

async fetch(): Promise<Response> {
this.ctx.storage.kv.put('test-key', { value: 'hello' });
const val = this.ctx.storage.kv.get('test-key');
const entries = [...this.ctx.storage.kv.list()];
const deleted = this.ctx.storage.kv.delete('test-key');

return Response.json({ get: val, listSize: entries.length, deleted });
}
}

export const TestDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
SyncKvDurableObjectBase,
);

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
{
async fetch(request: Request, env: Env): Promise<Response> {
const url = new URL(request.url);

if (url.pathname === '/flush-marker') {
Sentry.captureMessage('flush-marker');
return new Response(JSON.stringify({ ok: true }), { headers: { 'Content-Type': 'application/json' } });
}

const id = env.TEST_DURABLE_OBJECT.idFromName('test');
const stub = env.TEST_DURABLE_OBJECT.get(id);
return stub.fetch(request);
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
import type { Envelope } from '@sentry/core';
import { expect, it } from 'vitest';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import { createRunner } from '../../../runner';

const flushMarkerMatcher = (envelope: Envelope): void => {
const [, items] = envelope;
const [itemHeader, itemBody] = items[0] as [{ type: string }, Record<string, unknown>];

expect(itemHeader.type).toBe('event');
expect(itemBody.message).toBe('flush-marker');
};

it('instruments sync KV operations on Durable Object storage', async ({ signal }) => {
const runner = createRunner(__dirname)
.expect(envelope => {
const transactionEvent = envelope[1]?.[0]?.[1];
const spans = transactionEvent?.spans ?? [];

expect(transactionEvent).toEqual(
expect.objectContaining({
type: 'transaction',
transaction: 'GET /',
}),
);

expect(spans).toHaveLength(4);
expect(spans).toEqual(
expect.arrayContaining([
expect.objectContaining({
description: 'durable_object_storage_kv_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'db',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'put',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_list',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'list',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_delete',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'delete',
}),
}),
]),
);
})
.expect(flushMarkerMatcher)
.start(signal);

await runner.makeRequest('get', '/');
await runner.makeRequest('get', '/flush-marker');
await runner.completed();
Comment thread
cursor[bot] marked this conversation as resolved.
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
{
"name": "worker-name",
"main": "index.ts",
"compatibility_date": "2025-06-17",
"migrations": [
{
"new_sqlite_classes": ["TestDurableObject"],
"tag": "v1",
},
],
"durable_objects": {
"bindings": [
{
"class_name": "TestDurableObject",
"name": "TEST_DURABLE_OBJECT",
},
],
},
"compatibility_flags": ["nodejs_als"],
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import type { DurableObjectStorage, SyncKvStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';

const STORAGE_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list', 'setAlarm', 'getAlarm', 'deleteAlarm'] as const;

Expand DownExpand Up@@ -35,6 +36,10 @@ export function instrumentDurableObjectStorage(
// reference" errors.
const original = Reflect.get(target, prop, target);

if (prop === 'kv' && original != null && 'get' in original && 'put' in original) {
return instrumentDurableObjectSyncKvStorage(original as SyncKvStorage);
}

if (typeof original !== 'function') {
return original;
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import type { SyncKvStorage } from '@cloudflare/workers-types';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';

const SYNC_KV_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list'] as const;

type SyncKvMethod = (typeof SYNC_KV_METHODS_TO_INSTRUMENT)[number];

export function instrumentDurableObjectSyncKvStorage(syncKv: SyncKvStorage): SyncKvStorage {
return new Proxy(syncKv, {
get(target, prop, _receiver) {
const original = Reflect.get(target, prop, target);

if (typeof original !== 'function') {
return original;
}

const methodName = prop as SyncKvMethod;

if (!SYNC_KV_METHODS_TO_INSTRUMENT.includes(methodName)) {
return (original as (...args: unknown[]) => unknown).bind(target);
}

return function (this: unknown, ...args: unknown[]) {
return startSpan(
{
name: `durable_object_storage_kv_${methodName}`,
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
// keeping the value as close as possible to the Cloudflare Worker KV instrumentation
// https://github.com/cloudflare/workerd/blob/6b8b11787e2b2a800ab0edd0690bfab3857b0529/src/workerd/api/sync-kv.c%2B%2B#L19
'db.system.name': 'cloudflare-durable-object-sql',
Comment thread
JPeer264 marked this conversation as resolved.
'db.operation.name': methodName,
},
},
() => {
return (original as (...args: unknown[]) => unknown).apply(target, args);
},
);
};
},
});
}
29 changes: 29 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import * as sentryCore from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { instrumentDurableObjectStorage } from '../src/instrumentations/instrumentDurableObjectStorage';
Expand DownExpand Up@@ -304,6 +305,28 @@ describe('instrumentDurableObjectStorage', () => {
});
});

describe('sync KV instrumentation', () => {
it('instruments the kv property with a proxy', () => {
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

instrumented.kv.get('myKey');

expect(sentryCore.startSpan).toHaveBeenCalledWith(
{
name: 'durable_object_storage_kv_get',
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
},
},
expect.any(Function),
);
});
});

describe('native getter preservation', () => {
it('preserves native getter `this` binding through the proxy', () => {
// Private fields simulate workerd's native brand check —
Expand DownExpand Up@@ -349,5 +372,11 @@ function createMockStorage(): any {
sql: {
exec: vi.fn(),
},
kv: {
get: vi.fn().mockReturnValue(undefined),
put: vi.fn().mockReturnValue(undefined),
delete: vi.fn().mockReturnValue(false),
list: vi.fn().mockReturnValue([]),
},
};
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';

interface Env {
SENTRY_DSN: string;
TEST_DURABLE_OBJECT: DurableObjectNamespace;
}

class SyncKvDurableObjectBase extends DurableObject<Env> {
public constructor(ctx: DurableObjectState, env: Env) {
super(ctx, env);
}

async fetch(): Promise<Response> {
this.ctx.storage.kv.put('test-key', { value: 'hello' });
const val = this.ctx.storage.kv.get('test-key');
const entries = [...this.ctx.storage.kv.list()];
const deleted = this.ctx.storage.kv.delete('test-key');

return Response.json({ get: val, listSize: entries.length, deleted });
}
}

export const TestDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
SyncKvDurableObjectBase,
);

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
tracesSampleRate: 1.0,
}),
{
async fetch(request: Request, env: Env): Promise<Response> {
const url = new URL(request.url);

if (url.pathname === '/flush-marker') {
Sentry.captureMessage('flush-marker');
return new Response(JSON.stringify({ ok: true }), { headers: { 'Content-Type': 'application/json' } });
}

const id = env.TEST_DURABLE_OBJECT.idFromName('test');
const stub = env.TEST_DURABLE_OBJECT.get(id);
return stub.fetch(request);
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
import type { Envelope } from '@sentry/core';
import { expect, it } from 'vitest';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import { createRunner } from '../../../runner';

const flushMarkerMatcher = (envelope: Envelope): void => {
const [, items] = envelope;
const [itemHeader, itemBody] = items[0] as [{ type: string }, Record<string, unknown>];

expect(itemHeader.type).toBe('event');
expect(itemBody.message).toBe('flush-marker');
};

it('instruments sync KV operations on Durable Object storage', async ({ signal }) => {
const runner = createRunner(__dirname)
.expect(envelope => {
const transactionEvent = envelope[1]?.[0]?.[1];
const spans = transactionEvent?.spans ?? [];

expect(transactionEvent).toEqual(
expect.objectContaining({
type: 'transaction',
transaction: 'GET /',
}),
);

expect(spans).toHaveLength(4);
expect(spans).toEqual(
expect.arrayContaining([
expect.objectContaining({
description: 'durable_object_storage_kv_put',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'db',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'put',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_get',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_list',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'list',
}),
}),
expect.objectContaining({
description: 'durable_object_storage_kv_delete',
op: 'db',
origin: 'auto.db.cloudflare.durable_object',
data: expect.objectContaining({
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'delete',
}),
}),
]),
);
})
.expect(flushMarkerMatcher)
.start(signal);

await runner.makeRequest('get', '/');
await runner.makeRequest('get', '/flush-marker');
await runner.completed();
Comment thread
cursor[bot] marked this conversation as resolved.
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
{
"name": "worker-name",
"main": "index.ts",
"compatibility_date": "2025-06-17",
"migrations": [
{
"new_sqlite_classes": ["TestDurableObject"],
"tag": "v1",
},
],
"durable_objects": {
"bindings": [
{
"class_name": "TestDurableObject",
"name": "TEST_DURABLE_OBJECT",
},
],
},
"compatibility_flags": ["nodejs_als"],
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import type { DurableObjectStorage, SyncKvStorage } from '@cloudflare/workers-types';
import { isThenable, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';
import { storeSpanContext } from '../utils/traceLinks';
import { instrumentDurableObjectSyncKvStorage } from './instrumentDurableObjectSyncKvStorage';

const STORAGE_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list', 'setAlarm', 'getAlarm', 'deleteAlarm'] as const;

Expand DownExpand Up@@ -35,6 +36,10 @@ export function instrumentDurableObjectStorage(
// reference" errors.
const original = Reflect.get(target, prop, target);

if (prop === 'kv' && original != null && 'get' in original && 'put' in original) {
return instrumentDurableObjectSyncKvStorage(original as SyncKvStorage);
}

if (typeof original !== 'function') {
return original;
}
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import type { SyncKvStorage } from '@cloudflare/workers-types';
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, startSpan } from '@sentry/core';

const SYNC_KV_METHODS_TO_INSTRUMENT = ['get', 'put', 'delete', 'list'] as const;

type SyncKvMethod = (typeof SYNC_KV_METHODS_TO_INSTRUMENT)[number];

export function instrumentDurableObjectSyncKvStorage(syncKv: SyncKvStorage): SyncKvStorage {
return new Proxy(syncKv, {
get(target, prop, _receiver) {
const original = Reflect.get(target, prop, target);

if (typeof original !== 'function') {
return original;
}

const methodName = prop as SyncKvMethod;

if (!SYNC_KV_METHODS_TO_INSTRUMENT.includes(methodName)) {
return (original as (...args: unknown[]) => unknown).bind(target);
}

return function (this: unknown, ...args: unknown[]) {
return startSpan(
{
name: `durable_object_storage_kv_${methodName}`,
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
// keeping the value as close as possible to the Cloudflare Worker KV instrumentation
// https://github.com/cloudflare/workerd/blob/6b8b11787e2b2a800ab0edd0690bfab3857b0529/src/workerd/api/sync-kv.c%2B%2B#L19
'db.system.name': 'cloudflare-durable-object-sql',
Comment thread
JPeer264 marked this conversation as resolved.
'db.operation.name': methodName,
},
},
() => {
return (original as (...args: unknown[]) => unknown).apply(target, args);
},
);
};
},
});
}
29 changes: 29 additions & 0 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import * as sentryCore from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { instrumentDurableObjectStorage } from '../src/instrumentations/instrumentDurableObjectStorage';
Expand DownExpand Up@@ -304,6 +305,28 @@ describe('instrumentDurableObjectStorage', () => {
});
});

describe('sync KV instrumentation', () => {
it('instruments the kv property with a proxy', () => {
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

instrumented.kv.get('myKey');

expect(sentryCore.startSpan).toHaveBeenCalledWith(
{
name: 'durable_object_storage_kv_get',
op: 'db',
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare-durable-object-sql',
'db.operation.name': 'get',
},
},
expect.any(Function),
);
});
});

describe('native getter preservation', () => {
it('preserves native getter `this` binding through the proxy', () => {
// Private fields simulate workerd's native brand check —
Expand DownExpand Up@@ -349,5 +372,11 @@ function createMockStorage(): any {
sql: {
exec: vi.fn(),
},
kv: {
get: vi.fn().mockReturnValue(undefined),
put: vi.fn().mockReturnValue(undefined),
delete: vi.fn().mockReturnValue(false),
list: vi.fn().mockReturnValue([]),
},
};
}
Loading
Loading