Skip to content

Commit

Permalink
fix: ignore trailing slash for endpoints with file extensions (#13131)
Browse files Browse the repository at this point in the history
* fix: ignore trailing slash for endpoints with file extensions

* Fix test
  • Loading branch information
ascorbic authored Feb 4, 2025
1 parent b71bd10 commit d60c742
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 12 deletions.
5 changes: 5 additions & 0 deletions .changeset/purple-suits-matter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': patch
---

Ignores trailing slashes for endpoints with file extensions in the route
24 changes: 16 additions & 8 deletions packages/astro/src/core/routing/manifest/create.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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);
Expand All @@ -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)
Expand Down
17 changes: 13 additions & 4 deletions packages/astro/test/units/routing/trailing-slash.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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}');
});
});

0 comments on commit d60c742

Please sign in to comment.