@fluidframework/telemetry-utils 0.59.2000-63294 → 0.59.3000-66610

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/telemetry-utils",
-  "version": "0.59.2000-63294",
+  "version": "0.59.3000-66610",
   "description": "Collection of telemetry relates utilities for Fluid",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -72,9 +72,10 @@
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/eslint-config-fluid": "^0.28.1000",
-    "@fluidframework/mocha-test-setup": "0.59.2000-63294",
-    "@fluidframework/telemetry-utils-previous": "npm:@fluidframework/telemetry-utils@0.59.1000",
+    "@fluidframework/build-tools": "^0.2.66048",
+    "@fluidframework/eslint-config-fluid": "^0.28.2000-0",
+    "@fluidframework/mocha-test-setup": "0.59.3000-66610",
+    "@fluidframework/telemetry-utils-previous": "npm:@fluidframework/telemetry-utils@0.59.2000",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/debug": "^4.1.5",
@@ -100,10 +101,14 @@
     "nyc": "^15.0.0",
     "rimraf": "^2.6.2",
     "sinon": "^7.4.2",
-    "typescript": "~4.1.3"
+    "typescript": "~4.5.5"
   },
   "typeValidation": {
-    "version": "0.59.2000",
-    "broken": {}
+    "version": "0.59.3000",
+    "broken": {
+      "ClassDeclaration_MockLogger": {
+        "forwardCompat": false
+      }
+    }
   }
 }

package/src/config.ts

