✍️ Report tracebacks during kernel execution (#1406)

Co-authored-by: Rowan Cockett <rowanc1@gmail.com>
jupyter-book · Jul 23, 2024 · 28642fe · 28642fe
1 parent 19e96e2
commit 28642fe
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 14 deletions.
diff --git a/.changeset/gold-impalas-cheer.md b/.changeset/gold-impalas-cheer.md
@@ -0,0 +1,5 @@
+---
+"myst-execute": patch
+---
+
+Add error messages for failed kernel execution
diff --git a/packages/myst-execute/src/execute.ts b/packages/myst-execute/src/execute.ts
@@ -4,8 +4,8 @@ import type { PageFrontmatter } from 'myst-frontmatter';
 import type { Kernel, KernelMessage, Session, SessionManager } from '@jupyterlab/services';
 import type { Code, InlineExpression } from 'myst-spec-ext';
 import type { IOutput } from '@jupyterlab/nbformat';
-import type { GenericNode, GenericParent, IExpressionResult } from 'myst-common';
-import { NotebookCell, fileError, fileWarn } from 'myst-common';
+import type { GenericNode, GenericParent, IExpressionResult, IExpressionError } from 'myst-common';
+import { NotebookCell, fileError } from 'myst-common';
 import type { VFile } from 'vfile';
 import path from 'node:path';
 import assert from 'node:assert';
@@ -190,9 +190,13 @@ async function computeExecutableNodes(
       // Check for errors
       const allowErrors = !!matchedNode.data?.tags?.includes?.('raises-exception');
       if (status === 'error' && !allowErrors) {
-        fileWarn(
+        const errorMessage = outputs
+          .map((item) => item.traceback)
+          .flat()
+          .join('\n');
+        fileError(
           opts.vfile,
-          'An exception occurred during code execution, halting further execution',
+          `An exception occurred during code execution, halting further execution:\n\n${errorMessage}`,
           {
             node: matchedNode,
           },
@@ -207,9 +211,10 @@ async function computeExecutableNodes(
 
       // Check for errors
       if (status === 'error') {
-        fileWarn(
+        const errorMessage = (result as IExpressionError).traceback.join('\n');
+        fileError(
           opts.vfile,
-          'An exception occurred during expression evaluation, halting further execution',
+          `An exception occurred during expression evaluation, halting further execution:\n\n${errorMessage}`,
           { node: matchedNode },
         );
         // Make a note of the failure
@@ -336,11 +341,6 @@ export async function kernelExecutionTransform(tree: GenericParent, vfile: VFile
           // Populate cache if things were successful
           if (!errorOccurred) {
             opts.cache.set(cacheKey, results);
-          } else {
-            // Otherwise, keep tabs on the error
-            fileError(vfile, 'An error occurred during kernel execution', {
-              fatal: opts.errorIsFatal,
-            });
           }
           // Refer to these computed results
           cachedResults = results;

diff --git a/packages/myst-execute/tests/execute.yml b/packages/myst-execute/tests/execute.yml
@@ -94,7 +94,7 @@ cases:
               text/plain: '3'
             metadata: {}
   - title: tree with bad inline expression throws
-    throws: An error occurred during kernel execution
+    throws: An exception occurred during expression evaluation
     before:
       type: root
       children:
@@ -108,7 +108,7 @@ cases:
           name: expr-0
           value: 1 + llama
   - title: tree with bad executable code is evaluated and throws
-    throws: An error occurred during kernel execution
+    throws: An exception occurred during code execution
     before:
       type: root
       children:
@@ -233,7 +233,7 @@ cases:
               id: T7FMDqDm8dM2bOT1tKeeM
               identifier: nb-cell-0-output
               html_id: nb-cell-0-output
-              data:  
+              data:
     after:
       type: root
       children: