frontend

package
v0.0.0-...-2d420a4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 3, 2024 License: BSD-3-Clause Imports: 11 Imported by: 0

Documentation

Overview

Package frontend houses a variety of types that represent how the frontend expects the format of data. The data types here are those shared by multiple packages.

Index

Constants

View Source 
const (
	// PositiveRef identifies the diff to the closest positive digest.
	PositiveRef = RefClosest("pos")

	// NegativeRef identifies the diff to the closest negative digest.
	NegativeRef = RefClosest("neg")

	// NoRef indicates no other digests match.
	NoRef = RefClosest("")
)
View Source 
const (
	// ExpectationsRouteV2 serves the expectations of the master branch. If a changelist ID is
	// provided via the "issue" GET parameter, the expectations associated with that CL will be
	// merged onto the returned baseline.
	ExpectationsRouteV2 = "/json/v2/expectations"

	// KnownHashesRoute serves the list of known hashes.
	KnownHashesRoute   = "/json/hashes"
	KnownHashesRouteV1 = "/json/v1/hashes"

	GroupingsRouteV1 = "/json/v1/groupings"
)

Define common routes used by multiple servers and goldctl

View Source 
const (
	TriageResponseStatusOK       = TriageResponseStatus("ok")
	TriageResponseStatusConflict = TriageResponseStatus("conflict")
)
View Source 
const (
	// ClosestDiffLabelNone means there is no closest diff for a digest.
	ClosestDiffLabelNone      = ClosestDiffLabel("none")
	ClosestDiffLabelUntriaged = ClosestDiffLabel(expectations.Untriaged)
	ClosestDiffLabelPositive  = ClosestDiffLabel(expectations.Positive)
	ClosestDiffLabelNegative  = ClosestDiffLabel(expectations.Negative)
)

Variables

View Source 
var AllClosestDiffLabels = []ClosestDiffLabel{
	ClosestDiffLabelNone,
	ClosestDiffLabelUntriaged,
	ClosestDiffLabelPositive,
	ClosestDiffLabelNegative,
}

AllClosestDiffLabels is the list of all possible ClosetDiffLabel values.

View Source 
var AllTriageResponseStatus = []TriageResponseStatus{
	TriageResponseStatusOK,
	TriageResponseStatusConflict,
}

AllTriageResponseStatus is a list of all valid TriageResponseStatus values.

Functions

This section is empty.

Types

type BaselineV2Response 

type BaselineV2Response struct {
	// Expectations captures the "baseline expectations", that is, the expectations with only the
	// positive and negative digests (i.e. no untriaged digest) of the current commit.
	Expectations expectations.Baseline `json:"primary,omitempty"`

	// ChangelistID indicates the Gerrit or GitHub issue id of this baseline.
	// "" indicates the master branch.
	ChangelistID string `json:"cl_id,omitempty"`

	// CodeReviewSystem indicates which CRS system (if any) this baseline is tied to.
	// (e.g. "gerrit", "github") "" indicates the master branch.
	CodeReviewSystem string `json:"crs,omitempty"`
}

BaselineV2Response captures the data necessary to verify test results on the commit queue. A baseline is essentially just the positive and negative expectations for a branch.

type BulkTriageDeltaInfo 

type BulkTriageDeltaInfo struct {
	Grouping                   paramtools.Params  `json:"grouping"`
	Digest                     types.Digest       `json:"digest"`
	LabelBefore                expectations.Label `json:"label_before"`
	ClosestDiffLabel           ClosestDiffLabel   `json:"closest_diff_label"`
	InCurrentSearchResultsPage bool               `json:"in_current_search_results_page"`
}

BulkTriageDeltaInfo contains the information necessary to create a TriageDelta for a single digest that can be used in a bulk triage operation.

type ByBlameEntry 

type ByBlameEntry struct {
	GroupID       string       `json:"groupID"`
	NDigests      int          `json:"nDigests"`
	NTests        int          `json:"nTests"`
	AffectedTests []TestRollup `json:"affectedTests"`
	Commits       []Commit     `json:"commits"`
}

ByBlameEntry is a helper structure that is serialized to JSON and sent to the front-end.

type ByBlameResponse 

type ByBlameResponse struct {
	Data []ByBlameEntry `json:"data"`
}

ByBlameResponse is the response for /json/v1/byblame.

type Changelist 

