fix(core/js_error): Get frame data from prepareStackTrace() (#4690)

Fixes: #2703 Fixes: #2710 Closes: #4153 Closes: #4232 Co-authored-by: Kevin (Kun) Kassimo Qian <[email protected]>
denoland · Apr 10, 2020 · 8b45083 · 8b45083
1 parent 195ad4c
commit 8b45083
Show file tree

Hide file tree

Showing 11 changed files with 257 additions and 48 deletions.
diff --git a/cli/fmt_errors.rs b/cli/fmt_errors.rs
@@ -155,9 +155,21 @@ fn format_stack_frame(frame: &JSStackFrame, is_internal_frame: bool) -> String {
     source_loc = colors::gray(source_loc).to_string();
   }
   if !frame.function_name.is_empty() {
-    format!("{} {} {}", at_prefix, function_name, source_loc)
+    if frame.is_async {
+      format!(
+        "{} {} {} {}",
+        at_prefix,
+        colors::gray("async".to_owned()).to_string(),
+        function_name,
+        source_loc
+      )
+    } else {
+      format!("{} {} {}", at_prefix, function_name, source_loc)
+    }
   } else if frame.is_eval {
     format!("{} eval {}", at_prefix, source_loc)
+  } else if frame.is_async {
+    format!("{} async {}", at_prefix, source_loc)
   } else {
     format!("{} {}", at_prefix, source_loc)
   }
@@ -272,6 +284,7 @@ mod tests {
           function_name: "foo".to_string(),
           is_eval: false,
           is_constructor: false,
+          is_async: false,
         },
         JSStackFrame {
           line_number: 5,
@@ -280,6 +293,7 @@ mod tests {
           function_name: "qat".to_string(),
           is_eval: false,
           is_constructor: false,
+          is_async: false,
         },
         JSStackFrame {
           line_number: 1,
@@ -288,8 +302,10 @@ mod tests {
           function_name: "".to_string(),
           is_eval: false,
           is_constructor: false,
+          is_async: false,
         },
       ],
+      already_source_mapped: true,
     };
     let formatted_error = JSError(core_js_error).to_string();
     let actual = strip_ansi_codes(&formatted_error);

diff --git a/cli/js/error_stack.ts b/cli/js/error_stack.ts
@@ -140,7 +140,7 @@ function callSiteToString(callSite: CallSite): string {
     result += "async ";
   }
   if (isPromiseAll) {
-    result += `Promise.all (index ${callSite.getPromiseIndex})`;
+    result += `Promise.all (index ${callSite.getPromiseIndex()})`;
     return result;
   }
   if (isMethodCall) {
@@ -163,11 +163,52 @@ function callSiteToString(callSite: CallSite): string {
   return result;
 }
 
+interface CallSiteEval {
+  this: unknown;
+  typeName: string;
+  function: Function;
+  functionName: string;
+  methodName: string;
+  fileName: string;
+  lineNumber: number | null;
+  columnNumber: number | null;
+  evalOrigin: string | null;
+  isToplevel: boolean;
+  isEval: boolean;
+  isNative: boolean;
+  isConstructor: boolean;
+  isAsync: boolean;
+  isPromiseAll: boolean;
+  promiseIndex: number | null;
+}
+
+function evaluateCallSite(callSite: CallSite): CallSiteEval {
+  return {
+    this: callSite.getThis(),
+    typeName: callSite.getTypeName(),
+    function: callSite.getFunction(),
+    functionName: callSite.getFunctionName(),
+    methodName: callSite.getMethodName(),
+    fileName: callSite.getFileName(),
+    lineNumber: callSite.getLineNumber(),
+    columnNumber: callSite.getColumnNumber(),
+    evalOrigin: callSite.getEvalOrigin(),
+    isToplevel: callSite.isToplevel(),
+    isEval: callSite.isEval(),
+    isNative: callSite.isNative(),
+    isConstructor: callSite.isConstructor(),
+    isAsync: callSite.isAsync(),
+    isPromiseAll: callSite.isPromiseAll(),
+    promiseIndex: callSite.getPromiseIndex(),
+  };
+}
+
 function prepareStackTrace(
   error: Error,
   structuredStackTrace: CallSite[]
 ): string {
-  return (
+  Object.defineProperty(error, "__callSiteEvals", { value: [] });
+  const errorString =
     `${error.name}: ${error.message}\n` +
     structuredStackTrace
       .map(
@@ -188,9 +229,18 @@ function prepareStackTrace(
           return callSite;
         }
       )
-      .map((callSite): string => `    at ${callSiteToString(callSite)}`)
-      .join("\n")
-  );
+      .map((callSite): string => {
+        const callSiteEv = Object.freeze(evaluateCallSite(callSite));
+        if (callSiteEv.lineNumber != null && callSiteEv.columnNumber != null) {
+          // @ts-ignore
+          error["__callSiteEvals"].push(callSiteEv);
+        }
+        return `    at ${callSiteToString(callSite)}`;
+      })
+      .join("\n");
+  // @ts-ignore
+  Object.freeze(error["__callSiteEvals"]);
+  return errorString;
 }
 
 // @internal

diff --git a/cli/source_maps.rs b/cli/source_maps.rs
@@ -49,11 +49,16 @@ pub fn apply_source_map<G: SourceMapGetter>(
 ) -> deno_core::JSError {
   let mut mappings_map: CachedMaps = HashMap::new();
 
-  let mut frames = Vec::<JSStackFrame>::new();
-  for frame in &js_error.frames {
-    let f = frame_apply_source_map(&frame, &mut mappings_map, getter);
-    frames.push(f);
-  }
+  let frames = if !js_error.already_source_mapped {
+    let mut frames = Vec::<JSStackFrame>::new();
+    for frame in &js_error.frames {
+      let f = frame_apply_source_map(&frame, &mut mappings_map, getter);
+      frames.push(f);
+    }
+    frames
+  } else {
+    js_error.frames.clone()
+  };
 
   let (script_resource_name, line_number, start_column) =
     get_maybe_orig_position(
@@ -98,6 +103,7 @@ pub fn apply_source_map<G: SourceMapGetter>(
     start_column,
     end_column,
     frames,
+    already_source_mapped: js_error.already_source_mapped,
   }
 }
 
@@ -121,6 +127,7 @@ fn frame_apply_source_map<G: SourceMapGetter>(
     column,
     is_eval: frame.is_eval,
     is_constructor: frame.is_constructor,
+    is_async: frame.is_async,
   }
 }
 
@@ -255,6 +262,7 @@ mod tests {
           function_name: "foo".to_string(),
           is_eval: false,
           is_constructor: false,
+          is_async: false,
         },
         JSStackFrame {
           line_number: 5,
@@ -263,6 +271,7 @@ mod tests {
           function_name: "qat".to_string(),
           is_eval: false,
           is_constructor: false,
+          is_async: false,
         },
         JSStackFrame {
           line_number: 1,
@@ -271,8 +280,10 @@ mod tests {
           function_name: "".to_string(),
           is_eval: false,
           is_constructor: false,
+          is_async: false,
         },
       ],
+      already_source_mapped: false,
     };
     let getter = MockSourceMapGetter {};
     let actual = apply_source_map(&core_js_error, &getter);
@@ -291,6 +302,7 @@ mod tests {
           function_name: "foo".to_string(),
           is_eval: false,
           is_constructor: false,
+          is_async: false,
         },
         JSStackFrame {
           line_number: 4,
@@ -299,6 +311,7 @@ mod tests {
           function_name: "qat".to_string(),
           is_eval: false,
           is_constructor: false,
+          is_async: false,
         },
         JSStackFrame {
           line_number: 1,
@@ -307,8 +320,10 @@ mod tests {
           function_name: "".to_string(),
           is_eval: false,
           is_constructor: false,
+          is_async: false,
         },
       ],
+      already_source_mapped: false,
     };
     assert_eq!(actual, expected);
   }
@@ -329,7 +344,9 @@ mod tests {
         function_name: "setLogDebug".to_string(),
         is_eval: false,
         is_constructor: false,
+        is_async: false,
       }],
