6/2 API Changes (#6089)

src/client/common/application/notebook.ts

@@ -15,7 +15,8 @@ import {
     NotebookEditorSelectionChangeEvent,
     NotebookExecuteHandler,
     NotebookRendererScript,
-    window
+    window,
+    workspace
 } from 'vscode';
 import { UseVSCodeNotebookEditorApi } from '../constants';
 import { IDisposableRegistry } from '../types';
@@ -31,7 +32,7 @@ export class VSCodeNotebook implements IVSCodeNotebook {
     public readonly onDidSaveNotebookDocument: Event<NotebookDocument>;
     public readonly onDidChangeNotebookDocument: Event<NotebookCellChangedEvent>;
     public get notebookDocuments(): ReadonlyArray<NotebookDocument> {
-        return this.canUseNotebookApi ? notebooks.notebookDocuments : [];
+        return this.canUseNotebookApi ? workspace.notebookDocuments : [];
     }
     public get notebookEditors() {
         return this.canUseNotebookApi ? window.visibleNotebookEditors : [];
@@ -60,8 +61,8 @@ export class VSCodeNotebook implements IVSCodeNotebook {
             this.canUseNotebookApi = true;
             this.onDidChangeNotebookEditorSelection = window.onDidChangeNotebookEditorSelection;
             this.onDidChangeActiveNotebookEditor = window.onDidChangeActiveNotebookEditor;
-            this.onDidOpenNotebookDocument = notebooks.onDidOpenNotebookDocument;
-            this.onDidCloseNotebookDocument = notebooks.onDidCloseNotebookDocument;
+            this.onDidOpenNotebookDocument = workspace.onDidOpenNotebookDocument;
+            this.onDidCloseNotebookDocument = workspace.onDidCloseNotebookDocument;
             this.onDidChangeVisibleNotebookEditors = window.onDidChangeVisibleNotebookEditors;
             this.onDidSaveNotebookDocument = notebooks.onDidSaveNotebookDocument;
             this.onDidChangeNotebookDocument = this._onDidChangeNotebookDocument.event;
@@ -86,7 +87,7 @@ export class VSCodeNotebook implements IVSCodeNotebook {
             transientDocumentMetadata?: { [x: string]: boolean | undefined } | undefined;
         }
     ): Disposable {
-        return notebooks.registerNotebookContentProvider(notebookType, provider, options);
+        return workspace.registerNotebookContentProvider(notebookType, provider, options);
     }
     public createNotebookController(
         id: string,

src/client/datascience/jupyter/kernels/cellExecution.ts

@@ -185,7 +185,8 @@ export class CellExecution {
             `Cell Exec contents ${this.cell.document.getText().substring(0, 50)}...`
         );
         if (!this.canExecuteCell()) {
-            this.execution?.end({});
+            // End state is bool | undefined not optional. Undefined == not success or failure
+            this.execution?.end(undefined);
             this.execution = undefined;
             return;
         }
@@ -199,7 +200,7 @@ export class CellExecution {
 
         this.startTime = new Date().getTime();
         CellExecution.activeNotebookCellExecution.set(this.cell.notebook, this.execution);
-        this.execution?.start({ startTime: this.startTime });
+        this.execution?.start(this.startTime);
         await Promise.all([this.initPromise, this.execution?.clearOutput()]);
         this.stopWatch.reset();
 
@@ -289,13 +290,15 @@ export class CellExecution {
     }
     private endCellTask(success: 'success' | 'failed' | 'cancelled') {
         if (this.isEmptyCodeCell) {
-            this.execution?.end({});
+            // Undefined for not success or failures
+            this.execution?.end(undefined);
         } else if (success === 'success' || success === 'failed') {
             this.endTime = new Date().getTime();
-            this.execution?.end({ endTime: this.endTime, success: success === 'success' });
+            this.execution?.end(success === 'success', this.endTime);
         } else {
             // Cell was cancelled.
-            this.execution?.end({});
+            // Undefined for not success or failures
+            this.execution?.end(undefined);
         }
         if (CellExecution.activeNotebookCellExecution.get(this.cell.notebook) === this.execution) {
             CellExecution.activeNotebookCellExecution.set(this.cell.notebook, undefined);
@@ -323,7 +326,7 @@ export class CellExecution {
         // Create a temporary task.
         this.previousResultsToRestore = { ...(this.cell.executionSummary || {}) };
         this.temporaryExecution = this.controller.createNotebookCellExecution(this.cell);
-        this.temporaryExecution?.start({});
+        this.temporaryExecution?.start();
         if (this.previousResultsToRestore?.executionOrder && this.execution) {
             this.execution.executionOrder = this.previousResultsToRestore.executionOrder;
         }
@@ -337,12 +340,13 @@ export class CellExecution {
             if (this.previousResultsToRestore.executionOrder) {
                 this.temporaryExecution.executionOrder = this.previousResultsToRestore.executionOrder;
             }
-            this.temporaryExecution.end({
-                endTime: this.previousResultsToRestore.endTime,
-                success: this.previousResultsToRestore.success
-            });
+            this.temporaryExecution.end(
+                this.previousResultsToRestore.success,
+                this.previousResultsToRestore.timing?.endTime
+            );
         } else {
-            this.temporaryExecution?.end({});
+            // Undefined for not success or failure
+            this.temporaryExecution?.end(undefined);
         }
         this.previousResultsToRestore = undefined;
         this.temporaryExecution = undefined;
@@ -719,7 +723,7 @@ export class CellExecution {
                     name: msg.content.name,
                     text: formatStreamText(concatMultilineString(`${existingOutputText}${newContent}`))
                 });
-                promise = task?.replaceOutputItems(output.items, existingOutputToAppendTo.id);
+                promise = task?.replaceOutputItems(output.items, existingOutputToAppendTo);
             } else if (clearOutput) {
                 // Replace the current outputs with a single new output.
                 const output = cellOutputToVSCCellOutput({
@@ -857,7 +861,7 @@ export class CellExecution {
                 // This message could have come from a background thread.
                 // In such circumstances, create a temporary task & use that to update the output (only cell execution tasks can update cell output).
                 const task = this.execution || this.createTemporaryTask();
-                const promise = task?.replaceOutputItems(newOutput.items, outputToBeUpdated.id);
+                const promise = task?.replaceOutputItems(newOutput.items, outputToBeUpdated);
                 this.endTemporaryTask();
                 // await on the promise at the end, we want to minimize UI flickers.
                 // The way we update output of other cells is to use an existing task or a temporary task.

src/client/datascience/jupyter/kernels/kernelExecution.ts

@@ -3,7 +3,7 @@
 
 'use strict';
 
-import { notebooks, NotebookCell, NotebookCellKind, NotebookController, NotebookDocument } from 'vscode';
+import { NotebookCell, NotebookCellKind, NotebookController, NotebookDocument, workspace } from 'vscode';
 import { ServerStatus } from '../../../../datascience-ui/interactive-common/mainState';
 import { IApplicationShell } from '../../../common/application/types';
 import { traceInfo, traceWarning } from '../../../common/logger';
@@ -133,7 +133,7 @@ export class KernelExecution implements IDisposable {
         );
 
         // If the document is closed (user or on CI), then just stop handling the UI updates & cancel cell execution queue.
-        notebooks.onDidCloseNotebookDocument(
+        workspace.onDidCloseNotebookDocument(
             async (e: NotebookDocument) => {
                 if (e === document) {
                     if (!newCellExecutionQueue.failed || !newCellExecutionQueue.isEmpty) {

src/client/datascience/notebook/contentProvider.ts

@@ -44,16 +44,15 @@ export class NotebookContentProvider implements VSCNotebookContentProvider {
         if (!this.compatibilitySupport.canOpenWithVSCodeNotebookEditor(uri)) {
             // If not supported, return a notebook with error displayed.
             // We cannot, not display a notebook.
+            const cellData = new NotebookCellData(
+                NotebookCellKind.Markup,
+                `# ${DataScience.usingPreviewNotebookWithOtherNotebookWarning()}`,
+                MARKDOWN_LANGUAGE
+            );
+            cellData.outputs = [];
+            cellData.metadata = {};
             return {
-                cells: [
-                    new NotebookCellData(
-                        NotebookCellKind.Markup,
-                        `# ${DataScience.usingPreviewNotebookWithOtherNotebookWarning()}`,
-                        MARKDOWN_LANGUAGE,
-                        [],
-                        {}
-                    )
-                ],
+                cells: [cellData],
                 metadata: {}
             };
         }

src/client/datascience/notebook/helpers/executionHelpers.ts

@@ -48,8 +48,9 @@ export async function updateCellCode(cell: NotebookCell, text: string) {
 export async function addNewCellAfter(cell: NotebookCell, text: string) {
     await chainWithPendingUpdates(cell.notebook, (edit) => {
         traceCellMessage(cell, 'Create new cell after current');
-        edit.replaceNotebookCells(cell.notebook.uri, new NotebookRange(cell.index + 1, cell.index + 1), [
-            new NotebookCellData(NotebookCellKind.Code, text, cell.document.languageId, [], cell.metadata || {})
-        ]);
+        const cellData = new NotebookCellData(NotebookCellKind.Code, text, cell.document.languageId);
+        cellData.outputs = [];
+        cellData.metadata = {};
+        edit.replaceNotebookCells(cell.notebook.uri, new NotebookRange(cell.index + 1, cell.index + 1), [cellData]);
     });
 }

src/client/datascience/notebook/helpers/helpers.ts

@@ -304,9 +304,10 @@ function createCodeCellFromNotebookCell(cell: NotebookCell): nbformat.ICodeCell
 }
 
 function createNotebookCellDataFromRawCell(cell: nbformat.IRawCell): NotebookCellData {
-    return new NotebookCellData(NotebookCellKind.Code, concatMultilineString(cell.source), 'raw', [], {
-        custom: getNotebookCellMetadata(cell)
-    });
+    const cellData = new NotebookCellData(NotebookCellKind.Code, concatMultilineString(cell.source), 'raw');
+    cellData.outputs = [];
+    cellData.metadata = { custom: getNotebookCellMetadata(cell) };
+    return cellData;
 }
 function createMarkdownCellFromNotebookCell(cell: NotebookCell): nbformat.IMarkdownCell {
     const cellMetadata = cell.metadata.custom as CellMetadata | undefined;
@@ -321,9 +322,14 @@ function createMarkdownCellFromNotebookCell(cell: NotebookCell): nbformat.IMarkd
     return markdownCell;
 }
 function createNotebookCellDataFromMarkdownCell(cell: nbformat.IMarkdownCell): NotebookCellData {
-    return new NotebookCellData(NotebookCellKind.Markup, concatMultilineString(cell.source), MARKDOWN_LANGUAGE, [], {
-        custom: getNotebookCellMetadata(cell)
-    });
+    const cellData = new NotebookCellData(
+        NotebookCellKind.Markup,
+        concatMultilineString(cell.source),
+        MARKDOWN_LANGUAGE
+    );
+    cellData.outputs = [];
+    cellData.metadata = { custom: getNotebookCellMetadata(cell) };
+    return cellData;
 }
 function createNotebookCellDataFromCodeCell(cell: nbformat.ICodeCell, cellLanguage: string): NotebookCellData {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -336,14 +342,13 @@ function createNotebookCellDataFromCodeCell(cell: nbformat.ICodeCell, cellLangua
     const executionSummary: NotebookCellExecutionSummary = hasExecutionCount
         ? { executionOrder: cell.execution_count as number }
         : {};
-    return new NotebookCellData(
-        NotebookCellKind.Code,
-        source,
-        cellLanguage,
-        outputs,
-        { custom: getNotebookCellMetadata(cell) },
-        executionSummary
-    );
+
+    const cellData = new NotebookCellData(NotebookCellKind.Code, source, cellLanguage);
+
+    cellData.outputs = outputs;
+    cellData.metadata = { custom: getNotebookCellMetadata(cell) };
+    cellData.executionSummary = executionSummary;
+    return cellData;
 }
 const orderOfMimeTypes = [
     'application/vnd.*',

src/client/datascience/notebook/noKernelsNotebookController.ts

@@ -79,7 +79,7 @@ export class NoKernelsNotebookController implements Disposable {
             traceback: errorMessage.split('\n')
         });
         task.appendOutput(errorOutput).then(noop, noop);
-        task.end();
+        task.end(undefined);
         this.errorHandler.handleError(new KernelSpecNotFoundError(getNotebookMetadata(notebook))).catch(noop);
     }
 }

src/client/datascience/notebook/vscodeNotebookController.ts

@@ -106,7 +106,7 @@ export class VSCodeNotebookController implements Disposable {
         this.controller.interruptHandler = this.handleInterrupt.bind(this);
         this.controller.description = getDescriptionOfKernelConnection(kernelConnection);
         this.controller.detail = getDetailOfKernelConnection(kernelConnection, this.pathUtils);
-        this.controller.hasExecutionOrder = true;
+        this.controller.supportsExecutionOrder = true;
         this.controller.supportedLanguages = this.languageService.getSupportedLanguages(kernelConnection);
         // Hook up to see when this NotebookController is selected by the UI
         this.controller.onDidChangeNotebookAssociation(this.onDidChangeNotebookAssociation, this, this.disposables);

src/client/datascience/utils.ts

@@ -65,7 +65,7 @@ export function translateCellToNative(
             executionSummary: {
                 executionOrder: cell.data.execution_count as number,
                 success: true,
-                endTime: 0
+                timing: { startTime: 0, endTime: 0 }
             },
             outputs: [],
             kind: NotebookCellKind.Code,

src/test/datascience/notebook/contentProviderMain.vscode.test.ts

@@ -69,27 +69,25 @@ suite('DataScience - VSCode Notebook ContentProvider', () => {
 
         assert.isOk(notebook);
 
-        assert.deepEqual(notebook.cells, [
-            new NotebookCellData(
-                NotebookCellKind.Code,
-                'print(1)',
-                PYTHON_LANGUAGE,
-                [],
-                {
-                    custom: {
-                        metadata: {}
-                    }
-                },
-                {
-                    executionOrder: 10
-                }
-            ),
-            new NotebookCellData(NotebookCellKind.Markup, '# HEAD', MARKDOWN_LANGUAGE, [], {
-                custom: {
-                    metadata: {}
-                }
-            })
-        ]);
+        const codeCellData = new NotebookCellData(NotebookCellKind.Code, 'print(1)', PYTHON_LANGUAGE);
+
+        codeCellData.outputs = [];
+        codeCellData.metadata = {
+            custom: {
+                metadata: {}
+            }
+        };
+        codeCellData.executionSummary = { executionOrder: 10 };
+
+        const markdownCellData = new NotebookCellData(NotebookCellKind.Markup, '# HEAD', MARKDOWN_LANGUAGE);
+        markdownCellData.outputs = [];
+        markdownCellData.metadata = {
+            custom: {
+                metadata: {}
+            }
+        };
+
+        assert.deepEqual(notebook.cells, [codeCellData, markdownCellData]);
     });
 
     test('Return notebook with csharp language', async () => {
@@ -121,27 +119,29 @@ suite('DataScience - VSCode Notebook ContentProvider', () => {
 
         assert.isOk(notebook);
 
-        assert.deepEqual(notebook.cells, [
-            new NotebookCellData(
-                NotebookCellKind.Code,
-                'Console.WriteLine("1")',
-                'csharp',
-                [],
-                {
-                    custom: {
-                        metadata: {}
-                    }
-                },
-                {
-                    executionOrder: 10
-                }
-            ),
-            new NotebookCellData(NotebookCellKind.Markup, '# HEAD', MARKDOWN_LANGUAGE, [], {
-                custom: {
-                    metadata: {}
-                }
-            })
-        ]);
+        const codeCellData = new NotebookCellData(NotebookCellKind.Code, 'Console.WriteLine("1")', 'csharp');
+
+        codeCellData.outputs = [];
+        codeCellData.metadata = {
+            custom: {
+                metadata: {}
+            }
+        };
+
+        codeCellData.executionSummary = {
+            executionOrder: 10
+        };
+
+        const markdownCellData = new NotebookCellData(NotebookCellKind.Markup, '# HEAD', MARKDOWN_LANGUAGE);
+
+        markdownCellData.outputs = [];
+        markdownCellData.metadata = {
+            custom: {
+                metadata: {}
+            }
+        };
+
+        assert.deepEqual(notebook.cells, [codeCellData, markdownCellData]);
     });
     test('Verify mime types and order', () => {
         // https://github.com/microsoft/vscode-python/issues/11880

src/test/datascience/notebook/helper.ts

@@ -87,11 +87,12 @@ export async function insertMarkdownCell(source: string, options?: { index?: num
         throw new Error('No active editor');
     }
     const startNumber = options?.index ?? activeEditor.document.cellCount;
-    await chainWithPendingUpdates(activeEditor.document, (edit) =>
-        edit.replaceNotebookCells(activeEditor.document.uri, new NotebookRange(startNumber, startNumber), [
-            new NotebookCellData(NotebookCellKind.Markup, source, MARKDOWN_LANGUAGE, [], {})
-        ])
-    );
+    await chainWithPendingUpdates(activeEditor.document, (edit) => {
+        const cellData = new NotebookCellData(NotebookCellKind.Markup, source, MARKDOWN_LANGUAGE);
+        cellData.outputs = [];
+        cellData.metadata = {};
+        edit.replaceNotebookCells(activeEditor.document.uri, new NotebookRange(startNumber, startNumber), [cellData]);
+    });
     return activeEditor.document.cellAt(startNumber)!;
 }
 export async function insertCodeCell(source: string, options?: { language?: string; index?: number }) {
@@ -102,9 +103,10 @@ export async function insertCodeCell(source: string, options?: { language?: stri
     }
     const startNumber = options?.index ?? activeEditor.document.cellCount;
     const edit = new WorkspaceEdit();
-    edit.replaceNotebookCells(activeEditor.document.uri, new NotebookRange(startNumber, startNumber), [
-        new NotebookCellData(NotebookCellKind.Code, source, options?.language || PYTHON_LANGUAGE, [], {})
-    ]);
+    const cellData = new NotebookCellData(NotebookCellKind.Code, source, options?.language || PYTHON_LANGUAGE);
+    cellData.outputs = [];
+    cellData.metadata = {};
+    edit.replaceNotebookCells(activeEditor.document.uri, new NotebookRange(startNumber, startNumber), [cellData]);
     await workspace.applyEdit(edit);
 
     return activeEditor.document.cellAt(startNumber)!;