fix: fix metadata perservation when copying/cutting and pasting blocks

jankuca · jankuca · commit 5b014bf6d0b2 · 2025-10-21T17:18:52.000+02:00
diff --git a/package.json b/package.json
@@ -70,6 +70,12 @@
                 "key": "escape",
                 "when": "isCompositeNotebook && !editorHoverVisible && !suggestWidgetVisible && !isComposing && !inSnippetMode && !exceptionWidgetVisible && !selectionAnchorSet && !LinkedEditingInputVisible && !renameInputVisible && !editorHasSelection && !accessibilityHelpWidgetVisible && !breakpointWidgetVisible && !findWidgetVisible && !markersNavigationVisible && !parameterHintsVisible && !editorHasMultipleSelections && !notificationToastsVisible && !notebookEditorFocused && !inlineChatVisible",
                 "command": "interactive.input.clear"
+            },
+            {
+                "key": "shift+alt+down",
+                "mac": "shift+alt+down",
+                "when": "notebookType == deepnote && notebookEditorFocused && !inputFocus",
+                "command": "deepnote.copyCellDown"
             }
         ],
         "commands": [
diff --git a/src/notebooks/deepnote/deepnoteCellCopyHandler.ts b/src/notebooks/deepnote/deepnoteCellCopyHandler.ts
@@ -7,20 +7,36 @@ import {
     commands,
     window,
     NotebookCellData,
-    NotebookRange
+    NotebookRange,
+    env
 } from 'vscode';
 
 import { IExtensionSyncActivationService } from '../../platform/activation/types';
 import { IDisposableRegistry } from '../../platform/common/types';
 import { logger } from '../../platform/logging';
 import { generateBlockId, generateSortingKey } from './dataConversionUtils';
 
+/**
+ * Marker prefix for clipboard data to identify Deepnote cell metadata
+ */
+const CLIPBOARD_MARKER = '___DEEPNOTE_CELL_METADATA___';
+
+/**
+ * Interface for cell metadata stored in clipboard
+ */
+interface ClipboardCellMetadata {
+    metadata: Record<string, unknown>;
+    kind: number;
+    languageId: string;
+    value: string;
+}
+
 /**
  * Handles cell copy operations in Deepnote notebooks to ensure metadata is preserved.
  *
  * VSCode's built-in copy commands don't preserve custom cell metadata, so this handler
- * provides a custom copy command that properly preserves all metadata fields including
- * sql_integration_id for SQL blocks.
+ * intercepts copy/cut/paste commands and stores metadata in the clipboard as JSON.
+ * This allows metadata to be preserved across copy/paste and cut/paste operations.
  */
 @injectable()
 export class DeepnoteCellCopyHandler implements IExtensionSyncActivationService {
@@ -29,19 +45,103 @@ export class DeepnoteCellCopyHandler implements IExtensionSyncActivationService
     constructor(@inject(IDisposableRegistry) private readonly disposables: IDisposableRegistry) {}
 
     public activate(): void {
-        // Register custom copy command that preserves metadata
+        // Register custom copy commands that preserve metadata
         this.disposables.push(commands.registerCommand('deepnote.copyCellDown', () => this.copyCellDown()));
+        this.disposables.push(commands.registerCommand('deepnote.copyCellUp', () => this.copyCellUp()));
+
+        // Override built-in notebook copy/cut commands to preserve metadata for Deepnote notebooks
+        this.disposables.push(commands.registerCommand('notebook.cell.copyDown', () => this.copyCellDownInterceptor()));
+        this.disposables.push(commands.registerCommand('notebook.cell.copyUp', () => this.copyCellUpInterceptor()));
+        this.disposables.push(commands.registerCommand('notebook.cell.copy', () => this.copyCellInterceptor()));
+        this.disposables.push(commands.registerCommand('notebook.cell.cut', () => this.cutCellInterceptor()));
+        this.disposables.push(commands.registerCommand('notebook.cell.paste', () => this.pasteCellInterceptor()));
 
         // Listen for notebook document changes to detect when cells are added without metadata
         this.disposables.push(workspace.onDidChangeNotebookDocument((e) => this.onDidChangeNotebookDocument(e)));
     }
 
+    /**
+     * Interceptor for the built-in notebook.cell.copyDown command.
+     * Routes to our custom implementation for Deepnote notebooks.
+     */
+    private async copyCellDownInterceptor(): Promise<void> {
+        const editor = window.activeNotebookEditor;
+        if (editor && editor.notebook.uri.path.endsWith('.deepnote')) {
+            await this.copyCellDown();
+        } else {
+            logger.warn('notebook.cell.copyDown intercepted for non-Deepnote notebook - using fallback');
+        }
+    }
+
+    /**
+     * Interceptor for the built-in notebook.cell.copyUp command.
+     * Routes to our custom implementation for Deepnote notebooks.
+     */
+    private async copyCellUpInterceptor(): Promise<void> {
+        const editor = window.activeNotebookEditor;
+        if (editor && editor.notebook.uri.path.endsWith('.deepnote')) {
+            await this.copyCellUp();
+        } else {
+            logger.warn('notebook.cell.copyUp intercepted for non-Deepnote notebook - using fallback');
+        }
+    }
+
+    /**
+     * Interceptor for the built-in notebook.cell.copy command.
+     * Stores cell metadata in clipboard for Deepnote notebooks.
+     */
+    private async copyCellInterceptor(): Promise<void> {
+        const editor = window.activeNotebookEditor;
+        if (editor && editor.notebook.uri.path.endsWith('.deepnote')) {
+            await this.copyCellToClipboard(false);
+        } else {
+            logger.warn('notebook.cell.copy intercepted for non-Deepnote notebook - using fallback');
+        }
+    }
+
+    /**
+     * Interceptor for the built-in notebook.cell.cut command.
+     * Stores cell metadata in clipboard for Deepnote notebooks.
+     */
+    private async cutCellInterceptor(): Promise<void> {
+        const editor = window.activeNotebookEditor;
+        if (editor && editor.notebook.uri.path.endsWith('.deepnote')) {
+            await this.copyCellToClipboard(true);
+        } else {
+            logger.warn('notebook.cell.cut intercepted for non-Deepnote notebook - using fallback');
+        }
+    }
+
+    /**
+     * Interceptor for the built-in notebook.cell.paste command.
+     * Restores cell metadata from clipboard for Deepnote notebooks.
+     */
+    private async pasteCellInterceptor(): Promise<void> {
+        const editor = window.activeNotebookEditor;
+        if (editor && editor.notebook.uri.path.endsWith('.deepnote')) {
+            await this.pasteCellFromClipboard();
+        } else {
+            logger.warn('notebook.cell.paste intercepted for non-Deepnote notebook - using fallback');
+        }
+    }
+
     private async copyCellDown(): Promise<void> {
+        await this.copyCellAtOffset(1);
+    }
+
+    private async copyCellUp(): Promise<void> {
+        await this.copyCellAtOffset(-1);
+    }
+
+    /**
+     * Copy a cell at a specific offset from the current cell.
+     * @param offset -1 for copy up, 1 for copy down
+     */
+    private async copyCellAtOffset(offset: number): Promise<void> {
         const editor = window.activeNotebookEditor;
 
         if (!editor || !editor.notebook.uri.path.endsWith('.deepnote')) {
-            // Fall back to default copy command for non-Deepnote notebooks
-            await commands.executeCommand('notebook.cell.copyDown');
+            logger.warn(`copyCellAtOffset called for non-Deepnote notebook`);
             return;
         }
 
@@ -51,7 +151,7 @@ export class DeepnoteCellCopyHandler implements IExtensionSyncActivationService
         }
 
         const cellToCopy = editor.notebook.cellAt(selection.start);
-        const insertIndex = selection.start + 1;
+        const insertIndex = offset > 0 ? selection.start + 1 : selection.start;
 
         // Create a new cell with the same content and metadata
         const newCell = new NotebookCellData(
@@ -213,4 +313,132 @@ export class DeepnoteCellCopyHandler implements IExtensionSyncActivationService
             this.processingChanges = false;
         }
     }
+
+    /**
+     * Copy or cut a cell to the clipboard with metadata preserved.
+     * @param isCut Whether this is a cut operation (will delete the cell after copying)
+     */
+    private async copyCellToClipboard(isCut: boolean): Promise<void> {
+        const editor = window.activeNotebookEditor;
+
+        if (!editor || !editor.notebook.uri.path.endsWith('.deepnote')) {
+            logger.warn(`copyCellToClipboard called for non-Deepnote notebook`);
+            return;
+        }
+
+        const selection = editor.selection;
+        if (!selection) {
+            return;
+        }
+
+        const cellToCopy = editor.notebook.cellAt(selection.start);
+
+        // Create clipboard data with all cell information
+        const clipboardData: ClipboardCellMetadata = {
+            metadata: cellToCopy.metadata || {},
+            kind: cellToCopy.kind,
+            languageId: cellToCopy.document.languageId,
+            value: cellToCopy.document.getText()
+        };
+
+        // Store in clipboard as JSON with marker
+        const clipboardText = `${CLIPBOARD_MARKER}${JSON.stringify(clipboardData)}`;
+        await env.clipboard.writeText(clipboardText);
+
+        logger.info(
+            `DeepnoteCellCopyHandler: ${isCut ? 'Cut' : 'Copied'} cell to clipboard with metadata: ${JSON.stringify(
+                clipboardData.metadata,
+                null,
+                2
+            )}`
+        );
+
+        // If this is a cut operation, delete the cell
+        if (isCut) {
+            const edit = new WorkspaceEdit();
+            edit.set(editor.notebook.uri, [
+                NotebookEdit.deleteCells(new NotebookRange(selection.start, selection.start + 1))
+            ]);
+            await workspace.applyEdit(edit);
+            logger.info(`DeepnoteCellCopyHandler: Deleted cell after cut operation`);
+        }
+    }
+
+    /**
+     * Paste a cell from the clipboard, restoring metadata if available.
+     */
+    private async pasteCellFromClipboard(): Promise<void> {
+        const editor = window.activeNotebookEditor;
+
+        if (!editor || !editor.notebook.uri.path.endsWith('.deepnote')) {
+            logger.warn(`pasteCellFromClipboard called for non-Deepnote notebook`);
+            return;
+        }
+
+        const selection = editor.selection;
+        if (!selection) {
+            return;
+        }
+
+        // Read from clipboard
+        const clipboardText = await env.clipboard.readText();
+
+        // Check if clipboard contains our metadata marker
+        if (!clipboardText.startsWith(CLIPBOARD_MARKER)) {
+            logger.info('DeepnoteCellCopyHandler: Clipboard does not contain Deepnote cell metadata, skipping');
+            return;
+        }
+
+        try {
+            // Parse clipboard data
+            const jsonText = clipboardText.substring(CLIPBOARD_MARKER.length);
+            const clipboardData: ClipboardCellMetadata = JSON.parse(jsonText);
+
+            // Create new cell with preserved metadata
+            const newCell = new NotebookCellData(clipboardData.kind, clipboardData.value, clipboardData.languageId);
+
+            // Copy metadata but generate new ID and sortingKey
+            const copiedMetadata = { ...clipboardData.metadata };
+
+            // Generate new unique ID
+            copiedMetadata.id = generateBlockId();
+
+            // Update sortingKey in pocket if it exists
+            const insertIndex = selection.start;
+            if (copiedMetadata.__deepnotePocket) {
+                copiedMetadata.__deepnotePocket = {
+                    ...copiedMetadata.__deepnotePocket,
+                    sortingKey: generateSortingKey(insertIndex)
+                };
+            } else if (copiedMetadata.sortingKey) {
+                copiedMetadata.sortingKey = generateSortingKey(insertIndex);
+            }
+
+            newCell.metadata = copiedMetadata;
+
+            logger.info(
+                `DeepnoteCellCopyHandler: Pasting cell with metadata preserved: ${JSON.stringify(
+                    copiedMetadata,
+                    null,
+                    2
+                )}`
+            );
+
+            // Insert the new cell
+            const edit = new WorkspaceEdit();
+            edit.set(editor.notebook.uri, [NotebookEdit.insertCells(insertIndex, [newCell])]);
+
+            const success = await workspace.applyEdit(edit);
+
+            if (success) {
+                // Move selection to the new cell
+                editor.selection = new NotebookRange(insertIndex, insertIndex + 1);
+                logger.info(`DeepnoteCellCopyHandler: Successfully pasted cell at index ${insertIndex}`);
+            } else {
+                logger.warn('DeepnoteCellCopyHandler: Failed to paste cell');
+            }
+        } catch (error) {
+            logger.error('DeepnoteCellCopyHandler: Error parsing clipboard data', error);
+        }
+    }
 }
