Cut release v0.24.12 (#3458)

Co-authored-by: Frank Noirot <frank@zoo.dev>

.github/workflows/playwright.yml

@@ -35,7 +35,7 @@ jobs:
 
   playwright-ubuntu:
     timeout-minutes: 30
-    runs-on: ubuntu-latest-8-cores
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
@@ -112,7 +112,7 @@ jobs:
       run: yarn build:local
     - name: Run ubuntu/chrome snapshots
       run: |
-        yarn playwright test --project="Google Chrome" --retries="3" --update-snapshots --grep=@snapshot  --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
+        yarn playwright test --project="Google Chrome" --config=playwright.ci.config.ts --retries="3" --update-snapshots --grep=@snapshot  --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
       env:
         CI: true
         token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
@@ -171,7 +171,7 @@ jobs:
         if [[ ! -f "test-results/.last-run.json" ]]; then
             # if no last run artifact, than run plawright normally
             echo "run playwright normally"
-            yarn playwright test --project="Google Chrome" --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }} --grep-invert=@snapshot || true
+            yarn playwright test --project="Google Chrome" --config=playwright.ci.config.ts --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }} --grep-invert=@snapshot || true
             # # send to axiom
             node playwrightProcess.mjs | tee /tmp/github-actions.log > /dev/null 2>&1
         fi
@@ -186,7 +186,7 @@ jobs:
                 if [[ $failed_tests -gt 0 ]]; then
                     echo "retried=true" >>$GITHUB_OUTPUT
                     echo "run playwright with last failed tests and retry $retry"
-                    yarn playwright test --project="Google Chrome" --last-failed --grep-invert=@snapshot || true
+                    yarn playwright test --project="Google Chrome" --config=playwright.ci.config.ts --last-failed --grep-invert=@snapshot || true
                     # send to axiom
                     node playwrightProcess.mjs | tee /tmp/github-actions.log > /dev/null 2>&1
                     retry=$((retry + 1))
@@ -325,7 +325,7 @@ jobs:
         if [[ ! -f "test-results/.last-run.json" ]]; then
             # if no last run artifact, than run plawright normally
             echo "run playwright normally"
-            yarn playwright test --project="webkit" --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }} --grep-invert=@snapshot || true
+            yarn playwright test --project="webkit" --config=playwright.ci.config.ts --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }} --grep-invert=@snapshot || true
             # # send to axiom
             node playwrightProcess.mjs | tee /tmp/github-actions.log > /dev/null 2>&1
         fi
@@ -340,7 +340,7 @@ jobs:
                 if [[ $failed_tests -gt 0 ]]; then
                     echo "retried=true" >>$GITHUB_OUTPUT
                     echo "run playwright with last failed tests and retry $retry"
-                    yarn playwright test --project="webkit" --last-failed --grep-invert=@snapshot || true
+                    yarn playwright test --project="webkit" --config=playwright.ci.config.ts --last-failed --grep-invert=@snapshot || true
                     # send to axiom
                     node playwrightProcess.mjs | tee /tmp/github-actions.log > /dev/null 2>&1
                     retry=$((retry + 1))

README.md

@@ -117,6 +117,7 @@ Which commands from setup are one off vs need to be run every time?
 The following will need to be run when checking out a new commit and guarantees the build is not stale:
 ```bash
 yarn install
+yarn wasm-prep
 yarn build:wasm-dev # or yarn build:wasm for slower but more production-like build
 yarn start # or yarn build:local && yarn serve for slower but more production-like build
 ```

docs/kcl/KNOWN-ISSUES.md

@@ -25,5 +25,5 @@ once fixed in engine will just start working here with no language changes.
 
     Sketching on the chamfered face does not currently work.
 
-- **Shell**: Shell is only working for `end` faces, not for `side` or `start` 
-    faces. We are tracking the engine side bug on this.
+- **Shell**: Shell sometimes does not work when arcs or fillets are involved.
+    We are tracking the engine side bug on this.

e2e/playwright/command-bar-tests.spec.ts

@@ -98,14 +98,16 @@ const extrude001 = extrude(-10, sketch001)`
 
     const commandBarButton = page.getByRole('button', { name: 'Commands' })
     const cmdSearchBar = page.getByPlaceholder('Search commands')
-    const themeOption = page.getByRole('option', {
-      name: 'theme',
+    const commandName = 'debug panel'
+    const commandOption = page.getByRole('option', {
+      name: commandName,
       exact: false,
     })
     const commandLevelArgButton = page.getByRole('button', { name: 'level' })
     const commandThemeArgButton = page.getByRole('button', { name: 'value' })
+    const paneSelector = page.getByRole('button', { name: 'debug panel' })
     // This selector changes after we set the setting
-    let commandOptionInput = page.getByPlaceholder('Select an option')
+    let commandOptionInput = page.getByPlaceholder('On')
 
     await expect(
       page.getByRole('button', { name: 'Start Sketch' })
@@ -127,17 +129,16 @@ const extrude001 = extrude(-10, sketch001)`
     await expect(cmdSearchBar).toBeFocused()
 
     // Try typing in the command bar
