Skip to content

feat(sveltekit): Convert sentryHandle to a factory function #7975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 26, 2023
Merged

feat(sveltekit): Convert sentryHandle to a factory function #7975

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions packages/sveltekit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,10 +125,10 @@ The Sentry SvelteKit SDK mostly relies on [SvelteKit Hooks](https://kit.svelte.d
// hooks.server.(js|ts)
import { sentryHandle } from '@sentry/sveltekit';

export const handle = sentryHandle;
export const handle = sentryHandle();
// or alternatively, if you already have a handler defined, use the `sequence` function
// see: https://kit.svelte.dev/docs/modules#sveltejs-kit-hooks-sequence
// export const handle = sequence(sentryHandle, yourHandler);
// export const handle = sequence(sentryHandle(), yourHandler());
```

### 4. Configuring `load` Functions
Expand Down
10 changes: 7 additions & 3 deletions packages/sveltekit/src/server/handle.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,17 @@ export const transformPageChunk: NonNullable<ResolveOptions['transformPageChunk'
* // src/hooks.server.ts
* import { sentryHandle } from '@sentry/sveltekit';
*
* export const handle = sentryHandle;
* export const handle = sentryHandle();
*
* // Optionally use the sequence function to add additional handlers.
* // export const handle = sequence(sentryHandle, yourCustomHandle);
* // export const handle = sequence(sentryHandle(), yourCustomHandler);
* ```
*/
export const sentryHandle: Handle = input => {
export function sentryHandle(): Handle {
return sentryRequestHandler;
}

const sentryRequestHandler: Handle = input => {
// if there is an active transaction, we know that this handle call is nested and hence
// we don't create a new domain for it. If we created one, nested server calls would
// create new transactions instead of adding a child span to the currently active span.
Expand Down
16 changes: 8 additions & 8 deletions packages/sveltekit/test/server/handle.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ describe('handleSentry', () => {
it('should return a response', async () => {
let response: any = undefined;
try {
response = await sentryHandle({ event: mockEvent(), resolve: resolve(type, isError) });
response = await sentryHandle()({ event: mockEvent(), resolve: resolve(type, isError) });
} catch (e) {
expect(e).toBeInstanceOf(Error);
expect(e.message).toEqual(type);
Expand All @@ -136,7 +136,7 @@ describe('handleSentry', () => {
});

try {
await sentryHandle({ event: mockEvent(), resolve: resolve(type, isError) });
await sentryHandle()({ event: mockEvent(), resolve: resolve(type, isError) });
} catch (e) {
//
}
Expand All @@ -161,11 +161,11 @@ describe('handleSentry', () => {
});

try {
await sentryHandle({
await sentryHandle()({
event: mockEvent(),
resolve: async _ => {
// simulateing a nested load call:
await sentryHandle({
await sentryHandle()({
event: mockEvent({ route: { id: 'api/users/details/[id]' } }),
resolve: resolve(type, isError),
});
Expand Down Expand Up @@ -216,7 +216,7 @@ describe('handleSentry', () => {
});

try {
await sentryHandle({ event, resolve: resolve(type, isError) });
await sentryHandle()({ event, resolve: resolve(type, isError) });
} catch (e) {
//
}
Expand Down Expand Up @@ -256,7 +256,7 @@ describe('handleSentry', () => {
});

try {
await sentryHandle({ event, resolve: resolve(type, isError) });
await sentryHandle()({ event, resolve: resolve(type, isError) });
} catch (e) {
//
}
Expand All @@ -280,7 +280,7 @@ describe('handleSentry', () => {
});

try {
await sentryHandle({ event: mockEvent(), resolve: resolve(type, isError) });
await sentryHandle()({ event: mockEvent(), resolve: resolve(type, isError) });
} catch (e) {
expect(mockCaptureException).toBeCalledTimes(1);
expect(addEventProcessorSpy).toBeCalledTimes(1);
Expand All @@ -296,7 +296,7 @@ describe('handleSentry', () => {
const mockResolve = vi.fn().mockImplementation(resolve(type, isError));
const event = mockEvent();
try {
await sentryHandle({ event, resolve: mockResolve });
await sentryHandle()({ event, resolve: mockResolve });
} catch (e) {
expect(e).toBeInstanceOf(Error);
expect(e.message).toEqual(type);
Expand Down