Skip to content
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

ref(sveltekit): Clean up sub-request check #15251

Merged
merged 3 commits into from
Feb 4, 2025
Merged

ref(sveltekit): Clean up sub-request check #15251

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
97f48ff
ref(sveltekit): Clean up sub-request check
Lms24 Jan 31, 2025
50d105f
remove test
Lms24 Jan 31, 2025
27af201
remove unused import
Lms24 Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions packages/sveltekit/src/server/handle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,19 +100,13 @@ export function sentryHandle(handlerOptions?: SentryHandleOptions): Handle {
};

const sentryRequestHandler: Handle = input => {
// event.isSubRequest was added in SvelteKit 1.21.0 and we can use it to check
// if we should create a new execution context or not.
// In case of a same-origin `fetch` call within a server`load` function,
// SvelteKit will actually just re-enter the `handle` function and set `isSubRequest`
// to `true` so that no additional network call is made.
// We want the `http.server` span of that nested call to be a child span of the
// currently active span instead of a new root span to correctly reflect this
// behavior.
// As a fallback for Kit < 1.21.0, we check if there is an active span only if there's none,
// we create a new execution context.
const isSubRequest = typeof input.event.isSubRequest === 'boolean' ? input.event.isSubRequest : !!getActiveSpan();

if (isSubRequest) {
if (input.event.isSubRequest) {
return instrumentHandle(input, options);
}

Expand Down
49 changes: 1 addition & 48 deletions packages/sveltekit/test/server/handle.test.ts
View file
Open in desktop
Copy link
Member Author

Choose a reason for hiding this comment

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

in case reviewers are wondering, this is just funny diff formatting. I actually deleted the other test and removed [kit>=1.21.0] from the test that GH shows as removed 😅

Original file line number Diff line number Diff line change
Expand Up @@ -149,53 +149,6 @@ describe('sentryHandle', () => {
expect(spans).toHaveLength(1);
});

it('[kit>=1.21.0] creates a child span for nested server calls (i.e. if there is an active span)', async () => {
let _span: Span | undefined = undefined;
let txnCount = 0;
client.on('spanEnd', span => {
if (span === getRootSpan(span)) {
_span = span;
++txnCount;
}
});

try {
await sentryHandle()({
event: mockEvent(),
resolve: async _ => {
// simulating a nested load call:
await sentryHandle()({
event: mockEvent({ route: { id: 'api/users/details/[id]', isSubRequest: true } }),
resolve: resolve(type, isError),
});
return mockResponse;
},
});
} catch (e) {
//
}

expect(txnCount).toEqual(1);
expect(_span!).toBeDefined();

expect(spanToJSON(_span!).description).toEqual('GET /users/[id]');
expect(spanToJSON(_span!).op).toEqual('http.server');
expect(spanToJSON(_span!).status).toEqual(isError ? 'internal_error' : 'ok');
expect(spanToJSON(_span!).data?.[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]).toEqual('route');

expect(spanToJSON(_span!).timestamp).toBeDefined();

const spans = getSpanDescendants(_span!).map(spanToJSON);

expect(spans).toHaveLength(2);
expect(spans).toEqual(
expect.arrayContaining([
expect.objectContaining({ op: 'http.server', description: 'GET /users/[id]' }),
expect.objectContaining({ op: 'http.server', description: 'GET api/users/details/[id]' }),
]),
);
});

it('creates a child span for nested server calls (i.e. if there is an active span)', async () => {
let _span: Span | undefined = undefined;
let txnCount = 0;
Expand All @@ -212,7 +165,7 @@ describe('sentryHandle', () => {
resolve: async _ => {
// simulating a nested load call:
await sentryHandle()({
event: mockEvent({ route: { id: 'api/users/details/[id]' } }),
event: mockEvent({ route: { id: 'api/users/details/[id]', isSubRequest: true } }),
resolve: resolve(type, isError),
});
return mockResponse;
Expand Down
Loading