-    await cmdSearchBar.fill('theme')
-    await expect(themeOption).toBeVisible()
-    await themeOption.click()
-    const themeInput = page.getByPlaceholder('Select an option')
-    await expect(themeInput).toBeVisible()
-    await expect(themeInput).toBeFocused()
-    // Select dark theme
+    await cmdSearchBar.fill(commandName)
+    await expect(commandOption).toBeVisible()
+    await commandOption.click()
+    const toggleInput = page.getByPlaceholder('On')
+    await expect(toggleInput).toBeVisible()
+    await expect(toggleInput).toBeFocused()
+    // Select On
     await page.keyboard.press('ArrowDown')
     await page.keyboard.press('ArrowDown')
-    await page.keyboard.press('ArrowDown')
-    await expect(page.getByRole('option', { name: 'system' })).toHaveAttribute(
+    await expect(page.getByRole('option', { name: 'Off' })).toHaveAttribute(
       'data-headlessui-state',
       'active'
     )
@@ -145,21 +146,21 @@ const extrude001 = extrude(-10, sketch001)`
 
     // Check the toast appeared
     await expect(
-      page.getByText(`Set theme to "system" for this project`)
+      page.getByText(`Set show debug panel to "false" for this project`)
     ).toBeVisible()
-    // Check that the theme changed
-    await expect(page.locator('body')).not.toHaveClass(`body-bg dark`)
+    // Check that the visibility changed
+    await expect(paneSelector).not.toBeVisible()
 
-    commandOptionInput = page.getByPlaceholder('system')
+    commandOptionInput = page.getByPlaceholder('off')
 
     // Test case for https://github.com/KittyCAD/modeling-app/issues/2882
     await commandBarButton.click()
     await cmdSearchBar.focus()
-    await cmdSearchBar.fill('theme')
-    await themeOption.click()
+    await cmdSearchBar.fill(commandName)
+    await commandOption.click()
     await expect(commandThemeArgButton).toBeDisabled()
     await commandOptionInput.focus()
-    await commandOptionInput.fill('lig')
+    await commandOptionInput.fill('on')
     await commandLevelArgButton.click()
     await expect(commandLevelArgButton).toBeDisabled()
 
@@ -197,7 +198,7 @@ const extrude001 = extrude(-10, sketch001)`
     })
     await expect(themeOption).toBeVisible()
     await themeOption.click()
-    const themeInput = page.getByPlaceholder('Select an option')
+    const themeInput = page.getByPlaceholder('dark')
     await expect(themeInput).toBeVisible()
     await expect(themeInput).toBeFocused()
     // Select dark theme
@@ -212,7 +213,7 @@ const extrude001 = extrude(-10, sketch001)`
 
     // Check the toast appeared
     await expect(
-      page.getByText(`Set theme to "system" for this project`)
+      page.getByText(`Set theme to "system" as a user default`)
     ).toBeVisible()
     // Check that the theme changed
     await expect(page.locator('body')).not.toHaveClass(`body-bg dark`)

e2e/playwright/regression-tests.spec.ts

@@ -1,6 +1,12 @@
-import { test, expect } from '@playwright/test'
+import { test, expect, Page } from '@playwright/test'
 
 import { getUtils, setup, tearDown } from './test-utils'
+import { TEST_CODE_TRIGGER_ENGINE_EXPORT_ERROR } from './storageStates'
+import { bracket } from 'lib/exampleKcl'
+import {
+  PLAYWRIGHT_MOCK_EXPORT_DURATION,
+  PLAYWRIGHT_TOAST_DURATION,
+} from 'lib/constants'
 
 test.beforeEach(async ({ context, page }) => {
   await setup(context, page)
@@ -164,7 +170,7 @@ const sketch001 = startSketchAt([-0, -0])
     |> yLineTo(0, %)
     |> close(%)
     |>
-  
+
   const example = extrude(5, exampleSketch)
   shell({ faces: ['end'], thickness: 0.25 }, exampleSketch)`
       )
@@ -223,4 +229,212 @@ const sketch001 = startSketchAt([-0, -0])
 
     await expect(page.locator('.cm-lint-marker-error')).toBeVisible()
   })
