Skip to content

feat(stovepipe): Add status lookup contract #718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
prathshenoy wants to merge 1 commit into from
+515 −57
Open

feat(stovepipe): Add status lookup contract #718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions api/stovepipe/proto/stovepipe.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,52 @@ message GetRequestHistoryByURIResponse {
repeated RequestHistory histories = 1;
}

// GetProjectStatusByURIRequest selects the validation status for an exact commit URI.
message GetProjectStatusByURIRequest {
// Logical queue containing the validation request.
string queue = 1;
// Exact VCS-agnostic URI of the commit under validation.
string change_uri = 2;
// Required consumer-defined project IDs whose recorded results are requested.
repeated string projects = 3;
// Maximum projects to return when projects is empty. Zero selects the server default.
int32 page_size = 4;
// Opaque continuation token for full project-result pagination when projects is empty.
string page_token = 5;
}

// ProjectValidation contains one reported project and its recorded result, if any.
message ProjectValidation {
// Stable consumer-defined project identifier.
string project = 1;
// Breakage degree on [0.0, 1.0]. Zero is green; absence means no result is recorded yet.
optional double breakage_degree = 2;
}

// GetProjectStatusByURIResponse contains the selected validation's current projection.
message GetProjectStatusByURIResponse {
// Globally unique identifier of the validation request.
string request_id = 1;
// Logical queue containing the validation request.
string queue = 2;
// VCS-agnostic URI of the commit under validation.
string change_uri = 3;
// Baseline URI for incremental validation. Empty for a full build.
string base_uri = 4;
// Stable public lifecycle state of the validation request.
string request_state = 5;
// Unix millisecond timestamp of the newest durable lifecycle or result record.
int64 updated_at_ms = 10;
// Whole-repository breakage degree. Absent until the result is durable.
optional double repository_breakage_degree = 6;
// True after the implementation has durably finished producing relevant project results.
bool project_results_complete = 7;
// Recorded results for requested projects, or one full-result page when none are requested.
repeated ProjectValidation projects = 8;
// Opaque continuation token for another full-result page. Empty on the final page.
string next_page_token = 9;
}

// Stovepipe provides the Stovepipe API.
service Stovepipe {
// Ping returns a response indicating the service is alive
Expand All @@ -118,4 +164,6 @@ service Stovepipe {
rpc GetRequestHistoryByID(GetRequestHistoryByIDRequest) returns (GetRequestHistoryByIDResponse) {}
// GetRequestHistoryByURI returns retained histories for an exact commit URI.
rpc GetRequestHistoryByURI(GetRequestHistoryByURIRequest) returns (GetRequestHistoryByURIResponse) {}
// GetProjectStatusByURI returns the current validation status for an exact commit URI.
rpc GetProjectStatusByURI(GetProjectStatusByURIRequest) returns (GetProjectStatusByURIResponse) {}
}
Loading
Loading