+      already_source_mapped: false,
     };
     let getter = MockSourceMapGetter {};
     let actual = apply_source_map(&e, &getter);
@@ -348,6 +365,7 @@ mod tests {
       start_column: Some(16),
       end_column: None,
       frames: vec![],
+      already_source_mapped: false,
     };
     let getter = MockSourceMapGetter {};
     let actual = apply_source_map(&e, &getter);

diff --git a/cli/tests/044_bad_resource.ts.out b/cli/tests/044_bad_resource.ts.out
@@ -1,6 +1,6 @@
 [WILDCARD]
 error: Uncaught BadResource: Bad resource ID
 [WILDCARD]dispatch_json.ts:[WILDCARD]
-    at BadResource ([WILDCARD]errors.ts:[WILDCARD])
     at unwrapResponse ([WILDCARD]dispatch_json.ts:[WILDCARD])
     at sendAsync ([WILDCARD]dispatch_json.ts:[WILDCARD])
+    at async main ([WILDCARD]tests/044_bad_resource.ts:[WILDCARD])
diff --git a/cli/tests/error_004_missing_module.ts.out b/cli/tests/error_004_missing_module.ts.out
@@ -1,5 +1,9 @@
 [WILDCARD]error: Uncaught NotFound: Cannot resolve module "[WILDCARD]/bad-module.ts" from "[WILDCARD]/error_004_missing_module.ts"
 [WILDCARD]dispatch_json.ts:[WILDCARD]
