Running Sidebar Extension API

CONTRIBUTING.md

@@ -44,13 +44,14 @@ a keyboard shortcut or automatically on save.
 ## Submitting a Pull Request Contribution
 
 Generally, an issue should be opened describing a piece of proposed work and the
-issues it solves before a pull request is opened. 
+issues it solves before a pull request is opened.
 
 ### Issue Management
-Opening an issue lets community members participate in the design discussion, 
-makes others aware of work being done, and sets the stage for a fruitful community 
-interaction. A pull request should reference the issue it is addressing. Once the 
-pull request is merged, the issue related to it will also be closed. If there is 
+
+Opening an issue lets community members participate in the design discussion,
+makes others aware of work being done, and sets the stage for a fruitful community
+interaction. A pull request should reference the issue it is addressing. Once the
+pull request is merged, the issue related to it will also be closed. If there is
 additional discussion around implemementation the issue may be re-opened. Once 30 days
 have passed with no additional discussion, the [lock bot](https://github.com/apps/lock) will lock the issue. If
 additional discussion is desired, or if the pull request doesn't fully address the

packages/running-extension/package.json

@@ -36,7 +36,10 @@
   },
   "dependencies": {
     "@jupyterlab/application": "^1.1.0-alpha.1",
-    "@jupyterlab/running": "^1.1.0-alpha.1"
+    "@jupyterlab/coreutils": "^3.1.0-alpha.1",
+    "@jupyterlab/running": "^1.1.0-alpha.1",
+    "@jupyterlab/services": "^4.1.0-alpha.1",
+    "@phosphor/algorithm": "^1.1.3"
   },
   "devDependencies": {
     "rimraf": "~2.6.2",

packages/running-extension/src/index.ts

@@ -6,15 +6,39 @@ import {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
 } from '@jupyterlab/application';
+import {
+  IRunningSessions,
+  IRunningSessionManagers,
+  RunningSessionManagers,
+  RunningSessions
+} from '@jupyterlab/running';
+
+import { Session } from '@jupyterlab/services';
+import { PathExt } from '@jupyterlab/coreutils';
+import { toArray } from '@phosphor/algorithm';
+
+/**
+ * The class name added to a notebook icon.
+ */
+const NOTEBOOK_ICON_CLASS = 'jp-mod-notebook';
+
+/**
+ * The class name added to a console icon.
+ */
+const CONSOLE_ICON_CLASS = 'jp-mod-console';
 
-import { RunningSessions } from '@jupyterlab/running';
+/**
+ * The class name added to a file icon.
+ */
+const FILE_ICON_CLASS = 'jp-mod-file';
 
 /**
  * The default running sessions extension.
  */
-const plugin: JupyterFrontEndPlugin<void> = {
+const plugin: JupyterFrontEndPlugin<IRunningSessionManagers> = {
   activate,
   id: '@jupyterlab/running-extension:plugin',
+  provides: IRunningSessionManagers,
   optional: [ILayoutRestorer],
   autoStart: true
 };
@@ -30,8 +54,9 @@ export default plugin;
 function activate(
   app: JupyterFrontEnd,
   restorer: ILayoutRestorer | null
-): void {
-  let running = new RunningSessions({ manager: app.serviceManager });
+): IRunningSessionManagers {
+  let runningSessionManagers = new RunningSessionManagers();
+  let running = new RunningSessions(runningSessionManagers);
   running.id = 'jp-running-sessions';
   running.title.iconClass = 'jp-RunningIcon jp-SideBar-tabIcon';
   running.title.caption = 'Running Terminals and Kernels';
@@ -42,21 +67,77 @@ function activate(
   if (restorer) {
     restorer.add(running, 'running-sessions');
   }
+  addKernelRunningSessionManager(runningSessionManagers, app);
+  // Rank has been chosen somewhat arbitrarily to give priority to the running
+  // sessions widget in the sidebar.
+  app.shell.add(running, 'left', { rank: 200 });
 
-  running.sessionOpenRequested.connect((sender, model) => {
-    let path = model.path;
-    if (model.type.toLowerCase() === 'console') {
-      void app.commands.execute('console:open', { path });
-    } else {
-      void app.commands.execute('docmanager:open', { path });
-    }
-  });
+  return runningSessionManagers;
+}
 
-  running.terminalOpenRequested.connect((sender, model) => {
-    void app.commands.execute('terminal:open', { name: model.name });
+/**
+ * Add the running kernel manager (notebooks & consoles) to the running panel.
+ */
+function addKernelRunningSessionManager(
+  managers: IRunningSessionManagers,
+  app: JupyterFrontEnd
+) {
+  let manager = app.serviceManager.sessions;
+  function filterSessions(m: Session.IModel) {
+    return !!(
+      (m.name || PathExt.basename(m.path)).indexOf('.') !== -1 || m.name
+    );
+  }
+
+  managers.add({
+    name: 'Kernel',
+    running: () => {
+      return toArray(manager.running())
+        .filter(filterSessions)
+        .map(model => new RunningKernel(model));
+    },
+    shutdownAll: () => manager.shutdownAll(),
+    refreshRunning: () => manager.refreshRunning(),
+    runningChanged: manager.runningChanged
   });
 
-  // Rank has been chosen somewhat arbitrarily to give priority to the running
-  // sessions widget in the sidebar.
-  app.shell.add(running, 'left', { rank: 200 });
+  class RunningKernel implements IRunningSessions.IRunningItem {
+    constructor(model: Session.IModel) {
+      this._model = model;
+    }
+    open() {
+      let { path, type } = this._model;
+      if (type.toLowerCase() === 'console') {
+        void app.commands.execute('console:open', { path });
+      } else {
+        void app.commands.execute('docmanager:open', { path });
+      }
+    }
+    shutdown() {
+      return manager.shutdown(this._model.id);
+    }
+    iconClass() {
+      let { name, path, type } = this._model;
+      if ((name || PathExt.basename(path)).indexOf('.ipynb') !== -1) {
+        return NOTEBOOK_ICON_CLASS;
+      } else if (type.toLowerCase() === 'console') {
+        return CONSOLE_ICON_CLASS;
+      }
+      return FILE_ICON_CLASS;
+    }
+    label() {
+      return this._model.name || PathExt.basename(this._model.path);
+    }
+    labelTitle() {
+      let { kernel, path } = this._model;
+      let kernelName = kernel.name;
+      if (manager.specs) {
+        const spec = manager.specs.kernelspecs[kernelName];
+        kernelName = spec ? spec.display_name : 'unknown';
+      }
+      return `Path: ${path}\nKernel: ${kernelName}`;
+    }
+
+    private _model: Session.IModel;
+  }
 }

packages/running-extension/tsconfig.json

@@ -9,8 +9,14 @@
     {
       "path": "../application"
     },
+    {
+      "path": "../coreutils"
+    },
     {
       "path": "../running"
+    },
+    {
+      "path": "../services"
     }
   ]
 }

packages/running/package.json

@@ -39,6 +39,8 @@
     "@jupyterlab/coreutils": "^3.1.0-alpha.1",
     "@jupyterlab/services": "^4.1.0-alpha.1",
     "@phosphor/algorithm": "^1.1.3",
+    "@phosphor/coreutils": "^1.3.1",
+    "@phosphor/disposable": "^1.2.0",
     "@phosphor/signaling": "^1.2.3",
     "react": "~16.8.4"
   },