Enhance debug profiler to track tree framerate and dispatch errors (#10502)

2026-04-21 02:24:09 -07:00 · 2025-10-07 10:28:35 -07:00
parent 6bb99806f0
commit 34ba8be821
20 changed files with 487 additions and 27 deletions
@@ -0,0 +1,183 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
+import {
+  profiler,
+  ACTION_TIMESTAMP_CAPACITY,
+  FRAME_TIMESTAMP_CAPACITY,
+} from './DebugProfiler.js';
+import { FixedDeque } from 'mnemonist';
+
+describe('DebugProfiler', () => {
+  beforeEach(() => {
+    vi.useFakeTimers();
+    profiler.numFrames = 0;
+    profiler.totalIdleFrames = 0;
+    profiler.lastFrameStartTime = 0;
+    profiler.openedDebugConsole = false;
+    profiler.lastActionTimestamp = 0;
+    profiler.possiblyIdleFrameTimestamps = new FixedDeque<number>(
+      Array,
+      FRAME_TIMESTAMP_CAPACITY,
+    );
+    profiler.actionTimestamps = new FixedDeque<number>(
+      Array,
+      ACTION_TIMESTAMP_CAPACITY,
+    );
+  });
+
+  afterEach(() => {
+    vi.restoreAllMocks();
+    profiler.actionTimestamps.clear();
+    profiler.possiblyIdleFrameTimestamps.clear();
+  });
+
+  it('should not exceed action timestamp capacity', () => {
+    for (let i = 0; i < ACTION_TIMESTAMP_CAPACITY + 10; i++) {
+      profiler.reportAction();
+      // To ensure we don't trigger the debounce
+      profiler.lastActionTimestamp = 0;
+    }
+    expect(profiler.actionTimestamps.size).toBe(ACTION_TIMESTAMP_CAPACITY);
+  });
+
+  it('should not exceed frame timestamp capacity', () => {
+    for (let i = 0; i < FRAME_TIMESTAMP_CAPACITY + 10; i++) {
+      profiler.reportFrameRendered();
+      // To ensure we don't trigger the debounce
+      profiler.lastFrameStartTime = 0;
+    }
+    expect(profiler.possiblyIdleFrameTimestamps.size).toBe(
+      FRAME_TIMESTAMP_CAPACITY,
+    );
+  });
+
+  it('should drop oldest action timestamps when capacity is reached', () => {
+    for (let i = 0; i < ACTION_TIMESTAMP_CAPACITY; i++) {
+      profiler.actionTimestamps.push(i);
+    }
+    profiler.lastActionTimestamp = 0;
+    profiler.reportAction();
+
+    expect(profiler.actionTimestamps.size).toBe(ACTION_TIMESTAMP_CAPACITY);
+    expect(profiler.actionTimestamps.peekFirst()).toBe(1);
+  });
+
+  it('should drop oldest frame timestamps when capacity is reached', () => {
+    for (let i = 0; i < FRAME_TIMESTAMP_CAPACITY; i++) {
+      profiler.possiblyIdleFrameTimestamps.push(i);
+    }
+    profiler.lastFrameStartTime = 0;
+    profiler.reportFrameRendered();
+
+    expect(profiler.possiblyIdleFrameTimestamps.size).toBe(
+      FRAME_TIMESTAMP_CAPACITY,
+    );
+    expect(profiler.possiblyIdleFrameTimestamps.peekFirst()).toBe(1);
+  });
+
+  it('should not report frames as idle if an action happens shortly after', async () => {
+    const startTime = Date.now();
+    vi.setSystemTime(startTime);
+
+    for (let i = 0; i < 5; i++) {
+      profiler.reportFrameRendered();
+      vi.advanceTimersByTime(20);
+    }
+
+    vi.setSystemTime(startTime + 400);
+    profiler.reportAction();
+
+    vi.advanceTimersByTime(600);
+    profiler.checkForIdleFrames();
+
+    expect(profiler.totalIdleFrames).toBe(0);
+  });
+
+  it('should report frames as idle if no action happens nearby', async () => {
+    const startTime = Date.now();
+    vi.setSystemTime(startTime);
+
+    for (let i = 0; i < 5; i++) {
+      profiler.reportFrameRendered();
+      vi.advanceTimersByTime(20);
+    }
+
+    vi.advanceTimersByTime(1000);
+    profiler.checkForIdleFrames();
+
+    expect(profiler.totalIdleFrames).toBe(5);
+  });
+
+  it('should not report frames as idle if an action happens shortly before', async () => {
+    const startTime = Date.now();
+    vi.setSystemTime(startTime);
+
+    profiler.reportAction();
+
+    vi.advanceTimersByTime(400);
+
+    for (let i = 0; i < 5; i++) {
+      profiler.reportFrameRendered();
+      vi.advanceTimersByTime(20);
+    }
+
+    vi.advanceTimersByTime(600);
+    profiler.checkForIdleFrames();
+
+    expect(profiler.totalIdleFrames).toBe(0);
+  });
+
+  it('should correctly identify mixed idle and non-idle frames', async () => {
+    const startTime = Date.now();
+    vi.setSystemTime(startTime);
+
+    for (let i = 0; i < 3; i++) {
+      profiler.reportFrameRendered();
+      vi.advanceTimersByTime(20);
+    }
+
+    vi.advanceTimersByTime(1000);
+
+    profiler.reportAction();
+    vi.advanceTimersByTime(100);
+
+    for (let i = 0; i < 3; i++) {
+      profiler.reportFrameRendered();
+      vi.advanceTimersByTime(20);
+    }
+
+    vi.advanceTimersByTime(600);
+    profiler.checkForIdleFrames();
+
+    expect(profiler.totalIdleFrames).toBe(3);
+  });
+
+  it('should not report idle frames when actions are interleaved', async () => {
+    const startTime = Date.now();
+    vi.setSystemTime(startTime);
+
+    profiler.reportFrameRendered();
+    vi.advanceTimersByTime(20);
+
+    profiler.reportFrameRendered();
+    vi.advanceTimersByTime(200);
+
+    profiler.reportAction();
+    vi.advanceTimersByTime(200);
+
+    profiler.reportFrameRendered();
+    vi.advanceTimersByTime(20);
+
+    profiler.reportFrameRendered();
+
+    vi.advanceTimersByTime(600);
+    profiler.checkForIdleFrames();
+
+    expect(profiler.totalIdleFrames).toBe(0);
+  });
+});