@jupyterlab/notebook 4.6.0-alpha.5 → 4.6.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlab/notebook",
-  "version": "4.6.0-alpha.5",
+  "version": "4.6.0-beta.1",
   "description": "JupyterLab - Notebook",
   "homepage": "https://github.com/jupyterlab/jupyterlab",
   "bugs": {
@@ -40,26 +40,27 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter/ydoc": "^3.1.0",
-    "@jupyterlab/apputils": "^4.7.0-alpha.5",
-    "@jupyterlab/cells": "^4.6.0-alpha.5",
-    "@jupyterlab/codeeditor": "^4.6.0-alpha.5",
-    "@jupyterlab/codemirror": "^4.6.0-alpha.5",
-    "@jupyterlab/coreutils": "^6.6.0-alpha.5",
-    "@jupyterlab/docregistry": "^4.6.0-alpha.5",
-    "@jupyterlab/documentsearch": "^4.6.0-alpha.5",
-    "@jupyterlab/lsp": "^4.6.0-alpha.5",
-    "@jupyterlab/markedparser-extension": "^4.6.0-alpha.5",
-    "@jupyterlab/nbformat": "^4.6.0-alpha.5",
-    "@jupyterlab/observables": "^5.6.0-alpha.5",
-    "@jupyterlab/rendermime": "^4.6.0-alpha.5",
-    "@jupyterlab/services": "^7.6.0-alpha.5",
-    "@jupyterlab/settingregistry": "^4.6.0-alpha.5",
-    "@jupyterlab/statusbar": "^4.6.0-alpha.5",
-    "@jupyterlab/toc": "^6.6.0-alpha.5",
-    "@jupyterlab/translation": "^4.6.0-alpha.5",
-    "@jupyterlab/ui-components": "^4.6.0-alpha.5",
+    "@jupyter/ydoc": "^4.0.0-a3",
+    "@jupyterlab/apputils": "^4.7.0-beta.1",
+    "@jupyterlab/cells": "^4.6.0-beta.1",
+    "@jupyterlab/codeeditor": "^4.6.0-beta.1",
+    "@jupyterlab/codemirror": "^4.6.0-beta.1",
+    "@jupyterlab/coreutils": "^6.6.0-beta.1",
+    "@jupyterlab/docregistry": "^4.6.0-beta.1",
+    "@jupyterlab/documentsearch": "^4.6.0-beta.1",
+    "@jupyterlab/lsp": "^4.6.0-beta.1",
+    "@jupyterlab/markedparser-extension": "^4.6.0-beta.1",
+    "@jupyterlab/nbformat": "^4.6.0-beta.1",
+    "@jupyterlab/observables": "^5.6.0-beta.1",
+    "@jupyterlab/rendermime": "^4.6.0-beta.1",
+    "@jupyterlab/services": "^7.6.0-beta.1",
+    "@jupyterlab/settingregistry": "^4.6.0-beta.1",
+    "@jupyterlab/statusbar": "^4.6.0-beta.1",
+    "@jupyterlab/toc": "^6.6.0-beta.1",
+    "@jupyterlab/translation": "^4.6.0-beta.1",
+    "@jupyterlab/ui-components": "^4.6.0-beta.1",
     "@lumino/algorithm": "^2.0.4",
+    "@lumino/commands": "^2.3.3",
     "@lumino/coreutils": "^2.2.2",
     "@lumino/disposable": "^2.1.5",
     "@lumino/domutils": "^2.0.4",
@@ -69,11 +70,11 @@
     "@lumino/properties": "^2.0.4",
     "@lumino/signaling": "^2.1.5",
     "@lumino/virtualdom": "^2.0.4",
-    "@lumino/widgets": "^2.7.5",
+    "@lumino/widgets": "^2.8.0",
     "react": "^18.2.0"
   },
   "devDependencies": {
-    "@jupyterlab/testing": "^4.6.0-alpha.5",
+    "@jupyterlab/testing": "^4.6.0-beta.1",
     "@types/jest": "^29.2.0",
     "jest": "^29.2.0",
     "rimraf": "~5.0.5",

package/src/actions.tsx

@@ -1,5 +1,6 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
+/* eslint-disable @typescript-eslint/no-explicit-any */
 
 import type {
   ISessionContext,
@@ -11,8 +12,9 @@ import {
   showDialog,
   SystemClipboard
 } from '@jupyterlab/apputils';
-import type { Cell, CodeCell, ICodeCellModel } from '@jupyterlab/cells';
+import type { Cell, ICodeCellModel } from '@jupyterlab/cells';
 import {
+  CodeCell,
   CodeCellModel,
   isMarkdownCellModel,
   isRawCellModel,
@@ -21,8 +23,9 @@ import {
 import { Notification } from '@jupyterlab/apputils';
 import { signalToPromise } from '@jupyterlab/coreutils';
 import * as nbformat from '@jupyterlab/nbformat';
-import type { KernelMessage } from '@jupyterlab/services';
+import type { Kernel, KernelMessage } from '@jupyterlab/services';
 import type { ISharedAttachmentsCell } from '@jupyter/ydoc';
+import type { YNotebook } from '@jupyter/ydoc';
 import type { ITranslator } from '@jupyterlab/translation';
 import { nullTranslator } from '@jupyterlab/translation';
 import { every, findIndex } from '@lumino/algorithm';
@@ -442,6 +445,22 @@ export namespace NotebookActions {
           : undefined
     };
 
+    // Detach kernel futures from cells about to be deleted so OutputArea.dispose()
+    // does not terminate them - they stay live in kernel._futures for reconnection
+    // after undo. Handlers are cleared by detachFuture() so the future no
+    // longer holds references to the (soon-to-be-disposed) output area.
+    const storedExecutions: Private.IStoredCellExecution[] = [];
+    [active, ...toDelete].forEach(index => {
+      const cell = notebook.widgets[index];
+      if (!(cell instanceof CodeCell)) {
+        return;
+      }
+      const stored = Private.captureExecution(cell);
+      if (stored) {
+        storedExecutions.push(stored);
+      }
+    });
+
     // Make the changes while preserving history.
     model.sharedModel.transact(() => {
       model.sharedModel.deleteCell(active);
@@ -452,6 +471,14 @@ export namespace NotebookActions {
           model.sharedModel.deleteCell(index);
         });
     });
+
+    // Store execution context in the undo stack item so undo() can restore state.
+    if (storedExecutions.length > 0) {
+      const undoManager = (model.sharedModel as YNotebook).undoManager;
+      const lastItem = undoManager.undoStack[undoManager.undoStack.length - 1];
+      lastItem?.meta.set(Private.CELL_EXECUTION_META_KEY, storedExecutions);
+    }
+
     // If the original cell is a markdown cell, make sure
     // the new cell is unrendered.
     if (primary instanceof MarkdownCell) {
@@ -1581,7 +1608,60 @@ export namespace NotebookActions {
 
     const state = Private.getState(notebook);
     notebook.mode = 'command';
+
+    // Capture execution context from the stack item being popped.
+    let storedExecutions: Private.IStoredCellExecution[] | undefined;
+    const undoManager = (notebook.model.sharedModel as YNotebook).undoManager;
+    const onStackItemPopped = ({
+      stackItem
+    }: {
+      stackItem: { meta: Map<unknown, unknown> };
+    }) => {
+      storedExecutions = stackItem.meta.get(Private.CELL_EXECUTION_META_KEY) as
+        | Private.IStoredCellExecution[]
+        | undefined;
+    };
+    undoManager.on('stack-item-popped', onStackItemPopped);
     notebook.model.sharedModel.undo();
+    undoManager.off('stack-item-popped', onStackItemPopped);
+
+    // Restore execution state on resurrected cell widgets.
+    storedExecutions?.forEach(({ cellId, future, isDone, buffered }) => {
+      const cell = notebook.widgets.find(w => w.model.id === cellId);
+      if (!(cell instanceof CodeCell)) {
+        return;
+      }
+      if (isDone()) {
+        // Execution finished or was interrupted before undo - ensure state is idle.
+        cell.model.executionState = 'idle';
+        return;
+      }
+      // Still running - reconnect the future so the cell receives remaining
+      // output and stdin requests (e.g. input()), and tracks the idle transition.
+      cell.outputArea.reattachFuture(future);
+      // Replay any IOPub messages that arrived while the future was detached.
+      // After reattachFuture, future.onIOPub routes to the new output area.
+      for (const msg of buffered) {
+        void future.onIOPub(msg);
+      }
+      // The original execute() call targeted the old cell widget, so it will
+      // not update executionCount/executionState on this resurrected cell.
+      // Drive the idle transition here instead.
+      const cellRef = cell;
+      void future.done.then(
+        reply => {
+          if (!cellRef.isDisposed) {
+            cellRef.model.executionCount = reply.content.execution_count;
+          }
+        },
+        () => {
+          if (!cellRef.isDisposed) {
+            cellRef.model.executionState = 'idle';
+          }
+        }
+      );
+    });
+
     notebook.deselectAll();
     void Private.handleState(notebook, state);
   }
@@ -1977,6 +2057,36 @@ export namespace NotebookActions {
     }
   }
 
+  /**
+   * Select the last modified cell and pop it from the back stack
+   *
+   * @param notebook - The target notebook widget.
+   */
+  export async function selectLastModifiedCell(
+    notebook: Notebook
+  ): Promise<void> {
+    const cell = notebook.popLastModifiedCell();
+    if (cell && cell !== notebook.activeCell && !cell.isDisposed) {
+      notebook.activeCellIndex = notebook.widgets.indexOf(cell);
+      await notebook.scrollToCell(cell);
+    }
+  }
+
+  /**
+   * Select the next modified cell and pop it from the forward stack
+   *
+   * @param notebook - The target notebook widget.
+   */
+  export async function selectNextModifiedCell(
+    notebook: Notebook
+  ): Promise<void> {
+    const cell = notebook.popNextModifiedCell();
+    if (cell && cell !== notebook.activeCell && !cell.isDisposed) {
+      notebook.activeCellIndex = notebook.widgets.indexOf(cell);
+      await notebook.scrollToCell(cell);
+    }
+  }
+
   /**
    * Set the markdown header level.
    *
@@ -2455,6 +2565,44 @@ export function setCellExecutor(executor: INotebookCellExecutor): void {
  * A namespace for private data.
  */
 namespace Private {
+  /** Key used to store cell execution state in Y.js undo stack item metadata. */
+  export const CELL_EXECUTION_META_KEY = Symbol('cellExecutionState');
+
+  export interface IStoredCellExecution {
+    cellId: string;
+    future: Kernel.IShellFuture<
+      KernelMessage.IExecuteRequestMsg,
+      KernelMessage.IExecuteReplyMsg
+    >;
+    isDone: () => boolean;
+    /** IOPub messages that arrived while the future was detached. */
+    buffered: KernelMessage.IIOPubMessage[];
+  }
+
+  /**
+   * Detach the kernel future from a code cell, buffering any IOPub messages
+   * that arrive while it is detached so they can be replayed on reattach.
+   *
+   * Returns null if the cell has no active future.
+   */
+  export function captureExecution(
+    cell: CodeCell
+  ): IStoredCellExecution | null {
+    const future = cell.outputArea.detachFuture();
+    if (!future) {
+      return null;
+    }
+    let done = false;
+    void future.done.finally(() => {
+      done = true;
+    });
+    const buffered: KernelMessage.IIOPubMessage[] = [];
+    future.onIOPub = msg => {
+      buffered.push(msg);
+    };
+    return { cellId: cell.model.id, future, isDone: () => done, buffered };
+  }
+
   /**
    * Notebook cell executor
    */
@@ -2901,6 +3049,11 @@ namespace Private {
         if (headingLevel !== undefined) {
           newSource = Private.setMarkdownHeader(newSource, headingLevel);
         }
+        // Detach future before the transaction so dispose() does not cancel it.
+        const storedExecution =
+          child instanceof CodeCell
+            ? Private.captureExecution(child)
+            : undefined;
         notebookSharedModel.transact(() => {
           notebookSharedModel.deleteCell(index);
           if (value === 'code') {
@@ -2922,6 +3075,14 @@ namespace Private {
               raw.attachments as nbformat.IAttachments;
           }
         });
+        if (storedExecution) {
+          const undoManager = (notebookSharedModel as YNotebook).undoManager;
+          const lastItem =
+            undoManager.undoStack[undoManager.undoStack.length - 1];
+          lastItem?.meta.set(Private.CELL_EXECUTION_META_KEY, [
+            storedExecution
+          ]);
+        }
       } else if (value === 'markdown' && headingLevel !== undefined) {
         notebookSharedModel.transact(() => {
           child.model.sharedModel.setSource(
@@ -2971,6 +3132,19 @@ namespace Private {
 
     // If cells are not deletable, we may not have anything to delete.
     if (toDelete.length > 0) {
+      // Detach futures before the transaction so dispose() does not cancel them.
+      const storedExecutions: Private.IStoredCellExecution[] = [];
+      toDelete.forEach(index => {
+        const cell = notebook.widgets[index];
+        if (!(cell instanceof CodeCell)) {
+          return;
+        }
+        const stored = Private.captureExecution(cell);
+        if (stored) {
+          storedExecutions.push(stored);
+        }
+      });
+
       // Delete the cells as one undo event.
       sharedModel.transact(() => {
         // Delete cells in reverse order to maintain the correct indices.
@@ -2994,6 +3168,12 @@ namespace Private {
           });
         }
       });
+      if (storedExecutions.length > 0) {
+        const undoManager = (sharedModel as YNotebook).undoManager;
+        const lastItem =
+          undoManager.undoStack[undoManager.undoStack.length - 1];
+        lastItem?.meta.set(Private.CELL_EXECUTION_META_KEY, storedExecutions);
+      }
       // Select the *first* interior cell not deleted or the cell
       // *after* the last selected cell.
       // Note: The activeCellIndex is clamped to the available cells,
@@ -3013,7 +3193,7 @@ namespace Private {
    */
   export function setMarkdownHeader(source: string, level: number): string {
     // Remove existing header or leading white space.
-    const regex = /^(#+\s*)|^(\s*)/;
+    const regex = /^#+\s*|^\s*/;
     const newHeader = Array(level + 1).join('#') + ' ';
     const matches = regex.exec(source);
 

package/src/cellexecutor.ts

@@ -1,5 +1,6 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
+/* eslint-disable @typescript-eslint/no-explicit-any */
 
 import { Dialog, showDialog } from '@jupyterlab/apputils';
 import {

package/src/model.ts

@@ -1,5 +1,6 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
+/* eslint-disable @typescript-eslint/no-explicit-any */
 
 import { Dialog, showDialog } from '@jupyterlab/apputils';
 import type { ICellModel } from '@jupyterlab/cells';
@@ -15,6 +16,7 @@ import type {
 import { YNotebook } from '@jupyter/ydoc';
 import type { ITranslator, TranslationBundle } from '@jupyterlab/translation';
 import { nullTranslator } from '@jupyterlab/translation';
+import type { JSONValue } from '@lumino/coreutils';
 import { JSONExt } from '@lumino/coreutils';
 import type { ISignal } from '@lumino/signaling';
 import { Signal } from '@lumino/signaling';
@@ -160,19 +162,14 @@ export class NotebookModel implements INotebookModel {
    * The dirty state of the document.
    */
   get dirty(): boolean {
-    return this._dirty;
+    return this.sharedModel.dirty;
   }
   set dirty(newValue: boolean) {
-    const oldValue = this._dirty;
+    const oldValue = this.dirty;
     if (newValue === oldValue) {
       return;
     }
-    this._dirty = newValue;
-    this.triggerStateChange({
-      name: 'dirty',
-      oldValue,
-      newValue
-    });
+    this.sharedModel.dirty = newValue;
   }
 
   /**
@@ -382,10 +379,9 @@ close the notebook without saving it.`,
         { cell_type: 'code', source: '', metadata: { trusted: true } }
       ];
     }
-    this.sharedModel.fromJSON(copy);
+    this.sharedModel.setSource(copy as JSONValue);
 
     this._ensureMetadata();
-    this.dirty = true;
   }
 
   /**
@@ -431,12 +427,7 @@ close the notebook without saving it.`,
   ): void {
     if (changes.stateChange) {
       changes.stateChange.forEach(value => {
-        if (value.name === 'dirty') {
-          // Setting `dirty` will trigger the state change.
-          // We always set `dirty` because the shared model state
-          // and the local attribute are synchronized one way shared model -> _dirty
-          this.dirty = value.newValue;
-        } else if (value.oldValue !== value.newValue) {
+        if (value.oldValue !== value.newValue) {
           this.triggerStateChange({
             newValue: undefined,
             oldValue: undefined,
@@ -474,7 +465,6 @@ close the notebook without saving it.`,
    */
   protected triggerContentChange(): void {
     this._contentChanged.emit(void 0);
-    this.dirty = true;
   }
 
   /**
@@ -494,7 +484,6 @@ close the notebook without saving it.`,
    */
   protected standaloneModel = false;
 
-  private _dirty = false;
   private _readOnly = false;
   private _contentChanged = new Signal<this, void>(this);
   private _stateChanged = new Signal<this, IChangedArgs<any>>(this);

package/src/panel.ts

@@ -1,5 +1,6 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
+/* eslint-disable @typescript-eslint/no-explicit-any */
 
 import type { ISessionContext } from '@jupyterlab/apputils';
 import { Dialog, Printing, showDialog } from '@jupyterlab/apputils';

package/src/searchprovider.ts

@@ -1,5 +1,6 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
+/* eslint-disable @typescript-eslint/no-explicit-any */
 
 import { Dialog, showDialog } from '@jupyterlab/apputils';
 import type {

package/src/testutils.ts

@@ -1,5 +1,6 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
+/* eslint-disable @typescript-eslint/no-explicit-any */
 
 import type { ISessionContext } from '@jupyterlab/apputils';
 import {

package/src/toc.ts

@@ -1,5 +1,6 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
+/* eslint-disable @typescript-eslint/no-explicit-any */
 
 import type { CodeCell, ICellModel } from '@jupyterlab/cells';
 import { Cell, MarkdownCell } from '@jupyterlab/cells';
@@ -15,6 +16,13 @@ import { NotebookActions } from './actions';
 import type { NotebookPanel } from './panel';
 import type { INotebookTracker } from './tokens';
 import type { Notebook } from './widget';
+import {
+  CommandToolbarButton,
+  jumpBackIcon,
+  jumpForwardIcon
+} from '@jupyterlab/ui-components';
+import type { ToolbarRegistry } from '@jupyterlab/apputils';
+import type { CommandRegistry } from '@lumino/commands';
 
 /**
  * Cell running status
@@ -559,11 +567,13 @@ export class NotebookToCFactory extends TableOfContentsFactory<NotebookPanel> {
    * @param tracker Widget tracker
    * @param parser Markdown parser
    * @param sanitizer Sanitizer
+   * @param commands A registry of commands
    */
   constructor(
     tracker: INotebookTracker,
     protected parser: IMarkdownParser | null,
-    protected sanitizer: IRenderMime.ISanitizer
+    protected sanitizer: IRenderMime.ISanitizer,
+    protected commands: CommandRegistry | undefined
   ) {
     super(tracker);
   }
@@ -790,6 +800,44 @@ export class NotebookToCFactory extends TableOfContentsFactory<NotebookPanel> {
     return model;
   }
 
+  /**
+   * Get the toolbar items for the widget
+   *
+   * @param widget - widget
+   * @returns List of toolbar items
+   */
+  getToolbarItems(widget: NotebookPanel): ToolbarRegistry.IToolbarItem[] {
+    if (!this.commands) {
+      return [];
+    }
+    return [
+      {
+        name: 'select-last-modified-back',
+        widget: new CommandToolbarButton({
+          commands: this.commands,
+          id: 'notebook:select-last-modified-cell',
+          args: {
+            toolbar: true
+          },
+          icon: jumpBackIcon,
+          label: ''
+        })
+      },
+      {
+        name: 'select-last-modified-forward',
+        widget: new CommandToolbarButton({
+          commands: this.commands,
+          id: 'notebook:select-next-modified-cell',
+          args: {
+            toolbar: true
+          },
+          icon: jumpForwardIcon,
+          label: ''
+        })
+      }
+    ];
+  }
+
   private _scrollToTop: boolean = true;
 }