mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-10-09 08:59:40 +02:00
Seven things, none of which changes what the feature does. 1. The rebuilt Session dropped `nameSource`, so the constructor re-inferred it from the name: a session the user renamed by hand to something shaped like `w<n>-<case>` came back as `placeholder`, and with auto-naming on the next prompt overwrote their name. The route persists right after, so the loss went to disk. `restoreMuxSessions()` already passes it. 2. The already-live sets were snapshotted once before a loop that awaits a real `startInteractive()` per entry, so by the tenth entry the snapshot was tens of seconds old and a conversation resumed by hand from the Resume list in that window was invisible to it: two panes on one transcript, the exact thing the check exists to prevent. Both sets are now read per iteration, and the late case is spent rather than re-offered for the same reason the batch case is. 3. Auto-resume no longer re-arms the pre-reboot `autoResumeAt` on this path. The stamp predates the reboot and the pane is new, so honouring it meant one click had every restored session type `continue` into itself about a minute later, unattended, against the route header's own promise that a restored session comes back idle and disarmed. The setting stays ENABLED, so it re-arms on the next real limit message. A Codeman restart still re-arms from the stamp, because the limit footer will not reprint on its own; the new option exists only to tell the two paths apart. 4. `discardPartiallyBuiltSession()` now also calls `recordSessionStopped()` and `ralphTracker.fullReset()`, the two teardown steps `_doCleanupSession` performs that it was missing. Cosmetic, but a run left open reads as still going in the away digest. 5. A restored claude session gets `seedAgentSessionPreamble()` like both create paths, so the agent skill's bootstrap stays a two-line loader. 6. The heuristic's container comment was wrong in one direction and quiet about the real gap: after a genuine host reboot a containerized Codeman sees the host's short uptime and the banner does appear. What it cannot see is a container-only restart, which is where this would help most. 7. The banner is hidden in a solo window, which shows one session and has no tab strip to put restored ones in. Also reverts 17 of the 18 hunks in docs/api-reference.md, which were Prettier reformatting of prose the PR does not otherwise touch (docs/ is outside the format glob), keeping only the Reboot restore section and repairing the two continuation lines that reformat de-indented; renumbers reboot-restore-ui.js to @loadorder 11.65, since 11.7 is admin-ui.js, which loads after it; and gives the feature its CLAUDE.md entry plus a route test for the multi-user workspace-forbidden branch, the only new rule that had nothing behind it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
314 lines
17 KiB
TypeScript
314 lines
17 KiB
TypeScript
/**
|
|
* @fileoverview Reboot-restore routes: offer back the sessions a host reboot destroyed.
|
|
*
|
|
* The boot pass leaves a plan in `web/reboot-restore-registry` when the machine
|
|
* plausibly rebooted. The board reads it, shows a banner, and the user decides:
|
|
* - `GET /api/reboot-restore`: what is on offer, ownership-scoped
|
|
* - `POST /api/reboot-restore/restore`: rebuild some or all of it
|
|
* - `POST /api/reboot-restore/dismiss`: drop the offer
|
|
*
|
|
* A click, not the heuristic, is what creates panes. The heuristic only decides
|
|
* whether the banner appears, so a wrong yes costs a line of text the user
|
|
* dismisses rather than N CLI processes nobody asked for.
|
|
*
|
|
* Rebuilding is take-then-build: entries leave the plan synchronously at the top
|
|
* of the route, before the first `await`, and the whole route is single-flighted,
|
|
* so a double-click or two devices cannot put two panes on one conversation.
|
|
* Three things are re-checked at click time rather than trusted from boot: the
|
|
* owner's privilege grant, the workspace still being on disk, and the
|
|
* conversation not already being live because the user resumed it by hand.
|
|
*
|
|
* A rebuilt session comes back attached, idle and disarmed. Respawn controllers
|
|
* and Ralph loops are deliberately not re-armed, and its terminal scrollback is
|
|
* gone, because the pane is new. The banner says so.
|
|
*/
|
|
|
|
import { FastifyInstance } from 'fastify';
|
|
import { existsSync } from 'node:fs';
|
|
import { ApiErrorCode, createErrorResponse, getErrorMessage } from '../../types.js';
|
|
import { RebootRestoreRequestSchema } from '../schemas.js';
|
|
import {
|
|
parseBody,
|
|
getAuthUser,
|
|
canAccessOwned,
|
|
ownerFor,
|
|
isWorkingDirAllowedForUsername,
|
|
sessionCapacityMessage,
|
|
} from '../route-helpers.js';
|
|
import { rebootRestoreRegistry } from '../reboot-restore-registry.js';
|
|
import { rejectAlreadyLive, type RebootRestoreEntry, type RebootRestoreRejection } from '../../reboot-restore.js';
|
|
import { clampEnvOverridesForOwner } from '../../session-env-clamp.js';
|
|
import { Session } from '../../session.js';
|
|
import { resolveClaudeModeForUsername } from '../../user-store.js';
|
|
import { getCli } from '../../config/cli-registry/registry.js';
|
|
import { applyWorkspaceHooks, seedAgentSessionPreamble } from '../../hooks-config.js';
|
|
import { getLifecycleLog } from '../../session-lifecycle-log.js';
|
|
import { STATS_COLLECTION_INTERVAL_MS } from '../../config/server-timing.js';
|
|
import { SseEvent } from '../sse-events.js';
|
|
import type { SessionAttachmentHistoryItem } from '../../types.js';
|
|
import type { SessionPort, EventPort, ConfigPort, InfraPort } from '../ports/index.js';
|
|
|
|
type RebootRestoreCtx = SessionPort & EventPort & ConfigPort & InfraPort;
|
|
|
|
/** The banner's view of one restorable session. The record itself never leaves the server. */
|
|
function toBannerItem(entry: RebootRestoreEntry) {
|
|
return {
|
|
id: entry.sessionId,
|
|
name: entry.name,
|
|
workingDir: entry.workingDir,
|
|
mode: entry.mode,
|
|
owner: entry.owner,
|
|
};
|
|
}
|
|
|
|
export function registerRebootRestoreRoutes(app: FastifyInstance, ctx: RebootRestoreCtx): void {
|
|
const accessorFor = (req: Parameters<typeof getAuthUser>[0]) => {
|
|
const user = getAuthUser(req);
|
|
return (owner: string | undefined) => canAccessOwned(user, owner);
|
|
};
|
|
|
|
// ========== What is on offer ==========
|
|
|
|
app.get('/api/reboot-restore', async (req) => {
|
|
const entries = rebootRestoreRegistry.list(accessorFor(req));
|
|
return {
|
|
sessions: entries.map(toBannerItem),
|
|
// Said plainly here so the banner never implies a full restore: the pane is
|
|
// new, so the conversation continues and the terminal history does not.
|
|
scrollbackRestored: false,
|
|
};
|
|
});
|
|
|
|
// ========== Spend it ==========
|
|
|
|
app.post('/api/reboot-restore/restore', async (req, reply) => {
|
|
const body = parseBody(RebootRestoreRequestSchema, req.body, 'Invalid reboot restore request');
|
|
const canAccess = accessorFor(req);
|
|
const owner = ownerFor(req);
|
|
|
|
// Take BEFORE the first await: a second click must find nothing to spend.
|
|
// The flight is per owner, because `take()` already guarantees two callers
|
|
// never receive the same entry, so one user's restore need not block another's.
|
|
if (!rebootRestoreRegistry.beginSpending(owner)) {
|
|
return reply.code(409).send(createErrorResponse(ApiErrorCode.CONFLICT, 'A reboot restore is already running'));
|
|
}
|
|
const taken = rebootRestoreRegistry.take(canAccess, body.sessionIds, owner);
|
|
// Entries nothing built a pane for, returned to the plan on every exit path
|
|
// including a throw. Without this a failure between here and the loop would
|
|
// spend the offer and rebuild nothing, and the plan cannot be rebuilt.
|
|
const unspent = new Set(taken);
|
|
|
|
try {
|
|
if (taken.length === 0) return { restored: [], skipped: [] };
|
|
|
|
// The plan was built at boot and the board has moved on since. A conversation
|
|
// the user resumed by hand from the Resume list is already on screen, and a
|
|
// second pane on it would fight the first for the same transcript. This one
|
|
// is never re-offered: unlike a missing workspace, it cannot stop being true.
|
|
// Read fresh each time rather than snapshotted once: the loop below awaits a
|
|
// real `startInteractive()` per entry, so by the tenth entry a snapshot taken
|
|
// here is tens of seconds old, and a conversation the user resumed by hand in
|
|
// that window would be invisible to it.
|
|
const liveSessionIds = () => new Set(ctx.sessions.keys());
|
|
const liveConversationIds = () =>
|
|
new Set(
|
|
[...ctx.sessions.values()].map((session) => session.claudeSessionId).filter((id): id is string => !!id)
|
|
);
|
|
const { restore, skipped } = rejectAlreadyLive(taken, liveSessionIds(), liveConversationIds());
|
|
for (const entry of taken) {
|
|
if (skipped.some((s) => s.sessionId === entry.sessionId)) unspent.delete(entry);
|
|
}
|
|
|
|
const restored: ReturnType<typeof toBannerItem>[] = [];
|
|
const failures: RebootRestoreRejection[] = [...skipped];
|
|
const workspaceHooksEnabled = await ctx.getWorkspaceHooksEnabled();
|
|
|
|
for (const entry of restore) {
|
|
// The already-live check, re-run against the board as it is NOW. The pass
|
|
// above decided the batch; this catches a conversation that went live while
|
|
// an earlier entry in this same batch was starting. Spent rather than
|
|
// returned to the plan, for the same reason as the batch pass: unlike a
|
|
// missing workspace or a withdrawn grant, an open conversation is not a
|
|
// condition that stops being true.
|
|
const [lateLive] = rejectAlreadyLive([entry], liveSessionIds(), liveConversationIds()).skipped;
|
|
if (lateLive) {
|
|
failures.push(lateLive);
|
|
unspent.delete(entry);
|
|
continue;
|
|
}
|
|
// Capacity is re-checked per iteration, because this loop is itself
|
|
// creating the sessions it counts. The offer can be a day old, so the
|
|
// board may be fuller now than the plan assumed.
|
|
const capMsg = sessionCapacityMessage(ctx.sessions, entry.owner);
|
|
if (capMsg) {
|
|
failures.push({ sessionId: entry.sessionId, reason: 'capacity-reached' });
|
|
continue;
|
|
}
|
|
// A repo can be deleted between the boot that planned this and the click.
|
|
if (!existsSync(entry.workingDir)) {
|
|
failures.push({ sessionId: entry.sessionId, reason: 'workspace-missing' });
|
|
continue;
|
|
}
|
|
// Multi-user workspace separation: the create route confines a non-admin's
|
|
// workingDir to their own case space, and a grant can be withdrawn between
|
|
// the session's creation and this restore, so the confinement is re-run
|
|
// rather than inherited from the record. Keyed on the OWNER, not on the
|
|
// caller: an admin spending another user's entry must be held to that
|
|
// user's confinement, and `isWorkingDirAllowed` would wave an admin
|
|
// through. The same reason the two grant re-checks below read
|
|
// `saved.owner`.
|
|
if (!(await isWorkingDirAllowedForUsername(entry.owner, entry.workingDir))) {
|
|
// Left on offer: a withdrawn grant can be restored, unlike an already-open
|
|
// conversation, so this is not the permanent kind of refusal.
|
|
failures.push({ sessionId: entry.sessionId, reason: 'workspace-forbidden' });
|
|
continue;
|
|
}
|
|
try {
|
|
const saved = entry.state;
|
|
const claudeModeConfig = await ctx.getClaudeModeConfig();
|
|
const session = new Session({
|
|
// The old id is reused on purpose: a pinned record, subagent parents,
|
|
// window states and the lifecycle log all key off it, and the unpinned
|
|
// record is gone, so there is nothing to collide with.
|
|
id: saved.id,
|
|
workingDir: saved.workingDir,
|
|
mode: saved.mode,
|
|
name: saved.name,
|
|
// Without this the constructor re-infers ownership from the name, so a
|
|
// session the user renamed by hand to something shaped like `w<n>-<case>`
|
|
// comes back as `placeholder` and auto-naming overwrites their name on
|
|
// the next prompt. The route persists below, so the loss would go to
|
|
// disk. `restoreMuxSessions()` passes it for the same reason.
|
|
nameSource: saved.nameSource,
|
|
createdAt: saved.createdAt,
|
|
mux: ctx.mux,
|
|
useMux: true,
|
|
// No `muxSession`: the reboot took the pane with it, so `startInteractive()`
|
|
// takes its create branch and makes a fresh one.
|
|
claudeMode: await resolveClaudeModeForUsername(claudeModeConfig.claudeMode, saved.owner),
|
|
allowedTools: claudeModeConfig.allowedTools,
|
|
resumeSessionId: entry.resumeConversationId,
|
|
// Re-resolved against the owner's CURRENT grant, never replayed from the
|
|
// record: a grant held when the record was written may be gone now.
|
|
envOverrides: await clampEnvOverridesForOwner(
|
|
saved.owner,
|
|
(saved as { __envOverrides?: Record<string, string> }).__envOverrides
|
|
),
|
|
effort: saved.effort,
|
|
attachmentHistory:
|
|
(saved as { __attachmentHistory?: SessionAttachmentHistoryItem[] }).__attachmentHistory ??
|
|
saved.attachmentHistory,
|
|
lastSubmitAt: saved.lastSubmitAt,
|
|
claudeSessionChain: saved.claudeSessionChain,
|
|
lastActivityAt: saved.lastActivityAt,
|
|
owner: saved.owner,
|
|
parentSessionId: saved.parentSessionId,
|
|
});
|
|
|
|
await ctx.addSession(session);
|
|
// Before the listeners, because setupSessionListeners() reads the
|
|
// image-watcher flag this phase restores; before the spawn, because the
|
|
// custom-model environment and the nice priority shape the process.
|
|
await ctx.reapplyPersistedSessionState(session, saved, 'before-spawn');
|
|
await ctx.setupSessionListeners(session);
|
|
await session.startInteractive();
|
|
// The session's own history, applied only once the pane exists: on a
|
|
// failed start these totals would belong to a session that never ran.
|
|
// Both halves precede the route's OWN persist, which matters because a
|
|
// constructed session carries none of this and `toState()` is written
|
|
// wholesale, so persisting first would replace the fuller record with
|
|
// the reduced one and drop the pin that keeps it from being pruned. A
|
|
// listener-driven persist can still land inside the debounce window
|
|
// while the pane starts; the write below repairs the record.
|
|
// `rearmAutoResumeSchedule: false`: the saved stamp predates the reboot and
|
|
// the pane is new, so honouring it would have every restored session type
|
|
// `continue` into itself about a minute after one click. Auto-resume stays
|
|
// enabled and re-arms on the next real limit message. This is also what the
|
|
// module header promises ("comes back attached, idle and disarmed").
|
|
await ctx.reapplyPersistedSessionState(session, saved, 'after-spawn', {
|
|
rearmAutoResumeSchedule: false,
|
|
});
|
|
ctx.persistSessionState(session);
|
|
|
|
// A session without its workspace hooks goes silently blind: no stop or
|
|
// idle events for respawn, no Approvals Inbox item, no red tab on a
|
|
// blocking dialog. The boot-time sweep finished hours ago, so the click
|
|
// path installs them itself. `hooks: 'always'` is the capability that says
|
|
// this CLI installs Codeman's hooks into the workspace.
|
|
if (workspaceHooksEnabled && getCli(session.mode)?.capabilities.hooks === 'always') {
|
|
await applyWorkspaceHooks(session.workingDir, true).catch((err: unknown) =>
|
|
console.warn(`[reboot-restore] hook install failed for ${session.workingDir}: ${getErrorMessage(err)}`)
|
|
);
|
|
}
|
|
|
|
// Both create paths seed this; without it a restored claude session's agent
|
|
// skill falls back to writing out the whole ~150-line §0 preamble. Remote and
|
|
// docker sessions never reach here (the plan rejects them as
|
|
// `remote-or-docker`), so the local-only condition is structural.
|
|
if (getCli(session.mode)?.capabilities.agentSkillInjection && (await ctx.getAgentSkillEnabled())) {
|
|
await seedAgentSessionPreamble(session.id).catch((err: unknown) =>
|
|
console.warn(`[agent-skill] preamble seed failed for ${session.id}: ${getErrorMessage(err)}`)
|
|
);
|
|
}
|
|
|
|
getLifecycleLog().log({ event: 'recovered', sessionId: session.id, name: session.name });
|
|
// Every other open tab and phone needs this; the clicking tab already has
|
|
// the response, and the client's handler is an idempotent upsert.
|
|
ctx.broadcast(SseEvent.SessionCreated, ctx.getSessionStateWithRespawn(session));
|
|
restored.push(toBannerItem(entry));
|
|
} catch (err) {
|
|
// One entry that will not start must not stop the rest of the pass, and
|
|
// must not leave a registered session with no pane behind it: by this
|
|
// point the session is in `ctx.sessions`, holds a tab-layout slot and has
|
|
// listeners.
|
|
//
|
|
// Reaching this is rarer than it looks, measured against a real server:
|
|
// the CLI resolver finds its binary by absolute path rather than through
|
|
// PATH, and tmux falls back to another directory rather than failing when
|
|
// it cannot enter the workspace, so neither of the two obvious "freshly
|
|
// booted machine" failures throws. What is left is the mux layer itself
|
|
// failing, which is why this path is defended rather than expected.
|
|
console.error(`[reboot-restore] failed to rebuild ${entry.sessionId}:`, err);
|
|
// Not cleanupSession(): that is the user-initiated delete, and it would
|
|
// count this session's historical tokens into the lifetime totals, demote
|
|
// a pinned record to `stopped` (which this pass reads as an intentional
|
|
// kill, making the session permanently unrestorable) and delete the
|
|
// workspace's `.claude-images`. This undoes only the construction.
|
|
await ctx
|
|
.discardPartiallyBuiltSession(entry.sessionId)
|
|
.catch((discardErr: unknown) =>
|
|
console.error(`[reboot-restore] discarding a failed rebuild failed: ${getErrorMessage(discardErr)}`)
|
|
);
|
|
failures.push({ sessionId: entry.sessionId, reason: 'rebuild-failed' });
|
|
// Left on offer: the user can put the binary back and click again.
|
|
continue;
|
|
}
|
|
unspent.delete(entry);
|
|
}
|
|
|
|
if (restored.length > 0) {
|
|
// A reboot leaves recovery with nothing alive to find, so its own block never
|
|
// started the stats collector. This clears and re-arms its interval, so it is
|
|
// safe to call whether or not the collector is already running.
|
|
ctx.mux.startStatsCollection(STATS_COLLECTION_INTERVAL_MS);
|
|
}
|
|
|
|
return { restored, skipped: failures };
|
|
} finally {
|
|
// Anything that never became a pane goes back on offer, including after a
|
|
// throw, so a transient failure costs a retry rather than the whole plan.
|
|
// Ends the flight: entries still parked for it come back if they are in
|
|
// `unspent`, and a Dismiss that unparked them meanwhile wins.
|
|
rebootRestoreRegistry.releaseFlight(owner, [...unspent]);
|
|
rebootRestoreRegistry.endSpending(owner);
|
|
}
|
|
});
|
|
|
|
// ========== Drop it ==========
|
|
|
|
app.post('/api/reboot-restore/dismiss', async (req) => {
|
|
const dismissed = rebootRestoreRegistry.clear(accessorFor(req));
|
|
return { dismissed };
|
|
});
|
|
}
|