/
start.go
294 lines (262 loc) · 10 KB
/
start.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
/*
Copyright 2020 BlackRock, Inc.
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 calendar
import (
"context"
"encoding/json"
"fmt"
"os"
"strings"
"time"
"github.com/pkg/errors"
cronlib "github.com/robfig/cron/v3"
"go.uber.org/zap"
"k8s.io/client-go/kubernetes"
"github.com/argoproj/argo-events/common"
"github.com/argoproj/argo-events/common/logging"
eventsourcecommon "github.com/argoproj/argo-events/eventsources/common"
"github.com/argoproj/argo-events/eventsources/persist"
metrics "github.com/argoproj/argo-events/metrics"
apicommon "github.com/argoproj/argo-events/pkg/apis/common"
"github.com/argoproj/argo-events/pkg/apis/events"
"github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1"
)
// EventListener implements Eventing for calendar based events
type EventListener struct {
EventSourceName string
EventName string
Namespace string
CalendarEventSource v1alpha1.CalendarEventSource
Metrics *metrics.Metrics
log *zap.SugaredLogger
eventPersistence persist.EventPersist
}
// GetEventSourceName returns name of event source
func (el *EventListener) GetEventSourceName() string {
return el.EventSourceName
}
// GetEventName returns name of event
func (el *EventListener) GetEventName() string {
return el.EventName
}
// GetEventSourceType return type of event server
func (el *EventListener) GetEventSourceType() apicommon.EventSourceType {
return apicommon.CalendarEvent
}
// initializePersistence initialize the persistence object.
// This func can move to eventing.go once we start supporting persistence for all sources.
func (el *EventListener) initializePersistence(ctx context.Context, persistence *v1alpha1.EventPersistence) error {
el.log.Info("Initializing Persistence")
if persistence.ConfigMap != nil {
kubeConfig, _ := os.LookupEnv(common.EnvVarKubeConfig)
restConfig, err := common.GetClientConfig(kubeConfig)
if err != nil {
return errors.Wrapf(err, "failed to get a K8s rest config for the event source %s", el.GetEventName())
}
kubeClientset, err := kubernetes.NewForConfig(restConfig)
if err != nil {
return errors.Wrapf(err, "failed to set up a K8s client for the event source %s", el.GetEventName())
}
el.eventPersistence, err = persist.NewConfigMapPersist(ctx, kubeClientset, persistence.ConfigMap, el.Namespace)
if err != nil {
return err
}
}
return nil
}
func (el *EventListener) getPersistenceKey() string {
return fmt.Sprintf("%s.%s", el.EventSourceName, el.EventName)
}
// getExecutionTime return starting schedule time for execution
func (el *EventListener) getExecutionTime() (time.Time, error) {
lastT := time.Now()
if el.eventPersistence.IsEnabled() && el.CalendarEventSource.Persistence.IsCatchUpEnabled() {
lastEvent, err := el.eventPersistence.Get(el.getPersistenceKey())
if err != nil {
el.log.Errorw("failed to get last persisted event.", zap.Error(err))
return lastT, errors.Wrap(err, "failed to get last persisted event.")
}
if lastEvent != nil && lastEvent.EventPayload != "" {
var eventData events.CalendarEventData
err := json.Unmarshal([]byte(lastEvent.EventPayload), &eventData)
if err != nil {
el.log.Errorw("failed to marshal last persisted event.", zap.Error(err))
return lastT, errors.Wrap(err, "failed to marshal last persisted event.")
}
eventTime := strings.Split(eventData.EventTime, " m=")
lastT, err = time.Parse("2006-01-02 15:04:05.999999999 -0700 MST", eventTime[0])
if err != nil {
el.log.Errorw("failed to parse the persisted last event timestamp", zap.Error(err))
return lastT, errors.Wrap(err, "failed to parse the persisted last event timestamp.")
}
}
if el.CalendarEventSource.Persistence.Catchup.MaxDuration != "" {
duration, err := time.ParseDuration(el.CalendarEventSource.Persistence.Catchup.MaxDuration)
if err != nil {
return lastT, err
}
// Set maxCatchupDuration in execution time if last persisted event time is greater than maxCatchupDuration
if duration < time.Since(lastT) {
el.log.Infow("set execution time", zap.Any("maxDuration", el.CalendarEventSource.Persistence.Catchup.MaxDuration))
lastT = time.Now().Add(-duration)
}
}
}
return lastT, nil
}
// StartListening starts listening events
func (el *EventListener) StartListening(ctx context.Context, dispatch func([]byte, ...eventsourcecommon.Option) error) error {
el.log = logging.FromContext(ctx).
With(logging.LabelEventSourceType, el.GetEventSourceType(), logging.LabelEventName, el.GetEventName())
el.log.Info("started processing the calendar event source...")
calendarEventSource := &el.CalendarEventSource
el.log.Info("resolving calendar schedule...")
schedule, err := resolveSchedule(calendarEventSource)
if err != nil {
return err
}
el.log.Info("parsing exclusion dates if any...")
exDates, err := common.ParseExclusionDates(calendarEventSource.ExclusionDates)
if err != nil {
return err
}
el.eventPersistence = &persist.NullPersistence{}
if calendarEventSource.Persistence != nil {
if err = el.initializePersistence(ctx, calendarEventSource.Persistence); err != nil {
return err
}
} else {
el.log.Info("Persistence not enabled")
}
var next Next
next = func(last time.Time) time.Time {
nextT := schedule.Next(last)
nextYear := nextT.Year()
nextMonth := nextT.Month()
nextDay := nextT.Day()
for _, exDate := range exDates {
// if exDate == nextEvent, then we need to skip this and get the next
if exDate.Year() == nextYear && exDate.Month() == nextMonth && exDate.Day() == nextDay {
return next(nextT)
}
}
return nextT
}
lastT, err := el.getExecutionTime()
if err != nil {
return err
}
var location *time.Location
if calendarEventSource.Timezone != "" {
el.log.Infow("loading location for the schedule...", zap.Any("location", calendarEventSource.Timezone))
location, err = time.LoadLocation(calendarEventSource.Timezone)
if err != nil {
return errors.Wrapf(err, "failed to load location for event source %s / %s", el.GetEventSourceName(), el.GetEventName())
}
lastT = lastT.In(location)
}
sendEventFunc := func(tx time.Time) error {
defer func(start time.Time) {
el.Metrics.EventProcessingDuration(el.GetEventSourceName(), el.GetEventName(), float64(time.Since(start)/time.Millisecond))
}(time.Now())
eventData := &events.CalendarEventData{
EventTime: tx.String(),
Metadata: calendarEventSource.Metadata,
}
payload, err := json.Marshal(eventData)
if err != nil {
el.log.Errorw("failed to marshal the event data", zap.Error(err))
// no need to continue as further event payloads will suffer same fate as this one.
return errors.Wrapf(err, "failed to marshal the event data for event source %s / %s", el.GetEventSourceName(), el.GetEventName())
}
el.log.Info("dispatching calendar event...")
err = dispatch(payload)
if err != nil {
el.log.Errorw("failed to dispatch calendar event", zap.Error(err))
return errors.Wrapf(err, "failed to dispatch calendar event")
}
if el.eventPersistence != nil && el.eventPersistence.IsEnabled() {
event := persist.Event{EventKey: el.getPersistenceKey(), EventPayload: string(payload)}
err = el.eventPersistence.Save(&event)
if err != nil {
el.log.Errorw("failed to persist calendar event", zap.Error(err))
}
}
return nil
}
el.log.Infow("Calendar event start time:", zap.Any("Time", lastT.Format(time.RFC822)))
for {
t := next(lastT)
// Catchup scenario
// Trigger the event immediately if the current schedule time is earlier then
if time.Now().After(t) {
el.log.Infow("triggering catchup events", zap.Any(logging.LabelTime, t.UTC().String()))
if err = sendEventFunc(t); err != nil {
el.log.Errorw("failed to dispatch calendar event", zap.Error(err))
el.Metrics.EventProcessingFailed(el.GetEventSourceName(), el.GetEventName())
if el.eventPersistence.IsEnabled() {
time.Sleep(100 * time.Millisecond)
continue
}
}
lastT = t
if location != nil {
lastT = lastT.In(location)
}
continue
}
timer := time.After(time.Until(t))
el.log.Infow("expected next calendar event", zap.Any(logging.LabelTime, t.UTC().String()))
select {
case tx := <-timer:
if err = sendEventFunc(tx); err != nil {
el.log.Errorw("failed to dispatch calendar event", zap.Error(err))
el.Metrics.EventProcessingFailed(el.GetEventSourceName(), el.GetEventName())
if el.eventPersistence.IsEnabled() {
time.Sleep(100 * time.Millisecond)
continue
}
}
lastT = tx
if location != nil {
lastT = lastT.In(location)
}
case <-ctx.Done():
el.log.Info("exiting calendar event listener...")
return nil
}
}
}
// Next is a function to compute the next event time from a given time
type Next func(time.Time) time.Time
// resolveSchedule parses the schedule and returns a valid cron schedule
func resolveSchedule(cal *v1alpha1.CalendarEventSource) (cronlib.Schedule, error) {
if cal.Schedule != "" {
// standard cron expression
specParser := cronlib.NewParser(cronlib.Minute | cronlib.Hour | cronlib.Dom | cronlib.Month | cronlib.Dow)
schedule, err := specParser.Parse(cal.Schedule)
if err != nil {
return nil, errors.Errorf("failed to parse schedule %s from calendar event. Cause: %+v", cal.Schedule, err.Error())
}
return schedule, nil
}
if cal.Interval != "" {
intervalDuration, err := time.ParseDuration(cal.Interval)
if err != nil {
return nil, errors.Errorf("failed to parse interval %s from calendar event. Cause: %+v", cal.Interval, err.Error())
}
schedule := cronlib.ConstantDelaySchedule{Delay: intervalDuration}
return schedule, nil
}
return nil, errors.New("calendar event must contain either a schedule or interval")
}