Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slorber merged 6 commits into from
Oct 20, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0f5d85d
feat(plugin-client-redirects): keep the query string
xlahuerta Oct 19, 2022
9b48a14
Merge branch 'facebook:main' into main
xlahuerta Oct 19, 2022
6e3aa35
Merge branch 'main' into Xabilahu/main
slorber Oct 20, 2022
3447a59
simplify legacy /docs/introduction client redirect
slorber Oct 20, 2022
66fd638
keep the hash too
slorber Oct 20, 2022
fe7b92c
minor fix for deploy preview redirection test
slorber Oct 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...lugin-client-redirects/src/__tests__/__snapshots__/createRedirectPageContent.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>"
`;
Expand All @@ -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>"
`;
22 changes: 11 additions & 11 deletions ...aurus-plugin-client-redirects/src/__tests__/__snapshots__/writeRedirectFiles.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>",
]
Expand All @@ -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>",
]
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>",
]
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>",
]
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>",
]
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-client-redirects/src/templates/redirectPage.template.html.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
`;
11 changes: 2 additions & 9 deletions website/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,6 @@ function getNextVersionName() {
*/
}

const allDocHomesPaths = [
'/docs/',
'/docs/next/',
...versions.slice(1).map((version) => `/docs/${version}/`),
];

const isDev = process.env.NODE_ENV === 'development';

const isDeployPreview =
Expand Down Expand Up @@ -187,9 +181,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 [];
Expand Down