@theia/notebook 1.43.1 → 1.45.0

package/src/browser/view-model/notebook-model.ts

@@ -17,18 +17,16 @@
 import { Disposable, Emitter, URI } from '@theia/core';
 import { Saveable, SaveOptions } from '@theia/core/lib/browser';
 import {
-    CellData,
-    CellEditOperation, CellEditType, CellUri, NotebookCellInternalMetadata,
+    CellData, CellEditType, CellUri, NotebookCellInternalMetadata,
     NotebookCellsChangeType, NotebookCellTextModelSplice, NotebookData,
-    NotebookDocumentMetadata, NotebookModelWillAddRemoveEvent,
-    NotebookTextModelChangedEvent, NullablePartialNotebookCellInternalMetadata
+    NotebookDocumentMetadata,
 } from '../../common';
+import { NotebookContentChangedEvent, NotebookModelWillAddRemoveEvent, CellEditOperation, NullablePartialNotebookCellInternalMetadata } from '../notebook-types';
 import { NotebookSerializer } from '../service/notebook-service';
 import { FileService } from '@theia/filesystem/lib/browser/file-service';
 import { NotebookCellModel, NotebookCellModelFactory } from './notebook-cell-model';
 import { MonacoTextModelService } from '@theia/monaco/lib/browser/monaco-text-model-service';
 import { inject, injectable, interfaces, postConstruct } from '@theia/core/shared/inversify';
-import { NotebookKernel } from '../service/notebook-kernel-service';
 import { UndoRedoService } from '@theia/editor/lib/browser/undo-redo-service';
 
 export const NotebookModelFactory = Symbol('NotebookModelFactory');
