Stream handling / Stream idle mode v2; a ton of network related changes (ping; scene indicator -> stream indicator, stream resizing (even on pause))

docs/kcl/settings/user.md

@@ -96,7 +96,7 @@ Permanently dismiss the banner warning to download the desktop app. This setting
 
 ##### stream_idle_mode
 
-When the user is idle, and this is true, the stream will be torn down.
+When the user is idle, teardown the stream after some time.
 
 
 **Default:** None

e2e/playwright/boolean.spec.ts

@@ -46,8 +46,6 @@ test.describe('Point and click for boolean workflows', () => {
         localStorage.setItem('persistCode', file)
       }, file)
       await homePage.goToModelingScene()
-      await scene.waitForExecutionDone()
-
       await scene.settled(cmdBar)
 
       // Test coordinates for selection - these might need adjustment based on actual scene layout
@@ -77,6 +75,7 @@ test.describe('Point and click for boolean workflows', () => {
 
         // Select first object in the scene, expect there to be a pixel diff from the selection color change
         await clickFirstObject({ pixelDiff: 50 })
+        await page.waitForTimeout(1000)
 
         // For subtract, we need to proceed to the next step before selecting the second object
         if (operationName !== 'subtract') {
@@ -87,6 +86,8 @@ test.describe('Point and click for boolean workflows', () => {
         // Select second object
         await clickSecondObject({ pixelDiff: 50 })
 
+        await page.waitForTimeout(1000)
+
         // Confirm the operation in the command bar
         await cmdBar.progressCmdBar()
 

e2e/playwright/can-create-sketches-on-all-planes-and-their-back-sides.spec.ts

@@ -4,6 +4,7 @@ import { uuidv4 } from '@src/lib/utils'
 
 import type { HomePageFixture } from '@e2e/playwright/fixtures/homePageFixture'
 import type { SceneFixture } from '@e2e/playwright/fixtures/sceneFixture'
+import type { ToolbarFixture } from '@e2e/playwright/fixtures/toolbarFixture'
 import { getUtils } from '@e2e/playwright/test-utils'
 import { expect, test } from '@e2e/playwright/zoo-test'
 
@@ -15,6 +16,7 @@ test.describe(
       page: Page,
       homePage: HomePageFixture,
       scene: SceneFixture,
+      toolbar: ToolbarFixture,
       plane: string,
       clickCoords: { x: number; y: number }
     ) => {
@@ -59,9 +61,12 @@ test.describe(
       await u.sendCustomCmd(updateCamCommand)
 
       await u.closeDebugPanel()
+
       await page.mouse.click(clickCoords.x, clickCoords.y)
       await page.waitForTimeout(600) // wait for animation
 
+      await toolbar.waitUntilSketchingReady()
+
       await expect(
         page.getByRole('button', { name: 'line Line', exact: true })
       ).toBeVisible()
@@ -117,11 +122,12 @@ test.describe(
     ]
 
     for (const config of planeConfigs) {
-      test(config.plane, async ({ page, homePage, scene }) => {
+      test(config.plane, async ({ page, homePage, scene, toolbar }) => {
         await sketchOnPlaneAndBackSideTest(
           page,
           homePage,
           scene,
+          toolbar,
           config.plane,
           config.coords
         )

e2e/playwright/code-pane-and-errors.spec.ts

@@ -15,6 +15,7 @@ test.describe('Code pane and errors', { tag: ['@skipWin'] }, () => {
     page,
     homePage,
     scene,
+    cmdBar,
   }) => {
     const u = await getUtils(page)
 
@@ -36,7 +37,7 @@ extrude001 = extrude(sketch001, length = 5)`
 
     await page.setBodyDimensions({ width: 1200, height: 500 })
     await homePage.goToModelingScene()
-    await scene.waitForExecutionDone()
+    await scene.settled(cmdBar)
 
     // Ensure no badge is present
     const codePaneButtonHolder = page.locator('#code-button-holder')
@@ -171,6 +172,8 @@ extrude001 = extrude(sketch001, length = 5)`
     context,
     page,
     homePage,
+    scene,
+    cmdBar,
   }) => {
     // Load the app with the working starter code
     await context.addInitScript((code) => {
@@ -180,9 +183,7 @@ extrude001 = extrude(sketch001, length = 5)`
     await page.setBodyDimensions({ width: 1200, height: 500 })
     await homePage.goToModelingScene()
 
-    // FIXME: await scene.waitForExecutionDone() does not work. It still fails.
-    // I needed to increase this timeout to get this to pass.
-    await page.waitForTimeout(10000)
+    await scene.settled(cmdBar)
 
     // Ensure badge is present
     const codePaneButtonHolder = page.locator('#code-button-holder')

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

@@ -317,9 +317,13 @@ test.describe('Command bar tests', { tag: ['@skipWin'] }, () => {
   test('Can switch between sketch tools via command bar', async ({
     page,
     homePage,
+    scene,
+    cmdBar,
+    toolbar,
   }) => {
     await page.setBodyDimensions({ width: 1200, height: 500 })
     await homePage.goToModelingScene()
+    await scene.settled(cmdBar)
 
     const sketchButton = page.getByRole('button', { name: 'Start Sketch' })
     const cmdBarButton = page.getByRole('button', { name: 'Commands' })
@@ -343,7 +347,9 @@ test.describe('Command bar tests', { tag: ['@skipWin'] }, () => {
 
     // Start a sketch
     await sketchButton.click()
+
     await page.mouse.click(700, 200)
+    await toolbar.waitUntilSketchingReady()
 
     // Switch between sketch tools via the command bar
     await expect(lineToolButton).toHaveAttribute('aria-pressed', 'true')

e2e/playwright/desktop-export.spec.ts

@@ -11,7 +11,7 @@ import { expect, test } from '@e2e/playwright/zoo-test'
 test(
   'export works on the first try',
   { tag: ['@electron', '@skipLocalEngine'] },
-  async ({ page, context, scene, tronApp }, testInfo) => {
+  async ({ page, context, scene, tronApp, cmdBar }, testInfo) => {
     if (!tronApp) {
       fail()
     }
@@ -37,7 +37,7 @@ test(
       const projectName = page.getByText(`bracket`)
       await expect(projectName).toBeVisible()
       await projectName.click()
-      await scene.waitForExecutionDone()
+      await scene.settled(cmdBar)
       await page.waitForTimeout(1_000) // wait for panel buttons to be available
 
       // Expect zero errors in gutter
@@ -46,6 +46,7 @@ test(
       // Click the export button
       const exportButton = page.getByTestId('export-pane-button')
       await expect(exportButton).toBeVisible()
+
       await exportButton.click()
       await page.waitForTimeout(1_000) // wait for export options to be available
 
@@ -110,10 +111,9 @@ test(
 
       // Close the file pane
       await u.closeFilePanel()
-      await scene.waitForExecutionDone()
-      await page.waitForTimeout(1_000) // wait for panel buttons to be available
+      await scene.settled(cmdBar)
 
-      // Expect zero errors in gutter
+      // expect zero errors in guter
       await expect(page.locator('.cm-lint-marker-error')).not.toBeVisible()
 
       // Click the export button

e2e/playwright/editor-tests.spec.ts

@@ -78,12 +78,14 @@ sketch001 = startSketchOn(XY)
 
     // Ensure we execute the first time.
     await u.openDebugPanel()
-    await expect(
-      page.locator('[data-receive-command-type="scene_clear_all"]')
-    ).toHaveCount(1)
-    await expect(
-      page.locator('[data-message-type="execution-done"]')
-    ).toHaveCount(2)
+    await expect
+      .poll(() =>
+        page.locator('[data-receive-command-type="scene_clear_all"]').count()
+      )
+      .toBe(1)
+    await expect
+      .poll(() => page.locator('[data-message-type="execution-done"]').count())
+      .toBe(2)
 
     // Add whitespace to the end of the code.
     await u.codeLocator.click()
@@ -110,12 +112,14 @@ sketch001 = startSketchOn(XY)
   test('ensure we use the cache, and do not clear on append', async ({
     homePage,
     page,
+    scene,
+    cmdBar,
   }) => {
     const u = await getUtils(page)
     await page.setBodyDimensions({ width: 1000, height: 500 })
 
     await homePage.goToModelingScene()
-    await u.waitForPageLoad()
+    await scene.settled(cmdBar)
 
     await u.codeLocator.click()
     await page.keyboard.type(`sketch001 = startSketchOn(XY)
@@ -499,7 +503,7 @@ sketch_001 = startSketchOn(XY)
     await page.keyboard.press('ArrowLeft')
     await page.keyboard.press('ArrowRight')
 
-    await scene.waitForExecutionDone()
+    await scene.connectionEstablished()
 
     // error in guter
     await expect(page.locator('.cm-lint-marker-info').first()).toBeVisible()

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

@@ -64,7 +64,7 @@ test.describe('Feature Tree pane', () => {
   test(
     'User can go to definition and go to function definition',
     { tag: '@electron' },
-    async ({ context, homePage, scene, editor, toolbar }) => {
+    async ({ context, homePage, scene, editor, toolbar, cmdBar, page }) => {
       await context.folderSetupFn(async (dir) => {
         const bracketDir = join(dir, 'test-sample')
         await fsp.mkdir(bracketDir, { recursive: true })
@@ -86,9 +86,13 @@ test.describe('Feature Tree pane', () => {
           sortBy: 'last-modified-desc',
         })
         await homePage.openProject('test-sample')
-        await scene.waitForExecutionDone()
-        await editor.closePane()
+        await scene.connectionEstablished()
+        await scene.settled(cmdBar)
+
         await toolbar.openFeatureTreePane()
+        await expect
+          .poll(() => page.getByText('Feature tree').count())
+          .toBeGreaterThan(1)
       })
 
       async function testViewSource({
@@ -254,7 +258,7 @@ test.describe('Feature Tree pane', () => {
         sortBy: 'last-modified-desc',
       })
       await homePage.openProject('test-sample')
-      await scene.waitForExecutionDone()
+      await scene.settled(cmdBar)
       await toolbar.openFeatureTreePane()
     })
 
@@ -339,7 +343,7 @@ test.describe('Feature Tree pane', () => {
         sortBy: 'last-modified-desc',
       })
       await homePage.openProject('test-sample')
-      await scene.waitForExecutionDone()
+      await scene.settled(cmdBar)
       await toolbar.openFeatureTreePane()
     })
 
@@ -414,8 +418,7 @@ profile003 = startProfileAt([0, -4.93], sketch001)
     const planeColor: [number, number, number] = [74, 74, 74]
 
     await homePage.openProject('test-sample')
-    // FIXME: @lf94 has a better way to verify execution completion, in a PR rn
-    await scene.waitForExecutionDone()
+    await scene.settled(cmdBar)
 
     await test.step(`Verify we see the sketch`, async () => {
       await scene.expectPixelColor(sketchColor, testPoint, 10)

e2e/playwright/file-tree.spec.ts

@@ -47,6 +47,7 @@ test.describe('integrations tests', () => {
         await scene.connectionEstablished()
         await scene.settled(cmdBar)
         await clickObj()
+        await page.waitForTimeout(1000)
         await scene.moveNoWhere()
         await editor.expectState({
           activeLines: [
@@ -72,11 +73,11 @@ test.describe('integrations tests', () => {
       })
       await test.step('setup for next assertion', async () => {
         await toolbar.openFile('main.kcl')
-
-        await scene.settled(cmdBar)
-
+        await page.waitForTimeout(1000)
         await clickObj()
+        await page.waitForTimeout(1000)
         await scene.moveNoWhere()
+        await page.waitForTimeout(1000)
         await editor.expectState({
           activeLines: [
             '|>startProfileAt([75.8,317.2],%)//[$startCapTag,$EndCapTag]',
@@ -89,7 +90,7 @@ test.describe('integrations tests', () => {
         await toolbar.expectFileTreeState(['main.kcl', fileName])
       })
       await test.step('check sketch mode is exited when opening a different file', async () => {
-        await toolbar.openFile(fileName, { wait: false })
+        await toolbar.openFile(fileName)
 
         // check we're out of sketch mode
         await expect(toolbar.exitSketchBtn).not.toBeVisible()

e2e/playwright/fixtures/cmdBarFixture.ts

@@ -112,22 +112,16 @@ export class CmdBarFixture {
    * and assumes we are past the `pickCommand` step.
    */
   progressCmdBar = async (shouldFuzzProgressMethod = true) => {
-    // FIXME: Progressing the command bar is a race condition. We have an async useEffect that reports the final state via useCalculateKclExpression. If this does not run quickly enough, it will not "fail" the continue because you can press continue if the state is not ready. E2E tests do not know this.
-    // Wait 1250ms to assume the await executeAst of the KCL input field is finished
-    await this.page.waitForTimeout(1250)
-    if (shouldFuzzProgressMethod || Math.random() > 0.5) {
-      const arrowButton = this.page.getByRole('button', {
-        name: 'arrow right Continue',
-      })
-      if (await arrowButton.isVisible()) {
-        await arrowButton.click()
-      } else {
-        await this.page
-          .getByRole('button', { name: 'checkmark Submit command' })
-          .click()
-      }
+    await this.page.waitForTimeout(2000)
+    const arrowButton = this.page.getByRole('button', {
+      name: 'arrow right Continue',
+    })
+    if (await arrowButton.isVisible()) {
+      await arrowButton.click()
     } else {
-      await this.page.keyboard.press('Enter')
+      await this.page
+        .getByRole('button', { name: 'checkmark Submit command' })
+        .click()
     }
   }