feat: make dev server compatible with FetchableDevEnvironment#15574
feat: make dev server compatible with FetchableDevEnvironment#15574teemingc wants to merge 243 commits into
Conversation
🦋 Changeset detectedLatest commit: 987889c The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
| const resolved = await this.resolve(id, importer, { | ||
| custom: options.custom, | ||
| isEntry: options.isEntry, | ||
| kind: options.kind, | ||
| skipSelf: true |
There was a problem hiding this comment.
AFAIK we can't spread options here because the options.ssr property errors when passed here now
more cleanup separated from #15574
|
I tried splitting the PR into dev changes and analyse/prerender changes but it doesn't work because they share APIs such as EDIT: Let me still try.... |
| server_manifest, | ||
| tracked_features | ||
| )) { | ||
| check_feature(route.id, route_config, feature, config.adapter); |
There was a problem hiding this comment.
Had to temporarily remove this because the implementation has changed such that it only works inside the Vite environment. It's re-added in the PR stacked on top of this
|
Read through the diff since I was curious how the environment split works. The architecture makes sense to me. A handful of things I could verify at source level, roughly in order of importance. All line refs are against the current head (987889c). packages/kit/src/exports/vite/dev/server.js
packages/kit/src/exports/vite/index.js
packages/kit/src/exports/vite/dev/ssr_manifest.js
packages/kit/src/core/postbuild/analyse.js
Two small questions. |
This PR changes the dev, preview, build analysis and prerender to run inside of the configured Vite SSR environment. This required the following fundamental changes:
1. Avoiding Node.js imports in the runtime
node:fsis a requirement but we import it in the main process instead and communicate the results back to the Vite SSR environment.AsyncLocalStorage.enterWithbecause it's a Node.js-only experimental API2. Replacing Vite's
ssrLoadModuleThe Vite docs recommendation is to create a
ModuleRunneror theRunnableDevEnvironmentinstance to achieve a similar functionality but these don't work with Cloudflare's environment. There's also no strict contract for environments to make these available to us so they can't be relied on. We solve this in two different ways:import.meta.hot.onin the SSR environment to listen for events from the main process, compute the result, and send it back.Serverclass from the build output in the main process, we spin up a Vite development server with the build output but proxy theServerclass by intercepting module resolution with Vite'sresolveIdhook. Starting a dev server and sending a request or HMR event seems to be the only way to run a module in the environment.3. Communication between the main process (where Vite runs) and the SSR environment (where user code runs)
The two points before this makes this a requirement. Now we'll detail the different types of communication that exist as a result:
One way communication
environments.ssr.hot.send. This helps us retain synchronous access to the filesystem from a non-Node environment such as checking if a filename exists as a key in the server assets map. We can also construct virtual modules with serialised data that the can be imported and accessed in the environment.import.meta.hot.sendso that the main process can then create a Vite error overlay in the browser. This replaces ourloudSsrLoadModuleutility.Two way communication
ssrLoadModuleto run some code in Vite's pipeline and get a result back. Now, we have to ensure the SSR environment has animport.meta.hot.onevent listener attached, emit an event, compute in the environment, and receive the results back in the main process throughenvironments.ssr.hot.onandPromise.withResolversto await the result. This is used for retrieving remote function info, etc. Alternatively, we can also proxy theServerclass during analysis and prerendering to respond with our environment computed result as mentioned earlier.import.meta.hotapproach above because Cloudflare's workerd doesn't like responding to requests from a context created byimport.meta.hot.on. Therefore, we usefetchto send a request to the running Vite dev server, configure the Vite dev server using theconfigureServerhook to intercept the request viavite.middlewares.use, and respond with the computed result. This is primarily used for getting CSS to inline to avoid FOUC during dev, finding out which param matchers exist from the filesystem, or even checking if a feature should be allowed by theadapter.supportsfunction which we can't serialise.Most of the
import.meta.hotandfetchstyle communication requires serialising and deserialising data usingdevalue.Future PRs
sirvon the build output instead of running the SSR serverPlease don't delete this checklist! Before submitting the PR, please make sure you do the following:
Tests
pnpm testand lint the project withpnpm lintandpnpm checkChangesets
pnpm changesetand following the prompts. Changesets that add features should beminorand those that fix bugs should bepatch. Please prefix changeset messages withfeat:,fix:, orchore:.Edits