feat: allow filter reports and scm based on a date range (#335)

Author: olblak

pkg/database/report.go

@@ -73,19 +73,25 @@ func SearchReport(ctx context.Context, id string) (*model.PipelineReport, error)
 }
 
 // SearchLatestReport searches the latest reports according some parameters.
-func SearchLatestReport(ctx context.Context, scmID, sourceID, conditionID, targetID string, options ReportSearchOptions, limit, page int) ([]SearchLatestReportData, int, error) {
+func SearchLatestReport(ctx context.Context, scmID, sourceID, conditionID, targetID string, options ReportSearchOptions, limit, page int, startTime, endTime string) ([]SearchLatestReportData, int, error) {
 	queryString := ""
 	var args []any
 
 	query := psql.Select(
 		sm.From("pipelineReports"),
 		sm.Columns("id", "data", "created_at", "updated_at"),
 		sm.OrderBy(psql.Quote("updated_at")).Desc(),
-		sm.Where(
-			psql.Raw(fmt.Sprintf("updated_at > current_date - interval '%d day'", options.Days)),
-		),
 	)
 
+	if err := applyUpdatedAtRangeFilter(DateRangeFilterParams{
+		Query:         &query,
+		DateRangeDays: options.Days,
+		StartTime:     startTime,
+		EndTime:       endTime,
+	}); err != nil {
+		return nil, 0, fmt.Errorf("applying updated_at range filter: %w", err)
+	}
+
 	if sourceID != "" {
 		// Ensure sourceID is a valid UUID
 		if _, err := uuid.Parse(sourceID); err != nil {

pkg/database/scm.go

@@ -145,7 +145,7 @@ type SCMDataset struct {
 }
 
 // GetSCMSummary returns a list of scms summary from the scm database table.
-func GetSCMSummary(ctx context.Context, scmRows []model.SCM, totalCount, monitoringDurationDays int) (*SCMDataset, error) {
+func GetSCMSummary(ctx context.Context, scmRows []model.SCM, totalCount, monitoringDurationDays int, startTime, endTime string) (*SCMDataset, error) {
 
 	dataset := SCMDataset{}
 
@@ -167,12 +167,18 @@ func GetSCMSummary(ctx context.Context, scmRows []model.SCM, totalCount, monitor
 					psql.Arg(fmt.Sprintf("{%s}", scmID)),
 				),
 			),
-			sm.Where(
-				psql.Raw(fmt.Sprintf("updated_at > current_date - interval '%d day'", monitoringDurationDays)),
-			),
 			sm.Columns("id", "data", "updated_at"),
 		)
 
+		if err := applyUpdatedAtRangeFilter(DateRangeFilterParams{
+			Query:         &filteredSCMsQuery,
+			DateRangeDays: monitoringDurationDays,
+			StartTime:     startTime,
+			EndTime:       endTime,
+		}); err != nil {
+			return nil, fmt.Errorf("applying updated_at range filter: %w", err)
+		}
+
 		query := psql.Select(
 			sm.Distinct(
 				psql.Raw("data ->> 'ID'"),

pkg/database/time_utils.go

@@ -0,0 +1,66 @@
+package database
+
+import (
+	"fmt"
+	"time"
+
+	"github.com/stephenafamo/bob"
+	"github.com/stephenafamo/bob/dialect/psql"
+	"github.com/stephenafamo/bob/dialect/psql/dialect"
+	"github.com/stephenafamo/bob/dialect/psql/sm"
+)
+
+// DateRangeFilterParams holds parameters for applying a date range filter to a query.
+type DateRangeFilterParams struct {
+	Query         *bob.BaseQuery[*dialect.SelectQuery]
+	DateRangeDays int
+	StartTime     string
+	EndTime       string
+}
+
+// applyUpdatedAtRangeFilter applies a time range filter to the given query based on the provided
+// startTime and endTime strings in RFC3339 format. If both are empty and dateRangeDays is greater than zero,
+// it filters records updated within the last dateRangeDays days.
+func applyUpdatedAtRangeFilter(r DateRangeFilterParams) error {
+	if r.StartTime == "" && r.EndTime == "" && r.DateRangeDays > 0 {
+		start := time.Now().UTC().Add(-time.Duration(r.DateRangeDays) * 24 * time.Hour)
+		r.Query.Apply(
+			sm.Where(
+				psql.Raw("updated_at > ?", start),
+			),
+		)
+		return nil
+	}
+
+	if r.StartTime == "" && r.EndTime == "" {
+		return nil
+	}
+
+	if r.StartTime == "" || r.EndTime == "" {
+		return fmt.Errorf("both startTime and endTime must be provided for time range filtering")
+	}
+
+	startT, err := time.Parse("2006-01-02 15:04:05Z07:00", r.StartTime)
+	if err != nil {
+		return fmt.Errorf("parsing startTime: %w", err)
+	}
+	endT, err := time.Parse("2006-01-02 15:04:05Z07:00", r.EndTime)
+	if err != nil {
+		return fmt.Errorf("parsing endTime: %w", err)
+	}
+
+	startTimeUTC := startT.UTC()
+	endTimeUTC := endT.UTC()
+
+	if startTimeUTC.After(endTimeUTC) {
+		startTimeUTC, endTimeUTC = endTimeUTC, startTimeUTC
+	}
+
+	r.Query.Apply(
+		sm.Where(
+			psql.Raw("updated_at >= ? AND updated_at < ?", startTimeUTC, endTimeUTC),
+		),
+	)
+
+	return nil
+}

pkg/server/report_handlers.go

@@ -114,6 +114,14 @@ func SearchPipelineReports(c *gin.Context) {
 		// Page is the page number for pagination
 		// This is optional and can be used to paginate the results
 		Page int `json:"page"`
+		// StartTime is the start time for the time range filter
+		// This is optional and can be used to filter reports by a specific start time
+		// Time format is RFC3339: 2006-01-02T15:04:05Z07:00
+		StartTime string `json:"start_time"`
+		// EndTime is the end time for the time range filter
+		// This is optional and can be used to filter reports by a specific end time
+		// Time format is RFC3339: 2006-01-02T15:04:05Z07:00
+		EndTime string `json:"end_time"`
 	}
 
 	queryParams := queryData{}
@@ -130,6 +138,7 @@ func SearchPipelineReports(c *gin.Context) {
 		c, queryParams.ScmID, queryParams.SourceID, queryParams.ConditionID,
 		queryParams.TargetID, database.ReportSearchOptions{Days: monitoringDurationDays},
 		queryParams.Limit, queryParams.Page,
+		queryParams.StartTime, queryParams.EndTime,
 	)
 	if err != nil {
 		logrus.Errorf("searching for latest report: %s", err)
@@ -152,12 +161,18 @@ func SearchPipelineReports(c *gin.Context) {
 // @Param scmid query string false "SCM ID"
 // @Param limit query string false "Limit the number of reports returned, default is 100"
 // @Param page query string false "Page number for pagination, default is 1"
+// @Param start_time query string false "Start time for filtering reports (RFC3339 format)"
+// @Param end_time query string false "End time for filtering reports (RFC3339 format)"
+// @Accept json
+// @Produce json
 // @Success 200 {object} GetPipelineReportsResponse
 // @Failure 500 {object} DefaultResponseModel
 // @Router /api/pipeline/reports [get]
 func ListPipelineReports(c *gin.Context) {
 	queryParams := c.Request.URL.Query()
 	scmID := queryParams.Get("scmid")
+	startTime := queryParams.Get("start_time")
+	endTime := queryParams.Get("end_time")
 
 	limit, page, err := getPaginationParamFromURLQuery(c)
 	if err != nil {
@@ -173,6 +188,7 @@ func ListPipelineReports(c *gin.Context) {
 		database.ReportSearchOptions{Days: monitoringDurationDays},
 		limit,
 		page,
+		startTime, endTime,
 	)
 
 	if err != nil {

pkg/server/scmdb_handlers.go

@@ -28,6 +28,8 @@ type ListSCMsResponse struct {
 // @Param summary query bool false "Return a summary of the SCMs"
 // @Param limit query string false "Limit the number of reports returned, default is 100"
 // @Param page query string false "Page number for pagination, default is 1"
+// @Param start_time query string false "Start time for filtering SCMs (RFC3339 format)"
+// @Param end_time query string false "End time for filtering SCMs (RFC3339 format)"
 // @Success 200 {object} DefaultResponseModel
 // @Failure 500 {object} DefaultResponseModel
 // @Router /api/pipeline/scms [get]
@@ -36,6 +38,8 @@ func ListSCMs(c *gin.Context) {
 	url := c.Request.URL.Query().Get("url")
 	branch := c.Request.URL.Query().Get("branch")
 	summary := c.Request.URL.Query().Get("summary")
+	startTime := c.Request.URL.Query().Get("start_time")
+	endTime := c.Request.URL.Query().Get("end_time")
 
 	limit, page, err := getPaginationParamFromURLQuery(c)
 	if err != nil {
@@ -57,7 +61,7 @@ func ListSCMs(c *gin.Context) {
 	}
 
 	if strings.ToUpper(summary) == "TRUE" {
-		findSCMSummary(c, rows, totalCount)
+		findSCMSummary(c, rows, totalCount, startTime, endTime)
 		return
 	}
 
@@ -74,11 +78,11 @@ type FindSCMSummaryResponse struct {
 }
 
 // findSCMSummary returns a summary of all git repositories detected.
-func findSCMSummary(c *gin.Context, scmRows []model.SCM, totalCount int) {
+func findSCMSummary(c *gin.Context, scmRows []model.SCM, totalCount int, startTime, endTime string) {
 
 	var data map[string]database.SCMBranchDataset
 
-	dataset, err := database.GetSCMSummary(c, scmRows, totalCount, monitoringDurationDays) // Assuming 30 days as the default monitoring duration
+	dataset, err := database.GetSCMSummary(c, scmRows, totalCount, monitoringDurationDays, startTime, endTime) // Assuming 30 days as the default monitoring duration
 	if err != nil {
 		logrus.Errorf("getting scm summary failed: %s", err)
 		c.JSON(http.StatusInternalServerError, DefaultResponseModel{