feat(csv): added the csv export to the analytics page

apps/api/internal/handler/analytics.go

@@ -0,0 +1,205 @@
+package handler
+
+import (
+	"encoding/csv"
+	"errors"
+	"fmt"
+	"log/slog"
+	"net/http"
+	"strings"
+	"time"
+
+	"github.com/Devlaner/devlane/api/internal/middleware"
+	"github.com/Devlaner/devlane/api/internal/service"
+	"github.com/gin-gonic/gin"
+	"github.com/google/uuid"
+)
+
+type AnalyticsHandler struct {
+	AnalyticsService *service.AnalyticsService
+	Log              *slog.Logger
+}
+
+func sanitizeCSVField(v string) string {
+	if v == "" {
+		return v
+	}
+	switch v[0] {
+	case '=', '+', '-', '@', '\t', '\r':
+		return "'" + v
+	default:
+		return v
+	}
+}
+
+func sanitizeFilename(s string) string {
+	r := strings.NewReplacer("\"", "", "\n", "", "\r", "")
+	return r.Replace(s)
+}
+
+func parseParamUUID(c *gin.Context, key string) (uuid.UUID, bool) {
+	val := c.Param(key)
+	if val == "" {
+		val = c.Param("projectID")
+	}
+	if val == "" {
+		c.JSON(http.StatusBadRequest, gin.H{"error": "missing ID parameter"})
+		return uuid.Nil, false
+	}
+	parsed, err := uuid.Parse(val)
+	if err != nil {
+		c.JSON(http.StatusBadRequest, gin.H{"error": "invalid project ID"})
+		return uuid.Nil, false
+	}
+	return parsed, true
+}
+
+func (h *AnalyticsHandler) GetWorkspaceAnalytics(c *gin.Context) {
+	slug := c.Param("slug")
+	user := middleware.GetUser(c)
+	if user == nil {
+		c.JSON(http.StatusUnauthorized, gin.H{"error": "Unauthorized"})
+		return
+	}
+
+	res, err := h.AnalyticsService.GetWorkspaceAnalytics(c.Request.Context(), slug, user.ID)
+	if err != nil {
+		if errors.Is(err, service.ErrWorkspaceForbidden) {
+			c.JSON(http.StatusForbidden, gin.H{"error": "Forbidden"})
+			return
+		}
+		if errors.Is(err, service.ErrWorkspaceNotFound) {
+			c.JSON(http.StatusNotFound, gin.H{"error": "Workspace not found"})
+			return
+		}
+		h.Log.Error("failed to fetch workspace analytics", "error", err, "slug", slug)
+		c.JSON(http.StatusInternalServerError, gin.H{"error": "Internal server error"})
+		return
+	}
+
+	c.JSON(http.StatusOK, res)
+}
+
+func (h *AnalyticsHandler) GetProjectAnalytics(c *gin.Context) {
+	projectID, ok := parseParamUUID(c, "projectId")
+	if !ok {
+		return
+	}
+
+	user := middleware.GetUser(c)
+	if user == nil {
+		c.JSON(http.StatusUnauthorized, gin.H{"error": "Unauthorized"})
+		return
+	}
+
+	res, err := h.AnalyticsService.GetProjectAnalytics(c.Request.Context(), projectID, user.ID)
+	if err != nil {
+		if errors.Is(err, service.ErrProjectForbidden) || errors.Is(err, service.ErrWorkspaceForbidden) {
+			c.JSON(http.StatusForbidden, gin.H{"error": "Forbidden"})
+			return
+		}
+		if errors.Is(err, service.ErrProjectNotFound) || errors.Is(err, service.ErrWorkspaceNotFound) {
+			c.JSON(http.StatusNotFound, gin.H{"error": "Project not found"})
+			return
+		}
+		h.Log.Error("failed to fetch project analytics", "error", err, "project_id", projectID)
+		c.JSON(http.StatusInternalServerError, gin.H{"error": "Internal server error"})
+		return
+	}
+
+	c.JSON(http.StatusOK, res)
+}
+
+func (h *AnalyticsHandler) ExportWorkspaceCSV(c *gin.Context) {
+	slug := c.Param("slug")
+	user := middleware.GetUser(c)
+	if user == nil {
+		c.JSON(http.StatusUnauthorized, gin.H{"error": "Unauthorized"})
+		return
+	}
+
+	issues, err := h.AnalyticsService.ExportWorkspaceCSV(c.Request.Context(), slug, user.ID)
+	if err != nil {
+		if errors.Is(err, service.ErrWorkspaceForbidden) {
+			c.JSON(http.StatusForbidden, gin.H{"error": "Forbidden"})
+			return
+		}
+		if errors.Is(err, service.ErrWorkspaceNotFound) {
+			c.JSON(http.StatusNotFound, gin.H{"error": "Workspace not found"})
+			return
+		}
+		h.Log.Error("failed to fetch workspace issues for CSV export", "error", err, "slug", slug)
+		c.JSON(http.StatusInternalServerError, gin.H{"error": "Failed to fetch workspace data"})
+		return
+	}
+
+	safeSlug := sanitizeFilename(slug)
+	filename := fmt.Sprintf("workspace-%s-analytics-%s.csv", safeSlug, time.Now().Format("2006-01-02"))
+	c.Header("Content-Disposition", fmt.Sprintf("attachment; filename=\"%s\"", filename))
+	c.Header("Content-Type", "text/csv")
+
+	writer := csv.NewWriter(c.Writer)
+	_ = writer.Write([]string{"Issue ID", "Title", "State", "Priority"})
+
+	for _, issue := range issues {
+		_ = writer.Write([]string{
+			issue.ID,
+			sanitizeCSVField(issue.Name),
+			sanitizeCSVField(issue.State),
+			sanitizeCSVField(issue.Priority),
+		})
+	}
+
+	writer.Flush()
+	if err := writer.Error(); err != nil {
+		h.Log.Error("failed to flush CSV writer", "error", err, "slug", slug)
+	}
+}
+
+func (h *AnalyticsHandler) ExportProjectCSV(c *gin.Context) {
+	projectID, ok := parseParamUUID(c, "projectId")
+	if !ok {
+		return
+	}
+
+	user := middleware.GetUser(c)
+	if user == nil {
+		c.JSON(http.StatusUnauthorized, gin.H{"error": "Unauthorized"})
+		return
+	}
+
+	issues, err := h.AnalyticsService.ExportProjectCSV(c.Request.Context(), projectID, user.ID)
+	if err != nil {
+		if errors.Is(err, service.ErrProjectForbidden) || errors.Is(err, service.ErrWorkspaceForbidden) {
+			c.JSON(http.StatusForbidden, gin.H{"error": "Forbidden"})
+			return
+		}
+		if errors.Is(err, service.ErrProjectNotFound) || errors.Is(err, service.ErrWorkspaceNotFound) {
+			c.JSON(http.StatusNotFound, gin.H{"error": "Project not found"})
+			return
+		}
+		h.Log.Error("failed to fetch project issues for CSV export", "error", err, "project_id", projectID)
+		c.JSON(http.StatusInternalServerError, gin.H{"error": "Failed to fetch project data"})
+		return
+	}
+
+	filename := fmt.Sprintf("project-%s-analytics-%s.csv", projectID, time.Now().Format("2006-01-02"))
+	c.Header("Content-Disposition", fmt.Sprintf("attachment; filename=\"%s\"", filename))
+	c.Header("Content-Type", "text/csv")
+
+	writer := csv.NewWriter(c.Writer)
+	_ = writer.Write([]string{"Project Issue ID", "Title", "State"})
+
+	for _, issue := range issues {
+		_ = writer.Write([]string{
+			issue.ID,
+			sanitizeCSVField(issue.Name),
+			sanitizeCSVField(issue.State),
+		})
+	}
+
+	writer.Flush()
+	if err := writer.Error(); err != nil {
+		h.Log.Error("failed to flush CSV writer", "error", err, "project_id", projectID)
+	}
+}

