plain static routes need 2 redirects: one to defaultLocale, one to preview mode func

Author: lindsaylevine

lib/pages/getStaticProps/redirects.js

@@ -45,14 +45,19 @@ pages.forEach(({ route, dataRoute, srcRoute }) => {
     const { defaultLocale, locales = [] } = nextConfig.i18n;
     const isDynamic = !!srcRoute;
     if (!isDynamic) {
+      // Preview mode redirect for standard route (no locale)
+      redirects.push({
+        route,
+        target,
+        force: false, // force FALSE to allow collision with defaultLocale redirect below
+        conditions,
+      });
       // Add a redirect for "expected" route to the defaultLocale-prepended route
       // i.e. /getStaticProps -> /en/getStaticProps
-      if (defaultLocale) {
-        redirects.push({
-          route,
-          target: `/${defaultLocale}${route}`,
-        });
-      }
+      redirects.push({
+        route,
+        target: `/${defaultLocale}${route}`,
+      });
       // Add a preview mode redirect for every locale
       locales.forEach((locale) => {
         const pageRoute = `/${locale}${route}`;
@@ -82,6 +87,12 @@ pages.forEach(({ route, dataRoute, srcRoute }) => {
         !dynamicDefaultLocaleRedirectsAdded.includes(srcRoute) &&
         !isFallbackRoute(srcRoute)
       ) {
+        redirects.push({
+          route: srcRoute,
+          target,
+          force: false, // force FALSE to allow collision with defaultLocale redirect below
+          conditions,
+        });
         const formattedSrcRoute = srcRoute.replace("[", ":").replace("]", "");
         const defaultLocaleTarget = `/${defaultLocale}${formattedSrcRoute}`;
         redirects.push({

lib/steps/setupRedirects.js

@@ -29,6 +29,13 @@ const setupRedirects = (publishPath) => {
     ...require("../pages/withoutProps/redirects"),
   ];
 
+  // Enables us to add colliding route redirects (which may exist
+  // for good reason i.e. i18n, you have two redirects; one for
+  // /route /{defaultLocale/route & /route -> preview_mode_func)
+  const redirectsTracked = nextRedirects.map((redirect) => {
+    return { ...redirect, added: false };
+  });
+
   // Add _redirect section heading
   if (nextRedirects.length >= 1) redirects.push("# Next-on-Netlify Redirects");
 
@@ -38,8 +45,8 @@ const setupRedirects = (publishPath) => {
 
   // Assemble redirects for each route
   sortedRoutes.forEach((route) => {
-    const nextRedirect = nextRedirects.find(
-      (redirect) => redirect.route === route
+    const nextRedirect = redirectsTracked.find(
+      (redirect) => redirect.route === route && !redirect.added
     );
 
     // One route may map to multiple Netlify routes: e.g., catch-all pages
@@ -60,6 +67,7 @@ const setupRedirects = (publishPath) => {
       const redirect = redirectPieces.join("  ").trim();
       logItem(redirect);
       redirects.push(redirect);
+      nextRedirect.added = true;
     });
   });
 

tests/__snapshots__/i18n.test.js.snap

@@ -50,12 +50,14 @@ exports[`Routing creates Netlify redirects 1`] = `
 /getServerSideProps/all/*  /.netlify/functions/next_getServerSideProps_all_slug  200
 /getServerSideProps/static  /.netlify/functions/next_getServerSideProps_static  200
 /getServerSideProps/:id  /.netlify/functions/next_getServerSideProps_id  200
+/getStaticProps/static  /.netlify/functions/next_getStaticProps_static  200  Cookie=__prerender_bypass,__next_preview_data
 /getStaticProps/static  /en/getStaticProps/static  200
 /getStaticProps/with-revalidate  /.netlify/functions/next_getStaticProps_withrevalidate  200
 /getStaticProps/withFallback/:id  /.netlify/functions/next_getStaticProps_withFallback_id  200
 /getStaticProps/withFallback/:slug/*  /.netlify/functions/next_getStaticProps_withFallback_slug  200
 /getStaticProps/withRevalidate/withFallback/:id  /.netlify/functions/next_getStaticProps_withRevalidate_withFallback_id  200
 /getStaticProps/withRevalidate/:id  /.netlify/functions/next_getStaticProps_withRevalidate_id  200
+/getStaticProps/:id  /.netlify/functions/next_getStaticProps_id  200  Cookie=__prerender_bypass,__next_preview_data
 /getStaticProps/:id  /en/getStaticProps/:id  200
 /shows/:id  /.netlify/functions/next_shows_id  200
 /shows/:params/*  /.netlify/functions/next_shows_params  200