@jupyterlab/debugger 4.5.0-beta.1 → 4.5.0-rc.0

package/src/panels/breakpoints/model.ts

@@ -2,19 +2,16 @@
 // Distributed under the terms of the Modified BSD License.
 
 import { ISignal, Signal } from '@lumino/signaling';
-import { IDebugger } from '../../tokens';
-import { INotebookTracker } from '@jupyterlab/notebook';
-import { isCodeCellModel } from '@jupyterlab/cells';
-import { IConsoleTracker } from '@jupyterlab/console';
+import { IDebugger, IDebuggerDisplayRegistry } from '../../tokens';
+import { DebuggerDisplayRegistry } from '../../displayregistry';
 
 /**
  * A model for a list of breakpoints.
  */
 export class BreakpointsModel implements IDebugger.Model.IBreakpoints {
-  constructor(options: BreakpointsModel.IOptions) {
-    this._config = options.config;
-    this._notebookTracker = options.notebookTracker;
-    this._consoleTracker = options.consoleTracker;
+  constructor(options: { displayRegistry?: IDebuggerDisplayRegistry }) {
+    this._displayRegistry =
+      options.displayRegistry ?? new DebuggerDisplayRegistry();
   }
 
   /**
@@ -102,70 +99,18 @@ export class BreakpointsModel implements IDebugger.Model.IBreakpoints {
    * Shows execution count if notebook cell, [*] if running, [ ] if never executed.
    */
   getDisplayName(breakpoint: IDebugger.IBreakpoint): string {
-    if (!this._notebookTracker || !this._config) {
-      return breakpoint.source?.path ?? '';
-    }
-
-    let display = breakpoint.source?.path ?? '';
-
-    this._notebookTracker.forEach(panel => {
-      const kernelName = panel.sessionContext.session?.kernel?.name ?? '';
-      panel.content.widgets.forEach(cell => {
-        if (cell.model.type !== 'code') return;
-
-        const code = cell.model.sharedModel.getSource();
-        const codeId = this._config?.getCodeId(code, kernelName);
-
-        if (codeId && codeId === breakpoint.source?.path) {
-          if (isCodeCellModel(cell.model)) {
-            if (cell.model.executionState === 'running') {
-              display = `Cell [*]`;
-            } else if (cell.model.executionCount === null) {
-              display = `Cell [ ]`;
-            } else {
-              display = `Cell [${cell.model.executionCount}]`;
-            }
-          }
-        }
-      });
-    });
-
-    this._consoleTracker?.forEach(panel => {
-      const kernelName = panel.sessionContext.session?.kernel?.name ?? '';
-
-      Array.from(panel.console.cells).forEach(cell => {
-        const code = cell.model.sharedModel.getSource();
-        const codeId = this._config?.getCodeId(code, kernelName);
-
-        if (codeId && codeId === breakpoint.source?.path) {
-          if (isCodeCellModel(cell.model)) {
-            const executionCount = cell.model.executionCount ?? null;
-            const executionState = cell.model.executionState ?? null;
-
-            if (executionState === 'running') {
-              display = `In [*]`;
-            } else if (executionCount === null) {
-              display = `In [ ]`;
-            } else {
-              display = `In [${executionCount}]`;
-            }
-          }
-        }
-      });
-    });
-
-    return display;
+    return this._displayRegistry.getDisplayName(
+      breakpoint.source as IDebugger.Source
+    );
   }
 
-  private _config: IDebugger.IConfig;
-  private _notebookTracker: INotebookTracker | null;
-  private _consoleTracker: IConsoleTracker | null;
   private _breakpoints = new Map<string, IDebugger.IBreakpoint[]>();
   private _changed = new Signal<this, IDebugger.IBreakpoint[]>(this);
   private _restored = new Signal<this, void>(this);
   private _clicked = new Signal<this, IDebugger.IBreakpoint>(this);
   private _selectedBreakpoint: IDebugger.IBreakpoint;
   private _selectedChanged = new Signal<this, IDebugger.IBreakpoint>(this);
+  private _displayRegistry: IDebuggerDisplayRegistry;
 }
 
 /**
@@ -177,18 +122,8 @@ export namespace BreakpointsModel {
    */
   export interface IOptions {
     /**
-     * Debugger configuration.
-     */
-    config: IDebugger.IConfig;
-
-    /**
-     * The notebook tracker.
-     */
-    notebookTracker: INotebookTracker | null;
-
-    /**
-     * The console tracker.
+     * The debugger display registry.
      */
-    consoleTracker: IConsoleTracker | null;
+    displayRegistry: IDebuggerDisplayRegistry;
   }
 }

package/src/panels/callstack/model.ts

@@ -3,19 +3,17 @@
 
 import { ISignal, Signal } from '@lumino/signaling';
 
