Only update snapshots when there are failures (#7959)

Author: jacebrowning

.github/workflows/e2e-tests.yml

@@ -165,7 +165,7 @@ jobs:
           TARGET: web
 
       - name: Update snapshots
-        if: always()
+        if: failure()
         run: npm run test:snapshots -- --last-failed --update-snapshots
         env:
           VITE_KITTYCAD_API_TOKEN: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}

e2e/playwright/snapshot-tests.spec.ts

@@ -10,6 +10,8 @@ import {
 import { expect, test } from '@e2e/playwright/zoo-test'
 import { KCL_DEFAULT_LENGTH } from '@src/lib/constants'
 
+const TEST_OVERLAY_TIMEOUT_MS = 1_500 // slightly longer than OVERLAY_TIMEOUT_MS in @src/components/ModelingMachineProvider
+
 test.beforeEach(async ({ page, context }) => {
   // Make the user avatar image always 404
   // so we see the fallback menu icon for all snapshot tests
@@ -173,7 +175,7 @@ test(
       500 - pixelToUnitRatio * 10
     )
 
-    await page.waitForTimeout(1_500) // modeling machine timeout is 1s
+    await page.waitForTimeout(TEST_OVERLAY_TIMEOUT_MS)
     await expect(page).toHaveScreenshot({
       maxDiffPixels: 100,
       mask: lowerRightMasks(page),
@@ -203,7 +205,7 @@ test(
     await page.waitForTimeout(500)
 
     await endOfTangentMv()
-    await page.waitForTimeout(1_500) // modeling machine timeout is 1s
+    await page.waitForTimeout(TEST_OVERLAY_TIMEOUT_MS)
     await expect(page).toHaveScreenshot({
       maxDiffPixels: 100,
       mask: lowerRightMasks(page),
@@ -214,7 +216,7 @@ test(
     await page.waitForTimeout(500)
     await endOfTangentClk()
     await threePointArcMidPointMv()
-    await page.waitForTimeout(1_500) // modeling machine timeout is 1s
+    await page.waitForTimeout(TEST_OVERLAY_TIMEOUT_MS)
     await expect(page).toHaveScreenshot({
       maxDiffPixels: 100,
       mask: lowerRightMasks(page),
@@ -223,7 +225,7 @@ test(
     await page.waitForTimeout(100)
 
     await threePointArcEndPointMv()
-    await page.waitForTimeout(1_500) // modeling machine timeout is 1s
+    await page.waitForTimeout(TEST_OVERLAY_TIMEOUT_MS)
     await expect(page).toHaveScreenshot({
       maxDiffPixels: 100,
       mask: lowerRightMasks(page),
@@ -243,7 +245,7 @@ test(
     await arcCenterClk()
 
     await arcEndMv()
-    await page.waitForTimeout(1_500) // modeling machine timeout is 1s
+    await page.waitForTimeout(TEST_OVERLAY_TIMEOUT_MS)
     await expect(page).toHaveScreenshot({
       maxDiffPixels: 100,
       mask: lowerRightMasks(page),
@@ -289,7 +291,7 @@ test(
       500 - pixelToUnitRatio * 10,
       { steps: 5 }
     )
-    await page.waitForTimeout(1_500) // modeling machine timeout is 1s
+    await page.waitForTimeout(TEST_OVERLAY_TIMEOUT_MS)
 
     // Ensure the draft rectangle looks the same as it usually does
     await expect(page).toHaveScreenshot({
@@ -333,7 +335,7 @@ test(
       500 - pixelToUnitRatio * 10,
       { steps: 5 }
     )
-    await page.waitForTimeout(1_500) // modeling machine timeout is 1s
+    await page.waitForTimeout(TEST_OVERLAY_TIMEOUT_MS)
 
     // Ensure the draft circle looks the same as it usually does
     await expect(page).toHaveScreenshot({

src/components/ModelingMachineProvider.tsx

@@ -106,6 +106,8 @@ import type { SidebarType } from '@src/components/ModelingSidebar/ModelingPanes'
 import { useNetworkContext } from '@src/hooks/useNetworkContext'
 import { resetCameraPosition } from '@src/lib/resetCameraPosition'
 
+const OVERLAY_TIMEOUT_MS = 1_000
+
 export const ModelingMachineContext = createContext(
   {} as {
     state: StateFrom<typeof modelingMachine>
@@ -200,8 +202,7 @@ export const ModelingMachineProvider = ({
                     pathToNodeString,
                   },
                 })
-                // overlay timeout is 1s
-              }, 1000) as unknown as number
+              }, OVERLAY_TIMEOUT_MS) as unknown as number
               return {
                 ...context.segmentHoverMap,
                 [pathToNodeString]: timeoutId,