@sveltejs/adapter-vercel 1.0.5 → 2.0.0

package/README.md

@@ -6,7 +6,7 @@ If you're using [adapter-auto](https://kit.svelte.dev/docs/adapter-auto), you do
 
 ## Docs
 
-[Docs](https://kit.svelte.dev/docs/adapter-cloudflare)
+[Docs](https://kit.svelte.dev/docs/adapter-vercel)
 
 ## Changelog
 

package/files/edge.js

@@ -3,7 +3,7 @@ import { manifest } from 'MANIFEST';
 
 const server = new Server(manifest);
 const initialized = server.init({
-	env: process.env
+	env: /** @type {Record<string, string>} */ (process.env)
 });
 
 /**
@@ -13,7 +13,7 @@ export default async (request) => {
 	await initialized;
 	return server.respond(request, {
 		getClientAddress() {
-			return request.headers.get('x-forwarded-for');
+			return /** @type {string} */ (request.headers.get('x-forwarded-for'));
 		}
 	});
 };

package/files/serverless.js

@@ -8,7 +8,7 @@ installPolyfills();
 const server = new Server(manifest);
 
 await server.init({
-	env: process.env
+	env: /** @type {Record<string, string>} */ (process.env)
 });
 
 /**
@@ -22,7 +22,7 @@ export default async (req, res) => {
 	try {
 		request = await getRequest({ base: `https://${req.headers.host}`, request: req });
 	} catch (err) {
-		res.statusCode = err.status || 400;
+		res.statusCode = /** @type {any} */ (err).status || 400;
 		return res.end('Invalid request body');
 	}
 
@@ -30,7 +30,7 @@ export default async (req, res) => {
 		res,
 		await server.respond(request, {
 			getClientAddress() {
-				return request.headers.get('x-forwarded-for');
+				return /** @type {string} */ (request.headers.get('x-forwarded-for'));
 			}
 		})
 	);

package/index.d.ts

@@ -1,9 +1,83 @@
 import { Adapter } from '@sveltejs/kit';
 
-type Options = {
-	edge?: boolean;
+export default function plugin(config?: Config): Adapter;
+
+export interface ServerlessConfig {
+	/**
+	 * Whether to use [Edge Functions](https://vercel.com/docs/concepts/functions/edge-functions) or [Serverless Functions](https://vercel.com/docs/concepts/functions/serverless-functions)
+	 * @default 'nodejs18.x'
+	 */
+	runtime?: 'nodejs16.x' | 'nodejs18.x';
+	/**
+	 * To which regions to deploy the app. A list of regions.
+	 * More info: https://vercel.com/docs/concepts/edge-network/regions
+	 */
+	regions?: string[];
+	/**
+	 * Maximum execution duration (in seconds) that will be allowed for the Serverless Function.
+	 * Serverless only.
+	 */
+	maxDuration?: number;
+	/**
+	 * Amount of memory (RAM in MB) that will be allocated to the Serverless Function.
+	 * Serverless only.
+	 */
+	memory?: number;
+	/**
+	 * If `true`, this route will always be deployed as its own separate function
+	 */
+	split?: boolean;
+	/**
+	 * [Incremental Static Regeneration](https://vercel.com/docs/concepts/incremental-static-regeneration/overview) configuration.
+	 * Serverless only.
+	 */
+	isr?: {
+		/**
+		 * Expiration time (in seconds) before the cached asset will be re-generated by invoking the Serverless Function. Setting the value to `false` means it will never expire.
+		 */
+		expiration?: number | false;
+		/**
+		 * Option group number of the asset. Assets with the same group number will all be re-validated at the same time.
+		 */
+		group?: number;
+		/**
+		 * Random token that can be provided in the URL to bypass the cached version of the asset, by requesting the asset
+		 * with a __prerender_bypass=<token> cookie.
+		 *
+		 * Making a `GET` or `HEAD` request with `x-prerender-revalidate: <token>` will force the asset to be re-validated.
+		 */
+		bypassToken?: string;
+		/**
+		 * List of query string parameter names that will be cached independently. If an empty array, query values are not considered for caching. If undefined each unique query value is cached independently
+		 */
+		allowQuery?: string[] | undefined;
+	};
+}
+
+export interface EdgeConfig {
+	/**
+	 * Whether to use [Edge Functions](https://vercel.com/docs/concepts/functions/edge-functions) or [Serverless Functions](https://vercel.com/docs/concepts/functions/serverless-functions)
+	 */
+	runtime?: 'edge';
+	/**
+	 * To which regions to deploy the app. A list of regions or `'all'`.
+	 * More info: https://vercel.com/docs/concepts/edge-network/regions
+	 */
+	regions?: string[] | 'all';
+	/**
+	 * List of environment variable names that will be available for the Edge Function to utilize.
+	 * Edge only.
+	 */
+	envVarsInUse?: string[];
+	/**
+	 * List of packages that should not be bundled into the Edge Function.
+	 * Edge only.
+	 */
 	external?: string[];
+	/**
+	 * If `true`, this route will always be deployed as its own separate function
+	 */
 	split?: boolean;
-};
+}
 
