@fluidframework/telemetry-utils 2.0.0-internal.3.0.1 → 2.0.0-internal.3.1.0

package/src/eventEmitterWithErrorHandling.ts

@@ -10,17 +10,21 @@ import { TypedEventEmitter, EventEmitterEventType } from "@fluidframework/common
  * Any exceptions thrown by listeners will be caught and raised through "error" event.
  * Any exception thrown by "error" listeners will propagate to the caller.
  */
-export class EventEmitterWithErrorHandling<TEvent extends IEvent = IEvent> extends TypedEventEmitter<TEvent> {
-    constructor(private readonly errorHandler: (eventName: EventEmitterEventType, error: any) => void) {
-        super();
-    }
+export class EventEmitterWithErrorHandling<
+	TEvent extends IEvent = IEvent,
+> extends TypedEventEmitter<TEvent> {
+	constructor(
+		private readonly errorHandler: (eventName: EventEmitterEventType, error: any) => void,
+	) {
+		super();
+	}
 
-    public emit(event: EventEmitterEventType, ...args: any[]): boolean {
-        try {
-            return super.emit(event, ...args);
-        } catch (error) {
-            this.errorHandler(event, error);
-            return true;
-        }
-    }
+	public emit(event: EventEmitterEventType, ...args: any[]): boolean {
+		try {
+			return super.emit(event, ...args);
+		} catch (error) {
+			this.errorHandler(event, error);
+			return true;
+		}
+	}
 }

package/src/events.ts

@@ -4,23 +4,22 @@
  */
 
 import { EventEmitter } from "events";
-import {
-    ITelemetryLogger,
-} from "@fluidframework/common-definitions";
+import { ITelemetryLogger } from "@fluidframework/common-definitions";
 
 export const connectedEventName = "connected";
 export const disconnectedEventName = "disconnected";
 
 export function safeRaiseEvent(
-    emitter: EventEmitter,
-    logger: ITelemetryLogger,
-    event: string,
-    ...args) {
-    try {
-        emitter.emit(event, ...args);
-    } catch (error) {
-        logger.sendErrorEvent({ eventName: "RaiseEventError", event }, error);
-    }
+	emitter: EventEmitter,
+	logger: ITelemetryLogger,
+	event: string,
+	...args
+) {
+	try {
+		emitter.emit(event, ...args);
+	} catch (error) {
+		logger.sendErrorEvent({ eventName: "RaiseEventError", event }, error);
+	}
 }
 
 /**
@@ -32,18 +31,19 @@ export function safeRaiseEvent(
  * @param disconnectedReason - The reason for the connection to be disconnected (Used for telemetry purposes only)
  */
 export function raiseConnectedEvent(
-    logger: ITelemetryLogger,
-    emitter: EventEmitter,
-    connected: boolean,
-    clientId?: string,
-    disconnectedReason?: string) {
-    try {
-        if (connected) {
-            emitter.emit(connectedEventName, clientId);
-        } else {
-            emitter.emit(disconnectedEventName, disconnectedReason);
-        }
-    } catch (error) {
-        logger.sendErrorEvent({ eventName: "RaiseConnectedEventError" }, error);
-    }
+	logger: ITelemetryLogger,
+	emitter: EventEmitter,
+	connected: boolean,
+	clientId?: string,
+	disconnectedReason?: string,
+) {
+	try {
+		if (connected) {
+			emitter.emit(connectedEventName, clientId);
+		} else {
+			emitter.emit(disconnectedEventName, disconnectedReason);
+		}
+	} catch (error) {
+		logger.sendErrorEvent({ eventName: "RaiseConnectedEventError" }, error);
+	}
 }

package/src/fluidErrorBase.ts

@@ -11,53 +11,57 @@ import { ITelemetryProperties } from "@fluidframework/common-definitions";
  * and a getter/setter for telemetry props to be included when the error is logged.
  */
 export interface IFluidErrorBase extends Error {
-    /** Classification of what type of error this is, used programmatically by consumers to interpret the error */
-    readonly errorType: string;
-
-    /**
-     * Error's message property, made readonly.
-     * Be specific, but also take care when including variable data to consider suitability for aggregation in telemetry
-     * Also avoid including any data that jeopardizes the user's privacy.  Add a tagged telemetry property instead.
-     */
-    readonly message: string;
-
-    /** Error's stack property, made readonly */
-    readonly stack?: string;
-
-    /** Error's name property, made readonly */
-    readonly name: string;
-
-    /**
-     * A Guid identifying this error instance.
-     * Useful in telemetry for deduping multiple logging events arising from the same error,
-     * or correlating an error with an inner error that caused it, in case of error wrapping.
-     */
-    readonly errorInstanceId: string;
-
-    /** Get the telemetry properties stashed on this error for logging */
-    getTelemetryProperties(): ITelemetryProperties;
-    /** Add telemetry properties to this error which will be logged with the error */
-    addTelemetryProperties: (props: ITelemetryProperties) => void;
+	/** Classification of what type of error this is, used programmatically by consumers to interpret the error */
+	readonly errorType: string;
+
+	/**
+	 * Error's message property, made readonly.
+	 * Be specific, but also take care when including variable data to consider suitability for aggregation in telemetry
+	 * Also avoid including any data that jeopardizes the user's privacy.  Add a tagged telemetry property instead.
+	 */
+	readonly message: string;
+
+	/** Error's stack property, made readonly */
+	readonly stack?: string;
+
+	/** Error's name property, made readonly */
+	readonly name: string;
+
+	/**
+	 * A Guid identifying this error instance.
+	 * Useful in telemetry for deduping multiple logging events arising from the same error,
+	 * or correlating an error with an inner error that caused it, in case of error wrapping.
+	 */
+	readonly errorInstanceId: string;
+
+	/** Get the telemetry properties stashed on this error for logging */
+	getTelemetryProperties(): ITelemetryProperties;
+	/** Add telemetry properties to this error which will be logged with the error */
+	addTelemetryProperties: (props: ITelemetryProperties) => void;
 }
 
 const hasTelemetryPropFunctions = (x: any): boolean =>
-    typeof x?.getTelemetryProperties === "function" &&
-    typeof x?.addTelemetryProperties === "function";
+	typeof x?.getTelemetryProperties === "function" &&
+	typeof x?.addTelemetryProperties === "function";
 
-export const hasErrorInstanceId = (x: any): x is { errorInstanceId: string; } =>
-    typeof x?.errorInstanceId === "string";
+export const hasErrorInstanceId = (x: any): x is { errorInstanceId: string } =>
+	typeof x?.errorInstanceId === "string";
 
 /** type guard for IFluidErrorBase interface */
 export function isFluidError(e: any): e is IFluidErrorBase {
-    return typeof e?.errorType === "string" &&
-        typeof e?.message === "string" &&
-        hasErrorInstanceId(e) &&
-        hasTelemetryPropFunctions(e);
+	return (
+		typeof e?.errorType === "string" &&
+		typeof e?.message === "string" &&
+		hasErrorInstanceId(e) &&
+		hasTelemetryPropFunctions(e)
+	);
 }
 
 /** type guard for old standard of valid/known errors */
 export function isValidLegacyError(e: any): e is Omit<IFluidErrorBase, "errorInstanceId"> {
-    return typeof e?.errorType === "string" &&
-        typeof e?.message === "string" &&
-        hasTelemetryPropFunctions(e);
+	return (
+		typeof e?.errorType === "string" &&
+		typeof e?.message === "string" &&
+		hasTelemetryPropFunctions(e)
+	);
 }

package/src/index.ts

@@ -3,13 +3,13 @@
  * Licensed under the MIT License.
  */
 export {
-    MonitoringContext,
-    IConfigProviderBase,
-    sessionStorageConfigProvider,
-    mixinMonitoringContext,
-    IConfigProvider,
-    ConfigTypes,
-    loggerToMonitoringContext,
+	MonitoringContext,
+	IConfigProviderBase,
+	sessionStorageConfigProvider,
+	mixinMonitoringContext,
+	IConfigProvider,
+	ConfigTypes,
+	loggerToMonitoringContext,
 } from "./config";
 export { DebugLogger } from "./debugLogger";
 export {
@@ -28,8 +28,18 @@ export {
 	wrapErrorAndLog,
 } from "./errorLogging";
 export { EventEmitterWithErrorHandling } from "./eventEmitterWithErrorHandling";
-export { connectedEventName, disconnectedEventName, raiseConnectedEvent, safeRaiseEvent } from "./events";
-export { hasErrorInstanceId, IFluidErrorBase, isFluidError, isValidLegacyError } from "./fluidErrorBase";
+export {
+	connectedEventName,
+	disconnectedEventName,
+	raiseConnectedEvent,
+	safeRaiseEvent,
+} from "./events";
+export {
+	hasErrorInstanceId,
+	IFluidErrorBase,
+	isFluidError,
+	isValidLegacyError,
+} from "./fluidErrorBase";
 export {
 	BaseTelemetryNullLogger,
 	ChildLogger,
@@ -51,11 +61,11 @@ export { SampledTelemetryHelper } from "./sampledTelemetryHelper";
 export { logIfFalse } from "./utils";
 export {
 	TelemetryEventPropertyTypeExt,
-    ITelemetryEventExt,
-    ITelemetryGenericEventExt,
-    ITelemetryErrorEventExt,
-    ITelemetryPerformanceEventExt,
-    ITelemetryLoggerExt,
-    ITaggedTelemetryPropertyTypeExt,
-    ITelemetryPropertiesExt,
+	ITelemetryEventExt,
+	ITelemetryGenericEventExt,
+	ITelemetryErrorEventExt,
+	ITelemetryPerformanceEventExt,
+	ITelemetryLoggerExt,
+	ITaggedTelemetryPropertyTypeExt,
+	ITelemetryPropertiesExt,
 } from "./telemetryTypes";