database

type GetSCMParams struct {
	// ID restricts the lookup to a specific scm.
	ID string
	// URL restricts the lookup to the scms of a repository.
	URL string
	// Branch restricts the lookup to the scms of a branch.
	Branch string
	// StartTime and EndTime restrict the lookup to the scms a report was published for
	// within that range. Both must be provided, an empty range does not filter anything
	// out.
	StartTime string
	EndTime   string
	// Limit is the maximum number of scms to return, a value lower than one returns
	// them all. Page is one based.
	Limit int
	Page  int
}

type GetSCMSummaryParams struct {
	MonitoringDurationDays int
	StartTime              string
	EndTime                string
	Labels                 map[string]string
	// Results restricts the summary to the reports whose pipeline result is one of
	// them. An empty list does not filter anything out.
	Results []string
	// OpenAction restricts the summary to the pipelines which carry an open action, such as
	// a pull request still waiting to be merged, or to the ones which do not. A nil value
	// does not filter anything out.
	OpenAction   *bool
	TotalCount   int
	TotalActions int
	Ctx          context.Context
	ScmRows      []model.SCM
}

type Options struct {
	// URI defines the DB URI
	URI               string
	MigrationDisabled bool
}

type ReportResultSummaryEntry struct {
	// Date is the start of the bucket, in UTC, formatted as RFC3339.
	Date string `json:"date"`
	// Results contains the number of reports per Updatecli result for that bucket.
	Results map[string]int `json:"results"`
	// OpenActions contains, for each Updatecli result, how many of the reports counted in
	// Results also carry an open action, such as a pull request still waiting to be merged.
	// It is a breakdown of Results, not an addition to it, so its counts are always lower
	// than or equal to the matching ones in Results.
	//
	// The interesting one is the count reported under the success result: those pipelines
	// ran fine and had nothing to change only because the change is already waiting in a
	// pull request.
	OpenActions map[string]int `json:"open_actions"`
	// Total is the number of reports for that bucket, all results combined.
	Total int `json:"total"`
}

type ReportSearchOptions struct {
	// Days is the how far to look back for reports from today.
	Days int
}

type ReportSummaryParams struct {
	Ctx context.Context
	// Days is how far back to look for reports, in days.
	// It is ignored when Hours, or StartTime and EndTime, are provided.
	Days int
	// Hours is how far back to look for reports, in hours. It takes precedence over
	// Days and is ignored when StartTime and EndTime are provided.
	Hours int
	// Granularity is the size of the time buckets, it defaults to a day.
	Granularity SummaryGranularity
	// MaxDays is the widest time range accepted, in days. A value lower than one
	// does not enforce any limit.
	MaxDays int
	// MaxBuckets is the largest number of buckets a summary may return. A value lower
	// than one does not enforce any limit.
	MaxBuckets int
	// StartTime and EndTime define an explicit time range, both must be provided.
	StartTime string
	EndTime   string
	// ScmID restricts the summary to the reports of a specific scm.
	ScmID string
	// Labels restricts the summary to the reports matching those labels.
	Labels map[string]string
	// Results restricts the summary to the reports whose pipeline result is one of
	// them. An empty list does not filter anything out.
	Results []string
	// OpenAction restricts the summary to the reports which carry an open action, such as
	// a pull request still waiting to be merged, or to the ones which do not. A nil value
	// does not filter anything out.
	OpenAction *bool
}

type SCMBranchDataset map[string]ScmSummaryData

type SCMDataset struct {
	Data map[string]SCMBranchDataset `json:"data"`
}

type ScmSummaryData struct {
	// ID is the unique identifier of the SCM.
	ID string `json:"id"`
	// TotalResultByType is a map of result types and their counts.
	TotalResultByType map[string]int `json:"total_result_by_type"`
	// TotalResult is the total number of results for this SCM.
	TotalResult int `json:"total_result"`
	// TotalActionURLs is the total number of unique action URLs for this SCM.
	TotalActionURLs int `json:"total_action_urls"`
	// TotalOpenActionByResult is a map of result types to the number of pipelines in that
	// result which also carry an open action, such as a pull request still waiting to be
	// merged. It is a breakdown of TotalResultByType, so its counts are always lower than
	// or equal to the matching ones there.
	//
	// Unlike TotalActionURLs, which counts distinct action URLs, this counts pipelines: a
	// single pull request grouping the changes of several pipelines is counted once there
	// and once per pipeline here.
	TotalOpenActionByResult map[string]int `json:"total_open_action_by_result"`
}

type SearchLatestReportData struct {
	// ID represents the unique identifier of the report.
	ID string
	// Name represents the name of the report.
	Name string
	// Result represents the result of the report.
	Result string
	// Report contains the report data.
	Report reports.Report
	// FilteredResourceID contains the resource config ID that was filtered
	// It allows to identify in the report which resource was used to filter the report.
	FilteredResourceID string
	// CreatedAt represents the creation date of the report.
	CreatedAt string
	// UpdatedAt represents the last update date of the report.
	UpdatedAt string
	// TargetConfigIDs contains the config target IDs associated with the report.
	TargetConfigIDs pgtype.Hstore
	// ConditionConfigIDs contains the config condition IDs associated with the report.
	ConditionConfigIDs pgtype.Hstore
	// SourceConfigIDs contains the config source IDs associated with the report.
	SourceConfigIDs pgtype.Hstore
}

type SearchLatestReportsParams struct {
	Ctx         context.Context
	ScmID       string
	SourceID    string
	ConditionID string
	TargetID    string
	Options     ReportSearchOptions
	StartTime   string
	EndTime     string
	Limit       int
	Page        int
	Latest      bool
	Labels      map[string]string
	// Results restricts the search to the reports whose pipeline result is one of
	// them. An empty list does not filter anything out.
	Results []string
	// OpenAction restricts the search to the reports which carry an open action, such as
	// a pull request still waiting to be merged, or to the ones which do not. A nil value
	// does not filter anything out.
	OpenAction *bool
}

type SummaryGranularity string