Skip to content

feat: Vite environment API#14008

Closed
teemingc wants to merge 20 commits intomainfrom
environment-api
Closed

feat: Vite environment API#14008
teemingc wants to merge 20 commits intomainfrom
environment-api

Conversation

@teemingc
Copy link
Copy Markdown
Member

@teemingc teemingc commented Jul 17, 2025

closes #13692
closes #1712
part of #3535
closes #13739
closes #13357
closes #12637

w.i.p and still has a lot of problems to solve. Needed to open this PR to test installing this from pkg.pr.new since linking locally with pnpm symlinks to the local kit repo. Then, when we try importing kit code from inside an environment, it results in a path which doesn't exist such as /packages/kit/.... Instead, it should probably import from node_modules/@sveltejs/kit/....

This PR adopts the Vite Environment API in kit and changes adapter-cloudflare to use a similar approach to Remix where the user can specify their own worker.js file. Otherwise, we can generate the wrangler config and worker for them. This approach integrates well with vite-plugin-cloudflare and provides users with direct access to the worker script, allowing them to export Durable Objects and add additional handlers.

Thanks to @jamesopstad for #12637 and writing up the Google Doc explaining the Remix and vite-plugin-cloudflare integration. Resources include:

TODO

  • Cloudflare dev
  • Cloudflare build
  • Node
  • vite-plugin-netlify
  • Vercel?
  • SPA/static?

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
  • 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.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Jul 17, 2025

⚠️ No Changeset found

Latest commit: 7fdfe68

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

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Jul 17, 2025

⚠️ No Changeset found

Latest commit: 71e3d5a

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

@teemingc teemingc marked this pull request as draft July 17, 2025 05:26
@benmccann
Copy link
Copy Markdown
Member

You probably need to bump the peer dep version on Vite

@benmccann benmccann added this to the 3.0 milestone Jul 17, 2025
@teemingc
Copy link
Copy Markdown
Member Author

teemingc commented Jul 18, 2025

You probably need to bump the peer dep version on Vite

Thanks! I missed that. Bumped it to 7 because I think 6 is missing some Environment API behaviour around multiple plugins building the app

@svelte-docs-bot
Copy link
Copy Markdown

@umgefahren

This comment was marked as duplicate.

@didier

This comment was marked as duplicate.

@teemingc
Copy link
Copy Markdown
Member Author

Sorry this got paused for such a long time. Took a little time off from this since we were getting remote functions out, then I had some non-SvelteKit work too.

I left a bunch of TODOs in the code which should be enough to get started but I imagine resolving the merge conflicts since remote functions were merged would be step 1. The major goals are in the TODO list from the post at the top of the thread (get it working in cloudflare dev / vite dev). Hopefully I return to this this month if not next.

@Giggiux
Copy link
Copy Markdown

Giggiux commented Oct 8, 2025

I am currently bypassing this issue using the approach defined in this repository, using alchemy.dev. But it adds a bunch of extra dependencies, it requires creating a new Worker script with the Durable Objects that after deployment is attached as a binding to the SvelteKit workers, and most importantly requires an "hack" in dev to send the requests via fetch to the secondary workers dev server, instead of using bindings.

Adding support for the official cloudflare vite plugin, and for websockets would make development with Cloudflare as a target even better with SvelteKit!

@Ayfri

This comment was marked as duplicate.

@Giggiux
Copy link
Copy Markdown

Giggiux commented Nov 22, 2025

Hey @teemingc is there any way we can help in moving this PR forward?
I could try and spend some time on it, but I am very well conscious that I have no idea where to start.

@teemingc
Copy link
Copy Markdown
Member Author

Hey @teemingc is there any way we can help in moving this PR forward? I could try and spend some time on it, but I am very well conscious that I have no idea where to start.

Hey @Giggiux we’re waiting until SvelteKit 3 before we move to the environment API

@Giggiux

This comment was marked as off-topic.

hynj added a commit to hynj/kit-vite that referenced this pull request Dec 17, 2025
- Upgrade to Vite 7.0.3 and add pnpm override to ensure consistent versions
- Add sveltekit_vite_environment virtual module for dev-time manifest access
- Add DevEnvironment type for sharing state between plugin and dev server
- Add environment.js utilities for module resolution in Vite environments
- Update dev server to populate and invalidate environment module
- Support environments config for future isolated builds

This is a minimal port of the Environment API changes from PR sveltejs#14008,
enabling Vite 7 support while maintaining compatibility with existing
adapters.
@teemingc
Copy link
Copy Markdown
Member Author

teemingc commented Feb 5, 2026

Closing this because we'll be starting this from scratch next week

@teemingc teemingc closed this Feb 5, 2026
@kvanbere
Copy link
Copy Markdown

Is there a new PR for it?

]
],
"overrides": {
"esm-env": "github:benmccann/esm-env#bcbddbc&path:packages/esm-env"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

just curious, is there a reason you had to do this? is there anything you need me to fix in it?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@petebacondarwin
Copy link
Copy Markdown

Is there a new PR for it?

This I think: #15627

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Allow custom worker script when deploying to Cloudflare Cloudflare Worker Adapter - Durable Objects

8 participants