feat(maestro): port the sidebar to React
Ports catalog.ts's tree renderer to components under src/components/sidebar/, following docs/SIDEBAR.md: two-line cards behind a 5px activity rail, adaptive meta line (duration, detail, program, diff stat), collapsible folders, j/k walk, inline rename and a right-click menu. The nav walk reads a pure model (model.ts) rather than the DOM, so the rule that an expanded folder header is skipped and a collapsed one is not is testable without a render. Rail motion needs @keyframes, so it stays in sidebar.css rather than the Tailwind config. Closes #244
This commit is contained in:
@@ -0,0 +1,368 @@
|
||||
// React port of the sidebar tree (catalog.ts). The contract it renders is
|
||||
// docs/SIDEBAR.md: two-line cards behind an activity rail, folder-grouped by
|
||||
// repository, walked with j/k.
|
||||
|
||||
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
|
||||
import { useStore } from "zustand";
|
||||
|
||||
import { ApiRequestError, killSession, renameSession } from "../../api.js";
|
||||
import type { CatalogStoreApi } from "../../stores/catalogStore.js";
|
||||
import type { InTheWay, Session } from "../../types.js";
|
||||
import { sessionBlockers, sessionName } from "../../types.js";
|
||||
import { buildTree, type TreeNode } from "../../tree.js";
|
||||
import { ContextMenu, type ContextMenuItem } from "./ContextMenu.js";
|
||||
import { FolderNode } from "./FolderNode.js";
|
||||
import { KillConfirm } from "./KillConfirm.js";
|
||||
import { SessionCard } from "./SessionCard.js";
|
||||
import { SidebarSearch } from "./SidebarSearch.js";
|
||||
import { filterSessions, firstRowUnder, navRows, sessionKey } from "./model.js";
|
||||
import { useNow } from "./useNow.js";
|
||||
import "./sidebar.css";
|
||||
|
||||
export interface SidebarProps {
|
||||
/** Live catalog. Either this or `sessions` supplies the tree. */
|
||||
store?: CatalogStoreApi;
|
||||
/** Static session list — what tests and the design kit render from. */
|
||||
sessions?: Session[];
|
||||
/** The daemon's home dir, so cwds abbreviate to `~/…`. */
|
||||
homeDir?: string;
|
||||
/** Showing in the focused pane. */
|
||||
activeId?: string | null;
|
||||
/** Open in some pane, focused one included. */
|
||||
openIds?: ReadonlySet<string>;
|
||||
/** Previewing (docs/PREVIEW.md) — a view, never durable state. */
|
||||
previewId?: string | null;
|
||||
onSelect?(id: string): void;
|
||||
/** The highlight moved onto a session, or off every session. */
|
||||
onPreview?(id: string | null): void;
|
||||
onSpawnSimilar?(session: Session): void;
|
||||
onSpawn?(): void;
|
||||
/** Fast-forward spawn (`N`). */
|
||||
onSpawnDefaults?(): void;
|
||||
/** Tab: hand the keyboard back to the pane. */
|
||||
onFocusPane?(): void;
|
||||
onHelp?(): void;
|
||||
/** Overrides the built-in `DELETE /api/sessions/:id` flow (tests, kit). */
|
||||
onKill?(session: Session): void;
|
||||
/** Overrides the built-in `PATCH /api/sessions/:id` (tests, kit). */
|
||||
onRename?(id: string, name: string): void;
|
||||
}
|
||||
|
||||
interface MenuState {
|
||||
x: number;
|
||||
y: number;
|
||||
session: Session;
|
||||
}
|
||||
|
||||
interface KillState {
|
||||
session: Session;
|
||||
blockers: InTheWay | null;
|
||||
force: boolean;
|
||||
}
|
||||
|
||||
export function Sidebar(props: SidebarProps) {
|
||||
const sessions = useSessions(props);
|
||||
const now = useNow();
|
||||
|
||||
const [query, setQuery] = useState("");
|
||||
const [collapsed, setCollapsed] = useState<ReadonlySet<string>>(() => new Set<string>());
|
||||
const [navKey, setNavKey] = useState<string | null>(null);
|
||||
const [renamingId, setRenamingId] = useState<string | null>(null);
|
||||
const [menu, setMenu] = useState<MenuState | null>(null);
|
||||
const [kill, setKill] = useState<KillState | null>(null);
|
||||
const treeRef = useRef<HTMLDivElement>(null);
|
||||
|
||||
const tree = useMemo(
|
||||
() => buildTree(filterSessions(sessions, query), props.homeDir),
|
||||
[sessions, query, props.homeDir],
|
||||
);
|
||||
const rows = useMemo(() => navRows(tree, collapsed), [tree, collapsed]);
|
||||
|
||||
// A row that went away — session killed, folder collapsed over it — drops
|
||||
// the highlight rather than leaving it pointing at nothing.
|
||||
useEffect(() => {
|
||||
if (navKey !== null && !rows.some((r) => r.key === navKey)) setNavKey(null);
|
||||
}, [rows, navKey]);
|
||||
|
||||
const preview = props.onPreview;
|
||||
const previewOf = useCallback(
|
||||
(key: string | null) => {
|
||||
preview?.(key?.startsWith("session:") ? key.slice("session:".length) : null);
|
||||
},
|
||||
[preview],
|
||||
);
|
||||
|
||||
const moveNav = useCallback(
|
||||
(delta: number) => {
|
||||
if (rows.length === 0) return;
|
||||
const cur = rows.findIndex((r) => r.key === navKey);
|
||||
// Nothing highlighted: start one off the end being walked from, so the
|
||||
// first step lands on the first (or last) row.
|
||||
const from = cur === -1 ? (delta > 0 ? -1 : 0) : cur;
|
||||
const next = rows[(((from + delta) % rows.length) + rows.length) % rows.length];
|
||||
setNavKey(next.key);
|
||||
previewOf(next.key);
|
||||
},
|
||||
[rows, navKey, previewOf],
|
||||
);
|
||||
|
||||
const toggleFolder = useCallback((path: string) => {
|
||||
setCollapsed((prev) => {
|
||||
const next = new Set(prev);
|
||||
if (next.has(path)) next.delete(path);
|
||||
else next.add(path);
|
||||
return next;
|
||||
});
|
||||
}, []);
|
||||
|
||||
/** Enter: open the highlighted session, or expand the highlighted folder and
|
||||
* land on the first row it was hiding. */
|
||||
const activateNav = useCallback(() => {
|
||||
const row = rows.find((r) => r.key === navKey);
|
||||
if (!row) return;
|
||||
if (row.kind === "session") {
|
||||
props.onSelect?.(row.id);
|
||||
return;
|
||||
}
|
||||
const expanded = new Set(collapsed);
|
||||
expanded.delete(row.path);
|
||||
setCollapsed(expanded);
|
||||
const revealed = firstRowUnder(tree, expanded, row.path);
|
||||
setNavKey(revealed?.key ?? null);
|
||||
}, [rows, navKey, collapsed, tree, props]);
|
||||
|
||||
const beginKill = useCallback(
|
||||
(s: Session) => {
|
||||
if (props.onKill) {
|
||||
props.onKill(s);
|
||||
return;
|
||||
}
|
||||
setKill({ session: s, blockers: sessionBlockers(s), force: false });
|
||||
},
|
||||
[props],
|
||||
);
|
||||
|
||||
const commitRename = useCallback(
|
||||
(id: string, name: string) => {
|
||||
setRenamingId(null);
|
||||
if (props.onRename) props.onRename(id, name);
|
||||
else void renameSession(id, name).catch(() => {});
|
||||
},
|
||||
[props],
|
||||
);
|
||||
|
||||
/** The session behind the highlighted row, when the highlight is on a card. */
|
||||
const highlightedSession = useCallback((): Session | undefined => {
|
||||
const row = rows.find((r) => r.key === navKey);
|
||||
if (row?.kind !== "session") return undefined;
|
||||
return sessions.find((s) => s.id === row.id);
|
||||
}, [rows, navKey, sessions]);
|
||||
|
||||
const onKeyDown = (e: React.KeyboardEvent) => {
|
||||
// The inline rename field owns its own keys; the walk stays out of it.
|
||||
if (e.target instanceof HTMLInputElement) return;
|
||||
switch (e.key) {
|
||||
case "j":
|
||||
case "ArrowDown":
|
||||
e.preventDefault();
|
||||
moveNav(1);
|
||||
return;
|
||||
case "k":
|
||||
case "ArrowUp":
|
||||
e.preventDefault();
|
||||
moveNav(-1);
|
||||
return;
|
||||
case "Enter":
|
||||
e.preventDefault();
|
||||
activateNav();
|
||||
return;
|
||||
case "Tab":
|
||||
e.preventDefault();
|
||||
props.onFocusPane?.();
|
||||
return;
|
||||
case "c": {
|
||||
const row = rows.find((r) => r.key === navKey);
|
||||
if (row?.kind !== "folder") return;
|
||||
e.preventDefault();
|
||||
toggleFolder(row.path);
|
||||
return;
|
||||
}
|
||||
case "r": {
|
||||
const s = highlightedSession();
|
||||
if (!s) return;
|
||||
e.preventDefault();
|
||||
setRenamingId(s.id);
|
||||
return;
|
||||
}
|
||||
case "x": {
|
||||
const s = highlightedSession();
|
||||
if (!s) return;
|
||||
e.preventDefault();
|
||||
beginKill(s);
|
||||
return;
|
||||
}
|
||||
case "n":
|
||||
e.preventDefault();
|
||||
props.onSpawn?.();
|
||||
return;
|
||||
case "N":
|
||||
e.preventDefault();
|
||||
props.onSpawnDefaults?.();
|
||||
return;
|
||||
case "?":
|
||||
e.preventDefault();
|
||||
props.onHelp?.();
|
||||
return;
|
||||
}
|
||||
};
|
||||
|
||||
const menuItems = (s: Session): ContextMenuItem[] => [
|
||||
{ label: "Rename…", onSelect: () => setRenamingId(s.id) },
|
||||
{ label: "Spawn similar", onSelect: () => props.onSpawnSimilar?.(s) },
|
||||
{ label: "Kill session", danger: true, onSelect: () => beginKill(s) },
|
||||
];
|
||||
|
||||
const renderNode = (node: TreeNode, depth: number): React.ReactNode => {
|
||||
if (node.kind === "leaf") {
|
||||
const s = node.session;
|
||||
return (
|
||||
<SessionCard
|
||||
key={s.id}
|
||||
session={s}
|
||||
depth={depth}
|
||||
now={now}
|
||||
highlighted={navKey === sessionKey(s.id)}
|
||||
active={props.activeId === s.id}
|
||||
open={(props.openIds?.has(s.id) ?? false) && props.activeId !== s.id}
|
||||
previewing={props.previewId === s.id && props.activeId !== s.id}
|
||||
renaming={renamingId === s.id}
|
||||
onSelect={() => props.onSelect?.(s.id)}
|
||||
onOpenMenu={(x, y) => setMenu({ x, y, session: s })}
|
||||
onSpawnSimilar={() => props.onSpawnSimilar?.(s)}
|
||||
onKill={() => beginKill(s)}
|
||||
onRenameCommit={(name) => commitRename(s.id, name)}
|
||||
onRenameCancel={() => setRenamingId(null)}
|
||||
/>
|
||||
);
|
||||
}
|
||||
if (!node.name) {
|
||||
return node.children.map((c) => renderNode(c, depth));
|
||||
}
|
||||
return (
|
||||
<FolderNode
|
||||
key={node.path}
|
||||
name={node.name}
|
||||
path={node.path}
|
||||
depth={depth}
|
||||
collapsed={collapsed.has(node.path)}
|
||||
highlighted={navKey === `folder:${node.path}`}
|
||||
onToggle={() => toggleFolder(node.path)}
|
||||
>
|
||||
{node.children.map((c) => renderNode(c, depth + 1))}
|
||||
</FolderNode>
|
||||
);
|
||||
};
|
||||
|
||||
return (
|
||||
<aside className="sidebar flex h-full min-h-0 flex-col bg-surface">
|
||||
<SidebarSearch
|
||||
value={query}
|
||||
onChange={setQuery}
|
||||
onDismiss={() => treeRef.current?.focus()}
|
||||
/>
|
||||
<div
|
||||
ref={treeRef}
|
||||
className="tree min-h-0 flex-1 overflow-y-auto outline-none"
|
||||
tabIndex={-1}
|
||||
role="tree"
|
||||
aria-label="Sessions"
|
||||
onKeyDown={onKeyDown}
|
||||
// The keyboard walk's preview belongs to the list holding the
|
||||
// keyboard: once it doesn't, the pane goes back to what was opened.
|
||||
onBlur={() => preview?.(null)}
|
||||
>
|
||||
{sessions.length === 0 ? (
|
||||
<EmptyState onSpawn={() => props.onSpawn?.()} />
|
||||
) : (
|
||||
renderNode(tree, 0)
|
||||
)}
|
||||
</div>
|
||||
{menu && (
|
||||
<ContextMenu
|
||||
x={menu.x}
|
||||
y={menu.y}
|
||||
items={menuItems(menu.session)}
|
||||
onClose={() => setMenu(null)}
|
||||
/>
|
||||
)}
|
||||
{kill && (
|
||||
<KillConfirm
|
||||
name={sessionName(kill.session)}
|
||||
blockers={kill.blockers}
|
||||
force={kill.force}
|
||||
onCancel={() => setKill(null)}
|
||||
onConfirm={() => {
|
||||
const { session: s, force } = kill;
|
||||
setKill(null);
|
||||
void killSession(s.id, force).catch((e: unknown) => {
|
||||
// The daemon refuses an unforced kill over a worktree holding
|
||||
// unsaved work; that refusal needs its own prompt
|
||||
// (docs/WORKTREES.md).
|
||||
if (e instanceof ApiRequestError && e.code === "kill_guarded") {
|
||||
setKill({
|
||||
session: s,
|
||||
blockers: e.unsavedWork ?? sessionBlockers(s),
|
||||
force: true,
|
||||
});
|
||||
}
|
||||
});
|
||||
}}
|
||||
/>
|
||||
)}
|
||||
</aside>
|
||||
);
|
||||
}
|
||||
|
||||
/** The tree's one empty state: no sessions at all. */
|
||||
function EmptyState({ onSpawn }: { onSpawn(): void }) {
|
||||
return (
|
||||
<div className="empty flex flex-col items-center gap-sp-2 p-sp-6 text-center">
|
||||
<div aria-hidden="true" className="text-fs-20 text-faint">
|
||||
+
|
||||
</div>
|
||||
<div className="text-fs-13 text-ink">No sessions yet</div>
|
||||
<p className="text-fs-12 text-muted">Start your first session — it'll show up here.</p>
|
||||
<button
|
||||
type="button"
|
||||
className="rounded-r-1 bg-accent px-sp-3 py-sp-1 text-fs-12 text-accent-ink"
|
||||
onClick={onSpawn}
|
||||
>
|
||||
+ Spawn session
|
||||
</button>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
/** Sessions from the store when one is wired, else the static prop. */
|
||||
function useSessions(props: SidebarProps): Session[] {
|
||||
const fromStore = useStore(
|
||||
// `useStore` needs a store every render; the no-store case is served by a
|
||||
// stable empty stand-in whose result is thrown away below.
|
||||
props.store ?? EMPTY_STORE,
|
||||
(s) => (s as { sessions: Map<string, Session> }).sessions,
|
||||
);
|
||||
return useMemo(
|
||||
() => (props.store ? [...fromStore.values()] : (props.sessions ?? [])),
|
||||
[props.store, props.sessions, fromStore],
|
||||
);
|
||||
}
|
||||
|
||||
// One frozen state object, not a fresh one per call: `useStore` reads the
|
||||
// snapshot on every render and a new Map each time would never settle.
|
||||
const EMPTY_STATE = { sessions: new Map<string, Session>() };
|
||||
const EMPTY_STORE = {
|
||||
getState: () => EMPTY_STATE,
|
||||
getInitialState: () => EMPTY_STATE,
|
||||
setState: () => {},
|
||||
subscribe: () => () => {},
|
||||
} as unknown as CatalogStoreApi;
|
||||
Reference in New Issue
Block a user