fix: move locale detection to netlify redirects (#861)

* fix: move locale detection to netlify redirects

* chore: add e2e test

* chore: update tests

* chore: fix types

* fix: add null check

* chore: fix tests

Release-As: 4.0.0-beta.13

Author: ascorbic

cypress/config/static-root.json

@@ -0,0 +1,8 @@
+{
+  "baseUrl": "http://localhost:3000",
+  "integrationFolder": "../../cypress/integration/static-root",
+  "pluginsFile": "../../cypress/plugins",
+  "screenshotsFolder": "../../cypress/screenshots",
+  "supportFile": "../../cypress/support/index.js",
+  "videoFolder": "../../cypress/videos"
+}

cypress/integration/static-root/i18n.spec.ts

@@ -0,0 +1,48 @@
+describe('Localization', () => {
+  it('should use sub routing to determine current locale', () => {
+    cy.visit('/')
+
+    cy.findByText('The current locale is en')
+
+    cy.visit('/fr')
+    cy.findByText('The current locale is fr')
+  })
+
+  it('should use the NEXT_LOCALE cookie to determine the default locale', () => {
+    cy.setCookie('NEXT_LOCALE', 'fr')
+    cy.visit('/')
+
+    cy.url().should('eq', `${Cypress.config().baseUrl}/fr/`)
+    cy.findByText('The current locale is fr')
+  })
+
+  it('should use the nf_lang cookie to determine the default locale', () => {
+    cy.setCookie('nf_lang', 'fr')
+    cy.visit('/')
+
+    cy.url().should('eq', `${Cypress.config().baseUrl}/fr/`)
+    cy.findByText('The current locale is fr')
+  })
+
+  it('should use Accept-Language to choose a locale', () => {
+    cy.visit('/', {
+      headers: {
+        'Accept-Language': 'fr-FR,fr;q=0.5',
+      },
+    })
+    cy.url().should('eq', `${Cypress.config().baseUrl}/fr/`)
+    cy.findByText('The current locale is fr')
+  })
+
+  it('should use the NEXT_LOCALE cookie over Accept-Language header to determine the default locale', () => {
+    cy.setCookie('NEXT_LOCALE', 'en')
+    cy.visit({
+      url: '/',
+      headers: {
+        'Accept-Language': 'fr-FR,fr;q=0.5',
+      },
+    })
+    cy.url().should('eq', `${Cypress.config().baseUrl}/`)
+    cy.findByText('The current locale is en')
+  })
+})

cypress/integration/static-root/rewrites-redirects.spec.ts

@@ -0,0 +1,13 @@
+describe('Rewrites and Redirects', () => {
+  it('rewrites: points /old to /', () => {
+    // preview mode is off by default
+    cy.visit('/old/another/')
+    cy.findByText('Another page')
+    cy.url().should('eq', `${Cypress.config().baseUrl}/old/another/`)
+  })
+
+  it('redirects: redirects /redirectme to /', () => {
+    cy.visit('/redirectme')
+    cy.url().should('eq', `${Cypress.config().baseUrl}/`)
+  })
+})

demos/default/netlify.toml

@@ -1,7 +1,7 @@
 [build]
 command = "next build"
 publish = ".next"
-ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF . ../"
+ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF . ../../"
 
 [build.environment]
 # cache Cypress binary in local "node_modules" folder

demos/nx-next-monorepo-demo/netlify.toml

@@ -1,12 +1,14 @@
 [build]
-  command = "npm run build"
-  publish = "dist/apps/demo-monorepo/.next"
+command = "npm run build"
+publish = "dist/apps/demo-monorepo/.next"
+ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF . ../../"
+
 [dev]
-  command = "npm run start"
-  targetPort = 4200
-  
+command = "npm run start"
+targetPort = 4200
+
 [[plugins]]
-  package = "./local-plugin"
+package = "./local-plugin"
 
 [build.environment]
 # cache Cypress binary in local "node_modules" folder

demos/static-root/.eslintrc

@@ -0,0 +1,4 @@
+{
+  "extends": "next",
+  "root": true
+}

demos/static-root/.gitignore

@@ -0,0 +1,34 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel

demos/static-root/README.md

@@ -0,0 +1,34 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
+
+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
+
+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

demos/static-root/local-plugin/index.js

@@ -0,0 +1 @@
+module.exports = require('../../../lib')

demos/static-root/local-plugin/manifest.yml

@@ -0,0 +1 @@
+name: '@netlify/plugin-nextjs-local'

demos/static-root/local-plugin/package-lock.json

@@ -0,0 +1,11 @@
+{
+  "name": "local-plugin",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "preinstall": "cd ../../.. && npm i"
+  },
+  "author": "",
+  "license": "ISC"
+}

