(Article)Est. 2023 — Tokyo, JP

BLOG

← Back to Blog
Astro

astro devでVercel Functionsを動かす:開発用ミドルウェアを自作する

静的出力の Astro サイトにお問い合わせフォームを付けるため、送信処理だけを Vercel Functions(api/contact.ts)にしました。本番では Vercel がそのまま動かしてくれますが、astro dev では /api/contact が 404 になります。そこで、開発時だけ API を動かす小さな Astro インテグレーションを書きました。

リポジトリ:Astro-MicroCMS-Site / デモ:https://astrobase.vercel.app/

選択肢

  • vercel dev を使う:手軽ですが Vercel CLI へのログインが必要で、Astro の HMR と二重起動になる
  • Astro を SSR モードにして API ルートを作る:アダプターの導入が必要で、静的出力の構成から変わる
  • 開発サーバーにミドルウェアを足す:今回採用

astro:server:setup フック

Astro のインテグレーションは astro:server:setup フックで Vite の開発サーバーを受け取れます。server.middlewares.use() で Connect 形式のミドルウェアを追加し、/api/xxx へのリクエストを横取りします。

// astro.config.mjs
import { loadEnv } from 'vite'

const vercelApiDev = () => ({
  name: 'vercel-api-dev',
  hooks: {
    'astro:server:setup': ({ server }) => {
      Object.assign(process.env, loadEnv('development', process.cwd(), ''))
      server.middlewares.use(async (req, res, next) => {
        const match = req.url?.match(/^\/api\/([\w-]+)\/?(?:\?.*)?$/)
        if (!match) return next()
        const mod = await server.ssrLoadModule(`/api/${match[1]}.ts`)
        const handler = mod[req.method ?? 'GET']
        if (!handler) { res.statusCode = 405; return res.end() }
        // ↓ Node のリクエストを Web 標準の Request に変換して呼び出す
      })
    },
  },
})

ポイント 1:.env を process.env に読み込む

Astro は .env を import.meta.env に読み込みますが、Vercel Functions のコードは process.env を参照します。loadEnv の第 3 引数を空文字にすると、PUBLIC_ 以外の変数もすべて取得できます。

ポイント 2:ssrLoadModule で TypeScript をそのまま読む

server.ssrLoadModule() を使うと、Vite が api/contact.ts をその場で変換して読み込みます。ファイルを保存すれば次のリクエストから新しいコードが使われるので、開発中の手間がありません。

ポイント 3:Request と Response を変換する

Vercel の関数は export async function POST(request: Request) という Web 標準の形で書いているので、Node の req/res との間で変換します。

const chunks = []
for await (const chunk of req) chunks.push(chunk)
const request = new Request(new URL(req.url, `http://${req.headers.host}`), {
  method: req.method,
  headers: req.headers,
  body: chunks.length ? Buffer.concat(chunks) : undefined,
})
const response = await handler(request)
res.statusCode = response.status
response.headers.forEach((value, key) => res.setHeader(key, value))
res.end(Buffer.from(await response.arrayBuffer()))

まとめ

40 行ほどのインテグレーションで、npm run dev だけでフォーム送信まで確認できるようになりました。本番の挙動は変えずに開発体験だけを良くできるのが、この方法の良いところです。