First draft of a feature tree pane (#4782)

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()
+      })
+    }
+  )
+})

e2e/playwright/fixtures/editorFixture.ts

@@ -20,7 +20,7 @@ export class EditorFixture {
   private diagnosticsTooltip!: Locator
   private diagnosticsGutterIcon!: Locator
   private codeContent!: Locator
-  private activeLine!: Locator
+  public activeLine!: Locator
 
   constructor(page: Page) {
     this.page = page

e2e/playwright/fixtures/toolbarFixture.ts

@@ -1,6 +1,13 @@
 import type { Page, Locator } from '@playwright/test'
 import { expect } from '../zoo-test'
-import { doAndWaitForImageDiff } from '../test-utils'
+import {
+  checkIfPaneIsOpen,
+  closePane,
+  doAndWaitForImageDiff,
+  openPane,
+} from '../test-utils'
+import { SidebarType } from 'components/ModelingSidebar/ModelingPanes'
+import { SIDEBAR_BUTTON_SUFFIX } from 'lib/constants'
 
 export class ToolbarFixture {
   public page: Page
@@ -20,6 +27,10 @@ export class ToolbarFixture {
   filePane!: Locator
   exeIndicator!: Locator
   treeInputField!: Locator
+  /** The sidebar button for the Feature Tree pane */
+  featureTreeId = 'feature-tree' as const
+  /** The pane element for the Feature Tree */
+  featureTreePane!: Locator
 
   constructor(page: Page) {
     this.page = page
@@ -41,6 +52,7 @@ export class ToolbarFixture {
     this.treeInputField = page.getByTestId('tree-input-field')
 
     this.filePane = page.locator('#files-pane')
+    this.featureTreePane = page.locator('#feature-tree-pane')
     this.fileCreateToast = page.getByText('Successfully created')
     this.exeIndicator = page.getByTestId('model-state-indicator-execution-done')
   }
@@ -91,4 +103,76 @@ export class ToolbarFixture {
       await expect(this.exeIndicator).toBeVisible({ timeout: 15_000 })
     }
   }
+
+  async closePane(paneId: SidebarType) {
+    return closePane(this.page, paneId + SIDEBAR_BUTTON_SUFFIX)
+  }
+  async openPane(paneId: SidebarType) {
+    return openPane(this.page, paneId + SIDEBAR_BUTTON_SUFFIX)
+  }
+  async checkIfPaneIsOpen(paneId: SidebarType) {
+    return checkIfPaneIsOpen(this.page, paneId + SIDEBAR_BUTTON_SUFFIX)
+  }
+
+  async openFeatureTreePane() {
+    return this.openPane(this.featureTreeId)
+  }
+  async closeFeatureTreePane() {
+    await this.closePane(this.featureTreeId)
+  }
+  async checkIfFeatureTreePaneIsOpen() {
+    return this.checkIfPaneIsOpen(this.featureTreeId)
+  }
+
+  /**
+   * Get a specific operation button from the Feature Tree pane
+   */
+  async getFeatureTreeOperation(operationName: string, operationIndex: number) {
+    await this.openFeatureTreePane()
+    await expect(this.featureTreePane).toBeVisible()
+    return this.featureTreePane
+      .getByRole('button', {
+        name: operationName,
+      })
+      .nth(operationIndex)
+  }
+
+  /**
+   * View source on a specific operation in the Feature Tree pane.
+   * @param operationName The name of the operation type
+   * @param operationIndex The index out of operations of this type
+   */
+  async viewSourceOnOperation(operationName: string, operationIndex: number) {
+    const operationButton = await this.getFeatureTreeOperation(
+      operationName,
+      operationIndex
+    )
+    const viewSourceMenuButton = this.page.getByRole('button', {
+      name: 'View KCL source code',
+    })
+
+    await operationButton.click({ button: 'right' })
+    await expect(viewSourceMenuButton).toBeVisible()
+    await viewSourceMenuButton.click()
+  }
+
+  /**
+   * Go to definition on a specific operation in the Feature Tree pane
+   */
+  async goToDefinitionOnOperation(
+    operationName: string,
+    operationIndex: number
+  ) {
+    const operationButton = await this.getFeatureTreeOperation(
+      operationName,
+      operationIndex
+    )
+    const goToDefinitionMenuButton = this.page.getByRole('button', {
+      name: 'View function definition',
+    })
+
+    await operationButton.click({ button: 'right' })
+    await expect(goToDefinitionMenuButton).toBeVisible()
+    await goToDefinitionMenuButton.click()
+  }
 }

e2e/playwright/testing-selections.spec.ts

@@ -486,7 +486,7 @@ test.describe('Testing selections', () => {
     await u.clearCommandLogs()
     await page.keyboard.press('Backspace')
 
-    await expect(page.getByText('Unable to delete part')).toBeVisible()
+    await expect(page.getByText('Unable to delete selection')).toBeVisible()
   })
   test('Hovering over 3d features highlights code, clicking puts the cursor in the right place and sends selection id to engine', async ({
     page,