api

type ApplicationInfo struct {
	Version   string
	GOVersion string
	BuildDate string
	StartTime time.Time
}

type DeleteReportBulkRequest struct {
	IDs []uint `json:"ids"`
}

type DetailsCreated struct {
	// Number of successfully created detail objects
	Success uint `json:"success"`

	// Number of failed detail objects
	Fail uint `json:"fail"`
}

type ExportAPI struct {
	DB ExportDatabase
}

type ExportDatabase interface {
	FindReportByID(uint) (*model.Report, error)
	GetHistogramForReport(uint) (*model.Histogram, error)
	GetOptionsForReport(uint) (*model.Options, error)
	ListAllDetailsForReport(uint) ([]*model.Detail, error)
}

type HistogramAPI struct {
	DB HistogramDatabase
}

type HistogramDatabase interface {
	GetHistogramForReport(uint) (*model.Histogram, error)
}

type InfoAPI struct {
	Info ApplicationInfo
}

type InfoResponse struct {
	// Version of the application
	Version string `json:"version"`

	// Go runtime version
	RuntimeVersion string `json:"runtimeVersion"`

	// The build date of the server application
	BuildDate string `json:"buildDate"`

	// Uptime of the server
	Uptime string `json:"uptime"`

	// Memory info
	MemoryInfo *MemoryInfo `json:"memoryInfo,omitempty"`
}

type IngestAPI struct {
	DB IngestDatabase
}

type IngestDatabase interface {
	CreateProject(*model.Project) error
	CreateReport(*model.Report) error
	CreateHistogram(*model.Histogram) error
	CreateOptions(*model.Options) error
	FindProjectByID(uint) (*model.Project, error)
	FindLatestReportForProject(uint) (*model.Report, error)
	CreateDetailsBatch(uint, []*model.Detail) (uint, uint)
	UpdateProjectStatus(uint, model.Status) error
}

type IngestRequest runner.Report

type IngestResponse struct {
	// Created project
	Project *model.Project `json:"project"`

	// Created report
	Report *model.Report `json:"report"`

	// Created Options
	Options *model.Options `json:"options"`

	// Created Histogram
	Histogram *model.Histogram `json:"histogram"`

	// The summary of created details
	Details *DetailsCreated `json:"details"`
}

type JSONExportRespose struct {
	model.Report

	Options *model.OptionsInfo `json:"options,omitempty"`

	Histogram model.BucketList `json:"histogram"`

	Details []*runner.ResultDetail `json:"details"`
}

type MemoryInfo struct {
	// Bytes of allocated heap objects.
	Alloc uint64 `json:"allocated"`

	// Cumulative bytes allocated for heap objects.
	TotalAlloc uint64 `json:"totalAllocated"`

	// The total bytes of memory obtained from the OS.
	System uint64 `json:"system"`

	// The number of pointer lookups performed by the runtime.
	Lookups uint64 `json:"lookups"`

	// The cumulative count of heap objects allocated.
	// The number of live objects is Mallocs - Frees.
	Mallocs uint64 `json:"mallocs"`

	// The cumulative count of heap objects freed.
	Frees uint64 `json:"frees"`

	// The number of completed GC cycles.
	NumGC uint32 `json:"numGC"`
}

type OptionsAPI struct {
	DB OptionsDatabase
}

type OptionsDatabase interface {
	GetOptionsForReport(uint) (*model.Options, error)
}

type ProjectAPI struct {
	DB ProjectDatabase
}

type ProjectDatabase interface {
	CreateProject(project *model.Project) error
	FindProjectByID(id uint) (*model.Project, error)
	UpdateProject(*model.Project) error
	DeleteProject(*model.Project) error
	CountProjects() (uint, error)
	ListProjects(limit, page uint, sortField, order string) ([]*model.Project, error)
}

type ProjectList struct {
	Total uint             `json:"total"`
	Data  []*model.Project `json:"data"`
}

type ReportAPI struct {
	DB ReportDatabase
}

type ReportDatabase interface {
	CountReports() (uint, error)
	CountReportsForProject(uint) (uint, error)
	FindReportByID(uint) (*model.Report, error)
	FindPreviousReport(uint) (*model.Report, error)
	DeleteReport(*model.Report) error
	DeleteReportBulk([]uint) (int, error)
	ListReports(limit, page uint, sortField, order string) ([]*model.Report, error)
	ListReportsForProject(pid, limit, page uint, sortField, order string) ([]*model.Report, error)
}

type ReportList struct {
	Total uint            `json:"total"`
	Data  []*model.Report `json:"data"`
}