@@ -95,7 +95,7 @@ interface StronglyTypedValue extends Partial<ConfigTypeStringToType> {
  */
 function stronglyTypedParse(input: ConfigTypes): StronglyTypedValue | undefined {
     let output: ConfigTypes = input;
-    let defaultReturn: Pick<StronglyTypedValue,"raw" | "string"> | undefined;
+    let defaultReturn: Pick<StronglyTypedValue, "raw" | "string"> | undefined;
     // we do special handling for strings to try and coerce
     // them into a config type if we can. This makes it easy
     // for config sources like sessionStorage which only
@@ -220,7 +220,7 @@ export class CachedConfigProvider implements IConfigProvider {
  * A type containing both a telemetry logger and a configuration provider
  */
 export interface MonitoringContext<
-    L extends ITelemetryBaseLogger = ITelemetryLogger
+    L extends ITelemetryBaseLogger = ITelemetryLogger,
 > {
     config: IConfigProvider;
     logger: L;
@@ -234,7 +234,7 @@ export function loggerIsMonitoringContext<L extends ITelemetryBaseLogger = ITele
 
 export function loggerToMonitoringContext<L extends ITelemetryBaseLogger = ITelemetryLogger>(
     logger: L): MonitoringContext<L> {
-    if(loggerIsMonitoringContext<L>(logger)) {
+    if (loggerIsMonitoringContext<L>(logger)) {
         return logger;
     }
     return mixinMonitoringContext<L>(logger, sessionStorageConfigProvider.value);

package/src/debugLogger.ts

@@ -61,8 +61,8 @@ export class DebugLogger extends TelemetryLogger {
     }
 
     private static tryGetBaseLoggerProps(baseLogger?: ITelemetryBaseLogger) {
-        if(baseLogger instanceof TelemetryLogger) {
-            return (baseLogger as any as {properties: ITelemetryLoggerPropertyBags}).properties;
+        if (baseLogger instanceof TelemetryLogger) {
+            return (baseLogger as any as { properties: ITelemetryLoggerPropertyBags; }).properties;
         }
         return undefined;
     }

package/src/errorLogging.ts

@@ -40,7 +40,7 @@ export function extractLogSafeErrorProperties(error: any, sanitizeStack: boolean
         ? error.message as string
         : String(error);
 
-    const safeProps: { message: string; errorType?: string; stack?: string } = {
+    const safeProps: { message: string; errorType?: string; stack?: string; } = {
         message,
     };
 
@@ -134,9 +134,9 @@ export function normalizeError(
         Object.assign(normalizeError, { canRetry, retryAfterSeconds });
     }
 
-    if (typeof(error) !== "object") {
+    if (typeof (error) !== "object") {
         // This is only interesting for non-objects
-        fluidError.addTelemetryProperties({ typeofError: typeof(error) });
+        fluidError.addTelemetryProperties({ typeofError: typeof (error) });
     }
     return fluidError;
 }
@@ -267,7 +267,7 @@ export function isExternalError(e: any): boolean {
  * Type guard to identify if a particular value (loosely) appears to be a tagged telemetry property
  */
 export function isTaggedTelemetryPropertyValue(x: any): x is ITaggedTelemetryPropertyType {
-    return (typeof(x?.value) !== "object" && typeof(x?.tag) === "string");
+    return (typeof (x?.value) !== "object" && typeof (x?.tag) === "string");
 }
 
 /**

package/src/fluidErrorBase.ts

@@ -44,7 +44,7 @@ const hasTelemetryPropFunctions = (x: any): boolean =>
     typeof x?.getTelemetryProperties === "function" &&
     typeof x?.addTelemetryProperties === "function";
 
-export const hasErrorInstanceId = (x: any): x is { errorInstanceId: string } =>
+export const hasErrorInstanceId = (x: any): x is { errorInstanceId: string; } =>
     typeof x?.errorInstanceId === "string";
 
 /** type guard for IFluidErrorBase interface */

package/src/logger.ts

@@ -44,8 +44,8 @@ export interface ITelemetryLoggerPropertyBag {
     [index: string]: TelemetryEventPropertyTypes | (() => TelemetryEventPropertyTypes);
 }
 export interface ITelemetryLoggerPropertyBags{
-    all?: ITelemetryLoggerPropertyBag,
-    error?: ITelemetryLoggerPropertyBag,
+    all?: ITelemetryLoggerPropertyBag;
+    error?: ITelemetryLoggerPropertyBag;
 }
 
 /**
@@ -86,7 +86,7 @@ export abstract class TelemetryLogger implements ITelemetryLogger {
      * @param fetchStack - Whether to fetch the current callstack if error.stack is undefined
      */
     public static prepareErrorObject(event: ITelemetryBaseEvent, error: any, fetchStack: boolean) {
-        const { message, errorType, stack} = extractLogSafeErrorProperties(error, true /* sanitizeStack */);
+        const { message, errorType, stack } = extractLogSafeErrorProperties(error, true /* sanitizeStack */);
         // First, copy over error message, stack, and errorType directly (overwrite if present on event)
         event.stack = stack;
         event.error = message; // Note that the error message goes on the 'error' field
@@ -139,9 +139,8 @@ export abstract class TelemetryLogger implements ITelemetryLogger {
      * @param error - optional error object to log
      */
      protected sendTelemetryEventCore(
-        event: ITelemetryGenericEvent & { category: TelemetryEventCategory },
-        error?: any)
-    {
+        event: ITelemetryGenericEvent & { category: TelemetryEventCategory; },
+        error?: any) {
         const newEvent = { ...event };
         if (error !== undefined) {
             TelemetryLogger.prepareErrorObject(newEvent, error, false);
@@ -188,14 +187,14 @@ export abstract class TelemetryLogger implements ITelemetryLogger {
         if (this.namespace !== undefined) {
             newEvent.eventName = `${this.namespace}${TelemetryLogger.eventNamespaceSeparator}${newEvent.eventName}`;
         }
-        if(this.properties) {
+        if (this.properties) {
             const properties: (undefined | ITelemetryLoggerPropertyBag)[] = [];
             properties.push(this.properties.all);
-            if(includeErrorProps) {
+            if (includeErrorProps) {
                 properties.push(this.properties.error);
             }
-            for(const props of properties) {
-                if(props !== undefined) {
+            for (const props of properties) {
+                if (props !== undefined) {
                     for (const key of Object.keys(props)) {
                         if (event[key] !== undefined) {
                             continue;
@@ -282,15 +281,15 @@ export class ChildLogger extends TelemetryLogger {
         // the callstack overhead, just generate a new logger that includes everything from the previous
         if (baseLogger instanceof ChildLogger) {
             const combinedProperties: ITelemetryLoggerPropertyBags = {};
-            for(const extendedProps of [baseLogger.properties, properties]) {
-                if(extendedProps !== undefined) {
-                    if(extendedProps.all !== undefined) {
+            for (const extendedProps of [baseLogger.properties, properties]) {
+                if (extendedProps !== undefined) {
+                    if (extendedProps.all !== undefined) {
                         combinedProperties.all = {
                             ... combinedProperties.all,
                             ... extendedProps.all,
                         };
                     }
-                    if(extendedProps.error !== undefined) {
+                    if (extendedProps.error !== undefined) {
                         combinedProperties.error = {
                             ... combinedProperties.error,
                             ... extendedProps.error,
@@ -326,7 +325,7 @@ export class ChildLogger extends TelemetryLogger {
         super(namespace, properties);
 
         // propagate the monitoring context
-        if(loggerIsMonitoringContext(baseLogger)) {
+        if (loggerIsMonitoringContext(baseLogger)) {
             mixinMonitoringContext(
                 this,
                 new CachedConfigProvider(baseLogger.config));
@@ -449,7 +448,7 @@ export class PerformanceEvent {
     protected constructor(
         private readonly logger: ITelemetryLogger,
         event: ITelemetryGenericEvent,
-        private readonly markers: IPerformanceEventMarkers = {end: true, cancel: "generic"},
+        private readonly markers: IPerformanceEventMarkers = { end: true, cancel: "generic" },
     ) {
         this.event = { ...event };
         if (this.markers.start) {
@@ -492,7 +491,7 @@ export class PerformanceEvent {
 
     public cancel(props?: ITelemetryProperties, error?: any): void {
         if (this.markers.cancel !== undefined) {
-            this.reportEvent("cancel", {category: this.markers.cancel, ...props}, error);
+            this.reportEvent("cancel", { category: this.markers.cancel, ...props }, error);
         }
         this.event = undefined;
     }

package/src/mockLogger.ts

@@ -15,6 +15,10 @@ export class MockLogger extends TelemetryLogger implements ITelemetryLogger {
 
     constructor() { super(); }
 
+    clear() {
+        this.events = [];
+    }
+
     send(event: ITelemetryBaseEvent): void {
         this.events.push(event);
     }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/telemetry-utils";
-export const pkgVersion = "0.59.2000-63294";
+export const pkgVersion = "0.59.3000-66610";

package/src/utils.ts

@@ -20,13 +20,13 @@ export function logIfFalse(
     logger: ITelemetryBaseLogger,
     event: string | ITelemetryGenericEvent,
 ): condition is true {
-    if(condition) {
+    if (condition) {
         return true;
     }
     const newEvent: ITelemetryBaseEvent =
         typeof event === "string"
-        ? {eventName: event, category: "error"}
-        : {category: "error", ...event };
+        ? { eventName: event, category: "error" }
+        : { category: "error", ...event };
     logger.send(newEvent);
     return false;
 }