Compare commits

..
29 Commits
Author SHA1 Message Date
eabbd3d97c Show a Codex message canceled before it starts as canceled, not as a startup error (#9931)
* fix(server): treat canceled Codex starts as interruptions

* fix(server): report a replaced pending start as undelivered to its sender

waitForAgentRunStart followed the agent rather than the sender's run, so a
send canceled by a replacement before reaching Codex resolved once the
replacement started. Keep the sender's own pending run and reject when it is
cleared before its turn starts.

The canceled-start tests drain streamAgent, because a fresh Codex agent has no
session handle before its first turn (#8393).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(server): keep a sender's start wait across a stale-session retry

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* test(server): expect the start options passed to a foreground run

Session create and scheduled prompts now pass the sender's start options,
so the two call-argument assertions include them.

Co-authored-by: 3ae3ae <3ae3ae@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(server): keep a Codex message canceled before it starts in history

A Stop or replacing send during Codex preparation settled the run as
canceled without recording the sender's prompt, so the message vanished
from history after a reload and on other clients. Record it as a
rejected attempt, as the start-failure branch already does, so it stays
in history without being delivered.

Co-authored-by: 3ae3ae <3ae3ae@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(server): return each send's start from dispatch

A send waited for its turn by looking up the agent's pending run when the
wait began. When a provider plugin's session was stale, the first start
failed and its run was cleared before the sender started waiting, so the
send rejected with "has no pending run" while the retry answered it.

startAgentRun now returns the start of the prompt it dispatched. Every run
created for that prompt, including the stale-session retry, is bound to
it, so the send resolves when its own turn starts and rejects when its own
run ends unstarted. This replaces the retry hand-off between runs in the
agent manager.

Co-authored-by: 3ae3ae <3ae3ae@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: 3ae3ae <ogyshjsm@naver.com>
Co-authored-by: Bae Seongmin <83870598+3ae3ae@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: bot <bot@localhost>
Co-authored-by: paseo-bot[bot] <paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: 3ae3ae <3ae3ae@users.noreply.github.com>
Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
2026-11-17 05:11:25 +00:00
paseo-ai[bot] 0bac18f359 fix: update lockfile signatures and Nix hash [skip ci] 2026-11-17 04:02:57 +00:00
Mohamed Boudra 3eedffc4ac fix(claude): keep the user's ask rules and hooks in Bypass (#9927)
In Bypass, Claude agents again show a permission card for asks from the user's permissions.ask rules (including managed policy), PreToolUse hooks that return ask, compound and piped commands that hit an ask rule, permissions.blockReadsOutsideWorkingDirectories, an organization's ask limit, and sandbox overrides. Claude's own checks are still approved without a card. Upgrades @anthropic-ai/claude-agent-sdk to 0.3.326, which passes the ask's source to canUseTool.

Closes #9916
2026-11-17 10:53:08 +07:00
Michael ThomasandMohamed Boudra e5352c9890 fix: size controls by the primary pointer, not any touch screen (#9909)
* feat(desktop): size controls by the primary pointer, not any touch screen

The desktop app gave touch-sized controls to every machine with a touch
screen, including Windows laptops driven by a trackpad. In Electron, ask
whether a mouse-like primary pointer drives the UI instead: Chromium
reports a fine primary pointer for those laptops and a coarse one for a
tablet with no mouse or trackpad attached.

Browsers and native keep the touch-screen check, so an iPad keeps touch
sizes with a trackpad attached. Swipe gestures still follow the
touch-screen capability.

Refs #9892

* feat(app): size controls by the primary pointer on every platform

Replace the Electron-only check with one rule everywhere: touch-sized
when touch is the primary input, `(pointer: coarse)`, rather than when a
touch screen exists at all. WebKit keeps touch primary on an iPad with a
trackpad attached, so iPad Safari stays touch-sized; Chromium reports a
fine primary pointer for a touch-screen laptop driven by its trackpad, in
the browser and the desktop app. Native is always touch-sized.

`hasTouchScreen()` and its `maxTouchPoints` fallback had no other caller
and are removed. Swipe gestures still follow the touch-screen capability.

Refs #9892

* test(app): exercise pointer sizing through the media source

* test(app): cover touch laptops with a primary pointer

---------

Co-authored-by: Mohamed Boudra <boudra.moha@gmail.com>
2026-11-17 10:48:34 +07:00
ce09360241 fix(server): agents archived while not loaded get the archive time as their last update (#9926)
* fix(server): move updatedAt when archiving an agent that is only in storage

Archiving a loaded agent sets its updatedAt to the archive time
(markRecordArchived). Archiving an agent that is only in storage, which
is also how a parent's archive reaches its children, kept the old
updatedAt. Lists sorted by updated_at, such as History, then left a
just-archived agent where its last turn put it, sometimes days back, and
clients paging such a list by time never reached it.

archiveSnapshotUnlocked now records the archive time as updatedAt too.

Co-authored-by: RoundRedDot <roundreddot@gmail.com>

* fix(server): keep updatedAt from moving back when an archive is restored

Archiving a stored-only agent now sets updatedAt to the archive time.
When the archive time is earlier than the record's updatedAt, as when a
failed send or resume puts an agent's original archive back after
unarchiving it, updatedAt stays where it is. Clients drop agent updates
that are older than the one they hold, so moving it back left them
showing the agent active.

Co-authored-by: luke <luopeihuan@gmail.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(server): keep updatedAt from moving back when a loaded agent's archive is restored

The rule that archiving never moves updatedAt backwards now lives in
buildArchivedAgentRecord, which both archive paths use. A failed send
that resumed the agent before a later loading step failed puts its
original archive back through the loaded path, which had the same
backwards move.

The workspace archive stamp test now uses stamps taken after the
agents' activity, as real archive stamps are.

Co-authored-by: luke <luopeihuan@gmail.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* refactor(server): require the archive time when building an archived agent

buildArchivedAgentRecord no longer accepts an archive that leaves
updatedAt unset, the gap #9920 came through, and its tests now assert
the rule: a later archive time moves updatedAt, an earlier one keeps it.

Co-authored-by: luke <luopeihuan@gmail.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: luke <luopeihuan@gmail.com>
Co-authored-by: RoundRedDot <roundreddot@gmail.com>
Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 02:55:35 +00:00
paseo-bot[bot]andClaude Opus 5.5 8f3752ecb9 test(app): wait for a label filter row to be laid out before measuring it (#9922)
The workspace-labels journey measured the Urgent filter row right after
opening the label filter page. While the page is still coming in, the
row has no box yet, and the measuring helper threw inside expect.poll,
which ends the poll instead of retrying it. An element with no box now
counts as not settled, and the helper returns the box it settled on
instead of measuring a second time.

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 00:36:12 +00:00
73c22f7917 Keep desktop workspaces reachable when sidebar navigation overflows (#9903)
* fix(app): keep desktop workspaces reachable when sidebar navigation overflows

Apply the mobile cap from #8727 to DesktopSidebar: the navigation rows
scroll inside a viewport capped at half the sidebar, so plugin rows no
longer push the Workspaces list out of a short window. The viewport sits
outside the titlebar drag area and opts out of app regions, since
Electron does not clip app-region rects to scroll viewports.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(app): keep the sidebar drag strip on Windows and Linux

Moving the desktop navigation rows into a scroll viewport left the
sidebar's drag overlay in an empty container when the window controls
sit top-right, so Windows and Linux lost every window-drag surface in
the sidebar. The strip above the navigation now carries the drag
overlay there, and the rows start flush below it.

Refs #9872

Co-authored-by: Alex Tong <alex.tong@pentatonic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* refactor(app): share the window-content marker from the drag-region module

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* refactor(app): share one nav scroller between the mobile and desktop sidebars

The desktop sidebar's capped nav viewport was a plain ScrollView on every
platform, so on tablets it did not join the overlay's close swipe the way
the mobile nav block and the workspace list do. Both sidebars now render
SidebarNavScroll, which owns the 50% cap, the native gesture-handler
branch linked to the close gesture, the divider, and the web
window-content marker.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(app): drop the empty nav divider and drag strip when every top item is hidden

With every top navigation item turned off, the desktop sidebar now starts
at the Workspaces section again, as on main: no 1px divider and no 8px
drag strip above it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Alex Tong <alex.tong@pentatonic.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
2026-11-16 23:59:03 +00:00
paseo-bot[bot]andClaude Opus 5.5 038a9ca00d fix(opencode): clear a question that a new message replaces (#9891)
With the default send setting, a message sent while an OpenCode agent
waits on a question steers the turn, and Paseo rejects the question in
OpenCode. The OpenCode session dropped the question from its own list
without reporting it resolved, so the agent manager and the app kept
showing it. Answering or dismissing it then failed with "No pending
permission request", and the prompt could not be closed.

The session now reports permission_resolved whenever OpenCode accepts a
reply, rejection, or answer, as the other providers do.

Fixes #9879

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 19:03:40 +00:00
paseo-bot[bot]andClaude Opus 5.5 3a7e216b7d test(server): read the latest event when checking a removed file on macOS (#9898)
macOS FSEvents can replay the file's pre-subscription write as a create
after the observer starts. The test read the first event for the path,
so it stayed on that create after the delete arrived in a later batch.

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 18:45:26 +00:00
paseo-bot[bot]andClaude Opus 5.5 6ef188416f test(e2e): start the plugin modal settle check once the sheet is in view (#9889)
The compact sheet holds below the viewport for a few frames before it
slides up. On a slow runner two settle reads 100 ms apart can both land
in that hold. Waiting for the title to enter the viewport first means the
settle check only starts once the slide has begun.

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 18:04:29 +00:00
791bbd3596 fix(app): keep preview tab identities unique across split panes (#9888)
* fix(app): keep preview tab identities unique across split panes

Reserve existing pane and sheet IDs when allocating a new instance, including tabs opened by reconciliation. Keep menu-hosted sheet identities stable across layout changes.

Repair duplicate IDs in saved layouts without discarding tabs, state, or pane focus. Resolve file navigation by target rather than an ID retained from a previous preview.

* fix(app): open a listed subagent as its own agent tab

A subagent opened in place of the compact subagent list got a random
instance id, so "Open as tab" created a tab that no longer carried the
subagent's agent tab id. The in-place sheet now starts from the
subagent's own tab id, still checked against occupied ids and kept
stable across layout updates.

Co-authored-by: Kosmo CHE <108672813+KosmoCHE@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Kosmo CHE <kosmoche@gmail.com>
Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Kosmo CHE <108672813+KosmoCHE@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 18:04:19 +00:00
Angus Buick b95f1bbf31 fix(app): draw the Add host text fields as inputs again (#9864) (#9865)
AdaptiveTextInput wraps its input with withUnistyles, and the pairing link and direct connection modals wrapped AdaptiveTextInput a second time. On web each wrapper is a display: contents element whose style lands on its direct child, so the outer style landed on the inner wrapper and the input lost its border, background and padding.

Drop the outer wrapper, AdaptiveTextInput already themes the placeholder colour. Also give the host password field a placeholder and focus it when pairing asks for a password.
2026-11-16 16:58:48 +00:00
paseo-bot[bot]andClaude Opus 5.5 c2a24ae81e test(e2e): wait for a plugin modal sheet to settle before using the pointer (#9884)
On compact layouts the sheet holds below the viewport and then slides up,
so the Horizontal tab hover could resolve its point mid-slide and the wheel
landed on the rows below the tabs. openExample now waits for the title to
stop moving.

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 15:48:36 +00:00
paseo-bot[bot] 6eb94611b3 test(e2e): wait for the isolated daemon itself, not any listener on its port (#9863)
* test(e2e): wait for the isolated daemon itself, not any listener on its port

The helper reserves a port, releases it, and starts the daemon on it. If
another process takes the port in between, the daemon exits with
EADDRINUSE, but the readiness probe already succeeded against the other
listener. The worker fixture then reported the daemon as started and its
seed client retried a dead endpoint until the 60s fixture timeout.

Readiness now requires /api/status on the port to report this daemon's
server id, so the probe keeps waiting, sees the EADDRINUSE exit, and the
existing retry moves to a fresh port.

* test(e2e): authenticate the readiness probe with the daemon's local credential

A password with spaces cannot travel as an HTTP bearer, so the status
probe of a password-protected daemon stayed 401. The daemon writes a
local credential into its home before listening and /api/status accepts
it, as the CLI's local status does.

---------

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
2026-11-16 15:03:02 +00:00
Okan YILDIRIM a8cadae0ee fix(app): keep saved hosts when one entry can't be read (#9847)
The host registry was parsed with a strict array schema, so one host or
connection this build couldn't read failed the whole array. The loader then
removed @paseo:daemon-registry, and every saved host and password with it.
That happens after a downgrade, or once a newer build saves a connection kind
this build doesn't know.

- Hosts and connections are read one at a time. One this build can't read
  is skipped, and the other hosts load.
- Skipped entries are written back on every save, so the build that wrote
  them still finds them. Removing a host also drops what this build couldn't
  read for it.
- A value that isn't a JSON array is copied to
  @paseo:daemon-registry:unreadable instead of being removed.
- The stored-password migration still moves a connection password to its
  host when that host also has an unreadable connection.
2026-11-16 14:01:03 +00:00
5a78c1cd16 Let idle cleanup release Codex chats opened only to read history (#9859)
A Codex session opened to read history reads the thread and disposes its
app-server right away, but canStopRuntime() vetoed it because it had no
client. Idle cleanup then kept every such chat loaded in the daemon.

Closes #9804

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Spencer Shulem <1703265+Spshulem@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 13:01:00 +00:00
paseo-bot[bot]anddaysun-k 8522d18ed8 Keep Claude signed in when model discovery runs during a token refresh (#9855)
* Let Claude model discovery finish a token refresh instead of killing it

Model discovery stopped waiting after 5 s by aborting the SDK query and
tree-killing the CLI. A CLI that is still refreshing an expired OAuth
token at that moment has already rotated the refresh token, so the kill
leaves only the revoked token on disk and logs the user out.

The 5 s limit now only bounds the wait. A CLI that has not answered gets
its input ended and exits on its own; it is tree-killed only after a
60 s grace period or when the daemon shuts down.

Fixes #9314

* fix(server): let Claude model discovery finish a token refresh after it answers

Claude Code answers the model list before its startup token refresh has
saved the rotated refresh token. Discovery killed the CLI right after the
answer, so a refresh still in flight left the revoked token on disk and
every later Claude session failed until /login. Discovery now ends the
CLI's input and lets it exit on its own whether or not it answered, with
the existing grace period and shutdown kill as the bound.

Co-authored-by: daysun-k <8309193+daysun-k@users.noreply.github.com>

---------

Co-authored-by: daysun-k <8309193+daysun-k@users.noreply.github.com>
Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
2026-11-16 12:04:46 +00:00
paseo-bot[bot]andClaude Opus 5.5 be92e85a4e fix(server): return only the newest reply as the last message after a restart (#9846)
After a daemon restart, an agent's timeline is rebuilt from provider
history, and those rows have no turn id. A reply the agent starts on its
own, such as Claude waking after a background subagent, follows the
previous reply with no user message between them, so the last assistant
message lookup joined the two and wait results and finish notifications
returned the old reply with the new one appended.

The timeline projection already treats a message id change as a new
message. Share that rule with the lookup, so both decide which rows are
chunks of one message the same way.

Closes #9814

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 11:02:51 +00:00
Mohamed Boudra 3d30aaec42 Allow plugins to append agent instructions (#9781)
* feat(plugins): append agent instructions on session open

Recompute plugin instructions for each launch so changes apply on reopen without changing saved agent configuration.

* test(providers): verify plugin instructions on reopen

* fix(codex): refresh instructions from restored collaboration mode

A resumed thread can retain its prior collaboration instructions when the mode catalog is unavailable. Rebuild those instructions from the current launch before the next turn.

* fix(plugins): keep launch instructions out of agent records

Provider persistence handles can contain launch configuration. Strip transient instructions before saving and projecting handles.

* fix(codex): preserve built-in collaboration instructions

Pass agent instructions through the thread configuration so Codex can apply its own Plan and Default mode instructions.

* fix(opencode): preserve instructions when reading history

History-only opens do not apply current plugin contributions, so they must not clear the native session instruction entry.

* fix(codex): retain instructions after rewinding

A rewind forks the native thread, which does not inherit its parent launch instructions. Pass the current instructions to the fork.

* Deliver updated instructions to Codex threads

* Cover Codex snapshots after rewind

* Persist provider state when reopening agents

* Limit resume persistence refresh to providers that need it
2026-11-16 17:10:14 +07:00
a302e65c85 fix(omp): show model names with slashes and underscores in full (#9836)
OMP model labels were built as `${provider}/${name}` and then cut at the
last `/`, so a free-text name such as "... ~60-70 tok/s on 0.2.10, 52/56)"
showed as "56)". Underscores were rewritten to spaces ("IQ3_S" -> "IQ3 S"),
and a colon inside the name cut everything before it.

Pi had the same bug, fixed in #9823. Move that label rule into a shared
model-label module and use it for both providers: free-text names are
kept, path-like names are shortened to their last segment, and a
"Vendor: " prefix is dropped only when it is a prefix.

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Rahul Sharma <19687913+rms523@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 09:54:34 +00:00
paseo-bot[bot] d49991318f fix(server): see same-size edits saved in the tick a file was staged (#9854)
The private index snapshot behind index and All changes comparisons was a
fresh copy, newer than every entry, so Git skipped its same-timestamp
content check and a same-size save made right after staging read as
unchanged. The copy now keeps the source index's mtime, rounded down to
the second.

Closes #9827

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
2026-11-16 09:48:23 +00:00
33259746db Stop timed-out watcher setups from rescanning large repos every 5 minutes (#9828)
* fix(server): abort timed-out watcher setups and back off their retries

A watcher subscription that missed WORKSPACE_GIT_WATCHER_SUBSCRIBE_TIMEOUT_MS
was abandoned but its startup scan kept walking the tree to completion, and
recovery retried every five minutes forever, repeating the full scan each
time. On a CPU-starved host that kept dozens of directories rescanning.

- FileObserver.subscribe accepts an abort signal that stops the startup scan
  and rejects; WorkspaceGit aborts setups at the deadline and on dispose.
- Consecutive setup timeouts extend the recovery delay past the 5-minute
  ladder cap, doubling up to one hour; an accepted subscription resets it.
  Degraded polling keeps its 5-60 s cadence meanwhile.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(file-observer): keep an aborted observation's backend from starting

Aborting a subscription closes its observation, which can happen while
start() is still reading the root. The backend then started after its close
had finished, and the native backend opened a root watcher that nothing
would close.

Co-authored-by: Spencer Shulem <1703265+Spshulem@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* test(file-observer): abort a subscription mid-scan in the abort test

The test aborted before the backend started, so it passed with the abort
listener removed. A tree past the Linux directory limit makes a scan that
keeps walking fail on the limit instead of rejecting with the reason.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Spencer Shulem <spshulem@gmail.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Spencer Shulem <1703265+Spshulem@users.noreply.github.com>
2026-11-16 09:10:01 +00:00
Mohamed Boudra 41c294c785 Queue agent messages until the current turn ends (#9757)
* fix(server): queue agent messages until the current turn ends

Steering refusal could replace a running turn and cancel compaction. Hold agent-originated messages and notifications together until the recipient settles, retaining explicit interruption and acknowledging finish subscriptions only after dispatch succeeds.

* fix(server): wake queued delivery at turn and permission checkpoints

A pending follow-up must not hide the permission needed to finish the current turn. Wake ready batches on recipient state changes, let completion waits report permission checkpoints, and preserve admission order and session-mode boundaries when busy dispatches retry.

* fix(server): publish autonomous readiness after run settlement

Idle snapshots emitted while the autonomous run record still existed could not wake queued delivery. Publish terminal state after clearing that run, and keep already debounced busy retries ready for the next turn boundary.

* fix(server): apply queued modes only after run admission

Preparing a later mode group could change the running turn before busy admission rejected it. Carry the requested mode into the reserved run and apply it immediately before provider startup, leaving earlier and concurrently started turns untouched.

* fix(server): keep later mode groups queued until turn end

Dispatching every mode group at once prepared later modes against the preceding turn. Keep later groups pending and reject busy sends before changing mode, leaving mode validation outside run startup.

* fix(server): deliver provider commands during queued turns

Offer waiting messages individually through the provider-owned out-of-band path while a recipient runs. Recognized commands retain their existing behavior, while ordinary messages keep waiting without starting their dispatch observers.

* fix(server): offer queued commands once while running

Remember provider declines so timer retries do not repeat side effects or reinterpret a waiting message after provider state changes.

* fix(server): defer commands that request a session mode

An explicit mode belongs to a later turn. Keep those commands on the normal idle dispatch path so an out-of-band offer cannot ignore the requested mode or change the running turn.
2026-11-16 16:02:47 +07:00
Mohamed Boudra e19980a6c9 Dismiss chat errors and identify timed-out requests (#9837)
* fix(app): dismiss chat errors and identify timed-out requests

* test(client): assert subscription timeout codes

* refactor(app): keep toast errors on the existing string boundary

* test(app): remove redundant toast duration coverage
2026-11-16 15:06:24 +07:00
paseo-bot[bot] fa8ba1bd3b test(terminal): wait for the live worker's socket before reaping (#9835)
The reaper signals a worker only after its socket accepts. The two
"cannot be opened for a moment" tests spawned a listening worker and
reaped without waiting for the listen, so on a loaded runner the reaper
found no socket, left the worker alive, and the test failed after
waitUntilGone's 5s deadline. Spawn the worker through a helper that
resolves once the socket is listening, as the other socket tests in
this file already do.

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
2026-11-16 06:46:25 +00:00
Mohamed Boudra e7e1b44ec8 chore(release): reconcile 0.16.0 metadata into main (#9833) 2026-11-16 13:10:33 +07:00
paseo-bot[bot]andClaude Opus 5.5 ee3a3ba8c5 test(app): pick a new port when an isolated daemon loses its reserved one (#9815)
The isolated host daemon helper reserves a port, releases it, and passes
it to the daemon. Another process can bind it in between, and the daemon
exits with EADDRINUSE. That failed a Playwright worker's own daemon in
the e2eWorker fixture. The first start now reserves a fresh port and
starts again when the daemon reports EADDRINUSE; restart() keeps the
endpoint the app already knows.

Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 06:03:13 +00:00
d15190803a Show Pi model names with slashes and underscores in full (#9823)
* fix(pi): keep slashes and underscores in model display names

Pi model labels were built as `${provider}/${name}` and then cut at the
last `/`, so a free-text name such as "... ~60-70 tok/s, 52/56)" was shown
as "56)". Underscores were also rewritten to spaces ("IQ3_S" -> "IQ3 S").
The compact model trigger in the app repeated the last-`/` cut.

Build the Pi label from the model's own `name`/`id`: shorten only
path-like values with no whitespace (OpenRouter reports names like
"google/gemini-2.5-flash-lite"), and keep free-text names intact. The
compact trigger now strips only a leading provider namespace.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* test(pi): cover model labels through the catalog and drop stale ACP copies

acp-agent.test.ts still imported transformPiModels, which the Pi label
fix removed, so its modelTransformer test and a stale copy of the old
Pi label tests failed. The modelTransformer test now supplies its own
transformer, and the Pi label cases run through fetchCatalog with the
reported model names instead of an exported helper.

Co-authored-by: Rahul Sharma <19687913+rms523@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(pi): keep colons inside free-text model names

The vendor-prefix strip cut a free-text Pi name at its first ": ", so
"Qwen3 IQ3_S (tail skip: on, 52/56)" showed as "on, 52/56)". Strip only
when the text before ": " has no parenthesis or comma, which keeps
OpenRouter's "Vendor: Model" names shortened.

Co-authored-by: Rahul Sharma <19687913+rms523@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Rahul Sharma <19687913+rms523@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: paseo-bot[bot] <266920839+paseo-bot[bot]@users.noreply.github.com>
2026-11-16 04:55:28 +00:00
Josh BendavidandClaude Opus 5.5 ade3817a45 fix(server): fall back to the next socket directory when the bind is refused (#9214)
A PASEO_HOME on AFS passes the socket directory checks, then refuses the
Unix socket bind with EPERM, and the terminal worker failed to start. The
worker now binds each eligible candidate in turn and moves on when the
filesystem refuses the socket (EPERM, EACCES, EOPNOTSUPP, ENOTSUP). Other
listen errors still fail the start.

Fixes #9213

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 03:56:04 +00:00
93 changed files with 4917 additions and 615 deletions
+3 -2
View File
@@ -150,12 +150,13 @@ Users can also detach an existing subagent from the subagents track. Detach is d
`notifyOnFinish` defaults to `true` for agent-scoped creation and prompt follow-ups because most delegated work needs to report back to the creating agent. Set it to `false` for explicit reporting or no completion callback.
Agent-originated messages and automatic notifications share a recipient-daemon delivery module. A queued receipt acknowledges admission before provider dispatch, allowing a child to report and finish in the same two-second quiet window. Human prompts dispatch directly. Conflicting explicit interruption or session-mode choices retain separate ordered dispatches.
Agent-originated messages and automatic notifications share a recipient-daemon delivery module. A queued receipt acknowledges admission before provider dispatch. Idle recipients retain the two-second quiet window. While a recipient has a running or starting turn (including compaction), messages stay queued across quiet windows and are delivered together after that turn settles, including failure or cancellation. A ready batch is released when the daemon observes the recipient settle; the two-second timer also retries it. Agent callers using `steer`, including the default, wait for the turn to end; only explicit `interrupt` replaces a running turn. An explicit interrupt or a command the provider accepts out of band runs before earlier queued messages. Those messages stay queued and are delivered after the running or replacement turn ends. Human prompts dispatch directly with their existing behavior. Conflicting session-mode choices retain separate ordered dispatches.
The pending message window is in memory. Clean shutdown flushes it before closing agents; an abrupt
crash can lose queued prompts. A durable send receipt remains pending until actual dispatch
acknowledgment, so a lost window never becomes a completed receipt. Completion waits cover queued
admission within their original timeout and cancellation scope.
admission within their original timeout and cancellation scope, and return permission checkpoints
while messages are waiting.
Finish notification intent has a separate daemon-owned lifetime. The finish-subscriptions module
persists caller, child, host, and ownership policy through an injectable store; its JSON adapter uses
+10
View File
@@ -590,6 +590,16 @@ bookkeeping may scan opaque row sizes during a deferred write, never during host
before a requested cache row can paint. The row store is not encrypted. A cached timeline can contain
source code, prompts, and tool output; encrypted-at-rest storage is a separate security decision.
### Saved hosts
**AsyncStorage key:** `@paseo:daemon-registry`, an array of host profiles.
Every app build on a device shares this key, including an older build after a downgrade and a newer
one that saves a connection kind this build doesn't know. The key holds every saved host and its
password, so never remove it. Read each host and connection on its own, skip the ones this build
can't read, and write them back on every save. A value that isn't a JSON array is copied to
`@paseo:daemon-registry:unreadable` before the next save overwrites it.
### Draft Store
**AsyncStorage key:** `paseo-drafts` (version 2)
+1 -1
View File
@@ -6,7 +6,7 @@ Do not replace the Linux implementation with `fs.watch({ recursive: true })`. No
Closing an observation must remain safe after its root is renamed or removed. Workspace archive removes owned worktrees while releasing observation references, so teardown cannot assume the watched path still exists.
`unsubscribe()` is an awaited barrier. Once it resolves, no scan, reconciliation, queued event, native handle, or callback may remain. `updateIgnore()` is the equivalent barrier for excluded paths: events queued below a newly excluded root cannot be delivered after it resolves. Treat path disappearance while scanning, attaching, or receiving a watcher error as rename/archive churn. Surface permission and resource errors so WorkspaceGit can enter bounded polling.
`unsubscribe()` is an awaited barrier. Once it resolves, no scan, reconciliation, queued event, native handle, or callback may remain. `updateIgnore()` is the equivalent barrier for excluded paths: events queued below a newly excluded root cannot be delivered after it resolves. Treat path disappearance while scanning, attaching, or receiving a watcher error as rename/archive churn. Surface permission and resource errors so WorkspaceGit can enter bounded polling. `subscribe()` accepts an abort signal; aborting it before it resolves stops the startup scan and rejects. WorkspaceGit aborts every subscription that misses its setup deadline, because an abandoned scan otherwise keeps walking the tree. A timed-out directory retries on the recovery ladder (30 seconds doubling to five minutes), and each consecutive timeout keeps doubling the delay up to one hour. Under sustained CPU load the next scan misses the deadline too, and each attempt repeats the full scan. An accepted subscription resets the timeout streak. Degraded polling keeps its own cadence throughout.
Linux topology repair is trailing-debounced and scoped to the renamed path. A file rename needs one classification stat; a new or moved directory scans only its subtree. Full-tree scans are reserved for startup and ignore-set replacement. A subscription reports changes after `subscribe()` resolves, not the files that already existed. macOS FSEvents can still replay writes made moments before the stream started. Consumers read their initial state after `subscribe()` resolves; WorkspaceGit re-reads its checkout once observation setup completes, because its first refresh runs in parallel with setup. The Linux startup scan therefore emits nothing; only a scoped reconciliation of new topology reports files found before their directory's watcher was installed. Startup creates made every cold diff compute and discard a first revision. Benchmark startup cost with pre-populated trees.
+1
View File
@@ -29,6 +29,7 @@ The worker writes `$PASEO_HOME/terminal-worker/<pid>.json` (owner-only) with its
- Workers never query their own birth time or command line. Readers accept legacy identity fields but ignore them. Daemons through 0.15.1 report new records unreadable and cannot adopt them.
- Windows terminal programs have no recorded birth time and terminal lifecycle operations never launch PowerShell. Linux and macOS retain program birth-time checks through `ps` with `LC_ALL=C`; Linux also walks sessions to find surviving jobs.
- Unix socket paths have a byte budget (103 on macOS, 107 on Linux). Long dev homes use an owner-only fallback under `$TMPDIR/paseo-<uid>/` or `/tmp/paseo-<uid>/`. An existing directory must be a real `0700` directory owned by you; a shared root is never chmodded.
- A home on a filesystem that refuses Unix sockets (AFS, some network mounts) passes those checks and then fails the bind with `EPERM`, `EACCES`, `EOPNOTSUPP` or `ENOTSUP`. The worker moves on to the next directory on those codes only; any other listen error fails the start. The record carries the path the worker bound, so nothing else recomputes it.
- A kill cleanup that cannot confirm every process gone writes `closing-<recordId>.json` beside the worker record. The worker rewrites its own record whenever a terminal starts or exits, so the kill intent has to live in a file it never writes. A closing record is never adopted; the next stop or start retries it.
- An unreadable record of either kind makes `daemon status` and a kill restart fail with its path: a kill cleanup that met it could not check what it names, and leaves nothing else behind. A read that fails with `EPERM`, `EBUSY` or `EACCES` is retried for 250ms first: on Windows, opening a record while the worker renames its new copy over it fails that way for a moment.
@@ -2,10 +2,16 @@ import { copyPluginExample } from "../support/helpers/plugin-fixture";
import { expect, test as base, type Page } from "../support/fixtures";
import { gotoAppShell } from "../support/helpers/app";
import { connectNewWorkspaceDaemonClient } from "../support/helpers/new-workspace";
import { waitForSettledPosition } from "../support/helpers/sheet-layout";
async function openExample(page: Page, example: string) {
await page.getByRole("button", { name: `Open ${example}`, exact: true }).click();
await expect(page.getByText(`Modal example: ${example}`, { exact: true })).toBeVisible();
const title = page.getByText(`Modal example: ${example}`, { exact: true });
// A compact sheet holds below the viewport and then slides up, so a pointer placed before it
// stops lands on whatever slides under it. The settle check starts once the slide has begun;
// two equal reads during the hold would otherwise count as settled.
await expect(title).toBeInViewport();
await waitForSettledPosition(title);
}
async function closeExample(page: Page) {
@@ -208,6 +208,35 @@ test.describe("Plugin sidebar items", () => {
});
});
test("a short desktop sidebar keeps workspaces usable while navigation scrolls", async ({
page,
}) => {
await page.setViewportSize({ width: 1280, height: 480 });
await gotoAppShell(page);
await expect(botRow(page, "status")).toBeAttached();
const workspace = visibleTestId(page, `sidebar-workspace-row-${getServerId()}:${workspaceId}`);
await expect(workspace).toBeInViewport({ ratio: 1 });
await expect(botRow(page, "status")).not.toBeInViewport();
await test.step("navigation stays within half the sidebar", async () => {
const nav = await boxOf(visibleTestId(page, "sidebar-nav-scroll"));
expect(nav.height).toBeLessThanOrEqual(480 / 2 + 1);
});
await test.step("scrolling navigation reaches its last row without moving workspaces", async () => {
const before = await boxOf(workspace);
await visibleTestId(page, "sidebar-global-new-workspace").hover();
await page.mouse.wheel(0, 800);
await expect(botRow(page, "status")).toBeInViewport({ ratio: 1 });
await expect(workspace).toBeInViewport({ ratio: 1 });
expect((await boxOf(workspace)).y).toBe(before.y);
await qaScreenshot(page, "desktop-short-sidebar-nav-scrolled");
await botRow(page, "status").click();
await expect(page.getByText("Bot status details", { exact: true })).toBeVisible();
await page.getByRole("button", { name: "Close bot status", exact: true }).click();
});
});
test("a restored plugin screen waits for its catalog before rendering", async ({ page }) => {
await page.setViewportSize(WIDE);
await gotoWorkspace(page, workspaceId);
@@ -0,0 +1,106 @@
import { expect, type Page } from "@playwright/test";
import { test } from "../support/fixtures";
import { gotoAppShell, openSettings } from "../support/helpers/app";
import { renameHostFromSettings } from "../support/helpers/hosts";
import { getServerId } from "../support/helpers/server-id";
import { openHostSection, selectSettingsHost } from "../support/helpers/settings";
const REGISTRY_KEY = "@paseo:daemon-registry";
const SEED_NONCE_KEY = "@paseo:e2e-seed-nonce";
const DISABLE_DEFAULT_SEED_ONCE_KEY = "@paseo:e2e-disable-default-seed-once";
// What a build with a connection kind this one doesn't know leaves in the registry: an extra
// connection on a host this build can reach, and a host reached only through it.
const UNKNOWN_CONNECTION = { id: "future:garage", type: "futureKind", address: "garage" };
const UNKNOWN_HOST = {
serverId: "srv_e2e_unknown_connection_host",
label: "Unknown connection host",
connections: [{ id: "future:roof", type: "futureKind", address: "roof" }],
preferredConnectionId: "future:roof",
};
const OFFLINE_HOST = {
serverId: "srv_e2e_saved_offline_host",
label: "Saved offline host",
password: "e2e-fake-password",
connections: [{ id: "direct:127.0.0.1:59999", type: "directTcp", endpoint: "127.0.0.1:59999" }],
preferredConnectionId: "direct:127.0.0.1:59999",
};
interface StoredHost {
serverId: string;
label?: string;
password?: string;
connections: unknown[];
}
async function addUnreadableEntriesAndReload(page: Page): Promise<void> {
await page.evaluate(
({ keys, primaryServerId, unknownConnection, offlineHost, unknownHost }) => {
const nonce = localStorage.getItem(keys.nonce);
if (!nonce) {
throw new Error("Expected the e2e seed nonce before overriding the host registry.");
}
const registry: StoredHost[] = JSON.parse(localStorage.getItem(keys.registry) ?? "[]");
registry
.find((host) => host.serverId === primaryServerId)
?.connections.push(unknownConnection);
registry.push(offlineHost, unknownHost);
localStorage.setItem(keys.registry, JSON.stringify(registry));
localStorage.setItem(keys.disableSeedOnce, nonce);
},
{
keys: {
registry: REGISTRY_KEY,
nonce: SEED_NONCE_KEY,
disableSeedOnce: DISABLE_DEFAULT_SEED_ONCE_KEY,
},
primaryServerId: getServerId(),
unknownConnection: UNKNOWN_CONNECTION,
offlineHost: OFFLINE_HOST,
unknownHost: UNKNOWN_HOST,
},
);
await page.reload();
}
async function readStoredRegistry(page: Page): Promise<StoredHost[] | null> {
return page.evaluate((key) => JSON.parse(localStorage.getItem(key) ?? "null"), REGISTRY_KEY);
}
async function readStoredHost(page: Page, serverId: string): Promise<StoredHost | undefined> {
return (await readStoredRegistry(page))?.find((host) => host.serverId === serverId);
}
test("saved hosts survive a registry entry this build can't read, and saving keeps it", async ({
page,
}) => {
await gotoAppShell(page);
await addUnreadableEntriesAndReload(page);
await test.step("both readable hosts are listed", async () => {
await page.getByTestId("sidebar-hosts-trigger").click();
await expect(page.getByTestId(`sidebar-host-row-${getServerId()}`)).toBeVisible();
await expect(page.getByTestId(`sidebar-host-row-${OFFLINE_HOST.serverId}`)).toBeVisible();
await expect(page.getByTestId(`sidebar-host-row-${UNKNOWN_HOST.serverId}`)).toHaveCount(0);
await page.keyboard.press("Escape");
});
await test.step("renaming a host keeps its password and the entries it can't read", async () => {
await openSettings(page);
await selectSettingsHost(page, OFFLINE_HOST.serverId);
await openHostSection(page, OFFLINE_HOST.serverId, "host");
await renameHostFromSettings(page, "Renamed offline host");
await expect
.poll(() => readStoredHost(page, OFFLINE_HOST.serverId))
.toMatchObject({ label: "Renamed offline host", password: OFFLINE_HOST.password });
const stored = await readStoredRegistry(page);
expect(stored?.map((host) => host.serverId)).toEqual([
getServerId(),
OFFLINE_HOST.serverId,
UNKNOWN_HOST.serverId,
]);
expect(stored?.[0]?.connections).toContainEqual(UNKNOWN_CONNECTION);
expect(stored?.[2]).toEqual(UNKNOWN_HOST);
});
});
@@ -110,6 +110,7 @@ test.describe("Sidebar items in Appearance settings", () => {
await test.step("the sidebar starts in the default order", async () => {
await expectSidebarOrder(page, ["new-workspace", "history", "search", "schedules"]);
await expect(page.locator('[data-testid="sidebar-nav-separator"]:visible')).toHaveCount(1);
});
await test.step("the Sidebar section lists every item in the same order", async () => {
@@ -195,6 +196,9 @@ test.describe("Sidebar items in Appearance settings", () => {
await expectSidebarItemHidden(page, "history");
await expectSidebarItemHidden(page, "search");
await expectSidebarItemHidden(page, "schedules");
// Nothing is left above the Workspaces section: no drag strip, no empty divider.
await expect(page.locator('[data-testid="sidebar-nav-drag-strip"]:visible')).toHaveCount(0);
await expect(page.locator('[data-testid="sidebar-nav-separator"]:visible')).toHaveCount(0);
});
});
@@ -73,35 +73,36 @@ function labelRow(page: import("@playwright/test").Page, name: string) {
return page.getByTestId(`workspace-label-picker-row-${name}`);
}
async function box(locator: import("@playwright/test").Locator) {
const measured = await locator.boundingBox();
if (!measured) throw new Error("expected a visible element to measure");
return measured;
}
async function size(locator: import("@playwright/test").Locator) {
await settled(locator);
const { width, height } = await box(locator);
const { width, height } = await settled(locator);
return { width, height };
}
/**
* Waits until an element stops moving.
* Waits until an element is on screen and stops moving, and returns where it settled.
*
* The flyout scales in and the sidebar behind it re-lays out as the filter changes, so a rail
* measured mid-animation is not a rail — and a measurement built from two `boundingBox()` calls
* would take its two halves from two different frames.
* would take its two halves from two different frames. A row that has not been laid out yet has
* no box at all; that is not settled either, so the poll keeps waiting instead of failing.
*/
async function settled(locator: import("@playwright/test").Locator) {
let previous = "";
const last: { box: Awaited<ReturnType<typeof locator.boundingBox>>; key: string | null } = {
box: null,
key: null,
};
await expect
.poll(async () => {
const current = JSON.stringify(await box(locator));
const stable = current === previous;
previous = current;
const current = await locator.boundingBox();
const key = current ? JSON.stringify(current) : null;
const stable = key !== null && key === last.key;
last.box = current;
last.key = key;
return stable;
})
.toBe(true);
if (!last.box) throw new Error("a settled element has a box");
return last.box;
}
async function expectAssigned(
@@ -6,7 +6,7 @@ import {
type ChildProcess,
type SpawnOptions,
} from "node:child_process";
import { mkdtemp, rm, writeFile } from "node:fs/promises";
import { mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
import net from "node:net";
import { tmpdir } from "node:os";
import path from "node:path";
@@ -59,7 +59,17 @@ export async function getAvailableHostDaemonPort(): Promise<number> {
return port;
}
async function waitForServer(port: number, child: ChildProcess): Promise<void> {
/**
* Resolves once this daemon answers on its port. An open TCP port is not
* enough: the port is released before the daemon binds it, and whatever takes
* it in between also accepts connections while the daemon exits with
* EADDRINUSE. Only the daemon's own status reports its server id.
*/
async function waitForServer(
port: number,
child: ChildProcess,
identity: { serverId: string; paseoHome: string },
): Promise<void> {
const deadline = Date.now() + 90_000;
let lastError: unknown = null;
@@ -70,22 +80,13 @@ async function waitForServer(port: number, child: ChildProcess): Promise<void> {
);
}
try {
await new Promise<void>((resolve, reject) => {
const socket = net.connect(port, "127.0.0.1", () => {
socket.end();
resolve();
});
socket.setTimeout(1_000, () => {
socket.destroy();
reject(new Error(`Connection timed out to isolated daemon port ${port}`));
});
socket.on("error", reject);
});
return;
const serverId = await readServerId(port, identity.paseoHome);
if (serverId === identity.serverId) return;
lastError = new Error(`Port ${port} is served by ${serverId}, not ${identity.serverId}`);
} catch (error) {
lastError = error;
await new Promise((resolve) => setTimeout(resolve, 100));
}
await new Promise((resolve) => setTimeout(resolve, 100));
}
throw new Error(
@@ -95,6 +96,25 @@ async function waitForServer(port: number, child: ChildProcess): Promise<void> {
);
}
/**
* Reads the server id from the daemon's status route. The route needs a bearer
* on a password-protected daemon; the daemon accepts the local credential it
* writes into its home before listening, as the CLI does for local status.
*/
async function readServerId(port: number, paseoHome: string): Promise<string> {
const localCredential = await readFile(path.join(paseoHome, "local-credential"), "utf8").then(
(token) => token.trim(),
() => null,
);
const response = await fetch(`http://127.0.0.1:${port}/api/status`, {
headers: localCredential ? { authorization: `Bearer ${localCredential}` } : {},
signal: AbortSignal.timeout(1_000),
});
if (!response.ok) throw new Error(`Status request to port ${port} returned ${response.status}`);
const status = (await response.json()) as { serverId?: unknown };
return String(status.serverId);
}
function withMutableRelay(
config: NonNullable<IsolatedHostDaemonOptions["config"]>,
relay: NonNullable<IsolatedHostDaemonOptions["mutableRelay"]>,
@@ -121,7 +141,7 @@ export async function startIsolatedHostDaemon(
serverId: string,
options: IsolatedHostDaemonOptions = {},
): Promise<IsolatedHostDaemon> {
const port = await getAvailableHostDaemonPort();
let port = await getAvailableHostDaemonPort();
const metroPort = process.env.E2E_METRO_PORT;
if (!metroPort) throw new Error("E2E_METRO_PORT is required to start an isolated host daemon");
@@ -221,7 +241,7 @@ export async function startIsolatedHostDaemon(
});
try {
await waitForServer(port, spawned);
await waitForServer(port, spawned, { serverId, paseoHome });
return spawned;
} catch (error) {
throw new Error(
@@ -231,8 +251,25 @@ export async function startIsolatedHostDaemon(
}
};
// The reserved port is released before the daemon binds it, so another
// process can take it in between. Only the first start picks a new port:
// restart() keeps the endpoint the app already knows.
const startOnFreePort = async (): Promise<void> => {
for (let attempt = 1; ; attempt += 1) {
try {
await spawnDaemon();
return;
} catch (error) {
const lostPort = error instanceof Error && error.message.includes("EADDRINUSE");
if (!lostPort || attempt === 3) throw error;
await stopDaemon();
port = await getAvailableHostDaemonPort();
}
}
};
try {
await spawnDaemon();
await startOnFreePort();
} catch (error) {
await stopDaemon();
if (!options.preserveHome) {
@@ -17,6 +17,13 @@ import { isNative } from "@/constants/platform";
* On macOS, Electron handles edge resize natively.
*/
/**
* Marks a scroll viewport as window content: it and its descendants emit no window
* regions, because Electron does not clip app-region rects to scroll viewports.
* See the `[data-window-content]` rule in public/index.html.
*/
export const WINDOW_CONTENT_DATASET = { "window-content": "" };
export const titlebarDragSurfaceStyle: React.CSSProperties = {
cursor: "default",
// @ts-expect-error — WebkitAppRegion is not in CSSProperties
+89 -43
View File
@@ -9,7 +9,16 @@ import {
type LucideIcon,
} from "lucide-react-native";
import { useTranslation } from "react-i18next";
import { memo, useCallback, useEffect, useMemo, useRef, useState, type RefObject } from "react";
import {
memo,
useCallback,
useEffect,
useMemo,
useRef,
useState,
type ReactNode,
type RefObject,
} from "react";
import {
Pressable,
ScrollView,
@@ -19,12 +28,19 @@ import {
View,
type LayoutChangeEvent,
} from "react-native";
import { Gesture, ScrollView as GHScrollView } from "react-native-gesture-handler";
import {
Gesture,
type GestureType,
ScrollView as GHScrollView,
} from "react-native-gesture-handler";
import Animated, { runOnJS, useAnimatedStyle, useSharedValue } from "react-native-reanimated";
import { scheduleOnRN } from "react-native-worklets";
import { useSafeAreaInsets } from "react-native-safe-area-context";
import { StyleSheet, useUnistyles } from "react-native-unistyles";
import { TitlebarDragRegion } from "@/components/desktop/titlebar-drag-region";
import {
TitlebarDragRegion,
WINDOW_CONTENT_DATASET,
} from "@/components/desktop/titlebar-drag-region";
import { SidebarCloseButton } from "@/components/headers/sidebar-close-button";
import {
resolveDesktopSidebarInsetLeft,
@@ -39,7 +55,7 @@ import { HostPicker } from "@/components/hosts/host-picker";
import { SidebarDisplayPreferencesMenu } from "@/components/sidebar/display-preferences/menu";
import { SidebarSeparator } from "@/components/sidebar/sidebar-separator";
import { SidebarToastRegion } from "@/components/sidebar/sidebar-toast-region";
import { SidebarNavRows } from "@/components/sidebar/sidebar-nav-rows";
import { SidebarNavRows, useVisibleSidebarNavItems } from "@/components/sidebar/sidebar-nav-rows";
import { SidebarFooterIconHighlight } from "@/components/sidebar/sidebar-footer-icon-highlight";
import { SidebarHelpMenu } from "@/components/sidebar/sidebar-help-menu";
import { SidebarFooterOverflowMenu } from "@/components/sidebar/sidebar-footer-overflow-menu";
@@ -622,29 +638,7 @@ function MobileSidebar({
>
<View style={styles.sidebarContent} pointerEvents="auto">
<WindowChromeSafeArea placement="below" />
{platformIsNative ? (
<GHScrollView
// Same contract as the workspace list: vertical drags scroll the nav
// block, a clear horizontal intent still activates the close pan.
simultaneousHandlers={closeGestureRef}
style={styles.mobileNavScroll}
showsVerticalScrollIndicator={false}
alwaysBounceVertical={false}
testID="sidebar-nav-scroll"
>
{navRows}
</GHScrollView>
) : (
<ScrollView
style={styles.mobileNavScroll}
showsVerticalScrollIndicator={false}
alwaysBounceVertical={false}
testID="sidebar-nav-scroll"
>
{navRows}
</ScrollView>
)}
<SidebarSeparator />
<SidebarNavScroll closeGestureRef={closeGestureRef}>{navRows}</SidebarNavScroll>
<SidebarViewSlot dismiss={handleWorkspacePress}>
<SidebarToastRegion active={active}>
@@ -689,6 +683,47 @@ function MobileSidebar({
);
}
interface SidebarNavScrollProps {
closeGestureRef: RefObject<GestureType | undefined>;
/** Web only: the viewport emits no window regions (see WINDOW_CONTENT_DATASET). */
windowContent?: boolean;
children: ReactNode;
}
// The capped, scrolling nav block shared by the mobile and desktop sidebars, with the
// divider below it. The divider is a sibling because Unistyles does not patch the
// gesture-handler ScrollView.
function SidebarNavScroll({ closeGestureRef, windowContent, children }: SidebarNavScrollProps) {
return (
<>
{platformIsNative ? (
<GHScrollView
// Same contract as the workspace list: vertical drags scroll the nav
// block, a clear horizontal intent still activates the close pan.
simultaneousHandlers={closeGestureRef}
style={styles.navScroll}
showsVerticalScrollIndicator={false}
alwaysBounceVertical={false}
testID="sidebar-nav-scroll"
>
{children}
</GHScrollView>
) : (
<ScrollView
dataSet={windowContent ? WINDOW_CONTENT_DATASET : undefined}
style={styles.navScroll}
showsVerticalScrollIndicator={false}
alwaysBounceVertical={false}
testID="sidebar-nav-scroll"
>
{children}
</ScrollView>
)}
<SidebarSeparator testID="sidebar-nav-separator" />
</>
);
}
function DesktopSidebar({
theme,
workspaceGroups,
@@ -809,12 +844,14 @@ function DesktopSidebar({
],
[insetsTop, insets.bottom, insets.left, overlay, divisionLayout],
);
// Below the window controls' row, or in the top band's place, the first row starts flush.
const inTopBand = useTopBand() !== null;
const sidebarHeaderGroupStyle = useMemo(
() => [styles.sidebarHeaderGroup, (ownsTopLeft || inTopBand) && styles.sidebarHeaderGroupFlush],
[ownsTopLeft, inTopBand],
);
// Windows and Linux draw their window controls top-right, so the sidebar has no chrome
// row there. The strip above the scrolling rows is then its window drag surface.
const showsChromeRow = ownsTopLeft || Boolean(DEV_BUILD_LABEL);
// With every top item hidden the sidebar starts at the Workspaces section, as before the
// nav scroller existed: no strip above it and no divider below it.
const hasNavRows = useVisibleSidebarNavItems().length > 0;
const showsDragStrip = hasNavRows && !showsChromeRow && !inTopBand;
return (
<MobilePanelOverlay
panel="agent-list"
@@ -825,7 +862,7 @@ function DesktopSidebar({
<Animated.View style={desktopSidebarStyle}>
<View style={desktopSidebarBorderStyle}>
<View style={styles.sidebarDragArea}>
{ownsTopLeft || DEV_BUILD_LABEL ? (
{showsChromeRow ? (
<View style={styles.desktopChromeRow}>
<TitlebarDragRegion />
{DEV_BUILD_LABEL ? (
@@ -842,11 +879,21 @@ function DesktopSidebar({
</View>
) : null}
</View>
) : (
<TitlebarDragRegion />
)}
<SidebarNavRows style={sidebarHeaderGroupStyle} onBeforeNavigate={closeSidebar} />
) : null}
{showsDragStrip ? (
<View style={styles.desktopDragStrip} testID="sidebar-nav-drag-strip">
<TitlebarDragRegion />
</View>
) : null}
</View>
{/* The drag overlay stays above this viewport: Electron does not clip
app-region rects to scroll viewports, so a scrolled-out row would
still claim its no-drag rect. */}
{hasNavRows ? (
<SidebarNavScroll closeGestureRef={closeGestureRef} windowContent>
<SidebarNavRows style={styles.sidebarHeaderGroup} onBeforeNavigate={closeSidebar} />
</SidebarNavScroll>
) : null}
<SidebarViewSlot dismiss={closeSidebar}>
<SidebarToastRegion active={active}>
@@ -935,19 +982,18 @@ const staticStyles = RNStyleSheet.create({
});
const styles = StyleSheet.create((theme) => ({
// The rows start flush: the chrome row, drag strip, or top band above them gives the inset.
sidebarHeaderGroup: {
paddingTop: theme.spacing[2],
gap: 2,
paddingBottom: theme.spacing[1.5],
borderBottomWidth: 1,
borderBottomColor: theme.colors.border,
},
sidebarHeaderGroupFlush: {
paddingTop: 0,
desktopDragStrip: {
position: "relative",
height: theme.spacing[2],
},
// The nav block caps at half the sidebar; a long item list scrolls inside the
// cap instead of crowding the workspace list off a short screen.
mobileNavScroll: {
navScroll: {
flexGrow: 0,
flexShrink: 1,
maxHeight: "50%",
@@ -35,14 +35,19 @@ interface SidebarNavRowsProps extends SidebarNavRowProps {
firstRowTrailing?: ReactNode;
}
/** The top-level items the user keeps visible, in display order. */
export function useVisibleSidebarNavItems() {
const { items } = useSidebarNavItems("header");
return useMemo(() => items.filter((item) => item.visible), [items]);
}
/**
* Top-level sidebar navigation, ordered and filtered by the user's
* `sidebarNavItems` preference. Renders nothing — not even the bordered group
* wrapper — when every item is hidden and there is no `firstRowTrailing`.
*/
export function SidebarNavRows({ style, onBeforeNavigate, firstRowTrailing }: SidebarNavRowsProps) {
const { items } = useSidebarNavItems("header");
const visibleItems = useMemo(() => items.filter((item) => item.visible), [items]);
const visibleItems = useVisibleSidebarNavItems();
const groupRef = useRef<View | null>(null);
if (visibleItems.length === 0 && !firstRowTrailing) return null;
@@ -2256,6 +2256,59 @@ describe("HostRuntimeController", () => {
});
});
const REGISTRY_KEY = "@paseo:daemon-registry";
const futureConnection = { id: "future:1", type: "futureKind", address: "future.example.com" };
const directA: HostConnection = {
id: "direct:lan-a:6767",
type: "directTcp",
endpoint: "lan-a:6767",
};
const directB: HostConnection = {
id: "direct:lan-b:6767",
type: "directTcp",
endpoint: "lan-b:6767",
};
// What a build with a connection kind this one doesn't know leaves behind: an extra connection
// on a host this build can reach, and a host reached only through it.
const storedWithUnreadableEntries = [
{
...makeHost({ serverId: "srv_a", password: "secret-a" }),
connections: [futureConnection, directA],
},
makeHost({ serverId: "srv_b", password: "secret-b", connections: [directB] }),
{ serverId: "srv_future", label: "future host", connections: [futureConnection] },
];
async function bootWithRegistry(registry: string): Promise<{
store: HostRuntimeStore;
storage: HostRuntimeStorage;
}> {
const storage = createMemoryHostRuntimeStorage({
[REGISTRY_KEY]: registry,
"@paseo:e2e": "1",
});
const store = new HostRuntimeStore({
storage,
deps: {
createClient: () => new FakeDaemonClient() as unknown as DaemonClient,
connectToDaemon: async ({ host }) => ({
client: makeConnectedProbeClient(5) as unknown as DaemonClient,
serverId: host.serverId,
hostname: host.label ?? null,
}),
getClientId: async () => "cid_test_runtime",
},
revokePushNotifications: async () => undefined,
});
await store.boot();
return { store, storage };
}
async function readRegistry(storage: HostRuntimeStorage): Promise<unknown> {
const raw = await storage.getItem(REGISTRY_KEY);
return raw === null ? null : JSON.parse(raw);
}
describe("HostRuntimeStore", () => {
function gatewayRecoveryFixture() {
const parent = new FakeDaemonClient();
@@ -2686,6 +2739,98 @@ describe("HostRuntimeStore", () => {
session.clearSession(host.serverId);
});
it("keeps readable hosts when the registry holds entries this build can't read", async () => {
const { store, storage } = await bootWithRegistry(JSON.stringify(storedWithUnreadableEntries));
expect(store.getHosts().map((host) => [host.serverId, host.password])).toEqual([
["srv_a", "secret-a"],
["srv_b", "secret-b"],
]);
expect(store.getHosts()[0]?.connections.map((connection) => connection.id)).toEqual([
directA.id,
]);
expect(await readRegistry(storage)).toEqual(storedWithUnreadableEntries);
store.syncHosts([]);
});
it("keeps the entries it can't read when it saves the registry", async () => {
const { store, storage } = await bootWithRegistry(JSON.stringify(storedWithUnreadableEntries));
await store.renameHost("srv_b", "renamed");
expect(await readRegistry(storage)).toMatchObject([
{
serverId: "srv_a",
password: "secret-a",
connections: [{ id: directA.id }, futureConnection],
},
{ serverId: "srv_b", password: "secret-b", label: "renamed" },
storedWithUnreadableEntries[2],
]);
store.syncHosts([]);
});
it("moves a stored connection password to its host and keeps the connection it can't read", async () => {
const { store, storage } = await bootWithRegistry(
JSON.stringify([
{
serverId: "srv_legacy",
connections: [
{ type: "directTcp", endpoint: "lan-a:6767", password: "old-secret" },
futureConnection,
],
},
]),
);
expect(store.getHosts().map((host) => [host.serverId, host.password])).toEqual([
["srv_legacy", "old-secret"],
]);
await vi.waitFor(async () =>
expect(await readRegistry(storage)).toMatchObject([
{ serverId: "srv_legacy", password: "old-secret" },
]),
);
expect(await readRegistry(storage)).toMatchObject([
{ connections: [{ ...directA, useTls: false }, futureConnection] },
]);
const [written] = (await readRegistry(storage)) as Array<{ connections: unknown[] }>;
expect(written?.connections[0]).not.toHaveProperty("password");
store.syncHosts([]);
});
it("forgets an entry it can't read once that host is paired again and removed", async () => {
const { store, storage } = await bootWithRegistry(
JSON.stringify([{ serverId: "srv_future", connections: [futureConnection] }]),
);
expect(store.getHosts()).toEqual([]);
await store.upsertDirectConnection({ serverId: "srv_future", endpoint: directA.endpoint });
await vi.waitFor(async () =>
expect(await readRegistry(storage)).toMatchObject([
{ serverId: "srv_future", connections: [{ id: directA.id }] },
]),
);
await store.removeHost("srv_future");
expect(await readRegistry(storage)).toEqual([]);
store.syncHosts([]);
});
it("copies a registry that isn't JSON aside instead of deleting it", async () => {
const { store, storage } = await bootWithRegistry("{not json");
expect(store.getHosts()).toEqual([]);
expect(await storage.getItem(`${REGISTRY_KEY}:unreadable`)).toBe("{not json");
expect(await storage.getItem(REGISTRY_KEY)).toBe("{not json");
store.syncHosts([]);
});
it("marks the host registry loaded after boot reads storage", async () => {
const previousOverride = process.env.EXPO_PUBLIC_LOCAL_DAEMON;
process.env.EXPO_PUBLIC_LOCAL_DAEMON = "not-an-endpoint";
+37 -28
View File
@@ -17,14 +17,16 @@ import {
import {
connectionFromListen,
createRemoteSshHostConnection,
normalizeStoredHostProfile,
forgetUnreadableHost,
pinRelayProtectedSecurityInProfiles,
readHostRegistry,
upsertHostConnectionInProfiles,
registryHasConnection,
relayConnectionFromOffer,
StoredHostRegistrySchema,
writeHostRegistry,
type HostConnection,
type HostProfile,
type UnreadableHostEntries,
} from "@/types/host-connection";
import { defaultHostAppearance, type HostBadgeDisplay, type HostColor } from "@/hosts/appearance";
import {
@@ -43,7 +45,7 @@ import { isWeb } from "@/constants/platform";
import { connectToDaemon, getConnectionAuthFailureReason } from "@/utils/test-daemon-connection";
import { getOrCreateClientId } from "@/utils/client-id";
import { z } from "zod";
import { readValidatedJson, readValidatedString } from "@/storage/validated-storage";
import { readValidatedString } from "@/storage/validated-storage";
import {
selectBestConnection,
type ConnectionCandidate,
@@ -1692,6 +1694,7 @@ export class HostRuntimeStore {
private hostListVersion = 0;
private hostRegistryLoaded = false;
private hosts: HostProfile[] = [];
private unreadableHosts: UnreadableHostEntries = { hosts: [], connectionsByServerId: new Map() };
private hostAppearanceMutationTail: Promise<void> = Promise.resolve();
private hostRegistryStatus: HostRegistryStatus = "loading";
private deps: HostRuntimeControllerDeps;
@@ -1799,32 +1802,17 @@ export class HostRuntimeStore {
let shouldPersistHosts = false;
let profiles: HostProfile[] = [];
try {
const stored = await readValidatedJson(
this.storage,
REGISTRY_STORAGE_KEY,
StoredHostRegistrySchema,
);
const stored = await this.readStoredRegistry();
if (stored) {
const normalizedProfiles: HostProfile[] = [];
for (const entry of stored) {
const profile = normalizeStoredHostProfile(entry);
if (!profile) {
await this.storage.removeItem(REGISTRY_STORAGE_KEY);
normalizedProfiles.length = 0;
break;
}
// COMPAT(connectionPassword): added in v0.9.1, remove after 2027-03-24 with stored-password migration.
if (
entry.connections.some(
(connection) => connection.type === "directTcp" && connection.password,
)
) {
shouldPersistHosts = true;
}
normalizedProfiles.push(profile);
// An entry this build can't read skips only that host or connection, and stays stored.
const registry = readHostRegistry(stored);
this.unreadableHosts = registry.unreadable;
// COMPAT(connectionPassword): added in v0.9.1, remove after 2027-03-24 with stored-password migration.
if (registry.movedConnectionPassword) {
shouldPersistHosts = true;
}
profiles = normalizedProfiles.filter((entry) => !isPlaceholderServerId(entry.serverId));
if (profiles.length !== normalizedProfiles.length) {
profiles = registry.hosts.filter((entry) => !isPlaceholderServerId(entry.serverId));
if (profiles.length !== registry.hosts.length) {
shouldPersistHosts = true;
}
}
@@ -2320,6 +2308,7 @@ export class HostRuntimeStore {
async removeHost(serverId: string): Promise<void> {
await this.revokePushNotifications({ client: this.getClient(serverId), serverId });
const remaining = this.hosts.filter((daemon) => daemon.serverId !== serverId);
this.unreadableHosts = forgetUnreadableHost(this.unreadableHosts, serverId);
this.setHostsAndSync(remaining);
await this.persistHosts();
}
@@ -2408,7 +2397,27 @@ export class HostRuntimeStore {
}
private async persistHosts(hosts = this.hosts): Promise<void> {
await this.storage.setItem(REGISTRY_STORAGE_KEY, JSON.stringify(hosts));
await this.storage.setItem(
REGISTRY_STORAGE_KEY,
JSON.stringify(writeHostRegistry(hosts, this.unreadableHosts)),
);
}
/**
* Reads the stored registry without removing it. A value that isn't a JSON array is copied to
* `<key>:unreadable` first, because the next save overwrites the key.
*/
private async readStoredRegistry(): Promise<unknown[] | null> {
const raw = await this.storage.getItem(REGISTRY_STORAGE_KEY);
if (raw === null) return null;
try {
const value: unknown = JSON.parse(raw);
if (Array.isArray(value)) return value;
} catch {
// Not JSON: copied aside below.
}
await this.storage.setItem(`${REGISTRY_STORAGE_KEY}:unreadable`, raw);
return null;
}
private emitHostList(): void {
@@ -21,8 +21,7 @@ import {
import { useLocalDaemonServerId } from "@/hooks/use-is-local-daemon";
import { PairDeviceModal } from "@/desktop/components/pair-device-modal";
import { buildSettingsHostSectionRoute } from "@/utils/host-routes";
const WINDOW_CONTENT_DATASET = { "window-content": "" };
import { WINDOW_CONTENT_DATASET } from "@/components/desktop/titlebar-drag-region";
export function OpenProjectScreen() {
const { t } = useTranslation();
@@ -106,6 +106,79 @@ describe("workspace-pane-state", () => {
});
});
it("does not locate a file by an id retained from a previous target", () => {
const layout: WorkspaceLayout = {
root: {
kind: "pane",
pane: {
id: "main",
tabIds: ["file_/repo/a.ts", "agent_agent-a"],
focusedTabId: "agent_agent-a",
},
},
focusedPaneId: "main",
};
const tabs = [
createTab("file_/repo/a.ts", { kind: "file", path: "/repo/b.ts" }),
createTab("agent_agent-a", { kind: "agent", agentId: "agent-a" }),
];
const target: WorkspaceTab["target"] = { kind: "file", path: "/repo/a.ts" };
expect(resolveSideFileOpenPlacement({ layout, sourcePaneId: "main", tabs, target })).toEqual({
kind: "split-side-pane",
paneId: "main",
});
expect(deriveWorkspacePaneState({ layout, tabs, preferredTarget: target }).activeTabId).toBe(
"agent_agent-a",
);
});
it("matches a retained file instance when only the requested line range differs", () => {
const pane = {
id: "main",
tabIds: ["retained-file", "agent_agent-a"],
focusedTabId: "agent_agent-a",
};
const layout: WorkspaceLayout = { root: { kind: "pane", pane }, focusedPaneId: "main" };
const tabs = [
createTab("retained-file", { kind: "file", path: "/repo/a.ts", lineStart: 2 }),
createTab("agent_agent-a", { kind: "agent", agentId: "agent-a" }),
];
const target: WorkspaceTab["target"] = {
kind: "file",
path: "/repo/a.ts",
lineStart: 12,
lineEnd: 20,
};
expect(resolveSideFileOpenPlacement({ layout, sourcePaneId: "main", tabs, target })).toEqual({
kind: "open-in-source",
});
expect(deriveWorkspacePaneState({ layout, tabs, preferredTarget: target }).activeTabId).toBe(
"retained-file",
);
});
it("prefers an exact file navigation target over another instance of the same resource", () => {
const pane = {
id: "main",
tabIds: ["first", "second"],
focusedTabId: "first",
};
const tabs = [
createTab("first", { kind: "file", path: "/repo/a.ts", lineStart: 2 }),
createTab("second", { kind: "file", path: "/repo/a.ts", lineStart: 12 }),
];
expect(
deriveWorkspacePaneState({
pane,
tabs,
preferredTarget: { kind: "file", path: "/repo/a.ts", lineStart: 12 },
}).activeTabId,
).toBe("second");
});
it("resolves side file opens to an existing file tab", () => {
const layout: WorkspaceLayout = {
root: {
@@ -5,12 +5,9 @@ import {
} from "@/stores/workspace-layout-store";
import type { WorkspaceTab, WorkspaceTabTarget } from "@/workspace-tabs/model";
import type { WorkspaceTabDescriptor } from "@/screens/workspace/workspace-tabs-types";
import {
buildDeterministicWorkspaceTabId,
normalizeWorkspaceTabTarget,
workspaceTabTargetsEqual,
} from "@/workspace-tabs/identity";
import { normalizeWorkspaceTabTarget, workspaceTabTargetsEqual } from "@/workspace-tabs/identity";
import { findAdjacentPane } from "@/utils/split-navigation";
import { panelResourceKey } from "@/panels/panel-manifest";
export interface WorkspaceDerivedTab {
descriptor: WorkspaceTabDescriptor;
@@ -124,8 +121,10 @@ function getActiveTabId(input: {
}
const matchingTab =
input.tabs.find((tab) => workspaceTabTargetsEqual(tab.descriptor.target, preferredTarget)) ??
null;
return matchingTab?.descriptor.tabId ?? buildDeterministicWorkspaceTabId(preferredTarget);
input.tabs.find(
(tab) => panelResourceKey(tab.descriptor.target) === panelResourceKey(preferredTarget),
);
return matchingTab?.descriptor.tabId ?? null;
})();
if (preferredTabId && input.openTabIds.has(preferredTabId)) {
@@ -211,10 +210,8 @@ export function resolveSideFileOpenPlacement(input: {
tabs: WorkspaceTab[];
target: WorkspaceTabTarget;
}): WorkspaceSideFileOpenPlacement {
const targetTabId = buildDeterministicWorkspaceTabId(input.target);
const existingTab = input.tabs.find(
(tab) => tab.tabId === targetTabId || workspaceTabTargetsEqual(tab.target, input.target),
);
const targetKey = panelResourceKey(input.target);
const existingTab = input.tabs.find((tab) => panelResourceKey(tab.target) === targetKey);
if (existingTab) {
return { kind: "open-in-source" };
}
@@ -3,7 +3,7 @@ import type { JsonValue } from "@getpaseo/protocol/agent-types";
import type { WorkspaceTab, WorkspaceTabTarget } from "@/workspace-tabs/model";
import { MIN_SPLIT_SIZE } from "@/stores/workspace-layout-constants";
import { panelResourceKey, panelSupportsHost } from "@/panels/panel-manifest";
import { defaultWorkspaceLayoutIds } from "@/stores/workspace-layout-ids";
import { allocateWorkspaceTabId, defaultWorkspaceLayoutIds } from "@/stores/workspace-layout-ids";
import type { WorkspaceLayoutNodeIdPrefix } from "@/stores/workspace-layout-ids";
import {
buildDeterministicWorkspaceTabId,
@@ -137,6 +137,8 @@ interface OpenTabInLayoutInput {
placement: WorkspaceTabPlacement;
/** Required so a new caller cannot silently opt out of Explorer placement rules. */
explorerSidebarPaneId: string | null;
/** Live sheets share the workspace's panel-instance namespace with its tabs. */
reservedTabIds?: ReadonlySet<string>;
}
interface CreateTabInLayoutInput extends OpenTabInLayoutInput {
@@ -261,6 +263,7 @@ interface ReorderPaneTabsInLayoutInput {
export interface WorkspaceTabReconcileState {
layout: WorkspaceLayout;
reservedTabIds?: ReadonlySet<string>;
pinnedAgentIds?: ReadonlySet<string> | null;
hiddenAgentIds?: ReadonlySet<string> | null;
explorerSidebarPaneId: string | null;
@@ -398,15 +401,11 @@ function normalizeWorkspaceTabs(input: unknown): WorkspaceTab[] {
if (!Array.isArray(input)) {
return [];
}
// Preserve colliding entries until the whole layout can assign each an identity.
const next: WorkspaceTab[] = [];
const seen = new Set<string>();
for (const value of input) {
const tab = normalizeWorkspaceTab(value);
if (!tab || seen.has(tab.tabId)) {
continue;
}
seen.add(tab.tabId);
next.push(tab);
if (tab) next.push(tab);
}
return next;
}
@@ -1022,13 +1021,65 @@ function insertSplitInternal(input: InsertSplitInternalInput): InsertSplitIntern
};
}
function repairDuplicateTabIds(root: SplitNodeInternal): {
root: SplitNodeInternal;
ambiguousIds: ReadonlySet<string>;
} {
const keepers = new Map<string, WorkspaceTab>();
const ambiguousIds = new Set<string>();
for (const tab of collectAllTabs(root)) {
const keeper = keepers.get(tab.tabId);
if (!keeper) {
keepers.set(tab.tabId, tab);
continue;
}
ambiguousIds.add(tab.tabId);
if (
buildDeterministicWorkspaceTabId(tab.target) === tab.tabId &&
buildDeterministicWorkspaceTabId(keeper.target) !== keeper.tabId
) {
keepers.set(tab.tabId, tab);
}
}
if (ambiguousIds.size === 0) return { root, ambiguousIds };
// Reserve every original id before assigning replacements, including hidden panes.
const occupiedIds = new Set(keepers.keys());
function repair(node: SplitNodeInternal): SplitNodeInternal {
if (node.kind === "group") {
return { ...node, group: { ...node.group, children: node.group.children.map(repair) } };
}
const focusedCandidates = node.pane.tabs.filter((tab) => tab.tabId === node.pane.focusedTabId);
const focusedTab =
focusedCandidates.find((tab) => keepers.get(tab.tabId) === tab) ?? focusedCandidates[0];
let focusedTabId = node.pane.focusedTabId;
const tabs = node.pane.tabs.map((tab) => {
if (keepers.get(tab.tabId) === tab) return tab;
const tabId = allocateWorkspaceTabId(
buildDeterministicWorkspaceTabId(tab.target),
occupiedIds,
);
occupiedIds.add(tabId);
if (tab === focusedTab) focusedTabId = tabId;
return { ...tab, tabId };
});
return {
...node,
pane: { ...node.pane, tabs, tabIds: tabs.map((tab) => tab.tabId), focusedTabId },
};
}
return { root: repair(root), ambiguousIds };
}
export function normalizeLayout(layout: unknown): WorkspaceLayout {
if (!layout || typeof layout !== "object") {
return createDefaultLayout();
}
const rawLayout = layout as WorkspaceLayout;
const root = normalizeNode(rawLayout.root) ?? asInternalNode(createDefaultLayout().root);
const { root, ambiguousIds } = repairDuplicateTabIds(
normalizeNode(rawLayout.root) ?? asInternalNode(createDefaultLayout().root),
);
const focusedPaneId =
rawLayout.focusedPaneId === null ? null : trimNonEmpty(rawLayout.focusedPaneId);
const resolvedFocusedPaneId =
@@ -1047,7 +1098,16 @@ export function normalizeLayout(layout: unknown): WorkspaceLayout {
openTabIds: new Set(collectAllTabs(root).map((tab) => tab.tabId)),
});
return parentTabIdByTabId ? { ...normalizedLayout, parentTabIdByTabId } : normalizedLayout;
if (parentTabIdByTabId) {
// A duplicated id cannot identify either end of a parent relationship unambiguously.
for (const [childId, parentId] of Object.entries(parentTabIdByTabId)) {
if (ambiguousIds.has(childId) || ambiguousIds.has(parentId))
delete parentTabIdByTabId[childId];
}
if (Object.keys(parentTabIdByTabId).length > 0)
return { ...normalizedLayout, parentTabIdByTabId };
}
return normalizedLayout;
}
export function findPaneById(root: SplitNode, paneId: string | null | undefined): SplitPane | null {
@@ -1364,7 +1424,9 @@ function insertNewTabIntoPane(
return null;
}
const tabId = input.createTabId();
const occupiedIds = new Set(input.reservedTabIds);
for (const tab of collectAllTabs(layout.root)) occupiedIds.add(tab.tabId);
const tabId = allocateWorkspaceTabId(input.createTabId(), occupiedIds);
const nextTab: WorkspaceTab = {
tabId,
target: input.target,
@@ -2284,6 +2346,7 @@ function openEntityTabWithoutFocusing(input: {
layout: WorkspaceLayout;
target: WorkspaceTabTarget;
explorerSidebarPaneId: string | null;
reservedTabIds: ReadonlySet<string> | undefined;
}): WorkspaceLayout {
return (
insertNewTabIntoPane({
@@ -2292,6 +2355,7 @@ function openEntityTabWithoutFocusing(input: {
now: Date.now(),
placement: AMBIENT_PLACEMENT,
explorerSidebarPaneId: input.explorerSidebarPaneId,
reservedTabIds: input.reservedTabIds,
createTabId: () => buildDeterministicWorkspaceTabId(input.target),
focus: false,
})?.layout ?? input.layout
@@ -2382,6 +2446,7 @@ function addMissingEntityTabs(input: {
hasActivePendingTerminalCreate: boolean;
hasActivePendingDraftCreate: boolean;
explorerSidebarPaneId: string | null;
reservedTabIds: ReadonlySet<string> | undefined;
}): WorkspaceLayout {
const {
autoOpenAgentIds,
@@ -2412,6 +2477,7 @@ function addMissingEntityTabs(input: {
layout: nextLayout,
target: { kind: "agent", agentId },
explorerSidebarPaneId,
reservedTabIds: input.reservedTabIds,
});
currentAgentIds.add(agentId);
}
@@ -2426,6 +2492,7 @@ function addMissingEntityTabs(input: {
layout: nextLayout,
target: { kind: "terminal", terminalId },
explorerSidebarPaneId,
reservedTabIds: input.reservedTabIds,
});
currentTerminalIds.add(terminalId);
}
@@ -2525,6 +2592,7 @@ export function reconcileWorkspaceTabs(
hasActivePendingTerminalCreate: snapshot.hasActivePendingTerminalCreate ?? false,
hasActivePendingDraftCreate: snapshot.hasActivePendingDraftCreate ?? false,
explorerSidebarPaneId: state.explorerSidebarPaneId,
reservedTabIds: state.reservedTabIds,
});
if (reconciledFocusedTabId) {
@@ -11,6 +11,22 @@ function createRandomIdValue(): string {
: `${Date.now()}-${Math.random().toString(16).slice(2)}`;
}
export function createWorkspaceTabInstanceId(): string {
return `tab_${createRandomIdValue()}`;
}
/** A resource-derived id may still belong to a preview slot showing another target. */
export function allocateWorkspaceTabId(
preferredId: string,
occupiedIds: ReadonlySet<string>,
): string {
let tabId = preferredId;
for (let suffix = 2; occupiedIds.has(tabId); suffix += 1) {
tabId = `${preferredId}:${suffix}`;
}
return tabId;
}
export const defaultWorkspaceLayoutIds: WorkspaceLayoutIdSource = {
createNodeId: (prefix) => `${prefix}_${createRandomIdValue()}`,
createFocusRestorationToken: () => `workspace-focus-${createRandomIdValue()}`,
@@ -59,6 +59,84 @@ it("skips unchanged reconciliations and immediately saves real layout changes",
);
});
it("hydrates a saved preview collision and persists the repaired identities", async () => {
const workspaceKey = "server:workspace";
const duplicateId = "file_a.ts";
const values = new Map([
[
"workspace-layout-state",
JSON.stringify({
version: 2,
state: {
layoutByWorkspace: {
[workspaceKey]: {
root: {
kind: "group",
group: {
id: "split",
direction: "horizontal",
sizes: [0.5, 0.5],
children: [
{ id: "main", path: "b.ts" },
{ id: "right", path: "a.ts" },
].map(({ id, path }) => ({
kind: "pane",
pane: {
id,
tabIds: [duplicateId],
focusedTabId: duplicateId,
tabs: [{ tabId: duplicateId, target: { kind: "file", path }, createdAt: 1 }],
},
})),
},
},
focusedPaneId: "right",
},
},
},
}),
],
]);
const storage: StateStorage = {
getItem: (name) => values.get(name) ?? null,
setItem: (name, value) => {
values.set(name, value);
},
removeItem: (name) => {
values.delete(name);
},
};
const store = createWorkspaceLayoutStore(undefined, storage);
await store.persist.rehydrate();
const layout = store.getState().layoutByWorkspace[workspaceKey];
const tabs = collectAllTabs(layout.root);
expect(tabs.filter((tab) => tab.target.kind === "file").map((tab) => tab.tabId)).toEqual([
"file_b.ts",
"file_a.ts",
]);
expect(
deriveWorkspacePaneState({ layout, tabs, paneId: "main" }).activeTab?.descriptor.target,
).toEqual({
kind: "file",
path: "b.ts",
});
expect(
deriveWorkspacePaneState({ layout, tabs, paneId: "right" }).activeTab?.descriptor.target,
).toEqual({
kind: "file",
path: "a.ts",
});
store.getState().focusTab(workspaceKey, "file_b.ts");
expect(store.getState().layoutByWorkspace[workspaceKey].focusedPaneId).toBe("main");
const reloaded = createWorkspaceLayoutStore(undefined, storage);
await reloaded.persist.rehydrate();
expect(reloaded.getState().layoutByWorkspace[workspaceKey]).toEqual(
store.getState().layoutByWorkspace[workspaceKey],
);
});
it("keeps the saved layout when the shell publishes its layout mode before hydration", async () => {
const values = new Map<string, string>();
const storage: StateStorage = {
@@ -906,6 +906,91 @@ describe("workspace-layout-store actions", () => {
).toEqual(override);
});
it("keeps reused file tabs unique and focuses the matching split pane", () => {
const workspaceKey = createWorkspaceKey();
const store = workspaceLayoutStore.getState();
const firstTabId = store.openTab({
workspaceKey,
target: { kind: "file", path: "src/a.ts" },
intent: "reveal",
})!;
store.replaceTab(workspaceKey, firstTabId, { kind: "file", path: "src/b.ts" });
const rightPaneId = store.splitPaneEmpty(workspaceKey, {
targetPaneId: "main",
position: "right",
});
if (!rightPaneId) throw new Error("Expected a right split pane");
const rightTabId = store.openTab({
workspaceKey,
target: { kind: "file", path: "src/a.ts" },
intent: "reveal",
placement: { mode: "pane", paneId: rightPaneId },
})!;
store.openTab({
workspaceKey,
target: { kind: "file", path: "src/b.ts" },
intent: "reveal",
});
store.focusTab(workspaceKey, rightTabId);
const layout = workspaceLayoutStore.getState().layoutByWorkspace[workspaceKey];
const fileTabs = collectAllTabs(layout.root).filter((tab) => tab.target.kind === "file");
expect({
fileTabCount: fileTabs.length,
uniqueFileTabCount: new Set(fileTabs.map((tab) => tab.tabId)).size,
fileTargets: fileTabs.map((tab) => tab.target),
focusedPaneId: layout.focusedPaneId,
}).toEqual({
fileTabCount: 2,
uniqueFileTabCount: 2,
fileTargets: [
{ kind: "file", path: "src/b.ts" },
{ kind: "file", path: "src/a.ts" },
],
focusedPaneId: rightPaneId,
});
});
it("allocates distinct ids across retained tabs, sheets, and background opens", () => {
const workspaceKey = createWorkspaceKey();
const layoutStore = createWorkspaceLayoutStore(workspaceLayoutIds);
const store = layoutStore.getState();
const fileTabId = store.openTab({
workspaceKey,
target: { kind: "file", path: "src/a.ts" },
intent: "reveal",
})!;
store.replaceTab(workspaceKey, fileTabId, { kind: "file", path: "src/b.ts" });
layoutStore.setState({ layoutMode: "compact" });
const sheetTabId = store.openTab({
workspaceKey,
target: { kind: "file", path: "src/a.ts" },
intent: "reveal",
})!;
const selectedSheet = selectSheetTab(layoutStore.getState(), {
workspaceKey,
target: { kind: "file", path: "src/a.ts" },
});
expect(selectedSheet?.tab.tabId).toBe(sheetTabId);
const backgroundTabId = store.openTab({
workspaceKey,
target: { kind: "file", path: "src/a.ts" },
intent: "background",
})!;
expect(new Set([fileTabId, sheetTabId, backgroundTabId]).size).toBe(3);
expect(layoutStore.getState().sheetsByWorkspace[workspaceKey]).toHaveLength(1);
expect(
collectAllTabs(layoutStore.getState().layoutByWorkspace[workspaceKey].root)
.filter((tab) => tab.target.kind === "file")
.map((tab) => tab.target),
).toEqual([
{ kind: "file", path: "src/b.ts" },
{ kind: "file", path: "src/a.ts" },
]);
});
it("keeps the tab instance when a panel receives a same-kind replacement", () => {
const workspaceKey = createWorkspaceKey();
const store = workspaceLayoutStore.getState();
@@ -3200,6 +3285,75 @@ describe("workspace-layout-store actions", () => {
]);
});
it("repairs persisted duplicate ids without losing tabs, pane focus, or unambiguous parents", () => {
const file = (tabId: string, path: string) => ({
tabId,
target: { kind: "file", path },
createdAt: 1,
state: { treeVisible: true, treeWidth: 280 },
});
const leftTabs = [file("file_a.ts", "b.ts"), file("file_a.ts", "c.ts")];
const rightTabs = [
file("file_a.ts", "a.ts"),
file("file_b.ts", "b.ts"),
file("file_b.ts:2", "b.ts"),
file("child", "child.ts"),
file("parent", "parent.ts"),
];
const layout = normalizeLayout({
root: {
kind: "group",
group: {
id: "root",
direction: "horizontal",
sizes: [0.4, 0.6],
children: [
{
kind: "pane",
pane: {
id: "main",
tabs: leftTabs,
tabIds: leftTabs.map((tab) => tab.tabId),
focusedTabId: "file_a.ts",
},
},
{
kind: "pane",
pane: {
id: "right",
tabs: rightTabs,
tabIds: rightTabs.map((tab) => tab.tabId),
focusedTabId: "file_a.ts",
hidden: true,
},
},
],
},
},
focusedPaneId: "main",
parentTabIdByTabId: {
"file_a.ts": "parent",
"file_b.ts": "file_a.ts",
child: "parent",
},
});
const tabs = collectAllTabs(layout.root);
expect(tabs).toHaveLength(7);
expect(new Set(tabs.map((tab) => tab.tabId)).size).toBe(7);
expect(tabs[0]).toEqual({ ...leftTabs[0], tabId: "file_b.ts:3" });
expect(tabs[1]).toEqual({ ...leftTabs[1], tabId: "file_c.ts" });
expect(tabs.slice(2)).toEqual(rightTabs);
expect(findPaneById(layout.root, "main")?.tabIds).toEqual(["file_b.ts:3", "file_c.ts"]);
expect(findPaneById(layout.root, "main")?.focusedTabId).toBe("file_b.ts:3");
expect(findPaneById(layout.root, "right")).toMatchObject({
hidden: true,
focusedTabId: "file_a.ts",
});
expect(layout.parentTabIdByTabId).toEqual({ child: "parent" });
expect(normalizeLayout(layout)).toEqual(layout);
});
it("hydrates duplicate Changes and Pull request instances without collapsing their ids or state", () => {
const tabs = [
{
@@ -5110,6 +5264,50 @@ describe("compact workspace sheet", () => {
expect(sheetTargets(store)).toEqual([fileTarget, nextTarget]);
});
it("reserves a retargeted sheet's id when reconciling a new root agent tab", () => {
seedAgents([
{ id: "root", parentAgentId: null, workspaceId: "sheet-ws" },
{ id: "child-a", parentAgentId: "root", workspaceId: "sheet-ws" },
{ id: "child-b", parentAgentId: "root", workspaceId: "sheet-ws" },
]);
const store = createCompactStore();
store.getState().openTab({
workspaceKey,
target: { kind: "agent", agentId: "child-a" },
intent: "reveal",
});
const sheetId = requireTopSheet(store).tab.tabId;
store.getState().replaceTab(workspaceKey, sheetId, { kind: "agent", agentId: "child-b" });
seedAgents([
{ id: "root", parentAgentId: null, workspaceId: "sheet-ws" },
{ id: "child-a", parentAgentId: null, workspaceId: "sheet-ws" },
{ id: "child-b", parentAgentId: "root", workspaceId: "sheet-ws" },
]);
store.getState().reconcileTabs(workspaceKey, {
agentsHydrated: true,
terminalsHydrated: true,
activeAgentIds: ["root", "child-a", "child-b"],
autoOpenAgentIds: ["child-a"],
knownTerminalIds: ["term-1"],
standaloneTerminalIds: ["term-1"],
});
const tab = collectAllTabs(store.getState().layoutByWorkspace[workspaceKey].root).find(
(candidate) => candidate.target.kind === "agent" && candidate.target.agentId === "child-a",
);
if (!tab) throw new Error("Expected the root agent's tab");
expect(tab.tabId).not.toBe(sheetId);
store.getState().closeTab(workspaceKey, tab.tabId);
expect(requireTopSheet(store).tab).toMatchObject({
tabId: sheetId,
target: { kind: "agent", agentId: "child-b" },
});
expect(
collectAllTabs(store.getState().layoutByWorkspace[workspaceKey].root),
).not.toContainEqual(tab);
});
it("closes the sheet when its agent stops being a subagent, leaving one tab for it", () => {
seedAgents([
{ id: "root", parentAgentId: null, workspaceId: "sheet-ws" },
@@ -7,6 +7,8 @@ import { WorkspaceLayoutPersistedStateSchema } from "./workspace-layout-storage"
import type { JsonValue } from "@getpaseo/protocol/agent-types";
import type { WorkspaceTab, WorkspaceTabTarget } from "@/workspace-tabs/model";
import {
allocateWorkspaceTabId,
createWorkspaceTabInstanceId,
defaultWorkspaceLayoutIds,
type WorkspaceLayoutIdSource,
} from "@/stores/workspace-layout-ids";
@@ -431,14 +433,6 @@ function trimNonEmpty(value: string | null | undefined): string | null {
return trimmed.length > 0 ? trimmed : null;
}
function createWorkspaceTabInstanceId(): string {
const value =
typeof globalThis.crypto?.randomUUID === "function"
? globalThis.crypto.randomUUID()
: `${Date.now()}-${Math.random().toString(16).slice(2)}`;
return `tab_${value}`;
}
function addAgentIdToWorkspaceSet(
state: Record<string, Set<string>>,
workspaceKey: string,
@@ -531,7 +525,10 @@ export function selectExplorerSidebarPaneId(
*/
export function selectSheetTab(
state: Pick<WorkspaceLayoutStore, "layoutMode" | "layoutByWorkspace" | "sheetsByWorkspace">,
input: Pick<OpenWorkspaceTabInput, "workspaceKey" | "target" | "parentTabId">,
input: Pick<OpenWorkspaceTabInput, "workspaceKey" | "target" | "parentTabId"> & {
/** A host outside the sheet stack owns its instance identity. */
preferredTabId?: string;
},
): SheetTab | null {
const workspaceKey = trimNonEmpty(input.workspaceKey);
const target = normalizeWorkspaceTabTarget(input.target);
@@ -539,9 +536,14 @@ export function selectSheetTab(
const policy = resolveSheetPolicy(state, workspaceKey, target, "reveal");
if (!policy) return null;
return placeTargetInSheet({
kept: undefined,
occupiedTabIds: collectWorkspaceTabIds(state, workspaceKey),
kept: input.preferredTabId
? undefined
: getSheets(state, workspaceKey).find(
(sheet) => panelResourceKey(sheet.tab.target) === panelResourceKey(target),
),
target,
intent: "reveal",
createTabId: () => input.preferredTabId ?? buildDeterministicWorkspaceTabId(target),
policy,
parentTabId: resolveOpenParentTabId(state, workspaceKey, input.parentTabId),
state: undefined,
@@ -638,6 +640,7 @@ function getOpenTabPlacement(
layout: WorkspaceLayout;
placement: WorkspaceTabPlacement;
explorerSidebarPaneId: string | null;
reservedTabIds: Set<string>;
} {
const layout = getWorkspaceLayout(state.layoutByWorkspace, workspaceKey);
const explorerSidebarPaneId = resolveExplorerSidebarPaneId(
@@ -670,6 +673,7 @@ function getOpenTabPlacement(
layout,
placement: resolvedPlacement,
explorerSidebarPaneId,
reservedTabIds: new Set(getSheets(state, workspaceKey).map((sheet) => sheet.tab.tabId)),
};
}
@@ -815,11 +819,23 @@ function resolveOpenParentTabId(
return findSheet(state, workspaceKey, parentTabId)?.parentTabId ?? parentTabId;
}
function collectWorkspaceTabIds(
state: Pick<WorkspaceLayoutStore, "layoutByWorkspace" | "sheetsByWorkspace">,
workspaceKey: string,
): Set<string> {
const layout = state.layoutByWorkspace[workspaceKey];
return new Set([
...(layout ? collectAllTabs(layout.root).map((tab) => tab.tabId) : []),
...getSheets(state, workspaceKey).map((sheet) => sheet.tab.tabId),
]);
}
function placeTargetInSheet(input: {
occupiedTabIds: ReadonlySet<string>;
/** The sheet whose tab the target keeps, if any. */
kept: SheetTab | undefined;
target: WorkspaceTabTarget;
intent: WorkspaceTabOpenIntent;
createTabId: () => string;
policy: CompactSheetPolicy;
parentTabId: string | null;
state: JsonValue | undefined;
@@ -829,10 +845,7 @@ function placeTargetInSheet(input: {
}
return {
tab: {
tabId:
input.intent === "reveal"
? buildDeterministicWorkspaceTabId(input.target)
: createWorkspaceTabInstanceId(),
tabId: allocateWorkspaceTabId(input.createTabId(), input.occupiedTabIds),
target: input.target,
createdAt: Date.now(),
...(input.state !== undefined ? { state: input.state } : {}),
@@ -853,6 +866,7 @@ function promoteSheetToTab(
): { tabId: string; patch: Partial<WorkspaceLayoutStore> } | null {
const { tab } = sheet;
const placement = getOpenTabPlacement(state, workspaceKey, tab.target, FOCUSED_PANE_PLACEMENT);
placement.reservedTabIds.delete(tab.tabId);
const input = {
...placement,
target: tab.target,
@@ -1122,9 +1136,13 @@ export function createWorkspaceLayoutStore(
const sheets = getSheets(get(), normalizedWorkspaceKey);
const { keptIndex } = sheetPlacement;
const sheet = placeTargetInSheet({
occupiedTabIds: collectWorkspaceTabIds(get(), normalizedWorkspaceKey),
kept: keptIndex === null ? undefined : sheets[keptIndex],
target: normalizedTarget,
intent: input.intent,
createTabId: () =>
input.intent === "reveal"
? buildDeterministicWorkspaceTabId(normalizedTarget)
: createWorkspaceTabInstanceId(),
policy: sheetPlacement.policy,
parentTabId,
state: input.state,
@@ -1706,9 +1724,14 @@ export function createWorkspaceLayoutStore(
explorerSidebarPaneId,
rawLayout.focusedPaneId,
);
const sheets = getSheets(state, normalizedWorkspaceKey);
const fittingSheets = sheets.filter(
(sheet) => !sheetAgentNoLongerFits(normalizedWorkspaceKey, sheet, snapshot),
);
const nextState = reconcileWorkspaceTabs(
{
layout: currentLayout,
reservedTabIds: new Set(fittingSheets.map((sheet) => sheet.tab.tabId)),
pinnedAgentIds: state.pinnedAgentIdsByWorkspace[normalizedWorkspaceKey] ?? null,
hiddenAgentIds: state.hiddenAgentIdsByWorkspace[normalizedWorkspaceKey] ?? null,
explorerSidebarPaneId,
@@ -1730,10 +1753,6 @@ export function createWorkspaceLayoutStore(
);
}
}
const sheets = getSheets(state, normalizedWorkspaceKey);
const fittingSheets = sheets.filter(
(sheet) => !sheetAgentNoLongerFits(normalizedWorkspaceKey, sheet, snapshot),
);
const sheetAgentGone = fittingSheets.length !== sheets.length;
if (
state.layoutByWorkspace[normalizedWorkspaceKey] &&
@@ -138,6 +138,88 @@ describe("useSubagentSheetTab", () => {
expect(result.current?.tab.tabId).toBe(tabId);
});
it("keeps an open menu sheet's id when an unrelated reused tab disappears", () => {
const row = seedParentWithChild();
const store = useWorkspaceLayoutStore.getState();
const reusedId = store.openTab({
workspaceKey,
target: { kind: "agent", agentId: "child" },
intent: "reveal",
asTab: true,
});
if (!reusedId) throw new Error("Expected a child tab");
store.replaceTab(workspaceKey, reusedId, { kind: "agent", agentId: "other" });
store.setLayoutMode("compact");
const { result } = renderHook(() => useSubagentSheetTab(workspaceKey, "parent-tab")(row));
const sheetId = result.current?.tab.tabId;
expect(result.current?.tab.target).toEqual({ kind: "agent", agentId: "child" });
expect(sheetId).not.toBe(reusedId);
act(() => {
store.reconcileTabs(workspaceKey, {
agentsHydrated: true,
terminalsHydrated: true,
activeAgentIds: ["parent", "child"],
autoOpenAgentIds: [],
knownTerminalIds: [],
standaloneTerminalIds: [],
});
});
expect(store.getWorkspaceTabs(workspaceKey).map((tab) => tab.tabId)).not.toContain(reusedId);
expect(result.current?.tab.tabId).toBe(sheetId);
expect(result.current?.tab.target).toEqual({ kind: "agent", agentId: "child" });
});
it("promotes a menu sheet to the subagent's own tab", () => {
const row = seedParentWithChild();
const store = useWorkspaceLayoutStore.getState();
store.setLayoutMode("compact");
const { result } = renderHook(() => useSubagentSheetTab(workspaceKey, "parent-tab")(row));
const sheet = result.current;
if (!sheet) throw new Error("Expected a menu sheet");
let promotedId: string | null = null;
act(() => {
promotedId = store.openTabInFront(workspaceKey, sheet);
});
expect(promotedId).toBe("agent_child");
expect(
store.getWorkspaceTabs(workspaceKey).filter((tab) => tab.target.kind === "agent"),
).toEqual([
expect.objectContaining({
tabId: "agent_child",
target: { kind: "agent", agentId: "child" },
}),
]);
});
it("does not reuse a menu id retained by a promoted tab showing another target", () => {
const row = seedParentWithChild();
const store = useWorkspaceLayoutStore.getState();
store.setLayoutMode("compact");
const { result } = renderHook(() => useSubagentSheetTab(workspaceKey, "parent-tab")(row));
const sheet = result.current;
if (!sheet) throw new Error("Expected a menu sheet");
act(() => {
store.openTabInFront(workspaceKey, sheet);
});
expect(result.current).toBeNull();
act(() => {
store.replaceTab(workspaceKey, sheet.tab.tabId, { kind: "agent", agentId: "other" });
});
expect(result.current?.tab.target).toEqual({ kind: "agent", agentId: "child" });
expect(result.current?.tab.tabId).not.toBe(sheet.tab.tabId);
expect(
store.getWorkspaceTabs(workspaceKey).filter((tab) => tab.target.kind === "agent"),
).toEqual([
expect.objectContaining({
tabId: sheet.tab.tabId,
target: { kind: "agent", agentId: "other" },
}),
]);
});
it("hands a re-rendered row the same sheet", () => {
const row = seedParentWithChild();
useWorkspaceLayoutStore.getState().setLayoutMode("compact");
+10 -3
View File
@@ -4,6 +4,7 @@ import {
useWorkspaceLayoutStore,
type SheetTab,
} from "@/stores/workspace-layout-store";
import { buildDeterministicWorkspaceTabId } from "@/workspace-tabs/identity";
import type { WorkspaceTabTarget } from "@/workspace-tabs/model";
import type { SubagentRow } from "./select";
@@ -32,6 +33,9 @@ export function useSubagentSheetTab(
const sheets = useWorkspaceLayoutStore((state) =>
workspaceKey ? state.sheetsByWorkspace[workspaceKey] : undefined,
);
// Menu pages never enter the sheet stack. Each starts from the subagent's own tab id, so opening
// it as a tab lands on that id, and keeps the id it was given across layout updates.
const tabIds = useMemo(() => new Map<string, string>(), []);
return useMemo(() => {
// One answer per row until the state it reads changes, so a re-render of the list hands an
// open sheet the same tab rather than a fresh one.
@@ -43,16 +47,19 @@ export function useSubagentSheetTab(
layoutByWorkspace: layout ? { [workspaceKey]: layout } : {},
sheetsByWorkspace: sheets ? { [workspaceKey]: sheets } : {},
};
const key = `${row.kind}:${row.id}`;
const key = JSON.stringify([workspaceKey, parentTabId, row.kind, row.id]);
const known = answers.get(key);
if (known !== undefined) return known;
const target = subagentRowTarget(row);
const sheet = selectSheetTab(state, {
workspaceKey,
target: subagentRowTarget(row),
target,
parentTabId,
preferredTabId: tabIds.get(key) ?? buildDeterministicWorkspaceTabId(target),
});
if (sheet) tabIds.set(key, sheet.tab.tabId);
answers.set(key, sheet);
return sheet;
};
}, [layout, layoutMode, parentTabId, sheets, workspaceKey]);
}, [layout, layoutMode, parentTabId, sheets, tabIds, workspaceKey]);
}
@@ -5,9 +5,11 @@ import {
normalizeStoredHostProfile,
orderHostsLocalFirst,
pinRelayProtectedSecurityInProfiles,
readHostRegistry,
relayConnectionFromOffer,
resolveActiveHostServerId,
upsertHostConnectionInProfiles,
writeHostRegistry,
type HostConnection,
type HostProfile,
} from "./host-connection";
@@ -87,6 +89,25 @@ describe("normalizeStoredHostProfile", () => {
expect(profile?.connections[0]).not.toHaveProperty("password");
});
it("drops a connection kind this build doesn't know and keeps the host", () => {
const profile = normalizeStoredHostProfile({
serverId: "srv_mixed",
password: "secret",
connections: [
{ id: "future:1", type: "futureKind", address: "future.example.com" },
{ id: "direct:lan:6767", type: "directTcp", endpoint: "lan:6767", futureField: true },
{ id: "direct:remote:6767", type: "directTcp", endpoint: "remote:6767" },
],
preferredConnectionId: "direct:remote:6767",
});
expect(profile?.password).toBe("secret");
expect(profile?.connections).toEqual([
{ id: "direct:remote:6767", type: "directTcp", endpoint: "remote:6767", useTls: false },
]);
expect(profile?.preferredConnectionId).toBe("direct:remote:6767");
});
it("preserves legacy relay ids when TLS is absent", () => {
const profile = normalizeStoredHostProfile({
serverId: "srv_relay",
@@ -177,6 +198,59 @@ describe("normalizeStoredHostProfile", () => {
});
});
describe("readHostRegistry and writeHostRegistry", () => {
const direct: HostConnection = {
id: "direct:lan:6767",
type: "directTcp",
endpoint: "lan:6767",
useTls: false,
};
const future = { id: "future:1", type: "futureKind", address: "future.example.com" };
it("writes back every entry it could not read", () => {
const unreadableHost = { serverId: "srv_future", connections: [future] };
const hostWithFutureField = { serverId: "srv_field", connections: [direct], futureField: 1 };
const stored = [
{ ...makeHost("srv_a"), connections: [direct, future] },
unreadableHost,
hostWithFutureField,
"not a host",
];
const { hosts, unreadable } = readHostRegistry(stored);
expect(hosts.map((host) => host.serverId)).toEqual(["srv_a"]);
expect(hosts[0]?.connections).toEqual([direct]);
expect(writeHostRegistry(hosts, unreadable)).toEqual([
{ ...hosts[0], connections: [direct, future] },
unreadableHost,
hostWithFutureField,
"not a host",
]);
});
it("writes a host saved again by this build in place of the entry it could not read", () => {
const { hosts, unreadable } = readHostRegistry([{ serverId: "srv_a", connections: [future] }]);
expect(hosts).toEqual([]);
const saved = { ...makeHost("srv_a"), connections: [direct] };
expect(writeHostRegistry([saved], unreadable)).toEqual([saved]);
});
it("moves a stored direct TCP password to its host next to a connection it can't read", () => {
const registry = readHostRegistry([
{
serverId: "srv_legacy",
connections: [future, { type: "directTcp", endpoint: "lan:6767", password: "old-secret" }],
},
]);
expect(registry.movedConnectionPassword).toBe(true);
expect(registry.hosts[0]?.password).toBe("old-secret");
expect(registry.hosts[0]?.connections).toEqual([direct]);
});
});
describe("createRemoteSshHostConnection", () => {
it("keeps optional SSH settings absent", () => {
expect(createRemoteSshHostConnection({ host: "build-box" })).toEqual({
+102 -13
View File
@@ -522,12 +522,12 @@ const StoredHostProfileSchema = z.strictObject({
label: z.string().optional(),
appearance: HostAppearanceSchema.optional(),
lifecycle: z.strictObject({}).optional(),
connections: z.array(StoredHostConnectionSchema).min(1),
// Read one by one, so a connection kind another build wrote skips only that connection.
connections: z.array(z.unknown()).min(1),
preferredConnectionId: z.string().nullable().optional(),
createdAt: z.string().datetime({ offset: true }).optional(),
updatedAt: z.string().datetime({ offset: true }).optional(),
});
export const StoredHostRegistrySchema = z.array(StoredHostProfileSchema);
type StoredHostConnection = z.infer<typeof StoredHostConnectionSchema>;
function normalizeStoredConnection(connection: StoredHostConnection): HostConnection | null {
@@ -590,20 +590,37 @@ function normalizeStoredConnection(connection: StoredHostConnection): HostConnec
}
export function normalizeStoredHostProfile(entry: unknown): HostProfile | null {
return readStoredHost(entry)?.profile ?? null;
}
interface StoredHostRead {
profile: HostProfile;
unreadableConnections: unknown[];
movedConnectionPassword: boolean;
}
function readStoredHost(entry: unknown): StoredHostRead | null {
const result = StoredHostProfileSchema.safeParse(entry);
if (!result.success) {
return null;
}
const record = result.data;
const serverId = record.serverId;
const storedConnections: StoredHostConnection[] = [];
const unreadableConnections: unknown[] = [];
for (const stored of record.connections) {
const parsed = StoredHostConnectionSchema.safeParse(stored);
if (parsed.success) storedConnections.push(parsed.data);
else unreadableConnections.push(stored);
}
// COMPAT(connectionPassword): added in v0.9.1, remove after 2027-03-24 once stored direct passwords have migrated.
const legacyPassword = record.connections.find(
const legacyPassword = storedConnections.find(
(connection) => connection.type === "directTcp" && connection.password,
);
const password =
record.password ?? (legacyPassword?.type === "directTcp" ? legacyPassword.password : undefined);
const connections = record.connections
const connections = storedConnections
.map((connection) => normalizeStoredConnection(connection))
.filter((connection): connection is HostConnection => connection !== null);
if (connections.length === 0) {
@@ -620,18 +637,90 @@ export function normalizeStoredHostProfile(entry: unknown): HostProfile | null {
: (connections[0]?.id ?? null);
return {
serverId,
...(password ? { password } : {}),
label,
appearance: record.appearance ?? defaultHostAppearance(),
lifecycle: defaultLifecycle(),
connections,
preferredConnectionId,
createdAt: record.createdAt ?? now,
updatedAt: record.updatedAt ?? now,
profile: {
serverId,
...(password ? { password } : {}),
label,
appearance: record.appearance ?? defaultHostAppearance(),
lifecycle: defaultLifecycle(),
connections,
preferredConnectionId,
createdAt: record.createdAt ?? now,
updatedAt: record.updatedAt ?? now,
},
unreadableConnections,
movedConnectionPassword: legacyPassword !== undefined,
};
}
/**
* Stored registry entries this build can't read, such as a connection kind added by a newer
* build. `writeHostRegistry` writes them back so that build still finds them.
*/
export interface UnreadableHostEntries {
hosts: unknown[];
connectionsByServerId: Map<string, unknown[]>;
}
export function readHostRegistry(stored: unknown[]): {
hosts: HostProfile[];
unreadable: UnreadableHostEntries;
// COMPAT(connectionPassword): added in v0.9.1, remove after 2027-03-24 with stored-password migration.
movedConnectionPassword: boolean;
} {
const hosts: HostProfile[] = [];
const unreadable: UnreadableHostEntries = { hosts: [], connectionsByServerId: new Map() };
let movedConnectionPassword = false;
for (const entry of stored) {
const read = readStoredHost(entry);
if (!read) {
unreadable.hosts.push(entry);
continue;
}
hosts.push(read.profile);
if (read.unreadableConnections.length > 0) {
unreadable.connectionsByServerId.set(read.profile.serverId, read.unreadableConnections);
}
movedConnectionPassword ||= read.movedConnectionPassword;
}
return { hosts, unreadable, movedConnectionPassword };
}
export function writeHostRegistry(
hosts: HostProfile[],
unreadable: UnreadableHostEntries,
): unknown[] {
const savedServerIds = new Set(hosts.map((host) => host.serverId));
const written: unknown[] = hosts.map((host) => {
const kept = unreadable.connectionsByServerId.get(host.serverId);
return kept ? { ...host, connections: [...host.connections, ...kept] } : host;
});
for (const entry of unreadable.hosts) {
// A host this build saved again replaces the entry it couldn't read.
const serverId = readStoredServerId(entry);
if (serverId === null || !savedServerIds.has(serverId)) written.push(entry);
}
return written;
}
/** Drops the entries this build couldn't read for a host you removed. */
export function forgetUnreadableHost(
unreadable: UnreadableHostEntries,
serverId: string,
): UnreadableHostEntries {
const connectionsByServerId = new Map(unreadable.connectionsByServerId);
connectionsByServerId.delete(serverId);
return {
hosts: unreadable.hosts.filter((entry) => readStoredServerId(entry) !== serverId),
connectionsByServerId,
};
}
function readStoredServerId(entry: unknown): string | null {
if (typeof entry !== "object" || entry === null || !("serverId" in entry)) return null;
return typeof entry.serverId === "string" ? entry.serverId.trim() : null;
}
export function hostHasConnection(host: HostProfile, connection: HostConnection): boolean {
return host.connections.some((existing) => hostConnectionEquals(existing, connection));
}
+2 -2
View File
@@ -47,7 +47,7 @@ export function addSendOptions(cmd: Command): Command {
.addOption(
new Option(
"--behavior <behavior>",
"Active-turn behavior (agent default: steer; otherwise: interrupt)",
"Active-turn behavior (agent default: steer waits for turn end; otherwise: interrupt)",
).choices(["interrupt", "steer"]),
)
.option("--no-wait", "Return immediately without waiting for completion");
@@ -218,7 +218,7 @@ export async function runSendCommand(
status: receipt.deliveryStatus ?? "sent",
message:
receipt.deliveryStatus === "queued"
? "Message queued for delivery after two quiet seconds"
? "Message queued for delivery after two quiet seconds and the current turn ends, unless interrupt was requested"
: "Message sent, not waiting for completion",
},
schema: agentSendSchema,
+1 -1
View File
@@ -483,7 +483,7 @@ export interface SendMessageOptions {
sourceAgentServerId?: string;
sessionMode?: string;
messageId?: string;
/** What happens when the agent is mid-turn. The daemon interrupts the turn when omitted. */
/** Agent sources wait for turn end unless interrupt is explicit. Human sources default to interrupt. */
activeTurnBehavior?: ActiveTurnBehavior;
images?: Array<{ data: string; mimeType: string }>;
attachments?: SendAgentMessageRequest["attachments"];
@@ -0,0 +1,64 @@
import type { Page } from "@playwright/test";
import { test, expect } from "../../app/e2e/support/fixtures";
import { gotoAppShell } from "../../app/e2e/support/helpers/app";
// Windows and Linux draw their window controls top-right, so the desktop sidebar has no
// chrome row of its own. Its window-drag surface is the strip above the navigation rows.
const CUSTOM_CHROME_HOSTS = [
{ platform: "linux", windowChromeMode: "custom-linux" },
{ platform: "win32", windowChromeMode: "custom-windows" },
] as const;
async function installDesktopHost(
page: Page,
host: (typeof CUSTOM_CHROME_HOSTS)[number],
): Promise<void> {
await page.addInitScript((desktopHost) => {
window.paseoDesktop = {
...desktopHost,
events: { on: () => () => {} },
invoke: async (command: string) => {
if (command === "get_desktop_settings") {
return {
releaseChannel: "stable",
daemon: { manageBuiltInDaemon: true, keepRunningAfterQuit: true },
};
}
return null;
},
};
}, host);
}
async function sidebarDragGeometry(page: Page) {
const navScroll = page.locator('[data-testid="sidebar-nav-scroll"]:visible').first();
await expect(navScroll).toBeVisible();
return navScroll.evaluate((node) => {
const nav = node.getBoundingClientRect();
const dragRegions = [];
for (const element of document.querySelectorAll<HTMLElement>("*")) {
if (getComputedStyle(element).getPropertyValue("-webkit-app-region") !== "drag") continue;
const rect = element.getBoundingClientRect();
const overSidebar = rect.left < nav.right && rect.right > nav.left;
if (overSidebar && rect.height > 0) dragRegions.push({ top: rect.top, bottom: rect.bottom });
}
return { navTop: nav.top, navBottom: nav.bottom, dragRegions };
});
}
for (const host of CUSTOM_CHROME_HOSTS) {
test.describe(`Desktop sidebar on ${host.platform}`, () => {
test.use({ viewport: { width: 1280, height: 480 } });
test("keeps a window drag strip above the scrolling navigation", async ({ page }) => {
await installDesktopHost(page, host);
await gotoAppShell(page);
const geometry = await sidebarDragGeometry(page);
expect(geometry.dragRegions).not.toEqual([]);
for (const region of geometry.dragRegions) {
expect(region.bottom).toBeLessThanOrEqual(geometry.navTop + 1);
}
});
});
}
+2
View File
@@ -88,6 +88,8 @@ export interface PluginSessionOpenRequest {
readonly background: boolean;
readonly labels: Readonly<Record<string, string>>;
readonly metadata: Readonly<Record<string, JsonValue>>;
/** Instructions appended for this open; not saved on the agent. */
appendSystemPrompt?: string[];
tools: AgentToolDefinition[];
env: Record<string, string>;
mcpServers: NonNullable<AgentSessionConfig["mcpServers"]>;
@@ -14,18 +14,19 @@ const BASE_RECORD: StoredAgentRecord = {
config: null,
};
const ARCHIVE = {
archivedAt: "2025-01-03T00:00:00.000Z",
updatedAt: "2025-01-03T00:00:00.000Z",
};
test("archives a stored agent without changing terminal statuses", () => {
const statuses: Array<StoredAgentRecord["lastStatus"]> = ["idle", "error", "closed"];
for (const status of statuses) {
const archived = buildArchivedAgentRecord(
{ ...BASE_RECORD, lastStatus: status },
{ archivedAt: "2025-01-03T00:00:00.000Z" },
);
const archived = buildArchivedAgentRecord({ ...BASE_RECORD, lastStatus: status }, ARCHIVE);
expect(archived.lastStatus).toBe(status);
expect(archived.archivedAt).toBe("2025-01-03T00:00:00.000Z");
expect(archived.updatedAt).toBe(BASE_RECORD.updatedAt);
}
});
@@ -33,10 +34,7 @@ test("archives busy stored agents as idle", () => {
const statuses: Array<StoredAgentRecord["lastStatus"]> = ["initializing", "running"];
for (const status of statuses) {
const archived = buildArchivedAgentRecord(
{ ...BASE_RECORD, lastStatus: status },
{ archivedAt: "2025-01-03T00:00:00.000Z" },
);
const archived = buildArchivedAgentRecord({ ...BASE_RECORD, lastStatus: status }, ARCHIVE);
expect(archived.lastStatus).toBe("idle");
}
@@ -50,7 +48,7 @@ test("clears persisted attention when archiving", () => {
attentionReason: "finished",
attentionTimestamp: "2025-01-02T12:00:00.000Z",
},
{ archivedAt: "2025-01-03T00:00:00.000Z" },
ARCHIVE,
);
expect(archived).toMatchObject({
@@ -60,11 +58,19 @@ test("clears persisted attention when archiving", () => {
});
});
test("can stamp updatedAt to the archive timestamp", () => {
const archived = buildArchivedAgentRecord(BASE_RECORD, {
archivedAt: "2025-01-03T00:00:00.000Z",
updatedAt: "2025-01-03T00:00:00.000Z",
});
test("moves updatedAt to the archive time", () => {
const archived = buildArchivedAgentRecord(BASE_RECORD, ARCHIVE);
expect(archived.updatedAt).toBe("2025-01-03T00:00:00.000Z");
});
test("keeps a later updatedAt when the archive time is earlier", () => {
// Putting an original archive back after a failed unarchive must not move updatedAt backwards.
const archived = buildArchivedAgentRecord(
{ ...BASE_RECORD, updatedAt: "2025-01-04T00:00:00.000Z" },
ARCHIVE,
);
expect(archived.archivedAt).toBe("2025-01-03T00:00:00.000Z");
expect(archived.updatedAt).toBe("2025-01-04T00:00:00.000Z");
});
@@ -3,19 +3,19 @@ import type { StoredAgentRecord } from "./agent-storage.js";
export type ArchivedStoredAgentRecord = StoredAgentRecord & { archivedAt: string };
interface BuildArchivedAgentRecordOptions {
archivedAt?: string;
updatedAt?: string;
archivedAt: string;
/** When this archive happened. Re-archiving keeps the original archivedAt but still records it. */
updatedAt: string;
}
export function buildArchivedAgentRecord(
record: StoredAgentRecord,
options?: BuildArchivedAgentRecordOptions,
options: BuildArchivedAgentRecordOptions,
): ArchivedStoredAgentRecord {
const archivedAt = options?.archivedAt ?? new Date().toISOString();
return {
...record,
archivedAt,
updatedAt: options?.updatedAt ?? record.updatedAt,
archivedAt: options.archivedAt,
updatedAt: latestTimestamp(record.updatedAt, options.updatedAt),
lastStatus: normalizeArchivedStatus(record.lastStatus),
requiresAttention: false,
attentionReason: null,
@@ -23,6 +23,13 @@ export function buildArchivedAgentRecord(
};
}
// Archiving is the agent's latest change. An earlier archive time (an original archive put back
// after a failed unarchive) keeps the newer updatedAt, since clients drop an agent update that is
// older than the one they hold.
function latestTimestamp(current: string, archiveTime: string): string {
return Date.parse(archiveTime) > Date.parse(current) ? archiveTime : current;
}
function normalizeArchivedStatus(
status: StoredAgentRecord["lastStatus"],
): StoredAgentRecord["lastStatus"] {
File diff suppressed because it is too large Load Diff
@@ -29,6 +29,7 @@ import { z } from "zod";
import type { TerminalManager } from "../../terminal/terminal-manager.js";
import {
AgentTurnStartCanceledError,
getAgentStreamEventTurnId,
type AgentCapabilityFlags,
type AgentClient,
@@ -92,6 +93,7 @@ import {
import { limitAgentTimelineItemContent } from "./agent-timeline-content.js";
import {
AgentRunState,
type ForegroundPromptStart,
type ForegroundTurnWaiter,
type PendingForegroundRun,
} from "./agent-run-state.js";
@@ -634,7 +636,12 @@ function normalizePersistenceForConfig(
if (!handle) {
return null;
}
const { mcpServers: _launchMcpServers, ...metadata } = handle.metadata ?? {};
const {
mcpServers: _launchMcpServers,
pluginAppendSystemPrompt: _pluginAppendSystemPrompt,
daemonAppendSystemPrompt: _daemonAppendSystemPrompt,
...metadata
} = handle.metadata ?? {};
return {
...handle,
metadata: {
@@ -1117,6 +1124,10 @@ export class AgentManager {
return new Date(nextMs).toISOString();
}
hasPendingPermissions(agentId: string): boolean {
return (this.agents.get(agentId)?.pendingPermissions.size ?? 0) > 0;
}
hasInFlightRun(agentId: string): boolean {
const agent = this.agents.get(agentId);
if (!agent) {
@@ -1727,7 +1738,10 @@ export class AgentManager {
...(record ? { metadata: record.metadata, attention: extractAttention(record) } : {}),
workspaceId,
launchEnv,
persistence: handle,
persistence:
purpose === "interactive" && session.persistenceUpdatedOnResume
? (session.describePersistence() ?? handle)
: handle,
restoring: true,
});
}
@@ -2338,7 +2352,7 @@ export class AgentManager {
private async persistArchivedRecord(
record: StoredAgentRecord,
options: { archivedAt: string; updatedAt?: string },
options: { archivedAt: string; updatedAt: string },
): Promise<ArchivedStoredAgentRecord> {
const archivedRecord = buildArchivedAgentRecord(record, options);
await this.requireRegistry().upsert(archivedRecord);
@@ -2858,7 +2872,11 @@ export class AgentManager {
throw new Error(`Agent not found: ${agentId}`);
}
const nextRecord = await this.persistArchivedRecord(record, { archivedAt });
// Archiving is the agent's latest change, as markRecordArchived records it for a loaded agent.
const nextRecord = await this.persistArchivedRecord(record, {
archivedAt,
updatedAt: archivedAt,
});
await this.syncNativeArchiveState(record.provider, record.persistence, "archive");
@@ -3030,6 +3048,7 @@ export class AgentManager {
agentId: string,
prompt: AgentPromptInput,
options?: AgentRunOptions,
onAccepted?: () => void,
): Promise<boolean> {
if (this.collectingRuntimes.has(agentId) || !this.agents.has(agentId)) {
await this.waitForAgentClose(agentId);
@@ -3049,6 +3068,7 @@ export class AgentManager {
if (!handler) {
return false;
}
onAccepted?.();
this.touchUpdatedAt(agent);
if (options?.clientMessageId) {
this.recordSubmittedPrompt(agent, prompt, options.clientMessageId, "accepted");
@@ -3125,7 +3145,7 @@ export class AgentManager {
pendingRun: PendingForegroundRun;
prompt: AgentPromptInput;
options?: AgentRunOptions;
}): Promise<string> {
}): Promise<string | null> {
const { agent, agentId, pendingRun, prompt, options } = params;
try {
const result = await agent.session.startTurn(prompt, options);
@@ -3134,11 +3154,32 @@ export class AgentManager {
}
return result.turnId;
} catch (error) {
if (error instanceof AgentTurnStartCanceledError) {
if (!pendingRun.settled) {
if (options?.clientMessageId) {
this.recordSubmittedPrompt(agent, prompt, options.clientMessageId, "rejected", {
messageId: options.clientMessageId,
});
}
await this.handleStreamEvent(agent, {
type: "turn_canceled",
provider: agent.provider,
reason: "interrupted",
});
this.finalizeForegroundTurn(agent);
this.runs.settleForegroundRun(agentId, pendingRun.token);
}
return null;
}
if (pendingRun.settled) {
throw error;
}
if (isStaleProviderSessionError(error)) {
this.runs.settleForegroundStart(pendingRun, { status: "failed", error: error.message });
this.runs.settleForegroundStart(pendingRun, {
status: "failed",
error: error.message,
stale: true,
});
agent.pendingReplacement = false;
if (!agent.activeForegroundTurnId) agent.lifecycle = "idle";
this.runs.settleForegroundRun(agentId, pendingRun.token);
@@ -3194,15 +3235,17 @@ export class AgentManager {
agentId: string,
prompt: AgentPromptInput,
options?: AgentRunOptions,
promptStart?: ForegroundPromptStart,
): AsyncGenerator<AgentStreamEvent> {
await this.ensureInteractiveSession(agentId);
yield* this.streamAgent(agentId, prompt, options);
yield* this.streamAgent(agentId, prompt, options, promptStart);
}
private async *streamAfterRuntimeCollection(
agentId: string,
prompt: AgentPromptInput,
options?: AgentRunOptions,
promptStart?: ForegroundPromptStart,
): AsyncGenerator<AgentStreamEvent> {
await this.waitForAgentClose(agentId);
await ensureAgentLoaded(agentId, {
@@ -3210,19 +3253,20 @@ export class AgentManager {
agentStorage: this.requireRegistry(),
logger: this.logger,
});
yield* this.streamAgent(agentId, prompt, options);
yield* this.streamAgent(agentId, prompt, options, promptStart);
}
streamAgent(
agentId: string,
prompt: AgentPromptInput,
options?: AgentRunOptions,
promptStart?: ForegroundPromptStart,
): AsyncGenerator<AgentStreamEvent> {
if (this.collectingRuntimes.has(agentId) || (!this.agents.has(agentId) && this.registry))
return this.streamAfterRuntimeCollection(agentId, prompt, options);
return this.streamAfterRuntimeCollection(agentId, prompt, options, promptStart);
const existingAgent = this.requireSessionAgent(agentId);
if (this.historySessions.has(existingAgent.session))
return this.streamAfterHistoryLoad(agentId, prompt, options);
return this.streamAfterHistoryLoad(agentId, prompt, options, promptStart);
this.logger.trace(
{
agentId,
@@ -3257,9 +3301,10 @@ export class AgentManager {
agent.lastError = undefined;
const pendingRun = this.runs.createPendingRun(agentId);
promptStart?.bind(pendingRun);
const streamForwarder = async function* streamForwarder(this: AgentManager) {
let turnId: string;
let turnId: string | null;
let turnStream: ReturnType<AgentRunState["createTurnStream"]> | null = null;
turnId = await this.startPendingForegroundTurn({
agent,
@@ -3268,6 +3313,15 @@ export class AgentManager {
prompt,
options,
});
if (turnId === null) {
const canceledEvent: AgentStreamEvent = {
type: "turn_canceled",
provider: agent.provider,
reason: "interrupted",
};
yield canceledEvent;
return;
}
if (isReplacement) {
agent.pendingReplacement = false;
@@ -3422,9 +3476,10 @@ export class AgentManager {
agentId: string,
prompt: AgentPromptInput,
options?: AgentRunOptions,
promptStart?: ForegroundPromptStart,
): Promise<AsyncGenerator<AgentStreamEvent>> {
this.requireSessionAgent(agentId);
return this.replaceRunInForegroundLane(agentId, prompt, options);
return this.replaceRunInForegroundLane(agentId, prompt, options, promptStart);
}
async steerAgentRun(
@@ -3465,6 +3520,7 @@ export class AgentManager {
agentId: string,
prompt: AgentPromptInput,
options?: AgentSteerOptions,
promptStart?: ForegroundPromptStart,
): Promise<ActiveTurnSteerDispatchResult> {
// A turn that is still starting has no id to steer yet. Replacing it would drop its
// prompt, so wait until it is accepted (or fails) and steer the turn it became.
@@ -3512,6 +3568,7 @@ export class AgentManager {
expectedTurnId,
prompt,
stripSteerOptions(options),
promptStart,
),
};
}
@@ -3577,9 +3634,10 @@ export class AgentManager {
expectedTurnId: string,
prompt: AgentPromptInput,
options?: AgentRunOptions,
promptStart?: ForegroundPromptStart,
): Promise<AsyncGenerator<AgentStreamEvent>> {
this.assertSteerAdmissionOwnsTurn(agent, expectedTurnId);
return this.replaceRunInForegroundLane(agent.id, prompt, options, (live) =>
return this.replaceRunInForegroundLane(agent.id, prompt, options, promptStart, (live) =>
this.assertSteerAdmissionOwnsTurn(live, expectedTurnId),
);
}
@@ -3592,12 +3650,13 @@ export class AgentManager {
agentId: string,
prompt: AgentPromptInput,
options: AgentRunOptions | undefined,
promptStart?: ForegroundPromptStart,
assertAdmission?: (agent: ActiveManagedAgent) => void,
): Promise<AsyncGenerator<AgentStreamEvent>> {
// Replacements queue in arrival order; each one holds the foreground lane only while
// it cancels and reserves, so Stop is never stuck behind a replacement that is waiting.
return this.runQueuedMutation(this.replacementMutationTails, agentId, () =>
this.replaceRunWhenAdmitted(agentId, prompt, options, assertAdmission),
this.replaceRunWhenAdmitted(agentId, prompt, options, promptStart, assertAdmission),
);
}
@@ -3605,6 +3664,7 @@ export class AgentManager {
agentId: string,
prompt: AgentPromptInput,
options: AgentRunOptions | undefined,
promptStart?: ForegroundPromptStart,
assertAdmission?: (agent: ActiveManagedAgent) => void,
): Promise<AsyncGenerator<AgentStreamEvent>> {
let stalledStart: PendingForegroundRun | null = null;
@@ -3623,7 +3683,7 @@ export class AgentManager {
if (!this.hasInFlightRun(agent.id)) {
return {
status: "reserved" as const,
iterator: this.streamAgent(agent.id, prompt, options),
iterator: this.streamAgent(agent.id, prompt, options, promptStart),
};
}
agent.pendingReplacement = true;
@@ -3637,7 +3697,7 @@ export class AgentManager {
}
return {
status: "reserved" as const,
iterator: this.streamAgent(agent.id, prompt, options),
iterator: this.streamAgent(agent.id, prompt, options, promptStart),
};
} catch (error) {
agent.pendingReplacement = false;
@@ -3828,7 +3888,10 @@ export class AgentManager {
}
async cancelAgentRun(agentId: string): Promise<AgentRunCancellationResult> {
return this.runForegroundMutation(agentId, () => this.cancelAgentRunNow(agentId));
return this.runForegroundMutation(agentId, () => {
this.requireSessionAgent(agentId).pendingReplacement = false;
return this.cancelAgentRunNow(agentId);
});
}
private async cancelAgentRunNow(agentId: string): Promise<AgentRunCancellationResult> {
@@ -5113,6 +5176,9 @@ export class AgentManager {
this.runs.settleTerminalRun(agent.id, eventTurnId);
if (isForegroundEvent) {
this.finalizeForegroundTurn(agent, eventTurnId);
} else if (terminalDisposition !== "stale" && !agent.activeForegroundTurnId) {
// Publish autonomous readiness only after the tracked run has settled.
this.emitState(agent);
}
}
@@ -5382,7 +5448,6 @@ export class AgentManager {
!agent.pendingReplacement
) {
(agent as ActiveManagedAgent).lifecycle = "idle";
this.emitState(agent);
}
void this.refreshRuntimeInfo(agent);
}
@@ -5423,9 +5488,6 @@ export class AgentManager {
options,
);
this.resolvePendingPermissionsForAgent(agent, event.provider, options, "Turn failed");
if (!isForegroundEvent && !agent.activeForegroundTurnId) {
this.emitState(agent);
}
}
private onStreamTurnCanceled(params: {
@@ -5459,9 +5521,6 @@ export class AgentManager {
}
agent.lastError = undefined;
this.resolvePendingPermissionsForAgent(agent, event.provider, options, "Interrupted");
if (!isForegroundEvent && !agent.activeForegroundTurnId) {
this.emitState(agent);
}
}
private onStreamTurnStarted(params: {
@@ -6171,6 +6230,7 @@ export class AgentManager {
// A plugin changing during this open must still make the resulting session stale.
const generation = this.sessionOpenGeneration;
this.detachPluginTools(agentId);
let appendSystemPrompt: string[] | undefined;
let mcpServers: AgentSessionConfig["mcpServers"];
let mcpServerOwners: Record<string, string> | undefined;
if (this.pluginLifecycle) {
@@ -6192,12 +6252,14 @@ export class AgentManager {
env = transformed.env;
if (request.purpose === "interactive") {
this.attachedPluginTools.set(agentId, transformed.tools as AttachedAgentTool[]);
appendSystemPrompt = transformed.appendSystemPrompt;
mcpServers = transformed.mcpServers;
mcpServerOwners = transformed.mcpServerOwners;
}
}
const context: AgentLaunchContext = {
agentId,
...pluginPromptContext(appendSystemPrompt),
mcpServers,
mcpServerOwners,
env: {
@@ -6244,6 +6306,7 @@ export class AgentManager {
throw new Error(`MCP server '${name}' from plugin ${owner} collides with ${existingOwner}`);
}
}
launchConfig = { ...launchConfig, pluginAppendSystemPrompt: launchContext.appendSystemPrompt };
const merged =
Object.keys(launchContext.mcpServers ?? {}).length > 0
? {
@@ -6381,3 +6444,9 @@ export function commandMayHaveChangedExternalState(command: string): boolean {
/\bgit\s+fetch\b/.test(normalized)
);
}
function pluginPromptContext(
appendSystemPrompt: string[] | undefined,
): Pick<AgentLaunchContext, "appendSystemPrompt"> {
return appendSystemPrompt?.length ? { appendSystemPrompt } : {};
}
@@ -1,3 +1,4 @@
import { AgentTurnBusyError } from "../agent-prompt.js";
import { expect, test } from "vitest";
import { createAgentMessageDelivery, parseAgentMessages } from "./index.js";
import type { AgentPromptInput } from "../agent-sdk-types.js";
@@ -117,7 +118,6 @@ test("explicit interrupt and conflicting session modes retain ordered dispatch b
const delivery = createAgentMessageDelivery({
dispatch: async (request) => {
sent.push(request);
request.onDispatch("steered");
return "steered";
},
onError: (error) => {
@@ -313,3 +313,555 @@ test("runtime safety sees queued messages until provider dispatch settles", asyn
await delivery.close();
expect(delivery.hasPending("parent")).toBe(false);
});
test("messages wait across quiet windows and batch after the recipient turn ends", async () => {
const clock = createClock();
let running = true;
const sent: Array<readonly string[]> = [];
const delivery = createAgentMessageDelivery({
schedule: clock.schedule,
isRunning: () => running,
dispatch: async (request) => {
sent.push(request.messageIds);
return "turn_started";
},
onError: (error) => {
throw error;
},
});
const source = { kind: "agent-message" as const, agentId: "child" };
const report = delivery.enqueue({
recipientId: "parent",
messageId: "report",
source,
prompt: "report",
});
clock.advance(2000);
await Promise.resolve();
expect(sent).toEqual([]);
clock.advance(13000);
const finish = delivery.enqueue({
recipientId: "parent",
messageId: "finish",
source: { kind: "agent-notification", agentId: "child", event: "finished" },
prompt: "finished",
activeTurnBehavior: "steer",
});
clock.advance(2000);
await Promise.resolve();
expect(sent).toEqual([]);
running = false;
clock.advance(2000);
await Promise.all([report.dispatched, finish.dispatched]);
expect(sent).toEqual([["report", "finish"]]);
await delivery.close();
});
test("a turn starting during dispatch preparation keeps receipts queued and joins later arrivals", async () => {
const clock = createClock();
let busy = true;
const sent: Array<readonly string[]> = [];
const delivery = createAgentMessageDelivery({
schedule: clock.schedule,
dispatch: async (request) => {
if (busy) throw new AgentTurnBusyError("concurrent turn");
sent.push(request.messageIds);
return "turn_started";
},
onError: (error) => {
throw error;
},
});
const message = {
recipientId: "parent",
source: { kind: "agent-message" as const, agentId: "child" },
prompt: "report",
};
const first = delivery.enqueue({ ...message, messageId: "first" });
clock.advance(2000);
await new Promise<void>((resolve) => setImmediate(resolve));
expect(delivery.hasPending("parent")).toBe(true);
const second = delivery.enqueue({ ...message, messageId: "second" });
busy = false;
clock.advance(2000);
await Promise.all([first.dispatched, second.dispatched]);
expect(sent).toEqual([["first", "second"]]);
await delivery.close();
});
test("explicit interrupt bypasses a running turn while ordinary messages keep waiting", async () => {
const clock = createClock();
const sent: Array<readonly string[]> = [];
const delivery = createAgentMessageDelivery({
schedule: clock.schedule,
isRunning: () => true,
dispatch: async (request) => {
sent.push(request.messageIds);
return "turn_started";
},
onError: (error) => {
throw error;
},
});
const message = {
recipientId: "parent",
source: { kind: "agent-message" as const, agentId: "child" },
prompt: "report",
};
delivery.enqueue({ ...message, messageId: "wait" });
const interrupt = delivery.enqueue({
...message,
messageId: "interrupt",
activeTurnBehavior: "interrupt",
});
clock.advance(2000);
await interrupt.dispatched;
expect(sent).toEqual([["interrupt"]]);
expect(delivery.hasPending("parent")).toBe(true);
await delivery.close();
expect(sent).toEqual([["interrupt"], ["wait"]]);
});
test("shutdown flushes a dispatch that discovered a concurrent turn during preparation", async () => {
const clock = createClock();
let release!: () => void;
const preparing = new Promise<void>((resolve) => {
release = resolve;
});
const modes: boolean[] = [];
const delivery = createAgentMessageDelivery({
schedule: clock.schedule,
dispatch: async (request) => {
modes.push(request.idleOnly);
if (request.idleOnly) {
await preparing;
throw new AgentTurnBusyError("busy");
}
return "turn_started";
},
onError: () => {},
});
const receipt = delivery.enqueue({
recipientId: "parent",
prompt: "report",
source: { kind: "agent-message", agentId: "child" },
});
clock.advance(2000);
await new Promise<void>((resolve) => setImmediate(resolve));
const closing = delivery.close();
release();
await closing;
await expect(receipt.dispatched).resolves.toBe("turn_started");
expect(modes).toEqual([true, false]);
});
test("conflicting modes dispatch on separate turn ends without changing the active turn mode", async () => {
const clock = createClock();
let busy = false;
let mode = "initial";
let wake!: (recipientId: string) => void;
const sent: Array<{ ids: readonly string[]; mode?: string }> = [];
const delivery = createAgentMessageDelivery({
schedule: clock.schedule,
isRunning: () => busy,
subscribe: (listener) => {
wake = listener;
return () => {};
},
dispatch: async (request) => {
// Mode preparation precedes run admission in the real dispatcher.
mode = request.sessionMode ?? mode;
if (busy) throw new AgentTurnBusyError("concurrent turn");
sent.push({ ids: request.messageIds, mode });
busy = true;
return "turn_started";
},
onError: (error) => {
throw error;
},
});
const message = {
recipientId: "parent",
source: { kind: "agent-message" as const, agentId: "child" },
prompt: "message",
};
const a = delivery.enqueue({ ...message, messageId: "A", sessionMode: "plan" });
const b = delivery.enqueue({ ...message, messageId: "B", sessionMode: "default" });
clock.advance(2000);
await a.dispatched;
await new Promise<void>((resolve) => setImmediate(resolve));
expect(mode).toBe("plan");
expect(sent).toEqual([{ ids: ["A"], mode: "plan" }]);
busy = false;
wake("parent");
await b.dispatched;
expect(mode).toBe("default");
expect(sent).toEqual([
{ ids: ["A"], mode: "plan" },
{ ids: ["B"], mode: "default" },
]);
await delivery.close();
});
test("interrupts retain separate mode choices while the recipient is busy", async () => {
const clock = createClock();
const sent: Array<{ ids: readonly string[]; mode?: string }> = [];
const delivery = createAgentMessageDelivery({
schedule: clock.schedule,
isRunning: () => true,
dispatch: async (request) => {
sent.push({ ids: request.messageIds, mode: request.sessionMode });
return "turn_started";
},
onError: (error) => {
throw error;
},
});
const message = {
recipientId: "parent",
source: { kind: "agent-message" as const, agentId: "child" },
prompt: "message",
activeTurnBehavior: "interrupt" as const,
};
const a = delivery.enqueue({ ...message, messageId: "A", sessionMode: "plan" });
const b = delivery.enqueue({ ...message, messageId: "B", sessionMode: "default" });
clock.advance(2000);
await Promise.all([a.dispatched, b.dispatched]);
expect(sent).toEqual([
{ ids: ["A"], mode: "plan" },
{ ids: ["B"], mode: "default" },
]);
await delivery.close();
});
test("a settled-turn event releases a ready batch without waiting for the next timer sample", async () => {
const clock = createClock();
let running = true;
let settled: (id: string) => void = () => {};
let subscribed = true;
const sent: string[] = [];
const delivery = createAgentMessageDelivery({
schedule: clock.schedule,
isRunning: () => running,
subscribe: (listener) => {
settled = listener;
return () => {
subscribed = false;
};
},
dispatch: async (request) => {
sent.push(request.recipientId);
return "turn_started";
},
onError: (error) => {
throw error;
},
});
delivery.enqueue({
recipientId: "parent",
prompt: "report",
source: { kind: "agent-message", agentId: "child" },
});
clock.advance(2000);
expect(sent).toEqual([]);
running = false;
settled("parent");
await new Promise<void>((resolve) => setImmediate(resolve));
expect(sent).toEqual(["parent"]);
running = true;
await delivery.close();
expect(subscribed).toBe(false);
});
test.each([false, true])(
"completion waits report permission checkpoints without draining messages (initial: %s)",
async (initial) => {
const clock = createClock();
let permission = initial;
let changed: (id: string) => void = () => {};
let reported = false;
let sent = 0;
const delivery = createAgentMessageDelivery({
schedule: clock.schedule,
isRunning: () => true,
hasPendingPermission: () => permission,
subscribe: (listener) => {
changed = listener;
return () => {};
},
dispatch: async () => {
sent++;
return "turn_started";
},
onError: (error) => {
throw error;
},
});
delivery.enqueue({
recipientId: "child",
prompt: "follow up",
source: { kind: "agent-message", agentId: "parent" },
});
const wait = delivery.waitForDispatch("child", new AbortController().signal).then(() => {
reported = true;
return undefined;
});
permission = true;
changed("child");
await new Promise<void>((resolve) => setImmediate(resolve));
expect(reported).toBe(true);
expect(sent).toBe(0);
expect(delivery.hasPending("child")).toBe(true);
await wait;
await delivery.close();
},
);
test("a busy admission retry stays ready for the next settled-turn event", async () => {
const clock = createClock();
let running = false;
let raced = true;
let notify: (id: string) => void = () => {};
const sent: string[] = [];
const delivery = createAgentMessageDelivery({
schedule: clock.schedule,
isRunning: () => running,
subscribe: (listener) => {
notify = listener;
return () => {};
},
dispatch: async (request) => {
if (raced) {
running = true;
throw new AgentTurnBusyError("next turn started");
}
sent.push(request.recipientId);
return "turn_started";
},
onError: (error) => {
throw error;
},
});
delivery.enqueue({
recipientId: "parent",
prompt: "report",
source: { kind: "agent-message", agentId: "child" },
});
clock.advance(2000);
await new Promise<void>((resolve) => setImmediate(resolve));
raced = false;
running = false;
notify("parent");
await new Promise<void>((resolve) => setImmediate(resolve));
expect(sent).toEqual(["parent"]);
await delivery.close();
});
test("out-of-band acceptance owns callbacks and receipts; a failed attempt does not block waiting messages", async () => {
const clock = createClock();
let running = true;
let wake!: (recipientId: string) => void;
const callbacks: string[] = [];
const sent: string[] = [];
const errors: unknown[] = [];
const failure = new Error("recipient could not load");
const delivery = createAgentMessageDelivery({
schedule: clock.schedule,
isRunning: () => running,
subscribe: (listener) => {
wake = listener;
return () => {};
},
tryRunOutOfBand: async (request, onAccepted) => {
const text = parseAgentMessages(String(request.prompt))[0]!.text;
if (text === "failure") throw failure;
if (text !== "/handled") return false;
onAccepted();
callbacks.push("command ran");
return true;
},
dispatch: async (request) => {
sent.push(...parseAgentMessages(String(request.prompt)).map((message) => message.text));
return "turn_started";
},
onError: (error) => {
errors.push(error);
},
});
const message = {
recipientId: "parent",
source: { kind: "agent-message" as const, agentId: "child" },
};
const ordinary = delivery.enqueue({
...message,
prompt: "ordinary",
beforeDispatch: () => {
callbacks.push("ordinary");
},
});
const failed = delivery.enqueue({
...message,
prompt: "failure",
beforeDispatch: () => {
callbacks.push("failure");
},
});
const command = delivery.enqueue({
...message,
prompt: "/handled",
beforeDispatch: () => {
callbacks.push("command accepted");
},
onDispatch: (disposition) => {
callbacks.push(disposition);
},
});
clock.advance(2000);
await expect(failed.dispatched).rejects.toBe(failure);
await expect(command.dispatched).resolves.toBe("out_of_band");
expect(errors).toEqual([failure]);
expect(callbacks).toEqual(["command accepted", "command ran", "out_of_band"]);
expect(sent).toEqual([]);
running = false;
wake("parent");
await ordinary.dispatched;
expect(callbacks.at(-1)).toBe("ordinary");
expect(sent).toEqual(["ordinary"]);
await delivery.close();
});
test("shutdown waits for an in-flight out-of-band attempt and drains its unhandled message", async () => {
const clock = createClock();
let release!: () => void;
let attempted!: () => void;
const started = new Promise<void>((resolve) => {
attempted = resolve;
});
const gate = new Promise<void>((resolve) => {
release = resolve;
});
const dispatched: boolean[] = [];
const delivery = createAgentMessageDelivery({
schedule: clock.schedule,
isRunning: () => true,
tryRunOutOfBand: async () => {
attempted();
await gate;
return false;
},
dispatch: async (request) => {
dispatched.push(request.idleOnly);
return "turn_started";
},
onError: (error) => {
throw error;
},
});
const receipt = delivery.enqueue({
recipientId: "parent",
prompt: "ordinary",
source: { kind: "agent-message", agentId: "child" },
});
clock.advance(2000);
await started;
const closing = delivery.close();
release();
await closing;
await expect(receipt.dispatched).resolves.toBe("turn_started");
expect(dispatched).toEqual([false]);
});
test("a declined out-of-band message is offered once across running-turn retries", async () => {
const clock = createClock();
let running = true;
let accepts = false;
let offers = 0;
let dispatched = 0;
let wake!: (recipientId: string) => void;
const delivery = createAgentMessageDelivery({
schedule: clock.schedule,
isRunning: () => running,
subscribe: (listener) => {
wake = listener;
return () => {};
},
tryRunOutOfBand: async (_request, onAccepted) => {
offers++;
if (accepts) onAccepted();
return accepts;
},
dispatch: async () => {
dispatched++;
return "turn_started";
},
onError: (error) => {
throw error;
},
});
const receipt = delivery.enqueue({
recipientId: "parent",
prompt: "message",
source: { kind: "agent-message", agentId: "child" },
});
clock.advance(2000);
await new Promise<void>((resolve) => setImmediate(resolve));
expect(offers).toBe(1);
// A later provider state change does not reinterpret a declined message.
accepts = true;
for (let retry = 0; retry < 3; retry++) {
clock.advance(2000);
await new Promise<void>((resolve) => setImmediate(resolve));
}
expect(offers).toBe(1);
expect(dispatched).toBe(0);
running = false;
wake("parent");
await receipt.dispatched;
expect(dispatched).toBe(1);
await delivery.close();
});
test("a command with an explicit mode waits for turn end without an out-of-band offer", async () => {
const clock = createClock();
let running = true;
let offers = 0;
let wake!: (recipientId: string) => void;
const dispatched: Array<{ prompt: AgentPromptInput; sessionMode?: string }> = [];
const delivery = createAgentMessageDelivery({
schedule: clock.schedule,
isRunning: () => running,
subscribe: (listener) => {
wake = listener;
return () => {};
},
tryRunOutOfBand: async (_request, onAccepted) => {
offers++;
onAccepted();
return true;
},
dispatch: async (request) => {
dispatched.push(request);
return "out_of_band";
},
onError: (error) => {
throw error;
},
});
const receipt = delivery.enqueue({
recipientId: "parent",
prompt: "/handled",
sessionMode: "plan",
source: { kind: "agent-message", agentId: "child" },
});
clock.advance(2000);
await new Promise<void>((resolve) => setImmediate(resolve));
expect(offers).toBe(0);
expect(dispatched).toEqual([]);
running = false;
wake("parent");
await receipt.dispatched;
expect(dispatched).toHaveLength(1);
expect(dispatched[0]!.sessionMode).toBe("plan");
expect(parseAgentMessages(String(dispatched[0]!.prompt))![0]!.text).toBe("/handled");
await delivery.close();
});
@@ -1,4 +1,4 @@
import type { PromptDispatchDisposition } from "../agent-prompt.js";
import { AgentTurnBusyError, type PromptDispatchDisposition } from "../agent-prompt.js";
import { randomUUID } from "node:crypto";
import type { AgentPromptInput, AgentPromptContentBlock } from "../agent-sdk-types.js";
import { prepareAgentMessage, type AgentPromptSource } from "./envelope.js";
@@ -21,6 +21,8 @@ interface Receipt {
dispatched: Promise<PromptDispatchDisposition>;
}
interface Admitted extends Message {
sequence: number;
outOfBandDeclined: boolean;
receipt: Receipt;
resolve(disposition: PromptDispatchDisposition): void;
reject(error: unknown): void;
@@ -30,12 +32,18 @@ interface DispatchRequest {
messageIds: readonly string[];
prompt: AgentPromptInput;
activeTurnBehavior: "steer" | "interrupt";
idleOnly: boolean;
sessionMode?: string;
clearPendingPermissions: boolean;
unarchive: boolean;
onDispatch(disposition: PromptDispatchDisposition): void;
}
interface Dependencies {
/** Includes admitted starts and provider turns, including compaction. */
isRunning?: (recipientId: string) => boolean;
hasPendingPermission?: (recipientId: string) => boolean;
/** Notify when recipient state changes; admission still checks whether it is idle. */
subscribe?: (listener: (recipientId: string) => void) => () => void;
tryRunOutOfBand?(request: DispatchRequest, onAccepted: () => void): Promise<boolean>;
dispatch(request: DispatchRequest): Promise<PromptDispatchDisposition>;
onError(error: unknown, request: DispatchRequest): void;
/** Return a cancellation function. Production uses the daemon's event loop. */
@@ -47,7 +55,7 @@ export interface AgentMessageDelivery {
hasPending(recipientId: string): boolean;
/** Stop admission, flush pending messages, and await provider dispatch acknowledgments. */
close(): Promise<void>;
/** Existing completion waits include agent messages admitted before the wait. */
/** Completion waits include admitted messages, but return at permission checkpoints. */
waitForDispatch(recipientId: string, signal: AbortSignal): Promise<void>;
}
@@ -59,12 +67,14 @@ export function createAgentMessageDelivery(dependencies: Dependencies): AgentMes
const timer = setTimeout(callback, delayMs);
return () => clearTimeout(timer);
});
const pending = new Map<string, { messages: Admitted[]; cancel(): void }>();
const pending = new Map<string, { messages: Admitted[]; ready: boolean; cancel(): void }>();
const dispatching = new Map<string, Promise<void>>();
const receipts = new Map<string, Set<Receipt>>();
let sequence = 0;
let closed = false;
let closing: Promise<void> | undefined;
function dispatch(recipientId: string, messages: Admitted[]): void {
function requestFor(recipientId: string, messages: Admitted[]): DispatchRequest {
const prompts = messages.map(
(message) =>
prepareAgentMessage(message.prompt, message.source, message.receipt.messageId).prompt,
@@ -74,39 +84,55 @@ export function createAgentMessageDelivery(dependencies: Dependencies): AgentMes
: prompts.flatMap((entry): AgentPromptContentBlock[] =>
typeof entry === "string" ? [{ type: "text", text: entry }] : entry,
);
const request: DispatchRequest = {
return {
recipientId,
idleOnly: !closed && messages[0]!.activeTurnBehavior !== "interrupt",
messageIds: messages.map((message) => message.receipt.messageId),
prompt,
activeTurnBehavior: messages[0]!.activeTurnBehavior ?? "steer",
sessionMode: messages.find((message) => message.sessionMode)?.sessionMode,
clearPendingPermissions: messages.some((message) => message.clearPendingPermissions),
unarchive: messages.some((message) => message.unarchive !== false),
onDispatch: (disposition) => {
};
}
function dispatch(recipientId: string, messages: Admitted[]): void {
const request = requestFor(recipientId, messages);
queueDispatch(recipientId, async () => {
try {
for (const message of messages) message.beforeDispatch?.();
let disposition: PromptDispatchDisposition;
try {
disposition = await dependencies.dispatch(request);
} catch (error) {
if (!(error instanceof AgentTurnBusyError) || !closed) throw error;
// Shutdown drains admitted messages before closing the recipients.
disposition = await dependencies.dispatch({ ...request, idleOnly: false });
}
for (const message of messages) {
try {
message.onDispatch?.(disposition);
} catch (error) {
dependencies.onError(error, request);
}
message.resolve(disposition);
}
},
};
return undefined;
} catch (error) {
if (error instanceof AgentTurnBusyError && !closed) {
requeue(recipientId, messages);
return;
}
for (const message of messages) message.reject(error);
dependencies.onError(error, request);
throw error;
}
});
}
function queueDispatch(recipientId: string, operation: () => Promise<void>): void {
const previous = dispatching.get(recipientId) ?? Promise.resolve();
const dispatched = previous
.catch(() => undefined)
.then(async () => {
try {
for (const message of messages) message.beforeDispatch?.();
const disposition = await dependencies.dispatch(request);
for (const message of messages) message.resolve(disposition);
return undefined;
} catch (error) {
for (const message of messages) message.reject(error);
dependencies.onError(error, request);
throw error;
}
});
const dispatched = previous.catch(() => undefined).then(operation);
dispatching.set(recipientId, dispatched);
void dispatched
.finally(() => {
@@ -115,30 +141,121 @@ export function createAgentMessageDelivery(dependencies: Dependencies): AgentMes
.catch(() => undefined);
}
function requeue(recipientId: string, messages: Admitted[]): void {
const entry = pending.get(recipientId) ?? {
messages: [],
ready: true,
cancel: () => {},
};
entry.cancel();
entry.messages.push(...messages);
entry.messages.sort((a, b) => a.sequence - b.sequence);
entry.cancel = schedule(2000, () => flush(recipientId));
pending.set(recipientId, entry);
}
function flush(recipientId: string): void {
const entry = pending.get(recipientId);
if (!entry) return;
pending.delete(recipientId);
entry.ready = true;
entry.cancel();
if (!closed && dependencies.isRunning?.(recipientId)) {
const interrupts = entry.messages.filter(
(message) => message.activeTurnBehavior === "interrupt",
);
entry.messages = entry.messages.filter(
(message) => message.activeTurnBehavior !== "interrupt",
);
if (interrupts.length) dispatchGroups(recipientId, interrupts);
if (entry.messages.length && dependencies.tryRunOutOfBand) {
pending.delete(recipientId);
offerOutOfBand(recipientId, entry.messages);
} else if (entry.messages.length) {
entry.cancel = schedule(2000, () => flush(recipientId));
} else {
pending.delete(recipientId);
}
return;
}
pending.delete(recipientId);
dispatchGroups(recipientId, entry.messages);
}
function offerOutOfBand(recipientId: string, messages: Admitted[]): void {
queueDispatch(recipientId, async () => {
const waiting: Admitted[] = [];
for (const message of messages) {
if (
message.outOfBandDeclined ||
message.sessionMode !== undefined ||
closed ||
!dependencies.isRunning?.(recipientId)
) {
waiting.push(message);
continue;
}
const request = requestFor(recipientId, [message]);
try {
const accepted = await dependencies.tryRunOutOfBand!(request, () =>
message.beforeDispatch?.(),
);
if (!accepted) {
message.outOfBandDeclined = true;
waiting.push(message);
continue;
}
try {
message.onDispatch?.("out_of_band");
} catch (error) {
dependencies.onError(error, request);
}
message.resolve("out_of_band");
} catch (error) {
message.reject(error);
dependencies.onError(error, request);
}
}
if (waiting.length) requeue(recipientId, waiting);
if (closed || (pending.get(recipientId)?.ready && !dependencies.isRunning?.(recipientId)))
flush(recipientId);
});
}
function dispatchGroups(recipientId: string, messages: Admitted[]): void {
const groups: Admitted[][] = [];
let group: Admitted[] = [];
let mode: string | undefined;
for (const message of entry.messages) {
for (const message of messages) {
// Explicitly conflicting send options require separate, ordered dispatches.
if (
group.length &&
((message.activeTurnBehavior ?? "steer") !== (group[0]!.activeTurnBehavior ?? "steer") ||
(mode && message.sessionMode && mode !== message.sessionMode))
) {
dispatch(recipientId, group);
groups.push(group);
group = [];
mode = undefined;
}
group.push(message);
mode ??= message.sessionMode;
}
if (group.length) dispatch(recipientId, group);
if (group.length) groups.push(group);
let started = false;
for (const batch of groups) {
if (!closed && started && batch[0]!.activeTurnBehavior !== "interrupt") {
requeue(recipientId, batch);
} else {
dispatch(recipientId, batch);
started = true;
}
}
}
const unsubscribe = dependencies.subscribe?.((recipientId) => {
if (pending.get(recipientId)?.ready && !dependencies.isRunning?.(recipientId))
flush(recipientId);
});
return {
hasPending: (recipientId) => pending.has(recipientId) || dispatching.has(recipientId),
enqueue(message) {
@@ -155,17 +272,47 @@ export function createAgentMessageDelivery(dependencies: Dependencies): AgentMes
messageId: message.messageId ?? randomUUID(),
dispatched,
};
const entry = pending.get(message.recipientId) ?? { messages: [], cancel: () => {} };
const owned = receipts.get(message.recipientId) ?? new Set<Receipt>();
owned.add(receipt);
receipts.set(message.recipientId, owned);
void dispatched
.finally(() => {
owned.delete(receipt);
if (!owned.size) receipts.delete(message.recipientId);
})
.catch(() => undefined);
const entry = pending.get(message.recipientId) ?? {
messages: [],
ready: false,
cancel: () => {},
};
entry.cancel();
entry.messages.push({ ...message, receipt, resolve, reject });
entry.ready = false;
entry.messages.push({
...message,
receipt,
resolve,
reject,
sequence: sequence++,
outOfBandDeclined: false,
});
entry.cancel = schedule(2000, () => flush(message.recipientId));
pending.set(message.recipientId, entry);
return receipt;
},
async waitForDispatch(recipientId, signal) {
signal.throwIfAborted();
const admitted =
pending.get(recipientId)?.messages.map((message) => message.receipt.dispatched) ?? [];
const admitted = Array.from(receipts.get(recipientId) ?? [], (receipt) => receipt.dispatched);
let unsubscribePermission: (() => void) | undefined;
const permission = new Promise<void>((resolve) => {
const check = () => {
if (dependencies.hasPendingPermission?.(recipientId)) resolve();
};
unsubscribePermission = dependencies.subscribe?.((agentId) => {
if (agentId === recipientId) check();
});
check();
});
let aborted!: () => void;
const cancellation = new Promise<never>((_resolve, reject) => {
aborted = () => reject(new DOMException("Wait aborted", "AbortError"));
@@ -175,17 +322,22 @@ export function createAgentMessageDelivery(dependencies: Dependencies): AgentMes
await Promise.race([
Promise.all([dispatching.get(recipientId), ...admitted]),
cancellation,
permission,
]);
} finally {
signal.removeEventListener("abort", aborted);
unsubscribePermission?.();
}
},
close() {
if (closing) return closing;
closed = true;
unsubscribe?.();
for (const recipientId of pending.keys()) flush(recipientId);
// Each failure is reported and rejects its receipts; shutdown still drains other recipients.
closing = Promise.allSettled(dispatching.values()).then(() => undefined);
closing = Promise.allSettled(
[...receipts.values()].flatMap((owned) => [...owned].map((receipt) => receipt.dispatched)),
).then(() => undefined);
return closing;
},
};
@@ -337,6 +337,7 @@ describe("toAgentPayload", () => {
nativeHandle: { id: "native" } as unknown,
metadata: {
restored: new Date("2025-03-01T00:00:00.000Z"),
paseoInstructionReceipt: { threadId: "persist-99", digest: "internal-digest" },
empty: {},
mcpServers: {
hub: {
@@ -387,6 +388,8 @@ describe("toAgentPayload", () => {
sessionId: "persist-stored",
metadata: {
conversationId: "conversation-stored",
pluginAppendSystemPrompt: ["plugin instruction"],
daemonAppendSystemPrompt: "daemon instruction",
mcpServers: {
hub: {
type: "http",
@@ -402,6 +405,8 @@ describe("toAgentPayload", () => {
expect(record.persistence?.metadata).toEqual({
conversationId: "conversation-stored",
pluginAppendSystemPrompt: ["plugin instruction"],
daemonAppendSystemPrompt: "daemon instruction",
mcpServers: {
hub: {
type: "http",
@@ -495,6 +495,9 @@ function projectPersistenceHandleForWire(
return projected;
}
delete projected.metadata.mcpServers;
delete projected.metadata.pluginAppendSystemPrompt;
delete projected.metadata.daemonAppendSystemPrompt;
delete projected.metadata.paseoInstructionReceipt;
if (Object.keys(projected.metadata).length === 0) {
delete projected.metadata;
}
@@ -15,6 +15,7 @@ import { join } from "node:path";
import { createTestLogger } from "../../test-utils/test-logger.js";
import { AgentManager } from "./agent-manager.js";
import { waitForAgentRunStartWithTimeout } from "./agent-prompt.js";
import { ForegroundPromptStart } from "./agent-run-state.js";
import type {
AgentClient,
AgentRunResult,
@@ -161,7 +162,7 @@ class SlowStartAgentClient implements AgentClient {
async function createRunStartScenario(startDelayMs: number | null): Promise<{
agentManager: AgentManager;
agentId: string;
startRun: () => Promise<void>;
startRun: () => Promise<{ started: Promise<void> }>;
cleanup: () => Promise<void>;
}> {
const workdir = mkdtempSync(join(tmpdir(), "agent-run-start-budget-"));
@@ -178,14 +179,16 @@ async function createRunStartScenario(startDelayMs: number | null): Promise<{
return {
agentManager,
agentId: snapshot.id,
// streamAgent registers the pending run synchronously, so the wait always observes it.
// Returns the sender's start, bound to the run streamAgent registers.
startRun: async () => {
const run = agentManager.streamAgent(snapshot.id, "start the run");
const start = new ForegroundPromptStart(snapshot.id);
const run = agentManager.streamAgent(snapshot.id, "start the run", undefined, start);
drained = (async () => {
for await (const _event of run) {
// Drain whatever the turn produces.
}
})().catch(() => undefined);
return { started: start.started };
},
cleanup: async () => {
// Release any turn still held open, then close. The drain is deliberately not
@@ -207,8 +210,8 @@ test("waiting for a run start outlasts the slowest provider startup budget", asy
vi.useFakeTimers();
try {
await scenario.startRun();
const wait = waitForAgentRunStartWithTimeout(scenario.agentManager, scenario.agentId);
const { started } = await scenario.startRun();
const wait = waitForAgentRunStartWithTimeout(scenario.agentManager, scenario.agentId, started);
let settled = false;
const markSettled = () => {
settled = true;
@@ -233,8 +236,8 @@ test("waiting for a run start still gives up at the run start budget", async ()
vi.useFakeTimers();
try {
await scenario.startRun();
const wait = waitForAgentRunStartWithTimeout(scenario.agentManager, scenario.agentId);
const { started } = await scenario.startRun();
const wait = waitForAgentRunStartWithTimeout(scenario.agentManager, scenario.agentId, started);
const rejection = expect(wait).rejects.toThrow(
"codex run did not start within 60 seconds (phase: run start)",
);
@@ -3,6 +3,7 @@ import type { Logger } from "pino";
import type { AgentPromptInput, AgentRunOptions } from "./agent-sdk-types.js";
import type { AgentManager, ManagedAgent } from "./agent-manager.js";
import { ForegroundPromptStart } from "./agent-run-state.js";
import type { AgentStorage } from "./agent-storage.js";
import { ensureAgentLoaded } from "./agent-loading.js";
import { isStaleProviderSessionError } from "./stale-provider-session-error.js";
@@ -23,7 +24,10 @@ export type AgentRunController = Pick<
reloadAgentSession(agentId: string): Promise<unknown>;
};
export class AgentTurnBusyError extends Error {}
export interface StartAgentRunOptions {
idleOnly?: boolean;
/** Called after selecting the run, before consuming its events. */
onDispatch?: (disposition: PromptDispatchDisposition) => void;
replaceRunning?: boolean;
@@ -35,11 +39,17 @@ export interface StartAgentRunOptions {
export type PromptDispatchDisposition = "out_of_band" | "steered" | "turn_started";
/** A dispatched prompt. A started turn carries its sender's start outcome. */
export type PromptDispatchResult =
| { disposition: "turn_started"; started: Promise<void> }
| { disposition: Exclude<PromptDispatchDisposition, "turn_started"> };
async function steerOrReplaceActiveRun(
agentManager: AgentRunController,
agentId: string,
prompt: AgentPromptInput,
options: StartAgentRunOptions | undefined,
promptStart: ForegroundPromptStart,
): Promise<
| { disposition: "steered" }
| {
@@ -54,7 +64,12 @@ async function steerOrReplaceActiveRun(
const steerOptions = options.clearPendingPermissions
? { ...options.runOptions, clearPendingPermissions: true }
: options.runOptions;
const result = await agentManager.steerOrReplaceActiveTurn(agentId, prompt, steerOptions);
const result = await agentManager.steerOrReplaceActiveTurn(
agentId,
prompt,
steerOptions,
promptStart,
);
if (result.status === "steered") {
return { disposition: "steered" };
}
@@ -69,14 +84,15 @@ async function startOrReplaceRun(
agentId: string,
prompt: AgentPromptInput,
options: StartAgentRunOptions | undefined,
promptStart: ForegroundPromptStart,
): Promise<{
iterator: AsyncGenerator<import("./agent-sdk-types.js").AgentStreamEvent>;
replaced: boolean;
}> {
const replaced = Boolean(options?.replaceRunning && agentManager.hasInFlightRun(agentId));
const iterator = replaced
? await agentManager.replaceAgentRun(agentId, prompt, options?.runOptions)
: agentManager.streamAgent(agentId, prompt, options?.runOptions);
? await agentManager.replaceAgentRun(agentId, prompt, options?.runOptions, promptStart)
: agentManager.streamAgent(agentId, prompt, options?.runOptions, promptStart);
return { iterator, replaced };
}
@@ -94,7 +110,7 @@ export async function startAgentRun(
prompt: AgentPromptInput,
logger: Logger,
options?: StartAgentRunOptions,
): Promise<{ disposition: PromptDispatchDisposition }> {
): Promise<PromptDispatchResult> {
const snapshot = agentManager.getAgent(agentId);
logger.trace(
{
@@ -115,16 +131,25 @@ export async function startAgentRun(
options?.onDispatch?.("out_of_band");
return { disposition: "out_of_band" };
}
const promptStart = new ForegroundPromptStart(agentId);
try {
await agentManager.reloadStalePluginSession(agentId);
return await startAgentRunInner(agentManager, agentId, prompt, logger, options);
try {
await agentManager.reloadStalePluginSession(agentId);
return await startAgentRunInner(agentManager, agentId, prompt, logger, options, promptStart);
} catch (error) {
if (!isStaleProviderSessionError(error)) throw error;
logger.info(
{ agentId, err: error },
"Provider session went stale; reopening from persistence",
);
// The live session belongs to a retired plugin runtime. Reload swaps in a
// fresh session on the current runtime while preserving history and labels.
await agentManager.reloadAgentSession(agentId);
return await startAgentRunInner(agentManager, agentId, prompt, logger, options, promptStart);
}
} catch (error) {
if (!isStaleProviderSessionError(error)) throw error;
logger.info({ agentId, err: error }, "Provider session went stale; reopening from persistence");
// The live session belongs to a retired plugin runtime. Reload swaps in a
// fresh session on the current runtime while preserving history and labels.
await agentManager.reloadAgentSession(agentId);
return await startAgentRunInner(agentManager, agentId, prompt, logger, options);
promptStart.end();
throw error;
}
}
@@ -133,17 +158,23 @@ async function startAgentRunInner(
agentId: string,
prompt: AgentPromptInput,
logger: Logger,
options?: StartAgentRunOptions,
): Promise<{ disposition: PromptDispatchDisposition }> {
options: StartAgentRunOptions | undefined,
promptStart: ForegroundPromptStart,
): Promise<PromptDispatchResult> {
const snapshot = agentManager.getAgent(agentId);
const steered = await steerOrReplaceActiveRun(agentManager, agentId, prompt, options);
const steered = options?.idleOnly
? null
: await steerOrReplaceActiveRun(agentManager, agentId, prompt, options, promptStart);
if (options?.idleOnly && agentManager.hasInFlightRun(agentId)) {
throw new AgentTurnBusyError(`Agent ${agentId} is running`);
}
if (steered?.disposition === "steered") {
options?.onDispatch?.("steered");
return steered;
}
const { iterator, replaced } = steered
? { iterator: steered.iterator, replaced: true }
: await startOrReplaceRun(agentManager, agentId, prompt, options);
: await startOrReplaceRun(agentManager, agentId, prompt, options, promptStart);
logger.trace(
{
agentId,
@@ -165,7 +196,7 @@ async function startAgentRunInner(
"Provider session went stale; reopening from persistence",
);
await agentManager.reloadAgentSession(agentId);
const retry = await startOrReplaceRun(agentManager, agentId, prompt, options);
const retry = await startOrReplaceRun(agentManager, agentId, prompt, options, promptStart);
await drainAgentRunIterator(retry.iterator);
}
logger.trace(
@@ -187,9 +218,11 @@ async function startAgentRunInner(
"agent.session.iterator.error",
);
logger.error({ err: error, agentId }, "Agent stream failed");
} finally {
promptStart.end();
}
})();
return { disposition: "turn_started" };
return { disposition: "turn_started", started: promptStart.started };
}
/**
@@ -210,6 +243,7 @@ export async function unarchiveAgentState(
}
export interface SendPromptToAgentParams {
idleOnly?: boolean;
/** Awaited after the agent is loaded and its mode is set, before the prompt is handed to a run. */
beforeDispatch?: () => Promise<void>;
onDispatch?: StartAgentRunOptions["onDispatch"];
@@ -261,8 +295,9 @@ export interface StartCreatedAgentInitialPromptParams {
const AGENT_RUN_START_TIMEOUT_MS = 60_000;
export async function waitForAgentRunStartWithTimeout(
agentManager: AgentManager,
agentManager: Pick<AgentManager, "getAgent">,
agentId: string,
started: Promise<void>,
signal?: AbortSignal,
): Promise<void> {
const provider = agentManager.getAgent(agentId)?.provider ?? "provider";
@@ -277,15 +312,28 @@ export async function waitForAgentRunStartWithTimeout(
AGENT_RUN_START_TIMEOUT_MS,
);
const abortSignal = signal ? AbortSignal.any([startAbort.signal, signal]) : startAbort.signal;
let onAbort: (() => void) | null = null;
const aborted = new Promise<never>((_, reject) => {
onAbort = () => reject(createStartAbortError(abortSignal.reason));
if (abortSignal.aborted) onAbort();
else abortSignal.addEventListener("abort", onAbort, { once: true });
});
try {
await agentManager.waitForAgentRunStart(agentId, {
signal: signal ? AbortSignal.any([startAbort.signal, signal]) : startAbort.signal,
});
await Promise.race([started, aborted]);
} finally {
clearTimeout(startTimeout);
if (onAbort) abortSignal.removeEventListener("abort", onAbort);
}
}
function createStartAbortError(reason: unknown): Error {
let message = "wait_for_agent_start aborted";
if (typeof reason === "string") message = reason;
else if (reason instanceof Error) message = reason.message;
return Object.assign(new Error(message), { name: "AbortError" });
}
async function resolvePromptSource(
source: AgentPromptSource | undefined,
manager: Pick<AgentManager, "getAgent">,
@@ -311,7 +359,7 @@ async function resolvePromptSource(
*/
export async function sendPromptToAgent(
params: SendPromptToAgentParams,
): Promise<{ disposition: PromptDispatchDisposition }> {
): Promise<PromptDispatchResult> {
const source = await resolvePromptSource(params.source, params.agentManager, params.agentStorage);
const delivery = prepareAgentMessage(params.prompt, source, params.messageId);
return sendPreparedPromptToAgent({
@@ -326,14 +374,14 @@ export async function sendPromptToAgent(
/** Dispatch daemon-prepared context without reclassifying it as human input. */
export async function sendPreparedPromptToAgent(
params: Omit<SendPromptToAgentParams, "source" | "messageId">,
): Promise<{ disposition: PromptDispatchDisposition }> {
): Promise<PromptDispatchResult> {
const unarchive = params.unarchive ?? true;
const record = await params.agentStorage.get(params.agentId);
let archivedAtToRestore: string | null = null;
if (record?.archivedAt) {
if (!unarchive) {
return { disposition: "turn_started" };
return { disposition: "turn_started", started: Promise.resolve() };
}
if (await unarchiveAgentState(params.agentStorage, params.agentManager, params.agentId)) {
archivedAtToRestore = record.archivedAt;
@@ -355,13 +403,17 @@ export async function sendPreparedPromptToAgent(
throw error;
}
if (params.idleOnly && params.agentManager.hasInFlightRun(params.agentId)) {
throw new AgentTurnBusyError(`Agent ${params.agentId} is running`);
}
if (params.sessionMode) {
await params.agentManager.setAgentMode(params.agentId, params.sessionMode);
}
await params.beforeDispatch?.();
return await startAgentRun(params.agentManager, params.agentId, params.prompt, params.logger, {
replaceRunning: true,
replaceRunning: !params.idleOnly,
idleOnly: params.idleOnly,
onDispatch: params.onDispatch,
activeTurnBehavior: params.activeTurnBehavior,
clearPendingPermissions: params.clearPendingPermissions,
@@ -395,7 +447,11 @@ export async function startCreatedAgentInitialPrompt(
);
if (dispatchResult.disposition === "turn_started") {
await waitForAgentRunStartWithTimeout(params.agentManager, params.agentId);
await waitForAgentRunStartWithTimeout(
params.agentManager,
params.agentId,
dispatchResult.started,
);
}
const refreshedSnapshot = params.agentManager.getAgent(params.agentId) ?? params.snapshot ?? null;
@@ -13,7 +13,7 @@ export interface ForegroundTurnWaiter {
type ForegroundRunStart =
| { status: "pending" }
| { status: "started"; turnId: string }
| { status: "failed"; error: string };
| { status: "failed"; error: string; stale?: true };
export interface PendingForegroundRun {
token: string;
@@ -343,3 +343,59 @@ function settleTrackedRun(run: TrackedAgentRun): void {
run.settled = true;
run.resolveSettled();
}
/**
* Follows one sender's prompt to the foreground run that starts it. Each run created for the
* prompt, including a stale-session retry, is bound here, so `started` settles for this
* sender's prompt and never for another run the agent tracks.
*/
export class ForegroundPromptStart {
readonly started: Promise<void>;
private resolveStarted!: () => void;
private rejectStarted!: (error: Error) => void;
private run: PendingForegroundRun | null = null;
private done = false;
constructor(private readonly agentId: string) {
this.started = new Promise<void>((resolve, reject) => {
this.resolveStarted = resolve;
this.rejectStarted = reject;
});
// Steered and fire-and-forget dispatches never wait on the start.
this.started.catch(() => undefined);
}
/** A run was created for this prompt. */
bind(run: PendingForegroundRun): void {
this.run = run;
void Promise.race([run.turnStartedPromise, run.settledPromise]).then(() =>
this.settle(run, { ended: false }),
);
}
/** The prompt's dispatch is over; no further run will be created for it. */
end(): void {
this.settle(this.run, { ended: true });
}
private settle(run: PendingForegroundRun | null, { ended }: { ended: boolean }): void {
if (this.done || run !== this.run) return;
if (run?.start.status === "started") {
this.done = true;
this.resolveStarted();
return;
}
// A stale-session failure is retried with a new run; wait for it unless dispatch ended.
if (run?.start.status === "failed" && run.start.stale && !ended) return;
this.done = true;
this.rejectStarted(new Error(this.describeUnstarted(run)));
}
private describeUnstarted(run: PendingForegroundRun | null): string {
if (run?.start.status === "failed") return run.start.error;
if (run?.settled) {
return `Agent ${this.agentId} run was canceled before its turn started; its prompt was not delivered`;
}
return `Agent ${this.agentId} run finished before starting`;
}
}
@@ -528,6 +528,14 @@ export type AgentPermissionResponse =
interrupt?: boolean;
};
/** A requested turn was canceled before the provider accepted it. */
export class AgentTurnStartCanceledError extends Error {
constructor() {
super("Turn was canceled before starting");
this.name = "AgentTurnStartCanceledError";
}
}
export interface AgentRunResult {
sessionId: string;
finalText: string;
@@ -621,6 +629,8 @@ export interface AgentSessionConfig {
* persisted into agent config so daemon setting changes apply cleanly.
*/
daemonAppendSystemPrompt?: string;
/** Plugin instructions for this launch; never persisted. */
pluginAppendSystemPrompt?: string[];
modeId?: string;
model?: string;
thinkingOptionId?: string;
@@ -636,6 +646,8 @@ export interface AgentSessionConfig {
}
export interface AgentLaunchContext {
/** Launch-only instructions contributed by plugins. */
appendSystemPrompt?: string[];
/** Launch-only plugin MCP servers and their owners; never persisted. */
mcpServers?: Record<string, McpServerConfig>;
mcpServerOwners?: Record<string, string>;
@@ -688,6 +700,8 @@ export interface AgentUsageSession {
}
export interface AgentSession {
/** Persist the session's current handle immediately after an interactive resume. */
readonly persistenceUpdatedOnResume?: boolean;
usageSession?(): AgentUsageSession | null;
readonly provider: AgentProvider;
readonly id: string | null;
@@ -10,6 +10,7 @@ import { AgentManager } from "../agent-manager.js";
import { AgentStorage } from "../agent-storage.js";
import type { CreatePaseoWorktreeWorkflowResult } from "../../worktree-session.js";
import { createAgentCommand } from "./create.js";
import { ForegroundPromptStart } from "../agent-run-state.js";
import type { ManagedAgent } from "../agent-manager.js";
const logger = createTestLogger();
@@ -89,9 +90,12 @@ test("session create forwards clientMessageId to the initial prompt run options"
firstAgentContext: { attachments: [] },
});
expect(streamAgent).toHaveBeenCalledWith("agent-1", "hello from create", {
clientMessageId: "msg-create-1",
});
expect(streamAgent).toHaveBeenCalledWith(
"agent-1",
"hello from create",
{ clientMessageId: "msg-create-1" },
expect.any(ForegroundPromptStart),
);
});
test("session create validates the requested mode against the provider's modes", async () => {
@@ -498,3 +498,26 @@ test("finish recovery protects callers before durable intent has loaded", async
expect(recovered.hasPendingForCaller("parent")).toBe(true);
expect(recovered.hasPendingForCaller("unrelated")).toBe(false);
});
test("an undispatched follow-up does not block the running child's permission notification", async () => {
const state = await scenario();
await state.service.register(intent);
await until(() => state.observation.waits.length === 1);
await state.service.register(intent, true);
const result = outcome("running");
result.status = "permission";
result.final!.pendingPermissions = [
{
id: "approval",
provider: "codex",
name: "Bash",
kind: "tool",
input: { command: "run tests" },
} as NonNullable<typeof result.final>["pendingPermissions"][number],
];
state.observation.waits[0]!.result.resolve(result);
await until(() => state.delivery.prompts.length === 1);
expect(state.delivery.prompts[0]).toContain("needs permission");
expect(state.delivery.prompts[0]).toContain("approval");
expect(await state.store.list()).toHaveLength(2);
});
@@ -267,7 +267,9 @@ export function createFinishSubscriptions(deps: Dependencies): FinishSubscriptio
continue;
}
if (signal.aborted) return;
await decisions(group);
// A queued follow-up cannot start until the current permission is answered.
// Its pending registration must not hold the running turn's checkpoint.
if (pending.status !== "permission" || watch.pending) await decisions(group);
if (signal.aborted) return;
if (await suppressed(record, pending)) {
await remove(watch);
@@ -298,7 +298,7 @@ export function createHostResolver(input: {
status: agent.status,
guidance:
receipt.deliveryStatus === "queued"
? "Queued for delivery after two quiet seconds. You will get notified when the prompted agent finishes, errors, or needs permission unless notifyOnFinish is false."
? "Queued for delivery after two quiet seconds and the current turn ends, unless interrupt was requested. You will get notified when the prompted agent finishes, errors, or needs permission unless notifyOnFinish is false."
: "Dispatch acknowledged. Observe completion using get_agent_status/get_agent_activity or SDK/RPC subscriptions and wait APIs.",
});
},
@@ -1,3 +1,4 @@
import { AgentRunState, ForegroundPromptStart } from "./agent-run-state.js";
import {
createFinishSubscriptions,
createFinishObservation,
@@ -172,11 +173,12 @@ function registeredTool(
async function invokeToolWithParsedInput(
tool: RegisteredMcpToolWithHandler,
input: Record<string, unknown>,
awaitDispatch = true,
) {
const parsed = await tool.inputSchema.safeParseAsync(input);
expect(parsed.success).toBe(true);
const response = await tool.handler(parsed.data);
if (response.structuredContent.deliveryStatus === "queued") {
if (awaitDispatch && response.structuredContent.deliveryStatus === "queued") {
await toolDeliveries
.get(tool)!
.waitForDispatch(input.agentId as string, new AbortController().signal);
@@ -274,11 +276,19 @@ function buildAgentManagerSpies() {
effectiveOptionsFor: (_provider: string, own?: Record<string, unknown>) => own ?? {},
reloadStalePluginSession: async () => {},
hasInFlightRun: vi.fn().mockReturnValue(false),
hasPendingPermissions: () => false,
steerOrReplaceActiveTurn: async () => ({ status: "inactive" as const }),
tryRunOutOfBand: vi.fn().mockReturnValue(false),
subscribe: vi.fn().mockReturnValue(() => {}),
streamAgent: vi.fn(() => (async function* noop() {})()),
waitForAgentRunStart: vi.fn().mockResolvedValue(undefined),
streamAgent: vi.fn(
(agentId: string, _prompt: unknown, _options: unknown, start?: ForegroundPromptStart) => {
const runs = new AgentRunState();
const run = runs.createPendingRun(agentId);
runs.settleForegroundStart(run, { status: "started", turnId: `${agentId}-turn` });
start?.bind(run);
return (async function* noop() {})();
},
),
respondToPermission: vi.fn(),
cancelAgentRun: vi.fn(),
getPendingPermissions: vi.fn(),
@@ -623,6 +633,12 @@ class FakeBrowserToolsBroker {
}
class BoundaryAgentManagerFake {
subscribe() {
return () => {};
}
hasPendingPermissions() {
return false;
}
public getPluginTools(): [] {
return [];
}
@@ -877,8 +893,9 @@ function createPaseoWorktreeForMcpTest(options: {
async function createAgentMcpServer(
options: Parameters<typeof createAgentMcpServerWithDependencies>[0],
subscriptionStore?: FinishSubscriptionStore,
schedule?: (delayMs: number, callback: () => void) => () => void,
) {
const messages = createTestAgentMessages(options);
const messages = createTestAgentMessages({ ...options, schedule });
const records = new Map<string, FinishSubscription>();
const subscriptions = createFinishSubscriptions({
store: subscriptionStore ?? {
@@ -3677,15 +3694,15 @@ class HeldTurnAgentClient implements AgentClient {
describe("send_agent_prompt MCP tool", () => {
it.each([
{ agentScoped: true, behavior: undefined, available: true, steered: true },
{ agentScoped: true, behavior: "interrupt", available: true, steered: false },
{ agentScoped: true, behavior: "steer", available: true, steered: true },
{ agentScoped: false, behavior: undefined, available: true, steered: false },
{ agentScoped: false, behavior: "steer", available: true, steered: true },
{ agentScoped: true, behavior: undefined, available: false, steered: false },
{ agentScoped: true, behavior: undefined, available: true },
{ agentScoped: true, behavior: "interrupt", available: true },
{ agentScoped: true, behavior: "steer", available: true },
{ agentScoped: false, behavior: undefined, available: true },
{ agentScoped: false, behavior: "steer", available: true },
{ agentScoped: true, behavior: undefined, available: false },
] as const)(
"dispatches behavior $behavior for agent-scoped=$agentScoped, steering available=$available",
async ({ agentScoped, behavior, available, steered }) => {
async ({ agentScoped, behavior, available }) => {
const workdir = await mkdtemp(join(tmpdir(), "mcp-send-behavior-"));
const storage = new AgentStorage(join(workdir, "agents"), logger);
const client = new HeldTurnAgentClient("codex", true, {
@@ -3717,18 +3734,33 @@ describe("send_agent_prompt MCP tool", () => {
notifyOnFinish: false,
});
const originalTurn = manager.getAgent(child.id)!.activeTurnId;
const response = await invokeToolWithParsedInput(tool, {
agentId: child.id,
prompt: "New message",
notifyOnFinish: false,
...(behavior ? { activeTurnBehavior: behavior } : {}),
});
const queued = agentScoped && behavior !== "interrupt";
const steered = !agentScoped && behavior === "steer";
const response = await invokeToolWithParsedInput(
tool,
{
agentId: child.id,
prompt: "New message",
notifyOnFinish: false,
...(behavior ? { activeTurnBehavior: behavior } : {}),
},
!queued,
);
expect(response.structuredContent).toMatchObject({
success: true,
...(agentScoped
? { deliveryStatus: "queued" }
: { disposition: steered ? "steered" : "turn_started" }),
});
if (queued) {
expect(client.sessions[1]!.prompts).toHaveLength(1);
expect(client.sessions[1]!.steeredPrompts).toEqual([]);
expect(manager.getAgent(child.id)!.activeTurnId).toBe(originalTurn);
client.sessions[1]!.finishTurn();
await serverDeliveries
.get(server)!
.waitForDispatch(child.id, new AbortController().signal);
}
expect(client.sessions[1]!.prompts).toHaveLength(steered ? 1 : 2);
expect(client.sessions[1]!.steeredPrompts).toHaveLength(steered ? 1 : 0);
expect(manager.getAgent(child.id)!.activeTurnId === originalTurn).toBe(steered);
@@ -3740,18 +3772,16 @@ describe("send_agent_prompt MCP tool", () => {
it.each([
{ rejected: false, priorNotification: false },
{ rejected: true, priorNotification: false },
{ rejected: false, priorNotification: true },
{ rejected: true, priorNotification: false },
{ rejected: true, priorNotification: true },
])(
"buffers completion until steer acknowledgement (rejected: $rejected, prior notification: $priorNotification)",
"keeps completion tied to queued dispatch acknowledgement (rejected: $rejected, prior notification: $priorNotification)",
async ({ rejected, priorNotification }) => {
const workdir = await mkdtemp(join(tmpdir(), "mcp-send-behavior-"));
const workdir = await mkdtemp(join(tmpdir(), "mcp-queued-ack-"));
const storage = new AgentStorage(join(workdir, "agents"), logger);
const client = new HeldTurnAgentClient("codex", true, {
steerResult: "accepted",
finishDuringSteer: true,
rejectSteer: rejected,
});
const options: HeldTurnOptions = {};
const client = new HeldTurnAgentClient("codex", true, options);
const manager = new AgentManager({ clients: { codex: client }, registry: storage, logger });
let mcpClient: Client | undefined;
try {
@@ -3773,104 +3803,47 @@ describe("send_agent_prompt MCP tool", () => {
logger,
});
mcpClient = await connectInMemoryMcpClient(server);
const send = (input: Record<string, unknown>) =>
sendMcpAndAwaitDispatch(mcpClient!, server, input);
await send({
await sendMcpAndAwaitDispatch(mcpClient, server, {
agentId: child.id,
prompt: "Original work",
notifyOnFinish: priorNotification,
});
const sending = send({
agentId: child.id,
prompt: "New message",
notifyOnFinish: true,
const session = client.sessions[1]!;
const release = session.holdTurnStart();
options.finishTurnsDuringStart = true;
if (rejected) session.rejectNextTurnStart(new Error("Start rejected"));
const response = await mcpClient.callTool({
name: "send_agent_prompt",
arguments: { agentId: child.id, prompt: "New message", notifyOnFinish: true },
});
if (rejected) {
await expect(sending).rejects.toThrow("Steer rejected");
// Flush asynchronous notification work before checking that a rejected
// dispatch did not notify. Then prove a later successful send still can.
await new Promise((resolve) => setTimeout(resolve, 50));
expect(client.sessions[0]!.prompts).toHaveLength(0);
await send({
agentId: child.id,
prompt: "Retry after rejection",
expect(response.structuredContent).toMatchObject({
success: true,
deliveryStatus: "queued",
});
const dispatch = serverDeliveries
.get(server)!
.waitForDispatch(child.id, new AbortController().signal);
const rejectedDispatch = rejected
? expect(dispatch).rejects.toThrow("Start rejected")
: null;
expect(client.sessions[0]!.prompts).toHaveLength(0);
session.finishTurn();
await vi.waitFor(() => expect(session.prompts).toHaveLength(2));
expect(client.sessions[0]!.prompts).toHaveLength(0);
release();
if (rejectedDispatch) await rejectedDispatch;
else await dispatch;
if (!rejected || priorNotification) {
await vi.waitFor(() => expect(client.sessions[0]!.prompts).toHaveLength(1), {
timeout: 5000,
});
expect(parseAgentMessage(client.sessions[0]!.prompts[0])).toMatchObject({
source: { kind: "agent-notification", agentId: child.id, event: "finished" },
});
client.sessions[1]!.finishTurn();
} else {
const response = await sending;
expect(response.structuredContent).toMatchObject({
success: true,
deliveryStatus: "queued",
});
}
await vi.waitFor(() => expect(client.sessions[0]!.prompts).toHaveLength(1));
expect(parseAgentMessage(client.sessions[0]!.prompts[0])).toMatchObject({
source: { kind: "agent-notification", agentId: child.id, event: "finished" },
});
} finally {
await mcpClient?.close();
await removeAgentStateDir(manager, storage, workdir);
}
},
);
it.each([false, true])(
"preserves the original notification after rejection (completion during send: %s)",
async (finishDuringSteer) => {
const workdir = await mkdtemp(join(tmpdir(), "mcp-send-behavior-"));
const storage = new AgentStorage(join(workdir, "agents"), logger);
const client = new HeldTurnAgentClient("codex", true, {
steerResult: "accepted",
finishDuringSteer,
rejectSteer: true,
});
const manager = new AgentManager({ clients: { codex: client }, registry: storage, logger });
let mcpClient: Client | undefined;
try {
const parent = await manager.createAgent(
{ provider: "codex", cwd: existingCwd },
undefined,
{
workspaceId: "wks_parent",
},
);
const child = await manager.createAgent(
{ provider: "codex", cwd: existingCwd },
undefined,
{
workspaceId: "wks_parent",
},
);
const server = await createAgentMcpServer({
agentManager: manager,
agentStorage: storage,
callerAgentId: parent.id,
providerSnapshotManager: createOpenCodeManager().manager,
logger,
});
mcpClient = await connectInMemoryMcpClient(server);
const send = (input: Record<string, unknown>) =>
sendMcpAndAwaitDispatch(mcpClient!, server, input);
await send({
agentId: child.id,
prompt: "Original work",
notifyOnFinish: true,
});
const sending = send({
agentId: child.id,
prompt: "New message",
notifyOnFinish: true,
});
await expect(sending).rejects.toThrow("Steer rejected");
if (!finishDuringSteer) {
await new Promise((resolve) => setTimeout(resolve, 50));
await serverSubscriptions.get(server)!.close();
expect(client.sessions[0]!.prompts).toHaveLength(0);
client.sessions[1]!.finishTurn();
}
await vi.waitFor(() => expect(client.sessions[0]!.prompts).toHaveLength(1));
expect(parseAgentMessage(client.sessions[0]!.prompts[0])).toMatchObject({
source: { kind: "agent-notification", agentId: child.id, event: "finished" },
});
} finally {
await mcpClient?.close();
await removeAgentStateDir(manager, storage, workdir);
@@ -4012,7 +3985,7 @@ describe("send_agent_prompt MCP tool", () => {
const response = await tool.handler(parsed.data as Record<string, unknown>);
expect(response.structuredContent).toMatchObject({ deliveryStatus: "queued" });
expect(spies.agentManager.subscribe).not.toHaveBeenCalled();
expect(serverSubscriptionRecords.get(server)!.size).toBe(1);
await serverDeliveries
.get(server)!
.waitForDispatch("child-agent", new AbortController().signal);
@@ -4053,7 +4026,7 @@ describe("send_agent_prompt MCP tool", () => {
await tool.handler(parsed.data as Record<string, unknown>);
expect(spies.agentManager.subscribe).not.toHaveBeenCalled();
expect(serverSubscriptionRecords.get(server)!.size).toBe(0);
expect(spies.agentManager.waitForAgentEvent).not.toHaveBeenCalled();
});
@@ -4096,7 +4069,7 @@ describe("send_agent_prompt MCP tool", () => {
notifyOnFinish: false,
});
expect(spies.agentManager.subscribe).not.toHaveBeenCalled();
expect(serverSubscriptionRecords.get(server)!.size).toBe(0);
expect(spies.agentManager.waitForAgentEvent).not.toHaveBeenCalled();
});
@@ -4220,11 +4193,15 @@ describe("send_agent_prompt MCP tool", () => {
notifyOnFinish: false,
});
if (scenario !== "startup_failure") {
const response = await invokeToolWithParsedInput(tool, {
agentId: child.id,
prompt: "/side-command",
activeTurnBehavior: scenario === "out_of_band_interrupt" ? "interrupt" : "steer",
});
const response = await invokeToolWithParsedInput(
tool,
{
agentId: child.id,
prompt: "/side-command",
activeTurnBehavior: scenario === "out_of_band_interrupt" ? "interrupt" : "steer",
},
scenario !== "out_of_band",
);
expect(response.structuredContent).toMatchObject({
success: true,
deliveryStatus: "queued",
@@ -4236,6 +4213,9 @@ describe("send_agent_prompt MCP tool", () => {
});
expect(parentClient.sessions[0]!.prompts).toHaveLength(0);
childClient.sessions[0]!.finishTurn("Ongoing task done");
await serverDeliveries
.get(server)!
.waitForDispatch(child.id, new AbortController().signal);
await vi.waitFor(() => {
expect(parentClient.sessions[0]!.prompts).toHaveLength(1);
expect(parentClient.sessions[0]!.prompts[0]).toContain("finished.");
@@ -4243,7 +4223,11 @@ describe("send_agent_prompt MCP tool", () => {
} else {
childClient.sessions[0]!.rejectNextTurnStart(new Error("Requested turn could not start"));
await expect(
invokeToolWithParsedInput(tool, { agentId: child.id, prompt: "Replacement task" }),
invokeToolWithParsedInput(tool, {
agentId: child.id,
prompt: "Replacement task",
activeTurnBehavior: "interrupt",
}),
).rejects.toThrow("Requested turn could not start");
// A later real turn must not inherit a subscription from the rejected dispatch.
await invokeToolWithParsedInput(tool, {
@@ -4354,6 +4338,7 @@ describe("send_agent_prompt MCP tool", () => {
const sent = await invokeToolWithParsedInput(registeredTool(server, "send_agent_prompt"), {
agentId: childId,
prompt: "Stop and reply instead",
activeTurnBehavior: "interrupt",
});
expect(sent.structuredContent).toMatchObject({
success: true,
@@ -4517,7 +4502,7 @@ describe("send_agent_prompt MCP tool to an OMP child", () => {
const logger = createTestLogger();
const existingCwd = process.cwd();
async function setupOmpChild() {
async function setupOmpChild(schedule?: (delayMs: number, callback: () => void) => () => void) {
const workdir = await mkdtemp(join(tmpdir(), "mcp-omp-child-"));
const storage = new AgentStorage(join(workdir, "agents"), logger);
const parentClient = new HeldTurnAgentClient("claude", false);
@@ -4545,13 +4530,17 @@ describe("send_agent_prompt MCP tool to an OMP child", () => {
undefined,
{ workspaceId: "wks_parent" },
);
const server = await createAgentMcpServer({
agentManager,
agentStorage: storage,
callerAgentId: parent.id,
providerSnapshotManager: createOpenCodeManager().manager,
logger,
});
const server = await createAgentMcpServer(
{
agentManager,
agentStorage: storage,
callerAgentId: parent.id,
providerSnapshotManager: createOpenCodeManager().manager,
logger,
},
undefined,
schedule,
);
return {
agentManager,
storage,
@@ -4581,37 +4570,63 @@ describe("send_agent_prompt MCP tool to an OMP child", () => {
{ command: "follow-up", streamingBehavior: "followUp" },
{ command: "steer", streamingBehavior: "steer" },
] as const)(
"delivers /$command into a turn OMP started on its own, without aborting it",
"delivers /$command to a running OMP child while ordinary messages in the same quiet window wait",
async ({ command, streamingBehavior }) => {
const { agentManager, storage, workdir, parentClient, ompSession, childId, tool } =
await setupOmpChild();
let flush!: () => void;
const { agentManager, storage, workdir, ompSession, childId, tool } = await setupOmpChild(
(_delay, callback) => {
flush = callback;
return () => {};
},
);
try {
ompSession.beginTurn();
ompSession.streamAssistantText("background job finished, working on it");
await vi.waitFor(() => {
expect(agentManager.getAgent(childId)?.activeTurnId).toMatch(/^autonomous-/);
});
const response = await invokeToolWithParsedInput(tool, {
agentId: childId,
prompt: `/${command} then summarize the logs`,
});
expect(response.structuredContent).toMatchObject({
success: true,
deliveryStatus: "queued",
status: "running",
const activeTurnId = agentManager.getAgent(childId)?.activeTurnId;
const delivery = toolDeliveries.get(tool)!;
let ordinaryBeforeDispatch = 0;
const ordinary = delivery.enqueue({
recipientId: childId,
source: { kind: "agent-message", agentId: "parent" },
prompt: "ordinary follow-up",
beforeDispatch: () => {
ordinaryBeforeDispatch++;
},
});
const response = await invokeToolWithParsedInput(
tool,
{
agentId: childId,
prompt: `/${command} then summarize the logs`,
},
false,
);
flush();
await vi.waitFor(() => {
expect(ompSession.prompts).toEqual([
{ message: "then summarize the logs", imageCount: 0, streamingBehavior },
]);
});
expect(ordinaryBeforeDispatch).toBe(0);
expect(agentManager.getAgent(childId)?.activeTurnId).toBe(activeTurnId);
expect(response.structuredContent).toMatchObject({
success: true,
deliveryStatus: "queued",
status: "running",
});
expect(ompSession.abortRequested).toBe(false);
expect(agentManager.getAgent(childId)?.lifecycle).toBe("running");
ompSession.finishTurn();
await expectOneFinishNotification(agentManager, parentClient, childId);
await ordinary.dispatched;
expect(ordinaryBeforeDispatch).toBe(1);
expect(ompSession.prompts).toHaveLength(2);
expect(ompSession.prompts[1]!.message).toContain("ordinary follow-up");
ompSession.beginTurn();
ompSession.finishTurn();
} finally {
await removeAgentStateDir(agentManager, storage, workdir);
}
@@ -1949,7 +1949,11 @@ function mapSessionConfig(
return {
cwd: config.cwd,
env: createProviderEnv({ baseEnv: {}, overlays: [launchContext?.env] }),
systemPrompt: combineSystemPrompts(config.systemPrompt, config.daemonAppendSystemPrompt),
systemPrompt: combineSystemPrompts(
config.systemPrompt,
config.daemonAppendSystemPrompt,
...(config.pluginAppendSystemPrompt ?? []),
),
mcpServers: { ...config.mcpServers },
toolPolicy: config.toolPolicy
? { preapproved: config.toolPolicy.preapproved.map((grant) => ({ ...grant })) }
@@ -1968,8 +1972,9 @@ function mapSessionConfig(
function combineSystemPrompts(
systemPrompt: string | undefined,
daemonPrompt: string | undefined,
...pluginPrompts: string[]
): string | undefined {
const parts = [systemPrompt, daemonPrompt].filter(
const parts = [systemPrompt, daemonPrompt, ...pluginPrompts].filter(
(value): value is string => typeof value === "string" && value.trim().length > 0,
);
return parts.length > 0 ? parts.join("\n\n") : undefined;
@@ -448,6 +448,9 @@ export function wrapSessionProvider(provider: AgentProvider, inner: AgentSession
get initialTimeline() {
return inner.initialTimeline;
},
get persistenceUpdatedOnResume() {
return inner.persistenceUpdatedOnResume;
},
get controls() {
return inner.controls;
},
@@ -153,6 +153,56 @@ describe("Claude SDK env", () => {
}
});
test("resume uses current plugin instructions and excludes them from persistence", async () => {
const prompts: unknown[] = [];
const queryFactory = ({ options }: ClaudeQueryInput) => {
prompts.push(options.systemPrompt);
return createQueryMock([
{
type: "system",
subtype: "init",
session_id: "persisted-session",
permissionMode: "default",
model: "opus",
},
{ type: "assistant", message: { content: "done" } },
{
type: "result",
subtype: "success",
usage: { input_tokens: 1, cache_read_input_tokens: 0, output_tokens: 1 },
total_cost_usd: 0,
},
]);
};
const client = new ClaudeAgentClient({
logger: createTestLogger(),
queryFactory,
resolveBinary: async () => "/test/claude/bin",
});
const first = await client.createSession({
provider: "claude",
cwd: process.cwd(),
pluginAppendSystemPrompt: ["Plugin instructions"],
});
await first.run("first");
const handle = first.describePersistence()!;
expect(handle.metadata).not.toHaveProperty("pluginAppendSystemPrompt");
await first.close();
const resumed = await client.resumeSession(handle, {
cwd: process.cwd(),
pluginAppendSystemPrompt: undefined,
});
try {
await resumed.run("after disable");
expect(prompts).toEqual([
{ type: "preset", preset: "claude_code", append: "Plugin instructions" },
{ type: "preset", preset: "claude_code", append: "" },
]);
} finally {
await resumed.close();
}
});
test("forwards launch-context env through Claude resume env", async () => {
let capturedEnv: Record<string, string | undefined> | undefined;
const launchContext: AgentLaunchContext = {
@@ -3049,7 +3049,11 @@ class ClaudeAgentSession implements AgentSession {
if (!this.claudeSessionId) {
return null;
}
const { providerOptions: _providerOptions, ...persistedConfig } = this.config;
const {
providerOptions: _providerOptions,
pluginAppendSystemPrompt: _pluginAppendSystemPrompt,
...persistedConfig
} = this.config;
this.persistence = {
provider: "claude",
sessionId: this.claudeSessionId,
@@ -3717,7 +3721,11 @@ class ClaudeAgentSession implements AgentSession {
private buildAppendedSystemPrompt(): string {
return (
composeSystemPromptParts(this.config.systemPrompt, this.config.daemonAppendSystemPrompt) ?? ""
composeSystemPromptParts(
this.config.systemPrompt,
this.config.daemonAppendSystemPrompt,
...(this.config.pluginAppendSystemPrompt ?? []),
) ?? ""
);
}
@@ -22,6 +22,18 @@ function isCodexInstalled(): boolean {
}
}
function supportsInstructionSnapshots(): boolean {
try {
const match = execFileSync("codex", ["--version"], { encoding: "utf8" }).match(
/(\d+)\.(\d+)\.(\d+)/,
);
if (!match) return false;
return Number(match[1]) > 0 || Number(match[2]) >= 121;
} catch {
return false;
}
}
function sse(events: unknown[]): string {
return events
.map((event) => {
@@ -133,7 +145,7 @@ async function startMockResponsesServer(sequence: string[]): Promise<{
}> {
const requestBodies: string[] = [];
let index = 0;
const server = createServer((req, res) => {
const server = createServer({ maxHeaderSize: 1024 * 1024 }, (req, res) => {
const chunks: Buffer[] = [];
req.on("data", (chunk) => chunks.push(Buffer.from(chunk)));
req.on("end", () => {
@@ -221,6 +233,85 @@ function waitForEvent<TEvent extends AgentStreamEvent>(params: {
}
describe("Codex app-server provider (local e2e)", () => {
test.runIf(supportsInstructionSnapshots())(
"delivers changed and removed instructions to the model across process restarts",
async () => {
const artifactDir = path.resolve(process.cwd(), "../../.artifacts");
mkdirSync(artifactDir, { recursive: true });
const cwd = mkdtempSync(path.join(artifactDir, "codex-snapshot-cwd-"));
const codexHome = mkdtempSync(path.join(artifactDir, "codex-snapshot-home-"));
const server = await startMockResponsesServer([]);
const client = new CodexAppServerAgentClient(createTestLogger());
const base = { provider: "codex" as const, cwd, modeId: "auto", model: "mock-model" };
const launch = { env: { CODEX_HOME: codexHome } };
const run = async (session: Awaited<ReturnType<typeof client.createSession>>) => {
const finished = waitForEvent({
session,
timeoutMs: 20_000,
label: "turn completion",
predicate: (
event,
): event is Extract<
AgentStreamEvent,
{ type: "turn_completed" | "turn_failed" | "turn_canceled" }
> =>
event.type === "turn_completed" ||
event.type === "turn_failed" ||
event.type === "turn_canceled",
});
await session.startTurn("continue");
const result = await finished;
if (result.type !== "turn_completed") throw new Error(JSON.stringify(result));
const handle = session.describePersistence();
if (!handle) throw new Error("Expected persisted Codex thread");
await session.close();
return handle;
};
try {
writeMockCodexConfig(codexHome, server.url);
let handle = await run(
await client.createSession(
{ ...base, pluginAppendSystemPrompt: ["old snapshot"] },
launch,
),
);
expect(server.requestBodies.at(-1)).toContain("old snapshot");
expect(server.requestBodies.at(-1)).not.toContain("paseo_instruction_snapshot");
handle = await run(
await client.resumeSession(
handle,
{ ...base, pluginAppendSystemPrompt: ["new snapshot"] },
launch,
),
);
expect(server.requestBodies.at(-1)).toContain("new snapshot");
expect(server.requestBodies.at(-1)?.match(/paseo_instruction_snapshot/g)).toHaveLength(2);
handle = await run(
await client.resumeSession(
handle,
{ ...base, pluginAppendSystemPrompt: ["new snapshot"] },
launch,
),
);
expect(server.requestBodies.at(-1)?.match(/paseo_instruction_snapshot/g)).toHaveLength(2);
await run(
await client.resumeSession(
handle,
{ ...base, pluginAppendSystemPrompt: undefined },
launch,
),
);
expect(server.requestBodies.at(-1)).toContain('\\"instructions\\":\\"\\"');
expect(server.requestBodies.at(-1)?.match(/paseo_instruction_snapshot/g)).toHaveLength(4);
} finally {
await server.close();
rmSync(cwd, { recursive: true, force: true });
rmSync(codexHome, { recursive: true, force: true });
}
},
60_000,
);
test.runIf(isCodexInstalled())(
"concurrent import scans initialize successfully in a fresh shared Codex home",
async () => {
@@ -7,6 +7,7 @@ import { tmpdir } from "node:os";
import path from "node:path";
import { PassThrough } from "node:stream";
import { fileURLToPath } from "node:url";
import { CodexInstructionSnapshot } from "./codex/instruction-snapshot.js";
import type {
AgentClient,
@@ -100,6 +101,7 @@ import {
import { createTestLogger } from "../../../test-utils/test-logger.js";
import { asInternals as castInternals, createStub } from "../../test-utils/class-mocks.js";
import { AgentManager } from "../agent-manager.js";
import { AgentStorage } from "../agent-storage.js";
import { buildProviderRegistry } from "../provider-registry.js";
interface CollaborationModeRecord {
@@ -173,6 +175,9 @@ function createSession(
) as CodexTestSession;
session.connectionState = "connected";
session.currentThreadId = "test-thread";
castInternals<{ instructionSnapshot: { recordNewThread(id: string): void } }>(
session,
).instructionSnapshot.recordNewThread("test-thread");
session.activeForegroundTurnId = "test-turn";
return session;
}
@@ -683,7 +688,7 @@ function codexAgentItem(text: string) {
// An AgentManager over a real Codex provider whose every spawn gets a fresh fake
// app-server serving `threads` from thread/read.
function createReopenableCodexAgent(threads: Record<string, unknown[]>) {
function createReopenableCodexAgent(threads: Record<string, unknown[]>, registry?: AgentStorage) {
const appServers: FakeCodexAppServer[] = [];
const provider = new CodexAppServerAgentClient(createTestLogger(), undefined, {
appServerProcess: createFakeCodexAppServerProcess(() => {
@@ -715,7 +720,11 @@ function createReopenableCodexAgent(threads: Record<string, unknown[]>) {
},
resumeSession: (...args) => provider.resumeSession(...args),
};
const manager = new AgentManager({ clients: { codex: client }, logger: createTestLogger() });
const manager = new AgentManager({
clients: { codex: client },
registry,
logger: createTestLogger(),
});
const agentId = "00000000-0000-4000-8000-000000000001";
const handle = { provider: "codex", sessionId: "saved-thread" };
const config = createConfig({ cwd: process.cwd() });
@@ -728,6 +737,9 @@ function createReopenableCodexAgent(threads: Record<string, unknown[]>) {
return {
manager,
agentId,
handle,
config,
appServers,
latestAppServer: () => appServers[appServers.length - 1],
threadMethods: (index: number) =>
appServers[index]
@@ -1406,6 +1418,216 @@ describe("Codex app-server provider", () => {
}
});
test("reopening drops disabled plugin instructions and starts with fresh collaboration settings", async () => {
const modes = {
data: [
{
name: "Code",
mode: "default",
model: null,
reasoning_effort: null,
},
],
};
const firstServer = createFakeCodexAppServer({ "collaborationMode/list": () => modes });
const first = await createProviderWithFakeAppServer(firstServer).createSession(
createConfig({ pluginAppendSystemPrompt: ["Plugin instructions"] }),
);
await first.startTurn("first");
const firstTurn = await firstServer.waitForTurnStart();
expect(
firstServer.requests().find((request) => request.method === "thread/start")?.params,
).toMatchObject({ developerInstructions: "Plugin instructions" });
expect(firstTurn).toMatchObject({
collaborationMode: {
settings: { developer_instructions: null },
},
});
const started = waitForNextEvent(first, "thread_started");
firstServer.startsTurn({ threadId: "thread-1" });
await started;
const handle = first.describePersistence()!;
expect(handle.metadata).not.toHaveProperty("pluginAppendSystemPrompt");
await first.close();
const secondServer = createFakeCodexAppServer({ "collaborationMode/list": () => modes });
const resumed = await createProviderWithFakeAppServer(secondServer).resumeSession(handle, {
pluginAppendSystemPrompt: undefined,
});
try {
const resume = secondServer.requests().find((request) => request.method === "thread/resume");
expect(resume?.params).not.toHaveProperty("developerInstructions");
await resumed.startTurn("after disable");
const secondTurn = await secondServer.waitForTurnStart();
expect(secondTurn).not.toHaveProperty("developerInstructions");
expect(secondTurn).toMatchObject({
collaborationMode: { settings: { developer_instructions: null } },
});
firstServer.assertNoErrors();
secondServer.assertNoErrors();
} finally {
await resumed.close();
}
});
test("reopen injects current instructions once, including an explicit empty snapshot", async () => {
const handlers = {
initialize: () => ({ userAgent: "codex/0.165.0" }),
"thread/inject_items": () => ({}),
};
const firstServer = createFakeCodexAppServer(handlers);
const first = await createProviderWithFakeAppServer(firstServer).createSession(
createConfig({ pluginAppendSystemPrompt: ["Old plugin"] }),
);
await first.startTurn("first");
const started = waitForNextEvent(first, "thread_started");
firstServer.startsTurn({ threadId: "thread-1" });
await started;
expect(
firstServer.requests().filter((request) => request.method === "thread/inject_items"),
).toEqual([]);
const original = first.describePersistence()!;
expect(original.metadata).toHaveProperty("paseoInstructionReceipt");
await first.close();
const changedServer = createFakeCodexAppServer(handlers);
const changed = await createProviderWithFakeAppServer(changedServer).resumeSession(original, {
pluginAppendSystemPrompt: ["New plugin"],
});
const injected = changedServer
.requests()
.filter((request) => request.method === "thread/inject_items");
expect(injected).toHaveLength(1);
expect(JSON.stringify(injected[0]?.params)).toContain("New plugin");
const changedHandle = changed.describePersistence()!;
expect(changedHandle.metadata?.paseoInstructionReceipt).not.toEqual(
original.metadata?.paseoInstructionReceipt,
);
await changed.close();
const sameServer = createFakeCodexAppServer(handlers);
const same = await createProviderWithFakeAppServer(sameServer).resumeSession(changedHandle, {
pluginAppendSystemPrompt: ["New plugin"],
});
expect(
sameServer.requests().filter((request) => request.method === "thread/inject_items"),
).toEqual([]);
await same.close();
const emptyServer = createFakeCodexAppServer(handlers);
const empty = await createProviderWithFakeAppServer(emptyServer).resumeSession(changedHandle, {
pluginAppendSystemPrompt: undefined,
});
const removal = emptyServer
.requests()
.filter((request) => request.method === "thread/inject_items");
expect(removal).toHaveLength(1);
expect(JSON.stringify(removal[0]?.params)).toContain('\\"instructions\\":\\"\\"');
await empty.close();
});
test("requires a compatible Codex version before creating a thread with plugin instructions", async () => {
const appServer = createFakeCodexAppServer({
initialize: () => ({ userAgent: "codex/0.120.0" }),
});
await expect(
createProviderWithFakeAppServer(appServer).createSession(
createConfig({ pluginAppendSystemPrompt: ["Plugin instructions"] }),
),
).rejects.toThrow("Update Codex to 0.121.0 or newer");
});
test("retries an instruction snapshot when injection fails", async () => {
const snapshot = new CodexInstructionSnapshot("current", undefined);
const request = vi
.fn()
.mockRejectedValueOnce(new Error("connection lost"))
.mockResolvedValue({});
await expect(snapshot.apply("thread-1", request, true)).rejects.toThrow("connection lost");
expect(snapshot.describe("thread-1")).toBeUndefined();
await snapshot.apply("thread-1", request, true);
expect(snapshot.describe("thread-1")).toEqual({
threadId: "thread-1",
digest: expect.any(String),
});
await snapshot.apply("thread-1", request, true);
expect(request).toHaveBeenCalledTimes(2);
});
test("keeps built-in Plan instructions while sending plugin instructions to the thread", async () => {
const appServer = createFakeCodexAppServer({
"collaborationMode/list": () => ({
data: [
{ name: "Plan", mode: "plan", model: null, reasoning_effort: "medium" },
{ name: "Default", mode: "default", model: null, reasoning_effort: null },
],
}),
});
const session = await createProviderWithFakeAppServer(appServer).createSession(
createConfig({
pluginAppendSystemPrompt: ["Plugin instructions"],
providerOptions: { plan_mode: true },
}),
);
try {
await session.startTurn("make a plan");
const start = appServer.requests().find((request) => request.method === "thread/start");
expect(start?.params).toMatchObject({ developerInstructions: "Plugin instructions" });
expect(await appServer.waitForTurnStart()).toMatchObject({
collaborationMode: { mode: "plan", settings: { developer_instructions: null } },
});
expect(
appServer.requests().find((request) => request.method === "turn/start")?.params,
).not.toHaveProperty("developerInstructions");
appServer.assertNoErrors();
} finally {
await session.close();
}
});
test.each([
{ instructions: undefined, expected: undefined },
{ instructions: ["Current plugin"], expected: "Current plugin" },
])(
"rebuilds restored instructions with an unavailable collaboration catalog: $expected",
async ({ instructions, expected }) => {
const appServer = createFakeCodexAppServer({
"collaborationMode/list": () => ({ data: [] }),
"thread/resume": () => ({
thread: { id: "saved-thread" },
collaborationMode: {
mode: "default",
settings: {
model: "gpt-5.4",
reasoning_effort: "medium",
developer_instructions: "Old plugin",
},
},
}),
});
const session = await createProviderWithFakeAppServer(appServer).resumeSession(
{ sessionId: "saved-thread" },
{ pluginAppendSystemPrompt: instructions },
);
try {
const resume = appServer.requests().find((request) => request.method === "thread/resume");
if (expected) expect(resume?.params).toMatchObject({ developerInstructions: expected });
else expect(resume?.params).not.toHaveProperty("developerInstructions");
await session.startTurn("after reopen");
const turn = await appServer.waitForTurnStart();
expect(turn).toMatchObject({
collaborationMode: {
mode: "default",
settings: { model: "gpt-5.4", developer_instructions: null },
},
});
appServer.assertNoErrors();
} finally {
await session.close();
}
},
);
test("keeps the default effort when a session without one is resumed after a restart", async () => {
const beforeRestart = createFakeCodexAppServer();
const firstSession = await createProviderWithFakeAppServer(beforeRestart).createSession(
@@ -2315,7 +2537,12 @@ describe("Codex app-server provider", () => {
]);
// Background terminal observation is independent of conversation history loading.
const historyMethods = (index: number) =>
codex.threadMethods(index).filter((method) => method !== "thread/backgroundTerminals/list");
codex
.threadMethods(index)
.filter(
(method) =>
method !== "thread/backgroundTerminals/list" && method !== "thread/inject_items",
);
expect(historyMethods(0)).toEqual([
"thread/loaded/list",
"thread/resume",
@@ -2329,6 +2556,34 @@ describe("Codex app-server provider", () => {
}
});
test("persists an acknowledged instruction snapshot before a turn on repeated opens", async () => {
const artifactDir = path.resolve(process.cwd(), "../../.artifacts");
mkdirSync(artifactDir, { recursive: true });
const dir = await mkdtemp(path.join(artifactDir, "codex-receipt-"));
const storage = new AgentStorage(dir, createTestLogger());
const codex = createReopenableCodexAgent({}, storage);
try {
let handle = codex.handle;
for (let i = 0; i < 3; i++) {
await codex.manager.resumeAgentFromPersistence(handle, codex.config, codex.agentId);
await storage.flush();
const saved = await storage.get(codex.agentId);
expect(saved?.persistence?.metadata?.paseoInstructionReceipt).toEqual(expect.any(Object));
handle = saved!.persistence!;
await codex.manager.closeAgent(codex.agentId);
}
expect(
codex.appServers
.flatMap((server) => server.requests())
.filter((request) => request.method === "thread/inject_items"),
).toHaveLength(1);
} finally {
if (codex.manager.getAgent(codex.agentId)) await codex.manager.closeAgent(codex.agentId);
await storage.flush();
rmSync(dir, { recursive: true, force: true });
}
});
test("rewinds an agent reopened without reading its Codex history", async () => {
const firstTurn = {
id: "turn-1",
@@ -2848,6 +3103,9 @@ describe("Codex app-server provider", () => {
const session = new CodexAppServerAgentSession(
createConfig({
cwd: "/workspace/project",
systemPrompt: "Agent instructions",
daemonAppendSystemPrompt: "Daemon instructions",
pluginAppendSystemPrompt: ["Plugin instructions"],
mcpServers: {
paseo: { type: "http", url: "http://127.0.0.1:6767/mcp/agents?callerAgentId=agent-1" },
},
@@ -2879,6 +3137,24 @@ describe("Codex app-server provider", () => {
await session.revertConversation({ messageId: "codex-first" });
const forkRequest = appServer.requests().find((request) => request.method === "thread/fork");
expect(forkRequest?.params).toMatchObject({
developerInstructions: "Agent instructions\n\nDaemon instructions\n\nPlugin instructions",
});
const rewindRequests = appServer
.requests()
.filter((request) =>
["thread/fork", "thread/rollback", "thread/inject_items"].includes(
String(request.method),
),
);
expect(rewindRequests.map((request) => request.method)).toEqual(
historyMode === "legacy"
? ["thread/fork", "thread/rollback", "thread/inject_items"]
: ["thread/fork", "thread/inject_items"],
);
expect(rewindRequests.at(-1)?.params).toMatchObject({ threadId: "forked-thread" });
expect(JSON.stringify(rewindRequests.at(-1)?.params)).toContain("Plugin instructions");
const forkConfigs = appServer
.requests()
.filter((request) => request.method === "thread/fork")
@@ -5152,7 +5428,7 @@ describe("Codex app-server provider", () => {
threadStart.resolve({ thread: { id: "thread-1" } });
await expect(interruptPromise).resolves.toBeUndefined();
await expect(resultPromise).rejects.toThrow("interrupted before reaching Codex");
await expect(resultPromise).resolves.toMatchObject({ canceled: true, timeline: [] });
expect(appServer.requests()).not.toContainEqual(
expect.objectContaining({ method: "turn/start" }),
);
@@ -3,6 +3,7 @@ import { applyProviderOptionsPatch } from "../option-controls.js";
import { assertChangesAreLive, validateProviderOptions } from "../provider-options.js";
import { CodexBackgroundInventory } from "./codex/background-inventory.js";
import {
AgentTurnStartCanceledError,
getAgentStreamEventTurnId,
type AgentPermissionAction,
type AgentCapabilityFlags,
@@ -55,7 +56,8 @@ import path from "node:path";
import { isDeepStrictEqual } from "node:util";
import { z } from "zod";
import { renderPromptAttachmentAsText } from "../prompt-attachments.js";
import { composeSystemPromptParts } from "../system-prompt.js";
import { composeAgentSystemPrompt } from "../system-prompt.js";
import { CodexInstructionSnapshot } from "./codex/instruction-snapshot.js";
import { CodexAsyncQuestions, codexAsyncQuestionToTimeline } from "./codex/async-questions.js";
import {
fileChangesToPreview,
@@ -3591,9 +3593,12 @@ interface ConsumedRootCompaction {
export class CodexAppServerAgentSession implements AgentSession {
readonly provider = CODEX_PROVIDER;
readonly capabilities = CODEX_APP_SERVER_CAPABILITIES;
readonly persistenceUpdatedOnResume = true;
private readonly logger: Logger;
private readonly config: AgentSessionConfig;
private readonly instructionSnapshot: CodexInstructionSnapshot;
private supportsInstructionSnapshots = false;
private readonly asyncQuestions: CodexAsyncQuestions;
private readonly codexHome: string;
private currentMode: string;
@@ -3706,6 +3711,13 @@ export class CodexAppServerAgentSession implements AgentSession {
reasoning_effort?: string | null;
developer_instructions?: string | null;
}> = [];
private restoredCollaborationMode: {
name: string;
mode: string;
model: string;
reasoning_effort: string | null;
developer_instructions?: never;
} | null = null;
private resolvedCollaborationMode: {
mode: string;
settings: Record<string, unknown>;
@@ -3751,6 +3763,10 @@ export class CodexAppServerAgentSession implements AgentSession {
this.providerOptions =
validateProviderOptions("codex", CodexProviderOptionsSchema, config.providerOptions) ?? {};
this.config = config;
this.instructionSnapshot = new CodexInstructionSnapshot(
composeAgentSystemPrompt(config),
resumeHandle?.metadata?.paseoInstructionReceipt,
);
this.harnessEnvironment = deps.environment ?? buildCodexAppServerEnv();
this.asyncQuestions = new CodexAsyncQuestions(resumeHandle?.metadata?.asyncQuestions);
this.codexHome = deps.codexHome ?? resolveCodexHomeDir(process.env);
@@ -3837,9 +3853,17 @@ export class CodexAppServerAgentSession implements AgentSession {
this.registerRequestHandlers();
try {
this.threadRollbackAvailable = codexServerHasThreadRollback(
toObjectRecord(initialized)?.userAgent,
);
const userAgent = toObjectRecord(initialized)?.userAgent;
this.threadRollbackAvailable = codexServerHasThreadRollback(userAgent);
this.supportsInstructionSnapshots =
typeof userAgent === "string" && codexVersionAtLeast(userAgent, [0, 121, 0]);
if (
!this.currentThreadId &&
this.config.pluginAppendSystemPrompt?.length &&
!this.supportsInstructionSnapshots
) {
throw new Error("Update Codex to 0.121.0 or newer to apply agent instruction updates.");
}
this.speedModels =
CodexModelListResponseSchema.parse(await client.request("model/list", {})).data ?? [];
@@ -4037,18 +4061,17 @@ export class CodexAppServerAgentSession implements AgentSession {
settings: Record<string, unknown>;
name: string;
} | null {
const match = this.findCollaborationMode(this.planModeEnabled ? "plan" : "code");
const match =
this.findCollaborationMode(this.planModeEnabled ? "plan" : "code") ??
this.restoredCollaborationMode;
if (!match) return null;
const settings: Record<string, unknown> = {};
if (match.model) settings.model = match.model;
if (match.reasoning_effort) settings.reasoning_effort = match.reasoning_effort;
const developerInstructions = composeSystemPromptParts(
match.developer_instructions,
this.config.systemPrompt,
this.config.daemonAppendSystemPrompt,
);
if (developerInstructions) settings.developer_instructions = developerInstructions;
// Codex applies thread instructions separately. Null asks it to supply the
// built-in collaboration mode instructions instead of replacing them.
settings.developer_instructions = match.developer_instructions ?? null;
if (this.config.model) settings.model = this.config.model;
const thinkingOptionId = normalizeCodexThinkingOptionId(this.config.thinkingOptionId);
if (thinkingOptionId) settings.reasoning_effort = thinkingOptionId;
@@ -4308,10 +4331,7 @@ export class CodexAppServerAgentSession implements AgentSession {
// the unnamespaced key emitted by earlier Paseo versions.
params.modelProvider = this.deps.customCodexConfig.model_provider;
}
const developerInstructions = composeSystemPromptParts(
this.config.systemPrompt,
this.config.daemonAppendSystemPrompt,
);
const developerInstructions = composeAgentSystemPrompt(this.config);
if (developerInstructions) {
params.developerInstructions = developerInstructions;
}
@@ -4322,11 +4342,11 @@ export class CodexAppServerAgentSession implements AgentSession {
try {
const loaded = toObjectRecord(await this.client.request("thread/loaded/list", {}));
const ids = Array.isArray(loaded?.data) ? loaded.data : [];
if (ids.includes(this.currentThreadId)) {
return;
if (!ids.includes(this.currentThreadId)) {
const response = await this.client.request("thread/resume", params);
this.rememberResolvedSandboxPolicy(response);
this.rememberRestoredCollaborationMode(response);
}
const response = await this.client.request("thread/resume", params);
this.rememberResolvedSandboxPolicy(response);
} catch (error) {
const threadId = this.currentThreadId;
const message = error instanceof Error ? error.message : String(error);
@@ -4340,12 +4360,34 @@ export class CodexAppServerAgentSession implements AgentSession {
}
const response = await this.client.request("thread/resume", params);
this.rememberResolvedSandboxPolicy(response);
this.rememberRestoredCollaborationMode(response);
this.logger.info({ threadId }, "Unarchived Codex thread to restore active Paseo agent");
return;
} else {
this.logger.warn({ error, threadId }, "Failed to resume persisted Codex thread");
throw new Error(`Failed to resume Codex thread ${threadId}: ${message}`, { cause: error });
}
this.logger.warn({ error, threadId }, "Failed to resume persisted Codex thread");
throw new Error(`Failed to resume Codex thread ${threadId}: ${message}`, { cause: error });
}
await this.instructionSnapshot.apply(
this.currentThreadId,
this.client.request.bind(this.client),
this.supportsInstructionSnapshots,
);
}
private rememberRestoredCollaborationMode(response: unknown): void {
const mode = toObjectRecord(toObjectRecord(response)?.collaborationMode);
const settings = toObjectRecord(mode?.settings);
if (typeof mode?.mode !== "string" || typeof settings?.model !== "string") return;
// The resumed mode can contain instructions from a previous launch. Keep its
// identity and model, and let Codex restore the built-in mode instructions.
this.restoredCollaborationMode = {
name: mode.mode,
mode: mode.mode,
model: settings.model,
reasoning_effort:
typeof settings.reasoning_effort === "string" ? settings.reasoning_effort : null,
};
this.refreshResolvedCollaborationMode();
}
private parseSlashCommandInput(text: string): { commandName: string; args?: string } | null {
@@ -4461,13 +4503,7 @@ export class CodexAppServerAgentSession implements AgentSession {
if (options?.outputSchema) {
params.outputSchema = normalizeCodexOutputSchema(options.outputSchema);
}
const developerInstructions = composeSystemPromptParts(
this.config.systemPrompt,
this.config.daemonAppendSystemPrompt,
);
if (developerInstructions) {
params.developerInstructions = developerInstructions;
}
const developerInstructions = composeAgentSystemPrompt(this.config);
const codexConfig = this.buildCodexInnerConfig();
if (codexConfig) {
params.config = codexConfig;
@@ -4661,7 +4697,7 @@ export class CodexAppServerAgentSession implements AgentSession {
// outlives it into the new turn.
await this.waitForInterruptedTurnCleanup();
if (pendingStart.cancelRequested) {
throw new Error("Codex turn start was interrupted before reaching Codex");
throw new AgentTurnStartCanceledError();
}
await this.client.request("turn/start", turnStart.params, TURN_START_TIMEOUT_MS);
return { turnId };
@@ -5226,6 +5262,9 @@ export class CodexAppServerAgentSession implements AgentSession {
systemPrompt: this.config.systemPrompt,
mcpServers: this.config.mcpServers,
asyncQuestions: this.asyncQuestions.serialize(),
...(this.instructionSnapshot.describe(threadId)
? { paseoInstructionReceipt: this.instructionSnapshot.describe(threadId) }
: {}),
},
};
}
@@ -5256,9 +5295,15 @@ export class CodexAppServerAgentSession implements AgentSession {
model: this.config.model ?? null,
serviceTier: this.serviceTier,
config: this.buildCodexInnerConfig(),
developerInstructions: composeAgentSystemPrompt(this.config),
userMessageTurns: this.codexUserMessageTurns(),
threadRollbackAvailable: this.threadRollbackAvailable,
setThreadId: async (threadId) => {
await this.instructionSnapshot.apply(
threadId,
this.client!.request.bind(this.client),
this.supportsInstructionSnapshots,
);
this.currentThreadId = threadId;
// Codex writes a forked thread's rollout when it forks it, even before any turn.
this.savedThreadId = threadId;
@@ -5794,6 +5839,7 @@ export class CodexAppServerAgentSession implements AgentSession {
this.cachedRuntimeInfo = null;
}
this.currentThreadId = threadId;
this.instructionSnapshot.recordNewThread(threadId);
}
private buildThreadStartRequest(model: string): {
@@ -5805,10 +5851,7 @@ export class CodexAppServerAgentSession implements AgentSession {
const approvalPolicy = this.hasWorkflowModeOverride ? preset.approvalPolicy : undefined;
const sandbox = this.hasWorkflowModeOverride ? preset.sandbox : undefined;
const innerConfig = this.buildCodexInnerConfig();
const developerInstructions = composeSystemPromptParts(
this.config.systemPrompt,
this.config.daemonAppendSystemPrompt,
);
const developerInstructions = composeAgentSystemPrompt(this.config);
const params: Record<string, unknown> = {
model,
cwd: this.config.cwd ?? null,
@@ -0,0 +1,69 @@
import { createHash } from "node:crypto";
import { CodexAppServerRpcError } from "./app-server-transport.js";
/** The receipt records only which snapshot was delivered to a particular native thread. */
interface InstructionReceipt {
threadId: string;
digest: string;
}
function readReceipt(value: unknown): InstructionReceipt | null {
if (!value || typeof value !== "object") return null;
const receipt = value as Record<string, unknown>;
if (typeof receipt.threadId !== "string" || typeof receipt.digest !== "string") return null;
if (!/^[a-f0-9]{64}$/.test(receipt.digest)) return null;
return { threadId: receipt.threadId, digest: receipt.digest };
}
export class CodexInstructionSnapshot {
private receipt: InstructionReceipt | null;
private readonly digest: string;
constructor(
private readonly instructions: string | undefined,
receipt: unknown,
) {
this.receipt = readReceipt(receipt);
this.digest = createHash("sha256")
.update(JSON.stringify({ version: 1, instructions: instructions ?? "" }))
.digest("hex");
}
/** A new thread receives its first snapshot through thread/start. */
recordNewThread(threadId: string): void {
this.receipt = { threadId, digest: this.digest };
}
describe(threadId: string): InstructionReceipt | undefined {
return this.receipt?.threadId === threadId ? { ...this.receipt } : undefined;
}
async apply(
threadId: string,
request: (method: string, params: unknown) => Promise<unknown>,
supported: boolean,
): Promise<void> {
if (this.receipt?.threadId === threadId && this.receipt.digest === this.digest) return;
if (!supported)
throw new Error("Update Codex to 0.121.0 or newer to apply agent instruction updates.");
const snapshot = JSON.stringify({ version: 1, instructions: this.instructions ?? "" });
const text =
"This is the complete current set of Paseo-supplied instructions. It supersedes all earlier Paseo-supplied instructions in the conversation, including earlier snapshots. An empty instruction string means there are no current Paseo-supplied instructions. Provider and collaboration instructions remain in effect.\n\n<paseo_instruction_snapshot>" +
snapshot +
"</paseo_instruction_snapshot>";
try {
await request("thread/inject_items", {
threadId,
items: [{ type: "message", role: "developer", content: [{ type: "input_text", text }] }],
});
} catch (error) {
if (error instanceof CodexAppServerRpcError && error.code === -32601) {
throw new Error("Update Codex to 0.121.0 or newer to apply agent instruction updates.", {
cause: error,
});
}
throw error;
}
this.receipt = { threadId, digest: this.digest };
}
}
@@ -49,6 +49,7 @@ export async function revertCodexConversation(input: {
model?: string | null;
serviceTier?: string | null;
config?: Record<string, unknown> | null;
developerInstructions?: string;
userMessageTurns: CodexUserMessageTurnIndex;
threadRollbackAvailable: boolean;
setThreadId: (threadId: string) => void | Promise<void>;
@@ -76,6 +77,7 @@ export async function revertCodexConversation(input: {
model: input.model ?? null,
serviceTier: input.serviceTier ?? null,
...(input.config ? { config: input.config } : {}),
...(input.developerInstructions ? { developerInstructions: input.developerInstructions } : {}),
// Paseo re-reads the rewound thread through paged history, not the fork reply.
excludeTurns: true,
persistExtendedHistory: true,
@@ -171,7 +171,7 @@ export function createFakeCodexAppServer(
const child = createCodexAppServerChildProcess();
const recordedRollbacks: JsonObject[] = [];
const responseHandlers: Record<string, FakeCodexAppServerHandler> = {
initialize: () => ({}),
initialize: () => ({ userAgent: "codex/0.150.0" }),
"collaborationMode/list": () => ({ data: [] }),
"config/read": () => ({ config: {} }),
getUserSavedConfig: () => ({ config: {} }),
@@ -189,6 +189,7 @@ export function createFakeCodexAppServer(
"thread/loaded/list": () => ({ data: [] }),
"thread/backgroundTerminals/list": () => ({ data: [], nextCursor: null }),
"thread/resume": () => ({}),
"thread/inject_items": () => ({}),
"turn/start": () => ({}),
"thread/fork": (params) => ({
thread: {
@@ -435,6 +435,7 @@ function buildResumeStartInput(input: {
systemPrompt: composeSystemPromptParts(
input.resumeConfig.config.systemPrompt,
input.resumeConfig.config.daemonAppendSystemPrompt,
...(input.resumeConfig.config.pluginAppendSystemPrompt ?? []),
),
};
}
@@ -2339,7 +2340,11 @@ export class OmpAgentClient implements AgentClient {
noSession: config.internal === true,
modeId: launchMode.modeId,
extraArgs: launchMode.extraArgs,
systemPrompt: composeSystemPromptParts(config.systemPrompt, config.daemonAppendSystemPrompt),
systemPrompt: composeSystemPromptParts(
config.systemPrompt,
config.daemonAppendSystemPrompt,
...(config.pluginAppendSystemPrompt ?? []),
),
env: launchContext?.env,
};
const runtimeSession = await this.resolveRuntime(config.providerOptions).startSession(
@@ -30,6 +30,7 @@ import {
type AgentDraftControls,
type AgentOptionControl,
type AgentLaunchContext,
type AgentResumeSessionOptions,
type AgentMode,
type AgentModelDefinition,
type AgentPermissionAction,
@@ -1521,6 +1522,7 @@ export class OpenCodeAgentClient implements AgentClient {
handle: AgentPersistenceHandle,
overrides?: Partial<AgentSessionConfig>,
launchContext?: AgentLaunchContext,
_options?: AgentResumeSessionOptions,
): Promise<AgentSession> {
const metadata = (handle.metadata ?? {}) as Partial<AgentSessionConfig>;
const cwd = overrides?.cwd ?? metadata.cwd;
@@ -3692,6 +3694,7 @@ class OpenCodeAgentSession implements AgentSession {
const systemPrompt = composeSystemPromptParts(
this.config.systemPrompt,
this.config.daemonAppendSystemPrompt,
...(this.config.pluginAppendSystemPrompt ?? []),
);
const model = this.parseModel(this.config.model);
const effectiveMode = resolveOpenCodeRuntimeAgentId(this.currentMode);
@@ -4029,6 +4032,7 @@ class OpenCodeAgentSession implements AgentSession {
const systemPrompt = composeSystemPromptParts(
this.config.systemPrompt,
this.config.daemonAppendSystemPrompt,
...(this.config.pluginAppendSystemPrompt ?? []),
);
const promptResponse = await this.client.session.promptAsync({
sessionID: this.sessionId,
@@ -4,6 +4,7 @@ import type {
AgentSessionConfig,
AgentLaunchContext,
AgentCreateSessionOptions,
AgentResumeSessionOptions,
AgentPersistenceHandle,
FetchCatalogOptions,
ProviderRefreshContext,
@@ -149,9 +150,10 @@ export class OpenCodeRuntimeClient implements AgentClient {
handle: AgentPersistenceHandle,
config?: Partial<AgentSessionConfig>,
launch?: AgentLaunchContext,
options?: AgentResumeSessionOptions,
) {
const client = await this.client();
const session = await client.resumeSession(handle, config, launch);
const session = await client.resumeSession(handle, config, launch, options);
return client === this.legacy ? session : withOpenCodeRuntimeNotice(session, 2, handle);
}
async fetchCatalog(options: FetchCatalogOptions, context?: ProviderRefreshContext) {
@@ -28,6 +28,7 @@ export class V2Harness {
readonly prompts: string[] = [];
readonly environments: Array<{ sessionID: string; variables: Record<string, string> }> = [];
readonly mcpAdds: string[] = [];
readonly instructions = new Map<string, string>();
releases = 0;
active = false;
activeReads = 0;
@@ -153,7 +154,17 @@ export class V2Harness {
environment: async (input) => {
this.environments.push(input);
},
instructions: { entry: { list: unexpected, put: unexpected, remove: unexpected } },
instructions: {
entry: {
list: async () => [...this.instructions].map(([key, value]) => ({ key, value })),
put: async ({ key, value }) => {
this.instructions.set(key, String(value));
},
remove: async ({ key }) => {
this.instructions.delete(key);
},
},
},
prompt: async (input, options) => {
const before = this.executions.length;
await this.prompt(input, options);
@@ -17,6 +17,54 @@ function terminalEvents(events: AgentStreamEvent[]) {
}
describe("OpenCode v2 session lifecycle", () => {
test("reopening replaces and removes plugin instructions", async () => {
const harness = new V2Harness();
const client = new OpenCodeV2AgentClient({
logger: createTestLogger(),
runtime: harness.runtime,
});
const created = await client.createSession({
provider: "opencode",
cwd: "/tmp/project",
pluginAppendSystemPrompt: ["first"],
});
expect(harness.instructions.get("paseo")).toBe("first");
const handle = created.describePersistence()!;
await created.close();
const resumed = await client.resumeSession(handle, {
cwd: "/tmp/project",
pluginAppendSystemPrompt: ["changed"],
});
expect(harness.instructions.get("paseo")).toBe("changed");
await resumed.close();
const cleared = await client.resumeSession(handle, {
cwd: "/tmp/project",
pluginAppendSystemPrompt: undefined,
});
expect(harness.instructions.has("paseo")).toBe(false);
await cleared.close();
});
test("opening history does not change an existing session instruction", async () => {
const harness = new V2Harness();
harness.instructions.set("paseo", "Existing plugin instruction");
const client = new OpenCodeV2AgentClient({
logger: createTestLogger(),
runtime: harness.runtime,
});
const session = await client.resumeSession(
{ provider: "opencode", sessionId: "session", metadata: { cwd: "/tmp/project" } },
{ cwd: "/tmp/project" },
undefined,
{ purpose: "history" },
);
try {
expect(harness.instructions.get("paseo")).toBe("Existing plugin instruction");
} finally {
await session.close();
}
});
test("refreshes the existing location before reading a forced catalog", async () => {
const harness = new V2Harness();
const refreshed: string[] = [];
@@ -17,6 +17,7 @@ import type {
AgentCapabilityFlags,
AgentClient,
AgentCreateSessionOptions,
AgentResumeSessionOptions,
AgentDraftControls,
AgentLaunchContext,
AgentPersistenceHandle,
@@ -131,6 +132,7 @@ export class OpenCodeV2AgentClient implements AgentClient {
handle: AgentPersistenceHandle,
overrides?: Partial<AgentSessionConfig>,
launch?: AgentLaunchContext,
options?: AgentResumeSessionOptions,
): Promise<AgentSession> {
const cwd = overrides?.cwd ?? handle.metadata?.cwd;
if (typeof cwd !== "string")
@@ -151,7 +153,14 @@ export class OpenCodeV2AgentClient implements AgentClient {
sessionID: handle.nativeHandle ?? handle.sessionId,
});
await applyResumeOverrides(connection.client, info, overrides);
return await this.attach(connection, info, config, launch, true);
return await this.attach(
connection,
info,
config,
launch,
true,
options?.purpose === "history",
);
} catch (error) {
await connection.release();
throw error;
@@ -163,6 +172,7 @@ export class OpenCodeV2AgentClient implements AgentClient {
config: AgentSessionConfig,
launch: AgentLaunchContext | undefined,
persist: boolean,
historyOnly = false,
) {
const acquire = () =>
this.runtime.acquire(
@@ -209,6 +219,7 @@ export class OpenCodeV2AgentClient implements AgentClient {
bindChild,
acquire,
moved,
historyOnly,
);
try {
await session.initialize(
@@ -75,6 +75,7 @@ export class OpenCodeV2Session implements AgentSession {
bindChild?: (id: string) => void,
private readonly acquire?: () => Promise<V2Connection>,
private readonly moved?: (connection: V2Connection) => void,
private readonly historyOnly = false,
) {
this.background = new OpenCodeBackgroundInventory({
id: info.id,
@@ -193,16 +194,24 @@ export class OpenCodeV2Session implements AgentSession {
});
await this.awaitMcp(server);
}
if (this.historyOnly) return;
const system = composeSystemPromptParts(
this.config.systemPrompt,
this.config.daemonAppendSystemPrompt,
...(this.config.pluginAppendSystemPrompt ?? []),
);
if (system)
if (system) {
await this.client.session.instructions.entry.put({
sessionID: this.id,
key: "paseo",
value: system,
});
} else {
const entries = await this.client.session.instructions.entry.list({ sessionID: this.id });
if (entries.some((entry) => entry.key === "paseo")) {
await this.client.session.instructions.entry.remove({ sessionID: this.id, key: "paseo" });
}
}
}
private async startStream() {
let ready!: () => void;
@@ -1887,6 +1887,7 @@ describe("PiRpcAgentSession", () => {
createConfig({
systemPrompt: "Agent prompt",
daemonAppendSystemPrompt: "Daemon prompt",
pluginAppendSystemPrompt: ["Plugin one", "Plugin two"],
}),
);
@@ -1905,7 +1906,9 @@ describe("PiRpcAgentSession", () => {
await expect(
applyPaseoExtensionSystemPrompt(actualLaunch.extensionPaths[0]!, "Pi project prompt"),
).resolves.toBe("Pi project prompt\n\nAgent prompt\n\nDaemon prompt");
).resolves.toBe(
"Pi project prompt\n\nAgent prompt\n\nDaemon prompt\n\nPlugin one\n\nPlugin two",
);
await session.close();
});
@@ -1928,6 +1931,7 @@ describe("PiRpcAgentSession", () => {
},
{
daemonAppendSystemPrompt: "Daemon prompt",
pluginAppendSystemPrompt: ["Plugin one", "Plugin two"],
},
);
@@ -1951,7 +1955,9 @@ describe("PiRpcAgentSession", () => {
]);
await expect(
applyPaseoExtensionSystemPrompt(actualLaunch.extensionPaths[0]!, "Pi project prompt"),
).resolves.toBe("Pi project prompt\n\nAgent prompt\n\nDaemon prompt");
).resolves.toBe(
"Pi project prompt\n\nAgent prompt\n\nDaemon prompt\n\nPlugin one\n\nPlugin two",
);
});
test("updates model and thinking through Pi runtime commands", async () => {
@@ -52,7 +52,7 @@ import {
type ResolvedProviderLaunch,
} from "../../provider-launch-config.js";
import { renderPromptAttachmentAsText } from "../../prompt-attachments.js";
import { composeSystemPromptParts } from "../../system-prompt.js";
import { composeAgentSystemPrompt } from "../../system-prompt.js";
import {
buildBinaryDiagnosticRows,
buildCommandResolutionDiagnosticRows,
@@ -2601,7 +2601,7 @@ export class PiRpcAgentClient implements AgentClient {
const mcp = await this.prepareMcpInjection(config.cwd, config.mcpServers, mcpEnv, runtime);
const mcpConfigFile = mcp?.kind === "adapter" ? mcp.configFile : null;
const paseoExtension = createPiPaseoExtensionFile({
systemPrompt: composeSystemPromptParts(config.systemPrompt, config.daemonAppendSystemPrompt),
systemPrompt: composeAgentSystemPrompt(config),
mcpServers: mcp?.kind === "builtin" ? mcp.servers : undefined,
});
let runtimeSession: PiRuntimeSession;
@@ -2670,10 +2670,7 @@ export class PiRpcAgentClient implements AgentClient {
);
const mcpConfigFile = mcp?.kind === "adapter" ? mcp.configFile : null;
const paseoExtension = createPiPaseoExtensionFile({
systemPrompt: composeSystemPromptParts(
resumeConfig.config.systemPrompt,
resumeConfig.config.daemonAppendSystemPrompt,
),
systemPrompt: composeAgentSystemPrompt(resumeConfig.config),
mcpServers: mcp?.kind === "builtin" ? mcp.servers : undefined,
});
const tempFiles = mcpConfigFile ? [mcpConfigFile, paseoExtension] : [paseoExtension];
@@ -1,4 +1,5 @@
import {
AgentTurnStartCanceledError,
getAgentStreamEventTurnId,
type AgentPromptInput,
type AgentRunOptions,
@@ -90,6 +91,9 @@ export async function runProviderTurn({
processEvent(event);
}
await completion;
} catch (error) {
if (!(error instanceof AgentTurnStartCanceledError)) throw error;
return { sessionId: await getSessionId(), finalText: "", timeline: [], canceled: true };
} finally {
unsubscribe();
}
@@ -8,3 +8,15 @@ export function composeSystemPromptParts(
return prompt.length > 0 ? prompt : undefined;
}
export function composeAgentSystemPrompt(config: {
systemPrompt?: string;
daemonAppendSystemPrompt?: string;
pluginAppendSystemPrompt?: string[];
}): string | undefined {
return composeSystemPromptParts(
config.systemPrompt,
config.daemonAppendSystemPrompt,
...(config.pluginAppendSystemPrompt ?? []),
);
}
@@ -1281,7 +1281,7 @@ function createToolCatalog(
.strict();
const commonSendAgentPromptInputSchema = {
activeTurnBehavior: ActiveTurnBehaviorSchema.optional().describe(
'How to send into a running turn: "steer" joins it, falling back to interrupt when unavailable; "interrupt" replaces it. Defaults to steer for agent callers and interrupt otherwise.',
'Agent callers: "steer" (default) waits until the current turn ends; "interrupt" replaces it. Human callers: "steer" joins the turn, falling back to interrupt; default is interrupt.',
),
agentId: z.string(),
prompt: z.string(),
@@ -1968,7 +1968,7 @@ function createToolCatalog(
{
title: "Send agent prompt",
description:
"Send a task. Agent callers receive an immediate queued receipt; delivery follows after two quiet seconds per recipient. Completion reports include the target’s last response by default. Paseo supplies caller identity.",
"Send a task. Agent callers receive an immediate queued receipt; delivery follows after two quiet seconds per recipient and waits for the current turn to end unless interrupt is requested. Completion reports include the target’s last response by default. Paseo supplies caller identity.",
inputSchema: sendAgentPromptInputSchema,
outputSchema: {
success: z.boolean(),
@@ -2045,13 +2045,13 @@ function createToolCatalog(
messageId: receipt.messageId,
status: agentManager.getAgent(agentId)?.lifecycle ?? "idle",
guidance: notifying
? `Queued for delivery after two quiet seconds. ${PROMPTED_AGENT_NOTIFICATION_GUIDANCE}`
: "Queued for delivery after two quiet seconds; provider dispatch has not occurred.",
? `Queued for delivery after two quiet seconds and the current turn ends. ${PROMPTED_AGENT_NOTIFICATION_GUIDANCE}`
: "Queued for delivery after two quiet seconds and the current turn ends; provider dispatch has not occurred.",
},
};
}
const { disposition } = await sendPromptToAgent({
const dispatch = await sendPromptToAgent({
agentManager,
agentStorage,
agentId,
@@ -2070,11 +2070,14 @@ function createToolCatalog(
});
// Return once the provider has accepted the turn, so the status reports it running.
if (disposition === "turn_started") {
await waitForAgentRunStartWithTimeout(agentManager, agentId).catch((error) => {
rejectNotification();
throw error;
});
const { disposition } = dispatch;
if (dispatch.disposition === "turn_started") {
await waitForAgentRunStartWithTimeout(agentManager, agentId, dispatch.started).catch(
(error) => {
rejectNotification();
throw error;
},
);
}
const currentSnapshot = agentManager.getAgent(agentId);
@@ -95,7 +95,7 @@ test("an agent-sourced steer leaves the question pending and answerable", async
await client.sendAgentMessage(recipient.id, "Peer status check", {
sourceAgentId: sender.id,
});
// The public wait includes admitted message delivery before reporting permission status.
// Permission checkpoints are reported while the peer message waits for turn end.
const waiting = await client.waitForFinish(recipient.id);
expect(waiting.status).toBe("permission");
expect(waiting.final?.pendingPermissions).toMatchObject([
@@ -193,10 +193,11 @@ test("classifies a removed file as deleted", async () => {
});
await rm(target);
// Native recursive delivery can be coalesced before the backend's deletion audit.
// Assert eventual classification without imposing Vitest's one-second default.
// macOS FSEvents can replay the write above as a create after the subscription starts,
// so the delete is the latest event for the path, not the first. Native recursive delivery
// can also be coalesced before the backend's deletion audit, hence the longer timeout.
await expect
.poll(() => events.find((event) => event.path === target)?.type, { timeout: 10_000 })
.poll(() => events.findLast((event) => event.path === target)?.type, { timeout: 10_000 })
.toBe("delete");
await subscription.unsubscribe();
});
@@ -327,6 +328,39 @@ test("unsubscribe cancels reconciliation queued by a write burst", async () => {
expect(callback).toHaveBeenCalledTimes(callsAtClose);
}, 20_000);
test("aborting a pending subscription stops its startup scan and rejects", async () => {
const root = await createRoot();
// More directories than the Linux backend watches: a scan that keeps walking after the abort
// fails on the directory limit instead of rejecting with the abort reason.
await Promise.all(
Array.from({ length: 80 }, (_, outer) =>
Promise.all(
Array.from({ length: 70 }, (__, inner) =>
mkdir(join(root, `dir-${outer}`, `nested-${inner}`), { recursive: true }),
),
),
),
);
const observer = createObserver();
const controller = new AbortController();
const reason = new Error("setup deadline passed");
const callback = vi.fn();
const subscription = observer.subscribe(root, callback, { signal: controller.signal });
await new Promise((resolve) => setTimeout(resolve, 10));
controller.abort(reason);
await expect(subscription).rejects.toBe(reason);
expect(observer.getDiagnostics()).toMatchObject({
activeObservationCount: 0,
nativeHandleCount: 0,
pendingReconciliationWorkCount: 0,
});
await writeFile(join(root, "dir-0", "after-abort.txt"), "late");
await new Promise((resolve) => setTimeout(resolve, 100));
expect(callback).not.toHaveBeenCalled();
}, 20_000);
test("aggregate diagnostics return to their lifecycle baseline", async () => {
const root = await createRoot();
const observer = createObserver();
@@ -14,6 +14,8 @@ export interface FileChange {
export interface FileObserverOptions {
ignore?: string[];
// Aborting before `subscribe()` resolves stops the startup scan and rejects with the reason.
signal?: AbortSignal;
}
export type FileObserverCallback = (error: Error | null, events: FileChange[]) => void;
@@ -105,7 +107,19 @@ class FileObserverService implements FileObserver {
createBackend: this.createBackend,
onClosed: () => state.observations.delete(observation),
});
await observation.start();
const { signal } = options;
signal?.throwIfAborted();
const abort = () => void observation.close();
signal?.addEventListener("abort", abort, { once: true });
try {
await observation.start();
} finally {
signal?.removeEventListener("abort", abort);
}
if (signal?.aborted) {
await observation.close();
throw signal.reason;
}
if (this.closePromise) {
await observation.close();
throw new Error("File observer is closed");
@@ -0,0 +1,46 @@
import { mkdtemp, rm } from "node:fs/promises";
import { tmpdir } from "node:os";
import { join } from "node:path";
import { expect, test } from "vitest";
import { createFileObserver } from "../index.js";
import { createNativeRecursiveBackend } from "./native-recursive.js";
import { createManagedObservation } from "./observation.js";
import { createObserverPaths } from "./paths.js";
// Aborting a subscription closes its observation while start() may still be
// reading the root, before the backend has started.
test("closing an observation before its backend starts leaves no native watcher open", async () => {
const root = await mkdtemp(join(tmpdir(), "observation-close-"));
const paths = createObserverPaths(process.platform);
let openWatchers = 0;
const observation = createManagedObservation({
root,
callback: () => {},
options: {},
paths,
metrics: createFileObserver().getDiagnostics(),
createBackend: (host) =>
createNativeRecursiveBackend(host, paths, () => {
openWatchers += 1;
let open = true;
return {
close: () => {
if (open) openWatchers -= 1;
open = false;
},
on: () => {},
};
}),
onClosed: () => {},
});
try {
const started = observation.start();
const closed = observation.close();
await started;
await closed;
expect(openWatchers).toBe(0);
} finally {
await rm(root, { recursive: true, force: true });
}
});
@@ -69,6 +69,9 @@ class Observation implements ManagedObservation, ObservationHost {
if (!rootStats.isDirectory()) {
throw new Error(`File observation requires a directory: ${this.root}`);
}
// An aborted subscription can close the observation while the root is being read; the backend
// must not start after its close has already finished.
if (!this.isActive()) return;
try {
await this.backend.start();
} catch (error) {
@@ -527,13 +527,25 @@ test("agent creation hooks change the provider and environment before the sessio
});
server.addHook("agent.open.before", async ({ request }) => {
console.log(JSON.stringify({ hook: "agent.open.before", request }));
return { ...request, env: { ...request.env, HOOK_OPEN: "opened" } };
return { ...request, appendSystemPrompt: [...(request.appendSystemPrompt ?? []), "Plugin instructions"], env: { ...request.env, HOOK_OPEN: "opened" } };
});
server.addHook("agent.create.after", async (event) => {
console.log(JSON.stringify({ hook: "agent.create.after", event }));
});`,
reportOpen: true,
});
const extraPlugin = path.join(directory, "extra-plugin");
await mkdir(extraPlugin);
await writeFile(
path.join(extraPlugin, "paseo-plugin.json"),
JSON.stringify({ id: "a-prompt", requirements: { paseo: ">=0.8.0" } }),
);
const writePrompt = (prompt: string) =>
writeFile(
path.join(extraPlugin, "index.server.ts"),
`export default function contribute(server) { server.addHook("agent.open.before", async ({ request }) => ({ ...request, appendSystemPrompt: [...(request.appendSystemPrompt ?? []), ${JSON.stringify(prompt)}] })); return () => {}; }`,
);
await writePrompt("First plugin");
const daemon = await createTestPaseoDaemon();
const client = new DaemonClient({ url: `ws://127.0.0.1:${daemon.port}/ws` });
try {
@@ -541,15 +553,17 @@ test("agent creation hooks change the provider and environment before the sessio
await client.fetchAgents({ subscribe: {} });
await client.patchDaemonConfig({ pluginsEnabled: true });
await client.installDirectoryPlugin(pluginDirectory);
await client.installDirectoryPlugin(extraPlugin);
const agent = await client.createAgent({
provider: "claude",
cwd: directory,
title: "Hook test",
systemPrompt: "Saved instructions",
});
expect(agent.provider).toBe(PROVIDER_ID);
expect(await daemon.daemon.agentStorage.get(agent.id)).toMatchObject({
provider: PROVIDER_ID,
config: { model: "shutdown-model" },
config: { model: "shutdown-model", systemPrompt: "Saved instructions" },
});
await expect
.poll(async () => {
@@ -569,13 +583,32 @@ test("agent creation hooks change the provider and environment before the sessio
},
{
hook: "provider.open",
config: { env: { HOOK_CREATE: "created", HOOK_OPEN: "opened" } },
config: {
env: { HOOK_CREATE: "created", HOOK_OPEN: "opened" },
systemPrompt: "Saved instructions\n\nFirst plugin\n\nPlugin instructions",
},
},
{
hook: "agent.create.after",
event: { agent: { id: agent.id, provider: PROVIDER_ID } },
},
]);
await writePrompt("Changed plugin");
await client.reloadPlugin("a-prompt");
await daemon.daemon.agentManager.reloadAgentSession(agent.id);
await client.disablePlugin("a-prompt");
await daemon.daemon.agentManager.reloadAgentSession(agent.id);
const opens = (await client.getPluginLogs("shutdown-provider-plugin"))
.filter((entry) => entry.message.startsWith('{"hook":"provider.open"'))
.map((entry) => JSON.parse(entry.message).config.systemPrompt);
expect(opens).toEqual([
"Saved instructions\n\nFirst plugin\n\nPlugin instructions",
"Saved instructions\n\nChanged plugin\n\nPlugin instructions",
"Saved instructions\n\nPlugin instructions",
]);
expect((await daemon.daemon.agentStorage.get(agent.id))?.config?.systemPrompt).toBe(
"Saved instructions",
);
await client.archiveAgent(agent.id);
} finally {
await client.close();
@@ -228,7 +228,9 @@ test.each([{ title: "Changed" }, { labels: { changed: "true" } }, { background:
},
paseo,
),
).rejects.toThrow("agent.open.before hooks can only change env, tools, and mcpServers");
).rejects.toThrow(
"agent.open.before hooks can only change env, tools, mcpServers, and appendSystemPrompt",
);
},
);
@@ -357,3 +359,42 @@ test("checkout-branch hooks reject a branch-off baseRef", async () => {
validateBeforeResult("worktree.create.before", request, { ...request, baseRef: "main" }),
).rejects.toThrow(/baseRef/);
});
test("session-open instructions compose, survive old hooks, and are ignored for history", async () => {
const hooks = new PluginHookHandlers(() => {});
hooks.addHook("agent.open.before", async ({ request }) => ({
...request,
appendSystemPrompt: [...(request.appendSystemPrompt ?? []), "first"],
}));
hooks.addHook("agent.open.before", async ({ request }) => {
const { appendSystemPrompt: _ignored, ...oldRequest } = request;
return oldRequest;
});
hooks.addHook("agent.open.before", async ({ request }) => ({
...request,
appendSystemPrompt: [...(request.appendSystemPrompt ?? []), "second"],
}));
const input = {
agentId: "agent",
workspaceId: null,
provider: "codex",
cwd: "/project",
reason: "resume",
purpose: "interactive",
env: {},
title: null,
labels: {},
metadata: {},
tools: [],
mcpServers: {},
};
const interactive = await hooks.invoke("interactive", "agent.open.before", input, paseo);
expect(interactive).toMatchObject({ appendSystemPrompt: ["first", "second"] });
const history = await hooks.invoke(
"history",
"agent.open.before",
{ ...input, purpose: "history" },
paseo,
);
expect(history).not.toHaveProperty("appendSystemPrompt");
});
@@ -108,6 +108,7 @@ const beforeSchemas = {
labels: z.record(z.string(), z.string()),
// Optional so a plugin that returns its own object keeps working; omitted means unchanged.
metadata: z.record(z.string(), z.custom<JsonValue>()).optional(),
appendSystemPrompt: z.array(z.string()).optional(),
tools: z.array(agentToolMetadataSchema),
env: z.record(z.string(), z.string()),
mcpServers: CreateAgentRequestMessageSchema.shape.config.shape.mcpServers.unwrap(),
@@ -248,9 +249,18 @@ export async function validateBeforeResult<Name extends keyof PluginWireBeforeRe
const previous = beforeSchemas["agent.open.before"].parse(input);
const next = beforeSchemas["agent.open.before"].parse(result);
if (changesSessionOpenTarget(previous, next)) {
throw new Error("agent.open.before hooks can only change env, tools, and mcpServers");
throw new Error(
"agent.open.before hooks can only change env, tools, mcpServers, and appendSystemPrompt",
);
}
return { ...result, background: previous.background, metadata: previous.metadata };
return {
...result,
background: previous.background,
metadata: previous.metadata,
...(next.appendSystemPrompt === undefined && previous.appendSystemPrompt !== undefined
? { appendSystemPrompt: previous.appendSystemPrompt }
: {}),
};
}
if (name === "agent.create.before") {
const previous = beforeSchemas["agent.create.before"].parse(input);
@@ -376,6 +386,7 @@ export class PluginHookHandlers implements PluginLifecycleRegistration {
if (request.purpose === "history") {
request.tools = [];
request.mcpServers = {};
delete request.appendSystemPrompt;
} else this.agentTools?.attach(request.agentId, tools);
return request;
}
@@ -38,6 +38,7 @@ import {
type ScheduleServiceOptions,
} from "./service.js";
import { ScheduleStore } from "./store.js";
import { ForegroundPromptStart } from "../agent/agent-run-state.js";
import type { ScheduleExecutionResult, StoredSchedule } from "@getpaseo/protocol/schedule/types";
interface ScheduleServiceInternals {
@@ -754,6 +755,7 @@ describe("ScheduleService", () => {
agent.id,
expect.stringContaining(`Schedule fired (id=${schedule.id}, run=`),
undefined,
expect.any(ForegroundPromptStart),
]);
});
+1
View File
@@ -8993,6 +8993,7 @@ export class Session {
await waitForAgentRunStartWithTimeout(
this.agentManager,
agentId,
result.started,
this.delivery.requestSignal,
);
}
@@ -12,12 +12,31 @@ export function createTestAgentMessages(params: {
agentManager: AgentManager;
agentStorage: AgentStorage;
logger: Logger;
schedule?: (delayMs: number, callback: () => void) => () => void;
}) {
return createAgentMessageDelivery({
schedule: (_delay, callback) => {
const timer = setTimeout(callback, 0);
return () => clearTimeout(timer);
},
tryRunOutOfBand: (request, onAccepted) =>
params.agentManager.tryRunOutOfBand(
request.recipientId,
request.prompt,
{ clientMessageId: request.messageIds[0] },
onAccepted,
),
isRunning: (agentId) => params.agentManager.hasInFlightRun(agentId),
hasPendingPermission: (agentId) => params.agentManager.hasPendingPermissions(agentId),
subscribe: (notify) =>
params.agentManager.subscribe(
(event) => {
if (event.type === "agent_state") notify(event.agent.id);
},
{ replayState: false },
),
schedule:
params.schedule ??
((_delay, callback) => {
const timer = setTimeout(callback, 0);
return () => clearTimeout(timer);
}),
dispatch: async (request) => {
const result = await sendPreparedPromptToAgent({
...params,
@@ -26,12 +45,16 @@ export function createTestAgentMessages(params: {
sessionMode: request.sessionMode,
unarchive: request.unarchive,
activeTurnBehavior: request.activeTurnBehavior,
idleOnly: request.idleOnly,
clearPendingPermissions: request.clearPendingPermissions,
onDispatch: request.onDispatch,
runOptions: { clientMessageId: request.messageIds[0] },
});
if (result.disposition === "turn_started")
await waitForAgentRunStartWithTimeout(params.agentManager, request.recipientId);
await waitForAgentRunStartWithTimeout(
params.agentManager,
request.recipientId,
result.started,
);
return result.disposition;
},
onError: (error, request) =>
+21 -5
View File
@@ -728,23 +728,39 @@ export class VoiceAssistantWebSocketServer {
this.agentManager = agentManager;
this.agentStorage = agentStorage;
this.agentMessages = createAgentMessageDelivery({
tryRunOutOfBand: (request, onAccepted) =>
agentManager.tryRunOutOfBand(
request.recipientId,
request.prompt,
{ clientMessageId: request.messageIds[0] },
onAccepted,
),
isRunning: (agentId) => agentManager.hasInFlightRun(agentId),
hasPendingPermission: (agentId) => agentManager.hasPendingPermissions(agentId),
subscribe: (notify) =>
agentManager.subscribe(
(event) => {
if (event.type === "agent_state") notify(event.agent.id);
},
{ replayState: false },
),
dispatch: async (batch) => {
const { disposition } = await sendPreparedPromptToAgent({
const dispatch = await sendPreparedPromptToAgent({
agentManager,
agentStorage,
agentId: batch.recipientId,
prompt: batch.prompt,
activeTurnBehavior: batch.activeTurnBehavior,
idleOnly: batch.idleOnly,
sessionMode: batch.sessionMode,
clearPendingPermissions: batch.clearPendingPermissions,
unarchive: batch.unarchive,
runOptions: { clientMessageId: batch.messageIds[0] },
onDispatch: batch.onDispatch,
logger: this.logger,
});
if (disposition === "turn_started")
await waitForAgentRunStartWithTimeout(agentManager, batch.recipientId);
return disposition;
if (dispatch.disposition === "turn_started")
await waitForAgentRunStartWithTimeout(agentManager, batch.recipientId, dispatch.started);
return dispatch.disposition;
},
onError: (err, batch) =>
this.logger.error(
@@ -2195,6 +2195,7 @@ describe("WorkspaceGitServiceImpl D2 read methods", () => {
expect(subscribe).toHaveBeenCalledTimes(1);
expect(subscribe).toHaveBeenCalledWith(repoDir, expect.any(Function), {
ignore: [join(repoDir, ".git"), ignoredRoot],
signal: expect.any(AbortSignal),
});
subscription.unsubscribe();
@@ -477,6 +477,56 @@ async function advanceThroughWorkingTreeRecoveryAttempts(
}
}
// Stalls every subscription for `watchPath` the way a CPU-starved startup scan does, until the
// service aborts it at the subscribe deadline. Other paths subscribe immediately.
function createStallingWatchSetup(watchPath: string) {
const signals: AbortSignal[] = [];
let acceptNext = false;
let acceptedCallback: WatchCallback | null = null;
const subscribe = vi.fn(
async (directory: string, callback: WatchCallback, options?: { signal?: AbortSignal }) => {
if (directory !== watchPath) {
return createAsyncSubscription();
}
const signal = options?.signal ?? new AbortController().signal;
signals.push(signal);
if (acceptNext) {
acceptNext = false;
acceptedCallback = callback;
return createAsyncSubscription();
}
return new Promise<ReturnType<typeof createAsyncSubscription>>((_resolve, reject) => {
signal.addEventListener("abort", () => reject(signal.reason), { once: true });
});
},
);
return {
subscribe,
signals,
acceptNextAttempt() {
acceptNext = true;
},
failAcceptedWatcher() {
acceptedCallback?.(new Error("accepted watcher stopped"), []);
},
async expectAttemptAbortedAtDeadline() {
const signal = signals.at(-1);
expect(signal?.aborted).toBe(false);
await vi.advanceTimersByTimeAsync(WORKSPACE_GIT_WATCHER_SUBSCRIBE_TIMEOUT_MS);
expect(signal?.aborted).toBe(true);
expect(signal?.reason).toMatchObject({ name: "WorkspaceGitWatcherSubscriptionTimeoutError" });
},
async expectNextAttemptAfter(delayMs: number, service: WorkspaceGitServiceImpl) {
const attempts = signals.length;
await vi.advanceTimersByTimeAsync(delayMs - 1);
await waitForRefreshesToSettle(service);
expect(signals).toHaveLength(attempts);
await vi.advanceTimersByTimeAsync(1);
await settle(() => expect(signals).toHaveLength(attempts + 1));
},
};
}
describe("WorkspaceGitServiceImpl", () => {
beforeEach(() => {
vi.useFakeTimers();
@@ -1573,6 +1623,7 @@ describe("WorkspaceGitServiceImpl", () => {
expect(subscribe).toHaveBeenCalledTimes(1);
expect(subscribe).toHaveBeenCalledWith(REPO_CWD, expect.any(Function), {
ignore: [join(REPO_CWD, ".git")],
signal: expect.any(AbortSignal),
});
subscription.unsubscribe();
@@ -1648,6 +1699,67 @@ describe("WorkspaceGitServiceImpl", () => {
15_000,
);
test.each(["repository metadata", "working tree"])(
"aborts each timed-out %s watcher setup and backs retries off toward an hour",
async (kind) => {
const watchPath = kind === "repository metadata" ? join(REPO_CWD, ".git") : REPO_CWD;
const setup = createStallingWatchSetup(watchPath);
const getCheckoutStatus = vi.fn(async (cwd: string) => createCheckoutStatus(cwd));
const service = createService({ subscribe: setup.subscribe, getCheckoutStatus });
const subscription = service.registerWorkspace({ cwd: REPO_CWD }, vi.fn());
try {
await settle(() => expect(setup.signals).toHaveLength(1));
await setup.expectAttemptAbortedAtDeadline();
await waitForObservationToSettle(service, 1);
for (const delayMs of [
30_000, 60_000, 120_000, 240_000, 480_000, 960_000, 1_920_000, 3_600_000,
]) {
await setup.expectNextAttemptAfter(delayMs, service);
await setup.expectAttemptAbortedAtDeadline();
}
// Degraded polling keeps the checkout fresh while the watcher waits out an hour.
const readsBeforeCappedWait = getCheckoutStatus.mock.calls.length;
await setup.expectNextAttemptAfter(3_600_000, service);
expect(getCheckoutStatus.mock.calls.length).toBeGreaterThanOrEqual(
readsBeforeCappedWait + 59,
);
} finally {
subscription.unsubscribe();
await service.dispose();
}
},
30_000,
);
test.each(["repository metadata", "working tree"])(
"an accepted %s watcher subscription resets the setup-timeout backoff",
async (kind) => {
const watchPath = kind === "repository metadata" ? join(REPO_CWD, ".git") : REPO_CWD;
const setup = createStallingWatchSetup(watchPath);
const service = createService({ subscribe: setup.subscribe });
const subscription = service.registerWorkspace({ cwd: REPO_CWD }, vi.fn());
try {
await settle(() => expect(setup.signals).toHaveLength(1));
await setup.expectAttemptAbortedAtDeadline();
for (const delayMs of [30_000, 60_000, 120_000, 240_000, 480_000]) {
await setup.expectNextAttemptAfter(delayMs, service);
await setup.expectAttemptAbortedAtDeadline();
}
setup.acceptNextAttempt();
await setup.expectNextAttemptAfter(960_000, service);
setup.failAcceptedWatcher();
// The ordinary recovery ladder's ceiling applies again, not the 32-minute timeout step.
await setup.expectNextAttemptAfter(300_000, service);
await setup.expectAttemptAbortedAtDeadline();
await setup.expectNextAttemptAfter(300_000, service);
} finally {
subscription.unsubscribe();
await service.dispose();
}
},
30_000,
);
test.each(["repository metadata", "working tree"])(
"ignores expired %s watcher callbacks after recovery",
async (kind) => {
@@ -1873,6 +1985,7 @@ describe("WorkspaceGitServiceImpl", () => {
expect(subscription.repoRoot).toBeNull();
expect(subscribe).toHaveBeenCalledWith(plainCwd, expect.any(Function), {
ignore: [join(plainCwd, ".git")],
signal: expect.any(AbortSignal),
});
expect(vi.getTimerCount()).toBe(1);
@@ -123,6 +123,11 @@ const WATCH_RECOVERY_BASE_DELAY_MS = 30_000;
// restart, which kills running agents. Back off, but keep trying.
const WATCH_RECOVERY_MAX_DELAY_MS = 300_000;
const WATCH_RECOVERY_MAX_BACKOFF_STEPS = 4;
// A startup scan that missed the subscribe deadline on a CPU-starved host misses it again on the
// next attempt, and every attempt repeats the full scan. Consecutive setup timeouts therefore
// keep doubling the recovery delay past the ladder cap, up to an hour.
const WATCH_SETUP_TIMEOUT_RECOVERY_MAX_DELAY_MS = 3_600_000;
const WATCH_SETUP_TIMEOUT_MAX_BACKOFF_STEPS = 7;
// Auxiliary reads may reuse cached values within this window; snapshots do not expire on read.
const WORKSPACE_GIT_AUXILIARY_READ_TTL_MS = 15_000;
// Non-forced refresh triggers share this minimum gap to absorb watcher/self-heal bursts; force bypasses it.
@@ -574,6 +579,10 @@ interface WatchRecoveryState {
// use (SMB/NFS, Docker virtiofs, some FUSE) resets the ladder on every
// attempt and the backoff never engages.
establishedAt: number | null;
// Setup attempts that hit WORKSPACE_GIT_WATCHER_SUBSCRIBE_TIMEOUT_MS since the last accepted
// subscription. Reset on acceptance: finishing the startup scan in time is the proof that
// the next attempt is affordable.
setupTimeoutCount: number;
}
function setsEqual(left: ReadonlySet<string>, right: ReadonlySet<string>): boolean {
@@ -1519,7 +1528,7 @@ export class WorkspaceGitServiceImpl implements WorkspaceGitService {
fallbackPolling: false,
fallbackPollTimer: null,
fallbackPollQuietTickCount: 0,
recovery: { attemptCount: 0, timer: null, establishedAt: null },
recovery: { attemptCount: 0, timer: null, establishedAt: null, setupTimeoutCount: 0 },
listeners: new Set(),
closed: false,
};
@@ -1549,9 +1558,12 @@ export class WorkspaceGitServiceImpl implements WorkspaceGitService {
let removeAbortListener = () => {};
let unsubscribePromise: Promise<void> | null = null;
let subscriptionPromise: Promise<FileObserverSubscription>;
// Abandoning the race is not enough: the observer's startup scan would keep walking the
// tree after the deadline. Abort it so a timed-out attempt stops costing CPU.
const setupController = new AbortController();
try {
subscriptionPromise = this.deps
.subscribe(watchPath, callback, options)
.subscribe(watchPath, callback, { ...options, signal: setupController.signal })
.finally(onSubscribeSettled);
} catch (error) {
onSubscribeSettled();
@@ -1570,12 +1582,15 @@ export class WorkspaceGitServiceImpl implements WorkspaceGitService {
const timeoutPromise = new Promise<never>((_resolve, reject) => {
timeout = setTimeout(() => {
outcome = "expired";
reject(new WorkspaceGitWatcherSubscriptionTimeoutError(watchPath));
const error = new WorkspaceGitWatcherSubscriptionTimeoutError(watchPath);
setupController.abort(error);
reject(error);
}, WORKSPACE_GIT_WATCHER_SUBSCRIBE_TIMEOUT_MS);
});
const disposalPromise = new Promise<never>((_resolve, reject) => {
const rejectForDisposal = () => {
outcome = "expired";
setupController.abort(signal.reason);
reject(signal.reason);
};
if (signal.aborted) {
@@ -1710,6 +1725,7 @@ export class WorkspaceGitServiceImpl implements WorkspaceGitService {
// `scheduleWorkingTreeWatchRecovery` only resets the ladder once this
// one has survived long enough to prove itself durable.
target.recovery.establishedAt = this.deps.now().getTime();
target.recovery.setupTimeoutCount = 0;
if (options?.replaceFallback && target.repoRoot !== null) {
target.fallbackPolling = false;
if (target.fallbackPollTimer) {
@@ -1730,6 +1746,7 @@ export class WorkspaceGitServiceImpl implements WorkspaceGitService {
{ err: error, cwd: target.cwd },
"Failed to start working tree watcher; using degraded polling",
);
this.noteWatchSetupFailure(target.recovery, error);
if (!options?.replaceFallback) {
this.startWorkingTreeWatchFallback(target, "watcher_setup_failed");
}
@@ -1952,11 +1969,26 @@ export class WorkspaceGitServiceImpl implements WorkspaceGitService {
}
recovery.establishedAt = null;
recovery.attemptCount += 1;
return Math.min(
const ladderDelayMs = Math.min(
WATCH_RECOVERY_BASE_DELAY_MS *
2 ** Math.min(recovery.attemptCount - 1, WATCH_RECOVERY_MAX_BACKOFF_STEPS),
WATCH_RECOVERY_MAX_DELAY_MS,
);
if (recovery.setupTimeoutCount === 0) {
return ladderDelayMs;
}
const setupTimeoutDelayMs = Math.min(
WATCH_RECOVERY_BASE_DELAY_MS *
2 ** Math.min(recovery.setupTimeoutCount - 1, WATCH_SETUP_TIMEOUT_MAX_BACKOFF_STEPS),
WATCH_SETUP_TIMEOUT_RECOVERY_MAX_DELAY_MS,
);
return Math.max(ladderDelayMs, setupTimeoutDelayMs);
}
private noteWatchSetupFailure(recovery: WatchRecoveryState, error: unknown): void {
if (error instanceof WorkspaceGitWatcherSubscriptionTimeoutError) {
recovery.setupTimeoutCount += 1;
}
}
private scheduleWorkingTreeWatchRecovery(target: WorkingTreeWatchTarget): void {
@@ -2430,7 +2462,7 @@ export class WorkspaceGitServiceImpl implements WorkspaceGitService {
fallbackPolling: false,
fallbackPollTimer: null,
fallbackPollQuietTickCount: 0,
recovery: { attemptCount: 0, timer: null, establishedAt: null },
recovery: { attemptCount: 0, timer: null, establishedAt: null, setupTimeoutCount: 0 },
intervalId: null,
fetchInFlight: false,
bufferedFetchMetadataEvents: [],
@@ -2580,6 +2612,7 @@ export class WorkspaceGitServiceImpl implements WorkspaceGitService {
// subscribe success alone, only record when this subscription was
// established.
target.recovery.establishedAt = this.deps.now().getTime();
target.recovery.setupTimeoutCount = 0;
if (options?.replaceFallback) {
target.fallbackPolling = false;
if (target.fallbackPollTimer) {
@@ -2603,6 +2636,7 @@ export class WorkspaceGitServiceImpl implements WorkspaceGitService {
{ err: error, repoGitRoot: target.repoGitRoot },
"Failed to start repository metadata watcher; using degraded polling",
);
this.noteWatchSetupFailure(target.recovery, error);
if (!options?.replaceFallback) {
this.startRepoMetadataFallback(target);
}
@@ -19,7 +19,7 @@ import {
type TerminalWorkerRecord,
} from "./terminal-worker-record.js";
import { createTerminalWorkerRecordPublisher } from "./terminal-worker-record-publisher.js";
import { resolveTerminalWorkerSocketPath } from "./terminal-worker-socket-path.js";
import { listenOnTerminalWorkerSocket } from "./terminal-worker-socket-path.js";
import {
TERMINAL_WORKER_PROTOCOL_OVERRIDE_ENV,
TERMINAL_WORKER_PROTOCOL_VERSION,
@@ -700,23 +700,25 @@ function runWorker(argv: string[]): void {
}
async function start(): Promise<void> {
const socketPath = resolveTerminalWorkerSocketPath({
const { socketPath, listener } = await listenOnTerminalWorkerSocket({
paseoHome: args.paseoHome,
workerPid: process.pid,
recordId: args.recordId,
listen: (candidatePath) => {
if (process.platform !== "win32") {
rmSync(candidatePath, { force: true });
}
const listening = createServer(handleConnection);
return new Promise<Server>((resolve, reject) => {
listening.once("error", reject);
listening.listen(candidatePath, () => {
listening.off("error", reject);
resolve(listening);
});
});
},
});
if (process.platform !== "win32") {
rmSync(socketPath, { force: true });
}
const listening = createServer(handleConnection);
await new Promise<void>((resolve, reject) => {
listening.once("error", reject);
listening.listen(socketPath, () => {
listening.off("error", reject);
resolve();
});
});
server = listening;
server = listener;
if (process.platform !== "win32") {
chmodSync(socketPath, PRIVATE_FILE_MODE);
}
@@ -577,20 +577,27 @@ describe.skipIf(isPlatform("win32"))("terminal worker reaper", () => {
// chmod cannot make a file unreadable to root.
describe.skipIf(process.getuid?.() === 0)("a record that cannot be opened for a moment", () => {
it("still ends a live worker it names, then retires the record", async () => {
const home = makeHome();
// The reaper signals a worker only once its socket accepts, so wait for the listen.
async function spawnListeningWorker(socketPath: string): Promise<ChildProcess> {
const worker = spawn(
process.execPath,
[
"-e",
`require("node:net").createServer(() => {}).listen(${JSON.stringify(path.join(home, "live-record-under-test.sock"))});setInterval(() => {}, 1e9)`,
`require("node:net").createServer(() => {}).listen(${JSON.stringify(socketPath)}, () => process.stdout.write("listening\\n"));setInterval(() => {}, 1e9)`,
"--",
"--paseo-terminal-worker",
"record-under-test",
],
{ detached: true, stdio: "ignore" },
{ detached: true, stdio: ["ignore", "pipe", "ignore"] },
);
children.push(worker);
await new Promise((resolve) => worker.stdout!.once("data", resolve));
return worker;
}
it("still ends a live worker it names, then retires the record", async () => {
const home = makeHome();
const worker = await spawnListeningWorker(path.join(home, "live-record-under-test.sock"));
const recordPath = writeRecord(home, {
pid: worker.pid!,
socketPath: path.join(home, "live-record-under-test.sock"),
@@ -632,18 +639,7 @@ describe.skipIf(isPlatform("win32"))("terminal worker reaper", () => {
it("still reports a record that stays unreadable, and signals nothing it names", async () => {
const home = makeHome();
const worker = spawn(
process.execPath,
[
"-e",
`require("node:net").createServer(() => {}).listen(${JSON.stringify(path.join(home, "live-record-under-test.sock"))});setInterval(() => {}, 1e9)`,
"--",
"--paseo-terminal-worker",
"record-under-test",
],
{ detached: true, stdio: "ignore" },
);
children.push(worker);
const worker = await spawnListeningWorker(path.join(home, "live-record-under-test.sock"));
const recordPath = writeRecord(home, {
pid: worker.pid!,
socketPath: path.join(home, "live-record-under-test.sock"),
@@ -1,10 +1,11 @@
import { afterEach, describe, expect, it } from "vitest";
import { chmodSync, mkdirSync, mkdtempSync, rmSync, symlinkSync } from "node:fs";
import { createServer } from "node:net";
import { createServer, type Server } from "node:net";
import { tmpdir } from "node:os";
import path from "node:path";
import { isPlatform } from "../test-utils/platform.js";
import {
listenOnTerminalWorkerSocket,
resolveTerminalWorkerSocketPath,
TerminalWorkerSocketPathError,
} from "./terminal-worker-socket-path.js";
@@ -25,7 +26,36 @@ function longHome(root: string): string {
return home;
}
afterEach(() => {
const openServers: Server[] = [];
function listenFor(socketPath: string): Promise<Server> {
const server = createServer();
return new Promise((resolve, reject) => {
server.once("error", reject);
server.listen(socketPath, () => {
openServers.push(server);
resolve(server);
});
});
}
// Stands in for a filesystem that passes the directory checks but refuses AF_UNIX bind, as AFS
// does with EPERM.
function refuseBindUnder(directory: string, code: string) {
return (socketPath: string): Promise<Server> => {
if (socketPath.startsWith(directory + path.sep)) {
return Promise.reject(
Object.assign(new Error(`listen ${code}: ${socketPath}`), { code, syscall: "listen" }),
);
}
return listenFor(socketPath);
};
}
afterEach(async () => {
await Promise.all(
openServers.splice(0).map((server) => new Promise((resolve) => server.close(resolve))),
);
for (const dir of temporaryDirs.splice(0)) {
rmSync(dir, { recursive: true, force: true });
}
@@ -142,6 +172,66 @@ describe.skipIf(isPlatform("win32"))("terminal worker socket path", () => {
});
});
describe.skipIf(isPlatform("win32"))("terminal worker socket listen", () => {
it("falls back to the next directory when the home's filesystem refuses the bind", async () => {
const home = makeDir("tw-b-", "/tmp");
const tmpDir = makeDir("tw-t-", "/tmp");
const homeSocketDirectory = path.join(home, "terminal-worker", "sock");
const { socketPath, listener } = await listenOnTerminalWorkerSocket({
paseoHome: home,
recordId: "test",
workerPid: 11,
tmpDir,
listen: refuseBindUnder(homeSocketDirectory, "EPERM"),
});
expect(path.dirname(socketPath)).toBe(path.join(tmpDir, `paseo-${process.getuid!()}`));
expect(listener.address()).toBe(socketPath);
});
it("throws a listen error that does not mean the filesystem refuses sockets", async () => {
const home = makeDir("tw-u-", "/tmp");
const homeSocketDirectory = path.join(home, "terminal-worker", "sock");
await expect(
listenOnTerminalWorkerSocket({
paseoHome: home,
recordId: "test",
workerPid: 12,
tmpDir: makeDir("tw-t-", "/tmp"),
listen: refuseBindUnder(homeSocketDirectory, "EADDRINUSE"),
}),
).rejects.toMatchObject({ code: "EADDRINUSE" });
});
it("names every candidate's bind error when no directory accepts a socket", async () => {
const home = makeDir("tw-n-", "/tmp");
const tmpDir = makeDir("tw-t-", "/tmp");
let caught: unknown;
try {
await listenOnTerminalWorkerSocket({
paseoHome: home,
recordId: "test",
workerPid: 13,
tmpDir,
listen: refuseBindUnder("", "EPERM"),
});
} catch (error) {
caught = error;
}
expect(caught).toBeInstanceOf(TerminalWorkerSocketPathError);
const rejected = (caught as TerminalWorkerSocketPathError).rejected;
expect(rejected.slice(0, 2)).toEqual([
expect.objectContaining({
path: expect.stringContaining(path.join(home, "terminal-worker", "sock")),
reason: "cannot bind a socket here (EPERM)",
}),
expect.objectContaining({
path: expect.stringContaining(path.join(tmpDir, `paseo-${process.getuid!()}`)),
reason: "cannot bind a socket here (EPERM)",
}),
]);
});
});
it("uses a separate socket for each record even when its pid is reused", () => {
const paseoHome = makeDir("tw-id-");
const first = resolveTerminalWorkerSocketPath({ paseoHome, workerPid: 42, recordId: "old" });
@@ -14,6 +14,9 @@ const SOCKET_PATH_BYTE_BUDGET: Partial<Record<NodeJS.Platform, number>> = {
};
const DEFAULT_SOCKET_PATH_BYTE_BUDGET = 103;
const OWNER_ONLY_MODE = 0o700;
// Bind errors that mean the directory's filesystem cannot hold a Unix socket. AFS and some other
// network filesystems pass the directory checks and then refuse AF_UNIX bind with EPERM.
const SOCKET_UNSUPPORTED_BIND_CODES = new Set(["EPERM", "EACCES", "EOPNOTSUPP", "ENOTSUP"]);
export interface TerminalWorkerSocketPathInput {
paseoHome: string;
@@ -24,6 +27,16 @@ export interface TerminalWorkerSocketPathInput {
uid?: number;
}
export interface TerminalWorkerSocketListenInput<T> extends TerminalWorkerSocketPathInput {
/** Binds a fresh listener at the path, removing any stale socket there first. */
listen: (socketPath: string) => Promise<T>;
}
export interface TerminalWorkerSocketListener<T> {
socketPath: string;
listener: T;
}
export interface RejectedSocketCandidate {
path: string;
byteLength: number;
@@ -36,7 +49,7 @@ export class TerminalWorkerSocketPathError extends Error {
constructor(rejected: RejectedSocketCandidate[], budget: number) {
super(
[
`No terminal worker socket path fits ${budget} bytes in an owner-only directory:`,
`No terminal worker socket path fits ${budget} bytes in an owner-only directory that accepts a socket:`,
...rejected.map(
(candidate) => ` ${candidate.path} (${candidate.byteLength} bytes): ${candidate.reason}`,
),
@@ -57,18 +70,73 @@ export function terminalWorkerSocketId(paseoHome: string, workerPid: number): st
* Picks (and creates) the socket path a worker listens on. Windows uses a named pipe; POSIX
* tries $PASEO_HOME/terminal-worker/sock, then <tmpdir>/paseo-<uid>, then /tmp/paseo-<uid>.
* A shared root is never chmodded: an existing directory there is used only when it is a real
* directory owned by this user with mode 0700.
* directory owned by this user with mode 0700. It does not bind; the worker listens through
* `listenOnTerminalWorkerSocket`, which also skips directories that refuse a socket.
*/
export function resolveTerminalWorkerSocketPath(input: TerminalWorkerSocketPathInput): string {
const platform = input.platform ?? process.platform;
const id = terminalWorkerSocketId(input.paseoHome, input.workerPid) + "-" + input.recordId;
if (platform === "win32") {
return `\\\\.\\pipe\\paseo-tw-${id}`;
return windowsPipePath(input);
}
const budget = socketPathByteBudget(platform);
const rejected: RejectedSocketCandidate[] = [];
for (const candidate of eligibleUnixSocketPaths(input, budget, rejected)) {
return candidate.path;
}
throw new TerminalWorkerSocketPathError(rejected, budget);
}
/**
* Listens on the first candidate path that accepts a socket. A bind refused by the filesystem
* moves on to the next candidate; any other listen error (EADDRINUSE, ...) is thrown as is.
*/
export async function listenOnTerminalWorkerSocket<T>(
input: TerminalWorkerSocketListenInput<T>,
): Promise<TerminalWorkerSocketListener<T>> {
const { listen } = input;
const platform = input.platform ?? process.platform;
if (platform === "win32") {
const socketPath = windowsPipePath(input);
return { socketPath, listener: await listen(socketPath) };
}
const budget = socketPathByteBudget(platform);
const rejected: RejectedSocketCandidate[] = [];
for (const candidate of eligibleUnixSocketPaths(input, budget, rejected)) {
try {
return { socketPath: candidate.path, listener: await listen(candidate.path) };
} catch (error) {
const code = (error as NodeJS.ErrnoException).code;
if (!code || !SOCKET_UNSUPPORTED_BIND_CODES.has(code)) throw error;
rejected.push({
path: candidate.path,
byteLength: candidate.byteLength,
reason: `cannot bind a socket here (${code})`,
});
}
}
throw new TerminalWorkerSocketPathError(rejected, budget);
}
function windowsPipePath(input: TerminalWorkerSocketPathInput): string {
return `\\\\.\\pipe\\paseo-tw-${socketFileId(input)}`;
}
function socketFileId(input: TerminalWorkerSocketPathInput): string {
return terminalWorkerSocketId(input.paseoHome, input.workerPid) + "-" + input.recordId;
}
function socketPathByteBudget(platform: NodeJS.Platform): number {
return SOCKET_PATH_BYTE_BUDGET[platform] ?? DEFAULT_SOCKET_PATH_BYTE_BUDGET;
}
/** Yields each candidate that fits the budget in an owner-only directory, in order. */
function* eligibleUnixSocketPaths(
input: TerminalWorkerSocketPathInput,
budget: number,
rejected: RejectedSocketCandidate[],
): Generator<{ path: string; byteLength: number }> {
const uid = input.uid ?? process.getuid?.() ?? 0;
const budget = SOCKET_PATH_BYTE_BUDGET[platform] ?? DEFAULT_SOCKET_PATH_BYTE_BUDGET;
const fileName = `tw-${id}.sock`;
const fileName = `tw-${socketFileId(input)}.sock`;
const homeSocketDirectory = path.join(terminalWorkerDirectory(input.paseoHome), "sock");
const candidates: Array<{ directory: string; prepare: () => string | null }> = [
{
@@ -87,7 +155,6 @@ export function resolveTerminalWorkerSocketPath(input: TerminalWorkerSocketPathI
}),
];
const rejected: RejectedSocketCandidate[] = [];
const seen = new Set<string>();
for (const candidate of candidates) {
const socketPath = path.join(candidate.directory, fileName);
@@ -108,9 +175,8 @@ export function resolveTerminalWorkerSocketPath(input: TerminalWorkerSocketPathI
rejected.push({ path: socketPath, byteLength, reason: problem });
continue;
}
return socketPath;
yield { path: socketPath, byteLength };
}
throw new TerminalWorkerSocketPathError(rejected, budget);
}
function prepareSharedRootDirectory(directory: string, uid: number): string | null {
@@ -27,6 +27,10 @@ export default function contribute(server: PluginServerContext) {
return {
...request,
appendSystemPrompt: [
...(request.appendSystemPrompt ?? []),
"Follow the team engineering guide.",
],
mcpServers: {
...request.mcpServers,
company: {
+31 -18
View File
@@ -31,7 +31,7 @@ Names follow `subject.operation.position`: the subject, the operation, then `bef
All handlers must be async. Turn completion includes success, failure, and cancellation; inspect `outcome`. Permission completion includes every resolution; inspect `resolution`.
Creating an agent happens once, and `agent.create.before` changes its saved configuration. Opening starts the provider process: the first run, resume after a daemon restart, reading history, importing an outside session, or reload. `agent.open.before` contributes launch-only environment, tools, and MCP servers each time. Creating opens the agent; opening an existing agent does not create it; closing ends the running instance. Opening a tab in the app is a separate action.
Creating an agent happens once, and `agent.create.before` changes its saved configuration. Opening starts the provider process: the first run, resume after a daemon restart, reading history, importing an outside session, or reload. `agent.open.before` contributes launch-only environment, instructions, tools, and MCP servers each time. Creating opens the agent; opening an existing agent does not create it; closing ends the running instance. Opening a tab in the app is a separate action.
`worktree.create.after` runs before the workspace is registered. It precedes `workspace.create.after`, and both precede the first agent's `agent.create.before` / `agent.open.before`.
@@ -49,22 +49,22 @@ Paseo only sees the returned promise, so detached work gets no error reporting a
## Hooks
| Hook | Waits | Payload | Handler may change |
| ------------------------- | ----- | ----------------------------------------- | ---------------------------------------------- |
| `workspace.create.before` | yes | `{ request }` | Entire create request |
| `workspace.create.after` | no | `{ workspace }` | |
| `workspace.archive.after` | no | `{ workspace }` | |
| `worktree.create.before` | yes | `{ request }` | Creation options and destination |
| `worktree.create.after` | yes | `{ worktree }` | Files in the worktree; throw to abort creation |
| `agent.create.before` | yes | `{ request: { config, env?, metadata } }` | Saved config except `cwd`; `env`; `metadata` |
| `agent.create.after` | no | `{ agent }` | |
| `agent.open.before` | yes | `{ request }` | Launch-only `env`, `tools`, `mcpServers` |
| `agent.close.after` | no | `{ agent }` | |
| `agent.archive.after` | no | `{ agent, archivedAt }` | |
| `agent.turn.before` | no | `{ agent, turnId }` | |
| `agent.turn.after` | no | `{ agent, turnId, outcome }` | |
| `agent.permission.before` | no | `{ agent, request }` | |
| `agent.permission.after` | no | `{ agent, requestId, resolution }` | |
| Hook | Waits | Payload | Handler may change |
| ------------------------- | ----- | ----------------------------------------- | -------------------------------------------------------------- |
| `workspace.create.before` | yes | `{ request }` | Entire create request |
| `workspace.create.after` | no | `{ workspace }` | |
| `workspace.archive.after` | no | `{ workspace }` | |
| `worktree.create.before` | yes | `{ request }` | Creation options and destination |
| `worktree.create.after` | yes | `{ worktree }` | Files in the worktree; throw to abort creation |
| `agent.create.before` | yes | `{ request: { config, env?, metadata } }` | Saved config except `cwd`; `env`; `metadata` |
| `agent.create.after` | no | `{ agent }` | |
| `agent.open.before` | yes | `{ request }` | Launch-only `env`, `appendSystemPrompt`, `tools`, `mcpServers` |
| `agent.close.after` | no | `{ agent }` | |
| `agent.archive.after` | no | `{ agent, archivedAt }` | |
| `agent.turn.before` | no | `{ agent, turnId }` | |
| `agent.turn.after` | no | `{ agent, turnId, outcome }` | |
| `agent.permission.before` | no | `{ agent, request }` | |
| `agent.permission.after` | no | `{ agent, requestId, resolution }` | |
## Shared payloads
@@ -283,7 +283,7 @@ server.addHook("agent.create.after", async ({ agent }) => {
## agent.open.before
Receives `{ request }`; only `env`, `tools`, and `mcpServers` may change, for this launch. All other fields are read-only. A throw, invalid result, or timeout fails the open.
Receives `{ request }`; only `env`, `appendSystemPrompt`, `tools`, and `mcpServers` may change, for this launch. All other fields are read-only. A throw, invalid result, or timeout fails the open.
Do not await a write to the agent being opened: `setMetadata`, `setLabels`, or an option, model, thinking or mode change. The write waits for the open to finish, the open waits for your hook, so the hook times out and the open fails. Start the write without awaiting it; it runs right after the open:
@@ -329,6 +329,19 @@ server.addHook("agent.open.before", async ({ request }, { paseo }) => {
| `purpose` | `interactive`, `history` |
| `env` | Launch override map; excludes the daemon's inherited environment. Replace the map to add, replace, or remove overrides. |
### Append instructions on every session opening
```ts
server.addHook("agent.open.before", async ({ request }) => ({
...request,
appendSystemPrompt: [...(request.appendSystemPrompt ?? []), "Follow the team engineering guide."],
}));
```
Instructions follow the saved agent prompt and daemon instructions, in plugin order. They are not saved in the agent configuration and are ignored for history opens. Reload the plugin after changing its data to apply new instructions on the next reopen. Running turns continue; removing an instruction does not remove conversation history. Internal agents also receive these instructions. The ACP adapter does not send system instructions to its providers. Plugin providers receive the composed prompt, but must apply it themselves.
Codex instruction updates require Codex 0.121.0 or newer with a recognizable version reported by the app server. Source builds reporting `0.0.0` must use a versioned build. Paseo adds a current instruction snapshot to existing threads; earlier snapshots remain in the conversation. A crash during an update or rewinding a thread can repeat a snapshot.
### Inject environment variables on every session opening
```ts
+31 -18
View File
@@ -29,7 +29,7 @@ export default function contribute(server: PluginServerContext) {
所有处理函数都必须为异步函数。轮次完成包括成功、失败和取消,请查看 `outcome`。权限完成包括所有处理结果,请查看 `resolution`。
创建 Agent 会发生一次,`agent.create.before` 修改已保存的配置。打开 Agent 指启动 Provider 进程,包括首次运行、daemon 重启后恢复、读取历史、导入外部会话和重新加载。`agent.open.before` 为每次启动提供临时的环境变量、工具和 MCP 服务器。创建会打开 Agent;打开已有 Agent 不会创建它;关闭会结束运行中的实例。在应用中打开标签页不属于此操作。
创建 Agent 会发生一次,`agent.create.before` 修改已保存的配置。打开 Agent 指启动 Provider 进程,包括首次运行、daemon 重启后恢复、读取历史、导入外部会话和重新加载。`agent.open.before` 为每次启动提供临时的环境变量、指令、工具和 MCP 服务器。创建会打开 Agent;打开已有 Agent 不会创建它;关闭会结束运行中的实例。在应用中打开标签页不属于此操作。
`worktree.create.after` 在工作区注册前运行,随后是 `workspace.create.after`,两者都早于第一个 Agent 的 `agent.create.before` / `agent.open.before`。
@@ -47,22 +47,22 @@ Paseo 只观察返回的 Promise,因此独立任务没有错误报告,也没
## 钩子一览 {#hooks}
| 钩子 | 等待 | 载荷 | 可修改 |
| ------------------------- | ---- | ----------------------------------------- | ------------------------------------------ |
| `workspace.create.before` | 是 | `{ request }` | 整个创建请求 |
| `workspace.create.after` | 否 | `{ workspace }` | |
| `workspace.archive.after` | 否 | `{ workspace }` | |
| `worktree.create.before` | 是 | `{ request }` | 创建选项和目标路径 |
| `worktree.create.after` | 是 | `{ worktree }` | worktree 中的文件;抛出错误中止创建 |
| `agent.create.before` | 是 | `{ request: { config, env?, metadata } }` | 除 `cwd` 外的已保存配置;`env`;`metadata` |
| `agent.create.after` | 否 | `{ agent }` | |
| `agent.open.before` | 是 | `{ request }` | 仅用于启动的 `env`、`tools`、`mcpServers` |
| `agent.close.after` | 否 | `{ agent }` | |
| `agent.archive.after` | 否 | `{ agent, archivedAt }` | |
| `agent.turn.before` | 否 | `{ agent, turnId }` | |
| `agent.turn.after` | 否 | `{ agent, turnId, outcome }` | |
| `agent.permission.before` | 否 | `{ agent, request }` | |
| `agent.permission.after` | 否 | `{ agent, requestId, resolution }` | |
| 钩子 | 等待 | 载荷 | 可修改 |
| ------------------------- | ---- | ----------------------------------------- | --------------------------------------------------------------- |
| `workspace.create.before` | 是 | `{ request }` | 整个创建请求 |
| `workspace.create.after` | 否 | `{ workspace }` | |
| `workspace.archive.after` | 否 | `{ workspace }` | |
| `worktree.create.before` | 是 | `{ request }` | 创建选项和目标路径 |
| `worktree.create.after` | 是 | `{ worktree }` | worktree 中的文件;抛出错误中止创建 |
| `agent.create.before` | 是 | `{ request: { config, env?, metadata } }` | 除 `cwd` 外的已保存配置;`env`;`metadata` |
| `agent.create.after` | 否 | `{ agent }` | |
| `agent.open.before` | 是 | `{ request }` | 仅用于启动的 `env`、`appendSystemPrompt`、`tools`、`mcpServers` |
| `agent.close.after` | 否 | `{ agent }` | |
| `agent.archive.after` | 否 | `{ agent, archivedAt }` | |
| `agent.turn.before` | 否 | `{ agent, turnId }` | |
| `agent.turn.after` | 否 | `{ agent, turnId, outcome }` | |
| `agent.permission.before` | 否 | `{ agent, request }` | |
| `agent.permission.after` | 否 | `{ agent, requestId, resolution }` | |
## 共享载荷 {#shared-payloads}
@@ -279,7 +279,7 @@ server.addHook("agent.create.after", async ({ agent }) => {
## agent.open.before {#agentopenbefore}
收到 `{ request }`,只能修改 `env`、`tools` 和 `mcpServers`,修改只用于此次启动。其他字段只读。抛出错误、无效返回或超时会让打开操作失败。
收到 `{ request }`,只能修改 `env`、`appendSystemPrompt`、`tools` 和 `mcpServers`,修改只用于此次启动。其他字段只读。抛出错误、无效返回或超时会让打开操作失败。
不要 await 对正在打开的 Agent 的写入,例如 `setMetadata`。该写入要等打开完成,而打开在等你的钩子,结果钩子超时,打开失败。启动写入但不要 await,它会在打开完成后立即执行:
@@ -325,6 +325,19 @@ server.addHook("agent.open.before", async ({ request }, { paseo }) => {
| `purpose` | `interactive`、`history` |
| `env` | 启动覆盖映射;不包括 daemon 继承的环境变量。替换整个映射即可添加、替换或移除覆盖项。 |
### 在每次打开会话时追加指令 {#append-instructions-on-every-session-opening}
```ts
server.addHook("agent.open.before", async ({ request }) => ({
...request,
appendSystemPrompt: [...(request.appendSystemPrompt ?? []), "Follow the team engineering guide."],
}));
```
插件指令按插件顺序追加在已保存的 Agent 提示词和 daemon 指令之后。指令不会保存到 Agent 配置中,读取历史时也会忽略这些指令。插件数据更改后,重新加载插件以在下次重新打开会话时应用新指令。正在运行的轮次会继续。移除指令不会删除对话历史。内部 Agent 也会收到这些指令。ACP 适配器不会向 Provider 发送系统指令。插件 Provider 会收到组合后的提示词,但需要自行应用。
更新 Codex 指令需要 Codex 0.121.0 或更新版本,且 app server 报告的版本必须可识别。版本显示为 `0.0.0` 的源码构建需要换用带版本号的构建。Paseo 会向现有会话添加当前指令快照;之前的快照仍保留在对话中。更新期间发生崩溃或回退会话时,快照可能重复。
### 在每次打开会话时注入环境变量 {#inject-environment-variables-on-every-session-opening}
```ts
+1 -1
View File
@@ -84,7 +84,7 @@ Detach is an explicit user action in the subagents track, not an agent tool. A c
Agent-scoped `create_agent` defaults `notifyOnFinish` to true. Set it to `false` when you want explicit reporting or no completion callback.
**`send_agent_prompt`** — `{ agentId, prompt, activeTurnBehavior? }`. Use for follow-ups to an existing agent. Agent-scoped calls default to `steer`; top-level calls default to `interrupt`. Set `activeTurnBehavior` to `steer` or `interrupt` to override the default. Steering falls back to interruption when unavailable. CLI agent sends use the same defaults and accept `--behavior steer|interrupt`. Agent-scoped calls return a queued receipt immediately; messages to each recipient deliver after two quiet seconds. Top-level calls return after dispatch acknowledgement. Agent-scoped calls default `notifyOnFinish` to true; top-level calls have no parent callback.
**`send_agent_prompt`** — `{ agentId, prompt, activeTurnBehavior? }`. Use for follow-ups to an existing agent. Agent-scoped calls default to `steer`; top-level calls default to `interrupt`. For agent-scoped calls, `steer` waits until the recipient's current turn ends, and only `interrupt` stops a running turn. For top-level calls, `steer` joins the running turn and falls back to interruption when unavailable. CLI agent sends use the same defaults and accept `--behavior steer|interrupt`. Agent-scoped calls return a queued receipt immediately; messages to each recipient deliver together after two quiet seconds, or after the recipient's turn ends if it is running. Top-level calls return after dispatch acknowledgement. Agent-scoped calls default `notifyOnFinish` to true; top-level calls have no parent callback.
**`update_agent`** — `{ agentId, name?, labels?, settings? }`. Use `settings` for runtime changes on an existing agent: `modeId`, `model`, `thinkingOptionId`, and provider-specific `features`. For Codex fast mode, pass `settings: { features: { "fast_mode": true } }`.