PR preview pages don't handle visit to non deployed pages well #76
Description
Summary
Previews generated by the PR review companion include only the modified files. On preview pages, links to other unmodified pages give a 404 error. Also, the error is wrong: Key: pr37670/en-us/_spas/404.html. Following is the content of the 404 response:
404 Not Found
Code: NoSuchKey
Message: The specified key does not exist.
Key: pr37670/en-us/_spas/404.html
RequestId: W9ZG8PFR8V5N0MK5
HostId: EoaAHM8g7wgSv7rGa1dRb6/F9o5Pg93I6h0iZVYuA8A5x1RrlpNKgHZVADEZDyl/ZnC2KuEdIr8=
Reviewers find it annoying to see the 404 page instead of the requested page, even though it's not modified in the PR. It would be better if, on the 404 page, there is a link to the page on the production site.
Steps to reproduce
- Open any latest PR in the
mdn/contentrepo. - Open any preview page.
- On the page, click on any link to an MDN page that is not modified in the PR.
- You'll get
pr37670/en-us/_spas/404.htmlnot found error.
Solution
The solution is based on the TamporMonkey script created by Will. The script adds a link to the same doc on the production site. Instead of TamporMonkey, we can do it in the deployer code itself.\
During dev deployments for PRs, populate the /en-us/_spas/404.html file with the following content:
<!DOCTYPE html>
<HTML>
<head>
<title>404 Page Not Found</title>
</head>
<body>
<h1>404 Page Not Found</h1>
<script>
if (document.location.hostname.endsWith("content.dev.mdn.mozit.cloud")) {
const link = document.createElement("a");
link.href = `https://developer.mozilla.org${document.location.pathname}`;
link.textContent = "View on MDN production server.";
document.body.appendChild(link);
}
</script>
</body>
</html>Note: Ignore the fact that PR build doesn't populate the original _spas/404.html. The production style 404 page is not useful in PR previews anyway.