type Changelist struct {
	System   string    `json:"system"`
	SystemID string    `json:"id"`
	Owner    string    `json:"owner"`
	Status   string    `json:"status"`
	Subject  string    `json:"subject"`
	Updated  time.Time `json:"updated"`
	URL      string    `json:"url"`
}

Changelist encapsulates how the frontend expects to get information about a code_review.Changelist that has Gold results associated with it. We have a separate struct so we can decouple the JSON representation and the backend representation (if it needs changing or use by another project with its own JSON requirements).

type ChangelistSummary 

type ChangelistSummary struct {
	CL Changelist `json:"cl"`
	// these are only those patchsets with data.
	Patchsets         []Patchset `json:"patch_sets" go2ts:"ignorenil"`
	NumTotalPatchsets int        `json:"num_total_patch_sets"`
}

ChangelistSummary encapsulates how the frontend expects to get a summary of the TryJob information we have associated with a given Changelist. These TryJobs are those we've noticed that uploaded results to Gold.

type ChangelistSummaryResponseV1 

type ChangelistSummaryResponseV1 struct {
	// ChangelistID is the nonqualified id of the CL.
	ChangelistID string `json:"changelist_id"`
	// PatchsetSummaries is a summary for all Patchsets for which we have data.
	PatchsetSummaries []PatchsetNewAndUntriagedSummaryV1 `json:"patchsets"`
	// Outdated will be true if this is a stale cached entry. Clients are free to try again later
	// for the latest results.
	Outdated bool `json:"outdated"`
}

ChangelistSummaryResponseV1 is a summary of the results associated with a given CL. It focuses on the untriaged and new images produced.

type ChangelistsResponse 

type ChangelistsResponse struct {
	Changelists []Changelist `json:"changelists"`
	httputils.ResponsePagination
}

ChangelistsResponse is the response for /json/v1/changelists.

type ClosestDiffLabel 

type ClosestDiffLabel string

ClosestDiffLabel is the label that a digest should be assigned when bulk-triaging by closest diff.

type ClusterDiffResult 

type ClusterDiffResult struct {
	// Nodes represents each digest that matched the cluster criteria.
	Nodes []Node `json:"nodes"`
	// Links represents all possible comparisons between the nodes. There should be
	// (n-1) + (n-2) ... + 2 + 1 links for n nodes, or n(n-1)/2
	Links []Link `json:"links"`

	Test types.TestName `json:"test"`
	// ParamsetByDigest is a mapping of digest to the ParamSet created by combining all Params
	// for all traces that produce this digest.
	ParamsetByDigest map[types.Digest]paramtools.ParamSet `json:"paramsetByDigest" go2ts:"ignorenil"`
	// ParamsetsUnion is the union of all Params from all Traces that matched the cluster criteria.
	// It is also a union of all ParamSet in ParamsetByDigest.
	ParamsetsUnion paramtools.ParamSet `json:"paramsetsUnion"`
}

ClusterDiffResult contains the result of comparing all digests within a test. It is structured to be easy to render by the D3.js.

type Commit 

type Commit struct {
	// CommitTime is in seconds since the epoch
	CommitTime int64  `json:"commit_time"`
	ID         string `json:"id"`
	// Hash refers to the githash of a commit. It is deprecated, we should refer to commit IDs, not
	// hashes.
	Hash          string `json:"hash"` // For CLs, this is the CL ID.
	Author        string `json:"author"`
	Subject       string `json:"message"`
	ChangelistURL string `json:"cl_url"`
}

Commit represents a git Commit for use on the frontend.

type DetailsRequest 

type DetailsRequest struct {
	Grouping         paramtools.Params `json:"grouping"`
	Digest           types.Digest      `json:"digest"`
	ChangelistID     string            `json:"changelist_id,omitempty"`
	CodeReviewSystem string            `json:"crs,omitempty"`
}

DetailsRequest is the request for the /json/v2/details RPC.

type DiffRequest 

type DiffRequest struct {
	Grouping         paramtools.Params `json:"grouping"`
	LeftDigest       types.Digest      `json:"left_digest"`
	RightDigest      types.Digest      `json:"right_digest"`
	ChangelistID     string            `json:"changelist_id,omitempty"`
	CodeReviewSystem string            `json:"crs,omitempty"`
}

DiffRequest is the request for the /json/v2/diff RPC.

type DigestComparison 

