Script editor debugger - experimental

Makefile

@@ -83,6 +83,7 @@ uninstall-src: # Uninstalls source extensions if they're still installed
 	- jupyter labextension uninstall --no-build @elyra/python-editor-extension
 	- jupyter labextension uninstall --no-build @elyra/r-editor-extension
 	- jupyter labextension uninstall --no-build @elyra/code-viewer-extension
+	- jupyter labextension uninstall --no-build @elyra/script-debugger-extension
 	- jupyter labextension unlink --no-build @elyra/pipeline-services
 	- jupyter labextension unlink --no-build @elyra/pipeline-editor
 

create-release.py

@@ -597,14 +597,14 @@ def prepare_extensions_release() -> None:
             f"See https://elyra.readthedocs.io/en/{config.new_version}/user_guide/pipelines.html",
         ),
         "elyra-python-editor-extension": SimpleNamespace(
-            packages=["python-editor-extension", "metadata-extension", "theme-extension"],
+            packages=["python-editor-extension", "metadata-extension", "theme-extension", "script-debugger-extension"],
             description=f"The Python Script editor extension contains support for Python files, "
             f"which can take advantage of the Hybrid Runtime Support enabling users to "
             f"locally edit .py scripts and execute them against local or cloud-based resources."
             f"See https://elyra.readthedocs.io/en/{config.new_version}/user_guide/enhanced-script-support.html",
         ),
         "elyra-r-editor-extension": SimpleNamespace(
-            packages=["r-editor-extension", "metadata-extension", "theme-extension"],
+            packages=["r-editor-extension", "metadata-extension", "theme-extension", "script-debugger-extension"],
             description=f"The R Script editor extension contains support for R files, which can take "
             f"advantage of the Hybrid Runtime Support enabling users to locally edit .R scripts "
             f"and execute them against local or cloud-based resources."

packages/python-editor/package.json

@@ -47,7 +47,6 @@
     "@elyra/ui-components": "3.11.0-dev",
     "@jupyterlab/application": "^3.4.0",
     "@jupyterlab/apputils": "^3.4.0",
-    "@jupyterlab/builder": "^3.4.0",
     "@jupyterlab/codeeditor": "^3.4.0",
     "@jupyterlab/docregistry": "^3.4.0",
     "@jupyterlab/filebrowser": "^3.4.0",
@@ -59,6 +58,7 @@
     "@lumino/coreutils": "^1.5.6"
   },
   "devDependencies": {
+    "@jupyterlab/builder": "^3.4.0",
     "rimraf": "^3.0.2",
     "typescript": "~4.1.3"
   },

packages/script-debugger/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@elyra/script-debugger-extension",
+  "version": "3.10.0-dev",
+  "description": "JupyterLab extension - visual debugging support for script editors",
+  "keywords": [
+    "jupyter",
+    "jupyterlab",
+    "jupyterlab-extension"
+  ],
+  "homepage": "https://github.com/elyra-ai/elyra",
+  "bugs": {
+    "url": "https://github.com/elyra-ai/elyra/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/elyra-ai/elyra/"
+  },
+  "license": "Apache-2.0",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "style": "style/index.css",
+  "files": [
+    "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
+    "src/**/*.{ts,tsx}",
+    "style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}"
+  ],
+  "scripts": {
+    "build": "jlpm run build:lib && jlpm run build:labextension:dev",
+    "build:prod": "jlpm run build:lib && jlpm run build:labextension",
+    "build:lib": "tsc",
+    "build:labextension": "jupyter labextension build .",
+    "build:labextension:dev": "jupyter labextension build --development True .",
+    "clean": "rimraf lib tsconfig.tsbuildinfo ../../dist/labextensions/@elyra/script-debugger-extension",
+    "lab:dev": "jupyter labextension develop --overwrite ../../dist/labextensions/@elyra/script-debugger-extension",
+    "dist": "npm pack .",
+    "prepare": "npm run build",
+    "watch": "run-p watch:src watch:labextension",
+    "watch:src": "tsc -w",
+    "watch:labextension": "jupyter labextension watch .",
+    "lab:install": "jupyter labextension install --no-build",
+    "lab:uninstall": "jupyter labextension uninstall --no-build",
+    "link:dev": "yarn link @jupyterlab/builder",
+    "unlink:dev": "yarn unlink @jupyterlab/builder"
+  },
+  "dependencies": {
+    "@elyra/script-editor": "3.11.0-dev",
+    "@jupyterlab/application": "^3.4.0",
+    "@jupyterlab/debugger": "^3.4.0",
+    "@jupyterlab/fileeditor": "^3.4.0",
+    "@jupyterlab/services": "^6.4.0",
+    "@lumino/widgets": "^1.19.0"
+  },
+  "devDependencies": {
+    "@jupyterlab/builder": "^3.4.0",
+    "rimraf": "^3.0.2",
+    "typescript": "~4.1.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "jupyterlab": {
+    "extension": true,
+    "outputDir": "../../dist/labextensions/@elyra/script-debugger-extension"
+  }
+}

