@fluidframework/telemetry-utils 2.0.0-rc.1.0.3 → 2.0.0-rc.2.0.0

package/lib/test/error.spec.js

@@ -0,0 +1,161 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { strict as assert } from "node:assert";
+import { FluidErrorTypes } from "@fluidframework/core-interfaces";
+import { DataCorruptionError, DataProcessingError } from "../error.js";
+import { LoggingError, isILoggingError, normalizeError } from "../errorLogging.js";
+describe("Errors", () => {
+    describe("DataProcessingError.create", () => {
+        it("Should yield a DataProcessingError", () => {
+            const dpe = DataProcessingError.create("Some message", "someCodepath", undefined, {
+                someProp: 1234,
+            });
+            assert(dpe instanceof DataProcessingError);
+            assert(dpe.errorType === FluidErrorTypes.dataProcessingError);
+            assert(dpe.message === "Some message");
+            assert(dpe.getTelemetryProperties().someProp === 1234);
+            assert(dpe.getTelemetryProperties().dataProcessingError === 1);
+            assert(dpe.getTelemetryProperties().dataProcessingCodepath === "someCodepath");
+            assert(dpe.getTelemetryProperties().untrustedOrigin === 1);
+        });
+    });
+    describe("DataProcessingError coercion via DataProcessingError.wrapIfUnrecognized", () => {
+        it("Should preserve the stack", () => {
+            const originalError = new Error("Test error");
+            const testError = DataProcessingError.wrapIfUnrecognized(originalError, "someCodepath", undefined);
+            assert(testError.stack === originalError.stack);
+        });
+        it("Should skip coercion for valid Fluid Error", () => {
+            const originalError = new DataCorruptionError("some message", {});
+            const coercedError = DataProcessingError.wrapIfUnrecognized(originalError, "someCodepath", undefined);
+            assert(coercedError === originalError);
+            assert(coercedError.errorType === FluidErrorTypes.dataCorruptionError);
+            assert(coercedError.getTelemetryProperties().dataProcessingError === 1);
+            assert(coercedError.getTelemetryProperties().dataProcessingCodepath === "someCodepath");
+        });
+        it("Should skip coercion for LoggingError with errorType", () => {
+            const originalError = new LoggingError("Inherited error message", {
+                errorType: "Some error type",
+                otherProperty: "some safe-to-log property",
+            });
+            const coercedError = DataProcessingError.wrapIfUnrecognized(originalError, "someCodepath", undefined);
+            assert(coercedError === originalError);
+            assert(coercedError.errorType === "Some error type");
+            assert(coercedError.getTelemetryProperties().dataProcessingError === 1);
+            assert(coercedError.getTelemetryProperties().dataProcessingCodepath === "someCodepath");
+        });
+        it("Should coerce normalized external error", () => {
+            const originalError = normalizeError("boo");
+            const coercedError = DataProcessingError.wrapIfUnrecognized(originalError, "someCodepath", undefined);
+            assert(coercedError !== originalError);
+            assert(coercedError instanceof DataProcessingError);
+            assert(coercedError.errorType === FluidErrorTypes.dataProcessingError);
+            assert(coercedError.getTelemetryProperties().dataProcessingError === 1);
+            assert(coercedError.getTelemetryProperties().dataProcessingCodepath === "someCodepath");
+            assert(coercedError.getTelemetryProperties().untrustedOrigin === 1);
+        });
+        it("Should coerce external error object even with errorType", () => {
+            const originalError = {
+                errorType: "Some error type",
+            };
+            const coercedError = DataProcessingError.wrapIfUnrecognized(originalError, "someCodepath", undefined);
+            assert(coercedError !== originalError);
+            assert(coercedError instanceof DataProcessingError);
+            assert(coercedError.errorType === FluidErrorTypes.dataProcessingError);
+            assert(coercedError.getTelemetryProperties().dataProcessingError === 1);
+            assert(coercedError.getTelemetryProperties().dataProcessingCodepath === "someCodepath");
+            assert(coercedError.getTelemetryProperties().untrustedOrigin === 1);
+            assert(coercedError.message === "[object Object]");
+        });
+        it("Should coerce LoggingError missing errorType", () => {
+            const originalError = new LoggingError("Inherited error message", {
+                otherProperty: "some safe-to-log property",
+            });
+            const coercedError = DataProcessingError.wrapIfUnrecognized(originalError, "someCodepath", undefined);
+            assert(coercedError !== originalError);
+            assert(coercedError instanceof DataProcessingError);
+            assert(coercedError.errorType === FluidErrorTypes.dataProcessingError);
+            assert(coercedError.getTelemetryProperties().dataProcessingError === 1);
+            assert(coercedError.getTelemetryProperties().dataProcessingCodepath === "someCodepath");
+            assert(coercedError.getTelemetryProperties().untrustedOrigin === undefined);
+            assert(coercedError.message === "Inherited error message");
+            assert(coercedError.getTelemetryProperties().otherProperty === "some safe-to-log property", "telemetryProps should be copied when wrapping");
+        });
+        it("Should coerce Normalized LoggingError with errorType", () => {
+            const originalError = new LoggingError("Inherited error message", {
+                otherProperty: "some safe-to-log property",
+            });
+            const normalizedLoggingError = normalizeError(originalError);
+            const coercedError = DataProcessingError.wrapIfUnrecognized(normalizedLoggingError, "someCodepath", undefined);
+            assert(coercedError !== originalError);
+            assert(coercedError instanceof DataProcessingError);
+            assert(coercedError.errorType === FluidErrorTypes.dataProcessingError);
+            assert(coercedError.getTelemetryProperties().dataProcessingError === 1);
+            assert(coercedError.getTelemetryProperties().dataProcessingCodepath === "someCodepath");
+            assert(coercedError.getTelemetryProperties().untrustedOrigin === undefined);
+            assert(coercedError.message === "Inherited error message");
+            assert(coercedError.getTelemetryProperties().otherProperty === "some safe-to-log property", "telemetryProps should be copied when wrapping");
+        });
+        it("Should not fail coercing malformed inputs", () => {
+            const originalMalformations = [
+                // eslint-disable-next-line unicorn/no-null
+                null,
+                undefined,
+                false,
+                true,
+                3.14,
+                Symbol("Unique"),
+                () => { },
+                [],
+                [1, 2, 3],
+            ];
+            const coercedErrors = originalMalformations.map((value) => DataProcessingError.wrapIfUnrecognized(value, "someCodepath", undefined));
+            assert(coercedErrors.every((error) => typeof error.message === "string" &&
+                error.errorType === FluidErrorTypes.dataProcessingError &&
+                error.getTelemetryProperties().dataProcessingError === 1 &&
+                error.getTelemetryProperties().dataProcessingCodepath === "someCodepath" &&
+                error.getTelemetryProperties().untrustedOrigin === 1));
+            assert(!originalMalformations.some((value) => typeof value === "string" ||
+                (typeof value === "object" && !Array.isArray(value) && value !== null)), "Neither strings nor objects are considered malformed");
+        });
+        it("Should be coercible from a string message", () => {
+            const originalMessage = "Example of some thrown string";
+            const coercedError = DataProcessingError.wrapIfUnrecognized(originalMessage, "someCodepath", undefined);
+            assert(coercedError.message === originalMessage);
+            assert(coercedError.errorType === FluidErrorTypes.dataProcessingError);
+            assert(coercedError.getTelemetryProperties().dataProcessingError === 1);
+            assert(coercedError.getTelemetryProperties().dataProcessingCodepath === "someCodepath");
+        });
+        it("Should be coercible from a property object (no errorType)", () => {
+            const originalError = {
+                message: "Inherited error message",
+            };
+            const coercedError = DataProcessingError.wrapIfUnrecognized(originalError, "someCodepath", undefined);
+            assert(coercedError.message === originalError.message);
+            assert(coercedError.errorType === FluidErrorTypes.dataProcessingError);
+            assert(coercedError.getTelemetryProperties().dataProcessingError === 1);
+            assert(coercedError.getTelemetryProperties().dataProcessingCodepath === "someCodepath");
+        });
+        it("op props should be logged when coerced", () => {
+            const originalError = {
+                message: "Inherited error message",
+            };
+            const op = { sequenceNumber: 42 };
+            const coercedError = DataProcessingError.wrapIfUnrecognized(originalError, "someCodepath", op);
+            assert(isILoggingError(coercedError));
+            assert(coercedError.getTelemetryProperties().messageSequenceNumber === op.sequenceNumber);
+        });
+        it("op props should be logged even when not coerced", () => {
+            const originalError = {
+                errorType: "hello",
+            };
+            const op = { sequenceNumber: 42 };
+            const coercedError = DataProcessingError.wrapIfUnrecognized(originalError, "someCodepath", op);
+            assert(isILoggingError(coercedError));
+            assert(coercedError.getTelemetryProperties().messageSequenceNumber === op.sequenceNumber);
+        });
+    });
+});
+//# sourceMappingURL=error.spec.js.map

package/lib/test/error.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.spec.js","sourceRoot":"","sources":["../../src/test/error.spec.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAE/C,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAElE,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEnF,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACvB,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;QAC3C,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC7C,MAAM,GAAG,GAAG,mBAAmB,CAAC,MAAM,CAAC,cAAc,EAAE,cAAc,EAAE,SAAS,EAAE;gBACjF,QAAQ,EAAE,IAAI;aACd,CAAC,CAAC;YACH,MAAM,CAAC,GAAG,YAAY,mBAAmB,CAAC,CAAC;YAC3C,MAAM,CAAC,GAAG,CAAC,SAAS,KAAK,eAAe,CAAC,mBAAmB,CAAC,CAAC;YAC9D,MAAM,CAAC,GAAG,CAAC,OAAO,KAAK,cAAc,CAAC,CAAC;YACvC,MAAM,CAAC,GAAG,CAAC,sBAAsB,EAAE,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC;YACvD,MAAM,CAAC,GAAG,CAAC,sBAAsB,EAAE,CAAC,mBAAmB,KAAK,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,GAAG,CAAC,sBAAsB,EAAE,CAAC,sBAAsB,KAAK,cAAc,CAAC,CAAC;YAC/E,MAAM,CAAC,GAAG,CAAC,sBAAsB,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,yEAAyE,EAAE,GAAG,EAAE;QACxF,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACpC,MAAM,aAAa,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;YAC9C,MAAM,SAAS,GAAG,mBAAmB,CAAC,kBAAkB,CACvD,aAAa,EACb,cAAc,EACd,SAAS,CACT,CAAC;YAEF,MAAM,CAAC,SAAS,CAAC,KAAK,KAAK,aAAa,CAAC,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACrD,MAAM,aAAa,GAAG,IAAI,mBAAmB,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YAClE,MAAM,YAAY,GAAG,mBAAmB,CAAC,kBAAkB,CAC1D,aAAa,EACb,cAAc,EACd,SAAS,CACT,CAAC;YAEF,MAAM,CAAE,YAAwB,KAAK,aAAa,CAAC,CAAC;YACpD,MAAM,CAAC,YAAY,CAAC,SAAS,KAAK,eAAe,CAAC,mBAAmB,CAAC,CAAC;YACvE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,mBAAmB,KAAK,CAAC,CAAC,CAAC;YACxE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,sBAAsB,KAAK,cAAc,CAAC,CAAC;QACzF,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC/D,MAAM,aAAa,GAAG,IAAI,YAAY,CAAC,yBAAyB,EAAE;gBACjE,SAAS,EAAE,iBAAiB;gBAC5B,aAAa,EAAE,2BAA2B;aAC1C,CAAC,CAAC;YACH,MAAM,YAAY,GAAG,mBAAmB,CAAC,kBAAkB,CAC1D,aAAa,EACb,cAAc,EACd,SAAS,CACT,CAAC;YAEF,MAAM,CAAE,YAAwB,KAAK,aAAa,CAAC,CAAC;YACpD,MAAM,CAAC,YAAY,CAAC,SAAS,KAAK,iBAAiB,CAAC,CAAC;YACrD,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,mBAAmB,KAAK,CAAC,CAAC,CAAC;YACxE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,sBAAsB,KAAK,cAAc,CAAC,CAAC;QACzF,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YAClD,MAAM,aAAa,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;YAC5C,MAAM,YAAY,GAAG,mBAAmB,CAAC,kBAAkB,CAC1D,aAAa,EACb,cAAc,EACd,SAAS,CACT,CAAC;YAEF,MAAM,CAAE,YAAwB,KAAK,aAAa,CAAC,CAAC;YACpD,MAAM,CAAC,YAAY,YAAY,mBAAmB,CAAC,CAAC;YACpD,MAAM,CAAC,YAAY,CAAC,SAAS,KAAK,eAAe,CAAC,mBAAmB,CAAC,CAAC;YACvE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,mBAAmB,KAAK,CAAC,CAAC,CAAC;YACxE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,sBAAsB,KAAK,cAAc,CAAC,CAAC;YACxF,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;YAClE,MAAM,aAAa,GAAG;gBACrB,SAAS,EAAE,iBAAiB;aAC5B,CAAC;YACF,MAAM,YAAY,GAAG,mBAAmB,CAAC,kBAAkB,CAC1D,aAAa,EACb,cAAc,EACd,SAAS,CACT,CAAC;YAEF,MAAM,CAAE,YAAwB,KAAK,aAAa,CAAC,CAAC;YACpD,MAAM,CAAC,YAAY,YAAY,mBAAmB,CAAC,CAAC;YACpD,MAAM,CAAC,YAAY,CAAC,SAAS,KAAK,eAAe,CAAC,mBAAmB,CAAC,CAAC;YACvE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,mBAAmB,KAAK,CAAC,CAAC,CAAC;YACxE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,sBAAsB,KAAK,cAAc,CAAC,CAAC;YACxF,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC,CAAC;YACpE,MAAM,CAAC,YAAY,CAAC,OAAO,KAAK,iBAAiB,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACvD,MAAM,aAAa,GAAG,IAAI,YAAY,CAAC,yBAAyB,EAAE;gBACjE,aAAa,EAAE,2BAA2B;aAC1C,CAAC,CAAC;YACH,MAAM,YAAY,GAAG,mBAAmB,CAAC,kBAAkB,CAC1D,aAAa,EACb,cAAc,EACd,SAAS,CACT,CAAC;YAEF,MAAM,CAAE,YAAwB,KAAK,aAAa,CAAC,CAAC;YACpD,MAAM,CAAC,YAAY,YAAY,mBAAmB,CAAC,CAAC;YACpD,MAAM,CAAC,YAAY,CAAC,SAAS,KAAK,eAAe,CAAC,mBAAmB,CAAC,CAAC;YACvE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,mBAAmB,KAAK,CAAC,CAAC,CAAC;YACxE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,sBAAsB,KAAK,cAAc,CAAC,CAAC;YACxF,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC;YAC5E,MAAM,CAAC,YAAY,CAAC,OAAO,KAAK,yBAAyB,CAAC,CAAC;YAC3D,MAAM,CACL,YAAY,CAAC,sBAAsB,EAAE,CAAC,aAAa,KAAK,2BAA2B,EACnF,+CAA+C,CAC/C,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC/D,MAAM,aAAa,GAAG,IAAI,YAAY,CAAC,yBAAyB,EAAE;gBACjE,aAAa,EAAE,2BAA2B;aAC1C,CAAC,CAAC;YACH,MAAM,sBAAsB,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC;YAC7D,MAAM,YAAY,GAAG,mBAAmB,CAAC,kBAAkB,CAC1D,sBAAsB,EACtB,cAAc,EACd,SAAS,CACT,CAAC;YACF,MAAM,CAAE,YAAwB,KAAK,aAAa,CAAC,CAAC;YACpD,MAAM,CAAC,YAAY,YAAY,mBAAmB,CAAC,CAAC;YACpD,MAAM,CAAC,YAAY,CAAC,SAAS,KAAK,eAAe,CAAC,mBAAmB,CAAC,CAAC;YACvE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,mBAAmB,KAAK,CAAC,CAAC,CAAC;YACxE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,sBAAsB,KAAK,cAAc,CAAC,CAAC;YACxF,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC;YAC5E,MAAM,CAAC,YAAY,CAAC,OAAO,KAAK,yBAAyB,CAAC,CAAC;YAC3D,MAAM,CACL,YAAY,CAAC,sBAAsB,EAAE,CAAC,aAAa,KAAK,2BAA2B,EACnF,+CAA+C,CAC/C,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACpD,MAAM,qBAAqB,GAAG;gBAC7B,2CAA2C;gBAC3C,IAAI;gBACJ,SAAS;gBACT,KAAK;gBACL,IAAI;gBACJ,IAAI;gBACJ,MAAM,CAAC,QAAQ,CAAC;gBAChB,GAAS,EAAE,GAAE,CAAC;gBACd,EAAE;gBACF,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;aACT,CAAC;YACF,MAAM,aAAa,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACzD,mBAAmB,CAAC,kBAAkB,CAAC,KAAK,EAAE,cAAc,EAAE,SAAS,CAAC,CACxE,CAAC;YAEF,MAAM,CACL,aAAa,CAAC,KAAK,CAClB,CAAC,KAAK,EAAE,EAAE,CACT,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;gBACjC,KAAK,CAAC,SAAS,KAAK,eAAe,CAAC,mBAAmB;gBACvD,KAAK,CAAC,sBAAsB,EAAE,CAAC,mBAAmB,KAAK,CAAC;gBACxD,KAAK,CAAC,sBAAsB,EAAE,CAAC,sBAAsB,KAAK,cAAc;gBACxE,KAAK,CAAC,sBAAsB,EAAE,CAAC,eAAe,KAAK,CAAC,CACrD,CACD,CAAC;YACF,MAAM,CACL,CAAC,qBAAqB,CAAC,IAAI,CAC1B,CAAC,KAAK,EAAE,EAAE,CACT,OAAO,KAAK,KAAK,QAAQ;gBACzB,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,CAAC,CACvE,EACD,sDAAsD,CACtD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACpD,MAAM,eAAe,GAAG,+BAA+B,CAAC;YACxD,MAAM,YAAY,GAAG,mBAAmB,CAAC,kBAAkB,CAC1D,eAAe,EACf,cAAc,EACd,SAAS,CACT,CAAC;YAEF,MAAM,CAAC,YAAY,CAAC,OAAO,KAAK,eAAe,CAAC,CAAC;YACjD,MAAM,CAAC,YAAY,CAAC,SAAS,KAAK,eAAe,CAAC,mBAAmB,CAAC,CAAC;YACvE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,mBAAmB,KAAK,CAAC,CAAC,CAAC;YACxE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,sBAAsB,KAAK,cAAc,CAAC,CAAC;QACzF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACpE,MAAM,aAAa,GAAG;gBACrB,OAAO,EAAE,yBAAyB;aAClC,CAAC;YACF,MAAM,YAAY,GAAG,mBAAmB,CAAC,kBAAkB,CAC1D,aAAa,EACb,cAAc,EACd,SAAS,CACT,CAAC;YAEF,MAAM,CAAC,YAAY,CAAC,OAAO,KAAK,aAAa,CAAC,OAAO,CAAC,CAAC;YACvD,MAAM,CAAC,YAAY,CAAC,SAAS,KAAK,eAAe,CAAC,mBAAmB,CAAC,CAAC;YACvE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,mBAAmB,KAAK,CAAC,CAAC,CAAC;YACxE,MAAM,CAAC,YAAY,CAAC,sBAAsB,EAAE,CAAC,sBAAsB,KAAK,cAAc,CAAC,CAAC;QACzF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YACjD,MAAM,aAAa,GAAG;gBACrB,OAAO,EAAE,yBAAyB;aAClC,CAAC;YACF,MAAM,EAAE,GAAG,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;YAClC,MAAM,YAAY,GAAG,mBAAmB,CAAC,kBAAkB,CAC1D,aAAa,EACb,cAAc,EACd,EAAE,CACF,CAAC;YAEF,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC;YACtC,MAAM,CACL,YAAY,CAAC,sBAAsB,EAAE,CAAC,qBAAqB,KAAK,EAAE,CAAC,cAAc,CACjF,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YAC1D,MAAM,aAAa,GAAG;gBACrB,SAAS,EAAE,OAAO;aAClB,CAAC;YACF,MAAM,EAAE,GAAG,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;YAClC,MAAM,YAAY,GAAG,mBAAmB,CAAC,kBAAkB,CAC1D,aAAa,EACb,cAAc,EACd,EAAE,CACF,CAAC;YAEF,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC;YACtC,MAAM,CACL,YAAY,CAAC,sBAAsB,EAAE,CAAC,qBAAqB,KAAK,EAAE,CAAC,cAAc,CACjF,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { strict as assert } from \"node:assert\";\n\nimport { FluidErrorTypes } from \"@fluidframework/core-interfaces\";\n\nimport { DataCorruptionError, DataProcessingError } from \"../error.js\";\nimport { LoggingError, isILoggingError, normalizeError } from \"../errorLogging.js\";\n\ndescribe(\"Errors\", () => {\n\tdescribe(\"DataProcessingError.create\", () => {\n\t\tit(\"Should yield a DataProcessingError\", () => {\n\t\t\tconst dpe = DataProcessingError.create(\"Some message\", \"someCodepath\", undefined, {\n\t\t\t\tsomeProp: 1234,\n\t\t\t});\n\t\t\tassert(dpe instanceof DataProcessingError);\n\t\t\tassert(dpe.errorType === FluidErrorTypes.dataProcessingError);\n\t\t\tassert(dpe.message === \"Some message\");\n\t\t\tassert(dpe.getTelemetryProperties().someProp === 1234);\n\t\t\tassert(dpe.getTelemetryProperties().dataProcessingError === 1);\n\t\t\tassert(dpe.getTelemetryProperties().dataProcessingCodepath === \"someCodepath\");\n\t\t\tassert(dpe.getTelemetryProperties().untrustedOrigin === 1);\n\t\t});\n\t});\n\tdescribe(\"DataProcessingError coercion via DataProcessingError.wrapIfUnrecognized\", () => {\n\t\tit(\"Should preserve the stack\", () => {\n\t\t\tconst originalError = new Error(\"Test error\");\n\t\t\tconst testError = DataProcessingError.wrapIfUnrecognized(\n\t\t\t\toriginalError,\n\t\t\t\t\"someCodepath\",\n\t\t\t\tundefined,\n\t\t\t);\n\n\t\t\tassert(testError.stack === originalError.stack);\n\t\t});\n\t\tit(\"Should skip coercion for valid Fluid Error\", () => {\n\t\t\tconst originalError = new DataCorruptionError(\"some message\", {});\n\t\t\tconst coercedError = DataProcessingError.wrapIfUnrecognized(\n\t\t\t\toriginalError,\n\t\t\t\t\"someCodepath\",\n\t\t\t\tundefined,\n\t\t\t);\n\n\t\t\tassert((coercedError as unknown) === originalError);\n\t\t\tassert(coercedError.errorType === FluidErrorTypes.dataCorruptionError);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingError === 1);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingCodepath === \"someCodepath\");\n\t\t});\n\t\tit(\"Should skip coercion for LoggingError with errorType\", () => {\n\t\t\tconst originalError = new LoggingError(\"Inherited error message\", {\n\t\t\t\terrorType: \"Some error type\",\n\t\t\t\totherProperty: \"some safe-to-log property\",\n\t\t\t});\n\t\t\tconst coercedError = DataProcessingError.wrapIfUnrecognized(\n\t\t\t\toriginalError,\n\t\t\t\t\"someCodepath\",\n\t\t\t\tundefined,\n\t\t\t);\n\n\t\t\tassert((coercedError as unknown) === originalError);\n\t\t\tassert(coercedError.errorType === \"Some error type\");\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingError === 1);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingCodepath === \"someCodepath\");\n\t\t});\n\t\tit(\"Should coerce normalized external error\", () => {\n\t\t\tconst originalError = normalizeError(\"boo\");\n\t\t\tconst coercedError = DataProcessingError.wrapIfUnrecognized(\n\t\t\t\toriginalError,\n\t\t\t\t\"someCodepath\",\n\t\t\t\tundefined,\n\t\t\t);\n\n\t\t\tassert((coercedError as unknown) !== originalError);\n\t\t\tassert(coercedError instanceof DataProcessingError);\n\t\t\tassert(coercedError.errorType === FluidErrorTypes.dataProcessingError);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingError === 1);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingCodepath === \"someCodepath\");\n\t\t\tassert(coercedError.getTelemetryProperties().untrustedOrigin === 1);\n\t\t});\n\t\tit(\"Should coerce external error object even with errorType\", () => {\n\t\t\tconst originalError = {\n\t\t\t\terrorType: \"Some error type\",\n\t\t\t};\n\t\t\tconst coercedError = DataProcessingError.wrapIfUnrecognized(\n\t\t\t\toriginalError,\n\t\t\t\t\"someCodepath\",\n\t\t\t\tundefined,\n\t\t\t);\n\n\t\t\tassert((coercedError as unknown) !== originalError);\n\t\t\tassert(coercedError instanceof DataProcessingError);\n\t\t\tassert(coercedError.errorType === FluidErrorTypes.dataProcessingError);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingError === 1);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingCodepath === \"someCodepath\");\n\t\t\tassert(coercedError.getTelemetryProperties().untrustedOrigin === 1);\n\t\t\tassert(coercedError.message === \"[object Object]\");\n\t\t});\n\t\tit(\"Should coerce LoggingError missing errorType\", () => {\n\t\t\tconst originalError = new LoggingError(\"Inherited error message\", {\n\t\t\t\totherProperty: \"some safe-to-log property\",\n\t\t\t});\n\t\t\tconst coercedError = DataProcessingError.wrapIfUnrecognized(\n\t\t\t\toriginalError,\n\t\t\t\t\"someCodepath\",\n\t\t\t\tundefined,\n\t\t\t);\n\n\t\t\tassert((coercedError as unknown) !== originalError);\n\t\t\tassert(coercedError instanceof DataProcessingError);\n\t\t\tassert(coercedError.errorType === FluidErrorTypes.dataProcessingError);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingError === 1);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingCodepath === \"someCodepath\");\n\t\t\tassert(coercedError.getTelemetryProperties().untrustedOrigin === undefined);\n\t\t\tassert(coercedError.message === \"Inherited error message\");\n\t\t\tassert(\n\t\t\t\tcoercedError.getTelemetryProperties().otherProperty === \"some safe-to-log property\",\n\t\t\t\t\"telemetryProps should be copied when wrapping\",\n\t\t\t);\n\t\t});\n\n\t\tit(\"Should coerce Normalized LoggingError with errorType\", () => {\n\t\t\tconst originalError = new LoggingError(\"Inherited error message\", {\n\t\t\t\totherProperty: \"some safe-to-log property\",\n\t\t\t});\n\t\t\tconst normalizedLoggingError = normalizeError(originalError);\n\t\t\tconst coercedError = DataProcessingError.wrapIfUnrecognized(\n\t\t\t\tnormalizedLoggingError,\n\t\t\t\t\"someCodepath\",\n\t\t\t\tundefined,\n\t\t\t);\n\t\t\tassert((coercedError as unknown) !== originalError);\n\t\t\tassert(coercedError instanceof DataProcessingError);\n\t\t\tassert(coercedError.errorType === FluidErrorTypes.dataProcessingError);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingError === 1);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingCodepath === \"someCodepath\");\n\t\t\tassert(coercedError.getTelemetryProperties().untrustedOrigin === undefined);\n\t\t\tassert(coercedError.message === \"Inherited error message\");\n\t\t\tassert(\n\t\t\t\tcoercedError.getTelemetryProperties().otherProperty === \"some safe-to-log property\",\n\t\t\t\t\"telemetryProps should be copied when wrapping\",\n\t\t\t);\n\t\t});\n\n\t\tit(\"Should not fail coercing malformed inputs\", () => {\n\t\t\tconst originalMalformations = [\n\t\t\t\t// eslint-disable-next-line unicorn/no-null\n\t\t\t\tnull,\n\t\t\t\tundefined,\n\t\t\t\tfalse,\n\t\t\t\ttrue,\n\t\t\t\t3.14,\n\t\t\t\tSymbol(\"Unique\"),\n\t\t\t\t(): void => {},\n\t\t\t\t[],\n\t\t\t\t[1, 2, 3],\n\t\t\t];\n\t\t\tconst coercedErrors = originalMalformations.map((value) =>\n\t\t\t\tDataProcessingError.wrapIfUnrecognized(value, \"someCodepath\", undefined),\n\t\t\t);\n\n\t\t\tassert(\n\t\t\t\tcoercedErrors.every(\n\t\t\t\t\t(error) =>\n\t\t\t\t\t\ttypeof error.message === \"string\" &&\n\t\t\t\t\t\terror.errorType === FluidErrorTypes.dataProcessingError &&\n\t\t\t\t\t\terror.getTelemetryProperties().dataProcessingError === 1 &&\n\t\t\t\t\t\terror.getTelemetryProperties().dataProcessingCodepath === \"someCodepath\" &&\n\t\t\t\t\t\terror.getTelemetryProperties().untrustedOrigin === 1,\n\t\t\t\t),\n\t\t\t);\n\t\t\tassert(\n\t\t\t\t!originalMalformations.some(\n\t\t\t\t\t(value) =>\n\t\t\t\t\t\ttypeof value === \"string\" ||\n\t\t\t\t\t\t(typeof value === \"object\" && !Array.isArray(value) && value !== null),\n\t\t\t\t),\n\t\t\t\t\"Neither strings nor objects are considered malformed\",\n\t\t\t);\n\t\t});\n\n\t\tit(\"Should be coercible from a string message\", () => {\n\t\t\tconst originalMessage = \"Example of some thrown string\";\n\t\t\tconst coercedError = DataProcessingError.wrapIfUnrecognized(\n\t\t\t\toriginalMessage,\n\t\t\t\t\"someCodepath\",\n\t\t\t\tundefined,\n\t\t\t);\n\n\t\t\tassert(coercedError.message === originalMessage);\n\t\t\tassert(coercedError.errorType === FluidErrorTypes.dataProcessingError);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingError === 1);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingCodepath === \"someCodepath\");\n\t\t});\n\n\t\tit(\"Should be coercible from a property object (no errorType)\", () => {\n\t\t\tconst originalError = {\n\t\t\t\tmessage: \"Inherited error message\",\n\t\t\t};\n\t\t\tconst coercedError = DataProcessingError.wrapIfUnrecognized(\n\t\t\t\toriginalError,\n\t\t\t\t\"someCodepath\",\n\t\t\t\tundefined,\n\t\t\t);\n\n\t\t\tassert(coercedError.message === originalError.message);\n\t\t\tassert(coercedError.errorType === FluidErrorTypes.dataProcessingError);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingError === 1);\n\t\t\tassert(coercedError.getTelemetryProperties().dataProcessingCodepath === \"someCodepath\");\n\t\t});\n\n\t\tit(\"op props should be logged when coerced\", () => {\n\t\t\tconst originalError = {\n\t\t\t\tmessage: \"Inherited error message\",\n\t\t\t};\n\t\t\tconst op = { sequenceNumber: 42 };\n\t\t\tconst coercedError = DataProcessingError.wrapIfUnrecognized(\n\t\t\t\toriginalError,\n\t\t\t\t\"someCodepath\",\n\t\t\t\top,\n\t\t\t);\n\n\t\t\tassert(isILoggingError(coercedError));\n\t\t\tassert(\n\t\t\t\tcoercedError.getTelemetryProperties().messageSequenceNumber === op.sequenceNumber,\n\t\t\t);\n\t\t});\n\n\t\tit(\"op props should be logged even when not coerced\", () => {\n\t\t\tconst originalError = {\n\t\t\t\terrorType: \"hello\",\n\t\t\t};\n\t\t\tconst op = { sequenceNumber: 42 };\n\t\t\tconst coercedError = DataProcessingError.wrapIfUnrecognized(\n\t\t\t\toriginalError,\n\t\t\t\t\"someCodepath\",\n\t\t\t\top,\n\t\t\t);\n\n\t\t\tassert(isILoggingError(coercedError));\n\t\t\tassert(\n\t\t\t\tcoercedError.getTelemetryProperties().messageSequenceNumber === op.sequenceNumber,\n\t\t\t);\n\t\t});\n\t});\n});\n"]}