type DigestComparison struct {
	Left  LeftDiffInfo `json:"left"`  // The left hand digest and its params.
	Right SRDiffDigest `json:"right"` // The right hand digest, its params and the diff result.
}

DigestComparison contains the result of comparing two digests.

type DigestDetails 

type DigestDetails struct {
	Result  SearchResult `json:"digest"`
	Commits []Commit     `json:"commits"`
}

DigestDetails contains details about a digest.

type DigestListResponse 

type DigestListResponse struct {
	Digests []types.Digest `json:"digests"`
}

DigestListResponse is the response for "what digests belong to..."

type DigestStatus 

type DigestStatus struct {
	Digest types.Digest       `json:"digest"`
	Status expectations.Label `json:"status"`
}

DigestStatus is a digest and its status, used in TraceGroup.

type GUICorpusStatus 

type GUICorpusStatus struct {
	// Name of the corpus.
	Name string `json:"name"`

	// Number of untriaged digests in HEAD.
	UntriagedCount int `json:"untriagedCount"`
}

type GUIStatus 

type GUIStatus struct {
	// Last commit for which data was ingested..
	LastCommit Commit `json:"lastCommit"`
	// Status per corpus.
	CorpStatus []GUICorpusStatus `json:"corpStatus" go2ts:"ignorenil"`
}

GUIStatus reflects the current triage status of the various corpora at head.

type GroupingsResponse 

type GroupingsResponse struct {
	// GroupingParamKeysByCorpus contains the param keys that comprise the grouping of each corpus.
	GroupingParamKeysByCorpus map[string][]string `json:"grouping_param_keys_by_corpus"`
}

GroupingsResponse is the response for the /json/v1/groupings RPC.

type IgnoreRule 

type IgnoreRule struct {
	ID          string              `json:"id"`
	CreatedBy   string              `json:"name"` // TODO(kjlubick) rename this on the frontend.
	UpdatedBy   string              `json:"updatedBy"`
	Expires     time.Time           `json:"expires"`
	Query       string              `json:"query"`
	ParsedQuery map[string][]string `json:"-"`
	Note        string              `json:"note"`
	// Count represents how many traces are affected by this ignore rule.
	Count int `json:"countAll"`
	// ExclusiveCount represents how many traces are affected *exclusively* by this ignore rule,
	// that is, they are only matched by this rule.
	ExclusiveCount int `json:"exclusiveCountAll"`
	// UntriagedCount represents how many traces with an untriaged digest at HEAD are affected
	// by this ignore rule.
	UntriagedCount int `json:"count"`
	// ExclusiveUntriagedCount represents how many traces with an untriaged digest at HEAD are
	// affected *exclusively* by this ignore rule, that is, they are only matched by this rule.
	ExclusiveUntriagedCount int `json:"exclusiveCount"`
}

IgnoreRule represents an ignore.Rule as well as how many times the rule was applied. This allows for the decoupling of the rule as stored in the DB from how we present it to the UI.

func ConvertIgnoreRule 

func ConvertIgnoreRule(r ignore.Rule) (IgnoreRule, error)

ConvertIgnoreRule converts a backend ignore.Rule into its frontend counterpart.

type IgnoreRuleBody 

type IgnoreRuleBody struct {
	// Duration is a human readable string like "2w", "4h" to specify a duration.
	Duration string `json:"duration"`
	// Filter is a url-encoded set of key-value pairs that can be used to match traces.
	// For example: "config=angle_d3d9_es2&cpu_or_gpu_value=RadeonHD7770"
	// Filter is limited to 10 KB.
	Filter string `json:"filter"`
	// Note is a short comment by a developer, typically a bug. Note is limited to 1 KB.
	Note string `json:"note"`
}

IgnoreRuleBody encapsulates a single ignore rule that is submitted for addition or update.

type IgnoresResponse 

type IgnoresResponse struct {
	Rules []IgnoreRule `json:"rules"`
}

IgnoresResponse is the response for /json/v1/ignores.

type LeftDiffInfo 

