First draft of a feature tree pane (#4782)

2024-12-20 16:19:59 -05:00
parent 1d06cc7845
commit c02e31a530
78 changed files with 1466 additions and 65 deletions
--- a/e2e/playwright/feature-tree-pane.spec.ts
+++ b/e2e/playwright/feature-tree-pane.spec.ts
@ -0,0 +1,127 @@
+import { test, expect } from './zoo-test'
+import * as fsp from 'fs/promises'
+import { join } from 'path'
+
+const FEATURE_TREE_EXAMPLE_CODE = `export fn timesFive(x) {
+  return 5 * x
+}
+export fn triangle() {
+  return startSketchOn('XZ')
+    |> startProfileAt([0, 0], %)
+    |> xLine(10, %)
+    |> line([-10, -5], %)
+    |> lineTo([profileStartX(%), profileStartY(%)], %)
+    |> close(%)
+}
+
+length001 = timesFive(1) * 5
+sketch001 = startSketchOn('XZ')
+  |> startProfileAt([20, 10], %)
+  |> line([10, 10], %)
+  |> angledLine([-45, length001], %)
+  |> lineTo([profileStartX(%), profileStartY(%)], %)
+  |> close(%)
+revolve001 = revolve({ axis = "X" }, sketch001)
+triangle()
+  |> extrude(30, %)
+plane001 = offsetPlane('XY', 10)
+sketch002 = startSketchOn(plane001)
+  |> startProfileAt([-20, 0], %)
+  |> line([5, -15], %)
+  |> xLine(-10, %)
+  |> lineTo([-40, 0], %)
+  |> lineTo([profileStartX(%), profileStartY(%)], %)
+  |> close(%)
+extrude001 = extrude(10, sketch002)
+`
+
+test.describe('Feature Tree pane', () => {
+  test(
+    'User can go to definition and go to function definition',
+    { tag: '@electron' },
+    async ({ context, homePage, scene, editor, toolbar }) => {
+      await context.folderSetupFn(async (dir) => {
+        const bracketDir = join(dir, 'test-sample')
+        await fsp.mkdir(bracketDir, { recursive: true })
+        await fsp.writeFile(
+          join(bracketDir, 'main.kcl'),
+          FEATURE_TREE_EXAMPLE_CODE,
+          'utf-8'
+        )
+      })
+
+      await test.step('setup test', async () => {
+        await homePage.expectState({
+          projectCards: [
+            {
+              title: 'test-sample',
+              fileCount: 1,
+            },
+          ],
+          sortBy: 'last-modified-desc',
+        })
+        await homePage.openProject('test-sample')
+        await scene.waitForExecutionDone()
+        await editor.closePane()
+        await toolbar.openFeatureTreePane()
+      })
+
+      async function testViewSource({
+        operationName,
+        operationIndex,
+        expectedActiveLine,
+      }: {
+        operationName: string
+        operationIndex: number
+        expectedActiveLine: string
+      }) {
+        await test.step(`Go to definition of the ${operationName}`, async () => {
+          await toolbar.viewSourceOnOperation(operationName, operationIndex)
+          await editor.expectState({
+            highlightedCode: '',
+            diagnostics: [],
+            activeLines: [expectedActiveLine],
+          })
+          await expect(
+            editor.activeLine.first(),
+            `${operationName} code should be scrolled into view`
+          ).toBeVisible()
+        })
+      }
+
+      await testViewSource({
+        operationName: 'Offset Plane',
+        operationIndex: 0,
+        expectedActiveLine: "plane001 = offsetPlane('XY', 10)",
+      })
+      await testViewSource({
+        operationName: 'Extrude',
+        operationIndex: 1,
+        expectedActiveLine: 'extrude001 = extrude(10, sketch002)',
+      })
+      await testViewSource({
+        operationName: 'Revolve',
+        operationIndex: 0,
+        expectedActiveLine: 'revolve001 = revolve({ axis = "X" }, sketch001)',
+      })
+      await testViewSource({
+        operationName: 'Triangle',
+        operationIndex: 0,
+        expectedActiveLine: 'triangle()',
+      })
+
+      await test.step('Go to definition on the triangle function', async () => {
+        await toolbar.goToDefinitionOnOperation('Triangle', 0)
+        await editor.expectState({
+          highlightedCode: '',
+          diagnostics: [],
+          activeLines: ['export fn triangle() {'],
+        })
+        await expect(
+          editor.activeLine.first(),
+          'Triangle function definition should be scrolled into view'
+        ).toBeVisible()
+      })
+    }
+  )
+})