@sveltejs/kit 1.0.0-next.43 → 1.0.0-next.430

package/src/runtime/server/page/index.js

@@ -0,0 +1,416 @@
+import { negotiate } from '../../../utils/http.js';
+import { render_response } from './render.js';
+import { respond_with_error } from './respond_with_error.js';
+import { method_not_allowed, error_to_pojo, allowed_methods } from '../utils.js';
+import { create_fetch } from './fetch.js';
+import { HttpError, Redirect } from '../../../index/private.js';
+import { error, json } from '../../../index/index.js';
+import { normalize_error } from '../../../utils/error.js';
+import { load_data, load_server_data } from './load_data.js';
+
+/**
+ * @typedef {import('./types.js').Loaded} Loaded
+ * @typedef {import('types').SSRNode} SSRNode
+ * @typedef {import('types').SSROptions} SSROptions
+ * @typedef {import('types').SSRState} SSRState
+ */
+
+/**
+ * @param {import('types').RequestEvent} event
+ * @param {import('types').SSRPage} route
+ * @param {import('types').SSROptions} options
+ * @param {import('types').SSRState} state
+ * @param {import('types').RequiredResolveOptions} resolve_opts
+ * @returns {Promise<Response>}
+ */
+export async function render_page(event, route, options, state, resolve_opts) {
+	if (state.initiator === route) {
+		// infinite request cycle detected
+		return new Response(`Not found: ${event.url.pathname}`, {
+			status: 404
+		});
+	}
+
+	const accept = negotiate(event.request.headers.get('accept') || 'text/html', [
+		'text/html',
+		'application/json'
+	]);
+
+	if (
+		accept === 'application/json' &&
+		event.request.method !== 'GET' &&
+		event.request.method !== 'HEAD'
+	) {
+		const node = await options.manifest._.nodes[route.leaf]();
+		if (node.server) {
+			return handle_json_request(event, options, node.server);
+		}
+	}
+
+	const { fetcher, fetched, cookies } = create_fetch({ event, options, state, route });
+
+	try {
+		const nodes = await Promise.all([
+			// we use == here rather than === because [undefined] serializes as "[null]"
+			...route.layouts.map((n) => (n == undefined ? n : options.manifest._.nodes[n]())),
+			options.manifest._.nodes[route.leaf]()
+		]);
+
+		const leaf_node = /** @type {import('types').SSRNode} */ (nodes.at(-1));
+
+		let status = 200;
+
+		/** @type {HttpError | Error} */
+		let mutation_error;
+
+		/** @type {Record<string, string> | undefined} */
+		let validation_errors;
+
+		if (leaf_node.server && event.request.method !== 'GET' && event.request.method !== 'HEAD') {
+			// for non-GET requests, first call handler in +page.server.js
+			// (this also determines status code)
+			try {
+				const method = /** @type {'POST' | 'PATCH' | 'PUT' | 'DELETE'} */ (event.request.method);
+				const handler = leaf_node.server[method];
+				if (handler) {
+					const result = await handler.call(null, event);
+
+					if (result?.errors) {
+						validation_errors = result.errors;
+						status = result.status ?? 400;
+					}
+
+					if (event.request.method === 'POST' && result?.location) {
+						return redirect_response(303, result.location);
+					}
+				} else {
+					event.setHeaders({
+						allow: allowed_methods(leaf_node.server).join(', ')
+					});
+
+					mutation_error = error(405, 'Method not allowed');
+				}
+			} catch (e) {
+				if (e instanceof Redirect) {
+					return redirect_response(e.status, e.location);
+				}
+
+				mutation_error = /** @type {HttpError | Error} */ (e);
+			}
+		}
+
+		const should_prerender_data = nodes.some((node) => node?.server);
+		const data_pathname = `${event.url.pathname.replace(/\/$/, '')}/__data.json`;
+
+		if (!resolve_opts.ssr) {
+			return await render_response({
+				branch: [],
+				validation_errors: undefined,
+				fetched,
+				cookies,
+				page_config: {
+					hydrate: true,
+					router: true
+				},
+				status,
+				error: null,
+				event,
+				options,
+				state,
+				resolve_opts
+			});
+		}
+
+		const should_prerender =
+			leaf_node.shared?.prerender ?? leaf_node.server?.prerender ?? options.prerender.default;
+		if (should_prerender) {
+			const mod = leaf_node.server;
+			if (mod && (mod.POST || mod.PUT || mod.DELETE || mod.PATCH)) {
+				throw new Error('Cannot prerender pages that have endpoints with mutative methods');
+			}
+		} else if (state.prerendering) {
+			// if the page isn't marked as prerenderable (or is explicitly
+			// marked NOT prerenderable, if `prerender.default` is `true`),
+			// then bail out at this point
+			if (!should_prerender) {
+				return new Response(undefined, {
+					status: 204
+				});
+			}
+		}
+
+		/** @type {Array<Loaded | null>} */
+		let branch = [];
+
+		/** @type {Error | null} */
+		let load_error = null;
+
+		/** @type {Array<Promise<Record<string, any> | null>>} */
+		const server_promises = nodes.map((node, i) => {
+			if (load_error) {
+				// if an error happens immediately, don't bother with the rest of the nodes
+				throw load_error;
+			}
+
+			return Promise.resolve().then(async () => {
+				try {
+					if (node === leaf_node && mutation_error) {
+						// we wait until here to throw the error so that we can use
+						// any nested +error.svelte components that were defined
+						throw mutation_error;
+					}
+
+					return await load_server_data({
+						dev: options.dev,
+						event,
+						node,
+						parent: async () => {
+							/** @type {Record<string, any>} */
+							const data = {};
+							for (let j = 0; j < i; j += 1) {
+								Object.assign(data, await server_promises[j]);
+							}
+							return data;
+						}
+					});
+				} catch (e) {
+					load_error = /** @type {Error} */ (e);
+					throw load_error;
+				}
+			});
+		});
+
+		/** @type {Array<Promise<Record<string, any> | null>>} */
+		const load_promises = nodes.map((node, i) => {
+			if (load_error) throw load_error;
+			return Promise.resolve().then(async () => {
+				try {
+					return await load_data({
+						event,
+						fetcher,
+						node,
+						parent: async () => {
+							const data = {};
+							for (let j = 0; j < i; j += 1) {
+								Object.assign(data, await load_promises[j]);
+							}
+							return data;
+						},
+						server_data_promise: server_promises[i],
+						state
+					});
+				} catch (e) {
+					load_error = /** @type {Error} */ (e);
+					throw load_error;
+				}
+			});
+		});
+
+		// if we don't do this, rejections will be unhandled
+		for (const p of server_promises) p.catch(() => {});
+		for (const p of load_promises) p.catch(() => {});
+
+		for (let i = 0; i < nodes.length; i += 1) {
+			const node = nodes[i];
+
+			if (node) {
+				try {
+					const server_data = await server_promises[i];
+					const data = await load_promises[i];
+
+					branch.push({ node, server_data, data });
+				} catch (e) {
+					const error = normalize_error(e);
+
+					if (error instanceof Redirect) {
+						if (state.prerendering && should_prerender_data) {
+							state.prerendering.dependencies.set(data_pathname, {
+								response: new Response(undefined),
+								body: JSON.stringify({
+									type: 'redirect',
+									location: error.location
+								})
+							});
+						}
+
+						return redirect_response(error.status, error.location);
+					}
+
+					if (!(error instanceof HttpError)) {
+						options.handle_error(/** @type {Error} */ (error), event);
+					}
+
+					const status = error instanceof HttpError ? error.status : 500;
+
+					while (i--) {
+						if (route.errors[i]) {
+							const index = /** @type {number} */ (route.errors[i]);
+							const node = await options.manifest._.nodes[index]();
+
+							let j = i;
+							while (!branch[j]) j -= 1;
+
+							return await render_response({
+								event,
+								options,
+								state,
+								resolve_opts,
+								page_config: { router: true, hydrate: true },
+								status,
+								error,
+								branch: compact(branch.slice(0, j + 1)).concat({
+									node,
+									data: null,
+									server_data: null
+								}),
+								fetched,
+								cookies,
+								validation_errors: undefined
+							});
+						}
+					}
+
+					// if we're still here, it means the error happened in the root layout,
+					// which means we have to fall back to a plain text response
+					// TODO since the requester is expecting HTML, maybe it makes sense to
+					// doll this up a bit
+					return new Response(
+						error instanceof HttpError ? error.message : options.get_stack(error),
+						{ status }
+					);
+				}
+			} else {
+				// push an empty slot so we can rewind past gaps to the
+				// layout that corresponds with an +error.svelte page
+				branch.push(null);
+			}
+		}
+
+		if (state.prerendering && should_prerender_data) {
+			state.prerendering.dependencies.set(data_pathname, {
+				response: new Response(undefined),
+				body: JSON.stringify({
+					type: 'data',
+					nodes: branch.map((branch_node) => ({ data: branch_node?.server_data }))
+				})
+			});
+		}
+
+		// TODO use validation_errors
+
+		return await render_response({
+			event,
+			options,
+			state,
+			resolve_opts,
+			page_config: get_page_config(leaf_node, options),
+			status,
+			error: null,
+			branch: compact(branch),
+			validation_errors,
+			fetched,
+			cookies
+		});
+	} catch (error) {
+		// if we end up here, it means the data loaded successfull
+		// but the page failed to render
+		options.handle_error(/** @type {Error} */ (error), event);
+
+		return await respond_with_error({
+			event,
+			options,
+			state,
+			status: 500,
+			error: /** @type {Error} */ (error),
+			resolve_opts
+		});
+	}
+}
+
+/**
+ * @param {import('types').SSRNode} leaf
+ * @param {SSROptions} options
+ */
+function get_page_config(leaf, options) {
+	// TODO we can reinstate this now that it's in the module
+	if (leaf.shared && 'ssr' in leaf.shared) {
+		throw new Error(
+			'`export const ssr` has been removed — use the handle hook instead: https://kit.svelte.dev/docs/hooks#handle'
+		);
+	}
+
+	return {
+		router: leaf.shared?.router ?? options.router,
+		hydrate: leaf.shared?.hydrate ?? options.hydrate
+	};
+}
+
+/**
+ * @param {import('types').RequestEvent} event
+ * @param {import('types').SSROptions} options
+ * @param {import('types').SSRNode['server']} mod
+ */
+export async function handle_json_request(event, options, mod) {
+	const method = /** @type {'POST' | 'PUT' | 'PATCH' | 'DELETE'} */ (event.request.method);
+	const handler = mod[method];
+
+	if (!handler) {
+		return method_not_allowed(mod, method);
+	}
+
+	try {
+		// @ts-ignore
+		const result = await handler.call(null, event);
+
+		if (result?.errors) {
+			// @ts-ignore
+			return json({ errors: result.errors }, { status: result.status || 400 });
+		}
+
+		return new Response(undefined, {
+			status: 204,
+			// @ts-ignore
+			headers: result?.location ? { location: result.location } : undefined
+		});
+	} catch (e) {
+		const error = normalize_error(e);
+
+		if (error instanceof Redirect) {
+			return redirect_response(error.status, error.location);
+		}
+
+		if (!(error instanceof HttpError)) {
+			options.handle_error(error, event);
+		}
+
+		return json(error_to_pojo(error, options.get_stack), {
+			status: error instanceof HttpError ? error.status : 500
+		});
+	}
+}
+
+/**
+ * @param {number} status
+ * @param {string} location
+ */
+function redirect_response(status, location) {
+	return new Response(undefined, {
+		status,
+		headers: { location }
+	});
+}
+
+/**
+ * @template T
+ * @param {Array<T | null>} array
+ * @returns {T[]}
+ */
+function compact(array) {
+	const compacted = [];
+	for (const item of array) {
+		if (item) {
+			compacted.push(item);
+		}
+	}
+	return compacted;
+}

