fix: remove ":$" from virtual module ids to allow dev server to work with proxies #12157
+90
−39
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.
Summary:
This PR addresses an issue where Nginx, and potentially other reverse proxies, do not process URLs containing the sequence
:$
. Specifically, Nginx returns a "400 Bad Request" error when it encounters such URLs. This conflict arises when using the Vite development server with SvelteKit, where certain virtual modules (e.g.,$env/dynamic/public
and$env/static/public
) are externally represented with an ID that includes:$
.Details:
In the Vite dev server, some SvelteKit virtual modules are resolved to IDs such as
\0virtual:$env/dynamic/public
. The presence of:$
in these IDs causes compatibility issues with Nginx, which fails to handle these URLs correctly.Solution:
This PR modifies the naming convention for virtual modules in the Vite development environment. The proposed change is to avoid starting virtual module names with
$
, thereby preventing the inclusion of:$
in the module IDs. This adjustment ensures that the Vite dev server can operate behind Nginx or similar reverse proxies without encountering HTTP 400 errors.Impact:
Adopting this naming convention will allow developers to run the Vite development server behind Nginx and other reverse proxies seamlessly, improving development workflow and compatibility.
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm test
and lint the project withpnpm lint
andpnpm check
Changesets
pnpm changeset
and following the prompts. Changesets that add features should beminor
and those that fix bugs should bepatch
. Please prefix changeset messages withfeat:
,fix:
, orchore:
.Edits