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
|
package analytics
import (
"context"
"sync"
"time"
"github.com/google/uuid"
"github.com/hashicorp/go-hclog"
"github.com/mitchellh/mapstructure"
"github.com/vercel/turbo/cli/internal/util"
)
type Events = []map[string]interface{}
type EventPayload = interface{}
type Recorder interface {
LogEvent(payload EventPayload)
}
type Client interface {
Recorder
Close()
CloseWithTimeout(timeout time.Duration)
}
type Sink interface {
RecordAnalyticsEvents(events Events) error
}
type nullSink struct{}
func (n *nullSink) RecordAnalyticsEvents(events Events) error {
return nil
}
// NullSink is an analytics sink to use in the event that we don't want to send
// analytics
var NullSink = &nullSink{}
type client struct {
ch chan<- EventPayload
cancel func()
worker *worker
}
type worker struct {
buffer []EventPayload
ch <-chan EventPayload
ctx context.Context
doneSemaphore util.Semaphore
sessionID uuid.UUID
sink Sink
wg sync.WaitGroup
logger hclog.Logger
}
const bufferThreshold = 10
const eventTimeout = 200 * time.Millisecond
const noTimeout = 24 * time.Hour
func newWorker(ctx context.Context, ch <-chan EventPayload, sink Sink, logger hclog.Logger) *worker {
buffer := []EventPayload{}
sessionID := uuid.New()
w := &worker{
buffer: buffer,
ch: ch,
ctx: ctx,
doneSemaphore: util.NewSemaphore(1),
sessionID: sessionID,
sink: sink,
logger: logger,
}
w.doneSemaphore.Acquire()
go w.analyticsClient()
return w
}
func NewClient(parent context.Context, sink Sink, logger hclog.Logger) Client {
ch := make(chan EventPayload)
ctx, cancel := context.WithCancel(parent)
// creates and starts the worker
worker := newWorker(ctx, ch, sink, logger)
s := &client{
ch: ch,
cancel: cancel,
worker: worker,
}
return s
}
func (s *client) LogEvent(event EventPayload) {
s.ch <- event
}
func (s *client) Close() {
s.cancel()
s.worker.Wait()
}
func (s *client) CloseWithTimeout(timeout time.Duration) {
ch := make(chan struct{})
go func() {
s.Close()
close(ch)
}()
select {
case <-ch:
case <-time.After(timeout):
}
}
func (w *worker) Wait() {
w.doneSemaphore.Acquire()
w.wg.Wait()
}
func (w *worker) analyticsClient() {
timeout := time.After(noTimeout)
for {
select {
case e := <-w.ch:
w.buffer = append(w.buffer, e)
if len(w.buffer) == bufferThreshold {
w.flush()
timeout = time.After(noTimeout)
} else {
timeout = time.After(eventTimeout)
}
case <-timeout:
w.flush()
timeout = time.After(noTimeout)
case <-w.ctx.Done():
w.flush()
w.doneSemaphore.Release()
return
}
}
}
func (w *worker) flush() {
if len(w.buffer) > 0 {
w.sendEvents(w.buffer)
w.buffer = []EventPayload{}
}
}
func (w *worker) sendEvents(events []EventPayload) {
w.wg.Add(1)
go func() {
payload, err := addSessionID(w.sessionID.String(), events)
if err != nil {
w.logger.Debug("failed to encode cache usage analytics", "error", err)
}
err = w.sink.RecordAnalyticsEvents(payload)
if err != nil {
w.logger.Debug("failed to record cache usage analytics", "error", err)
}
w.wg.Done()
}()
}
func addSessionID(sessionID string, events []EventPayload) (Events, error) {
eventMaps := []map[string]interface{}{}
err := mapstructure.Decode(events, &eventMaps)
if err != nil {
return nil, err
}
for _, event := range eventMaps {
event["sessionId"] = sessionID
}
return eventMaps, nil
}
|