エラー処理

CoddyのNode.jsジャーニー「Expressの基礎」セクションの一部。レッスン 18/23。

ルートで例外が発生すると、Expressは独自のエラーページを返します。このページはJSONではなく、あなた向けの詳細情報が表示されます。

app.get('/api/fines/:member', (req, res) => {
    throw new Error('Fines database is down');
});

app.use((err, req, res, next) => {
    console.error(err);
    res.status(500).json({ error: 'Try again later' });
});

引数を4つ取るミドルウェア(err, req, res, next)はエラーハンドラーです。Expressは引数の数で判別します。引数が3つなら通常のミドルウェアで、エラーが発生するとスキップされます。ルートで例外が発生すると、Expressは通常のミドルウェアをスキップし、エラーを渡してエラーハンドラーを呼び出します。404ハンドラーの後、最後に追加してください。詳細は自分用にログへ記録し、クライアントには短いメッセージを送信します。

throw new Error('text')はルートの処理を停止し、エラーをExpressに渡します。next(err)を呼び出した場合も同じです。訪問者が誤った内容を送信し、自分で修正できる場合は400を返します。サーバー側に問題がある場合は例外を発生させます。

チャレンジ

簡単

Recipe Boxを続けましょう。別個のpractice-errors/ファイルは無視してかまいません。「実行」を押すと、プロジェクトのserver.jsが起動するようになりました。

料理をする人は、たとえばパーティー用に分量を2倍にするなど、レシピの分量を調整したいことがあります。servingsが保存されていないレシピは分量を調整できません。これはデータの不備であり、訪問者が修正できるものではないため、適切なJSON 500レスポンスを送るエラーハンドラーに処理を渡します。

server.jsで、404ハンドラーの上に/api/recipes/:id/scaleのルートを追加します。/api/recipes/1/scale?by=2のように、クエリー文字列から倍率を読み取ります。
そのidのレシピがない場合は、ステータス404と{"error": "No such recipe"}を返します。
byを数値に変換します。数値ではない場合、または0以下の場合は、ステータス400と{"error": "Scale by a positive number"}を返します。Number('lots')はNaNになり、Number.isNaNで判定できます。
レシピにservingsがない場合は、メッセージがRecipe 5 has no servingsである新しいErrorをスローします。5の部分には、そのレシピのidを入れます。
それ以外の場合は、タイトルと調整後のservingsだけを含むJSONを返します。レシピ1のTomato Soupはservingsが4なので、/api/recipes/1/scale?by=2は{"title": "Tomato Soup", "servings": 8}を返します。他のフィールドは追加しないでください。
ファイル内のミドルウェアの最後、404ハンドラーの後にエラーハンドラーを追加します。4つの引数(err, req, res, next)を取る関数を指定したapp.useです。console.errorでエラーを出力し、ステータス500と{"error": "Something went wrong"}を返します。

試してみましょう:「実行」を押して、/api/recipes/1/scale?by=2を送信します。{"title":"Tomato Soup","servings":8}が表示されるはずです。/api/recipes/2/scale?by=lotsを送信すると、ステータス400と{"error":"Scale by a positive number"}が返ります。/api/recipes/99/scale?by=2を送信すると、ステータス404が返ります。次にPOSTを選び、{"title": "Toast"}を/api/recipesに送信します。これでservingsのないレシピ5が作成されます。/api/recipes/5/scale?by=2を送信すると、ステータス500と{"error":"Something went wrong"}が返り、コンソールにはエラーRecipe 5 has no servingsが表示されます。

自分で試してみよう

import { escapeHtml } from './html.js';
import express from 'express';
import { randomUUID } from 'node:crypto';
import { recipes } from './data.js';

const app = express();

app.use((req, res, next) => {
    console.log(`${req.method} ${req.url}`);
    next();
});

app.use((req, res, next) => {
    res.set('X-Request-Id', randomUUID());
    next();
});

app.use(express.json());

app.use(express.static('public'));

app.get('/', (req, res) => {
    const items = recipes.map((r) => `<li><a href="/recipes/${r.id}">${escapeHtml(r.title)}</a></li>`);
    res.send(`<link rel="stylesheet" href="/style.css"><h1>Recipe Box</h1><ul>${items.join('')}</ul>`);
});

// type('text') はプレーンテキストを送信するため、各タイトルがそれぞれ別の行に表示されます。
app.get('/recipes', (req, res) => {
    const { tag } = req.query;
    const list = tag ? recipes.filter((recipe) => recipe.tags.includes(tag)) : recipes;
    res.type('text').send(list.map((recipe) => recipe.title).join('\n'));
});

app.get('/recipes/:id', (req, res) => {
    const recipe = recipes.find((r) => r.id === Number(req.params.id));
    if (!recipe) {
        res.status(404).send('No such recipe');
        return;
    }
    res.send(recipe.title);
});

app.get('/api/recipes', (req, res) => {
    res.json(recipes);
});

app.get('/api/recipes/:id', (req, res) => {
    const recipe = recipes.find((r) => r.id === Number(req.params.id));
    if (!recipe) {
        res.status(404).json({ error: 'No such recipe' });
        return;
    }
    res.json(recipe);
});

app.post('/api/recipes', (req, res) => {
    const { title, tags } = req.body;
    if (!title) {
        res.status(400).json({ error: 'A recipe needs a title' });
        return;
    }
    const recipe = { id: recipes.length + 1, title, tags: tags ?? [] };
    recipes.push(recipe);
    res.status(201).json(recipe);
});

app.get('/about', (req, res) => {
    res.send('Recipe Box collects family recipes.');
});

app.get('/menu', (req, res) => {
    res.redirect(301, '/recipes');
});

app.get('/menu/:id', (req, res) => {
    res.redirect(301, `/recipes/${req.params.id}`);
});

app.use((req, res) => {
    if (req.path.startsWith('/api/')) {
        res.status(404).json({ error: 'Not found' });
        return;
    }
    res.status(404).send('<h1>Page not found</h1><p><a href="/">Back to Recipe Box</a></p>');
});

app.listen(3000, () => {
    console.log('Recipe Box is running on port 3000');
});