vitest-plugin-vis/src/client/page/has_image_snapshot.ts

Vitest visual testing plugin

import type { ImageSnapshotKeyOptions } from '../../shared/types.ts'
import { hasImageSnapshotAction } from '../actions/has_image_snapshot_action.ts'
import { toTaskId } from '../task/task_id.ts'
import type { BrowserPage } from './_ctx.ts'
import { ctx } from './_ctx.ts'

export interface HasImageSnapshotAction {
	/**
	 * Check if the snapshot image exists.
	 */
	hasImageSnapshot(this: BrowserPage, options?: ImageSnapshotKeyOptions | undefined): Promise<boolean>
}

export function hasImageSnapshot(this: BrowserPage, options?: ImageSnapshotKeyOptions | undefined) {
	const test = ctx.getCurrentTest()
	if (!test) {
		throw new Error('`hasImageSnapshot()` must be called in a test.')
	}

	if (test.concurrent) {
		throw new Error(
			'`hasImageSnapshot()` cannot be called in a concurrent test because ' +
				"concurrent tests run at the same time in the same iframe and affect each other's environment. ",
		)
	}
	return hasImageSnapshotAction(ctx.commands, toTaskId(test), options)
}