Fix errors and improve error handling

+ Review code
+ Fix error with braces
This commit is contained in:
Stephan
2022-05-29 12:37:02 +02:00
parent 57671d72b8
commit 7ae0c81bb8
4 changed files with 78 additions and 75 deletions
+13 -1
View File
@@ -1,6 +1,7 @@
import { AdminLevel, Prisma } from "@prisma/client"; import { AdminLevel, Prisma } from "@prisma/client";
import { PrismaClientKnownRequestError, PrismaClientUnknownRequestError } from "@prisma/client/runtime"; import { PrismaClientKnownRequestError, PrismaClientUnknownRequestError } from "@prisma/client/runtime";
import { Request, Response } from "express"; import { Request, Response } from "express";
import { ZodError } from "zod";
import prisma from "../lib/prisma"; import prisma from "../lib/prisma";
interface StringIndexedObject { interface StringIndexedObject {
@@ -33,7 +34,18 @@ interface Body {
[k: string]: DataType; [k: string]: DataType;
} }
export function generateInvalidBodyError(body: Body) { export function generateInvalidBodyError(body: Body, zodError?: ZodError) {
if (zodError instanceof ZodError) {
return {
type: "error",
payload: {
message: "The body of your request did not conform to the requirements",
errors: { body: zodError.format() },
schema: { body },
},
};
}
return { return {
type: "error", type: "error",
payload: { payload: {
+62 -74
View File
@@ -16,13 +16,19 @@ import {
require("express-async-errors"); require("express-async-errors");
const DisciplineBody = z.object({ const InitialDisciplineBody = z.object({
name: z.string(), name: z.string().min(1),
minTeamSize: z.number(), minTeamSize: z.number(),
maxTeamSize: z.number(), maxTeamSize: z.number(),
}) });
const updateDisciplineBody = DisciplineBody.partial(); const disciplineRefiner = [
(args: any) => (args.minTeamSize && args.maxTeamSize ? args.minTeamSize <= args.maxTeamSize : true),
{ message: "The minTeamSize must be smaller or equal to the maxTeamSize" },
] as const;
const DisciplineBody = InitialDisciplineBody.refine(...disciplineRefiner);
const updateDisciplineBody = InitialDisciplineBody.partial().refine(...disciplineRefiner);
const basicDiscipline = { const basicDiscipline = {
pid: true, pid: true,
@@ -137,22 +143,21 @@ export const createDiscipline = async (req: Request<{ eventPid: string }, {}, Cr
const result = DisciplineBody.safeParse(req.body); const result = DisciplineBody.safeParse(req.body);
if(result.success === false) { if (result.success === false) {
return res.status(400).json( return res.status(400).json(
generateInvalidBodyError({ generateInvalidBodyError(
name: DataType.STRING, {
minTeamSize: DataType.NUMBER, name: DataType.STRING,
maxTeamSize: DataType.NUMBER, minTeamSize: DataType.NUMBER,
}) maxTeamSize: DataType.NUMBER,
},
result.error
)
); );
} }
const { name, minTeamSize, maxTeamSize } = result.data; const { name, minTeamSize, maxTeamSize } = result.data;
if (!validateName(name)) {
return res.status(400).json(NAME_ERROR);
}
try { try {
const discipline = await prisma.discipline.create({ const discipline = await prisma.discipline.create({
data: { name, minTeamSize, maxTeamSize, event: { connect: { pid: req.params.eventPid } } }, data: { name, minTeamSize, maxTeamSize, event: { connect: { pid: req.params.eventPid } } },
@@ -168,72 +173,53 @@ export const createDiscipline = async (req: Request<{ eventPid: string }, {}, Cr
} }
}; };
export const updateDiscipline = async (req: Request<{ eventPid: string }, {}, CreateDisciplineBody>, res: Response) => { // requires: auth(ELEVATED)
export const updateDiscipline = async (req: Request<{ pid: string }>, res: Response) => {
if (req.auth?.permission_level !== "ELEVATED") { if (req.auth?.permission_level !== "ELEVATED") {
res.status(403).json(createInsufficientPermissionsError()); res.status(403).json(createInsufficientPermissionsError());
} }
const result = updateDisciplineBody.safeParse(req.body); const result = updateDisciplineBody.safeParse(req.body); // FIXME: Useres can currently use two requests to forgo min/max team size checking altogether
if(result.success === false){ if (result.success === false) {
return res.status(400).json( return res.status(400).json(
generateInvalidBodyError({ generateInvalidBodyError(
name: DataType.STRING, {
minTeamSize: DataType.NUMBER, name: DataType.STRING,
maxTeamSize: DataType.NUMBER, minTeamSize: DataType.NUMBER,
}) maxTeamSize: DataType.NUMBER,
); },
result.error
)
);
}
const body = result.data;
const { pid } = req.params;
try {
const discipline = await prisma.discipline.update({
where: { pid },
data: {
name: body.name,
minTeamSize: body.minTeamSize,
maxTeamSize: body.maxTeamSize,
},
select: basicDiscipline,
});
res.status(200).json({
type: "success",
payload: { discipline },
});
} catch (e) {
if (e instanceof Prisma.PrismaClientKnownRequestError && e.code === "P2025") {
throw new NotFoundError("discipline", pid);
} }
const body = result.data; throw e;
const { eventPid } = req.params; }
};
try {
const discipline = await prisma.discipline.update({
where: { pid: eventPid },
data: {
name: body.name,
minTeamSize: body.minTeamSize,
maxTeamSize: body.maxTeamSize,
},
select: basicDiscipline,
});
if(!discipline) {
throw new NotFoundError("discipline", eventPid);
}
res.status(200).json({
type: "success",
payload: discipline,
});
} catch (e) {
if (e instanceof Prisma.PrismaClientKnownRequestError) {
return res.status(500).json({
type: "error",
payload: {
message: `Internal Server error occured. Try again later`,
},
});
}
if (e instanceof Prisma.PrismaClientUnknownRequestError) {
return res.status(500).json({
type: "error",
payload: {
message: "Unknown error occurred with your request. Check if your parameters are correct",
schema: {
name: DataType.STRING,
minTeamSize: DataType.NUMBER,
maxTeamSize: DataType.NUMBER,
},
},
});
}
throw e;
}
}
// requires: auth(ELEVATED) // requires: auth(ELEVATED)
export const deleteDiscipline = async (req: Request<{ pid: string }>, res: Response) => { export const deleteDiscipline = async (req: Request<{ pid: string }>, res: Response) => {
@@ -278,6 +264,8 @@ export const addVisual = async (req: Request<visualParams, {}, visualBody>, res:
}, },
}); });
// TODO: This does not work and should be updated in all addVisual-type code segments
// Reason: update throw a PrismaClientKnownRequestError with code P2025 if the record to update could not be found
if (!discipline) { if (!discipline) {
throw new NotFoundError("discipline", disciplinePid); throw new NotFoundError("discipline", disciplinePid);
} }
@@ -307,7 +295,7 @@ export const deleteVisual = async (req: Request<visualParams & { pid: string }>,
return res.status(204).end(); return res.status(204).end();
} catch (e) { } catch (e) {
if (e instanceof PrismaClientKnownRequestError && e.code === "P2025") { if (e instanceof PrismaClientKnownRequestError && e.code === "P2025") {
throw new NotFoundError("discipline", disciplinePid); throw new NotFoundError("discipline", disciplinePid); // Refer: Last todo; This is a correct example
} }
throw e; throw e;
@@ -216,6 +216,7 @@ export const deleteRoleSchema = async (req: Request<{ pid: string }>, res: Respo
throw e; throw e;
} }
}
interface visualParams { interface visualParams {
schemaPid: string; schemaPid: string;
+2
View File
@@ -7,6 +7,7 @@ import {
deleteVisual, deleteVisual,
getAllDisciplines, getAllDisciplines,
getDiscipline, getDiscipline,
updateDiscipline,
} from "../Controllers/discipline.controller"; } from "../Controllers/discipline.controller";
import { requireAuthentication } from "../Middleware/auth/auth"; import { requireAuthentication } from "../Middleware/auth/auth";
@@ -16,6 +17,7 @@ router.get("/", getAllDisciplines); // TODO: Optional auth
router.get("/:pid", getDiscipline); router.get("/:pid", getDiscipline);
router.put("/:pid", requireAuthentication, updateDiscipline);
router.delete<"/:pid", { pid: string }>("/:pid", requireAuthentication, deleteDiscipline); router.delete<"/:pid", { pid: string }>("/:pid", requireAuthentication, deleteDiscipline);
router.post<"/:disciplinePid/images", { disciplinePid: string }>( router.post<"/:disciplinePid/images", { disciplinePid: string }>(