Skip to content
Open
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
5 changes: 5 additions & 0 deletions packages/aws-serverless/src/instrumentHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,11 @@ function getPatchedHandler(original: Handler | StreamifyHandler, lambdaStartTime
throw error;
}

// Callback-style handlers usually return before invoking the callback, so the wrapped callback ends the span.
if (original.length > 2 && typeof maybePromise?.then !== 'function') {
return maybePromise;
}

return handlePromiseResult(span, maybePromise);
}),
);
Expand Down
84 changes: 84 additions & 0 deletions packages/aws-serverless/test/instrumentHandler.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
import type { Context, Handler } from 'aws-lambda';
import { beforeEach, describe, expect, test, vi } from 'vitest';
import { instrumentHandler } from '../src/instrumentHandler';

const mockSpan = {
setStatus: vi.fn(),
end: vi.fn(),
};

vi.mock('@sentry/core', async () => {
const original = await vi.importActual('@sentry/core');
return {
...original,
continueTrace: (_traceData: unknown, callback: () => unknown) => callback(),
startSpanManual: (_options: unknown, callback: (span: unknown) => unknown) => callback(mockSpan),
};
});

vi.mock('@sentry/node', async () => {
const original = await vi.importActual('@sentry/node');
return {
...original,
flush: () => Promise.resolve(true),
captureException: vi.fn(),
};
});

const fakeContext = {
callbackWaitsForEmptyEventLoop: false,
functionName: 'functionName',
functionVersion: 'functionVersion',
invokedFunctionArn: 'arn:aws:lambda:us-east-1:123456789012:function:functionName',
memoryLimitInMB: '128',
awsRequestId: 'awsRequestId',
logGroupName: 'logGroupName',
logStreamName: 'logStreamName',
getRemainingTimeInMillis: () => 30_000,
done: () => {},
fail: () => {},
succeed: () => {},
} as Context;

describe('instrumentHandler', () => {
beforeEach(() => {
vi.clearAllMocks();
});

test('ends the span when a callback-style handler calls back asynchronously', async () => {
const handler: Handler = (_event, _context, callback) => {
setTimeout(() => callback(null, 42), 10);
};

const result = instrumentHandler(handler)({}, fakeContext, () => {});
expect(mockSpan.end).not.toHaveBeenCalled();

await expect(result).resolves.toBe(42);
expect(mockSpan.end).toHaveBeenCalledTimes(1);
expect(mockSpan.setStatus).not.toHaveBeenCalled();
});

test('sets error status when a callback-style handler calls back with an error asynchronously', async () => {
const handler: Handler = (_event, _context, callback) => {
setTimeout(() => callback(new Error('boom')), 10);
};

const result = instrumentHandler(handler)({}, fakeContext, () => {});
expect(mockSpan.end).not.toHaveBeenCalled();

await expect(result).rejects.toThrow('boom');
expect(mockSpan.setStatus).toHaveBeenCalledWith({ code: 2, message: 'boom' });
expect(mockSpan.end).toHaveBeenCalledTimes(1);
});

test('ends the span when an async handler resolves', async () => {
const handler: Handler = async () => {
await new Promise(resolve => setTimeout(resolve, 10));
return 42;
};

await expect(instrumentHandler(handler)({}, fakeContext, () => {})).resolves.toBe(42);
expect(mockSpan.end).toHaveBeenCalledTimes(1);
expect(mockSpan.setStatus).not.toHaveBeenCalled();
});
});
Loading