ui

type Bot struct {
	model.Bot
	Status model.BotStatus
}

type Build struct {
	*buildbucketpb.Build

	// Now is the current time, used to generate durations that may depend
	// on the current time.
	Now *timestamppb.Timestamp `json:"now,omitempty"`
}

type BuildComponent struct {
	// The parent of this component.  For buildbot and swarmbucket builds, this
	// refers to the builder.  For DM, this refers to whatever triggered the Quest.
	ParentLabel *Link `json:",omitempty"`

	// The main label for the component.
	Label *Link

	// Status of the build.
	Status model.Status

	// Banner is a banner of logos that define the OS and devices this
	// component is associated with.
	Banner *LogoBanner `json:",omitempty"`

	// Bot is the machine or execution instance that this component ran on.
	Bot *Link `json:",omitempty"`

	// Recipe is a link to the recipe this component is based on.
	Recipe *Link `json:",omitempty"`

	// Source is a link to the external (buildbot, swarming, dm, etc) data
	// source that this component relates to.
	Source *Link `json:",omitempty"`

	// Links to show adjacent to the main label.
	MainLink LinkSet `json:",omitempty"`

	// Links to show right below the main label. Top-level slice are rows of
	// links, second level shows up as
	SubLink []LinkSet `json:",omitempty"`

	// Designates the progress of the current component. Set null for no progress.
	Progress *BuildProgress `json:",omitempty"`

	// Pending is time interval that this build was pending.
	PendingTime Interval

	// Execution is time interval that this build was executing.
	ExecutionTime Interval

	// The type of component.  This manifests itself as a little label on the
	// top left corner of the component.
	// This is either "RECIPE" or "STEP".  An attempt is considered a recipe.
	Type ComponentType

	// Arbitrary text to display below links.  One line per entry,
	// newlines are stripped.
	Text []string

	// Children of the step. Undefined for other types of build components.
	Children []*BuildComponent

	// Render a step as collapsed or expanded. Undefined for other types of build
	// components.
	Collapsed bool
}

type BuildPage struct {
	// Build is the underlying build proto for the build page.
	Build

	// Blame is a list of people and commits that likely caused the build result.
	// It is usually used as the list of commits between the previous run of the
	// build on the same builder, and this run.
	Blame []*Commit `json:"blame,omitempty"`

	// BuildBugLink is a URL to be used a feedback link for the build. If the
	// link could not be generated an empty string will be returned. There will be
	// no link, for example, if the project has not set up their build bug template.
	BuildBugLink string `json:"build_bug_link,omitempty"`

	// BuildbucketHost is the hostname for the buildbucket instance this build came from.
	BuildbucketHost string `json:"buildbucket_host,omitempty"`

	// Errors contains any non-critical errors encountered while rendering the page.
	Errors []error `json:"errors,omitempty"`

	// Mode to render the steps.
	StepDisplayPref StepDisplayPref `json:"step_display_pref,omitempty"`

	// Iff true, show all log links whose name starts with '$'.
	ShowDebugLogsPref bool `json:"show_debug_logs_pref,omitempty"`

	// BlamelistError holds errors related to the blamelist.
	// This determines the behavior of clicking the "blamelist" tab.
	BlamelistError error `json:"blamelist_error,omitempty"`

	// ForcedBlamelist indicates that the user forced a blamelist load.
	ForcedBlamelist bool `json:"forced_blamelist,omitempty"`

	// Whether the user is able to perform certain actions on this build
	CanCancel bool `json:"can_cancel,omitempty"`
	CanRetry  bool `json:"can_retry,omitempty"`
	// contains filtered or unexported fields
}

type BuildPageData struct {
	*BuildPage
	CommitLinkHTML          template.HTML   `json:"commit_link_html,omitempty"`
	Summary                 []string        `json:"summary,omitempty"`
	RecipeLink              *Link           `json:"recipe_link,omitempty"`
	BuildbucketLink         *Link           `json:"buildbucket_link,omitempty"`
	BuildSets               []string        `json:"build_sets,omitempty"`
	BuildSetLinks           []template.HTML `json:"build_set_links,omitempty"`
	Steps                   []*Step         `json:"steps,omitempty"`
	HumanStatus             string          `json:"human_status,omitempty"`
	ShouldShowCanaryWarning bool            `json:"should_show_canary_warning,omitempty"`
	InputProperties         []property      `json:"input_properties,omitempty"`
	OutputProperties        []property      `json:"output_properties,omitempty"`
	BuilderLink             *Link           `json:"builder_link,omitempty"`
	Link                    *Link           `json:"link,omitempty"`
	Banners                 []Logo          `json:"banners,omitempty"`
	Timeline                string          `json:"timeline,omitempty"`
}

