How to override the error serializer/sanitizer?

[adaboese]

Documentation mentions sanitization:

If you need to log these errors or report then to a third-party service such as BugSnag or Sentry, then you can do this through a handleError export in your app/entry.server.js. This method receives the un-sanitized versions of the error since it is also running on the server.

https://remix.run/docs/en/main/guides/errors#error-sanitization

Where is this logic implemented and how do I override it?

My use case is that I need to attach an additional property to the error.

Namely, when an error occurs, I want to generate Sentry error ID and display that to the user.

import { captureException } from '@sentry/node';

// ...

const sentryErrorId = captureException(error);

I would imagine that I can do this in the error sanitization stage, e.g.

const sanitizeError = (error) => {
  const sentryErrorId = captureException(error);

  const sanitizedError = originalSanitizeError(error);

  sanitizedError.sentryErrorId = sentryErrorId;

  return sanitizedError;
};

---

I just realized that if I do this, then I will get errors reported twice, because @sentry/remix already wraps error handler. I can always remove it, but just flagging that there is this issue.

[steuraa]

I'm wondering about this as well.
In our project we're trying to show extra info about the occurred error (via error codes coming from the backend) in our error boundary and simultaneously log the errors in Sentry.
It would be nice if there was an option to pass any extra data to the Errorboundary when throwing an Error, or to disable/amend the sanitizing.

[kiliman]

Yes, I had that issue as well. Unfortunately, the only thing that gets through to the error boundary is error.message (and stack in development) or error.data for thrown responses.

In my remix-global-data example I work around it by setting .message to JSON.stringify(data) in handleError and then parse it in my error boundary.

https://github.com/kiliman/remix-global-data#access-request-data-in-errorboundary

[steuraa]

Thanks @kiliman , tried it out and seems like a simple/workable solution 👍

[thomasverleye]

@kiliman After testing this out, it seems like overwriting the .message aint possible after all.
We consistently are receiving the error Error: Unexpected Server Error while in the handleError we're overwriting the error.message 🤔

Did something change in the way Remix sanitize the errors?

[gustavopch]

This is the relevant code:

remix/packages/remix-server-runtime/errors.ts

Lines 48 to 55 in ede2012

	export function sanitizeError<T = unknown>(error: T, serverMode: ServerMode) {
	if (error instanceof Error && serverMode !== ServerMode.Development) {
	let sanitized = new Error("Unexpected Server Error");
	sanitized.stack = undefined;
	return sanitized;
	}
	return error;
	}

[manzaloros]

Started a conversation about this here