@luma.gl/test-utils 9.0.0-alpha.21 → 9.0.0-alpha.23

package/dist/index.cjs

@@ -87,9 +87,6 @@ var import_gl = __toESM(require("gl"), 1);
 (0, import_webgl.registerHeadlessGL)(import_gl.default);
 import_api.luma.registerDevices([import_webgl.WebGLDevice, import_webgpu.WebGPUDevice]);
 
-// src/test-runner.ts
-var import_webgl_legacy = require("@luma.gl/webgl-legacy");
-
 // src/create-test-device.ts
 var import_api2 = require("@luma.gl/api");
 var import_webgl2 = require("@luma.gl/webgl");
@@ -143,22 +140,470 @@ function getTestDevices() {
   });
 }
 
-// src/test-runner.ts
-function noop() {
+// src/engine/classic-animation-loop.ts
+var import_api3 = require("@luma.gl/api");
+var import_env = require("@probe.gl/env");
+var import_webgl3 = require("@luma.gl/webgl");
+var isPage = (0, import_env.isBrowser)() && typeof document !== "undefined";
+function getHTMLCanvasElement(canvas) {
+  return typeof HTMLCanvasElement !== "undefined" && canvas instanceof HTMLCanvasElement ? canvas : null;
 }
+var statIdCounter = 0;
+var DEFAULT_CLASSIC_ANIMATION_LOOP_PROPS = {
+  onCreateDevice: (props) => import_api3.luma.createDevice(props),
+  onCreateContext: void 0,
+  onAddHTML: void 0,
+  onInitialize: () => ({}),
+  onRender: () => {
+  },
+  onFinalize: () => {
+  },
+  onError: (error) => console.error(error),
+  // eslint-disable-line no-console
+  device: null,
+  // debug: true,
+  // view parameters
+  useDevicePixels: true,
+  autoResizeViewport: true,
+  autoResizeDrawingBuffer: true,
+  stats: import_api3.luma.stats.get(`animation-loop-${statIdCounter++}`),
+  // deprecated
+  // onCreateContext: (opts) => createGLContext(opts),
+  gl: void 0,
+  glOptions: {},
+  createFramebuffer: false
+};
+var ClassicAnimationLoop = class {
+  /*
+   */
+  constructor(props = {}) {
+    // framebuffer: ClassicFramebuffer = null;
+    this.timeline = null;
+    this.needsRedraw = "initialized";
+    this._initialized = false;
+    this._running = false;
+    this._animationFrameId = null;
+    this._pageLoadPromise = null;
+    this._nextFramePromise = null;
+    this._resolveNextFrame = null;
+    this._cpuStartTime = 0;
+    this.props = __spreadValues(__spreadValues({}, DEFAULT_CLASSIC_ANIMATION_LOOP_PROPS), props);
+    props = this.props;
+    let { useDevicePixels = true } = this.props;
+    if ("useDevicePixelRatio" in props) {
+      import_api3.log.deprecated("useDevicePixelRatio", "useDevicePixels")();
+      useDevicePixels = props.useDevicePixelRatio;
+    }
+    this.device = props.device;
+    this.gl = this.device && this.device.gl || props.gl;
+    this.stats = props.stats;
+    this.cpuTime = this.stats.get("CPU Time");
+    this.gpuTime = this.stats.get("GPU Time");
+    this.frameRate = this.stats.get("Frame Rate");
+    this.setProps({
+      autoResizeViewport: props.autoResizeViewport,
+      autoResizeDrawingBuffer: props.autoResizeDrawingBuffer,
+      useDevicePixels
+    });
+    this.start = this.start.bind(this);
+    this.stop = this.stop.bind(this);
+    this._onMousemove = this._onMousemove.bind(this);
+    this._onMouseleave = this._onMouseleave.bind(this);
+  }
+  destroy() {
+    this.stop();
+    this._setDisplay(null);
+  }
+  /** @deprecated Use .destroy() */
+  delete() {
+    this.destroy();
+  }
+  setNeedsRedraw(reason) {
+    this.needsRedraw = this.needsRedraw || reason;
+    return this;
+  }
+  setProps(props) {
+    if ("autoResizeViewport" in props) {
+      this.props.autoResizeViewport = props.autoResizeViewport;
+    }
+    if ("autoResizeDrawingBuffer" in props) {
+      this.props.autoResizeDrawingBuffer = props.autoResizeDrawingBuffer;
+    }
+    if ("useDevicePixels" in props) {
+      this.props.useDevicePixels = props.useDevicePixels;
+    }
+    return this;
+  }
+  start(opts = {}) {
+    this._start(opts);
+    return this;
+  }
+  /** Starts a render loop if not already running */
+  _start(props) {
+    return __async(this, null, function* () {
+      if (this._running) {
+        return this;
+      }
+      this._running = true;
+      try {
+        yield this._getPageLoadPromise();
+        if (!this._running) {
+          return null;
+        }
+        let appContext;
+        if (!this._initialized) {
+          this._initialized = true;
+          yield this._createDevice(props);
+          this._initialize(props);
+          appContext = yield this.onInitialize(this.animationProps);
+          this._addCallbackData(appContext || {});
+        }
+        if (!this._running) {
+          return null;
+        }
+        if (appContext !== false) {
+          this._cancelAnimationFrame();
+          this._requestAnimationFrame();
+        }
+        return this;
+      } catch (error) {
+        this.props.onError(error);
+        return null;
+      }
+    });
+  }
+  /** Explicitly draw a frame */
+  redraw() {
+    if (this.isContextLost()) {
+      return this;
+    }
+    this._beginTimers();
+    this._setupFrame();
+    this._updateCallbackData();
+    this._renderFrame(this.animationProps);
+    this._clearNeedsRedraw();
+    if (this._resolveNextFrame) {
+      this._resolveNextFrame(this);
+      this._nextFramePromise = null;
+      this._resolveNextFrame = null;
+    }
+    this._endTimers();
+    return this;
+  }
+  // Stops a render loop if already running, finalizing
+  stop() {
+    if (this._running) {
+      this._finalizeCallbackData();
+      this._cancelAnimationFrame();
+      this._nextFramePromise = null;
+      this._resolveNextFrame = null;
+      this._running = false;
+    }
+    return this;
+  }
+  attachTimeline(timeline) {
+    this.timeline = timeline;
+    return this.timeline;
+  }
+  detachTimeline() {
+    this.timeline = null;
+  }
+  waitForRender() {
+    this.setNeedsRedraw("waitForRender");
+    if (!this._nextFramePromise) {
+      this._nextFramePromise = new Promise((resolve) => {
+        this._resolveNextFrame = resolve;
+      });
+    }
+    return this._nextFramePromise;
+  }
+  toDataURL() {
+    return __async(this, null, function* () {
+      var _a;
+      this.setNeedsRedraw("toDataURL");
+      yield this.waitForRender();
+      return (_a = getHTMLCanvasElement(this.gl.canvas)) == null ? void 0 : _a.toDataURL();
+    });
+  }
+  isContextLost() {
+    return this.gl.isContextLost();
+  }
+  onCreateDevice(deviceProps) {
+    const { onCreateDevice } = this.props;
+    return onCreateDevice(deviceProps);
+  }
+  onInitialize(animationProps) {
+    const { onInitialize } = this.props;
+    return onInitialize(animationProps);
+  }
+  onRender(animationProps) {
+    const { onRender } = this.props;
+    return onRender(animationProps);
+  }
+  onFinalize(animationProps) {
+    const { onFinalize } = this.props;
+    return onFinalize(animationProps);
+  }
+  // DEPRECATED/REMOVED METHODS
+  /** @deprecated Use .onCreateDevice() */
+  onCreateContext(props) {
+    const { onCreateContext } = this.props;
+    return onCreateContext(props);
+  }
+  /** @deprecated */
+  getHTMLControlValue(id, defaultValue = 1) {
+    const element = document.getElementById(id);
+    return element ? Number(element.value) : defaultValue;
+  }
+  // PRIVATE METHODS
+  _initialize(props) {
+    this._createFramebuffer();
+    this._startEventHandling();
+    this._initializeCallbackData();
+    this._updateCallbackData();
+    this._resizeCanvasDrawingBuffer();
+    this._resizeViewport();
+  }
+  _getPageLoadPromise() {
+    if (!this._pageLoadPromise) {
+      this._pageLoadPromise = isPage ? new Promise((resolve, reject) => {
+        if (isPage && document.readyState === "complete") {
+          resolve(document);
+          return;
+        }
+        window.addEventListener("load", () => {
+          resolve(document);
+        });
+      }) : Promise.resolve({});
+    }
+    return this._pageLoadPromise;
+  }
+  _setDisplay(display) {
+    if (this.display) {
+      this.display.destroy();
+      this.display.animationLoop = null;
+    }
+    if (display) {
+      display.animationLoop = this;
+    }
+    this.display = display;
+  }
+  _requestAnimationFrame() {
+    if (!this._running) {
+      return;
+    }
+    this._animationFrameId = (0, import_api3.requestAnimationFrame)(this._animationFrame.bind(this));
+  }
+  _cancelAnimationFrame() {
+    if (this._animationFrameId !== null) {
+      return;
+    }
+    (0, import_api3.cancelAnimationFrame)(this._animationFrameId);
+    this._animationFrameId = null;
+  }
+  _animationFrame() {
+    if (!this._running) {
+      return;
+    }
+    this.redraw();
+    this._requestAnimationFrame();
+  }
+  // Called on each frame, can be overridden to call onRender multiple times
+  // to support e.g. stereoscopic rendering
+  _renderFrame(props) {
+    if (this.display) {
+      this.display._renderFrame(props);
+      return;
+    }
+    this.onRender(props);
+  }
+  _clearNeedsRedraw() {
+    this.needsRedraw = null;
+  }
+  _setupFrame() {
+    this._resizeCanvasDrawingBuffer();
+    this._resizeViewport();
+    this._resizeFramebuffer();
+  }
+  /* eslint-disable @typescript-eslint/unbound-method */
+  // Initialize the  object that will be passed to app callbacks
+  _initializeCallbackData() {
+    this.animationProps = {
+      device: this.device,
+      gl: this.gl,
+      stop: this.stop,
+      canvas: this.gl.canvas,
+      // Initial values
+      useDevicePixels: this.props.useDevicePixels,
+      needsRedraw: null,
+      // Animation props
+      startTime: Date.now(),
+      engineTime: 0,
+      tick: 0,
+      tock: 0,
+      timeline: this.timeline,
+      // @ts-ignore
+      animationLoop: this,
+      // Timeline time for back compatibility
+      time: 0,
+      // Experimental
+      _mousePosition: null,
+      // Event props
+      /** @deprecated */
+      // framebuffer: this.framebuffer,
+      /** @deprecated */
+      _timeline: this.timeline,
+      /** @deprecated */
+      _loop: this,
+      /** @deprecated */
+      _animationLoop: this
+    };
+  }
+  // Update the context object that will be passed to app callbacks
+  _updateCallbackData() {
+    const { width, height, aspect } = this._getSizeAndAspect();
+    if (width !== this.animationProps.width || height !== this.animationProps.height) {
+      this.setNeedsRedraw("drawing buffer resized");
+    }
+    if (aspect !== this.animationProps.aspect) {
+      this.setNeedsRedraw("drawing buffer aspect changed");
+    }
+    this.animationProps.width = width;
+    this.animationProps.height = height;
+    this.animationProps.aspect = aspect;
+    this.animationProps.needsRedraw = this.needsRedraw;
+    this.animationProps.engineTime = Date.now() - this.animationProps.startTime;
+    if (this.timeline) {
+      this.timeline.update(this.animationProps.engineTime);
+    }
+    this.animationProps.tick = Math.floor(this.animationProps.time / 1e3 * 60);
+    this.animationProps.tock++;
+    this.animationProps.time = this.timeline ? this.timeline.getTime() : this.animationProps.engineTime;
+  }
+  _finalizeCallbackData() {
+    this.onFinalize(this.animationProps);
+  }
+  /** Add application's data to the app context object */
+  _addCallbackData(appContext) {
+    if (typeof appContext === "object" && appContext !== null) {
+      this.animationProps = Object.assign({}, this.animationProps, appContext);
+    }
+  }
+  /** Either uses supplied or existing context, or calls provided callback to create one */
+  _createDevice(props) {
+    return __async(this, null, function* () {
+      const deviceProps = __spreadValues(__spreadValues(__spreadValues({}, this.props), props), this.props.glOptions);
+      this.device = yield this.onCreateDevice(deviceProps);
+      this.gl = this.device.gl;
+      if (!(0, import_webgl3.isWebGL)(this.gl)) {
+        throw new Error("ClassicAnimationLoop.onCreateContext - illegal context returned");
+      }
+      (0, import_webgl3.resetParameters)(this.gl);
+      this._createInfoDiv();
+    });
+  }
+  _createInfoDiv() {
+    const canvas = getHTMLCanvasElement(this.gl.canvas);
+    if (canvas && this.props.onAddHTML) {
+      const wrapperDiv = document.createElement("div");
+      document.body.appendChild(wrapperDiv);
+      wrapperDiv.style.position = "relative";
+      const div = document.createElement("div");
+      div.style.position = "absolute";
+      div.style.left = "10px";
+      div.style.bottom = "10px";
+      div.style.width = "300px";
+      div.style.background = "white";
+      if (canvas) {
+        wrapperDiv.appendChild(canvas);
+      }
+      wrapperDiv.appendChild(div);
+      const html = this.props.onAddHTML(div);
+      if (html) {
+        div.innerHTML = html;
+      }
+    }
+  }
+  _getSizeAndAspect() {
+    const width = this.gl.drawingBufferWidth;
+    const height = this.gl.drawingBufferHeight;
+    let aspect = 1;
+    const canvas = getHTMLCanvasElement(this.gl.canvas);
+    if (canvas && canvas.clientHeight) {
+      aspect = canvas.clientWidth / canvas.clientHeight;
+    } else if (width > 0 && height > 0) {
+      aspect = width / height;
+    }
+    return { width, height, aspect };
+  }
+  /** Default viewport setup */
+  _resizeViewport() {
+    if (this.props.autoResizeViewport) {
+      this.gl.viewport(0, 0, this.gl.drawingBufferWidth, this.gl.drawingBufferHeight);
+    }
+  }
+  /**
+   * Resize the render buffer of the canvas to match canvas client size
+   * Optionally multiplying with devicePixel ratio
+   */
+  _resizeCanvasDrawingBuffer() {
+    if (this.props.autoResizeDrawingBuffer) {
+      this.device.canvasContext.resize({ useDevicePixels: this.props.useDevicePixels });
+    }
+  }
+  _beginTimers() {
+    this.frameRate.timeEnd();
+    this.frameRate.timeStart();
+    this.cpuTime.timeStart();
+  }
+  _endTimers() {
+    this.cpuTime.timeEnd();
+  }
+  // Event handling
+  _startEventHandling() {
+    const { canvas } = this.gl;
+    if (canvas) {
+      canvas.addEventListener("mousemove", this._onMousemove);
+      canvas.addEventListener("mouseleave", this._onMouseleave);
+    }
+  }
+  _onMousemove(e) {
+    this.animationProps._mousePosition = [e.offsetX, e.offsetY];
+  }
+  _onMouseleave(e) {
+    this.animationProps._mousePosition = null;
+  }
+  // Deprecated
+  /** @deprecated */
+  _createFramebuffer() {
+    if (this.props.createFramebuffer) {
+    }
+  }
+  /** @deprecated */
+  _resizeFramebuffer() {
+  }
+};
+
+// src/test-runner.ts
 var DEFAULT_TEST_CASE = {
   name: "Unnamed test",
-  onInitialize: noop,
+  onInitialize: () => __async(void 0, null, function* () {
+  }),
   onRender: ({ done }) => done(),
-  onFinalize: noop
+  onFinalize: () => {
+  }
 };
 var DEFAULT_TEST_PROPS = {
+  width: void 0,
+  height: void 0,
   // test lifecycle callback
   onTestStart: (testCase) => console.log(`# ${testCase.name}`),
-  onTestPass: (testCase) => console.log(`ok ${testCase.name} passed`),
-  onTestFail: (testCase) => console.log(`not ok ${testCase.name} failed`),
+  onTestPass: (testCase, result) => console.log(`ok ${testCase.name} passed`),
+  onTestFail: (testCase, error) => console.log(`not ok ${testCase.name} failed`),
   // milliseconds to wait for each test case before aborting
-  timeout: 2e3
+  timeout: 2e3,
+  maxFramesToRender: void 0,
+  imageDiffOptions: void 0
 };
 var TestRunner = class {
   /**
@@ -169,9 +614,10 @@ var TestRunner = class {
     this.device = webglDevice;
     this.isRunning = false;
     this.testOptions = __spreadValues({}, DEFAULT_TEST_PROPS);
-    this._animationProps = {};
     this._testCases = [];
     this._testCaseData = null;
+    // should be defined in snapshot-test-runner
+    this.isDiffing = false;
     // @ts-expect-error
     this.isHeadless = Boolean(window.browserTestDriver_isHeadless);
     this.props = props;
@@ -194,7 +640,7 @@ var TestRunner = class {
   run(options = {}) {
     this.testOptions = __spreadValues(__spreadValues({}, this.testOptions), options);
     return new Promise((resolve, reject) => {
-      this._animationLoop = new import_webgl_legacy.AnimationLoop(__spreadProps(__spreadValues({}, this.props), {
+      this._animationLoop = new ClassicAnimationLoop(__spreadProps(__spreadValues({}, this.props), {
         device: this.device,
         onRender: this._onRender.bind(this),
         onFinalize: () => {
@@ -275,7 +721,7 @@ var TestRunner = class {
       for (const key in this._testCaseData) {
         const value = this._testCaseData[key];
         if (value && value.delete) {
-          value.delete();
+          value.destroy();
         }
       }
       this._currentTestCase.onFinalize(Object.assign({}, animationProps, this._testCaseData));
@@ -318,9 +764,10 @@ function getBoundingBoxInPage(domElement) {
 
 // src/snapshot-test-runner.ts
 var SnapshotTestRunner = class extends TestRunner {
+  // should be defined here but hack access in TestRunner
+  // private isDiffing: boolean = false;
   constructor(props) {
     super(props);
-    this.isDiffing = false;
     this.testOptions.imageDiffOptions = {};
   }
   initTestCase(testCase) {

package/dist/snapshot-test-runner.d.ts

@@ -10,7 +10,6 @@ export declare type SnapshotTestRunnerTestCase = TestRunnerTestCase & {
 };
 export declare type SnapshotTestRunnerProps = TestRunnerProps;
 export declare class SnapshotTestRunner extends TestRunner {
-    private isDiffing;
     constructor(props: SnapshotTestRunnerProps);
     initTestCase(testCase: SnapshotTestRunnerTestCase): void;
     shouldRender(): boolean;

package/dist/snapshot-test-runner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snapshot-test-runner.d.ts","sourceRoot":"","sources":["../src/snapshot-test-runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,eAAe,EAAE,kBAAkB,EAAC,MAAM,eAAe,CAAC;AAG9E,2BAA2B;AAC3B,oBAAY,0BAA0B,GAAG,kBAAkB,GAAG;IAC5D,0BAA0B;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB;IACnB,gBAAgB,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAAC;CACzC,CAAA;AAED,oBAAY,uBAAuB,GAAG,eAAe,CAAC;AAEtD,qBAAa,kBAAmB,SAAQ,UAAU;IAChD,OAAO,CAAC,SAAS,CAAkB;gBAEvB,KAAK,EAAE,uBAAuB;IAKjC,YAAY,CAAC,QAAQ,EAAE,0BAA0B,GAAG,IAAI;IAOxD,YAAY,IAAI,OAAO;IAKjB,MAAM,CAAC,QAAQ,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;CAgC3E"}
+{"version":3,"file":"snapshot-test-runner.d.ts","sourceRoot":"","sources":["../src/snapshot-test-runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,eAAe,EAAE,kBAAkB,EAAC,MAAM,eAAe,CAAC;AAG9E,2BAA2B;AAC3B,oBAAY,0BAA0B,GAAG,kBAAkB,GAAG;IAC5D,0BAA0B;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB;IACnB,gBAAgB,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAAC;CACzC,CAAA;AAED,oBAAY,uBAAuB,GAAG,eAAe,CAAC;AAEtD,qBAAa,kBAAmB,SAAQ,UAAU;gBAIpC,KAAK,EAAE,uBAAuB;IAKjC,YAAY,CAAC,QAAQ,EAAE,0BAA0B,GAAG,IAAI;IAOxD,YAAY,IAAI,OAAO;IAKjB,MAAM,CAAC,QAAQ,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;CAgC3E"}

package/dist/snapshot-test-runner.js

@@ -1,10 +1,8 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
 import { TestRunner } from "./test-runner.js";
 import { getBoundingBoxInPage } from "./utils.js";
 export class SnapshotTestRunner extends TestRunner {
   constructor(props) {
     super(props);
-    _defineProperty(this, "isDiffing", false);
     this.testOptions.imageDiffOptions = {};
   }
   initTestCase(testCase) {

package/dist/snapshot-test-runner.js.map

@@ -1 +1 @@
-{"version":3,"file":"snapshot-test-runner.js","names":["TestRunner","getBoundingBoxInPage","SnapshotTestRunner","constructor","props","_defineProperty","testOptions","imageDiffOptions","initTestCase","testCase","goldenImage","Error","concat","name","shouldRender","isDiffing","assert","_this$_animationProps","canvas","_animationProps","HTMLCanvasElement","diffOptions","region","result","globalThis","browserTestDriver_captureAndDiffScreen","success","_pass","_fail","_next"],"sources":["../src/snapshot-test-runner.ts"],"sourcesContent":["import {TestRunner, TestRunnerProps, TestRunnerTestCase} from './test-runner';\nimport {getBoundingBoxInPage} from './utils';\n\n/** A snapshot test case */\nexport type SnapshotTestRunnerTestCase = TestRunnerTestCase & {\n  /** URL to golden image */\n  goldenImage: string;\n  /** Diff options */\n  imageDiffOptions?: {[key: string]: any}; \n}\n\nexport type SnapshotTestRunnerProps = TestRunnerProps;\n\nexport class SnapshotTestRunner extends TestRunner {\n  private isDiffing: boolean = false;\n\n  constructor(props: SnapshotTestRunnerProps) {\n    super(props);\n    this.testOptions.imageDiffOptions = {};\n  }\n\n  override initTestCase(testCase: SnapshotTestRunnerTestCase): void {\n    super.initTestCase(testCase);\n    if (!testCase.goldenImage) {\n      throw new Error(`Test case ${testCase.name} does not have golden image`);\n    }\n  }\n\n  override shouldRender(): boolean {\n    // wait for the current diffing to finish\n    return !this.isDiffing;\n  }\n\n  override async assert(testCase: SnapshotTestRunnerTestCase): Promise<void> {\n    if (this.isDiffing) {\n      // Already performing diffing\n      return;\n    }\n    this.isDiffing = true;\n\n    const canvas = this._animationProps?.canvas;\n    if (!(canvas instanceof HTMLCanvasElement)) {\n      throw new Error('canvas');\n    }\n\n    const diffOptions = {\n      ...this.testOptions.imageDiffOptions,\n      ...testCase.imageDiffOptions,\n      goldenImage: testCase.goldenImage,\n      region: getBoundingBoxInPage(canvas)\n    };\n\n    // Take screenshot and compare\n    const result = await globalThis.browserTestDriver_captureAndDiffScreen(diffOptions);\n\n    // invoke user callback\n    if (result.success) {\n      this._pass(result);\n    } else {\n      this._fail(result);\n    }\n\n    this.isDiffing = false;\n    this._next();\n  }\n}\n"],"mappings":";SAAQA,UAAU;AAAA,SACVC,oBAAoB;AAY5B,OAAO,MAAMC,kBAAkB,SAASF,UAAU,CAAC;EAGjDG,WAAWA,CAACC,KAA8B,EAAE;IAC1C,KAAK,CAACA,KAAK,CAAC;IAACC,eAAA,oBAHc,KAAK;IAIhC,IAAI,CAACC,WAAW,CAACC,gBAAgB,GAAG,CAAC,CAAC;EACxC;EAESC,YAAYA,CAACC,QAAoC,EAAQ;IAChE,KAAK,CAACD,YAAY,CAACC,QAAQ,CAAC;IAC5B,IAAI,CAACA,QAAQ,CAACC,WAAW,EAAE;MACzB,MAAM,IAAIC,KAAK,cAAAC,MAAA,CAAcH,QAAQ,CAACI,IAAI,iCAA8B;IAC1E;EACF;EAESC,YAAYA,CAAA,EAAY;IAE/B,OAAO,CAAC,IAAI,CAACC,SAAS;EACxB;EAEA,MAAeC,MAAMA,CAACP,QAAoC,EAAiB;IAAA,IAAAQ,qBAAA;IACzE,IAAI,IAAI,CAACF,SAAS,EAAE;MAElB;IACF;IACA,IAAI,CAACA,SAAS,GAAG,IAAI;IAErB,MAAMG,MAAM,IAAAD,qBAAA,GAAG,IAAI,CAACE,eAAe,cAAAF,qBAAA,uBAApBA,qBAAA,CAAsBC,MAAM;IAC3C,IAAI,EAAEA,MAAM,YAAYE,iBAAiB,CAAC,EAAE;MAC1C,MAAM,IAAIT,KAAK,CAAC,QAAQ,CAAC;IAC3B;IAEA,MAAMU,WAAW,GAAG;MAClB,GAAG,IAAI,CAACf,WAAW,CAACC,gBAAgB;MACpC,GAAGE,QAAQ,CAACF,gBAAgB;MAC5BG,WAAW,EAAED,QAAQ,CAACC,WAAW;MACjCY,MAAM,EAAErB,oBAAoB,CAACiB,MAAM;IACrC,CAAC;IAGD,MAAMK,MAAM,GAAG,MAAMC,UAAU,CAACC,sCAAsC,CAACJ,WAAW,CAAC;IAGnF,IAAIE,MAAM,CAACG,OAAO,EAAE;MAClB,IAAI,CAACC,KAAK,CAACJ,MAAM,CAAC;IACpB,CAAC,MAAM;MACL,IAAI,CAACK,KAAK,CAACL,MAAM,CAAC;IACpB;IAEA,IAAI,CAACR,SAAS,GAAG,KAAK;IACtB,IAAI,CAACc,KAAK,EAAE;EACd;AACF"}
+{"version":3,"file":"snapshot-test-runner.js","names":["TestRunner","getBoundingBoxInPage","SnapshotTestRunner","constructor","props","testOptions","imageDiffOptions","initTestCase","testCase","goldenImage","Error","concat","name","shouldRender","isDiffing","assert","_this$_animationProps","canvas","_animationProps","HTMLCanvasElement","diffOptions","region","result","globalThis","browserTestDriver_captureAndDiffScreen","success","_pass","_fail","_next"],"sources":["../src/snapshot-test-runner.ts"],"sourcesContent":["import {TestRunner, TestRunnerProps, TestRunnerTestCase} from './test-runner';\nimport {getBoundingBoxInPage} from './utils';\n\n/** A snapshot test case */\nexport type SnapshotTestRunnerTestCase = TestRunnerTestCase & {\n  /** URL to golden image */\n  goldenImage: string;\n  /** Diff options */\n  imageDiffOptions?: {[key: string]: any}; \n}\n\nexport type SnapshotTestRunnerProps = TestRunnerProps;\n\nexport class SnapshotTestRunner extends TestRunner {\n  // should be defined here but hack access in TestRunner\n  // private isDiffing: boolean = false;\n\n  constructor(props: SnapshotTestRunnerProps) {\n    super(props);\n    this.testOptions.imageDiffOptions = {};\n  }\n\n  override initTestCase(testCase: SnapshotTestRunnerTestCase): void {\n    super.initTestCase(testCase);\n    if (!testCase.goldenImage) {\n      throw new Error(`Test case ${testCase.name} does not have golden image`);\n    }\n  }\n\n  override shouldRender(): boolean {\n    // wait for the current diffing to finish\n    return !this.isDiffing;\n  }\n\n  override async assert(testCase: SnapshotTestRunnerTestCase): Promise<void> {\n    if (this.isDiffing) {\n      // Already performing diffing\n      return;\n    }\n    this.isDiffing = true;\n\n    const canvas = this._animationProps?.canvas;\n    if (!(canvas instanceof HTMLCanvasElement)) {\n      throw new Error('canvas');\n    }\n\n    const diffOptions = {\n      ...this.testOptions.imageDiffOptions,\n      ...testCase.imageDiffOptions,\n      goldenImage: testCase.goldenImage,\n      region: getBoundingBoxInPage(canvas)\n    };\n\n    // Take screenshot and compare\n    const result = await globalThis.browserTestDriver_captureAndDiffScreen(diffOptions);\n\n    // invoke user callback\n    if (result.success) {\n      this._pass(result);\n    } else {\n      this._fail(result);\n    }\n\n    this.isDiffing = false;\n    this._next();\n  }\n}\n"],"mappings":"SAAQA,UAAU;AAAA,SACVC,oBAAoB;AAY5B,OAAO,MAAMC,kBAAkB,SAASF,UAAU,CAAC;EAIjDG,WAAWA,CAACC,KAA8B,EAAE;IAC1C,KAAK,CAACA,KAAK,CAAC;IACZ,IAAI,CAACC,WAAW,CAACC,gBAAgB,GAAG,CAAC,CAAC;EACxC;EAESC,YAAYA,CAACC,QAAoC,EAAQ;IAChE,KAAK,CAACD,YAAY,CAACC,QAAQ,CAAC;IAC5B,IAAI,CAACA,QAAQ,CAACC,WAAW,EAAE;MACzB,MAAM,IAAIC,KAAK,cAAAC,MAAA,CAAcH,QAAQ,CAACI,IAAI,iCAA8B;IAC1E;EACF;EAESC,YAAYA,CAAA,EAAY;IAE/B,OAAO,CAAC,IAAI,CAACC,SAAS;EACxB;EAEA,MAAeC,MAAMA,CAACP,QAAoC,EAAiB;IAAA,IAAAQ,qBAAA;IACzE,IAAI,IAAI,CAACF,SAAS,EAAE;MAElB;IACF;IACA,IAAI,CAACA,SAAS,GAAG,IAAI;IAErB,MAAMG,MAAM,IAAAD,qBAAA,GAAG,IAAI,CAACE,eAAe,cAAAF,qBAAA,uBAApBA,qBAAA,CAAsBC,MAAM;IAC3C,IAAI,EAAEA,MAAM,YAAYE,iBAAiB,CAAC,EAAE;MAC1C,MAAM,IAAIT,KAAK,CAAC,QAAQ,CAAC;IAC3B;IAEA,MAAMU,WAAW,GAAG;MAClB,GAAG,IAAI,CAACf,WAAW,CAACC,gBAAgB;MACpC,GAAGE,QAAQ,CAACF,gBAAgB;MAC5BG,WAAW,EAAED,QAAQ,CAACC,WAAW;MACjCY,MAAM,EAAEpB,oBAAoB,CAACgB,MAAM;IACrC,CAAC;IAGD,MAAMK,MAAM,GAAG,MAAMC,UAAU,CAACC,sCAAsC,CAACJ,WAAW,CAAC;IAGnF,IAAIE,MAAM,CAACG,OAAO,EAAE;MAClB,IAAI,CAACC,KAAK,CAACJ,MAAM,CAAC;IACpB,CAAC,MAAM;MACL,IAAI,CAACK,KAAK,CAACL,MAAM,CAAC;IACpB;IAEA,IAAI,CAACR,SAAS,GAAG,KAAK;IACtB,IAAI,CAACc,KAAK,EAAE;EACd;AACF"}

package/dist/test-runner.d.ts

@@ -1,24 +1,26 @@
-import { AnimationProps } from '@luma.gl/webgl-legacy';
+import { AnimationProps } from '@luma.gl/engine';
+import { ClassicAnimationLoop as AnimationLoop } from './engine/classic-animation-loop';
 /** Describes a test case */
 export declare type TestRunnerTestCase = {
     /** Name of the test case (for logging) */
     name: string;
     /** Initialize the test case. Can return a promise */
-    onInitialize: (props: AnimationProps) => Promise<unknown>;
+    onInitialize: (props: AnimationProps) => Promise<void | {}>;
     /** Perform rendering */
     onRender: (props: AnimationProps & {
         done: any;
     }) => void;
     /** Clean up after the test case */
     onFinalize: (props: AnimationProps) => void;
+    animationLoop?: AnimationLoop;
 };
 /** Options for a TestRunner */
 export declare type TestRunnerProps = {
     width?: number;
     height?: number;
     onTestStart?: (testCase: TestRunnerTestCase) => void;
-    onTestPass?: (testCase: TestRunnerTestCase) => void;
-    onTestFail?: (testCase: TestRunnerTestCase) => void;
+    onTestPass?: (testCase: TestRunnerTestCase, result?: unknown) => void;
+    onTestFail?: (testCase: TestRunnerTestCase, error?: unknown) => void;
     /** milliseconds to wait for each test case before aborting */
     timeout?: number;
     maxFramesToRender?: number;
@@ -29,11 +31,15 @@ export declare class TestRunner {
     device: import("modules/webgl/dist").WebGLDevice;
     props: Record<string, any>;
     isRunning: boolean;
-    readonly testOptions: Required<TestRunnerProps>;
+    testOptions: Required<TestRunnerProps>;
     readonly _animationProps?: AnimationProps;
     private _animationLoop;
     private _testCases;
     private _testCaseData;
+    private _currentTestCase;
+    private _currentTestCaseStartTime;
+    private _currentTestCaseStartTick;
+    isDiffing: boolean;
     isHeadless: boolean;
     /**
      * props

package/dist/test-runner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test-runner.d.ts","sourceRoot":"","sources":["../src/test-runner.ts"],"names":[],"mappings":"AAEA,OAAO,EAAgB,cAAc,EAAC,MAAM,uBAAuB,CAAC;AAGpE,4BAA4B;AAC5B,oBAAY,kBAAkB,GAAG;IAC/B,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,YAAY,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1D,wBAAwB;IACxB,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,GAAG;QAAC,IAAI,MAAA;KAAC,KAAK,IAAI,CAAC;IACnD,mCAAmC;IACnC,UAAU,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;CAC7C,CAAC;AAWF,+BAA+B;AAC/B,oBAAY,eAAe,GAAG;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACrD,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACpD,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACpD,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE,GAAG,CAAC;CACxB,CAAC;AAYF,kCAAkC;AAClC,qBAAa,UAAU;IACrB,MAAM,2CAAe;IACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,SAAS,EAAE,OAAO,CAAS;IAC3B,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,eAAe,CAAC,CAA2B;IAC1E,QAAQ,CAAC,eAAe,CAAC,EAAE,cAAc,CAAM;IAC/C,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,UAAU,CAA4B;IAC9C,OAAO,CAAC,aAAa,CAAa;IAGlC,UAAU,EAAE,OAAO,CAAgD;IAEnE;;;OAGG;gBACS,KAAK,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM;IAI3C;;OAEG;IACH,GAAG,CAAC,SAAS,EAAE,kBAAkB,EAAE,GAAG,IAAI;IAU1C;;QAEI;IACJ,GAAG,CAAC,OAAO,GAAE,MAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BxC,YAAY,CAAC,QAAQ,EAAE,kBAAkB;IAYzC,YAAY,CAAC,cAAc,KAAA,GAAG,OAAO;IAIrC,MAAM,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI;IAO1C,KAAK,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAK5B,KAAK,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAK5B,KAAK,IAAI,IAAI;IAMb,SAAS,CAAC,cAAc,KAAA,GAAG,IAAI;IA2C/B,aAAa,IAAI,OAAO,CAAC,kBAAkB,CAAC;CAuD7C"}
+{"version":3,"file":"test-runner.d.ts","sourceRoot":"","sources":["../src/test-runner.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,cAAc,EAAC,MAAM,iBAAiB,CAAC;AAI/C,OAAO,EAAC,oBAAoB,IAAI,aAAa,EAAC,MAAM,iCAAiC,CAAC;AAEtF,4BAA4B;AAC5B,oBAAY,kBAAkB,GAAG;IAC/B,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,YAAY,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;IAC5D,wBAAwB;IACxB,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,GAAG;QAAC,IAAI,MAAA;KAAC,KAAK,IAAI,CAAC;IACnD,mCAAmC;IACnC,UAAU,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IAC5C,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AASF,+BAA+B;AAC/B,oBAAY,eAAe,GAAG;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACrD,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IACtE,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,kBAAkB,EAAE,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IACrE,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,gBAAgB,CAAC,EAAE,GAAG,CAAC;CACxB,CAAC;AAiBF,kCAAkC;AAClC,qBAAa,UAAU;IACrB,MAAM,2CAAe;IACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,SAAS,EAAE,OAAO,CAAS;IAC3B,WAAW,EAAE,QAAQ,CAAC,eAAe,CAAC,CAA2B;IACjE,QAAQ,CAAC,eAAe,CAAC,EAAE,cAAc,CAAC;IAC1C,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,UAAU,CAA4B;IAC9C,OAAO,CAAC,aAAa,CAAa;IAClC,OAAO,CAAC,gBAAgB,CAA4B;IACpD,OAAO,CAAC,yBAAyB,CAAS;IAC1C,OAAO,CAAC,yBAAyB,CAAS;IAG1C,SAAS,EAAE,OAAO,CAAS;IAG3B,UAAU,EAAE,OAAO,CAAgD;IAEnE;;;OAGG;gBACS,KAAK,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM;IAI3C;;OAEG;IACH,GAAG,CAAC,SAAS,EAAE,kBAAkB,EAAE,GAAG,IAAI;IAU1C;;QAEI;IACJ,GAAG,CAAC,OAAO,GAAE,MAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BxC,YAAY,CAAC,QAAQ,EAAE,kBAAkB;IAYzC,YAAY,CAAC,cAAc,KAAA,GAAG,OAAO;IAIrC,MAAM,CAAC,QAAQ,EAAE,kBAAkB,GAAG,IAAI;IAO1C,KAAK,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAK5B,KAAK,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAK5B,KAAK,IAAI,IAAI;IAMb,SAAS,CAAC,cAAc,KAAA,GAAG,IAAI;IA2C/B,aAAa,IAAI,OAAO,CAAC,kBAAkB,CAAC;CAuD7C"}