fix: ignore SPA redirect in dev mode to allow Vite to take over #514
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Filter out the SPA redirect pattern (from '/*' to '/index.html' with status 200) in createRewriter when ignoreSPARedirect is true. This prevents the redirect from interfering with local dev servers like Vite, while still allowing it to work in production. RedirectsHandler now always passes ignoreSPARedirect: true to createRewriter, ensuring the SPA redirect is ignored in dev mode. Added e2e test to verify JS modules load correctly and execute when SPA redirect is configured in netlify.toml. Fixes #325
serhalp
changed the title
pieh
reviewed
Nov 5, 2025
| const isSPARedirect = | ||
| redirect.from === '/*' && | ||
| redirect.to === '/index.html' && | ||
| (redirect.status === 200 || redirect.status === undefined) |
Contributor
There was a problem hiding this comment.
Is it correct to filter out when status is undefined? Wouldn't this be a redirect by default if there was no status there? And redirect doesn't seem like it would work generally for SPA mode as you really need rewrite for that (plus we don't check for explicit redirect status code here either)
Member
Author
There was a problem hiding this comment.
Yeah, I guess so! Good catch, thanks.
pieh
previously approved these changes
Nov 5, 2025
Member
Author
|
ugh, Windows tests are not flaky, it's some sort of path issue with the new test... only on Vite 5 for some reason... 😭 looking. |
After normalization, redirects use 'origin' instead of 'from', so we need to check redirect.origin for the SPA pattern match.
Removed direct JS file check that was causing path resolution issues on Windows with Vite 5. The test now verifies the fix by checking that JS executes and updates the page, which is a better test of the actual user-facing behavior.
serhalp
force-pushed
the
2025-11-04-jumr-bclmo
branch
from
8ef8483 to
67cf9e7
Compare
pieh
reviewed
Nov 5, 2025
pieh
approved these changes
Nov 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #325
Problem
When using the standard recommended SPA redirect configuration in
netlify.toml:This works in production (it rewrites all requests to
/index.html) but breaks local development with Vite. The redirect catches all requests, even JS module requests, causing them to be redirected toindex.htmlinstead of serving the actual JS files. This results in errors like:Solution
This PR ports the existing solution from Netlify CLI (yeah, it really isn't obvious what's going in there, sorry): detect and ignore the SPA redirect pattern in dev mode. The redirect is still used in production (via the CLI), but in dev mode it's ignored, allowing Vite to handle routing and serve JS modules correctly.
Future work
This is a stopgap solution. Ideally it seems if we've centralized all build and dev functionality in this Vite plugin, users should not need to configure this special redirect manually but rather our plugin could inject it only at build time, only in SPA mode.