Tweak IDL Machine to improve UX in notebooks

Author: znorman-harris

libs/idl/idl-interaction-manager/src/lib/idl-interaction-manager.class.ts

@@ -439,6 +439,13 @@ export class IDLInteractionManager {
     this.idl.removeAllListeners();
   }
 
+  /**
+   * Resets information about the call stack so that we are always fresh
+   */
+  async resetCallStack() {
+    await this.idl.resetCallStack();
+  }
+
   /**
    * Reset errors by file
    */

libs/idl/idl-process/src/lib/idl-process.class.ts

@@ -239,6 +239,20 @@ export class IDLProcess extends EventEmitter {
     this._machine.registerRequestHandler(event, handler);
   }
 
+  /**
+   * Resets information about the call stack so that we are always fresh
+   */
+  async resetCallStack() {
+    /**
+     * If machine, forget the last place we stopped to trigger a new stop as unexpected
+     */
+    if (this.isIDLMachine()) {
+      this._machine.lastStop = undefined;
+    } else {
+      this.idlInfo = copy(DEFAULT_IDL_INFO);
+    }
+  }
+
   /**
    * Wraps emitting standard output to make sure all checks happen in one place
    */

libs/idl/idl-process/src/lib/wrappers/idl-machine-wrapper.class.ts

@@ -34,15 +34,18 @@ const kill = require('tree-kill');
  * Wraps the IDL Machine process and connects events from it to/from our IDL Process class
  */
 export class IDLMachineWrapper {
+  /** last debug send */
+  lastDebugSend: FromIDLMachineNotificationParams<'debugSend'>;
+
+  /** Track the last interpreter stopped params */
+  lastStop: FromIDLMachineNotificationParams<'interpreterStopped'>;
+
   /** Flag that we are expecting a stop or end to command running */
   private expectingStop = false;
 
   /** The IDL process */
   private idl: ChildProcess;
 
-  /** last debug send */
-  private lastDebugSend: FromIDLMachineNotificationParams<'debugSend'>;
-
   /** The IDL Machine */
   private machine: IDLMachine;
 
@@ -147,15 +150,13 @@ export class IDLMachineWrapper {
       }
     });
 
-    /** Track the last interpreter stopped params */
-    let lastStop: FromIDLMachineNotificationParams<'interpreterStopped'>;
-
     this.machine.onNotification('interpreterStopped', (params) => {
       /** Check if our last stop is different */
-      const stopDelta = lastStop !== undefined || !deepEqual(params, lastStop);
+      const stopDelta =
+        this.lastStop !== undefined || !deepEqual(params, this.lastStop);
 
       // save the parameters
-      lastStop = params;
+      this.lastStop = params;
 
       // create output parameters
       const res: IDLOutput = {
@@ -169,7 +170,7 @@ export class IDLMachineWrapper {
        */
       if (
         params.line > 0 &&
-        (!this.expectingStop || (this.lastDebugSend.stack.changed && stopDelta))
+        (!this.expectingStop || this.lastDebugSend.stack.changed || stopDelta)
       ) {
         res.stopped = {
           reason: 'stop',
@@ -188,7 +189,9 @@ export class IDLMachineWrapper {
       // check if we are expecting to stop or not
       if (this.expectingStop) {
         // emit that IDL is ready
-        this.process.emit(IDL_EVENT_LOOKUP.PROMPT_READY, res);
+        setTimeout(() => {
+          this.process.emit(IDL_EVENT_LOOKUP.PROMPT_READY, res);
+        }, 10);
       } else {
         this.process.emit(
           IDL_EVENT_LOOKUP.STOP,

libs/vscode/notebooks/client/src/lib/controller/idl-notebook-execution-manager.class.ts

@@ -355,6 +355,9 @@ export class IDLNotebookExecutionManager {
        * Clean things up and get our !magic system variable
        */
       await this.evaluate(commands.join(' & '));
+
+      // reset the call stack
+      this.resetCallStack();
     }
 
     // remove listener
@@ -733,6 +736,13 @@ export class IDLNotebookExecutionManager {
     }
   }
 
+  /**
+   * Resets information about the call stack so that we are always fresh
+   */
+  async resetCallStack() {
+    await this._runtime.resetCallStack();
+  }
+
   /**
    * Stop kernel execution
    */