Skip to content
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
drop virtual modules and split out features
  • Loading branch information
Chew Tee Ming Chew Tee Ming
Chew Tee Ming authored and Chew Tee Ming committed Nov 10, 2026
commit 9e8b67630f01d4faf5f49321fa60fd939d4ec7ce
2 changes: 1 addition & 1 deletion .changeset/kit-vite-respond.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
'@sveltejs/kit': minor
---

feat: add `virtual:sveltekit/server` and the `respond` option of `adapter.vite`, so that adapters can render requests in their platform's runtime during `vite dev`
feat: add `@sveltejs/kit/dev-server` and the `respond` option of `adapter.vite`, so that adapters can render requests in their platform's runtime during `vite dev`
6 changes: 2 additions & 4 deletions documentation/docs/25-build-and-deploy/99-writing-adapters.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,5 @@ Where possible, we recommend putting the adapter output under the `build/` direc

By default, `vite dev` renders requests in Node. If your platform's runtime can run in a [Vite environment](https://vite.dev/guide/api-environment), for example through a Vite plugin that your platform provides, you can render requests there instead, so that development behaves like production:

- In the code that runs in that environment, import `server` from `virtual:sveltekit/server`. It has the same API as the `server` that `builder.generateServerInstance` writes for production: call `await server.init({ env })` and `server.respond(request, { getClientAddress })`
- Add a `respond` function to your adapter's `vite` config that sends each request to that code and returns its response. SvelteKit calls it after serving static files, imported assets and the service worker, and logs the response as usual. It also sends its own requests through it, such as to find what a remote module exports, so that your app's modules only run in your platform's runtime

