Метки

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

Задачам присваиваются метки, например office или money, а приложению с доской нужно меню со всеми метками и количеством задач для каждой из них. На этом шаге добавляются три вещи: правило схемы для списка, фильтр и маршрут, подсчитывающий метки. Подсчёт в объекте, показанный ниже, — это новая тема.

// genres: z.array(z.string()).max(3).optional() в схеме
const counts = {};
for (const book of books) {
    for (const genre of book.genres) {
        counts[genre] = (counts[genre] ?? 0) + 1;
    }
}
// { poetry: 2, drama: 1 }

Object.entries(counts) преобразует этот объект в пары [["poetry", 2], ...], готовые для преобразования в список. Такая сводка — самостоятельный ресурс со своим URL.

optional() позволяет этому полю отсутствовать, при этом его значение проверяется, если оно указано. Преобразуй пары записей в объекты с помощью Object.entries(counts).map(([genre, count]) => ({ genre, count })): скобки распаковывают каждую пару; круглые скобки возвращают объект.

Задание

Легко

Приложение доски хочет группировать задачи по меткам, например office или money, и показывать меню со всеми метками и количеством задач, у которых они есть. Добавь метки в свой API.

В routes/tasks.js добавь необязательное поле labels в схему Task: список не более чем из 5 меток, каждая из которых после удаления пробелов по краям содержит от 1 до 20 символов. POST и PATCH тоже принимают это поле, поскольку их схемы создаются на основе Task. Неверный список вызывает обычную ошибку 400 invalid_body. К неверным спискам относятся "labels": "office" (текст, а не список), "labels": [""] и список из шести меток.
У каждой сохранённой задачи есть список labels:
- Если POST или PUT отправляет запрос без labels, сохрани []. PUT заменяет всю задачу, поэтому PUT без меток очищает их.
- PATCH изменяет labels только если отправляет их.
В store.js добавь метки к начальным задачам: ["office"] для задач 1 и 2 и ["money"] для задачи 3.
Всё ещё в routes/tasks.js добавь фильтр для маршрута списка: GET /api/v1/tasks?label=office возвращает только те задачи, в списке labels которых есть именно office. Он работает вместе с другими фильтрами и с пагинацией, как и раньше.
В server.js добавь GET /api/v1/labels рядом с подключением маршрутизатора и импортируй туда tasks из store.js. Этот маршрут возвращает все используемые метки и количество задач, у которых есть каждая из них, отсортированные по меткам от А до Я. Для начальных задач результат будет таким:
```
[
  { "label": "money", "count": 1 },
  { "label": "office", "count": 2 }
]
```

Проверь:

GET /api/v1/labels возвращает список, показанный выше.
Отправь POST с телом { "title": "Order chairs", "labels": ["office"] } на /api/v1/tasks: получишь код 201, а у новой задачи будет "labels": ["office"]. Теперь GET /api/v1/labels показывает "count": 3 для office.
Отправь POST с телом { "title": "Water the plants" }: у новой задачи будет "labels": [].
GET /api/v1/tasks?label=money возвращает только задачу 3. GET /api/v1/tasks?label=nope возвращает "items": [] и "total": 0.
Отправь PUT /api/v1/tasks/2 с телом { "title": "Book the meeting room", "done": false }: в ответе будет задача 2 с "labels": [].

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

import { Router } from 'express';
import { z } from 'zod';
import { config } from '../config.js';
import { sendError, sendInvalid } from '../errors.js';
import { nextId, tasks } from '../store.js';

const router = Router();

// Задача целиком, как её передаёт PUT. .strict() отклоняет поля, которые в нём не перечислены.
const Task = z
    .object({
        title: z.string().trim().min(1).max(100),
        done: z.boolean(),
    })
    .strict();
const NewTask = Task.partial({ done: true });
const TaskChanges = Task.partial();
const SORT_FIELDS = ['title', 'createdAt'];

// True, если у другой задачи уже есть такой заголовок, независимо от регистра.
const titleTaken = (title, exceptId) =>
    tasks.some((t) => t.id !== exceptId && t.title.toLowerCase() === title.toLowerCase());

router.get('/', (req, res) => {
    const { done, q, sort } = req.query;
    let list = tasks;
    if (done !== undefined) {
        if (done !== 'true' && done !== 'false') {
            return sendError(res, 400, 'invalid_query', 'done must be true or false');
        }
        list = list.filter((t) => t.done === (done === 'true'));
    }
    if (q !== undefined) {
        const words = String(q).toLowerCase();
        list = list.filter((t) => t.title.toLowerCase().includes(words));
    }
    if (sort !== undefined) {
        const field = String(sort).startsWith('-') ? String(sort).slice(1) : String(sort);
        if (!SORT_FIELDS.includes(field)) {
            return sendError(
                res,
                400,
                'invalid_query',
                'sort must be title or createdAt, with - in front to reverse',
            );
        }
        const direction = String(sort).startsWith('-') ? -1 : 1;
        list = list.toSorted((a, b) => a[field].localeCompare(b[field]) * direction);
    }
    const page = req.query.page === undefined ? 1 : Number(req.query.page);
    const limit = req.query.limit === undefined ? config.pageSize : Number(req.query.limit);
    if (!Number.isInteger(page) || page < 1) {
        return sendError(res, 400, 'invalid_query', 'page must be a whole number from 1');
    }
    if (!Number.isInteger(limit) || limit < 1 || limit > 50) {
        return sendError(res, 400, 'invalid_query', 'limit must be a whole number from 1 to 50');
    }
    const start = (page - 1) * limit;
    res.json({
        items: list.slice(start, start + limit),
        page,
        total: list.length,
        pages: Math.ceil(list.length / limit),
    });
});

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

router.post('/', (req, res) => {
    const result = NewTask.safeParse(req.body);
    if (!result.success) {
        return sendInvalid(res, result.error);
    }
    const { title, done = false } = result.data;
    if (titleTaken(title)) {
        return sendError(res, 409, 'conflict', 'A task with this title already exists');
    }
    const task = { id: nextId(), title, done, createdAt: new Date().toISOString() };
    tasks.push(task);
    res.status(201).location(`/api/v1/tasks/${task.id}`).json(task);
});

router.patch('/:id', (req, res) => {
    const task = tasks.find((t) => t.id === Number(req.params.id));
    if (!task) {
        return sendError(res, 404, 'not_found', 'Task not found');
    }
    const result = TaskChanges.safeParse(req.body);
    if (!result.success) {
        return sendInvalid(res, result.error);
    }
    if (result.data.title !== undefined && titleTaken(result.data.title, task.id)) {
        return sendError(res, 409, 'conflict', 'A task with this title already exists');
    }
    Object.assign(task, result.data);
    res.json(task);
});

router.put('/:id', (req, res) => {
    const index = tasks.findIndex((t) => t.id === Number(req.params.id));
    if (index === -1) {
        return sendError(res, 404, 'not_found', 'Task not found');
    }
    const result = Task.safeParse(req.body);
    if (!result.success) {
        return sendInvalid(res, result.error);
    }
    const { id, createdAt } = tasks[index];
    if (titleTaken(result.data.title, id)) {
        return sendError(res, 409, 'conflict', 'A task with this title already exists');
    }
    tasks[index] = { id, ...result.data, 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 sendError(res, 404, 'not_found', 'Task not found');
    }
    tasks.splice(index, 1);
    res.status(204).end();
});

export default router;