@loglayer/mixin-wide-events 1.2.0 → 1.3.0

package/dist/index.mjs

@@ -1,39 +1,4 @@
-//#region ../../core/plugin/dist/index.js
-/**
-* List of plugin callbacks that can be called by the plugin manager.
-*
-* @see {@link https://loglayer.dev/plugins/creating-plugins.html#transformloglevel | transformLogLevel Docs}
-* @see {@link https://loglayer.dev/plugins/creating-plugins.html#onbeforedataout | onBeforeDataOut Docs}
-* @see {@link https://loglayer.dev/plugins/creating-plugins.html#shouldsendtologger | shouldSendToLogger Docs}
-* @see {@link https://loglayer.dev/plugins/creating-plugins.html#onmetadatacalled | onMetadataCalled Docs}
-* @see {@link https://loglayer.dev/plugins/creating-plugins.html#onbeforemessageout | onBeforeMessageOut Docs}
-* @see {@link https://loglayer.dev/plugins/creating-plugins.html#oncontextcalled | onContextCalled Docs}
-*/
-let PluginCallbackType = /* @__PURE__ */ function(PluginCallbackType) {
-	PluginCallbackType["transformLogLevel"] = "transformLogLevel";
-	PluginCallbackType["onBeforeDataOut"] = "onBeforeDataOut";
-	PluginCallbackType["shouldSendToLogger"] = "shouldSendToLogger";
-	PluginCallbackType["onMetadataCalled"] = "onMetadataCalled";
-	PluginCallbackType["onBeforeMessageOut"] = "onBeforeMessageOut";
-	PluginCallbackType["onContextCalled"] = "onContextCalled";
-	return PluginCallbackType;
-}({});
-PluginCallbackType.onBeforeDataOut, PluginCallbackType.onMetadataCalled, PluginCallbackType.onBeforeMessageOut, PluginCallbackType.transformLogLevel, PluginCallbackType.shouldSendToLogger, PluginCallbackType.onContextCalled;
-/**
-* The class that the mixin extends
-*/
-let LogLayerMixinAugmentType = /* @__PURE__ */ function(LogLayerMixinAugmentType) {
-	/**
-	* Mixin extends the LogBuilder prototype
-	*/
-	LogLayerMixinAugmentType["LogBuilder"] = "LogBuilder";
-	/**
-	* Mixin extends the LogLayer prototype
-	*/
-	LogLayerMixinAugmentType["LogLayer"] = "LogLayer";
-	return LogLayerMixinAugmentType;
-}({});
-//#endregion
+import { LogLayerMixinAugmentType } from "loglayer";
 //#region src/mixin.ts
 /**
 * Log levels that default to rate=1 (error/fatal) — can be overridden via `perLevel` or callback.
@@ -128,7 +93,8 @@ function createWideEventMixin(options) {
 		rate: options.sampling.rate,
 		perLevel: snapshotPerLevel,
 		emitLevel: options.sampling.emitLevel,
-		shouldEmit: options.sampling.shouldEmit
+		shouldEmit: options.sampling.shouldEmit,
+		forceKeep: options.sampling.forceKeep
 	} : void 0;
 	function defaultErrorSerializer(err) {
 		if (err instanceof Error) return {
@@ -223,23 +189,59 @@ function createWideEventMixin(options) {
 		return self;
 	}
 	/**
+	* Logs a thrown sampling callback via console.error, gated on `consoleDebug`.
+	* Matches loglayer's emit-path error convention (see LogLayer.ts:1457).
+	*/
+	function logCallbackError(callbackName, err, self) {
+		if (self.getConfig?.()?.consoleDebug) console.error(`[LogLayer] wide-events ${callbackName} callback threw; falling back:`, err);
+	}
+	/**
+	* Single sampling decision for an emit. Only called when a `forceKeep` or
+	* `shouldEmit` callback is configured (the no-callback case is handled by the
+	* pre-build fast-path in emitWideEventImpl).
+	*
+	* - `forceKeep` runs first (OR logic): true → keep; throws → fail-safe (log +
+	*   fall through); false → fall through.
+	* - Standard logic: rate AND `shouldEmit` (shouldEmit throws → fail-open, log
+	*   + keep). Without `shouldEmit`, rate alone decides.
+	*
+	* Invokes `runRateSampling` at most once.
+	*/
+	function evaluateSampling(wideData, level, self) {
+		if (samplingConfig?.forceKeep) try {
+			if (samplingConfig.forceKeep({
+				wideData,
+				level
+			})) return true;
+		} catch (err) {
+			logCallbackError("forceKeep", err, self);
+		}
+		if (samplingConfig?.shouldEmit) try {
+			const callbackOk = samplingConfig.shouldEmit({
+				wideData,
+				level
+			});
+			return runRateSampling(level, samplingConfig.strategy, samplingConfig.rate, samplingConfig.perLevel) && callbackOk;
+		} catch (err) {
+			logCallbackError("shouldEmit", err, self);
+			return true;
+		}
+		return runRateSampling(level, samplingConfig?.strategy, samplingConfig?.rate, samplingConfig?.perLevel);
+	}
+	/**
 	* Implementation for emitWideEvent
 	*/
 	function emitWideEventImpl(config, self) {
 		const defaultLevel = samplingConfig?.emitLevel ?? "info";
 		const level = config.level ?? defaultLevel;
-		if (samplingConfig && !samplingConfig.shouldEmit && !runRateSampling(level, samplingConfig.strategy, samplingConfig.rate, samplingConfig.perLevel)) return;
+		if (samplingConfig && !samplingConfig.shouldEmit && !samplingConfig.forceKeep && !runRateSampling(level, samplingConfig.strategy, samplingConfig.rate, samplingConfig.perLevel)) return;
 		const store = asyncContext.getStore();
 		const wideEventData = {};
 		if (includeContext && store?._llContext) Object.assign(wideEventData, store._llContext);
 		if (store?._llWideEvents) Object.assign(wideEventData, store._llWideEvents);
-		if (samplingConfig?.shouldEmit) try {
-			const callbackOk = samplingConfig.shouldEmit({
-				wideData: wideEventData,
-				level
-			});
-			if (!runRateSampling(level, samplingConfig.strategy, samplingConfig.rate, samplingConfig.perLevel) || !callbackOk) return;
-		} catch {}
+		if (samplingConfig && (samplingConfig.forceKeep || samplingConfig.shouldEmit)) {
+			if (!evaluateSampling(wideEventData, level, self)) return;
+		}
 		const metadataToEmit = wideEventField ? { [wideEventField]: wideEventData } : wideEventData;
 		self.raw({
 			logLevel: level,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@loglayer/mixin-wide-events",
   "description": "Adds wide event logging functionality to LogLayer for comprehensive, self-contained log entries.",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -41,7 +41,9 @@
     "@loglayer/shared": "4.3.0",
     "loglayer": "9.3.0"
   },
-  "peerDependencies": {},
+  "peerDependencies": {
+    "loglayer": ">=9.0.0"
+  },
   "bugs": "https://github.com/loglayer/loglayer/issues",
   "files": [
     "dist"