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

package/src/service.ts

@@ -20,6 +20,7 @@ import { Debugger } from './debugger';
 import { VariablesModel } from './panels/variables/model';
 
 import { IDebugger } from './tokens';
+import { IDebuggerDisplayRegistry } from './tokens';
 
 /**
  * A concrete implementation of the IDebugger interface.
@@ -39,7 +40,9 @@ export class DebuggerService implements IDebugger, IDisposable {
     // runs a kernel with debugging ability
     this._session = null;
     this._specsManager = options.specsManager ?? null;
-    this._model = new Debugger.Model();
+    this._model = new Debugger.Model({
+      displayRegistry: options.displayRegistry
+    });
     this._debuggerSources = options.debuggerSources ?? null;
     this._trans = (options.translator || nullTranslator).load('jupyterlab');
   }
@@ -425,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;
@@ -453,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);
@@ -571,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.
@@ -690,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;
   }
 
   /**
@@ -1045,5 +1086,10 @@ export namespace DebuggerService {
      * The application language translator.
      */
     translator?: ITranslator | null;
+
+    /**
+     * The display registry.
+     */
+    displayRegistry?: IDebuggerDisplayRegistry | null;
   }
 }

package/src/sidebar.ts

@@ -140,7 +140,7 @@ export namespace DebuggerSidebar {
     callstackCommands: CallstackPanel.ICommands;
 
     /**
-     * The callstack toolbar commands.
+     * The breakpoints toolbar commands.
      */
     breakpointsCommands: BreakpointsPanel.ICommands;
 

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.
  */
@@ -122,7 +124,6 @@ export interface IDebugger {
    * Request to set a variable in the global scope.
    *
    * @param name The name of the variable.
-   * @param value The value of the variable.
    */
   copyToGlobals(name: string): Promise<void>;
 
@@ -886,6 +887,14 @@ export namespace IDebugger {
        * @param breakpoints The list of breakpoints.
        */
       setBreakpoints(id: string, breakpoints: IBreakpoint[]): void;
+
+      /**
+       * Function to get a display name for a breakpoint.
+       *
+       * @param breakpoint The breakpoint object.
+       * @returns The display name.
+       */
+      getDisplayName(breakpoint: IBreakpoint): string;
     }
 
     /**
@@ -911,6 +920,14 @@ export namespace IDebugger {
        * Signal emitted when the frames have changed.
        */
       readonly framesChanged: ISignal<this, IDebugger.IStackFrame[]>;
+
+      /**
+       * Function to get a display name for a frame.
+       *
+       * @param frame The frame object.
+       * @returns The display name.
+       */
+      getDisplayName?(frame: IDebugger.IStackFrame): string;
     }
 
     /**
@@ -1010,6 +1027,14 @@ export namespace IDebugger {
        * Open a source in the main area.
        */
       open(): void;
+
+      /**
+       * Function to get a display name for a frame.
+       *
+       * @param frame The frame object.
+       * @returns The display name.
+       */
+      getDisplayName(frame: IDebugger.IStackFrame): string;
     }
 
     /**
@@ -1087,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.
  */
@@ -1134,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.'
+);

package/style/base.css

@@ -14,7 +14,7 @@
 .jp-left-truncated {
   overflow: hidden;
   text-overflow: ellipsis;
-  direction: rtl;
+  direction: ltr;
 }
 
 #jp-debugger .jp-switch-label {
@@ -29,3 +29,38 @@
 .jp-DebuggerBugButton[aria-pressed='true'] path {
   fill: var(--jp-warn-color0);
 }
+
+.jp-DebuggerPausedOverlay {
+  position: absolute;
+  top: 8px;
+  left: 50%;
+  transform: translateX(-50%);
+  display: flex;
+  align-items: center;
+  gap: 6px;
+  padding: 4px 8px;
+  border: 1px solid var(--jp-border-color2);
+  border-radius: 4px;
+  background: var(--jp-layout-color2);
+  box-shadow: 0 2px 4px rgba(0, 0, 0, 0.2);
+  z-index: 1000;
+  font-size: var(--jp-ui-font-size1);
+  color: var(--jp-ui-font-color1);
+}
+
+.jp-DebuggerPausedButton {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  width: 24px;
+  height: 24px;
+  border: none;
+  border-radius: 3px;
+  background: transparent;
+  cursor: pointer;
+  padding: 0;
+}
+
+.jp-DebuggerPausedButton:hover {
+  background: var(--jp-layout-color3);
+}