feat: implement read (#11649)

* feat: implement readAsset

* lint etc

* maybe make it work on netlify? no idea how to test, manual deploys dont appear to respect .netlify directory

* set length/type from manifest

* tidy up

* regenerate types

* lint

* missed a spot

* more efficient manifest generation

* working on vercel

* lint/fix

* Update packages/adapter-vercel/index.js

Co-authored-by: Simon H <[email protected]>

* fix

* createReadable helper

* more future-proof API

* account for basepath

* lint

* rename to just `read`

* inline docs

* it is already deprecated, we just need to remove it

* read_asset -> read_implementation

* add test

* Apply suggestions from code review

Co-authored-by: Ben McCann <[email protected]>

* improve searchability

* prevent $app/server being imported client-side

* regenerate types

* add dev time feature tracking mechanism

* test feature support at build time

* lint

* lint

* regenerate types

* account for hooks.server.js, mostly

* regenerate types

* fix

* bump peerdeps, add changesets

* createReadable -> createReadableStream

* Apply suggestions from code review

Co-authored-by: Ben McCann <[email protected]>

* remove unnecessary if

* replace docs for find_server_assets

* update adapter author docs

* regenerate types

* explain what __SVELTEKIT_TRACK__ does

* mention `$app/server` on server-only modules page

* minor details

* oh ffs

* exclude prerendered routes from feature detection, handle /@fs assets in dev

* use read to populate content.json

* fix prerendering

* simplify

* simplify docs logic

* fix

* style

* simplify

* lockfile

* Apply suggestions from code review

Co-authored-by: Ben McCann <[email protected]>

* capitalize

* Apply suggestions from code review

Co-authored-by: Ben McCann <[email protected]>

---------

Co-authored-by: Rich Harris <[email protected]>
Co-authored-by: Simon H <[email protected]>
Co-authored-by: Ben McCann <[email protected]>

Author: 3 people

.changeset/rude-apples-jam.md

@@ -0,0 +1,7 @@
+---
+'@sveltejs/adapter-netlify': major
+'@sveltejs/adapter-vercel': major
+'@sveltejs/adapter-node': major
+---
+
+breaking: update peer dependency on `@sveltejs/kit`

.changeset/tasty-masks-talk.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': minor
+---
+
+feat: add `$app/server` module with `read` function for reading assets from filesystem

.changeset/tiny-maps-chew.md

@@ -0,0 +1,7 @@
+---
+'@sveltejs/adapter-netlify': minor
+'@sveltejs/adapter-vercel': minor
+'@sveltejs/adapter-node': minor
+---
+
+feat: support `read` from `$app/server`

documentation/docs/25-build-and-deploy/99-writing-adapters.md

@@ -7,6 +7,7 @@ If an adapter for your preferred environment doesn't yet exist, you can build yo
 Adapters packages must implement the following API, which creates an `Adapter`:
 
 ```js
+// @errors: 2322
 // @filename: ambient.d.ts
 type AdapterSpecificOptions = any;
 
@@ -19,6 +20,13 @@ export default function (options) {
 		name: 'adapter-package-name',
 		async adapt(builder) {
 			// adapter implementation
+		},
+		supports: {
+			read: ({ config, route }) => {
+				// Return `true` if the route with the given `config` can use `read`
+				// from `$app/server` in production, return `false` if it can't.
+				// Or throw a descriptive error describing how to configure the deployment
+			}
 		}
 	};
 

documentation/docs/30-advanced/50-server-only-modules.md

@@ -8,6 +8,10 @@ Like a good friend, SvelteKit keeps your secrets. When writing your backend and
 
 The `$env/static/private` and `$env/dynamic/private` modules, which are covered in the [modules](modules) section, can only be imported into modules that only run on the server, such as [`hooks.server.js`](hooks#server-hooks) or [`+page.server.js`](routing#page-page-server-js).
 
+## Server-only utilities
+
+The [`$app/server`](/docs/modules#$app-server) module, which contains a `read` function for reading assets from the filesystem, can likewise only be imported by code that runs on the server.
+
 ## Your modules
 
 You can make your own modules server-only in two ways:

packages/adapter-netlify/index.js

@@ -27,6 +27,7 @@ import toml from '@iarna/toml';
  *	 }} HandlerManifest
  */
 
+const name = '@sveltejs/adapter-netlify';
 const files = fileURLToPath(new URL('./files', import.meta.url).href);
 
 const edge_set_in_env_var =
@@ -38,7 +39,7 @@ const FUNCTION_PREFIX = 'sveltekit-';
 /** @type {import('./index.js').default} */
 export default function ({ split = false, edge = edge_set_in_env_var } = {}) {
 	return {
-		name: '@sveltejs/adapter-netlify',
+		name,
 
 		async adapt(builder) {
 			if (!builder.routes) {
@@ -92,6 +93,19 @@ export default function ({ split = false, edge = edge_set_in_env_var } = {}) {
 			} else {
 				await generate_lambda_functions({ builder, split, publish });
 			}
+		},
+
+		supports: {
+			// reading from the filesystem only works in serverless functions
+			read: ({ route }) => {
+				if (edge) {
+					throw new Error(
+						`${name}: Cannot use \`read\` from \`$app/server\` in route \`${route.id}\` when using edge functions`
+					);
+				}
+
+				return true;
+			}
 		}
 	};
 }

