Fix region capture, power ownership, click-source reporting, strict timing
Template tests / tests (pull_request) Failing after 33s
Template tests / tests (pull_request) Failing after 33s
Phase 2 of the improvement plan (PR 5 of the sequence). Several confirmed
capture defects from the audit.
Region capture:
- regionCapture returned { ok, step } wrapping storeFrameAsStep's own
{ ok, step }, so the real step was at result.step.step — region selection
and region auto-doc (which read result.step.stepId) broke. Return the
storeFrameAsStep result directly.
- pickRegion leaked the region:picked IPC listener (and the overlay/image
refs) whenever the overlay was cancelled/closed rather than picked: cleanup
only ran on a pick. Cleanup is now idempotent and runs on pick, close, load
failure, and settle. The received rectangle is validated and clamped to the
image (new overlayRectToImageRect handles negative-size drags and
out-of-bounds selections) so image.crop can never read out of bounds.
Power blocker ownership:
- New single owner: CaptureService.syncPower() holds the blocker iff a session
is actively recording, called on start/pause/resume/finish. A new session
starts paused and no longer holds the blocker while idle; tray and
second-instance pauses that previously bypassed main.js's stop closure now
release it correctly. main.js provides the power policy (blocker + EcoQoS
opt-out) via dependency injection.
Explicit click-trigger source:
- startEvdevWatcher never set clickWatcher, so state().clickCapture read false
while evdev was actively capturing clicks. Replaced the boolean with an
explicit clickSource (windows-hook | x11 | evdev-x11 | evdev-wayland |
unavailable); clickCapture is now derived from it. evdev device-stream
errors/closes now fall back via handleClickWatcherLoss instead of being
swallowed.
Strict click timing:
- When no pre-click frame qualifies, strict mode previously fell through to a
fresh (post-click) shot and stored it — contradicting the strict promise.
It now skips with a capture:diagnostic instead. Non-strict (balanced) mode
keeps the fresh-shot fallback. Existing tests that exercised the fallback
now run in balanced mode; the strict test asserts the skip.
Other:
- pathToFileURL replaces file://${p} concatenation for step image URLs and
export previews (correct for spaces, #, %, drive letters).
- Best-effort click-queue drain on app shutdown (before-quit) so a burst just
before quit is not lost; bounded so quit never hangs.
Tests: region rect clamping/normalization, power-held-only-while-recording
(incl. finish releases), click-source reporting incl. evdev, drain deadline.
230 unit tests pass. Click self-test: markers 3/3 (strict) and burst 8/8
deterministic across runs; the burst scenario runs in balanced mode because
it tests the drain, not strict timing. (arm/debounce remain the pre-existing
Linux capture failures untouched by this PR.)
Co-Authored-By: Claude Fable 5 <[email protected]>
This commit is contained in:
@@ -0,0 +1,120 @@
|
||||
'use strict';
|
||||
|
||||
const test = require('node:test');
|
||||
const assert = require('node:assert/strict');
|
||||
|
||||
const CaptureService = require('../../app/capture');
|
||||
|
||||
function makeService({ settings: settingsOverrides, powerPolicy } = {}) {
|
||||
const settingsData = {
|
||||
'capture.mode': 'fullscreen',
|
||||
'capture.delayMs': 0,
|
||||
...settingsOverrides,
|
||||
};
|
||||
return new CaptureService({
|
||||
store: {},
|
||||
settings: { get: (k) => (k in settingsData ? settingsData[k] : null) },
|
||||
getWindow: () => null,
|
||||
notify: () => {},
|
||||
powerPolicy,
|
||||
screenApi: {
|
||||
getCursorScreenPoint: () => ({ x: 0, y: 0 }),
|
||||
getAllDisplays: () => [],
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
// ---- region rect clamping (bug: out-of-bounds / negative drags) -------------
|
||||
|
||||
test('overlayRectToImageRect scales, clamps, and normalizes selections', () => {
|
||||
const svc = makeService();
|
||||
const display = { bounds: { x: 0, y: 0, width: 100, height: 100 } };
|
||||
const imgSize = { width: 200, height: 200 }; // 2x DPI
|
||||
|
||||
// Simple selection: display px -> image px (2x).
|
||||
assert.deepEqual(
|
||||
svc.overlayRectToImageRect({ x: 10, y: 20, w: 30, h: 40 }, display, imgSize),
|
||||
{ x: 20, y: 40, width: 60, height: 80 }
|
||||
);
|
||||
|
||||
// Negative-size drag (drawn up/left) normalizes to a positive rect.
|
||||
assert.deepEqual(
|
||||
svc.overlayRectToImageRect({ x: 40, y: 40, w: -20, h: -20 }, display, imgSize),
|
||||
{ x: 40, y: 40, width: 40, height: 40 }
|
||||
);
|
||||
|
||||
// Selection larger than the screen is clamped to the image bounds.
|
||||
const clamped = svc.overlayRectToImageRect({ x: -10, y: -10, w: 200, h: 200 }, display, imgSize);
|
||||
assert.deepEqual(clamped, { x: 0, y: 0, width: 200, height: 200 });
|
||||
|
||||
// Degenerate selections return null instead of an out-of-bounds crop.
|
||||
assert.equal(svc.overlayRectToImageRect({ x: 0, y: 0, w: 0, h: 0 }, display, imgSize), null);
|
||||
assert.equal(svc.overlayRectToImageRect({ x: 999, y: 999, w: 10, h: 10 }, display, imgSize), null);
|
||||
assert.equal(svc.overlayRectToImageRect(null, display, imgSize), null);
|
||||
});
|
||||
|
||||
// ---- power ownership follows recording state --------------------------------
|
||||
|
||||
test('the power blocker is held only while actively recording', () => {
|
||||
const calls = [];
|
||||
const powerPolicy = { setRecording: (on) => calls.push(on) };
|
||||
const svc = makeService({ powerPolicy });
|
||||
|
||||
// startSession begins PAUSED — must not hold power.
|
||||
svc.startSession('g1', { intervalSec: 0 });
|
||||
assert.deepEqual(calls, [], 'a paused new session must not start the power blocker');
|
||||
|
||||
// Resume records -> power on. (togglePause(false) arms recording.)
|
||||
svc.togglePause(false);
|
||||
assert.deepEqual(calls, [true]);
|
||||
|
||||
// Pause -> power off. This is the tray/second-instance path that used to leak.
|
||||
svc.togglePause(true);
|
||||
assert.deepEqual(calls, [true, false]);
|
||||
|
||||
// Resume again -> on, finish -> off.
|
||||
svc.togglePause(false);
|
||||
svc.finishSession();
|
||||
assert.deepEqual(calls, [true, false, true, false]);
|
||||
});
|
||||
|
||||
test('finishSession releases power even if it was recording', () => {
|
||||
const calls = [];
|
||||
const svc = makeService({ powerPolicy: { setRecording: (on) => calls.push(on) } });
|
||||
svc.startSession('g1', { intervalSec: 0 });
|
||||
svc.togglePause(false);
|
||||
calls.length = 0;
|
||||
svc.finishSession();
|
||||
assert.deepEqual(calls, [false]);
|
||||
});
|
||||
|
||||
// ---- explicit click-source reporting ----------------------------------------
|
||||
|
||||
test('click source is unavailable outside a session and after stop', () => {
|
||||
const svc = makeService();
|
||||
assert.equal(svc.state().clickSource, 'unavailable');
|
||||
assert.equal(svc.state().clickCapture, undefined); // no session -> no field
|
||||
svc.clickSource = 'evdev-x11';
|
||||
svc.stopClickWatcher();
|
||||
assert.equal(svc.clickSource, 'unavailable');
|
||||
});
|
||||
|
||||
test('state reports clickCapture true for a non-process (evdev) source', () => {
|
||||
const svc = makeService();
|
||||
svc.session = { guideId: 'g', paused: false, count: 0, intervalSec: 0 };
|
||||
// evdev has no child process; the old Boolean(clickWatcher) reported false.
|
||||
svc.clickSource = 'evdev-wayland';
|
||||
const st = svc.state();
|
||||
assert.equal(st.clickCapture, true);
|
||||
assert.equal(st.clickSource, 'evdev-wayland');
|
||||
});
|
||||
|
||||
// ---- drain never hangs quit -------------------------------------------------
|
||||
|
||||
test('drainPendingClicks resolves within the deadline even if the queue hangs', async () => {
|
||||
const svc = makeService();
|
||||
svc.clickQueue = new Promise(() => {}); // never settles
|
||||
const start = Date.now();
|
||||
await svc.drainPendingClicks(60);
|
||||
assert.ok(Date.now() - start < 1000, 'drain must not block on a hung queue');
|
||||
});
|
||||
+26
-11
@@ -68,7 +68,9 @@ function makeFrame(name, ageMs = 0, overrides = {}) {
|
||||
// ---- fresh-shot fallback path ----------------------------------------------
|
||||
|
||||
test('click-triggered session capture uses the low-latency hide pause', async () => {
|
||||
const service = makeService();
|
||||
// The fresh-shot fallback only runs in non-strict (balanced) mode; strict
|
||||
// mode skips rather than storing a post-click shot.
|
||||
const service = makeService({ settings: { 'capture.strictClickFrames': false } });
|
||||
service.session = { guideId: 'guide-1', paused: false, count: 0, intervalSec: 0 };
|
||||
|
||||
let seenOptions = null;
|
||||
@@ -1006,7 +1008,9 @@ test('a buffered frame from a different display is ignored for click capture', a
|
||||
});
|
||||
|
||||
test('a stale buffered frame is not reused — the click falls back to a fresh shot', async () => {
|
||||
const service = makeService();
|
||||
// Balanced (non-strict) mode: a stale frame is rejected and the click takes
|
||||
// the fresh-shot fallback. (Strict mode skips instead — see below.)
|
||||
const service = makeService({ settings: { 'capture.strictClickFrames': false } });
|
||||
service.session = { guideId: 'guide-stale', paused: false, count: 0, intervalSec: 0 };
|
||||
service.latestFrame = makeFrame('stale-png', 10_000);
|
||||
|
||||
@@ -1022,12 +1026,12 @@ test('a stale buffered frame is not reused — the click falls back to a fresh s
|
||||
assert.equal(shootCalled, true, 'a stale buffered frame must not be reused');
|
||||
});
|
||||
|
||||
test('strict mode: a frame whose grab started after the click is rejected', async () => {
|
||||
// This replaces the old "idle click waits for the imminent loop frame"
|
||||
// behavior: a grab that begins after the click can already show the
|
||||
// click's effects, so strict mode takes the explicit fresh-shot fallback
|
||||
// instead of passing it off as the click-time screen.
|
||||
const service = makeService();
|
||||
test('strict mode: no pre-click frame is skipped, never stored as a post-click shot', async () => {
|
||||
// A grab that begins after the click can already show the click's effects.
|
||||
// Strict mode's promise is that a stored step never shows the post-click
|
||||
// screen, so when no pre-click frame qualifies it SKIPS with a diagnostic
|
||||
// rather than taking a fresh (post-click) shot.
|
||||
const service = makeService(); // strict is the default
|
||||
service.session = { guideId: 'guide-strict', paused: false, count: 0, intervalSec: 0 };
|
||||
service.frameLoopRunning = true;
|
||||
service.frameLoopInFlight = false; // nothing in flight at click time
|
||||
@@ -1041,11 +1045,18 @@ test('strict mode: a frame whose grab started after the click is rejected', asyn
|
||||
shootCalled = true;
|
||||
return { ok: true, step: { stepId: 'fresh-step' } };
|
||||
};
|
||||
const diagnostics = [];
|
||||
service.notify = (channel, payload) => {
|
||||
if (channel === 'capture:diagnostic') diagnostics.push(payload);
|
||||
};
|
||||
|
||||
const result = await service.sessionCapture('click', { x: 1, y: 1 }, { at: clickAt });
|
||||
|
||||
assert.equal(result.ok, true);
|
||||
assert.equal(shootCalled, true);
|
||||
assert.equal(result.ok, false);
|
||||
assert.match(result.reason, /strict/i);
|
||||
assert.equal(shootCalled, false, 'strict mode must not store a post-click shot');
|
||||
assert.equal(diagnostics.length, 1);
|
||||
assert.equal(diagnostics[0].kind, 'strict-click-skipped');
|
||||
});
|
||||
|
||||
test('balanced mode keeps the legacy slack: an imminent post-click frame is accepted', async () => {
|
||||
@@ -1183,7 +1194,9 @@ test('click frames come from the stream backend when it is active', async () =>
|
||||
});
|
||||
|
||||
test('a stream backend with no qualifying frame falls through to the fresh-shot path', async () => {
|
||||
const service = makeService();
|
||||
// Balanced (non-strict) mode: the fresh-shot fallback runs. Strict mode
|
||||
// would skip rather than store a post-click shot.
|
||||
const service = makeService({ settings: { 'capture.strictClickFrames': false } });
|
||||
service.session = { guideId: 'guide-stream-miss', paused: false, count: 0, intervalSec: 0 };
|
||||
service.streamBackend = {
|
||||
isActive: () => true,
|
||||
@@ -1279,6 +1292,8 @@ test('click capture marks the click-time cursor position', async () => {
|
||||
if (key === 'capture.clickMarker') return true;
|
||||
if (key === 'capture.clickMarkerColor') return '#E5484D';
|
||||
if (key === 'editor.focusedViewDefaultForNewSteps') return false;
|
||||
// Exercise the fresh-shot fallback: strict mode would skip instead.
|
||||
if (key === 'capture.strictClickFrames') return false;
|
||||
return null;
|
||||
};
|
||||
service.session = { guideId: 'guide-4', paused: false, count: 0, intervalSec: 0 };
|
||||
|
||||
Reference in New Issue
Block a user