mirror of
https://github.com/block/buzz.git
synced 2026-11-02 15:31:27 +00:00
## Summary - ship **Buzz Term** end to end: the terminal engine/runtime, mounted desktop substrate, and user-visible naming - add Quinn's tape-deck-inspired banner: a beveled chassis filled by the `buzz term` wordmark, surrounded by a complete-hex field - derive the wordmark's three-stop sweep from each theme's terminal palette so primary, secondary, and accent roles remain visibly distinct across all 62 shipped themes, including light themes - paint the banner once on its own pointer-transparent canvas; PTY rendering beneath it remains unchanged ## Banner behavior - uses the renderer's shared `8.4 × 17` cell metrics and production aspect ratio `2.0238` - regenerates only for viewport/theme changes; palette switches repaint correctly while the banner is visible - dismisses on non-empty output from the active terminal session; empty output and inactive sessions do not dismiss it - fails closed below **70 columns** rather than squeezing or clipping the wordmark - adds **8 lines** to `terminalRenderer.ts` for shared cell metrics and **zero lines inside `paint()`** ## Screenshots | Buzz (light) | Buzz Dark | |---|---| |  |  | | Kanagawa Lotus (light) | Red | |---|---| |  |  | Additional production-aspect finals: [Vesper](https://buzz.block.builderlab.xyz/media/9ca6514b63f8cfb2107a85ca46f16a940c0883848e6fbc718e411af94aa13100.png), [Min Dark](https://buzz.block.builderlab.xyz/media/f67bd2970e5d64ffb07b1ae78ab58c847e6ebc23e7e7a48e067eb024dba64ec8.png), and [Dark Plus](https://buzz.block.builderlab.xyz/media/290fee08924f37d064abc687ecf3e9526ab05b87e8e56d610f23048949793dbe.png). The screenshot harness was checked against the shipped painter at this exact head: all **2,541 draw calls** matched on color, glyph, x, and y; four deliberate divergence controls fired. ## Verification at `98ebc8f9048bd5f0ceb7e843b67874d642f0b7fd` - desktop tests: **3,946 / 3,946** - TypeScript: clean - checks: pass (two pre-existing informational `useTemplate` notices only) - integration/e2e: PASS (independent exact-SHA lane; artifacts recorded in the originating Buzz thread) - artifact/dead-path sweep: clean - redteam G1–G7: PASS - all six named banner emitter-deletion mutants die - independent handwritten five-row full-wordmark fixture kills Quinn's seven-mutant battery, including a one-pixel glyph change - real `112 × 46` canvas-rect dismissal tests separately cover active non-empty, active empty, and inactive non-empty output - layer-drop and zero-draw painter mutants die; z-order and pointer-events verified - CI's `tsc && vite build` includes all three banner modules - performance at DPR 2 (worst-case measured envelope): - one-time content paint: **~0.7–0.8 ms**, paid only when the banner is built or its palette changes - busy compositor, CSS `1277 × 697`, backing `2554 × 1394`: **470–497 µs/frame** for the full banner (**2.82–2.98%** of a 60 Hz frame) - busy compositor, CSS `1920 × 1080`, backing `3840 × 2160`: **1,139–1,212 µs/frame** (**6.83–7.27%**) - empty, one-glyph, and full-banner controls converge: compositor cost follows backing-layer area and DPR rather than painted-cell count - in the actual idle welcome state, cost is below both vsync-clamped rigs' resolution; it is not claimed as zero - **Pane cross-rig spread: resolved at matched loop rate.** Two independent rigs initially differed 2.3× (58–68 vs 136 µs/Mpx of backing store; pane, CSS 1277×697 / backing 2554×1394, DPR 2). The cause of *that* spread is rAF loop rate: the higher figure came from a free-running loop at ~1600fps. Throttled to ~200–236fps, both rigs read 58–68 µs/Mpx (1.25–1.44% of a 60Hz frame). The busy-composite figures quoted above remain the **unthrottled worst case** and are conservative by ~2.3× at the pane. Not established: the mechanism and sign of free-running distortion (one rig under-charges ~15%, the other over-charges 2.3×), and the 1080p figure has not been re-measured throttled. - the layer paints only on generation/theme/resize and dismisses on first non-empty active-session output, so the measurable busy cost is a short-lived worst case rather than a persistent PTY paint-path tax ## Follow-ups in this PR These are intentionally subsequent commits after the certified static-banner head, not claims about `98ebc8f90`: 1. close the compositor metrology: remeasure the 1080p point throttled and characterize the opposite-sign free-running rAF distortion, with each measurement regime stated 2. add Tyler's animated honeycomb color waves, gated by `prefers-reduced-motion`, a full 62-theme phase-sweep contrast check, and DPR-2 per-tick performance certification 3. land the already-proven mounted theme-switch regression probe from `RESEARCH/BUZZ_TERM_G3A_PROBE/` 4. bound the slow/hang-shaped G1-c mutant `waitFor` 5. optionally trim the generator to its ink bounding box, reducing the minimum viewport from 70 to 62 columns --------- Signed-off-by: tlongwell-block <109685178+tlongwell-block@users.noreply.github.com> Signed-off-by: npub1mprnacetjua2xx3p5eddmhxyk6wv929ymm5py8kd2xfxurxahspqqlgyta <d8473ee32b973aa31a21a65adddcc4b69cc2a8a4dee8121ecd51926e0cddbc02@buzz.block.builderlab.xyz> Signed-off-by: npub1jh9wn95s0472h86ahapupaf7m6kx4v9sx2n0atj2hltcfer8k06s5n3pyf <95cae996907d7cab9f5dbf43c0f53edeac6ab0b032a6feae4abfd784e467b3f5@buzz.block.builderlab.xyz> Signed-off-by: npub17jjz49l9jjmhhk7cac63j8yt9z555n9cw8vk7v5jz4vzw4ppld5qgj57cc <f4a42a97e594b77bdbd8ee35191c8b28a94a4cb871d96f32921558275421fb68@buzz.block.builderlab.xyz> Signed-off-by: npub1qyvc0c5kl4gqv2fd97fsk46tu378sqgy35vc83rvgfwne90sel7s0ed67d <011987e296fd5006292d2f930b574be47c7801048d1983c46c425d3c95f0cffd@buzz.block.builderlab.xyz> Co-authored-by: Dawn (sprout agent) <c6237ef84fa537c78dcee78efd2d4e59f728859c7f194da42ac51ededfa0be05@sprout-oss.stage.blox.sqprod.co> Co-authored-by: npub1t2tgm7d8f995uqvmnm8h88sg3wnpp9a5xysjf6dg3tjmgt3ltulqdp8ehr <5a968df9a7494b4e019b9ecf739e088ba61097b4312124e9a88ae5b42e3f5f3e@buzz.block.builderlab.xyz> Co-authored-by: npub1cc3ha7z055mu0rwwu7806t2wt8mj3pvu0uv5mfp2c50dahaqhczshdalg6 <c6237ef84fa537c78dcee78efd2d4e59f728859c7f194da42ac51ededfa0be05@buzz.block.builderlab.xyz> Co-authored-by: npub17jjz49l9jjmhhk7cac63j8yt9z555n9cw8vk7v5jz4vzw4ppld5qgj57cc <f4a42a97e594b77bdbd8ee35191c8b28a94a4cb871d96f32921558275421fb68@buzz.block.builderlab.xyz> Co-authored-by: npub1jh9wn95s0472h86ahapupaf7m6kx4v9sx2n0atj2hltcfer8k06s5n3pyf <95cae996907d7cab9f5dbf43c0f53edeac6ab0b032a6feae4abfd784e467b3f5@buzz.block.builderlab.xyz> Co-authored-by: npub1mprnacetjua2xx3p5eddmhxyk6wv929ymm5py8kd2xfxurxahspqqlgyta <d8473ee32b973aa31a21a65adddcc4b69cc2a8a4dee8121ecd51926e0cddbc02@buzz.block.builderlab.xyz> Co-authored-by: npub1qyvc0c5kl4gqv2fd97fsk46tu378sqgy35vc83rvgfwne90sel7s0ed67d <011987e296fd5006292d2f930b574be47c7801048d1983c46c425d3c95f0cffd@buzz.block.builderlab.xyz>
275 lines
8.0 KiB
TypeScript
275 lines
8.0 KiB
TypeScript
import * as React from "react";
|
|
import { isTauri } from "@tauri-apps/api/core";
|
|
|
|
import {
|
|
type TerminalDelivery,
|
|
TerminalConnection,
|
|
type TerminalFrameMessage,
|
|
type TerminalMessage,
|
|
} from "./terminalClient";
|
|
import {
|
|
TerminalSubstrate,
|
|
type TerminalViewportSize,
|
|
} from "./TerminalSubstrate";
|
|
|
|
type TerminalContext = {
|
|
channelId: string;
|
|
channelName: string;
|
|
threadId: string | null;
|
|
npub: string;
|
|
relayUrl: string;
|
|
};
|
|
|
|
type Session = {
|
|
key: string;
|
|
connection: TerminalConnection | null;
|
|
delivery: TerminalDelivery | null;
|
|
frame: TerminalFrameMessage | undefined;
|
|
title: string;
|
|
closing: boolean;
|
|
};
|
|
|
|
const INITIAL_SIZE: TerminalViewportSize = {
|
|
columns: 80,
|
|
rows: 24,
|
|
pixelWidth: 672,
|
|
pixelHeight: 408,
|
|
};
|
|
|
|
function report(error: unknown) {
|
|
console.error("terminal session failed", error);
|
|
}
|
|
|
|
export function TerminalBootstrap({
|
|
channelId,
|
|
channelName,
|
|
threadId,
|
|
npub,
|
|
relayUrl,
|
|
}: {
|
|
channelId: string | null;
|
|
channelName: string | null;
|
|
threadId: string | null;
|
|
npub: string | null;
|
|
relayUrl: string | null;
|
|
}) {
|
|
const context =
|
|
channelId && npub && relayUrl
|
|
? {
|
|
channelId,
|
|
channelName: channelName ?? channelId,
|
|
threadId,
|
|
npub,
|
|
relayUrl,
|
|
}
|
|
: null;
|
|
const contextRef = React.useRef<TerminalContext | null>(context);
|
|
contextRef.current = context;
|
|
const mountedRef = React.useRef(true);
|
|
const sizeRef = React.useRef(INITIAL_SIZE);
|
|
const resizeChainRef = React.useRef(Promise.resolve());
|
|
const [sessions, setSessions] = React.useState<Session[]>([]);
|
|
const [activeKey, setActiveKey] = React.useState<string | null>(null);
|
|
const [available, setAvailable] = React.useState(() => isTauri());
|
|
const acknowledgedSequenceRef = React.useRef(new Map<string, number>());
|
|
const sessionsRef = React.useRef(sessions);
|
|
sessionsRef.current = sessions;
|
|
|
|
const fail = React.useCallback((error: unknown) => {
|
|
report(error);
|
|
setAvailable(false);
|
|
}, []);
|
|
|
|
const removeSession = React.useCallback((key: string) => {
|
|
setSessions((current) => current.filter((session) => session.key !== key));
|
|
setActiveKey((current) => {
|
|
if (current !== key) return current;
|
|
const remaining = sessionsRef.current.filter(
|
|
(session) => session.key !== key,
|
|
);
|
|
return remaining.at(-1)?.key ?? null;
|
|
});
|
|
}, []);
|
|
|
|
const createSession = React.useCallback(() => {
|
|
const spawnContext = contextRef.current;
|
|
if (!available || !spawnContext) return;
|
|
const key = crypto.randomUUID();
|
|
const initial: Session = {
|
|
key,
|
|
connection: null,
|
|
delivery: null,
|
|
frame: undefined,
|
|
title: "SHELL",
|
|
closing: false,
|
|
};
|
|
setSessions((current) => [...current, initial]);
|
|
setActiveKey(key);
|
|
|
|
const update = (apply: (session: Session) => Session) => {
|
|
if (!mountedRef.current) return;
|
|
setSessions((current) =>
|
|
current.map((session) =>
|
|
session.key === key ? apply(session) : session,
|
|
),
|
|
);
|
|
};
|
|
const onMessage = (
|
|
message: Exclude<TerminalMessage, { type: "frame" }>,
|
|
) => {
|
|
if (message.type === "exit") {
|
|
removeSession(key);
|
|
} else if (message.type === "title") {
|
|
update((session) => ({
|
|
...session,
|
|
title: message.payload || "SHELL",
|
|
}));
|
|
} else if (message.type === "resetTitle") {
|
|
update((session) => ({ ...session, title: "SHELL" }));
|
|
}
|
|
};
|
|
const onFrame = (delivery: TerminalDelivery) => {
|
|
update((session) => ({ ...session, delivery, frame: delivery.frame }));
|
|
};
|
|
|
|
const size = sizeRef.current;
|
|
void TerminalConnection.attach(
|
|
{
|
|
...spawnContext,
|
|
threadId: spawnContext.threadId ?? undefined,
|
|
...size,
|
|
},
|
|
onMessage,
|
|
onFrame,
|
|
)
|
|
.then((connection) => {
|
|
if (!mountedRef.current) return connection.detach();
|
|
update((session) => ({ ...session, connection }));
|
|
if (sizeRef.current !== size) {
|
|
const currentSize = sizeRef.current;
|
|
resizeChainRef.current = resizeChainRef.current
|
|
.then(async () => {
|
|
const viewport = await connection.resize(
|
|
currentSize.columns,
|
|
currentSize.rows,
|
|
currentSize.pixelWidth,
|
|
currentSize.pixelHeight,
|
|
);
|
|
await connection.viewportReady(viewport);
|
|
})
|
|
.catch(fail);
|
|
}
|
|
})
|
|
.catch((error) => {
|
|
removeSession(key);
|
|
fail(error);
|
|
});
|
|
}, [available, fail, removeSession]);
|
|
|
|
React.useEffect(() => {
|
|
if (available && context && sessions.length === 0) createSession();
|
|
}, [available, context, createSession, sessions.length]);
|
|
|
|
React.useEffect(() => {
|
|
mountedRef.current = true;
|
|
return () => {
|
|
mountedRef.current = false;
|
|
for (const session of sessionsRef.current) {
|
|
void session.connection?.detach().catch(report);
|
|
}
|
|
};
|
|
}, []);
|
|
|
|
const active = sessions.find((session) => session.key === activeKey) ?? null;
|
|
const send = (operation: Promise<void> | undefined) => operation?.catch(fail);
|
|
|
|
const handleSize = React.useCallback(
|
|
(size: TerminalViewportSize) => {
|
|
sizeRef.current = size;
|
|
const connection = sessionsRef.current.find(
|
|
(session) => session.key === activeKey,
|
|
)?.connection;
|
|
if (!connection) return;
|
|
resizeChainRef.current = resizeChainRef.current
|
|
.then(async () => {
|
|
const viewport = await connection.resize(
|
|
size.columns,
|
|
size.rows,
|
|
size.pixelWidth,
|
|
size.pixelHeight,
|
|
);
|
|
await connection.viewportReady(viewport);
|
|
})
|
|
.catch(fail);
|
|
},
|
|
[activeKey, fail],
|
|
);
|
|
|
|
return (
|
|
<TerminalSubstrate
|
|
bracketedPaste={active?.frame?.bracketedPaste ?? false}
|
|
channelName={channelName}
|
|
enabled={available && Boolean(active)}
|
|
focusReportingEnabled={active?.frame?.focusReporting ?? false}
|
|
frame={active?.frame}
|
|
sessionFrames={sessions.flatMap((session) =>
|
|
session.frame ? [{ sessionId: session.key, frame: session.frame }] : [],
|
|
)}
|
|
onCloseSession={(key) => {
|
|
setSessions((current) =>
|
|
current.map((session) =>
|
|
session.key === key ? { ...session, closing: true } : session,
|
|
),
|
|
);
|
|
const connection = sessionsRef.current.find(
|
|
(session) => session.key === key,
|
|
)?.connection;
|
|
if (!connection) {
|
|
removeSession(key);
|
|
return;
|
|
}
|
|
void connection
|
|
.close()
|
|
.then(() => removeSession(key))
|
|
.catch(fail);
|
|
}}
|
|
onFrameConsumed={(frame) => {
|
|
const delivery = sessionsRef.current.find(
|
|
(session) => session.delivery?.frame === frame,
|
|
)?.delivery;
|
|
if (!delivery) return;
|
|
const { sequence, subscriptionId } = delivery.frame;
|
|
const lastAcknowledged =
|
|
acknowledgedSequenceRef.current.get(subscriptionId) ?? -1;
|
|
if (sequence <= lastAcknowledged) return;
|
|
acknowledgedSequenceRef.current.set(subscriptionId, sequence);
|
|
delivery.acknowledge().catch((error) => {
|
|
if (
|
|
acknowledgedSequenceRef.current.get(subscriptionId) === sequence
|
|
) {
|
|
acknowledgedSequenceRef.current.set(
|
|
subscriptionId,
|
|
lastAcknowledged,
|
|
);
|
|
}
|
|
fail(error);
|
|
});
|
|
}}
|
|
onInput={(text) => send(active?.connection?.input(text))}
|
|
onNewSession={createSession}
|
|
onScroll={(lines) => send(active?.connection?.scroll(lines))}
|
|
onSelectSession={setActiveKey}
|
|
onTerminalFocusChange={(focused) =>
|
|
send(active?.connection?.focus(focused))
|
|
}
|
|
onViewportSize={handleSize}
|
|
sessions={sessions.map((session) => ({
|
|
active: session.key === activeKey,
|
|
closing: session.closing,
|
|
id: session.key,
|
|
title: session.title,
|
|
}))}
|
|
/>
|
|
);
|
|
}
|