Cloudflare PagesでNext.js App Routerを使ってみる

はじめに

Cloudflare Developer Week 2023にて数々の魅力的な発表がある中、Cloudflare PagesでNext.jsを利用するためのパッケージ@cloudflare/next-on-pagesがv1.0.0となりました。

https://github.com/cloudflare/next-on-pages

執筆時の最新版であるv13.4.2のApp Routerにも対応しているということで早速試してみました。

なお、現時点でサポートされている機能については@cloudflare/next-on-pagesのドキュメントにもまとまめられています。

検証環境

• Next.js v13.4.2
• @cloudflare/next-on-pages 1.0.0

試してみる

@cloudflare/next-on-pagesを使ってCloudflare Pagesにデプロイしてみます。

Next.jsのセットアップ

まずはNext.jsの環境を用意します。

npx create-next-app@latest my-next-app
cd my-next-app

2023.05.17追記

Developer Week 2023で紹介されたC3(create-cloudflare CLI)を使うことで新規プロジェクトの作成からデプロイまで一気通貫で行うことができるようになりました。とりあえず動かしたい場合はこちらをお試しください。

npm create cloudflare

https://blog.cloudflare.com/making-cloudflare-for-web/

Edgeランタイムの設定

Cloudflare PagesではビルドはNode.jsが利用されますが、ランタイムははEdge Runtimeとなるので、利用するpage.tsxやroute.tsそれぞれにruntime設定を追記しておきます。

src/app/page.tsx など

export const runtime = 'edge';

https://nextjs.org/docs/app/building-your-application/rendering/edge-and-nodejs-runtimes

Cloudflare Pagesへデプロイ

@cloudflare/next-on-pagesをインストールします。

npm install -D @cloudflare/next-on-pages

GitHubリポジトリとの連携

今回はPagesへのデプロイにGitHubを利用します。

git init
git add .
git commit -m 'initial commit'
git remote add origin your-repository // 自分のリポジトリを入力
git push -u origin main

そしてCloudflare Dashboardにログイン後、「Pages > プロジェクトを作成 > Gitに接続」を選択して先ほど作成したリポジトリと連携します。

続けて、ビルド設定ではフレームワークとしてNext.jsを選択し、環境変数にNODE_VERSIONとして16以上のバージョンを指定する必要があります。

これでビルド、デプロイが走りますが一度目は失敗しています:)
Node.jsに依存するAPIが必要となるため、ビルド時に互換性フラグnodejs_compatが必要なためです。

仕切り直して、Pagesのプロジェクトから、「設定 > Functions > 互換性フラグ」にてnodejs_compatを追加して保存します。

失敗したデプロイを選択して「デプロイの再試行」を押下し再デプロイします。

これでNext.jsのスターターページが表示されるようになりました。

Cloudflareのサービスを利用する

いったん最低限の動作は確認ができたところで、続けてCloudflareのサービスと連携も試してみます。
Next.js v13ではデータの取得に独自のcache、revalidateの機能を持っていますがCloudflare Pagesでは動作しません。

https://nextjs.org/docs/app/building-your-application/data-fetching/caching

とはいえCloudflareにはキャッシュ用途にも利用できるKey-Value型のストレージであるWorkers KVがあります。ここではKVの動作を試しておきます。

Workers KVを作成する

「Workers > KV > 名前空間を作成する」を選択して新規にKVを作成します。

PagesとKVを紐付ける

PagesでKVを利用するにはバインディング（紐付け）が必要になります。再度Pagesの設定画面から作成したKVのバインディングを設定します。

Pagesのプロジェクトから、「設定 > Functions > KV 名前空間のバインディング」からKVを追加して保存します。（その他のサービスを利用する場合も都度バインディングの必要があります）

KVにテスト用の値を追加

KVとの連携をテストするためにテスト用の値を追加しておきます。

KVの値をページで取得

さきほど登録したKVの値をページで取得、表示するためにsrc/app/page.tsxを書き換えます。あわせて@cloudflare/workers-typesもインストールしておきます。

npm install -D @cloudflare/workers-types

src/app/page.tsx

import { KVNamespace } from "@cloudflare/workers-types";

export const runtime = "edge";

const getPlatform = async () => {
  const { MY_KV_STORE } = process.env as unknown as {
    MY_KV_STORE: KVNamespace;
  };

  const platform = await MY_KV_STORE.get("platform", "text");

  return platform;
};

export default async function Home() {
  const platform = await getPlatform();

  return (
    <main>
      <p className="p-8">{platform}</p>
    </main>
  );
}

書き換えたところでデプロイして早速確認してみます。

KVに登録した値が表示されることが確認できました。ダッシュボードから値を変更すると表示も切り替わることも確認できるはずです。

補足

ローカル環境での開発では下記2つのコマンドを併用する必要がありますが、現時点では--watchモードにビルドがループするバグがあるようです。すでにPRは出ているようなので少し待つ必要がありそう。

npx @cloudflare/next-on-pages --watch

npx wrangler pages dev .vercel/output/static --compatibility-flag=nodejs_compat

https://github.com/cloudflare/next-on-pages/issues/240

おわりに

駆け足にてCloudflare PagesでのNext.js(App Router)の動作を確認してみました。Next.jsの進化は早いので@cloudflare/next-on-pagesが都度どの程度までサポートしてくれるかにも依存してしまいますがCloudflare PagesでもNext.jsを利用することができそうです。プロダクションレベルでの利用を想定すると、決して楽な運用とはならないかもしれませんが、みなさんも挑戦してみてはいかがでしょうか:)