|
| 1 | +import { Callout } from "nextra/components"; |
| 2 | + |
| 3 | +## Performance tips |
| 4 | + |
| 5 | +They are a lot of features and knobs you can tune to improve the performance of your app. This page lists some of the recommend settings. |
| 6 | + |
| 7 | +### General |
| 8 | + |
| 9 | +You should regularly update to the latest available version of [`@opennextjs/cloudflare`](https://www.npmjs.com/package/@opennextjs/cloudflare) to benefit from the latest performance and security updates. |
| 10 | + |
| 11 | +### Caching |
| 12 | + |
| 13 | +Caching can drastically improves the performance of your application by only fetching data / re-generating your pages when they change. |
| 14 | + |
| 15 | +To get the most out of caching, you should start by reading how Next.js implements caching. The ["Caching in Next.js" guide](https://nextjs.org/docs/app/guides/caching) is a good place to start. |
| 16 | + |
| 17 | +You should then check [how to configure caching](/cloudflare/caching) for the OpenNext adapter. See below for some advice. |
| 18 | + |
| 19 | +#### [Incremental Cache](/cloudflare/caching#incremental-static-regeneration-isr) |
| 20 | + |
| 21 | +The Incremental cache is the store containing all the cached data (i.e. pages, `fetch`, `unstable_cache`). |
| 22 | + |
| 23 | +You should use the Workers Static Assets based cache if your site is SSG. It is the fastest available option. Note that as Workers Static Assets are read-only, this option can not be used with revalidation. |
| 24 | + |
| 25 | +When your app uses re-validation, use the R2 based store instead. We recommend the following settings to get the best perfomance: |
| 26 | + |
| 27 | +- use regional cache by wrapping the handler into `withRegionalCache(...)` |
| 28 | + - use the `long-lived` mode |
| 29 | + - you should not need to explicitly set `shouldLazilyUpdateOnCacheHit` nor `bypassTagCacheOnCacheHit` as they are set to the most performant mode by default |
| 30 | +- setup [automatic cache purge](/cloudflare/caching#automatic-cache-purge) |
| 31 | + |
| 32 | +<Callout type="info"> |
| 33 | + Using KV is not recommended as it is eventually consistent. It could cause stale data to be persisted |
| 34 | + indefinitely |
| 35 | +</Callout> |
| 36 | + |
| 37 | +#### [Tag Cache](/cloudflare/caching#tag-cache-for-on-demand-revalidation) |
| 38 | + |
| 39 | +The Tag Cache is not properly a cache. It only stores the timestamp at which tags have been revalidated. |
| 40 | + |
| 41 | +It should be configured for App-Router based app using `revalidateTag` or `revalidatePath`. |
| 42 | + |
| 43 | +The D1 based tag cache should only be used if your site receives low traffic. The Durable Object based tag cache is the recommend option for most sites. See [the reference guide](/cloudflare/caching#tag-cache-for-on-demand-revalidation) for the available configuration options. |
| 44 | + |
| 45 | +Application using `revalidateTag` exclusively (and not `revalidatePath`) will benefit from using the `withFilter` wrapper with the `softTagFilter` filter. |
| 46 | + |
| 47 | +#### [Static Assets](/cloudflare/caching#static-assets-caching) |
| 48 | + |
| 49 | +You should add a `public/_headers` file to cache the static assets served by your app. |
| 50 | + |
| 51 | +See the [Cloudflare documentation](https://developers.cloudflare.com/workers/static-assets/headers/) for a detailed explanation of the default and the syntax. |
| 52 | + |
| 53 | +### [Multiple Workers](https://opennext.js.org/cloudflare/howtos/multi-worker) |
| 54 | + |
| 55 | +Deploying the middleware and the main server to distinct Workers can help with performance. As when a page can be retrieved from the cache, the main server can be fully bypassed. |
| 56 | + |
| 57 | +### Troubleshooting performance |
| 58 | + |
| 59 | +You can profile the code to troubleshoot performance issues. |
| 60 | + |
| 61 | +#### Building unminified code |
| 62 | + |
| 63 | +Code profiles are much easier to read when the code is not minified, you can use the following settings to generate unminified code |
| 64 | + |
| 65 | +**next.config.ts** |
| 66 | + |
| 67 | +```ts |
| 68 | +const nextConfig = { |
| 69 | + // ... |
| 70 | + experimental: { |
| 71 | + serverMinification: false, |
| 72 | + }, |
| 73 | + webpack: (config) => { |
| 74 | + config.optimization.minimize = false; |
| 75 | + return config; |
| 76 | + }, |
| 77 | + compress: false, |
| 78 | +}; |
| 79 | +``` |
| 80 | + |
| 81 | +**CLI** |
| 82 | + |
| 83 | +Use the `--noMinify` option when building the app: |
| 84 | + |
| 85 | +```bash |
| 86 | +opennextjs-cloudflare build --noMinify |
| 87 | +``` |
| 88 | + |
| 89 | +#### Record a profile |
| 90 | + |
| 91 | +You should first launch a local version of your application by running |
| 92 | + |
| 93 | +```bash |
| 94 | +opennextjs-cloudflare preview |
| 95 | +``` |
| 96 | + |
| 97 | +Once the app is running, follow [the steps from the Workers doc](https://developers.cloudflare.com/workers/observability/dev-tools/cpu-usage/) to record a CPU profile. |
| 98 | + |
| 99 | +You can then inspect the profile and check if any particular section of the application is unexpectedly slow. |
0 commit comments