並べ替え

CoddyのNode.jsジャーニー「REST API」セクションの一部。レッスン 11/18。

クライアントは、新しいタスクを先に表示したい場合や、AからZの順に並べたリストを求める場合があります。よく使われる慣例は ?sort=field で、逆順にするには前に - を付けます。

// GET /api/books?sort=-year
const field = sort.replace(/^-/, '');            // 'year'
const direction = sort.startsWith('-') ? -1 : 1;
list = list.toSorted((a, b) => (a[field] - b[field]) * direction);

まず、field が許可しているフィールドに含まれているか確認し、それ以外の場合は400を返してください。書籍に存在しないフィールドでは、有用な並び順を指定できないためです。toSorted はソート済みのコピーを返します。sort は配列自体の順序を変更します。フィルターによってコピーが作られていない場合、その配列はストアそのものなので、以降のリクエストではすべて新しい順序が反映されます。文字列の比較には a.localeCompare(b) を使ってください。ISO形式の日付は、時系列順に並ぶ文字列です。

チャレンジ

簡単

?sort=titleはAからZの順に並べ、?sort=createdAtは古いものから順に並べます。先頭に-を付けると逆順になります。
それ以外のフィールドを指定すると、コードinvalid_queryとともに400を返します。
並べ替えても、保存されている順序は変わりません。

GET /api/tasks?sort=-createdAtを送信し、次にGET /api/tasksを送信し、その後GET /api/tasks?sort=colorを送信してください。

自分で試してみよう

import { Router } from 'express';
import { z } from 'zod';
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();

// 大文字と小文字を区別せず、別のタスクにこのタイトルがすでに使われている場合は true。
const titleTaken = (title, exceptId) =>
    tasks.some((t) => t.id !== exceptId && t.title.toLowerCase() === title.toLowerCase());

router.get('/', (req, res) => {
    const { done, q } = 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));
    }
    res.json(list);
});

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/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;