Telemetry patch (#457)

* Moved event logger handler up the stack.

* Fixed lint errors

* Combined handler, and plugin.

* Fixed lint errors

* separate launcher command and rename show-notebook-jobs (#3)

---------

Co-authored-by: david qiu <[email protected]>

Author: 3coins

src/index.tsx

@@ -32,9 +32,10 @@ export namespace CommandIDs {
   export const deleteJob = 'scheduling:delete-job';
   export const createJobFileBrowser = 'scheduling:create-from-filebrowser';
   export const createJobCurrentNotebook = 'scheduling:create-from-notebook';
-  export const showNotebookJobs = 'scheduling:show-notebook-jobs';
+  export const restoreLayout = 'scheduling:restore-layout';
   export const stopJob = 'scheduling:stop-job';
   export const downloadFiles = 'scheduling:download-files';
+  export const listJobsFromLauncher = 'scheduling:list-jobs-from-launcher';
 }
 
 export const NotebookJobsPanelId = 'notebook-jobs-panel';
@@ -68,19 +69,14 @@ const advancedOptions: JupyterFrontEndPlugin<Scheduler.IAdvancedOptions> = {
   }
 };
 
-// Default Telemetry Handler
-const telemetryHandler = async (
-  eventLog: Scheduler.IEventLog
-): Promise<void> => {
-  console.log(JSON.stringify(eventLog, undefined, 4));
-};
-
 const telemetry: JupyterFrontEndPlugin<Scheduler.TelemetryHandler> = {
   id: '@jupyterlab/scheduler:TelemetryHandler',
   autoStart: true,
   provides: Scheduler.TelemetryHandler,
   activate: (app: JupyterFrontEnd) => {
-    return telemetryHandler;
+    return async (e: Scheduler.IEventLog) => {
+      /*noop*/
+    };
   }
 };
 
@@ -174,21 +170,34 @@ async function activatePlugin(
     namespace: 'jupyterlab-scheduler'
   });
   restorer.restore(widgetTracker, {
-    command: CommandIDs.showNotebookJobs,
+    command: CommandIDs.restoreLayout,
     args: widget => widget.content.model.toJson(),
     name: () => 'jupyterlab-scheduler'
   });
 
   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
@@ -222,14 +231,15 @@ async function activatePlugin(
 
   // Commands
 
-  commands.addCommand(CommandIDs.showNotebookJobs, {
-    execute: async args => showJobsPanel(args as IJobsModel),
-    label: trans.__('Notebook Jobs'),
-    icon: eventNoteIcon
+  commands.addCommand(CommandIDs.restoreLayout, {
+    execute: async args => {
+      showJobsPanel(args as IJobsModel);
+    }
   });
 
   commands.addCommand(CommandIDs.createJobFileBrowser, {
     execute: async () => {
+      eventLogger('file-browser.create-job');
       const widget = fileBrowserTracker.currentWidget;
       const filePath = getSelectedFilePath(widget) ?? '';
 
@@ -252,6 +262,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;
@@ -301,8 +312,22 @@ async function activatePlugin(
 
   // Add to launcher
   if (launcher) {
+    commands.addCommand(CommandIDs.listJobsFromLauncher, {
+      execute: async () => {
+        eventLogger('launcher.show-jobs');
+        showJobsPanel({
+          jobsView: JobsView.ListJobs
+        });
+      },
+      label: trans.__('Notebook Jobs'),
+      icon: eventNoteIcon
+    });
+
     launcher.add({
-      command: CommandIDs.showNotebookJobs
+      command: CommandIDs.listJobsFromLauncher,
+      args: {
+        launcher: true
+      }
     });
   }
 }

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,19 +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 +222,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 +312,7 @@ namespace NotebookJobsPanel {
     app: JupyterFrontEnd;
     translator: ITranslator;
     advancedOptions: Scheduler.IAdvancedOptions;
-    telemetryHandler: Scheduler.TelemetryHandler;
+    eventLogger: Scheduler.EventLogger;
     model?: JobsModel;
   }
 }

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;
 }