feat(plugin-client-redirects): keep the query string + hash (#8227)

Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
facebook · Oct 28, 2022 · 324440a · 324440a
1 parent 7dd225a
commit 324440a
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 23 deletions.
diff --git a/...lugin-client-redirects/src/__tests__/__snapshots__/createRedirectPageContent.test.ts.snap b/...lugin-client-redirects/src/__tests__/__snapshots__/createRedirectPageContent.test.ts.snap
@@ -9,7 +9,7 @@ exports[`createRedirectPageContent encodes uri special chars 1`] = `
     <link rel="canonical" href="https://docusaurus.io/gr/%CF%83%CE%B5%CE%BB%CE%B9%CE%B4%CE%B1%CF%82/" />
   </head>
   <script>
-    window.location.href = 'https://docusaurus.io/gr/%CF%83%CE%B5%CE%BB%CE%B9%CE%B4%CE%B1%CF%82/';
+    window.location.href = 'https://docusaurus.io/gr/%CF%83%CE%B5%CE%BB%CE%B9%CE%B4%CE%B1%CF%82/' + window.location.search + window.location.hash;
   </script>
 </html>"
 `;
@@ -23,7 +23,7 @@ exports[`createRedirectPageContent works 1`] = `
     <link rel="canonical" href="https://docusaurus.io/" />
   </head>
   <script>
-    window.location.href = 'https://docusaurus.io/';
+    window.location.href = 'https://docusaurus.io/' + window.location.search + window.location.hash;
   </script>
 </html>"
 `;
diff --git a/...aurus-plugin-client-redirects/src/__tests__/__snapshots__/writeRedirectFiles.test.ts.snap b/...aurus-plugin-client-redirects/src/__tests__/__snapshots__/writeRedirectFiles.test.ts.snap
@@ -10,7 +10,7 @@ exports[`toRedirectFiles creates appropriate metadata for empty baseUrl: fileCon
     <link rel="canonical" href="/abc" />
   </head>
   <script>
-    window.location.href = '/abc';
+    window.location.href = '/abc' + window.location.search + window.location.hash;
   </script>
 </html>",
 ]
@@ -26,7 +26,7 @@ exports[`toRedirectFiles creates appropriate metadata for root baseUrl: fileCont
     <link rel="canonical" href="/abc" />
   </head>
   <script>
-    window.location.href = '/abc';
+    window.location.href = '/abc' + window.location.search + window.location.hash;
   </script>
 </html>",
 ]
@@ -42,7 +42,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=false: fileC
     <link rel="canonical" href="https://docusaurus.io/abc" />
   </head>
   <script>
-    window.location.href = 'https://docusaurus.io/abc';
+    window.location.href = 'https://docusaurus.io/abc' + window.location.search + window.location.hash;
   </script>
 </html>",
   "<!DOCTYPE html>
@@ -53,7 +53,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=false: fileC
     <link rel="canonical" href="https://docusaurus.io/def.html" />
   </head>
   <script>
-    window.location.href = 'https://docusaurus.io/def.html';
+    window.location.href = 'https://docusaurus.io/def.html' + window.location.search + window.location.hash;
   </script>
 </html>",
   "<!DOCTYPE html>
@@ -64,7 +64,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=false: fileC
     <link rel="canonical" href="https://docusaurus.io/" />
   </head>
   <script>
-    window.location.href = 'https://docusaurus.io/';
+    window.location.href = 'https://docusaurus.io/' + window.location.search + window.location.hash;
   </script>
 </html>",
 ]
@@ -80,7 +80,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=true: fileCo
     <link rel="canonical" href="https://docusaurus.io/abc" />
   </head>
   <script>
-    window.location.href = 'https://docusaurus.io/abc';
+    window.location.href = 'https://docusaurus.io/abc' + window.location.search + window.location.hash;
   </script>
 </html>",
   "<!DOCTYPE html>
@@ -91,7 +91,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=true: fileCo
     <link rel="canonical" href="https://docusaurus.io/def.html" />
   </head>
   <script>
-    window.location.href = 'https://docusaurus.io/def.html';
+    window.location.href = 'https://docusaurus.io/def.html' + window.location.search + window.location.hash;
   </script>
 </html>",
   "<!DOCTYPE html>
@@ -102,7 +102,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=true: fileCo
     <link rel="canonical" href="https://docusaurus.io/" />
   </head>
   <script>
-    window.location.href = 'https://docusaurus.io/';
+    window.location.href = 'https://docusaurus.io/' + window.location.search + window.location.hash;
   </script>
 </html>",
 ]
@@ -118,7 +118,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=undefined: f
     <link rel="canonical" href="https://docusaurus.io/abc" />
   </head>
   <script>
-    window.location.href = 'https://docusaurus.io/abc';
+    window.location.href = 'https://docusaurus.io/abc' + window.location.search + window.location.hash;
   </script>
 </html>",
   "<!DOCTYPE html>
@@ -129,7 +129,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=undefined: f
     <link rel="canonical" href="https://docusaurus.io/def.html" />
   </head>
   <script>
-    window.location.href = 'https://docusaurus.io/def.html';
+    window.location.href = 'https://docusaurus.io/def.html' + window.location.search + window.location.hash;
   </script>
 </html>",
   "<!DOCTYPE html>
@@ -140,7 +140,7 @@ exports[`toRedirectFiles creates appropriate metadata trailingSlash=undefined: f
     <link rel="canonical" href="https://docusaurus.io/" />
   </head>
   <script>
-    window.location.href = 'https://docusaurus.io/';
+    window.location.href = 'https://docusaurus.io/' + window.location.search + window.location.hash;
   </script>
 </html>",
 ]

diff --git a/packages/docusaurus-plugin-client-redirects/src/templates/redirectPage.template.html.ts b/packages/docusaurus-plugin-client-redirects/src/templates/redirectPage.template.html.ts
@@ -14,7 +14,7 @@ export default `
     <link rel="canonical" href="<%= it.toUrl %>" />
   </head>
   <script>
-    window.location.href = '<%= it.toUrl %>';
+    window.location.href = '<%= it.toUrl %>' + window.location.search + window.location.hash;
   </script>
 </html>
 `;
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -35,12 +35,6 @@ function getNextVersionName() {
   return `${expectedPrefix}${version + 1}`;
 }
 
-const allDocHomesPaths = [
-  '/docs/',
-  '/docs/next/',
-  ...versions.slice(1).map((version) => `/docs/${version}/`),
-];
-
 const isDev = process.env.NODE_ENV === 'development';
 
 const isDeployPreview =
@@ -183,9 +177,8 @@ const config = {
       ({
         fromExtensions: ['html'],
         createRedirects(routePath) {
-          // Redirect to /docs from /docs/introduction, as introduction has been
-          // made the home doc
-          if (allDocHomesPaths.includes(routePath)) {
+          // Redirect to /docs from /docs/introduction (now docs root doc)
+          if (routePath === '/docs' || routePath === '/docs/') {
             return [`${routePath}/introduction`];
           }
           return [];