fix: change default timeout

.changeset/slow-colts-tickle.md

@@ -0,0 +1,20 @@
+---
+"storybook-addon-vis": patch
+"vitest-plugin-vis": patch
+---
+
+Change default timeout to 30s.
+The initial timeout of 1s was set by Vitest.
+It is causing tests to fail with `TimeoutError`,
+even when getting `Locator` like `getByRole`.
+
+This timeout will be removed in Vitest 3.
+
+The underlying provider (`playwright`) does not have a default timeout.
+
+Setting to 30s should be a good default for most cases.
+
+It could still be too short for slow CI or when it is running scripts in parallel.
+That was the case for `storybook-test-runner` but could be improved in Vitest browser mode.
+
+If timeout is still an issue, we can further default it to 60s or even 120s.

packages/storybook-addon-vis/readme.md

@@ -102,7 +102,7 @@ export default defineConfig({
 			diffOptions: undefined,
 			failureThresholdType: 'pixel',
 			failureThreshold: 0,
-			timeout: 5000 // 30000 on CI
+			timeout: 30000
 		})
 	],
 })

packages/vitest-plugin-vis/readme.md

@@ -69,7 +69,7 @@ export default defineConfig({
 			diffOptions: undefined,
 			failureThresholdType: 'pixel',
 			failureThreshold: 0,
-			timeout: 5000 // 30000 on CI
+			timeout: 30000
 		})
 	],
 	test:{
@@ -191,7 +191,7 @@ setAutoSnapshotOptions({
 	diffOptions: { threshold: 0.01 },
 	failureThreshold: 0.01,
 	failureThresholdType: 'percent',
-	timeout: 15000
+	timeout: 60000
 })
 ```
 
@@ -244,7 +244,7 @@ it('manual snapshot with options', async () => {
 		diffOptions: {
 			threshold: 0.1
 		},
-		timeout: 15000
+		timeout: 60000
 	})
 })
 ```

packages/vitest-plugin-vis/src/server/commands/match_image_snapshot.ts

@@ -1,5 +1,4 @@
 import dedent from 'dedent'
-import ci from 'is-ci'
 import { resolve } from 'pathe'
 import { PNG } from 'pngjs'
 import type { BrowserCommand } from 'vitest/node'
@@ -41,7 +40,7 @@ export const matchImageSnapshot: BrowserCommand<
 
 	// vitest:browser passes in `null` when not defined
 	if (!options) options = {}
-	options.timeout = options.timeout ?? (ci ? 30000 : 5000)
+	options.timeout = options.timeout ?? 30000
 
 	const info = visContext.getSnapshotInfo(context.testPath, taskId, options)
 	const baselineBuffer = await file.tryReadFile(info.baselinePath)

packages/vitest-plugin-vis/src/server/commands/prepare_image_snapshot_comparison.ts

@@ -1,4 +1,3 @@
-import ci from 'is-ci'
 import type { BrowserCommand } from 'vitest/node'
 import { isBase64String } from '../../shared/base64.ts'
 import type {
@@ -39,7 +38,7 @@ export const prepareImageSnapshotComparison: BrowserCommand<
 
 	// vitest:browser passes in `null` when not defined
 	if (!options) options = {}
-	options.timeout = options.timeout ?? (ci ? 30000 : 5000)
+	options.timeout = options.timeout ?? 30000
 
 	const info = visContext.getSnapshotInfo(context.testPath, taskId, options)
 	const baselineBuffer = await file.tryReadFile(info.baselinePath)

packages/vitest-plugin-vis/src/server/vis_context.ctx.ts

@@ -5,7 +5,6 @@ import { rimraf } from 'rimraf'
 export const ctx = {
 	rimraf,
 	getSnapshotPlatform() {
-		/* v8 ignore next */
 		return ci ? process.platform : 'local'
 	},
 }

packages/vitest-plugin-vis/src/shared/types.ts

@@ -5,7 +5,7 @@ export interface ImageSnapshotTimeoutOptions {
 	/**
 	 * Timeout for taking the snapshot.
 	 *
-	 * Default: 5000 ms locally, 30000 ms on CI.
+	 * Default: 30000 ms (30 seconds)
 	 */
 	timeout?: number | undefined
 }

testcases/vpv/src/to_match_image_snapshot.spec.tsx

@@ -47,7 +47,7 @@ it('uses options set in vis()', async () => {
 			(error) => {
 				expect(error.message).toMatch(
 					`Options:    failureThreshold: 0.01 percent
-            timeout: 15000 ms
+            timeout: 60000 ms
             comparisonMethod: ssim
             diffOptions: {\"ssim\":\"bezkrovny\"}`,
 				)

testcases/vpv/vitest.config.ts

@@ -12,7 +12,7 @@ export default defineConfig({
 			diffOptions: { ssim: 'bezkrovny' },
 			failureThreshold: 0.01,
 			failureThresholdType: 'percent',
-			timeout: 15000,
+			timeout: 60000,
 		}),
 	],
 	test: {