Fix redirect logic to be able to handle dynamic parts in target paths #11184
Conversation
|
github-actions
bot
added
the
pkg: astro
| @@ -29,4 +29,282 @@ describe('Astro', () => { | |||
|
|
|||
| assert.equal(_redirects.definitions.length, 2); | |||
| }); | |||
|
|
|||
| describe('Supports dynamic routes', () => { | |||
There was a problem hiding this comment.
There's a lot of branching in the source file that isn't covered by these tests, but that's out of scope for my changes.
| const pattern = | ||
| '/' + | ||
| route.segments | ||
| .map(([part]) => { | ||
| //(part.dynamic ? '*' : part.content) | ||
| if (part.dynamic) { | ||
| if (part.spread) { | ||
| return '*'; | ||
| return forTarget ? ':splat': '*'; |
There was a problem hiding this comment.
| .find( | ||
| (route) => | ||
| route.pattern.test(destination) || | ||
| route.fallbackRoutes.some((fallbackRoute) => fallbackRoute.pattern.test(destination)) |
There was a problem hiding this comment.
This is basically the same as matchRoute, but the current matchRoute code in match.js is for handling requests one level higher, and thus requires the entire Manifest
Context
There are a few related changes in this PR, but this was the use case I was trying to fix:
[category]/page/[page].astrois the route handler formyCategory/page/1.I'm trying to redirect from
/[category]to/[category]/page/1. Right now, since there's no RouteData with key/[category]/page/1in the manifest, my redirect target falls back to the server-rendered path, which in my case for cloudflare, is the empty string '', causing the entry in_redirectto be invalid. The line that gets generated is/:category 301There is however, a RouteData in the manifest that's able to handle this path, so it should resolve that route at the key
/[category]/page/[page].Changes
underscore-redirectto generate the right _redirect for targets with dynamic partsThis should allow this comment and hack to be removed
Questions
Are there edge cases that I'm missing? Its not clear to me if this is actually a backwards compatible change. It feels like my changes align with what the code is supposed to do, but this might break some folks?
Testing
Added test for each of the 3 cases above that did not exist before.
Docs
/cc @withastro/maintainers-docs Not sure if we need to add more docs around what is permissible in the redirect config, but this really threw me off guard that I couldn't do what I thought I was able to do.