fix: clear message cache on server startup (#3683)

Author: BobbieGoede

src/runtime/context.ts

@@ -20,8 +20,11 @@ import type {
   RootRedirectOptions
 } from '#internal-i18n-types'
 
-const useLocaleConfigs = () =>
-  useState<Record<string, { cacheable: boolean; fallbacks: string[] }>>('i18n:cached-locale-configs', () => ({}))
+export const useLocaleConfigs = () =>
+  useState<Record<string, { cacheable: boolean; fallbacks: string[] }> | undefined>(
+    'i18n:cached-locale-configs',
+    () => undefined
+  )
 
 /**
  * @internal
@@ -84,7 +87,7 @@ export function createNuxtI18nContext(nuxt: NuxtApp, vueI18n: I18n, defaultLocal
   const localeCookie = useI18nCookie(detectConfig)
 
   /** Get computed config for locale */
-  const getLocaleConfig = (locale: string) => serverLocaleConfigs.value[locale]
+  const getLocaleConfig = (locale: string) => serverLocaleConfigs.value![locale]
   const getDomainFromLocale = (locale: string) =>
     domainFromLocale(runtimeI18n.domainLocales, useRequestURL({ xForwardedHost: true }), locale)
   const baseUrl = createBaseUrlGetter(nuxt, runtimeI18n.baseUrl, defaultLocale, getDomainFromLocale)

src/runtime/plugins/i18n.ts

@@ -7,9 +7,9 @@ import { extendI18n } from '../routing/i18n'
 import { getI18nTarget } from '../compatibility'
 import { localeHead, _useLocaleHead } from '../routing/head'
 import { useLocalePath, useLocaleRoute, useRouteBaseName, useSwitchLocalePath } from '../composables'
-import { getDefaultLocaleForDomain } from '../shared/locales'
+import { createLocaleConfigs, getDefaultLocaleForDomain } from '../shared/locales'
 import { setupVueI18nOptions } from '../shared/vue-i18n'
-import { createNuxtI18nContext, useNuxtI18nContext, type NuxtI18nContext } from '../context'
+import { createNuxtI18nContext, useLocaleConfigs, useNuxtI18nContext, type NuxtI18nContext } from '../context'
 import { useI18nDetection, useRuntimeI18n } from '../shared/utils'
 import { useDetectors } from '../shared/detection'
 import { resolveSupportedLocale } from '../shared/locales'
@@ -31,6 +31,14 @@ export default defineNuxtPlugin({
       getDefaultLocaleForDomain(useRequestURL({ xForwardedHost: true }).host) || runtimeI18n.defaultLocale || ''
     const optionsI18n = preloadedOptions || (await setupVueI18nOptions(_defaultLocale))
 
+    const localeConfigs = useLocaleConfigs()
+    if (import.meta.server) {
+      localeConfigs.value = useRequestEvent()!.context.nuxtI18n?.localeConfigs || {}
+    } else {
+      // fallback when server is disabled
+      localeConfigs.value ??= createLocaleConfigs(optionsI18n.fallbackLocale)
+    }
+
     if (__MULTI_DOMAIN_LOCALES__) {
       setupMultiDomainLocales(optionsI18n.defaultLocale)
     }

src/runtime/server/plugin.ts

@@ -1,6 +1,6 @@
 import { stringify } from 'devalue'
 import { defineI18nMiddleware } from '@intlify/h3'
-import { defineNitroPlugin } from 'nitropack/runtime'
+import { defineNitroPlugin, useStorage } from 'nitropack/runtime'
 import { tryUseI18nContext, createI18nContext } from './context'
 import { createUserLocaleDetector } from './utils/locale-detector'
 import { pickNested } from './utils/messages-utils'
@@ -20,6 +20,11 @@ export default defineNitroPlugin(async nitro => {
   const runtimeI18n = useRuntimeI18n()
   const defaultLocale: string = runtimeI18n.defaultLocale || ''
 
+  // clear cache for i18n handlers on startup
+  const cacheStorage = useStorage('cache')
+  const cachedKeys = await cacheStorage.getKeys('nitro:handlers:i18n')
+  await Promise.all(cachedKeys.map(key => cacheStorage.removeItem(key)))
+
   nitro.hooks.hook('request', async (event: H3Event) => {
     const options = await setupVueI18nOptions(getDefaultLocaleForDomain(getHost(event)) || defaultLocale)
     const localeConfigs = createLocaleConfigs(options.fallbackLocale)

src/runtime/server/routes/messages.ts

@@ -1,5 +1,5 @@
 import { deepCopy } from '@intlify/shared'
-import { defineCachedEventHandler } from 'nitropack/runtime'
+import { defineCachedEventHandler, defineCachedFunction } from 'nitropack/runtime'
 import { getRouterParam, createError, defineEventHandler } from 'h3'
 import { useI18nContext } from '../context'
 import { getMergedMessages } from '../utils/messages'
@@ -27,11 +27,8 @@ const _messagesHandler = defineEventHandler(async (event: H3Event) => {
   return ctx.messages
 })
 
-/**
- * Load messages for the specified locale event parameter (cached)
- */
-const _messagesHandlerCached = defineCachedEventHandler(_messagesHandler, {
-  name: 'i18n:messages',
+const _cachedMessageLoader = defineCachedFunction(_messagesHandler, {
+  name: 'i18n:messages-internal',
   maxAge: !__I18N_CACHE__ ? -1 : 60 * 60 * 24,
   getKey: event => getRouterParam(event, 'locale') ?? 'null',
   shouldBypassCache(event) {
@@ -41,6 +38,16 @@ const _messagesHandlerCached = defineCachedEventHandler(_messagesHandler, {
   }
 })
 
+/**
+ * Load messages for the specified locale event parameter (cached)
+ */
+const _messagesHandlerCached = defineCachedEventHandler(_cachedMessageLoader, {
+  name: 'i18n:messages',
+  maxAge: !__I18N_CACHE__ ? -1 : 10,
+  swr: false,
+  getKey: event => getRouterParam(event, 'locale') ?? 'null'
+})
+
 /**
  * Load messages for the specified locale event parameter
  * - uses `messagesHandler` in development