Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
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
5 changes: 5 additions & 0 deletions .changeset/kit-adapter-dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@sveltejs/kit': minor
---

feat: add `@sveltejs/kit/adapter/dev`, so that adapters can render requests in their platform's runtime during `vite dev`
7 changes: 7 additions & 0 deletions documentation/docs/25-build-and-deploy/99-writing-adapters.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,10 @@ Within the `adapt` method, there are a number of things that an adapter should d
- Put the user's static files and the generated JS/CSS in the correct location for the target platform

Where possible, we recommend putting the adapter output under the `build/` directory with any intermediate output placed under `.svelte-kit/[adapter-name]`.

## Rendering in your platform's runtime during development

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 `@sveltejs/kit/adapter/dev`. 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 `dev.respond` function to your adapter 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: @sveltejs/kit/adapter/dev
---

> MODULE: @sveltejs/kit/adapter/dev
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"
},
"./adapter/dev": {
"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
1 change: 1 addition & 0 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/adapter/dev': 'src/exports/adapter/dev/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 Down
17 changes: 17 additions & 0 deletions packages/kit/src/exports/adapter/dev/public.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
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. See [`respond`](https://svelte.dev/docs/kit/@sveltejs-kit#AdapterDevConfig).
*
* ```js
* import { server } from '@sveltejs/kit/adapter/dev';
*
* await server.init({ env });
* const response = await server.respond(request, { getClientAddress: () => address });
* ```
* @since 3.3.0
*/
export const server: Server;
62 changes: 61 additions & 1 deletion packages/kit/src/exports/vite/dev/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,20 @@ import { URL } from 'node:url';
import { AsyncLocalStorage } from 'node:async_hooks';
import { styleText } from 'node:util';
import sirv from 'sirv';
import { generate_manifest, loud_ssr_load_module } from './generate_manifest.js';
import * as devalue from 'devalue';
import {
generate_manifest,
get_dev_manifest_data,
loud_ssr_load_module
} from './generate_manifest.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';
import { resolve_entry } from '../../../utils/filesystem.js';
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 { s } from '../../../utils/misc.js';
import { load_error_page } from '../../../core/config/index.js';
import { SRC_ROOT, SVELTE_KIT_ASSETS } from '../../../constants.js';
import * as sync from '../../../core/sync/sync.js';
Expand Down Expand Up @@ -81,6 +88,9 @@ export async function dev(
/** @type {Error | null} */
let manifest_error = null;

/** @type {string | undefined} the last manifest data written for other vite environments */
let dev_data;

const runner = get_runner(vite, vite_dev_server);
const { hot } = vite_dev_server.environments.client;

Expand All @@ -98,13 +108,63 @@ export async function dev(
}
}

const dev_data_file = path.join(svelte_config.outDir, 'generated', 'dev', 'manifest-data.js');

/**
* Writes what `@sveltejs/kit/adapter/dev` builds the manifest from, for an adapter that
* renders requests outside the Vite process
*/
function write_dev_data() {
if (!svelte_config.adapter?.dev?.respond || !manifest_data) return;

const data = get_dev_manifest_data(svelte_config, manifest_data, root);

const instrumentation = resolve_entry(
path.join(svelte_config.files.src, 'instrumentation.server'),
svelte_config.moduleExtensions
);

const code = `// generated during dev for \`@sveltejs/kit/adapter/dev\`
export const root = ${s(posixify(root))};

export const assets = ${s(svelte_config.paths.assets ? SVELTE_KIT_ASSETS : svelte_config.paths.base)};

export const instrumentation = ${s(instrumentation ? posixify(path.relative(root, instrumentation)) : null)};

export const data = ${devalue.uneval({
...data,
nodes: data.nodes.map(({ component, universal, server, page_options }) => ({
component,
universal,
server,
page_options
}))
})};
`;

if (code === dev_data) return;
dev_data = code;

write_if_changed(dev_data_file, code);

// the watcher would do this too, but a request that needs the new data may arrive first
for (const environment of Object.values(vite_dev_server.environments)) {
for (const module of environment.moduleGraph.getModulesByFile(posixify(dev_data_file)) ??
[]) {
environment.moduleGraph.invalidateModule(module);
}
}
}

/** @param {boolean} [validate_params] */
async function update_manifest(validate_params = true) {
try {
manifest_data = create_manifest_data(svelte_config, root);
sync.create(svelte_config, root, manifest_data, false);
set_manifest_data(manifest_data);

write_dev_data();

if (!validate_params) return;

await load_and_validate_params({
Expand Down
84 changes: 84 additions & 0 deletions packages/kit/src/runtime/server/dev_instance.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
/** @import { Server, ServerInitOptions } from '@sveltejs/kit' */
/** @import { SSRManifest } from 'types' */
import { create_dev_manifest } from '../../utils/dev_manifest.js';

// the adapter decides which features its platform supports once it renders requests itself
globalThis.__SVELTEKIT_TRACK__ = () => {};

/** @type {ServerInitOptions | undefined} */
let options;

/** @type {{ generated: typeof import('<sveltekit:generated>/manifest-data.js'), manifest: SSRManifest } | undefined} */
let current;

/**
* @param {string} root
* @param {string} file a path relative to the project root
*/
function resolve(root, file) {
const parts = root.split('/');

for (const part of file.split('/')) {
if (part === '..') parts.pop();
else if (part !== '.') parts.push(part);
}

return parts.join('/');
}

async function get_manifest() {
// imported per request, since sveltekit rewrites it when routes change
const generated = await import('<sveltekit:generated>/manifest-data.js');

if (current?.generated !== generated) {
const { root } = generated;

const manifest = create_dev_manifest(generated.data, {
load: (file) => import(/* @vite-ignore */ resolve(root, file)),
inline_styles: () => Promise.resolve({}),
server_assets: {},
remotes: () => []
});

current = { generated, manifest };
}

return current;
}

/** @type {Server} */
export const server = {
init(opts) {
options = opts;
return Promise.resolve();
},

async respond(request, request_options) {
const env = options?.env ?? {};
const { generated, manifest } = await get_manifest();

if (generated.instrumentation) {
// the instrumentation file may read environment variables, so set them first
const { set_env } = await import('<sveltekit:generated>/env/config.js');
set_env(env);
await import(/* @vite-ignore */ resolve(generated.root, generated.instrumentation));
}

const { configure } = await import('./index.js');

// configures the runtime for each request, like the node dev server
const server = await configure({
manifest,
env,
assets: generated.assets,
read: options?.read
});
await server.init();

// without read, like in production, since it is only for prerendering static files
return server.respond(
request,
/** @type {import('types').InternalRequestOptions} */ (request_options)
);
}
};
11 changes: 11 additions & 0 deletions packages/kit/src/types/ambient-private.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@ declare module '<sveltekit:generated>/server.js' {
export function get_hooks(): Promise<Partial<ServerHooks>>;
}

/** What `@sveltejs/kit/adapter/dev` builds the dev manifest from */
declare module '<sveltekit:generated>/manifest-data.js' {
/** The project root */
export const root: string;
/** The path that asset URLs start with */
export const assets: string;
/** The instrumentation file, relative to the project root */
export const instrumentation: string | null;
export const data: import('types').DevManifestData;
}

declare module '<sveltekit:generated>/env/config.js' {
// exported environment variables are defined in env.d.ts

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export function load() {
return {
// defined in vite.config.js
// @ts-expect-error
environment: __TEST_ENVIRONMENT__
};
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<script>
let { data } = $props();
</script>

<p>rendered in the {data.environment} environment</p>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export function GET() {
// defined in vite.config.js
// @ts-expect-error
return new Response(__TEST_ENVIRONMENT__);
}
12 changes: 12 additions & 0 deletions packages/kit/test/apps/dev-only/test/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -247,3 +247,15 @@ test('adapters can render requests themselves', async ({ request }) => {
const response = await request.get('/adapter-respond');
expect(await response.text()).toBe('rendered by the adapter');
});

test.describe('@sveltejs/kit/adapter/dev', () => {
test('renders pages in another environment', async ({ page }) => {
await page.goto('/other-environment');
await expect(page.locator('p')).toHaveText('rendered in the other environment');
});

test('renders endpoints in another environment', async ({ request }) => {
const response = await request.get('/other-environment/endpoint');
expect(await response.text()).toBe('other');
});
});
56 changes: 53 additions & 3 deletions packages/kit/test/apps/dev-only/vite.config.js
Original file line number Diff line number Diff line change
@@ -1,26 +1,76 @@
import * as path from 'node:path';
import process from 'node:process';
import { loadEnv } from 'vite';
import { sveltekit } from '@sveltejs/kit/vite';

/** @type {import('vite').ViteDevServer} */
let vite_dev_server;

/**
* Renders requests in another Vite environment, like an adapter
* for a platform whose runtime is not Node
* @type {import('vite').Plugin}
*/
const other_environment = {
name: 'test-other-environment',
config: () => ({
environments: {
other: {
consumer: 'server',
define: {
__TEST_ENVIRONMENT__: JSON.stringify('other')
},
resolve: {
noExternal: ['@sveltejs/kit']
}
}
}
}),
configureServer(server) {
vite_dev_server = server;
}
};

/** @type {import('vite').UserConfig} */
const config = {
build: {
minify: false
},
clearScreen: false,
define: {
__TEST_ENVIRONMENT__: JSON.stringify('ssr')
},
optimizeDeps: {
// for CI, we need to explicitly prebundle deps, since
// the reload confuses Playwright
include: ['cookie']
},
plugins: [
other_environment,
sveltekit({
adapter: {
name: 'test-adapter',
adapt: () => {},
dev: {
respond: (request, { resolve }) => {
if (new URL(request.url).pathname === '/adapter-respond') {
return Promise.resolve(new Response('rendered by the adapter'));
respond: async (request, { getClientAddress, resolve }) => {
const { pathname } = new URL(request.url);

if (pathname === '/adapter-respond') {
return new Response('rendered by the adapter');
}

if (pathname.startsWith('/other-environment')) {
const environment = /** @type {import('vite').RunnableDevEnvironment} */ (
vite_dev_server.environments.other
);

/** @type {typeof import('@sveltejs/kit/adapter/dev')} */
const { server } = await environment.runner.import('@sveltejs/kit/adapter/dev');

await server.init({
env: loadEnv(vite_dev_server.config.mode, process.cwd(), '')
});
return server.respond(request, { getClientAddress });
}

return resolve(request);
Expand Down
Loading
Loading