mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
Kyle Carberry
cd3692c0c2
Adds the agent half of the workspace context sources RFC. The agent now resolves instruction files, skills, and MCP configs into a typed `Snapshot`, watches the relevant paths recursively, exposes the source list over a workspace-agent HTTP API, and pushes each `Snapshot` to coderd over a new `PushContextState` RPC on Agent API v2.10. The coderd-side handler is a stub returning `Unimplemented` for now. Real persistence to `workspace_agent_context`, chatd hydration on dirty events, and the `KindMCPServer` MCP provider are tracked by [CODAGT-569](https://linear.app/codercom/issue/CODAGT-569/enable-agent-api-v210-pushcontextstate-bump-currentminor-wire-coderd). This matches the pattern used for v2.7 `ReportBoundaryLogs` in [#21293](https://github.com/coder/coder/pull/21293), which bumped the version and shipped a stub server so the wire and client could iterate before the persistence layer landed. ## What ships ### agent/agentcontext (new package) - `Source`, `Resource` (kinds `instruction_file`, `skill`, `mcp_config`, `mcp_server` plus reserved `plugin`/`hook`/`subagent`/`command`), `ResourceStatus`, `Snapshot`, `ComputeAggregateHash`. - `Manager` owns the in-memory source list, performs the initial resolve synchronously in `NewManager`, runs a re-resolve/watcher loop in `Run`, exposes `AddSource`/`RemoveSource`/`Sources`/`HasSource`/`Snapshot`/`SubscribeChanges`/`Resync`/`SeedSources`/`Close`. - `Resolver` walks scan roots, classifies recognized files, enforces 64 KiB per-resource, 2 MiB aggregate, and 500-resource caps with `StatusOversize`/`StatusExcluded`/`StatusUnreadable`/`StatusInvalid` outcomes, skips `node_modules`/`vendor`/etc., validates symlink targets stay inside the scan root, stamps `SourcePath` on user-derived resources, and optionally pulls MCP server tool lists via an `MCPProvider` interface. MCP config resources ship metadata only (size, hash) so secrets in env blocks never leave the agent. - `Watcher` is a recursive `fsnotify` wrapper with a 250 ms debounce, dynamic arming of newly created directories, and an ENOSPC-tolerant degraded mode that no-ops further syncs until the manager resyncs explicitly. - HTTP API for `GET/POST /sources`, `GET/DELETE /sources/{path}`, `POST /resync` mounted at `/api/v0/context`. - `Pusher` interface plus `RunPush` goroutine with exponential backoff capped at 30 s. `DRPCPusher` adapts the generated `DRPCAgentClient210` to `Pusher` and translates `drpcerr.Unimplemented` to `ErrPushUnimplemented` so the push loop exits cleanly when talking to coderd deployments that have not enabled the real handler. ### agent/proto (v2.10) - New messages `ContextResource`, `PushContextStateRequest`, `PushContextStateResponse` and the `PushContextState` RPC on `service Agent`. - Generated `DRPCAgentClient210` interface and `codersdk/agentsdk.Client.ConnectRPC210` / `ConnectRPC210WithRole`. - `tailnet/proto.CurrentMinor` bumped from `9` to `10`. ### Agent wiring - `agent.Options.Client` declares both v2.9 and v2.10 connectors; `run()` dials with `ConnectRPC210WithRole`. - `apiConnRoutineManager` holds a `DRPCAgentClient210`. Existing v2.8 routines keep their narrower `DRPCAgentClient28` signature thanks to interface embedding. - `startAgentAPI210` is the v2.10 counterpart to `startAgentAPI` for routines that need the new client. The push context state routine uses it. - A `contextManager` is constructed in `agent.init()`, seeded from the existing `CODER_AGENT_EXP_*_DIRS` env vars, started in its own goroutine under `gracefulCtx`, and closed in `agent.Close`. - `handleManifest` calls `Manager.SeedSources` for sources rooted at the manifest directory, then `Resync` after `manifest.Swap`, so the snapshot reflects the workspace working directory immediately instead of waiting for the next filesystem event. - HTTP routes mounted at `/api/v0/context` when the manager is up. ### Coderd stub `coderd/agentapi/context.go` returns `drpcerr.Unimplemented` for `PushContextState`. The real handler that persists `workspace_agent_context` rows, hydrates chats, and emits dirty events lives in CODAGT-569. ## Tests 24 tests across `agent/agentcontext` cover types, paths, resolver behavior with file caps, skill containers, MCP secret omission, symlink target validation, the recursive watcher firing on real fsnotify events, manager source CRUD / `Resync` / `SeedSources` / `Run` lifetime, the HTTP API, the DRPC adapter, and the push retry / initial-flag / unimplemented paths. Passes `go test -race -count=2`. `TestAgent_ContextStatePushed` boots a full agent against `agenttest.FakeAgentAPI` (which now records `PushContextState` traffic) and asserts the seeded `AGENTS.md` appears in a snapshot push with `schema_version = 1`. <details> <summary>Notes for reviewers</summary> - Source CRUD is workspace-agent-token only; coderd is not in the path for source mutation. - Per-resource cap 64 KiB, aggregate 2 MiB, count cap 500; resources past the cap ship with `StatusExcluded` and an empty payload so the aggregate hash still detects content edits. MCP-emitted resources enforce both a per-provider count cap and the aggregate byte cap. - Symlinks inside the scan root are followed; symlinks pointing outside (or broken) are rejected with `StatusExcluded` so credentials reachable via a stray symlink stay off the wire. - The initial push gates `lifecycle = ready` in the eventual full design. For this PR the `SeedSources` plus `handleManifest`-driven `Resync` keeps the snapshot fresh; the live push loop ships now and DRPCPusher translates the coderd `Unimplemented` stub into a clean exit. - The `PLUGIN`/`HOOK`/`SUBAGENT`/`COMMAND` kinds are reserved in proto and Go enums but unused; the Claude Code plugin resolver ships in a follow-up that does not need a schema migration. - Two follow-ups remain, both tracked by [CODAGT-569](https://linear.app/codercom/issue/CODAGT-569/enable-agent-api-v210-pushcontextstate-bump-currentminor-wire-coderd): (1) the chatd-side handler that persists snapshots and dirties chats; (2) the `coder exp chat context` CLI command set for `list`/`show`/`add`/`remove`/`refresh`. </details> _This PR was authored by Coder Agents on Kyle Carberry's behalf._
102 lines
4.5 KiB
Go
102 lines
4.5 KiB
Go
package proto
|
|
|
|
import (
|
|
"context"
|
|
|
|
emptypb "google.golang.org/protobuf/types/known/emptypb"
|
|
"storj.io/drpc"
|
|
)
|
|
|
|
// DRPCAgentClient20 is the Agent API at v2.0. Notably, it is missing GetAnnouncementBanners, but
|
|
// is useful when you want to be maximally compatible with Coderd Release Versions from 2.9+
|
|
type DRPCAgentClient20 interface {
|
|
DRPCConn() drpc.Conn
|
|
|
|
GetManifest(ctx context.Context, in *GetManifestRequest) (*Manifest, error)
|
|
GetServiceBanner(ctx context.Context, in *GetServiceBannerRequest) (*ServiceBanner, error)
|
|
UpdateStats(ctx context.Context, in *UpdateStatsRequest) (*UpdateStatsResponse, error)
|
|
UpdateLifecycle(ctx context.Context, in *UpdateLifecycleRequest) (*Lifecycle, error)
|
|
BatchUpdateAppHealths(ctx context.Context, in *BatchUpdateAppHealthRequest) (*BatchUpdateAppHealthResponse, error)
|
|
UpdateStartup(ctx context.Context, in *UpdateStartupRequest) (*Startup, error)
|
|
BatchUpdateMetadata(ctx context.Context, in *BatchUpdateMetadataRequest) (*BatchUpdateMetadataResponse, error)
|
|
BatchCreateLogs(ctx context.Context, in *BatchCreateLogsRequest) (*BatchCreateLogsResponse, error)
|
|
}
|
|
|
|
// DRPCAgentClient21 is the Agent API at v2.1. It is useful if you want to be maximally compatible
|
|
// with Coderd Release Versions from 2.12+
|
|
type DRPCAgentClient21 interface {
|
|
DRPCAgentClient20
|
|
GetAnnouncementBanners(ctx context.Context, in *GetAnnouncementBannersRequest) (*GetAnnouncementBannersResponse, error)
|
|
}
|
|
|
|
// DRPCAgentClient22 is the Agent API at v2.2. It is identical to 2.1, since the change was made on
|
|
// the Tailnet API, which uses the same version number. Compatible with Coder v2.13+
|
|
type DRPCAgentClient22 interface {
|
|
DRPCAgentClient21
|
|
}
|
|
|
|
// DRPCAgentClient23 is the Agent API at v2.3. It adds the ScriptCompleted RPC. Compatible with
|
|
// Coder v2.18+
|
|
type DRPCAgentClient23 interface {
|
|
DRPCAgentClient22
|
|
ScriptCompleted(ctx context.Context, in *WorkspaceAgentScriptCompletedRequest) (*WorkspaceAgentScriptCompletedResponse, error)
|
|
}
|
|
|
|
// DRPCAgentClient24 is the Agent API at v2.4. It adds the GetResourcesMonitoringConfiguration,
|
|
// PushResourcesMonitoringUsage and ReportConnection RPCs. Compatible with Coder v2.19+
|
|
type DRPCAgentClient24 interface {
|
|
DRPCAgentClient23
|
|
GetResourcesMonitoringConfiguration(ctx context.Context, in *GetResourcesMonitoringConfigurationRequest) (*GetResourcesMonitoringConfigurationResponse, error)
|
|
PushResourcesMonitoringUsage(ctx context.Context, in *PushResourcesMonitoringUsageRequest) (*PushResourcesMonitoringUsageResponse, error)
|
|
ReportConnection(ctx context.Context, in *ReportConnectionRequest) (*emptypb.Empty, error)
|
|
}
|
|
|
|
// DRPCAgentClient25 is the Agent API at v2.5. It adds a ParentId field to the
|
|
// agent manifest response. Compatible with Coder v2.23+
|
|
type DRPCAgentClient25 interface {
|
|
DRPCAgentClient24
|
|
}
|
|
|
|
// DRPCAgentClient26 is the Agent API at v2.6. It adds the CreateSubAgent,
|
|
// DeleteSubAgent and ListSubAgents RPCs. Compatible with Coder v2.24+
|
|
type DRPCAgentClient26 interface {
|
|
DRPCAgentClient25
|
|
CreateSubAgent(ctx context.Context, in *CreateSubAgentRequest) (*CreateSubAgentResponse, error)
|
|
DeleteSubAgent(ctx context.Context, in *DeleteSubAgentRequest) (*DeleteSubAgentResponse, error)
|
|
ListSubAgents(ctx context.Context, in *ListSubAgentsRequest) (*ListSubAgentsResponse, error)
|
|
}
|
|
|
|
// DRPCAgentClient27 is the Agent API at v2.7. It adds the ReportBoundaryLogs
|
|
// RPC for forwarding boundary audit logs to coderd. Compatible with Coder v2.30+
|
|
type DRPCAgentClient27 interface {
|
|
DRPCAgentClient26
|
|
ReportBoundaryLogs(ctx context.Context, in *ReportBoundaryLogsRequest) (*ReportBoundaryLogsResponse, error)
|
|
}
|
|
|
|
// DRPCAgentClient28 is the Agent API at v2.8. It adds
|
|
// - a SubagentId field to the WorkspaceAgentDevcontainer message
|
|
// - an Id field to the CreateSubAgentRequest message.
|
|
// - UpdateAppStatus RPC.
|
|
//
|
|
// Compatible with Coder v2.31+
|
|
type DRPCAgentClient28 interface {
|
|
DRPCAgentClient27
|
|
UpdateAppStatus(ctx context.Context, in *UpdateAppStatusRequest) (*UpdateAppStatusResponse, error)
|
|
}
|
|
|
|
// DRPCAgentClient29 is the Agent API at v2.9. It adds
|
|
// session_id and confined_process fields to ReportBoundaryLogsRequest,
|
|
// and sequence_number to BoundaryLog. No new RPCs.
|
|
type DRPCAgentClient29 interface {
|
|
DRPCAgentClient28
|
|
}
|
|
|
|
// DRPCAgentClient210 is the Agent API at v2.10. It adds the
|
|
// PushContextState RPC used by the agent to ship resolved
|
|
// workspace context snapshots (instruction files, skills, MCP
|
|
// configs, MCP server tool lists) to coderd.
|
|
type DRPCAgentClient210 interface {
|
|
DRPCAgentClient29
|
|
PushContextState(ctx context.Context, in *PushContextStateRequest) (*PushContextStateResponse, error)
|
|
}
|