Moved event logger handler up the stack.

jupyter-server · Oct 31, 2023 · 03ad172 · 03ad172
1 parent 867d2ea
commit 03ad172
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 20 deletions.
diff --git a/src/index.tsx b/src/index.tsx
@@ -72,7 +72,7 @@ const advancedOptions: JupyterFrontEndPlugin<Scheduler.IAdvancedOptions> = {
 const telemetryHandler = async (
   eventLog: Scheduler.IEventLog
 ): Promise<void> => {
-  console.log(JSON.stringify(eventLog, undefined, 4));
+  // console.log(JSON.stringify(eventLog, undefined, 4));
 };
 
 const telemetry: JupyterFrontEndPlugin<Scheduler.TelemetryHandler> = {
@@ -182,13 +182,26 @@ async function activatePlugin(
   let mainAreaWidget: MainAreaWidget<NotebookJobsPanel> | undefined;
   let jobsPanel: NotebookJobsPanel | undefined;
 
+  const eventLogger: Scheduler.EventLogger = (eventName) => {
+    if (!eventName) {
+      return;
+    }
+    const eventLog = {
+      body: {
+        name: `org.jupyter.jupyter-scheduler.${eventName}`
+      },
+      timestamp: new Date()
+    };
+    telemetryHandler(eventLog).then();
+  }
+
   const showJobsPanel = async (data: IJobsModel) => {
     if (!mainAreaWidget || mainAreaWidget.isDisposed) {
       // Create new jobs panel widget
       jobsPanel = new NotebookJobsPanel({
         app,
         translator,
-        telemetryHandler,
+        eventLogger,
         advancedOptions: advancedOptions
       });
       // Create new main area widget
@@ -223,13 +236,19 @@ async function activatePlugin(
   // Commands
 
   commands.addCommand(CommandIDs.showNotebookJobs, {
-    execute: async args => showJobsPanel(args as IJobsModel),
+    execute: async args => {
+      if(args['launcher']){
+        eventLogger("launcher.show-jobs")
+      }
+      showJobsPanel(args as IJobsModel)
+    },
     label: trans.__('Notebook Jobs'),
     icon: eventNoteIcon
   });
 
   commands.addCommand(CommandIDs.createJobFileBrowser, {
     execute: async () => {
+      eventLogger("file-browser.create-job");
       const widget = fileBrowserTracker.currentWidget;
       const filePath = getSelectedFilePath(widget) ?? '';
 
@@ -252,6 +271,7 @@ async function activatePlugin(
 
   commands.addCommand(CommandIDs.createJobCurrentNotebook, {
     execute: async () => {
+      eventLogger("notebook-header.create-job");
       // Get the current notebook's name and path
       const contentsModel =
         notebookTracker.currentWidget?.context?.contentsModel;
@@ -302,7 +322,10 @@ async function activatePlugin(
   // Add to launcher
   if (launcher) {
     launcher.add({
-      command: CommandIDs.showNotebookJobs
+      command: CommandIDs.showNotebookJobs,
+      args: {
+        launcher: true
+      }
     });
   }
 }

diff --git a/src/notebook-jobs-panel.tsx b/src/notebook-jobs-panel.tsx
@@ -41,7 +41,7 @@ export class NotebookJobsPanel extends VDomRenderer<JobsModel> {
   readonly _translator: ITranslator;
   readonly _trans: TranslationBundle;
   readonly _advancedOptions: React.FunctionComponent<Scheduler.IAdvancedOptionsProps>;
-  readonly _telemetryHandler: Scheduler.TelemetryHandler;
+  readonly _eventLogger: Scheduler.EventLogger;
   private _newlyCreatedId: string | undefined;
   private _newlyCreatedName: string | undefined;
   private _last_input_drop_target: Element | null;
@@ -68,7 +68,7 @@ export class NotebookJobsPanel extends VDomRenderer<JobsModel> {
     this._translator = options.translator;
     this._trans = this._translator.load('jupyterlab');
     this._advancedOptions = options.advancedOptions;
-    this._telemetryHandler = options.telemetryHandler;
+    this._eventLogger = options.eventLogger;
     this._last_input_drop_target = null;
 
     this.node.setAttribute('role', 'region');
@@ -124,18 +124,6 @@ export class NotebookJobsPanel extends VDomRenderer<JobsModel> {
     }
   };
 
-  logEvent(eventName: string): void {
-    if (!eventName) {
-      return;
-    }
-    const eventLog = {
-      body: {
-        name: `org.jupyter.jupyter-scheduler.${eventName}`
-      },
-      timestamp: new Date()
-    };
-    this._telemetryHandler(eventLog).then();
-  }
 
   /**
    * Handle the DOM events for the directory listing.
@@ -235,7 +223,7 @@ export class NotebookJobsPanel extends VDomRenderer<JobsModel> {
     return (
       <ThemeProvider theme={getJupyterLabTheme()}>
         <TranslatorContext.Provider value={this._translator}>
-          <LogContext.Provider value={this.logEvent.bind(this)}>
+          <LogContext.Provider value={this._eventLogger.bind(this)}>
             <ErrorBoundary
               alertTitle={this._trans.__('Internal error')}
               alertMessage={this._trans.__(
@@ -325,7 +313,7 @@ namespace NotebookJobsPanel {
     app: JupyterFrontEnd;
     translator: ITranslator;
     advancedOptions: Scheduler.IAdvancedOptions;
-    telemetryHandler: Scheduler.TelemetryHandler;
+    eventLogger: Scheduler.EventLogger;
     model?: JobsModel;
   }
 }
diff --git a/src/tokens.ts b/src/tokens.ts
@@ -59,4 +59,6 @@ export namespace Scheduler {
   export const TelemetryHandler = new Token<TelemetryHandler>(
     '@jupyterlab/scheduler:ITelemetryHandler'
   );
+
+  export type EventLogger = (eventName: string) => void;
 }