prisma-error-formatter
Version:
A flexible and customizable Prisma error formatter to simplify and unify error handling in Prisma Client applications.
250 lines (249 loc) • 11.7 kB
JavaScript
;
var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
var _, done = false;
for (var i = decorators.length - 1; i >= 0; i--) {
var context = {};
for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
for (var p in contextIn.access) context.access[p] = contextIn.access[p];
context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
if (kind === "accessor") {
if (result === void 0) continue;
if (result === null || typeof result !== "object") throw new TypeError("Object expected");
if (_ = accept(result.get)) descriptor.get = _;
if (_ = accept(result.set)) descriptor.set = _;
if (_ = accept(result.init)) initializers.unshift(_);
}
else if (_ = accept(result)) {
if (kind === "field") initializers.unshift(_);
else descriptor[key] = _;
}
}
if (target) Object.defineProperty(target, contextIn.name, descriptor);
done = true;
};
var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
var useValue = arguments.length > 2;
for (var i = 0; i < initializers.length; i++) {
value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
}
return useValue ? value : void 0;
};
var __setFunctionName = (this && this.__setFunctionName) || function (f, name, prefix) {
if (typeof name === "symbol") name = name.description ? "[".concat(name.description, "]") : "";
return Object.defineProperty(f, "name", { configurable: true, value: prefix ? "".concat(prefix, " ", name) : name });
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.GlobalExceptionFilter = void 0;
const common_1 = require("@nestjs/common");
const library_1 = require("@prisma/client/runtime/library");
const parse_http_exception_1 = require("./helpers/parse-http-exception");
const parse_prisma_errors_1 = require("./helpers/parse-prisma-errors");
const parse_validation_errors_1 = require("./helpers/parse-validation-errors");
let GlobalExceptionFilter = (() => {
let _classDecorators = [(0, common_1.Catch)()];
let _classDescriptor;
let _classExtraInitializers = [];
let _classThis;
var GlobalExceptionFilter = _classThis = class {
constructor() {
this.logger = new common_1.Logger(GlobalExceptionFilter.name);
}
catch(exception, host) {
const ctx = host.switchToHttp();
const response = ctx.getResponse();
const request = ctx.getRequest();
const errorResponse = this.formatException(exception);
this.logException(exception, request);
const status = this.getStatus(exception);
response.status(status).json(errorResponse);
}
formatException(exception) {
if (exception instanceof common_1.HttpException) {
return this.formatHttpException(exception);
}
if (this.isPrismaError(exception)) {
return this.formatPrismaException(exception);
}
if (this.isValidationError(exception)) {
return this.formatValidationException(exception);
}
return this.formatGenericError(exception);
}
formatHttpException(exception) {
const parsed = (0, parse_http_exception_1.parseHttpException)(exception);
const status = exception.getStatus();
const response = exception.getResponse();
let message;
if (typeof response === "object" && response !== null) {
const res = response;
message = typeof res.error === "string"
? res.error
: this.getDefaultMessageForStatus(status);
}
else {
message = exception.message || this.getDefaultMessageForStatus(status);
}
return {
success: false,
message,
errorMessages: parsed,
};
}
formatPrismaException(exception) {
if (exception instanceof library_1.PrismaClientKnownRequestError ||
exception instanceof library_1.PrismaClientValidationError ||
exception instanceof library_1.PrismaClientInitializationError) {
const parsed = (0, parse_prisma_errors_1.parsePrismaError)(exception);
let message;
if (exception instanceof library_1.PrismaClientKnownRequestError) {
switch (exception.code) {
case "P2002":
message = "Unique constraint failed";
break;
case "P2025":
message = "Record not found";
break;
default:
message = "Database error occurred";
}
}
else if (exception instanceof library_1.PrismaClientValidationError) {
message = "Invalid data provided";
}
else {
message = "Database connection failed";
}
return {
success: false,
message,
errorMessages: parsed.length > 0 ? parsed : [{ path: "database", message }],
};
}
return {
success: false,
message: "Database error occurred",
errorMessages: [{ path: "database", message: "Database error occurred" }],
};
}
formatValidationException(exception) {
const response = exception.getResponse();
const messages = [];
if (typeof response === "object" && response !== null) {
const res = response;
if (Array.isArray(res.message)) {
const validationErrors = res.message;
for (const error of validationErrors) {
if (typeof error === "object" && error !== null) {
const errorObj = error;
if (errorObj.errors && Array.isArray(errorObj.errors)) {
const parsed = (0, parse_validation_errors_1.parseValidationErrors)(errorObj.errors);
messages.push(...parsed);
}
}
}
}
}
if (messages.length === 0) {
messages.push({ path: "validation", message: "Validation failed" });
}
return {
success: false,
message: "Validation failed",
errorMessages: messages,
};
}
formatGenericError(exception) {
if (exception instanceof Error) {
return {
success: false,
message: exception.message || "Internal server error",
errorMessages: [
{
path: "server",
message: exception.message || "Internal server error",
},
],
};
}
return {
success: false,
message: "Internal server error",
errorMessages: [
{
path: "server",
message: "Internal server error",
},
],
};
}
isPrismaError(exception) {
return (exception instanceof library_1.PrismaClientKnownRequestError ||
exception instanceof library_1.PrismaClientValidationError ||
exception instanceof library_1.PrismaClientInitializationError);
}
isValidationError(exception) {
if (!(exception instanceof common_1.HttpException))
return false;
const response = exception.getResponse();
if (typeof response !== "object" || response === null)
return false;
const res = response;
return (exception.getStatus() === common_1.HttpStatus.BAD_REQUEST &&
Array.isArray(res.message));
}
getStatus(exception) {
if (exception instanceof common_1.HttpException) {
return exception.getStatus();
}
if (this.isPrismaError(exception)) {
return common_1.HttpStatus.BAD_REQUEST;
}
if (this.isValidationError(exception)) {
return common_1.HttpStatus.BAD_REQUEST;
}
return common_1.HttpStatus.INTERNAL_SERVER_ERROR;
}
getDefaultMessageForStatus(status) {
switch (status) {
case common_1.HttpStatus.BAD_REQUEST:
return "Bad request";
case common_1.HttpStatus.UNAUTHORIZED:
return "Unauthorized";
case common_1.HttpStatus.FORBIDDEN:
return "Forbidden";
case common_1.HttpStatus.NOT_FOUND:
return "Resource not found";
case common_1.HttpStatus.CONFLICT:
return "Conflict";
default:
return "Internal server error";
}
}
logException(exception, request) {
const method = request.method;
const url = request.url;
const ip = request.ip || request.headers["x-forwarded-for"] || "unknown";
if (exception instanceof Error) {
this.logger.error(`${method} ${url} - ${ip} - ${exception.message}`, exception.stack);
}
else {
this.logger.error(`${method} ${url} - ${ip} - ${JSON.stringify(exception)}`);
}
}
};
__setFunctionName(_classThis, "GlobalExceptionFilter");
(() => {
const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(null) : void 0;
__esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
GlobalExceptionFilter = _classThis = _classDescriptor.value;
if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
__runInitializers(_classThis, _classExtraInitializers);
})();
return GlobalExceptionFilter = _classThis;
})();
exports.GlobalExceptionFilter = GlobalExceptionFilter;