-export default function plugin(options?: Options): Adapter;
+export type Config = EdgeConfig | ServerlessConfig;

package/index.js

@@ -1,17 +1,31 @@
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { nodeFileTrace } from '@vercel/nft';
 import esbuild from 'esbuild';
 
+const VALID_RUNTIMES = ['edge', 'nodejs16.x', 'nodejs18.x'];
+
+const get_default_runtime = () => {
+	const major = process.version.slice(1).split('.')[0];
+	if (major === '16') return 'nodejs16.x';
+	if (major === '18') return 'nodejs18.x';
+
+	throw new Error(
+		`Unsupported Node.js version: ${process.version}. Please use Node 16 or Node 18 to build your project, or explicitly specify a runtime in your adapter configuration.`
+	);
+};
+
 /** @type {import('.').default} **/
-const plugin = function ({ external = [], edge, split } = {}) {
+const plugin = function (defaults = {}) {
+	if ('edge' in defaults) {
+		throw new Error("{ edge: true } has been removed in favour of { runtime: 'edge' }");
+	}
+
 	return {
 		name: '@sveltejs/adapter-vercel',
 
 		async adapt(builder) {
-			const node_version = get_node_version();
-
 			const dir = '.vercel/output';
 			const tmp = builder.getBuildDirectory('vercel-tmp');
 
@@ -25,16 +39,16 @@ const plugin = function ({ external = [], edge, split } = {}) {
 				functions: `${dir}/functions`
 			};
 
-			const config = static_vercel_config(builder);
+			const static_config = static_vercel_config(builder);
 
 			builder.log.minor('Generating serverless function...');
 
 			/**
 			 * @param {string} name
-			 * @param {string} pattern
-			 * @param {(options: { relativePath: string }) => string} generate_manifest
+			 * @param {import('.').ServerlessConfig} config
+			 * @param {import('@sveltejs/kit').RouteDefinition<import('.').Config>[]} routes
 			 */
-			async function generate_serverless_function(name, pattern, generate_manifest) {
+			async function generate_serverless_function(name, config, routes) {
 				const relativePath = path.posix.relative(tmp, builder.getServerDirectory());
 
 				builder.copy(`${files}/serverless.js`, `${tmp}/index.js`, {
@@ -46,28 +60,49 @@ const plugin = function ({ external = [], edge, split } = {}) {
 
 				write(
 					`${tmp}/manifest.js`,
-					`export const manifest = ${generate_manifest({ relativePath })};\n`
+					`export const manifest = ${builder.generateManifest({ relativePath, routes })};\n`
 				);
 
 				await create_function_bundle(
 					builder,
 					`${tmp}/index.js`,
 					`${dirs.functions}/${name}.func`,
-					`nodejs${node_version.major}.x`
+					config
 				);
 
-				config.routes.push({ src: pattern, dest: `/${name}` });
+				if (config.isr) {
+					write(
+						`${dirs.functions}/${name}.prerender-config.json`,
+						JSON.stringify(
+							{
+								expiration: config.isr.expiration,
+								group: config.isr.group,
+								bypassToken: config.isr.bypassToken,
+								allowQuery: config.isr.allowQuery
+							},
+							null,
+							'\t'
+						)
+					);
+				}
 			}
 
 			/**
 			 * @param {string} name
-			 * @param {string} pattern
-			 * @param {(options: { relativePath: string }) => string} generate_manifest
+			 * @param {import('.').EdgeConfig} config
+			 * @param {import('@sveltejs/kit').RouteDefinition<import('.').EdgeConfig>[]} routes
 			 */
-			async function generate_edge_function(name, pattern, generate_manifest) {
+			async function generate_edge_function(name, config, routes) {
 				const tmp = builder.getBuildDirectory(`vercel-tmp/${name}`);
 				const relativePath = path.posix.relative(tmp, builder.getServerDirectory());
 
+				const envVarsInUse = new Set();
+				routes.forEach((route) => {
+					route.config?.envVarsInUse?.forEach((x) => {
+						envVarsInUse.add(x);
+					});
+				});
+
 				builder.copy(`${files}/edge.js`, `${tmp}/edge.js`, {
 					replace: {
 						SERVER: `${relativePath}/index.js`,
@@ -77,7 +112,7 @@ const plugin = function ({ external = [], edge, split } = {}) {
 
 				write(
 					`${tmp}/manifest.js`,
-					`export const manifest = ${generate_manifest({ relativePath })};\n`
+					`export const manifest = ${builder.generateManifest({ relativePath, routes })};\n`
 				);
 
 				await esbuild.build({
@@ -87,51 +122,122 @@ const plugin = function ({ external = [], edge, split } = {}) {
 					bundle: true,
 					platform: 'browser',
 					format: 'esm',
-					external,
+					external: config.external,
 					sourcemap: 'linked',
 					banner: { js: 'globalThis.global = globalThis;' }
 				});
 
 				write(
 					`${dirs.functions}/${name}.func/.vc-config.json`,
-					JSON.stringify({
-						runtime: 'edge',
-						entrypoint: 'index.js'
-						// TODO expose envVarsInUse
-					})
+					JSON.stringify(
+						{
+							runtime: config.runtime,
+							regions: config.regions,
+							envVarsInUse: [...envVarsInUse],
+							entrypoint: 'index.js'
+						},
+						null,
+						'\t'
+					)
 				);
+			}
+
+			/** @type {Map<string, { i: number, config: import('.').Config, routes: import('@sveltejs/kit').RouteDefinition<import('.').Config>[] }>} */
+			const groups = new Map();
+
+			/** @type {Map<string, { hash: string, route_id: string }>} */
+			const conflicts = new Map();
+
+			/** @type {Map<string, string>} */
+			const functions = new Map();
 
-				config.routes.push({ src: pattern, dest: `/${name}` });
+			// group routes by config
+			for (const route of builder.routes) {
+				if (route.prerender === true) continue;
+
+				const pattern = route.pattern.toString();
+
+				const runtime = route.config?.runtime ?? defaults?.runtime ?? get_default_runtime();
+				if (runtime && !VALID_RUNTIMES.includes(runtime)) {
+					throw new Error(
+						`Invalid runtime '${runtime}' for route ${
+							route.id
+						}. Valid runtimes are ${VALID_RUNTIMES.join(', ')}`
+					);
+				}
+
+				const config = { runtime, ...defaults, ...route.config };
+
+				const hash = hash_config(config);
+
+				// first, check there are no routes with incompatible configs that will be merged
+				const existing = conflicts.get(pattern);
+				if (existing) {
+					if (existing.hash !== hash) {
+						throw new Error(
+							`The ${route.id} and ${existing.route_id} routes must be merged into a single function that matches the ${route.pattern} regex, but they have incompatible configs. You must either rename one of the routes, or make their configs match.`
+						);
+					}
+				} else {
+					conflicts.set(pattern, { hash, route_id: route.id });
+				}
+
+				// then, create a group for each config
+				const id = config.split ? `${hash}-${groups.size}` : hash;
+				let group = groups.get(id);
+				if (!group) {
+					group = { i: groups.size, config, routes: [] };
+					groups.set(id, group);
+				}
+
+				group.routes.push(route);
 			}
 
-			const generate_function = edge ? generate_edge_function : generate_serverless_function;
-
-			if (split) {
-				await builder.createEntries((route) => {
-					return {
-						id: route.pattern.toString(), // TODO is `id` necessary?
-						filter: (other) => route.pattern.toString() === other.pattern.toString(),
-						complete: async (entry) => {
-							let sliced_pattern = route.pattern
-								.toString()
-								// remove leading / and trailing $/
-								.slice(1, -2)
-								// replace escaped \/ with /
-								.replace(/\\\//g, '/');
-
-							// replace the root route "^/" with "^/?"
-							if (sliced_pattern === '^/') {
-								sliced_pattern = '^/?';
-							}
-
-							const src = `${sliced_pattern}(?:/__data.json)?$`; // TODO adding /__data.json is a temporary workaround — those endpoints should be treated as distinct routes
-
-							await generate_function(route.id.slice(1) || 'index', src, entry.generateManifest);
-						}
-					};
-				});
-			} else {
-				await generate_function('render', '/.*', builder.generateManifest);
+			for (const group of groups.values()) {
+				const generate_function =
+					group.config.runtime === 'edge' ? generate_edge_function : generate_serverless_function;
+
+				// generate one function for the group
+				const name = `fn-${group.i}`;
+				await generate_function(
+					name,
+					/** @type {any} */ (group.config),
+					/** @type {import('@sveltejs/kit').RouteDefinition<any>[]} */ (group.routes)
+				);
+
+				if (groups.size === 1) {
+					// Special case: One function for all routes
+					static_config.routes.push({ src: '/.*', dest: `/${name}` });
+				} else {
+					for (const route of group.routes) {
+						functions.set(route.pattern.toString(), name);
+					}
+				}
+			}
+
+			for (const route of builder.routes) {
+				if (route.prerender === true) continue;
+
+				const pattern = route.pattern.toString();
+
+				let src = pattern
+					// remove leading / and trailing $/
+					.slice(1, -2)
+					// replace escaped \/ with /
+					.replace(/\\\//g, '/');
+
+				// replace the root route "^/" with "^/?"
+				if (src === '^/') {
+					src = '^/?';
+				}
+
+				src += '(?:/__data.json)?$';
+
+				const name = functions.get(pattern);
+				if (name) {
+					static_config.routes.push({ src, dest: `/${name}` });
+					functions.delete(pattern);
+				}
 			}
 
 			builder.log.minor('Copying assets...');
@@ -141,11 +247,26 @@ const plugin = function ({ external = [], edge, split } = {}) {
 
 			builder.log.minor('Writing routes...');
 
-			write(`${dir}/config.json`, JSON.stringify(config, null, '  '));
+			write(`${dir}/config.json`, JSON.stringify(static_config, null, '\t'));
 		}
 	};
 };
 
+/** @param {import('.').EdgeConfig & import('.').ServerlessConfig} config */
+function hash_config(config) {
+	return [
+		config.runtime ?? '',
+		config.external ?? '',
+		config.regions ?? '',
+		config.memory ?? '',
+		config.maxDuration ?? '',
+		config.isr?.expiration ?? '',
+		config.isr?.group ?? '',
+		config.isr?.bypassToken ?? '',
+		config.isr?.allowQuery ?? ''
+	].join('/');
+}
+
 /**
  * @param {string} file
  * @param {string} data
@@ -160,19 +281,6 @@ function write(file, data) {
 	fs.writeFileSync(file, data);
 }
 
-function get_node_version() {
-	const full = process.version.slice(1); // 'v16.5.0' --> '16.5.0'
-	const major = parseInt(full.split('.')[0]); // '16.5.0' --> 16
-
-	if (major < 16) {
-		throw new Error(
-			`SvelteKit only supports Node.js version 16 or greater (currently using v${full}). Consult the documentation: https://vercel.com/docs/runtimes#official-runtimes/node-js/node-js-version`
-		);
-	}
-
-	return { major, full };
-}
-
 // This function is duplicated in adapter-static
 /** @param {import('@sveltejs/kit').Builder} builder */
 function static_vercel_config(builder) {
@@ -193,16 +301,24 @@ function static_vercel_config(builder) {
 	}
 
 	for (const [path, page] of builder.prerendered.pages) {
-		if (path.endsWith('/') && path !== '/') {
+		let overrides_path = path.slice(1);
+
+		if (path !== '/') {
+			/** @type {string | undefined} */
+			let counterpart_route = path + '/';
+
+			if (path.endsWith('/')) {
+				counterpart_route = path.slice(0, -1);
+				overrides_path = path.slice(1, -1);
+			}
+
 			prerendered_redirects.push(
-				{ src: path, dest: path.slice(0, -1) },
-				{ src: path.slice(0, -1), status: 308, headers: { Location: path } }
+				{ src: path, dest: counterpart_route },
+				{ src: counterpart_route, status: 308, headers: { Location: path } }
 			);
-
-			overrides[page.file] = { path: path.slice(1, -1) };
-		} else {
-			overrides[page.file] = { path: path.slice(1) };
 		}
+
+		overrides[page.file] = { path: overrides_path };
 	}
 
 	return {
@@ -227,9 +343,9 @@ function static_vercel_config(builder) {
  * @param {import('@sveltejs/kit').Builder} builder
  * @param {string} entry
  * @param {string} dir
- * @param {string} runtime
+ * @param {import('.').ServerlessConfig} config
  */
-async function create_function_bundle(builder, entry, dir, runtime) {
+async function create_function_bundle(builder, entry, dir, config) {
 	fs.rmSync(dir, { force: true, recursive: true });
 
 	let base = entry;
@@ -257,7 +373,7 @@ async function create_function_bundle(builder, entry, dir, runtime) {
 				resolution_failures.set(importer, []);
 			}
 
-			resolution_failures.get(importer).push(module);
+			/** @type {string[]} */ (resolution_failures.get(importer)).push(module);
 		} else {
 			throw error;
 		}
@@ -278,7 +394,8 @@ async function create_function_bundle(builder, entry, dir, runtime) {
 	}
 
 	// find common ancestor directory
-	let common_parts;
+	/** @type {string[]} */
+	let common_parts = [];
 
 	for (const file of traced.fileList) {
 		if (common_parts) {
@@ -322,11 +439,18 @@ async function create_function_bundle(builder, entry, dir, runtime) {
 
 	write(
 		`${dir}/.vc-config.json`,
-		JSON.stringify({
-			runtime,
-			handler: path.relative(base + ancestor, entry),
-			launcherType: 'Nodejs'
-		})
+		JSON.stringify(
+			{
+				runtime: config.runtime,
+				regions: config.regions,
+				memory: config.memory,
+				maxDuration: config.maxDuration,
+				handler: path.relative(base + ancestor, entry),
+				launcherType: 'Nodejs'
+			},
+			null,
+			'\t'
+		)
 	);
 
 	write(`${dir}/package.json`, JSON.stringify({ type: 'module' }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sveltejs/adapter-vercel",
-  "version": "1.0.5",
+  "version": "2.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/sveltejs/kit",
@@ -29,10 +29,10 @@
   "devDependencies": {
     "@types/node": "^16.18.6",
     "typescript": "^4.9.4",
-    "@sveltejs/kit": "^1.1.3"
+    "@sveltejs/kit": "^1.5.0"
   },
   "peerDependencies": {
-    "@sveltejs/kit": "^1.0.0"
+    "@sveltejs/kit": "^1.5.0"
   },
   "scripts": {
     "lint": "prettier --check . --config ../../.prettierrc --ignore-path .gitignore",