Skip to content
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

chore: mask internal server errors #350

Merged
merged 3 commits into from
Jan 9, 2024
Merged
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
49 changes: 25 additions & 24 deletions src/lib/apollo-server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,11 @@ import type {
Prisma,
Semester,
} from "@prisma/client";
import { PrismaClientKnownRequestError } from "@prisma/client/runtime/library.js";
import type { FastifyInstance, FastifyReply, FastifyRequest } from "fastify";
import type { GraphQLFormattedError } from "graphql";
import { GraphQLError, type GraphQLFormattedError } from "graphql";
import { merge } from "lodash-es";
import { ZodError } from "zod";
import type { BookingStatus } from "~/domain/cabins.js";
import { KnownDomainError, errorCodes } from "~/domain/errors.js";
import { errorCodes, isUserFacingError } from "~/domain/errors.js";
import type { Category, Event, SignUpAvailability } from "~/domain/events.js";
import type { Role } from "~/domain/organizations.js";
import type { User } from "~/domain/users.js";
Expand All @@ -28,38 +26,41 @@ export function getFormatErrorHandler(log?: Partial<FastifyInstance["log"]>) {
formattedError: GraphQLFormattedError,
error: unknown,
): GraphQLFormattedError => {
if (error instanceof ZodError) {
return {
...formattedError,
message: error.message,
extensions: {
code: errorCodes.ERR_BAD_USER_INPUT,
},
};
}

const originalError = unwrapResolverError(error);

if (originalError instanceof KnownDomainError) {
/**
* GraphQLErrors include errors such as invalid queries, missing required arguments, etc.
* and should be returned as-is.
*/
if (originalError instanceof GraphQLError) {
return formattedError;
}

/**
* If the error is a user-facing error, we can return it as-is.
*/
if (isUserFacingError(originalError)) {
return merge({}, formattedError, {
message: originalError.description,
message: originalError.message,
extensions: {
code: originalError.code,
},
});
}

if (originalError instanceof PrismaClientKnownRequestError) {
if (originalError instanceof Error) {
log?.error?.(originalError);
return merge({}, formattedError, {
message: originalError.message,
extensions: {
code: errorCodes.ERR_INTERNAL_SERVER_ERROR,
},
});
}

return formattedError;
/**
* If the error is not a user-facing error, we should mask it and return a generic error message.
*/
return merge({}, formattedError, {
message: "An unexpected error occurred",
extensions: {
code: errorCodes.ERR_INTERNAL_SERVER_ERROR,
},
});
};
return formatError;
}
Expand Down