STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Don't deduplicate checks that stem from different events (#7618)

Browse source
This commit is contained in:
Sam Coe 2023-06-27 09:12:52 +09:00 • committed by GitHub
parent c4e648a8ea
commit d46f47e430
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 183 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

27
api/queries_pr.go
View file

@ -183,16 +183,10 @@ type CheckContexts struct {
}
type CheckContext struct {
TypeName string `json:"__typename"`
Name string `json:"name"`
IsRequired bool `json:"isRequired"`
CheckSuite struct {
WorkflowRun struct {
Workflow struct {
Name string `json:"name"`
} `json:"workflow"`
} `json:"workflowRun"`
} `json:"checkSuite"`
TypeName string `json:"__typename"`
Name string `json:"name"`
IsRequired bool `json:"isRequired"`
CheckSuite CheckSuite `json:"checkSuite"`
// QUEUED IN_PROGRESS COMPLETED WAITING PENDING REQUESTED
Status string `json:"status"`
// ACTION_REQUIRED TIMED_OUT CANCELLED FAILURE SUCCESS NEUTRAL SKIPPED STARTUP_FAILURE STALE
@ -210,6 +204,19 @@ type CheckContext struct {
CreatedAt time.Time `json:"createdAt"`
}
type CheckSuite struct {
WorkflowRun WorkflowRun `json:"workflowRun"`
}
type WorkflowRun struct {
Event string `json:"event"`
Workflow Workflow `json:"workflow"`
}
type Workflow struct {
Name string `json:"name"`
}
type PRRepository struct {
ID string `json:"id"`
Name string `json:"name"`

2
api/query_builder.go
View file

@ -226,7 +226,7 @@ func RequiredStatusCheckRollupGraphQL(prID, after string) string {
},
...on CheckRun {
name,
checkSuite{workflowRun{workflow{name}}},
checkSuite{workflowRun{event,workflow{name}}},
status,
conclusion,
startedAt,

7
pkg/cmd/pr/checks/aggregate.go
View file

@ -15,6 +15,8 @@ type check struct {
CompletedAt time.Time `json:"completedAt"`
Link string `json:"link"`
Bucket string `json:"bucket"`
Event string `json:"event"`
Workflow string `json:"workflow"`
}
type checkCounts struct {
@ -55,7 +57,10 @@ func aggregateChecks(checkContexts []api.CheckContext, requiredChecks bool) (che
StartedAt: c.StartedAt,
CompletedAt: c.CompletedAt,
Link: link,
Event: c.CheckSuite.WorkflowRun.Event,
Workflow: c.CheckSuite.WorkflowRun.Workflow.Name,
}
switch state {
case "SUCCESS":
item.Bucket = "pass"
@ -91,7 +96,7 @@ func eliminateDuplicates(checkContexts []api.CheckContext) []api.CheckContext {
}
mapContexts[ctx.Context] = struct{}{}
} else {
key := fmt.Sprintf("%s/%s", ctx.Name, ctx.CheckSuite.WorkflowRun.Workflow.Name)
key := fmt.Sprintf("%s/%s/%s", ctx.Name, ctx.CheckSuite.WorkflowRun.Workflow.Name, ctx.CheckSuite.WorkflowRun.Event)
if _, exists := mapChecks[key]; exists {
continue
}

150
pkg/cmd/pr/checks/checks_test.go
View file

@ -610,6 +610,156 @@ func TestEliminateDuplicates(t *testing.T) {
},
},
},
{
name: "unique workflow name",
checkContexts: []api.CheckContext{
{
TypeName: "CheckRun",
Name: "build (ubuntu-latest)",
Status: "COMPLETED",
Conclusion: "SUCCESS",
StartedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
CompletedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
DetailsURL: "https://github.com/cli/cli/runs/1",
CheckSuite: api.CheckSuite{
WorkflowRun: api.WorkflowRun{
Event: "push",
Workflow: api.Workflow{
Name: "some builds",
},
},
},
},
{
TypeName: "CheckRun",
Name: "build (ubuntu-latest)",
Status: "COMPLETED",
Conclusion: "SUCCESS",
StartedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
CompletedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
DetailsURL: "https://github.com/cli/cli/runs/2",
CheckSuite: api.CheckSuite{
WorkflowRun: api.WorkflowRun{
Event: "push",
Workflow: api.Workflow{
Name: "some other builds",
},
},
},
},
},
want: []api.CheckContext{
{
TypeName: "CheckRun",
Name: "build (ubuntu-latest)",
Status: "COMPLETED",
Conclusion: "SUCCESS",
StartedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
CompletedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
DetailsURL: "https://github.com/cli/cli/runs/1",
CheckSuite: api.CheckSuite{
WorkflowRun: api.WorkflowRun{
Event: "push",
Workflow: api.Workflow{
Name: "some builds",
},
},
},
},
{
TypeName: "CheckRun",
Name: "build (ubuntu-latest)",
Status: "COMPLETED",
Conclusion: "SUCCESS",
StartedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
CompletedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
DetailsURL: "https://github.com/cli/cli/runs/2",
CheckSuite: api.CheckSuite{
WorkflowRun: api.WorkflowRun{
Event: "push",
Workflow: api.Workflow{
Name: "some other builds",
},
},
},
},
},
},
{
name: "unique workflow run event",
checkContexts: []api.CheckContext{
{
TypeName: "CheckRun",
Name: "build (ubuntu-latest)",
Status: "COMPLETED",
Conclusion: "SUCCESS",
StartedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
CompletedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
DetailsURL: "https://github.com/cli/cli/runs/1",
CheckSuite: api.CheckSuite{
WorkflowRun: api.WorkflowRun{
Event: "push",
Workflow: api.Workflow{
Name: "builds",
},
},
},
},
{
TypeName: "CheckRun",
Name: "build (ubuntu-latest)",
Status: "COMPLETED",
Conclusion: "SUCCESS",
StartedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
CompletedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
DetailsURL: "https://github.com/cli/cli/runs/2",
CheckSuite: api.CheckSuite{
WorkflowRun: api.WorkflowRun{
Event: "pull_request",
Workflow: api.Workflow{
Name: "builds",
},
},
},
},
},
want: []api.CheckContext{
{
TypeName: "CheckRun",
Name: "build (ubuntu-latest)",
Status: "COMPLETED",
Conclusion: "SUCCESS",
StartedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
CompletedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
DetailsURL: "https://github.com/cli/cli/runs/1",
CheckSuite: api.CheckSuite{
WorkflowRun: api.WorkflowRun{
Event: "push",
Workflow: api.Workflow{
Name: "builds",
},
},
},
},
{
TypeName: "CheckRun",
Name: "build (ubuntu-latest)",
Status: "COMPLETED",
Conclusion: "SUCCESS",
StartedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
CompletedAt: time.Date(2022, 1, 1, 1, 1, 1, 1, time.UTC),
DetailsURL: "https://github.com/cli/cli/runs/2",
CheckSuite: api.CheckSuite{
WorkflowRun: api.WorkflowRun{
Event: "pull_request",
Workflow: api.Workflow{
Name: "builds",
},
},
},
},
},
},
}
for _, tt := range tests {

10
pkg/cmd/pr/checks/output.go
View file

@ -34,8 +34,16 @@ func addRow(tp utils.TablePrinter, io *iostreams.IOStreams, o check) {
}
if io.IsStdoutTTY() {
var name string
if o.Workflow != "" {
name += fmt.Sprintf("%s/", o.Workflow)
}
name += o.Name
if o.Event != "" {
name += fmt.Sprintf(" (%s)", o.Event)
}
tp.AddField(mark, nil, markColor)
tp.AddField(o.Name, nil, nil)
tp.AddField(name, nil, nil)
tp.AddField(elapsed, nil, nil)
tp.AddField(o.Link, nil, nil)
} else {