fix: add tests for forwardedHost change, deprecate setting instead of…

… removing
nuxt-modules · Mar 15, 2020 · 3f4d135 · 3f4d135
1 parent 2a17c99
commit 3f4d135
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 3 deletions.
diff --git a/src/index.js b/src/index.js
@@ -78,6 +78,11 @@ module.exports = function (userOptions) {
     console.warn('[' + options.MODULE_NAME + '] The `differentDomains` option and `no_prefix` strategy are not compatible. Change strategy or disable `differentDomains` option.')
   }
 
+  if ('forwardedHost' in options) {
+    // eslint-disable-next-line no-console
+    console.warn('[' + options.MODULE_NAME + '] The `forwardedHost` option is deprecated. You can safely remove it. See: https://github.com/nuxt-community/nuxt-i18n/pull/630.')
+  }
+
   // Plugins
   for (const file of requiredPlugins) {
     this.addPlugin({

diff --git a/test/module.test.js b/test/module.test.js
@@ -812,7 +812,7 @@ describe('differentDomains enabled', () => {
     await nuxt.close()
   })
 
-  test('matches domain\'s locale (en)', async () => {
+  test('host matches locale\'s domain (en)', async () => {
     const requestOptions = {
       headers: {
         Host: 'en.nuxt-app.localhost'
@@ -824,7 +824,7 @@ describe('differentDomains enabled', () => {
     await expect(dom.querySelector('head meta[property="og-locale"]')).toBe(null)
   })
 
-  test('matches domain\'s locale (fr)', async () => {
+  test('host matches locale\'s domain (fr)', async () => {
     const requestOptions = {
       headers: {
         Host: 'fr.nuxt-app.localhost'
@@ -833,7 +833,29 @@ describe('differentDomains enabled', () => {
     const html = await get('/', requestOptions)
     const dom = getDom(html)
     await expect(dom.querySelector('body').textContent).toContain('page: Accueil')
-    await expect(dom.querySelector('head meta[property="og-locale"]')).toBe(null)
+  })
+
+  test('x-forwarded-host does not match locale\'s domain', async () => {
+    const requestOptions = {
+      headers: {
+        'X-Forwarded-Host': 'xx.nuxt-app.localhost'
+      }
+    }
+    const html = await get('/', requestOptions)
+    const dom = getDom(html)
+    // Falls back to english.
+    await expect(dom.querySelector('body').textContent).toContain('page: Homepage')
+  })
+
+  test('x-forwarded-host does match locale\'s domain (fr)', async () => {
+    const requestOptions = {
+      headers: {
+        'X-Forwarded-Host': 'fr.nuxt-app.localhost'
+      }
+    }
+    const html = await get('/', requestOptions)
+    const dom = getDom(html)
+    await expect(dom.querySelector('body').textContent).toContain('page: Accueil')
   })
 })
 

diff --git a/types/nuxt-i18n.d.ts b/types/nuxt-i18n.d.ts
@@ -46,6 +46,7 @@ declare namespace NuxtVueI18n {
       defaultLocale?: null | Locale
       locales?: Array<Locale | LocaleObject>
       differentDomains?: boolean
+      forwardedHost?: boolean
       onLanguageSwitched?: (oldLocale: string, newLocale: string) => void
     }