Generate a common identifier to be accessible into logger options and to the error page

[leidsoncruz]

Goals

1. Enable custom parameters to be shared between the logger and error page

Non-Goals

1. Generate automatically a UUID

Background

When a user encounters a login issue, we log the error using the logger options in our service log. The relevant code snippet looks like this:

export default NextAuth({
  ...
  logger: {
    error(code, metadata) {
      // Log to the service logging.
    },
  }
  ...
})

However, the issue arises when the user is redirected to an error page displaying only a basic error code. This makes it difficult to link the error logged in our service with the specific issue the user is experiencing. As a result, when a user submits a ticket reporting a login problem, we struggle to identify the exact error in our logging service that corresponds to their issue.

Proposal

Add a new callback that allows us to generate metadata, making it available in both the logger error function and as a query parameter on the error page.

Here's how the implementation would look:

// authOptions
callbacks: {
  async signIn({ user, account, profile, email, credentials }) {
    return true;
  },
  ...
  async error({ code, metadata }) {
    // Generate specific metadata, such as a trace ID, which can be helpful for tracking errors.
    const traceId = generateUUID();
    return { traceId };
  }
}

// logger

logger: {
  error(code, metadata) {
    // Log the error code along with the generated trace ID to the service logging.
    logger.error(code, metadata.traceId);
  },
}

// error page

?error=Verification&traceId=<UUID>

This setup allows the generated metadata, like traceId, to be available in the logger and also passed as a query parameter to the error page, facilitating easier tracking and correlation of errors.