chore(test): vitest migration - exploration phase

.eslintignore

@@ -11,4 +11,6 @@ mapbox-gl.js
 .docusaurus
 examples/layer-browser/
 test/apps/
-bindings/
+bindings/
+# TODO: Remove once eslint-plugin-import supports vite 5.x (vitest brings vite 5.x, master uses 4.x)
+examples/vite.config.local.mjs

.gitignore

@@ -4,6 +4,7 @@ dist/
 node_modules/
 coverage/
 test/**/*-failed.png
+test/**/__screenshots__/
 .nyc_output/
 .reify-cache/
 

.yarnrc

@@ -0,0 +1 @@
+--ignore-engines true

modules/test-utils/package.json

@@ -39,7 +39,7 @@
     "@deck.gl/core": "~9.2.0",
     "@luma.gl/core": "~9.2.6",
     "@luma.gl/engine": "~9.2.6",
-    "@probe.gl/test-utils": "^4.1.0"
+    "vitest": "^2.1.0"
   },
   "gitHead": "13ace64fc2cee08c133afc882fc307253489a4e4"
 }

modules/test-utils/src/globals.d.ts

@@ -0,0 +1,42 @@
+// deck.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+// Type declarations for browser test driver functions injected by @probe.gl/test-utils
+
+interface BrowserTestDriverDiffOptions {
+  goldenImage: string;
+  region?: {x: number; y: number; width: number; height: number};
+  saveOnFail?: boolean;
+  saveAs?: string;
+  threshold?: number;
+  createDiffImage?: boolean;
+  tolerance?: number;
+  includeAA?: boolean;
+  includeEmpty?: boolean;
+  platform?: string;
+}
+
+interface BrowserTestDriverDiffResult {
+  headless: boolean;
+  match: string | number;
+  matchPercentage: string;
+  success: boolean;
+  error: Error | string | null;
+}
+
+interface BrowserTestDriverInputEvent {
+  type: string;
+  [key: string]: any;
+}
+
+declare global {
+  interface Window {
+    browserTestDriver_emulateInput(event: BrowserTestDriverInputEvent): Promise<void>;
+    browserTestDriver_captureAndDiffScreen(
+      options: BrowserTestDriverDiffOptions
+    ): Promise<BrowserTestDriverDiffResult>;
+  }
+}
+
+export {};

modules/test-utils/src/interaction-test-runner.ts

@@ -47,7 +47,7 @@ export class InteractionTestRunner extends TestRunner<InteractionTestCase, {}> {
     });
 
     for (const event of testCase.events) {
-      if (event.wait) {
+      if ('wait' in event) {
         await sleep(event.wait);
       } else {
         await window.browserTestDriver_emulateInput(event);

modules/test-utils/src/lifecycle-test.ts

@@ -4,7 +4,7 @@
 
 import {LayerManager, MapView, DeckRenderer} from '@deck.gl/core';
 
-import {makeSpy} from '@probe.gl/test-utils';
+import {vi, type MockInstance} from 'vitest';
 import {device} from './utils/setup-gl';
 
 import type {Layer, CompositeLayer, Viewport} from '@deck.gl/core';
@@ -128,8 +128,7 @@ export async function testInitializeLayerAsync(
   return null;
 }
 
-// TODO - export from probe.gl
-type Spy = ReturnType<typeof makeSpy>;
+type Spy = MockInstance;
 
 export type LayerClass<LayerT extends Layer> = {
   new (...args): LayerT;
@@ -205,7 +204,7 @@ export function testLayer<LayerT extends Layer>(opts: {
     runLayerTestPostUpdateCheck(testCase, newLayer, oldState, spyMap);
 
     // Remove spies
-    Object.keys(spyMap).forEach(k => spyMap[k].reset());
+    Object.keys(spyMap).forEach(k => spyMap[k].mockClear());
     layer = newLayer;
   }
 
@@ -258,7 +257,7 @@ export async function testLayerAsync<LayerT extends Layer>(opts: {
     }
 
     // Remove spies
-    Object.keys(spyMap).forEach(k => spyMap[k].reset());
+    Object.keys(spyMap).forEach(k => spyMap[k].mockClear());
     layer = newLayer;
   }
 
@@ -330,7 +329,7 @@ function injectSpies(layer: Layer, spies: string[]): Record<string, Spy> {
   const spyMap: Record<string, Spy> = {};
   if (spies) {
     for (const functionName of spies) {
-      spyMap[functionName] = makeSpy(Object.getPrototypeOf(layer), functionName);
+      spyMap[functionName] = vi.spyOn(Object.getPrototypeOf(layer), functionName);
     }
   }
   return spyMap;

package.json

@@ -22,12 +22,15 @@
     "clean": "ocular-clean",
     "build": "npm run clean && ocular-build && lerna run build",
     "lint": "ocular-lint",
-    "cover": "ocular-test cover",
+    "cover": "vitest run --coverage",
     "publish-beta": "ocular-publish version-only-beta",
     "publish-prod": "ocular-publish version-only-prod",
     "start": "open https://deck.gl/docs/get-started/getting-started",
-    "test": "ocular-test",
-    "test-fast": "ocular-lint && ocular-test node",
+    "test": "vitest run",
+    "test-node": "vitest run --project node",
+    "test-browser": "vitest run --project browser",
+    "test-headless": "vitest run --project headless",
+    "test-fast": "ocular-lint && vitest run --project node",
     "test-website": "cd website && yarn && yarn test-build && cd ..",
     "metrics": "ocular-metrics",
     "link-luma": "yarn && (cd node_modules && mv luma.gl luma.orig && ln -s ../../luma.gl/modules/core)",
@@ -42,18 +45,20 @@
     "@loaders.gl/csv": "^4.2.0",
     "@loaders.gl/polyfills": "^4.2.0",
     "@luma.gl/core": "^9.2.6",
-    "@luma.gl/webgpu": "^9.2.6",
     "@luma.gl/effects": "^9.2.6",
+    "@luma.gl/webgpu": "^9.2.6",
     "@math.gl/proj4": "^4.1.0",
     "@probe.gl/bench": "^4.1.0",
     "@vis.gl/dev-tools": "1.0.0-alpha.21",
     "@vis.gl/ts-plugins": "1.0.0-alpha.21",
+    "@vitest/browser": "^2.1.9",
+    "@vitest/coverage-v8": "^2.1.9",
     "jsdom": "^20.0.0",
+    "playwright": "^1.58.0",
     "pre-commit": "^1.2.2",
     "puppeteer": "^24.26.1",
     "s2-geometry": "^1.2.10",
-    "tap-spec": "^5.0.0",
-    "tape-catch": "^1.0.6"
+    "vitest": "^2.1.9"
   },
   "resolutions": {
     "wgsl_reflect": "^1.2.0"