mirror of
https://github.com/stablyai/orca.git
synced 2026-11-03 10:37:35 +00:00
[comment audit] Complete repository-wide comment cleanup (#33249)
* [comment audit] Align legacy failure-read counts with cached display * [comment audit] Condense shared provider lifecycle and browser recovery comments [skip ci] * [comment audit] Condense shared generation, path and preview comments [skip ci] * [comment audit] Condense host, file and Git contract rationale [skip ci] * [comment audit] Tighten Git lifecycle and provider contract comments [skip ci] * [comment audit] Clarify shared host authority and launch isolation [skip ci] * [comment audit] simplify local access mobile and native chat contracts [skip ci] * [comment audit] simplify native chat presentation and state contracts [skip ci] * [comment audit] simplify native runtime and provider contracts [skip ci] * [comment audit] simplify migration and orchestration contracts [skip ci] * [comment audit] simplify plugin trust and process capture rationale [skip ci] * [comment audit] simplify terminal delivery and remote compatibility rationale [skip ci] * [comment audit] clarify remote recovery and launch wire rationale [skip ci] * [comment audit] shorten shared RPC compatibility and runtime evidence comments [skip ci] * [comment audit] simplify secure storage shell startup and sidebar rationale [skip ci] * [comment audit] clarify sidebar, skill and SSH invariants [skip ci] * [comment audit] condense structured chat delivery and timing rationale [skip ci] * [comment audit] condense terminal replay and telemetry invariants [skip ci] * [comment audit] clarify launch permission and terminal delivery rationale [skip ci] * [comment audit] clarify workspace ownership and layout contracts [skip ci] * [comment audit] wait for fitted and painted SSH terminal links * [comment audit] clarify layout persistence and session ownership [skip ci] * [comment audit] clarify host routing and workspace lifecycle contracts [skip ci] * [comment audit] clarify startup persistence and app lifetime comments [skip ci] * [comment audit] clarify recovery and activity boundaries [skip ci] * [comment audit] condense activity and artifact invariants [skip ci] * [comment audit] condense automation authority contracts [skip ci] * [comment audit] simplify automation scheduling and history contracts [skip ci] * [comment audit] clarify browser chrome and annotation lifecycles [skip ci] * [comment audit] clarify browser routing and retained guest ownership [skip ci] * [comment audit] clarify browser recovery and document ownership comments [skip ci] * [comment audit] restore hosted runners required by native IME fixtures * [comment audit] shorten preview, palette and dashboard invariants [skip ci] * [comment audit] clarify terminal preview, dashboard and retention comments [skip ci] * [comment audit] clarify diff-note recovery and editor lifecycle comments [skip ci] * [comment audit] shorten rich-text and combined-diff ownership comments [skip ci] * [comment audit] shorten autosave, draft recovery and model ownership comments [skip ci] * [comment audit] shorten save-queue, notebook and Markdown constraints [skip ci] * [comment audit] shorten Monaco, PDF and rich Markdown safeguards [skip ci] * [comment audit] clarify rich Markdown source and selection safeguards [skip ci] * [comment audit] clarify editor loading and emulator stream lifetimes [skip ci] * [comment audit] trim emulator and feature tour narration [skip ci] * [comment audit] clarify floating workspace and GitHub cache ownership [skip ci] * [comment audit] trim provider controls and Linear filter explanations [skip ci] * [comment audit] clarify pairing and chat resume lifetimes [skip ci] * [comment audit] clarify chat delivery and transcript lifetimes [skip ci] * [comment audit] clarify session options and host-owned status [skip ci] * [comment audit] clarify draft durability and live-status precedence [skip ci] * [comment audit] Trim chat send and model ownership explanations [skip ci] * [comment audit] Shorten transcript ownership and send recovery comments [skip ci] * [comment audit] Simplify native chat composer and transcript hook comments [skip ci] * [comment audit] Shorten native chat scroll and structured session explanations [skip ci] * [comment audit] Trim workspace picker and onboarding commentary [skip ci] * [comment audit] Simplify pet rendering, review cache and quick open comments [skip ci] * [comment audit] Trim sidebar and session history explanations [skip ci] * [comment audit] Condense session resume and review checks comments [skip ci] * [comment audit] Shorten checks state and file explorer refresh comments [skip ci] * [comment audit] Trim plugin bridge and source-control action rationale [skip ci] * [comment audit] Trim source-control listing and review rationale [skip ci] * [comment audit] Shorten sidebar lifecycle and explorer safeguards [skip ci] * [comment audit] Condense Settings account and appearance rationale [skip ci] * [comment audit] Trim pairing and repository Settings explanations [skip ci] * [comment audit] Condense Settings search SSH and terminal safeguards [skip ci] * [comment audit] Shorten Settings voice and provider ownership comments [skip ci] * [comment audit] Condense Settings draft persistence and host-state rationale [skip ci] * [comment audit] Trim Settings hooks and sidebar setup rationale [skip ci] * [comment audit] Condense sidebar deletion and board-filter safeguards [skip ci] * [comment audit] Condense worktree cards, host ownership and Markdown contracts [skip ci] * [comment audit] Condense sidebar drag, folder and filtering contracts [skip ci] * [comment audit] Condense sidebar parity, sleep and host ownership contracts [skip ci] * [comment audit] Prune focus-read baseline after comment cleanup * [comment audit] Clarify sidebar visibility, board drops and agent evidence [skip ci] * [comment audit] Tighten sidebar listing, drag and reveal contracts [skip ci] * [comment audit] Clarify viewport geometry and skill update safeguards [skip ci] * [comment audit] Tighten skill inventory, usage and host status comments [skip ci] * [comment audit] Clarify usage ownership and resource kill safeguards [skip ci] * [comment audit] Tighten tab selection, rename and search contracts [skip ci] * [comment audit] Tighten tab-strip geometry and drag ownership comments [skip ci] * [comment audit] Tighten Tasks recovery, pagination and mutation comments [skip ci] * [comment audit] Tighten provider loading and terminal recovery comments [skip ci] * [comment audit] Tighten completion, cadence and PTY ownership comments [skip ci] * [comment audit] Clarify terminal restore and parked-pane boundaries [skip ci] * [comment audit] Tighten PTY startup and replay explanations [skip ci] * [comment audit] Clarify PTY identity and delivery ownership [skip ci] * [comment audit] Shorten remote reconnect and input replay rationale [skip ci] * [comment audit] Condense terminal parking clipboard and file link comments [skip ci] * [comment audit] Clarify IME ownership and trim trace history [skip ci] * [comment audit] Shorten pane recovery and parked watcher explanations [skip ci] * [comment audit] Condense snapshot replay and visibility recovery rationale [skip ci] * [comment audit] Shorten terminal parking and keyboard ownership rationale [skip ci] * [comment audit] Trim renderer lifecycle and menu rationale [skip ci] * [comment audit] Condense workspace cleanup ownership and settlement notes [skip ci] * [comment audit] Clarify renderer hook evidence and source ownership [skip ci] * [comment audit] Tighten IPC ownership and reconnect explanations [skip ci] * [comment audit] Trim renderer focus, paste and attention comments [skip ci] * [comment audit] Shorten scroll, locale and agent lifecycle comments [skip ci] * [comment audit] Trim agent launch, resume and ownership commentary [skip ci] * [comment audit] Shorten account, browser and editor comments [skip ci] * [comment audit] Clarify host-mirror waits, previews and input ownership [skip ci] * [comment audit] Condense launch recovery and editor tokenization comments [skip ci] * [comment audit] Condense workspace selection and terminal pane rationale [skip ci] * [comment audit] Condense terminal fitting and rendering recovery comments [skip ci] * [comment audit] Condense terminal input and host routing explanations [skip ci] * [comment audit] Condense ownership and sleeping-session recovery rationale [skip ci] * [comment audit] Condense structured launch and terminal link explanations [skip ci] * [comment audit] Condense terminal ownership and workspace file routing rationale [skip ci] * [comment audit] Condense session persistence and workspace activation rationale [skip ci] * [comment audit] Condense workspace routing and browser ownership rationale [skip ci] * [comment audit] Condense mirror recovery and layout authority rationale [skip ci] * [comment audit] Condense runtime transport and file safety rationale [skip ci] * [comment audit] Condense runtime graph and structured session rationale [skip ci] * [comment audit] Condense browser creation and remote tab recovery rationale [skip ci] * [comment audit] Condense snapshot authority and publisher recovery rationale [skip ci] * [comment audit] Condense frame, startup and provider cache rationale [skip ci] * [comment audit] Condense host twin and agent lifecycle rationale [skip ci] * [comment audit] Condense browser authority and editor cleanup rationale [skip ci] * [comment audit] Condense editor buffer identity and review cache rationale [skip ci] * [comment audit] Condense provider lifetime and repository ownership rationale [skip ci] * [comment audit] Condense reconnect, hydration and terminal retirement rationale [skip ci] * [comment audit] Condense recovery, reconciliation and persistence rationale [skip ci] * [comment audit] Condense cleanup ownership and listing admission rationale [skip ci] * [comment audit] Condense teardown ordering and terminal ownership rationale [skip ci] * [comment audit] Condense recovery ledger and web host-boundary rationale [skip ci] * [comment audit] Condense web reconnect and credential lifecycle rationale [skip ci] * [comment audit] Condense cloud rollout and assignment safety rationale [skip ci] * [comment audit] Condense relay session and database recovery rationale [skip ci] * [comment audit] Condense relay placement and protocol compatibility rationale [skip ci] * [comment audit] Condense build and packaging constraints [skip ci] * [comment audit] Condense CI gates and validation isolation rationale [skip ci] * [comment audit] Condense catalog identity and browser validation rationale [skip ci] * [comment audit] Condense mobile browser and frame-budget rationale [skip ci] * [comment audit] Shorten mobile route and browser test explanations [skip ci] * [comment audit] Condense editor and session seam test rationale [skip ci] * [comment audit] Trim session and terminal closure history [skip ci] * [comment audit] Shorten terminal browser and census explanations [skip ci] * [comment audit] Preserve root-only E2E diagnostic baseline * [comment audit] Condense mobile seam and HTML preview test rationale [skip ci] * [comment audit] Condense preview instrumentation and render harness rationale [skip ci] * [comment audit] Condense bundle contracts and native-build constraints [skip ci] * [comment audit] Shorten native packaging and CI routing rationale [skip ci] * [comment audit] Condense release tooling and benchmark constraints [skip ci] * [comment audit] Condense packaging and platform gate rationale [skip ci] * [comment audit] Shorten mobile route and history rationale [skip ci] * [comment audit] Condense mobile browser and component rationale [skip ci] * [comment audit] Shorten drawer and workspace-form rationale [skip ci] * [comment audit] Trim mobile review and editor-document explanations [skip ci] * [comment audit] Condense editor lifecycle and Markdown explanations [skip ci] * [comment audit] Trim mobile file, diagnostics and dictation commentary [skip ci] * [comment audit] Simplify mobile host-list and workspace-view explanations [skip ci] * [comment audit] Clarify mobile shell lifetime and bridge delivery constraints [skip ci] * [comment audit] Condense bridge stream, native request and audio rationale [skip ci] * [comment audit] Reduce bridge schema and page-client commentary [skip ci] * [comment audit] Tighten mobile page bridge contracts [skip ci] * [comment audit] Clarify mobile cache and session constraints [skip ci] * [comment audit] Condense mobile route and lifecycle rationale [skip ci] * [comment audit] Tighten mobile shell hook timing rationale [skip ci] * [comment audit] Clarify route handoff and notification compatibility [skip ci] * [comment audit] Clarify push registration and dictation cleanup constraints [skip ci] * [comment audit] Condense keyboard geometry and native media ownership rationale [skip ci] * [comment audit] Tighten mobile chat scroll and composer concurrency rationale [skip ci] * [comment audit] Condense mobile reply compatibility and upload ownership rationale [skip ci] * [comment audit] Condense optimistic echo and scroll ownership rationale [skip ci] * [comment audit] Tighten stream replay and queued session ownership rationale [skip ci] * [comment audit] Condense mobile composer and reply-schema constraints [skip ci] * [comment audit] Clarify mobile transcript recovery and session ownership [skip ci] * [comment audit] Clarify mobile queue and source-control compatibility [skip ci] * [comment audit] Condense storage and task launch constraints [skip ci] * [comment audit] Clarify task schemas and terminal document ownership [skip ci] * [comment audit] Tighten terminal input and viewport rationale [skip ci] * [comment audit] Shorten terminal and RPC recorder contracts [skip ci] * [comment audit] Condense recorder engine and connection contracts [skip ci] * [comment audit] Shorten host credential and relay recovery comments [skip ci] * [comment audit] Tighten pairing recovery and bundle transport rationale [skip ci] * [comment audit] Clarify RPC delivery and workspace catalog boundaries [skip ci] * [comment audit] Condense catalog and relay entry contracts [skip ci] * [comment audit] Shorten shutdown and SSH relay delivery contracts [skip ci] * [comment audit] Condense WSL relay and E2E regression rationale [skip ci] * [comment audit] Shorten cross-version harness and renderer fixture explanations [skip ci] * [comment audit] Condense paired-host and E2E lifecycle rationale [skip ci] * [comment audit] Shorten layout oracle and regression explanations [skip ci] * [comment audit] Condense paired recovery and ownership regression contracts [skip ci] * [comment audit] Shorten restart, sidebar and SSH lifecycle contracts [skip ci] * [comment audit] Condense terminal rendering and IME regression rationale [skip ci] * [comment audit] Shorten terminal recovery and benchmark contracts [skip ci] * [comment audit] Condense tooling and Windows lifecycle proof rationale [skip ci] * [comment audit] Condense workflow routing and release rationale [skip ci] * [comment audit] Condense mobile security and installer contracts [skip ci] * [comment audit] Shorten native rationale and stylesheet workarounds [skip ci] * [comment audit] Shorten Windows visibility probe rationale [skip ci] * [comment audit] Condense embedded release and signing rationale [skip ci] * [comment audit] Retain current main test behavior in final reconciliation [skip ci] * [comment audit] Complete final comment review across current source inventory * [comment audit] Handle consolidated audit reports before final CI * [comment audit] Preserve credential storage census detail [skip ci] * [comment audit] Scale broad changed E2E selections with verified timing shards * [comment audit] Align E2E assertions with browser close and settled session metadata * [comment audit] Match existing E2Es to current resource and windowing contracts * [comment audit] Observe the shared server outage notice in reconnect coverage * [comment audit] Make existing renderer probes measure settled tab and PTY work * [comment audit] Align palette E2E selector with task search * [comment audit] Refresh remaining palette search selectors * [comment audit] Keep selector correction within selected audit specs * [comment audit] Await emoji fixture settings inside renderer evaluation * [comment audit] Cancel fixture fit retries between terminal tests --------- Co-authored-by: OrcaWin <293788423+OrcaWin@users.noreply.github.com>
This commit is contained in:
OrcaWin
OrcaWin
@@ -2,7 +2,6 @@ import { getOpenCode2TuiSource } from './status-plugin-tui-source'
|
||||
import { openCodeTuiPluginDirName } from '../../shared/opencode-tui-plugin-install'
|
||||
import { getLegacyOpenCodeTuiSource } from '../opencode/status-plugin-legacy-tui-source'
|
||||
|
||||
/** The OpenCode 2 entry points (server setup and TUI reporter) plus the constants they share. */
|
||||
export function getOpenCode2ModuleSource(pluginID: string, expectedAgent: string): string[] {
|
||||
return [
|
||||
`const ORCA_TUI_PLUGIN_ENTRY = new URL("./${openCodeTuiPluginDirName(`${pluginID}.js`)}/tui.js", import.meta.url);`,
|
||||
@@ -12,21 +11,15 @@ export function getOpenCode2ModuleSource(pluginID: string, expectedAgent: string
|
||||
]
|
||||
}
|
||||
|
||||
// Interpolated so the server bundle stays ASCII; String.raw keeps the generated source's bytes.
|
||||
// Preserve ASCII server bundles while String.raw keeps generated bytes.
|
||||
const EM_DASH = '\u2014'
|
||||
|
||||
export function getOpenCode2SetupSource(): string[] {
|
||||
return String.raw`
|
||||
// Why: OpenCode owns a form under a session id, and Orca retires a blocker when
|
||||
// that session goes idle. An owner that is not a real session has no idle, so a
|
||||
// blocker minted for it can only ever be retired by an exact reply ${EM_DASH} add an id
|
||||
// here to drop forms Orca could otherwise strand. OpenCode's own schema calls
|
||||
// "global" a temporary MCP-elicitation sentinel it intends to replace with real
|
||||
// session ids; when it does, this set stops matching and those forms block.
|
||||
// Non-session owners have no Idle ${EM_DASH} ignore known sentinels to avoid stranded blockers.
|
||||
const NON_SESSION_FORM_OWNERS = new Set(["global"]);
|
||||
|
||||
// Why one translation: the TUI reporter builds its Needs input payloads with it, so a blocker
|
||||
// reaches Orca in the same shape whichever process reported it.
|
||||
// Normalize blockers once so server and TUI reports reach Orca in the same shape.
|
||||
function translateOpenCode2Event(inputType, data) {
|
||||
let type = inputType;
|
||||
let properties = data || {};
|
||||
@@ -42,12 +35,9 @@ function translateOpenCode2Event(inputType, data) {
|
||||
properties = { ...properties, permission: properties.action, patterns: properties.resources };
|
||||
} else if (type === "form.created") {
|
||||
const form = properties.form;
|
||||
// Why: block on every form whose owner is a real session. "metadata" is
|
||||
// optional in OpenCode's schema and its "kind" is a convention no
|
||||
// producer is obliged to stamp, so an unknown shape must surface a
|
||||
// blocker the user can clear rather than vanish while OpenCode waits.
|
||||
// Metadata kind is optional; every real-session-owned form must surface a clearable blocker.
|
||||
if (!form || NON_SESSION_FORM_OWNERS.has(form.sessionID)) return null;
|
||||
// A malformed form must not throw: that would kill the subscription.
|
||||
// Malformed forms must not kill the subscription.
|
||||
const fields = Array.isArray(form.fields) ? form.fields : [];
|
||||
type = "question.asked";
|
||||
properties = {
|
||||
@@ -60,8 +50,6 @@ function translateOpenCode2Event(inputType, data) {
|
||||
})),
|
||||
};
|
||||
} else if (type === "form.replied" || type === "form.cancelled") {
|
||||
// A resolution for an ignored form is inert: the blocker key carries the
|
||||
// form id, so it simply matches nothing.
|
||||
type = type === "form.replied" ? "question.replied" : "question.rejected";
|
||||
properties = { ...properties, requestID: properties.id };
|
||||
} else if (type === "session.text.started" || type === "session.text.delta" || type === "session.text.ended") {
|
||||
@@ -70,15 +58,12 @@ function translateOpenCode2Event(inputType, data) {
|
||||
return { type, properties };
|
||||
}
|
||||
|
||||
// Why: every OpenCode 2 server runs as a "serve" process (the shared service or a
|
||||
// --standalone child) whose env names only the pane that spawned it, so each full TUI
|
||||
// reports its own pane through the TUI copy of this plugin instead.
|
||||
// Serve-process environment names only its starter pane; each TUI must report its own pane.
|
||||
async function tuiReportsPaneLifecycle() {
|
||||
if (!process.argv.includes("serve")) return false;
|
||||
try {
|
||||
const { statSync } = await import("node:fs");
|
||||
// Why: an installer that predates the TUI copy (e.g. an older SSH relay) writes only
|
||||
// this file; without the TUI copy nothing else would report, so keep reporting.
|
||||
// Older SSH installers may omit the TUI copy; retain server reporting as fallback.
|
||||
return statSync(ORCA_TUI_PLUGIN_ENTRY).isFile();
|
||||
} catch {
|
||||
return false;
|
||||
@@ -92,22 +77,15 @@ async function setupOpenCode2Status(ctx) {
|
||||
return setupOpenCode2Tui(ctx);
|
||||
}
|
||||
let hooks;
|
||||
// Why: OpenCode may probe setup() with no context during startup, and the setup
|
||||
// API shape can drift between releases. Never throw from setup ${EM_DASH} a throw surfaces
|
||||
// as an 'orca-opencode-status' plugin failed error in the TUI, which is worse
|
||||
// than silently running without status reporting.
|
||||
// OpenCode probes varying setup contexts; avoid startup errors when status reporting is unavailable.
|
||||
try {
|
||||
if (!ctx || typeof ctx.session?.hook !== "function" || typeof ctx.event?.subscribe !== "function") return noop;
|
||||
reportingOpenCodeMajor = 2;
|
||||
if (await tuiReportsPaneLifecycle()) return noop;
|
||||
const controller = new AbortController();
|
||||
// Why the envelope: OpenCode 2's plugin adapter unwraps a single-property
|
||||
// { data } success schema, so ctx.session.get resolves to the bare record ${EM_DASH}
|
||||
// but the shared lineage lookup only accepts result?.data?.id === sessionID.
|
||||
// Without it, resolveRootSessionID returns null for every session and a
|
||||
// subagent's work publishes as if it were the root's.
|
||||
// Wrap bare OpenCode 2 session records for shared lineage lookup's data.id contract.
|
||||
const client = { session: { get: async (input, options) => { const result = await ctx.session.get(input, options); return result && typeof result.id === "string" ? { data: result } : result; } } };
|
||||
// Why: this host disposes plugins on a hot reload while turns keep running.
|
||||
// Hot reload disposes plugins while turns continue.
|
||||
hooks = await OrcaOpenCodeStatusPlugin({ client, sessionsOutliveDispose: true });
|
||||
if (!hooks || typeof hooks.event !== "function") return noop;
|
||||
const promptRegistration = await ctx.session.hook("prompt", async (properties) => {
|
||||
@@ -127,7 +105,7 @@ async function setupOpenCode2Status(ctx) {
|
||||
return async () => {
|
||||
try {
|
||||
controller.abort();
|
||||
// Each owner must finish cleanup even when an earlier disposer rejects.
|
||||
// Finish every owner's cleanup even if an earlier disposer fails.
|
||||
try {
|
||||
await promptRegistration?.dispose?.();
|
||||
} finally {
|
||||
@@ -138,7 +116,7 @@ async function setupOpenCode2Status(ctx) {
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// Why: cleanup runs during plugin unload; a throw here also fails the plugin.
|
||||
// Cleanup failures must not fail plugin unload.
|
||||
}
|
||||
};
|
||||
} catch {
|
||||
|
||||
@@ -1,12 +1,6 @@
|
||||
import { getTuiStatusDeliverySource } from '../opencode/status-plugin-delivery-source'
|
||||
|
||||
/**
|
||||
* TUI reporter for the OpenCode 2 status plugin. The module Orca writes as a server plugin is
|
||||
* also installed as a TUI plugin; in a TUI process setup() lands here. The TUI runs in its
|
||||
* pane's PTY, so every post names the right pane. It derives the pane's level from the TUI's
|
||||
* own session data (which OpenCode keeps current, re-hydrating it on reconnect) instead of
|
||||
* inferring it from events, and reuses only the plugin's delivery functions.
|
||||
*/
|
||||
// Report from each TUI’s own PTY and current session data so ownership and reconnects self-correct.
|
||||
export function getOpenCode2TuiSource(): string[] {
|
||||
return String.raw`
|
||||
const TUI_TICK_MS = 100;
|
||||
@@ -25,21 +19,20 @@ function boundedSet(set, value, max) {
|
||||
if (set.size > max) set.delete(set.values().next().value);
|
||||
}
|
||||
|
||||
// Memory survives hot reloads and ends with the TUI.
|
||||
// Memory survives hot reload within this TUI process.
|
||||
function paneStatusMemory(ctx) {
|
||||
const initial = { owned: [], last: "idle:", lastRoot: "", started: false, endings: [] };
|
||||
if (typeof ctx.storage?.memory === "function") return ctx.storage.memory("pane-status", { initial });
|
||||
// Why started: without memory a reload looks like a TUI start, and must not reset the pane.
|
||||
// Without memory, reload resembles startup; avoid resetting the pane.
|
||||
const local = { ...initial, started: true };
|
||||
return [local, (mutate) => mutate(local)];
|
||||
}
|
||||
|
||||
async function setupOpenCode2Tui(ctx) {
|
||||
const noop = async () => {};
|
||||
// Why: post() needs this pane's key, so a TUI outside an Orca pane has nothing to report.
|
||||
// Outside an Orca pane, post has no pane identity to report.
|
||||
if (!process.env.ORCA_PANE_KEY) return noop;
|
||||
if (process.env.ORCA_OPENCODE_AGENT && process.env.ORCA_OPENCODE_AGENT !== ORCA_STATUS_AGENT) return noop;
|
||||
// Legacy attach contexts enter only through the checked API adapter.
|
||||
if (/^1\./.test(String(ctx.app?.version || "")) && !ctx.legacyOpenCodeTui) return noop;
|
||||
const data = ctx.data.session;
|
||||
if (typeof data?.status !== "function" || typeof data.root !== "function") return noop;
|
||||
@@ -52,7 +45,7 @@ async function setupOpenCode2Tui(ctx) {
|
||||
let lastLevel = null;
|
||||
let ticks = 0;
|
||||
const early = new Map();
|
||||
// Why: a permission/form list fetched on reconnect can land after the reply event and restore it.
|
||||
// Reconnect fetches may arrive after reply events; do not resurrect retired blockers.
|
||||
const resolved = new Set();
|
||||
const permissionSeenAt = new Map();
|
||||
|
||||
@@ -70,7 +63,7 @@ async function setupOpenCode2Tui(ctx) {
|
||||
if (resolved.has(request.id)) return false;
|
||||
seenPermissions.add(request.id);
|
||||
if (!permissionSeenAt.has(request.id)) permissionSeenAt.set(request.id, Date.now());
|
||||
// Auto replies arrive after the request; only an unanswered request needs attention.
|
||||
// Auto replies follow requests; only unanswered requests need attention.
|
||||
return Date.now() - permissionSeenAt.get(request.id) >= TUI_PERMISSION_SETTLE_MS;
|
||||
});
|
||||
if (permission) return { request: permission, isPermission: true };
|
||||
@@ -92,7 +85,7 @@ async function setupOpenCode2Tui(ctx) {
|
||||
const ending = (memory.endings || []).find(([id]) => id === level.root);
|
||||
const idleAt = session?.time?.idle;
|
||||
const sameTurn = Number.isFinite(idleAt) && ending?.[2] === idleAt;
|
||||
// Current session data repairs a whole turn missed while the plugin was unloaded.
|
||||
// Current session data repairs turns missed while the plugin was unloaded.
|
||||
const errorName = !rootRunning && (session?.outcome === "failed"
|
||||
? (sameTurn && ending[1]) || "UnknownError"
|
||||
: session?.outcome === "interrupted" && sameTurn ? ending[1] : "");
|
||||
@@ -107,21 +100,19 @@ async function setupOpenCode2Tui(ctx) {
|
||||
return [...owned, root];
|
||||
}
|
||||
|
||||
// Why derive, not infer: OpenCode's session data is the single copy of running/blocked/lineage
|
||||
// and self-corrects on reconnect; nothing here latches a start or end event.
|
||||
// Derive from current session data so reconnects self-correct without latched start/end events.
|
||||
function derive() {
|
||||
const route = currentRoute();
|
||||
let owned = [...memory.owned];
|
||||
if (route && !owned.includes(route) && running(route)) owned = own(route, owned);
|
||||
// Why keep a root past navigation: a pane that started a turn must still reach Done
|
||||
// when the user browses to another session mid-turn.
|
||||
// Retain roots after navigation so turns started here can still reach Done.
|
||||
owned = owned.filter((root) => root === route || running(root));
|
||||
if (owned.join("\n") !== memory.owned.join("\n")) setMemory((draft) => { draft.owned = owned; });
|
||||
const active = owned.filter(running);
|
||||
const seenPermissions = new Set();
|
||||
let waiting;
|
||||
for (const root of active) {
|
||||
// Why only while running: a blocker the session data kept after its turn ended is stale.
|
||||
// Session data can retain stale blockers after a turn ends; consider only running turns.
|
||||
const found = blocker(root, seenPermissions);
|
||||
if (found && !waiting) waiting = { kind: "waiting", root, blocker: found };
|
||||
}
|
||||
@@ -141,7 +132,7 @@ async function setupOpenCode2Tui(ctx) {
|
||||
level = derive();
|
||||
level.rootFields = rootFields(level);
|
||||
} catch {
|
||||
// Why: a data read that throws must not kill the listener or the tick.
|
||||
// Session-data read failures must not kill the listener or tick.
|
||||
return;
|
||||
}
|
||||
const key = levelKey(level);
|
||||
@@ -155,7 +146,7 @@ async function setupOpenCode2Tui(ctx) {
|
||||
}
|
||||
|
||||
async function deliver(level, changed) {
|
||||
// Retires assistant text queued under the previous level (see flushPendingAssistantPart).
|
||||
// Retire assistant previews queued under the old level.
|
||||
if (changed) stateArrivalRevision += 1;
|
||||
const properties = level.root ? { sessionID: level.root, ...level.rootFields } : {};
|
||||
if (level.kind === "waiting") {
|
||||
@@ -186,13 +177,11 @@ async function setupOpenCode2Tui(ctx) {
|
||||
if (early.size > TUI_EARLY_ROOTS_MAX) early.delete(early.keys().next().value);
|
||||
}
|
||||
|
||||
// Content only; status comes from derive().
|
||||
function observe(event) {
|
||||
const properties = event.data || {};
|
||||
const sessionID = properties.sessionID;
|
||||
if (event.type === "server.connected") {
|
||||
// Why: OpenCode re-syncs blockers only for the sessions it displays; an owned session the
|
||||
// user navigated away from would otherwise keep a request answered while disconnected.
|
||||
// OpenCode resyncs only displayed sessions; refetch owned sessions to clear disconnected replies.
|
||||
for (const root of memory.owned) {
|
||||
for (const member of family(root)) {
|
||||
void data.permission?.sync?.(member)?.catch?.(() => {});
|
||||
@@ -236,7 +225,7 @@ async function setupOpenCode2Tui(ctx) {
|
||||
const errorName = event.type === "session.execution.failed"
|
||||
? (typeof properties.error?.type === "string" && properties.error.type) || "UnknownError"
|
||||
: event.type === "session.execution.interrupted" && properties.reason === "user" ? "MessageAbortedError" : "";
|
||||
// A hot reload keeps the terminal verdict; only this root's next turn replaces it.
|
||||
// Hot reload preserves terminal verdicts until this root starts another turn.
|
||||
setMemory((draft) => {
|
||||
draft.endings = (draft.endings || []).filter(([id]) => id !== root);
|
||||
if (errorName) draft.endings = [...draft.endings, [root, errorName, event.created ?? data.get?.(root)?.time?.idle]].slice(-TUI_EARLY_ROOTS_MAX);
|
||||
@@ -244,7 +233,7 @@ async function setupOpenCode2Tui(ctx) {
|
||||
}
|
||||
}
|
||||
if (event.type === "session.inbox.enqueued") {
|
||||
// Why TUI-only: the server takes the prompt from session.hook("prompt"), which a TUI lacks.
|
||||
// TUI lacks the server's session.hook prompt callback.
|
||||
const item = properties.item;
|
||||
if (sessionID !== root || item?.type !== "user" || typeof item.payload?.text !== "string" || !item.payload.text) return;
|
||||
const prompt = { text: item.payload.text, messageID: properties.inboxID };
|
||||
@@ -253,31 +242,29 @@ async function setupOpenCode2Tui(ctx) {
|
||||
return;
|
||||
}
|
||||
if (event.type === "session.text.ended" && isOwned && sessionID === root && typeof properties.text === "string" && properties.text) {
|
||||
// Why: Orca reads any MessagePart as Working, which would bury this pane's Needs input.
|
||||
// MessagePart implies Working in Orca and must not bury Needs input.
|
||||
if (memory.last.startsWith("waiting:")) return;
|
||||
const part = { role: "assistant", text: properties.text, messageID: properties.assistantMessageID, sessionID: root, factoryID };
|
||||
// Why queued: the reply must not overtake this turn's SessionStart, prompt or Busy.
|
||||
// Queue reply previews after this turn's start, prompt and Busy.
|
||||
void enqueueLifecycle(() => queueAssistantPart({ ...part, authorityRevision: stateArrivalRevision }));
|
||||
}
|
||||
}
|
||||
|
||||
// Why synchronous: OpenCode applies each event to its session data before plugin listeners
|
||||
// run, so deciding here never trails the data, and no queue of events can build up.
|
||||
// OpenCode updates data before listeners; derive synchronously to avoid stale event queues.
|
||||
const unsubscribe = ctx.data.listen(({ details } = {}) => {
|
||||
if (disposed || !details || typeof details.type !== "string") return;
|
||||
try {
|
||||
observe(details);
|
||||
publish();
|
||||
} catch {
|
||||
// A malformed event must not break the listener.
|
||||
// Malformed events must not break the listener.
|
||||
}
|
||||
});
|
||||
// Why a tick: a route change has no event, and a reconnect re-hydrates the data without one.
|
||||
// Route changes and reconnect rehydration can happen without events.
|
||||
const tick = setInterval(() => {
|
||||
try {
|
||||
publish();
|
||||
// Why: an Orca restart moves the hook endpoint; the delivery layer re-posts an unchanged
|
||||
// level only when asked, which the old event-driven path did on every lifecycle event.
|
||||
// Ticks must request unchanged-level reposting when Orca restarts and moves the endpoint.
|
||||
if (++ticks % TUI_ENDPOINT_CHECK_TICKS === 0 && lastLevel && desiredFactoryID === factoryID && deliveredEndpointKey !== hookEndpointKey()) {
|
||||
const level = lastLevel;
|
||||
void enqueueLifecycle(() => deliver(level, false));
|
||||
@@ -288,8 +275,7 @@ async function setupOpenCode2Tui(ctx) {
|
||||
publish();
|
||||
if (!memory.started) {
|
||||
setMemory((draft) => { draft.started = true; });
|
||||
// Why: clears a status an earlier process left on this pane (e.g. a pre-upgrade shared service
|
||||
// posting another pane's turn here). Connected idle, never a completion; reloads skip it.
|
||||
// Fresh starts clear prior-process status with connected idle; reloads retain the terminal verdict.
|
||||
if (memory.last === "idle:") {
|
||||
const route = currentRoute();
|
||||
void enqueueLifecycle(() => post("SessionStart", route ? { sessionID: route } : {}));
|
||||
@@ -300,11 +286,10 @@ async function setupOpenCode2Tui(ctx) {
|
||||
disposed = true;
|
||||
clearInterval(tick);
|
||||
if (typeof unsubscribe === "function") unsubscribe();
|
||||
// Why publish nothing: a hot reload disposes this mid-turn and the next generation
|
||||
// re-derives from the same memory. Unconfirmed delivery is re-derived by that generation.
|
||||
// Hot reload rederives memory and unconfirmed delivery in the next generation; publish nothing.
|
||||
await releaseTuiStatusDelivery(factoryID, () => setMemory((draft) => { draft.last = ""; }));
|
||||
} catch {
|
||||
// Why: cleanup runs during plugin unload; a throw here also fails the plugin.
|
||||
// Cleanup failures must not fail plugin unload.
|
||||
}
|
||||
};
|
||||
} catch {
|
||||
|
||||
Reference in New Issue
Block a user