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

fix: ignore trailing slash for endpoints with file extensions (#13131)

Browse source 
* fix: ignore trailing slash for endpoints with file extensions

* Fix test
This commit is contained in:
Matt Kane 2025-02-04 09:48:41 +00:00 • committed by GitHub
parent b71bd10989
commit d60c74243f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 34 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/purple-suits-matter.md Normal file
View file

@ -0,0 +1,5 @@
---
'astro': patch
---
Ignores trailing slashes for endpoints with file extensions in the route

24
packages/astro/src/core/routing/manifest/create.ts
View file

@ -19,7 +19,7 @@ import {
UnsupportedExternalRedirect,
} from '../../errors/errors-data.js';
import { AstroError } from '../../errors/index.js';
import { removeLeadingForwardSlash, slash } from '../../path.js';
import { hasFileExtension, removeLeadingForwardSlash, slash } from '../../path.js';
import { injectServerIslandRoute } from '../../server-islands/endpoint.js';
import { resolvePages } from '../../util.js';
import { ensure404Route } from '../astro-designed-error-pages.js';
@ -218,12 +218,12 @@ function createFileBasedRoutes(
} else {
components.push(item.file);
const component = item.file;
const { trailingSlash } = settings.config;
const pattern = getPattern(segments, settings.config.base, trailingSlash);
const generate = getRouteGenerator(segments, trailingSlash);
const pathname = segments.every((segment) => segment.length === 1 && !segment[0].dynamic)
? `/${segments.map((segment) => segment[0].content).join('/')}`
: null;
const trailingSlash = trailingSlashForPath(pathname, settings.config);
const pattern = getPattern(segments, settings.config.base, trailingSlash);
const generate = getRouteGenerator(segments, trailingSlash);
const route = joinSegments(segments);
routes.push({
route,
@ -257,6 +257,14 @@ function createFileBasedRoutes(
return routes;
}
// Get trailing slash rule for a path, based on the config and whether the path has an extension.
// TODO: in Astro 6, change endpoints with extentions to use 'never'
const trailingSlashForPath = (
pathname: string | null,
config: AstroConfig,
): AstroConfig['trailingSlash'] =>
pathname && hasFileExtension(pathname) ? 'ignore' : config.trailingSlash;
function createInjectedRoutes({ settings, cwd }: CreateRouteManifestParams): RouteData[] {
const { config } = settings;
const prerender = getPrerenderDefault(config);
@ -276,13 +284,13 @@ function createInjectedRoutes({ settings, cwd }: CreateRouteManifestParams): Rou
});
const type = resolved.endsWith('.astro') ? 'page' : 'endpoint';
const { trailingSlash } = config;
const pattern = getPattern(segments, settings.config.base, trailingSlash);
const generate = getRouteGenerator(segments, trailingSlash);
const pathname = segments.every((segment) => segment.length === 1 && !segment[0].dynamic)
? `/${segments.map((segment) => segment[0].content).join('/')}`
: null;
const trailingSlash = trailingSlashForPath(pathname, config);
const pattern = getPattern(segments, settings.config.base, trailingSlash);
const generate = getRouteGenerator(segments, trailingSlash);
const params = segments
.flat()
.filter((p) => p.dynamic)

17
packages/astro/test/units/routing/trailing-slash.test.js
View file

@ -95,6 +95,16 @@ describe('trailingSlash', () => {
assert.equal(res.statusCode, 404);
});
it('should match an injected route when request has a file extension and no slash', async () => {
const { req, res, text } = createRequestAndResponse({
method: 'GET',
url: '/injected.json',
});
container.handle(req, res);
const json = await text();
assert.equal(json, '{"success":true}');
});
it('should match the API route when request has a trailing slash, with a file extension', async () => {
const { req, res, text } = createRequestAndResponse({
method: 'GET',
@ -105,14 +115,13 @@ describe('trailingSlash', () => {
assert.equal(json, '{"success":true}');
});
it('should NOT match the API route when request lacks a trailing slash, with a file extension', async () => {
it('should also match the API route when request lacks a trailing slash, with a file extension', async () => {
const { req, res, text } = createRequestAndResponse({
method: 'GET',
url: '/dot.json',
});
container.handle(req, res);
const html = await text();
assert.equal(html.includes(`<span class="statusMessage">Not found</span>`), true);
assert.equal(res.statusCode, 404);
const json = await text();
assert.equal(json, '{"success":true}');
});
});