jupyterlab-pioneer 0.1.4 → 0.1.6

package/lib/index.d.ts

@@ -1,13 +1,19 @@
 import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+import { NotebookPanel } from '@jupyterlab/notebook';
 import { Token } from '@lumino/coreutils';
-import { Router } from './router';
 export declare const IJupyterLabPioneer: Token<IJupyterLabPioneer>;
 export interface IJupyterLabPioneer {
-    router: Router;
+    /**
+     * Send event data to exporters defined in the configuration file.
+     *
+     * @param {NotebookPanel} notebookPanel The notebook panel the extension currently listens to.
+     * @param {Object} eventDetail An object containing event details
+     * @param {Boolean} logNotebookContent A boolean indicating whether to log the entire notebook or not
+     */
+    publishEvent(notebookPanel: NotebookPanel, eventDetail: Object, logNotebookContent?: Boolean): Promise<void>;
 }
 declare class JupyterLabPioneer implements IJupyterLabPioneer {
-    router: Router;
-    constructor();
+    publishEvent(notebookPanel: NotebookPanel, eventDetail: Object, logNotebookContent?: Boolean): Promise<void>;
 }
 declare const plugin: JupyterFrontEndPlugin<JupyterLabPioneer>;
 export default plugin;

package/lib/index.js

@@ -1,13 +1,33 @@
 import { INotebookTracker } from '@jupyterlab/notebook';
 import { Token } from '@lumino/coreutils';
 import { requestAPI } from './handler';
