feat: add experimental option

Author: BobbieGoede

src/bundler.ts

@@ -92,7 +92,8 @@ export function getDefineConfig({ options, fullStatic }: I18nNuxtContext, server
     __I18N_PRELOAD__: JSON.stringify(!!options.experimental.preload),
     // eslint-disable-next-line @typescript-eslint/no-base-to-string
     __I18N_ROUTING__: JSON.stringify(nuxt.options.pages.toString() && options.strategy !== 'no_prefix'),
-    __I18N_STRICT_SEO__: JSON.stringify(!!options.experimental.strictSeo)
+    __I18N_STRICT_SEO__: JSON.stringify(!!options.experimental.strictSeo),
+    __I18N_SERVER_REDIRECT__: JSON.stringify(!!options.experimental.nitroContextDetection)
   }
 
   if (nuxt.options.ssr || !server) {

src/constants.ts

@@ -35,7 +35,8 @@ export const DEFAULT_OPTIONS = {
     cacheLifetime: undefined,
     stripMessagesPayload: false,
     preload: false,
-    strictSeo: false
+    strictSeo: false,
+    nitroContextDetection: true
   },
   bundle: {
     compositionOnly: true,

src/env.d.ts

@@ -28,3 +28,4 @@ declare let __I18N_PRELOAD__: boolean
 /** Project has pages and strategy is not `no_prefix` */
 declare let __I18N_ROUTING__: boolean
 declare let __I18N_STRICT_SEO__: boolean
+declare let __I18N_SERVER_REDIRECT__: boolean

src/prepare/strategy.ts

@@ -7,9 +7,6 @@ export function prepareStrategy({ options, localeCodes }: I18nNuxtContext, nuxt:
     nuxt.hook('nitro:config', config => {
       config.prerender ??= {}
 
-      config.routeRules ??= {}
-      // config.routeRules['/'] = { prerender: false, ssr: true }
-
       // ignore `/` which is added by nitro by default
       config.prerender.ignore ??= []
       config.prerender.ignore.push(/^\/$/)

src/runtime/context.ts

@@ -81,7 +81,7 @@ export function createNuxtI18nContext(nuxt: NuxtApp, vueI18n: I18n, defaultLocal
     domainFromLocale(runtimeI18n.domainLocales, useRequestURL({ xForwardedHost: true }), locale)
   const baseUrl = createBaseUrlGetter(nuxt, runtimeI18n.baseUrl, defaultLocale, getDomainFromLocale)
   const resolvedLocale = useResolvedLocale()
-  if (import.meta.server && nuxt.ssrContext?.event?.context?.nuxtI18n?.detectLocale) {
+  if (__I18N_SERVER_REDIRECT__ && import.meta.server && nuxt.ssrContext?.event?.context?.nuxtI18n?.detectLocale) {
     resolvedLocale.value = nuxt.ssrContext.event.context.nuxtI18n.detectLocale
   }
 

src/runtime/plugins/route-locale-detect.ts

@@ -15,7 +15,7 @@ export default defineNuxtPlugin({
     )
 
     // no pages or no prefixes - do not register route middleware
-    if (!__I18N_ROUTING__ || import.meta.server) return
+    if (!__I18N_ROUTING__ || (import.meta.server && __I18N_SERVER_REDIRECT__)) return
 
     addRouteMiddleware(
       'locale-changing',

src/runtime/server/plugin.ts

@@ -135,31 +135,33 @@ export default defineNitroPlugin(async nitro => {
 
   const baseUrlGetter = createBaseUrlGetter()
   nitro.hooks.hook('request', async (event: H3Event) => {
-    const detector = useDetectors(event, detection)
-    const localeSegment = detector.route(event.path)
-    const pathLocale = (isSupportedLocale(localeSegment) && localeSegment) || undefined
-    const path = (pathLocale && event.path.slice(pathLocale.length + 1)) || event.path
-
-    // attempt to only run i18n detection for nuxt pages and i18n server routes
-    if (!event.path.includes('/_i18n/') && !isExistingNuxtRoute(path)) {
-      return
-    }
-
     const options = await setupVueI18nOptions(getDefaultLocaleForDomain(getHost(event)) || _defaultLocale)
     const ctx = createI18nContext()
+    event.context.nuxtI18n = ctx
+
+    if (__I18N_SERVER_REDIRECT__) {
+      const detector = useDetectors(event, detection)
+      const localeSegment = detector.route(event.path)
+      const pathLocale = (isSupportedLocale(localeSegment) && localeSegment) || undefined
+      const path = (pathLocale && event.path.slice(pathLocale.length + 1)) || event.path
 
-    const resolved = resolveRedirectPath(event, path, pathLocale, options.defaultLocale, detector)
-    if (resolved.path) {
-      ctx.detectLocale = resolved.locale
-      detection.useCookie && setCookie(event, detection.cookieKey, resolved.locale, cookieOptions)
-      await sendRedirect(event, joinURL(baseUrlGetter(event, options.defaultLocale), resolved.path), resolved.code)
-      return
+      // attempt to only run i18n detection for nuxt pages and i18n server routes
+      if (!event.path.includes('/_i18n/') && !isExistingNuxtRoute(path)) {
+        return
+      }
+
+      const resolved = resolveRedirectPath(event, path, pathLocale, options.defaultLocale, detector)
+      if (resolved.path) {
+        ctx.detectLocale = resolved.locale
+        detection.useCookie && setCookie(event, detection.cookieKey, resolved.locale, cookieOptions)
+        await sendRedirect(event, joinURL(baseUrlGetter(event, options.defaultLocale), resolved.path), resolved.code)
+        return
+      }
     }
 
     const localeConfigs = createLocaleConfigs(options.fallbackLocale)
     ctx.vueI18nOptions = options
     ctx.localeConfigs = localeConfigs
-    event.context.nuxtI18n = ctx
   })
 
   nitro.hooks.hook('render:html', (htmlContext, { event }) => {

src/types.ts

@@ -114,6 +114,12 @@ export interface ExperimentalFeatures {
    */
   stripMessagesPayload?: boolean
   strictSeo?: boolean | SeoAttributesOptions
+  /**
+   * Enables Nitro context detection and allows for more reliable detection and redirection behavior especially in setups using prerendering.
+   * It is recommended to keep it enabled, but can be disabled if this causes issues, this option might be removed in v11.
+   * @default true
+   */
+  nitroContextDetection?: boolean
 }
 
 export interface BundleOptions