api

type App struct {
	Router      *mux.Router
	RedisClient *libredis.Client
}

type AppOption func(c *App)

type AuditResult struct {
	ID               string  `json:"id"`
	Title            string  `json:"title"`
	Description      string  `json:"description"`
	Score            float32 `json:"score"`
	ScoreDisplayMode string  `json:"scoreDisplayMode"`
	NumericValue     float64 `json:"numericValue"`
	NumericUnit      string  `json:"numericUnit"`
	DisplayValue     string  `json:"DisplayValue"`
}

type GCPScheduler struct {
	Project  string
	Location string
	Queue    string
}

type GoScheduler struct{}

type Location struct {
	ID          primitive.ObjectID `json:"id" bson:"_id"`
	Name        string             `json:"name" bson:"name" example:"australia-southeast1"`
	DisplayName string             `json:"display_name" bson:"display_name" example:"Sydney, AU"`
	Address     string             `json:"address" bson:"address" example:"8.8.8.8:50051"`
	// Flag to indicate whether TLS should be used
	Secure    bool      `json:"secure" bson:"secure"`
	Order     int32     `json:"order" bson:"order"`
	Premium   bool      `json:"premium" bson:"premium"`
	CreatedAt time.Time `json:"created_at" bson:"created_at"`
}

type Report struct {
	ID              primitive.ObjectID `json:"id" bson:"_id"`
	ReportRequest   `bson:",inline"`
	LocationDisplay string `json:"location_display" bson:"location_display"`
	// RawJSON contains the lighthouse JSON result
	RawJSON          string                 `json:"raw_json" bson:"raw_json"`
	CreatedAt        time.Time              `json:"created_at" bson:"created_at"`
	PerformanceScore float32                `json:"performance_score" bson:"performance_score"`
	AuditResults     map[string]AuditResult `json:"audit_results" bson:"audit_results"`
}

type ReportRequest struct {
	// Required parameter the URL of the website
	URL string `json:"url" bson:"url" example:"https://www.google.com"`
	// Optional parameter, possible values are desktop or mobile. If unset will default to desktop
	FormFactor string `json:"form_factor" bson:"form_factor" example:"desktop"`
	// Optional parameter, by default will be set to 1000 if omitted
	ThroughputKbps int64 `json:"throughput_kbps" bson:"thoughput_kbps" example:"50000"`
	// Optional parameter, default location will be used if not set
	Location string `json:"location" bson:"location" example:"australia-southeast1"`
	// Optional parameter, email adress to sent the report to
	Email string `json:"email,omitempty" bson:"email"`
	User  string `json:"user,omitempty" bson:"user"`
}

type ReportRunner interface {
	RunReport(sr ScheduledReport)
}

type ScheduledReport struct {
	ID            primitive.ObjectID `json:"id" bson:"_id"`
	ReportRequest `bson:",inline"`
	Schedule      string    `json:"schedule" bson:"schedule" example:"daily"`
	LastRun       time.Time `json:"last_run" bson:"last_run"`
	CreatedAt     time.Time `json:"created_at" bson:"created_at"`
}