-import { Router } from './router';
+// import { Router } from './router';
 import { producerCollection } from './producer';
 const PLUGIN_ID = 'jupyterlab-pioneer:plugin';
 export const IJupyterLabPioneer = new Token(PLUGIN_ID);
 class JupyterLabPioneer {
-    constructor() {
-        this.router = new Router();
+    async publishEvent(notebookPanel, eventDetail, logNotebookContent) {
+        var _a, _b;
+        if (!notebookPanel) {
+            throw Error('router is listening to a null notebook panel');
+        }
+        // Construct data
+        const requestBody = {
+            eventDetail: eventDetail,
+            notebookState: {
+                sessionID: (_a = notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.sessionContext.session) === null || _a === void 0 ? void 0 : _a.id,
+                notebookPath: notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.context.path,
+                notebookContent: logNotebookContent
+                    ? (_b = notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.model) === null || _b === void 0 ? void 0 : _b.toJSON()
+                    : null // decide whether to log the entire notebook
+            }
+        };
+        // Send data to exporters
+        const response = await requestAPI('export', {
+            method: 'POST',
+            body: JSON.stringify(requestBody)
+        });
+        console.log(response);
     }
 }
 const plugin = {
@@ -21,8 +41,8 @@ const plugin = {
         const config = await requestAPI('config');
         const pioneer = new JupyterLabPioneer();
         notebookTracker.widgetAdded.connect(async (_, notebookPanel) => {
-            await notebookPanel.sessionContext.ready; // wait until session id is created
-            await pioneer.router.loadNotebookPanel(notebookPanel);
+            await notebookPanel.revealed;
+            await notebookPanel.sessionContext.ready;
             producerCollection.forEach(producer => {
                 if (config.activeEvents.includes(producer.id)) {
                     new producer().listen(notebookPanel, pioneer, config.logNotebookContentEvents.includes(producer.id));

package/lib/producer.d.ts

@@ -3,7 +3,7 @@ import { IJupyterLabPioneer } from './index';
 export declare class NotebookOpenEventProducer {
     static id: string;
     private produced;
-    listen(_: NotebookPanel, pioneer: IJupyterLabPioneer, logNotebookContentEvent: boolean): Promise<void>;
+    listen(notebookPanel: NotebookPanel, pioneer: IJupyterLabPioneer, logNotebookContentEvent: boolean): Promise<void>;
 }
 export declare class NotebookScrollProducer {
     static id: string;
@@ -16,7 +16,7 @@ export declare class NotebookVisibleEventProducer {
 }
 export declare class NotebookHiddenEventProducer {
     static id: string;
-    listen(_: NotebookPanel, pioneer: IJupyterLabPioneer, logNotebookContentEvent: boolean): void;
+    listen(notebookPanel: NotebookPanel, pioneer: IJupyterLabPioneer, logNotebookContentEvent: boolean): void;
 }
 export declare class ClipboardCopyEventProducer {
     static id: string;
@@ -40,7 +40,7 @@ export declare class NotebookSaveEventProducer {
 }
 export declare class CellExecuteEventProducer {
     static id: string;
-    listen(_: any, pioneer: IJupyterLabPioneer, logNotebookContentEvent: boolean): void;
+    listen(notebookPanel: NotebookPanel, pioneer: IJupyterLabPioneer, logNotebookContentEvent: boolean): void;
 }
 export declare class CellAddEventProducer {
     static id: string;

package/lib/producer.js

@@ -4,7 +4,7 @@ class NotebookOpenEventProducer {
     constructor() {
         this.produced = false;
     }
-    async listen(_, pioneer, logNotebookContentEvent) {
+    async listen(notebookPanel, pioneer, logNotebookContentEvent) {
         if (!this.produced) {
             const event = {
                 eventName: NotebookOpenEventProducer.id,
@@ -13,7 +13,7 @@ class NotebookOpenEventProducer {
                     environ: await requestAPI('environ')
                 }
             };
-            await pioneer.router.publishEvent(event, logNotebookContentEvent);
+            await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
             this.produced = true;
         }
     }
@@ -54,7 +54,7 @@ class NotebookScrollProducer {
                     cells: getVisibleCells(notebookPanel)
                 }
             };
-            await pioneer.router.publishEvent(event, logNotebookContentEvent);
+            await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
         });
     }
 }
@@ -63,7 +63,7 @@ export { NotebookScrollProducer };
 class NotebookVisibleEventProducer {
     listen(notebookPanel, pioneer, logNotebookContentEvent) {
         document.addEventListener('visibilitychange', async () => {
-            if (document.visibilityState === 'visible') {
+            if (document.visibilityState === 'visible' && document.contains(notebookPanel.node)) {
                 const event = {
                     eventName: NotebookVisibleEventProducer.id,
                     eventTime: Date.now(),
@@ -71,7 +71,7 @@ class NotebookVisibleEventProducer {
                         cells: getVisibleCells(notebookPanel)
                     }
                 };
-                await pioneer.router.publishEvent(event, logNotebookContentEvent);
+                await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
             }
         });
     }
@@ -79,14 +79,15 @@ class NotebookVisibleEventProducer {
 NotebookVisibleEventProducer.id = 'NotebookVisibleEvent';
 export { NotebookVisibleEventProducer };
 class NotebookHiddenEventProducer {
-    listen(_, pioneer, logNotebookContentEvent) {
+    listen(notebookPanel, pioneer, logNotebookContentEvent) {
         document.addEventListener('visibilitychange', async (e) => {
-            if (document.visibilityState === 'hidden') {
+            if (document.visibilityState === 'hidden' && document.contains(notebookPanel.node)) {
                 const event = {
                     eventName: NotebookHiddenEventProducer.id,
-                    eventTime: Date.now()
+                    eventTime: Date.now(),
+                    eventInfo: null
                 };
-                await pioneer.router.publishEvent(event, logNotebookContentEvent);
+                await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
             }
         });
     }
@@ -110,7 +111,7 @@ class ClipboardCopyEventProducer {
                     selection: text
                 }
             };
-            await pioneer.router.publishEvent(event, logNotebookContentEvent);
+            await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
         });
     }
 }
@@ -133,7 +134,7 @@ class ClipboardCutEventProducer {
                     selection: text
                 }
             };
-            await pioneer.router.publishEvent(event, logNotebookContentEvent);
+            await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
         });
     }
 }
@@ -156,7 +157,7 @@ class ClipboardPasteEventProducer {
                     selection: text
                 }
             };
-            await pioneer.router.publishEvent(event, logNotebookContentEvent);
+            await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
         });
     }
 }
@@ -177,7 +178,7 @@ class ActiveCellChangeEventProducer {
                         cells: [activatedCell] // activated cell
                     }
                 };
-                await pioneer.router.publishEvent(event, logNotebookContentEvent);
+                await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
             }
         });
     }
@@ -190,9 +191,10 @@ class NotebookSaveEventProducer {
             if (saveState.match('completed')) {
                 const event = {
                     eventName: NotebookSaveEventProducer.id,
-                    eventTime: Date.now()
+                    eventTime: Date.now(),
+                    eventInfo: null
                 };
-                await pioneer.router.publishEvent(event, logNotebookContentEvent);
+                await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
             }
         });
     }