-    at NotFound ([WILDCARD]errors.ts:[WILDCARD])
     at unwrapResponse ([WILDCARD]dispatch_json.ts:[WILDCARD])
-    at sendAsync[WILDCARD] ([WILDCARD]dispatch_json.ts:[WILDCARD])
+    at sendAsync ([WILDCARD]dispatch_json.ts:[WILDCARD])
+    at async processImports ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at async processImports ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at async compile ([WILDCARD]compiler.ts:[WILDCARD])
+    at async tsCompilerOnMessage ([WILDCARD]compiler.ts:[WILDCARD])
+    at async workerMessageRecvCallback ([WILDCARD]runtime_worker.ts:[WILDCARD])
diff --git a/cli/tests/error_005_missing_dynamic_import.ts.out b/cli/tests/error_005_missing_dynamic_import.ts.out
@@ -1,5 +1,9 @@
 [WILDCARD]error: Uncaught NotFound: Cannot resolve module "[WILDCARD]/bad-module.ts" from "[WILDCARD]/error_005_missing_dynamic_import.ts"
 [WILDCARD]dispatch_json.ts:[WILDCARD]
-    at NotFound ([WILDCARD]errors.ts:[WILDCARD])
     at unwrapResponse ([WILDCARD]dispatch_json.ts:[WILDCARD])
-    at sendAsync[WILDCARD] ([WILDCARD]dispatch_json.ts:[WILDCARD])
+    at sendAsync ([WILDCARD]dispatch_json.ts:[WILDCARD])
+    at async processImports ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at async processImports ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at async compile ([WILDCARD]compiler.ts:[WILDCARD])
+    at async tsCompilerOnMessage ([WILDCARD]compiler.ts:[WILDCARD])
+    at async workerMessageRecvCallback ([WILDCARD]runtime_worker.ts:[WILDCARD])
diff --git a/cli/tests/error_006_import_ext_failure.ts.out b/cli/tests/error_006_import_ext_failure.ts.out
@@ -1,5 +1,9 @@
 [WILDCARD]error: Uncaught NotFound: Cannot resolve module "[WILDCARD]/non-existent" from "[WILDCARD]/error_006_import_ext_failure.ts"
 [WILDCARD]dispatch_json.ts:[WILDCARD]
-    at NotFound ([WILDCARD]errors.ts:[WILDCARD])
     at unwrapResponse ([WILDCARD]dispatch_json.ts:[WILDCARD])
     at sendAsync[WILDCARD] ([WILDCARD]dispatch_json.ts:[WILDCARD])
+    at async processImports ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at async processImports ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at async compile ([WILDCARD]compiler.ts:[WILDCARD])
+    at async tsCompilerOnMessage ([WILDCARD]compiler.ts:[WILDCARD])
+    at async workerMessageRecvCallback ([WILDCARD]runtime_worker.ts:[WILDCARD])
diff --git a/cli/tests/error_011_bad_module_specifier.ts.out b/cli/tests/error_011_bad_module_specifier.ts.out
@@ -1,7 +1,10 @@
 [WILDCARD]error: Uncaught URIError: relative import path "bad-module.ts" not prefixed with / or ./ or ../ Imported from "[WILDCARD]/error_011_bad_module_specifier.ts"
 [WILDCARD]dispatch_json.ts:[WILDCARD]
