mirror of
https://github.com/got-feedBack/feedBack-desktop.git
synced 2026-09-12 20:38:11 +00:00
fix(audio): close the PR #107 review findings
Seven fixes on top of the audio-engine TLC branch, each with the gate that catches its regression. Blocking: - Monitor-mute suppression leaked its refcount. setMonitorMuteSuppressed() became a refcounted acquire/release, but screen.js's callers are deliberately unpaired: resolveChainRebuildGuard() leaves the suppression on when a rebuild yields an empty chain, and returns early without releasing while a provider route is still resolving. Harmless against the old latched bool, a permanent +1 each against a refcount — after a failed tone rebuild the count never returned to zero and monitor mute was silently dead for the rest of the session. The renderer now holds at most one suppression. - Slot ids are monotonic HANDLES (nextSlotId, never reset by clear()), not bounded indices, so argSlotId's 4096 ceiling meant that once a session created its 4096th processor EVERY guarded binding — setBypass, setParameter, remove/moveProcessor, open/closePluginEditor — silently no-opped for the rest of the run. Ceiling removed (same for SetMultiBypass's hardcoded 4096); unknown ids are still rejected by SignalChain::findSlotIndex. - clearChain / removeProcessor / moveProcessor took chainMutationMutex with a blocking lock_guard on the N-API thread — Electron's main thread, and on macOS also the JUCE message thread. LoadPreset/LoadVST hold that mutex across an unbounded plugin init (done->wait() has no timeout by design), so a slow plugin froze the whole main process, every IPC channel with it. They now queue on a libuv worker via queueChainMutation() and resolve a promise; the bridge awaits them so callers still observe the mutation applied. Also: - getChainState() dereferenced raw ProcessorSlot* returned by getAllSlots() after the lock was dropped — a concurrent clear() frees them under the reader. Replaced with SignalChain::getSlotSummaries(), which copies under the lock. getAllSlots() is gone (it had one caller). - The device-settings migration removed the localStorage copy even when the file-store save failed or was unavailable, losing the user's settings. - SetSlotState and GetParameters kept the raw Int32Value() path: IsNumber() is true for NaN, so setSlotState(NaN) wrote onto slot 0 — the same coercion class the rest of the branch fixed. - RendererBus flushed to the LIVE writeIndex, so a disable→re-enable with no pull in between discarded the freshly pushed audio along with the stale tail. It now snapshots the flush target at disable time. - LoadPreset's rebuild barrier is now released by a scope guard, so a throw between arming it and Queue() can't block editor opens forever. Gates: new renderer-bus case (fails on the old flush), new slot-id-handle case (fails on the old ceiling). ctest 9/9, npm test 79 pass / 0 fail, chain-mutation storm green, addon export contract unchanged.
This commit is contained in:
@@ -26,7 +26,12 @@ function writeImpulseWav(file) {
|
||||
fs.writeFileSync(file, buf);
|
||||
}
|
||||
|
||||
const GARBAGE = [NaN, Infinity, -Infinity, -1, 1.5, 4097, 'x', null, undefined, {}, []];
|
||||
// NB 2**31 (not 4097): a slot id is a monotonic HANDLE from nextSlotId, which
|
||||
// clear() never resets, so a long session legitimately hands out ids past any
|
||||
// small ceiling — see the slot-id-handle test below. What must be rejected is
|
||||
// the NaN/Inf/fractional/negative/non-number class, plus ids that don't fit an
|
||||
// int32 at all.
|
||||
const GARBAGE = [NaN, Infinity, -Infinity, -1, 1.5, 2 ** 31, 'x', null, undefined, {}, []];
|
||||
|
||||
test('chain-mutating bindings no-op on garbage args and never touch slot 0', { skip: !HAVE_ADDON && 'addon not built' }, async () => {
|
||||
const audio = require(ADDON);
|
||||
@@ -73,3 +78,53 @@ test('chain-mutating bindings no-op on garbage args and never touch slot 0', { s
|
||||
fs.rmSync(tmp, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
// PR #107 review: slot ids are monotonic HANDLES (SignalChain::nextSlotId,
|
||||
// never reset by clear()), not bounded indices. A ceiling in the N-API arg
|
||||
// guard meant that once a session had created its 4096th processor — a few
|
||||
// hundred song loads / tone switches, each rebuilding a chainful — EVERY
|
||||
// guarded binding (setBypass, setParameter, remove/moveProcessor, open/close
|
||||
// PluginEditor) silently no-opped for the rest of the run, with no error.
|
||||
//
|
||||
// Deliberately slow (~40s): the only way to observe the bug through the public
|
||||
// surface is to actually push nextSlotId past the old ceiling and then drive a
|
||||
// real slot. Batched as 21 x 210-slot presets so only 210 IRLoaders are ever
|
||||
// live at once.
|
||||
test('slot ids are handles, not indices — bindings still work past the old 4096 ceiling',
|
||||
{ skip: !HAVE_ADDON && 'addon not built' }, async () => {
|
||||
const audio = require(ADDON);
|
||||
audio.init();
|
||||
const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'slot-handle-'));
|
||||
const ir = path.join(tmp, 'i.wav');
|
||||
writeImpulseWav(ir);
|
||||
const SLOTS = 210, LOADS = 21; // 4410 ids > the old 4096 ceiling
|
||||
try {
|
||||
let slots = [];
|
||||
for (let i = 0; i < LOADS; i++) {
|
||||
const res = await audio.loadPreset(JSON.stringify({
|
||||
chain: Array.from({ length: SLOTS }, (_, k) => ({
|
||||
type: 2, name: `handle-${k}`, path: ir, bypassed: false,
|
||||
})),
|
||||
}));
|
||||
assert.ok(res?.success, `preset ${i} must load`);
|
||||
slots = audio.getChainState();
|
||||
}
|
||||
|
||||
const maxId = Math.max(...slots.map((s) => s.id));
|
||||
assert.ok(maxId > 4096, `expected a slot id past the old ceiling, got ${maxId}`);
|
||||
|
||||
// The regression: with an index ceiling on the arg guard this was a
|
||||
// silent no-op and bypassed stayed false.
|
||||
audio.setBypass(maxId, true);
|
||||
assert.equal(audio.getChainState().find((s) => s.id === maxId)?.bypassed, true,
|
||||
'setBypass on a >4096 slot id must apply, not silently no-op');
|
||||
|
||||
await audio.removeProcessor(maxId);
|
||||
assert.equal(audio.getChainState().find((s) => s.id === maxId), undefined,
|
||||
'removeProcessor on a >4096 slot id must apply');
|
||||
} finally {
|
||||
await audio.clearChain?.();
|
||||
audio.shutdown?.();
|
||||
fs.rmSync(tmp, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user