packages/adapter-netlify/package.json

@@ -51,6 +51,6 @@
 		"vitest": "^1.2.0"
 	},
 	"peerDependencies": {
-		"@sveltejs/kit": "^2.0.0"
+		"@sveltejs/kit": "^2.4.0"
 	}
 }

packages/adapter-netlify/src/serverless.js

@@ -1,6 +1,7 @@
 import './shims';
 import { Server } from '0SERVER';
 import { split_headers } from './headers.js';
+import { createReadableStream } from '@sveltejs/kit/node';
 
 /**
  * @param {import('@sveltejs/kit').SSRManifest} manifest
@@ -10,7 +11,8 @@ export function init(manifest) {
 	const server = new Server(manifest);
 
 	let init_promise = server.init({
-		env: process.env
+		env: process.env,
+		read: (file) => createReadableStream(`.netlify/server/${file}`)
 	});
 
 	return async (event, context) => {

packages/adapter-node/ambient.d.ts

@@ -9,6 +9,7 @@ declare module 'HANDLER' {
 declare module 'MANIFEST' {
 	import { SSRManifest } from '@sveltejs/kit';
 
+	export const base: string;
 	export const manifest: SSRManifest;
 	export const prerendered: Set<string>;
 }

packages/adapter-node/index.js

@@ -39,8 +39,11 @@ export default function (opts = {}) {
 
 			writeFileSync(
 				`${tmp}/manifest.js`,
-				`export const manifest = ${builder.generateManifest({ relativePath: './' })};\n\n` +
-					`export const prerendered = new Set(${JSON.stringify(builder.prerendered.paths)});\n`
+				[
+					`export const manifest = ${builder.generateManifest({ relativePath: './' })};`,
+					`export const prerendered = new Set(${JSON.stringify(builder.prerendered.paths)});`,
+					`export const base = ${JSON.stringify(builder.config.kit.paths.base)};`
+				].join('\n\n')
 			);
 
 			const pkg = JSON.parse(readFileSync('package.json', 'utf8'));
@@ -86,6 +89,10 @@ export default function (opts = {}) {
 					ENV_PREFIX: JSON.stringify(envPrefix)
 				}
 			});
+		},
+
+		supports: {
+			read: () => true
 		}
 	};
 }

packages/adapter-node/package.json

@@ -50,6 +50,6 @@
 		"rollup": "^4.9.5"
 	},
 	"peerDependencies": {
-		"@sveltejs/kit": "^2.0.0"
+		"@sveltejs/kit": "^2.4.0"
 	}
 }

packages/adapter-node/src/handler.js

@@ -4,15 +4,15 @@ import path from 'node:path';
 import sirv from 'sirv';
 import { fileURLToPath } from 'node:url';
 import { parse as polka_url_parser } from '@polka/url';
-import { getRequest, setResponse } from '@sveltejs/kit/node';
+import { getRequest, setResponse, createReadableStream } from '@sveltejs/kit/node';
 import { Server } from 'SERVER';
-import { manifest, prerendered } from 'MANIFEST';
+import { manifest, prerendered, base } from 'MANIFEST';
 import { env } from 'ENV';
 
 /* global ENV_PREFIX */
 
 const server = new Server(manifest);