+  test('when engine fails export we handle the failure and alert the user', async ({
+    page,
+  }) => {
+    const u = await getUtils(page)
+    await page.addInitScript(async (code) => {
+      localStorage.setItem('persistCode', code)
+    }, TEST_CODE_TRIGGER_ENGINE_EXPORT_ERROR)
+
+    await page.setViewportSize({ width: 1000, height: 500 })
+
+    await u.waitForAuthSkipAppStart()
+
+    // wait for execution done
+    await u.openDebugPanel()
+    await u.expectCmdLog('[data-message-type="execution-done"]')
+    await u.closeDebugPanel()
+
+    // expect zero errors in guter
+    await expect(page.locator('.cm-lint-marker-error')).not.toBeVisible()
+
+    // export the model
+    const exportButton = page.getByTestId('export-pane-button')
+    await expect(exportButton).toBeVisible()
+
+    // Click the export button
+    await exportButton.click()
+
+    // Click the stl.
+    const stlOption = page.getByText('glTF')
+    await expect(stlOption).toBeVisible()
+
+    await page.keyboard.press('Enter')
+
+    // Click the checkbox
+    const submitButton = page.getByText('Confirm Export')
+    await expect(submitButton).toBeVisible()
+
+    await page.keyboard.press('Enter')
+
+    // Find the toast.
+    // Look out for the toast message
+    const exportingToastMessage = page.getByText(`Exporting...`)
+    await expect(exportingToastMessage).toBeVisible()
+
+    const errorToastMessage = page.getByText(`Error while exporting`)
+    await expect(errorToastMessage).toBeVisible()
+
+    const engineErrorToastMessage = page.getByText(`Nothing to export`)
+    await expect(engineErrorToastMessage).toBeVisible()
+
+    // Make sure the exporting toast is gone
+    await expect(exportingToastMessage).not.toBeVisible()
+
+    // Click the code editor
+    await page.locator('.cm-content').click()
+
+    await page.waitForTimeout(2000)
+
+    // Expect the toast to be gone
+    await expect(errorToastMessage).not.toBeVisible()
+    await expect(engineErrorToastMessage).not.toBeVisible()
+
+    // Now add in code that works.
+    await page.locator('.cm-content').fill(bracket)
+    await page.keyboard.press('End')
+    await page.keyboard.press('Enter')
+
+    // wait for execution done
+    await u.openDebugPanel()
+    await u.clearCommandLogs()
+    await u.expectCmdLog('[data-message-type="execution-done"]')
+    await u.closeDebugPanel()
+
+    // Now try exporting
+
+    // Click the export button
+    await exportButton.click()
+
+    // Click the stl.
+    await expect(stlOption).toBeVisible()
+
+    await page.keyboard.press('Enter')
+
+    // Click the checkbox
+    await expect(submitButton).toBeVisible()
+
+    await page.keyboard.press('Enter')
+
+    // Find the toast.
+    // Look out for the toast message
+    await expect(exportingToastMessage).toBeVisible()
+
+    // Expect it to succeed.
+    await expect(exportingToastMessage).not.toBeVisible()
+    await expect(errorToastMessage).not.toBeVisible()
+    await expect(engineErrorToastMessage).not.toBeVisible()
+
+    const successToastMessage = page.getByText(`Exported successfully`)
+    await expect(successToastMessage).toBeVisible()
+  })
+  test('ensure you can not export while an export is already going', async ({
+    page,
+  }) => {
+    const u = await getUtils(page)
+    await test.step('Set up the code and durations', async () => {
+      await page.addInitScript(
+        async ({ code, toastDurationKey, exportDurationKey }) => {
+          localStorage.setItem('persistCode', code)
+          // Normally we make these durations short to speed up PW tests
+          // to superhuman speeds. But in this case we want to make sure
+          // the export toast is visible for a while, and the export
+          // duration is long enough to make sure the export toast is visible
+          localStorage.setItem(toastDurationKey, '1500')
+          localStorage.setItem(exportDurationKey, '750')
+        },
+        {
+          code: bracket,
+          toastDurationKey: PLAYWRIGHT_TOAST_DURATION,
+          exportDurationKey: PLAYWRIGHT_MOCK_EXPORT_DURATION,
+        }
+      )
+
+      await page.setViewportSize({ width: 1000, height: 500 })
+
+      await u.waitForAuthSkipAppStart()
+
+      // wait for execution done
+      await u.openDebugPanel()
+      await u.expectCmdLog('[data-message-type="execution-done"]')
+      await u.closeDebugPanel()
+
+      // expect zero errors in guter
+      await expect(page.locator('.cm-lint-marker-error')).not.toBeVisible()
+    })
+
+    const errorToastMessage = page.getByText(`Error while exporting`)
+    const exportingToastMessage = page.getByText(`Exporting...`)
+    const engineErrorToastMessage = page.getByText(`Nothing to export`)
+    const alreadyExportingToastMessage = page.getByText(`Already exporting`)
+    const successToastMessage = page.getByText(`Exported successfully`)
+
+    await test.step('Blocked second export', async () => {
+      await clickExportButton(page)
+
+      await expect(exportingToastMessage).toBeVisible()
+
+      await clickExportButton(page)
+
+      await test.step('The second export is blocked', async () => {
+        // Find the toast.
+        // Look out for the toast message
+        await expect(exportingToastMessage).toBeVisible()
+        await expect(alreadyExportingToastMessage).toBeVisible()
+
+        await page.waitForTimeout(1000)
+      })
+
+      await test.step('The first export still succeeds', async () => {
+        await expect(exportingToastMessage).not.toBeVisible()
+        await expect(errorToastMessage).not.toBeVisible()
+        await expect(engineErrorToastMessage).not.toBeVisible()
+
+        await expect(successToastMessage).toBeVisible()
+
+        await expect(alreadyExportingToastMessage).not.toBeVisible()
+      })
+    })
+
+    await test.step('Successful, unblocked export', async () => {
+      // Try exporting again.
+      await clickExportButton(page)
+
+      // Find the toast.
+      // Look out for the toast message
+      await expect(exportingToastMessage).toBeVisible()
+
+      // Expect it to succeed.
+      await expect(exportingToastMessage).not.toBeVisible()
+      await expect(errorToastMessage).not.toBeVisible()
+      await expect(engineErrorToastMessage).not.toBeVisible()
+      await expect(alreadyExportingToastMessage).not.toBeVisible()
+
+      await expect(successToastMessage).toBeVisible()
+    })
+  })
 })
