|
| 1 | +/* |
| 2 | +Toolbox Aid |
| 3 | +David Quesenberry |
| 4 | +04/17/2026 |
| 5 | +DebugObservabilityMaturity.test.mjs |
| 6 | +*/ |
| 7 | +import assert from "node:assert/strict"; |
| 8 | +import { drawPerformanceMetricsPanel } from "../../src/engine/debug/PerformanceMetricsPanel.js"; |
| 9 | +import { create3dCollisionOverlaysPanel } from "../../src/engine/debug/standard/threeD/panels/panel3dCollisionOverlays.js"; |
| 10 | +import { createCollisionOverlaysProvider } from "../../src/engine/debug/standard/threeD/providers/collisionOverlaysProvider.js"; |
| 11 | +import { createAdvancedInspectorDebugPluginDefinition } from "../../src/engine/debug/inspectors/index.js"; |
| 12 | +import { createNetworkObservabilityPanels } from "../../src/engine/debug/network/index.js"; |
| 13 | +import { drawActionInputDebugOverlay } from "../../src/engine/input/ActionInputDebugOverlay.js"; |
| 14 | + |
| 15 | +function createRendererProbe() { |
| 16 | + const texts = []; |
| 17 | + return { |
| 18 | + texts, |
| 19 | + drawRect() {}, |
| 20 | + strokeRect() {}, |
| 21 | + drawText(text) { |
| 22 | + texts.push(String(text)); |
| 23 | + } |
| 24 | + }; |
| 25 | +} |
| 26 | + |
| 27 | +export async function run() { |
| 28 | + const renderingRenderer = createRendererProbe(); |
| 29 | + drawPerformanceMetricsPanel( |
| 30 | + renderingRenderer, |
| 31 | + { |
| 32 | + getSnapshot: () => ({ |
| 33 | + fps: 59.7, |
| 34 | + frameMs: 16.73, |
| 35 | + updateMs: 5.3, |
| 36 | + renderMs: 4.21, |
| 37 | + fixedUpdates: 1 |
| 38 | + }) |
| 39 | + }, |
| 40 | + { x: 0, y: 0 } |
| 41 | + ); |
| 42 | + assert.equal(renderingRenderer.texts.some((line) => line.includes("Render ms: 4.21")), true); |
| 43 | + |
| 44 | + const inputRenderer = createRendererProbe(); |
| 45 | + drawActionInputDebugOverlay( |
| 46 | + inputRenderer, |
| 47 | + { |
| 48 | + getActionDebugSnapshot: () => [ |
| 49 | + { |
| 50 | + action: "move", |
| 51 | + down: true, |
| 52 | + pressed: true, |
| 53 | + buffered: false, |
| 54 | + queued: true, |
| 55 | + windowOpen: true, |
| 56 | + cooldown: false |
| 57 | + } |
| 58 | + ], |
| 59 | + getQueuedActions: () => [{ action: "move", priority: 2 }], |
| 60 | + getActionChainProgress: () => 2, |
| 61 | + isActionChainComplete: () => false |
| 62 | + }, |
| 63 | + { |
| 64 | + x: 0, |
| 65 | + y: 0, |
| 66 | + chains: ["movement"] |
| 67 | + } |
| 68 | + ); |
| 69 | + assert.equal(inputRenderer.texts.some((line) => line.includes("move: D1 P1 B0 Q1 W1 C0")), true); |
| 70 | + assert.equal(inputRenderer.texts.some((line) => line.includes("Queue: move:2")), true); |
| 71 | + |
| 72 | + const collisionProvider = createCollisionOverlaysProvider({ |
| 73 | + collisionOverlays: () => ({ |
| 74 | + overlays: [ |
| 75 | + { overlayId: "broadphase", kind: "bounds", state: "active", enabled: true } |
| 76 | + ] |
| 77 | + }) |
| 78 | + }); |
| 79 | + const collisionSnapshot = collisionProvider.getSnapshot({}); |
| 80 | + assert.equal(collisionSnapshot.overlayCount, 1); |
| 81 | + assert.equal(collisionSnapshot.activeCount, 1); |
| 82 | + |
| 83 | + const collisionPanel = create3dCollisionOverlaysPanel(collisionProvider, { enabled: true }); |
| 84 | + const collisionRender = collisionPanel.render({}, {}); |
| 85 | + assert.equal(collisionRender.lines.includes("overlay.1=broadphase|bounds|active|enabled=true"), true); |
| 86 | + |
| 87 | + const inspectorPlugin = createAdvancedInspectorDebugPluginDefinition({ |
| 88 | + panelsEnabled: true |
| 89 | + }); |
| 90 | + const inspectorProviders = inspectorPlugin.getProviders(); |
| 91 | + assert.equal( |
| 92 | + inspectorProviders.some((provider) => provider.providerId === "inspector.stateDiff.snapshot"), |
| 93 | + true |
| 94 | + ); |
| 95 | + assert.equal( |
| 96 | + inspectorProviders.some((provider) => provider.providerId === "inspector.timeline.snapshot"), |
| 97 | + true |
| 98 | + ); |
| 99 | + |
| 100 | + const inspectorContext = { |
| 101 | + inspectors: { |
| 102 | + state: { |
| 103 | + current: { |
| 104 | + mode: "play", |
| 105 | + replayFrame: 12 |
| 106 | + } |
| 107 | + }, |
| 108 | + timelineMarkers: [ |
| 109 | + { |
| 110 | + markerId: "replay-12", |
| 111 | + frameIndex: 12, |
| 112 | + category: "replay", |
| 113 | + label: "Replay frame 12" |
| 114 | + } |
| 115 | + ], |
| 116 | + eventStream: [ |
| 117 | + { |
| 118 | + eventId: "input-pressed", |
| 119 | + category: "input", |
| 120 | + message: "move pressed" |
| 121 | + } |
| 122 | + ] |
| 123 | + } |
| 124 | + }; |
| 125 | + |
| 126 | + const inspectorPanels = inspectorPlugin.getPanels(); |
| 127 | + const stateDiffPanel = inspectorPanels.find((panel) => panel.id === "inspector-state-diff"); |
| 128 | + const timelinePanel = inspectorPanels.find((panel) => panel.id === "inspector-timeline"); |
| 129 | + const stateDiffRender = stateDiffPanel.render(stateDiffPanel, inspectorContext); |
| 130 | + const timelineRender = timelinePanel.render(timelinePanel, inspectorContext); |
| 131 | + assert.equal(stateDiffRender.lines.some((line) => line.includes("added:mode")), true); |
| 132 | + assert.equal(timelineRender.lines.some((line) => line.includes("category=replay")), true); |
| 133 | + |
| 134 | + const networkPanels = createNetworkObservabilityPanels(); |
| 135 | + const latencyRender = networkPanels[0].render(networkPanels[0], { |
| 136 | + assets: { |
| 137 | + network: { |
| 138 | + latency: { |
| 139 | + status: "degraded", |
| 140 | + rttMs: 85, |
| 141 | + jitterMs: 11 |
| 142 | + }, |
| 143 | + replication: { |
| 144 | + hostTick: 300, |
| 145 | + highestBacklog: 5 |
| 146 | + } |
| 147 | + } |
| 148 | + } |
| 149 | + }); |
| 150 | + assert.equal(latencyRender.lines.some((line) => line.includes("rttMs=85")), true); |
| 151 | +} |
0 commit comments