Sketch mode partial execution (#9557)

* Change sketch block args to require a variable

The plane Object ID in frontend tests is wrong.

* Fix plane types to model ObjectId correctly

* Fix to send plane to engine at start of sketch block
Update test expectations

* Refactor existing code to use new helper function

* Fix sketch blocks to always provide on argument

* Update generated output for sketch block tests

* Add test sketching on offset plane

* Fix to find sketch block artifact

Ignore it for now.

* Update generated output

* Rename functions

* Make sure to mark the sketch block node whenever we mock execute

* Add sketch mode to state

* Skip non-sketch-block statements

Some tests are failing because ObjectIds are actually wrong.

* Change previous memory tuple to named struct

* Add scene objects to mock execution cache

* Fix delete sketch to use engine execution

* Add back assertions that IDs match the array index

* Simplify accessor and modifier functions

* Add failing test for sketch block on face

* Add support for sketch block `on` parameter to be a Face or Sketch

* Update output for sketch on face sim test

* Update the rest of the sim test output

* Fix sketch on face

* Add sketch on plane of sim test

* Add sketch on planeOf frontend test

* allow edit from cursor position in sketch blocks

* Update output after merging main

* Add comments about reading the cached module state

* Fix to never panic when cache length is unexpected

* Simplify cache rehydration

* Fix segment IDs in tests

---------

Co-authored-by: Kurt Hutten Irev-Dev <[email protected]>

Author: jtran

e2e/playwright/sketch-solve-edit.spec.ts

@@ -125,7 +125,7 @@ test.describe('Sketch solve edit tests', { tag: '@desktop' }, () => {
 
     await test.step('Drag point segment 13 down', async () => {
       const segmentBox = await scene.getBoundingBoxOrThrow(
-        '[data-segment_id="13"]'
+        '[data-segment_id="14"]'
       )
 
       const centerX = segmentBox.x + segmentBox.width / 2
@@ -145,7 +145,7 @@ test.describe('Sketch solve edit tests', { tag: '@desktop' }, () => {
     })
 
     await test.step('Drag line segment by dragging midpoint between points 8 and 9 down', async () => {
-      const midpoint = await getMidpointBetweenSegments(scene, '8', '9')
+      const midpoint = await getMidpointBetweenSegments(scene, '9', '10')
 
       const lineToEdit = getCodeLine({ code: TEST_CODE, line: 8 })
       await editor.expectEditor.toContain(lineToEdit)
@@ -306,10 +306,10 @@ test.describe('Sketch solve edit tests', { tag: '@desktop' }, () => {
       await page.getByTestId('point').click()
     })
 
-    await test.step('Select segments 1 and 8, then apply coincident constraint', async () => {
-      await page.locator('[data-segment_id="1"]').click()
+    await test.step('Select segments 2 and 9, then apply coincident constraint', async () => {
+      await page.locator('[data-segment_id="2"]').click()
       // await page.waitForTimeout(100)
-      await page.locator('[data-segment_id="8"]').click()
+      await page.locator('[data-segment_id="9"]').click()
       // await page.waitForTimeout(100)
 
       // Click the coincident tool
@@ -323,10 +323,10 @@ test.describe('Sketch solve edit tests', { tag: '@desktop' }, () => {
     const [clearSelection] = scene.makeMouseHelpers(0.5, 0.5, {
       format: 'ratio',
     })
-    await test.step('Select lines between segments 1-2 and 4-5, then apply parallel constraint', async () => {
+    await test.step('Select lines between segments 2-3 and 5-6, then apply parallel constraint', async () => {
       await clearSelection()
       const segmentBox = await scene.getBoundingBoxOrThrow(
-        '[data-segment_id="1"]'
+        '[data-segment_id="2"]'
       )
       const centerX = segmentBox.x + segmentBox.width / 2
       const centerY = segmentBox.y + segmentBox.height / 2
@@ -336,10 +336,10 @@ test.describe('Sketch solve edit tests', { tag: '@desktop' }, () => {
       await page.mouse.up()
     })
 
-    await test.step('Select lines between segments 1-2 and 4-5, then apply parallel constraint', async () => {
+    await test.step('Select lines between segments 2-3 and 5-6, then apply parallel constraint', async () => {
       // Click in dead space to clear selections
-      const midpoint1_2 = await getMidpointBetweenSegments(scene, '1', '2')
-      const midpoint4_5 = await getMidpointBetweenSegments(scene, '4', '5')
+      const midpoint1_2 = await getMidpointBetweenSegments(scene, '2', '3')
+      const midpoint4_5 = await getMidpointBetweenSegments(scene, '5', '6')
 
       await clearSelection()
       // await page.waitForTimeout(100)

public/kcl-samples/screenshots/inner-thread.png

@@ -12,6 +12,7 @@ use crate::{
         memory::Stack,
         state::{self as exec_state, ModuleInfoMap},
     },
+    front::Object,
     parsing::ast::types::{Annotation, Node, Program},
     walk::Node as WalkNode,
 };
@@ -20,7 +21,7 @@ lazy_static::lazy_static! {
     /// A static mutable lock for updating the last successful execution state for the cache.
     static ref OLD_AST: Arc<RwLock<Option<GlobalState>>> = Default::default();
     // The last successful run's memory. Not cleared after an unsuccessful run.
-    static ref PREV_MEMORY: Arc<RwLock<Option<(Stack, ModuleInfoMap)>>> = Default::default();
+    static ref PREV_MEMORY: Arc<RwLock<Option<SketchModeState>>> = Default::default();
 }
 
 /// Read the old ast memory from the lock.
@@ -34,12 +35,12 @@ pub(super) async fn write_old_ast(old_state: GlobalState) {
     *old_ast = Some(old_state);
 }
 
-pub(crate) async fn read_old_memory() -> Option<(Stack, ModuleInfoMap)> {
+pub(crate) async fn read_old_memory() -> Option<SketchModeState> {
     let old_mem = PREV_MEMORY.read().await;
     old_mem.clone()
 }
 
-pub(crate) async fn write_old_memory(mem: (Stack, ModuleInfoMap)) {
+pub(crate) async fn write_old_memory(mem: SketchModeState) {
     let mut old_mem = PREV_MEMORY.write().await;
     *old_mem = Some(mem);
 }
@@ -134,6 +135,18 @@ pub(super) struct ModuleState {
     pub(super) result_env: EnvironmentRef,
 }
 
+/// Cached state for sketch mode.
+#[derive(Debug, Clone)]
+pub(crate) struct SketchModeState {
+    /// The stack of the main module.
+    pub stack: Stack,
+    /// The module info map.
+    pub module_infos: ModuleInfoMap,
+    /// The scene objects.
+    #[cfg_attr(not(feature = "artifact-graph"), expect(dead_code))]
+    pub scene_objects: Vec<Object>,
+}
+
 /// The result of a cache check.
 #[derive(Debug, Clone, PartialEq)]
 #[allow(clippy::large_enum_variant)]