feat(agent): add ParentId to agent manifest

DanielleMaywood · DanielleMaywood · commit fdf56514935f · 2025-05-19T09:17:09.000Z
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.
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/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(),
@@ -364,6 +371,74 @@ 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{},
+		}
+
+		// Log got and expected with spew.
+		// t.Log("got:\n" + spew.Sdump(got))
+		// t.Log("expected:\n" + spew.Sdump(expected))
+
+		require.Equal(t, expected, got)
+	})
+
 	t.Run("NoAppHostname", func(t *testing.T) {
 		t.Parallel()
 