-    at unwrapResponse ($deno$/ops/dispatch_json.ts:[WILDCARD])
-    at sendSync ($deno$/ops/dispatch_json.ts:[WILDCARD])
-    at resolveModules ($deno$/compiler/imports.ts:[WILDCARD])
-    at processImports ($deno$/compiler/imports.ts:[WILDCARD])
-    at processImports ($deno$/compiler/imports.ts:[WILDCARD])
+    at unwrapResponse ([WILDCARD]ops/dispatch_json.ts:[WILDCARD])
+    at sendSync ([WILDCARD]ops/dispatch_json.ts:[WILDCARD])
+    at resolveModules ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at processImports ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at processImports ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at async compile ([WILDCARD]compiler.ts:[WILDCARD])
+    at async tsCompilerOnMessage ([WILDCARD]compiler.ts:[WILDCARD])
+    at async workerMessageRecvCallback ([WILDCARD]runtime_worker.ts:[WILDCARD])
diff --git a/cli/tests/error_012_bad_dynamic_import_specifier.ts.out b/cli/tests/error_012_bad_dynamic_import_specifier.ts.out
@@ -1,7 +1,10 @@
 [WILDCARD]error: Uncaught URIError: relative import path "bad-module.ts" not prefixed with / or ./ or ../ Imported from "[WILDCARD]/error_012_bad_dynamic_import_specifier.ts"
 [WILDCARD]dispatch_json.ts:[WILDCARD]
-    at unwrapResponse ($deno$/ops/dispatch_json.ts:[WILDCARD])
-    at sendSync ($deno$/ops/dispatch_json.ts:[WILDCARD])
-    at resolveModules ($deno$/compiler/imports.ts:[WILDCARD])
-    at processImports ($deno$/compiler/imports.ts:[WILDCARD])
-    at processImports ($deno$/compiler/imports.ts:[WILDCARD])
+    at unwrapResponse ([WILDCARD]ops/dispatch_json.ts:[WILDCARD])
+    at sendSync ([WILDCARD]ops/dispatch_json.ts:[WILDCARD])
+    at resolveModules ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at processImports ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at processImports ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at async compile ([WILDCARD]compiler.ts:[WILDCARD])
+    at async tsCompilerOnMessage ([WILDCARD]compiler.ts:[WILDCARD])
+    at async workerMessageRecvCallback ([WILDCARD]runtime_worker.ts:[WILDCARD])
diff --git a/cli/tests/error_type_definitions.ts.out b/cli/tests/error_type_definitions.ts.out
@@ -1,7 +1,11 @@
 [WILDCARD]error: Uncaught URIError: relative import path "baz" not prefixed with / or ./ or ../ Imported from "[WILDCARD]/type_definitions/bar.d.ts"
 [WILDCARD]dispatch_json.ts:[WILDCARD]
-    at unwrapResponse ($deno$/ops/dispatch_json.ts:[WILDCARD])
-    at sendSync ($deno$/ops/dispatch_json.ts:[WILDCARD])
-    at resolveModules ($deno$/compiler/imports.ts:[WILDCARD])
-    at processImports ($deno$/compiler/imports.ts:[WILDCARD])
-    at processImports ($deno$/compiler/imports.ts:[WILDCARD])
+    at unwrapResponse ([WILDCARD]ops/dispatch_json.ts:[WILDCARD])
+    at sendSync ([WILDCARD]ops/dispatch_json.ts:[WILDCARD])
+    at resolveModules ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at processImports ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at processImports ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at async processImports ([WILDCARD]compiler/imports.ts:[WILDCARD])
+    at async compile ([WILDCARD]compiler.ts:[WILDCARD])
+    at async tsCompilerOnMessage ([WILDCARD]compiler.ts:[WILDCARD])
+    at async workerMessageRecvCallback ([WILDCARD]runtime_worker.ts:[WILDCARD])