@@ -200,22 +202,24 @@ class NotebookSaveEventProducer {
 NotebookSaveEventProducer.id = 'NotebookSaveEvent';
 export { NotebookSaveEventProducer };
 class CellExecuteEventProducer {
-    listen(_, pioneer, logNotebookContentEvent) {
+    listen(notebookPanel, pioneer, logNotebookContentEvent) {
         NotebookActions.executed.connect(async (_, args) => {
-            const executedCell = {
-                id: args.cell.model.id,
-                index: args.notebook.widgets.findIndex(value => value == args.cell)
-            };
-            const event = {
-                eventName: CellExecuteEventProducer.id,
-                eventTime: Date.now(),
-                eventInfo: {
-                    cells: [executedCell],
-                    success: args.success,
-                    kernelError: args.success ? null : args.error
-                }
-            };
-            await pioneer.router.publishEvent(event, logNotebookContentEvent);
+            if (notebookPanel.content === args.notebook) {
+                const executedCell = {
+                    id: args.cell.model.id,
+                    index: args.notebook.widgets.findIndex(value => value == args.cell)
+                };
+                const event = {
+                    eventName: CellExecuteEventProducer.id,
+                    eventTime: Date.now(),
+                    eventInfo: {
+                        cells: [executedCell],
+                        success: args.success,
+                        kernelError: args.success ? null : args.error
+                    }
+                };
+                await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
+            }
         });
     }
 }
@@ -237,7 +241,7 @@ class CellAddEventProducer {
                         cells: [addedCell]
                     }
                 };
-                await pioneer.router.publishEvent(event, logNotebookContentEvent);
+                await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
             }
         });
     }
@@ -260,7 +264,7 @@ class CellRemoveEventProducer {
                         cells: [removedCell]
                     }
                 };
-                await pioneer.router.publishEvent(event, logNotebookContentEvent);
+                await pioneer.publishEvent(notebookPanel, event, logNotebookContentEvent);
             }
         });
     }

package/lib/router.d.ts

@@ -1,18 +1,11 @@
 import { NotebookPanel } from '@jupyterlab/notebook';
 export declare class Router {
-    private sessionID?;
-    private notebookPanel?;
-    /**
-     * Load notebookPanel.
-     *
-     * @param {NotebookPanel} notebookPanel
-     */
-    loadNotebookPanel(notebookPanel: NotebookPanel): Promise<void>;
     /**
      * Send event data to exporters defined in the configuration file.
      *
+     * @param {NotebookPanel} notebookPanel The notebook panel the extension currently listens to.
      * @param {Object} eventDetail An object containing event details
      * @param {Boolean} logNotebookContent A boolean indicating whether to log the entire notebook or not
      */
-    publishEvent(eventDetail: Object, logNotebookContent?: Boolean): Promise<void>;
+    publishEvent(notebookPanel: NotebookPanel, eventDetail: Object, logNotebookContent?: Boolean): Promise<void>;
 }

package/lib/router.js

@@ -1,37 +1,25 @@
 import { requestAPI } from './handler';
 export class Router {
-    /**
-     * Load notebookPanel.
-     *
-     * @param {NotebookPanel} notebookPanel
-     */
-    async loadNotebookPanel(notebookPanel) {
-        this.notebookPanel = notebookPanel;
-    }
     /**
      * Send event data to exporters defined in the configuration file.
      *
+     * @param {NotebookPanel} notebookPanel The notebook panel the extension currently listens to.
      * @param {Object} eventDetail An object containing event details
      * @param {Boolean} logNotebookContent A boolean indicating whether to log the entire notebook or not
      */
-    async publishEvent(eventDetail, logNotebookContent) {
-        var _a, _b, _c, _d, _e, _f, _g;
-        if (!this.notebookPanel) {
-            throw Error('router needs to load notebookPanel first.');
-        }
-        // Check if session id received is equal to the stored session id
-        if (!this.sessionID ||
-            this.sessionID !== ((_b = (_a = this.notebookPanel) === null || _a === void 0 ? void 0 : _a.sessionContext.session) === null || _b === void 0 ? void 0 : _b.id)) {
-            this.sessionID = (_d = (_c = this.notebookPanel) === null || _c === void 0 ? void 0 : _c.sessionContext.session) === null || _d === void 0 ? void 0 : _d.id;
+    async publishEvent(notebookPanel, eventDetail, logNotebookContent) {
+        var _a, _b;
+        if (!notebookPanel) {
+            throw Error('router is listening to a null notebook panel');
         }
         // Construct data
         const requestBody = {
             eventDetail: eventDetail,
             notebookState: {
-                sessionID: this.sessionID,
-                notebookPath: (_e = this.notebookPanel) === null || _e === void 0 ? void 0 : _e.context.path,
+                sessionID: (_a = notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.sessionContext.session) === null || _a === void 0 ? void 0 : _a.id,
+                notebookPath: notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.context.path,
                 notebookContent: logNotebookContent
-                    ? (_g = (_f = this.notebookPanel) === null || _f === void 0 ? void 0 : _f.model) === null || _g === void 0 ? void 0 : _g.toJSON()
+                    ? (_b = notebookPanel === null || notebookPanel === void 0 ? void 0 : notebookPanel.model) === null || _b === void 0 ? void 0 : _b.toJSON()
                     : null // decide whether to log the entire notebook
             }
         };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jupyterlab-pioneer",
-    "version": "0.1.4",
+    "version": "0.1.6",
     "description": "A JupyterLab extension.",
     "keywords": [
         "jupyter",