docs and metadata changes.

Author: Artmann

build/esbuild/build.ts

@@ -327,7 +327,7 @@ async function buildAll() {
         build(
             path.join(extensionFolder, 'src', 'webviews', 'webview-side', 'dataframe-renderer', 'index.ts'),
             path.join(extensionFolder, 'dist', 'webviews', 'webview-side', 'dataframeRenderer', 'dataframeRenderer.js'),
-            { target: 'web', watch: watchAll }
+            { target: 'web', watch: isWatchMode }
         ),
         build(
             path.join(extensionFolder, 'src', 'webviews', 'webview-side', 'variable-view', 'index.tsx'),

src/kernels/execution/cellExecutionMessageHandler.ts

@@ -644,7 +644,8 @@ export class CellExecutionMessageHandler implements IDisposable {
         }
         // Use cell metadata id if available (from Deepnote blocks), otherwise fall back to cell's internal id
         const cellId = getCellId(this.cell);
-        const cellOutput = cellOutputToVSCCellOutput(output, this.cell.index, cellId);
+        const cellMetadata = this.cell.metadata || {};
+        const cellOutput = cellOutputToVSCCellOutput(output, this.cell.index, cellId, cellMetadata);
         const displayId =
             'transient' in output &&
             typeof output.transient === 'object' &&
@@ -1015,14 +1016,16 @@ export class CellExecutionMessageHandler implements IDisposable {
         if (this.lastUsedStreamOutput?.stream === msg.content.name) {
             // Use cell metadata id if available (from Deepnote blocks), otherwise fall back to cell's internal id
             const cellId = getCellId(this.cell);
+            const cellMetadata = this.cell.metadata || {};
             const output = cellOutputToVSCCellOutput(
                 {
                     output_type: 'stream',
                     name: msg.content.name,
                     text: msg.content.text
                 },
                 this.cell.index,
-                cellId
+                cellId,
+                cellMetadata
             );
             traceCellMessage(this.cell, `Append output items '${msg.content.text.substring(0, 100)}`);
             task?.appendOutputItems(output.items, this.lastUsedStreamOutput.output).then(noop, noop);
@@ -1031,14 +1034,16 @@ export class CellExecutionMessageHandler implements IDisposable {
             const text = concatMultilineString(msg.content.text);
             // Use cell metadata id if available (from Deepnote blocks), otherwise fall back to cell's internal id
             const cellId = getCellId(this.cell);
+            const cellMetadata = this.cell.metadata || {};
             const output = cellOutputToVSCCellOutput(
                 {
                     output_type: 'stream',
                     name: msg.content.name,
                     text
                 },
                 this.cell.index,
-                cellId
+                cellId,
+                cellMetadata
             );
             this.lastUsedStreamOutput = { output, stream: msg.content.name };
             traceCellMessage(this.cell, `Replace output with '${text.substring(0, 100)}'`);
@@ -1048,14 +1053,16 @@ export class CellExecutionMessageHandler implements IDisposable {
             const text = formatStreamText(concatMultilineString(msg.content.text));
             // Use cell metadata id if available (from Deepnote blocks), otherwise fall back to cell's internal id
             const cellId = getCellId(this.cell);
+            const cellMetadata = this.cell.metadata || {};
             const output = cellOutputToVSCCellOutput(
                 {
                     output_type: 'stream',
                     name: msg.content.name,
                     text
                 },
                 this.cell.index,
-                cellId
+                cellId,
+                cellMetadata
             );
             this.lastUsedStreamOutput = { output, stream: msg.content.name };
             traceCellMessage(this.cell, `Append new output '${text.substring(0, 100)}'`);
@@ -1176,14 +1183,16 @@ export class CellExecutionMessageHandler implements IDisposable {
         );
         // Use cell metadata id if available (from Deepnote blocks), otherwise fall back to cell's internal id
         const cellId = getCellId(outputToBeUpdated.cell);
+        const cellMetadata = outputToBeUpdated.cell.metadata || {};
         const newOutput = cellOutputToVSCCellOutput(
             {
                 ...output,
                 data: msg.content.data,
                 metadata: msg.content.metadata
             } as nbformat.IDisplayData,
             outputToBeUpdated.cell.index,
-            cellId
+            cellId,
+            cellMetadata
         );
         // If there was no output and still no output, then nothing to do.
         if (outputToBeUpdated.outputItems.length === 0 && newOutput.items.length === 0) {

src/kernels/execution/helpers.ts

@@ -117,7 +117,12 @@ export function traceCellMessage(cell: NotebookCell, message: string | (() => st
 
 const cellOutputMappers = new Map<
     nbformat.OutputType,
-    (output: nbformat.IOutput, cellIndex?: number, cellId?: string) => NotebookCellOutput
+    (
+        output: nbformat.IOutput,
+        cellIndex?: number,
+        cellId?: string,
+        cellMetadata?: Record<string, unknown>
+    ) => NotebookCellOutput
 >();
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 cellOutputMappers.set('display_data', translateDisplayDataOutput as any);
@@ -132,7 +137,8 @@ cellOutputMappers.set('update_display_data', translateDisplayDataOutput as any);
 export function cellOutputToVSCCellOutput(
     output: nbformat.IOutput,
     cellIndex?: number,
-    cellId?: string
+    cellId?: string,
+    cellMetadata?: Record<string, unknown>
 ): NotebookCellOutput {
     /**
      * Stream, `application/x.notebook.stream`
@@ -160,29 +166,39 @@ export function cellOutputToVSCCellOutput(
     const fn = cellOutputMappers.get(output.output_type as nbformat.OutputType);
     let result: NotebookCellOutput;
     if (fn) {
-        result = fn(output, cellIndex, cellId);
+        result = fn(output, cellIndex, cellId, cellMetadata);
     } else {
         logger.warn(`Unable to translate cell from ${output.output_type} to NotebookCellData for VS Code.`);
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        result = translateDisplayDataOutput(output as any, cellIndex, cellId);
+        result = translateDisplayDataOutput(output as any, cellIndex, cellId, cellMetadata);
     }
     return result;
 }
 
-function getOutputMetadata(output: nbformat.IOutput, cellIndex?: number, cellId?: string): CellOutputMetadata {
-    // Add on transient data if we have any. This should be removed by our save functions elsewhere.
+function getOutputMetadata(
+    output: nbformat.IOutput,
+    cellIndex?: number,
+    cellId?: string,
+    cellMetadata?: Record<string, unknown>
+): CellOutputMetadata {
+    // Merge in order: cellId, cellMetadata, cellIndex, then output-specific metadata (output metadata wins conflicts)
     const metadata: CellOutputMetadata = {
         outputType: output.output_type
     };
 
-    if (cellIndex !== undefined) {
-        metadata.cellIndex = cellIndex;
-    }
-
     if (cellId) {
         metadata.cellId = cellId;
     }
 
+    // Merge cell metadata next (block-level metadata from Deepnote)
+    if (cellMetadata) {
+        Object.assign(metadata, cellMetadata);
+    }
+
+    if (cellIndex !== undefined) {
+        metadata.cellIndex = cellIndex;
+    }
+
     if (output.transient) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         metadata.transient = output.transient as any;
@@ -193,7 +209,10 @@ function getOutputMetadata(output: nbformat.IOutput, cellIndex?: number, cellId?
         case 'execute_result':
         case 'update_display_data': {
             metadata.executionCount = output.execution_count;
-            metadata.metadata = output.metadata ? JSON.parse(JSON.stringify(output.metadata)) : {};
+            // Output metadata is merged last so it overrides block metadata
+            if (output.metadata) {
+                Object.assign(metadata, output.metadata);
+            }
             break;
         }
         default:
@@ -218,7 +237,8 @@ export function getNotebookCellOutputMetadata(output: {
 function translateDisplayDataOutput(
     output: nbformat.IDisplayData | nbformat.IDisplayUpdate | nbformat.IExecuteResult,
     cellIndex?: number,
-    cellId?: string
+    cellId?: string,
+    cellMetadata?: Record<string, unknown>
 ): NotebookCellOutput {
     // Metadata could be as follows:
     // We'll have metadata specific to each mime type as well as generic metadata.
@@ -237,7 +257,7 @@ function translateDisplayDataOutput(
         }
     }
     */
-    const metadata = getOutputMetadata(output, cellIndex, cellId);
+    const metadata = getOutputMetadata(output, cellIndex, cellId, cellMetadata);
     // If we have SVG or PNG, then add special metadata to indicate whether to display `open plot`
     if ('image/svg+xml' in output.data || 'image/png' in output.data) {
         metadata.__displayOpenPlotIcon = true;
@@ -253,10 +273,15 @@ function translateDisplayDataOutput(
     return new NotebookCellOutput(sortOutputItemsBasedOnDisplayOrder(items), metadata);
 }
 
-function translateStreamOutput(output: nbformat.IStream, cellIndex?: number, cellId?: string): NotebookCellOutput {
+function translateStreamOutput(
+    output: nbformat.IStream,
+    cellIndex?: number,
+    cellId?: string,
+    cellMetadata?: Record<string, unknown>
+): NotebookCellOutput {
     const value = concatMultilineString(output.text);
     const factoryFn = output.name === 'stderr' ? NotebookCellOutputItem.stderr : NotebookCellOutputItem.stdout;
-    return new NotebookCellOutput([factoryFn(value)], getOutputMetadata(output, cellIndex, cellId));
+    return new NotebookCellOutput([factoryFn(value)], getOutputMetadata(output, cellIndex, cellId, cellMetadata));
 }
 
 // Output stream can only have stderr or stdout so just check the first output. Undefined if no outputs
@@ -568,7 +593,12 @@ export function translateCellDisplayOutput(output: NotebookCellOutput): JupyterO
  * As we're displaying the error in the statusbar, we don't want this dup error in output.
  * Hence remove this.
  */
-function translateErrorOutput(output?: nbformat.IError, cellIndex?: number, cellId?: string): NotebookCellOutput {
+function translateErrorOutput(
+    output?: nbformat.IError,
+    cellIndex?: number,
+    cellId?: string,
+    cellMetadata?: Record<string, unknown>
+): NotebookCellOutput {
     output = output || { output_type: 'error', ename: '', evalue: '', traceback: [] };
     return new NotebookCellOutput(
         [
@@ -578,7 +608,7 @@ function translateErrorOutput(output?: nbformat.IError, cellIndex?: number, cell
                 stack: (output?.traceback || []).join('\n')
             })
         ],
-        { ...getOutputMetadata(output, cellIndex, cellId), originalError: output }
+        { ...getOutputMetadata(output, cellIndex, cellId, cellMetadata), originalError: output }
     );
 }