feat: export Org Projects as CSV (#918)

* feat: update proto

* feat: export org projects

* lint fix

* lint fix

* update proto

Author: whoAbhishekSah

Makefile

@@ -4,7 +4,7 @@ TAG := $(shell git rev-list --tags --max-count=1)
 VERSION := $(shell git describe --tags ${TAG})
 .PHONY: build check fmt lint test test-race vet test-cover-html help install proto ui compose-up-dev
 .DEFAULT_GOAL := build
-PROTON_COMMIT := "2558857f074805048966ede02501b5e9508f8341"
+PROTON_COMMIT := "740c3a1b4aeb64592c1b5b39f49b703489c6a8a6"
 
 ui:
 	@echo " > generating ui build"

core/aggregates/orgprojects/service.go

@@ -1,13 +1,23 @@
 package orgprojects
 
 import (
+	"bytes"
 	"context"
+	"encoding/csv"
+	"errors"
+	"fmt"
+	"reflect"
+	"strings"
 	"time"
 
 	"github.com/raystack/frontier/core/project"
 	"github.com/raystack/salt/rql"
 )
 
+var ErrNoContent = errors.New("no content")
+
+const CSVContentType = "text/csv"
+
 type Repository interface {
 	Search(ctx context.Context, orgID string, query *rql.Query) (OrgProjects, error)
 }
@@ -54,6 +64,100 @@ type AggregatedProject struct {
 	UserIDs        []string
 }
 
+// CSVExport represents the structure for CSV export of organization projects
+type CSVExport struct {
+	ProjectID      string `csv:"Project ID"`
+	Name           string `csv:"Name"`
+	Title          string `csv:"Title"`
+	State          string `csv:"State"`
+	MemberCount    string `csv:"Member Count"`
+	UserIDs        string `csv:"User IDs"`
+	CreatedAt      string `csv:"Created At"`
+	OrganizationID string `csv:"Organization ID"`
+}
+
+// NewCSVExport converts AggregatedProject to CSVExport
+func NewCSVExport(project AggregatedProject) CSVExport {
+	return CSVExport{
+		ProjectID:      project.ID,
+		Name:           project.Name,
+		Title:          project.Title,
+		State:          string(project.State),
+		MemberCount:    fmt.Sprint(project.MemberCount),
+		UserIDs:        strings.Join(project.UserIDs, ","), // Comma-separated list of user IDs
+		CreatedAt:      project.CreatedAt.Format(time.RFC3339),
+		OrganizationID: project.OrganizationID,
+	}
+}
+
+// GetHeaders returns the CSV headers based on struct tags
+func (c CSVExport) GetHeaders() []string {
+	t := reflect.TypeOf(c)
+	headers := make([]string, t.NumField())
+
+	for i := 0; i < t.NumField(); i++ {
+		field := t.Field(i)
+		if tag := field.Tag.Get("csv"); tag != "" {
+			headers[i] = tag
+		} else {
+			headers[i] = field.Name
+		}
+	}
+
+	return headers
+}
+
+// ToRow converts the struct to a string slice for CSV writing
+func (c CSVExport) ToRow() []string {
+	v := reflect.ValueOf(c)
+	row := make([]string, v.NumField())
+
+	for i := 0; i < v.NumField(); i++ {
+		row[i] = fmt.Sprint(v.Field(i).Interface())
+	}
+
+	return row
+}
+
 func (s Service) Search(ctx context.Context, orgID string, query *rql.Query) (OrgProjects, error) {
 	return s.repository.Search(ctx, orgID, query)
 }
+
+// Export generates a CSV file containing organization projects data
+func (s Service) Export(ctx context.Context, orgID string) ([]byte, string, error) {
+	orgProjectsData, err := s.repository.Search(ctx, orgID, &rql.Query{})
+	if err != nil {
+		return nil, "", fmt.Errorf("failed to search organization projects: %w", err)
+	}
+
+	orgProjectsData.Projects = []AggregatedProject{}
+	if len(orgProjectsData.Projects) == 0 {
+		return nil, "", fmt.Errorf("%w: no projects found for organization %s", ErrNoContent, orgID)
+	}
+
+	// Create a buffer to write CSV data
+	var buf bytes.Buffer
+	writer := csv.NewWriter(&buf)
+
+	// Write headers
+	csvExport := NewCSVExport(orgProjectsData.Projects[0])
+	headers := csvExport.GetHeaders()
+	if err := writer.Write(headers); err != nil {
+		return nil, "", fmt.Errorf("error writing CSV headers: %w", err)
+	}
+
+	// Write data rows
+	for _, project := range orgProjectsData.Projects {
+		csvExport := NewCSVExport(project)
+		if err := writer.Write(csvExport.ToRow()); err != nil {
+			return nil, "", fmt.Errorf("error writing CSV row: %w", err)
+		}
+	}
+
+	writer.Flush()
+	if err := writer.Error(); err != nil {
+		return nil, "", fmt.Errorf("error flushing CSV writer: %w", err)
+	}
+
+	return buf.Bytes(), CSVContentType, nil
+}

internal/api/v1beta1/org_projects.go

@@ -10,13 +10,15 @@ import (
 	"github.com/raystack/frontier/pkg/utils"
 	frontierv1beta1 "github.com/raystack/frontier/proto/v1beta1"
 	"github.com/raystack/salt/rql"
+	httpbody "google.golang.org/genproto/googleapis/api/httpbody"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
 	"google.golang.org/protobuf/types/known/timestamppb"
 )
 
 type OrgProjectsService interface {
 	Search(ctx context.Context, id string, query *rql.Query) (orgprojects.OrgProjects, error)
+	Export(ctx context.Context, orgID string) ([]byte, string, error)
 }
 
 func (h Handler) SearchOrganizationProjects(ctx context.Context, request *frontierv1beta1.SearchOrganizationProjectsRequest) (*frontierv1beta1.SearchOrganizationProjectsResponse, error) {
@@ -65,6 +67,33 @@ func (h Handler) SearchOrganizationProjects(ctx context.Context, request *fronti
 	}, nil
 }
 
+func (h Handler) ExportOrganizationProjects(req *frontierv1beta1.ExportOrganizationProjectsRequest, stream frontierv1beta1.AdminService_ExportOrganizationProjectsServer) error {
+	orgProjectsDataBytes, contentType, err := h.orgProjectsService.Export(stream.Context(), req.GetId())
+	if err != nil {
+		if errors.Is(err, orgprojects.ErrNoContent) {
+			return status.Errorf(codes.InvalidArgument, fmt.Sprintf("no data to export: %v", err))
+		}
+		return err
+	}
+
+	chunkSize := 1024 * 200 // 200KB chunks
+
+	for i := 0; i < len(orgProjectsDataBytes); i += chunkSize {
+		end := min(i+chunkSize, len(orgProjectsDataBytes))
+
+		chunk := orgProjectsDataBytes[i:end]
+		msg := &httpbody.HttpBody{
+			ContentType: contentType,
+			Data:        chunk,
+		}
+
+		if err := stream.Send(msg); err != nil {
+			return fmt.Errorf("failed to send chunk: %v", err)
+		}
+	}
+	return nil
+}
+
 // Helper function to transform domain model to protobuf
 func transformAggregatedProjectToPB(p orgprojects.AggregatedProject) *frontierv1beta1.SearchOrganizationProjectsResponse_OrganizationProject {
 	return &frontierv1beta1.SearchOrganizationProjectsResponse_OrganizationProject{

pkg/server/interceptors/authorization.go

@@ -947,6 +947,9 @@ var authorizationValidationMap = map[string]func(ctx context.Context, handler *v
 	"/raystack.frontier.v1beta1.AdminService/ExportOrganizationUsers": func(ctx context.Context, handler *v1beta1.Handler, req any) error {
 		return handler.IsSuperUser(ctx)
 	},
+	"/raystack.frontier.v1beta1.AdminService/ExportOrganizationProjects": func(ctx context.Context, handler *v1beta1.Handler, req any) error {
+		return handler.IsSuperUser(ctx)
+	},
 	"/raystack.frontier.v1beta1.AdminService/SetOrganizationKyc": func(ctx context.Context, handler *v1beta1.Handler, req any) error {
 		return handler.IsSuperUser(ctx)
 	},

proto/apidocs.swagger.yaml

@@ -349,6 +349,52 @@ paths:
           format: int32
       tags:
         - Organization
+  /v1beta1/admin/organizations/{id}/projects/export:
+    get:
+      summary: Export organization projects
+      description: Export organization projects with user IDs
+      operationId: AdminService_ExportOrganizationProjects
+      responses:
+        "200":
+          description: A successful response.(streaming responses)
+          schema:
+            type: string
+            format: binary
+            properties: {}
+            title: Free form byte stream
+        "400":
+          description: Bad Request - The request was malformed or contained invalid parameters.
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+        "401":
+          description: Unauthorized - Authentication is required
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+        "403":
+          description: Forbidden - User does not have permission to access the resource
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+        "404":
+          description: Not Found - The requested resource was not found
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+        "500":
+          description: Internal Server Error. Returned when theres is something wrong with Frontier server.
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/googlerpcStatus'
+      parameters:
+        - name: id
+          in: path
+          required: true
+          type: string
+      tags:
+        - Organization
+      produces:
+        - text/csv
   /v1beta1/admin/organizations/{id}/projects/search:
     post:
       summary: Search organization projects