type LeftDiffInfo struct {
	// Test is the name of the test that produced the primary digest. This is needed because
	// we might have a case where, for example, a blank 100x100 image is correct for one test,
	// but not for another test and we need to distinguish between the two cases.
	// TODO(kjlubick) make this be grouping
	Test types.TestName `json:"test"`
	// Digest is the primary digest to which the rest of the data in this struct belongs.
	Digest types.Digest `json:"digest"`
	// Status is positive, negative, or untriaged. This is also known as the expectation for the
	// primary digest (for Test).
	Status expectations.Label `json:"status"`
	// TriageHistory is a history of all the times the primary digest has been retriaged for the
	// given Test.
	TriageHistory []TriageHistory `json:"triage_history"`
	// ParamSet is all the keys and options of all traces that produce the digest on the primary
	// branch (disregarding ignore rules, but respecting the public visibility rules, if
	// applicable). It is for frontend UI presentation only; essentially a word cloud of what drew
	// the primary digest.
	ParamSet paramtools.ParamSet `json:"paramset"`
}

LeftDiffInfo describes the left digest in a comparison between two digests. It describes the triage status, history and summarizes how it is drawn on the primary branch. 

type Link struct {
	// LeftIndex is the index in the sibling Nodes slice corresponding to the "left" digest.
	LeftIndex int `json:"source"`
	// RightIndex is the index in the sibling Nodes slice corresponding to the "right" digest.
	RightIndex int `json:"target"`
	// Distance is how far apart the two digests are. This distance is currently the percentage
	// of pixels different between the two images.
	Distance float32 `json:"value"`
}

Link represents a link between d3 nodes, used in ClusterDiffResult.

type ListTestsQuery 

type ListTestsQuery struct {
	Corpus      string
	TraceValues paramtools.ParamSet
	IgnoreState types.IgnoreState
}

ListTestsQuery encapsulates the inputs to ListTestsHandler.

func ParseListTestsQuery 

func ParseListTestsQuery(r *http.Request) (ListTestsQuery, error)

ParseListTestsQuery returns a ListTestsQuery by parsing the given request or error if the inputs are invalid.

type ListTestsResponse 

type ListTestsResponse struct {
	Tests []TestSummary `json:"tests"`
}

ListTestsResponse is the response for /json/v1/list.

type MostRecentPositiveDigestResponse 

type MostRecentPositiveDigestResponse struct {
	Digest types.Digest `json:"digest"`
}

MostRecentPositiveDigestResponse is the response for /json/latestpositivedigest.

type Node 

type Node struct {
	Digest types.Digest       `json:"name"`
	Status expectations.Label `json:"status"`
}

Node represents a single node in a d3 diagram. Used in ClusterDiffResult.

type Patchset 

type Patchset struct {
	SystemID string   `json:"id"`
	Order    int      `json:"order"`
	TryJobs  []TryJob `json:"try_jobs" go2ts:"ignorenil"`
}

Patchset represents the data the frontend needs for Patchsets.

type PatchsetNewAndUntriagedSummaryV1 

type PatchsetNewAndUntriagedSummaryV1 struct {
	// NewImages is the number of new images (digests) that were produced by this patchset by
	// non-ignored traces and not seen on the primary branch.
	NewImages int `json:"new_images"`
	// NewUntriagedImages is the number of NewImages which are still untriaged. It is less than or
	// equal to NewImages.
	NewUntriagedImages int `json:"new_untriaged_images"`
	// TotalUntriagedImages is the number of images produced by this patchset by non-ignored traces
	// that are untriaged. This includes images that are untriaged and observed on the primary
	// branch (i.e. might not be the fault of this CL/PS). It is greater than or equal to
	// NewUntriagedImages.
	TotalUntriagedImages int `json:"total_untriaged_images"`
	// PatchsetID is the nonqualified id of the patchset. This is usually a git hash.
	PatchsetID string `json:"patchset_id"`
	// PatchsetOrder is represents the chronological order the patchsets are in. It starts at 1.
	PatchsetOrder int `json:"patchset_order"`
}

PatchsetNewAndUntriagedSummaryV1 is the summary for a specific PS. It focuses on the untriaged and new images produced.

type PositiveDigestsByGroupingIDResponse 

type PositiveDigestsByGroupingIDResponse struct {
	// GroupingID is the hex encoded MD5 hash of GroupingKeys
	GroupingID string `json:"grouping_id"`
	// GroupingKeys are the key/value pairs that define a grouping. By default this is the
	// corpus (called source_type for historical reasons) and name (i.e. the test name).
	GroupingKeys paramtools.Params `json:"grouping_keys"`
	// Traces contains all positive digests seen on a given trace which has the grouping GroupingID.
	Traces []PositiveDigestsTraceInfo `json:"traces"`
}

