Skip to content

fix(node): Fix tRPC middleware typing #9540

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
Nov 14, 2023
Merged

fix(node): Fix tRPC middleware typing #9540

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
64 changes: 39 additions & 25 deletions packages/node/src/handlers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
dropUndefinedKeys,
extractPathForTransaction,
isString,
isThenable,
logger,
normalize,
tracingContextFromHeaders,
Expand Down Expand Up @@ -326,7 +327,7 @@ interface SentryTrpcMiddlewareOptions {

interface TrpcMiddlewareArguments<T> {
path: string;
type: 'query' | 'mutation' | 'subscription';
type: string;
Copy link
Member

Choose a reason for hiding this comment

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

Are we broading this on purpose here (just checking)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, we are not depending on any of the direct strings here (just dumping what's in type onto the event) and I figured that if trpc adds more types we will break typing again.

next: () => T;
rawInput: unknown;
}
Expand All @@ -338,7 +339,7 @@ interface TrpcMiddlewareArguments<T> {
* e.g. Express Request Handlers or Next.js SDK.
*/
export function trpcMiddleware(options: SentryTrpcMiddlewareOptions = {}) {
return async function <T>({ path, type, next, rawInput }: TrpcMiddlewareArguments<T>): Promise<T> {
return function <T>({ path, type, next, rawInput }: TrpcMiddlewareArguments<T>): T {
const hub = getCurrentHub();
const clientOptions = hub.getClient()?.getOptions();
const sentryTransaction = hub.getScope().getTransaction();
Expand All @@ -358,36 +359,49 @@ export function trpcMiddleware(options: SentryTrpcMiddlewareOptions = {}) {
sentryTransaction.setContext('trpc', trpcContext);
}

function captureError(e: unknown): void {
captureException(e, scope => {
scope.addEventProcessor(event => {
addExceptionMechanism(event, {
handled: false,
function shouldCaptureError(e: unknown): boolean {
if (typeof e === 'object' && e && 'code' in e) {
// Is likely TRPCError - we only want to capture internal server errors
return e.code === 'INTERNAL_SERVER_ERROR';
} else {
// Is likely random error that bubbles up
return true;
}
}

function handleErrorCase(e: unknown): void {
if (shouldCaptureError(e)) {
captureException(e, scope => {
scope.addEventProcessor(event => {
addExceptionMechanism(event, {
handled: false,
});
return event;
});
return event;
});

return scope;
});
return scope;
});
}
}

try {
return await next();
} catch (e: unknown) {
if (typeof e === 'object' && e) {
if ('code' in e) {
// Is likely TRPCError - we only want to capture internal server errors
if (e.code === 'INTERNAL_SERVER_ERROR') {
captureError(e);
}
} else {
// Is likely random error that bubbles up
captureError(e);
}
}
let maybePromiseResult;
Copy link
Member

Choose a reason for hiding this comment

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

not directly related and nothing to do, but I feel like we've written this or very similar code a lot of times by now, maybe we can find a way to extract this into some util function that we can reuse 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah agreed. It's like a promise aware try catch. Would definitely make sense to extract!


try {
maybePromiseResult = next();
} catch (e) {
handleErrorCase(e);
throw e;
}

if (isThenable(maybePromiseResult)) {
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
Promise.resolve(maybePromiseResult).then(null, e => {
handleErrorCase(e);
});
}

// We return the original promise just to be safe.
return maybePromiseResult;
};
}

Expand Down