fix: remove ":$" from virtual module ids to allow dev server to work with proxies

janabimustafa commented 3 weeks ago

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:

[x] It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
[x] This message body should clearly illustrate what problems it solves.
[x] Ideally, include a test that fails without this PR but passes with it.

Tests

[x] Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

[x] If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

[x] Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

changeset-bot[bot] commented 3 weeks ago

🦋 Changeset detected

Latest commit: 3261c7d1fdd345f1182301ec5d5eab11b53bb04c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

| Name | Type | | ------------- | ----- | | @sveltejs/kit | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

janabimustafa commented 6 days ago

@dummdidumm @Rich-Harris @benmccann any chance someone can take a look at this? as it stands, version 1.25.1 is the latest version I can use without running into this issue. If you ever need to stitch multiple sites behind a reverse proxy while developing locally, you will run into this issue.

sveltejs / kit