fix(app): reuse computed runtime config across requests

[cjpearson]

🔗 Linked issue

#2569

❓ Type of change

• 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
• 🐞 Bug fix (a non-breaking change that fixes an issue)
• 👌 Enhancement (improving an existing functionality like performance)
• ✨ New feature (a non-breaking change that adds functionality)
• 🧹 Chore (updates to the build process or auxiliary tools and libraries)
• ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

In our Nuxt application, we noticed that as the size of the runtime config the performance decreases significantly. Loading the runtime config occurs in every request and was making up a significant portion of the request time. Since there is not a need to recompute the config every request, we created a plugin to load the config at startup instead of for each request.

export default defineNitroPlugin((nitroApp: NitroApp) => {
  const runtimeConfig = useRuntimeConfig() as RuntimeConfig
  nitroApp.hooks.hook('request', (event) => {
    event.context.nitro = event.context.nitro ?? {}
    event.context.nitro.runtimeConfig = runtimeConfig
  })
})

But I think this performance improvement would also be beneficial for other Nitro users and would make sense in core. Unless my assumptions here are wrong. Perhaps in that case, it could be configured?

I've done some very rough tests with autocannon against a cached page to show the impact we're seeing. It's nearly twice as fast in the average case.

Before Change

┌─────────┬───────┬───────┬───────┬───────┬─────────┬──────────┬─────────┐
│ Stat    │ 2.5%  │ 50%   │ 97.5% │ 99%   │ Avg     │ Stdev    │ Max     │
├─────────┼───────┼───────┼───────┼───────┼─────────┼──────────┼─────────┤
│ Latency │ 23 ms │ 28 ms │ 36 ms │ 39 ms │ 31.3 ms │ 53.74 ms │ 1370 ms │
└─────────┴───────┴───────┴───────┴───────┴─────────┴──────────┴─────────┘
┌───────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┐
│ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5%   │ Avg     │ Stdev   │ Min     │
├───────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
│ Req/Sec   │ 45      │ 45      │ 344     │ 355     │ 314.4   │ 90.13   │ 45      │
├───────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
│ Bytes/Sec │ 12.3 MB │ 12.3 MB │ 94.3 MB │ 97.3 MB │ 86.2 MB │ 24.7 MB │ 12.3 MB │
└───────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┘
┌──────┬───────┐
│ Code │ Count │
├──────┼───────┤
│ 200  │ 3144  │
└──────┴───────┘

After Change

┌─────────┬───────┬───────┬───────┬───────┬──────────┬──────────┬─────────┐
│ Stat    │ 2.5%  │ 50%   │ 97.5% │ 99%   │ Avg      │ Stdev    │ Max     │
├─────────┼───────┼───────┼───────┼───────┼──────────┼──────────┼─────────┤
│ Latency │ 13 ms │ 15 ms │ 21 ms │ 25 ms │ 17.75 ms │ 48.12 ms │ 1142 ms │
└─────────┴───────┴───────┴───────┴───────┴──────────┴──────────┴─────────┘
┌───────────┬─────┬──────┬────────┬────────┬────────┬─────────┬────────┐
│ Stat      │ 1%  │ 2.5% │ 50%    │ 97.5%  │ Avg    │ Stdev   │ Min    │
├───────────┼─────┼──────┼────────┼────────┼────────┼─────────┼────────┤
│ Req/Sec   │ 0   │ 0    │ 616    │ 642    │ 547.6  │ 188.61  │ 472    │
├───────────┼─────┼──────┼────────┼────────┼────────┼─────────┼────────┤
│ Bytes/Sec │ 0 B │ 0 B  │ 169 MB │ 176 MB │ 150 MB │ 51.7 MB │ 129 MB │
└───────────┴─────┴──────┴────────┴────────┴────────┴─────────┴────────┘
┌──────┬───────┐
│ Code │ Count │
├──────┼───────┤
│ 200  │ 5476  │
└──────┴───────┘

📝 Checklist

• I have linked an issue or discussion.
• I have updated the documentation accordingly.

[jamaluddinrumi]

thanks @cjpearson

i use this approach to make sure runtime config is filled by environment variables.

// plugins/runtime-config.ts

export default defineNitroPlugin((nitroApp: NitroApp) => {
  nitroApp.hooks.hook('request', (event) => {
    event.context.nitro = event.context.nitro ?? {}
    event.context.nitro.runtimeConfig = {
      cloudflarePagesWebhookUrl: process.env.CLOUDFLARE_PAGES_WEBHOOK_URL, // reassign env vars one by one here.
      turnstileSecretKey: process.env.NITRO_TURNSTILE_SECRET_KEY,
      turnstileEndpoint: process.env.NITRO_TURNSTILE_ENDPOINT,
    }
  })
})