+
+async function clickExportButton(page: Page) {
+  await test.step('Running export flow', async () => {
+    // export the model
+    const exportButton = page.getByTestId('export-pane-button')
+    await expect(exportButton).toBeEnabled()
+
+    // Click the export button
+    await exportButton.click()
+
+    // Click the stl.
+    const gltfOption = page.getByRole('option', { name: 'glTF' })
+    await expect(gltfOption).toBeVisible()
+
+    await page.keyboard.press('Enter')
+
+    // Click the checkbox
+    const submitButton = page.getByText('Confirm Export')
+    await expect(submitButton).toBeVisible()
+
+    await page.keyboard.press('Enter')
+  })
+}

e2e/playwright/sketch-tests.spec.ts

@@ -151,11 +151,12 @@ test.describe('Sketch tests', () => {
 
     await page.mouse.click(700, 200)
 
-    await expect(page.locator('.cm-content')).toHaveText(
-      `const sketch001 = startSketchOn('XZ')
-  |> startProfileAt([4.61, -14.01], %)
-  |> line([0.31, 16.47], %)`
-    )
+    await expect.poll(u.normalisedEditorCode)
+      .toBe(`const sketch001 = startSketchOn('XZ')
+  |> startProfileAt([12.34, -12.34], %)
+  |> line([-12.34, 12.34], %)
+
+`)
   })
   test('Can exit selection of face', async ({ page }) => {
     // Load the app with the code panes

e2e/playwright/storageStates.ts

@@ -368,3 +368,5 @@ startSketchOn(keychain, 'end')
        height - (keychainHoleSize + 1.5)
      ], keychainHoleSize, %)
   |> extrude(-thickness, %)`
+
+export const TEST_CODE_TRIGGER_ENGINE_EXPORT_ERROR = `const thing = 1`

e2e/playwright/test-network-and-connection-issues.spec.ts

@@ -204,19 +204,24 @@ test.describe('Test network and connection issues', () => {
 
     // Ensure we can continue sketching
     await page.mouse.click(startXPx + PUR * 20, 500 - PUR * 20)
-    await expect(page.locator('.cm-content'))
-      .toHaveText(`const sketch001 = startSketchOn('XZ')
-    |> startProfileAt(${commonPoints.startAt}, %)
-    |> line([${commonPoints.num1}, 0], %)
-    |> line([-8.84, 8.75], %)`)
+    await expect.poll(u.normalisedEditorCode)
+      .toBe(`const sketch001 = startSketchOn('XZ')
+  |> startProfileAt([12.34, -12.34], %)
+  |> line([12.34, 0], %)
+  |> line([-12.34, 12.34], %)
+
+`)
     await page.waitForTimeout(100)
     await page.mouse.click(startXPx, 500 - PUR * 20)
-    await expect(page.locator('.cm-content'))
-      .toHaveText(`const sketch001 = startSketchOn('XZ')
-    |> startProfileAt(${commonPoints.startAt}, %)
-    |> line([${commonPoints.num1}, 0], %)
-    |> line([-8.84, 8.75], %)
-    |> line([-5.6, 0], %)`)
+
+    await expect.poll(u.normalisedEditorCode)
+      .toBe(`const sketch001 = startSketchOn('XZ')
+  |> startProfileAt([12.34, -12.34], %)
+  |> line([12.34, 0], %)
+  |> line([-12.34, 12.34], %)
+  |> line([-12.34, 0], %)
+
+`)
 
     // Unequip line tool
     await page.keyboard.press('Escape')