Files
Codeman/test/tab-layout-browser.test.ts
T
Aamer Akhter 7cbce5bf6c feat(tabs): grouped vertical rail from owner tab layouts
The vertical tab rail now reads the owner's tab layout (GET /api/tab-layout)
and draws its groups as collapsible sections. This is the first frontend
consumer of the tab-layout backend and it is read-only: nothing in the
browser writes the layout yet.

- tab-layout-browser.js (new, pure, loaded before app.js): projects the
  layout onto the live sessions and open web tabs, renders the grouped
  markup, stores collapse per device, and sequences loads newest-wins with
  a bounded retry on failure.
- app.js: loads the layout on init and on tab:layoutChanged, renders the
  grouped rail from the same per-row markup the flat rail uses, falls
  through to a full render whenever the grouping structure changes, and
  withholds drag-reorder in the grouped rail.
- Grouping is opt-in by construction. With no layout, a failed read, a
  layout without groups, or a horizontal strip, the rail renders exactly
  as before (byte-identical markup).
- Grouping is a render layer only: sessionOrder, Alt+N, Ctrl+Tab and the
  palette keep reading the server-projected order, and row badges keep
  their Alt+N slot.
- A collapsed group still shows the active row; lineage arcs to a hidden
  session anchor to its group header.
- webview-tabs.js: renderWebviewTab() extracted so a single web tab can be
  placed into its group with unchanged markup.
2026-10-01 14:14:30 -04:00

297 lines
12 KiB
TypeScript

/**
* @fileoverview Browser projection of the owner tab layout (tab-layout-browser.js).
*
* Pins the pure half of the grouped vertical rail: which live rows land in which
* group, what a collapsed group hides (and the one row it must keep showing),
* the per-device collapse storage, the grouped markup, and newest-wins loading.
*
* Port: none (vm-loaded module + static wiring assertions).
*/
import { readFileSync } from 'node:fs';
import vm from 'node:vm';
import { JSDOM } from 'jsdom';
import { describe, expect, it, vi } from 'vitest';
const SOURCE = readFileSync(new URL('../src/web/public/tab-layout-browser.js', import.meta.url), 'utf8');
const APP_SOURCE = readFileSync(new URL('../src/web/public/app.js', import.meta.url), 'utf8');
const INDEX_SOURCE = readFileSync(new URL('../src/web/public/index.html', import.meta.url), 'utf8');
const BUILD_SOURCE = readFileSync(new URL('../scripts/build.mjs', import.meta.url), 'utf8');
type Ref = { kind: 'session' | 'webview'; id: string };
function loadHelper() {
const context = vm.createContext({ window: {}, globalThis: {} });
vm.runInContext(SOURCE, context, { filename: 'tab-layout-browser.js' });
return (context.window as any).CodemanTabLayout;
}
const escape = (value: string) =>
value.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
const layout = (version = 4) => ({
version,
updatedAt: '2026-08-16T00:00:00.000Z',
groups: [
{
id: 'g1',
name: '<Core & Ops>',
refs: [
{ kind: 'session', id: 's2' },
{ kind: 'webview', id: 'w1' },
{ kind: 'session', id: 's1' },
{ kind: 'webview', id: 'saved-closed' },
{ kind: 'session', id: 'gone' },
],
},
{ id: 'g2', name: 'Later', refs: [{ kind: 'session', id: 's3' }] },
],
ungrouped: [
{ kind: 'webview', id: 'w2' },
{ kind: 'session', id: 's4' },
{ kind: 'session', id: 's2' },
],
});
const ids = (refs: Ref[]) => refs.map((ref) => `${ref.kind}:${ref.id}`);
describe('projection', () => {
it('returns null for a layout without groups, so the caller keeps the flat rail', () => {
const h = loadHelper();
expect(h.project({ version: 1, groups: [], ungrouped: [{ kind: 'session', id: 's1' }] }, {})).toBeNull();
expect(h.project(null, {})).toBeNull();
expect(h.hasGroups(h.normalizeLayout({ version: 1 }))).toBe(false);
});
it('places stored refs in their groups, skips gone/unopened refs, and deduplicates', () => {
const h = loadHelper();
const result = h.project(layout(), {
liveSessionIds: ['s1', 's2', 's3', 's4'],
openWebviewIds: ['w1', 'w2'],
});
expect(result.sections.map((s: any) => [s.id, ids(s.refs), s.count])).toEqual([
['g1', ['session:s2', 'webview:w1', 'session:s1'], 3],
['g2', ['session:s3'], 1],
[null, ['webview:w2', 'session:s4'], 2],
]);
expect(new Set(ids(result.visibleRefs)).size).toBe(result.visibleRefs.length);
});
it('appends live sessions and open web tabs the layout has not placed, in caller order', () => {
const h = loadHelper();
const result = h.project(layout(), {
liveSessionIds: ['new-b', 's1', 'new-a'],
openWebviewIds: ['w-local'],
});
expect(ids(result.sections.at(-1).refs)).toEqual(['session:new-b', 'session:new-a', 'webview:w-local']);
});
it('omits an empty ungrouped section', () => {
const h = loadHelper();
const result = h.project(layout(), { liveSessionIds: ['s1', 's3'], openWebviewIds: [] });
expect(result.sections.map((s: any) => s.id)).toEqual(['g1', 'g2']);
});
it('hides a collapsed group but keeps its highlighted row, and records where hidden rows went', () => {
const h = loadHelper();
const common = {
liveSessionIds: ['s1', 's2', 's3', 's4'],
openWebviewIds: ['w1', 'w2'],
collapsedGroupIds: ['g1'],
};
const collapsed = h.project(layout(), { ...common, activeSessionId: 's1' });
expect(ids(collapsed.sections[0].refs)).toEqual(['session:s1']);
expect(collapsed.sections[0].count).toBe(3);
expect(collapsed.sections[0].collapsed).toBe(true);
expect(collapsed.hiddenTabGroupByRef).toEqual({ 'session:s2': 'g1', 'webview:w1': 'g1' });
// An active web tab owns the highlight even while a session stays selected.
const web = h.project(layout(), { ...common, activeSessionId: 's1', activeWebviewId: 'w1' });
expect(ids(web.sections[0].refs)).toEqual(['webview:w1']);
});
});
describe('structure key', () => {
it('changes with every structural input and ignores everything else', () => {
const h = loadHelper();
const opts = { liveSessionIds: ['s1', 's2', 's3'], openWebviewIds: [] };
const base = h.structureKey(layout(), h.project(layout(), opts), []);
expect(h.structureKey(layout(), h.project(layout(), opts), [])).toBe(base);
expect(h.structureKey(layout(5), h.project(layout(5), opts), [])).not.toBe(base);
expect(h.structureKey(layout(), h.project(layout(), { ...opts, collapsedGroupIds: ['g1'] }), ['g1'])).not.toBe(
base
);
expect(h.structureKey(layout(), h.project(layout(), { ...opts, liveSessionIds: ['s1', 's2'] }), [])).not.toBe(base);
expect(h.structureKey(layout(), null, [])).toBeNull();
});
});
describe('per-device collapse storage', () => {
function storage(initial: string | null = null) {
const values = new Map<string, string>();
if (initial !== null) values.set('codeman:tab-groups-collapsed', initial);
return {
getItem: vi.fn((key: string) => values.get(key) ?? null),
setItem: vi.fn((key: string, next: string) => {
values.set(key, next);
}),
};
}
it('round-trips collapsed group ids', () => {
const h = loadHelper();
const local = storage();
expect(h.saveCollapsedGroupIds(local, ['g2', 'g1', 'g2'])).toEqual({ ids: ['g2', 'g1'], ok: true });
expect(h.loadCollapsedGroupIds(local, ['g1', 'g2'])).toEqual({ ids: ['g2', 'g1'], ok: true });
});
it('garbage-collects ids of groups that no longer exist', () => {
const h = loadHelper();
const local = storage('["gone","g1"]');
expect(h.loadCollapsedGroupIds(local, ['g1', 'g2'])).toEqual({ ids: ['g1'], ok: true });
expect(local.setItem).toHaveBeenLastCalledWith('codeman:tab-groups-collapsed', '["g1"]');
});
it('reports failure (all-expanded) on unreadable, malformed or unwritable storage', () => {
const h = loadHelper();
const throwing = {
getItem: () => {
throw new Error('denied');
},
setItem: () => {
throw new Error('quota');
},
};
expect(h.loadCollapsedGroupIds(throwing, ['g1'])).toEqual({ ids: [], ok: false });
expect(h.loadCollapsedGroupIds(storage('{"g1":true}'), ['g1'])).toEqual({ ids: [], ok: false });
expect(h.saveCollapsedGroupIds(throwing, ['g1'])).toEqual({ ids: [], ok: false });
});
});
describe('grouped markup', () => {
it('renders escaped group sections with real toggle buttons around caller-rendered rows', () => {
const h = loadHelper();
const projection = h.project(layout(), {
liveSessionIds: ['s1', 's2', 's3', 's4'],
openWebviewIds: ['w1', 'w2'],
collapsedGroupIds: ['g2'],
});
const html = h.renderProjection(
projection,
(ref: Ref) => `<div class="row" data-ref="${ref.kind}:${ref.id}"></div>`,
escape
);
const doc = new JSDOM(`<main>${html}</main>`).window.document;
expect([...doc.querySelectorAll('.tab-layout-group-name')].map((el) => el.textContent)).toEqual([
'<Core & Ops>',
'Later',
'Ungrouped',
]);
expect(doc.querySelectorAll('.tab-layout-group-name *')).toHaveLength(0);
expect(doc.querySelector('.tab-layout-group-name')?.hasAttribute('data-i18n-skip')).toBe(true);
const g1 = doc.querySelector<HTMLElement>('[data-tab-group-header="g1"]')!;
const g2 = doc.querySelector<HTMLElement>('[data-tab-group-header="g2"]')!;
expect(g1.tagName).toBe('BUTTON');
expect(g1.getAttribute('aria-expanded')).toBe('true');
expect(g2.getAttribute('aria-expanded')).toBe('false');
expect(doc.getElementById(g1.getAttribute('aria-controls')!)?.querySelectorAll('.row')).toHaveLength(3);
// The ungrouped header is a label, not a control: there is nothing to collapse.
expect(doc.querySelector('.tab-layout-ungrouped-header')?.tagName).toBe('DIV');
expect([...doc.querySelectorAll<HTMLElement>('.row')].map((el) => el.dataset.ref)).toEqual(
ids(projection.visibleRefs)
);
});
});
describe('load coordination', () => {
it('applies only the newest response when loads overlap', async () => {
const h = loadHelper();
const pending: Array<(value: unknown) => void> = [];
const applied: number[] = [];
const coordinator = h.createLoadCoordinator({
fetchLayout: () => new Promise((resolve) => pending.push(resolve)),
applyLayout: (value: any) => applied.push(value.version),
applyFallback: vi.fn(),
scheduleRetry: vi.fn(),
});
const first = coordinator.load();
const second = coordinator.load();
pending[1](layout(2));
await second;
pending[0](layout(1));
await first;
expect(applied).toEqual([2]);
});
it('falls back on failure, schedules one retry, and lets a successful retry replace the fallback', async () => {
const h = loadHelper();
const applyLayout = vi.fn();
const applyFallback = vi.fn();
let retry: (() => Promise<boolean>) | undefined;
let attempt = 0;
const coordinator = h.createLoadCoordinator({
fetchLayout: async () => {
attempt++;
if (attempt === 1) throw new Error('offline');
return layout(7);
},
applyLayout,
applyFallback,
scheduleRetry: (fn: () => Promise<boolean>) => {
retry = fn;
return 42;
},
cancelRetry: vi.fn(),
});
await coordinator.load();
expect(applyFallback).toHaveBeenCalledTimes(1);
expect(applyLayout).not.toHaveBeenCalled();
await retry!();
expect(applyLayout).toHaveBeenCalledWith(layout(7));
});
it('cancels a pending retry and ignores in-flight results after dispose', async () => {
const h = loadHelper();
let resolve!: (value: unknown) => void;
const applyLayout = vi.fn();
const cancelRetry = vi.fn();
let calls = 0;
const coordinator = h.createLoadCoordinator({
fetchLayout: () => {
calls++;
if (calls === 1) return Promise.reject(new Error('offline'));
return new Promise((r) => (resolve = r));
},
applyLayout,
applyFallback: vi.fn(),
scheduleRetry: () => 7,
cancelRetry,
});
await coordinator.load();
const second = coordinator.load();
expect(cancelRetry).toHaveBeenCalledWith(7);
coordinator.dispose();
resolve(layout(3));
await second;
expect(applyLayout).not.toHaveBeenCalled();
});
});
describe('browser wiring', () => {
it('loads the helper before app.js, ships it through the build, and wires GET + SSE', () => {
expect(INDEX_SOURCE.indexOf('<script defer src="tab-layout-browser.js"')).toBeGreaterThan(-1);
expect(INDEX_SOURCE.indexOf('<script defer src="tab-layout-browser.js"')).toBeLessThan(
INDEX_SOURCE.indexOf('<script defer src="app.js"')
);
expect(BUILD_SOURCE).toContain("'tab-layout-browser.js'");
expect(APP_SOURCE).toContain("this._apiJson('/api/tab-layout')");
expect(APP_SOURCE).toContain("[SSE_EVENTS.TAB_LAYOUT_CHANGED, '_onTabLayoutChanged']");
});
it('never writes the layout from the browser in this slice', () => {
expect(APP_SOURCE).not.toMatch(/['"`]PUT['"`][^\n]*tab-layout|tab-layout[^\n]*['"`]PUT['"`]/);
expect(SOURCE).not.toContain('fetch(');
});
});