Timeout ミドルウェア

Timeout ミドルウェアで、アプリケーションのリクエストのタイムアウトを簡単に管理できます。リクエストの最大時間を設定し、超過した場合のエラーレスポンスを必要に応じてカスタマイズできます。

インポート

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

使い方

次に、デフォルト設定とカスタム設定での 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' })
})

注意事項

• タイムアウト時間はミリ秒で指定できます。指定時間を超えると、ミドルウェアは自動的に Promise を拒否し、エラーをスローする場合があります。

• Timeout ミドルウェアはストリームには使用できません。代わりに 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)
    }
  })
})

ミドルウェアの競合

ミドルウェアの順番には注意してください。特に、エラー処理や他の時間関連のミドルウェアを使う場合、Timeout ミドルウェアの動作に影響する可能性があります。