type PositiveDigestsTraceInfo 

type PositiveDigestsTraceInfo struct {
	TraceID         string         `json:"trace_id"`
	PositiveDigests []types.Digest `json:"digests"`
}

type RefClosest 

type RefClosest string

RefClosest is effectively an enum of two values - positive/negative.

type SRDiffDigest 

type SRDiffDigest struct {
	// NumDiffPixels is the absolute number of pixels that are different.
	NumDiffPixels int `json:"numDiffPixels"`

	// CombinedMetric is a value in [0, 10] that represents how large the diff is between two
	// images. It is based off the MaxRGBADiffs and PixelDiffPercent.
	CombinedMetric float32 `json:"combinedMetric"`

	// PixelDiffPercent is the percentage of pixels that are different.
	PixelDiffPercent float32 `json:"pixelDiffPercent"`

	// MaxRGBADiffs contains the maximum difference of each channel.
	MaxRGBADiffs [4]int `json:"maxRGBADiffs"`

	// One of CombinedMetric, PixelDiffPercent, or NumDiffPixels depending on the requested
	// metric name (see query.go). Used internally in search.
	QueryMetric float32 `json:"-"`

	// DimDiffer is true if the dimensions between the two images are different.
	DimDiffer bool `json:"dimDiffer"`

	// Digest identifies which image we are comparing the primary digest to. Put another way, what
	// is the image on the right side of the comparison.
	Digest types.Digest `json:"digest"`
	// Status represents the expectation.Label for this digest.
	Status expectations.Label `json:"status"`
	// ParamSet is all of the params of all traces that produce this digest (the digest on the right).
	// It is for frontend UI presentation only; essentially a word cloud of what drew the primary
	// digest.
	ParamSet paramtools.ParamSet `json:"paramset"`
	// TODO(kjlubick) make use of these instead of the combined ParamSet.
	TracesKeys    paramtools.ParamSet `json:"-"`
	TracesOptions paramtools.ParamSet `json:"-"`
}

SRDiffDigest captures the diff information between a primary digest and the digest given here. The primary digest is generally shown on the left in the frontend UI, and the data here represents a digest on the right that the primary digest is being compared to.

type SearchResponse 

type SearchResponse struct {
	Results []*SearchResult `json:"digests"`
	// Offset is the offset of the digest into the total list of digests.
	Offset int `json:"offset"`
	// Size is the total number of Digests that match the current query.
	Size    int      `json:"size"`
	Commits []Commit `json:"commits"`
	// BulkTriageDeltaInfos contains an entry for each digest that matches the query. Each item
	// contains the information necessary to create a TriageDelta that can be used in a bulk triage
	// operation.
	BulkTriageDeltaInfos []BulkTriageDeltaInfo `json:"bulk_triage_delta_infos" go2ts:"ignorenil"`
}

SearchResponse is the structure returned by the Search(...) function of SearchAPI and intended to be returned as JSON in an HTTP response.

type SearchResult 

type SearchResult struct {
	// Digest is the primary digest to which the rest of the data in this struct belongs.
	Digest types.Digest `json:"digest"`
	// Test is the name of the test that produced the primary digest. This is needed because
	// we might have a case where, for example, a blank 100x100 image is correct for one test,
	// but not for another test and we need to distinguish between the two cases.
	Test types.TestName `json:"test"`
	// Status is positive, negative, or untriaged. This is also known as the expectation for the
	// primary digest (for Test).
	Status expectations.Label `json:"status"`
	// TriageHistory is a history of all the times the primary digest has been retriaged for the
	// given Test.
	// TODO(kjlubick) make this be just the most recent event and add the history for
	//   the right digests.
	TriageHistory []TriageHistory `json:"triage_history"`
	// ParamSet is all the keys and options of all traces that produce the primary digest and
	// match the given search constraints. It is for frontend UI presentation only; essentially a
	// word cloud of what drew the primary digest.
	ParamSet paramtools.ParamSet `json:"paramset"`
	// TODO(kjlubick) make use of these instead of the combined ParamSet.
	TracesKeys    paramtools.ParamSet `json:"-"`
	TracesOptions paramtools.ParamSet `json:"-"`
	// TraceGroup represents all traces that produced this digest at least once in the sliding window
	// of commits.
	TraceGroup TraceGroup `json:"traces"`
	// RefDiffs are comparisons of the primary digest to other digests in Test. As an example, the
	// closest digest (closest being defined as least different) also triaged positive is usually
	// in here (unless there are no other positive digests).
	// TODO(kjlubick) map is confusing because it's just 2 things. Use struct instead.
	RefDiffs map[RefClosest]*SRDiffDigest `json:"refDiffs"`
	// ClosestRef labels the reference from RefDiffs that is the absolute closest to the primary
	// digest.
	ClosestRef RefClosest `json:"closestRef"` // "pos" or "neg"
}