-import { IDebugger } from '../../tokens';
-import { isCodeCellModel } from '@jupyterlab/cells';
+import { DebuggerDisplayRegistry } from '../../displayregistry';
+import { IDebugger, IDebuggerDisplayRegistry } from '../../tokens';
 import { INotebookTracker } from '@jupyterlab/notebook';
 import { IConsoleTracker } from '@jupyterlab/console';
-
 /**
  * A model for a callstack.
  */
 export class CallstackModel implements IDebugger.Model.ICallstack {
-  constructor(options: CallstackModel.IOptions) {
-    this._config = options.config;
-    this._notebookTracker = options.notebookTracker ?? null;
-    this._consoleTracker = options.consoleTracker ?? null;
+  constructor(options: { displayRegistry?: IDebuggerDisplayRegistry }) {
+    this._displayRegistry =
+      options.displayRegistry ?? new DebuggerDisplayRegistry();
   }
 
   /**
@@ -77,70 +75,22 @@ export class CallstackModel implements IDebugger.Model.ICallstack {
    * Returns a human-readable display for a frame.
    */
   getDisplayName(frame: IDebugger.IStackFrame): string {
-    if (!this._notebookTracker || !this._config) {
-      return frame.source?.path ?? '';
+    let name = this._displayRegistry.getDisplayName(
+      frame.source as IDebugger.Source
+    );
+    if (frame.line !== undefined) {
+      name += `:${frame.line}`;
     }
-
-    let display = frame.source?.path ?? '';
-
-    this._notebookTracker.forEach(panel => {
-      const kernelName = panel.sessionContext.session?.kernel?.name ?? '';
-      panel.content.widgets.forEach(cell => {
-        if (cell.model.type !== 'code') return;
-
-        const code = cell.model.sharedModel.getSource();
-        const codeId = this._config.getCodeId(code, kernelName);
-
-        if (codeId && codeId === frame.source?.path) {
-          if (isCodeCellModel(cell.model)) {
-            if (cell.model.executionState === 'running') {
-              display = `Cell [*]`;
-            } else if (cell.model.executionCount === null) {
-              display = `Cell [ ]`;
-            } else {
-              display = `Cell [${cell.model.executionCount}]`;
-            }
-          }
-        }
-      });
-    });
-
-    this._consoleTracker?.forEach(panel => {
-      const kernelName = panel.sessionContext.session?.kernel?.name ?? '';
-
-      Array.from(panel.console.cells).forEach(cell => {
-        const code = cell.model.sharedModel.getSource();
-        const codeId = this._config?.getCodeId(code, kernelName);
-
-        if (codeId && codeId === frame.source?.path) {
-          if (isCodeCellModel(cell.model)) {
-            const executionCount = cell.model.executionCount ?? null;
-            const executionState = cell.model.executionState ?? null;
-
-            if (executionState === 'running') {
-              display = `In [*]`;
-            } else if (executionCount === null) {
-              display = `In [ ]`;
-            } else {
-              display = `In [${executionCount}]`;
-            }
-          }
-        }
-      });
-    });
-
-    return display;
+    return name;
   }
 
-  private _config: IDebugger.IConfig;
-  private _notebookTracker: INotebookTracker | null;
-  private _consoleTracker: IConsoleTracker | null;
   private _state: IDebugger.IStackFrame[] = [];
   private _currentFrame: IDebugger.IStackFrame | null = null;
   private _framesChanged = new Signal<this, IDebugger.IStackFrame[]>(this);
   private _currentFrameChanged = new Signal<this, IDebugger.IStackFrame | null>(
     this
   );
+  private _displayRegistry: IDebuggerDisplayRegistry;
 }
 
 /**

package/src/panels/sources/model.ts

@@ -3,9 +3,8 @@
 
 import { ISignal, Signal } from '@lumino/signaling';
 
-import { IDebugger } from '../../tokens';
-import { INotebookTracker } from '@jupyterlab/notebook';
-import { isCodeCellModel } from '@jupyterlab/cells';
+import { DebuggerDisplayRegistry } from '../../displayregistry';
+import { IDebugger, IDebuggerDisplayRegistry } from '../../tokens';
 
 /**
  * The model to keep track of the current source being displayed.
@@ -18,8 +17,8 @@ export class SourcesModel implements IDebugger.Model.ISources {
    */
   constructor(options: SourcesModel.IOptions) {
     this.currentFrameChanged = options.currentFrameChanged;
-    this._notebookTracker = options.notebookTracker ?? undefined;
-    this._config = options.config;
+    this._displayRegistry =
+      options.displayRegistry ?? new DebuggerDisplayRegistry();
   }
 
   /**
@@ -73,36 +72,17 @@ export class SourcesModel implements IDebugger.Model.ISources {
    *
    * For notebook cells, shows execution count if available, [*] if running, or [ ] if never executed.
    */
+  /**
+   * Returns a human-readable display for a frame.
+   */
   getDisplayName(frame: IDebugger.IStackFrame): string {
-    let display = frame.source?.path ?? '';
-
-    if (!this._notebookTracker || !this._config || !frame.source?.path) {
-      return display;
+    let name = this._displayRegistry.getDisplayName(
+      frame.source as IDebugger.Source
+    );
+    if (frame.line !== undefined) {
+      name += `:${frame.line}`;
     }
-
-    this._notebookTracker.forEach(panel => {
-      const kernelName = panel.sessionContext.session?.kernel?.name ?? '';
-      panel.content.widgets.forEach(cell => {
-        if (cell.model.type !== 'code') return;
-
-        const code = cell.model.sharedModel.getSource();
-        const codeId = this._config!.getCodeId(code, kernelName);
-
-        if (codeId === frame.source?.path) {
-          if (isCodeCellModel(cell.model)) {
-            if (cell.model.executionState === 'running') {
-              display = `Cell [*]`;
-            } else if (cell.model.executionCount === null) {
-              display = `Cell [ ]`;
-            } else {
-              display = `Cell [${cell.model.executionCount}]`;
-            }
-          }
-        }
-      });
-    });
-
-    return display;
+    return name;
   }
 
   private _currentSource: IDebugger.Source | null;
@@ -114,8 +94,7 @@ export class SourcesModel implements IDebugger.Model.ISources {
     SourcesModel,
     IDebugger.Source | null
   >(this);
-  private _notebookTracker?: INotebookTracker;
-  private _config?: IDebugger.IConfig;
+  private _displayRegistry: IDebuggerDisplayRegistry;
 }
 
 /**
@@ -135,13 +114,8 @@ export namespace SourcesModel {
     >;
 
     /**
-     * Optional notebook tracker to resolve cell execution numbers.
-     */
-    notebookTracker: INotebookTracker | null;
-
-    /**
-     * Debugger config used to get code ids.
+     * The display registry.
      */
-    config: IDebugger.IConfig;
+    displayRegistry?: IDebuggerDisplayRegistry;
   }
 }

package/src/service.ts

@@ -20,8 +20,7 @@ import { Debugger } from './debugger';
 import { VariablesModel } from './panels/variables/model';
 
 import { IDebugger } from './tokens';
-import { INotebookTracker } from '@jupyterlab/notebook';
-import { IConsoleTracker } from '@jupyterlab/console';
+import { IDebuggerDisplayRegistry } from './tokens';
 
 /**
  * A concrete implementation of the IDebugger interface.
@@ -42,9 +41,7 @@ export class DebuggerService implements IDebugger, IDisposable {
     this._session = null;
     this._specsManager = options.specsManager ?? null;
     this._model = new Debugger.Model({
-      config: options.config,
-      notebookTracker: options.notebookTracker || null,
-      consoleTracker: options.consoleTracker || null
+      displayRegistry: options.displayRegistry
     });
     this._debuggerSources = options.debuggerSources ?? null;
     this._trans = (options.translator || nullTranslator).load('jupyterlab');
@@ -431,7 +428,7 @@ export class DebuggerService implements IDebugger, IDisposable {
 
     const reply = await this.session.restoreState();
     const { body } = reply;
-    const breakpoints = this._mapBreakpoints(body.breakpoints);
+    const kernelBreakpoints = this._mapBreakpoints(body.breakpoints);
     const stoppedThreads = new Set(body.stoppedThreads);
 
     this._model.hasRichVariableRendering = body.richRendering === true;
@@ -459,6 +456,28 @@ export class DebuggerService implements IDebugger, IDisposable {
         ? this.session?.connection?.name || '-'
         : '-';
     }
+    const breakpoints = this._migrateBreakpoints(
+      this._model.breakpoints.breakpoints
+    );
+
+    // Merge kernel breakpoints with existing breakpoints, avoiding duplicates
+    for (const [path, kernelBpList] of kernelBreakpoints) {
+      const existingBreakpoints = breakpoints.get(path) ?? [];
+
+      // Filter out kernel breakpoints that already exist at the same line
+      const newBreakpoints = kernelBpList.filter(
+        kernelBp =>
+          !existingBreakpoints.some(
+            existingBp => existingBp.line === kernelBp.line
+          )
+      );
+
+      // Merge existing and new breakpoints
+      breakpoints.set(path, [...existingBreakpoints, ...newBreakpoints]);
+    }
+
+    // restore in kernel AND model
+    await this._restoreBreakpoints(breakpoints);
 
     if (this._debuggerSources) {
       const filtered = this._filterBreakpoints(breakpoints);
@@ -577,6 +596,7 @@ export class DebuggerService implements IDebugger, IDisposable {
     const localBreakpoints = breakpoints
       .filter(({ line }) => typeof line === 'number')
       .map(({ line }) => ({ line: line! }));
+
     const remoteBreakpoints = this._mapBreakpoints(state.body.breakpoints);
 
     // Set the local copy of breakpoints to reflect only editors that exist.
@@ -696,21 +716,36 @@ export class DebuggerService implements IDebugger, IDisposable {
       await this._dumpCell(cell);
     }
 
-    const breakpoints = new Map<string, IDebugger.IBreakpoint[]>();
+    const breakpoints = this._migrateBreakpoints(state.breakpoints);
+
+    await this._restoreBreakpoints(breakpoints);
+    const config = await this.session!.sendRequest('configurationDone', {});
+    await this.restoreState(false);
+    return config.success;
+  }
+
+  /**
+   * Migrate breakpoints from previous path to new path when restoring service state
+   * @param breakpoints
+   * @returns
+   */
+  private _migrateBreakpoints(
+    breakpoints: Map<string, IDebugger.IBreakpoint[]>
+  ) {
+    const migratedBreakpoints = new Map<string, IDebugger.IBreakpoint[]>();
     const kernel = this.session?.connection?.kernel?.name ?? '';
     const { prefix, suffix } = this._config.getTmpFileParams(kernel);
-    for (const item of state.breakpoints) {
+    for (const item of breakpoints) {
       const [id, list] = item;
-      const unsuffixedId = id.substr(0, id.length - suffix.length);
-      const codeHash = unsuffixedId.substr(unsuffixedId.lastIndexOf('/') + 1);
+      const unSuffixedId = id.substring(0, id.length - suffix.length);
+      const codeHash = unSuffixedId.substring(
+        unSuffixedId.lastIndexOf('/') + 1
+      );
       const newId = prefix.concat(codeHash).concat(suffix);
-      breakpoints.set(newId, list);
+      migratedBreakpoints.set(newId, list);
     }
 
-    await this._restoreBreakpoints(breakpoints);
-    const config = await this.session!.sendRequest('configurationDone', {});
-    await this.restoreState(false);
-    return config.success;
+    return migratedBreakpoints;
   }
 
   /**
@@ -1053,13 +1088,8 @@ export namespace DebuggerService {
     translator?: ITranslator | null;
 
     /**
-     * The notebook tracker.
-     */
-    notebookTracker?: INotebookTracker | null;
-
-    /**
-     * The console tracker.
+     * The display registry.
      */
-    consoleTracker?: IConsoleTracker | null;
+    displayRegistry?: IDebuggerDisplayRegistry | null;
   }
 }

