/
progress_reporter_delaying.go
121 lines (99 loc) · 3.04 KB
/
progress_reporter_delaying.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
// Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// 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 flow
import (
"context"
"fmt"
"sync"
"time"
"k8s.io/apimachinery/pkg/util/clock"
)
type progressReporterDelaying struct {
lock sync.Mutex
ctx context.Context
ctxCancel context.CancelFunc
reporterFn ProgressReporterFn
period time.Duration
clock clock.Clock
timer clock.Timer
pendingProgress *Stats
delayProgressReport bool
}
// NewDelayingProgressReporter returns a new progress reporter with the given function and the configured period. A
// period of `0` will lead to immediate reports as soon as flow tasks are completed.
func NewDelayingProgressReporter(clock clock.Clock, reporterFn ProgressReporterFn, period time.Duration) ProgressReporter {
return &progressReporterDelaying{
clock: clock,
reporterFn: reporterFn,
period: period,
}
}
func (p *progressReporterDelaying) Start(ctx context.Context) error {
p.lock.Lock()
defer p.lock.Unlock()
if p.timer != nil {
return fmt.Errorf("progress reporter has already been started")
}
// We store the context on the progressReporterDelaying object so that we can call the reporterFn with the original
// context - otherwise, the final state cannot be reported because the cancel context will already be canceled
p.ctx = ctx
if p.period > 0 {
p.timer = p.clock.NewTimer(p.period)
ctx, cancel := context.WithCancel(ctx)
p.ctxCancel = cancel
go p.run(ctx)
}
return nil
}
func (p *progressReporterDelaying) Stop() {
p.lock.Lock()
if p.ctxCancel != nil {
p.ctxCancel()
}
p.ctxCancel = nil
p.timer = nil
p.lock.Unlock()
p.report()
}
func (p *progressReporterDelaying) Report(_ context.Context, pendingProgress *Stats) {
p.lock.Lock()
defer p.lock.Unlock()
if p.timer != nil && p.delayProgressReport {
p.pendingProgress = pendingProgress
return
}
p.reporterFn(p.ctx, pendingProgress)
p.delayProgressReport = true
}
func (p *progressReporterDelaying) run(ctx context.Context) {
timer := p.timer
for timer != nil {
select {
case <-timer.C():
timer.Reset(p.period)
p.report()
case <-ctx.Done():
timer.Stop()
return
}
}
}
func (p *progressReporterDelaying) report() {
p.lock.Lock()
defer p.lock.Unlock()
if p.pendingProgress != nil {
p.reporterFn(p.ctx, p.pendingProgress)
p.pendingProgress = nil
}
}