feat(astro): Implement Request Route Parametrization for Astro 5

[s1gr1d]

Route Parametrization for Server Requests in Astro 5.

The route information is gathered during build-time. During runtime, the route information is matched to use the parametrized route information during runtime

Part of #16686

[Lms24]

Just a few questions -- nice work!

[Lms24]

l: Is there a test that ensures that a known route like GET / api/user/settings.json? Just wanna make sure we can disambiguate these routes :)

[s1gr1d]

not yet, but I was thinking about that!

In this case, it would work as user/settings and user/someID can be differentiated easily by matching the routePattern. routePattern will be user/settings or user/[userid] (all lowercased).

[Lms24]

also just so that I understand correctly: The ctx.routePattern alone is case-insensitive and we use the build time-injected information so that we get the case-sensitive one?

[s1gr1d]

yes

[Lms24]

Thanks for clarifying!
(I'll leave reviewing the cursor stuff up to you. Pretty sure some of the findings don't apply).

[s1gr1d]

Addressing cursor comments:

The includeRouteDataToConfigFile function repeatedly appends route information

That's no problem during build-time as the hook is only called once. During runtime I'll add a variable to make sure it only runs once.

The route.pattern property within storedBuildTimeRoutes is incorrectly serialized to {}

That's why I am appending .source of the regex to get the stringified value

joinRouteSegments() incorrectly processes catch-all route segments

No because the .content of the segment includes the ... like ...path

The rawRoutePattern variable is always undefined

No, only Astro version lower than 5

[cursor]

Bug: Sentry Route Info Repeatedly Appended

The astro:routes:resolved hook unconditionally appends globalThis["__sentryRouteInfo"] to the user's server init file. The didSaveRouteData flag only prevents multiple writes within a single build process, causing route information to be repeatedly appended across multiple builds. This leads to file bloat, duplicate assignments, and potential JavaScript syntax errors or unexpected runtime behavior.

packages/astro/src/integration/index.ts#L174-L203

sentry-javascript/packages/astro/src/integration/index.ts

Lines 174 to 203 in b4ec0f7

	// @ts-expect-error - This hook is available in Astro 5+
	'astro:routes:resolved': ({ routes }: { routes: IntegrationResolvedRoute[] }) => {
	if (!sentryServerInitPath || didSaveRouteData) {
	return;
	}
	try {
	const serverInitContent = readFileSync(sentryServerInitPath, 'utf8');
	const updatedServerInitContent = `${serverInitContent}\nglobalThis["__sentryRouteInfo"] = ${JSON.stringify(
	routes.map(route => {
	return {
	...route,
	patternCaseSensitive: joinRouteSegments(route.segments), // Store parametrized routes with correct casing on `globalThis` to be able to use them on the server during runtime
	patternRegex: route.patternRegex.source, // using `source` to be able to serialize the regex
	};
	}),
	null,
	2,
	)};`;
	writeFileSync(sentryServerInitPath, updatedServerInitContent, 'utf8');
	didSaveRouteData = true; // Prevents writing the file multiple times during runtime
	debug.log('Successfully added route pattern information to Sentry config file:', sentryServerInitPath);
	} catch (error) {
	debug.warn(`Failed to write to Sentry config file at ${sentryServerInitPath}:`, error);
	}
	},

Fix in Cursor • Fix in Web

---

Was this report helpful? Give feedback by reacting with 👍 or 👎