All posts

Nuxt 3 の $fetch でエラーメッセージを取得するコンポーザブルを作った

Nuxt 3 で $fetch を使って API サーバーからデータを取得する際、エラーメッセージを取り出す処理を毎回書くのが面倒でした。

そこで、エラーの種類に応じて表示用のメッセージを返すコンポーザブルを作り、使い回すことにしました。

API サーバー側のエラー処理

API サーバーには Express を使っています。エラーの生成には http-errors を使用し、次のようにメッセージを返しています。

const createError = require('http-errors')

try {
  // 処理
} catch (err) {
  next(createError(500, 'XXXXに失敗しました。'))
  return
}

エラー処理のミドルウェアでは、ステータスコードとメッセージをレスポンスに設定しています。

app.use((err, _req, res, next) => {
  if (res.headersSent) {
    return next(err)
  }

  res
    .status(err.statusCode || 500)
    .send(err.message || 'Internal Server Error')
})

この例では、エラーメッセージを文字列として返しています。

$fetch のエラーからメッセージを取り出す

以前、Nuxt 2 で $axios を使っていたときは、API から返されたエラーメッセージを err.data.message から取得していました。

今回の API では、Nuxt 3 の $fetch が返すエラーの data から、レスポンスの文字列を取得できました。レスポンスが JSON か文字列かによって data の中身は変わるため、API の返却形式に合わせて扱う必要があります。[ofetch の型定義]

また、$fetch で発生するエラーは、今回の環境では ofetch の FetchError として扱えました。

$fetch だけを try...catch で囲むなら、FetchError を想定して処理できます。ただ、前後の処理もまとめて囲む場合は、通常の Error などが発生することもあります。

そこで、次のエラーからメッセージを取り出せるようにしました。

  • $fetch で発生した FetchError
  • throw new Error('...') で発生した Error
  • throw '...' のように直接投げられた文字列

メッセージを取得できなかった場合は、呼び出し元で指定したデフォルトのメッセージを返します。

コンポーザブルを作る

作成したコンポーザブルがこちらです。

import { FetchError } from 'ofetch'

export const useFetchErrorMessage = (error: any, defaultErrorMessage: string): string => {
    // エラーメッセージを初期化する
    let errorMessage = ''

    if (error instanceof FetchError) {
        // FetchErrorの場合
        const { cause, data, message } = error
        if (cause && ((cause as DOMException).message || '').indexOf('abort') > -1) {
            // ファイルアップロードを中断した場合の処理
            // Abort時の動作がブラウザによって異なるので、上記の条件で拾いきれるかは不明...
            errorMessage = 'ファイルのアップロードを中止しました。'
        } else if (typeof data === 'string' || data instanceof String) {
            // APIから返却されたエラーメッセージを取り出す
            errorMessage = data as string
        } else {
            // その他の場合の処理
            errorMessage = message
        }
    } else if (error instanceof Error) {
        // Errorがthrowされた場合の処理
        errorMessage = error.message
    } else if (typeof error === 'string' || error instanceof String) {
        // 文字列がthrowされた場合の処理
        errorMessage = error as string
    }

    return errorMessage || defaultErrorMessage
}

ファイルアップロードを途中でキャンセルする場合を考え、FetchError の原因に含まれるメッセージから中断を判定する処理も入れています。

この判定は、最新の Chrome、Firefox、iOS で試しました。Android の各種ブラウザでは確認していません。また、ブラウザや実行環境によってエラーの内容が異なる可能性があるため、この条件ですべての中断を判定できるとは限りません。

使い方

エラーと、メッセージを取得できなかった場合に表示する文字列を渡します。

try {
    // 処理
    await $fetch('...')
    // 処理
} catch (err) {
    const errorMessage = useFetchErrorMessage(err, '送信に失敗しました。')
    // errorMessage を画面に表示する
}

エラーの種類に応じた処理を一か所にまとめられたので、呼び出し元では表示するメッセージを取り出すだけで済むようになりました。

Discussion