-await server.init({ env: process.env });
+
 const origin = env('ORIGIN', undefined);
 const xff_depth = parseInt(env('XFF_DEPTH', '1'));
 const address_header = env('ADDRESS_HEADER', '').toLowerCase();
@@ -29,6 +29,13 @@ if (isNaN(body_size_limit)) {
 
 const dir = path.dirname(fileURLToPath(import.meta.url));
 
+const asset_dir = `${dir}/client${base}`;
+
+await server.init({
+	env: process.env,
+	read: (file) => createReadableStream(`${asset_dir}/${file}`)
+});
+
 /**
  * @param {string} path
  * @param {boolean} client

packages/adapter-vercel/files/serverless.js

@@ -1,5 +1,5 @@
 import { installPolyfills } from '@sveltejs/kit/node/polyfills';
-import { getRequest, setResponse } from '@sveltejs/kit/node';
+import { getRequest, setResponse, createReadableStream } from '@sveltejs/kit/node';
 import { Server } from 'SERVER';
 import { manifest } from 'MANIFEST';
 
@@ -8,7 +8,8 @@ installPolyfills();
 const server = new Server(manifest);
 
 await server.init({
-	env: /** @type {Record<string, string>} */ (process.env)
+	env: /** @type {Record<string, string>} */ (process.env),
+	read: createReadableStream
 });
 
 const DATA_SUFFIX = '/__data.json';

packages/adapter-vercel/index.js

@@ -5,6 +5,7 @@ import { nodeFileTrace } from '@vercel/nft';
 import esbuild from 'esbuild';
 import { get_pathname } from './utils.js';
 
