feat: add universal IDs to client nodes

Author: elliott-with-the-longest-name-on-github

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

@@ -101,7 +101,7 @@ const get_defaults = (prefix = '') => ({
 		serviceWorker: {
 			register: true
 		},
-		tracing: false,
+		tracing: undefined,
 		typescript: {},
 		paths: {
 			base: '',
@@ -407,44 +407,22 @@ test('errors on loading config with incorrect default export', async () => {
 });
 
 test('accepts valid tracing values', () => {
-	// Test boolean values
 	assert.doesNotThrow(() => {
 		validate_config({
 			kit: {
-				tracing: true
-			}
-		});
-	});
-
-	assert.doesNotThrow(() => {
-		validate_config({
-			kit: {
-				tracing: false
-			}
-		});
-	});
-
-	// Test string values
-	assert.doesNotThrow(() => {
-		validate_config({
-			kit: {
-				tracing: 'server'
-			}
-		});
-	});
-
-	assert.doesNotThrow(() => {
-		validate_config({
-			kit: {
-				tracing: 'client'
+				experimental: {
+					tracing: 'server'
+				}
 			}
 		});
 	});
 
 	assert.doesNotThrow(() => {
 		validate_config({
 			kit: {
-				tracing: undefined
+				experimental: {
+					tracing: undefined
+				}
 			}
 		});
 	});
@@ -454,27 +432,33 @@ test('errors on invalid tracing values', () => {
 	assert.throws(() => {
 		validate_config({
 			kit: {
-				// @ts-expect-error - given value expected to throw
-				tracing: 'invalid'
+				experimental: {
+					// @ts-expect-error - given value expected to throw
+					tracing: true
+				}
 			}
 		});
-	}, /^config\.kit\.tracing should be true, false, "server", or "client"$/);
+	}, /^config\.kit\.tracing should be undefined or "server"$/);
 
 	assert.throws(() => {
 		validate_config({
 			kit: {
-				// @ts-expect-error - given value expected to throw
-				tracing: 42
+				experimental: {
+					// @ts-expect-error - given value expected to throw
+					tracing: false
+				}
 			}
 		});
-	}, /^config\.kit\.tracing should be true, false, "server", or "client"$/);
+	}, /^config\.kit\.tracing should be undefined or "server"$/);
 
 	assert.throws(() => {
 		validate_config({
 			kit: {
-				// @ts-expect-error - given value expected to throw
-				tracing: null
+				experimental: {
+					// @ts-expect-error - given value expected to throw
+					tracing: 'client'
+				}
 			}
 		});
-	}, /^config\.kit\.tracing should be true, false, "server", or "client"$/);
+	}, /^config\.kit\.tracing should be undefined or "server"$/);
 });

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

@@ -120,6 +120,15 @@ const options = object(
 				privatePrefix: string('')
 			}),
 
