Merge branch 'main' into migrate-to-lsp-execution

Signed-off-by: Jess Frazelle <github@jessfraz.com>

e2e/playwright/flow-tests.spec.ts

@@ -1189,7 +1189,7 @@ fn yohey = (pos) => {
     },
     selectionsSnippets
   )
-  await page.setViewportSize({ width: 1200, height: 500 })
+  await page.setViewportSize({ width: 1200, height: 1000 })
   await page.goto('/')
   await u.waitForAuthSkipAppStart()
 

e2e/playwright/snapshot-tests.spec.ts

@@ -35,7 +35,7 @@ test('exports of each format should work', async ({ page, context }) => {
   // FYI this test doesn't work with only engine running locally
   // And you will need to have the KittyCAD CLI installed
   const u = getUtils(page)
-  await context.addInitScript(async () => {
+  await page.addInitScript(async () => {
     ;(window as any).playwrightSkipFilePicker = true
     localStorage.setItem(
       'persistCode',
@@ -79,6 +79,7 @@ const part001 = startSketchOn('-XZ')
   |> extrude(4, %)`
     )
   })
+
   await page.setViewportSize({ width: 1200, height: 500 })
   await page.goto('/')
   await u.waitForAuthSkipAppStart()

src/components/FileTree.tsx

@@ -171,7 +171,7 @@ const FileTreeItem = ({
 
     if (fileOrDir.name?.endsWith(FILE_EXT) === false && project?.path) {
       // Import non-kcl files
-      kclManager.setCodeAndExecute(
+      kclManager.setCode(
         `import("${fileOrDir.path.replace(project.path, '.')}")\n` +
           kclManager.code
       )

src/components/ModelingMachineProvider.tsx

@@ -21,6 +21,7 @@ import {
 } from './Toolbar/SetAngleBetween'
 import { applyConstraintAngleLength } from './Toolbar/setAngleLength'
 import { pathMapToSelections } from 'lang/util'
+import { useLspContext } from 'components/LspProvider'
 import { useStore } from 'useStore'
 import {
   Selections,
@@ -86,6 +87,7 @@ export const ModelingMachineProvider = ({
     htmlRef,
     token
   )
+  const { lspClients } = useLspContext()
   useHotkeys('meta + shift + .', () => coreDump(coreDumpManager, true))
 
   const {
@@ -116,6 +118,24 @@ export const ModelingMachineProvider = ({
     modelingMachine,
     {
       actions: {
+        'disable lsp execution': async () => {
+          // Update the lsp server that we are in sketch mode, so we can turn off lsp execution.
+          for (const lspClient of lspClients) {
+            for (const plugin of lspClient.plugins) {
+              await plugin.updateCanExecute(false)
+            }
+          }
+          await kclManager.enterEditMode()
+          console.log('done with disabling lsp execution')
+        },
+        'enable lsp execution': async () => {
+          // Update the lsp server that we are done with sketch mode, so we can turn back on lsp execution.
+          for (const lspClient of lspClients) {
+            for (const plugin of lspClient.plugins) {
+              await plugin.updateCanExecute(true)
+            }
+          }
+        },
         'sketch exit execute': () => {
           try {
             kclManager.executeAst(parse(kclManager.code))

src/components/ModelingSidebar/ModelingPanes/KclEditorPane.tsx

@@ -5,7 +5,7 @@ import { useCommandsContext } from 'hooks/useCommandsContext'
 import { useSettingsAuthContext } from 'hooks/useSettingsAuthContext'
 import { useConvertToVariable } from 'hooks/useToolbarGuards'
 import { Themes, getSystemTheme } from 'lib/theme'
-import { useEffect, useMemo, useRef } from 'react'
+import { useMemo, useRef } from 'react'
 import { useStore } from 'useStore'
 import { processCodeMirrorRanges } from 'lib/selections'
 import { highlightSelectionMatches, searchKeymap } from '@codemirror/search'
@@ -29,7 +29,7 @@ import {
   historyKeymap,
   history,
 } from '@codemirror/commands'
-import { lintGutter, lintKeymap, linter } from '@codemirror/lint'
+import { lintGutter, lintKeymap } from '@codemirror/lint'
 import {
   foldGutter,
   foldKeymap,
@@ -57,11 +57,6 @@ import {
   completionKeymap,
   hasNextSnippetField,
 } from '@codemirror/autocomplete'
-import {
-  NetworkHealthState,
-  useNetworkStatus,
-} from 'components/NetworkHealthIndicator'
-import { kclErrorsToDiagnostics } from 'lang/errors'
 
 export const editorShortcutMeta = {
   formatCode: {
@@ -86,20 +81,11 @@ export const KclEditorPane = () => {
     setEditorView: s.setEditorView,
     isShiftDown: s.isShiftDown,
   }))
-  const { code, errors } = useKclContext()
+  const { code } = useKclContext()
   const lastEvent = useRef({ event: '', time: Date.now() })
   const { copilotLSP, kclLSP } = useLspContext()
-  const { overallState } = useNetworkStatus()
-  const isNetworkOkay = overallState === NetworkHealthState.Ok
   const navigate = useNavigate()
 
-  useEffect(() => {
-    if (typeof window === 'undefined') return
-    const onlineCallback = () => kclManager.setCodeAndExecute(kclManager.code)
-    window.addEventListener('online', onlineCallback)
-    return () => window.removeEventListener('online', onlineCallback)
-  }, [])
-
   useHotkeys('mod+z', (e) => {
     e.preventDefault()
     if (editorView) {
@@ -136,8 +122,7 @@ export const KclEditorPane = () => {
       return
     }
 
-    if (isNetworkOkay) kclManager.setCodeAndExecute(newCode)
-    else kclManager.setCode(newCode)
+    kclManager.setCode(newCode)
   }
   const lastSelection = useRef('')
   const onUpdate = (viewUpdate: ViewUpdate) => {
@@ -252,9 +237,6 @@ export const KclEditorPane = () => {
     if (!TEST) {
       extensions.push(
         lintGutter(),
-        linter((_view: EditorView) => {
-          return kclErrorsToDiagnostics(errors)
-        }),
         lineNumbers(),
         highlightActiveLineGutter(),
         highlightSpecialChars(),

src/components/SettingsAuthProvider.tsx

@@ -18,7 +18,7 @@ import {
 } from 'xstate'
 import { isTauri } from 'lib/isTauri'
 import { authCommandBarConfig } from 'lib/commandBarConfigs/authCommandConfig'
-import { kclManager, sceneInfra, engineCommandManager } from 'lib/singletons'
+import { sceneInfra, engineCommandManager } from 'lib/singletons'
 import { uuidv4 } from 'lib/utils'
 import { IndexLoaderData } from 'lib/types'
 import { settings } from 'lib/settings/initialSettings'
@@ -138,7 +138,6 @@ export const SettingsAuthProviderBase = ({
             id: `${event.type}.success`,
           })
         },
-        'Execute AST': () => kclManager.executeAst(),
         persistSettings: (context) =>
           saveSettings(context, loadedProject?.project?.path),
       },

src/editor/plugins/lsp/plugin.ts

@@ -12,7 +12,6 @@ import {
   CompletionTriggerKind,
 } from 'vscode-languageserver-protocol'
 
-import { deferExecution } from 'lib/utils'
 import type {
   Completion,
   CompletionContext,
@@ -43,8 +42,6 @@ const CompletionItemKindMap = Object.fromEntries(
   Object.entries(CompletionItemKind).map(([key, value]) => [value, key])
 ) as Record<CompletionItemKind, string>
 
-const changesDelay = 600
-
 export class LanguageServerPlugin implements PluginValue {
   public client: LanguageServerClient
   public documentUri: string
@@ -52,19 +49,6 @@ export class LanguageServerPlugin implements PluginValue {
   public workspaceFolders: LSP.WorkspaceFolder[]
   private documentVersion: number
   private foldingRanges: LSP.FoldingRange[] | null = null
-  private _defferer = deferExecution((code: string) => {
-    try {
-      this.client.textDocumentDidChange({
-        textDocument: {
-          uri: this.documentUri,
-          version: this.documentVersion++,
-        },
-        contentChanges: [{ text: code }],
-      })
-    } catch (e) {
-      console.error(e)
-    }
-  }, changesDelay)
 
   constructor(
     client: LanguageServerClient,
@@ -134,7 +118,17 @@ export class LanguageServerPlugin implements PluginValue {
       documentText = ''
     }
 
-    this._defferer(documentText)
+    try {
+      this.client.textDocumentDidChange({
+        textDocument: {
+          uri: this.documentUri,
+          version: this.documentVersion++,
+        },
+        contentChanges: [{ text: documentText }],
+      })
+    } catch (e) {
+      console.error(e)
+    }
   }
 
   requestDiagnostics(view: EditorView) {
@@ -380,10 +374,10 @@ export class LanguageServerPlugin implements PluginValue {
           const params = notification.params as PublishDiagnosticsParams
           this.processDiagnostics(params)
           // Update the kcl errors pane.
-          /*kclManager.kclErrors = lspDiagnosticsToKclErrors(
+          kclManager.kclErrors = lspDiagnosticsToKclErrors(
             this.view.state.doc,
             params.diagnostics
-          )*/
+          )
           break
         case 'window/logMessage':
           console.log(

src/hooks/useSetupEngineManager.ts

@@ -3,7 +3,7 @@ import { useStore } from '../useStore'
 import { engineCommandManager, kclManager } from 'lib/singletons'
 import { deferExecution } from 'lib/utils'
 import { Themes } from 'lib/theme'
-import { makeDefaultPlanes, parse } from 'lang/wasm'
+import { makeDefaultPlanes } from 'lang/wasm'
 
 export function useSetupEngineManager(
   streamRef: React.RefObject<HTMLDivElement>,
@@ -40,10 +40,6 @@ export function useSetupEngineManager(
         setIsStreamReady,
         width: quadWidth,
         height: quadHeight,
-        executeCode: (code?: string) => {
-          const _ast = parse(code || kclManager.code)
-          return kclManager.executeAst(_ast, true)
-        },
         token,
         theme,
         makeDefaultPlanes: () => {

src/lang/KclSingleton.ts

@@ -1,10 +1,9 @@
-import { executeAst, executeCode } from 'useStore'
+import { executeAst } from 'useStore'
 import { Selections } from 'lib/selections'
 import { KCLError } from './errors'
 import { uuidv4 } from 'lib/utils'
 import { EngineCommandManager } from './std/engineConnection'
 
-import { deferExecution } from 'lib/utils'
 import {
   CallExpression,
   initPromise,
@@ -47,19 +46,6 @@ export class KclManager {
   private _params: Params<string> = {}
 
   engineCommandManager: EngineCommandManager
-  private _defferer = deferExecution((code: string) => {
-    const ast = this.safeParse(code)
-    if (!ast) return
-    try {
-      const fmtAndStringify = (ast: Program) =>
-        JSON.stringify(parse(recast(ast)))
-      const isAstTheSame = fmtAndStringify(ast) === fmtAndStringify(this._ast)
-      if (isAstTheSame) return
-    } catch (e) {
-      console.error(e)
-    }
-    this.executeAst(ast)
-  }, 600)
 
   private _isExecutingCallback: (arg: boolean) => void = () => {}
   private _codeCallBack: (arg: string) => void = () => {}
@@ -81,6 +67,9 @@ export class KclManager {
   get code() {
     return this._code
   }
+  // Calling set code will update the code in the codemirror editor.
+  // That will then trigger the lsp to update the ast and execute the code.
+  // DO NOT ALSO CALL execute/parseCode here, as that will cause the code to be executed twice.
   set code(code) {
     this._code = code
     this._codeCallBack(code)
@@ -106,6 +95,12 @@ export class KclManager {
   set programMemory(programMemory) {
     this._programMemory = programMemory
     this._programMemoryCallBack(programMemory)
+    // We only do this to help the playwright testes otherwise I would remove
+    // it. (@jessfraz wrote this comment)
+    this.engineCommandManager.addCommandLog({
+      type: 'execution-done',
+      data: null,
+    })
   }
 
   get logs() {
@@ -208,7 +203,6 @@ export class KclManager {
       console.error('error parsing code', e)
       if (e instanceof KCLError) {
         this.kclErrors = [e]
-        if (e.msg === 'file is empty') this.engineCommandManager?.endSession()
       }
       return null
     }
@@ -220,8 +214,9 @@ export class KclManager {
       if (this.wasmInitFailed) {
         this.wasmInitFailed = false
       }
-    } catch (e) {
+    } catch (e: any) {
       this.wasmInitFailed = true
+      throw new Error('error initializing wasm: ' + e.toString())
     }
   }
 
@@ -241,7 +236,7 @@ export class KclManager {
       ast,
       engineCommandManager: this.engineCommandManager,
     })
-    enterEditMode(programMemory, this.engineCommandManager)
+    await enterEditMode(programMemory, this.engineCommandManager)
     this.isExecuting = false
     // Check the cancellation token for this execution before applying side effects
     if (this._cancelTokens.get(currentExecutionId)) {
@@ -276,7 +271,7 @@ export class KclManager {
     if (!newAst) return
     await this?.engineCommandManager?.waitForReady
     if (updates !== 'none') {
-      this.setCode(recast(ast))
+      this.setCode(newCode)
     }
     this._ast = { ...newAst }
 
@@ -308,41 +303,14 @@ export class KclManager {
       }
     )
   }
-  executeCode = async (code?: string, executionId?: number) => {
-    const currentExecutionId = executionId || Date.now()
-    this._cancelTokens.set(currentExecutionId, false)
-    if (this._cancelTokens.get(currentExecutionId)) {
-      this._cancelTokens.delete(currentExecutionId)
-      return
-    }
-    await this.ensureWasmInit()
-    await this?.engineCommandManager?.waitForReady
-    const result = await executeCode({
-      engineCommandManager: this.engineCommandManager,
-      code: code || this._code,
-      lastAst: this._ast,
-      force: false,
-    })
-    // Check the cancellation token for this execution before applying side effects
-    if (this._cancelTokens.get(currentExecutionId)) {
-      this._cancelTokens.delete(currentExecutionId)
-      return
-    }
-    if (!result.isChange) return
-    const { logs, errors, programMemory, ast } = result
-    enterEditMode(programMemory, this.engineCommandManager)
-    this.logs = logs
-    this.kclErrors = errors
-    this.programMemory = programMemory
-    this.ast = ast
-    if (code) this.code = code
-    this._cancelTokens.delete(currentExecutionId)
-  }
   cancelAllExecutions() {
     this._cancelTokens.forEach((_, key) => {
       this._cancelTokens.set(key, true)
     })
   }
+  // Calling set code will update the code in the codemirror editor.
+  // That will then trigger the lsp to update the ast and execute the code.
+  // DO NOT ALSO CALL execute/parseCode here, as that will cause the code to be executed twice.
   setCode(code: string, shouldWriteFile = true) {
     if (shouldWriteFile) {
       // use the normal code setter
@@ -352,27 +320,6 @@ export class KclManager {
     this._code = code
     this._codeCallBack(code)
   }
-  setCodeAndExecute(code: string, shouldWriteFile = true) {
-    this.setCode(code, shouldWriteFile)
-    if (code.trim()) {
-      this._defferer(code)
-      return
-    }
-    this._ast = {
-      body: [],
-      start: 0,
-      end: 0,
-      nonCodeMeta: {
-        nonCodeNodes: {},
-        start: [],
-      },
-    }
-    this._programMemory = {
-      root: {},
-      return: null,
-    }
-    this.engineCommandManager.endSession()
-  }
   format() {
     const ast = this.safeParse(this.code)
     if (!ast) return
@@ -440,6 +387,10 @@ export class KclManager {
     void this.engineCommandManager.setPlaneHidden(this.defaultPlanes.yz, true)
     void this.engineCommandManager.setPlaneHidden(this.defaultPlanes.xz, true)
   }
+
+  async enterEditMode() {
+    await enterEditMode(this.programMemory, this.engineCommandManager)
+  }
 }
 
 function safeLSGetItem(key: string) {
@@ -452,7 +403,7 @@ function safteLSSetItem(key: string, value: string) {
   localStorage?.setItem(key, value)
 }
 
-function enterEditMode(
+async function enterEditMode(
   programMemory: ProgramMemory,
   engineCommandManager: EngineCommandManager
 ) {
@@ -460,7 +411,7 @@ function enterEditMode(
     (node) => node.type === 'ExtrudeGroup' || node.type === 'SketchGroup'
   ) as SketchGroup | ExtrudeGroup
   firstSketchOrExtrudeGroup &&
-    engineCommandManager.sendSceneCommand({
+    (await engineCommandManager.sendSceneCommand({
       type: 'modeling_cmd_batch_req',
       batch_id: uuidv4(),
       requests: [
@@ -479,5 +430,5 @@ function enterEditMode(
           },
         },
       ],
-    })
+    }))
 }

src/lang/std/engineConnection.ts

@@ -921,7 +921,6 @@ export class EngineCommandManager {
     setIsStreamReady,
     width,
     height,
-    executeCode,
     token,
     makeDefaultPlanes,
     theme = Themes.Dark,
@@ -930,7 +929,6 @@ export class EngineCommandManager {
     setIsStreamReady: (isStreamReady: boolean) => void
     width: number
     height: number
-    executeCode: (code?: string, force?: boolean) => void
     token?: string
     makeDefaultPlanes: () => Promise<DefaultPlanes>
     theme?: Themes
@@ -1005,7 +1003,6 @@ export class EngineCommandManager {
         this.initPlanes().then(() => {
           this.resolveReady()
           setIsStreamReady(true)
-          executeCode(undefined, true)
         })
       },
       onClose: () => {

src/lib/routeLoaders.ts

@@ -100,7 +100,7 @@ export const fileLoader: LoaderFunction = async ({
     const children = await invoke<FileEntry[]>('read_dir_recursive', {
       path: projectPath,
     })
-    kclManager.setCodeAndExecute(code, false)
+    kclManager.setCode(code, false)
 
     // Set the file system manager to the project path
     // So that WASM gets an updated path for operations

src/lib/testHelpers.ts

@@ -98,7 +98,6 @@ export async function executor(
     setMediaStream: () => {},
     width: 0,
     height: 0,
-    executeCode: () => {},
     theme: Themes.Dark,
     makeDefaultPlanes: () => {
       return new Promise((resolve) => resolve(defaultPlanes))

src/machines/modelingMachine.ts

@@ -192,7 +192,11 @@ export const modelingMachine = createMachine(
           Extrude: {
             target: 'idle',
             cond: 'has valid extrude selection',
-            actions: ['AST extrude'],
+            actions: [
+              'disable lsp execution',
+              'AST extrude',
+              'enable lsp execution',
+            ],
             internal: true,
           },
 
@@ -490,13 +494,18 @@ export const modelingMachine = createMachine(
           'tear down client sketch',
           'remove sketch grid',
           'engineToClient cam sync direction',
+          'enable lsp execution',
         ],
 
         entry: ['add axis n grid', 'conditionally equip line tool'],
       },
 
       'Sketch no face': {
-        entry: ['show default planes', 'set selection filter to faces only'],
+        entry: [
+          'disable lsp execution',
+          'show default planes',
+          'set selection filter to faces only',
+        ],
 
         exit: ['hide default planes', 'set selection filter to defaults'],
         on: {

src/machines/settingsMachine.ts

@@ -45,7 +45,6 @@ export const settingsMachine = createMachine(
               'setSettingAtLevel',
               'toastSuccess',
               'setClientSideSceneUnits',
-              'Execute AST',
               'persistSettings',
             ],
           },
@@ -70,7 +69,6 @@ export const settingsMachine = createMachine(
               'setThemeClass',
               'setEngineTheme',
               'setClientSideSceneUnits',
-              'Execute AST',
               'persistSettings',
             ],
           },
@@ -83,7 +81,6 @@ export const settingsMachine = createMachine(
               'setThemeClass',
               'setEngineTheme',
               'setClientSideSceneUnits',
-              'Execute AST',
               'persistSettings',
             ],
           },

src/routes/Onboarding/FutureWork.tsx

@@ -11,13 +11,8 @@ export default function FutureWork() {
   const dismiss = useDismiss()
 
   useEffect(() => {
-    if (kclManager.engineCommandManager.engineConnection?.isReady()) {
-      // If the engine is ready, promptly execute the loaded code
-      kclManager.setCodeAndExecute(bracket)
-    } else {
     // Otherwise, just set the code and wait for the connection to complete
     kclManager.setCode(bracket)
-    }
 
     send({ type: 'Cancel' }) // in case the user hit 'Next' while still in sketch mode
   }, [send])

src/routes/Onboarding/Introduction.tsx

@@ -70,7 +70,7 @@ function OnboardingWithNewFile() {
               className="mt-6"
               dismiss={dismiss}
               next={() => {
-                kclManager.setCodeAndExecute(bracket)
+                kclManager.setCode(bracket)
                 next()
               }}
               nextText="Overwrite code and continue"

src/routes/Onboarding/Sketching.tsx

@@ -10,13 +10,7 @@ export default function Sketching() {
   const next = useNextClick(onboardingPaths.FUTURE_WORK)
 
   useEffect(() => {
-    if (kclManager.engineCommandManager.engineConnection?.isReady()) {
-      // If the engine is ready, promptly execute the loaded code
-      kclManager.setCodeAndExecute('')
-    } else {
-      // Otherwise, just set the code and wait for the connection to complete
     kclManager.setCode('')
-    }
   }, [])
 
   return (

src/useStore.ts

@@ -2,7 +2,6 @@ import { create } from 'zustand'
 import { persist } from 'zustand/middleware'
 import { addLineHighlight, EditorView } from './editor/highlightextension'
 import {
-  parse,
   Program,
   _executor,
   ProgramMemory,
@@ -175,74 +174,6 @@ export const useStore = create<StoreState>()(
   )
 )
 
-export async function executeCode({
-  engineCommandManager,
-  code,
-  lastAst,
-  force,
-}: {
-  code: string
-  lastAst: Program
-  engineCommandManager: EngineCommandManager
-  force?: boolean
-}): Promise<
-  | {
-      logs: string[]
-      errors: KCLError[]
-      programMemory: ProgramMemory
-      ast: Program
-      isChange: true
-    }
-  | { isChange: false }
-> {
-  let ast: Program
-  try {
-    ast = parse(code)
-  } catch (e) {
-    let errors: KCLError[] = []
-    let logs: string[] = [JSON.stringify(e)]
-    if (e instanceof KCLError) {
-      errors = [e]
-      logs = []
-      if (e.msg === 'file is empty') engineCommandManager.endSession()
-    }
-    return {
-      isChange: true,
-      logs,
-      errors,
-      programMemory: {
-        root: {},
-        return: null,
-      },
-      ast: {
-        start: 0,
-        end: 0,
-        body: [],
-        nonCodeMeta: {
-          nonCodeNodes: {},
-          start: [],
-        },
-      },
-    }
-  }
-  // Check if the ast we have is equal to the ast in the storage.
-  // If it is, we don't need to update the ast.
-  if (JSON.stringify(ast) === JSON.stringify(lastAst) && !force)
-    return { isChange: false }
-
-  const { logs, errors, programMemory } = await executeAst({
-    ast,
-    engineCommandManager,
-  })
-  return {
-    ast,
-    logs,
-    errors,
-    programMemory,
-    isChange: true,
-  }
-}
-
 export async function executeAst({
   ast,
   engineCommandManager,

src/wasm-lib/src/wasm.rs

@@ -223,8 +223,7 @@ pub async fn kcl_lsp_run(
     let engine = kcl_lib::engine::conn_wasm::EngineConnection::new(engine_manager)
         .await
         .map_err(|e| format!("{:?}", e))?;
-    // Turn off lsp execute for now
-    let _executor_ctx = kcl_lib::executor::ExecutorContext {
+    let executor_ctx = kcl_lib::executor::ExecutorContext {
         engine: Arc::new(Box::new(engine)),
         fs: file_manager.clone(),
         stdlib: std::sync::Arc::new(stdlib),
@@ -266,8 +265,8 @@ pub async fn kcl_lsp_run(
         semantic_tokens_map: Default::default(),
         zoo_client,
         can_send_telemetry: privacy_settings.can_train_on_data,
-        executor_ctx: Default::default(),
-        can_execute: Default::default(),
+        executor_ctx: Arc::new(tokio::sync::RwLock::new(Some(executor_ctx))),
+        can_execute: Arc::new(tokio::sync::RwLock::new(true)),
 
         is_initialized: Default::default(),
         current_handle: Default::default(),