Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2025-03-17 23:11:29 -05:00
Code Issues Activity

Make status code check more strict for sitemap plugin (#10779)

Browse source 
Co-authored-by: Ben Holmes <hey@bholmes.dev>
Co-authored-by: Florian Lefebvre <contact@florian-lefebvre.dev>
This commit is contained in:
Adrian Lyjak 2024-05-21 07:01:35 -04:00 • committed by GitHub
parent 026f50ad2f
commit cefeadf0a4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 49 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/nasty-turtles-obey.md Normal file
View file

@ -0,0 +1,5 @@
---
"@astrojs/sitemap": patch
---
Fixes false positives for status code routes like `404` and `500` when generating sitemaps.

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

@ -47,14 +47,23 @@ const PKG_NAME = '@astrojs/sitemap';
const OUTFILE = 'sitemap-index.xml';
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 isStatusCodePage = (locales: string[]) => {
const statusPathNames = new Set(
locales
.flatMap((locale) => [...STATUS_CODE_PAGES].map((page) => `${locale}/${page}`))
.concat([...STATUS_CODE_PAGES])
);
return (pathname: string): boolean => {
if (pathname.endsWith('/')) {
pathname = pathname.slice(0, -1);
}
if (pathname.startsWith('/')) {
pathname = pathname.slice(1);
}
return statusPathNames.has(pathname);
};
};
const createPlugin = (options?: SitemapOptions): AstroIntegration => {
let config: AstroConfig;
@ -88,9 +97,9 @@ const createPlugin = (options?: SitemapOptions): AstroIntegration => {
);
return;
}
const shouldIgnoreStatus = isStatusCodePage(Object.keys(opts.i18n?.locales ?? {}));
let pageUrls = pages
.filter((p) => !isStatusCodePage(p.pathname))
.filter((p) => !shouldIgnoreStatus(p.pathname))
.map((p) => {
if (p.pathname !== '' && !finalSiteUrl.pathname.endsWith('/'))
finalSiteUrl.pathname += '/';
@ -107,7 +116,7 @@ const createPlugin = (options?: SitemapOptions): AstroIntegration => {
* Dynamic URLs have entries with `undefined` pathnames
*/
if (r.pathname) {
if (isStatusCodePage(r.pathname ?? r.route)) return urls;
if (shouldIgnoreStatus(r.pathname ?? r.route)) return urls;
// `finalSiteUrl` may end with a trailing slash
// or not because of base paths.

10
packages/integrations/sitemap/test/fixtures/static/astro.config.mjs vendored
View file

@ -2,7 +2,15 @@ import sitemap from '@astrojs/sitemap';
import { defineConfig } from 'astro/config';
export default defineConfig({
integrations: [sitemap()],
integrations: [sitemap({
i18n: {
defaultLocale: 'it',
locales: {
it: 'it-IT',
de: 'de-DE',
}
}
})],
site: 'http://example.com',
redirects: {
'/redirect': '/'

11
packages/integrations/sitemap/test/fixtures/static/src/pages/products-by-id/[id].astro vendored Normal file
View file

@ -0,0 +1,11 @@
---
export async function getStaticPaths() {
return [
{ params: { id: '404' } },
{ params: { id: '405' } },
]
}
const { id } = Astro.params
---
<!DOCTYPE html><html> <head><title>Product #{id}</title></head> <body> <h1>Product #404</h1> <p>This is a product that just happens to have an ID of {id}. It is found!</p></body></html>

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

@ -36,6 +36,11 @@ describe('getStaticPaths support', () => {
assert.equal(urls.includes('http://example.com/123/'), true);
});
it('includes numerical 404 pages if not for i18n', () => {
assert.equal(urls.includes('http://example.com/products-by-id/405/'), true);
assert.equal(urls.includes('http://example.com/products-by-id/404/'), true);
});
it('should render the endpoint', async () => {
const page = await fixture.readFile('./it/manifest');
assert.match(page, /I'm a route in the "it" language./);