Debugging internal server errors with ORPC

[evrys]

Hello, I am trying out ORPC and have a route which fails with an unhandled error like so:

export const router = {
  someroute: os.someroute.handler(async () => {
    throw new Error("Oh no");
  }),
};

This results in a 500 error ORPCError: Internal server error going to the frontend, which makes sense. The problem is that the underlying error/stacktrace doesn't show up in the server log output so I don't know what went wrong. Can I configure the OpenAPIHandler in some way to print the underlying errors?

[dosubot[bot]]

Hi @evrys! I'm Dosu and I’m helping the orpc team.

You can log underlying errors and stack traces in ORPC by adding custom error handling middleware or using the onError interceptor when setting up your OpenAPIHandler. By default, ORPC hides error details for security, but you can intercept errors and log them before they're sent to the client.

Here's a pattern you can use:

import { onError, ORPCError } from '@orpc/server';

const handler = new OpenAPIHandler(router, {
  interceptors: [
    onError((error) => {
      // Log the full error and stack trace
      console.error('ORPC Internal Error:', error);
      if (error instanceof ORPCError && error.cause) {
        console.error('Underlying cause:', error.cause);
      }
    }),
  ],
});

This will print the error and its stack trace to your server logs whenever an unhandled error occurs in a route handler. You can further customize the logging logic as needed. More details and examples are available in related discussions and issues and middleware docs.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}    

[evrys]

This works! It would be neat if orpc did some clever error logging by default though since I inevitably want that on all projects