feat(agent): add ParentId to agent manifest (#17888)

DanielleMaywood · web-flow · commit 61f22a59ba36 · 2025-05-19T16:09:56.000+01:00
Closes coder/internal#648 This change introduces a new `ParentId` field to the agent's manifest. This will allow an agent to know if it is a child or not, as well as knowing who the owner is. This is part of the Dev Container Agents work
diff --git a/agent/agent.go b/agent/agent.go
@@ -95,8 +95,8 @@ type Options struct {
 }
 
 type Client interface {
-	ConnectRPC24(ctx context.Context) (
-		proto.DRPCAgentClient24, tailnetproto.DRPCTailnetClient24, error,
+	ConnectRPC25(ctx context.Context) (
+		proto.DRPCAgentClient25, tailnetproto.DRPCTailnetClient25, error,
 	)
 	RewriteDERPMap(derpMap *tailcfg.DERPMap)
 }
@@ -908,7 +908,7 @@ func (a *agent) run() (retErr error) {
 	a.sessionToken.Store(&sessionToken)
 
 	// ConnectRPC returns the dRPC connection we use for the Agent and Tailnet v2+ APIs
-	aAPI, tAPI, err := a.client.ConnectRPC24(a.hardCtx)
+	aAPI, tAPI, err := a.client.ConnectRPC25(a.hardCtx)
 	if err != nil {
 		return err
 	}
diff --git a/agent/agenttest/client.go b/agent/agenttest/client.go
@@ -98,8 +98,8 @@ func (c *Client) Close() {
 	c.derpMapOnce.Do(func() { close(c.derpMapUpdates) })
 }
 
-func (c *Client) ConnectRPC24(ctx context.Context) (
-	agentproto.DRPCAgentClient24, proto.DRPCTailnetClient24, error,
+func (c *Client) ConnectRPC25(ctx context.Context) (
+	agentproto.DRPCAgentClient25, proto.DRPCTailnetClient25, error,
 ) {
 	conn, lis := drpcsdk.MemTransportPipe()
 	c.LastWorkspaceAgent = func() {
diff --git a/agent/proto/agent.pb.go b/agent/proto/agent.pb.go
diff --git a/agent/proto/agent.proto b/agent/proto/agent.proto
@@ -90,6 +90,7 @@ message Manifest {
 	string motd_path = 6;
 	bool disable_direct_connections = 7;
 	bool derp_force_websockets = 8;
+	optional bytes parent_id = 18;
 
 	coder.tailnet.v2.DERPMap derp_map = 9;
 	repeated WorkspaceAgentScript scripts = 10;
diff --git a/agent/proto/agent_drpc_old.go b/agent/proto/agent_drpc_old.go
@@ -50,3 +50,8 @@ type DRPCAgentClient24 interface {
 	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.
+type DRPCAgentClient25 interface {
+	DRPCAgentClient24
+}
diff --git a/coderd/agentapi/manifest.go b/coderd/agentapi/manifest.go
@@ -120,6 +120,11 @@ func (a *ManifestAPI) GetManifest(ctx context.Context, _ *agentproto.GetManifest
 		return nil, xerrors.Errorf("converting workspace apps: %w", err)
 	}
 
+	var parentID []byte
+	if workspaceAgent.ParentID.Valid {
+		parentID = workspaceAgent.ParentID.UUID[:]
+	}
+
 	return &agentproto.Manifest{
 		AgentId:                  workspaceAgent.ID[:],
 		AgentName:                workspaceAgent.Name,
@@ -133,6 +138,7 @@ func (a *ManifestAPI) GetManifest(ctx context.Context, _ *agentproto.GetManifest
 		MotdPath:                 workspaceAgent.MOTDFile,
 		DisableDirectConnections: a.DisableDirectConnections,
 		DerpForceWebsockets:      a.DerpForceWebSockets,
+		ParentId:                 parentID,
 
 		DerpMap:       tailnet.DERPMapToProto(a.DerpMapFn()),
 		Scripts:       dbAgentScriptsToProto(scripts),
diff --git a/coderd/agentapi/manifest_test.go b/coderd/agentapi/manifest_test.go
@@ -60,6 +60,13 @@ func TestGetManifest(t *testing.T) {
 			Directory: "/cool/dir",
 			MOTDFile:  "/cool/motd",
 		}
+		childAgent = database.WorkspaceAgent{
+			ID:        uuid.New(),
+			Name:      "cool-child-agent",
+			ParentID:  uuid.NullUUID{Valid: true, UUID: agent.ID},
+			Directory: "/workspace/dir",
+			MOTDFile:  "/workspace/motd",
+		}
 		apps = []database.WorkspaceApp{
 			{
 				ID:                   uuid.New(),
@@ -337,6 +344,7 @@ func TestGetManifest(t *testing.T) {
 		expected := &agentproto.Manifest{
 			AgentId:                  agent.ID[:],
 			AgentName:                agent.Name,
+			ParentId:                 nil,
 			OwnerUsername:            owner.Username,
 			WorkspaceId:              workspace.ID[:],
 			WorkspaceName:            workspace.Name,
@@ -364,6 +372,70 @@ func TestGetManifest(t *testing.T) {
 		require.Equal(t, expected, got)
 	})
 
+	t.Run("OK/Child", func(t *testing.T) {
+		t.Parallel()
+
+		mDB := dbmock.NewMockStore(gomock.NewController(t))
+
+		api := &agentapi.ManifestAPI{
+			AccessURL:   &url.URL{Scheme: "https", Host: "example.com"},
+			AppHostname: "*--apps.example.com",
+			ExternalAuthConfigs: []*externalauth.Config{
+				{Type: string(codersdk.EnhancedExternalAuthProviderGitHub)},
+				{Type: "some-provider"},
+				{Type: string(codersdk.EnhancedExternalAuthProviderGitLab)},
+			},
+			DisableDirectConnections: true,
+			DerpForceWebSockets:      true,
+
+			AgentFn: func(ctx context.Context) (database.WorkspaceAgent, error) {
+				return childAgent, nil
+			},
+			WorkspaceID: workspace.ID,
+			Database:    mDB,
+			DerpMapFn:   derpMapFn,
+		}
+
+		mDB.EXPECT().GetWorkspaceAppsByAgentID(gomock.Any(), childAgent.ID).Return([]database.WorkspaceApp{}, nil)
+		mDB.EXPECT().GetWorkspaceAgentScriptsByAgentIDs(gomock.Any(), []uuid.UUID{childAgent.ID}).Return([]database.WorkspaceAgentScript{}, nil)
+		mDB.EXPECT().GetWorkspaceAgentMetadata(gomock.Any(), database.GetWorkspaceAgentMetadataParams{
+			WorkspaceAgentID: childAgent.ID,
+			Keys:             nil, // all
+		}).Return([]database.WorkspaceAgentMetadatum{}, nil)
+		mDB.EXPECT().GetWorkspaceAgentDevcontainersByAgentID(gomock.Any(), childAgent.ID).Return([]database.WorkspaceAgentDevcontainer{}, nil)
+		mDB.EXPECT().GetWorkspaceByID(gomock.Any(), workspace.ID).Return(workspace, nil)
+		mDB.EXPECT().GetUserByID(gomock.Any(), workspace.OwnerID).Return(owner, nil)
+
+		got, err := api.GetManifest(context.Background(), &agentproto.GetManifestRequest{})
+		require.NoError(t, err)
+
+		expected := &agentproto.Manifest{
+			AgentId:                  childAgent.ID[:],
+			AgentName:                childAgent.Name,
+			ParentId:                 agent.ID[:],
+			OwnerUsername:            owner.Username,
+			WorkspaceId:              workspace.ID[:],
+			WorkspaceName:            workspace.Name,
+			GitAuthConfigs:           2, // two "enhanced" external auth configs
+			EnvironmentVariables:     nil,
+			Directory:                childAgent.Directory,
+			VsCodePortProxyUri:       fmt.Sprintf("https://{{port}}--%s--%s--%s--apps.example.com", childAgent.Name, workspace.Name, owner.Username),
+			MotdPath:                 childAgent.MOTDFile,
+			DisableDirectConnections: true,
+			DerpForceWebsockets:      true,
+			// tailnet.DERPMapToProto() is extensively tested elsewhere, so it's
+			// not necessary to manually recreate a big DERP map here like we
+			// did for apps and metadata.
+			DerpMap:       tailnet.DERPMapToProto(derpMapFn()),
+			Scripts:       []*agentproto.WorkspaceAgentScript{},
+			Apps:          []*agentproto.WorkspaceApp{},
+			Metadata:      []*agentproto.WorkspaceAgentMetadata_Description{},
+			Devcontainers: []*agentproto.WorkspaceAgentDevcontainer{},
+		}
+
+		require.Equal(t, expected, got)
+	})
+
 	t.Run("NoAppHostname", func(t *testing.T) {
 		t.Parallel()
 
diff --git a/coderd/workspaceagents_test.go b/coderd/workspaceagents_test.go
@@ -2575,7 +2575,7 @@ func requireGetManifest(ctx context.Context, t testing.TB, aAPI agentproto.DRPCA
 }
 
 func postStartup(ctx context.Context, t testing.TB, client agent.Client, startup *agentproto.Startup) error {
-	aAPI, _, err := client.ConnectRPC24(ctx)
+	aAPI, _, err := client.ConnectRPC25(ctx)
 	require.NoError(t, err)
 	defer func() {
 		cErr := aAPI.DRPCConn().Close()
diff --git a/codersdk/agentsdk/agentsdk.go b/codersdk/agentsdk/agentsdk.go
@@ -246,7 +246,7 @@ func (c *Client) ConnectRPC23(ctx context.Context) (
 }
 
 // ConnectRPC24 returns a dRPC client to the Agent API v2.4.  It is useful when you want to be
-// maximally compatible with Coderd Release Versions from 2.xx+ // TODO @vincent: define version
+// maximally compatible with Coderd Release Versions from 2.20+
 func (c *Client) ConnectRPC24(ctx context.Context) (
 	proto.DRPCAgentClient24, tailnetproto.DRPCTailnetClient24, error,
 ) {
@@ -257,6 +257,18 @@ func (c *Client) ConnectRPC24(ctx context.Context) (
 	return proto.NewDRPCAgentClient(conn), tailnetproto.NewDRPCTailnetClient(conn), nil
 }
 
+// ConnectRPC25 returns a dRPC client to the Agent API v2.5.  It is useful when you want to be
+// maximally compatible with Coderd Release Versions from 2.xx+ // TODO(DanielleMaywood): Update version
+func (c *Client) ConnectRPC25(ctx context.Context) (
+	proto.DRPCAgentClient25, tailnetproto.DRPCTailnetClient25, error,
+) {
+	conn, err := c.connectRPCVersion(ctx, apiversion.New(2, 5))
+	if err != nil {
+		return nil, nil, err
+	}
+	return proto.NewDRPCAgentClient(conn), tailnetproto.NewDRPCTailnetClient(conn), nil
+}
+
 // ConnectRPC connects to the workspace agent API and tailnet API
 func (c *Client) ConnectRPC(ctx context.Context) (drpc.Conn, error) {
 	return c.connectRPCVersion(ctx, proto.CurrentVersion)
diff --git a/tailnet/proto/tailnet_drpc_old.go b/tailnet/proto/tailnet_drpc_old.go
@@ -40,3 +40,8 @@ type DRPCTailnetClient23 interface {
 type DRPCTailnetClient24 interface {
 	DRPCTailnetClient23
 }
+
+// DRPCTailnetClient25 is the Tailnet API at v2.5.
+type DRPCTailnetClient25 interface {
+	DRPCTailnetClient24
+}
diff --git a/tailnet/proto/version.go b/tailnet/proto/version.go
@@ -45,9 +45,13 @@ import (
 //     PushResourcesMonitoringUsage RPCs on the Agent API.
 //   - Added support for reporting connection events for auditing via the
 //     ReportConnection RPC on the Agent API.
+//
+// API v2.5:
+//   - Shipped in Coder v2.xx.x // TODO(DanielleMaywood): Update version
+//   - Added `ParentId` to the agent manifest.
 const (
 	CurrentMajor = 2
-	CurrentMinor = 4
+	CurrentMinor = 5
 )
 
 var CurrentVersion = apiversion.New(CurrentMajor, CurrentMinor)

Original file line number	Diff line number	Diff line change
`@@ -95,8 +95,8 @@ type Options struct {`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`type Client interface {`
`98`		`- ConnectRPC24(ctx context.Context) (`
`99`		`- proto.DRPCAgentClient24, tailnetproto.DRPCTailnetClient24, error,`
	`98`	`+ ConnectRPC25(ctx context.Context) (`
	`99`	`+ proto.DRPCAgentClient25, tailnetproto.DRPCTailnetClient25, error,`
`100`	`100`	`)`
`101`	`101`	`RewriteDERPMap(derpMap *tailcfg.DERPMap)`
`102`	`102`	`}`
`@@ -908,7 +908,7 @@ func (a *agent) run() (retErr error) {`
`908`	`908`	`a.sessionToken.Store(&sessionToken)`
`909`	`909`
`910`	`910`	`// ConnectRPC returns the dRPC connection we use for the Agent and Tailnet v2+ APIs`
`911`		`- aAPI, tAPI, err := a.client.ConnectRPC24(a.hardCtx)`
	`911`	`+ aAPI, tAPI, err := a.client.ConnectRPC25(a.hardCtx)`
`912`	`912`	`if err != nil {`
`913`	`913`	`return err`
`914`	`914`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,3 +50,8 @@ type DRPCAgentClient24 interface {`
`50`	`50`	`PushResourcesMonitoringUsage(ctx context.Context, in PushResourcesMonitoringUsageRequest) (PushResourcesMonitoringUsageResponse, error)`
`51`	`51`	`ReportConnection(ctx context.Context, in ReportConnectionRequest) (emptypb.Empty, error)`
`52`	`52`	`}`
	`53`	`+`
	`54`	`+// DRPCAgentClient25 is the Agent API at v2.5.`
	`55`	`+type DRPCAgentClient25 interface {`
	`56`	`+ DRPCAgentClient24`
	`57`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -2575,7 +2575,7 @@ func requireGetManifest(ctx context.Context, t testing.TB, aAPI agentproto.DRPCA`
`2575`	`2575`	`}`
`2576`	`2576`
`2577`	`2577`	`func postStartup(ctx context.Context, t testing.TB, client agent.Client, startup *agentproto.Startup) error {`
`2578`		`- aAPI, _, err := client.ConnectRPC24(ctx)`
	`2578`	`+ aAPI, _, err := client.ConnectRPC25(ctx)`
`2579`	`2579`	`require.NoError(t, err)`
`2580`	`2580`	`defer func() {`
`2581`	`2581`	`cErr := aAPI.DRPCConn().Close()`
Original file line number	Diff line number	Diff line change
`@@ -40,3 +40,8 @@ type DRPCTailnetClient23 interface {`
`40`	`40`	`type DRPCTailnetClient24 interface {`
`41`	`41`	`DRPCTailnetClient23`
`42`	`42`	`}`
	`43`	`+`
	`44`	`+// DRPCTailnetClient25 is the Tailnet API at v2.5.`
	`45`	`+type DRPCTailnetClient25 interface {`
	`46`	`+ DRPCTailnetClient24`
	`47`	`+}`