KCL: Make shell stdlib fn use keyword arguments (#5293)

Before:

```
shell({ faces = ['end'], thickness = caseThickness }, case)
```

After:
```
shell(case, faces = ['end'], thickness = caseThickness)
```

docs/kcl/patternTransform2d.md

@@ -9,7 +9,7 @@ Just like patternTransform, but works on 2D sketches not 3D solids.
 
 
 ```js
-patternTransform2d(total_instances: integer, transform_function: FunctionParam, solid_set: SketchSet) -> [Sketch]
+patternTransform2d(total_instances: integer, transform_function: FunctionParam, solid_set: SketchSet, use_original?: bool) -> [Sketch]
 ```
 
 
@@ -20,6 +20,7 @@ patternTransform2d(total_instances: integer, transform_function: FunctionParam,
 | `total_instances` | `integer` |  | Yes |
 | `transform_function` | `FunctionParam` |  | Yes |
 | `solid_set` | [`SketchSet`](/docs/kcl/types/SketchSet) | A sketch or a group of sketches. | Yes |
+| `use_original` | `bool` |  | No |
 
 ### Returns
 

docs/kcl/types/ArtifactId.md

@@ -0,0 +1,15 @@
+---
+title: "ArtifactId"
+excerpt: ""
+layout: manual
+---
+
+
+**Type:** `string` (`uuid`)
+
+
+
+
+
+
+

docs/kcl/types/CircularPattern2dData.md

@@ -20,5 +20,6 @@ Data for a circular pattern on a 2D sketch.
 | `center` |`[number, number]`| The center about which to make the pattern. This is a 2D vector. | No |
 | `arcDegrees` |`number`| The arc angle (in degrees) to place the repetitions. Must be greater than 0. | No |
 | `rotateDuplicates` |`boolean`| Whether or not to rotate the duplicates as they are copied. | No |
+| `useOriginal` |`boolean`| If the target being patterned is itself a pattern, then, should you use the original solid, or the pattern? | No |
 
 

docs/kcl/types/CircularPattern3dData.md

@@ -21,5 +21,6 @@ Data for a circular pattern on a 3D model.
 | `center` |`[number, number, number]`| The center about which to make the pattern. This is a 3D vector. | No |
 | `arcDegrees` |`number`| The arc angle (in degrees) to place the repetitions. Must be greater than 0. | No |
 | `rotateDuplicates` |`boolean`| Whether or not to rotate the duplicates as they are copied. | No |
+| `useOriginal` |`boolean`| If the target being patterned is itself a pattern, then, should you use the original solid, or the pattern? | No |
 
 

docs/kcl/types/Face.md

@@ -17,6 +17,7 @@ A face.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `id` |`string`| The id of the face. | No |
+| `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The artifact ID. | No |
 | `value` |`string`| The tag of the face. | No |
 | `xAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the face’s X axis be? | No |
 | `yAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the face’s Y axis be? | No |

docs/kcl/types/Helix.md

@@ -17,6 +17,7 @@ A helix.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `value` |`string`| The id of the helix. | No |
+| `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The artifact ID. | No |
 | `revolutions` |`number`| Number of revolutions. | No |
 | `angleStart` |`number`| Start angle (in degrees). | No |
 | `ccw` |`boolean`| Is the helix rotation counter clockwise? | No |

docs/kcl/types/HelixData.md

@@ -1,26 +0,0 @@
----
-title: "HelixData"
-excerpt: "Data for a helix."
-layout: manual
----
-
-Data for a helix.
-
-**Type:** `object`
-
-
-
-
-
-## Properties
-
-| Property | Type | Description | Required |
-|----------|------|-------------|----------|
-| `revolutions` |`number`| Number of revolutions. | No |
-| `angleStart` |`number`| Start angle (in degrees). | No |
-| `ccw` |`boolean`| Is the helix rotation counter clockwise? The default is `false`. | No |
-| `length` |`number`| Length of the helix. This is not necessary if the helix is created around an edge. If not given the length of the edge is used. | No |
-| `radius` |`number`| Radius of the helix. | No |
-| `axis` |[`Axis3dOrEdgeReference`](/docs/kcl/types/Axis3dOrEdgeReference)| Axis to use as mirror. | No |
-
-

docs/kcl/types/HelixValue.md

@@ -17,6 +17,7 @@ A helix.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `value` |`string`| The id of the helix. | No |
+| `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The artifact ID. | No |
 | `revolutions` |`number`| Number of revolutions. | No |
 | `angleStart` |`number`| Start angle (in degrees). | No |
 | `ccw` |`boolean`| Is the helix rotation counter clockwise? | No |

docs/kcl/types/Plane.md

@@ -17,6 +17,7 @@ A plane.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `id` |`string`| The id of the plane. | No |
+| `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The artifact ID. | No |
 | `value` |[`PlaneType`](/docs/kcl/types/PlaneType)| A plane. | No |
 | `origin` |[`Point3d`](/docs/kcl/types/Point3d)| Origin of the plane. | No |
 | `xAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the plane’s X axis be? | No |

docs/kcl/types/Sketch.md

@@ -21,6 +21,8 @@ A sketch is a collection of paths.
 | `on` |[`SketchSurface`](/docs/kcl/types/SketchSurface)| What the sketch is on (can be a plane or a face). | No |
 | `start` |[`BasePath`](/docs/kcl/types/BasePath)| The starting path. | No |
 | `tags` |`object`| Tag identifiers that have been declared in this sketch. | No |
+| `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The original id of the sketch. This stays the same even if the sketch is is sketched on face etc. | No |
+| `originalId` |`string`|  | No |
 | `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A sketch is a collection of paths. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`| Metadata. | No |
 

docs/kcl/types/SketchSet.md

@@ -30,6 +30,8 @@ A sketch is a collection of paths.
 | `on` |[`SketchSurface`](/docs/kcl/types/SketchSurface)| What the sketch is on (can be a plane or a face). | No |
 | `start` |[`BasePath`](/docs/kcl/types/BasePath)| The starting path. | No |
 | `tags` |`object`| Tag identifiers that have been declared in this sketch. | No |
+| `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The original id of the sketch. This stays the same even if the sketch is is sketched on face etc. | No |
+| `originalId` |`string`|  | No |
 | `units` |[`UnitLen`](/docs/kcl/types/UnitLen)| A sketch or a group of sketches. | No |
 | `__meta` |`[` [`Metadata`](/docs/kcl/types/Metadata) `]`| Metadata. | No |
 

docs/kcl/types/SketchSurface.md

@@ -26,6 +26,7 @@ A plane.
 |----------|------|-------------|----------|
 | `type` |enum: `plane`|  | No |
 | `id` |`string`| The id of the plane. | No |
+| `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The artifact ID. | No |
 | `value` |[`PlaneType`](/docs/kcl/types/PlaneType)| A sketch type. | No |
 | `origin` |[`Point3d`](/docs/kcl/types/Point3d)| Origin of the plane. | No |
 | `xAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the plane’s X axis be? | No |
@@ -50,6 +51,7 @@ A face.
 |----------|------|-------------|----------|
 | `type` |enum: `face`|  | No |
 | `id` |`string`| The id of the face. | No |
+| `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The artifact ID. | No |
 | `value` |`string`| The tag of the face. | No |
 | `xAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the face’s X axis be? | No |
 | `yAxis` |[`Point3d`](/docs/kcl/types/Point3d)| What should the face’s Y axis be? | No |

docs/kcl/types/Solid.md

@@ -17,6 +17,7 @@ An solid is a collection of extrude surfaces.
 | Property | Type | Description | Required |
 |----------|------|-------------|----------|
 | `id` |`string`| The id of the solid. | No |
+| `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The artifact ID of the solid.  Unlike `id`, this doesn't change. | No |
 | `value` |`[` [`ExtrudeSurface`](/docs/kcl/types/ExtrudeSurface) `]`| The extrude surfaces. | No |
 | `sketch` |[`Sketch`](/docs/kcl/types/Sketch)| The sketch. | No |
 | `height` |`number`| The height of the solid. | No |

docs/kcl/types/SolidSet.md

@@ -26,6 +26,7 @@ An solid is a collection of extrude surfaces.
 |----------|------|-------------|----------|
 | `type` |enum: `solid`|  | No |
 | `id` |`string`| The id of the solid. | No |
+| `artifactId` |[`ArtifactId`](/docs/kcl/types/ArtifactId)| The artifact ID of the solid.  Unlike `id`, this doesn't change. | No |
 | `value` |`[` [`ExtrudeSurface`](/docs/kcl/types/ExtrudeSurface) `]`| The extrude surfaces. | No |
 | `sketch` |[`Sketch`](/docs/kcl/types/Sketch)| The sketch. | No |
 | `height` |`number`| The height of the solid. | No |

e2e/playwright/feature-tree-pane.spec.ts

@@ -35,6 +35,30 @@ sketch002 = startSketchOn(plane001)
 extrude001 = extrude(sketch002, length = 10)
 `
 
+const FEAUTRE_TREE_SKETCH_CODE = `sketch001 = startSketchOn('XZ')
+  |> startProfileAt([0, 0], %)
+  |> angledLine([0, 4], %, $rectangleSegmentA001)
+  |> angledLine([
+       segAng(rectangleSegmentA001) - 90,
+       2
+     ], %, $rectangleSegmentB001)
+  |> angledLine([
+       segAng(rectangleSegmentA001),
+       -segLen(rectangleSegmentA001)
+     ], %, $rectangleSegmentC001)
+  |> line(endAbsolute = [profileStartX(%), profileStartY(%)])
+  |> close(%)
+extrude001 = extrude(sketch001, length = 10)
+sketch002 = startSketchOn(extrude001, rectangleSegmentB001)
+  |> circle({
+       center = [-1, 2],
+       radius = .5
+     }, %)
+plane001 = offsetPlane('XZ', -5)
+sketch003 = startSketchOn(plane001)
+  |> circle({ center = [0, 0], radius = 5 }, %)
+`
+
 test.describe('Feature Tree pane', () => {
   test(
     'User can go to definition and go to function definition',
@@ -124,4 +148,267 @@ test.describe('Feature Tree pane', () => {
       })
     }
   )
+
+  test(
+    `User can edit sketch (but not on offset plane yet) from the feature tree`,
+    { tag: '@electron' },
+    async ({ context, homePage, scene, editor, toolbar, page }) => {
+      const unavailableToastMessage = page.getByText(
+        'Editing sketches on faces or offset planes through the feature tree is not yet supported'
+      )
+
+      await context.folderSetupFn(async (dir) => {
+        const bracketDir = join(dir, 'test-sample')
+        await fsp.mkdir(bracketDir, { recursive: true })
+        await fsp.writeFile(
+          join(bracketDir, 'main.kcl'),
+          FEAUTRE_TREE_SKETCH_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 toolbar.openFeatureTreePane()
+      })
+
+      await test.step('On a default plane should work', async () => {
+        await (await toolbar.getFeatureTreeOperation('Sketch', 0)).dblclick()
+        await expect(
+          toolbar.exitSketchBtn,
+          'We should be in sketch mode now'
+        ).toBeVisible()
+        await editor.expectState({
+          highlightedCode: '',
+          diagnostics: [],
+          activeLines: ["sketch001 = startSketchOn('XZ')"],
+        })
+        await toolbar.exitSketchBtn.click()
+      })
+
+      await test.step('On an extrude face should *not* work', async () => {
+        // Tooltip is getting in the way of clicking, so I'm first closing the pane
+        await toolbar.closeFeatureTreePane()
+        await (await toolbar.getFeatureTreeOperation('Sketch', 1)).dblclick()
+        await expect(
+          unavailableToastMessage,
+          'We should see a toast message about this'
+        ).toBeVisible()
+        await unavailableToastMessage.waitFor({ state: 'detached' })
+        // TODO - turn on once we update the artifactGraph in Rust
+        // to include the proper source location for the extrude face
+        // await expect(
+        //   toolbar.exitSketchBtn,
+        //   'We should be in sketch mode now'
+        // ).toBeVisible()
+        // await editor.expectState({
+        //   highlightedCode: '',
+        //   diagnostics: [],
+        //   activeLines: ['|>circle({center=[-1,2],radius=.5},%)'],
+        // })
+        // await toolbar.exitSketchBtn.click()
+      })
+
+      await test.step('On an offset plane should *not* work', async () => {
+        // Tooltip is getting in the way of clicking, so I'm first closing the pane
+        await toolbar.closeFeatureTreePane()
+        await (await toolbar.getFeatureTreeOperation('Sketch', 2)).dblclick()
+        await editor.expectState({
+          highlightedCode: '',
+          diagnostics: [],
+          activeLines: ['|>circle({center=[0,0],radius=5},%)'],
+        })
+        await expect(
+          toolbar.exitSketchBtn,
+          'We should not be in sketch mode now'
+        ).not.toBeVisible()
+        await expect(
+          page.getByText(
+            'Editing sketches on faces or offset planes through the feature tree is not yet supported'
+          ),
+          'We should see a toast message about this'
+        ).toBeVisible()
+      })
+    }
+  )
+  test(`User can edit an extrude operation from the feature tree`, async ({
+    context,
+    homePage,
+    scene,
+    editor,
+    toolbar,
+    cmdBar,
+    page,
+  }) => {
+    const initialInput = '23'
+    const initialCode = `sketch001 = startSketchOn('XZ')
+      |> circle({ center = [0, 0], radius = 5 }, %)
+      renamedExtrude = extrude(sketch001, length = ${initialInput})`
+    const newConstantName = 'distance001'
+    const expectedCode = `sketch001 = startSketchOn('XZ')
+      |> circle({ center = [0, 0], radius = 5 }, %)
+      ${newConstantName} = 23
+      renamedExtrude = extrude(sketch001, length = ${newConstantName})`
+
+    await context.folderSetupFn(async (dir) => {
+      const testDir = join(dir, 'test-sample')
+      await fsp.mkdir(testDir, { recursive: true })
+      await fsp.writeFile(join(testDir, 'main.kcl'), initialCode, '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 toolbar.openFeatureTreePane()
+    })
+
+    await test.step('Double click on the extrude operation', async () => {
+      await (await toolbar.getFeatureTreeOperation('Extrude', 0))
+        .first()
+        .dblclick()
+      await editor.expectState({
+        highlightedCode: '',
+        diagnostics: [],
+        activeLines: [
+          `renamedExtrude = extrude(sketch001, length = ${initialInput})`,
+        ],
+      })
+      await cmdBar.expectState({
+        commandName: 'Extrude',
+        stage: 'arguments',
+        currentArgKey: 'distance',
+        currentArgValue: initialInput,
+        headerArguments: {
+          Selection: '1 face',
+          Distance: initialInput,
+        },
+        highlightedHeaderArg: 'distance',
+      })
+    })
+
+    await test.step('Add a named constant for distance argument and submit', async () => {
+      await expect(cmdBar.currentArgumentInput).toBeVisible()
+      const addVariableButton = page.getByRole('button', {
+        name: 'Create new variable',
+      })
+      await addVariableButton.click()
+      await cmdBar.progressCmdBar()
+      await cmdBar.expectState({
+        stage: 'review',
+        headerArguments: {
+          Selection: '1 face',
+          // The calculated value is shown in the argument summary
+          Distance: initialInput,
+        },
+        commandName: 'Extrude',
+      })
+      await cmdBar.progressCmdBar()
+      await editor.expectState({
+        highlightedCode: '',
+        diagnostics: [],
+        activeLines: [
+          `renamedExtrude = extrude(sketch001, length = ${newConstantName})`,
+        ],
+      })
+      await editor.expectEditor.toContain(expectedCode, {
+        shouldNormalise: true,
+      })
+    })
+  })
+  test(`User can edit an offset plane operation from the feature tree`, async ({
+    context,
+    homePage,
+    scene,
+    editor,
+    toolbar,
+    cmdBar,
+  }) => {
+    const testCode = (value: string) => `p = offsetPlane('XY', ${value})`
+    const initialInput = '10'
+    const initialCode = testCode(initialInput)
+    const newInput = '5 + 10'
+    const expectedCode = testCode(newInput)
+    await context.folderSetupFn(async (dir) => {
+      const testDir = join(dir, 'test-sample')
+      await fsp.mkdir(testDir, { recursive: true })
+      await fsp.writeFile(join(testDir, 'main.kcl'), initialCode, '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 toolbar.openFeatureTreePane()
+    })
+
+    await test.step('Double click on the offset plane operation', async () => {
+      await (await toolbar.getFeatureTreeOperation('Offset Plane', 0))
+        .first()
+        .dblclick()
+      await editor.expectState({
+        highlightedCode: '',
+        diagnostics: [],
+        activeLines: [initialCode],
+      })
+      await cmdBar.expectState({
+        commandName: 'Offset plane',
+        stage: 'arguments',
+        currentArgKey: 'distance',
+        currentArgValue: initialInput,
+        headerArguments: {
+          Plane: '1 plane',
+          Distance: initialInput,
+        },
+        highlightedHeaderArg: 'distance',
+      })
+    })
+
+    await test.step('Edit the distance argument and submit', async () => {
+      await expect(cmdBar.currentArgumentInput).toBeVisible()
+      await cmdBar.currentArgumentInput.locator('.cm-content').fill(newInput)
+      await cmdBar.progressCmdBar()
+      await cmdBar.expectState({
+        stage: 'review',
+        headerArguments: {
+          Plane: '1 plane',
+          // We show the calculated value in the argument summary
+          Distance: '15',
+        },
+        commandName: 'Offset plane',
+      })
+      await cmdBar.progressCmdBar()
+      await editor.expectState({
+        highlightedCode: '',
+        diagnostics: [],
+        activeLines: [expectedCode],
+      })
+    })
+  })
 })

e2e/playwright/fixtures/cmdBarFixture.ts

@@ -26,11 +26,18 @@ type CmdBarSerialised =
 export class CmdBarFixture {
   public page: Page
   cmdBarOpenBtn!: Locator
+  cmdBarElement!: Locator
 
   constructor(page: Page) {
     this.page = page
     this.cmdBarOpenBtn = page.getByTestId('command-bar-open-button')
+    this.cmdBarElement = page.getByTestId('command-bar')
   }
+
+  get currentArgumentInput() {
+    return this.page.getByTestId('cmd-bar-arg-value')
+  }
+
   reConstruct = (page: Page) => {
     this.page = page
   }

e2e/playwright/fixtures/sceneFixture.ts

@@ -38,7 +38,10 @@ export class SceneFixture {
   public page: Page
   public streamWrapper!: Locator
   public loadingIndicator!: Locator
-  private exeIndicator!: Locator
+
+  get exeIndicator() {
+    return this.page.getByTestId('model-state-indicator-execution-done')
+  }
 
   constructor(page: Page) {
     this.page = page
@@ -64,7 +67,6 @@ export class SceneFixture {
   reConstruct = (page: Page) => {
     this.page = page
 
-    this.exeIndicator = page.getByTestId('model-state-indicator-execution-done')
     this.streamWrapper = page.getByTestId('stream')
     this.loadingIndicator = this.streamWrapper.getByTestId('loading')
   }

e2e/playwright/fixtures/toolbarFixture.ts

@@ -29,7 +29,6 @@ export class ToolbarFixture {
   createFileBtn!: Locator
   fileCreateToast!: Locator
   filePane!: Locator
-  exeIndicator!: Locator
   treeInputField!: Locator
   /** The sidebar button for the Feature Tree pane */
   featureTreeId = 'feature-tree' as const
@@ -62,15 +61,16 @@ export class ToolbarFixture {
     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-receive-reliable'
-    )
   }
 
   get logoLink() {
     return this.page.getByTestId('app-logo')
   }
 
+  get exeIndicator() {
+    return this.page.getByTestId('model-state-indicator-receive-reliable')
+  }
+
   startSketchPlaneSelection = async () =>
     doAndWaitForImageDiff(this.page, () => this.startSketchBtn.click(), 500)
 
@@ -139,7 +139,8 @@ export class ToolbarFixture {
   }
 
   /**
-   * Get a specific operation button from the Feature Tree pane
+   * Get a specific operation button from the Feature Tree pane.
+   * Index is 0-based.
    */
   async getFeatureTreeOperation(operationName: string, operationIndex: number) {
     await this.openFeatureTreePane()

e2e/playwright/point-click.spec.ts

@@ -1890,7 +1890,7 @@ chamfer04 = chamfer({  length = 5,  tags = [getOppositeEdge(seg02)]}, extrude001
       const testPoint = { x: 575, y: 200 }
       const [clickOnCap] = scene.makeMouseHelpers(testPoint.x, testPoint.y)
       const shellDeclaration =
-        "shell001 = shell({ faces = ['end'], thickness = 5 }, extrude001)"
+        "shell001 = shell(extrude001, faces = ['end'], thickness = 5)"
 
       await test.step(`Look for the grey of the shape`, async () => {
         await scene.expectPixelColor([127, 127, 127], testPoint, 15)
@@ -1990,8 +1990,7 @@ extrude001 = extrude(sketch001, length = 40)
     const [clickOnWall] = scene.makeMouseHelpers(testPoint.x, testPoint.y + 70)
     const mutatedCode = 'xLine(-40, %, $seg01)'
     const shellDeclaration =
-      "shell001 = shell({  faces = ['end', seg01],  thickness = 5}, extrude001)"
-    const formattedOutLastLine = '}, extrude001)'
+      "shell001 = shell(extrude001, faces = ['end', seg01], thickness = 5)"
 
     await test.step(`Look for the grey of the shape`, async () => {
       await scene.expectPixelColor([99, 99, 99], testPoint, 15)
@@ -2034,7 +2033,7 @@ extrude001 = extrude(sketch001, length = 40)
       await editor.expectEditor.toContain(shellDeclaration)
       await editor.expectState({
         diagnostics: [],
-        activeLines: [formattedOutLastLine],
+        activeLines: [shellDeclaration],
         highlightedCode: '',
       })
       await scene.expectPixelColor([49, 49, 49], testPoint, 15)
@@ -2088,9 +2087,8 @@ extrude002 = extrude(sketch002, length = 50)
       // One dumb hardcoded screen pixel value
       const testPoint = { x: 550, y: 295 }
       const [clickOnCap] = scene.makeMouseHelpers(testPoint.x, testPoint.y)
-      const shellDeclaration = `shell001 = shell({ faces = ['end'], thickness = 5 }, ${
-        hasExtrudesInPipe ? 'sketch002' : 'extrude002'
-      })`
+      const shellTarget = hasExtrudesInPipe ? 'sketch002' : 'extrude002'
+      const shellDeclaration = `shell001 = shell(${shellTarget}, faces = ['end'], thickness = 5)`
 
       await test.step(`Look for the grey of the shape`, async () => {
         await toolbar.closePane('code')

e2e/playwright/prompt-to-edit.spec.ts

@@ -35,106 +35,108 @@ sketch003 = startSketchOn('XY')
 extrude003 = extrude(sketch003, length = 20)
 `
 
-test.fixme('Check the happy path, for basic changing color', () => {
-  const cases = [
-    {
-      desc: 'User accepts change',
-      shouldReject: false,
-    },
-    {
-      desc: 'User rejects change',
-      shouldReject: true,
-    },
-  ] as const
-  for (const { desc, shouldReject } of cases) {
-    test(`${desc}`, async ({
-      context,
-      homePage,
-      cmdBar,
-      editor,
-      page,
-      scene,
-    }) => {
-      await context.addInitScript((file) => {
-        localStorage.setItem('persistCode', file)
-      }, file)
-      await homePage.goToModelingScene()
+test.describe('Prompt-to-edit tests', { tag: '@skipWin' }, () => {
+  test.describe('Check the happy path, for basic changing color', () => {
+    const cases = [
+      {
+        desc: 'User accepts change',
+        shouldReject: false,
+      },
+      {
+        desc: 'User rejects change',
+        shouldReject: true,
+      },
+    ] as const
+    for (const { desc, shouldReject } of cases) {
+      test(`${desc}`, async ({
+        context,
+        homePage,
+        cmdBar,
+        editor,
+        page,
+        scene,
+      }) => {
+        await context.addInitScript((file) => {
+          localStorage.setItem('persistCode', file)
+        }, file)
+        await homePage.goToModelingScene()
 
-      const body1CapCoords = { x: 571, y: 351 }
-      const greenCheckCoords = { x: 565, y: 345 }
-      const body2WallCoords = { x: 609, y: 153 }
-      const [clickBody1Cap] = scene.makeMouseHelpers(
-        body1CapCoords.x,
-        body1CapCoords.y
-      )
-      const yellow: [number, number, number] = [179, 179, 131]
-      const green: [number, number, number] = [108, 152, 75]
-      const notGreen: [number, number, number] = [132, 132, 132]
-      const body2NotGreen: [number, number, number] = [88, 88, 88]
-      const submittingToast = page.getByText('Submitting to Text-to-CAD API...')
-      const successToast = page.getByText('Prompt to edit successful')
-      const acceptBtn = page.getByRole('button', { name: 'checkmark Accept' })
-      const rejectBtn = page.getByRole('button', { name: 'close Reject' })
+        const body1CapCoords = { x: 571, y: 351 }
+        const greenCheckCoords = { x: 565, y: 345 }
+        const body2WallCoords = { x: 609, y: 153 }
+        const [clickBody1Cap] = scene.makeMouseHelpers(
+          body1CapCoords.x,
+          body1CapCoords.y
+        )
+        const yellow: [number, number, number] = [179, 179, 131]
+        const green: [number, number, number] = [108, 152, 75]
+        const notGreen: [number, number, number] = [132, 132, 132]
+        const body2NotGreen: [number, number, number] = [88, 88, 88]
+        const submittingToast = page.getByText(
+          'Submitting to Text-to-CAD API...'
+        )
+        const successToast = page.getByText('Prompt to edit successful')
+        const acceptBtn = page.getByRole('button', { name: 'checkmark Accept' })
+        const rejectBtn = page.getByRole('button', { name: 'close Reject' })
 
-      await test.step('wait for scene to load select body and check selection came through', async () => {
-        await scene.expectPixelColor([134, 134, 134], body1CapCoords, 15)
-        await clickBody1Cap()
-        await scene.expectPixelColor(yellow, body1CapCoords, 20)
-        await editor.expectState({
-          highlightedCode: '',
-          activeLines: ['|>startProfileAt([-73.64,-42.89],%)'],
-          diagnostics: [],
+        await test.step('wait for scene to load select body and check selection came through', async () => {
+          await scene.expectPixelColor([134, 134, 134], body1CapCoords, 15)
+          await clickBody1Cap()
+          await scene.expectPixelColor(yellow, body1CapCoords, 20)
+          await editor.expectState({
+            highlightedCode: '',
+            activeLines: ['|>startProfileAt([-73.64,-42.89],%)'],
+            diagnostics: [],
+          })
         })
-      })
 
-      await test.step('fire off edit prompt', async () => {
-        await cmdBar.openCmdBar('promptToEdit')
-        // being specific about the color with a hex means asserting pixel color is more stable
-        await page
-          .getByTestId('cmd-bar-arg-value')
-          .fill('make this neon green please, use #39FF14')
-        await page.waitForTimeout(100)
-        await cmdBar.progressCmdBar()
-        await expect(submittingToast).toBeVisible()
-        await expect(submittingToast).not.toBeVisible({ timeout: 2 * 60_000 }) // can take a while
-        await expect(successToast).toBeVisible()
-      })
-
-      await test.step('verify initial change', async () => {
-        await scene.expectPixelColor(green, greenCheckCoords, 15)
-        await scene.expectPixelColor(body2NotGreen, body2WallCoords, 15)
-        await editor.expectEditor.toContain('appearance({')
-      })
-
-      if (!shouldReject) {
-        await test.step('check accept works and can be "undo"ed', async () => {
-          await acceptBtn.click()
-          await expect(successToast).not.toBeVisible()
+        await test.step('fire off edit prompt', async () => {
+          await cmdBar.openCmdBar('promptToEdit')
+          // being specific about the color with a hex means asserting pixel color is more stable
+          await page
+            .getByTestId('cmd-bar-arg-value')
+            .fill('make this neon green please, use #39FF14')
+          await page.waitForTimeout(100)
+          await cmdBar.progressCmdBar()
+          await expect(submittingToast).toBeVisible()
+          await expect(submittingToast).not.toBeVisible({ timeout: 2 * 60_000 }) // can take a while
+          await expect(successToast).toBeVisible()
+        })
 
+        await test.step('verify initial change', async () => {
           await scene.expectPixelColor(green, greenCheckCoords, 15)
+          await scene.expectPixelColor(body2NotGreen, body2WallCoords, 15)
           await editor.expectEditor.toContain('appearance({')
-
-          // ctrl-z works after accepting
-          await page.keyboard.down('ControlOrMeta')
-          await page.keyboard.press('KeyZ')
-          await page.keyboard.up('ControlOrMeta')
-          await editor.expectEditor.not.toContain('appearance({')
-          await scene.expectPixelColor(notGreen, greenCheckCoords, 15)
         })
-      } else {
-        await test.step('check reject works', async () => {
-          await rejectBtn.click()
-          await expect(successToast).not.toBeVisible()
 
-          await scene.expectPixelColor(notGreen, greenCheckCoords, 15)
-          await editor.expectEditor.not.toContain('appearance({')
-        })
-      }
-    })
-  }
-})
+        if (!shouldReject) {
+          await test.step('check accept works and can be "undo"ed', async () => {
+            await acceptBtn.click()
+            await expect(successToast).not.toBeVisible()
+
+            await scene.expectPixelColor(green, greenCheckCoords, 15)
+            await editor.expectEditor.toContain('appearance({')
+
+            // ctrl-z works after accepting
+            await page.keyboard.down('ControlOrMeta')
+            await page.keyboard.press('KeyZ')
+            await page.keyboard.up('ControlOrMeta')
+            await editor.expectEditor.not.toContain('appearance({')
+            await scene.expectPixelColor(notGreen, greenCheckCoords, 15)
+          })
+        } else {
+          await test.step('check reject works', async () => {
+            await rejectBtn.click()
+            await expect(successToast).not.toBeVisible()
+
+            await scene.expectPixelColor(notGreen, greenCheckCoords, 15)
+            await editor.expectEditor.not.toContain('appearance({')
+          })
+        }
+      })
+    }
+  })
 
-test.describe('bad path', { tag: ['@skipWin'] }, () => {
   test(`bad edit prompt`, async ({
     context,
     homePage,

e2e/playwright/regression-tests.spec.ts

@@ -253,7 +253,7 @@ extrude001 = extrude(sketch001, length = 50)
       |>
   
     example = extrude(exampleSketch, length = 5)
-    shell({ faces: ['end'], thickness: 0.25 }, exampleSketch)`
+    shell(exampleSketch, faces = ['end'], thickness = 0.25)`
         )
       })
 
@@ -314,6 +314,7 @@ extrude001 = extrude(sketch001, length = 50)
   )
 
   test('when engine fails export we handle the failure and alert the user', async ({
+    scene,
     page,
     homePage,
   }) => {
@@ -383,10 +384,7 @@ extrude001 = extrude(sketch001, length = 50)
     await page.keyboard.press('End')
     await page.keyboard.press('Enter')
 
-    // wait for execution done
-    await u.openDebugPanel()
-    await u.expectCmdLog('[data-message-type="execution-done"]')
-    await u.closeDebugPanel()
+    await scene.waitForExecutionDone()
 
     // Now try exporting
 

e2e/playwright/sketch-tests.spec.ts

@@ -15,6 +15,7 @@ test.describe('Sketch tests', { tag: ['@skipWin'] }, () => {
     page,
     context,
     homePage,
+    scene,
   }) => {
     const u = await getUtils(page)
     const selectionsSnippets = {
@@ -75,6 +76,7 @@ test.describe('Sketch tests', { tag: ['@skipWin'] }, () => {
     await page.setBodyDimensions({ width: 1200, height: 500 })
 
     await homePage.goToModelingScene()
+    await scene.waitForExecutionDone()
 
     // wait for execution done
     await u.openDebugPanel()