+const name = '@sveltejs/adapter-vercel';
 const DEFAULT_FUNCTION_NAME = 'fn';
 
 const get_default_runtime = () => {
@@ -24,7 +25,7 @@ const plugin = function (defaults = {}) {
 	}
 
 	return {
-		name: '@sveltejs/adapter-vercel',
+		name,
 
 		async adapt(builder) {
 			if (!builder.routes) {
@@ -63,6 +64,8 @@ const plugin = function (defaults = {}) {
 			 * @param {import('@sveltejs/kit').RouteDefinition<import('.').Config>[]} routes
 			 */
 			async function generate_serverless_function(name, config, routes) {
+				const dir = `${dirs.functions}/${name}.func`;
+
 				const relativePath = path.posix.relative(tmp, builder.getServerDirectory());
 
 				builder.copy(`${files}/serverless.js`, `${tmp}/index.js`, {
@@ -77,12 +80,12 @@ const plugin = function (defaults = {}) {
 					`export const manifest = ${builder.generateManifest({ relativePath, routes })};\n`
 				);
 
-				await create_function_bundle(
-					builder,
-					`${tmp}/index.js`,
-					`${dirs.functions}/${name}.func`,
-					config
-				);
+				await create_function_bundle(builder, `${tmp}/index.js`, dir, config);
+
+				for (const asset of builder.findServerAssets(routes)) {
+					// TODO use symlinks, once Build Output API supports doing so
+					builder.copy(`${builder.getServerDirectory()}/${asset}`, `${dir}/${asset}`);
+				}
 			}
 
 			/**
@@ -335,6 +338,21 @@ const plugin = function (defaults = {}) {
 			builder.log.minor('Writing routes...');
 
 			write(`${dir}/config.json`, JSON.stringify(static_config, null, '\t'));
+		},
+
+		supports: {
+			// reading from the filesystem only works in serverless functions
+			read: ({ config, route }) => {
+				const runtime = config.runtime ?? defaults.runtime;
+
+				if (runtime === 'edge') {
+					throw new Error(
+						`${name}: Cannot use \`read\` from \`$app/server\` in route \`${route.id}\` configured with \`runtime: 'edge'\``
+					);
+				}
+
+				return true;
+			}
 		}
 	};
 };

packages/adapter-vercel/package.json

@@ -42,6 +42,6 @@
 		"vitest": "^1.2.0"
 	},
 	"peerDependencies": {
-		"@sveltejs/kit": "^2.0.0"
+		"@sveltejs/kit": "^2.4.0"
 	}
 }

packages/kit/scripts/generate-dts.js

@@ -13,6 +13,7 @@ await createBundle({
 		'$app/forms': 'src/runtime/app/forms.js',
 		'$app/navigation': 'src/runtime/app/navigation.js',
 		'$app/paths': 'src/runtime/app/paths/types.d.ts',
+		'$app/server': 'src/runtime/app/server/index.js',
 		'$app/stores': 'src/runtime/app/stores.js'
 	},
 	include: ['src']

packages/kit/src/core/adapt/builder.js

@@ -11,6 +11,7 @@ import { get_env } from '../../exports/vite/utils.js';
 import generate_fallback from '../postbuild/fallback.js';
 import { write } from '../sync/utils.js';
 import { list_files } from '../utils.js';
+import { find_server_assets } from '../generate_manifest/find_server_assets.js';
 
 const pipe = promisify(pipeline);
 const extensions = ['.html', '.js', '.mjs', '.json', '.css', '.svg', '.xml', '.wasm'];
@@ -145,6 +146,13 @@ export function create_builder({
 			}
 		},
 
+		findServerAssets(route_data) {
+			return find_server_assets(
+				build_data,
+				route_data.map((route) => /** @type {import('types').RouteData} */ (lookup.get(route)))
+			);
+		},
+
 		async generateFallback(dest) {
 			const manifest_path = `${config.kit.outDir}/output/server/manifest-full.js`;
 			const env = get_env(config.kit.env, vite_config.mode);

packages/kit/src/core/generate_manifest/find_server_assets.js

@@ -0,0 +1,52 @@
+import { find_deps } from '../../exports/vite/build/utils.js';
+
+/**
+ * Finds all the assets that are imported by server files associated with `routes`
+ * @param {import('types').BuildData} build_data
+ * @param {import('types').RouteData[]} routes
+ */
+export function find_server_assets(build_data, routes) {
+	/**
+	 * All nodes actually used in the routes definition (prerendered routes are omitted).
+	 * Root layout/error is always included as they are needed for 404 and root errors.
+	 * @type {Set<any>}
+	 */
+	const used_nodes = new Set([0, 1]);
+
+	// TODO add hooks.server.js asset imports
+	/** @type {Set<string>} */
+	const server_assets = new Set();
+
+	/** @param {string} id */
+	function add_assets(id) {
+		if (id in build_data.server_manifest) {
+			const deps = find_deps(build_data.server_manifest, id, false);
+			for (const asset of deps.assets) {
+				server_assets.add(asset);
+			}
+		}
+	}
+
+	for (const route of routes) {
+		if (route.page) {
+			for (const i of route.page.layouts) used_nodes.add(i);
+			for (const i of route.page.errors) used_nodes.add(i);
+			used_nodes.add(route.page.leaf);
+		}
+
+		if (route.endpoint) {
+			add_assets(route.endpoint.file);
+		}
+	}
+
+	for (const n of used_nodes) {
+		const node = build_data.manifest_data.nodes[n];
+		if (node?.server) add_assets(node.server);
+	}
+
+	if (build_data.manifest_data.hooks.server) {
+		add_assets(build_data.manifest_data.hooks.server);
+	}
+
+	return Array.from(server_assets);
+}