@fluidframework/telemetry-utils 2.0.0-dev.5.2.0.169897 → 2.0.0-dev.6.4.0.191258

package/src/mockLogger.ts

@@ -3,26 +3,32 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryBaseEvent } from "@fluidframework/common-definitions";
-import { assert } from "@fluidframework/common-utils";
-import { TelemetryLogger } from "./logger";
-import { ITelemetryLoggerExt } from "./telemetryTypes";
+import {
+	ITelemetryBaseEvent,
+	ITelemetryBaseLogger,
+	LogLevel,
+} from "@fluidframework/core-interfaces";
+import { assert } from "@fluidframework/core-utils";
+import { ITelemetryLoggerExt, ITelemetryPropertiesExt } from "./telemetryTypes";
+import { createChildLogger } from "./logger";
 
 /**
  * The MockLogger records events sent to it, and then can walk back over those events
  * searching for a set of expected events to match against the logged events.
  */
-export class MockLogger extends TelemetryLogger implements ITelemetryLoggerExt {
+export class MockLogger implements ITelemetryBaseLogger {
 	events: ITelemetryBaseEvent[] = [];
 
-	constructor() {
-		super();
-	}
+	constructor(public readonly minLogLevel?: LogLevel) {}
 
-	clear() {
+	clear(): void {
 		this.events = [];
 	}
 
+	toTelemetryLogger(): ITelemetryLoggerExt {
+		return createChildLogger({ logger: this });
+	}
+
 	send(event: ITelemetryBaseEvent): void {
 		this.events.push(event);
 	}
@@ -48,12 +54,14 @@ export class MockLogger extends TelemetryLogger implements ITelemetryLoggerExt {
 		return unmatchedExpectedEventCount === 0;
 	}
 
-	/** Asserts that matchEvents is true, and prints the actual/expected output if not */
+	/**
+	 * Asserts that matchEvents is true, and prints the actual/expected output if not.
+	 */
 	assertMatch(
 		expectedEvents: Omit<ITelemetryBaseEvent, "category">[],
 		message?: string,
 		inlineDetailsProp: boolean = false,
-	) {
+	): void {
 		const actualEvents = this.events;
 		if (!this.matchEvents(expectedEvents, inlineDetailsProp)) {
 			throw new Error(`${message}
@@ -85,12 +93,14 @@ ${JSON.stringify(actualEvents)}`);
 		return matchedExpectedEventCount > 0;
 	}
 
-	/** Asserts that matchAnyEvent is true, and prints the actual/expected output if not */
+	/**
+	 * Asserts that matchAnyEvent is true, and prints the actual/expected output if not.
+	 */
 	assertMatchAny(
 		expectedEvents: Omit<ITelemetryBaseEvent, "category">[],
 		message?: string,
 		inlineDetailsProp: boolean = false,
-	) {
+	): void {
 		const actualEvents = this.events;
 		if (!this.matchAnyEvent(expectedEvents, inlineDetailsProp)) {
 			throw new Error(`${message}
@@ -120,12 +130,14 @@ ${JSON.stringify(actualEvents)}`);
 		);
 	}
 
-	/** Asserts that matchEvents is true, and prints the actual/expected output if not */
+	/**
+	 * Asserts that matchEvents is true, and prints the actual/expected output if not
+	 */
 	assertMatchStrict(
 		expectedEvents: Omit<ITelemetryBaseEvent, "category">[],
 		message?: string,
 		inlineDetailsProp: boolean = false,
-	) {
+	): void {
 		const actualEvents = this.events;
 		if (!this.matchEventStrict(expectedEvents, inlineDetailsProp)) {
 			throw new Error(`${message}
@@ -137,12 +149,14 @@ ${JSON.stringify(actualEvents)}`);
 		}
 	}
 
-	/** Asserts that matchAnyEvent is false for the given events, and prints the actual/expected output if not */
+	/**
+	 * Asserts that matchAnyEvent is false for the given events, and prints the actual/expected output if not
+	 */
 	assertMatchNone(
 		disallowedEvents: Omit<ITelemetryBaseEvent, "category">[],
 		message?: string,
 		inlineDetailsProp: boolean = false,
-	) {
+	): void {
 		const actualEvents = this.events;
 		if (this.matchAnyEvent(disallowedEvents, inlineDetailsProp)) {
 			throw new Error(`${message}
@@ -159,7 +173,7 @@ ${JSON.stringify(actualEvents)}`);
 		inlineDetailsProp: boolean,
 	): number {
 		let iExpectedEvent = 0;
-		this.events.forEach((event) => {
+		for (const event of this.events) {
 			if (
 				iExpectedEvent < expectedEvents.length &&
 				MockLogger.eventsMatch(event, expectedEvents[iExpectedEvent], inlineDetailsProp)
@@ -167,7 +181,7 @@ ${JSON.stringify(actualEvents)}`);
 				// We found the next expected event; increment
 				++iExpectedEvent;
 			}
-		});
+		}
 
 		// Remove the events so far; next call will just compare subsequent events from here
 		this.events = [];
@@ -185,19 +199,46 @@ ${JSON.stringify(actualEvents)}`);
 		inlineDetailsProp: boolean,
 	): boolean {
 		const { details, ...actualForMatching } = actual;
-		let detailsExpanded = { details };
 		// "details" is used in a lot of telemetry logs to group a bunch of properties together and stringify them.
 		// Some of the properties in the expected event may be inside "details". So, if inlineDetailsProp is true,
 		// extract the properties from "details" in the actual event and inline them in the actual event.
 		if (inlineDetailsProp && details !== undefined) {
 			assert(
 				typeof details === "string",
+				// eslint-disable-next-line unicorn/numeric-separators-style
 				0x6c9 /* Details should a JSON stringified string if inlineDetailsProp is true */,
 			);
-			detailsExpanded = JSON.parse(details);
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+			const detailsExpanded = JSON.parse(details);
+			// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+			return matchObjects({ ...actualForMatching, ...detailsExpanded }, expected);
+		}
+		return matchObjects(actual, expected);
+	}
+}
+
+function matchObjects(actual: ITelemetryPropertiesExt, expected: ITelemetryPropertiesExt): boolean {
+	for (const [expectedKey, expectedValue] of Object.entries(expected)) {
+		const actualValue = actual[expectedKey];
+		if (
+			!Array.isArray(expectedValue) &&
+			expectedValue !== null &&
+			typeof expectedValue === "object"
+		) {
+			if (
+				Array.isArray(actualValue) ||
+				actualValue === null ||
+				typeof actualValue !== "object" ||
+				!matchObjects(
+					actualValue as ITelemetryPropertiesExt,
+					expectedValue as ITelemetryPropertiesExt,
+				)
+			) {
+				return false;
+			}
+		} else if (JSON.stringify(actualValue) !== JSON.stringify(expectedValue)) {
+			return false;
 		}
-		const actualExpanded: ITelemetryBaseEvent = { ...actualForMatching, ...detailsExpanded };
-		const masked = { ...actualExpanded, ...expected };
-		return JSON.stringify(masked) === JSON.stringify(actualExpanded);
 	}
+	return true;
 }

package/src/sampledTelemetryHelper.ts

@@ -4,19 +4,22 @@
  */
 
 import {
-	IDisposable,
 	ITelemetryGenericEvent,
 	ITelemetryPerformanceEvent,
 	ITelemetryProperties,
-} from "@fluidframework/common-definitions";
-import { performance } from "@fluidframework/common-utils";
+	IDisposable,
+} from "@fluidframework/core-interfaces";
+import { performance } from "@fluid-internal/client-utils";
 import { ITelemetryLoggerExt } from "./telemetryTypes";
 
+/**
+ * @privateRemarks
+ *
+ * The names of the properties in this interface are the ones that will get stamped in the
+ * telemetry event, changes should be considered carefully. The optional properties should
+ * only be populated if 'includeAggregateMetrics' is true.
+ */
 interface Measurements {
-	// The names of the properties in this interface are the ones that will get stamped in the
-	// telemetry event, changes should be considered carefully. The optional properties should
-	// only be populated if 'includeAggregateMetrics' is true.
-
 	/**
 	 * The duration of the latest execution.
 	 */
@@ -45,7 +48,7 @@ interface Measurements {
 
 /**
  * Helper class that executes a specified code block and writes an
- * {@link @fluidframework/common-definitions#ITelemetryPerformanceEvent} to a specified logger every time a specified
+ * {@link @fluidframework/core-interfaces#ITelemetryPerformanceEvent} to a specified logger every time a specified
  * number of executions is reached (or when the class is disposed). The `duration` field in the telemetry event is
  * the duration of the latest execution (sample) of the specified function. See the documentation of the
  * `includeAggregateMetrics` parameter for additional details that can be included.
@@ -82,12 +85,13 @@ export class SampledTelemetryHelper implements IDisposable {
 	) {}
 
 	/**
-	 * @param codeToMeasure -
-	 * The code to be executed and measured.
-	 * @param bucket -
-	 * A key to track executions of the code block separately. Each different value of this parameter has a separate
-	 * set of executions and metrics tracked by the class. If no such distinction needs to be made, do not provide a
-	 * value.
+	 * Executes the specified code and keeps track of execution time statistics.
+	 * If it's been called enough times (the sampleThreshold for the class) then it generates a log message with the necessary information.
+	 *
+	 * @param codeToMeasure - The code to be executed and measured.
+	 * @param bucket - A key to track executions of the code block separately.
+	 * Each different value of this parameter has a separate set of executions and metrics tracked by the class.
+	 * If no such distinction needs to be made, do not provide a value.
 	 * @returns Whatever the passed-in code block returns.
 	 */
 	public measure<T>(codeToMeasure: () => T, bucket: string = ""): T {
@@ -116,7 +120,7 @@ export class SampledTelemetryHelper implements IDisposable {
 		return returnValue;
 	}
 
-	private flushBucket(bucket: string) {
+	private flushBucket(bucket: string): void {
 		const measurements = this.measurementsMap.get(bucket);
 		if (measurements === undefined) {
 			return;
@@ -137,6 +141,6 @@ export class SampledTelemetryHelper implements IDisposable {
 	}
 
 	public dispose(error?: Error | undefined): void {
-		this.measurementsMap.forEach((_, k) => this.flushBucket(k));
+		for (const [k] of this.measurementsMap.entries()) this.flushBucket(k);
 	}
 }

package/src/telemetryTypes.ts

@@ -3,11 +3,20 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryBaseLogger, TelemetryEventCategory } from "@fluidframework/common-definitions";
+import { ITelemetryBaseLogger, LogLevel, Tagged } from "@fluidframework/core-interfaces";
+
+/**
+ * The categories FF uses when instrumenting the code.
+ *
+ * generic - Informational log event
+ * error - Error log event, ideally 0 of these are logged during a session
+ * performance - Includes duration, and often has _start, _end, or _cancel suffixes for activity tracking
+ */
+export type TelemetryEventCategory = "generic" | "error" | "performance";
 
 /**
  * Property types that can be logged.
- * Includes extra types beyond TelemetryEventPropertyType (which will be deprecated in favor of this one)
+ * Includes extra types beyond TelemetryBaseEventPropertyType, which must be converted before sending to a base logger
  */
 export type TelemetryEventPropertyTypeExt =
 	| string
@@ -24,6 +33,8 @@ export type TelemetryEventPropertyTypeExt =
  * A property to be logged to telemetry containing both the value and a tag. Tags are generic strings that can be used
  * to mark pieces of information that should be organized or handled differently by loggers in various first or third
  * party scenarios. For example, tags are used to mark personal information that should not be stored in logs.
+ *
+ * @deprecated Use Tagged<TelemetryEventPropertyTypeExt>
  */
 export interface ITaggedTelemetryPropertyTypeExt {
 	value: TelemetryEventPropertyTypeExt;
@@ -34,7 +45,7 @@ export interface ITaggedTelemetryPropertyTypeExt {
  * JSON-serializable properties, which will be logged with telemetry.
  */
 export interface ITelemetryPropertiesExt {
-	[index: string]: TelemetryEventPropertyTypeExt | ITaggedTelemetryPropertyTypeExt;
+	[index: string]: TelemetryEventPropertyTypeExt | Tagged<TelemetryEventPropertyTypeExt>;
 }
 
 /**
@@ -83,18 +94,30 @@ export interface ITelemetryLoggerExt extends ITelemetryBaseLogger {
 	 * Send information telemetry event
 	 * @param event - Event to send
 	 * @param error - optional error object to log
+	 * @param logLevel - optional level of the log.
 	 */
-	sendTelemetryEvent(event: ITelemetryGenericEventExt, error?: any): void;
+	sendTelemetryEvent(
+		event: ITelemetryGenericEventExt,
+		error?: unknown,
+		logLevel?: typeof LogLevel.verbose | typeof LogLevel.default,
+	): void;
 
 	/**
 	 * Send error telemetry event
 	 * @param event - Event to send
+	 * @param error - optional error object to log
 	 */
-	sendErrorEvent(event: ITelemetryErrorEventExt, error?: any): void;
+	sendErrorEvent(event: ITelemetryErrorEventExt, error?: unknown): void;
 
 	/**
 	 * Send performance telemetry event
 	 * @param event - Event to send
+	 * @param error - optional error object to log
+	 * @param logLevel - optional level of the log.
 	 */
-	sendPerformanceEvent(event: ITelemetryPerformanceEventExt, error?: any): void;
+	sendPerformanceEvent(
+		event: ITelemetryPerformanceEventExt,
+		error?: unknown,
+		logLevel?: typeof LogLevel.verbose | typeof LogLevel.default,
+	): void;
 }

package/src/thresholdCounter.ts

@@ -19,7 +19,7 @@ export class ThresholdCounter {
 	/**
 	 * Sends the value if it's above the treshold.
 	 */
-	public send(eventName: string, value: number) {
+	public send(eventName: string, value: number): void {
 		if (value < this.threshold) {
 			return;
 		}
@@ -36,7 +36,7 @@ export class ThresholdCounter {
 	 * To be used in scenarios where we'd like to record a
 	 * threshold violation while reducing telemetry noise.
 	 */
-	public sendIfMultiple(eventName: string, value: number) {
+	public sendIfMultiple(eventName: string, value: number): void {
 		if (value === this.thresholdMultiple) {
 			this.logger.sendPerformanceEvent({
 				eventName,

package/src/utils.ts

@@ -6,17 +6,17 @@ import {
 	ITelemetryBaseEvent,
 	ITelemetryBaseLogger,
 	ITelemetryGenericEvent,
-} from "@fluidframework/common-definitions";
+} from "@fluidframework/core-interfaces";
 
 /**
  * Like assert, but logs only if the condition is false, rather than throwing
  * @param condition - The condition to attest too
  * @param logger - The logger to log with
  * @param event - The string or event to log
- * @returns - The outcome of the condition
+ * @returns The outcome of the condition
  */
 export function logIfFalse(
-	condition: any,
+	condition: unknown,
 	logger: ITelemetryBaseLogger,
 	event: string | ITelemetryGenericEvent,
 ): condition is true {

package/dist/debugLogger.d.ts

@@ -1,39 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ITelemetryBaseEvent, ITelemetryBaseLogger } from "@fluidframework/common-definitions";
-import { IDebugger } from "debug";
-import { TelemetryLogger, ITelemetryLoggerPropertyBags } from "./logger";
-/**
- * Implementation of debug logger
- */
-export declare class DebugLogger extends TelemetryLogger {
-    private readonly debug;
-    private readonly debugErr;
-    /**
-     * Create debug logger - all events are output to debug npm library
-     * @param namespace - Telemetry event name prefix to add to all events
-     * @param properties - Base properties to add to all events
-     * @param propertyGetters - Getters to add additional properties to all events
-     */
-    static create(namespace: string, properties?: ITelemetryLoggerPropertyBags): TelemetryLogger;
-    /**
-     * Mix in debug logger with another logger.
-     * Returned logger will output events to both newly created debug logger, as well as base logger
-     * @param namespace - Telemetry event name prefix to add to all events
-     * @param properties - Base properties to add to all events
-     * @param propertyGetters - Getters to add additional properties to all events
-     * @param baseLogger - Base logger to output events (in addition to debug logger being created). Can be undefined.
-     */
-    static mixinDebugLogger(namespace: string, baseLogger?: ITelemetryBaseLogger, properties?: ITelemetryLoggerPropertyBags): TelemetryLogger;
-    private static tryGetBaseLoggerProps;
-    constructor(debug: IDebugger, debugErr: IDebugger, properties?: ITelemetryLoggerPropertyBags);
-    /**
-     * Send an event to debug loggers
-     *
-     * @param event - the event to send
-     */
-    send(event: ITelemetryBaseEvent): void;
-}
-//# sourceMappingURL=debugLogger.d.ts.map

package/dist/debugLogger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"debugLogger.d.ts","sourceRoot":"","sources":["../src/debugLogger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,mBAAmB,EACnB,oBAAoB,EAEpB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAA0B,SAAS,EAAE,MAAM,OAAO,CAAC;AAC1D,OAAO,EACN,eAAe,EAGf,4BAA4B,EAC5B,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,qBAAa,WAAY,SAAQ,eAAe;IAiE9C,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAjE1B;;;;;OAKG;WACW,MAAM,CACnB,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,4BAA4B,GACvC,eAAe;IAqBlB;;;;;;;OAOG;WACW,gBAAgB,CAC7B,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,oBAAoB,EACjC,UAAU,CAAC,EAAE,4BAA4B,GACvC,eAAe;IAclB,OAAO,CAAC,MAAM,CAAC,qBAAqB;gBAQlB,KAAK,EAAE,SAAS,EAChB,QAAQ,EAAE,SAAS,EACpC,UAAU,CAAC,EAAE,4BAA4B;IAK1C;;;;OAIG;IACI,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;CA2C7C"}

package/dist/debugLogger.js

@@ -1,112 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DebugLogger = void 0;
-const common_utils_1 = require("@fluidframework/common-utils");
-const debug_1 = require("debug");
-const logger_1 = require("./logger");
-/**
- * Implementation of debug logger
- */
-class DebugLogger extends logger_1.TelemetryLogger {
-    constructor(debug, debugErr, properties) {
-        super(undefined, properties);
-        this.debug = debug;
-        this.debugErr = debugErr;
-    }
-    /**
-     * Create debug logger - all events are output to debug npm library
-     * @param namespace - Telemetry event name prefix to add to all events
-     * @param properties - Base properties to add to all events
-     * @param propertyGetters - Getters to add additional properties to all events
-     */
-    static create(namespace, properties) {
-        // Setup base logger upfront, such that host can disable it (if needed)
-        const debug = (0, debug_1.debug)(namespace);
-        // Create one for errors that is always enabled
-        // It can be silenced by replacing console.error if the debug namespace is not enabled.
-        const debugErr = (0, debug_1.debug)(namespace);
-        debugErr.log = function () {
-            if (debug.enabled) {
-                // if the namespace is enabled, just use the default logger
-                debug_1.debug.log(...arguments);
-            }
-            else {
-                // other wise, use the console logger (which could be replaced and silenced)
-                console.error(...arguments);
-            }
-        };
-        debugErr.enabled = true;
-        return new DebugLogger(debug, debugErr, properties);
-    }
-    /**
-     * Mix in debug logger with another logger.
-     * Returned logger will output events to both newly created debug logger, as well as base logger
-     * @param namespace - Telemetry event name prefix to add to all events
-     * @param properties - Base properties to add to all events
-     * @param propertyGetters - Getters to add additional properties to all events
-     * @param baseLogger - Base logger to output events (in addition to debug logger being created). Can be undefined.
-     */
-    static mixinDebugLogger(namespace, baseLogger, properties) {
-        if (!baseLogger) {
-            return DebugLogger.create(namespace, properties);
-        }
-        const multiSinkLogger = new logger_1.MultiSinkLogger(undefined, properties);
-        multiSinkLogger.addLogger(DebugLogger.create(namespace, this.tryGetBaseLoggerProps(baseLogger)));
-        multiSinkLogger.addLogger(logger_1.ChildLogger.create(baseLogger, namespace));
-        return multiSinkLogger;
-    }
-    static tryGetBaseLoggerProps(baseLogger) {
-        if (baseLogger instanceof logger_1.TelemetryLogger) {
-            return baseLogger.properties;
-        }
-        return undefined;
-    }
-    /**
-     * Send an event to debug loggers
-     *
-     * @param event - the event to send
-     */
-    send(event) {
-        const newEvent = this.prepareEvent(event);
-        const isError = newEvent.category === "error";
-        let logger = isError ? this.debugErr : this.debug;
-        // Use debug's coloring schema for base of the event
-        const index = event.eventName.lastIndexOf(logger_1.TelemetryLogger.eventNamespaceSeparator);
-        const name = event.eventName.substring(index + 1);
-        if (index > 0) {
-            logger = logger.extend(event.eventName.substring(0, index));
-        }
-        newEvent.eventName = undefined;
-        let tick = "";
-        tick = `tick=${logger_1.TelemetryLogger.formatTick(common_utils_1.performance.now())}`;
-        // Extract stack to put it last, but also to avoid escaping '\n' in it by JSON.stringify below
-        const stack = newEvent.stack ? newEvent.stack : "";
-        newEvent.stack = undefined;
-        // Watch out for circular references - they can come from two sources
-        // 1) error object - we do not control it and should remove it and retry
-        // 2) properties supplied by telemetry caller - that's a bug that should be addressed!
-        let payload;
-        try {
-            payload = JSON.stringify(newEvent);
-        }
-        catch (error) {
-            newEvent.error = undefined;
-            payload = JSON.stringify(newEvent);
-        }
-        if (payload === "{}") {
-            payload = "";
-        }
-        // Force errors out, to help with diagnostics
-        if (isError) {
-            logger.enabled = true;
-        }
-        // Print multi-line.
-        logger(`${name} ${payload} ${tick} ${stack}`);
-    }
-}
-exports.DebugLogger = DebugLogger;
-//# sourceMappingURL=debugLogger.js.map

package/dist/debugLogger.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"debugLogger.js","sourceRoot":"","sources":["../src/debugLogger.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,+DAA2D;AAC3D,iCAA0D;AAC1D,qCAKkB;AAElB;;GAEG;AACH,MAAa,WAAY,SAAQ,wBAAe;IAgE/C,YACkB,KAAgB,EAChB,QAAmB,EACpC,UAAyC;QAEzC,KAAK,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAJZ,UAAK,GAAL,KAAK,CAAW;QAChB,aAAQ,GAAR,QAAQ,CAAW;IAIrC,CAAC;IArED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CACnB,SAAiB,EACjB,UAAyC;QAEzC,uEAAuE;QACvE,MAAM,KAAK,GAAG,IAAA,aAAa,EAAC,SAAS,CAAC,CAAC;QAEvC,+CAA+C;QAC/C,uFAAuF;QACvF,MAAM,QAAQ,GAAG,IAAA,aAAa,EAAC,SAAS,CAAC,CAAC;QAC1C,QAAQ,CAAC,GAAG,GAAG;YACd,IAAI,KAAK,CAAC,OAAO,EAAE;gBAClB,2DAA2D;gBAC3D,aAAa,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC;aAChC;iBAAM;gBACN,4EAA4E;gBAC5E,OAAO,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,CAAC;aAC5B;QACF,CAAC,CAAC;QACF,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;QAExB,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,gBAAgB,CAC7B,SAAiB,EACjB,UAAiC,EACjC,UAAyC;QAEzC,IAAI,CAAC,UAAU,EAAE;YAChB,OAAO,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;SACjD;QAED,MAAM,eAAe,GAAG,IAAI,wBAAe,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACnE,eAAe,CAAC,SAAS,CACxB,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CACrE,CAAC;QACF,eAAe,CAAC,SAAS,CAAC,oBAAW,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC;QAErE,OAAO,eAAe,CAAC;IACxB,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,UAAiC;QACrE,IAAI,UAAU,YAAY,wBAAe,EAAE;YAC1C,OAAQ,UAAkE,CAAC,UAAU,CAAC;SACtF;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAUD;;;;OAIG;IACI,IAAI,CAAC,KAA0B;QACrC,MAAM,QAAQ,GAAyB,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAChE,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,KAAK,OAAO,CAAC;QAC9C,IAAI,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;QAElD,oDAAoD;QACpD,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,wBAAe,CAAC,uBAAuB,CAAC,CAAC;QACnF,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAClD,IAAI,KAAK,GAAG,CAAC,EAAE;YACd,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;SAC5D;QACD,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC;QAE/B,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,IAAI,GAAG,QAAQ,wBAAe,CAAC,UAAU,CAAC,0BAAW,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;QAE/D,8FAA8F;QAC9F,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACnD,QAAQ,CAAC,KAAK,GAAG,SAAS,CAAC;QAE3B,qEAAqE;QACrE,wEAAwE;QACxE,sFAAsF;QACtF,IAAI,OAAe,CAAC;QACpB,IAAI;YACH,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;SACnC;QAAC,OAAO,KAAK,EAAE;YACf,QAAQ,CAAC,KAAK,GAAG,SAAS,CAAC;YAC3B,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;SACnC;QAED,IAAI,OAAO,KAAK,IAAI,EAAE;YACrB,OAAO,GAAG,EAAE,CAAC;SACb;QAED,6CAA6C;QAC7C,IAAI,OAAO,EAAE;YACZ,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;SACtB;QAED,oBAAoB;QACpB,MAAM,CAAC,GAAG,IAAI,IAAI,OAAO,IAAI,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC;IAC/C,CAAC;CACD;AAxHD,kCAwHC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n\tITelemetryBaseEvent,\n\tITelemetryBaseLogger,\n\tITelemetryProperties,\n} from \"@fluidframework/common-definitions\";\nimport { performance } from \"@fluidframework/common-utils\";\nimport { debug as registerDebug, IDebugger } from \"debug\";\nimport {\n\tTelemetryLogger,\n\tMultiSinkLogger,\n\tChildLogger,\n\tITelemetryLoggerPropertyBags,\n} from \"./logger\";\n\n/**\n * Implementation of debug logger\n */\nexport class DebugLogger extends TelemetryLogger {\n\t/**\n\t * Create debug logger - all events are output to debug npm library\n\t * @param namespace - Telemetry event name prefix to add to all events\n\t * @param properties - Base properties to add to all events\n\t * @param propertyGetters - Getters to add additional properties to all events\n\t */\n\tpublic static create(\n\t\tnamespace: string,\n\t\tproperties?: ITelemetryLoggerPropertyBags,\n\t): TelemetryLogger {\n\t\t// Setup base logger upfront, such that host can disable it (if needed)\n\t\tconst debug = registerDebug(namespace);\n\n\t\t// Create one for errors that is always enabled\n\t\t// It can be silenced by replacing console.error if the debug namespace is not enabled.\n\t\tconst debugErr = registerDebug(namespace);\n\t\tdebugErr.log = function () {\n\t\t\tif (debug.enabled) {\n\t\t\t\t// if the namespace is enabled, just use the default logger\n\t\t\t\tregisterDebug.log(...arguments);\n\t\t\t} else {\n\t\t\t\t// other wise, use the console logger (which could be replaced and silenced)\n\t\t\t\tconsole.error(...arguments);\n\t\t\t}\n\t\t};\n\t\tdebugErr.enabled = true;\n\n\t\treturn new DebugLogger(debug, debugErr, properties);\n\t}\n\n\t/**\n\t * Mix in debug logger with another logger.\n\t * Returned logger will output events to both newly created debug logger, as well as base logger\n\t * @param namespace - Telemetry event name prefix to add to all events\n\t * @param properties - Base properties to add to all events\n\t * @param propertyGetters - Getters to add additional properties to all events\n\t * @param baseLogger - Base logger to output events (in addition to debug logger being created). Can be undefined.\n\t */\n\tpublic static mixinDebugLogger(\n\t\tnamespace: string,\n\t\tbaseLogger?: ITelemetryBaseLogger,\n\t\tproperties?: ITelemetryLoggerPropertyBags,\n\t): TelemetryLogger {\n\t\tif (!baseLogger) {\n\t\t\treturn DebugLogger.create(namespace, properties);\n\t\t}\n\n\t\tconst multiSinkLogger = new MultiSinkLogger(undefined, properties);\n\t\tmultiSinkLogger.addLogger(\n\t\t\tDebugLogger.create(namespace, this.tryGetBaseLoggerProps(baseLogger)),\n\t\t);\n\t\tmultiSinkLogger.addLogger(ChildLogger.create(baseLogger, namespace));\n\n\t\treturn multiSinkLogger;\n\t}\n\n\tprivate static tryGetBaseLoggerProps(baseLogger?: ITelemetryBaseLogger) {\n\t\tif (baseLogger instanceof TelemetryLogger) {\n\t\t\treturn (baseLogger as any as { properties: ITelemetryLoggerPropertyBags }).properties;\n\t\t}\n\t\treturn undefined;\n\t}\n\n\tconstructor(\n\t\tprivate readonly debug: IDebugger,\n\t\tprivate readonly debugErr: IDebugger,\n\t\tproperties?: ITelemetryLoggerPropertyBags,\n\t) {\n\t\tsuper(undefined, properties);\n\t}\n\n\t/**\n\t * Send an event to debug loggers\n\t *\n\t * @param event - the event to send\n\t */\n\tpublic send(event: ITelemetryBaseEvent): void {\n\t\tconst newEvent: ITelemetryProperties = this.prepareEvent(event);\n\t\tconst isError = newEvent.category === \"error\";\n\t\tlet logger = isError ? this.debugErr : this.debug;\n\n\t\t// Use debug's coloring schema for base of the event\n\t\tconst index = event.eventName.lastIndexOf(TelemetryLogger.eventNamespaceSeparator);\n\t\tconst name = event.eventName.substring(index + 1);\n\t\tif (index > 0) {\n\t\t\tlogger = logger.extend(event.eventName.substring(0, index));\n\t\t}\n\t\tnewEvent.eventName = undefined;\n\n\t\tlet tick = \"\";\n\t\ttick = `tick=${TelemetryLogger.formatTick(performance.now())}`;\n\n\t\t// Extract stack to put it last, but also to avoid escaping '\\n' in it by JSON.stringify below\n\t\tconst stack = newEvent.stack ? newEvent.stack : \"\";\n\t\tnewEvent.stack = undefined;\n\n\t\t// Watch out for circular references - they can come from two sources\n\t\t// 1) error object - we do not control it and should remove it and retry\n\t\t// 2) properties supplied by telemetry caller - that's a bug that should be addressed!\n\t\tlet payload: string;\n\t\ttry {\n\t\t\tpayload = JSON.stringify(newEvent);\n\t\t} catch (error) {\n\t\t\tnewEvent.error = undefined;\n\t\t\tpayload = JSON.stringify(newEvent);\n\t\t}\n\n\t\tif (payload === \"{}\") {\n\t\t\tpayload = \"\";\n\t\t}\n\n\t\t// Force errors out, to help with diagnostics\n\t\tif (isError) {\n\t\t\tlogger.enabled = true;\n\t\t}\n\n\t\t// Print multi-line.\n\t\tlogger(`${name} ${payload} ${tick} ${stack}`);\n\t}\n}\n"]}

package/lib/debugLogger.d.ts

@@ -1,39 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ITelemetryBaseEvent, ITelemetryBaseLogger } from "@fluidframework/common-definitions";
-import { IDebugger } from "debug";
-import { TelemetryLogger, ITelemetryLoggerPropertyBags } from "./logger";
-/**
- * Implementation of debug logger
- */
-export declare class DebugLogger extends TelemetryLogger {
-    private readonly debug;
-    private readonly debugErr;
-    /**
-     * Create debug logger - all events are output to debug npm library
-     * @param namespace - Telemetry event name prefix to add to all events
-     * @param properties - Base properties to add to all events
-     * @param propertyGetters - Getters to add additional properties to all events
-     */
-    static create(namespace: string, properties?: ITelemetryLoggerPropertyBags): TelemetryLogger;
-    /**
-     * Mix in debug logger with another logger.
-     * Returned logger will output events to both newly created debug logger, as well as base logger
-     * @param namespace - Telemetry event name prefix to add to all events
-     * @param properties - Base properties to add to all events
-     * @param propertyGetters - Getters to add additional properties to all events
-     * @param baseLogger - Base logger to output events (in addition to debug logger being created). Can be undefined.
-     */
-    static mixinDebugLogger(namespace: string, baseLogger?: ITelemetryBaseLogger, properties?: ITelemetryLoggerPropertyBags): TelemetryLogger;
-    private static tryGetBaseLoggerProps;
-    constructor(debug: IDebugger, debugErr: IDebugger, properties?: ITelemetryLoggerPropertyBags);
-    /**
-     * Send an event to debug loggers
-     *
-     * @param event - the event to send
-     */
-    send(event: ITelemetryBaseEvent): void;
-}
-//# sourceMappingURL=debugLogger.d.ts.map

package/lib/debugLogger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"debugLogger.d.ts","sourceRoot":"","sources":["../src/debugLogger.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACN,mBAAmB,EACnB,oBAAoB,EAEpB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAA0B,SAAS,EAAE,MAAM,OAAO,CAAC;AAC1D,OAAO,EACN,eAAe,EAGf,4BAA4B,EAC5B,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,qBAAa,WAAY,SAAQ,eAAe;IAiE9C,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAjE1B;;;;;OAKG;WACW,MAAM,CACnB,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,4BAA4B,GACvC,eAAe;IAqBlB;;;;;;;OAOG;WACW,gBAAgB,CAC7B,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,oBAAoB,EACjC,UAAU,CAAC,EAAE,4BAA4B,GACvC,eAAe;IAclB,OAAO,CAAC,MAAM,CAAC,qBAAqB;gBAQlB,KAAK,EAAE,SAAS,EAChB,QAAQ,EAAE,SAAS,EACpC,UAAU,CAAC,EAAE,4BAA4B;IAK1C;;;;OAIG;IACI,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;CA2C7C"}