Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2025-02-17 22:44:24 -05:00
Code Issues Activity

fix(sitemap): ensure nested 404 and 500 pages are excluded (#7722)

Browse source
This commit is contained in:
Nate Moore 2023-07-19 17:05:44 -05:00 • committed by GitHub
parent 7a3f4efcd9
commit 77ffcc8f8b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 28 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/fuzzy-toes-float.md Normal file
View file

@ -0,0 +1,5 @@
---
'@astrojs/sitemap': patch
---
Ensure nested 404 and 500 pages are always excluded

14
packages/integrations/sitemap/src/index.ts
View file

@ -49,7 +49,15 @@ function formatConfigErrorMessage(err: ZodError) {
const PKG_NAME = '@astrojs/sitemap'; const PKG_NAME = '@astrojs/sitemap';
const OUTFILE = 'sitemap-index.xml'; const OUTFILE = 'sitemap-index.xml';
const STATUS_CODE_PAGES = new Set(['/404', '/500']); const STATUS_CODE_PAGES = new Set(['404', '500']);
function isStatusCodePage(pathname: string): boolean {
if (pathname.endsWith('/')) {
pathname = pathname.slice(0, -1);
}
const end = pathname.split('/').pop() ?? '';
return STATUS_CODE_PAGES.has(end);
}
const createPlugin = (options?: SitemapOptions): AstroIntegration => { const createPlugin = (options?: SitemapOptions): AstroIntegration => {
let config: AstroConfig; let config: AstroConfig;
@ -87,7 +95,7 @@ const createPlugin = (options?: SitemapOptions): AstroIntegration => {
} }
let pageUrls = pages let pageUrls = pages
.filter((p) => !STATUS_CODE_PAGES.has('/' + p.pathname.slice(0, -1))) .filter((p) => !isStatusCodePage(p.pathname))
.map((p) => { .map((p) => {
if (p.pathname !== '' && !finalSiteUrl.pathname.endsWith('/')) if (p.pathname !== '' && !finalSiteUrl.pathname.endsWith('/'))
finalSiteUrl.pathname += '/'; finalSiteUrl.pathname += '/';
@ -103,7 +111,7 @@ const createPlugin = (options?: SitemapOptions): AstroIntegration => {
* Dynamic URLs have entries with `undefined` pathnames * Dynamic URLs have entries with `undefined` pathnames
*/ */
if (r.pathname) { if (r.pathname) {
if (STATUS_CODE_PAGES.has(r.pathname)) return urls; if (isStatusCodePage(r.pathname ?? r.route)) return urls;
/** /**
* remove the initial slash from relative pathname * remove the initial slash from relative pathname
* because `finalSiteUrl` always has trailing slash * because `finalSiteUrl` always has trailing slash

8
packages/integrations/sitemap/test/fixtures/static/src/pages/de/404.astro vendored Normal file
View file

@ -0,0 +1,8 @@
<html>
<head>
<title>404</title>
</head>
<body>
<h1>404</h1>
</body>
</html>

4
packages/integrations/sitemap/test/staticPaths.test.js
View file

@ -26,6 +26,10 @@ describe('getStaticPaths support', () => {
expect(urls).to.not.include('http://example.com/404/'); expect(urls).to.not.include('http://example.com/404/');
}); });
it('does not include nested 404 pages', () => {
expect(urls).to.not.include('http://example.com/de/404/');
});
it('includes numerical pages', () => { it('includes numerical pages', () => {
expect(urls).to.include('http://example.com/123/'); expect(urls).to.include('http://example.com/123/');
}); });