fix: ignore missing @opentelemetry/api (#14774)

.changeset/fuzzy-lies-begin.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': patch
+---
+
+fix: ignore TypeScript errors when `@opentelemetry/api` is not installed

packages/kit/scripts/generate-dts.js

@@ -15,7 +15,8 @@ await createBundle({
 		'$app/paths': 'src/runtime/app/paths/public.d.ts',
 		'$app/server': 'src/runtime/app/server/index.js',
 		'$app/state': 'src/runtime/app/state/index.js',
-		'$app/stores': 'src/runtime/app/stores.js'
+		'$app/stores': 'src/runtime/app/stores.js',
+		'@opentelemetry/api': 'src/exports/internal/otel.d.ts'
 	},
 	include: ['src']
 });

packages/kit/src/exports/internal/otel.d.ts

@@ -0,0 +1,14 @@
+/* Users may not have this package installed, this prevents errors when using `tsc` without it. */
+/* eslint-disable @typescript-eslint/no-empty-object-type */
+
+type _any = any;
+
+export interface Span extends _any {}
+
+export interface Tracer extends _any {}
+
+export interface SpanContext extends _any {}
+
+export interface PropagationAPI extends _any {}
+
+export interface ContextAPI extends _any {}

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

@@ -25,6 +25,7 @@ import {
 	LayoutParams as AppLayoutParams,
 	ResolvedPathname
 } from '$app/types';
+
 import { Span } from '@opentelemetry/api';
 
 export { PrerenderOption } from '../types/private.js';

packages/kit/src/runtime/telemetry/otel.js

@@ -1,11 +1,11 @@
-/** @import { Tracer, SpanStatusCode, PropagationAPI, ContextAPI } from '@opentelemetry/api' */
+/** @import { Tracer, PropagationAPI, ContextAPI } from '@opentelemetry/api' */
 
-/** @type {Promise<{ tracer: Tracer, SpanStatusCode: typeof SpanStatusCode, propagation: PropagationAPI, context: ContextAPI }> | null} */
+/** @type {Promise<{ tracer: Tracer, SpanStatusCode: { ERROR: number }, propagation: PropagationAPI, context: ContextAPI }> | null} */
 export let otel = null;
 
 if (__SVELTEKIT_SERVER_TRACING_ENABLED__) {
 	otel = import('@opentelemetry/api')
-		.then((module) => {
+		.then((/** @type {any} */ module) => {
 			return {
 				tracer: module.trace.getTracer('sveltekit'),
 				propagation: module.propagation,

packages/kit/src/runtime/telemetry/record_span.js

@@ -11,55 +11,59 @@ export async function record_span({ name, attributes, fn }) {
 
 	const { SpanStatusCode, tracer } = await otel;
 
-	return tracer.startActiveSpan(name, { attributes }, async (span) => {
-		try {
-			return await fn(span);
-		} catch (error) {
-			if (error instanceof HttpError) {
-				span.setAttributes({
-					[`${name}.result.type`]: 'known_error',
-					[`${name}.result.status`]: error.status,
-					[`${name}.result.message`]: error.body.message
-				});
-				if (error.status >= 500) {
+	return tracer.startActiveSpan(
+		name,
+		{ attributes },
+		async (/** @type {import('@opentelemetry/api').Span} */ span) => {
+			try {
+				return await fn(span);
+			} catch (error) {
+				if (error instanceof HttpError) {
+					span.setAttributes({
+						[`${name}.result.type`]: 'known_error',
+						[`${name}.result.status`]: error.status,
+						[`${name}.result.message`]: error.body.message
+					});
+					if (error.status >= 500) {
+						span.recordException({
+							name: 'HttpError',
+							message: error.body.message
+						});
+						span.setStatus({
+							code: SpanStatusCode.ERROR,
+							message: error.body.message
+						});
+					}
+				} else if (error instanceof Redirect) {
+					span.setAttributes({
+						[`${name}.result.type`]: 'redirect',
+						[`${name}.result.status`]: error.status,
+						[`${name}.result.location`]: error.location
+					});
+				} else if (error instanceof Error) {
+					span.setAttributes({
+						[`${name}.result.type`]: 'unknown_error'
+					});
 					span.recordException({
-						name: 'HttpError',
-						message: error.body.message
+						name: error.name,
+						message: error.message,
+						stack: error.stack
 					});
 					span.setStatus({
 						code: SpanStatusCode.ERROR,
-						message: error.body.message
+						message: error.message
 					});
+				} else {
+					span.setAttributes({
+						[`${name}.result.type`]: 'unknown_error'
+					});
+					span.setStatus({ code: SpanStatusCode.ERROR });
 				}
-			} else if (error instanceof Redirect) {
-				span.setAttributes({
-					[`${name}.result.type`]: 'redirect',
-					[`${name}.result.status`]: error.status,
-					[`${name}.result.location`]: error.location
-				});
-			} else if (error instanceof Error) {
-				span.setAttributes({
-					[`${name}.result.type`]: 'unknown_error'
-				});
-				span.recordException({
-					name: error.name,
-					message: error.message,
-					stack: error.stack
-				});
-				span.setStatus({
-					code: SpanStatusCode.ERROR,
-					message: error.message
-				});
-			} else {
-				span.setAttributes({
-					[`${name}.result.type`]: 'unknown_error'
-				});
-				span.setStatus({ code: SpanStatusCode.ERROR });
-			}
 
-			throw error;
-		} finally {
-			span.end();
+				throw error;
+			} finally {
+				span.end();
+			}
 		}
-	});
+	);
 }

packages/kit/test/apps/basics/tsconfig.json

@@ -4,7 +4,8 @@
 		"checkJs": true,
 		"esModuleInterop": true,
 		"noEmit": true,
-		"resolveJsonModule": true
+		"resolveJsonModule": true,
+		"skipLibCheck": true
 	},
 	"extends": "./.svelte-kit/tsconfig.json"
 }

packages/kit/types/index.d.ts

@@ -3371,6 +3371,25 @@ declare module '$app/stores' {
 		check(): Promise<boolean>;
 	};
 
+	export {};
+}
+
+declare module '@opentelemetry/api' {
+	/* Users may not have this package installed, this prevents errors when using `tsc` without it. */
+	/* eslint-disable @typescript-eslint/no-empty-object-type */
+
+	type _any = any;
+
+	export interface Span extends _any {}
+
+	export interface Tracer extends _any {}
+
+	export interface SpanContext extends _any {}
+
+	export interface PropagationAPI extends _any {}
+
+	export interface ContextAPI extends _any {}
+
 	export {};
 }/**
  * It's possible to tell SvelteKit how to type objects inside your app by declaring the `App` namespace. By default, a new project will have a file called `src/app.d.ts` containing the following: