@m1212e/rumble 0.23.9 → 0.23.11

package/out/index.mjs

@@ -1,6 +1,6 @@
 import { t as lazy } from "./lazy-C7IyM4M4.mjs";
 import { t as generateFromSchema } from "./generate-0QFVc3Sg.mjs";
-import { GraphQLError, GraphQLSchema, execute as defaultExecute, subscribe as defaultSubscribe } from "graphql";
+import { GraphQLError, GraphQLSchema, execute as defaultExecute, getOperationAST, print, subscribe as defaultSubscribe } from "graphql";
 import { EnvelopArmorPlugin } from "@escape.tech/graphql-armor";
 import { useDisableIntrospection } from "@graphql-yoga/plugin-disable-introspection";
 import { SpanStatusCode, trace } from "@opentelemetry/api";
@@ -180,7 +180,7 @@ function mapNullFieldsToUndefined(obj) {
 }
 //#endregion
 //#region package.json
-var version = "0.23.9";
+var version = "0.23.11";
 //#endregion
 //#region lib/helpers/mergeFilters.ts
 const EmptyFilter$1 = Symbol.for("drizzle:EmptyFilter");
@@ -1305,31 +1305,81 @@ const sofaOpenAPIWebhookDocs = {
 	} }
 };
 //#endregion
+//#region lib/helpers/errorLogging.ts
+function hasMessage(error) {
+	return typeof error === "object" && error !== null && "message" in error;
+}
+function toLoggedException(error) {
+	if (hasMessage(error)) {
+		const gqlError = error;
+		return {
+			"exception.type": gqlError.constructor?.name ?? gqlError.name ?? "Error",
+			"exception.message": String(gqlError.message),
+			...gqlError.stack ? { "exception.stacktrace": gqlError.stack } : {},
+			...gqlError.path ? { path: gqlError.path } : {},
+			...gqlError.extensions && Object.keys(gqlError.extensions).length > 0 ? { extensions: gqlError.extensions } : {}
+		};
+	}
+	return {
+		"exception.type": "UnknownError",
+		"exception.message": String(error)
+	};
+}
+/**
+* Every erroneous rumble log carries the same `errors` array shape,
+* whether it originates from a thrown exception (single-element array)
+* or a GraphQL `ExecutionResult.errors` list (multi-element array).
+*/
+function errorsLogField(errors) {
+	return { errors: errors.map(toLoggedException) };
+}
+function errorLogField(error) {
+	return errorsLogField([error]);
+}
+//#endregion
 //#region lib/helpers/tracing.ts
+const SUBSCRIBE_SPAN_NAME = "graphql.subscribe";
+function getOperationType(options) {
+	return getOperationAST(options.document, options.operationName)?.operation;
+}
+function operationLogFields(operationName, operationType) {
+	return {
+		"graphql.operation.name": operationName,
+		...operationType ? { "graphql.operation.type": operationType } : {}
+	};
+}
+function traceIdLogFields(span) {
+	const { traceId, spanId, traceFlags } = span.spanContext();
+	return {
+		trace_id: traceId,
+		span_id: spanId,
+		trace_flags: traceFlags.toString(16).padStart(2, "0")
+	};
+}
 function isAsyncIterable(value) {
 	return typeof value === "object" && value !== null && Symbol.asyncIterator in value;
 }
-async function* wrapSubscriptionIterator(iterator, log, operationName) {
+async function* wrapSubscriptionIterator(iterator, log, operationName, operationType) {
 	let eventCount = 0;
 	try {
 		for await (const event of iterator) {
 			eventCount++;
 			if (event.errors?.length) log.error({
-				"graphql.operation.name": operationName,
-				eventCount,
-				errors: event.errors.map((e) => e.message)
+				...operationLogFields(operationName, operationType),
+				event_count: eventCount,
+				...errorsLogField(event.errors)
 			}, "graphql subscription event error");
 			yield event;
 		}
 		log.info({
-			"graphql.operation.name": operationName,
-			eventCount
+			...operationLogFields(operationName, operationType),
+			event_count: eventCount
 		}, "graphql subscription completed");
 	} catch (error) {
 		log.error({
-			"graphql.operation.name": operationName,
-			eventCount,
-			err: error
+			...operationLogFields(operationName, operationType),
+			event_count: eventCount,
+			...errorLogField(error)
 		}, "graphql subscription threw");
 		throw error;
 	}
@@ -1338,32 +1388,28 @@ function buildTracedExecute(executeFn, rumbleInput) {
 	return async (options) => {
 		let log = rumbleInput.logger?.enabled ? rumbleInput.logger.logger : void 0;
 		const operationName = options.operationName ?? "anonymous";
+		const operationType = getOperationType(options);
 		const start = Date.now();
-		log?.info({ "graphql.operation.name": operationName }, "graphql execute start");
+		log?.info(operationLogFields(operationName, operationType), "graphql execute start");
 		const run = async () => {
 			const result = await executeFn(options);
 			if (result && "errors" in result && result.errors?.length) log?.error({
-				"graphql.operation.name": operationName,
-				durationMs: Date.now() - start,
-				errors: result.errors.map((e) => e.message)
+				...operationLogFields(operationName, operationType),
+				duration_ms: Date.now() - start,
+				...errorsLogField(result.errors)
 			}, "graphql execute completed with errors");
 			else log?.info({
-				"graphql.operation.name": operationName,
-				durationMs: Date.now() - start
+				...operationLogFields(operationName, operationType),
+				duration_ms: Date.now() - start
 			}, "graphql execute completed");
 			return result;
 		};
 		if (rumbleInput.otel?.enabled) return rumbleInput.otel.tracer.startActiveSpan(SpanNames.EXECUTE, { attributes: {
 			[AttributeNames.OPERATION_NAME]: operationName,
-			[AttributeNames.SOURCE]: options.document
+			...operationType ? { [AttributeNames.OPERATION_TYPE]: operationType } : {},
+			"graphql.document": print(options.document)
 		} }, async (span) => {
-			if (log && rumbleInput.logger?.injectTraceId !== false) {
-				const { traceId, spanId } = span.spanContext();
-				log = log.child({
-					traceId,
-					spanId
-				});
-			}
+			if (log && rumbleInput.logger?.injectTraceId !== false) log = log.child(traceIdLogFields(span));
 			try {
 				const result = await run();
 				if (result && "errors" in result && result.errors?.length) {
@@ -1374,9 +1420,9 @@ function buildTracedExecute(executeFn, rumbleInput) {
 			} catch (error) {
 				if (error instanceof Error) span.recordException(error);
 				log?.error({
-					"graphql.operation.name": operationName,
-					durationMs: Date.now() - start,
-					err: error
+					...operationLogFields(operationName, operationType),
+					duration_ms: Date.now() - start,
+					...errorLogField(error)
 				}, "graphql execute threw");
 				span.setStatus({ code: SpanStatusCode.ERROR });
 				throw error;
@@ -1388,9 +1434,9 @@ function buildTracedExecute(executeFn, rumbleInput) {
 			return await run();
 		} catch (error) {
 			log?.error({
-				"graphql.operation.name": operationName,
-				durationMs: Date.now() - start,
-				err: error
+				...operationLogFields(operationName, operationType),
+				duration_ms: Date.now() - start,
+				...errorLogField(error)
 			}, "graphql execute threw");
 			throw error;
 		}
@@ -1400,34 +1446,33 @@ function buildTracedSubscribe(subscribeFn, rumbleInput) {
 	return async (options) => {
 		let log = rumbleInput.logger?.enabled ? rumbleInput.logger.logger : void 0;
 		const operationName = options.operationName ?? "anonymous";
+		const operationType = getOperationType(options);
 		const start = Date.now();
 		const doSubscribe = async () => {
-			log?.info({ "graphql.operation.name": operationName }, "graphql subscribe start");
+			log?.info(operationLogFields(operationName, operationType), "graphql subscribe start");
 			const result = await subscribeFn(options);
 			if (!isAsyncIterable(result)) {
 				const execResult = result;
 				if (execResult.errors?.length) log?.error({
-					"graphql.operation.name": operationName,
-					durationMs: Date.now() - start,
-					errors: execResult.errors.map((e) => e.message)
+					...operationLogFields(operationName, operationType),
+					duration_ms: Date.now() - start,
+					...errorsLogField(execResult.errors)
 				}, "graphql subscribe completed with errors");
 				return execResult;
 			}
 			log?.info({
-				"graphql.operation.name": operationName,
-				durationMs: Date.now() - start
+				...operationLogFields(operationName, operationType),
+				duration_ms: Date.now() - start
 			}, "graphql subscription established");
-			if (log) return wrapSubscriptionIterator(result, log, operationName);
+			if (log) return wrapSubscriptionIterator(result, log, operationName, operationType);
 			return result;
 		};
-		if (rumbleInput.otel?.enabled) return rumbleInput.otel.tracer.startActiveSpan("graphql.subscribe", async (span) => {
-			if (log && rumbleInput.logger?.injectTraceId !== false) {
-				const { traceId, spanId } = span.spanContext();
-				log = log.child({
-					traceId,
-					spanId
-				});
-			}
+		if (rumbleInput.otel?.enabled) return rumbleInput.otel.tracer.startActiveSpan(SUBSCRIBE_SPAN_NAME, { attributes: {
+			[AttributeNames.OPERATION_NAME]: operationName,
+			...operationType ? { [AttributeNames.OPERATION_TYPE]: operationType } : {},
+			"graphql.document": print(options.document)
+		} }, async (span) => {
+			if (log && rumbleInput.logger?.injectTraceId !== false) log = log.child(traceIdLogFields(span));
 			try {
 				const result = await doSubscribe();
 				if (!isAsyncIterable(result)) {
@@ -1441,9 +1486,9 @@ function buildTracedSubscribe(subscribeFn, rumbleInput) {
 			} catch (error) {
 				if (error instanceof Error) span.recordException(error);
 				log?.error({
-					"graphql.operation.name": operationName,
-					durationMs: Date.now() - start,
-					err: error
+					...operationLogFields(operationName, operationType),
+					duration_ms: Date.now() - start,
+					...errorLogField(error)
 				}, "graphql subscribe threw");
 				span.setStatus({ code: SpanStatusCode.ERROR });
 				throw error;
@@ -1455,9 +1500,9 @@ function buildTracedSubscribe(subscribeFn, rumbleInput) {
 			return await doSubscribe();
 		} catch (error) {
 			log?.error({
-				"graphql.operation.name": operationName,
-				durationMs: Date.now() - start,
-				err: error
+				...operationLogFields(operationName, operationType),
+				duration_ms: Date.now() - start,
+				...errorLogField(error)
 			}, "graphql subscribe threw");
 			throw error;
 		}
@@ -1550,7 +1595,7 @@ async function initSearchIfApplicable(input) {
 		await input.db.execute(sql`CREATE EXTENSION IF NOT EXISTS pg_trgm;`);
 	} catch (error) {
 		const msg = "Failed to create pg_trgm extension. Search functionality may not work. Ensure the database user has CREATE privilege or the extension is pre-installed.";
-		log ? log.error({ err: error }, msg) : console.error(msg, error);
+		log ? log.error(errorLogField(error), msg) : console.error(msg, error);
 		return;
 	}
 	if (input.search?.threshold) {
@@ -2300,7 +2345,7 @@ var RuntimeFiltersPlugin = class extends BasePlugin {
 				} catch (error) {
 					this.logger?.error({
 						"graphql.field.name": fieldConfig.name,
-						err: error
+						...errorLogField(error)
 					}, "runtime filter threw");
 					throw error;
 				} finally {
@@ -2312,7 +2357,7 @@ var RuntimeFiltersPlugin = class extends BasePlugin {
 			} catch (error) {
 				this.logger?.error({
 					"graphql.field.name": fieldConfig.name,
-					err: error
+					...errorLogField(error)
 				}, "runtime filter threw");
 				throw error;
 			}
@@ -2365,13 +2410,13 @@ const createSchemaBuilder = ({ db, pubsub, pothosConfig, otel, logger }) => {
 						if (error) log.error({
 							"graphql.field.name": config.name,
 							"graphql.parent.type": config.parentType,
-							durationMs: duration,
-							err: error
+							duration_ms: duration,
+							...errorLogField(error)
 						}, "resolver failed");
 						else log.debug({
 							"graphql.field.name": config.name,
 							"graphql.parent.type": config.parentType,
-							durationMs: duration
+							duration_ms: duration
 						}, "resolver completed");
 					});
 				}