Nadro/3686/file swapping while executing (#3703)

* chore: Implemented a executeAst interrupt to stop processing a KCL program

* fix: added a catch since this promise was not being caught

* fix: fmt formatting, need to fix some tsc errors next.

* fix: fixing tsc errors

* fix: cleaning up comment

* fix: only rejecting pending modeling commands

* fix: adding constant for rejection message, adding rejection in WASM send command

* fix: tsc, lint, fmt checks

* fix circ dependency

---------

Co-authored-by: Kurt Hutten Irev-Dev <k.hutten@protonmail.ch>

src/lang/KclSingleton.ts

@@ -4,6 +4,7 @@ import { KCLError, kclErrorsToDiagnostics } from './errors'
 import { uuidv4 } from 'lib/utils'
 import { EngineCommandManager } from './std/engineConnection'
 import { err } from 'lib/trap'
+import { EXECUTE_AST_INTERRUPT_ERROR_MESSAGE } from 'lib/constants'
 
 import {
   CallExpression,
@@ -122,6 +123,7 @@ export class KclManager {
   get isExecuting() {
     return this._isExecuting
   }
+
   set isExecuting(isExecuting) {
     this._isExecuting = isExecuting
     // If we have finished executing, but the execute is stale, we should
@@ -232,6 +234,12 @@ export class KclManager {
   async executeAst(args: ExecuteArgs = {}): Promise<void> {
     if (this.isExecuting) {
       this.executeIsStale = args
+
+      // The previous execteAst will be rejected and cleaned up. The execution will be marked as stale.
+      // A new executeAst will start.
+      this.engineCommandManager.rejectAllModelingCommands(
+        EXECUTE_AST_INTERRUPT_ERROR_MESSAGE
+      )
       // Exit early if we are already executing.
       return
     }
@@ -245,35 +253,38 @@ export class KclManager {
     // Make sure we clear before starting again. End session will do this.
     this.engineCommandManager?.endSession()
     await this.ensureWasmInit()
-    const { logs, errors, programMemory } = await executeAst({
+    const { logs, errors, programMemory, isInterrupted } = await executeAst({
       ast,
       engineCommandManager: this.engineCommandManager,
     })
 
-    this.lints = await lintAst({ ast: ast })
+    // Program was not interrupted, setup the scene
+    // Do not send send scene commands if the program was interrupted, go to clean up
+    if (!isInterrupted) {
+      this.lints = await lintAst({ ast: ast })
 
-    sceneInfra.modelingSend({ type: 'code edit during sketch' })
-    defaultSelectionFilter(programMemory, this.engineCommandManager)
-    await this.engineCommandManager.waitForAllCommands()
+      sceneInfra.modelingSend({ type: 'code edit during sketch' })
+      defaultSelectionFilter(programMemory, this.engineCommandManager)
 
-    if (args.zoomToFit) {
-      let zoomObjectId: string | undefined = ''
-      if (args.zoomOnRangeAndType) {
-        zoomObjectId = this.engineCommandManager?.mapRangeToObjectId(
-          args.zoomOnRangeAndType.range,
-          args.zoomOnRangeAndType.type
-        )
+      if (args.zoomToFit) {
+        let zoomObjectId: string | undefined = ''
+        if (args.zoomOnRangeAndType) {
+          zoomObjectId = this.engineCommandManager?.mapRangeToObjectId(
+            args.zoomOnRangeAndType.range,
+            args.zoomOnRangeAndType.type
+          )
+        }
+
+        await this.engineCommandManager.sendSceneCommand({
+          type: 'modeling_cmd_req',
+          cmd_id: uuidv4(),
+          cmd: {
+            type: 'zoom_to_fit',
+            object_ids: zoomObjectId ? [zoomObjectId] : [], // leave empty to zoom to all objects
+            padding: 0.1, // padding around the objects
+          },
+        })
       }
-
-      await this.engineCommandManager.sendSceneCommand({
-        type: 'modeling_cmd_req',
-        cmd_id: uuidv4(),
-        cmd: {
-          type: 'zoom_to_fit',
-          object_ids: zoomObjectId ? [zoomObjectId] : [], // leave empty to zoom to all objects
-          padding: 0.1, // padding around the objects
-        },
-      })
     }
 
     this.isExecuting = false
@@ -284,7 +295,8 @@ export class KclManager {
       return
     }
     this.logs = logs
-    this.addKclErrors(errors)
+    // Do not add the errors since the program was interrupted and the error is not a real KCL error
+    this.addKclErrors(isInterrupted ? [] : errors)
     this.programMemory = programMemory
     this.ast = { ...ast }
     this._executeCallback()
@@ -292,6 +304,7 @@ export class KclManager {
       type: 'execution-done',
       data: null,
     })
+
     this._cancelTokens.delete(currentExecutionId)
   }
   // NOTE: this always updates the code state and editor.