Skip to content

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
wants to merge 1 commit into from
Closed
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
41 changes: 41 additions & 0 deletions packages/sveltekit/src/server-common/remoteFunctions.ts
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();
}
},
});
Copy link

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:

  1. Its async proxy apply method breaks the type contract for synchronous origRemoteFn, causing it to return a Promise<ReturnType<T>> instead of ReturnType<T>.
  2. The startSpan call is missing the required SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN ('sentry.origin') and SEMANTIC_ATTRIBUTE_SENTRY_OP ('sentry.op') span attributes.
  3. The captureException call is missing the mechanism parameter, which must specify handled (true/false) and type (integration/origin).
Fix in Cursor Fix in Web

Copy link
Member Author

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!

}
Loading