fix(venue/highway): flyover replay on arrangement switch, venue on Virtuoso, and the paused throttle starving the venue (#968)

* fix(venue): don't replay the flyover on an arrangement switch; keep the venue off other screens

Two bugs from a live career session.

1. CHANGING ARRANGEMENT REPLAYED THE ARRIVAL FLYOVER.

   changeArrangement() reloads the song through the normal load path, so
   highway.js re-emits `song:loaded` — same filename, new arrangement. The venue
   could not tell that from a fresh arrival, so it reset the machine and flew the
   camera in from the back of the room again, mid-set, every time the player
   switched lead -> rhythm. The player is already on stage.

   onSongLoaded now compares the filename. A repeat of the song already on stage
   keeps the video pipeline running and only re-syncs the mood: the performance
   restarts, so the loop follows the reset machine with a quiet crossfade, never
   the intro. A genuinely different song still gets the full teardown + flyover.

2. THE VENUE SHOWED UP ON THE VIRTUOSO HIGHWAY.

   The venue was gated purely on `isVenueViz()` — the selected visualization,
   which is a GLOBAL preference and says nothing about what is on screen.
   Virtuoso borrows the same highway_3d renderer for its practice charts, so with
   Venue selected it inherited the backdrop: the crowd and the stage behind a
   chromatic exercise.

   Selecting Venue is a preference for the PLAYER; it is not a licence to paint
   the venue over whatever else happens to be using the renderer. The venue is now
   gated on viz AND screen (`shouldBeActive`), and follows `screen:changed` — it
   tears down on leaving the player and rebuilds on return. Nothing else changes:
   stop() already unbinds the videos from the renderer, so deactivating is enough
   to clear the backdrop.

Tests: both decisions exposed as pure predicates and pinned — arrangement switch
vs new song (including the first load, and a malformed payload that must not
suppress the flyover forever), and the venue's screen scope. The existing syncViz
test encoded the OLD contract (activate regardless of screen), so it now states
the new one and additionally asserts the venue does NOT activate on virtuoso.

Includes a guard test: with Venue selected AND on the player, the venue IS
active — without it, every "not active" assertion could pass vacuously.

All 8 new/updated assertions fail against the pre-fix source. eslint clean;
JS 1199/1199; pytest 2597 passed.

* fix(highway): the paused-frame throttle was throttling the whole venue

Pausing the song dropped the venue, the crowd and the stage to ~10 fps —
"everything around the highway drops fps by a lot".

draw() caps paused frames to one per _PAUSED_FRAME_INTERVAL_MS (100ms), on an
assumption stated plainly in highway-constants.js: a heavy WebGL renderer "does
a full render every frame even while paused. That is pure waste." That was true
when a paused chart was a still picture.

The venue broke the assumption. Its video backdrop keeps playing and its crowd
reacts on a clock of their own, and BOTH are drawn into the same canvas as the
notes — so a throttle aimed at static notes throttled the entire room. The
scene only got a texture upload 10 times a second while the transport sat
paused.

Renderers can now declare that their picture is not static while the chart
clock is stopped: an optional needsContinuousFrames(). The throttle is skipped
only when it returns exactly true, and the probe fails closed — a renderer that
doesn't implement it, or one that throws, keeps the throttle unchanged. So the
GPU saving that motivated #654 survives everywhere it was actually valid.

highway_3d implements it and claims continuous frames ONLY while a crowd video
is genuinely rolling (bound, unpaused, not ended, readyState >= 2). With no
venue pack — the common case — the paused scene really is static, so it keeps
the throttle and the GPU still idles.

Tests extend tests/js/highway_pause_throttle.test.js, which guards this code
path source-level (the draw loop owns the rAF + WebGL lifecycle and is
deliberately not reproduced in a vm — see the file header). The new guards pin
that the capability GATES the early return rather than merely being called near
it, that the probe fails closed on absent/non-function/throwing/truthy-but-not-
true, and that the 3D renderer keys off the real video elements and can still
return false. All 3 fail against the pre-fix source.

eslint 0 errors; JS 1202/1202; pytest 2597 passed.
This commit is contained in:
Byron Gamatos
2026-07-14 22:11:52 +02:00
committed by GitHub
parent 8ef97708ef
commit 4e0e3c5417
7 changed files with 298 additions and 6 deletions
+119
View File
@@ -0,0 +1,119 @@
// Two venue bugs reported from a live career session.
//
// 1. Changing arrangement mid-song replayed the venue arrival flyover. The
// camera flew in from the back of the room again, every time the player
// switched lead -> rhythm. changeArrangement() reloads the song through the
// normal load path, so highway.js re-emits `song:loaded` — same filename,
// new arrangement — and the venue could not tell that from a fresh arrival.
// The player is already on stage; the room should just carry on.
//
// 2. With Venue selected, the venue backdrop showed up on the VIRTUOSO highway.
// The venue was gated purely on the viz selection, which is a global
// preference and says nothing about what is on screen. Virtuoso borrows the
// same highway_3d renderer for its practice charts, so it inherited the
// crowd and the stage behind a chromatic exercise. The venue belongs to the
// song player and nowhere else.
'use strict';
const { test } = require('node:test');
const assert = require('node:assert/strict');
const crowd = require('../../static/v3/venue-crowd.js');
// ── 1. arrangement switch is not an arrival ────────────────────────────────
test('same filename = arrangement switch (no arrival flyover)', () => {
// changeArrangement() re-emits song:loaded for the song already on stage.
assert.equal(crowd.isArrangementSwitch('song.feedpak', 'song.feedpak'), true);
});
test('different filename = a genuinely new song (flyover is correct)', () => {
assert.equal(crowd.isArrangementSwitch('a.feedpak', 'b.feedpak'), false);
});
test('first load of the session is an arrival, not a switch', () => {
// No previous song -> the flyover must play.
assert.equal(crowd.isArrangementSwitch('', 'a.feedpak'), false);
});
test('a missing filename is never treated as a switch', () => {
// Otherwise a malformed payload would silently suppress the flyover for the
// rest of the session.
assert.equal(crowd.isArrangementSwitch('a.feedpak', ''), false);
assert.equal(crowd.isArrangementSwitch('a.feedpak', undefined), false);
assert.equal(crowd.isArrangementSwitch('', ''), false);
});
// ── 2. the venue belongs to the player screen ──────────────────────────────
const scene = require('../../static/v3/venue-scene-3d.js');
// Venue MUST be the selected visualization for these to mean anything: if the
// viz were unset, shouldBeActive() would be false for the wrong reason and the
// virtuoso assertion below would pass vacuously. Force the viz on, so the only
// thing under test is the SCREEN gate.
function withScreen(id, fn) {
const prevDoc = global.document;
const prevViz = global.v3VenueViz;
global.v3VenueViz = {
isVenueVisualization: (v) => String(v) === 'venue',
getSelectedVizId: () => 'venue',
};
global.document = {
querySelector(sel) {
if (sel !== '.screen.active') return null;
return id ? { id } : null;
},
};
try { return fn(); } finally { global.document = prevDoc; global.v3VenueViz = prevViz; }
}
test('guard: with Venue selected AND on the player, the venue IS active', () => {
// If this ever fails, every "not active" test below is vacuous.
withScreen('player', () => {
assert.equal(scene.shouldBeActive(), true,
'the screen gate must not break the normal case');
});
});
test('venue is active on the player screen', () => {
withScreen('player', () => {
assert.equal(scene.isPlayerScreen(), true);
});
});
test('venue is NOT active on the virtuoso screen (the bug)', () => {
withScreen('virtuoso', () => {
assert.equal(scene.isPlayerScreen(), false,
'Virtuoso borrows the same highway_3d renderer — the venue backdrop ' +
'must not follow it there');
assert.equal(scene.shouldBeActive(), false,
'selecting Venue is a preference for the PLAYER; it is not a licence ' +
'to paint the venue over whatever else is using the renderer');
});
});
test('venue is not active on any other screen either', () => {
for (const id of ['v3-home', 'plugin-folder_library', 'settings', 'career']) {
withScreen(id, () => {
assert.equal(scene.shouldBeActive(), false, `venue must not be active on ${id}`);
});
}
});
test('no active screen at all is not the player', () => {
withScreen(null, () => {
assert.equal(scene.isPlayerScreen(), false);
});
});
test('a throwing document does not take the venue down with it', () => {
const prev = global.document;
global.document = { querySelector() { throw new Error('detached'); } };
try {
assert.equal(scene.isPlayerScreen(), false, 'must fail closed, not throw');
} finally {
global.document = prev;
}
});