SketchOnFace UI (#1664)

* always enter edit mode

* initial blocking of extra code-mirror updates

* dry out code

* rejig selections

* A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu)

* clean up

* stream clean up

* update export

* sketch mode can be entered and exited for extrude faces

But has bugs

* startSketchOn working in some cases, editsketch animation working but not orientation of instersection plane etc

* Revert "A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu)"

This reverts commit 406fca4c55.

* A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu)

* remove comment

* add sketch on face e2e test

* tweenCamToNegYAxis should respect reduced motion

* initial sketch on face working with test

* remove temporary toolbar button and xState flow

* un-used vars

* snapshot test tweak

* A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu)

* type tidy up

* Revert "A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu)"

This reverts commit c39b8ebf95.

* Revert "A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu)"

This reverts commit fecf6f490a.

* A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu)

* rename

* sketch on sketch on sketch

* A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu)

* typo

* startSketchOn Endcaps

end works, start is weird still

* clear selections for entity_ids that are not recognised

* fix sketch on end cap of second order extrustion

* tiny clean up

* fix sketch on close segment/face

* clean up 'lastCodeMirrorSelectionUpdatedFromScene'

* add code mode test for sketchOnExtrudedFace

* make end cap selection more robust

* update js artifacts for extrudes

* update kcl docs

* clean up

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

src/lang/modifyAst.test.ts

@@ -12,8 +12,10 @@ import {
   addSketchTo,
   giveSketchFnCallTag,
   moveValueIntoNewVariable,
+  sketchOnExtrudedFace,
 } from './modifyAst'
 import { enginelessExecutor } from '../lib/testHelpers'
+import { getNodePathFromSourceRange } from './queryAst'
 
 beforeAll(() => initPromise)
 
@@ -274,3 +276,89 @@ const yo2 = hmm([identifierGuy + 5])`
     expect(newCode).toContain(`const yo2 = hmm([newVar])`)
   })
 })
+
+describe('testing sketchOnExtrudedFace', () => {
+  test('it should be able to extrude on regular segments', async () => {
+    const code = `const part001 = startSketchOn('-XZ')
+  |> startProfileAt([3.58, 2.06], %)
+  |> line([9.7, 9.19], %)
+  |> line([8.62, -9.57], %)
+  |> close(%)
+  |> extrude(5 + 7, %)`
+    const ast = parse(code)
+    const programMemory = await enginelessExecutor(ast)
+    const snippet = `line([9.7, 9.19], %)`
+    const range: [number, number] = [
+      code.indexOf(snippet),
+      code.indexOf(snippet) + snippet.length,
+    ]
+    const pathToNode = getNodePathFromSourceRange(ast, range)
+
+    const { modifiedAst } = sketchOnExtrudedFace(ast, pathToNode, programMemory)
+    const newCode = recast(modifiedAst)
+    expect(newCode).toContain(`const part001 = startSketchOn('-XZ')
+  |> startProfileAt([3.58, 2.06], %)
+  |> line([9.7, 9.19], %, 'seg01')
+  |> line([8.62, -9.57], %)
+  |> close(%)
+  |> extrude(5 + 7, %)
+const part002 = startSketchOn(part001, 'seg01')`)
+  })
+  test('it should be able to extrude on close segments', async () => {
+    const code = `const part001 = startSketchOn('-XZ')
+  |> startProfileAt([3.58, 2.06], %)
+  |> line([9.7, 9.19], %)
+  |> line([8.62, -9.57], %)
+  |> close(%)
+  |> extrude(5 + 7, %)`
+    const ast = parse(code)
+    const programMemory = await enginelessExecutor(ast)
+    const snippet = `close(%)`
+    const range: [number, number] = [
+      code.indexOf(snippet),
+      code.indexOf(snippet) + snippet.length,
+    ]
+    const pathToNode = getNodePathFromSourceRange(ast, range)
+
+    const { modifiedAst } = sketchOnExtrudedFace(ast, pathToNode, programMemory)
+    const newCode = recast(modifiedAst)
+    expect(newCode).toContain(`const part001 = startSketchOn('-XZ')
+  |> startProfileAt([3.58, 2.06], %)
+  |> line([9.7, 9.19], %)
+  |> line([8.62, -9.57], %)
+  |> close(%, 'seg01')
+  |> extrude(5 + 7, %)
+const part002 = startSketchOn(part001, 'seg01')`)
+  })
+  test('it should be able to extrude on start-end caps', async () => {
+    const code = `const part001 = startSketchOn('-XZ')
+  |> startProfileAt([3.58, 2.06], %)
+  |> line([9.7, 9.19], %)
+  |> line([8.62, -9.57], %)
+  |> close(%)
+  |> extrude(5 + 7, %)`
+    const ast = parse(code)
+    const programMemory = await enginelessExecutor(ast)
+    const snippet = `startProfileAt([3.58, 2.06], %)`
+    const range: [number, number] = [
+      code.indexOf(snippet),
+      code.indexOf(snippet) + snippet.length,
+    ]
+    const pathToNode = getNodePathFromSourceRange(ast, range)
+
+    const { modifiedAst } = sketchOnExtrudedFace(
+      ast,
+      pathToNode,
+      programMemory,
+      'end'
+    )
+    const newCode = recast(modifiedAst)
+    expect(newCode).toContain(`const part001 = startSketchOn('-XZ')
+  |> startProfileAt([3.58, 2.06], %)
+  |> line([9.7, 9.19], %)
+  |> line([8.62, -9.57], %)
+  |> close(%)
+  |> extrude(5 + 7, %)
+const part002 = startSketchOn(part001, 'END')`)
+  })
+})