autotel-mongoose 10.0.0 → 10.1.0

package/dist/index.cjs

@@ -106,6 +106,7 @@ const INSTRUMENTED_FLAG = "__autotelMongooseInstrumented";
 const WRAPPED_HOOK_FLAG = "__autotelWrappedHook";
 const WRAPPED_METHOD_FLAG = "__autotelWrappedMethod";
 const MODEL_PATCHED_FLAG = "__autotelModelPatched";
+const PROXIED_COLLECTION_FLAG = "__autotelProxiedCollection";
 /**
 * Per-Mongoose-instance registry of the resolved tracer + config.
 *
@@ -161,6 +162,98 @@ function createSpan(tracer, operation, modelName, collectionName, config) {
 	});
 }
 /**
+* Returns an idempotent finalizer for a span. Every wrapper invocation may try
+* to close its span from more than one place — a callback, an `exec()`
+* continuation, a promise settlement, a synchronous return, or a thrown error —
+* and the span must be ended exactly once. The first call wins; later calls are
+* no-ops. A non-Error rejection is normalized to an `Error`.
+*/
+function createSpanFinalizer(span) {
+	let done = false;
+	return (error) => {
+		if (done) return;
+		done = true;
+		(0, autotel_trace_helpers.finalizeSpan)(span, error === void 0 || error === null ? void 0 : error instanceof Error ? error : new Error(String(error)));
+	};
+}
+/**
+* Closes `finalize` over whatever async shape an operation returns:
+*
+* - a Mongoose Query/Aggregate (`exec()`) → wrap `exec()` so the span spans the
+*   real DB round-trip, and return the Query unchanged for further chaining;
+* - a Promise → finalize when it settles, and return the chained promise;
+* - a synchronous value → finalize now, and return it.
+*
+* This is the single settlement ladder shared by every wrapper, so the rule
+* "the span ends when the work ends" lives in exactly one place.
+*/
+function settleSpan(result, finalize) {
+	if (result && typeof result.exec === "function") {
+		const originalExec = result.exec.bind(result);
+		result.exec = function wrappedExec() {
+			try {
+				return Promise.resolve(originalExec()).then((value) => {
+					finalize();
+					return value;
+				}, (error) => {
+					finalize(error);
+					throw error;
+				});
+			} catch (error) {
+				finalize(error);
+				throw error;
+			}
+		};
+		return result;
+	}
+	if (result && typeof result.then === "function") return Promise.resolve(result).then((value) => {
+		finalize();
+		return value;
+	}, (error) => {
+		finalize(error);
+		throw error;
+	});
+	finalize();
+	return result;
+}
+/**
+* Node-convention callback support for custom methods: if the last argument is
+* a function, replace it with one that (a) runs the original callback inside the
+* span's context — so any DB calls the callback makes nest under this span — and
+* (b) finalizes the span when the callback fires, treating a truthy first
+* argument as the error. Older Mongoose code returns synchronously and does its
+* real work in such a callback (e.g. `doc.checkValidationErrors(cb)`), so the
+* span must outlive the synchronous return.
+*
+* Returns the args to call with and whether finalization was handed to a
+* callback. If there is no trailing callback, the args pass through unchanged.
+*
+* NOTE: This is the Node trailing-callback convention. Mongoose *hooks* use a
+* different convention — kareem's positional `next` — handled separately in
+* wrapHookHandler. The two are intentionally not merged: a single "find the
+* callback" rule across both would hide two genuinely different calling shapes.
+*/
+function deferFinalizeToCallback(args, span, finalize) {
+	const lastIndex = args.length - 1;
+	const maybeCallback = lastIndex >= 0 ? args[lastIndex] : void 0;
+	if (typeof maybeCallback !== "function") return {
+		callArgs: args,
+		deferred: false
+	};
+	const callArgs = [...args];
+	callArgs[lastIndex] = function tracedCallback(...callbackArgs) {
+		try {
+			return (0, autotel_trace_helpers.runWithSpan)(span, () => maybeCallback.apply(this, callbackArgs));
+		} finally {
+			finalize(callbackArgs[0]);
+		}
+	};
+	return {
+		callArgs,
+		deferred: true
+	};
+}
+/**
 * Wraps Model methods that return Query objects (find, findOne, findById,
 * findOneAndUpdate, findOneAndDelete, findOneAndReplace, deleteOne, deleteMany,
 * updateOne, updateMany, countDocuments, estimatedDocumentCount).
@@ -174,41 +267,22 @@ function wrapQueryReturningMethod(target, methodName, operation, getCollectionNa
 	target[methodName] = function instrumented(...args) {
 		const collectionName = getCollectionName(this);
 		const span = createSpan(tracer, operation, getModelName(this), collectionName, config);
+		const finalize = createSpanFinalizer(span);
 		return (0, autotel_trace_helpers.runWithSpan)(span, () => {
 			try {
 				const result = original.apply(this, args);
-				if (result && typeof result.exec === "function") {
-					try {
-						const payload = {};
-						if (typeof result.getFilter === "function") payload.condition = result.getFilter();
-						if (result._update !== void 0) payload.updates = result._update;
-						if (typeof result.getOptions === "function") payload.options = result.getOptions();
-						if (result._fields !== void 0) payload.fields = result._fields;
-						const statementText = captureStatement(operation, payload);
-						if (statementText) span.setAttribute(ATTR_DB_QUERY_TEXT, statementText);
-					} catch {}
-					const originalExec = result.exec.bind(result);
-					result.exec = function wrappedExec() {
-						try {
-							const execPromise = originalExec();
-							return Promise.resolve(execPromise).then((value) => {
-								(0, autotel_trace_helpers.finalizeSpan)(span);
-								return value;
-							}).catch((error) => {
-								(0, autotel_trace_helpers.finalizeSpan)(span, error instanceof Error ? error : new Error(String(error)));
-								throw error;
-							});
-						} catch (error) {
-							(0, autotel_trace_helpers.finalizeSpan)(span, error instanceof Error ? error : new Error(String(error)));
-							throw error;
-						}
-					};
-					return result;
-				}
-				(0, autotel_trace_helpers.finalizeSpan)(span);
-				return result;
+				if (result && typeof result.exec === "function") try {
+					const payload = {};
+					if (typeof result.getFilter === "function") payload.condition = result.getFilter();
+					if (result._update !== void 0) payload.updates = result._update;
+					if (typeof result.getOptions === "function") payload.options = result.getOptions();
+					if (result._fields !== void 0) payload.fields = result._fields;
+					const statementText = captureStatement(operation, payload);
+					if (statementText) span.setAttribute(ATTR_DB_QUERY_TEXT, statementText);
+				} catch {}
+				return settleSpan(result, finalize);
 			} catch (error) {
-				(0, autotel_trace_helpers.finalizeSpan)(span, error instanceof Error ? error : new Error(String(error)));
+				finalize(error);
 				throw error;
 			}
 		});
@@ -250,39 +324,12 @@ function wrapStaticMethod(target, methodName, operation, getCollectionName, getM
 			const statementText = captureStatement(operation, payload);
 			if (statementText) span.setAttribute(ATTR_DB_QUERY_TEXT, statementText);
 		} catch {}
+		const finalize = createSpanFinalizer(span);
 		return (0, autotel_trace_helpers.runWithSpan)(span, () => {
 			try {
-				const result = original.apply(this, args);
-				if (result && typeof result.exec === "function") {
-					const originalExec = result.exec.bind(result);
-					result.exec = function wrappedExec() {
-						try {
-							const execPromise = originalExec();
-							return Promise.resolve(execPromise).then((value) => {
-								(0, autotel_trace_helpers.finalizeSpan)(span);
-								return value;
-							}).catch((error) => {
-								(0, autotel_trace_helpers.finalizeSpan)(span, error instanceof Error ? error : new Error(String(error)));
-								throw error;
-							});
-						} catch (error) {
-							(0, autotel_trace_helpers.finalizeSpan)(span, error instanceof Error ? error : new Error(String(error)));
-							throw error;
-						}
-					};
-					return result;
-				}
-				if (result && typeof result.then === "function") return Promise.resolve(result).then((value) => {
-					(0, autotel_trace_helpers.finalizeSpan)(span);
-					return value;
-				}).catch((error) => {
-					(0, autotel_trace_helpers.finalizeSpan)(span, error instanceof Error ? error : new Error(String(error)));
-					throw error;
-				});
-				(0, autotel_trace_helpers.finalizeSpan)(span);
-				return result;
+				return settleSpan(original.apply(this, args), finalize);
 			} catch (error) {
-				(0, autotel_trace_helpers.finalizeSpan)(span, error instanceof Error ? error : new Error(String(error)));
+				finalize(error);
 				throw error;
 			}
 		});
@@ -310,20 +357,12 @@ function wrapInstanceMethod(target, methodName, operation, getCollectionName, ge
 			const statementText = captureStatement(operation, payload);
 			if (statementText) span.setAttribute(ATTR_DB_QUERY_TEXT, statementText);
 		} catch {}
+		const finalize = createSpanFinalizer(span);
 		return (0, autotel_trace_helpers.runWithSpan)(span, () => {
 			try {
-				const result = original.apply(this, args);
-				if (result && typeof result.then === "function") return Promise.resolve(result).then((value) => {
-					(0, autotel_trace_helpers.finalizeSpan)(span);
-					return value;
-				}).catch((error) => {
-					(0, autotel_trace_helpers.finalizeSpan)(span, error instanceof Error ? error : new Error(String(error)));
-					throw error;
-				});
-				(0, autotel_trace_helpers.finalizeSpan)(span);
-				return result;
+				return settleSpan(original.apply(this, args), finalize);
 			} catch (error) {
-				(0, autotel_trace_helpers.finalizeSpan)(span, error instanceof Error ? error : new Error(String(error)));
+				finalize(error);
 				throw error;
 			}
 		});
@@ -580,42 +619,24 @@ function wrapCustomFunction(original, methodName, methodType) {
 				if (params !== void 0) span.setAttribute(ATTR_MONGOOSE_METHOD_PARAMETERS, params);
 			} catch {}
 		}
+		const finalize = createSpanFinalizer(span);
 		return (0, autotel_trace_helpers.runWithSpan)(span, () => {
-			try {
+			if (methodType === "query") try {
 				const result = original.apply(this, args);
-				if (methodType === "query") {
-					(0, autotel_trace_helpers.finalizeSpan)(span);
-					return result;
-				}
-				if (result && typeof result.exec === "function") {
-					const originalExec = result.exec.bind(result);
-					result.exec = function wrappedExec() {
-						try {
-							return Promise.resolve(originalExec()).then((value) => {
-								(0, autotel_trace_helpers.finalizeSpan)(span);
-								return value;
-							}).catch((error) => {
-								(0, autotel_trace_helpers.finalizeSpan)(span, error instanceof Error ? error : new Error(String(error)));
-								throw error;
-							});
-						} catch (error) {
-							(0, autotel_trace_helpers.finalizeSpan)(span, error instanceof Error ? error : new Error(String(error)));
-							throw error;
-						}
-					};
-					return result;
-				}
-				if (result && typeof result.then === "function") return Promise.resolve(result).then((value) => {
-					(0, autotel_trace_helpers.finalizeSpan)(span);
-					return value;
-				}).catch((error) => {
-					(0, autotel_trace_helpers.finalizeSpan)(span, error instanceof Error ? error : new Error(String(error)));
-					throw error;
-				});
-				(0, autotel_trace_helpers.finalizeSpan)(span);
+				finalize();
 				return result;
 			} catch (error) {
-				(0, autotel_trace_helpers.finalizeSpan)(span, error instanceof Error ? error : new Error(String(error)));
+				finalize(error);
+				throw error;
+			}
+			const { callArgs, deferred } = deferFinalizeToCallback(args, span, finalize);
+			try {
+				const result = original.apply(this, callArgs);
+				if (result && (typeof result.exec === "function" || typeof result.then === "function")) return settleSpan(result, finalize);
+				if (!deferred) finalize();
+				return result;
+			} catch (error) {
+				finalize(error);
 				throw error;
 			}
 		});
@@ -653,20 +674,51 @@ const MONGOOSE_INTERNAL_FUNCTION_NAMES = new Set(["initializeTimestamps"]);
 function isMongooseInternalFunctionName(name) {
 	return name.startsWith("$") || MONGOOSE_INTERNAL_FUNCTION_NAMES.has(name);
 }
+/**
+* Detects a compiled Mongoose Model assigned onto a schema collection — e.g.
+* the `Patches` model attached to `schema.statics` by history/audit plugins
+* (`schema.statics.Patches = mongoose.model(...)`). A Model is a constructor
+* function carrying its own statics (`find`, `create`, …); wrapping it in a
+* plain tracing function would drop those and break callers, so it must be
+* skipped — both at the compile-time scan and on later assignment.
+*/
+function isMongooseModelLike(fn) {
+	try {
+		return typeof fn === "function" && typeof fn.modelName === "string" && fn.schema != null;
+	} catch {
+		return false;
+	}
+}
+/** Whether a value assigned to a schema collection should be wrapped. */
+function shouldWrapCustomFunction(name, value) {
+	return typeof value === "function" && !isMongooseInternalFunctionName(name) && !value[WRAPPED_METHOD_FLAG] && !isMongooseModelLike(value);
+}
 function instrumentSchemaCustomFunctions(schema) {
 	if (!schema) return;
 	const wrapCollection = (collection, methodType) => {
-		if (!collection) return;
+		if (!collection || collection[PROXIED_COLLECTION_FLAG]) return collection;
 		for (const name of Object.keys(collection)) {
-			if (isMongooseInternalFunctionName(name)) continue;
 			const fn = collection[name];
-			if (typeof fn !== "function" || fn[WRAPPED_METHOD_FLAG]) continue;
-			collection[name] = wrapCustomFunction(fn, name, methodType);
+			if (isMongooseModelLike(fn)) continue;
+			if (shouldWrapCustomFunction(name, fn)) collection[name] = wrapCustomFunction(fn, name, methodType);
+		}
+		try {
+			Object.defineProperty(collection, PROXIED_COLLECTION_FLAG, {
+				value: true,
+				enumerable: false,
+				configurable: true
+			});
+		} catch {
+			return collection;
 		}
+		return new Proxy(collection, { set(target, prop, value) {
+			target[prop] = typeof prop === "string" && shouldWrapCustomFunction(prop, value) ? wrapCustomFunction(value, prop, methodType) : value;
+			return true;
+		} });
 	};
-	wrapCollection(schema.statics, "static");
-	wrapCollection(schema.methods, "instance");
-	wrapCollection(schema.query, "query");
+	schema.statics = wrapCollection(schema.statics, "static");
+	schema.methods = wrapCollection(schema.methods, "instance");
+	schema.query = wrapCollection(schema.query, "query");
 }
 /**
 * Patches `mongoose.model()` (and `Connection.prototype.model()`) so custom