fix: Use correct host and protocol for alternate links when running behind a proxy (x-forwarded-host, x-forwarded-proto) (#462 by @HHongSeungWoo)

---------

Co-authored-by: Jan Amann <jan@amann.me>

Author: HHongSeungWoo

packages/next-intl/src/middleware/getAlternateLinksHeaderValue.tsx

@@ -2,10 +2,13 @@ import {NextRequest} from 'next/server';
 import MiddlewareConfig, {
   MiddlewareConfigWithDefaults
 } from './NextIntlMiddlewareConfig';
-import {isLocaleSupportedOnDomain} from './utils';
+import {getHost, isLocaleSupportedOnDomain} from './utils';
 
 function getUnprefixedUrl(config: MiddlewareConfig, request: NextRequest) {
   const url = new URL(request.url);
+  url.host = getHost(request.headers) ?? url.host;
+  url.protocol = request.headers.get('x-forwarded-proto') ?? url.protocol;
+
   if (!url.pathname.endsWith('/')) {
     url.pathname += '/';
   }

packages/next-intl/test/middleware/getAlternateLinksHeaderValue.test.tsx

@@ -3,10 +3,6 @@ import {it, expect} from 'vitest';
 import {MiddlewareConfigWithDefaults} from '../../src/middleware/NextIntlMiddlewareConfig';
 import getAlternateLinksHeaderValue from '../../src/middleware/getAlternateLinksHeaderValue';
 
-function getRequest(url = 'https://example.com/') {
-  return {url} as NextRequest;
-}
-
 it('works for prefixed routing (as-needed)', () => {
   const config: MiddlewareConfigWithDefaults = {
     defaultLocale: 'en',
@@ -17,7 +13,10 @@ it('works for prefixed routing (as-needed)', () => {
   };
 
   expect(
-    getAlternateLinksHeaderValue(config, getRequest()).split(', ')
+    getAlternateLinksHeaderValue(
+      config,
+      new NextRequest('https://example.com/')
+    ).split(', ')
   ).toEqual([
     '<https://example.com/>; rel="alternate"; hreflang="en"',
     '<https://example.com/es>; rel="alternate"; hreflang="es"',
@@ -27,7 +26,7 @@ it('works for prefixed routing (as-needed)', () => {
   expect(
     getAlternateLinksHeaderValue(
       config,
-      getRequest('https://example.com/about')
+      new NextRequest('https://example.com/about')
     ).split(', ')
   ).toEqual([
     '<https://example.com/about>; rel="alternate"; hreflang="en"',
@@ -46,7 +45,10 @@ it('works for prefixed routing (always)', () => {
   };
 
   expect(
-    getAlternateLinksHeaderValue(config, getRequest()).split(', ')
+    getAlternateLinksHeaderValue(
+      config,
+      new NextRequest('https://example.com/')
+    ).split(', ')
   ).toEqual([
     '<https://example.com/en>; rel="alternate"; hreflang="en"',
     '<https://example.com/es>; rel="alternate"; hreflang="es"',
@@ -56,7 +58,7 @@ it('works for prefixed routing (always)', () => {
   expect(
     getAlternateLinksHeaderValue(
       config,
-      getRequest('https://example.com/about')
+      new NextRequest('https://example.com/about')
     ).split(', ')
   ).toEqual([
     '<https://example.com/en/about>; rel="alternate"; hreflang="en"',
@@ -92,10 +94,13 @@ it("works for type domain with `localePrefix: 'as-needed'`", () => {
   };
 
   [
-    getAlternateLinksHeaderValue(config, getRequest()).split(', '),
     getAlternateLinksHeaderValue(
       config,
-      getRequest('https://example.es/')
+      new NextRequest('https://example.com/')
+    ).split(', '),
+    getAlternateLinksHeaderValue(
+      config,
+      new NextRequest('https://example.es/')
     ).split(', ')
   ].forEach((links) => {
     expect(links).toEqual([
@@ -111,7 +116,7 @@ it("works for type domain with `localePrefix: 'as-needed'`", () => {
   expect(
     getAlternateLinksHeaderValue(
       config,
-      getRequest('https://example.com/about')
+      new NextRequest('https://example.com/about')
     ).split(', ')
   ).toEqual([
     '<https://example.com/about>; rel="alternate"; hreflang="en"',
@@ -150,10 +155,13 @@ it("works for type domain with `localePrefix: 'always'`", () => {
   };
 
   [
-    getAlternateLinksHeaderValue(config, getRequest()).split(', '),
     getAlternateLinksHeaderValue(
       config,
-      getRequest('https://example.es/')
+      new NextRequest('https://example.com/')
+    ).split(', '),
+    getAlternateLinksHeaderValue(
+      config,
+      new NextRequest('https://example.es/')
     ).split(', ')
   ].forEach((links) => {
     expect(links).toEqual([
@@ -169,7 +177,7 @@ it("works for type domain with `localePrefix: 'always'`", () => {
   expect(
     getAlternateLinksHeaderValue(
       config,
-      getRequest('https://example.com/about')
+      new NextRequest('https://example.com/about')
     ).split(', ')
   ).toEqual([
     '<https://example.com/en/about>; rel="alternate"; hreflang="en"',
@@ -180,3 +188,30 @@ it("works for type domain with `localePrefix: 'always'`", () => {
     '<https://example.ca/fr/about>; rel="alternate"; hreflang="fr"'
   ]);
 });
+
+it('uses the external host name from headers instead of the url of the incoming request (relevant when running the app behind a proxy)', () => {
+  const config: MiddlewareConfigWithDefaults = {
+    defaultLocale: 'en',
+    locales: ['en', 'es'],
+    alternateLinks: true,
+    localePrefix: 'as-needed',
+    localeDetection: true
+  };
+
+  expect(
+    getAlternateLinksHeaderValue(
+      config,
+      new NextRequest('http://127.0.0.1/about', {
+        headers: {
+          host: 'example.com',
+          'x-forwarded-host': 'example.com',
+          'x-forwarded-proto': 'https'
+        }
+      })
+    ).split(', ')
+  ).toEqual([
+    '<https://example.com/about>; rel="alternate"; hreflang="en"',
+    '<https://example.com/es/about>; rel="alternate"; hreflang="es"',
+    '<https://example.com/about>; rel="alternate"; hreflang="x-default"'
+  ]);
+});