@@ -62,7 +60,7 @@ export class NotebookModel implements Saveable, Disposable {
     protected readonly onDidAddOrRemoveCellEmitter = new Emitter<NotebookModelWillAddRemoveEvent>();
     readonly onDidAddOrRemoveCell = this.onDidAddOrRemoveCellEmitter.event;
 
-    protected readonly onDidChangeContentEmitter = new Emitter<NotebookTextModelChangedEvent>();
+    protected readonly onDidChangeContentEmitter = new Emitter<NotebookContentChangedEvent[]>();
     readonly onDidChangeContent = this.onDidChangeContentEmitter.event;
 
     @inject(FileService)
@@ -81,11 +79,19 @@ export class NotebookModel implements Saveable, Disposable {
     protected cellModelFactory: NotebookCellModelFactory;
     readonly autoSave: 'off' | 'afterDelay' | 'onFocusChange' | 'onWindowChange';
 
-    nextHandle: number = 0;
+    protected nextHandle: number = 0;
 
-    kernel?: NotebookKernel;
+    protected _dirty: boolean = false;
+
+    set dirty(dirty: boolean) {
+        this._dirty = dirty;
+        this.onDirtyChangedEmitter.fire();
+    }
+
+    get dirty(): boolean {
+        return this._dirty;
+    }
 
-    dirty: boolean;
     selectedCell?: NotebookCellModel;
     protected dirtyCells: NotebookCellModel[] = [];
 
@@ -121,18 +127,6 @@ export class NotebookModel implements Saveable, Disposable {
 
         this.metadata = this.metadata;
 
-        this.modelService.onDidCreate(editorModel => {
-            const modelUri = new URI(editorModel.uri);
-            if (modelUri.scheme === CellUri.scheme) {
-                const cellUri = CellUri.parse(modelUri);
-                if (cellUri && cellUri.notebook.isEqual(this.uri)) {
-                    const cell = this.cells.find(c => c.handle === cellUri.handle);
-                    if (cell) {
-                        cell.textModel = editorModel;
-                    }
-                }
-            }
-        });
         this.nextHandle = this.cells.length;
     }
 
@@ -147,7 +141,6 @@ export class NotebookModel implements Saveable, Disposable {
     async save(options: SaveOptions): Promise<void> {
         this.dirtyCells = [];
         this.dirty = false;
-        this.onDirtyChangedEmitter.fire();
 
         const serializedNotebook = await this.props.serializer.fromNotebook({
             cells: this.cells.map(cell => cell.getData()),
@@ -170,9 +163,34 @@ export class NotebookModel implements Saveable, Disposable {
         };
     }
 
+    async applySnapshot(snapshot: Saveable.Snapshot): Promise<void> {
+        const rawData = 'read' in snapshot ? snapshot.read() : snapshot.value;
+        if (!rawData) {
+            throw new Error('could not read notebook snapshot');
+        }
+        const data = JSON.parse(rawData);
+        const cells = data.cells.map((cell: CellData, index: number) => {
+            const handle = this.nextHandle++;
+            return this.cellModelFactory({
+                uri: CellUri.generate(this.uri, handle),
+                handle: handle,
+                source: cell.source,
+                language: cell.language,
+                cellKind: cell.cellKind,
+                outputs: cell.outputs,
+                metadata: cell.metadata,
+                internalMetadata: cell.internalMetadata,
+                collapseState: cell.collapseState
+            });
+        });
+        this.addCellOutputListeners(cells);
+
+        this.metadata = data.metadata;
+
+    }
+
     async revert(options?: Saveable.RevertOptions): Promise<void> {
         this.dirty = false;
-        this.onDirtyChangedEmitter.fire();
     }
 
     isDirty(): boolean {
@@ -186,8 +204,8 @@ export class NotebookModel implements Saveable, Disposable {
             this.dirtyCells.splice(this.dirtyCells.indexOf(cell), 1);
         }
 
-        const oldDirtyState = this.dirty;
-        this.dirty = this.dirtyCells.length > 0;
+        const oldDirtyState = this._dirty;
+        this._dirty = this.dirtyCells.length > 0;
         if (this.dirty !== oldDirtyState) {
             this.onDirtyChangedEmitter.fire();
         }
@@ -211,7 +229,6 @@ export class NotebookModel implements Saveable, Disposable {
         for (const cell of cells) {
             cell.onDidChangeOutputs(() => {
                 this.dirty = true;
-                this.onDirtyChangedEmitter.fire();
             });
         }
     }
@@ -294,7 +311,7 @@ export class NotebookModel implements Saveable, Disposable {
         });
         this.addCellOutputListeners(cells);
 
-        const changes: NotebookCellTextModelSplice<NotebookCellModel>[] = [[start, deleteCount, cells]];
+        const changes: NotebookCellTextModelSplice<NotebookCellModel>[] = [{ start, deleteCount, newItems: cells }];
 
         const deletedCells = this.cells.splice(start, deleteCount, ...cells);
 
@@ -308,8 +325,8 @@ export class NotebookModel implements Saveable, Disposable {
                 async () => this.replaceCells(start, deleteCount, newCells, false));
         }
 
-        this.onDidAddOrRemoveCellEmitter.fire({ rawEvent: { kind: NotebookCellsChangeType.ModelChange, changes } });
-        this.onDidChangeContentEmitter.fire({ rawEvents: [{ kind: NotebookCellsChangeType.ModelChange, changes }] });
+        this.onDidAddOrRemoveCellEmitter.fire({ rawEvent: { kind: NotebookCellsChangeType.ModelChange, changes }, newCellIds: cells.map(cell => cell.handle) });
+        this.onDidChangeContentEmitter.fire([{ kind: NotebookCellsChangeType.ModelChange, changes }]);
     }
 
     private changeCellInternalMetadataPartial(cell: NotebookCellModel, internalMetadata: NullablePartialNotebookCellInternalMetadata): void {
@@ -323,11 +340,9 @@ export class NotebookModel implements Saveable, Disposable {
         }
 
         cell.internalMetadata = newInternalMetadata;
-        this.onDidChangeContentEmitter.fire({
-            rawEvents: [
-                { kind: NotebookCellsChangeType.ChangeCellInternalMetadata, index: this.cells.indexOf(cell), internalMetadata: newInternalMetadata }
-            ]
-        });
+        this.onDidChangeContentEmitter.fire([
+            { kind: NotebookCellsChangeType.ChangeCellInternalMetadata, index: this.cells.indexOf(cell), internalMetadata: newInternalMetadata }
+        ]);
     }
 
     private updateNotebookMetadata(metadata: NotebookDocumentMetadata, computeUndoRedo: boolean): void {
@@ -340,10 +355,7 @@ export class NotebookModel implements Saveable, Disposable {
         }
 
         this.metadata = metadata;
-        this.onDidChangeContentEmitter.fire({
-            rawEvents: [{ kind: NotebookCellsChangeType.ChangeDocumentMetadata, metadata: this.metadata }],
-            synchronous: true,
-        });
+        this.onDidChangeContentEmitter.fire([{ kind: NotebookCellsChangeType.ChangeDocumentMetadata, metadata: this.metadata }]);
     }
 
     private changeCellLanguage(cell: NotebookCellModel, languageId: string, computeUndoRedo: boolean): void {
@@ -353,10 +365,7 @@ export class NotebookModel implements Saveable, Disposable {
 
         cell.language = languageId;
 
-        this.onDidChangeContentEmitter.fire({
-            rawEvents: [{ kind: NotebookCellsChangeType.ChangeCellLanguage, index: this.cells.indexOf(cell), language: languageId }],
-            synchronous: true,
-        });
+        this.onDidChangeContentEmitter.fire([{ kind: NotebookCellsChangeType.ChangeCellLanguage, index: this.cells.indexOf(cell), language: languageId }]);
     }
 
     private moveCellToIndex(fromIndex: number, length: number, toIndex: number, computeUndoRedo: boolean): boolean {
@@ -369,9 +378,7 @@ export class NotebookModel implements Saveable, Disposable {
 
         const cells = this.cells.splice(fromIndex, length);
         this.cells.splice(toIndex, 0, ...cells);
-        this.onDidChangeContentEmitter.fire({
-            rawEvents: [{ kind: NotebookCellsChangeType.Move, index: fromIndex, length, newIdx: toIndex, cells }],
-        });
+        this.onDidChangeContentEmitter.fire([{ kind: NotebookCellsChangeType.Move, index: fromIndex, length, newIdx: toIndex, cells }]);
 
         return true;
     }

package/src/common/notebook-common.ts

@@ -14,11 +14,18 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { CancellationToken, Command, Event, URI } from '@theia/core';
+import { Command, URI, isObject } from '@theia/core';
 import { MarkdownString } from '@theia/core/lib/common/markdown-rendering/markdown-string';
 import { BinaryBuffer } from '@theia/core/lib/common/buffer';
 import { UriComponents } from '@theia/core/lib/common/uri';
-import { CellRange } from './notebook-range';
+
+export interface NotebookCommand {
+    id: string;
+    title?: string;
+    tooltip?: string;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    arguments?: any[];
+}
 
 export enum CellKind {
     Markup = 1,
@@ -88,23 +95,6 @@ export interface NotebookCellCollapseState {
     outputCollapsed?: boolean;
 }
 
-export interface NotebookCell {
-    readonly uri: URI;
-    handle: number;
-    language: string;
-    cellKind: CellKind;
-    outputs: CellOutput[];
-    metadata: NotebookCellMetadata;
-    internalMetadata: NotebookCellInternalMetadata;
-    text: string;
-    onDidChangeOutputs?: Event<NotebookCellOutputsSplice>;
-    onDidChangeOutputItems?: Event<CellOutput>;
-    onDidChangeLanguage: Event<string>;
-    onDidChangeMetadata: Event<void>;
-    onDidChangeInternalMetadata: Event<CellInternalMetadataChangedEvent>;
-
-}
-
 export interface CellData {
     source: string;
     language: string;
@@ -115,13 +105,6 @@ export interface CellData {
     collapseState?: NotebookCellCollapseState;
 }
 
-export interface CellReplaceEdit {
-    editType: CellEditType.Replace;
-    index: number;
-    count: number;
-    cells: CellData[];
-}
-
 export interface NotebookDocumentMetadataEdit {
     editType: CellEditType.DocumentMetadata;
     metadata: NotebookDocumentMetadata;
@@ -140,32 +123,11 @@ export interface NotebookContributionData {
     exclusive: boolean;
 }
 
-export interface NotebookCellStatusBarItemList {
-    items: NotebookCellStatusBarItem[];
-    dispose?(): void;
-}
-
-export interface NotebookCellStatusBarItemProvider {
-    viewType: string;
-    onDidChangeStatusBarItems?: Event<void>;
-    provideCellStatusBarItems(uri: UriComponents, index: number, token: CancellationToken): Promise<NotebookCellStatusBarItemList | undefined>;
-}
-
-export interface NotebookCellOutputsSplice {
-    start: number /* start */;
-    deleteCount: number /* delete count */;
-    newOutputs: CellOutput[];
-};
-
-export interface CellInternalMetadataChangedEvent {
-    readonly lastRunSuccessChanged?: boolean;
-}
-
-export type NotebookCellTextModelSplice<T> = [
+export interface NotebookCellTextModelSplice<T> {
     start: number,
     deleteCount: number,
     newItems: T[]
-];
+};
 
 export enum NotebookCellsChangeType {
     ModelChange = 1,
@@ -182,69 +144,12 @@ export enum NotebookCellsChangeType {
     Unknown = 100
 }
 
-export enum SelectionStateType {
-    Handle = 0,
-    Index = 1
-}
-export interface SelectionHandleState {
-    kind: SelectionStateType.Handle;
-    primary: number | null;
-    selections: number[];
-}
-
-export interface SelectionIndexState {
-    kind: SelectionStateType.Index;
-    focus: CellRange;
-    selections: CellRange[];
-}
-
-export type SelectionState = SelectionHandleState | SelectionIndexState;
-
-export interface NotebookTextModelChangedEvent {
-    readonly rawEvents: NotebookRawContentEvent[];
-    // readonly versionId: number;
-    readonly synchronous?: boolean;
-    readonly endSelectionState?: SelectionState;
-};
-
-export interface NotebookCellsInitializeEvent<T> {
-    readonly kind: NotebookCellsChangeType.Initialize;
-    readonly changes: NotebookCellTextModelSplice<T>[];
-}
-
 export interface NotebookCellsChangeLanguageEvent {
     readonly kind: NotebookCellsChangeType.ChangeCellLanguage;
     readonly index: number;
     readonly language: string;
 }
 
-export interface NotebookCellsModelChangedEvent<T> {
-    readonly kind: NotebookCellsChangeType.ModelChange;
-    readonly changes: NotebookCellTextModelSplice<T>[];
-}
-
-export interface NotebookCellsModelMoveEvent<T> {
-    readonly kind: NotebookCellsChangeType.Move;
-    readonly index: number;
-    readonly length: number;
-    readonly newIdx: number;
-    readonly cells: T[];
-}
-
-export interface NotebookOutputChangedEvent {
-    readonly kind: NotebookCellsChangeType.Output;
-    readonly index: number;
-    readonly outputs: CellOutput[];
-    readonly append: boolean;
-}
-
-export interface NotebookOutputItemChangedEvent {
-    readonly kind: NotebookCellsChangeType.OutputItem;
-    readonly index: number;
-    readonly outputId: string;
-    readonly outputItems: CellOutputItem[];
-    readonly append: boolean;
-}
 export interface NotebookCellsChangeMetadataEvent {
     readonly kind: NotebookCellsChangeType.ChangeCellMetadata;
     readonly index: number;
@@ -257,35 +162,23 @@ export interface NotebookCellsChangeInternalMetadataEvent {
     readonly internalMetadata: NotebookCellInternalMetadata;
 }
 
-export interface NotebookDocumentChangeMetadataEvent {
-    readonly kind: NotebookCellsChangeType.ChangeDocumentMetadata;
-    readonly metadata: NotebookDocumentMetadata;
-}
-
-export interface NotebookDocumentUnknownChangeEvent {
-    readonly kind: NotebookCellsChangeType.Unknown;
-}
-
 export interface NotebookCellContentChangeEvent {
     readonly kind: NotebookCellsChangeType.ChangeCellContent;
     readonly index: number;
 }
 
-export type NotebookRawContentEvent = (NotebookCellsInitializeEvent<NotebookCell> | NotebookDocumentChangeMetadataEvent | NotebookCellContentChangeEvent |
-    NotebookCellsModelChangedEvent<NotebookCell> | NotebookCellsModelMoveEvent<NotebookCell> | NotebookOutputChangedEvent | NotebookOutputItemChangedEvent |
-    NotebookCellsChangeLanguageEvent | NotebookCellsChangeMetadataEvent |
-    NotebookCellsChangeInternalMetadataEvent | NotebookDocumentUnknownChangeEvent); // & { transient: boolean };
-
-export interface NotebookModelChangedEvent {
-    readonly rawEvents: NotebookRawContentEvent[];
-    readonly versionId: number;
-    // readonly synchronous: boolean | undefined;
-    // readonly endSelectionState: ISelectionState | undefined;
-};
+export interface NotebookModelResource {
+    notebookModelUri: URI;
+}
 
-export interface NotebookModelWillAddRemoveEvent {
-    readonly rawEvent: NotebookCellsModelChangedEvent<CellData>;
-};
+export namespace NotebookModelResource {
+    export function is(item: unknown): item is NotebookModelResource {
+        return isObject<NotebookModelResource>(item) && item.notebookModelUri instanceof URI;
+    }
+    export function create(uri: URI): NotebookModelResource {
+        return { notebookModelUri: uri };
+    }
+}
 
 export enum NotebookCellExecutionState {
     Unconfirmed = 1,
@@ -321,51 +214,12 @@ export interface CellExecutionStateUpdateDto {
     isPaused?: boolean;
 }
 
-export interface CellOutputEdit {
-    editType: CellEditType.Output;
-    index: number;
-    outputs: CellOutput[];
-    append?: boolean;
-}
-
-export interface CellOutputEditByHandle {
-    editType: CellEditType.Output;
-    handle: number;
-    outputs: CellOutput[];
-    append?: boolean;
-}
-
-export interface CellOutputItemEdit {
-    editType: CellEditType.OutputItems;
-    items: CellOutputItem[];
-    outputId: string;
-    append?: boolean;
-}
-
 export interface CellMetadataEdit {
     editType: CellEditType.Metadata;
     index: number;
     metadata: NotebookCellMetadata;
 }
 
-export interface CellLanguageEdit {
-    editType: CellEditType.CellLanguage;
-    index: number;
-    language: string;
-}
-
-export interface DocumentMetadataEdit {
-    editType: CellEditType.DocumentMetadata;
-    metadata: NotebookDocumentMetadata;
-}
-
-export interface CellMoveEdit {
-    editType: CellEditType.Move;
-    index: number;
-    length: number;
-    newIdx: number;
-}
-
 export const enum CellEditType {
     Replace = 1,
     Output = 2,
@@ -378,19 +232,6 @@ export const enum CellEditType {
     PartialInternalMetadata = 9,
 }
 
-export type ImmediateCellEditOperation = CellOutputEditByHandle | CellOutputItemEdit | CellPartialInternalMetadataEditByHandle; // add more later on
-export type CellEditOperation = ImmediateCellEditOperation | CellReplaceEdit | CellOutputEdit |
-    CellMetadataEdit | CellLanguageEdit | DocumentMetadataEdit | CellMoveEdit; // add more later on
-
-export type NullablePartialNotebookCellInternalMetadata = {
-    [Key in keyof Partial<NotebookCellInternalMetadata>]: NotebookCellInternalMetadata[Key] | null
-};
-export interface CellPartialInternalMetadataEditByHandle {
-    editType: CellEditType.PartialInternalMetadata;
-    handle: number;
-    internalMetadata: NullablePartialNotebookCellInternalMetadata;
-}
-
 export interface NotebookKernelSourceAction {
     readonly label: string;
     readonly description?: string;