SearchResult is a single digest produced by one or more traces for a given test.

type TestRollup 

type TestRollup struct {
	Grouping     paramtools.Params `json:"grouping"`
	Num          int               `json:"num"`
	SampleDigest types.Digest      `json:"sample_digest"`
}

type TestSummary 

type TestSummary struct {
	Grouping         paramtools.Params `json:"grouping"`
	PositiveDigests  int               `json:"positive_digests"`
	NegativeDigests  int               `json:"negative_digests"`
	UntriagedDigests int               `json:"untriaged_digests"`
	TotalDigests     int               `json:"total_digests"`
}

TestSummary summarizes the digest count for a given test (and a series of search params).

type Trace 

type Trace struct {
	// The id of the trace. Keep the json as label to be compatible with dots-sk.
	ID tiling.TraceID `json:"label"`
	// RawTrace is meant to be used to hold the raw trace (that is, the tiling.Trace which has not yet
	// been converted for frontend display) until all the raw traces for a given
	// TraceGroup can be converted to the frontend representation. The conversion process needs to be
	// done once all the RawTraces are available so the digest indices can be in agreement for a given
	// TraceGroup. It is not meant to be exposed to the frontend in its raw form.
	RawTrace *tiling.Trace `json:"-"`
	// DigestIndices represents the index of the digest that was part of the trace. -1 means we did
	// not get a digest at this commit. There is one entry per commit. DigestIndices[0] is the oldest
	// commit in the trace, DigestIndices[N-1] is the most recent. The index here matches up with
	// the Digests in the parent TraceGroup.
	DigestIndices []int `json:"data"`
	// Params are the key/value pairs that describe this trace.
	Params map[string]string `json:"params"`
	// TODO(kjlubick) Use these split values instead of the combined one.
	Keys    map[string]string `json:"-"`
	Options map[string]string `json:"-"`
	// CommentIndices are indices into the TraceComments slice on the final result. For example,
	// a 1 means the second TraceComment in the top level TraceComments applies to this trace.
	CommentIndices []int `json:"comment_indices"`
}

Trace describes a single trace, used in TraceGroup.

type TraceGroup 

type TraceGroup struct {
	// Traces represents all traces in the TraceGroup. All of these traces have the primary digest.
	Traces []Trace `json:"traces"`
	// Digests represents the triage status of the primary digest and the first N-1 digests that
	// appear in Traces, starting at head on the first trace. N is search.maxDistinctDigestsToPresent.
	Digests []DigestStatus `json:"digests"`
	// TotalDigests is the count of all unique digests in the set of Traces. This number can
	// exceed search.maxDistinctDigestsToPresent.
	TotalDigests int `json:"total_digests"`
}

TraceGroup is info about a group of traces. The concrete use of TraceGroup is to represent all traces that draw a given digest (known below as the "primary digest") for a given test.

type TriageConflict 

type TriageConflict struct {
	Grouping            paramtools.Params  `json:"grouping"`
	Digest              types.Digest       `json:"digest"`
	ExpectedLabelBefore expectations.Label `json:"expected_label_before"`
	ActualLabelBefore   expectations.Label `json:"actual_label_before"`
}

TriageConflict contains information about a conflicting triage action. A conflict occurs when two or more try to triage the same digest at roughly the same time.

type TriageDelta 

type TriageDelta struct {
	Grouping    paramtools.Params  `json:"grouping"`
	Digest      types.Digest       `json:"digest"`
	LabelBefore expectations.Label `json:"label_before"`
	LabelAfter  expectations.Label `json:"label_after"`
}

TriageDelta represents one changed digest and the label that was assigned as part of the triage operation.

type TriageHistory 

type TriageHistory struct {
	User string    `json:"user"`
	TS   time.Time `json:"ts"`
}

TriageHistory represents who last triaged a certain digest for a certain test.