During development, `server` reads imported assets from the Vite dev server, so it doesn't need a `read` function.
- In the code that runs in that environment, import `server` from `@sveltejs/kit/dev-server`. It has the same API as the `server` that `builder.generateServerInstance` writes for production: call `await server.init({ env })` and `server.respond(request, { getClientAddress })`
- Add a `respond` function to your adapter's `vite` config that sends each request to that code and returns its response. SvelteKit calls it after serving static files, imported assets and the service worker, and logs the response as usual
4 changes: 4 additions & 0 deletions packages/kit/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,10 @@
"types": "./types/index.d.ts",
"import": "./src/exports/adapter.js"
},
"./dev-server": {
"types": "./types/index.d.ts",
"import": "./src/runtime/server/dev_instance.js"
},
"./node": {
"types": "./types/index.d.ts",
"import": "./src/exports/node/index.js"
Expand Down
4 changes: 2 additions & 2 deletions packages/kit/scripts/generate-dts.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ await createBundle({
modules: {
'@sveltejs/kit': 'src/exports/public.d.ts',
'@sveltejs/kit/adapter': 'src/exports/adapter.js',
'@sveltejs/kit/dev-server': 'src/exports/dev-server/public.d.ts',
'@sveltejs/kit/env': 'src/exports/env/public.d.ts',
'@sveltejs/kit/hooks': 'src/exports/hooks/public.d.ts',
'@sveltejs/kit/node': 'src/exports/node/index.js',
Expand All @@ -17,8 +18,7 @@ await createBundle({
'$app/paths': 'src/runtime/app/paths/public.d.ts',
'$app/server': 'src/runtime/app/server/public.d.ts',
'$app/service-worker': 'src/runtime/app/service-worker/index.js',
'$app/state': 'src/runtime/app/state/public.d.ts',
'virtual:sveltekit/server': 'src/exports/virtual/server/public.d.ts'
'$app/state': 'src/runtime/app/state/public.d.ts'
},
include: ['src'],
exclude: ['**/test/**', '**/fixtures/**', '**/*.spec.js'],
Expand Down
21 changes: 0 additions & 21 deletions packages/kit/src/constants.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,6 @@ export const SVELTE_KIT_ASSETS = '/_svelte_kit_assets';
/** dev server path that returns the css a module depends on */
export const DEV_INLINE_STYLES_PATH = '/@sveltejs/kit/dev/inline-styles';

/** dev server path that returns the sizes of the assets a module imports */
export const DEV_SERVER_ASSETS_PATH = '/@sveltejs/kit/dev/server-assets';

/**
* response header that reports the features and remote function a request used
*/
export const DEV_INFO_HEADER = 'x-sveltekit-dev-info';

/**
* request header that asks the dev server for the exports of a remote module
*/
export const DEV_REMOTE_EXPORTS_HEADER = 'x-sveltekit-dev-remote-exports';

export const DEV_SERVER_ID = 'virtual:sveltekit/server';

/** exports the origin of the vite dev server */
export const DEV_HOST_ID = '__sveltekit/dev/host';

/** id prefix of the modules that load a remote module by its hash */
export const DEV_REMOTE_PREFIX = '__sveltekit/dev/remote/';

export const GENERATED_COMMENT = '// this file is generated — do not edit it';

export const ENDPOINT_METHODS = [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@ import { Server } from '@sveltejs/kit';
* SvelteKit's server during `vite dev`, for code that renders requests in a Vite environment
* outside the Vite process, such as an adapter's Worker in workerd. It has the same API as the
* [server](https://svelte.dev/docs/kit/@sveltejs-kit#Server) that `builder.generateServerInstance`
* writes for production. It reads imported assets from the Vite dev server, so `init` doesn't need
* a `read` function. See [`respond`](https://svelte.dev/docs/kit/@sveltejs-kit#AdapterViteConfig).
* writes for production. See [`respond`](https://svelte.dev/docs/kit/@sveltejs-kit#AdapterViteConfig).
*
* ```js
* import { server } from 'virtual:sveltekit/server';
* import { server } from '@sveltejs/kit/dev-server';
*
* await server.init({ env });
* const response = await server.respond(request, { getClientAddress: () => address });
Expand Down
3 changes: 1 addition & 2 deletions packages/kit/src/exports/public.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,8 @@ export interface AdapterViteConfig {
* During `vite dev`, SvelteKit calls this function with each request it would render, after
* serving static files, imported assets and the service worker. Use it to render requests in
* your platform's runtime instead of Node: send them to code that runs there, which imports
* `server` from `virtual:sveltekit/server` and calls `server.respond`.
* `server` from `@sveltejs/kit/dev-server` and calls `server.respond`.
* Call `resolve` to render a request in Node, as SvelteKit does without this function.
* SvelteKit also sends its own requests through it, such as to find what a remote module exports.
* @since 3.3.0
*/
respond?: (
Expand Down
203 changes: 52 additions & 151 deletions packages/kit/src/exports/vite/dev/index.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/** @import { RequestEvent } from '@sveltejs/kit' */
/** @import { EnvironmentModuleNode, ViteDevServer } from 'vite' */
/** @import { DevRequestInfo, ManifestData, PrerenderOption, RemoteChunk, ServerModule, ValidatedConfig, SSRManifest } from 'types' */
/** @import { ManifestData, PrerenderOption, RemoteChunk, ServerModule, ValidatedConfig, SSRManifest } from 'types' */
import process from 'node:process';
import fs from 'node:fs';
import path from 'node:path';
Expand All @@ -14,7 +14,7 @@ import {
loud_ssr_load_module,
vite_css_query_regex
} from './generate_manifest.js';
import { generate_server_manifest_code } from './server_manifest_code.js';
import { generate_server_manifest_code, to_code } from './server_manifest_code.js';
import { write_if_changed } from '../../../core/sync/utils.js';
import { createReadableStream, getRequest, setResponse } from '../../../exports/node/index.js';
import { coalesce_to_error, set_error_stack } from '../../../utils/error.js';
Expand All @@ -23,17 +23,16 @@ import { load_and_validate_params } from '../../../core/params.js';
import { from_fs, to_fs } from '../../../utils/vite.js';
import { posixify } from '../../../utils/os.js';
import { load_error_page } from '../../../core/config/index.js';
import {
DEV_INFO_HEADER,
DEV_INLINE_STYLES_PATH,
DEV_SERVER_ASSETS_PATH,
SRC_ROOT,
SVELTE_KIT_ASSETS
} from '../../../constants.js';
import { DEV_INLINE_STYLES_PATH, SRC_ROOT, SVELTE_KIT_ASSETS } from '../../../constants.js';
import * as sync from '../../../core/sync/sync.js';
import { get_runtime_base } from '../../../core/utils.js';
import '../../../utils/mime.js'; // extend mrmime with additional types (affects sirv too)
import { is_chrome_devtools_request, is_remote_module, not_found } from '../utils.js';
import {
get_dev_origin,
is_chrome_devtools_request,
is_remote_module,
not_found
} from '../utils.js';
import { SCHEME } from '../../../utils/url.js';
import { check_feature } from '../../../core/features.js';
import * as e from '../../../messages/build-errors.js';
Expand Down Expand Up @@ -86,6 +85,15 @@ export async function dev(

write_tsconfig(svelte_config, root);

// for code outside the vite process, which imports it once the server listens
const write_origin = () =>
write_if_changed(
path.join(svelte_config.outDir, 'generated', 'dev', 'origin.js'),
`export const origin = ${to_code(get_dev_origin(vite_dev_server))};\n`
);
write_origin();
vite_dev_server.httpServer?.on('listening', write_origin);

/** @type {ManifestData} */
let manifest_data;
/** @type {SSRManifest} */
Expand Down Expand Up @@ -294,108 +302,49 @@ export async function dev(
});

/**
* only own keys, since the name comes from the request
* @param {string | null} name
* finds what a module depends on in the server environments that have it, since a dev server
* in another environment does not know which one it runs in
* @param {string} id the file path or url of the module
* @returns {Promise<Set<EnvironmentModuleNode> | undefined>}
*/
const get_environment = (name) =>
name !== null && Object.hasOwn(vite_dev_server.environments, name)
? vite_dev_server.environments[name]
: undefined;

// returns the css a module depends on, for servers in other vite environments
vite_dev_server.middlewares.use(
DEV_INLINE_STYLES_PATH,
catch_errors(async (req, res) => {
const url = new URL(req.originalUrl ?? '', 'http://localhost');
const environment = get_environment(url.searchParams.get('environment'));
async function find_server_deps(id) {
/** @type {Set<EnvironmentModuleNode> | undefined} */
let deps;

if (!environment) {
res.statusCode = 404;
res.end();
return;
}
for (const environment of Object.values(vite_dev_server.environments)) {
if (environment.config.consumer !== 'server') continue;

/** @type {Set<EnvironmentModuleNode>} */
const deps = new Set();
for (const module of url.searchParams.getAll('module')) {
// the generated manifest imports modules by their file path, which is their id
const node =
environment.moduleGraph.getModuleById(module) ??
(await environment.moduleGraph.getModuleByUrl(module));
if (node) await find_deps(environment, node, deps);
}
const node =
environment.moduleGraph.getModuleById(id) ??
(await environment.moduleGraph.getModuleByUrl(id));

/** @type {Array<{ url: string; inline: string }>} */
const styles = [];
for (const dep of deps) {
if (vite.isCSSRequest(dep.url) && !vite_css_query_regex.test(dep.url)) {
styles.push({
url: dep.url,
inline: dep.url.includes('?') ? dep.url.replace('?', '?inline&') : dep.url + '?inline'
});
}
}
if (node) await find_deps(environment, node, (deps ??= new Set()));
}

res.setHeader('content-type', 'application/json');
res.end(JSON.stringify(styles));
})
);
return deps;
}

// returns the sizes of the assets a server module imports, for servers that cannot read files
// returns the css a module depends on, for servers in other vite environments
vite_dev_server.middlewares.use(
DEV_SERVER_ASSETS_PATH,
DEV_INLINE_STYLES_PATH,
catch_errors(async (req, res) => {
const url = new URL(req.originalUrl ?? '', 'http://localhost');
const environment = get_environment(url.searchParams.get('environment'));
const id = url.searchParams.get('module');
const node =
environment &&
id &&
(environment.moduleGraph.getModuleById(id) ??
(await environment.moduleGraph.getModuleByUrl(id)));

if (!node) {
res.statusCode = 404;
res.end();
return;
}

/** @type {Set<EnvironmentModuleNode>} */
const deps = new Set();
await find_deps(environment, node, deps);

/** @type {Record<string, number>} */
const sizes = {};
for (const dep of deps) {
if (
!dep.file ||
vite.isCSSRequest(dep.file) ||
/\.(?:[cm]?[jt]sx?|svelte)$/.test(dep.file)
) {
continue;
}

/** @type {fs.Stats} */
let stats;
try {
stats = fs.statSync(dep.file);
} catch {
continue;
/** @type {Map<string, string>} */
const styles = new Map();
for (const module of url.searchParams.getAll('module')) {
for (const dep of (await find_server_deps(module)) ?? []) {
if (vite.isCSSRequest(dep.url) && !vite_css_query_regex.test(dep.url)) {
styles.set(
dep.url,
dep.url.includes('?') ? dep.url.replace('?', '?inline&') : dep.url + '?inline'
);
}
}
if (!stats.isFile()) continue;

// the same path read gets from the asset url
const relative = posixify(path.relative(root, dep.file));
const file =
relative.startsWith('../') || path.isAbsolute(relative)
? `/@fs${posixify(dep.file)}`
: relative;

sizes[file] = stats.size;
}

res.setHeader('content-type', 'application/json');
res.end(JSON.stringify(sizes));
res.end(JSON.stringify(Array.from(styles, ([url, inline]) => ({ url, inline }))));
})
);

Expand Down Expand Up @@ -561,16 +510,11 @@ export async function dev(

const adapter_respond = svelte_config.adapter?.vite?.respond;

// whether this process rendered the request and so loaded its modules
let rendered_here = !adapter_respond;

/**
* renders the request in this process
* @param {Request} request
*/
const resolve = async (request) => {
rendered_here = true;

if (resolved_instrumentation) {
const { set_env } = await runner.import('<sveltekit:generated>/env/config.js');
set_env(env);
Expand Down Expand Up @@ -605,39 +549,23 @@ export async function dev(
});
};

const { response: rendered, info } = adapter_respond
? read_dev_info(
await adapter_respond(request, { getClientAddress, resolve }),
svelte_config.adapter
)
: { response: await resolve(request), info: undefined };

// a server in another environment reports the remote function, so the log does not load it here
/** @type {Parameters<ServerModule['format_response']>[3]} */
const get_remote = rendered_here
? undefined
: () =>
Promise.resolve(
info?.remote && {
fn: /** @type {any} */ ({ __: info.remote }),
name: info.remote.name,
additional_args: ''
}
);
const rendered = adapter_respond
? await adapter_respond(request, { getClientAddress, resolve })
: await resolve(request);

if (rendered.status === 404) {
// @ts-expect-error
serve_static_middleware.handle(req, res, async () => {
log_dev_response(
rendered.status,
await format_response(rendered.status, request, manifest, get_remote)
await format_response(rendered.status, request, manifest)
);
(svelte_config.adapter?.vite?.setResponse ?? setResponse)(res, rendered);
});
} else {
log_dev_response(
rendered.status,
await format_response(rendered.status, request, manifest, get_remote)
await format_response(rendered.status, request, manifest)
);
(svelte_config.adapter?.vite?.setResponse ?? setResponse)(res, rendered);
}
Expand Down Expand Up @@ -668,33 +596,6 @@ function catch_errors(handler) {
};
}

/**
* reads what a server in another environment reported and checks its features against adapter.supports
* @param {Response} response
* @param {import('@sveltejs/kit').Adapter | undefined} adapter
* @returns {{ response: Response; info: DevRequestInfo | undefined }}
*/
function read_dev_info(response, adapter) {
const header = response.headers.get(DEV_INFO_HEADER);
if (!header) return { response, info: undefined };

/** @type {DevRequestInfo} */
const info = JSON.parse(decodeURIComponent(header));

try {
for (const { label, route, config } of info.features ?? []) {
check_feature(route, config, label, adapter);
}
} catch (error) {
void response.body?.cancel();
throw error;
}

const checked = new Response(response.body, response);
checked.headers.delete(DEV_INFO_HEADER);
return { response: checked, info };
}

/**
* @param {import('connect').Server} server
*/
Expand Down
Loading
Loading