Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: migrate to vite environment API #13357

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

43081j
Copy link

@43081j 43081j commented Jan 21, 2025

Moves the vite dev server to use the new environments API.

This changes the following:

  • vite.moduleGraph is replaced by vite.environments.ssr.moduleGraph
  • vite.ssrLoadModule is replaced by vite.environments.ssr.runner.import(url)

Draft for now

These things are only deprecated with future: true, so we don't actually need to make the changes yet.

Also i don't work with svelte often so this PR could be way off. Same for vite internals. I was doing this as a learning task.

If it turns out you want to do this another way, or i've done it completely wrong, let's close the PR 👍


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • 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
    • no issue while draft, but will add one before publish, if we ever do
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • 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

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

Moves the vite dev server to use the new environments API.

This changes the following:

- `vite.moduleGraph` is replaced by `vite.environments.ssr.moduleGraph`
- `vite.ssrLoadModule` is replaced by
	`vite.environments.ssr.runner.import(url)`
Copy link

changeset-bot bot commented Jan 21, 2025

⚠️ No Changeset found

Latest commit: 5cc38e1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@@ -64,9 +70,13 @@ export async function dev(vite, vite_config, svelte_config) {
let manifest_error = null;

/** @param {string} url */
async function loud_ssr_load_module(url) {
async function load_ssr_load_module(url) {
if (!isRunnableDevEnvironment(viteEnv)) {
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

repeated logic because these functions are all hoisted before we've done our type guard on L38

@dummdidumm dummdidumm added this to the 3.0 milestone Jan 21, 2025
@dummdidumm
Copy link
Member

AFAIK we can only do this when we do SvelteKit 3 and bump the Vite peer dependency to 6+

@43081j
Copy link
Author

43081j commented Jan 21, 2025

makes sense to me! 👍

happy to leave this or close it, up to you folks. i can pick it up again once we're ready if nobody else does

@@ -33,6 +33,12 @@ const vite_css_query_regex = /(?:\?|&)(?:raw|url|inline)(?:&|$)/;
export async function dev(vite, vite_config, svelte_config) {
installPolyfills();

const viteEnv = vite.environments.ssr;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should probably be named sth like vite_env_ssr (internally we use snake_case)

Copy link
Author

@43081j 43081j Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is just the default environment vite sets up

nevermind i misread! yes you're right

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants