Add missing test case (and fix)

microsoft · Jul 30, 2021 · 2e6c9c0 · 2e6c9c0
1 parent 3257f8f
commit 2e6c9c0
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 4 deletions.
diff --git a/packages/utils/telemetry-utils/src/fluidErrorBase.ts b/packages/utils/telemetry-utils/src/fluidErrorBase.ts
@@ -5,6 +5,7 @@
 
 import { ITelemetryProperties } from "@fluidframework/common-definitions";
 
+/** LoggingError interface providing both a getter and setter for telemetry props */
 export interface IWriteableLoggingError {
     getTelemetryProperties(): ITelemetryProperties;
     addTelemetryProperties: (props: ITelemetryProperties) => void;
@@ -17,7 +18,8 @@ const isIWriteableLoggingError = (x: any): x is IWriteableLoggingError =>
 
 /**
  * All normalized errors flowing through the Fluid Framework adhere to this readonly interface.
- * It includes Error's properties but as optional, plus errorType and fluidErrorCode strings.
+ * It features errorType, fluidErrorCode, and message strings, plus Error's members as optional
+ * and a getter/setter for telemetry props to be included when the error is logged.
  */
 export interface IFluidErrorBase extends Readonly<Partial<Error>>, IWriteableLoggingError {
     readonly errorType: string;
@@ -29,7 +31,8 @@ export interface IFluidErrorBase extends Readonly<Partial<Error>>, IWriteableLog
 export function isFluidError(e: any): e is IFluidErrorBase {
     return typeof e?.errorType === "string" &&
         typeof e?.fluidErrorCode === "string" &&
-        typeof e?.message === "string";
+        typeof e?.message === "string" &&
+        isIWriteableLoggingError(e);
 }
 
 /** type guard for old standard of valid/known errors */

diff --git a/packages/utils/telemetry-utils/src/test/errorLogging.spec.ts b/packages/utils/telemetry-utils/src/test/errorLogging.spec.ts
@@ -405,15 +405,23 @@ describe("normalizeError", () => {
             stack: stackHint,
         }).withExpectedTelemetryProps({ untrustedOrigin: true });
         const untrustedInputs: { [label: string]: () => { input: any, expectedOutput: TestFluidError }} = {
-            "Fluid Error minus errorType (with stack)": () => ({
+            "Fluid Error minus errorType": () => ({
                 input: sampleFluidError().withoutProperty("errorType"),
                 expectedOutput: typicalOutput("Hello", "<<stack from input>>"),
             }),
 //          "Fluid Error minus fluidErrorCode": This is a Valid Legacy Error, tested elsewhere in this file
-            "Fluid Error minus message (with stack)": () => ({
+            "Fluid Error minus message": () => ({
                 input: sampleFluidError().withoutProperty("message"),
                 expectedOutput: typicalOutput("[object Object]", "<<stack from input>>"),
             }),
+            "Fluid Error minus getTelemetryProperties": () => ({
+                input: sampleFluidError().withoutProperty("getTelemetryProperties"),
+                expectedOutput: typicalOutput("Hello", "<<stack from input>>"),
+            }),
+            "Fluid Error minus addTelemetryProperties": () => ({
+                input: sampleFluidError().withoutProperty("addTelemetryProperties"),
+                expectedOutput: typicalOutput("Hello", "<<stack from input>>"),
+            }),
             "Fluid Error minus errorType (no stack)": () => ({
                 input: sampleFluidError().withoutProperty("errorType").withoutProperty("stack"),
                 expectedOutput: typicalOutput("Hello", "<<generated stack>>"),