Implement RPC endpoint to list child projects

This allows for listing child projects for a given project. This will be useful for navigating through projects with subcommands or the UI. Signed-off-by: Juan Antonio Osorio <[email protected]>
mindersec · Jun 19, 2024 · aa2ffd0 · aa2ffd0
1 parent 54c62db
commit aa2ffd0
Show file tree

Hide file tree

Showing 11 changed files with 2,056 additions and 1,495 deletions.
diff --git a/database/mock/store.go b/database/mock/store.go
diff --git a/database/query/projects.sql b/database/query/projects.sql
@@ -70,6 +70,12 @@ WITH RECURSIVE get_children AS (
 )
 SELECT * FROM get_children;
 
+-- name: GetImmediateChildrenProjects :many
+
+-- GetImmediateChildrenProjects is a query that returns all the immediate children of a project.
+
+SELECT * FROM projects
+WHERE parent_id = sqlc.arg(parent_id)::UUID;
 
 -- name: DeleteProject :many
 WITH RECURSIVE get_children AS (

diff --git a/docs/docs/ref/proto.md b/docs/docs/ref/proto.md
diff --git a/internal/controlplane/handlers_projects.go b/internal/controlplane/handlers_projects.go
@@ -86,6 +86,79 @@ func (s *Server) ListProjects(
 	return &resp, nil
 }
 
+// ListChildProjects returns the list of subprojects for the current project
+func (s *Server) ListChildProjects(
+	ctx context.Context,
+	req *minderv1.ListChildProjectsRequest,
+) (*minderv1.ListChildProjectsResponse, error) {
+	entityCtx := engine.EntityFromContext(ctx)
+	projectID := entityCtx.Project.ID
+
+	var projs []*minderv1.Project
+	var err error
+
+	if req.Recursive {
+		projs, err = s.getChildProjects(ctx, projectID)
+		if err != nil {
+			return nil, status.Errorf(codes.Internal, "error getting subprojects: %v", err)
+		}
+	} else {
+		projs, err = s.getImmediateChildrenProjects(ctx, projectID)
+		if err != nil {
+			return nil, status.Errorf(codes.Internal, "error getting subprojects: %v", err)
+		}
+	}
+
+	resp := minderv1.ListChildProjectsResponse{
+		Projects: projs,
+	}
+	return &resp, nil
+}
+
+func (s *Server) getChildProjects(ctx context.Context, projectID uuid.UUID) ([]*minderv1.Project, error) {
+	projs, err := s.store.GetChildrenProjects(ctx, projectID)
+	if err != nil {
+		return nil, status.Errorf(codes.Internal, "error getting subprojects: %v", err)
+	}
+
+	out := make([]*minderv1.Project, 0, len(projs))
+	for _, project := range projs {
+		out = append(out, &minderv1.Project{
+			ProjectId:   project.ID.String(),
+			Name:        project.Name,
+			Description: "",
+			// TODO: We need to agree on how to handle metadata for subprojects
+			DisplayName: project.Name,
+			CreatedAt:   timestamppb.New(project.CreatedAt),
+			UpdatedAt:   timestamppb.New(project.UpdatedAt),
+		})
+	}
+
+	return out, nil
+}
+
+func (s *Server) getImmediateChildrenProjects(ctx context.Context, projectID uuid.UUID) ([]*minderv1.Project, error) {
+	projs, err := s.store.GetImmediateChildrenProjects(ctx, projectID)
+	if err != nil {
+		return nil, status.Errorf(codes.Internal, "error getting subprojects: %v", err)
+	}
+
+	out := make([]*minderv1.Project, 0, len(projs))
+	for _, project := range projs {
+		out = append(out, &minderv1.Project{
+			ProjectId:   project.ID.String(),
+			Name:        project.Name,
+			Description: "",
+			// TODO: We need to agree on how to handle metadata for subprojects
+			DisplayName: project.Name,
+			CreatedAt:   timestamppb.New(project.CreatedAt),
+			UpdatedAt:   timestamppb.New(project.UpdatedAt),
+		})
+	}
+
+	return out, nil
+}
+
 // CreateProject creates a new subproject
 func (s *Server) CreateProject(
 	ctx context.Context,

diff --git a/internal/db/projects.sql.go b/internal/db/projects.sql.go
diff --git a/internal/db/querier.go b/internal/db/querier.go
diff --git a/pkg/api/openapi/minder/v1/minder.swagger.json b/pkg/api/openapi/minder/v1/minder.swagger.json