+			experimental: object({
+				tracing: validate(undefined, (input, keypath) => {
+					if (input !== 'server') {
+						throw new Error(`${keypath} should be undefined or "server"`);
+					}
+					return input;
+				})
+			}),
+
 			files: object({
 				assets: string('static'),
 				hooks: object({
@@ -270,12 +279,6 @@ const options = object(
 				files: fun((filename) => !/\.DS_Store/.test(filename))
 			}),
 
-			tracing: validate(false, (input, keypath) => {
-				if (typeof input === 'boolean') return input;
-				if (input === 'server' || input === 'client') return input;
-				throw new Error(`${keypath} should be true, false, "server", or "client"`);
-			}),
-
 			typescript: object({
 				config: fun((config) => config)
 			}),

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

@@ -174,8 +174,6 @@ export function write_client_manifest(kit, manifest_data, output, metadata) {
 
 			export const hash = ${s(kit.router.type === 'hash')};
 
-			export const tracing = ${s(kit.tracing === true || kit.tracing === 'client')};
-
 			export const decode = (type, value) => decoders[type](value);
 
 			export { default as root } from '../root.${isSvelte5Plus() ? 'js' : 'svelte'}';

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

@@ -33,6 +33,11 @@ import { set_building, set_prerendering } from '__sveltekit/environment';
 import { set_assets } from '__sveltekit/paths';
 import { set_manifest, set_read_implementation } from '__sveltekit/server';
 import { set_private_env, set_public_env, set_safe_public_env } from '${runtime_directory}/shared-server.js';
+import { get_tracer, enable_tracing } from '${runtime_directory}/telemetry/get_tracer.js';
+
+if (${s(config.kit.tracing === 'server')}) {
+	enable_tracing();
+}
 
 export const options = {
 	app_template_contains_nonce: ${template.includes('%sveltekit.nonce%')},
@@ -60,7 +65,7 @@ export const options = {
 			.replace(/%sveltekit\.status%/g, '" + status + "')
 			.replace(/%sveltekit\.error\.message%/g, '" + message + "')}
 	},
-	tracing: ${config.kit.tracing === true || config.kit.tracing === 'server'},
+	tracer: get_tracer(),
 	version_hash: ${s(hash(config.kit.version.name))}
 };
 

packages/kit/src/exports/hooks/sequence.js

@@ -1,3 +1,9 @@
+/** @import { Handle, RequestEvent, ResolveOptions } from '@sveltejs/kit' */
+/** @import { MaybePromise } from 'types' */
+import { with_event } from '../../runtime/app/server/event.js';
+import { get_tracer } from '../../runtime/telemetry/get_tracer.js';
+import { record_span } from '../../runtime/telemetry/record_span.js';
+
 /**
  * A helper function for sequencing multiple `handle` calls in a middleware-like manner.
  * The behavior for the `handle` options is as follows:
@@ -66,56 +72,76 @@
  * first post-processing
  * ```
  *
- * @param {...import('@sveltejs/kit').Handle} handlers The chain of `handle` functions
- * @returns {import('@sveltejs/kit').Handle}
+ * @param {...Handle} handlers The chain of `handle` functions
+ * @returns {Handle}
  */
 export function sequence(...handlers) {
 	const length = handlers.length;
 	if (!length) return ({ event, resolve }) => resolve(event);
 
-	return ({ event, resolve }) => {
+	return async ({ event, resolve }) => {
+		const rootSpan = /** @type {NonNullable<RequestEvent['tracing']>['rootSpan']} */ (
+			event.tracing?.rootSpan
+		);
+		const tracer = await get_tracer();
 		return apply_handle(0, event, {});
 
 		/**
 		 * @param {number} i
-		 * @param {import('@sveltejs/kit').RequestEvent} event
-		 * @param {import('@sveltejs/kit').ResolveOptions | undefined} parent_options
-		 * @returns {import('types').MaybePromise<Response>}
+		 * @param {RequestEvent} event
+		 * @param {ResolveOptions | undefined} parent_options
+		 * @returns {MaybePromise<Response>}
 		 */
 		function apply_handle(i, event, parent_options) {
 			const handle = handlers[i];
 
-			return handle({
-				event,
-				resolve: (event, options) => {
-					/** @type {import('@sveltejs/kit').ResolveOptions['transformPageChunk']} */
-					const transformPageChunk = async ({ html, done }) => {
-						if (options?.transformPageChunk) {
-							html = (await options.transformPageChunk({ html, done })) ?? '';
-						}
+			return record_span({
+				tracer,
+				name: 'sveltekit.handle.child',
+				attributes: {
+					'sveltekit.handle.child.index': i
+				},
+				fn: async (span) => {
+					const traced_event = { ...event, tracing: { rootSpan, currentSpan: span } };
+					return await with_event(traced_event, () =>
+						handle({
+							event: traced_event,
+							resolve: (event, options) => {
+								/** @type {ResolveOptions['transformPageChunk']} */
+								const transformPageChunk = async ({ html, done }) => {
+									if (options?.transformPageChunk) {
+										html = (await options.transformPageChunk({ html, done })) ?? '';
+									}
 
-						if (parent_options?.transformPageChunk) {
-							html = (await parent_options.transformPageChunk({ html, done })) ?? '';
-						}
+									if (parent_options?.transformPageChunk) {
+										html = (await parent_options.transformPageChunk({ html, done })) ?? '';
+									}
 
-						return html;
-					};
+									return html;
+								};
 
-					/** @type {import('@sveltejs/kit').ResolveOptions['filterSerializedResponseHeaders']} */
-					const filterSerializedResponseHeaders =
-						parent_options?.filterSerializedResponseHeaders ??
-						options?.filterSerializedResponseHeaders;
+								/** @type {ResolveOptions['filterSerializedResponseHeaders']} */
+								const filterSerializedResponseHeaders =
+									parent_options?.filterSerializedResponseHeaders ??
+									options?.filterSerializedResponseHeaders;
 
-					/** @type {import('@sveltejs/kit').ResolveOptions['preload']} */
-					const preload = parent_options?.preload ?? options?.preload;
+								/** @type {ResolveOptions['preload']} */
+								const preload = parent_options?.preload ?? options?.preload;
 
-					return i < length - 1
-						? apply_handle(i + 1, event, {
-								transformPageChunk,
-								filterSerializedResponseHeaders,
-								preload
-							})
-						: resolve(event, { transformPageChunk, filterSerializedResponseHeaders, preload });
+								return i < length - 1
+									? apply_handle(i + 1, event, {
+											transformPageChunk,
+											filterSerializedResponseHeaders,
+											preload
+										})
+									: resolve(event, {
+											transformPageChunk,
+											filterSerializedResponseHeaders,
+											preload
+										});
+							}
+						})
+					);
 				}
 			});
 		}

packages/kit/src/exports/public.d.ts

@@ -18,6 +18,7 @@ import {
 } from '../types/private.js';
 import { BuildData, SSRNodeLoader, SSRRoute, ValidatedConfig } from 'types';
 import type { SvelteConfig } from '@sveltejs/vite-plugin-svelte';
+import { Span } from '@opentelemetry/api';
 
 export { PrerenderOption } from '../types/private.js';
 
@@ -401,6 +402,15 @@ export interface KitConfig {
 		 */
 		privatePrefix?: string;
 	};
+	/** Experimental features. Here be dragons. Breaking changes may occur in minor releases. */
+	experimental?: {
+		/**
+		 * Whether to enable serverside OpenTelemetry tracing for SvelteKit operations including handle hooks, load functions, and form actions.
+		 * @default undefined
+		 * @since 2.22.0 // TODO: update this before publishing
+		 */
+		tracing?: 'server';
+	};
 	/**
 	 * Where to find various files within your project.
 	 */
@@ -686,16 +696,6 @@ export interface KitConfig {
 		 */
 		files?(filepath: string): boolean;
 	};
-	/**
-	 * Whether to enable OpenTelemetry tracing for SvelteKit operations including handle hooks, load functions, and form actions.
-	 * - `true` - Enable tracing for both server and client
-	 * - `false` - Disable tracing
-	 * - `'server'` - Enable tracing only on the server side
-	 * - `'client'` - Enable tracing only on the client side
-	 * @default false
-	 * @since 2.22.0
-	 */
-	tracing?: boolean | 'server' | 'client';
 	typescript?: {
 		/**
 		 * A function that allows you to edit the generated `tsconfig.json`. You can mutate the config (recommended) or return a new one.
@@ -977,6 +977,16 @@ export interface LoadEvent<
 	 * ```
 	 */
 	untrack: <T>(fn: () => T) => T;
+
+	/**
+	 * Access to spans for tracing. If tracing is not enabled, this will be `undefined`.
+	 */
+	tracing?: {
+		/** The root span for the request. This span is named `sveltekit.handle.root`. */
+		rootSpan: Span;
+		/** The span associated with the current `load` function. */
+		currentSpan: Span;
+	};
 }
 
 export interface NavigationEvent<
@@ -1252,6 +1262,16 @@ export interface RequestEvent<
 	 * `true` for `+server.js` calls coming from SvelteKit without the overhead of actually making an HTTP request. This happens when you make same-origin `fetch` requests on the server.
 	 */
 	isSubRequest: boolean;
+
+	/**
+	 * Access to spans for tracing. If tracing is not enabled, this will be `undefined`.
+	 */
+	tracing?: {
+		/** The root span for the request. This span is named `sveltekit.handle.root`. */
+		rootSpan: Span;
+		/** The span associated with the current `handle` hook, `load` function, or server action. */
+		currentSpan: Span;
+	};
 }
 
 /**
@@ -1408,6 +1428,16 @@ export interface ServerLoadEvent<
 	 * ```
 	 */
 	untrack: <T>(fn: () => T) => T;
+
+	/**
+	 * Access to spans for tracing. If tracing is not enabled, this will be `undefined`.
+	 */
+	tracing?: {
+		/** The root span for the request. This span is named `sveltekit.handle.root`. */
+		rootSpan: Span;
+		/** The span associated with the current `load` function. */
+		currentSpan: Span;
+	};
 }
 
 /**