type BuildProgress struct {
	// contains filtered or unexported fields
}

type BuildSummaryLegacy struct {
	// Link to the build.
	Link *Link

	// Status of the build.
	Status model.Status

	// Pending is time interval that this build was pending.
	PendingTime Interval

	// Execution is time interval that this build was executing.
	ExecutionTime Interval

	// Revision is the main revision of the build.
	Revision *Commit

	// Arbitrary text to display below links.  One line per entry,
	// newlines are stripped.
	Text []string

	// Blame is for tracking whose change the build belongs to, if any.
	Blame []*Commit
}

type BuilderGroup struct {
	// Name is the name of the group.
	Name string
	// Builders is a list of links to the builder page for that builder.
	Builders []Link
}

type BuilderLegacy struct {
	// Name of the builder
	Name string

	// Indicates that this Builder should render a blamelist for each build.
	// This is only supported for Buildbot (crbug.com/807846)
	HasBlamelist bool

	// Warning text, if any.
	Warning string

	CurrentBuilds []*BuildSummaryLegacy
	PendingBuilds []*BuildSummaryLegacy
	// PendingBuildNum is the number of pending builds, since the slice above
	// may be a snapshot instead of the full set.
	PendingBuildNum int
	FinishedBuilds  []*BuildSummaryLegacy

	// MachinePool was primarily used by buildbot builders to list the set of
	// machines that can run in a builder. It has no meaning in buildbucket or dm
	// and is expected to be nil.
	MachinePool *MachinePool

	// Groups is a list of links to builder groups that contain this builder.
	Groups []*Link

	// PrevCursor is a cursor to the previous page.
	PrevCursor string `json:",omitempty"`
	// NextCursor is a cursor to the next page.
	NextCursor string `json:",omitempty"`
}

type BuilderPage struct {
	Builder *buildbucketpb.BuilderItem

	ScheduledBuilds         []*Build
	ScheduledBuildsComplete bool
	StartedBuilds           []*Build
	StartedBuildsComplete   bool
	EndedBuilds             []*Build

	MachinePool *MachinePool

	// Views is a list of links to milo views that reference this builder.
	Views []*Link

	// PrevPageToken is a token to the previous page.
	PrevPageToken string
	// NextPageToken is a token to the next page.
	NextPageToken string
}

type BuilderRef struct {
	// ID is the canonical reference to a specific builder.
	ID string
	// ShortName is a string of length 1-3 used to label the builder.
	ShortName string
	// The most recent build summaries for this builder.
	Build []*model.BuildSummary
	// The most recent builder summary for this builder.
	Builder *model.BuilderSummary
}

type BuilderSummaryGroup struct {
	// Name is a Link that contains the name of the console as well as a relative URL
	// to the console's page.
	Name *Link

	// Builders contains a list of builders for a given console and some data about
	// the latest state for each builder.
	Builders []*model.BuilderSummary
}

type CIService struct {
	// Name is the display name of the service, which could be "Buildbot",
	// or "SwarmBucket"
	Name string

	// Host points to the specific instance of this CI Service.
	Host *Link

	// BuilderGroups lists all of the known named groups of builders within this service.
	BuilderGroups []BuilderGroup
}

type Category struct {
	Name string
	// contains filtered or unexported fields
}

type Choices struct {
	// A list of all possible choices.
	Choices []string

	// The selected choice.
	Selected string
}

