@jupyterlab/debugger 3.3.0-alpha.6 → 3.3.0-beta.0

package/lib/tokens.d.ts

@@ -1,10 +1,11 @@
 import { CodeEditor, CodeEditorWrapper } from '@jupyterlab/codeeditor';
 import { KernelMessage, Session } from '@jupyterlab/services';
-import { Token } from '@lumino/coreutils';
+import { ReadonlyJSONObject, Token } from '@lumino/coreutils';
 import { IObservableDisposable } from '@lumino/disposable';
 import { ISignal, Signal } from '@lumino/signaling';
 import { Widget } from '@lumino/widgets';
-import { DebugProtocol } from 'vscode-debugprotocol';
+import { DebugProtocol } from '@vscode/debugprotocol';
+import { DebuggerHandler } from './handler';
 /**
  * An interface describing an application's visual debugger.
  */
@@ -17,6 +18,10 @@ export interface IDebugger {
      * Whether the current debugger is started.
      */
     readonly isStarted: boolean;
+    /**
+     * Whether the session is pausing for exceptions.
+     */
+    readonly isPausingOnExceptions: boolean;
     /**
      * The debugger service's model.
      */
@@ -33,6 +38,14 @@ export interface IDebugger {
      * Removes all the breakpoints from the current notebook or console
      */
     clearBreakpoints(): Promise<void>;
+    /**
+     * Used to determine if kernel has pause on exception capabilities
+     */
+    pauseOnExceptionsIsValid(): boolean;
+    /**
+     * Handles enabling and disabling of Pause on Exception
+     */
+    pauseOnExceptions(enable: boolean): Promise<void>;
     /**
      * Continues the execution of the current thread.
      */
@@ -61,6 +74,14 @@ export interface IDebugger {
      * @param variablesReference The variable reference to request.
      */
     inspectVariable(variablesReference: number): Promise<DebugProtocol.Variable[]>;
+    /**
+     * Request rich representation of a variable.
+     *
+     * @param variableName The variable name to request
+     * @param frameId The current frame id in which to request the variable
+     * @returns The mime renderer data model
+     */
+    inspectRichVariable(variableName: string, frameId?: number): Promise<IDebugger.IRichVariable>;
     /**
      * Requests all the defined variables and display them in the
      * table view.
@@ -76,6 +97,10 @@ export interface IDebugger {
      * Makes the current thread run again for one step.
      */
     next(): Promise<void>;
+    /**
+     * Requests all the loaded modules and display them.
+     */
+    displayModules(): Promise<void>;
     /**
      * Restart the debugger.
      * Precondition: isStarted
@@ -164,6 +189,19 @@ export declare namespace IDebugger {
          */
         breakpoints: Map<string, IDebugger.IBreakpoint[]>;
     };
+    /**
+     * The type for a kernel source file.
+     */
+    type KernelSource = {
+        /**
+         * The name of the source.
+         */
+        name: string;
+        /**
+         * The path of the source.
+         */
+        path: string;
+    };
     /**
      * Debugger file and hashing configuration.
      */
@@ -194,6 +232,11 @@ export declare namespace IDebugger {
          */
         getTmpFileParams(kernel: string): IConfig.FileParams;
     }
+    /**
+     * An interface for debugger handler.
+     */
+    interface IHandler extends DebuggerHandler.IHandler {
+    }
     /**
      * An interface for a scope.
      */
@@ -215,10 +258,23 @@ export declare namespace IDebugger {
          * The API session connection to connect to a debugger.
          */
         connection: Session.ISessionConnection | null;
+        readonly capabilities: DebugProtocol.Capabilities | undefined;
         /**
-         * Whether the debug session is started
+         * Whether the debug session is started.
          */
         readonly isStarted: boolean;
+        /**
+         * Whether the debug session is pausing on exceptions.
+         */
+        pausingOnExceptions: string[];
+        /**
+         * Whether the debug session is pausing on exceptions.
+         */
+        exceptionPaths: string[];
+        /**
+         * Get exception filters and default values.
+         */
+        exceptionBreakpointFilters: DebugProtocol.ExceptionBreakpointsFilter[] | undefined;
         /**
          * Signal emitted for debug event messages.
          */
@@ -264,6 +320,19 @@ export declare namespace IDebugger {
      */
     interface IStackFrame extends DebugProtocol.StackFrame {
     }
+    /**
+     * A reply to an rich inspection request.
+     */
+    interface IRichVariable {
+        /**
+         * The MIME bundle data returned from an rich inspection request.
+         */
+        data: ReadonlyJSONObject;
+        /**
+         * Any metadata that accompanies the MIME bundle returning from a rich inspection request.
+         */
+        metadata: ReadonlyJSONObject;
+    }
     /**
      * An interface for a variable.
      */
@@ -325,7 +394,7 @@ export declare namespace IDebugger {
             completions: DebugProtocol.CompletionsArguments;
             configurationDone: DebugProtocol.ConfigurationDoneArguments;
             continue: DebugProtocol.ContinueArguments;
-            debugInfo: Record<string, never>;
+            debugInfo: {};
             disconnect: DebugProtocol.DisconnectArguments;
             dumpCell: IDumpCellArguments;
             evaluate: DebugProtocol.EvaluateArguments;
@@ -333,7 +402,7 @@ export declare namespace IDebugger {
             goto: DebugProtocol.GotoArguments;
             gotoTargets: DebugProtocol.GotoTargetsArguments;
             initialize: DebugProtocol.InitializeRequestArguments;
-            inspectVariables: Record<string, never>;
+            inspectVariables: {};
             launch: DebugProtocol.LaunchRequestArguments;
             loadedSources: DebugProtocol.LoadedSourcesArguments;
             modules: DebugProtocol.ModulesArguments;
@@ -342,6 +411,7 @@ export declare namespace IDebugger {
             restart: DebugProtocol.RestartArguments;
             restartFrame: DebugProtocol.RestartFrameArguments;
             reverseContinue: DebugProtocol.ReverseContinueArguments;
+            richInspectVariables: IRichVariablesArguments;
             scopes: DebugProtocol.ScopesArguments;
             setBreakpoints: DebugProtocol.SetBreakpointsArguments;
             setExceptionBreakpoints: DebugProtocol.SetExceptionBreakpointsArguments;
@@ -356,7 +426,7 @@ export declare namespace IDebugger {
             stepOut: DebugProtocol.StepOutArguments;
             terminate: DebugProtocol.TerminateArguments;
             terminateThreads: DebugProtocol.TerminateThreadsArguments;
-            threads: Record<string, never>;
+            threads: {};
             variables: DebugProtocol.VariablesArguments;
         };
         /**
@@ -384,6 +454,7 @@ export declare namespace IDebugger {
             restart: DebugProtocol.RestartResponse;
             restartFrame: DebugProtocol.RestartFrameResponse;
             reverseContinue: DebugProtocol.ReverseContinueResponse;
+            richInspectVariables: IRichVariablesResponse;
             scopes: DebugProtocol.ScopesResponse;
             setBreakpoints: DebugProtocol.SetBreakpointsResponse;
             setExceptionBreakpoints: DebugProtocol.SetExceptionBreakpointsResponse;
@@ -415,13 +486,18 @@ export declare namespace IDebugger {
          */
         interface IDebugInfoResponse extends DebugProtocol.Response {
             body: {
-                isStarted: boolean;
+                breakpoints: IDebugInfoBreakpoints[];
                 hashMethod: string;
                 hashSeed: number;
-                breakpoints: IDebugInfoBreakpoints[];
+                isStarted: boolean;
+                /**
+                 * Whether the kernel supports variable rich rendering or not.
+                 */
+                richRendering?: boolean;
                 tmpFilePrefix: string;
                 tmpFileSuffix: string;
                 stoppedThreads: number[];
+                exceptionPaths: string[];
             };
         }
         /**
@@ -447,6 +523,34 @@ export declare namespace IDebugger {
                 variables: DebugProtocol.Variable[];
             };
         }
+        /**
+         * Arguments for 'richVariables' request
+         *
+         * This is an addition to the Debug Adapter Protocol to support
+         * render rich variable representation.
+         */
+        interface IRichVariablesArguments {
+            /**
+             * Variable name
+             */
+            variableName: string;
+            /**
+             * Frame Id
+             */
+            frameId?: number;
+        }
+        /**
+         * Arguments for 'richVariables' request
+         *
+         * This is an addition to the Debug Adapter Protocol to support
+         * rich rendering of variables.
+         */
+        interface IRichVariablesResponse extends DebugProtocol.Response {
+            /**
+             * Variable mime type data
+             */
+            body: IRichVariable;
+        }
         /**
          * Response to the 'kernel_info_request' request.
          * This interface extends the IInfoReply by adding the `debugger` key
@@ -457,6 +561,16 @@ export declare namespace IDebugger {
             debugger: boolean;
         }
     }
+    /**
+     * Select variable in the variables explorer.
+     *
+     * @hidden
+     *
+     * #### Notes
+     * This is experimental API
+     */
+    interface IVariableSelection extends Pick<DebugProtocol.Variable, 'name' | 'type' | 'variablesReference' | 'value'> {
+    }
     /**
      * Debugger sidebar interface.
      */
@@ -568,11 +682,11 @@ export declare namespace IDebugger {
             /**
              * Signal emitted when the current frame has changed.
              */
-            readonly currentFrameChanged: ISignal<this, IDebugger.IStackFrame>;
+            readonly currentFrameChanged: ISignal<this, IDebugger.IStackFrame | null>;
             /**
              * The current frame.
              */
-            frame: IDebugger.IStackFrame;
+            frame: IDebugger.IStackFrame | null;
             /**
              * The frames for the callstack.
              */
@@ -594,6 +708,10 @@ export declare namespace IDebugger {
              * The callstack UI model.
              */
             readonly callstack: ICallstack;
+            /**
+             * Whether the kernel support rich variable rendering based on mime type.
+             */
+            hasRichVariableRendering: boolean;
             /**
              * The variables UI model.
              */
@@ -602,6 +720,10 @@ export declare namespace IDebugger {
              * The sources UI model.
              */
             readonly sources: ISources;
+            /**
+             * The kernel sources UI model.
+             */
+            readonly kernelSources: IKernelSources;
             /**
              * The set of threads in stopped state.
              */
@@ -626,7 +748,7 @@ export declare namespace IDebugger {
             /**
              * Signal emitted when the current frame changes.
              */
-            readonly currentFrameChanged: ISignal<IDebugger.Model.ICallstack, IDebugger.IStackFrame>;
+            readonly currentFrameChanged: ISignal<IDebugger.Model.ICallstack, IDebugger.IStackFrame | null>;
             /**
              * Return the current source.
              */
@@ -644,6 +766,31 @@ export declare namespace IDebugger {
              */
             open(): void;
         }
+        /**
+         * The kernel sources UI model.
+         */
+        interface IKernelSources {
+            /**
+             * The kernel source.
+             */
+            kernelSources: IDebugger.KernelSource[] | null;
+            /**
+             * The filter to apply.
+             */
+            filter: string;
+            /**
+             * Signal emitted when the kernel sources have changed.
+             */
+            readonly changed: ISignal<IDebugger.Model.IKernelSources, IDebugger.KernelSource[] | null>;
+            /**
+             * Signal emitted when a kernel source has be opened in the main area.
+             */
+            readonly kernelSourceOpened: ISignal<IDebugger.Model.IKernelSources, IDebugger.Source | null>;
+            /**
+             * Open a source in the main area.
+             */
+            open(source: IDebugger.Source): void;
+        }
         /**
          * The variables UI model.
          */
@@ -660,6 +807,10 @@ export declare namespace IDebugger {
              * Signal emitted when the current variable has been expanded.
              */
             readonly variableExpanded: ISignal<this, IDebugger.IVariable>;
+            /**
+             * Selected variable in the variables explorer.
+             */
+            selectedVariable: IVariableSelection | null;
             /**
              * Expand a variable.
              *
@@ -685,3 +836,7 @@ export declare const IDebuggerSources: Token<IDebugger.ISources>;
  * The debugger configuration token.
  */
 export declare const IDebuggerSidebar: Token<IDebugger.ISidebar>;
+/**
+ * The debugger handler token.
+ */
+export declare const IDebuggerHandler: Token<IDebugger.IHandler>;

package/lib/tokens.js

@@ -17,4 +17,8 @@ export const IDebuggerSources = new Token('@jupyterlab/debugger:IDebuggerSources
  * The debugger configuration token.
  */
 export const IDebuggerSidebar = new Token('@jupyterlab/debugger:IDebuggerSidebar');
+/**
+ * The debugger handler token.
+ */
+export const IDebuggerHandler = new Token('@jupyterlab/debugger:IDebuggerHandler');
 //# sourceMappingURL=tokens.js.map

package/lib/tokens.js.map

@@ -1 +1 @@
-{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAM3D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AA8xB1C;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,KAAK,CAAY,gCAAgC,CAAC,CAAC;AAEhF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,KAAK,CACtC,sCAAsC,CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,KAAK,CACvC,uCAAuC,CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,KAAK,CACvC,uCAAuC,CACxC,CAAC"}
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAM3D,OAAO,EAAsB,KAAK,EAAE,MAAM,mBAAmB,CAAC;AA+9B9D;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,KAAK,CAAY,gCAAgC,CAAC,CAAC;AAEhF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,KAAK,CACtC,sCAAsC,CACvC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,KAAK,CACvC,uCAAuC,CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,KAAK,CACvC,uCAAuC,CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,KAAK,CACvC,uCAAuC,CACxC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlab/debugger",
-  "version": "3.3.0-alpha.6",
+  "version": "3.3.0-beta.0",
   "description": "JupyterLab - Debugger Extension",
   "keywords": [
     "jupyter",
@@ -48,37 +48,37 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyterlab/application": "^3.3.0-alpha.6",
-    "@jupyterlab/apputils": "^3.3.0-alpha.6",
-    "@jupyterlab/cells": "^3.3.0-alpha.6",
-    "@jupyterlab/codeeditor": "^3.3.0-alpha.6",
-    "@jupyterlab/codemirror": "^3.3.0-alpha.6",
-    "@jupyterlab/console": "^3.3.0-alpha.6",
-    "@jupyterlab/coreutils": "^5.3.0-alpha.6",
-    "@jupyterlab/docregistry": "^3.3.0-alpha.6",
-    "@jupyterlab/fileeditor": "^3.3.0-alpha.6",
-    "@jupyterlab/notebook": "^3.3.0-alpha.6",
-    "@jupyterlab/observables": "^4.3.0-alpha.6",
-    "@jupyterlab/rendermime": "^3.3.0-alpha.6",
-    "@jupyterlab/services": "^6.3.0-alpha.6",
-    "@jupyterlab/translation": "^3.3.0-alpha.6",
-    "@jupyterlab/ui-components": "^3.3.0-alpha.6",
+    "@jupyterlab/application": "^3.3.0-beta.0",
+    "@jupyterlab/apputils": "^3.3.0-beta.0",
+    "@jupyterlab/cells": "^3.3.0-beta.0",
+    "@jupyterlab/codeeditor": "^3.3.0-beta.0",
+    "@jupyterlab/codemirror": "^3.3.0-beta.0",
+    "@jupyterlab/console": "^3.3.0-beta.0",
+    "@jupyterlab/coreutils": "^5.3.0-beta.0",
+    "@jupyterlab/docregistry": "^3.3.0-beta.0",
+    "@jupyterlab/fileeditor": "^3.3.0-beta.0",
+    "@jupyterlab/notebook": "^3.3.0-beta.0",
+    "@jupyterlab/observables": "^4.3.0-beta.0",
+    "@jupyterlab/rendermime": "^3.3.0-beta.0",
+    "@jupyterlab/services": "^6.3.0-beta.0",
+    "@jupyterlab/translation": "^3.3.0-beta.0",
+    "@jupyterlab/ui-components": "^3.3.0-beta.0",
     "@lumino/algorithm": "^1.3.3",
     "@lumino/commands": "^1.12.0",
     "@lumino/coreutils": "^1.5.3",
-    "@lumino/datagrid": "^0.28.0",
+    "@lumino/datagrid": "^0.20.0",
     "@lumino/disposable": "^1.4.3",
     "@lumino/messaging": "^1.4.3",
     "@lumino/signaling": "^1.4.3",
-    "@lumino/widgets": "^1.26.0",
+    "@lumino/widgets": "^1.19.0",
+    "@vscode/debugprotocol": "^1.51.0",
     "codemirror": "~5.61.0",
-    "react": "^17.0.1",
-    "vscode-debugprotocol": "^1.37.0"
+    "react": "^17.0.1"
   },
   "devDependencies": {
     "@babel/core": "^7.10.2",
     "@babel/preset-env": "^7.10.2",
-    "@jupyterlab/testutils": "^3.3.0-alpha.6",
+    "@jupyterlab/testutils": "^3.3.0-beta.0",
     "@types/codemirror": "^0.0.109",
     "@types/jest": "^26.0.10",
     "@types/react-dom": "^17.0.0",

package/style/base.css

@@ -8,6 +8,7 @@
 @import './icons.css';
 @import './sidebar.css';
 @import './sources.css';
+@import './kernelSources.css';
 @import './variables.css';
 
 .jp-left-truncated {
@@ -19,3 +20,7 @@
 #jp-debugger .jp-switch-label {
   margin-right: 0px;
 }
+
+.jp-DebuggerBugButton[aria-pressed='true'] path {
+  fill: var(--jp-warn-color0);
+}

package/style/icons/open-kernel-source.svg

@@ -0,0 +1,6 @@
+<svg width="24" height="24" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+    <g class="jp-icon3" fill="#616161">
+        <path d="M5 2H15L20 7V20C20 20.5304 19.7893 21.0391 19.4142 21.4142C19.0391 21.7893 18.5304 22 18 22H5C4.46957 22 3.96086 21.7893 3.58579 21.4142C3.21071 21.0391 3 20.5304 3 20V14H4V16L8 13L4 10V12H3V4C3 3.46957 3.21071 2.96086 3.58579 2.58579C3.96086 2.21071 4.46957 2 5 2ZM12 18H16V16H12V18ZM12 14H18V12H12V14ZM12 10H18V8H12V10ZM10 14C10.5523 14 11 13.5523 11 13C11 12.4477 10.5523 12 10 12C9.44771 12 9 12.4477 9 13C9 13.5523 9.44771 14 10 14Z"/>
+        <path d="M3 12V14H1V13V12H3Z"/>
+    </g>
+</svg>

package/style/icons/pause.svg

@@ -0,0 +1,6 @@
+<svg height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
+    <g class="jp-icon3" fill="#616161">
+        <path d="m 7,6 h 4 V 18 H 7 Z" />
+        <path d="m 13,6 h 4 v 12 h -4 z" />
+    </g>
+</svg>

package/style/icons.css

@@ -25,3 +25,13 @@ button.jp-Button.bp3-button.bp3-minimal.jp-TableView:hover {
 .jp-ViewModeSelected {
   background-color: var(--jp-layout-color1);
 }
+
+/* Pause on exceptions */
+button.jp-Button.jp-mod-minimal.jp-PauseOnExceptions:hover {
+  cursor: pointer;
+  background-color: var(--jp-layout-color1);
+}
+
+button.jp-Button.jp-PauseOnExceptions.lm-mod-toggled {
+  background-color: var(--jp-layout-color1);
+}

package/style/kernelSources.css

@@ -0,0 +1,42 @@
+/*-----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+
+.jp-DebuggerKernelSources {
+  min-height: 50px;
+  margin-top: 3px;
+}
+
+[data-jp-debugger='true'].jp-Editor .jp-mod-readOnly {
+  background: var(--jp-layout-color2);
+  height: 100%;
+}
+
+.jp-DebuggerKernelSources-body [data-jp-debugger='true'].jp-Editor {
+  height: 100%;
+}
+
+.jp-DebuggerKernelSources-body {
+  height: 100%;
+  overflow-y: auto;
+}
+
+.jp-DebuggerKernelSources-header > div > span {
+  overflow: hidden;
+  cursor: pointer;
+  text-overflow: ellipsis;
+  white-space: nowrap;
+  font-size: var(--jp-ui-font-size0);
+  color: var(--jp-ui-font-color1);
+}
+
+.jp-DebuggerKernelSource-filterBox {
+  padding: 0px;
+  flex: 0 0 auto;
+  margin: 0px 0px 0px 0px;
+}
+
+.jp-DebuggerKernelSource-filterBox-hidden {
+  display: none;
+}

package/style/variables.css

@@ -30,6 +30,38 @@
   padding: 5px 0 0 0;
   cursor: pointer;
   color: var(--jp-content-font-color1);
+  display: flex;
+  align-items: center;
+}
+
+.jp-DebuggerVariables-body ul li:hover .jp-DebuggerVariables-renderVariable {
+  display: block;
+}
+
+.jp-DebuggerVariables-body .jp-DebuggerVariables-hspacer {
+  flex: 1 1 auto;
+}
+
+.jp-DebuggerVariables-body .jp-DebuggerVariables-renderVariable {
+  flex: 0 0 auto;
+  border: none;
+  background: none;
+  cursor: pointer;
+  display: none;
+  padding: 0px 8px;
+}
+
+.jp-DebuggerVariables-body .jp-DebuggerVariables-renderVariable:active {
+  transform: scale(1.272) translateX(-4px);
+  overflow: hidden;
+}
+
+.jp-DebuggerVariables-body .jp-DebuggerVariables-renderVariable:hover {
+  background-color: var(--jp-layout-color2);
+}
+
+.jp-DebuggerVariables-body .jp-DebuggerVariables-renderVariable:disabled {
+  cursor: default;
 }
 
 .jp-DebuggerVariables-body ul li > ul {
@@ -84,3 +116,17 @@
 .jp-DebuggerVariables-colorPalette .jp-mod-text {
   color: var(--jp-content-font-color0);
 }
+
+.jp-VariableRenderer-TrustButton[aria-pressed='true'] {
+  box-shadow: inset 0 var(--jp-border-width) 4px
+    rgba(
+      var(--jp-shadow-base-lightness),
+      var(--jp-shadow-base-lightness),
+      var(--jp-shadow-base-lightness),
+      0.6
+    );
+}
+
+.jp-DebuggerRichVariable div[data-mime-type='text/plain'] > pre {
+  white-space: normal;
+}