itriager

Documentation

Overview

Package itriager defines interface of a CL component triage process.

It's a separate package to avoid circular imports.

Index

• Variables
• func IsErrOutdatedPMState(err error) bool
• type PMState
• type Result
• type Triage

Variables

var ErrOutdatedPMState = errors.New("outdated PM state")

ErrOutdatedPMState signals that PMState is out dated.

Functions

func IsErrOutdatedPMState

func IsErrOutdatedPMState(err error) bool

IsErrOutdatedPMState returns true if given error is a possibly wrapped ErrOutdatedPMState.

Types

type PMState

type PMState interface {
	// PCL provides access to the CLs tracked by the PM.
	//
	// Returns nil if clid refers to a CL not known to the PM.
	PCL(clid int64) *prjpb.PCL

	// PurgingCL provides access to CLs being purged on behalf of the PM.
	//
	// Returns nil if given CL isn't being purged.
	PurgingCL(clid int64) *prjpb.PurgingCL

	// ConfigGroup returns a ConfigGroup for a given index of the current
	// (from the view point of PM) LUCI project config version.
	ConfigGroup(index int32) *prjcfg.ConfigGroup
}

PMState provides limited access to resources of Project Manager (PM) state for ease of testing and correctness.

All data exposed by the PMState must not be modified and remains immutable during the lifetime of a Triage() function execution.

type Result

type Result struct {
	// RunsToCreate is set if a Run has to be created.
	//
	// If set, must contain fully populated runcreator.Creator objects.
	RunsToCreate []*runcreator.Creator

	// NewValue specifies the new value of a component if non-nil.
	//
	// Must be set if the input component is .TriageRequired.
	// If not set, implies that component doesn't have to be changed.
	NewValue *prjpb.Component

	// CLsToPurge must contain PurgeCLTasks tasks with with these (sub)fields set:
	//  * .PurgingCL.Clid
	//  * .Reasons
	CLsToPurge []*prjpb.PurgeCLTask
}

Result is the result of a component traige.

Consistency notes:

The RunsToCreate are processed first, independently from each other. If at least one fails, then NewValue and CLsTopurge are not saved. This ensures that in case of Run creation failure, the next PM invocation will call Triage again.

If RunsToCreate aren't specified OR all of them are created successfully, then the CLsTopurge and NewValue are saved atomically.

type Triage

type Triage func(ctx context.Context, c *prjpb.Component, s PMState) (Result, error)

Triage triages a component deciding what and when has to be done.

Triage is called outside of transaction context. Triage may be retried with the same or different input, possibly concurrently, on the same component.

Triage must treat all given data as read-only. If it needs to modify component, it should use copy-on-write approach.

Project Manager guarantees that for each CL of the given component:

• there is a PCL via Supporter interface,
• and for each such CL's dependency, either:
• dep is not yet loaded,
• OR dep must be itself a component's CL.

May return special, possibly wrapped, ErrOutdatedPMState to signal that Triage function has detected outdated PMState.