type Commit struct {
	// Who made the commit?
	AuthorName string `json:"author_name,omitempty"`
	// Email of the committer.
	AuthorEmail string `json:"author_email,omitempty"`
	// Time of the commit.
	CommitTime time.Time `json:"commit_time,omitempty"`
	// Full URL of the main source repository.
	Repo string `json:"repo,omitempty"`
	// Branch of the repo.
	Branch string `json:"branch,omitempty"`
	// Requested revision of the commit or base commit.
	RequestRevision *Link `json:"request_revision,omitempty"`
	// Revision of the commit or base commit.
	Revision *Link `json:"revision,omitempty"`
	// The commit message.
	Description string `json:"description,omitempty"`
	// Rietveld or Gerrit URL if the commit is a patch.
	Changelist *Link `json:"changelist,omitempty"`
	// Browsable URL of the commit.
	CommitURL string `json:"commit_url,omitempty"`
	// List of changed filenames.
	File []string `json:"file,omitempty"`
}

type ComponentType int

type Console struct {
	Name string

	// Project is the LUCI project for which this console is defined.
	Project string

	// Header is an optional header for the console which contains links, oncall info,
	// and summaries of other, presumably related consoles.
	//
	// This field may be nil, which simply indicates to the renderer to not render a
	// header.
	Header *ConsoleHeader

	// Commit is a list of commits representing the list of commits to the left of the
	// console.
	Commit []Commit

	// Table is a tree of builder categories used to generate the console's main table.
	//
	// Leaf nodes must always be of concrete type BuilderRef, interior nodes must
	// always be of type Category. The root node is a dummy node without a name
	// to simplify the implementation.
	Table Category

	// MaxDepth represents the maximum tree depth of Table.
	MaxDepth int

	// FaviconURL is the URL to the favicon for this console.
	FaviconURL string
}

type ConsoleElement interface {
	// Writes HTML into the given byte buffer.
	//
	// The two integer parameters represent useful pieces of metadata in
	// rendering: current depth, and maximum depth.
	RenderHTML(*bytes.Buffer, int, int)

	// Returns number of leaf nodes in this console element.
	NumLeafNodes() int
}

type ConsoleGroup struct {
	// Title is the title for this group of consoles and may link to anywhere.
	Title *Link

	// Consoles is the list of console summaries contained without this group.
	Consoles []*BuilderSummaryGroup
}

type ConsoleHeader struct {
	// Oncalls is a list of oncall roles and the current people who fill that role
	// that will be displayed in the header..
	Oncalls []*OncallSummary

	// Links is a list of link groups to be displayed in the header.
	Links []LinkGroup

	// ConsoleGroups is a list of groups of console summaries to be displayed in
	// the header, or nil if there was an error when retrieving consoles.
	//
	// A console group without a title will have all of its console summaries
	// appear "ungrouped" when rendered.
	ConsoleGroups []ConsoleGroup

	// ConsoleGroupsErr is the error thrown when retrieving console groups.
	ConsoleGroupsErr error

	// TreeStatus indicates the status of the tree if it is not nil.
	TreeStatus *TreeStatus
}

type Frontpage struct {
	Projects []*common.Project
}

type Interval struct {
	// Started denotes the start time of this interval.
	Started time.Time
	// Finished denotest the end time of this interval.
	Finished time.Time
	// Duration is the length of the interval.
	Duration time.Duration
}

type Link struct {
	model.Link

	// AriaLabel is a spoken label for the link.  Used as aria-label under the anchor tag.
	AriaLabel string `json:"aria_label,omitempty"`

	// Img is an icon for the link.  Not compatible with label.  Rendered as <img>
	Img string `json:"img,omitempty"`

	// Alt text for the image, or title text with text link.
	Alt string `json:"alt,omitempty"`
}

type LinkGroup struct {
	// Name is the name of the category this group of links belongs to.
	Name *Link

	// Links is a list of links in this link group.
	Links []*Link
}

type LinkSet []*Link

type Logo struct {
	LogoBase
	// Subtitle is text that goes under the logo.  This is most commonly used
	// to specify the version of the OS or type of device.
	Subtitle string `json:"subtitle,omitempty"`
	// Count specifies how many of the OS or device there are.
	Count int `json:"count,omitempty"`
}

type LogoBanner struct {
	OS     []Logo
	Device []Logo
}

type LogoBase struct {
	Img string `json:"img,omitempty"`
	Alt string `json:"alt,omitempty"`
}

type MachinePool struct {
	Total        int
	Offline      int
	Idle         int
	Busy         int
	Bots         []Bot
	Dimensions   []string
	SwarmingHost string
}

