-
Notifications
You must be signed in to change notification settings - Fork 27
/
issuetriage.go
789 lines (684 loc) · 25.3 KB
/
issuetriage.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
package issuetriage
import (
"context"
"fmt"
"net/http"
"regexp"
"strings"
"sync"
"time"
githubql "github.com/shurcooL/githubv4"
"github.com/sirupsen/logrus"
tiexternalplugins "github.com/ti-community-infra/tichi/internal/pkg/externalplugins"
"github.com/ti-community-infra/tichi/internal/pkg/externalplugins/utils"
utilerrors "k8s.io/apimachinery/pkg/util/errors"
"k8s.io/apimachinery/pkg/util/json"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/test-infra/prow/config"
"k8s.io/test-infra/prow/github"
"k8s.io/test-infra/prow/pluginhelp"
"k8s.io/test-infra/prow/pluginhelp/externalplugins"
"k8s.io/test-infra/prow/plugins"
)
const PluginName = "ti-community-issue-triage"
const (
typeLabelPrefix = "type/"
bugTypeLabel = "type/bug"
severityLabelPrefix = "severity/"
majorSeverityLabel = "severity/major"
criticalSeverityLabel = "severity/critical"
maxStatusDescriptionLength = 140
)
const (
issueNeedTriagedContextName = "check-issue-triage-complete"
statusDescAllBugIssueTriaged = "All linked bug issues have been triaged complete."
statusDescNoLinkedIssue = "No linked issue found."
statusDescFailedToGetIssue = "Failed to get issue %s/%s#%d."
statusDescTypeLabelNotFound = "Can not find any type label on issue %s/%s#%d."
statusDescSeverityLabelNotFound = "Can not find any severity label on bug issue %s/%s#%d."
statusDescMayAffectsLabelBeFound = "Found may-affects label on bug issue %s/%s#%d."
)
var (
IssueNumberLineRe = regexp.MustCompile("(?im)^Issue Number:.+")
checkIssueTriagedRe = regexp.MustCompile(`(?mi)^/(run-)?check-issue-triage-complete\s*$`)
)
type githubClient interface {
AddLabel(org, repo string, number int, label string) error
AddLabels(org, repo string, number int, labels ...string) error
RemoveLabel(org, repo string, number int, label string) error
CreateStatus(owner, repo, ref string, status github.Status) error
CreateComment(owner, repo string, number int, comment string) error
GetIssue(org, repo string, number int) (*github.Issue, error)
GetPullRequest(org, repo string, number int) (*github.PullRequest, error)
GetCombinedStatus(org, repo, ref string) (*github.CombinedStatus, error)
BotUserChecker() (func(candidate string) bool, error)
QueryWithGitHubAppsSupport(ctx context.Context, q interface{}, vars map[string]interface{}, org string) error
}
type referencePullRequestQuery struct {
Repository queryRepository `graphql:"repository(owner: $org, name: $repo)"`
RateLimit rateLimit
}
type queryRepository struct {
Issue issue `graphql:"issue(number: $issueNumber)"`
}
type issue struct {
TimelineItems timelineItems `graphql:"timelineItems(first: 10, itemTypes: [CROSS_REFERENCED_EVENT])"`
}
type rateLimit struct {
Cost githubql.Int
Remaining githubql.Int
}
type timelineItems struct {
Nodes []timelineItemNode
}
type timelineItemNode struct {
CrossReferencedEvent crossReferencedEvent `graphql:"... on CrossReferencedEvent"`
}
type crossReferencedEvent struct {
Source crossReferencedEventSource
WillCloseTarget githubql.Boolean
}
type crossReferencedEventSource struct {
PullRequest pullRequest `graphql:"... on PullRequest"`
}
// See: https://developer.github.com/v4/object/pullrequest/.
type pullRequest struct {
Number githubql.Int
Repository repository
State githubql.String
Author struct {
Login githubql.String
}
BaseRefName githubql.String
HeadRefOid githubql.String
Labels struct {
Nodes []struct {
Name githubql.String
}
} `graphql:"labels(first:20)"`
Body githubql.String
}
type repository struct {
Name githubql.String
Owner struct {
Login githubql.String
}
DefaultBranchRef struct {
Name githubql.String
}
}
type issueCache map[string]*github.Issue
// HelpProvider constructs the PluginHelp for this plugin that takes into account enabled repositories.
// HelpProvider defines the type for function that construct the PluginHelp for plugins.
func HelpProvider(epa *tiexternalplugins.ConfigAgent) externalplugins.ExternalPluginHelpProvider {
return func(enabledRepos []config.OrgRepo) (*pluginhelp.PluginHelp, error) {
configInfo := map[string]string{}
cfg := epa.Config()
for _, repo := range enabledRepos {
opts := cfg.IssueTriageFor(repo.Org, repo.Repo)
var configInfoStrings []string
configInfoStrings = append(configInfoStrings, "The plugin has these configurations:<ul>")
if len(opts.AffectsLabelPrefix) != 0 {
configInfoStrings = append(configInfoStrings,
fmt.Sprintf("<li>The affects label prefix is: %s</li>", opts.AffectsLabelPrefix))
}
if len(opts.MayAffectsLabelPrefix) != 0 {
configInfoStrings = append(configInfoStrings,
fmt.Sprintf("<li>The may affects label prefix is: %s</li>", opts.MayAffectsLabelPrefix))
}
if len(opts.NeedTriagedLabel) != 0 {
configInfoStrings = append(configInfoStrings,
fmt.Sprintf("<li>The need triaged label prefix is: %s</li>", opts.NeedTriagedLabel))
}
if len(opts.NeedCherryPickLabelPrefix) != 0 {
configInfoStrings = append(configInfoStrings,
fmt.Sprintf("<li>The need cherry-pick label prefix is: %s</li>", opts.NeedCherryPickLabelPrefix))
}
if len(opts.StatusTargetURL) != 0 {
configInfoStrings = append(
configInfoStrings,
fmt.Sprintf("<li>The status details will be targeted to: <a href=\"%s\">Link</a></li>",
opts.StatusTargetURL),
)
}
if len(opts.MaintainVersions) != 0 {
var versionConfigStrings []string
versionConfigStrings = append(versionConfigStrings,
"The release branches that the current repository is maintaining: ")
versionConfigStrings = append(versionConfigStrings, "<ul>")
for _, version := range opts.MaintainVersions {
versionConfigStrings = append(versionConfigStrings, fmt.Sprintf("<li>%s</li>", version))
}
versionConfigStrings = append(versionConfigStrings, "</ul>")
configInfoStrings = append(configInfoStrings, strings.Join(versionConfigStrings, "\n"))
}
if len(opts.WontfixVersions) != 0 {
wontFixStrings := []string{"The release branches won't fix in the current repository: ", "<ul>"}
for _, version := range opts.WontfixVersions {
wontFixStrings = append(wontFixStrings, fmt.Sprintf("<li>%s</li>", version))
}
wontFixStrings = append(wontFixStrings, "</ul>")
configInfoStrings = append(configInfoStrings, strings.Join(wontFixStrings, "\n"))
}
configInfo[repo.String()] = strings.Join(configInfoStrings, "\n")
}
yamlSnippet, err := plugins.CommentMap.GenYaml(&tiexternalplugins.Configuration{
TiCommunityIssueTriage: []tiexternalplugins.TiCommunityIssueTriage{
{
Repos: []string{"ti-community-infra/test-dev"},
WontfixVersions: []string{"5.0", "6.0"},
MaintainVersions: []string{"5.1", "5.2", "5.3"},
AffectsLabelPrefix: "affects/",
MayAffectsLabelPrefix: "may-affects/",
NeedTriagedLabel: "do-not-merge/needs-triage-completed",
NeedCherryPickLabelPrefix: "needs-cherry-pick-release-",
StatusTargetURL: "https://book.prow.tidb.net/#/plugins/issue-triage",
},
},
})
if err != nil {
logrus.WithError(err).Warnf("cannot generate comments for %s plugin", PluginName)
}
pluginHelp := &pluginhelp.PluginHelp{
Description: fmt.Sprintf("The %s plugin", PluginName),
Config: configInfo,
Snippet: yamlSnippet,
Commands: []pluginhelp.Command{
{
Usage: "/[run-]check-issue-triage-complete",
Examples: []string{
"/run-check-issue-triage-complete",
"/check-issue-triage-complete",
},
Description: "Forces rechecking of the check-issue-triage-complete status.",
WhoCanUse: "Anyone",
},
},
Events: []string{
tiexternalplugins.PullRequestEvent,
},
}
return pluginHelp, nil
}
}
// Server implements http.Handler. It validates incoming GitHub webhooks and
// then dispatches them to the appropriate plugins.
type Server struct {
WebhookSecretGenerator func() []byte
GitHubTokenGenerator func() []byte
GitHubClient githubClient
ConfigAgent *tiexternalplugins.ConfigAgent
mapLock sync.Mutex
lockMap map[checkRequest]*sync.Mutex
}
type checkRequest struct {
org string
repo string
pr int
}
func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
eventType, eventGUID, payload, ok, _ := github.ValidateWebhook(w, r, s.WebhookSecretGenerator)
if !ok {
return
}
if err := s.handleEvent(eventType, eventGUID, payload); err != nil {
logrus.WithError(err).Error("Error parsing event.")
}
}
// handleEvent distributed events and handles them.
func (s *Server) handleEvent(eventType, eventGUID string, payload []byte) error {
l := logrus.WithFields(
logrus.Fields{
"event-type": eventType,
github.EventGUID: eventGUID,
},
)
switch eventType {
case tiexternalplugins.PullRequestEvent:
var pe github.PullRequestEvent
if err := json.Unmarshal(payload, &pe); err != nil {
return err
}
go func() {
if err := s.handlePullRequestEvent(&pe, l); err != nil {
l.WithError(err).Info("Error handling event.")
}
}()
case tiexternalplugins.IssuesEvent:
var ie github.IssueEvent
if err := json.Unmarshal(payload, &ie); err != nil {
return err
}
go func() {
if err := s.handleIssueEvent(&ie, l); err != nil {
l.WithError(err).Info("Error handling event.")
}
}()
case tiexternalplugins.IssueCommentEvent:
var ice github.IssueCommentEvent
if err := json.Unmarshal(payload, &ice); err != nil {
return err
}
go func() {
if err := s.handleIssueCommentEvent(&ice, l); err != nil {
l.WithError(err).Info("Error handling event.")
}
}()
default:
l.Debugf("received an event of type %q but didn't ask for it", eventType)
}
return nil
}
//nolint:gocritic
func (s *Server) handleIssueEvent(ie *github.IssueEvent, log *logrus.Entry) error {
org := ie.Repo.Owner.Login
repo := ie.Repo.Name
num := ie.Issue.Number
log = log.WithFields(logrus.Fields{
"org": org,
"repo": repo,
"num": num,
})
// Notice: When we check out a new release-x.y branch, the release management tool will add affects-x.y labels
// to bug issues in batches. At this time, a large number of requests will be generated. We need to handle
// labeled events very carefully to avoid it consumes too many API points.
if ie.Action != github.IssueActionLabeled && ie.Action != github.IssueActionUnlabeled {
log.Debug("Skipping because not a labeled / unlabeled action.")
return nil
}
cfg := s.ConfigAgent.Config().IssueTriageFor(org, repo)
newLabel := ie.Label.Name
existedLabels := sets.String{}
for _, label := range ie.Issue.Labels {
existedLabels.Insert(label.Name)
}
if !existedLabels.Has(bugTypeLabel) {
log.Debug("Skipping because not a type/bug issue.")
return nil
}
if ie.Action == github.IssueActionLabeled && (newLabel == majorSeverityLabel || newLabel == criticalSeverityLabel) {
// Add may-affects labels when major or critical severity label was added.
labelsNeedToAdd := sets.String{}
for _, version := range cfg.MaintainVersions {
affectVersionLabel := cfg.AffectsLabelPrefix + version
mayAffectVersionLabel := cfg.MayAffectsLabelPrefix + version
if !existedLabels.HasAny(affectVersionLabel, mayAffectVersionLabel) {
labelsNeedToAdd.Insert(mayAffectVersionLabel)
}
}
if labelsNeedToAdd.Len() > 0 {
return s.GitHubClient.AddLabels(org, repo, num, labelsNeedToAdd.List()...)
}
} else if ie.Action == github.IssueActionLabeled && strings.HasPrefix(newLabel, cfg.AffectsLabelPrefix) {
// Remove the may-affects label when the affects label was added.
version := strings.TrimPrefix(newLabel, cfg.AffectsLabelPrefix)
mayAffectsVersionLabel := cfg.MayAffectsLabelPrefix + version
if existedLabels.Has(mayAffectsVersionLabel) {
return s.GitHubClient.RemoveLabel(org, repo, num, mayAffectsVersionLabel)
}
} else if strings.HasPrefix(newLabel, cfg.MayAffectsLabelPrefix) {
// Rerun the issue triage complete checker when may-affects label was removed.
prs, err := s.getReferencePRList(log, org, repo, num)
if err != nil {
return err
}
if len(prs) == 0 {
log.Infof("Can not find any reference PRs.")
return nil
}
log.Infof("Found %d reference PRs.", len(prs))
// Notice: wait a few seconds to reduce API consumption in case of batched label operations.
time.Sleep(5 * time.Second)
issue, err := s.GitHubClient.GetIssue(org, repo, num)
if err != nil {
return err
}
issues := make(issueCache)
key := fmt.Sprintf("%s/%s#%d", org, repo, num)
issues[key] = issue
var errs []error
for _, pr := range prs {
defaultBranch := string(pr.Repository.DefaultBranchRef.Name)
prOrg := string(pr.Repository.Owner.Login)
prRepo := string(pr.Repository.Name)
prNum := int(pr.Number)
prState := string(pr.State)
prSHA := string(pr.HeadRefOid)
prBranch := string(pr.BaseRefName)
log = log.WithFields(logrus.Fields{
"org": prOrg,
"repo": prRepo,
"num": prNum,
})
if !isPRNeedToCheck(prState, prBranch, defaultBranch) {
log.Debugf("Skipping the check, because it is not a open PR on the default branch.")
continue
}
log.Infof("Checking triggered by issue %s/%s#%d.", org, repo, num)
prLabels := sets.NewString()
for _, node := range pr.Labels.Nodes {
prLabels.Insert(string(node.Name))
}
issueNumberLine := IssueNumberLineRe.FindString(string(pr.Body))
linkedIssueNumbers := utils.NormalizeIssueNumbers(issueNumberLine, org, repo)
log.Infof("Found %d linked issues.", len(linkedIssueNumbers))
err := s.handle(log, cfg, prOrg, prRepo, prSHA, prNum, prLabels, linkedIssueNumbers, issues)
if err != nil {
errs = append(errs, err)
}
}
return utilerrors.NewAggregate(errs)
}
return nil
}
func (s *Server) handlePullRequestEvent(pe *github.PullRequestEvent, log *logrus.Entry) error {
if pe.Action != github.PullRequestActionOpened && pe.Action != github.PullRequestActionReopened &&
pe.Action != github.PullRequestActionEdited && pe.Action != github.PullRequestActionSynchronize {
log.Debug("Skipping because not a opened / reopened / edited / synchronize action.")
return nil
}
pr := pe.PullRequest
prOrg := pe.Repo.Owner.Login
prRepo := pe.Repo.Name
prSHA := pr.Head.SHA
prNum := pr.Number
log = log.WithFields(logrus.Fields{
"org": prOrg,
"repo": prRepo,
"num": prNum,
})
if !isPRNeedToCheck(pr.State, pr.Base.Ref, pe.Repo.DefaultBranch) {
log.Debug("Skipping the check, because it is not a open PR on the default branch.")
return nil
}
log.Infof("Checking triggered by PR %s/%s#%d.", prOrg, prRepo, prNum)
prLabels := sets.NewString()
for _, label := range pr.Labels {
prLabels.Insert(label.Name)
}
cfg := s.ConfigAgent.Config().IssueTriageFor(prOrg, prRepo)
issueNumberLine := IssueNumberLineRe.FindString(pr.Body)
linkedIssueNumbers := utils.NormalizeIssueNumbers(issueNumberLine, prOrg, prRepo)
log.Infof("Found %d linked issues.", len(linkedIssueNumbers))
return s.handle(log, cfg, prOrg, prRepo, prSHA, prNum, prLabels, linkedIssueNumbers, issueCache{})
}
func (s *Server) handleIssueCommentEvent(ice *github.IssueCommentEvent, log *logrus.Entry) error {
// Only reacted for pull request in open state.
if ice.Action != github.IssueCommentActionCreated || !ice.Issue.IsPullRequest() {
return nil
}
issue := ice.Issue
comment := ice.Comment.Body
prOrg := ice.Repo.Owner.Login
prRepo := ice.Repo.Name
prNum := issue.Number
log = log.WithFields(logrus.Fields{
"org": prOrg,
"repo": prRepo,
"num": prNum,
"comment_id": ice.Comment.ID,
})
if !checkIssueTriagedRe.MatchString(comment) {
log.Debug("Skipping the check, because no command comment.")
return nil
}
pr, err := s.GitHubClient.GetPullRequest(prOrg, prRepo, prNum)
if err != nil {
return err
}
if !isPRNeedToCheck(pr.State, pr.Base.Ref, ice.Repo.DefaultBranch) {
log.Debug("Skipping the check because it is not a open PR on the default branch.")
return nil
}
log.Infof("Checking triggered by comment %s/%s#%d:%d.", prOrg, prRepo, prNum, ice.Comment.ID)
prSHA := pr.Head.SHA
prLabels := sets.NewString()
for _, label := range pr.Labels {
prLabels.Insert(label.Name)
}
cfg := s.ConfigAgent.Config().IssueTriageFor(prOrg, prRepo)
issueNumberLine := IssueNumberLineRe.FindString(pr.Body)
linkedIssueNumbers := utils.NormalizeIssueNumbers(issueNumberLine, prOrg, prRepo)
log.Infof("Found %d linked issues.", len(linkedIssueNumbers))
return s.handle(log, cfg, prOrg, prRepo, prSHA, prNum, prLabels, linkedIssueNumbers, issueCache{})
}
func (s *Server) handle(log *logrus.Entry, cfg *tiexternalplugins.TiCommunityIssueTriage,
prOrg, prRepo, prSHA string, prNum int, prLabels sets.String,
issueKeys []utils.IssueNumberData, issueCache issueCache) error {
// TODO: need function throttling.
var lock *sync.Mutex
func() {
s.mapLock.Lock()
defer s.mapLock.Unlock()
if _, ok := s.lockMap[checkRequest{prOrg, prRepo, prNum}]; !ok {
if s.lockMap == nil {
s.lockMap = map[checkRequest]*sync.Mutex{}
}
s.lockMap[checkRequest{prOrg, prRepo, prNum}] = &sync.Mutex{}
}
lock = s.lockMap[checkRequest{prOrg, prRepo, prNum}]
}()
lock.Lock()
defer lock.Unlock()
existingStatus, existingDesc, existingURL, err := s.checkExistingStatus(log, prOrg, prRepo, prSHA)
if err != nil {
return err
}
wantStatus, wantDesc, affectsVersionLabels, err := s.checkLinkedIssues(cfg, issueKeys, issueCache)
if err != nil {
return err
}
log.Infof("Checking result: %s, found affects labels: %v", strings.ToLower(wantDesc), affectsVersionLabels)
// Notice: check pass when all the linked issues needed to be triaged have triaged complete,
// if a PR has no linked bug issues, the check will pass too.
if wantStatus == github.StatusSuccess {
// Remove the need triaged label.
if len(cfg.NeedTriagedLabel) != 0 && prLabels.Has(cfg.NeedTriagedLabel) {
err := s.GitHubClient.RemoveLabel(prOrg, prRepo, prNum, cfg.NeedTriagedLabel)
if err != nil {
return err
}
}
// Add needs-cherry-pick label.
if err := s.addCherryPickLabelsToPR(affectsVersionLabels, prLabels, prOrg, prRepo, prNum, cfg); err != nil {
return err
}
} else if wantStatus == github.StatusError || wantStatus == github.StatusFailure {
// Add the need triaged label.
if len(cfg.NeedTriagedLabel) != 0 && !prLabels.Has(cfg.NeedTriagedLabel) {
err := s.GitHubClient.AddLabel(prOrg, prRepo, prNum, cfg.NeedTriagedLabel)
if err != nil {
return err
}
}
}
// Update status.
wantDesc = truncatedStatusDesc(log, wantDesc)
return s.createStatus(log, prOrg, prRepo, prSHA, existingStatus, existingDesc, existingURL,
wantStatus, wantDesc, cfg.StatusTargetURL)
}
func (s *Server) addCherryPickLabelsToPR(
affectsVersionLabels, prLabels sets.String,
org, repo string, num int,
cfg *tiexternalplugins.TiCommunityIssueTriage,
) error {
if affectsVersionLabels.Len() == 0 {
return nil
}
maintainVersions := sets.NewString(cfg.MaintainVersions...)
wontfixVersionSets := sets.NewString(cfg.WontfixVersions...)
labelsNeedToAdd := make([]string, 0)
for _, affectsVersionLabel := range affectsVersionLabels.List() {
affectVersion := strings.TrimPrefix(affectsVersionLabel, cfg.AffectsLabelPrefix)
if wontfixVersionSets.Has(affectVersion) || !maintainVersions.Has(affectVersion) {
continue
}
cherryPickLabel := cfg.NeedCherryPickLabelPrefix + affectVersion
if !prLabels.Has(cherryPickLabel) {
labelsNeedToAdd = append(labelsNeedToAdd, cherryPickLabel)
}
}
if len(labelsNeedToAdd) == 0 {
return nil
}
return s.GitHubClient.AddLabels(org, repo, num, labelsNeedToAdd...)
}
// isPRNeedToCheck used to determine if PR needs to be checked.
// Only open PR on the master branch need to be checked.
func isPRNeedToCheck(state, prBranch, defaultBranch string) bool {
return strings.EqualFold(state, github.PullRequestStateOpen) && strings.EqualFold(prBranch, defaultBranch)
}
// checkLinkedIssues used to check if a given set of bug issues have all been triaged.
func (s *Server) checkLinkedIssues(cfg *tiexternalplugins.TiCommunityIssueTriage,
issueKeys []utils.IssueNumberData, issueCache issueCache) (string, string, sets.String, error) {
affectsVersionLabels := sets.NewString()
if len(issueKeys) == 0 {
return github.StatusSuccess, statusDescNoLinkedIssue, affectsVersionLabels, nil
}
for _, issueKey := range issueKeys {
org := issueKey.Org
repo := issueKey.Repo
num := issueKey.Number
issue, err := s.getIssueWithCache(issueCache, org, repo, num)
if err != nil {
desc := fmt.Sprintf(statusDescFailedToGetIssue, org, repo, num)
return github.StatusFailure, desc, sets.String{}, err
}
labels := sets.NewString()
for _, label := range issue.Labels {
labels.Insert(label.Name)
if strings.HasPrefix(label.Name, cfg.AffectsLabelPrefix) {
affectsVersionLabels.Insert(label.Name)
}
}
// Issue without type label is not triaged.
if !hasAnyTypeLabel(issue) {
desc := fmt.Sprintf(statusDescTypeLabelNotFound, org, repo, num)
return github.StatusError, desc, sets.String{}, nil
}
// Only bug issues need to be checked.
if !labels.Has(bugTypeLabel) {
continue
}
// Bug issue must have severity label, if not, it will be considered to triage.
if !hasAnySeverityLabel(issue) {
desc := fmt.Sprintf(statusDescSeverityLabelNotFound, org, repo, num)
return github.StatusError, desc, sets.String{}, nil
}
// Only major or critical bug issues need to be checked.
if !labels.HasAny(majorSeverityLabel, criticalSeverityLabel) {
continue
}
// Check if issue has any may-affects labels, if any issue have
// not yet been triaged, the checker will fail.
if hasAnyMayAffectsLabel(issue, cfg.MayAffectsLabelPrefix) {
desc := fmt.Sprintf(statusDescMayAffectsLabelBeFound, org, repo, num)
return github.StatusError, desc, sets.String{}, nil
}
}
return github.StatusSuccess, statusDescAllBugIssueTriaged, affectsVersionLabels, nil
}
// checkExistingStatus will retrieve the current status of the linked issue need triaged context
// for the provided SHA.
func (s *Server) checkExistingStatus(l *logrus.Entry, org, repo, sha string) (string, string, string, error) {
combinedStatus, err := s.GitHubClient.GetCombinedStatus(org, repo, sha)
if err != nil {
return "", "", "", fmt.Errorf("error listing pull request combined statuses: %w", err)
}
existingStatus := ""
existingDesc := ""
existingURL := ""
for _, status := range combinedStatus.Statuses {
if status.Context != issueNeedTriagedContextName {
continue
}
existingStatus = status.State
existingDesc = status.Description
existingURL = status.TargetURL
break
}
l.Debugf("Existing linked issue need triaged status context status is %q", existingStatus)
return existingStatus, existingDesc, existingURL, nil
}
func hasAnyTypeLabel(issue *github.Issue) bool {
for _, label := range issue.Labels {
if strings.HasPrefix(label.Name, typeLabelPrefix) {
return true
}
}
return false
}
func hasAnySeverityLabel(issue *github.Issue) bool {
for _, label := range issue.Labels {
if strings.HasPrefix(label.Name, severityLabelPrefix) {
return true
}
}
return false
}
func hasAnyMayAffectsLabel(issue *github.Issue, mayAffectsLabelPrefix string) bool {
for _, label := range issue.Labels {
if strings.HasPrefix(label.Name, mayAffectsLabelPrefix) {
return true
}
}
return false
}
func (s *Server) getIssueWithCache(issues issueCache, org, repo string, num int) (*github.Issue, error) {
key := fmt.Sprintf("%s/%s#%d", org, repo, num)
if issue, ok := issues[key]; ok {
return issue, nil
}
issue, err := s.GitHubClient.GetIssue(org, repo, num)
if err != nil {
return nil, err
}
issues[key] = issue
return issue, nil
}
func (s *Server) getReferencePRList(log *logrus.Entry, org, repo string, issueNumber int) ([]pullRequest, error) {
var query referencePullRequestQuery
vars := map[string]interface{}{
"org": githubql.String(org),
"repo": githubql.String(repo),
"issueNumber": githubql.Int(issueNumber),
}
ctx := context.Background()
if err := s.GitHubClient.QueryWithGitHubAppsSupport(ctx, &query, vars, org); err != nil {
return nil, err
}
totalCost := int(query.RateLimit.Cost)
remaining := int(query.RateLimit.Remaining)
ret := make([]pullRequest, 0)
for _, node := range query.Repository.Issue.TimelineItems.Nodes {
ret = append(ret, node.CrossReferencedEvent.Source.PullRequest)
}
log.Infof("Get reference PR list for issue %s/%s#%d cost %d point(s), %d remaining, found %d.",
org, repo, issueNumber, totalCost, remaining, len(ret))
return ret, nil
}
func (s *Server) createStatus(log *logrus.Entry, org, repo, sha, existingState, existingDesc, existingURL,
wantState, wantDesc, wantURL string) error {
if existingState != wantState || existingDesc != wantDesc || existingURL != wantURL {
log.Debugf("Setting check-issue-triage-complete status context to %s.", wantState)
if err := s.GitHubClient.CreateStatus(org, repo, sha, github.Status{
Context: issueNeedTriagedContextName,
State: wantState,
TargetURL: wantURL,
Description: wantDesc,
}); err != nil {
return fmt.Errorf("error setting pull request status: %w", err)
}
} else {
log.Debugf("The check-issue-triage-complete status context is already %s.", wantState)
}
return nil
}
func truncatedStatusDesc(log *logrus.Entry, wantDesc string) string {
if len(wantDesc) > maxStatusDescriptionLength {
original := wantDesc
wantDesc = fmt.Sprintf("%s...", wantDesc[0:(maxStatusDescriptionLength-3)])
log.WithField("original-desc", original).Warn("GitHub status description needed to be truncated to fit GH API limit")
}
return wantDesc
}