package/src/runtime/server/page/load_data.js

@@ -0,0 +1,135 @@
+import { LoadURL, PrerenderingURL } from '../../../utils/url.js';
+
+/**
+ * Calls the user's `load` function.
+ * @param {{
+ *   dev: boolean;
+ *   event: import('types').RequestEvent;
+ *   node: import('types').SSRNode | undefined;
+ *   parent: () => Promise<Record<string, any>>;
+ * }} opts
+ */
+export async function load_server_data({ dev, event, node, parent }) {
+	if (!node?.server) return null;
+
+	const server_data = await node.server.load?.call(null, {
+		// can't use destructuring here because it will always
+		// invoke event.clientAddress, which breaks prerendering
+		get clientAddress() {
+			return event.clientAddress;
+		},
+		locals: event.locals,
+		params: event.params,
+		parent,
+		platform: event.platform,
+		request: event.request,
+		routeId: event.routeId,
+		setHeaders: event.setHeaders,
+		url: event.url
+	});
+
+	const result = server_data ? await unwrap_promises(server_data) : null;
+
+	if (dev) {
+		check_serializability(result, /** @type {string} */ (node.server_id), 'data');
+	}
+
+	return result;
+}
+
+/**
+ * Calls the user's `load` function.
+ * @param {{
+ *   event: import('types').RequestEvent;
+ *   fetcher: typeof fetch;
+ *   node: import('types').SSRNode | undefined;
+ *   parent: () => Promise<Record<string, any>>;
+ *   server_data_promise: Promise<Record<string, any> | null>;
+ *   state: import('types').SSRState;
+ * }} opts
+ */
+export async function load_data({ event, fetcher, node, parent, server_data_promise, state }) {
+	const server_data = await server_data_promise;
+
+	if (!node?.shared?.load) {
+		return server_data;
+	}
+
+	const load_input = {
+		url: state.prerendering ? new PrerenderingURL(event.url) : new LoadURL(event.url),
+		params: event.params,
+		data: server_data,
+		routeId: event.routeId,
+		fetch: fetcher,
+		setHeaders: event.setHeaders,
+		depends: () => {},
+		parent
+	};
+
+	// TODO remove this for 1.0
+	Object.defineProperties(load_input, {
+		session: {
+			get() {
+				throw new Error(
+					'session is no longer available. See https://github.com/sveltejs/kit/discussions/5883'
+				);
+			},
+			enumerable: false
+		}
+	});
+
+	const data = await node.shared.load.call(null, load_input);
+
+	return data ? unwrap_promises(data) : null;
+}
+
+/** @param {Record<string, any>} object */
+async function unwrap_promises(object) {
+	/** @type {Record<string, any>} */
+	const unwrapped = {};
+
+	for (const key in object) {
+		unwrapped[key] = await object[key];
+	}
+
+	return unwrapped;
+}
+
+/**
+ * Check that the data can safely be serialized to JSON
+ * @param {any} value
+ * @param {string} id
+ * @param {string} path
+ */
+function check_serializability(value, id, path) {
+	const type = typeof value;
+
+	if (type === 'string' || type === 'boolean' || type === 'number' || type === 'undefined') {
+		// primitives are fine
+		return;
+	}
+
+	if (type === 'object') {
+		// nulls are fine...
+		if (!value) return;
+
+		// ...so are plain arrays...
+		if (Array.isArray(value)) {
+			value.forEach((child, i) => {
+				check_serializability(child, id, `${path}[${i}]`);
+			});
+			return;
+		}
+
+		// ...and objects
+		const tag = Object.prototype.toString.call(value);
+		if (tag === '[object Object]') {
+			for (const key in value) {
+				check_serializability(value[key], id, `${path}.${key}`);
+			}
+			return;
+		}
+	}
+
+	throw new Error(`${path} returned from 'load' in ${id} cannot be serialized as JSON`);
+}