@fluidframework/telemetry-utils 0.50.3 → 0.51.2

package/dist/errorLogging.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { ILoggingError, ITaggedTelemetryPropertyType, ITelemetryProperties } from "@fluidframework/common-definitions";
+import { ILoggingError, ITaggedTelemetryPropertyType, ITelemetryLogger, ITelemetryProperties } from "@fluidframework/common-definitions";
 import { IFluidErrorBase } from "./fluidErrorBase";
 /** Inspect the given error for common "safe" props and return them */
 export declare function extractLogSafeErrorProperties(error: any, sanitizeStack: boolean): {
@@ -16,8 +16,6 @@ export declare const isILoggingError: (x: any) => x is ILoggingError;
 export interface IFluidErrorAnnotations {
     /** Telemetry props to log with the error */
     props?: ITelemetryProperties;
-    /** fluidErrorCode to mention if error isn't already an IFluidErrorBase */
-    errorCodeIfNone?: string;
 }
 /**
  * Normalize the given error yielding a valid Fluid Error
@@ -27,6 +25,17 @@ export interface IFluidErrorAnnotations {
  */
 export declare function normalizeError(error: unknown, annotations?: IFluidErrorAnnotations): IFluidErrorBase;
 export declare function generateStack(): string | undefined;
+/**
+ * Create a new error, wrapping and caused by the given unknown error.
+ * Copies the inner error's message and stack over but otherwise uses newErrorFn to define the error.
+ * The inner error's instance id will also be logged for telemetry analysis.
+ * @param innerError - An error from untrusted/unknown origins
+ * @param newErrorFn - callback that will create a new error given the original error's message
+ * @returns A new error object "wrapping" the given error
+ */
+export declare function wrapError<T extends IFluidErrorBase>(innerError: unknown, newErrorFn: (message: string) => T): T;
+/** The same as wrapError, but also logs the innerError, including the wrapping error's instance id */
+export declare function wrapErrorAndLog<T extends IFluidErrorBase>(innerError: unknown, newErrorFn: (message: string) => T, logger: ITelemetryLogger): T;
 /**
  * Type guard to identify if a particular value (loosely) appears to be a tagged telemetry property
  */

package/dist/errorLogging.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errorLogging.d.ts","sourceRoot":"","sources":["../src/errorLogging.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,aAAa,EACb,4BAA4B,EAC5B,oBAAoB,EACvB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,eAAe,EAGlB,MAAM,kBAAkB,CAAC;AAO1B,sEAAsE;AACtE,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,GAAG,EAAE,aAAa,EAAE,OAAO;aAiBhD,MAAM;;;EAkBrC;AAED,6CAA6C;AAC7C,eAAO,MAAM,eAAe,MAAO,GAAG,uBAAwE,CAAC;AAW/G,6EAA6E;AAC7E,MAAM,WAAW,sBAAsB;IACnC,4CAA4C;IAC5C,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,0EAA0E;IAC1E,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAiDD;;;;;GAKG;AACH,wBAAgB,cAAc,CAC1B,KAAK,EAAE,OAAO,EACd,WAAW,GAAE,sBAA2B,GACzC,eAAe,CA+BjB;AAED,wBAAgB,aAAa,IAAI,MAAM,GAAG,SAAS,CAWlD;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,4BAA4B,CAExF;AAiCD;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,KAAM,YAAW,aAAa,EAAE,IAAI,CAAC,eAAe,EAAE,iBAAiB,CAAC;IAYlG,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IAXzC,QAAQ,CAAC,eAAe,SAAU;IAElC;;;;;OAKG;gBAEC,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,oBAAoB,EACX,oBAAoB,GAAE,GAAG,CAAC,MAAM,CAAa;IAYlE;;OAEG;IACI,sBAAsB,CAAC,KAAK,EAAE,oBAAoB;IAIzD;;OAEG;IACI,sBAAsB,IAAI,oBAAoB;CASxD"}
+{"version":3,"file":"errorLogging.d.ts","sourceRoot":"","sources":["../src/errorLogging.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,aAAa,EACb,4BAA4B,EAC5B,gBAAgB,EAChB,oBAAoB,EACvB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAEH,eAAe,EAGlB,MAAM,kBAAkB,CAAC;AAO1B,sEAAsE;AACtE,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,GAAG,EAAE,aAAa,EAAE,OAAO;aAiBhD,MAAM;;;EAkBrC;AAED,6CAA6C;AAC7C,eAAO,MAAM,eAAe,MAAO,GAAG,uBAAwE,CAAC;AAW/G,6EAA6E;AAC7E,MAAM,WAAW,sBAAsB;IACnC,4CAA4C;IAC5C,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAgDD;;;;;GAKG;AACH,wBAAgB,cAAc,CAC1B,KAAK,EAAE,OAAO,EACd,WAAW,GAAE,sBAA2B,GACzC,eAAe,CA+BjB;AAED,wBAAgB,aAAa,IAAI,MAAM,GAAG,SAAS,CAWlD;AAED;;;;;;;GAOG;AACF,wBAAgB,SAAS,CAAC,CAAC,SAAS,eAAe,EAChD,UAAU,EAAE,OAAO,EACnB,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,CAAC,GACnC,CAAC,CAsBH;AAED,sGAAsG;AACtG,wBAAgB,eAAe,CAAC,CAAC,SAAS,eAAe,EACrD,UAAU,EAAE,OAAO,EACnB,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,CAAC,EAClC,MAAM,EAAE,gBAAgB,KAa3B;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,4BAA4B,CAExF;AAiCD;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,KAAM,YAAW,aAAa,EAAE,IAAI,CAAC,eAAe,EAAE,iBAAiB,CAAC;IAYlG,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IAXzC,QAAQ,CAAC,eAAe,SAAU;IAElC;;;;;OAKG;gBAEC,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,oBAAoB,EACX,oBAAoB,GAAE,GAAG,CAAC,MAAM,CAAa;IAYlE;;OAEG;IACI,sBAAsB,CAAC,KAAK,EAAE,oBAAoB;IAIzD;;OAEG;IACI,sBAAsB,IAAI,oBAAoB;CASxD"}

package/dist/errorLogging.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LoggingError = exports.isTaggedTelemetryPropertyValue = exports.generateStack = exports.normalizeError = exports.isILoggingError = exports.extractLogSafeErrorProperties = void 0;
+exports.LoggingError = exports.isTaggedTelemetryPropertyValue = exports.wrapErrorAndLog = exports.wrapError = exports.generateStack = exports.normalizeError = exports.isILoggingError = exports.extractLogSafeErrorProperties = void 0;
 const uuid_1 = require("uuid");
 const fluidErrorBase_1 = require("./fluidErrorBase");
 /** @returns true if value is an object but neither null nor an array */
@@ -74,10 +74,10 @@ class SimpleFluidError {
     }
 }
 /** For backwards compatibility with pre-fluidErrorCode valid errors */
-function patchWithErrorCode(legacyError, errorCode = "<error predates fluidErrorCode>") {
+function patchWithErrorCode(legacyError) {
     const patchMe = legacyError;
     if (patchMe.fluidErrorCode === undefined) {
-        patchMe.fluidErrorCode = errorCode;
+        patchMe.fluidErrorCode = "<error predates fluidErrorCode>";
     }
 }
 /**
@@ -87,10 +87,10 @@ function patchWithErrorCode(legacyError, errorCode = "<error predates fluidError
  * @param annotations - Annotations to apply to the normalized error
  */
 function normalizeError(error, annotations = {}) {
-    var _a, _b;
+    var _a;
     // Back-compat, while IFluidErrorBase is rolled out
     if (fluidErrorBase_1.isValidLegacyError(error)) {
-        patchWithErrorCode(error, annotations.errorCodeIfNone);
+        patchWithErrorCode(error);
     }
     if (fluidErrorBase_1.isFluidError(error)) {
         // We can simply add the telemetry props to the error and return it
@@ -101,7 +101,7 @@ function normalizeError(error, annotations = {}) {
     const { message, stack } = extractLogSafeErrorProperties(error, false /* sanitizeStack */);
     const fluidError = new SimpleFluidError({
         errorType: "genericError",
-        fluidErrorCode: (_b = annotations.errorCodeIfNone) !== null && _b !== void 0 ? _b : "none",
+        fluidErrorCode: "",
         message,
         stack: stack !== null && stack !== void 0 ? stack : generateStack(),
     });
@@ -127,6 +127,45 @@ function generateStack() {
     return stack;
 }
 exports.generateStack = generateStack;
+/**
+ * Create a new error, wrapping and caused by the given unknown error.
+ * Copies the inner error's message and stack over but otherwise uses newErrorFn to define the error.
+ * The inner error's instance id will also be logged for telemetry analysis.
+ * @param innerError - An error from untrusted/unknown origins
+ * @param newErrorFn - callback that will create a new error given the original error's message
+ * @returns A new error object "wrapping" the given error
+ */
+function wrapError(innerError, newErrorFn) {
+    const { message, stack, } = extractLogSafeErrorProperties(innerError, false /* sanitizeStack */);
+    const newError = newErrorFn(message);
+    if (stack !== undefined) {
+        // supposedly setting stack on an Error can throw.
+        try {
+            Object.assign(newError, { stack });
+        }
+        catch (errorSettingStack) {
+            newError.addTelemetryProperties({ stack2: stack });
+        }
+    }
+    if (fluidErrorBase_1.hasErrorInstanceId(innerError)) {
+        newError.addTelemetryProperties({ innerErrorInstanceId: innerError.errorInstanceId });
+    }
+    return newError;
+}
+exports.wrapError = wrapError;
+/** The same as wrapError, but also logs the innerError, including the wrapping error's instance id */
+function wrapErrorAndLog(innerError, newErrorFn, logger) {
+    const newError = wrapError(innerError, newErrorFn);
+    const wrappedByErrorInstanceId = fluidErrorBase_1.hasErrorInstanceId(newError)
+        ? newError.errorInstanceId
+        : undefined;
+    logger.sendTelemetryEvent({
+        eventName: "WrapError",
+        wrappedByErrorInstanceId,
+    }, innerError);
+    return newError;
+}
+exports.wrapErrorAndLog = wrapErrorAndLog;
 /**
  * Type guard to identify if a particular value (loosely) appears to be a tagged telemetry property
  */

package/dist/errorLogging.js.map

@@ -1 +1 @@
-{"version":3,"file":"errorLogging.js","sourceRoot":"","sources":["../src/errorLogging.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAOH,+BAAkC;AAClC,qDAI0B;AAE1B,wEAAwE;AACxE,MAAM,eAAe,GAAG,CAAC,KAAU,EAAW,EAAE;IAC5C,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAChF,CAAC,CAAC;AAEF,sEAAsE;AACtE,SAAgB,6BAA6B,CAAC,KAAU,EAAE,aAAsB;IAC5E,MAAM,sBAAsB,GAAG,CAAC,KAAa,EAAE,SAAkB,EAAE,EAAE;QACjE,IAAI,CAAC,aAAa,EAAE;YAChB,OAAO,KAAK,CAAC;SAChB;QACD,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtC,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC,uCAAuC;QAC5D,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB;SACvD;QACD,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,QAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,CAAA,KAAK,QAAQ,CAAC;QAChD,CAAC,CAAC,KAAK,CAAC,OAAiB;QACzB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEpB,MAAM,SAAS,GAA4D;QACvE,OAAO;KACV,CAAC;IAEF,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE;QACxB,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QAEzC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YAC/B,SAAS,CAAC,SAAS,GAAG,SAAS,CAAC;SACnC;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC3B,MAAM,SAAS,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,SAAS,CAAC,KAAK,GAAG,sBAAsB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;SAC9D;KACJ;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAnCD,sEAmCC;AAED,6CAA6C;AACtC,MAAM,eAAe,GAAG,CAAC,CAAM,EAAsB,EAAE,CAAC,QAAO,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,sBAAsB,CAAA,KAAK,UAAU,CAAC;AAAlG,QAAA,eAAe,mBAAmF;AAE/G,6FAA6F;AAC7F,SAAS,SAAS,CAAC,MAA2C,EAAE,MAA4B;IACxF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;QACnC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;YAC3B,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;SAC7B;KACJ;AACL,CAAC;AAUD,0DAA0D;AAC1D,MAAM,gBAAgB;IAUlB,YACI,UAGsB;QAbT,mBAAc,GAAyB,EAAE,CAAC;QAevD,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,eAAe,GAAG,SAAI,EAAE,CAAC;QAE9B,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,sBAAsB;QAClB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAED,sBAAsB,CAAC,KAA2B;QAC9C,SAAS,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;CACJ;AAED,uEAAuE;AACvE,SAAS,kBAAkB,CACvB,WAAoD,EACpD,YAAoB,iCAAiC;IAErD,MAAM,OAAO,GAAgC,WAAkB,CAAC;IAChE,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE;QACtC,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;KACtC;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAC1B,KAAc,EACd,cAAsC,EAAE;;IAExC,mDAAmD;IACnD,IAAI,mCAAkB,CAAC,KAAK,CAAC,EAAE;QAC3B,kBAAkB,CAAC,KAAK,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC;KAC1D;IAED,IAAI,6BAAY,CAAC,KAAK,CAAC,EAAE;QACrB,mEAAmE;QACnE,KAAK,CAAC,sBAAsB,OAAC,WAAW,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC;QACtD,OAAO,KAAK,CAAC;KAChB;IAED,uEAAuE;IACvE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,6BAA6B,CAAC,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC3F,MAAM,UAAU,GAAoB,IAAI,gBAAgB,CAAC;QACrD,SAAS,EAAE,cAAc;QACzB,cAAc,QAAE,WAAW,CAAC,eAAe,mCAAI,MAAM;QACrD,OAAO;QACP,KAAK,EAAE,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,aAAa,EAAE;KAClC,CAAC,CAAC;IAEH,UAAU,CAAC,sBAAsB,iCAC1B,WAAW,CAAC,KAAK,KACpB,eAAe,EAAE,CAAC,IACpB,CAAC;IAEH,IAAI,OAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE;QAC5B,2CAA2C;QAC3C,UAAU,CAAC,sBAAsB,CAAC,EAAE,WAAW,EAAE,OAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KACrE;IACD,OAAO,UAAU,CAAC;AACtB,CAAC;AAlCD,wCAkCC;AAED,SAAgB,aAAa;IACzB,8EAA8E;IAC9E,IAAI,KAAK,GAAG,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,KAAK,CAAC;IACnD,IAAI,CAAC,KAAK,EAAE;QACR,IAAI;YACA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SAC1C;QAAC,OAAO,CAAC,EAAE;YACR,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;SACnB;KACJ;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAXD,sCAWC;AAED;;GAEG;AACH,SAAgB,8BAA8B,CAAC,CAAM;IACjD,OAAO,CAAC,OAAM,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,CAAC,KAAK,QAAQ,IAAI,OAAM,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,GAAG,CAAC,KAAK,QAAQ,CAAC,CAAC;AAC1E,CAAC;AAFD,wEAEC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,GAAQ,EAAE,UAAuB;IAC7D,MAAM,KAAK,GAAyB,EAAE,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAChC,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACrB,SAAS;SACZ;QACD,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,QAAQ,OAAO,GAAG,EAAE;YAChB,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,WAAW;gBACZ,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;gBACjB,MAAM;YACV,OAAO,CAAC,CAAC;gBACL,IAAI,8BAA8B,CAAC,GAAG,CAAC,EAAE;oBACrC,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;iBACpB;qBAAM;oBACH,6CAA6C;oBAC7C,KAAK,CAAC,GAAG,CAAC,GAAG,6BAA6B,CAAC;iBAC9C;gBACD,MAAM;aACT;SACJ;KACJ;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;;GAMG;AACH,MAAa,YAAa,SAAQ,KAAK;IAGnC;;;;;OAKG;IACH,YACI,OAAe,EACf,KAA4B,EACX,uBAAoC,IAAI,GAAG,EAAE;QAE9D,KAAK,CAAC,OAAO,CAAC,CAAC;QAFE,yBAAoB,GAApB,oBAAoB,CAAyB;QAXzD,oBAAe,GAAG,SAAI,EAAE,CAAC;QAe9B,oCAAoC;QACpC,oBAAoB,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QAEjD,IAAI,KAAK,EAAE;YACP,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;SACtC;IACL,CAAC;IAED;;OAEG;IACI,sBAAsB,CAAC,KAA2B;QACrD,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,sBAAsB;QACzB,MAAM,aAAa,GAAG,sBAAsB,CAAC,IAAI,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC9E,oGAAoG;QACpG,uCACO,aAAa,KAChB,KAAK,EAAE,IAAI,CAAC,KAAK,EACjB,OAAO,EAAE,IAAI,CAAC,OAAO,IACvB;IACN,CAAC;CACJ;AA3CD,oCA2CC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    ILoggingError,\n    ITaggedTelemetryPropertyType,\n    ITelemetryProperties,\n} from \"@fluidframework/common-definitions\";\nimport { v4 as uuid } from \"uuid\";\nimport {\n    IFluidErrorBase,\n    isFluidError,\n    isValidLegacyError,\n} from \"./fluidErrorBase\";\n\n/** @returns true if value is an object but neither null nor an array */\nconst isRegularObject = (value: any): boolean => {\n    return value !== null && !Array.isArray(value) && typeof value === \"object\";\n};\n\n/** Inspect the given error for common \"safe\" props and return them */\nexport function extractLogSafeErrorProperties(error: any, sanitizeStack: boolean) {\n    const removeMessageFromStack = (stack: string, errorName?: string) => {\n        if (!sanitizeStack) {\n            return stack;\n        }\n        const stackFrames = stack.split(\"\\n\");\n        stackFrames.shift(); // Remove \"[ErrorName]: [ErrorMessage]\"\n        if (errorName !== undefined) {\n            stackFrames.unshift(errorName); // Add \"[ErrorName]\"\n        }\n        return stackFrames.join(\"\\n\");\n    };\n\n    const message = (typeof error?.message === \"string\")\n        ? error.message as string\n        : String(error);\n\n    const safeProps: { message: string; errorType?: string; stack?: string } = {\n        message,\n    };\n\n    if (isRegularObject(error)) {\n        const { errorType, stack, name } = error;\n\n        if (typeof errorType === \"string\") {\n            safeProps.errorType = errorType;\n        }\n\n        if (typeof stack === \"string\") {\n            const errorName = (typeof name === \"string\") ? name : undefined;\n            safeProps.stack = removeMessageFromStack(stack, errorName);\n        }\n    }\n\n    return safeProps;\n}\n\n/** type guard for ILoggingError interface */\nexport const isILoggingError = (x: any): x is ILoggingError => typeof x?.getTelemetryProperties === \"function\";\n\n/** Copy props from source onto target, but do not overwrite an existing prop that matches */\nfunction copyProps(target: ITelemetryProperties | LoggingError, source: ITelemetryProperties) {\n    for (const key of Object.keys(source)) {\n        if (target[key] === undefined) {\n            target[key] = source[key];\n        }\n    }\n}\n\n/** Metadata to annotate an error object when annotating or normalizing it */\nexport interface IFluidErrorAnnotations {\n    /** Telemetry props to log with the error */\n    props?: ITelemetryProperties;\n    /** fluidErrorCode to mention if error isn't already an IFluidErrorBase */\n    errorCodeIfNone?: string;\n}\n\n/** Simplest possible implementation of IFluidErrorBase */\nclass SimpleFluidError implements IFluidErrorBase {\n    private readonly telemetryProps: ITelemetryProperties = {};\n\n    readonly errorType: string;\n    readonly fluidErrorCode: string;\n    readonly message: string;\n    readonly stack?: string;\n    readonly name?: string;\n    readonly errorInstanceId: string;\n\n    constructor(\n        errorProps: Omit<IFluidErrorBase,\n            \"getTelemetryProperties\" |\n            \"addTelemetryProperties\" |\n            \"errorInstanceId\">,\n    ) {\n        this.errorType = errorProps.errorType;\n        this.fluidErrorCode = errorProps.fluidErrorCode;\n        this.message = errorProps.message;\n        this.stack = errorProps.stack;\n        this.name = errorProps.name;\n        this.errorInstanceId = uuid();\n\n        this.addTelemetryProperties(errorProps);\n    }\n\n    getTelemetryProperties(): ITelemetryProperties {\n        return this.telemetryProps;\n    }\n\n    addTelemetryProperties(props: ITelemetryProperties) {\n        copyProps(this.telemetryProps, props);\n    }\n}\n\n/** For backwards compatibility with pre-fluidErrorCode valid errors */\nfunction patchWithErrorCode(\n    legacyError: Omit<IFluidErrorBase, \"fluidErrorCode\">,\n    errorCode: string = \"<error predates fluidErrorCode>\",\n): asserts legacyError is IFluidErrorBase {\n    const patchMe: { fluidErrorCode?: string } = legacyError as any;\n    if (patchMe.fluidErrorCode === undefined) {\n        patchMe.fluidErrorCode = errorCode;\n    }\n}\n\n/**\n * Normalize the given error yielding a valid Fluid Error\n * @returns A valid Fluid Error with any provided annotations applied\n * @param error - The error to normalize\n * @param annotations - Annotations to apply to the normalized error\n */\nexport function normalizeError(\n    error: unknown,\n    annotations: IFluidErrorAnnotations = {},\n): IFluidErrorBase {\n    // Back-compat, while IFluidErrorBase is rolled out\n    if (isValidLegacyError(error)) {\n        patchWithErrorCode(error, annotations.errorCodeIfNone);\n    }\n\n    if (isFluidError(error)) {\n        // We can simply add the telemetry props to the error and return it\n        error.addTelemetryProperties(annotations.props ?? {});\n        return error;\n    }\n\n    // We have to construct a new Fluid Error, copying safe properties over\n    const { message, stack } = extractLogSafeErrorProperties(error, false /* sanitizeStack */);\n    const fluidError: IFluidErrorBase = new SimpleFluidError({\n        errorType: \"genericError\", // Match Container/Driver generic error type\n        fluidErrorCode: annotations.errorCodeIfNone ?? \"none\",\n        message,\n        stack: stack ?? generateStack(),\n    });\n\n    fluidError.addTelemetryProperties({\n        ...annotations.props,\n        untrustedOrigin: 1, // This will let us filter to errors not originated by our own code\n    });\n\n    if (typeof(error) !== \"object\") {\n        // This is only interesting for non-objects\n        fluidError.addTelemetryProperties({ typeofError: typeof(error) });\n    }\n    return fluidError;\n}\n\nexport function generateStack(): string | undefined {\n    // Some browsers will populate stack right away, others require throwing Error\n    let stack = new Error(\"<<generated stack>>\").stack;\n    if (!stack) {\n        try {\n            throw new Error(\"<<generated stack>>\");\n        } catch (e) {\n            stack = e.stack;\n        }\n    }\n    return stack;\n}\n\n/**\n * Type guard to identify if a particular value (loosely) appears to be a tagged telemetry property\n */\nexport function isTaggedTelemetryPropertyValue(x: any): x is ITaggedTelemetryPropertyType {\n    return (typeof(x?.value) !== \"object\" && typeof(x?.tag) === \"string\");\n}\n\n/**\n * Walk an object's enumerable properties to find those fit for telemetry.\n */\nfunction getValidTelemetryProps(obj: any, keysToOmit: Set<string>): ITelemetryProperties {\n    const props: ITelemetryProperties = {};\n    for (const key of Object.keys(obj)) {\n        if (keysToOmit.has(key)) {\n            continue;\n        }\n        const val = obj[key];\n        switch (typeof val) {\n            case \"string\":\n            case \"number\":\n            case \"boolean\":\n            case \"undefined\":\n                props[key] = val;\n                break;\n            default: {\n                if (isTaggedTelemetryPropertyValue(val)) {\n                    props[key] = val;\n                } else {\n                    // We don't support logging arbitrary objects\n                    props[key] = \"REDACTED (arbitrary object)\";\n                }\n                break;\n            }\n        }\n    }\n    return props;\n}\n\n/**\n * Base class for \"trusted\" errors we create, whose properties can generally be logged to telemetry safely.\n * All properties set on the object, or passed in (via the constructor or getTelemetryProperties),\n * will be logged in accordance with their tag, if present.\n *\n * PLEASE take care to avoid setting sensitive data on this object without proper tagging!\n */\nexport class LoggingError extends Error implements ILoggingError, Pick<IFluidErrorBase, \"errorInstanceId\"> {\n    readonly errorInstanceId = uuid();\n\n    /**\n     * Create a new LoggingError\n     * @param message - Error message to use for Error base class\n     * @param props - telemetry props to include on the error for when it's logged\n     * @param omitPropsFromLogging - properties by name to omit from telemetry props\n     */\n    constructor(\n        message: string,\n        props?: ITelemetryProperties,\n        private readonly omitPropsFromLogging: Set<string> = new Set(),\n    ) {\n        super(message);\n\n        // Don't log this list itself either\n        omitPropsFromLogging.add(\"omitPropsFromLogging\");\n\n        if (props) {\n            this.addTelemetryProperties(props);\n        }\n    }\n\n    /**\n     * Add additional properties to be logged\n     */\n    public addTelemetryProperties(props: ITelemetryProperties) {\n        copyProps(this, props);\n    }\n\n    /**\n     * Get all properties fit to be logged to telemetry for this error\n     */\n    public getTelemetryProperties(): ITelemetryProperties {\n        const taggableProps = getValidTelemetryProps(this, this.omitPropsFromLogging);\n        // Include non-enumerable props inherited from Error that are not returned by getValidTelemetryProps\n        return  {\n            ...taggableProps,\n            stack: this.stack,\n            message: this.message,\n        };\n    }\n}\n"]}
+{"version":3,"file":"errorLogging.js","sourceRoot":"","sources":["../src/errorLogging.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAQH,+BAAkC;AAClC,qDAK0B;AAE1B,wEAAwE;AACxE,MAAM,eAAe,GAAG,CAAC,KAAU,EAAW,EAAE;IAC5C,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAChF,CAAC,CAAC;AAEF,sEAAsE;AACtE,SAAgB,6BAA6B,CAAC,KAAU,EAAE,aAAsB;IAC5E,MAAM,sBAAsB,GAAG,CAAC,KAAa,EAAE,SAAkB,EAAE,EAAE;QACjE,IAAI,CAAC,aAAa,EAAE;YAChB,OAAO,KAAK,CAAC;SAChB;QACD,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtC,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC,uCAAuC;QAC5D,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB;SACvD;QACD,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,QAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,CAAA,KAAK,QAAQ,CAAC;QAChD,CAAC,CAAC,KAAK,CAAC,OAAiB;QACzB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEpB,MAAM,SAAS,GAA4D;QACvE,OAAO;KACV,CAAC;IAEF,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE;QACxB,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QAEzC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YAC/B,SAAS,CAAC,SAAS,GAAG,SAAS,CAAC;SACnC;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC3B,MAAM,SAAS,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,SAAS,CAAC,KAAK,GAAG,sBAAsB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;SAC9D;KACJ;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAnCD,sEAmCC;AAED,6CAA6C;AACtC,MAAM,eAAe,GAAG,CAAC,CAAM,EAAsB,EAAE,CAAC,QAAO,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,sBAAsB,CAAA,KAAK,UAAU,CAAC;AAAlG,QAAA,eAAe,mBAAmF;AAE/G,6FAA6F;AAC7F,SAAS,SAAS,CAAC,MAA2C,EAAE,MAA4B;IACxF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;QACnC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;YAC3B,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;SAC7B;KACJ;AACL,CAAC;AAQD,0DAA0D;AAC1D,MAAM,gBAAgB;IAUlB,YACI,UAGsB;QAbT,mBAAc,GAAyB,EAAE,CAAC;QAevD,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,eAAe,GAAG,SAAI,EAAE,CAAC;QAE9B,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,sBAAsB;QAClB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAED,sBAAsB,CAAC,KAA2B;QAC9C,SAAS,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;CACJ;AAED,uEAAuE;AACvE,SAAS,kBAAkB,CACvB,WAAoD;IAEpD,MAAM,OAAO,GAA+D,WAAkB,CAAC;IAC/F,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE;QACtC,OAAO,CAAC,cAAc,GAAG,iCAAiC,CAAC;KAC9D;AACL,CAAC;AAED;;;;;GAKG;AACH,SAAgB,cAAc,CAC1B,KAAc,EACd,cAAsC,EAAE;;IAExC,mDAAmD;IACnD,IAAI,mCAAkB,CAAC,KAAK,CAAC,EAAE;QAC3B,kBAAkB,CAAC,KAAK,CAAC,CAAC;KAC7B;IAED,IAAI,6BAAY,CAAC,KAAK,CAAC,EAAE;QACrB,mEAAmE;QACnE,KAAK,CAAC,sBAAsB,OAAC,WAAW,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC;QACtD,OAAO,KAAK,CAAC;KAChB;IAED,uEAAuE;IACvE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,6BAA6B,CAAC,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC3F,MAAM,UAAU,GAAoB,IAAI,gBAAgB,CAAC;QACrD,SAAS,EAAE,cAAc;QACzB,cAAc,EAAE,EAAE;QAClB,OAAO;QACP,KAAK,EAAE,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,aAAa,EAAE;KAClC,CAAC,CAAC;IAEH,UAAU,CAAC,sBAAsB,iCAC1B,WAAW,CAAC,KAAK,KACpB,eAAe,EAAE,CAAC,IACpB,CAAC;IAEH,IAAI,OAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE;QAC5B,2CAA2C;QAC3C,UAAU,CAAC,sBAAsB,CAAC,EAAE,WAAW,EAAE,OAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KACrE;IACD,OAAO,UAAU,CAAC;AACtB,CAAC;AAlCD,wCAkCC;AAED,SAAgB,aAAa;IACzB,8EAA8E;IAC9E,IAAI,KAAK,GAAG,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,KAAK,CAAC;IACnD,IAAI,CAAC,KAAK,EAAE;QACR,IAAI;YACA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SAC1C;QAAC,OAAO,CAAC,EAAE;YACR,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;SACnB;KACJ;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAXD,sCAWC;AAED;;;;;;;GAOG;AACF,SAAgB,SAAS,CACtB,UAAmB,EACnB,UAAkC;IAElC,MAAM,EACF,OAAO,EACP,KAAK,GACR,GAAG,6BAA6B,CAAC,UAAU,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAEzE,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAErC,IAAI,KAAK,KAAK,SAAS,EAAE;QACrB,kDAAkD;QAClD,IAAI;YACA,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;SACtC;QAAC,OAAO,iBAAiB,EAAE;YACxB,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;SACtD;KACJ;IAED,IAAI,mCAAkB,CAAC,UAAU,CAAC,EAAE;QAChC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,oBAAoB,EAAE,UAAU,CAAC,eAAe,EAAE,CAAC,CAAC;KACzF;IAED,OAAO,QAAQ,CAAC;AACpB,CAAC;AAzBA,8BAyBA;AAED,sGAAsG;AACtG,SAAgB,eAAe,CAC3B,UAAmB,EACnB,UAAkC,EAClC,MAAwB;IAExB,MAAM,QAAQ,GAAG,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACnD,MAAM,wBAAwB,GAAG,mCAAkB,CAAC,QAAQ,CAAC;QACzD,CAAC,CAAC,QAAQ,CAAC,eAAe;QAC1B,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,CAAC,kBAAkB,CAAC;QACtB,SAAS,EAAE,WAAW;QACtB,wBAAwB;KAC3B,EAAE,UAAU,CAAC,CAAC;IAEf,OAAO,QAAQ,CAAC;AACpB,CAAC;AAhBD,0CAgBC;AAED;;GAEG;AACH,SAAgB,8BAA8B,CAAC,CAAM;IACjD,OAAO,CAAC,OAAM,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,CAAC,KAAK,QAAQ,IAAI,OAAM,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,GAAG,CAAC,KAAK,QAAQ,CAAC,CAAC;AAC1E,CAAC;AAFD,wEAEC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,GAAQ,EAAE,UAAuB;IAC7D,MAAM,KAAK,GAAyB,EAAE,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAChC,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACrB,SAAS;SACZ;QACD,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,QAAQ,OAAO,GAAG,EAAE;YAChB,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,WAAW;gBACZ,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;gBACjB,MAAM;YACV,OAAO,CAAC,CAAC;gBACL,IAAI,8BAA8B,CAAC,GAAG,CAAC,EAAE;oBACrC,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;iBACpB;qBAAM;oBACH,6CAA6C;oBAC7C,KAAK,CAAC,GAAG,CAAC,GAAG,6BAA6B,CAAC;iBAC9C;gBACD,MAAM;aACT;SACJ;KACJ;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;;GAMG;AACH,MAAa,YAAa,SAAQ,KAAK;IAGnC;;;;;OAKG;IACH,YACI,OAAe,EACf,KAA4B,EACX,uBAAoC,IAAI,GAAG,EAAE;QAE9D,KAAK,CAAC,OAAO,CAAC,CAAC;QAFE,yBAAoB,GAApB,oBAAoB,CAAyB;QAXzD,oBAAe,GAAG,SAAI,EAAE,CAAC;QAe9B,oCAAoC;QACpC,oBAAoB,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QAEjD,IAAI,KAAK,EAAE;YACP,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;SACtC;IACL,CAAC;IAED;;OAEG;IACI,sBAAsB,CAAC,KAA2B;QACrD,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,sBAAsB;QACzB,MAAM,aAAa,GAAG,sBAAsB,CAAC,IAAI,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC9E,oGAAoG;QACpG,uCACO,aAAa,KAChB,KAAK,EAAE,IAAI,CAAC,KAAK,EACjB,OAAO,EAAE,IAAI,CAAC,OAAO,IACvB;IACN,CAAC;CACJ;AA3CD,oCA2CC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    ILoggingError,\n    ITaggedTelemetryPropertyType,\n    ITelemetryLogger,\n    ITelemetryProperties,\n} from \"@fluidframework/common-definitions\";\nimport { v4 as uuid } from \"uuid\";\nimport {\n    hasErrorInstanceId,\n    IFluidErrorBase,\n    isFluidError,\n    isValidLegacyError,\n} from \"./fluidErrorBase\";\n\n/** @returns true if value is an object but neither null nor an array */\nconst isRegularObject = (value: any): boolean => {\n    return value !== null && !Array.isArray(value) && typeof value === \"object\";\n};\n\n/** Inspect the given error for common \"safe\" props and return them */\nexport function extractLogSafeErrorProperties(error: any, sanitizeStack: boolean) {\n    const removeMessageFromStack = (stack: string, errorName?: string) => {\n        if (!sanitizeStack) {\n            return stack;\n        }\n        const stackFrames = stack.split(\"\\n\");\n        stackFrames.shift(); // Remove \"[ErrorName]: [ErrorMessage]\"\n        if (errorName !== undefined) {\n            stackFrames.unshift(errorName); // Add \"[ErrorName]\"\n        }\n        return stackFrames.join(\"\\n\");\n    };\n\n    const message = (typeof error?.message === \"string\")\n        ? error.message as string\n        : String(error);\n\n    const safeProps: { message: string; errorType?: string; stack?: string } = {\n        message,\n    };\n\n    if (isRegularObject(error)) {\n        const { errorType, stack, name } = error;\n\n        if (typeof errorType === \"string\") {\n            safeProps.errorType = errorType;\n        }\n\n        if (typeof stack === \"string\") {\n            const errorName = (typeof name === \"string\") ? name : undefined;\n            safeProps.stack = removeMessageFromStack(stack, errorName);\n        }\n    }\n\n    return safeProps;\n}\n\n/** type guard for ILoggingError interface */\nexport const isILoggingError = (x: any): x is ILoggingError => typeof x?.getTelemetryProperties === \"function\";\n\n/** Copy props from source onto target, but do not overwrite an existing prop that matches */\nfunction copyProps(target: ITelemetryProperties | LoggingError, source: ITelemetryProperties) {\n    for (const key of Object.keys(source)) {\n        if (target[key] === undefined) {\n            target[key] = source[key];\n        }\n    }\n}\n\n/** Metadata to annotate an error object when annotating or normalizing it */\nexport interface IFluidErrorAnnotations {\n    /** Telemetry props to log with the error */\n    props?: ITelemetryProperties;\n}\n\n/** Simplest possible implementation of IFluidErrorBase */\nclass SimpleFluidError implements IFluidErrorBase {\n    private readonly telemetryProps: ITelemetryProperties = {};\n\n    readonly errorType: string;\n    readonly fluidErrorCode: string;\n    readonly message: string;\n    readonly stack?: string;\n    readonly name?: string;\n    readonly errorInstanceId: string;\n\n    constructor(\n        errorProps: Omit<IFluidErrorBase,\n            \"getTelemetryProperties\" |\n            \"addTelemetryProperties\" |\n            \"errorInstanceId\">,\n    ) {\n        this.errorType = errorProps.errorType;\n        this.fluidErrorCode = errorProps.fluidErrorCode;\n        this.message = errorProps.message;\n        this.stack = errorProps.stack;\n        this.name = errorProps.name;\n        this.errorInstanceId = uuid();\n\n        this.addTelemetryProperties(errorProps);\n    }\n\n    getTelemetryProperties(): ITelemetryProperties {\n        return this.telemetryProps;\n    }\n\n    addTelemetryProperties(props: ITelemetryProperties) {\n        copyProps(this.telemetryProps, props);\n    }\n}\n\n/** For backwards compatibility with pre-fluidErrorCode valid errors */\nfunction patchWithErrorCode(\n    legacyError: Omit<IFluidErrorBase, \"fluidErrorCode\">,\n): asserts legacyError is IFluidErrorBase {\n    const patchMe: { -readonly [P in \"fluidErrorCode\"]?: IFluidErrorBase[P] } = legacyError as any;\n    if (patchMe.fluidErrorCode === undefined) {\n        patchMe.fluidErrorCode = \"<error predates fluidErrorCode>\";\n    }\n}\n\n/**\n * Normalize the given error yielding a valid Fluid Error\n * @returns A valid Fluid Error with any provided annotations applied\n * @param error - The error to normalize\n * @param annotations - Annotations to apply to the normalized error\n */\nexport function normalizeError(\n    error: unknown,\n    annotations: IFluidErrorAnnotations = {},\n): IFluidErrorBase {\n    // Back-compat, while IFluidErrorBase is rolled out\n    if (isValidLegacyError(error)) {\n        patchWithErrorCode(error);\n    }\n\n    if (isFluidError(error)) {\n        // We can simply add the telemetry props to the error and return it\n        error.addTelemetryProperties(annotations.props ?? {});\n        return error;\n    }\n\n    // We have to construct a new Fluid Error, copying safe properties over\n    const { message, stack } = extractLogSafeErrorProperties(error, false /* sanitizeStack */);\n    const fluidError: IFluidErrorBase = new SimpleFluidError({\n        errorType: \"genericError\", // Match Container/Driver generic error type\n        fluidErrorCode: \"\",\n        message,\n        stack: stack ?? generateStack(),\n    });\n\n    fluidError.addTelemetryProperties({\n        ...annotations.props,\n        untrustedOrigin: 1, // This will let us filter to errors not originated by our own code\n    });\n\n    if (typeof(error) !== \"object\") {\n        // This is only interesting for non-objects\n        fluidError.addTelemetryProperties({ typeofError: typeof(error) });\n    }\n    return fluidError;\n}\n\nexport function generateStack(): string | undefined {\n    // Some browsers will populate stack right away, others require throwing Error\n    let stack = new Error(\"<<generated stack>>\").stack;\n    if (!stack) {\n        try {\n            throw new Error(\"<<generated stack>>\");\n        } catch (e) {\n            stack = e.stack;\n        }\n    }\n    return stack;\n}\n\n/**\n * Create a new error, wrapping and caused by the given unknown error.\n * Copies the inner error's message and stack over but otherwise uses newErrorFn to define the error.\n * The inner error's instance id will also be logged for telemetry analysis.\n * @param innerError - An error from untrusted/unknown origins\n * @param newErrorFn - callback that will create a new error given the original error's message\n * @returns A new error object \"wrapping\" the given error\n */\n export function wrapError<T extends IFluidErrorBase>(\n    innerError: unknown,\n    newErrorFn: (message: string) => T,\n): T {\n    const {\n        message,\n        stack,\n    } = extractLogSafeErrorProperties(innerError, false /* sanitizeStack */);\n\n    const newError = newErrorFn(message);\n\n    if (stack !== undefined) {\n        // supposedly setting stack on an Error can throw.\n        try {\n            Object.assign(newError, { stack });\n        } catch (errorSettingStack) {\n            newError.addTelemetryProperties({ stack2: stack });\n        }\n    }\n\n    if (hasErrorInstanceId(innerError)) {\n        newError.addTelemetryProperties({ innerErrorInstanceId: innerError.errorInstanceId });\n    }\n\n    return newError;\n}\n\n/** The same as wrapError, but also logs the innerError, including the wrapping error's instance id */\nexport function wrapErrorAndLog<T extends IFluidErrorBase>(\n    innerError: unknown,\n    newErrorFn: (message: string) => T,\n    logger: ITelemetryLogger,\n) {\n    const newError = wrapError(innerError, newErrorFn);\n    const wrappedByErrorInstanceId = hasErrorInstanceId(newError)\n        ? newError.errorInstanceId\n        : undefined;\n\n    logger.sendTelemetryEvent({\n        eventName: \"WrapError\",\n        wrappedByErrorInstanceId,\n    }, innerError);\n\n    return newError;\n}\n\n/**\n * Type guard to identify if a particular value (loosely) appears to be a tagged telemetry property\n */\nexport function isTaggedTelemetryPropertyValue(x: any): x is ITaggedTelemetryPropertyType {\n    return (typeof(x?.value) !== \"object\" && typeof(x?.tag) === \"string\");\n}\n\n/**\n * Walk an object's enumerable properties to find those fit for telemetry.\n */\nfunction getValidTelemetryProps(obj: any, keysToOmit: Set<string>): ITelemetryProperties {\n    const props: ITelemetryProperties = {};\n    for (const key of Object.keys(obj)) {\n        if (keysToOmit.has(key)) {\n            continue;\n        }\n        const val = obj[key];\n        switch (typeof val) {\n            case \"string\":\n            case \"number\":\n            case \"boolean\":\n            case \"undefined\":\n                props[key] = val;\n                break;\n            default: {\n                if (isTaggedTelemetryPropertyValue(val)) {\n                    props[key] = val;\n                } else {\n                    // We don't support logging arbitrary objects\n                    props[key] = \"REDACTED (arbitrary object)\";\n                }\n                break;\n            }\n        }\n    }\n    return props;\n}\n\n/**\n * Base class for \"trusted\" errors we create, whose properties can generally be logged to telemetry safely.\n * All properties set on the object, or passed in (via the constructor or getTelemetryProperties),\n * will be logged in accordance with their tag, if present.\n *\n * PLEASE take care to avoid setting sensitive data on this object without proper tagging!\n */\nexport class LoggingError extends Error implements ILoggingError, Pick<IFluidErrorBase, \"errorInstanceId\"> {\n    readonly errorInstanceId = uuid();\n\n    /**\n     * Create a new LoggingError\n     * @param message - Error message to use for Error base class\n     * @param props - telemetry props to include on the error for when it's logged\n     * @param omitPropsFromLogging - properties by name to omit from telemetry props\n     */\n    constructor(\n        message: string,\n        props?: ITelemetryProperties,\n        private readonly omitPropsFromLogging: Set<string> = new Set(),\n    ) {\n        super(message);\n\n        // Don't log this list itself either\n        omitPropsFromLogging.add(\"omitPropsFromLogging\");\n\n        if (props) {\n            this.addTelemetryProperties(props);\n        }\n    }\n\n    /**\n     * Add additional properties to be logged\n     */\n    public addTelemetryProperties(props: ITelemetryProperties) {\n        copyProps(this, props);\n    }\n\n    /**\n     * Get all properties fit to be logged to telemetry for this error\n     */\n    public getTelemetryProperties(): ITelemetryProperties {\n        const taggableProps = getValidTelemetryProps(this, this.omitPropsFromLogging);\n        // Include non-enumerable props inherited from Error that are not returned by getValidTelemetryProps\n        return  {\n            ...taggableProps,\n            stack: this.stack,\n            message: this.message,\n        };\n    }\n}\n"]}

package/dist/eventEmitterWithErrorHandling.d.ts

@@ -11,8 +11,7 @@ import { TypedEventEmitter, EventEmitterEventType } from "@fluidframework/common
  */
 export declare class EventEmitterWithErrorHandling<TEvent extends IEvent = IEvent> extends TypedEventEmitter<TEvent> {
     private readonly errorHandler;
-    constructor(errorHandler?: (eventName: EventEmitterEventType, error: any) => void);
-    private defaultErrorHandler;
+    constructor(errorHandler: (eventName: EventEmitterEventType, error: any) => void);
     emit(event: EventEmitterEventType, ...args: any[]): boolean;
 }
 //# sourceMappingURL=eventEmitterWithErrorHandling.d.ts.map

package/dist/eventEmitterWithErrorHandling.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eventEmitterWithErrorHandling.d.ts","sourceRoot":"","sources":["../src/eventEmitterWithErrorHandling.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAExF;;;;GAIG;AACH,qBAAa,6BAA6B,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,iBAAiB,CAAC,MAAM,CAAC;IACxG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAyD;gBAE1E,YAAY,CAAC,EAAE,CAAC,SAAS,EAAE,qBAAqB,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI;IAKjF,OAAO,CAAC,mBAAmB;IAWpB,IAAI,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;CAQrE"}
+{"version":3,"file":"eventEmitterWithErrorHandling.d.ts","sourceRoot":"","sources":["../src/eventEmitterWithErrorHandling.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAExF;;;;GAIG;AACH,qBAAa,6BAA6B,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,iBAAiB,CAAC,MAAM,CAAC;IAC5F,OAAO,CAAC,QAAQ,CAAE,YAAY;gBAAZ,YAAY,EAAE,CAAC,SAAS,EAAE,qBAAqB,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI;IAI3F,IAAI,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;CAQrE"}

package/dist/eventEmitterWithErrorHandling.js

@@ -10,16 +10,7 @@ const common_utils_1 = require("@fluidframework/common-utils");
 class EventEmitterWithErrorHandling extends common_utils_1.TypedEventEmitter {
     constructor(errorHandler) {
         super();
-        this.errorHandler = errorHandler !== null && errorHandler !== void 0 ? errorHandler : this.defaultErrorHandler.bind(this);
-    }
-    defaultErrorHandler(event, error) {
-        // Some listener threw an error, we'll try emitting that error via the error event
-        // But not if we're already dealing with the error event, in that case just let the error be thrown
-        if (event === "error") {
-            throw error;
-        }
-        // Note: This will throw if no listeners are registered for the error event
-        super.emit("error", error);
+        this.errorHandler = errorHandler;
     }
     emit(event, ...args) {
         try {

package/dist/eventEmitterWithErrorHandling.js.map

@@ -1 +1 @@
-{"version":3,"file":"eventEmitterWithErrorHandling.js","sourceRoot":"","sources":["../src/eventEmitterWithErrorHandling.ts"],"names":[],"mappings":";;;AAKA,+DAAwF;AAExF;;;;GAIG;AACH,MAAa,6BAA8D,SAAQ,gCAAyB;IAGxG,YAAY,YAAqE;QAC7E,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,YAAY,GAAG,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5E,CAAC;IAEO,mBAAmB,CAAC,KAAK,EAAE,KAAK;QACpC,kFAAkF;QAClF,mGAAmG;QACnG,IAAI,KAAK,KAAK,OAAO,EAAE;YACnB,MAAM,KAAK,CAAC;SACf;QAED,2EAA2E;QAC3E,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC;IAEM,IAAI,CAAC,KAA4B,EAAE,GAAG,IAAW;QACpD,IAAI;YACA,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;SACrC;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAChC,OAAO,IAAI,CAAC;SACf;IACL,CAAC;CACJ;AA3BD,sEA2BC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IEvent } from \"@fluidframework/common-definitions\";\nimport { TypedEventEmitter, EventEmitterEventType } from \"@fluidframework/common-utils\";\n\n/**\n * Event Emitter helper class\n * Any exceptions thrown by listeners will be caught and raised through \"error\" event.\n * Any exception thrown by \"error\" listeners will propagate to the caller.\n */\nexport class EventEmitterWithErrorHandling<TEvent extends IEvent = IEvent> extends TypedEventEmitter<TEvent> {\n    private readonly errorHandler: (eventName: EventEmitterEventType, error: any) => void;\n\n    constructor(errorHandler?: (eventName: EventEmitterEventType, error: any) => void) {\n        super();\n        this.errorHandler = errorHandler ?? this.defaultErrorHandler.bind(this);\n    }\n\n    private defaultErrorHandler(event, error) {\n        // Some listener threw an error, we'll try emitting that error via the error event\n        // But not if we're already dealing with the error event, in that case just let the error be thrown\n        if (event === \"error\") {\n            throw error;\n        }\n\n        // Note: This will throw if no listeners are registered for the error event\n        super.emit(\"error\", error);\n    }\n\n    public emit(event: EventEmitterEventType, ...args: any[]): boolean {\n        try {\n            return super.emit(event, ...args);\n        } catch (error) {\n            this.errorHandler(event, error);\n            return true;\n        }\n    }\n}\n"]}
+{"version":3,"file":"eventEmitterWithErrorHandling.js","sourceRoot":"","sources":["../src/eventEmitterWithErrorHandling.ts"],"names":[],"mappings":";;;AAKA,+DAAwF;AAExF;;;;GAIG;AACH,MAAa,6BAA8D,SAAQ,gCAAyB;IACxG,YAA8B,YAAoE;QAC9F,KAAK,EAAE,CAAC;QADkB,iBAAY,GAAZ,YAAY,CAAwD;IAElG,CAAC;IAEM,IAAI,CAAC,KAA4B,EAAE,GAAG,IAAW;QACpD,IAAI;YACA,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;SACrC;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAChC,OAAO,IAAI,CAAC;SACf;IACL,CAAC;CACJ;AAbD,sEAaC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IEvent } from \"@fluidframework/common-definitions\";\nimport { TypedEventEmitter, EventEmitterEventType } from \"@fluidframework/common-utils\";\n\n/**\n * Event Emitter helper class\n * Any exceptions thrown by listeners will be caught and raised through \"error\" event.\n * Any exception thrown by \"error\" listeners will propagate to the caller.\n */\nexport class EventEmitterWithErrorHandling<TEvent extends IEvent = IEvent> extends TypedEventEmitter<TEvent> {\n    constructor(private readonly  errorHandler: (eventName: EventEmitterEventType, error: any) => void) {\n        super();\n    }\n\n    public emit(event: EventEmitterEventType, ...args: any[]): boolean {\n        try {\n            return super.emit(event, ...args);\n        } catch (error) {\n            this.errorHandler(event, error);\n            return true;\n        }\n    }\n}\n"]}

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/telemetry-utils";
-export declare const pkgVersion = "0.50.3";
+export declare const pkgVersion = "0.51.2";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/telemetry-utils";
-exports.pkgVersion = "0.50.3";
+exports.pkgVersion = "0.51.2";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,iCAAiC,CAAC;AAC5C,QAAA,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/telemetry-utils\";\nexport const pkgVersion = \"0.50.3\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,iCAAiC,CAAC;AAC5C,QAAA,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/telemetry-utils\";\nexport const pkgVersion = \"0.51.2\";\n"]}

package/lib/errorLogging.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { ILoggingError, ITaggedTelemetryPropertyType, ITelemetryProperties } from "@fluidframework/common-definitions";
+import { ILoggingError, ITaggedTelemetryPropertyType, ITelemetryLogger, ITelemetryProperties } from "@fluidframework/common-definitions";
 import { IFluidErrorBase } from "./fluidErrorBase";
 /** Inspect the given error for common "safe" props and return them */
 export declare function extractLogSafeErrorProperties(error: any, sanitizeStack: boolean): {
@@ -16,8 +16,6 @@ export declare const isILoggingError: (x: any) => x is ILoggingError;
 export interface IFluidErrorAnnotations {
     /** Telemetry props to log with the error */
     props?: ITelemetryProperties;
-    /** fluidErrorCode to mention if error isn't already an IFluidErrorBase */
-    errorCodeIfNone?: string;
 }
 /**
  * Normalize the given error yielding a valid Fluid Error
@@ -27,6 +25,17 @@ export interface IFluidErrorAnnotations {
  */
 export declare function normalizeError(error: unknown, annotations?: IFluidErrorAnnotations): IFluidErrorBase;
 export declare function generateStack(): string | undefined;
+/**
+ * Create a new error, wrapping and caused by the given unknown error.
+ * Copies the inner error's message and stack over but otherwise uses newErrorFn to define the error.
+ * The inner error's instance id will also be logged for telemetry analysis.
+ * @param innerError - An error from untrusted/unknown origins
+ * @param newErrorFn - callback that will create a new error given the original error's message
+ * @returns A new error object "wrapping" the given error
+ */
+export declare function wrapError<T extends IFluidErrorBase>(innerError: unknown, newErrorFn: (message: string) => T): T;
+/** The same as wrapError, but also logs the innerError, including the wrapping error's instance id */
+export declare function wrapErrorAndLog<T extends IFluidErrorBase>(innerError: unknown, newErrorFn: (message: string) => T, logger: ITelemetryLogger): T;
 /**
  * Type guard to identify if a particular value (loosely) appears to be a tagged telemetry property
  */

package/lib/errorLogging.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errorLogging.d.ts","sourceRoot":"","sources":["../src/errorLogging.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,aAAa,EACb,4BAA4B,EAC5B,oBAAoB,EACvB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EACH,eAAe,EAGlB,MAAM,kBAAkB,CAAC;AAO1B,sEAAsE;AACtE,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,GAAG,EAAE,aAAa,EAAE,OAAO;aAiBhD,MAAM;;;EAkBrC;AAED,6CAA6C;AAC7C,eAAO,MAAM,eAAe,MAAO,GAAG,uBAAwE,CAAC;AAW/G,6EAA6E;AAC7E,MAAM,WAAW,sBAAsB;IACnC,4CAA4C;IAC5C,KAAK,CAAC,EAAE,oBAAoB,CAAC;IAC7B,0EAA0E;IAC1E,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAiDD;;;;;GAKG;AACH,wBAAgB,cAAc,CAC1B,KAAK,EAAE,OAAO,EACd,WAAW,GAAE,sBAA2B,GACzC,eAAe,CA+BjB;AAED,wBAAgB,aAAa,IAAI,MAAM,GAAG,SAAS,CAWlD;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,4BAA4B,CAExF;AAiCD;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,KAAM,YAAW,aAAa,EAAE,IAAI,CAAC,eAAe,EAAE,iBAAiB,CAAC;IAYlG,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IAXzC,QAAQ,CAAC,eAAe,SAAU;IAElC;;;;;OAKG;gBAEC,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,oBAAoB,EACX,oBAAoB,GAAE,GAAG,CAAC,MAAM,CAAa;IAYlE;;OAEG;IACI,sBAAsB,CAAC,KAAK,EAAE,oBAAoB;IAIzD;;OAEG;IACI,sBAAsB,IAAI,oBAAoB;CASxD"}
+{"version":3,"file":"errorLogging.d.ts","sourceRoot":"","sources":["../src/errorLogging.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,aAAa,EACb,4BAA4B,EAC5B,gBAAgB,EAChB,oBAAoB,EACvB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAEH,eAAe,EAGlB,MAAM,kBAAkB,CAAC;AAO1B,sEAAsE;AACtE,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,GAAG,EAAE,aAAa,EAAE,OAAO;aAiBhD,MAAM;;;EAkBrC;AAED,6CAA6C;AAC7C,eAAO,MAAM,eAAe,MAAO,GAAG,uBAAwE,CAAC;AAW/G,6EAA6E;AAC7E,MAAM,WAAW,sBAAsB;IACnC,4CAA4C;IAC5C,KAAK,CAAC,EAAE,oBAAoB,CAAC;CAChC;AAgDD;;;;;GAKG;AACH,wBAAgB,cAAc,CAC1B,KAAK,EAAE,OAAO,EACd,WAAW,GAAE,sBAA2B,GACzC,eAAe,CA+BjB;AAED,wBAAgB,aAAa,IAAI,MAAM,GAAG,SAAS,CAWlD;AAED;;;;;;;GAOG;AACF,wBAAgB,SAAS,CAAC,CAAC,SAAS,eAAe,EAChD,UAAU,EAAE,OAAO,EACnB,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,CAAC,GACnC,CAAC,CAsBH;AAED,sGAAsG;AACtG,wBAAgB,eAAe,CAAC,CAAC,SAAS,eAAe,EACrD,UAAU,EAAE,OAAO,EACnB,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,CAAC,EAClC,MAAM,EAAE,gBAAgB,KAa3B;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,4BAA4B,CAExF;AAiCD;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,KAAM,YAAW,aAAa,EAAE,IAAI,CAAC,eAAe,EAAE,iBAAiB,CAAC;IAYlG,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IAXzC,QAAQ,CAAC,eAAe,SAAU;IAElC;;;;;OAKG;gBAEC,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,oBAAoB,EACX,oBAAoB,GAAE,GAAG,CAAC,MAAM,CAAa;IAYlE;;OAEG;IACI,sBAAsB,CAAC,KAAK,EAAE,oBAAoB;IAIzD;;OAEG;IACI,sBAAsB,IAAI,oBAAoB;CASxD"}

package/lib/errorLogging.js

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 import { v4 as uuid } from "uuid";
-import { isFluidError, isValidLegacyError, } from "./fluidErrorBase";
+import { hasErrorInstanceId, isFluidError, isValidLegacyError, } from "./fluidErrorBase";
 /** @returns true if value is an object but neither null nor an array */
 const isRegularObject = (value) => {
     return value !== null && !Array.isArray(value) && typeof value === "object";
@@ -69,10 +69,10 @@ class SimpleFluidError {
     }
 }
 /** For backwards compatibility with pre-fluidErrorCode valid errors */
-function patchWithErrorCode(legacyError, errorCode = "<error predates fluidErrorCode>") {
+function patchWithErrorCode(legacyError) {
     const patchMe = legacyError;
     if (patchMe.fluidErrorCode === undefined) {
-        patchMe.fluidErrorCode = errorCode;
+        patchMe.fluidErrorCode = "<error predates fluidErrorCode>";
     }
 }
 /**
@@ -82,10 +82,10 @@ function patchWithErrorCode(legacyError, errorCode = "<error predates fluidError
  * @param annotations - Annotations to apply to the normalized error
  */
 export function normalizeError(error, annotations = {}) {
-    var _a, _b;
+    var _a;
     // Back-compat, while IFluidErrorBase is rolled out
     if (isValidLegacyError(error)) {
-        patchWithErrorCode(error, annotations.errorCodeIfNone);
+        patchWithErrorCode(error);
     }
     if (isFluidError(error)) {
         // We can simply add the telemetry props to the error and return it
@@ -96,7 +96,7 @@ export function normalizeError(error, annotations = {}) {
     const { message, stack } = extractLogSafeErrorProperties(error, false /* sanitizeStack */);
     const fluidError = new SimpleFluidError({
         errorType: "genericError",
-        fluidErrorCode: (_b = annotations.errorCodeIfNone) !== null && _b !== void 0 ? _b : "none",
+        fluidErrorCode: "",
         message,
         stack: stack !== null && stack !== void 0 ? stack : generateStack(),
     });
@@ -120,6 +120,43 @@ export function generateStack() {
     }
     return stack;
 }
+/**
+ * Create a new error, wrapping and caused by the given unknown error.
+ * Copies the inner error's message and stack over but otherwise uses newErrorFn to define the error.
+ * The inner error's instance id will also be logged for telemetry analysis.
+ * @param innerError - An error from untrusted/unknown origins
+ * @param newErrorFn - callback that will create a new error given the original error's message
+ * @returns A new error object "wrapping" the given error
+ */
+export function wrapError(innerError, newErrorFn) {
+    const { message, stack, } = extractLogSafeErrorProperties(innerError, false /* sanitizeStack */);
+    const newError = newErrorFn(message);
+    if (stack !== undefined) {
+        // supposedly setting stack on an Error can throw.
+        try {
+            Object.assign(newError, { stack });
+        }
+        catch (errorSettingStack) {
+            newError.addTelemetryProperties({ stack2: stack });
+        }
+    }
+    if (hasErrorInstanceId(innerError)) {
+        newError.addTelemetryProperties({ innerErrorInstanceId: innerError.errorInstanceId });
+    }
+    return newError;
+}
+/** The same as wrapError, but also logs the innerError, including the wrapping error's instance id */
+export function wrapErrorAndLog(innerError, newErrorFn, logger) {
+    const newError = wrapError(innerError, newErrorFn);
+    const wrappedByErrorInstanceId = hasErrorInstanceId(newError)
+        ? newError.errorInstanceId
+        : undefined;
+    logger.sendTelemetryEvent({
+        eventName: "WrapError",
+        wrappedByErrorInstanceId,
+    }, innerError);
+    return newError;
+}
 /**
  * Type guard to identify if a particular value (loosely) appears to be a tagged telemetry property
  */

package/lib/errorLogging.js.map

@@ -1 +1 @@
-{"version":3,"file":"errorLogging.js","sourceRoot":"","sources":["../src/errorLogging.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAOH,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EAEH,YAAY,EACZ,kBAAkB,GACrB,MAAM,kBAAkB,CAAC;AAE1B,wEAAwE;AACxE,MAAM,eAAe,GAAG,CAAC,KAAU,EAAW,EAAE;IAC5C,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAChF,CAAC,CAAC;AAEF,sEAAsE;AACtE,MAAM,UAAU,6BAA6B,CAAC,KAAU,EAAE,aAAsB;IAC5E,MAAM,sBAAsB,GAAG,CAAC,KAAa,EAAE,SAAkB,EAAE,EAAE;QACjE,IAAI,CAAC,aAAa,EAAE;YAChB,OAAO,KAAK,CAAC;SAChB;QACD,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtC,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC,uCAAuC;QAC5D,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB;SACvD;QACD,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,QAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,CAAA,KAAK,QAAQ,CAAC;QAChD,CAAC,CAAC,KAAK,CAAC,OAAiB;QACzB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEpB,MAAM,SAAS,GAA4D;QACvE,OAAO;KACV,CAAC;IAEF,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE;QACxB,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QAEzC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YAC/B,SAAS,CAAC,SAAS,GAAG,SAAS,CAAC;SACnC;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC3B,MAAM,SAAS,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,SAAS,CAAC,KAAK,GAAG,sBAAsB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;SAC9D;KACJ;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,6CAA6C;AAC7C,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAM,EAAsB,EAAE,CAAC,QAAO,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,sBAAsB,CAAA,KAAK,UAAU,CAAC;AAE/G,6FAA6F;AAC7F,SAAS,SAAS,CAAC,MAA2C,EAAE,MAA4B;IACxF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;QACnC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;YAC3B,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;SAC7B;KACJ;AACL,CAAC;AAUD,0DAA0D;AAC1D,MAAM,gBAAgB;IAUlB,YACI,UAGsB;QAbT,mBAAc,GAAyB,EAAE,CAAC;QAevD,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,eAAe,GAAG,IAAI,EAAE,CAAC;QAE9B,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,sBAAsB;QAClB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAED,sBAAsB,CAAC,KAA2B;QAC9C,SAAS,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;CACJ;AAED,uEAAuE;AACvE,SAAS,kBAAkB,CACvB,WAAoD,EACpD,YAAoB,iCAAiC;IAErD,MAAM,OAAO,GAAgC,WAAkB,CAAC;IAChE,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE;QACtC,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;KACtC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAC1B,KAAc,EACd,cAAsC,EAAE;;IAExC,mDAAmD;IACnD,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE;QAC3B,kBAAkB,CAAC,KAAK,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC;KAC1D;IAED,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE;QACrB,mEAAmE;QACnE,KAAK,CAAC,sBAAsB,OAAC,WAAW,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC;QACtD,OAAO,KAAK,CAAC;KAChB;IAED,uEAAuE;IACvE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,6BAA6B,CAAC,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC3F,MAAM,UAAU,GAAoB,IAAI,gBAAgB,CAAC;QACrD,SAAS,EAAE,cAAc;QACzB,cAAc,QAAE,WAAW,CAAC,eAAe,mCAAI,MAAM;QACrD,OAAO;QACP,KAAK,EAAE,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,aAAa,EAAE;KAClC,CAAC,CAAC;IAEH,UAAU,CAAC,sBAAsB,iCAC1B,WAAW,CAAC,KAAK,KACpB,eAAe,EAAE,CAAC,IACpB,CAAC;IAEH,IAAI,OAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE;QAC5B,2CAA2C;QAC3C,UAAU,CAAC,sBAAsB,CAAC,EAAE,WAAW,EAAE,OAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KACrE;IACD,OAAO,UAAU,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,aAAa;IACzB,8EAA8E;IAC9E,IAAI,KAAK,GAAG,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,KAAK,CAAC;IACnD,IAAI,CAAC,KAAK,EAAE;QACR,IAAI;YACA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SAC1C;QAAC,OAAO,CAAC,EAAE;YACR,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;SACnB;KACJ;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAAC,CAAM;IACjD,OAAO,CAAC,OAAM,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,CAAC,KAAK,QAAQ,IAAI,OAAM,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,GAAG,CAAC,KAAK,QAAQ,CAAC,CAAC;AAC1E,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,GAAQ,EAAE,UAAuB;IAC7D,MAAM,KAAK,GAAyB,EAAE,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAChC,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACrB,SAAS;SACZ;QACD,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,QAAQ,OAAO,GAAG,EAAE;YAChB,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,WAAW;gBACZ,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;gBACjB,MAAM;YACV,OAAO,CAAC,CAAC;gBACL,IAAI,8BAA8B,CAAC,GAAG,CAAC,EAAE;oBACrC,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;iBACpB;qBAAM;oBACH,6CAA6C;oBAC7C,KAAK,CAAC,GAAG,CAAC,GAAG,6BAA6B,CAAC;iBAC9C;gBACD,MAAM;aACT;SACJ;KACJ;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IAGnC;;;;;OAKG;IACH,YACI,OAAe,EACf,KAA4B,EACX,uBAAoC,IAAI,GAAG,EAAE;QAE9D,KAAK,CAAC,OAAO,CAAC,CAAC;QAFE,yBAAoB,GAApB,oBAAoB,CAAyB;QAXzD,oBAAe,GAAG,IAAI,EAAE,CAAC;QAe9B,oCAAoC;QACpC,oBAAoB,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QAEjD,IAAI,KAAK,EAAE;YACP,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;SACtC;IACL,CAAC;IAED;;OAEG;IACI,sBAAsB,CAAC,KAA2B;QACrD,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,sBAAsB;QACzB,MAAM,aAAa,GAAG,sBAAsB,CAAC,IAAI,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC9E,oGAAoG;QACpG,uCACO,aAAa,KAChB,KAAK,EAAE,IAAI,CAAC,KAAK,EACjB,OAAO,EAAE,IAAI,CAAC,OAAO,IACvB;IACN,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    ILoggingError,\n    ITaggedTelemetryPropertyType,\n    ITelemetryProperties,\n} from \"@fluidframework/common-definitions\";\nimport { v4 as uuid } from \"uuid\";\nimport {\n    IFluidErrorBase,\n    isFluidError,\n    isValidLegacyError,\n} from \"./fluidErrorBase\";\n\n/** @returns true if value is an object but neither null nor an array */\nconst isRegularObject = (value: any): boolean => {\n    return value !== null && !Array.isArray(value) && typeof value === \"object\";\n};\n\n/** Inspect the given error for common \"safe\" props and return them */\nexport function extractLogSafeErrorProperties(error: any, sanitizeStack: boolean) {\n    const removeMessageFromStack = (stack: string, errorName?: string) => {\n        if (!sanitizeStack) {\n            return stack;\n        }\n        const stackFrames = stack.split(\"\\n\");\n        stackFrames.shift(); // Remove \"[ErrorName]: [ErrorMessage]\"\n        if (errorName !== undefined) {\n            stackFrames.unshift(errorName); // Add \"[ErrorName]\"\n        }\n        return stackFrames.join(\"\\n\");\n    };\n\n    const message = (typeof error?.message === \"string\")\n        ? error.message as string\n        : String(error);\n\n    const safeProps: { message: string; errorType?: string; stack?: string } = {\n        message,\n    };\n\n    if (isRegularObject(error)) {\n        const { errorType, stack, name } = error;\n\n        if (typeof errorType === \"string\") {\n            safeProps.errorType = errorType;\n        }\n\n        if (typeof stack === \"string\") {\n            const errorName = (typeof name === \"string\") ? name : undefined;\n            safeProps.stack = removeMessageFromStack(stack, errorName);\n        }\n    }\n\n    return safeProps;\n}\n\n/** type guard for ILoggingError interface */\nexport const isILoggingError = (x: any): x is ILoggingError => typeof x?.getTelemetryProperties === \"function\";\n\n/** Copy props from source onto target, but do not overwrite an existing prop that matches */\nfunction copyProps(target: ITelemetryProperties | LoggingError, source: ITelemetryProperties) {\n    for (const key of Object.keys(source)) {\n        if (target[key] === undefined) {\n            target[key] = source[key];\n        }\n    }\n}\n\n/** Metadata to annotate an error object when annotating or normalizing it */\nexport interface IFluidErrorAnnotations {\n    /** Telemetry props to log with the error */\n    props?: ITelemetryProperties;\n    /** fluidErrorCode to mention if error isn't already an IFluidErrorBase */\n    errorCodeIfNone?: string;\n}\n\n/** Simplest possible implementation of IFluidErrorBase */\nclass SimpleFluidError implements IFluidErrorBase {\n    private readonly telemetryProps: ITelemetryProperties = {};\n\n    readonly errorType: string;\n    readonly fluidErrorCode: string;\n    readonly message: string;\n    readonly stack?: string;\n    readonly name?: string;\n    readonly errorInstanceId: string;\n\n    constructor(\n        errorProps: Omit<IFluidErrorBase,\n            \"getTelemetryProperties\" |\n            \"addTelemetryProperties\" |\n            \"errorInstanceId\">,\n    ) {\n        this.errorType = errorProps.errorType;\n        this.fluidErrorCode = errorProps.fluidErrorCode;\n        this.message = errorProps.message;\n        this.stack = errorProps.stack;\n        this.name = errorProps.name;\n        this.errorInstanceId = uuid();\n\n        this.addTelemetryProperties(errorProps);\n    }\n\n    getTelemetryProperties(): ITelemetryProperties {\n        return this.telemetryProps;\n    }\n\n    addTelemetryProperties(props: ITelemetryProperties) {\n        copyProps(this.telemetryProps, props);\n    }\n}\n\n/** For backwards compatibility with pre-fluidErrorCode valid errors */\nfunction patchWithErrorCode(\n    legacyError: Omit<IFluidErrorBase, \"fluidErrorCode\">,\n    errorCode: string = \"<error predates fluidErrorCode>\",\n): asserts legacyError is IFluidErrorBase {\n    const patchMe: { fluidErrorCode?: string } = legacyError as any;\n    if (patchMe.fluidErrorCode === undefined) {\n        patchMe.fluidErrorCode = errorCode;\n    }\n}\n\n/**\n * Normalize the given error yielding a valid Fluid Error\n * @returns A valid Fluid Error with any provided annotations applied\n * @param error - The error to normalize\n * @param annotations - Annotations to apply to the normalized error\n */\nexport function normalizeError(\n    error: unknown,\n    annotations: IFluidErrorAnnotations = {},\n): IFluidErrorBase {\n    // Back-compat, while IFluidErrorBase is rolled out\n    if (isValidLegacyError(error)) {\n        patchWithErrorCode(error, annotations.errorCodeIfNone);\n    }\n\n    if (isFluidError(error)) {\n        // We can simply add the telemetry props to the error and return it\n        error.addTelemetryProperties(annotations.props ?? {});\n        return error;\n    }\n\n    // We have to construct a new Fluid Error, copying safe properties over\n    const { message, stack } = extractLogSafeErrorProperties(error, false /* sanitizeStack */);\n    const fluidError: IFluidErrorBase = new SimpleFluidError({\n        errorType: \"genericError\", // Match Container/Driver generic error type\n        fluidErrorCode: annotations.errorCodeIfNone ?? \"none\",\n        message,\n        stack: stack ?? generateStack(),\n    });\n\n    fluidError.addTelemetryProperties({\n        ...annotations.props,\n        untrustedOrigin: 1, // This will let us filter to errors not originated by our own code\n    });\n\n    if (typeof(error) !== \"object\") {\n        // This is only interesting for non-objects\n        fluidError.addTelemetryProperties({ typeofError: typeof(error) });\n    }\n    return fluidError;\n}\n\nexport function generateStack(): string | undefined {\n    // Some browsers will populate stack right away, others require throwing Error\n    let stack = new Error(\"<<generated stack>>\").stack;\n    if (!stack) {\n        try {\n            throw new Error(\"<<generated stack>>\");\n        } catch (e) {\n            stack = e.stack;\n        }\n    }\n    return stack;\n}\n\n/**\n * Type guard to identify if a particular value (loosely) appears to be a tagged telemetry property\n */\nexport function isTaggedTelemetryPropertyValue(x: any): x is ITaggedTelemetryPropertyType {\n    return (typeof(x?.value) !== \"object\" && typeof(x?.tag) === \"string\");\n}\n\n/**\n * Walk an object's enumerable properties to find those fit for telemetry.\n */\nfunction getValidTelemetryProps(obj: any, keysToOmit: Set<string>): ITelemetryProperties {\n    const props: ITelemetryProperties = {};\n    for (const key of Object.keys(obj)) {\n        if (keysToOmit.has(key)) {\n            continue;\n        }\n        const val = obj[key];\n        switch (typeof val) {\n            case \"string\":\n            case \"number\":\n            case \"boolean\":\n            case \"undefined\":\n                props[key] = val;\n                break;\n            default: {\n                if (isTaggedTelemetryPropertyValue(val)) {\n                    props[key] = val;\n                } else {\n                    // We don't support logging arbitrary objects\n                    props[key] = \"REDACTED (arbitrary object)\";\n                }\n                break;\n            }\n        }\n    }\n    return props;\n}\n\n/**\n * Base class for \"trusted\" errors we create, whose properties can generally be logged to telemetry safely.\n * All properties set on the object, or passed in (via the constructor or getTelemetryProperties),\n * will be logged in accordance with their tag, if present.\n *\n * PLEASE take care to avoid setting sensitive data on this object without proper tagging!\n */\nexport class LoggingError extends Error implements ILoggingError, Pick<IFluidErrorBase, \"errorInstanceId\"> {\n    readonly errorInstanceId = uuid();\n\n    /**\n     * Create a new LoggingError\n     * @param message - Error message to use for Error base class\n     * @param props - telemetry props to include on the error for when it's logged\n     * @param omitPropsFromLogging - properties by name to omit from telemetry props\n     */\n    constructor(\n        message: string,\n        props?: ITelemetryProperties,\n        private readonly omitPropsFromLogging: Set<string> = new Set(),\n    ) {\n        super(message);\n\n        // Don't log this list itself either\n        omitPropsFromLogging.add(\"omitPropsFromLogging\");\n\n        if (props) {\n            this.addTelemetryProperties(props);\n        }\n    }\n\n    /**\n     * Add additional properties to be logged\n     */\n    public addTelemetryProperties(props: ITelemetryProperties) {\n        copyProps(this, props);\n    }\n\n    /**\n     * Get all properties fit to be logged to telemetry for this error\n     */\n    public getTelemetryProperties(): ITelemetryProperties {\n        const taggableProps = getValidTelemetryProps(this, this.omitPropsFromLogging);\n        // Include non-enumerable props inherited from Error that are not returned by getValidTelemetryProps\n        return  {\n            ...taggableProps,\n            stack: this.stack,\n            message: this.message,\n        };\n    }\n}\n"]}
+{"version":3,"file":"errorLogging.js","sourceRoot":"","sources":["../src/errorLogging.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAQH,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAC;AAClC,OAAO,EACH,kBAAkB,EAElB,YAAY,EACZ,kBAAkB,GACrB,MAAM,kBAAkB,CAAC;AAE1B,wEAAwE;AACxE,MAAM,eAAe,GAAG,CAAC,KAAU,EAAW,EAAE;IAC5C,OAAO,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAChF,CAAC,CAAC;AAEF,sEAAsE;AACtE,MAAM,UAAU,6BAA6B,CAAC,KAAU,EAAE,aAAsB;IAC5E,MAAM,sBAAsB,GAAG,CAAC,KAAa,EAAE,SAAkB,EAAE,EAAE;QACjE,IAAI,CAAC,aAAa,EAAE;YAChB,OAAO,KAAK,CAAC;SAChB;QACD,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtC,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC,uCAAuC;QAC5D,IAAI,SAAS,KAAK,SAAS,EAAE;YACzB,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB;SACvD;QACD,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,QAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,CAAA,KAAK,QAAQ,CAAC;QAChD,CAAC,CAAC,KAAK,CAAC,OAAiB;QACzB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEpB,MAAM,SAAS,GAA4D;QACvE,OAAO;KACV,CAAC;IAEF,IAAI,eAAe,CAAC,KAAK,CAAC,EAAE;QACxB,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QAEzC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YAC/B,SAAS,CAAC,SAAS,GAAG,SAAS,CAAC;SACnC;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC3B,MAAM,SAAS,GAAG,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,SAAS,CAAC,KAAK,GAAG,sBAAsB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;SAC9D;KACJ;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,6CAA6C;AAC7C,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAM,EAAsB,EAAE,CAAC,QAAO,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,sBAAsB,CAAA,KAAK,UAAU,CAAC;AAE/G,6FAA6F;AAC7F,SAAS,SAAS,CAAC,MAA2C,EAAE,MAA4B;IACxF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;QACnC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;YAC3B,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;SAC7B;KACJ;AACL,CAAC;AAQD,0DAA0D;AAC1D,MAAM,gBAAgB;IAUlB,YACI,UAGsB;QAbT,mBAAc,GAAyB,EAAE,CAAC;QAevD,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;QACtC,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;QAChD,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,eAAe,GAAG,IAAI,EAAE,CAAC;QAE9B,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,sBAAsB;QAClB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAED,sBAAsB,CAAC,KAA2B;QAC9C,SAAS,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAC1C,CAAC;CACJ;AAED,uEAAuE;AACvE,SAAS,kBAAkB,CACvB,WAAoD;IAEpD,MAAM,OAAO,GAA+D,WAAkB,CAAC;IAC/F,IAAI,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE;QACtC,OAAO,CAAC,cAAc,GAAG,iCAAiC,CAAC;KAC9D;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAC1B,KAAc,EACd,cAAsC,EAAE;;IAExC,mDAAmD;IACnD,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE;QAC3B,kBAAkB,CAAC,KAAK,CAAC,CAAC;KAC7B;IAED,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE;QACrB,mEAAmE;QACnE,KAAK,CAAC,sBAAsB,OAAC,WAAW,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC;QACtD,OAAO,KAAK,CAAC;KAChB;IAED,uEAAuE;IACvE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,6BAA6B,CAAC,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC3F,MAAM,UAAU,GAAoB,IAAI,gBAAgB,CAAC;QACrD,SAAS,EAAE,cAAc;QACzB,cAAc,EAAE,EAAE;QAClB,OAAO;QACP,KAAK,EAAE,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,aAAa,EAAE;KAClC,CAAC,CAAC;IAEH,UAAU,CAAC,sBAAsB,iCAC1B,WAAW,CAAC,KAAK,KACpB,eAAe,EAAE,CAAC,IACpB,CAAC;IAEH,IAAI,OAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE;QAC5B,2CAA2C;QAC3C,UAAU,CAAC,sBAAsB,CAAC,EAAE,WAAW,EAAE,OAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KACrE;IACD,OAAO,UAAU,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,aAAa;IACzB,8EAA8E;IAC9E,IAAI,KAAK,GAAG,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,KAAK,CAAC;IACnD,IAAI,CAAC,KAAK,EAAE;QACR,IAAI;YACA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SAC1C;QAAC,OAAO,CAAC,EAAE;YACR,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;SACnB;KACJ;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;;;GAOG;AACF,MAAM,UAAU,SAAS,CACtB,UAAmB,EACnB,UAAkC;IAElC,MAAM,EACF,OAAO,EACP,KAAK,GACR,GAAG,6BAA6B,CAAC,UAAU,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAEzE,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAErC,IAAI,KAAK,KAAK,SAAS,EAAE;QACrB,kDAAkD;QAClD,IAAI;YACA,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;SACtC;QAAC,OAAO,iBAAiB,EAAE;YACxB,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;SACtD;KACJ;IAED,IAAI,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAChC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,oBAAoB,EAAE,UAAU,CAAC,eAAe,EAAE,CAAC,CAAC;KACzF;IAED,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED,sGAAsG;AACtG,MAAM,UAAU,eAAe,CAC3B,UAAmB,EACnB,UAAkC,EAClC,MAAwB;IAExB,MAAM,QAAQ,GAAG,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACnD,MAAM,wBAAwB,GAAG,kBAAkB,CAAC,QAAQ,CAAC;QACzD,CAAC,CAAC,QAAQ,CAAC,eAAe;QAC1B,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,CAAC,kBAAkB,CAAC;QACtB,SAAS,EAAE,WAAW;QACtB,wBAAwB;KAC3B,EAAE,UAAU,CAAC,CAAC;IAEf,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAAC,CAAM;IACjD,OAAO,CAAC,OAAM,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,KAAK,CAAC,KAAK,QAAQ,IAAI,OAAM,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,GAAG,CAAC,KAAK,QAAQ,CAAC,CAAC;AAC1E,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,GAAQ,EAAE,UAAuB;IAC7D,MAAM,KAAK,GAAyB,EAAE,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAChC,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACrB,SAAS;SACZ;QACD,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACrB,QAAQ,OAAO,GAAG,EAAE;YAChB,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,WAAW;gBACZ,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;gBACjB,MAAM;YACV,OAAO,CAAC,CAAC;gBACL,IAAI,8BAA8B,CAAC,GAAG,CAAC,EAAE;oBACrC,KAAK,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;iBACpB;qBAAM;oBACH,6CAA6C;oBAC7C,KAAK,CAAC,GAAG,CAAC,GAAG,6BAA6B,CAAC;iBAC9C;gBACD,MAAM;aACT;SACJ;KACJ;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IAGnC;;;;;OAKG;IACH,YACI,OAAe,EACf,KAA4B,EACX,uBAAoC,IAAI,GAAG,EAAE;QAE9D,KAAK,CAAC,OAAO,CAAC,CAAC;QAFE,yBAAoB,GAApB,oBAAoB,CAAyB;QAXzD,oBAAe,GAAG,IAAI,EAAE,CAAC;QAe9B,oCAAoC;QACpC,oBAAoB,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QAEjD,IAAI,KAAK,EAAE;YACP,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;SACtC;IACL,CAAC;IAED;;OAEG;IACI,sBAAsB,CAAC,KAA2B;QACrD,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,sBAAsB;QACzB,MAAM,aAAa,GAAG,sBAAsB,CAAC,IAAI,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC9E,oGAAoG;QACpG,uCACO,aAAa,KAChB,KAAK,EAAE,IAAI,CAAC,KAAK,EACjB,OAAO,EAAE,IAAI,CAAC,OAAO,IACvB;IACN,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport {\n    ILoggingError,\n    ITaggedTelemetryPropertyType,\n    ITelemetryLogger,\n    ITelemetryProperties,\n} from \"@fluidframework/common-definitions\";\nimport { v4 as uuid } from \"uuid\";\nimport {\n    hasErrorInstanceId,\n    IFluidErrorBase,\n    isFluidError,\n    isValidLegacyError,\n} from \"./fluidErrorBase\";\n\n/** @returns true if value is an object but neither null nor an array */\nconst isRegularObject = (value: any): boolean => {\n    return value !== null && !Array.isArray(value) && typeof value === \"object\";\n};\n\n/** Inspect the given error for common \"safe\" props and return them */\nexport function extractLogSafeErrorProperties(error: any, sanitizeStack: boolean) {\n    const removeMessageFromStack = (stack: string, errorName?: string) => {\n        if (!sanitizeStack) {\n            return stack;\n        }\n        const stackFrames = stack.split(\"\\n\");\n        stackFrames.shift(); // Remove \"[ErrorName]: [ErrorMessage]\"\n        if (errorName !== undefined) {\n            stackFrames.unshift(errorName); // Add \"[ErrorName]\"\n        }\n        return stackFrames.join(\"\\n\");\n    };\n\n    const message = (typeof error?.message === \"string\")\n        ? error.message as string\n        : String(error);\n\n    const safeProps: { message: string; errorType?: string; stack?: string } = {\n        message,\n    };\n\n    if (isRegularObject(error)) {\n        const { errorType, stack, name } = error;\n\n        if (typeof errorType === \"string\") {\n            safeProps.errorType = errorType;\n        }\n\n        if (typeof stack === \"string\") {\n            const errorName = (typeof name === \"string\") ? name : undefined;\n            safeProps.stack = removeMessageFromStack(stack, errorName);\n        }\n    }\n\n    return safeProps;\n}\n\n/** type guard for ILoggingError interface */\nexport const isILoggingError = (x: any): x is ILoggingError => typeof x?.getTelemetryProperties === \"function\";\n\n/** Copy props from source onto target, but do not overwrite an existing prop that matches */\nfunction copyProps(target: ITelemetryProperties | LoggingError, source: ITelemetryProperties) {\n    for (const key of Object.keys(source)) {\n        if (target[key] === undefined) {\n            target[key] = source[key];\n        }\n    }\n}\n\n/** Metadata to annotate an error object when annotating or normalizing it */\nexport interface IFluidErrorAnnotations {\n    /** Telemetry props to log with the error */\n    props?: ITelemetryProperties;\n}\n\n/** Simplest possible implementation of IFluidErrorBase */\nclass SimpleFluidError implements IFluidErrorBase {\n    private readonly telemetryProps: ITelemetryProperties = {};\n\n    readonly errorType: string;\n    readonly fluidErrorCode: string;\n    readonly message: string;\n    readonly stack?: string;\n    readonly name?: string;\n    readonly errorInstanceId: string;\n\n    constructor(\n        errorProps: Omit<IFluidErrorBase,\n            \"getTelemetryProperties\" |\n            \"addTelemetryProperties\" |\n            \"errorInstanceId\">,\n    ) {\n        this.errorType = errorProps.errorType;\n        this.fluidErrorCode = errorProps.fluidErrorCode;\n        this.message = errorProps.message;\n        this.stack = errorProps.stack;\n        this.name = errorProps.name;\n        this.errorInstanceId = uuid();\n\n        this.addTelemetryProperties(errorProps);\n    }\n\n    getTelemetryProperties(): ITelemetryProperties {\n        return this.telemetryProps;\n    }\n\n    addTelemetryProperties(props: ITelemetryProperties) {\n        copyProps(this.telemetryProps, props);\n    }\n}\n\n/** For backwards compatibility with pre-fluidErrorCode valid errors */\nfunction patchWithErrorCode(\n    legacyError: Omit<IFluidErrorBase, \"fluidErrorCode\">,\n): asserts legacyError is IFluidErrorBase {\n    const patchMe: { -readonly [P in \"fluidErrorCode\"]?: IFluidErrorBase[P] } = legacyError as any;\n    if (patchMe.fluidErrorCode === undefined) {\n        patchMe.fluidErrorCode = \"<error predates fluidErrorCode>\";\n    }\n}\n\n/**\n * Normalize the given error yielding a valid Fluid Error\n * @returns A valid Fluid Error with any provided annotations applied\n * @param error - The error to normalize\n * @param annotations - Annotations to apply to the normalized error\n */\nexport function normalizeError(\n    error: unknown,\n    annotations: IFluidErrorAnnotations = {},\n): IFluidErrorBase {\n    // Back-compat, while IFluidErrorBase is rolled out\n    if (isValidLegacyError(error)) {\n        patchWithErrorCode(error);\n    }\n\n    if (isFluidError(error)) {\n        // We can simply add the telemetry props to the error and return it\n        error.addTelemetryProperties(annotations.props ?? {});\n        return error;\n    }\n\n    // We have to construct a new Fluid Error, copying safe properties over\n    const { message, stack } = extractLogSafeErrorProperties(error, false /* sanitizeStack */);\n    const fluidError: IFluidErrorBase = new SimpleFluidError({\n        errorType: \"genericError\", // Match Container/Driver generic error type\n        fluidErrorCode: \"\",\n        message,\n        stack: stack ?? generateStack(),\n    });\n\n    fluidError.addTelemetryProperties({\n        ...annotations.props,\n        untrustedOrigin: 1, // This will let us filter to errors not originated by our own code\n    });\n\n    if (typeof(error) !== \"object\") {\n        // This is only interesting for non-objects\n        fluidError.addTelemetryProperties({ typeofError: typeof(error) });\n    }\n    return fluidError;\n}\n\nexport function generateStack(): string | undefined {\n    // Some browsers will populate stack right away, others require throwing Error\n    let stack = new Error(\"<<generated stack>>\").stack;\n    if (!stack) {\n        try {\n            throw new Error(\"<<generated stack>>\");\n        } catch (e) {\n            stack = e.stack;\n        }\n    }\n    return stack;\n}\n\n/**\n * Create a new error, wrapping and caused by the given unknown error.\n * Copies the inner error's message and stack over but otherwise uses newErrorFn to define the error.\n * The inner error's instance id will also be logged for telemetry analysis.\n * @param innerError - An error from untrusted/unknown origins\n * @param newErrorFn - callback that will create a new error given the original error's message\n * @returns A new error object \"wrapping\" the given error\n */\n export function wrapError<T extends IFluidErrorBase>(\n    innerError: unknown,\n    newErrorFn: (message: string) => T,\n): T {\n    const {\n        message,\n        stack,\n    } = extractLogSafeErrorProperties(innerError, false /* sanitizeStack */);\n\n    const newError = newErrorFn(message);\n\n    if (stack !== undefined) {\n        // supposedly setting stack on an Error can throw.\n        try {\n            Object.assign(newError, { stack });\n        } catch (errorSettingStack) {\n            newError.addTelemetryProperties({ stack2: stack });\n        }\n    }\n\n    if (hasErrorInstanceId(innerError)) {\n        newError.addTelemetryProperties({ innerErrorInstanceId: innerError.errorInstanceId });\n    }\n\n    return newError;\n}\n\n/** The same as wrapError, but also logs the innerError, including the wrapping error's instance id */\nexport function wrapErrorAndLog<T extends IFluidErrorBase>(\n    innerError: unknown,\n    newErrorFn: (message: string) => T,\n    logger: ITelemetryLogger,\n) {\n    const newError = wrapError(innerError, newErrorFn);\n    const wrappedByErrorInstanceId = hasErrorInstanceId(newError)\n        ? newError.errorInstanceId\n        : undefined;\n\n    logger.sendTelemetryEvent({\n        eventName: \"WrapError\",\n        wrappedByErrorInstanceId,\n    }, innerError);\n\n    return newError;\n}\n\n/**\n * Type guard to identify if a particular value (loosely) appears to be a tagged telemetry property\n */\nexport function isTaggedTelemetryPropertyValue(x: any): x is ITaggedTelemetryPropertyType {\n    return (typeof(x?.value) !== \"object\" && typeof(x?.tag) === \"string\");\n}\n\n/**\n * Walk an object's enumerable properties to find those fit for telemetry.\n */\nfunction getValidTelemetryProps(obj: any, keysToOmit: Set<string>): ITelemetryProperties {\n    const props: ITelemetryProperties = {};\n    for (const key of Object.keys(obj)) {\n        if (keysToOmit.has(key)) {\n            continue;\n        }\n        const val = obj[key];\n        switch (typeof val) {\n            case \"string\":\n            case \"number\":\n            case \"boolean\":\n            case \"undefined\":\n                props[key] = val;\n                break;\n            default: {\n                if (isTaggedTelemetryPropertyValue(val)) {\n                    props[key] = val;\n                } else {\n                    // We don't support logging arbitrary objects\n                    props[key] = \"REDACTED (arbitrary object)\";\n                }\n                break;\n            }\n        }\n    }\n    return props;\n}\n\n/**\n * Base class for \"trusted\" errors we create, whose properties can generally be logged to telemetry safely.\n * All properties set on the object, or passed in (via the constructor or getTelemetryProperties),\n * will be logged in accordance with their tag, if present.\n *\n * PLEASE take care to avoid setting sensitive data on this object without proper tagging!\n */\nexport class LoggingError extends Error implements ILoggingError, Pick<IFluidErrorBase, \"errorInstanceId\"> {\n    readonly errorInstanceId = uuid();\n\n    /**\n     * Create a new LoggingError\n     * @param message - Error message to use for Error base class\n     * @param props - telemetry props to include on the error for when it's logged\n     * @param omitPropsFromLogging - properties by name to omit from telemetry props\n     */\n    constructor(\n        message: string,\n        props?: ITelemetryProperties,\n        private readonly omitPropsFromLogging: Set<string> = new Set(),\n    ) {\n        super(message);\n\n        // Don't log this list itself either\n        omitPropsFromLogging.add(\"omitPropsFromLogging\");\n\n        if (props) {\n            this.addTelemetryProperties(props);\n        }\n    }\n\n    /**\n     * Add additional properties to be logged\n     */\n    public addTelemetryProperties(props: ITelemetryProperties) {\n        copyProps(this, props);\n    }\n\n    /**\n     * Get all properties fit to be logged to telemetry for this error\n     */\n    public getTelemetryProperties(): ITelemetryProperties {\n        const taggableProps = getValidTelemetryProps(this, this.omitPropsFromLogging);\n        // Include non-enumerable props inherited from Error that are not returned by getValidTelemetryProps\n        return  {\n            ...taggableProps,\n            stack: this.stack,\n            message: this.message,\n        };\n    }\n}\n"]}

package/lib/eventEmitterWithErrorHandling.d.ts

@@ -11,8 +11,7 @@ import { TypedEventEmitter, EventEmitterEventType } from "@fluidframework/common
  */
 export declare class EventEmitterWithErrorHandling<TEvent extends IEvent = IEvent> extends TypedEventEmitter<TEvent> {
     private readonly errorHandler;
-    constructor(errorHandler?: (eventName: EventEmitterEventType, error: any) => void);
-    private defaultErrorHandler;
+    constructor(errorHandler: (eventName: EventEmitterEventType, error: any) => void);
     emit(event: EventEmitterEventType, ...args: any[]): boolean;
 }
 //# sourceMappingURL=eventEmitterWithErrorHandling.d.ts.map

package/lib/eventEmitterWithErrorHandling.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eventEmitterWithErrorHandling.d.ts","sourceRoot":"","sources":["../src/eventEmitterWithErrorHandling.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAExF;;;;GAIG;AACH,qBAAa,6BAA6B,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,iBAAiB,CAAC,MAAM,CAAC;IACxG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAyD;gBAE1E,YAAY,CAAC,EAAE,CAAC,SAAS,EAAE,qBAAqB,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI;IAKjF,OAAO,CAAC,mBAAmB;IAWpB,IAAI,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;CAQrE"}
+{"version":3,"file":"eventEmitterWithErrorHandling.d.ts","sourceRoot":"","sources":["../src/eventEmitterWithErrorHandling.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAExF;;;;GAIG;AACH,qBAAa,6BAA6B,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,iBAAiB,CAAC,MAAM,CAAC;IAC5F,OAAO,CAAC,QAAQ,CAAE,YAAY;gBAAZ,YAAY,EAAE,CAAC,SAAS,EAAE,qBAAqB,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI;IAI3F,IAAI,CAAC,KAAK,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO;CAQrE"}

package/lib/eventEmitterWithErrorHandling.js

@@ -7,16 +7,7 @@ import { TypedEventEmitter } from "@fluidframework/common-utils";
 export class EventEmitterWithErrorHandling extends TypedEventEmitter {
     constructor(errorHandler) {
         super();
-        this.errorHandler = errorHandler !== null && errorHandler !== void 0 ? errorHandler : this.defaultErrorHandler.bind(this);
-    }
-    defaultErrorHandler(event, error) {
-        // Some listener threw an error, we'll try emitting that error via the error event
-        // But not if we're already dealing with the error event, in that case just let the error be thrown
-        if (event === "error") {
-            throw error;
-        }
-        // Note: This will throw if no listeners are registered for the error event
-        super.emit("error", error);
+        this.errorHandler = errorHandler;
     }
     emit(event, ...args) {
         try {

package/lib/eventEmitterWithErrorHandling.js.map

@@ -1 +1 @@
-{"version":3,"file":"eventEmitterWithErrorHandling.js","sourceRoot":"","sources":["../src/eventEmitterWithErrorHandling.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAyB,MAAM,8BAA8B,CAAC;AAExF;;;;GAIG;AACH,MAAM,OAAO,6BAA8D,SAAQ,iBAAyB;IAGxG,YAAY,YAAqE;QAC7E,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,YAAY,GAAG,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5E,CAAC;IAEO,mBAAmB,CAAC,KAAK,EAAE,KAAK;QACpC,kFAAkF;QAClF,mGAAmG;QACnG,IAAI,KAAK,KAAK,OAAO,EAAE;YACnB,MAAM,KAAK,CAAC;SACf;QAED,2EAA2E;QAC3E,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC;IAEM,IAAI,CAAC,KAA4B,EAAE,GAAG,IAAW;QACpD,IAAI;YACA,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;SACrC;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAChC,OAAO,IAAI,CAAC;SACf;IACL,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IEvent } from \"@fluidframework/common-definitions\";\nimport { TypedEventEmitter, EventEmitterEventType } from \"@fluidframework/common-utils\";\n\n/**\n * Event Emitter helper class\n * Any exceptions thrown by listeners will be caught and raised through \"error\" event.\n * Any exception thrown by \"error\" listeners will propagate to the caller.\n */\nexport class EventEmitterWithErrorHandling<TEvent extends IEvent = IEvent> extends TypedEventEmitter<TEvent> {\n    private readonly errorHandler: (eventName: EventEmitterEventType, error: any) => void;\n\n    constructor(errorHandler?: (eventName: EventEmitterEventType, error: any) => void) {\n        super();\n        this.errorHandler = errorHandler ?? this.defaultErrorHandler.bind(this);\n    }\n\n    private defaultErrorHandler(event, error) {\n        // Some listener threw an error, we'll try emitting that error via the error event\n        // But not if we're already dealing with the error event, in that case just let the error be thrown\n        if (event === \"error\") {\n            throw error;\n        }\n\n        // Note: This will throw if no listeners are registered for the error event\n        super.emit(\"error\", error);\n    }\n\n    public emit(event: EventEmitterEventType, ...args: any[]): boolean {\n        try {\n            return super.emit(event, ...args);\n        } catch (error) {\n            this.errorHandler(event, error);\n            return true;\n        }\n    }\n}\n"]}
+{"version":3,"file":"eventEmitterWithErrorHandling.js","sourceRoot":"","sources":["../src/eventEmitterWithErrorHandling.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAyB,MAAM,8BAA8B,CAAC;AAExF;;;;GAIG;AACH,MAAM,OAAO,6BAA8D,SAAQ,iBAAyB;IACxG,YAA8B,YAAoE;QAC9F,KAAK,EAAE,CAAC;QADkB,iBAAY,GAAZ,YAAY,CAAwD;IAElG,CAAC;IAEM,IAAI,CAAC,KAA4B,EAAE,GAAG,IAAW;QACpD,IAAI;YACA,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;SACrC;QAAC,OAAO,KAAK,EAAE;YACZ,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAChC,OAAO,IAAI,CAAC;SACf;IACL,CAAC;CACJ","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { IEvent } from \"@fluidframework/common-definitions\";\nimport { TypedEventEmitter, EventEmitterEventType } from \"@fluidframework/common-utils\";\n\n/**\n * Event Emitter helper class\n * Any exceptions thrown by listeners will be caught and raised through \"error\" event.\n * Any exception thrown by \"error\" listeners will propagate to the caller.\n */\nexport class EventEmitterWithErrorHandling<TEvent extends IEvent = IEvent> extends TypedEventEmitter<TEvent> {\n    constructor(private readonly  errorHandler: (eventName: EventEmitterEventType, error: any) => void) {\n        super();\n    }\n\n    public emit(event: EventEmitterEventType, ...args: any[]): boolean {\n        try {\n            return super.emit(event, ...args);\n        } catch (error) {\n            this.errorHandler(event, error);\n            return true;\n        }\n    }\n}\n"]}

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/telemetry-utils";
-export declare const pkgVersion = "0.50.3";
+export declare const pkgVersion = "0.51.2";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/telemetry-utils";
-export const pkgVersion = "0.50.3";
+export const pkgVersion = "0.51.2";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,iCAAiC,CAAC;AACzD,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/telemetry-utils\";\nexport const pkgVersion = \"0.50.3\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,iCAAiC,CAAC;AACzD,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/telemetry-utils\";\nexport const pkgVersion = \"0.51.2\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/telemetry-utils",
-  "version": "0.50.3",
+  "version": "0.51.2",
   "description": "Collection of telemetry relates utilities for Fluid",
   "homepage": "https://fluidframework.com",
   "repository": "https://github.com/microsoft/FluidFramework",
@@ -67,8 +67,8 @@
   },
   "devDependencies": {
     "@fluidframework/build-common": "^0.23.0",
-    "@fluidframework/eslint-config-fluid": "^0.23.0",
-    "@fluidframework/mocha-test-setup": "^0.50.3",
+    "@fluidframework/eslint-config-fluid": "^0.24.0",
+    "@fluidframework/mocha-test-setup": "^0.51.2",
     "@microsoft/api-extractor": "^7.16.1",
     "@types/debug": "^4.1.5",
     "@types/events": "^3.0.0",
@@ -76,7 +76,7 @@
     "@types/node": "^12.19.0",
     "@typescript-eslint/eslint-plugin": "~4.14.0",
     "@typescript-eslint/parser": "~4.14.0",
-    "concurrently": "^5.2.0",
+    "concurrently": "^6.2.0",
     "copyfiles": "^2.1.0",
     "cross-env": "^7.0.2",
     "eslint": "~7.18.0",

package/src/errorLogging.ts

@@ -6,10 +6,12 @@
 import {
     ILoggingError,
     ITaggedTelemetryPropertyType,
+    ITelemetryLogger,
     ITelemetryProperties,
 } from "@fluidframework/common-definitions";
 import { v4 as uuid } from "uuid";
 import {
+    hasErrorInstanceId,
     IFluidErrorBase,
     isFluidError,
     isValidLegacyError,
@@ -74,8 +76,6 @@ function copyProps(target: ITelemetryProperties | LoggingError, source: ITelemet
 export interface IFluidErrorAnnotations {
     /** Telemetry props to log with the error */
     props?: ITelemetryProperties;
-    /** fluidErrorCode to mention if error isn't already an IFluidErrorBase */
-    errorCodeIfNone?: string;
 }
 
 /** Simplest possible implementation of IFluidErrorBase */
@@ -117,11 +117,10 @@ class SimpleFluidError implements IFluidErrorBase {
 /** For backwards compatibility with pre-fluidErrorCode valid errors */
 function patchWithErrorCode(
     legacyError: Omit<IFluidErrorBase, "fluidErrorCode">,
-    errorCode: string = "<error predates fluidErrorCode>",
 ): asserts legacyError is IFluidErrorBase {
-    const patchMe: { fluidErrorCode?: string } = legacyError as any;
+    const patchMe: { -readonly [P in "fluidErrorCode"]?: IFluidErrorBase[P] } = legacyError as any;
     if (patchMe.fluidErrorCode === undefined) {
-        patchMe.fluidErrorCode = errorCode;
+        patchMe.fluidErrorCode = "<error predates fluidErrorCode>";
     }
 }
 
@@ -137,7 +136,7 @@ export function normalizeError(
 ): IFluidErrorBase {
     // Back-compat, while IFluidErrorBase is rolled out
     if (isValidLegacyError(error)) {
-        patchWithErrorCode(error, annotations.errorCodeIfNone);
+        patchWithErrorCode(error);
     }
 
     if (isFluidError(error)) {
@@ -150,7 +149,7 @@ export function normalizeError(
     const { message, stack } = extractLogSafeErrorProperties(error, false /* sanitizeStack */);
     const fluidError: IFluidErrorBase = new SimpleFluidError({
         errorType: "genericError", // Match Container/Driver generic error type
-        fluidErrorCode: annotations.errorCodeIfNone ?? "none",
+        fluidErrorCode: "",
         message,
         stack: stack ?? generateStack(),
     });
@@ -180,6 +179,60 @@ export function generateStack(): string | undefined {
     return stack;
 }
 
+/**
+ * Create a new error, wrapping and caused by the given unknown error.
+ * Copies the inner error's message and stack over but otherwise uses newErrorFn to define the error.
+ * The inner error's instance id will also be logged for telemetry analysis.
+ * @param innerError - An error from untrusted/unknown origins
+ * @param newErrorFn - callback that will create a new error given the original error's message
+ * @returns A new error object "wrapping" the given error
+ */
+ export function wrapError<T extends IFluidErrorBase>(
+    innerError: unknown,
+    newErrorFn: (message: string) => T,
+): T {
+    const {
+        message,
+        stack,
+    } = extractLogSafeErrorProperties(innerError, false /* sanitizeStack */);
+
+    const newError = newErrorFn(message);
+
+    if (stack !== undefined) {
+        // supposedly setting stack on an Error can throw.
+        try {
+            Object.assign(newError, { stack });
+        } catch (errorSettingStack) {
+            newError.addTelemetryProperties({ stack2: stack });
+        }
+    }
+
+    if (hasErrorInstanceId(innerError)) {
+        newError.addTelemetryProperties({ innerErrorInstanceId: innerError.errorInstanceId });
+    }
+
+    return newError;
+}
+
+/** The same as wrapError, but also logs the innerError, including the wrapping error's instance id */
+export function wrapErrorAndLog<T extends IFluidErrorBase>(
+    innerError: unknown,
+    newErrorFn: (message: string) => T,
+    logger: ITelemetryLogger,
+) {
+    const newError = wrapError(innerError, newErrorFn);
+    const wrappedByErrorInstanceId = hasErrorInstanceId(newError)
+        ? newError.errorInstanceId
+        : undefined;
+
+    logger.sendTelemetryEvent({
+        eventName: "WrapError",
+        wrappedByErrorInstanceId,
+    }, innerError);
+
+    return newError;
+}
+
 /**
  * Type guard to identify if a particular value (loosely) appears to be a tagged telemetry property
  */

package/src/eventEmitterWithErrorHandling.ts

@@ -11,22 +11,8 @@ import { TypedEventEmitter, EventEmitterEventType } from "@fluidframework/common
  * Any exception thrown by "error" listeners will propagate to the caller.
  */
 export class EventEmitterWithErrorHandling<TEvent extends IEvent = IEvent> extends TypedEventEmitter<TEvent> {
-    private readonly errorHandler: (eventName: EventEmitterEventType, error: any) => void;
-
-    constructor(errorHandler?: (eventName: EventEmitterEventType, error: any) => void) {
+    constructor(private readonly  errorHandler: (eventName: EventEmitterEventType, error: any) => void) {
         super();
-        this.errorHandler = errorHandler ?? this.defaultErrorHandler.bind(this);
-    }
-
-    private defaultErrorHandler(event, error) {
-        // Some listener threw an error, we'll try emitting that error via the error event
-        // But not if we're already dealing with the error event, in that case just let the error be thrown
-        if (event === "error") {
-            throw error;
-        }
-
-        // Note: This will throw if no listeners are registered for the error event
-        super.emit("error", error);
     }
 
     public emit(event: EventEmitterEventType, ...args: any[]): boolean {

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/telemetry-utils";
-export const pkgVersion = "0.50.3";
+export const pkgVersion = "0.51.2";