This repository has been archived on 2026-07-17. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
tao.chen 031451fe3e feat(acp): streaming WebSocket route for prompt chunks
Adds GET /api/workspaces/:id/acp/stream. Client opens a WebSocket,
sends {"type":"prompt","content":"..."}, and receives a stream of
{"type":"chunk","messageId","text"} events followed by exactly
one {"type":"complete","stopReason"} or {"type":"error","error"}.
Closing the WS early triggers session/cancel.

- internal/acp/messages.go: StreamEvent wire shape.
- internal/acp/client.go:
  - streamChs []chan StreamEvent set; AddStream / RemoveStream.
  - sendStream non-blocking fanout.
  - Client.Stream(ctx, content, out) registers out, sends prompt,
    emits complete/error after the prompt response, unregisters.
  - handleNotification fans chunk events to all stream consumers.
  - notifyWG ensures chunk ordering vs the terminal event.
- internal/acp/service.go: Service.Stream(workspaceID, content, out)
  mirrors Prompt (per-workspace lock, 5-min timeout, EnsureReady).
- internal/service/acp_service.go: thin AcpService.Stream wrapper
  that maps acp.StreamEvent -> model.AcpStreamEvent.
- internal/model/acp.go: AcpStreamRequest, AcpStreamEvent DTOs.
- internal/api/acp_handler.go: stream WS handler (upgrade, read
  prompt, run Stream in a goroutine, write events, ping/pong, Cancel
  on client close).
- internal/api/router.go: register the new route.
- internal/acp/transport.go: dispatch notifications synchronously
  (vs. goroutine per notification) so chunks preserve order before
  the session/prompt response.
- internal/acp/client_test.go: TestClientStreamEmitsChunkAndComplete
  with a fake transport that drives a known sequence.
- internal/api/acp_handler_test.go: TestAcpStreamHandlerRoutes
  smoke test using a fake opencode acp script.

Existing POST /api/workspaces/:id/acp/prompt is unchanged.

E2E: prompt 'say hi in exactly 3 words' -> 3 chunk events
('Hi',' there','!') + 1 complete {stopReason: 'end_turn'}.

Conversation: 019f3680-200f-79b0-860b-43302e60d0ea
2026-07-06 16:43:17 +08:00

366 lines
9.7 KiB
Go

