Update to the latest Notebook API (#15416) (#15602)

Author: DonJayamanne

news/3 Code Health/15415.md

@@ -0,0 +1 @@
+Updated to used the latest Notebook (proposed) API.

news/3 Code Health/15573.md

@@ -0,0 +1 @@
+Fix failing smoke tests on CI.

package-lock.json

@@ -28,7 +28,7 @@
         "theme": "dark"
     },
     "engines": {
-        "vscode": "^1.51.0"
+        "vscode": "^1.54.0"
     },
     "keywords": [
         "python",
@@ -2082,7 +2082,7 @@
         "@types/tmp": "0.0.33",
         "@types/untildify": "^3.0.0",
         "@types/uuid": "^3.4.3",
-        "@types/vscode": "~1.51.0",
+        "@types/vscode": "~1.53.0",
         "@types/webpack-bundle-analyzer": "^2.13.0",
         "@types/winreg": "^1.2.30",
         "@types/xml2js": "^0.4.2",

package.json

@@ -14,6 +14,7 @@ import type {
     NotebookEditor,
     NotebookKernel,
     NotebookKernelProvider,
+    window,
 } from 'vscode-proposed';
 import { UseProposedApi } from '../constants';
 import { IDisposableRegistry } from '../types';
@@ -34,7 +35,7 @@ export class VSCodeNotebook implements IVSCodeNotebook {
     }
     public get onDidChangeActiveNotebookEditor(): Event<NotebookEditor | undefined> {
         return this.canUseNotebookApi
-            ? this.notebook.onDidChangeActiveNotebookEditor
+            ? this.window.onDidChangeActiveNotebookEditor
             : new EventEmitter<NotebookEditor | undefined>().event;
     }
     public get onDidOpenNotebookDocument(): Event<NotebookDocument> {
@@ -56,7 +57,7 @@ export class VSCodeNotebook implements IVSCodeNotebook {
         return this.canUseNotebookApi ? this.notebook.notebookDocuments : [];
     }
     public get notebookEditors() {
-        return this.canUseNotebookApi ? this.notebook.visibleNotebookEditors : [];
+        return this.canUseNotebookApi ? this.window.visibleNotebookEditors : [];
     }
     public get onDidChangeNotebookDocument(): Event<NotebookCellChangedEvent> {
         return this.canUseNotebookApi
@@ -67,17 +68,24 @@ export class VSCodeNotebook implements IVSCodeNotebook {
         if (!this.useProposedApi) {
             return;
         }
-        return this.notebook.activeNotebookEditor;
+        return this.window.activeNotebookEditor;
     }
     private get notebook() {
         if (!this._notebook) {
             this._notebook = require('vscode').notebook;
         }
         return this._notebook!;
     }
+    private get window() {
+        if (!this._window) {
+            this._window = require('vscode').window;
+        }
+        return this._window!;
+    }
     private readonly _onDidChangeNotebookDocument = new EventEmitter<NotebookCellChangedEvent>();
     private addedEventHandlers?: boolean;
     private _notebook?: typeof notebook;
+    private _window?: typeof window;
     private readonly canUseNotebookApi?: boolean;
     private readonly handledCellChanges = new WeakSet<VSCNotebookCellsChangeEvent>();
     constructor(

src/client/common/application/notebook.ts

@@ -20,6 +20,7 @@ import { isEqual } from 'lodash';
 import { NotebookConcatTextDocument, NotebookCell, NotebookDocument } from 'vscode-proposed';
 import { IVSCodeNotebook } from '../../common/application/types';
 import { IDisposable } from '../../common/types';
+import { PYTHON_LANGUAGE } from '../../common/constants';
 
 export const NotebookConcatPrefix = '_NotebookConcat_';
 
@@ -44,7 +45,16 @@ export class NotebookConcatDocument implements TextDocument, IDisposable {
     }
 
     public get languageId(): string {
-        return this.notebook.languages[0];
+        // eslint-disable-next-line global-require
+        const { NotebookCellKind } = require('vscode');
+        // Return Python if we have python cells.
+        if (this.notebook.cells.some((item) => item.language.toLowerCase() === PYTHON_LANGUAGE.toLowerCase())) {
+            return PYTHON_LANGUAGE;
+        }
+        // Return the language of the first available cell, else assume its a Python notebook.
+        // The latter is not possible, except for the case where we have all markdown cells,
+        // in which case the language server will never kick in.
+        return this.notebook.cells.find((item) => item.cellKind === NotebookCellKind.Code)?.language || PYTHON_LANGUAGE;
     }
 
     public get version(): number {

src/client/jupyter/languageserver/notebookConcatDocument.ts

@@ -97,12 +97,12 @@ suite('Insiders Test: Language Server', () => {
                 expect(locations![0].uri.fsPath).to.contain(path.basename(notebookDefinitions));
 
                 // Insert a new cell
-                const activeEditor = vscode.notebook.activeNotebookEditor;
+                const activeEditor = vscode.window.activeNotebookEditor;
                 expect(activeEditor).not.to.be.equal(undefined, 'Active editor not found in notebook');
                 await activeEditor!.edit((edit) => {
                     edit.replaceCells(0, 0, [
                         {
-                            cellKind: vscode.CellKind.Code,
+                            cellKind: vscode.NotebookCellKind.Code,
                             language: PYTHON_LANGUAGE,
                             source: 'x = 4',
                             metadata: {
@@ -125,7 +125,7 @@ suite('Insiders Test: Language Server', () => {
                     edit.replaceCells(0, 1, []);
                     edit.replaceCells(1, 0, [
                         {
-                            cellKind: vscode.CellKind.Code,
+                            cellKind: vscode.NotebookCellKind.Code,
                             language: PYTHON_LANGUAGE,
                             source: 'x = 4',
                             metadata: {

src/test/insiders/languageServer.insiders.test.ts

@@ -38,6 +38,8 @@ export class MockOutputChannel implements vscode.OutputChannel {
 }
 
 export class MockStatusBarItem implements vscode.StatusBarItem {
+    backgroundColor: vscode.ThemeColor | undefined;
+    accessibilityInformation?: vscode.AccessibilityInformation | undefined;
     public alignment!: vscode.StatusBarAlignment;
     public priority!: number;
     public text!: string;

src/test/mockClasses.ts

@@ -14,7 +14,7 @@ import { vscUri } from './uri';
 import { generateUuid } from './uuid';
 
 export namespace vscMockExtHostedTypes {
-    export enum CellKind {
+    export enum NotebookCellKind {
         Markdown = 1,
         Code = 2,
     }
@@ -544,6 +544,32 @@ export namespace vscMockExtHostedTypes {
     }
 
     export class WorkspaceEdit implements vscode.WorkspaceEdit {
+        appendNotebookCellOutput(
+            _uri: vscode.Uri,
+            _index: number,
+            _outputs: vscode.NotebookCellOutput[],
+            _metadata?: vscode.WorkspaceEditEntryMetadata,
+        ): void {
+            // Noop
+        }
+        replaceNotebookCellOutputItems(
+            _uri: vscode.Uri,
+            _index: number,
+            _outputId: string,
+            _items: vscode.NotebookCellOutputItem[],
+            _metadata?: vscode.WorkspaceEditEntryMetadata,
+        ): void {
+            // Noop
+        }
+        appendNotebookCellOutputItems(
+            _uri: vscode.Uri,
+            _index: number,
+            _outputId: string,
+            _items: vscode.NotebookCellOutputItem[],
+            _metadata?: vscode.WorkspaceEditEntryMetadata,
+        ): void {
+            // Noop
+        }
         replaceNotebookMetadata(_uri: vscode.Uri, _value: vscode.NotebookDocumentMetadata): void {
             //
         }
@@ -560,7 +586,7 @@ export namespace vscMockExtHostedTypes {
         replaceNotebookCellOutput(
             _uri: vscode.Uri,
             _index: number,
-            _outputs: vscode.CellOutput[],
+            _outputs: vscode.NotebookCellOutput[],
             _metadata?: vscode.WorkspaceEditEntryMetadata,
         ): void {
             // Noop.

src/test/mocks/vsc/extHostedTypes.ts

@@ -49,7 +49,7 @@ export async function enableJedi(enable: boolean | undefined): Promise<void> {
 export async function openNotebook(file: string): Promise<vscode.NotebookEditor> {
     await verifyExtensionIsAvailable(JUPYTER_EXTENSION_ID);
     await vscode.commands.executeCommand('vscode.openWith', vscode.Uri.file(file), 'jupyter-notebook');
-    const notebook = vscode.notebook.activeNotebookEditor;
+    const notebook = vscode.window.activeNotebookEditor;
     assert(notebook, 'Notebook did not open');
     return notebook;
 }

src/test/smoke/common.ts

@@ -10,7 +10,7 @@ import * as vscode from 'vscode';
 import { JUPYTER_EXTENSION_ID } from '../../client/common/constants';
 import { openFile, setAutoSaveDelayInWorkspaceRoot, waitForCondition } from '../common';
 import { EXTENSION_ROOT_DIR_FOR_TESTS, IS_SMOKE_TEST } from '../constants';
-import { noop, sleep } from '../core';
+import { sleep } from '../core';
 import { closeActiveWindows, initialize, initializeTest } from '../initialize';
 import { verifyExtensionIsAvailable } from './common';
 
@@ -75,8 +75,8 @@ suite('Smoke Test: Datascience', () => {
         if (await fs.pathExists(outputFile)) {
             await fs.unlink(outputFile);
         }
-        // Ignore exceptions (as native editor closes the document as soon as its opened);
-        await openFile(file).catch(noop);
+
+        await vscode.commands.executeCommand('jupyter.opennotebook', vscode.Uri.file(file));
 
         // Wait for 15 seconds for notebook to launch.
         // Unfortunately there's no way to know for sure it has completely loaded.

src/test/smoke/datascience.smoke.test.ts

@@ -106,7 +106,7 @@ mockedVSCode.QuickInputButtons = vscodeMocks.vscMockExtHostedTypes.QuickInputBut
 mockedVSCode.FileType = vscodeMocks.vscMock.FileType;
 mockedVSCode.UIKind = vscodeMocks.vscMock.UIKind;
 mockedVSCode.FileSystemError = vscodeMocks.vscMockExtHostedTypes.FileSystemError;
-(mockedVSCode as any).CellKind = vscodeMocks.vscMockExtHostedTypes.CellKind;
+(mockedVSCode as any).NotebookCellKind = vscodeMocks.vscMockExtHostedTypes.NotebookCellKind;
 (mockedVSCode as any).CellOutputKind = vscodeMocks.vscMockExtHostedTypes.CellOutputKind;
 (mockedVSCode as any).NotebookCellRunState = vscodeMocks.vscMockExtHostedTypes.NotebookCellRunState;