feat: set dynamic base when rendering page (#9220)

* dynamic base

* fix failing test

* reuse base expression if possible

* minor tweaks

* shorthand

* fix

* hardcode fallbacks

* changeset

* use dynamic base path when server rendering

* use relative assets

* tidy up

* fix

* reduce indirection

* add paths.reset() function

* add paths.relative

* fix tests

* simplify

* small tweak

* update changesets

* add tests, and fix the bug revealed by the tests

* fix

* Update packages/kit/src/core/config/options.js

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

* Update packages/kit/src/runtime/server/page/render.js

Co-authored-by: Rich Harris <[email protected]>

---------

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

Author: 4 people

.changeset/few-lions-drive.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': minor
+---
+
+feat: add `paths.relative` option to control interpretation of `paths.assets` and `paths.base`

packages/kit/src/core/config/index.spec.js

@@ -98,7 +98,8 @@ const get_defaults = (prefix = '') => ({
 		typescript: {},
 		paths: {
 			base: '',
-			assets: ''
+			assets: '',
+			relative: undefined
 		},
 		prerender: {
 			concurrency: 1,
@@ -236,6 +237,7 @@ test('fails if paths.base is not root-relative', () => {
 		validate_config({
 			kit: {
 				paths: {
+					// @ts-expect-error
 					base: 'https://example.com/somewhere/else'
 				}
 			}
@@ -260,6 +262,7 @@ test('fails if paths.assets is relative', () => {
 		validate_config({
 			kit: {
 				paths: {
+					// @ts-expect-error
 					assets: 'foo'
 				}
 			}
@@ -294,8 +297,8 @@ test('fails if prerender.entries are invalid', () => {
 
 /**
  * @param {string} name
- * @param {{ base?: string, assets?: string }} input
- * @param {{ base?: string, assets?: string }} output
+ * @param {import('types').KitConfig['paths']} input
+ * @param {import('types').KitConfig['paths']} output
  */
 function validate_paths(name, input, output) {
 	test(name, () => {
@@ -317,7 +320,8 @@ validate_paths(
 	},
 	{
 		base: '/path/to/base',
-		assets: ''
+		assets: '',
+		relative: undefined
 	}
 );
 
@@ -328,7 +332,8 @@ validate_paths(
 	},
 	{
 		base: '',
-		assets: 'https://cdn.example.com'
+		assets: 'https://cdn.example.com',
+		relative: undefined
 	}
 );
 
@@ -340,7 +345,8 @@ validate_paths(
 	},
 	{
 		base: '/path/to/base',
-		assets: 'https://cdn.example.com'
+		assets: 'https://cdn.example.com',
+		relative: undefined
 	}
 );
 

packages/kit/src/core/config/options.js

@@ -171,6 +171,13 @@ const options = object(
 						}
 					}
 
+					return input;
+				}),
+				relative: validate(undefined, (input, keypath) => {
+					if (typeof input !== 'boolean') {
+						throw new Error(`${keypath} option must be a boolean or undefined`);
+					}
+
 					return input;
 				})
 			}),

packages/kit/src/core/sync/write_server.js

@@ -27,7 +27,8 @@ const server_template = ({
 }) => `
 import root from '../root.svelte';
 import { set_building } from '__sveltekit/environment';
-import { set_assets, set_private_env, set_public_env } from '${runtime_directory}/shared-server.js';
+import { set_assets } from '__sveltekit/paths';
+import { set_private_env, set_public_env } from '${runtime_directory}/shared-server.js';
 
 export const options = {
 	app_template_contains_nonce: ${template.includes('%sveltekit.nonce%')},

packages/kit/src/exports/vite/dev/index.js

@@ -451,15 +451,14 @@ export async function dev(vite, vite_config, svelte_config) {
 					await vite.ssrLoadModule(`${runtime_base}/server/index.js`)
 				);
 
-				const { set_assets, set_fix_stack_trace } =
-					/** @type {import('types').ServerInternalModule} */ (
-						await vite.ssrLoadModule(`${runtime_base}/shared-server.js`)
-					);
+				const { set_fix_stack_trace } = await vite.ssrLoadModule(
+					`${runtime_base}/shared-server.js`
+				);
+				set_fix_stack_trace(fix_stack_trace);
 
+				const { set_assets } = await vite.ssrLoadModule('__sveltekit/paths');
 				set_assets(assets);
 
-				set_fix_stack_trace(fix_stack_trace);
-
 				const server = new Server(manifest);
 
 				await server.init({ env });

packages/kit/src/exports/vite/index.js

@@ -379,17 +379,34 @@ function kit({ svelte_config }) {
 				case '\0__sveltekit/paths':
 					const { assets, base } = svelte_config.kit.paths;
 
+					// use the values defined in `global`, but fall back to hard-coded values
+					// for the sake of things like Vitest which may import this module
+					// outside the context of a page
 					if (browser) {
-						return `export const base = ${s(base)};
-export const assets = ${global}.assets;`;
+						return `export const base = ${global}?.base ?? ${s(base)};
+export const assets = ${global}?.assets ?? ${assets ? s(assets) : 'base'};`;
 					}
 
-					return `export const base = ${s(base)};
+					return `export let base = ${s(base)};
 export let assets = ${assets ? s(assets) : 'base'};
 
+export const relative = ${svelte_config.kit.paths.relative};
+
+const initial = { base, assets };
+
+export function override(paths) {
+	base = paths.base;
+	assets = paths.assets;
+}
+
+export function reset() {
+	base = initial.base;
+	assets = initial.assets;
+}
+
 /** @param {string} path */
 export function set_assets(path) {
-	assets = path;
+	assets = initial.assets = path;
 }`;
 
 				case '\0__sveltekit/environment':

packages/kit/src/internal.d.ts

@@ -7,7 +7,10 @@ declare module '__sveltekit/environment' {
 
 /** Internal version of $app/paths */
 declare module '__sveltekit/paths' {
-	export const base: `/${string}`;
-	export let assets: `https://${string}` | `http://${string}`;
+	export let base: '' | `/${string}`;
+	export let assets: '' | `https://${string}` | `http://${string}` | '/_svelte_kit_assets';
+	export let relative: boolean | undefined; // TODO in 2.0, make this a `boolean` that defaults to `true`
+	export function reset(): void;
+	export function override(paths: { base: string; assets: string }): void;
 	export function set_assets(path: string): void;
 }

packages/kit/src/runtime/server/page/render.js

@@ -1,7 +1,7 @@
 import * as devalue from 'devalue';
 import { readable, writable } from 'svelte/store';
 import { DEV } from 'esm-env';
-import { assets, base } from '__sveltekit/paths';
+import * as paths from '__sveltekit/paths';
 import { hash } from '../../hash.js';
 import { serialize_data } from './serialize_data.js';
 import { s } from '../../../utils/misc.js';
@@ -11,6 +11,7 @@ import { clarify_devalue_error, stringify_uses, handle_error_and_jsonify } from
 import { public_env } from '../../shared-server.js';
 import { text } from '../../../exports/index.js';
 import { create_async_iterator } from '../../../utils/streaming.js';
+import { SVELTE_KIT_ASSETS } from '../../../constants.js';
 
 // TODO rename this function/module
 
@@ -80,6 +81,43 @@ export async function render_response({
 			? action_result.data ?? null
 			: null;
 
+	/** @type {string} */
+	let base = paths.base;
+
+	/** @type {string} */
+	let assets = paths.assets;
+
+	/**
+	 * An expression that will evaluate in the client to determine the resolved base path.
+	 * We use a relative path when possible to support IPFS, the internet archive, etc.
+	 */
+	let base_expression = s(paths.base);
+
+	// if appropriate, use relative paths for greater portability
+	if (paths.relative !== false && !state.prerendering?.fallback) {
+		const segments = event.url.pathname.slice(paths.base.length).split('/');
+
+		if (segments.length === 1 && paths.base !== '') {
+			// if we're on `/my-base-path`, relative links need to start `./my-base-path` rather than `.`
+			base = `./${paths.base.split('/').at(-1)}`;
+
+			base_expression = `new URL(${s(base)}, location).pathname`;
+		} else {
+			base =
+				segments
+					.slice(2)
+					.map(() => '..')
+					.join('/') || '.';
+
+			// resolve e.g. '../..' against current location, then remove trailing slash
+			base_expression = `new URL(${s(base)}, location).pathname.slice(0, -1)`;
+		}
+
+		if (!paths.assets || (paths.assets[0] === '/' && paths.assets !== SVELTE_KIT_ASSETS)) {
+			assets = base;
+		}
+	}
+
 	if (page_config.ssr) {
 		if (__SVELTEKIT_DEV__ && !branch.at(-1)?.node.component) {
 			// Can only be the leaf, layouts have a fallback component generated
@@ -116,6 +154,10 @@ export async function render_response({
 			form: form_value
 		};
 
+		// use relative paths during rendering, so that the resulting HTML is as
+		// portable as possible, but reset afterwards
+		if (paths.relative) paths.override({ base, assets });
+
 		if (__SVELTEKIT_DEV__) {
 			const fetch = globalThis.fetch;
 			let warned = false;
@@ -138,9 +180,14 @@ export async function render_response({
 				rendered = options.root.render(props);
 			} finally {
 				globalThis.fetch = fetch;
+				paths.reset();
 			}
 		} else {
-			rendered = options.root.render(props);
+			try {
+				rendered = options.root.render(props);
+			} finally {
+				paths.reset();
+			}
 		}
 
 		for (const { node } of branch) {
@@ -156,35 +203,6 @@ export async function render_response({
 		rendered = { head: '', html: '', css: { code: '', map: null } };
 	}
 
-	/**
-	 * The prefix to use for static assets. Replaces `%sveltekit.assets%` in the template
-	 * @type {string}
-	 */
-	let resolved_assets;
-
-	/**
-	 * An expression that will evaluate in the client to determine the resolved asset path
-	 */
-	let asset_expression;
-
-	if (assets) {
-		// if an asset path is specified, use it
-		resolved_assets = assets;
-		asset_expression = s(assets);
-	} else if (state.prerendering?.fallback) {
-		// if we're creating a fallback page, asset paths need to be root-relative
-		resolved_assets = base;
-		asset_expression = s(base);
-	} else {
-		// otherwise we want asset paths to be relative to the page, so that they
-		// will work in odd contexts like IPFS, the internet archive, and so on
-		const segments = event.url.pathname.slice(base.length).split('/').slice(2);
-		resolved_assets = segments.length > 0 ? segments.map(() => '..').join('/') : '.';
-		asset_expression = `new URL(${s(
-			resolved_assets
-		)}, location.href).pathname.replace(/^\\\/$/, '')`;
-	}
-
 	let head = '';
 	let body = rendered.html;
 
@@ -198,9 +216,9 @@ export async function render_response({
 			// Vite makes the start script available through the base path and without it.
 			// We load it via the base path in order to support remote IDE environments which proxy
 			// all URLs under the base path during development.
-			return base + path;
+			return paths.base + path;
 		}
-		return `${resolved_assets}/${path}`;
+		return `${assets}/${path}`;
 	};
 
 	if (inline_styles.size > 0) {
@@ -286,9 +304,10 @@ export async function render_response({
 
 		const properties = [
 			`env: ${s(public_env)}`,
-			`assets: ${asset_expression}`,
+			paths.assets && `assets: ${s(paths.assets)}`,
+			`base: ${base_expression}`,
 			`element: document.currentScript.parentElement`
-		];
+		].filter(Boolean);
 
 		if (chunks) {
 			blocks.push(`const deferred = new Map();`);
@@ -419,7 +438,7 @@ export async function render_response({
 	const html = options.templates.app({
 		head,
 		body,
-		assets: resolved_assets,
+		assets,
 		nonce: /** @type {string} */ (csp.nonce),
 		env: public_env
 	});

packages/kit/src/runtime/shared-server.js

@@ -1,5 +1,3 @@
-export { set_assets } from '__sveltekit/paths';
-
 /** @type {Record<string, string>} */
 export let private_env = {};
 

packages/kit/test/apps/basics/src/routes/paths/deeply/nested/+page.svelte

@@ -0,0 +1,5 @@
+<script>
+	import { base, assets } from '$app/paths';
+</script>
+
+<pre>{JSON.stringify({ base, assets })}</pre>