Merge pull request #8005 from processing/millis

Reset millis() after setup

Author: davepagurek

src/core/main.js

@@ -238,7 +238,8 @@ class p5 {
       constants.P2D
     );
 
-    // Record the time when sketch starts
+    // Record the time when setup starts. millis() will start at 0 within
+    // setup, but this isn't documented, locked-in behavior yet.
     this._millisStart = window.performance.now();
 
     const context = this._isGlobal ? window : this;
@@ -274,6 +275,10 @@ class p5 {
 
     // Run `postsetup` hooks
     await this._runLifecycleHook('postsetup');
+
+    // Record the time when the draw loop starts so that millis() starts at 0
+    // when the draw loop begins.
+    this._millisStart = window.performance.now();
   }
 
   // While '#_draw' here is async, it is not awaited as 'requestAnimationFrame'
@@ -468,11 +473,11 @@ for (const k in constants) {
  * If `setup()` is declared `async` (e.g. `async function setup()`),
  * execution pauses at each `await` until its promise resolves.
  * For example, `font = await loadFont(...)` waits for the font asset
- * to load because `loadFont()` function returns a promise, and the await 
+ * to load because `loadFont()` function returns a promise, and the await
  * keyword means the program will wait for the promise to resolve.
  * This ensures that all assets are fully loaded before the sketch continues.
 
- * 
+ *
  * loading assets.
  *
  * Note: `setup()` doesn’t have to be declared, but it’s common practice to do so.

test/unit/core/main.js

@@ -179,4 +179,36 @@ suite('Core', function () {
       assert.isUndefined(logMsg);
     });
   });
+
+  suite('millis()', () => {
+    let myp5
+
+    beforeEach(() => {
+      vi.useFakeTimers();
+    });
+    afterEach(() => {
+      vi.useRealTimers();
+      if (myp5) {
+        myp5.remove();
+        myp5 = undefined;
+      }
+    });
+
+    test('millis() starts at 0 when the draw loop begins', async () => {
+      const t = await new Promise((resolve) => {
+        myp5 = new p5((p) => {
+          p.setup = () => {
+            // Pretend setup takes 1s
+            vi.advanceTimersByTime(1000);
+          };
+          p.draw = () => {
+            // Pretend draw() happens 50ms after setup
+            vi.advanceTimersByTime(50);
+            resolve(p.millis());
+          };
+        });
+      });
+      expect(t).toEqual(50);
+    });
+  });
 });

vitest.workspace.mjs

@@ -1,4 +1,4 @@
-import { defineWorkspace } from 'vitest/config';
+import { defineWorkspace, configDefaults } from 'vitest/config';
 import vitePluginString from 'vite-plugin-string';
 
 const plugins = [
@@ -38,7 +38,10 @@ export default defineWorkspace([
         name: 'chrome',
         provider: 'webdriverio',
         screenshotFailures: false
-      }
+      },
+      fakeTimers: {
+        toFake: [...(configDefaults.fakeTimers.toFake ?? []), 'performance'],
+      },
     }
   }
 ]);