mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-10-09 16:59:43 +02:00
Merge pull request #397 from irisitymichaelgrundberg/fix/detached-session-owns-its-pane-size
fix(terminal): let a detached session's own window own its pane size
This commit is contained in:
+20
-1
@@ -1332,7 +1332,11 @@ class CodemanApp {
|
|||||||
this._redock(id);
|
this._redock(id);
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Clear all dashboard-side detached state/timers for a session. */
|
/** Clear all dashboard-side detached state/timers for a session, and take its
|
||||||
|
* sizing back: the popup owned the pane while it was open, so the dashboard's
|
||||||
|
* record of it is stale and the session it is showing needs re-measuring.
|
||||||
|
* ⚠️ Not idempotent — each call re-asserts, so a path that redocks twice for
|
||||||
|
* one close sends two SIGWINCHs. */
|
||||||
_redock(id) {
|
_redock(id) {
|
||||||
const t = this._detachWatchTimers.get(id);
|
const t = this._detachWatchTimers.get(id);
|
||||||
if (t) { clearInterval(t); this._detachWatchTimers.delete(id); }
|
if (t) { clearInterval(t); this._detachWatchTimers.delete(id); }
|
||||||
@@ -1340,6 +1344,21 @@ class CodemanApp {
|
|||||||
this._detachOrphanStrikes.delete(id);
|
this._detachOrphanStrikes.delete(id);
|
||||||
this.detachedWindows.delete(id);
|
this.detachedWindows.delete(id);
|
||||||
this._markDetached(id, false);
|
this._markDetached(id, false);
|
||||||
|
// While the popup owned this session the dashboard sent no resizes, so
|
||||||
|
// `_lastResizeDims` — one value for the whole window — no longer describes
|
||||||
|
// the PTY, which the popup has been sizing. Clearing it makes the next
|
||||||
|
// sendResize report truthfully, on every redock path rather than only the
|
||||||
|
// active one: `selectSession` reads that answer to decide whether to wait
|
||||||
|
// for the TUI's redraw, and a false "unchanged" makes it fetch the frame
|
||||||
|
// before the redraw lands.
|
||||||
|
this._lastResizeDims = null;
|
||||||
|
// Sizing comes back with the session. `force` buys a guaranteed repaint for
|
||||||
|
// the case where popup and dashboard happened to agree on a size; the server
|
||||||
|
// already resizes on its own comparison against the real pane whenever the
|
||||||
|
// two differ.
|
||||||
|
if (this.sessions.has(id) && id === this.activeSessionId) {
|
||||||
|
this.sendResize(id, { force: true })?.catch?.(() => {});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Defer a channel-driven redock briefly. A popup *reload* emits 'redocked'
|
/** Defer a channel-driven redock briefly. A popup *reload* emits 'redocked'
|
||||||
|
|||||||
@@ -940,7 +940,10 @@ Object.assign(CodemanApp.prototype, {
|
|||||||
// causes Ink to re-render at the new row count, garbling terminal output.
|
// causes Ink to re-render at the new row count, garbling terminal output.
|
||||||
// Local fit() still runs so xterm knows the viewport size for scrolling.
|
// Local fit() still runs so xterm knows the viewport size for scrolling.
|
||||||
const keyboardUp = typeof KeyboardHandler !== 'undefined' && KeyboardHandler.keyboardVisible;
|
const keyboardUp = typeof KeyboardHandler !== 'undefined' && KeyboardHandler.keyboardVisible;
|
||||||
if (this.activeSessionId && !keyboardUp) {
|
// Same yield as sendResize: never resize a PTY whose session is showing
|
||||||
|
// in its own window. Dragging the dashboard's border must not reshape it.
|
||||||
|
const detachedElsewhere = !this.isSoloWindow && this.detachedSessions?.has(this.activeSessionId);
|
||||||
|
if (this.activeSessionId && !keyboardUp && !detachedElsewhere) {
|
||||||
const dims = this.fitAddon.proposeDimensions();
|
const dims = this.fitAddon.proposeDimensions();
|
||||||
// Enforce minimum dimensions to prevent layout issues
|
// Enforce minimum dimensions to prevent layout issues
|
||||||
const cols = dims ? Math.max(dims.cols, MIN_COLS) : MIN_COLS;
|
const cols = dims ? Math.max(dims.cols, MIN_COLS) : MIN_COLS;
|
||||||
@@ -3848,6 +3851,14 @@ Object.assign(CodemanApp.prototype, {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The pane belongs to the popup showing it, so this window has nothing to
|
||||||
|
// restore. Say so rather than reporting a size that was never sent — the
|
||||||
|
// same button in that window does the job.
|
||||||
|
if (!this.isSoloWindow && this.detachedSessions?.has(this.activeSessionId)) {
|
||||||
|
this.showToast('This session is sized by its own window', 'warning');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
const dims = this.getTerminalDimensions();
|
const dims = this.getTerminalDimensions();
|
||||||
if (!dims) {
|
if (!dims) {
|
||||||
this.showToast('Could not determine terminal size', 'error');
|
this.showToast('Could not determine terminal size', 'error');
|
||||||
@@ -4900,6 +4911,17 @@ Object.assign(CodemanApp.prototype, {
|
|||||||
// Fit terminal to container before reading dimensions — ensures local
|
// Fit terminal to container before reading dimensions — ensures local
|
||||||
// terminal size matches what we report to the server PTY.
|
// terminal size matches what we report to the server PTY.
|
||||||
if (this.fitAddon) this.fitAddon.fit();
|
if (this.fitAddon) this.fitAddon.fit();
|
||||||
|
// One PTY cannot hold two sizes. A detached session is owned by its own
|
||||||
|
// window, and the dashboard's terminal is narrower than that window because
|
||||||
|
// the session rail takes width the popup does not have — so both sizing it
|
||||||
|
// makes the CLI draw frames that fit neither, which garbles the popup. The
|
||||||
|
// dashboard yields; the solo window sizes what it alone displays.
|
||||||
|
// (_maybeRefetchFullHistory already stands aside for the same reason.)
|
||||||
|
// ⚠️ AFTER the fit, never before: the local reflow keeps the dashboard's own
|
||||||
|
// xterm right, and only the SERVER write is the dashboard's to withhold —
|
||||||
|
// the mobile-keyboard guard below draws exactly this line. tab-rail-resize
|
||||||
|
// performs its one settle-time refit through this call and has no fallback.
|
||||||
|
if (!this.isSoloWindow && this.detachedSessions?.has(sessionId)) return false;
|
||||||
const dims = this.getTerminalDimensions();
|
const dims = this.getTerminalDimensions();
|
||||||
if (!dims) return false;
|
if (!dims) return false;
|
||||||
// Did the dimensions actually change since the last resize we sent? Callers
|
// Did the dimensions actually change since the last resize we sent? Callers
|
||||||
|
|||||||
@@ -0,0 +1,184 @@
|
|||||||
|
/**
|
||||||
|
* @fileoverview A detached session's pane is sized by its own window, not by
|
||||||
|
* the dashboard.
|
||||||
|
*
|
||||||
|
* One PTY holds one size. When a session is popped out, the dashboard keeps it
|
||||||
|
* active and keeps measuring it, but the dashboard's terminal is narrower than
|
||||||
|
* the popup because the session rail takes width the popup does not have. Both
|
||||||
|
* windows sizing the same pane makes the CLI draw frames that fit neither, and
|
||||||
|
* the popup shows the result as a garbled frame.
|
||||||
|
*
|
||||||
|
* `sendResize` therefore returns early for a session this window has marked
|
||||||
|
* detached, and the debounced window-resize handler skips it for the same
|
||||||
|
* reason. A solo window is exempt: it IS the owner. `_maybeRefetchFullHistory`
|
||||||
|
* already stood aside on the same condition, so this follows a rule the code
|
||||||
|
* had already established.
|
||||||
|
*
|
||||||
|
* Loaded via `vm` with a stubbed context (no jsdom — jsdom is broken on this
|
||||||
|
* box; see connection-indicator.test.ts), the same way terminal-buffer-flush
|
||||||
|
* extracts the real mixin methods from terminal-ui.js.
|
||||||
|
*/
|
||||||
|
import { readFileSync } from 'node:fs';
|
||||||
|
import { performance } from 'node:perf_hooks';
|
||||||
|
import { resolve } from 'node:path';
|
||||||
|
import vm from 'node:vm';
|
||||||
|
import { describe, expect, it, vi } from 'vitest';
|
||||||
|
|
||||||
|
/** The mixin runs inside the vm context, so its `fetch` must live there too. */
|
||||||
|
let currentFetch: ReturnType<typeof vi.fn> = vi.fn();
|
||||||
|
|
||||||
|
function loadTerminalMixin(): Record<string, unknown> {
|
||||||
|
const source = readFileSync(resolve(import.meta.dirname, '../src/web/public/terminal-ui.js'), 'utf8');
|
||||||
|
const FakeCodemanApp = function () {} as unknown as { prototype: Record<string, unknown> };
|
||||||
|
const context = vm.createContext({
|
||||||
|
console,
|
||||||
|
performance,
|
||||||
|
setTimeout,
|
||||||
|
clearTimeout,
|
||||||
|
setInterval: vi.fn(),
|
||||||
|
clearInterval: vi.fn(),
|
||||||
|
requestAnimationFrame: vi.fn(),
|
||||||
|
CodemanApp: FakeCodemanApp,
|
||||||
|
window: { addEventListener: vi.fn(), removeEventListener: vi.fn(), innerWidth: 1600 },
|
||||||
|
document: { addEventListener: vi.fn() },
|
||||||
|
fetch: (...args: unknown[]) => currentFetch(...args),
|
||||||
|
});
|
||||||
|
vm.runInContext(source, context);
|
||||||
|
return FakeCodemanApp.prototype;
|
||||||
|
}
|
||||||
|
|
||||||
|
const mixin = loadTerminalMixin();
|
||||||
|
|
||||||
|
const SESSION = 'session-A';
|
||||||
|
|
||||||
|
function makeApp(overrides: Record<string, unknown> = {}) {
|
||||||
|
const fetchMock = vi.fn(async () => ({ json: async () => ({ data: { changed: true } }) }));
|
||||||
|
currentFetch = fetchMock;
|
||||||
|
const app = {
|
||||||
|
sendResize: mixin.sendResize,
|
||||||
|
getTerminalDimensions: () => ({ cols: 120, rows: 40 }),
|
||||||
|
fitAddon: { fit: vi.fn() },
|
||||||
|
detachedSessions: new Set<string>(),
|
||||||
|
isSoloWindow: false,
|
||||||
|
_lastResizeDims: null as { cols: number; rows: number } | null,
|
||||||
|
_wsReady: false,
|
||||||
|
_wsSessionId: null as string | null,
|
||||||
|
...overrides,
|
||||||
|
} as Record<string, unknown> & { sendResize: (id: string, o?: object) => Promise<boolean> };
|
||||||
|
return { app, fetchMock };
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('detached sessions own their pane size', () => {
|
||||||
|
it('the dashboard does not resize a session showing in its own window', async () => {
|
||||||
|
const { app, fetchMock } = makeApp();
|
||||||
|
(app.detachedSessions as Set<string>).add(SESSION);
|
||||||
|
const changed = await app.sendResize(SESSION);
|
||||||
|
|
||||||
|
expect(changed).toBe(false);
|
||||||
|
// No request: the popup's size stands on the server.
|
||||||
|
expect(fetchMock).not.toHaveBeenCalled();
|
||||||
|
// The LOCAL fit still runs, so the dashboard's own xterm stays correct and
|
||||||
|
// tab-rail-resize's single settle-time refit is not swallowed. Same line the
|
||||||
|
// mobile-keyboard guard draws: withhold the send, never the reflow.
|
||||||
|
expect((app.fitAddon as { fit: ReturnType<typeof vi.fn> }).fit).toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('the solo window still sizes the session it displays', async () => {
|
||||||
|
const { app, fetchMock } = makeApp({ isSoloWindow: true });
|
||||||
|
(app.detachedSessions as Set<string>).add(SESSION);
|
||||||
|
await app.sendResize(SESSION);
|
||||||
|
|
||||||
|
// The popup is the owner, so being marked detached must not stop it.
|
||||||
|
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||||
|
expect((app.fitAddon as { fit: ReturnType<typeof vi.fn> }).fit).toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('the dashboard resizes a session that is not detached', async () => {
|
||||||
|
const { app, fetchMock } = makeApp();
|
||||||
|
await app.sendResize(SESSION);
|
||||||
|
|
||||||
|
expect(fetchMock).toHaveBeenCalledTimes(1);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `_redock` lives on the CodemanApp class rather than the terminal mixin, so it
|
||||||
|
* needs app.js loaded. Same `vm` approach as terminal-flush-budget.test.ts.
|
||||||
|
*/
|
||||||
|
function loadAppClass() {
|
||||||
|
const dir = resolve(import.meta.dirname, '../src/web/public');
|
||||||
|
const context = vm.createContext({
|
||||||
|
console: { ...console, log: vi.fn(), warn: vi.fn(), error: vi.fn() },
|
||||||
|
performance: { now: () => 0 },
|
||||||
|
setInterval: vi.fn(),
|
||||||
|
clearInterval: vi.fn(),
|
||||||
|
setTimeout,
|
||||||
|
clearTimeout,
|
||||||
|
requestAnimationFrame: vi.fn(),
|
||||||
|
HTMLCanvasElement: class HTMLCanvasElement {},
|
||||||
|
WebSocket: { OPEN: 1 },
|
||||||
|
fetch: vi.fn(),
|
||||||
|
document: { addEventListener: vi.fn(), getElementById: () => null, querySelector: () => null },
|
||||||
|
localStorage: { length: 0, key: vi.fn(), getItem: vi.fn(), setItem: vi.fn(), removeItem: vi.fn() },
|
||||||
|
window: { addEventListener: vi.fn(), removeEventListener: vi.fn() },
|
||||||
|
MobileDetection: { isTouchDevice: () => false },
|
||||||
|
});
|
||||||
|
const constants = readFileSync(resolve(dir, 'constants.js'), 'utf8');
|
||||||
|
const appSource = readFileSync(resolve(dir, 'app.js'), 'utf8');
|
||||||
|
vm.runInContext(`${constants}\n${appSource}\nglobalThis.__CodemanApp = CodemanApp;`, context);
|
||||||
|
return (context as { __CodemanApp: { prototype: Record<string, unknown> } }).__CodemanApp;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('redock takes the sizing back', () => {
|
||||||
|
const CodemanApp = loadAppClass();
|
||||||
|
|
||||||
|
function makeDashboard(activeSessionId: string | null) {
|
||||||
|
const app = Object.create(CodemanApp.prototype) as Record<string, any>;
|
||||||
|
app.detachedSessions = new Set([SESSION]);
|
||||||
|
app.detachedWindows = new Map();
|
||||||
|
app._detachWatchTimers = new Map();
|
||||||
|
app._redockGrace = new Map();
|
||||||
|
app._detachOrphanStrikes = new Map();
|
||||||
|
app.sessions = new Map([[SESSION, { id: SESSION }]]);
|
||||||
|
app.activeSessionId = activeSessionId;
|
||||||
|
app._lastResizeDims = { cols: 120, rows: 40 };
|
||||||
|
app.$ = () => null;
|
||||||
|
app.sendResize = vi.fn(() => Promise.resolve(true));
|
||||||
|
return app;
|
||||||
|
}
|
||||||
|
|
||||||
|
it('clears the stale dimensions so the next send reports truthfully', () => {
|
||||||
|
// The popup sized the pane while it owned the session, so this window's one
|
||||||
|
// global record of "what the PTY holds" is wrong. Left in place, the next
|
||||||
|
// sendResize returns "unchanged" and selectSession skips its redraw wait.
|
||||||
|
const app = makeDashboard(SESSION);
|
||||||
|
app._redock(SESSION);
|
||||||
|
expect(app._lastResizeDims).toBeNull();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('clears them even when the redocked session is not the active one', () => {
|
||||||
|
// Pop out A, switch to B, close the popup: no resize is due, but the stale
|
||||||
|
// record still has to go or selecting A later lies about it.
|
||||||
|
const app = makeDashboard('some-other-session');
|
||||||
|
app._redock(SESSION);
|
||||||
|
expect(app._lastResizeDims).toBeNull();
|
||||||
|
expect(app.sendResize).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('re-asserts this window size for the session it is showing', () => {
|
||||||
|
const app = makeDashboard(SESSION);
|
||||||
|
app._redock(SESSION);
|
||||||
|
expect(app.sendResize).toHaveBeenCalledWith(SESSION, { force: true });
|
||||||
|
// Un-marked first, or the yield in sendResize would swallow the re-assert.
|
||||||
|
expect(app.detachedSessions.has(SESSION)).toBe(false);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('sends nothing for a session that is gone', () => {
|
||||||
|
// _onSessionDeleted redocks before cleanup, so the id can already be dead;
|
||||||
|
// the resize would be a guaranteed 404.
|
||||||
|
const app = makeDashboard(SESSION);
|
||||||
|
app.sessions.delete(SESSION);
|
||||||
|
app._redock(SESSION);
|
||||||
|
expect(app.sendResize).not.toHaveBeenCalled();
|
||||||
|
});
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user