forked from kubernetes-retired/contrib
/
pinger.go
118 lines (94 loc) · 2.95 KB
/
pinger.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
/*
Copyright 2016 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package comment
import (
"time"
"github.com/google/go-github/github"
)
// Pinger checks if it's time to send a ping.
// You can build a pinger for a specific use-case and re-use it when you want.
type Pinger struct {
keyword string // Short description for the ping
description string // Long description for the ping
timePeriod time.Duration // How often should we ping
maxCount int // Will stop pinging after that many occurences
}
// NewPinger creates a new pinger. `keyword` is the name of the notification.
func NewPinger(keyword string) *Pinger {
return &Pinger{
keyword: keyword,
}
}
// SetDescription is the description that goes along the ping
func (p *Pinger) SetDescription(description string) *Pinger {
p.description = description
return p
}
// SetTimePeriod is the time we wait between pings
func (p *Pinger) SetTimePeriod(timePeriod time.Duration) *Pinger {
p.timePeriod = timePeriod
return p
}
// SetMaxCount will make the pinger fail when it reaches maximum
func (p *Pinger) SetMaxCount(maxCount int) *Pinger {
p.maxCount = maxCount
return p
}
// PingNotification creates a new notification to ping `who`
func (p *Pinger) PingNotification(comments []*github.IssueComment, who string, startDate *time.Time) *Notification {
if startDate == nil {
startDate = &time.Time{}
}
pings := FilterComments(
comments,
And([]Matcher{
CreatedAfter(*startDate),
MungerNotificationName(p.keyword),
}),
)
// We have pinged too many times, it's time to try something else
if p.isMaxReached(pings) {
return nil
}
if !p.shouldPingNow(pings, startDate) {
return nil
}
return &Notification{
Name: p.keyword,
Arguments: who,
Context: p.description,
}
}
// IsMaxReached tells you if you've reached the limit yet
func (p *Pinger) IsMaxReached(comments []*github.IssueComment, startDate *time.Time) bool {
if startDate == nil {
startDate = &time.Time{}
}
return p.isMaxReached(FilterComments(
comments,
And([]Matcher{
CreatedAfter(*startDate),
MungerNotificationName(p.keyword),
}),
))
}
func (p *Pinger) isMaxReached(pings FilteredComments) bool {
return p.maxCount != 0 && len(pings) >= p.maxCount
}
func (p *Pinger) shouldPingNow(pings FilteredComments, startDate *time.Time) bool {
lastEvent := startDate
if len(pings) != 0 {
lastEvent = pings[len(pings)-1].CreatedAt
}
return time.Since(*lastEvent) > p.timePeriod
}