Схемы с zod

Часть раздела REST API путешествия по Node.js на Coddy. Урок 11 из 25.

Ручных проверок становится больше с каждым полем и каждым маршрутом. Схема zod один раз описывает структуру, а safeParse проверяет значение на соответствие ей:

import { z } from 'zod';

const Event = z.object({
    name: z.string().trim().min(1).max(80),
    seats: z.number().int().min(1),
}).strict();

const result = Event.safeParse(req.body);
if (!result.success) {
    return res.status(400).json({ error: z.flattenError(result.error) });
}
// result.data содержит проверенное тело запроса, в котором у name удалены пробелы по краям

.strict() отклоняет поля, не перечисленные в схеме. Event.partial() делает все поля необязательными — это необходимо для PATCH. Event.partial({ seats: true }) делает необязательным только поле seats, а const { seats = 1 } = result.data использует значение 1, если поле отсутствует. z.flattenError(result.error) преобразует ошибки в { formErrors, fieldErrors }: formErrors содержит ошибки всего тела запроса, например неизвестное поле, а fieldErrors — ошибки отдельных полей. Event.parse выполняет ту же проверку, но выбрасывает исключение при неверном значении, а исключение в маршруте приводит к ответу 500.

Задание

Легко

На этом шаге открывается подготовленный для курса проект API трекера задач, а не файлы вашего проекта из урока Проверка входных данных (включая routes/tasks.js). Ваша предыдущая работа остается в своем уроке. Прочитайте предоставленные файлы, прежде чем редактировать routes/tasks.js. В этой копии есть маршруты CRUD для задач и написанная вручную проверка входных данных.

Ручных проверок становится все больше с каждым полем и каждым маршрутом. Опишите задачу один раз с помощью схемы zod и используйте ее во всех трех маршрутах, которые принимают тело запроса.

В routes/tasks.js импортируйте z из zod и напишите схему с именем Task:
- title: строка, обрезанная по краям; после обрезки длина должна составлять от 1 до 100 символов.
- done: true или false (z.boolean()).
- Схема является строгой, поэтому поля, которых в ней нет, например color, отклоняются.
Удалите предоставленную вспомогательную функцию titleError (версию проверки из урока «Проверка входных данных», используемую в курсе).
Создайте две версии Task с помощью .partial(). В версии для POST необязательным становится только done. В версии для PATCH необязательными становятся оба поля. PUT использует саму Task, поэтому ему нужны оба поля.
В POST, PATCH и PUT проверяйте req.body с помощью safeParse. Если проверка не пройдена, возвращайте статус 400 и список проблем от zod под ключом error, созданный с помощью z.flattenError(result.error). Для { "title": 123 } результат будет выглядеть так:
```
{ "error": { "formErrors": [], "fieldErrors": { "title": ["Invalid input: expected string, received number"] } } }
```
Если проверка пройдена, сохраняйте данные из result.data, а не из req.body: в них содержится обрезанное по краям значение title. В POST тело без done создает задачу со значением "done": false (отсутствующее поле в result.data имеет значение undefined, а ?? задает значение по умолчанию). PUT по-прежнему сохраняет id и createdAt из сохраненной задачи.

Попробуйте: отправьте POST-запрос с телом { "title": " Order new chairs ", "color": "red" } на адрес /api/tasks. Вы получите ответ 400, а в formErrors будет указано Unrecognized key: "color". Отправьте запрос еще раз, убрав color: вы получите ответ 201 со значением "title": "Order new chairs" (без пробелов) и "done": false. Запрос PATCH /api/tasks/2 с телом { "done": "yes" } вернет ответ 400 с записью done в fieldErrors. Запрос PUT /api/tasks/2 с телом { "title": "Book the big room", "done": false } вернет ответ 200, причем у задачи 2 останется прежнее значение createdAt.

Попробуйте сами

import { Router } from 'express';
import { nextId, tasks } from '../store.js';

const router = Router();

// Причина, по которой title нельзя сохранить, или null, если сохранить его можно.
const titleError = (title) => {
    if (typeof title !== 'string' || title.trim() === '' || title.length > 100) {
        return 'title must be a string of 1 to 100 characters';
    }
    return null;
};

router.get('/', (req, res) => {
    res.json(tasks);
});

router.get('/:id', (req, res) => {
    const task = tasks.find((t) => t.id === Number(req.params.id));
    if (!task) {
        return res.status(404).json({ error: 'Task not found' });
    }
    res.json(task);
});

router.post('/', (req, res) => {
    const { title } = req.body ?? {};
    const problem = titleError(title);
    if (problem) {
        return res.status(400).json({ error: problem });
    }
    const task = { id: nextId(), title, done: false, createdAt: new Date().toISOString() };
    tasks.push(task);
    res.status(201).location(`/api/tasks/${task.id}`).json(task);
});

router.patch('/:id', (req, res) => {
    const task = tasks.find((t) => t.id === Number(req.params.id));
    if (!task) {
        return res.status(404).json({ error: 'Task not found' });
    }
    const { title, done } = req.body ?? {};
    if (title !== undefined && titleError(title)) {
        return res.status(400).json({ error: titleError(title) });
    }
    if (done !== undefined && typeof done !== 'boolean') {
        return res.status(400).json({ error: 'done must be true or false' });
    }
    if (title !== undefined) task.title = title;
    if (done !== undefined) task.done = done;
    res.json(task);
});

router.put('/:id', (req, res) => {
    const index = tasks.findIndex((t) => t.id === Number(req.params.id));
    if (index === -1) {
        return res.status(404).json({ error: 'Task not found' });
    }
    const { title, done } = req.body ?? {};
    if (title === undefined || done === undefined) {
        return res.status(400).json({ error: 'PUT needs every field: title and done' });
    }
    const { id, createdAt } = tasks[index];
    tasks[index] = { id, title, done, createdAt };
    res.json(tasks[index]);
});

router.delete('/:id', (req, res) => {
    const index = tasks.findIndex((t) => t.id === Number(req.params.id));
    if (index === -1) {
        return res.status(404).json({ error: 'Task not found' });
    }
    tasks.splice(index, 1);
    res.status(204).end();
});

export default router;