Address #13

Update stickyland map when a user closes notebook tabs

Signed-off-by: Jay Wang <[email protected]>

Author: xiaohk

.gitignore

@@ -115,3 +115,4 @@ dmypy.json
 # OSX files
 .DS_Store
 lite/
+.yarn/

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

package.json

@@ -60,7 +60,8 @@
     "eslint-config-prettier": "^6.15.0",
     "eslint-plugin-prettier": "^3.1.4",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.1.1"
+    "prettier": "^2.1.1",
+    "typescript": "4.3.5"
   },
   "sideEffects": [
     "style/*.css",

src/button.ts

@@ -1,17 +1,58 @@
+import { JupyterFrontEnd } from '@jupyterlab/application';
 import { ToolbarButton } from '@jupyterlab/apputils';
+import { IDocumentManager } from '@jupyterlab/docmanager';
 import { IDisposable, DisposableDelegate } from '@lumino/disposable';
 import { DocumentRegistry } from '@jupyterlab/docregistry';
-import { NotebookPanel, INotebookModel } from '@jupyterlab/notebook';
+import { Widget } from '@lumino/widgets';
+import {
+  NotebookPanel,
+  INotebookModel,
+  INotebookTracker
+} from '@jupyterlab/notebook';
 import { StickyLand } from './stickyland';
 
 export class ButtonExtension
   implements DocumentRegistry.IWidgetExtension<NotebookPanel, INotebookModel>
 {
   // This maps each stickyLand object to a notebook title
-  stickyLandMap: Map<string, StickyLand> | null;
+  stickyLandMap: Map<string, StickyLand>;
+  shell: JupyterFrontEnd.IShell;
+  notebookTracker: INotebookTracker;
+  documentManager: IDocumentManager;
 
-  constructor() {
-    this.stickyLandMap = new Map();
+  constructor(
+    shell: JupyterFrontEnd.IShell,
+    notebookTracker: INotebookTracker,
+    documentManager: IDocumentManager
+  ) {
+    this.shell = shell;
+    this.stickyLandMap = new Map<string, StickyLand>();
+    this.notebookTracker = notebookTracker;
+    this.documentManager = documentManager;
+
+    // Listen to the notebook tracker to update stickyLandMap when a user closes
+    // a notebook
+    this.notebookTracker.currentChanged.connect((sender, panel) => {
+      setTimeout(() => {
+        const widgetIter = this.shell.widgets();
+        const openPaths: Set<string> = new Set();
+        let nextWidget = widgetIter.next();
+        while (nextWidget !== undefined) {
+          const context = this.documentManager.contextForWidget(nextWidget);
+          if (context !== undefined) {
+            openPaths.add(context.path);
+          }
+          nextWidget = widgetIter.next();
+        }
+
+        // Remove stickylands where their associated notebooks are closed
+        for (const path of this.stickyLandMap.keys()) {
+          if (!openPaths.has(path)) {
+            this.stickyLandMap.delete(path);
+          }
+        }
+      }, 500);
+    });
   }
 
   createNew(

src/index.ts

@@ -1,14 +1,24 @@
 import { JupyterFrontEnd } from '@jupyterlab/application';
 import { ICommandPalette } from '@jupyterlab/apputils';
+import { IDocumentManager } from '@jupyterlab/docmanager';
 import { ButtonExtension } from './button';
+import { INotebookTracker, NotebookPanel } from '@jupyterlab/notebook';
 
 const plugin = {
   id: 'jupyterlab_stickyland',
   autoStart: true,
-  requires: [ICommandPalette],
-  activate: function (app: JupyterFrontEnd) {
+  requires: [INotebookTracker, IDocumentManager],
+  activate: function (
+    app: JupyterFrontEnd,
+    notebookTracker: INotebookTracker,
+    documentManager: IDocumentManager
+  ) {
     console.log('Activating StickyLand.');
-    app.docRegistry.addWidgetExtension('Notebook', new ButtonExtension());
+
+    app.docRegistry.addWidgetExtension(
+      'Notebook',
+      new ButtonExtension(app.shell, notebookTracker, documentManager)
+    );
   }
 };
 

tsconfig.json

@@ -17,7 +17,7 @@
     "rootDir": "src",
     "strict": true,
     "strictNullChecks": true,
-    "target": "es2017",
+    "target": "ESNext",
     "types": []
   },
   "include": ["src/*"]