タイムアウトミドルウェア

タイムアウトミドルウェアを使用することで、アプリケーション内のリクエストタイムアウトを簡単に管理できます。これを使用すると、リクエストに最大期間を設定し、オプションで指定したタイムアウトを超えた場合にカスタムエラーレスポンスを定義できます。

インポート

import { Hono } from 'hono'
import { timeout } from 'hono/timeout'

使用方法

タイムアウトミドルウェアを既定の設定とカスタム設定の両方で使用する方法を以下に示します。

既定の設定

const app = new Hono()

// Applying a 5-second timeout
app.use('/api', timeout(5000))

// Handling a route
app.get('/api/data', async (c) => {
  // Your route handler logic
  return c.json({ data: 'Your data here' })
})

カスタム設定

import { HTTPException } from 'hono/http-exception'

// Custom exception factory function
const customTimeoutException = (context) =>
  new HTTPException(408, {
    message: `Request timeout after waiting ${context.req.headers.get(
      'Duration'
    )} seconds. Please try again later.`,
  })

// for Static Exception Message
// const customTimeoutException = new HTTPException(408, {
//   message: 'Operation timed out. Please try again later.'
// });

// Applying a 1-minute timeout with a custom exception
app.use('/api/long-process', timeout(60000, customTimeoutException))

app.get('/api/long-process', async (c) => {
  // Simulate a long process
  await new Promise((resolve) => setTimeout(resolve, 61000))
  return c.json({ data: 'This usually takes longer' })
})

注記

• タイムアウトの期間はミリ秒で指定できます。指定された期間を超えると、ミドルウェアは自動的にプロミスを拒否し、エラーをスローする可能性があります。

• タイムアウトミドルウェアは stream で使用できません。そのため、stream.close と setTimeout を一緒に使用します。

app.get('/sse', async (c) => {
  let id = 0
  let running = true
  let timer: number | undefined

  return streamSSE(c, async (stream) => {
    timer = setTimeout(() => {
      console.log('Stream timeout reached, closing stream')
      stream.close()
    }, 3000) as unknown as number

    stream.onAbort(async () => {
      console.log('Client closed connection')
      running = false
      clearTimeout(timer)
    })

    while (running) {
      const message = `It is ${new Date().toISOString()}`
      await stream.writeSSE({
        data: message,
        event: 'time-update',
        id: String(id++),
      })
      await stream.sleep(1000)
    }
  })
})

ミドルウェアの競合

エラー処理または他のタイミング関連ミドルウェアを使用する場合は特に、ミドルウェアの順序に注意してください。このタイムアウトミドルウェアの動作に影響を与える可能性があります。