Stub vscode 'Notebook' API

* Remove stub notebook.api.ts file
* introduce Disposable.NULL and use it wherever possible in plugin folder
* Avoid unnecessary code for stubbing (all event management in document)
* Remove file-system-ext-impl entry

packages/plugin-ext/src/main/browser/workspace-main.ts

@@ -263,10 +263,7 @@ export class WorkspaceMainImpl implements WorkspaceMain, Disposable {
     }
 
     $registerNotebookSerializer(notebookType: string, serializer: theia.NotebookSerializer, options?: theia.NotebookDocumentContentOptions | undefined): theia.Disposable {
-        return {
-            dispose(): void {
-            },
-        };
+        return Disposable.NULL;
     }
 
     $unregisterTextDocumentContentProvider(scheme: string): void {

packages/plugin-ext/src/plugin/documents.ts

@@ -39,20 +39,12 @@ export class DocumentsExtImpl implements DocumentsExt {
     private _onDidChangeDocument = new Emitter<theia.TextDocumentChangeEvent>();
     private _onDidSaveTextDocument = new Emitter<theia.TextDocument>();
     private _onWillSaveTextDocument = new Emitter<theia.TextDocumentWillSaveEvent>();
-    private _onDidAddNotebookDocument = new Emitter<theia.NotebookDocument>();
-    private _onDidCloseNotebookDocument = new Emitter<theia.NotebookDocument>();
-    private _onDidChangeNotebookDocument = new Emitter<theia.NotebookDocumentChangeEvent>();
-    private _onDidSaveNotebookDocument = new Emitter<theia.NotebookDocument>();
 
     readonly onDidAddDocument: Event<theia.TextDocument> = this._onDidAddDocument.event;
     readonly onDidRemoveDocument: Event<theia.TextDocument> = this._onDidRemoveDocument.event;
     readonly onDidChangeDocument: Event<theia.TextDocumentChangeEvent> = this._onDidChangeDocument.event;
     readonly onDidSaveTextDocument: Event<theia.TextDocument> = this._onDidSaveTextDocument.event;
     readonly onWillSaveTextDocument: Event<theia.TextDocumentWillSaveEvent> = this._onWillSaveTextDocument.event;
-    readonly onDidAddNotebookDocument: Event<theia.NotebookDocument> = this._onDidAddNotebookDocument.event;
-    readonly onDidCloseNotebookDocument: Event<theia.NotebookDocument> = this._onDidCloseNotebookDocument.event;
-    readonly onDidChangeNotebookDocument: Event<theia.NotebookDocumentChangeEvent> = this._onDidChangeNotebookDocument.event;
-    readonly onDidSaveNotebookDocument: Event<theia.NotebookDocument> = this._onDidSaveNotebookDocument.event;
 
     private proxy: DocumentsMain;
     private loadingDocuments = new Map<string, Promise<DocumentDataExt | undefined>>();

packages/plugin-ext/src/plugin/file-system-ext-impl.ts

@@ -294,13 +294,6 @@ export class FileSystemExtImpl implements FileSystemExt {
         };
     }
 
-    registerNotebookSerializer() {
-        return {
-            dispose: () => {
-            }
-        };
-    }
-
     private static _asIStat(stat: vscode.FileStat): files.Stat {
         const { type, ctime, mtime, size } = stat;
         return { type, ctime, mtime, size };

packages/plugin-ext/src/plugin/plugin-context.ts

@@ -155,6 +155,7 @@ import {
     InlayHint,
     InlayHintKind,
     InlayHintLabelPart,
+    NotebookCell,
     NotebookCellKind,
     NotebookCellStatusBarAlignment,
     NotebookEditorRevealType,
@@ -213,7 +214,6 @@ import { CustomEditorsExtImpl } from './custom-editors';
 import { WebviewViewsExtImpl } from './webview-views';
 import { PluginPackage } from '../common';
 import { Endpoint } from '@theia/core/lib/browser/endpoint';
-import { createNotebookCellExecution } from './stubs/notebooks-api';
 
 export function createAPIFactory(
     rpc: RPCProtocol,
@@ -398,33 +398,21 @@ export function createAPIFactory(
                 return [] as theia.NotebookEditor[];
             },
             onDidChangeVisibleNotebookEditors(listener, thisArg?, disposables?) {
-                return {
-                    dispose: () => {
-                    }
-                };
+                return Disposable.NULL;
             },
             get activeNotebookEditor(): theia.NotebookEditor | undefined {
                 return undefined;
             }, onDidChangeActiveNotebookEditor(listener, thisArg?, disposables?) {
-                return {
-                    dispose: () => {
-                    }
-                };
+                return Disposable.NULL;
             },
             onDidChangeNotebookEditorSelection(listener, thisArg?, disposables?) {
-                return {
-                    dispose: () => {
-                    }
-                };
+                return Disposable.NULL;
             },
             onDidChangeNotebookEditorVisibleRanges(listener, thisArg?, disposables?) {
-                return {
-                    dispose: () => {
-                    }
-                };
+                return Disposable.NULL;
             },
             showNotebookDocument(document: NotebookDocument, options?: theia.NotebookDocumentShowOptions) {
-                return Promise.resolve(undefined as unknown as theia.NotebookEditor);
+                return Promise.resolve({} as theia.NotebookEditor);
             },
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             showQuickPick(items: any, options?: theia.QuickPickOptions, token?: theia.CancellationToken): any {
@@ -586,16 +574,16 @@ export function createAPIFactory(
                 return documents.onDidRemoveDocument(listener, thisArg, disposables);
             },
             onDidOpenNotebookDocument(listener, thisArg?, disposables?) {
-                return documents.onDidAddNotebookDocument(listener, thisArg, disposables);
+                return Disposable.NULL;
             },
             onDidCloseNotebookDocument(listener, thisArg?, disposables?) {
-                return documents.onDidCloseNotebookDocument(listener, thisArg, disposables);
+                return Disposable.NULL;
             },
             onDidChangeNotebookDocument(listener, thisArg?, disposables?) {
-                return documents.onDidChangeNotebookDocument(listener, thisArg, disposables);
+                return Disposable.NULL;
             },
             onDidSaveNotebookDocument(listener, thisArg?, disposables?) {
-                return documents.onDidSaveNotebookDocument(listener, thisArg, disposables);
+                return Disposable.NULL;
             },
             onDidOpenTextDocument(listener, thisArg?, disposables?) {
                 return documents.onDidAddDocument(listener, thisArg, disposables);
@@ -642,7 +630,7 @@ export function createAPIFactory(
                 return data && data.document;
             },
             async openNotebookDocument(uriOrString: theia.Uri | string, content?: NotebookData): Promise<theia.NotebookDocument | undefined> {
-                return undefined;
+                return Promise.reject(new Error('Notebook API is stubbed'));
             },
             createFileSystemWatcher: (pattern, ignoreCreate, ignoreChange, ignoreDelete): theia.FileSystemWatcher =>
                 extHostFileSystemEvent.createFileSystemWatcher(fromGlobPattern(pattern), ignoreCreate, ignoreChange, ignoreDelete),
@@ -684,7 +672,7 @@ export function createAPIFactory(
                 return timelineExt.registerTimelineProvider(plugin, scheme, provider);
             },
             registerNotebookSerializer(notebookType: string, serializer: theia.NotebookSerializer, options?: theia.NotebookDocumentContentOptions): theia.Disposable {
-                return workspaceExt.registerNotebookSerializer(notebookType, serializer, options);
+                return Disposable.NULL;
             },
             get isTrusted(): boolean {
                 return workspaceExt.trusted;
@@ -1063,7 +1051,18 @@ export function createAPIFactory(
                     notebookType,
                     label,
                     handler,
-                    createNotebookCellExecution,
+                    createNotebookCellExecution: (cell: NotebookCell) => ({
+                        cell,
+                        token: CancellationToken.None,
+                        executionOrder: undefined,
+                        start: () => undefined,
+                        end: () => undefined,
+                        clearOutput: () => ({} as Thenable<void>),
+                        replaceOutput: () => ({} as Thenable<void>),
+                        appendOutput: () => ({} as Thenable<void>),
+                        replaceOutputItems: () => ({} as Thenable<void>),
+                        appendOutputItems: () => ({} as Thenable<void>)
+                    }),
                     executeHandler(
                         cells: theia.NotebookCell[],
                         notebook: theia.NotebookDocument,

packages/plugin-ext/src/plugin/types-impl.ts

@@ -148,6 +148,8 @@ export class Disposable {
     static create(func: () => void): Disposable {
         return new Disposable(func);
     }
+
+    static NULL: Disposable;
 }
 
 export interface AccessibilityInformation {
@@ -1209,10 +1211,10 @@ export class NotebookDocument implements theia.NotebookDocument {
     readonly cellCount: number;
 
     cellAt(index: number): theia.NotebookCell {
-        return undefined as unknown as theia.NotebookCell;
+        return {} as theia.NotebookCell;
     }
     save(): theia.Thenable<boolean> {
-        return undefined as unknown as Thenable<boolean>;
+        return Promise.resolve(false);
     }
 
     getCells(range?: theia.NotebookRange | undefined): theia.NotebookCell[] {

packages/plugin-ext/src/plugin/workspace.ts

@@ -280,14 +280,6 @@ export class WorkspaceExtImpl implements WorkspaceExt {
         };
     }
 
-    registerNotebookSerializer(notebookType: string, serializer: theia.NotebookSerializer, options?: theia.NotebookDocumentContentOptions): theia.Disposable {
-        return {
-            dispose(): void {
-
-            },
-        };
-    }
-
     async $provideTextDocumentContent(documentURI: string): Promise<string | undefined | null> {
         const uri = URI.parse(documentURI);
         const provider = this.documentContentProviders.get(uri.scheme);