type TriageLogEntry 

type TriageLogEntry struct {
	ID      string        `json:"id"`
	User    string        `json:"name"`
	TS      int64         `json:"ts"` // is milliseconds since the epoch
	Details []TriageDelta `json:"details" go2ts:"ignorenil"`
}

TriageLogEntry represents a set of changes by a single person.

type TriageLogResponse 

type TriageLogResponse struct {
	httputils.ResponsePagination
	Entries []TriageLogEntry `json:"entries" go2ts:"ignorenil"`
}

TriageLogResponse is the response for /json/v2/triagelog.

type TriageRequestDataV2 

type TriageRequestDataV2 map[types.TestName]map[types.Digest]expectations.Label

TriageRequestDataV2 contains the digests in a TriageRequest and their desired labels.

type TriageRequestV2 

type TriageRequestV2 struct {
	// TestDigestStatus maps status to test name and digests. The strings are
	// expectation.Label.String() values
	TestDigestStatus TriageRequestDataV2 `json:"testDigestStatus" go2ts:"ignorenil"`

	// ChangelistID is the id of the Changelist for which we want to change the expectations.
	ChangelistID string `json:"changelist_id"`

	// CodeReviewSystem is the id of the crs that the ChangelistID belongs. If ChangelistID is set,
	// CodeReviewSystem should be also.
	CodeReviewSystem string `json:"crs"`

	// ImageMatchingAlgorithm is the name of the non-exact image matching algorithm requesting the
	// triage (see http://go/gold-non-exact-matching). If set, the algorithm name will be used as
	// the author of the triage action.
	//
	// An empty image matching algorithm indicates this is a manual triage operation, in which case
	// the username that initiated the triage operation via Gold's UI will be used as the author of
	// the operation.
	ImageMatchingAlgorithm string `json:"imageMatchingAlgorithm,omitempty"`
}

TriageRequestV2 is the form of the JSON posted by the frontend when triaging (both single and bulk).

type TriageRequestV3 

type TriageRequestV3 struct {
	// Deltas is the list of triage deltas to apply.
	//
	// When triaging from Gold's UI, this will be a slice of length 1 if the user clicks on a
	// triage button for a specific digest, or of any length for bulk triage operations.
	Deltas []TriageDelta `json:"deltas" go2ts:"ignorenil"`

	// ChangelistID is the ID of the Changelist for which we want to change the expectations.
	ChangelistID string `json:"changelist_id,omitempty"`

	// CodeReviewSystem is the ID of the CRS that the ChangelistID belongs. If ChangelistID is set,
	// CodeReviewSystem should be also.
	CodeReviewSystem string `json:"crs,omitempty"`

	// ImageMatchingAlgorithm is the name of the non-exact image matching algorithm requesting the
	// triage (see http://go/gold-non-exact-matching). If set, the algorithm name will be used as
	// the author of the triage action.
	//
	// An empty image matching algorithm indicates this is a manual triage operation, in which case
	// the username that initiated the triage operation via Gold's UI will be used as the author of
	// the operation.
	ImageMatchingAlgorithm string `json:"image_matching_algorithm,omitempty"`
}

TriageRequestV3 is the form of the JSON posted by the frontend when triaging (both single and bulk).

type TriageResponse 

type TriageResponse struct {
	Status   TriageResponseStatus `json:"status"`
	Conflict TriageConflict       `json:"conflict,omitempty"`
}

TriageResponse is the response for the /json/v3/triage RPC.

type TriageResponseStatus 

type TriageResponseStatus string

TriageResponseStatus is the status of a TriageResponse.

type TryJob 

type TryJob struct {
	SystemID    string    `json:"id"`
	DisplayName string    `json:"name"`
	Updated     time.Time `json:"updated"`
	System      string    `json:"system"`
	URL         string    `json:"url"`
}

TryJob represents the data the frontend needs for TryJobs.

type UntriagedDigestList 

type UntriagedDigestList struct {
	Digests []types.Digest `json:"digests"`

	// Corpora is filed with the strings representing a corpus that has one or more Digests belong
	// to it. In other words, it summarizes where the Digests come from.
	Corpora []string `json:"corpora"`

	// TS is the time that this data was created. It might be served from a cache, so this time will
	// not necessarily be "now".
	TS time.Time `json:"ts"`
}

UntriagedDigestList represents multiple digests that are untriaged for a given query.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.