packages/script-debugger/src/index.ts

@@ -0,0 +1,188 @@
+/*
+ * Copyright 2018-2022 Elyra Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { ScriptEditor } from '@elyra/script-editor';
+import {
+  ILabShell,
+  JupyterFrontEnd,
+  JupyterFrontEndPlugin
+} from '@jupyterlab/application';
+import { Debugger, IDebugger } from '@jupyterlab/debugger';
+import { IEditorTracker } from '@jupyterlab/fileeditor';
+import { KernelManager, Session, SessionManager } from '@jupyterlab/services';
+import { Widget } from '@lumino/widgets';
+
+/**
+ * Debugger plugin.
+ * Adapted from JupyterLab debugger extension.
+ * A plugin that provides visual debugging support for script editors.
+ */
+const scriptEditorDebuggerExtension: JupyterFrontEndPlugin<void> = {
+  id: 'elyra-script-debugger',
+  autoStart: true,
+  requires: [IDebugger, IEditorTracker],
+  optional: [ILabShell],
+  activate: (
+    app: JupyterFrontEnd,
+    debug: IDebugger,
+    editorTracker: IEditorTracker,
+    labShell: ILabShell | null
+  ) => {
+    console.log('Elyra - script-debugger extension is activated!');
+    const handler = new Debugger.Handler({
+      type: 'file',
+      shell: app.shell,
+      service: debug
+    });
+
+    const activeSessions: { [id: string]: Session.ISessionConnection } = {};
+    const kernelManager = new KernelManager();
+    const sessionManager = new SessionManager({
+      kernelManager: kernelManager
+    });
+
+    const updateDebugger = async (widget: ScriptEditor): Promise<void> => {
+      const kernelSelection = (widget as ScriptEditor).kernelSelection;
+      const debuggerAvailable = await widget.isDebuggerAvailable(
+        kernelSelection
+      );
+      // console.log(
+      //   `#####updateDebugger kernelSelection= ' ${kernelSelection} \n debuggerAvailable= ' ${!!debuggerAvailable}`
+      // );
+      if (!debuggerAvailable) {
+        return;
+      }
+
+      const sessions = app.serviceManager.sessions;
+      try {
+        const path = widget.context.path;
+        let sessionModel = await sessions.findByPath(path);
+        if (!sessionModel) {
+          // Start a kernel session for the selected kernel supporting debug
+          const sessionConnection = await startSession(kernelSelection, path);
+          sessionModel = await sessions.findByPath(path);
+          if (sessionConnection && sessionModel) {
+            activeSessions[sessionModel.id] = sessionConnection;
+          }
+        }
+
+        if (sessionModel) {
+          let sessionConnection: Session.ISessionConnection | null =
+            activeSessions[sessionModel.id];
+          if (!sessionConnection) {
+            // Use `connectTo` only if the session does not exist.
+            // `connectTo` sends a kernel_info_request on the shell
+            // channel, which blocks the debug session restore when waiting
+            // for the kernel to be ready
+            sessionConnection = sessions.connectTo({ model: sessionModel });
+            activeSessions[sessionModel.id] = sessionConnection;
+          }
+          if (sessionModel.kernel?.name !== kernelSelection) {
+            // New kernel selection detected, restart session connection for new kernel
+            await shutdownSession(sessionConnection);
+
+            sessionConnection = await startSession(kernelSelection, path);
+            sessionModel = await sessions.findByPath(path);
+            if (sessionConnection && sessionModel) {
+              activeSessions[sessionModel.id] = sessionConnection;
+            }
+          }
+          await handler.update(widget, sessionConnection);
+          app.commands.notifyCommandChanged();
+        }
+      } catch (e) {
+        console.log('Exception: shutdown = ' + JSON.stringify(e));
+      }
+    };
+
+    // Use a weakmap to track the callback function used by signal listeners so that the object can be cleared by gargabe collector when no longer in use, avoiding memory leaks
+    // Key: ScriptEditor widget
+    // Value: instance of updateDebugger function
+    const callbackControl = new WeakMap<ScriptEditor, () => Promise<void>>();
+
+    const update = async (widget: Widget | null): Promise<void> => {
+      if (widget instanceof ScriptEditor) {
+        let callbackFn = callbackControl.get(widget);
+        if (!callbackFn) {
+          callbackFn = (): Promise<void> => updateDebugger(widget);
+          callbackControl.set(widget, callbackFn);
+        }
+        updateDebugger(widget);
+
+        // Listen to possible kernel selection changes
+        widget.kernelSelectionChanged.disconnect(callbackFn);
+        widget.kernelSelectionChanged.connect(callbackFn);
+      }
+    };
+
+    if (labShell) {
+      // Listen to main area's current focus changes.
+      labShell.currentChanged.connect((_, widget) => {
+        return update(widget.newValue);
+      });
+    }
+
+    if (editorTracker) {
+      // Listen to script editor's current instance changes.
+      editorTracker.currentChanged.connect((_, widget) => {
+        console.log('editorTracker.currentChanged#######');
+        return update(widget);
+      });
+      // listen to script editor's widget updates
+      // editorTracker.widgetUpdated.connect((_, widget) => { console.log('editorTracker.widgetUpdated#######'); return update(widget); });
+    }
+
+    const startSession = async (
+      kernelSelection: string,
+      path: string
+    ): Promise<Session.ISessionConnection | null> => {
+      const options: Session.ISessionOptions = {
+        kernel: {
+          name: kernelSelection
+        },
+        path: path,
+        type: 'file',
+        name: path
+      };
+      let sessionConnection;
+      try {
+        sessionConnection = await sessionManager.startNew(options);
+        sessionConnection.setPath(path);
+        console.log(
+          `Kernel session started for ${path} with selected ${kernelSelection} kernel.`
+        );
+      } catch (e) {
+        console.log('Exception: start session = ' + JSON.stringify(e));
+        sessionConnection = null;
+      }
+      return sessionConnection;
+    };
+
+    const shutdownSession = async (
+      sessionConnection: Session.ISessionConnection
+    ): Promise<void> => {
+      try {
+        const kernelName = sessionConnection.kernel?.name;
+        await sessionConnection.shutdown();
+        console.log(`${kernelName} kernel shut down.`);
+      } catch (e) {
+        console.log('Exception: shutdown = ' + JSON.stringify(e));
+      }
+    };
+  }
+};
+
+export default scriptEditorDebuggerExtension;

packages/script-debugger/style/index.css

@@ -0,0 +1,15 @@
+/*
+ * Copyright 2018-2022 Elyra Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */

packages/script-debugger/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "lib"
+  },
+  "include": ["src"]
+}

packages/script-editor/package.json

@@ -44,6 +44,7 @@
     "@jupyterlab/rendermime": "^3.4.0",
     "@jupyterlab/services": "^6.4.0",
     "@jupyterlab/ui-components": "^3.4.0",
+    "@lumino/signaling": "^1.4.3",
     "@lumino/widgets": "^1.19.0",
     "react": "^17.0.1",
     "react-dom": "^17.0.1"