🚀

Next.js breaking change - disable router/fetch cache by default

2024/05/24に公開

1件

Next.js

React

tech

Next.js App Routerは巷では難しいと評されることが多々あります。これはReactの新機能であるServer ComponentsをはじめとするServer 1stとも言えるパラダイムシフトを必要とすること、そして初見殺しなデフォルトのキャッシュ挙動に起因していると筆者は考えています。

パラダイムシフトが必要となるServer ComponentsやServer ActionsなどのReactの新機能については、エラーで指摘・修正のヒントが提示されるなどの初学者のフォローもしっかり考慮した設計がなされてたり、多くのドキュメントや記事が公開されているので、これらについてはhooksが登場した時のようにあとは世の中に理解が広まるまでの時間の問題なのかなとも感じています。

一方でキャッシュについては、デフォルトで積極的かつ何層にも分けてキャッシュされる上、「意図せずキャッシュされてる状態」は当然エラーにならず動作してしまうため、初学者にとってNext.jsのキャッシュはつまづきやすいポイントだと筆者は感じています。筆者は特に、クライアントサイドのキャッシュであるRouter Cacheに着目しその複雑さや問題点について過去に記事にしたこともありました。

上記執筆時点では、Router Cacheは最低でも30sは利用されてしまうことを筆者は問題視していたのですが、その後experimental.staleTimeが導入されてRouter Cacheの有効期限を設定できるようになり、状況は大きく改善されました。

そしてここに来てさらに、v15でRouter CacheやData Cacheのデフォルト設定が変更されることが発表されました。これは非常に大きな変更だと筆者は捉えています。

本稿ではv15で行われるキャッシュ周りの破壊的変更と、その背景やPPRとの関係について解説します。

v15の破壊的変更概要

Next.jsコアチームのメンバーであるJimmy Lai氏によって、Next.jsのv15で変更される内容が公表されました。

◆ no more fetch caching by default ✅(fetchをデフォルトキャッシュすることを廃止)
◆ no more client caching by default ✅(クライアントサイドでデフォルトキャッシュすることを廃止)
◆ no more static GET routes by default ✅(GET routeをデフォルト静的化することを廃止)

これにより、Data CacheとRouter Cacheがデフォルトで無効化されることになります。その他、機能追加として以下も発表されました。

◆ incremental PPR migration support(インクリメンタルなPPRマイグレーションをサポート)
◆ next/after, our own little version of waitUntil(next/afterの追加)
◆ the experimental React Compiler support(React Compiler(別名React Forget)のexperimentalサポート)

このツイートの後日、これらの変更の説明を含むv15のアナウンス記事が公開されました。

これらに対するupgradeガイドは本稿執筆時点では公式ドキュメント上にまだ公開されてないものの、リポジトリ上ではマージされていることが確認できました。

キャッシュ設定の破壊的変更

前述の通り、v15でData CacheとRouter Cacheはデフォルトで無効化されます。簡単におさらいするとData Cacheはfetchはじめサーバー側でのデータアクセス時に保持されるデータそのもののキャッシュで、Router Cacheはクライアントサイドに保持されるRSC Payloadのキャッシュです。

詳しくは以下をご参照ください。

Data Cacheの無効化

v14以前は、fetchを使ったデータ取得はデフォルトで無期限にキャッシュされていました。これはNext.jsが拡張したfetchのオプションであるcacheやnext.revalidateによって変更が可能でした。

// fetch時に`cache: 'no-store'`を指定してopt-out
fetch(`https://...`, { cache: 'no-store' })

// fetch時に`next: { revalidate: 0 }`を指定してopt-out
fetch('https://...', { next: { revalidate: 0 } })

// fetch時に`next: { revalidate: 3600 }`を指定して有効期限を設定
fetch('https://...', { next: { revalidate: 3600 } })

v15以降、Data Cacheはデフォルトで無効化されるので、上記方法によってData Cacheをopt-outする必要はなくなりました。opt-inする場合には、以下のように実装する必要があります。

// v14以前同様、無期限キャッシュをopt-in
fetch(`https://...`, { cache: 'force-store' })

// fetch時に`next: { revalidate: 3600 }`を指定して有効期限を設定
fetch('https://...', { next: { revalidate: 3600 } })

Router Cacheの無効化

初稿時の誤った情報（一応残しています）

Router Cacheのデフォルト有効期限はいくつかの条件によって決定されるのですが、ほとんどの場合はdynamic renderingかどうかによって決定されます。

v14以前はstatic renderingなら5m、dynamic renderingなら30sがデフォルトで設定されていました。v15以降、dynamic renderingのデフォルトが0sに変更されます。staticには変更ありません。