demos/static-root/local-plugin/package.json

@@ -0,0 +1,24 @@
+[build]
+command = "next build"
+publish = ".next"
+ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF . ../../"
+
+[build.environment]
+# cache Cypress binary in local "node_modules" folder
+# so Netlify caches it
+CYPRESS_CACHE_FOLDER = "../node_modules/.CypressBinary"
+
+[dev]
+framework = "#static"
+
+[[plugins]]
+package = "./local-plugin"
+
+[[plugins]]
+package = "@netlify/plugin-local-install-core"
+
+[[context.deploy-preview.plugins]]
+package = "netlify-plugin-cypress"
+
+[context.deploy-preview.plugins.inputs]
+configFile = "../../cypress/config/static-root.json"

demos/static-root/netlify.toml

@@ -0,0 +1,46 @@
+module.exports = {
+  // Configurable site features we support:
+  // distDir: 'build',
+  generateBuildId: () => 'build-id',
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en', 'es', 'fr'],
+  },
+  async headers() {
+    return [
+      {
+        source: '/',
+        headers: [
+          {
+            key: 'x-custom-header',
+            value: 'my custom header value',
+          },
+        ],
+      },
+    ]
+  },
+  trailingSlash: true,
+  // Configurable site features _to_ support:
+  // basePath: '/docs',
+  // Rewrites allow you to map an incoming request path to a different destination path.
+  async rewrites() {
+    return {
+      beforeFiles: [
+        {
+          source: '/old/:path*',
+          destination: '/:path*',
+        },
+      ],
+    }
+  },
+  // Redirects allow you to redirect an incoming request path to a different destination path.
+  async redirects() {
+    return [
+      {
+        source: '/redirectme',
+        destination: '/',
+        permanent: true,
+      },
+    ]
+  },
+}

demos/static-root/next.config.js

@@ -0,0 +1,7 @@
+import '../styles/globals.css'
+
+function MyApp({ Component, pageProps }) {
+  return <Component {...pageProps} />
+}
+
+export default MyApp

demos/static-root/pages/_app.js

@@ -0,0 +1,22 @@
+import Head from 'next/head'
+import { useRouter } from 'next/router'
+import styles from '../styles/Home.module.css'
+
+export default function Home() {
+  const { locale } = useRouter()
+  return (
+    <div className={styles.container}>
+      <Head>
+        <title>Create Next App</title>
+        <meta name="description" content="Generated by create next app" />
+        <link rel="icon" href="/favicon.ico" />
+      </Head>
+
+      <main className={styles.main}>
+        <h1 className={styles.title}>Another page</h1>
+      </main>
+
+
+    </div>
+  )
+}

demos/static-root/pages/another.js

@@ -0,0 +1,5 @@
+// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
+
+export default (req, res) => {
+  res.status(200).json({ name: 'John Doe' })
+}

demos/static-root/pages/api/hello.js

@@ -0,0 +1,52 @@
+import Head from 'next/head'
+import Image from 'next/image'
+import { useRouter } from 'next/router'
+import styles from '../styles/Home.module.css'
+
+export default function Home() {
+  const { locale } = useRouter()
+  return (
+    <div className={styles.container}>
+      <Head>
+        <title>Create Next App</title>
+        <meta name="description" content="Generated by create next app" />
+        <link rel="icon" href="/favicon.ico" />
+      </Head>
+
+      <main className={styles.main}>
+        <h1 className={styles.title}>
+          Welcome to <a href="https://nextjs.org">Next.js!</a>
+        </h1>
+
+        <p>The current locale is {locale}</p>
+
+        <p className={styles.description}>
+          Get started by editing{' '}
+          <code className={styles.code}>pages/index.js</code>
+        </p>
+
+        <div className={styles.grid}>
+          <a href="https://nextjs.org/docs" className={styles.card}>
+            <h2>Documentation &rarr;</h2>
+            <p>Find in-depth information about Next.js features and API.</p>
+          </a>
+
+          <a href="https://nextjs.org/learn" className={styles.card}>
+            <h2>Learn &rarr;</h2>
+            <p>Learn about Next.js in an interactive course with quizzes!</p>
+          </a>
+
+          <a
+            href="https://github.com/vercel/next.js/tree/master/examples"
+            className={styles.card}
+          >
+            <h2>Examples &rarr;</h2>
+            <p>Discover and deploy boilerplate example Next.js projects.</p>
+          </a>
+        </div>
+      </main>
+
+
+    </div>
+  )
+}