package/src/sidebar.ts

@@ -11,8 +11,6 @@ import { bugIcon, SidePanel } from '@jupyterlab/ui-components';
 
 import { Widget } from '@lumino/widgets';
 
-import { INotebookTracker } from '@jupyterlab/notebook';
-
 import { Breakpoints as BreakpointsPanel } from './panels/breakpoints';
 
 import { Callstack as CallstackPanel } from './panels/callstack';
@@ -160,16 +158,6 @@ export namespace DebuggerSidebar {
      * An optional application language translator.
      */
     translator?: ITranslator;
-
-    /**
-     * The notebook tracker (required to resolve notebook breakpoints).
-     */
-    notebookTracker: INotebookTracker | null;
-
-    /**
-     * The debugger configuration.
-     */
-    config: IDebugger.IConfig;
   }
 
   /**

package/src/tokens.ts

@@ -19,6 +19,8 @@ import { DebugProtocol } from '@vscode/debugprotocol';
 
 import { DebuggerHandler } from './handler';
 
+import { IDebuggerSourceDisplayProvider } from './displayregistry';
+
 /**
  * An interface describing an application's visual debugger.
  */
@@ -1110,6 +1112,21 @@ export namespace IDebugger {
   }
 }
 
+/**
+ * Interface token for the Debugger Display Registry service.
+ */
+export interface IDebuggerDisplayRegistry {
+  /**
+   * Register a display provider.
+   */
+  register(provider: IDebuggerSourceDisplayProvider): void;
+
+  /**
+   * Get a display name for a given source.
+   */
+  getDisplayName(source: IDebugger.Source): string;
+}
+
 /**
  * The visual debugger token.
  */
@@ -1157,3 +1174,11 @@ export const IDebuggerSourceViewer = new Token<IDebugger.ISourceViewer>(
   '@jupyterlab/debugger:IDebuggerSourceViewer',
   'A debugger source viewer.'
 );
+
+/**
+ * Debugger display registry token.
+ */
+export const IDebuggerDisplayRegistry = new Token<IDebuggerDisplayRegistry>(
+  '@jupyterlab/debugger:IDebuggerDisplayRegistry',
+  'A service for registering display labels for cells/files in the debugger.'
+);