Skip to content

test(cloudflare): Remove mock in DO tests #21634

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

Open
JPeer264 wants to merge 1 commit into
base: develop
Choose a base branch
from
+72 −53
Open

test(cloudflare): Remove mock in DO tests #21634

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 72 additions & 53 deletions packages/cloudflare/test/instrumentDurableObjectStorage.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,9 @@
import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
import * as sentryCore from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { instrumentDurableObjectStorage } from '../src/instrumentations/instrumentDurableObjectStorage';
import * as traceLinks from '../src/utils/traceLinks';

vi.mock('@sentry/core', async importOriginal => {
const actual = await importOriginal<typeof sentryCore>();
return {
...actual,
startSpan: vi.fn((opts, callback) => callback()),
getActiveSpan: vi.fn(),
};
});

vi.mock('../src/utils/traceLinks', async importOriginal => {
const actual = await importOriginal<typeof traceLinks>();
return {
Expand All @@ -22,42 +13,48 @@ vi.mock('../src/utils/traceLinks', async importOriginal => {
});

describe('instrumentDurableObjectStorage', () => {
beforeEach(() => {
vi.clearAllMocks();
afterEach(() => {
vi.restoreAllMocks();
});

describe('get', () => {
it('instruments get with single key', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

await instrumented.get('myKey');

expect(sentryCore.startSpan).toHaveBeenCalledWith(
expect(startSpanSpy).toHaveBeenCalledWith(
{
name: 'durable_object_storage_get',
op: 'db',
attributes: expect.objectContaining({
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare.durable_object.storage',
'db.operation.name': 'get',
}),
},
},
expect.any(Function),
);
});

it('instruments get with array of keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

await instrumented.get(['key1', 'key2', 'key3']);

expect(sentryCore.startSpan).toHaveBeenCalledWith(
expect(startSpanSpy).toHaveBeenCalledWith(
{
name: 'durable_object_storage_get',
op: 'db',
attributes: expect.objectContaining({
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare.durable_object.storage',
'db.operation.name': 'get',
}),
},
},
expect.any(Function),
);
Expand All @@ -66,36 +63,42 @@ describe('instrumentDurableObjectStorage', () => {

describe('put', () => {
it('instruments put with single key', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

await instrumented.put('myKey', 'myValue');

expect(sentryCore.startSpan).toHaveBeenCalledWith(
expect(startSpanSpy).toHaveBeenCalledWith(
{
name: 'durable_object_storage_put',
op: 'db',
attributes: expect.objectContaining({
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare.durable_object.storage',
'db.operation.name': 'put',
}),
},
},
expect.any(Function),
);
});

it('instruments put with object entries', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

await instrumented.put({ key1: 'val1', key2: 'val2' });

expect(sentryCore.startSpan).toHaveBeenCalledWith(
expect(startSpanSpy).toHaveBeenCalledWith(
{
name: 'durable_object_storage_put',
op: 'db',
attributes: expect.objectContaining({
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare.durable_object.storage',
'db.operation.name': 'put',
}),
},
},
expect.any(Function),
);
Expand All @@ -104,36 +107,42 @@ describe('instrumentDurableObjectStorage', () => {

describe('delete', () => {
it('instruments delete with single key', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

await instrumented.delete('myKey');

expect(sentryCore.startSpan).toHaveBeenCalledWith(
expect(startSpanSpy).toHaveBeenCalledWith(
{
name: 'durable_object_storage_delete',
op: 'db',
attributes: expect.objectContaining({
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare.durable_object.storage',
'db.operation.name': 'delete',
}),
},
},
expect.any(Function),
);
});

it('instruments delete with array of keys', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

await instrumented.delete(['key1', 'key2']);

expect(sentryCore.startSpan).toHaveBeenCalledWith(
expect(startSpanSpy).toHaveBeenCalledWith(
{
name: 'durable_object_storage_delete',
op: 'db',
attributes: expect.objectContaining({
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare.durable_object.storage',
'db.operation.name': 'delete',
}),
},
},
expect.any(Function),
);
Expand All @@ -142,18 +151,21 @@ describe('instrumentDurableObjectStorage', () => {

describe('list', () => {
it('instruments list', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

await instrumented.list();

expect(sentryCore.startSpan).toHaveBeenCalledWith(
expect(startSpanSpy).toHaveBeenCalledWith(
{
name: 'durable_object_storage_list',
op: 'db',
attributes: expect.objectContaining({
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare.durable_object.storage',
'db.operation.name': 'list',
}),
},
},
expect.any(Function),
);
Expand All @@ -162,24 +174,27 @@ describe('instrumentDurableObjectStorage', () => {

describe('alarm methods', () => {
it('instruments setAlarm', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

await instrumented.setAlarm(Date.now() + 1000);

expect(sentryCore.startSpan).toHaveBeenCalledWith(
expect(startSpanSpy).toHaveBeenCalledWith(
{
name: 'durable_object_storage_setAlarm',
op: 'db',
attributes: expect.objectContaining({
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare.durable_object.storage',
'db.operation.name': 'setAlarm',
}),
},
},
expect.any(Function),
);
});

it('stores span context when setAlarm is called (async)', async () => {
it('stores span context when setAlarm is called', async () => {
const mockStorage = createMockStorage();
const waitUntil = vi.fn();
const instrumented = instrumentDurableObjectStorage(mockStorage, waitUntil);
Expand All @@ -190,7 +205,7 @@ describe('instrumentDurableObjectStorage', () => {
expect(traceLinks.storeSpanContext).toHaveBeenCalledWith(mockStorage, 'alarm');
});

it('calls teardown after promise resolves (async case)', async () => {
it('calls teardown after promise resolves', async () => {
const callOrder: string[] = [];
let resolveStorage: () => void;
const storagePromise = new Promise<void>(resolve => {
Expand All @@ -212,15 +227,12 @@ describe('instrumentDurableObjectStorage', () => {
const instrumented = instrumentDurableObjectStorage(mockStorage, waitUntil);
const resultPromise = instrumented.setAlarm(Date.now() + 1000);

// Before resolving, waitUntil should not have been called yet

@nicohrubec nicohrubec Jun 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

q: are these comments removed on purpose?

expect(waitUntil).not.toHaveBeenCalled();
expect(callOrder).toEqual(['setAlarm started']);

// Resolve the storage promise
resolveStorage!();
await resultPromise;

// After resolving, waitUntil should have been called
expect(waitUntil).toHaveBeenCalledTimes(1);
expect(callOrder).toEqual(['setAlarm started', 'setAlarm resolved', 'waitUntil called']);
});
Expand All @@ -229,10 +241,9 @@ describe('instrumentDurableObjectStorage', () => {
const callOrder: string[] = [];

const mockStorage = createMockStorage();
// Make setAlarm return a sync value (not a promise)
mockStorage.setAlarm = vi.fn().mockImplementation(() => {
callOrder.push('setAlarm executed');
return undefined; // sync return
return undefined;
});

const waitUntil = vi.fn().mockImplementation(() => {
Expand All @@ -242,42 +253,47 @@ describe('instrumentDurableObjectStorage', () => {
const instrumented = instrumentDurableObjectStorage(mockStorage, waitUntil);
instrumented.setAlarm(Date.now() + 1000);

// For sync results, waitUntil should be called immediately after
expect(waitUntil).toHaveBeenCalledTimes(1);
expect(callOrder).toEqual(['setAlarm executed', 'waitUntil called']);
});

it('instruments getAlarm', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

await instrumented.getAlarm();

expect(sentryCore.startSpan).toHaveBeenCalledWith(
expect(startSpanSpy).toHaveBeenCalledWith(
{
name: 'durable_object_storage_getAlarm',
op: 'db',
attributes: expect.objectContaining({
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare.durable_object.storage',
'db.operation.name': 'getAlarm',
}),
},
},
expect.any(Function),
);
});

it('instruments deleteAlarm', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

await instrumented.deleteAlarm();

expect(sentryCore.startSpan).toHaveBeenCalledWith(
expect(startSpanSpy).toHaveBeenCalledWith(
{
name: 'durable_object_storage_deleteAlarm',
op: 'db',
attributes: expect.objectContaining({
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.db.cloudflare.durable_object',
'db.system.name': 'cloudflare.durable_object.storage',
'db.operation.name': 'deleteAlarm',
}),
},
},
expect.any(Function),
);
Expand All @@ -286,14 +302,15 @@ describe('instrumentDurableObjectStorage', () => {

describe('non-instrumented methods', () => {
it('does not instrument deleteAll, sync, transaction', async () => {
const startSpanSpy = vi.spyOn(sentryCore, 'startSpan');
const mockStorage = createMockStorage();
const instrumented = instrumentDurableObjectStorage(mockStorage);

await instrumented.deleteAll();
await instrumented.sync();
await instrumented.transaction(async txn => txn);

expect(sentryCore.startSpan).not.toHaveBeenCalled();
expect(startSpanSpy).not.toHaveBeenCalled();
});

it('does not instrument sql property', () => {
Expand All @@ -307,12 +324,13 @@ describe('instrumentDurableObjectStorage', () => {

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

instrumented.kv.get('myKey');

expect(sentryCore.startSpan).toHaveBeenCalledWith(
expect(startSpanSpy).toHaveBeenCalledWith(
{
name: 'durable_object_storage_kv_get',
op: 'db',
Expand Down Expand Up @@ -370,7 +388,8 @@ function createMockStorage(): any {
sync: vi.fn().mockResolvedValue(undefined),
transaction: vi.fn().mockImplementation(async (cb: () => unknown) => cb()),
sql: {
exec: vi.fn(),
exec: vi.fn().mockReturnValue({ rowsRead: 0, rowsWritten: 0, toArray: () => [] }),
databaseSize: 0,
},
kv: {
get: vi.fn().mockReturnValue(undefined),
Expand Down
Loading