package acp
import (
"context"
"encoding/json"
"log/slog"
"strings"
"sync"
"codespace/internal/fs"
"codespace/internal/process"
"codespace/internal/util"
)
// PromptResult is the outcome of a single prompt turn.
type PromptResult struct {
StopReason string
Text string
}
// Client manages one ACP session for a single workspace process.
type Client struct {
workspaceID string
root string
processes process.Manager
fs fs.FileSystem
lg *slog.Logger
mu sync.RWMutex
ready bool
sessionID string
transport *transport
history *History
streamChs []chan<- StreamEvent
notifyWG sync.WaitGroup
}
// NewClient creates an ACP client for the given workspace.
func NewClient(workspaceID, root string, processes process.Manager, filesystem fs.FileSystem, lg *slog.Logger) *Client {
if lg == nil {
lg = slog.Default()
}
return &Client{
workspaceID: workspaceID,
root: root,
processes: processes,
fs: filesystem,
lg: lg,
history: NewHistory(),
}
}
// Initialize starts the process (if necessary), performs the ACP handshake,
// and creates a session. It is safe to call repeatedly; the client will reset
// and re-initialize if the process is not running.
func (c *Client) Initialize(ctx context.Context) error {
c.mu.RLock()
already := c.ready && c.sessionID != "" && c.processes.Status(c.workspaceID).Running
c.mu.RUnlock()
if already {
return nil
}
c.mu.Lock()
c.ready = false
c.sessionID = ""
c.history.Clear()
old := c.transport
c.transport = nil
c.mu.Unlock()
if old != nil {
old.onRequest = nil
old.onNotification = nil
old.onClose = nil
_ = old.Close()
}
if !c.processes.Status(c.workspaceID).Running {
if err := c.processes.Start(c.workspaceID, c.root); err != nil {
return util.Wrap(util.CodeInternal, "failed to start opencode", err)
}
}
stdin, err := c.processes.Stdin(c.workspaceID)
if err != nil {
return util.Wrap(util.CodeInternal, "failed to get opencode stdin", err)
}
sub, err := c.processes.Subscribe(c.workspaceID)
if err != nil {
return util.Wrap(util.CodeInternal, "failed to subscribe to opencode output", err)
}
tr := newTransport(stdin, sub, c.lg)
tr.onRequest = c.handleRequest
tr.onNotification = c.handleNotification
tr.onClose = c.onTransportClose
tr.start()
initParams := InitializeParams{
ProtocolVersion: 1,
ClientCapabilities: ClientCapabilities{
FS: ClientFSCapabilities{ReadTextFile: true, WriteTextFile: true},
},
ClientInfo: ClientInfo{Name: "codespace", Version: "0.1.0"},
}
var initRes InitializeResult
if err := tr.call(ctx, "initialize", initParams, &initRes); err != nil {
_ = tr.Close()
return util.Wrap(util.CodeInternal, "initialize failed", err)
}
sessParams := SessionNewParams{Cwd: c.root, MCPServers: []any{}}
var sessRes SessionNewResult
if err := tr.call(ctx, "session/new", sessParams, &sessRes); err != nil {
_ = tr.Close()
return util.Wrap(util.CodeInternal, "session/new failed", err)
}
c.mu.Lock()
c.transport = tr
c.sessionID = sessRes.SessionID
c.ready = true
c.mu.Unlock()
c.lg.Info("acp initialized", "workspace_id", c.workspaceID, "session_id", sessRes.SessionID)
return nil
}
// Prompt sends a user message and returns the agent's final text for this turn.
func (c *Client) Prompt(ctx context.Context, content string) (PromptResult, error) {
var result PromptResult
c.mu.RLock()
if !c.ready {
c.mu.RUnlock()
return result, util.New(util.CodeConflict, "client not ready")
}
sessionID := c.sessionID
tr := c.transport
startIdx := c.history.Len()
c.mu.RUnlock()
c.history.Add("user", content)
params := SessionPromptParams{
SessionID: sessionID,
Prompt: []PromptMessage{{Type: "text", Text: content}},
}
if err := tr.call(ctx, "session/prompt", params, &result); err != nil {
return result, util.Wrap(util.CodeInternal, "session/prompt failed", err)
}
msgs := c.history.Since(startIdx)
var sb strings.Builder
for _, m := range msgs {
if m.Role == "agent" {
sb.WriteString(m.Text)
}
}
result.Text = sb.String()
return result, nil
}
// sendStream writes ev to out without blocking. It is used for both chunk
// notifications and terminal events so that a slow consumer cannot stall the
// transport goroutine.
func (c *Client) sendStream(out chan<- StreamEvent, ev StreamEvent) {
select {
case out <- ev:
default:
}
}
// AddStream registers a new streaming consumer. It must be paired with RemoveStream.
func (c *Client) AddStream(ch chan<- StreamEvent) int {
c.mu.Lock()
defer c.mu.Unlock()
c.streamChs = append(c.streamChs, ch)
return len(c.streamChs)
}
// RemoveStream unregisters a streaming consumer previously added with AddStream.
func (c *Client) RemoveStream(ch chan<- StreamEvent) {
c.mu.Lock()
defer c.mu.Unlock()
for i, existing := range c.streamChs {
if existing == ch {
c.streamChs[i] = c.streamChs[len(c.streamChs)-1]
c.streamChs = c.streamChs[:len(c.streamChs)-1]
return
}
}
}
// Stream sends a user prompt and forwards streamed chunks to out as they arrive.
// It emits exactly one terminal event, either complete or error, before returning.
func (c *Client) Stream(ctx context.Context, content string, out chan<- StreamEvent) error {
c.mu.RLock()
if !c.ready {
c.mu.RUnlock()
c.sendStream(out, StreamEvent{Type: "error", Error: "client not ready"})
return util.New(util.CodeConflict, "client not ready")
}
sessionID := c.sessionID
tr := c.transport
c.mu.RUnlock()
c.history.Add("user", content)
c.AddStream(out)
defer c.RemoveStream(out)
params := SessionPromptParams{
SessionID: sessionID,
Prompt: []PromptMessage{{Type: "text", Text: content}},
}
var result PromptResult
if err := tr.call(ctx, "session/prompt", params, &result); err != nil {
c.sendStream(out, StreamEvent{Type: "error", Error: err.Error()})
return util.Wrap(util.CodeInternal, "session/prompt failed", err)
}
// Wait for any chunk notifications that were already in flight to be
// delivered before we emit the terminal complete event.
c.notifyWG.Wait()
c.sendStream(out, StreamEvent{Type: "complete", StopReason: result.StopReason})
return nil
}
// Cancel sends a best-effort session/cancel notification.
func (c *Client) Cancel() error {
c.mu.RLock()
defer c.mu.RUnlock()
if !c.ready || c.transport == nil {
return nil
}
return c.transport.sendNotification("session/cancel", SessionCancelParams{SessionID: c.sessionID})
}
// Status returns whether the client has a ready session and its id.
func (c *Client) Status() (ready bool, sessionID string) {
c.mu.RLock()
defer c.mu.RUnlock()
return c.ready, c.sessionID
}
// History returns the in-memory conversation history.
func (c *Client) History() []Message {
return c.history.List()
}
// handleRequest dispatches agent-initiated JSON-RPC requests.
func (c *Client) handleRequest(method string, params json.RawMessage, id int) {
var result any
var rpcErr *rpcError
switch method {
case "fs/read_text_file":
var p FSReadParams
if err := json.Unmarshal(params, &p); err != nil {
rpcErr = &rpcError{Code: -32700, Message: "Parse error"}
break
}
data, err := c.fs.Read(p.Path)
if err != nil {
rpcErr = c.rpcErrorFromErr(err)
} else {
result = FSReadResult{Content: string(data)}
}
case "fs/write_text_file":
var p FSWriteParams
if err := json.Unmarshal(params, &p); err != nil {
rpcErr = &rpcError{Code: -32700, Message: "Parse error"}
break
}
if err := c.fs.Write(p.Path, []byte(p.Content)); err != nil {
rpcErr = c.rpcErrorFromErr(err)
} else {
result = FSWriteResult{}
}
default:
rpcErr = &rpcError{Code: -32601, Message: "Method not found: " + method}
}
c.mu.RLock()
tr := c.transport
c.mu.RUnlock()
if tr != nil {
if err := tr.sendResponse(id, result, rpcErr); err != nil {
c.lg.Error("acp failed to send response", "workspace_id", c.workspaceID, "method", method, "error", err)
}
}
}
// handleNotification processes agent-initiated notifications.
func (c *Client) handleNotification(method string, params json.RawMessage) {
if method != "session/update" {
c.lg.Debug("acp drop notification", "workspace_id", c.workspaceID, "method", method)
return
}
c.notifyWG.Add(1)
defer c.notifyWG.Done()
var up SessionUpdateParams
if err := json.Unmarshal(params, &up); err != nil {
c.lg.Error("acp invalid session/update", "workspace_id", c.workspaceID, "error", err)
return
}
var role string
switch up.Update.SessionUpdate {
case "agent_message_chunk":
role = "agent"
case "user_message_chunk":
role = "user"
default:
c.lg.Debug("acp drop update", "workspace_id", c.workspaceID, "type", up.Update.SessionUpdate)
return
}
if up.Update.Content.Type != "text" {
c.lg.Debug("acp drop non-text chunk", "workspace_id", c.workspaceID, "type", up.Update.Content.Type)
return
}
c.history.AppendOrCreate(role, up.Update.MessageID, up.Update.Content.Text)
ev := StreamEvent{
Type: "chunk",
MessageID: up.Update.MessageID,
Text: up.Update.Content.Text,
}
c.mu.RLock()
streams := make([]chan<- StreamEvent, len(c.streamChs))
copy(streams, c.streamChs)
c.mu.RUnlock()
for _, ch := range streams {
c.sendStream(ch, ev)
}
}
// onTransportClose is invoked when the process output stream closes.
func (c *Client) onTransportClose() {
c.mu.Lock()
defer c.mu.Unlock()
if c.ready {
c.ready = false
c.sessionID = ""
c.transport = nil
c.history.Clear()
c.lg.Info("acp transport closed", "workspace_id", c.workspaceID)
}
}
// rpcErrorFromErr maps a filesystem error to a JSON-RPC error.
func (c *Client) rpcErrorFromErr(err error) *rpcError {
switch util.CodeOf(err) {
case util.CodeNotFound, util.CodeBadRequest:
return &rpcError{Code: -32602, Message: err.Error()}
default:
return &rpcError{Code: -32603, Message: err.Error()}
}
}