-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
feat(sveltekit): Add wrapper for remote function invocation #17328
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.
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
import { addNonEnumerableProperty, captureException, flushIfServerless, startSpan } from '@sentry/core'; | ||
import type { LoadEvent } from '@sveltejs/kit'; | ||
import type { SentryWrappedFlag } from '../common/utils'; | ||
|
||
type PatchedRequestEvent = LoadEvent & SentryWrappedFlag; | ||
|
||
/** | ||
* Wraps a remote function invokation with a Sentry span and captures an exception if the remote function throws. | ||
*/ | ||
export function wrapRemoteFunctionWithSentry<T extends (...args: any) => any>(origRemoteFn: T): T { | ||
return new Proxy(origRemoteFn, { | ||
apply: async (wrappingTarget, thisArg, args: Parameters<T>) => { | ||
// Type casting here because `T` cannot extend `Load` (see comment above function signature) | ||
// Also, this event possibly already has a sentry wrapped flag attached | ||
const event = args[0] as PatchedRequestEvent; | ||
|
||
if (event.__sentry_wrapped__) { | ||
return wrappingTarget.apply(thisArg, args); | ||
} | ||
|
||
addNonEnumerableProperty(event as unknown as Record<string, unknown>, '__sentry_wrapped__', true); | ||
|
||
const routeId = event.route?.id; | ||
|
||
try { | ||
// We need to await before returning, otherwise we won't catch any errors thrown by the load function | ||
return await startSpan( | ||
{ | ||
name: routeId ? routeId : event.url.pathname, | ||
}, | ||
() => wrappingTarget.apply(thisArg, args), | ||
); | ||
} catch (e) { | ||
captureException(e); | ||
throw e; | ||
} finally { | ||
await flushIfServerless(); | ||
} | ||
}, | ||
}); | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Sentry Wrapping Function Type and Attribute Issues
The
wrapRemoteFunctionWithSentry
function has three issues:async
proxyapply
method breaks the type contract for synchronousorigRemoteFn
, causing it to return aPromise<ReturnType<T>>
instead ofReturnType<T>
.startSpan
call is missing the requiredSEMANTIC_ATTRIBUTE_SENTRY_ORIGIN
('sentry.origin') andSEMANTIC_ATTRIBUTE_SENTRY_OP
('sentry.op') span attributes.captureException
call is missing themechanism
parameter, which must specifyhandled
(true/false) andtype
(integration/origin).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good cursor! have a treat!