type MiloBuildLegacy struct {
	// Summary is a top level summary of the page.
	Summary BuildComponent

	// Trigger gives information about how and with what information
	// the build was triggered.
	Trigger *Trigger

	// Components is a detailed list of components and subcomponents of the page.
	// This is most often used for steps or deps.
	Components []*BuildComponent

	// PropertyGroup is a list of input and output property of this page.
	// This is used for build and emitted properties (buildbot) and quest
	// information (luci).  This is also grouped by the "type" of property
	// so different categories of properties can be separated and sorted.
	//
	// This is not a map so code that constructs MiloBuildLegacy can control the
	// order of property groups, for example show important properties
	// first.
	PropertyGroup []*PropertyGroup

	// Blame is a list of people and commits that is likely to be in relation to
	// the thing displayed on this page.
	Blame []*Commit

	// Mode to render the steps.
	StepDisplayPref StepDisplayPref

	// Iff true, show all log links whose name starts with '$'.
	ShowDebugLogsPref bool
}

type Navigation struct {
	// Title of the site, is generally consistent throughout the whole site.
	SiteTitle *Link

	// Title of the page, usually talks about what's currently here
	PageTitle *Link

	// List of clickable thing to navigate down the hierarchy.
	Breadcrumbs []*Link

	// List of (smaller) clickable things to display on the right side.
	Right []*Link
}

type Oncall struct {
	// Primary is the username of the primary oncall.  This is used in lieu of emails.
	// This is filled in from the remote JSON.
	Primary string

	// Secondaries are the usernames of the secondary oncalls.  This is used in lieu of emails.
	// This is filled in from the remote JSON.
	Secondaries []string

	// Emails is a list of email addresses for the individuals who are currently in
	// that role.  This is loaded from the sheriffing json.
	Emails []string
}

type OncallSummary struct {
	// Name is the name of the oncall role.  This is set in the Milo config.
	Name string

	// Oncallers is an HTML template containing the usernames (for Googlers) or email addresses
	// (for external contributors) of current oncallers. External emails are obfuscated to make
	// them harder to scrape. If specified in the config, displays "(primary)" and "(secondary)"
	// after the oncaller names. Displays "<none>" if no-one is oncall.
	Oncallers template.HTML
}

type Property struct {
	Key   string
	Value string
}

type PropertyGroup struct {
	GroupName string
	Property  []*Property
}

type RelatedBuildsTable struct {
	// Build is the underlying build proto for the build page.
	Build `json:"build,omitempty"`

	// RelatedBuilds are build summaries with the same buildset.
	RelatedBuilds []*Build `json:"related_builds,omitempty"`
}

type Search struct {
	// CIServices is a backing service for a Continuous Integration system,
	// such as "buildbot", "swarmbucket", or "dm".
	CIServices []CIService
}

type Settings struct {
	// Where the form should go.
	ActionURL string

	// Themes is a list of usable themes for Milo
	Theme *Choices
}

type Step struct {
	*buildbucketpb.Step
	Children  []*Step         `json:"children,omitempty"`
	Collapsed bool            `json:"collapsed,omitempty"`
	Interval  common.Interval `json:"interval,omitempty"`
}

type StepDisplayPref string

type TreeStatus struct {
	// Username is the name of the user who changed the status last.
	Username        string `json:"username"`
	CanCommitFreely bool   `json:"can_commit_freely"`
	// GeneralState is the general state of the tree, which also indicates
	// the color of the tree.
	GeneralState TreeStatusState `json:"general_state"`
	Key          int64           `json:"key"`
	// Date is when the tree was last updated.  The format is YYYY-mm-DD HH:MM:SS.ssssss
	// and implicitly UTC.  eg. "2017-11-10 14:29:21.804080"
	Date string `json:"date"`
	// Message is a human readable description of the tree.
	Message string `json:"message"`
	// URL is a link to the root status page.  This is generated on the Milo side,
	// not provided by the status app.
	URL *url.URL
}

type TreeStatusState string

type Trigger struct {
	Commit
	// Source is the trigger source.  In buildbot, this would be the "Reason".
	// This has no meaning in SwarmBucket and DM yet.
	Source string
	// Project is the name of the LUCI project responsible for
	// triggering the build.
	Project string
}