dynamic renderingはRoute Segment Configのdynamicの設定やdynamic functionsの利用有無によって決定されるので、これらを利用していないstatic renderingなページにおいてはRouter Cacheがデフォルトでは無効化されないということです。

rendering	e.g.	v14	v15
static	静的ページ、ブログ記事ページ	5m	5m
dynamic	ユーザーのマイページ	30s	0s

これにより、ブログ記事ページをrevalidateしたのに他のユーザーにはRouter Cacheが残ってて古い情報が見えてしまうなどのケースが想定されます。これを制御したい場合、前述のstaleTimeを設定する必要があります。

とはいえ個人的な意見としては、static renderingはデフォルトで強くキャッシュしても違和感はないので、デフォルト設定としてはこれは悪くない判断じゃないかなと思っています。

Router Cacheの有効期限は、staticなものとして扱われるloading.tsxや明示的なprefetch（Linkのprefetch指定時やrouter.prefetch()）対象を除くpageやlayoutについて、defaultで無効化されます。

これらの有効期限はそれぞれstatic/dynamicとして、experimental.staleTimesを使って設定することができます。

/** @type {import('next').NextConfig} */
const nextConfig = {
  experimental: {
    staleTimes: {
      dynamic: 30, // default: 0
      static: 180, // default: 300
    },
  },
}
 
module.exports = nextConfig

ちなみに、ブラウザバック・フォワード時には有効期限に関係なくRouter Cacheが利用されるようになっているようです。

なぜこのタイミングで変更されたのか

実際に使ってみないとわからない部分もあるかもしれませんが、これらの情報を眺める限りでは基本的に初見殺しだったキャッシュ周りが改善される良いbreaking changeじゃないかなと筆者は考えています。

しかし、キャッシュ周りについては以前からDiscussionで強くフィードバックされてたり要望は多かったのですが、なぜこのタイミングでの変更となったのでしょう？これについてもコアチームのJimmy Lai氏がツイートで説明しています。

上記ツイートは要約すると、以下のような理由が挙げられています。

2023/11時点でキャッシュのデフォルトを変更したいと考えていた
しかし、この変更を実施するにはトレードオフを正確に見極める必要があった
今年の最大の焦点はPPRの完成であり、PPRはキャッシュへの依存があったためPPRの設計が固めることの方が先だった
(v15時点ではまだexperimentalではあるものの)すでにPPRの設計は議論の余地がないところまで進んだため、キャッシュのデフォルト変更を実施することができた

コアメンバーの説明は上記のようなものですが、これに加えkoichikさんの考察が納得行くものだったので引用します。

PPRによって動的なfetchがあっても静的化できるようになったので、Data Cacheをデフォルトで有効にしておくモチベーションがなくなったのです。デフォルトにおいては、データ単位のキャッシュに代わってhtmlやRSC Payload単位でのキャッシュされる範囲が広がったとイメージするとわかりやすいかもしれません。

v15以降でのNext.jsの設計思想

もう1つkoichikさんのツイートで重要だと思ったのが、Next.jsの設計思想についての変革です。

Next.js v15以降はページ単位の静的・動的という思想ではなく、ページやSuspenseによって隔てられた境界ごとに静的・動的が決定できるようになります。開発者としては「必要な部分だけを動的にすることができる」と捉えることもできるので、レンダリング設計としてはシンプルでわかりやすい気もします。

感想

Next.jsは定期的に大きな概念の追加やアップデートが行われます。巷で「進化が早すぎる」「too much」などと評されるのはそれが原因なのかもしれません。一方でその進化はユーザーの体験へと繋がるものが多く、重視すべき点だと筆者は考えています。

PPRは1つの新たな概念なので、我々がそれを理解し使いこなすには学習コストが伴います。正直筆者自身、まだPPRについての理解度や解像度は荒い部分があります。一方でPPR以降の世界では前述の通り「必要な部分だけを動的にすることができる」という世界になることで、レンダリングプロセスの理解容易性とユーザー体験どちらをとっても歓迎すべき変更な気はしてます。パフォーマンス観点はアプリケーション実装者がチューニングしなければならないケースも当然ありますが、フレームワーク側でデフォルトで対処されてると平均値が上がっていくので1Webユーザーとしても嬉しいところです。

PPRが安定化して使える日が近い将来なのだと思うと楽しみですが、フレームワーク内部としては大幅な変更でしょうから、バグや既存影響など出ないかは少々心配なところです。Next.jsの場合v15への更新に限らないですが、アップデートは慎重に行いましょう。

Discussion

Q/A

素晴らしい最新情報ありがとうございます！