apps/api/internal/model/analytics.go

@@ -0,0 +1,34 @@
+package model
+
+type StateCount struct {
+	State string `gorm:"column:state" json:"state"`
+	Count int64  `gorm:"column:count" json:"count"`
+}
+
+type PriorityCount struct {
+	Priority string `gorm:"column:priority" json:"priority"`
+	Count    int64  `gorm:"column:count" json:"count"`
+}
+
+type AssigneeCount struct {
+	Email string `gorm:"column:email" json:"email"`
+	Count int64  `gorm:"column:count" json:"count"`
+}
+
+type LabelCount struct {
+	Label string `gorm:"column:label" json:"label"`
+	Count int64  `gorm:"column:count" json:"count"`
+}
+
+type WorkspaceIssueExport struct {
+	ID       string `gorm:"column:id" json:"id"`
+	Name     string `gorm:"column:name" json:"name"`
+	State    string `gorm:"column:state" json:"state"`
+	Priority string `gorm:"column:priority" json:"priority"`
+}
+
+type ProjectIssueExport struct {
+	ID    string `gorm:"column:id" json:"id"`
+	Name  string `gorm:"column:name" json:"name"`
+	State string `gorm:"column:state" json:"state"`
+}

apps/api/internal/router/router.go

@@ -244,6 +244,14 @@ func New(cfg Config) (*gin.Engine, *service.ImporterService) {
 		Queue:      cfg.Queue,
 		AppBaseURL: appBaseURL,
 	}
+
+	analyticsStore := store.NewAnalyticsStore(cfg.DB)
+	analyticsSvc := service.NewAnalyticsService(analyticsStore, workspaceStore, projectStore, cfg.Log)
+	analyticsHandler := &handler.AnalyticsHandler{
+		AnalyticsService: analyticsSvc,
+		Log:              cfg.Log,
+	}
+
 	projectHandler := &handler.ProjectHandler{Project: projectSvc, State: stateSvc}
 	notifPrefHandler := &handler.NotificationPreferenceHandler{Prefs: userNotifPrefStore, Ws: workspaceStore, Projects: projectSvc}
 	favoriteSvc := service.NewFavoriteService(userFavoriteStore, workspaceStore, projectSvc)
@@ -424,6 +432,12 @@ func New(cfg Config) (*gin.Engine, *service.ImporterService) {
 		api.POST("/workspaces/:slug/projects/:projectId/issues-bulk/delete/", issueHandler.BulkDelete)
 		api.POST("/workspaces/:slug/projects/:projectId/issues-bulk/reorder/", issueHandler.BulkReorder)
 
+		api.GET("/workspaces/:slug/analytics/", analyticsHandler.GetWorkspaceAnalytics)
+		api.GET("/workspaces/:slug/analytics/export/", analyticsHandler.ExportWorkspaceCSV)
+
+		api.GET("/workspaces/:slug/projects/:projectId/analytics/", analyticsHandler.GetProjectAnalytics)
+		api.GET("/workspaces/:slug/projects/:projectId/analytics/export/", analyticsHandler.ExportProjectCSV)
+
 		api.GET("/workspaces/:slug/projects/:projectId/cycles/", cycleHandler.List)
 		api.GET("/workspaces/:slug/projects/:projectId/cycles-progress/", cycleHandler.CyclesProgress)
 		api.POST("/workspaces/:slug/projects/:projectId/cycles/", cycleHandler.Create)
@@ -438,8 +452,8 @@ func New(cfg Config) (*gin.Engine, *service.ImporterService) {
 		api.GET("/workspaces/:slug/projects/:projectId/cycles/:cycleId/cycle-progress/", cycleHandler.Progress)
 		api.GET("/workspaces/:slug/projects/:projectId/cycles/:cycleId/analytics", cycleHandler.Analytics)
 
-		api.GET("/workspaces/:slug/projects/:projectId/modules/", moduleHandler.List)
 		api.GET("/workspaces/:slug/projects/:projectId/modules-progress/", moduleHandler.ModulesProgress)
+		api.GET("/workspaces/:slug/projects/:projectId/modules/", moduleHandler.List)
 		api.POST("/workspaces/:slug/projects/:projectId/modules/", moduleHandler.Create)
 		api.GET("/workspaces/:slug/projects/:projectId/modules/:moduleId/", moduleHandler.Get)
 		api.PATCH("/workspaces/:slug/projects/:projectId/modules/:moduleId/", moduleHandler.Update)