-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathbrowsers_telemetry_test.go
More file actions
402 lines (345 loc) · 15.3 KB
/
Copy pathbrowsers_telemetry_test.go
File metadata and controls
402 lines (345 loc) · 15.3 KB
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
package cmd
import (
"bytes"
"context"
"encoding/json"
"io"
"os"
"testing"
kernel "github.com/kernel/kernel-go-sdk"
"github.com/kernel/kernel-go-sdk/option"
"github.com/kernel/kernel-go-sdk/packages/ssestream"
"github.com/stretchr/testify/assert"
)
// captureStdout redirects os.Stdout for the duration of the test and returns
// the captured output. Needed for paths that use fmt.Println rather than pterm.
func captureStdout(t *testing.T, fn func()) string {
t.Helper()
r, w, err := os.Pipe()
if err != nil {
t.Fatalf("os.Pipe: %v", err)
}
old := os.Stdout
os.Stdout = w
fn()
w.Close()
os.Stdout = old
var buf bytes.Buffer
io.Copy(&buf, r)
return buf.String()
}
type FakeBrowserTelemetryService struct {
StreamFunc func() *ssestream.Stream[kernel.BrowserTelemetryStreamResponse]
LastQuery kernel.BrowserTelemetryStreamParams
}
func (f *FakeBrowserTelemetryService) StreamStreaming(ctx context.Context, id string, query kernel.BrowserTelemetryStreamParams, opts ...option.RequestOption) *ssestream.Stream[kernel.BrowserTelemetryStreamResponse] {
f.LastQuery = query
if f.StreamFunc != nil {
return f.StreamFunc()
}
return makeStream([]kernel.BrowserTelemetryStreamResponse{})
}
func TestTelemetryStream_NilTelemetryErrors(t *testing.T) {
b := BrowsersCmd{browsers: &FakeBrowsersService{}}
err := b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
})
assert.Error(t, err)
assert.Contains(t, err.Error(), "telemetry service not available")
}
func TestTelemetryStream_ContextCanceledExitsCleanly(t *testing.T) {
fakeBrowsers := &FakeBrowsersService{GetFunc: func(ctx context.Context, id string, query kernel.BrowserGetParams, opts ...option.RequestOption) (*kernel.BrowserGetResponse, error) {
return &kernel.BrowserGetResponse{SessionID: id}, nil
}}
fakeTelemetry := &FakeBrowserTelemetryService{StreamFunc: func() *ssestream.Stream[kernel.BrowserTelemetryStreamResponse] {
return ssestream.NewStream[kernel.BrowserTelemetryStreamResponse](&testDecoder{}, context.Canceled)
}}
b := BrowsersCmd{browsers: fakeBrowsers, telemetry: fakeTelemetry}
err := b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
Seq: -1,
})
assert.NoError(t, err)
}
func TestTelemetryStream_NegativeSeqErrors(t *testing.T) {
b := BrowsersCmd{browsers: &FakeBrowsersService{}, telemetry: &FakeBrowserTelemetryService{}}
err := b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
Seq: -2,
})
assert.Error(t, err)
assert.Contains(t, err.Error(), "invalid --seq value -2")
}
func TestTelemetryStream_ReplayAllWithSeqErrors(t *testing.T) {
b := BrowsersCmd{browsers: &FakeBrowsersService{}, telemetry: &FakeBrowserTelemetryService{}}
err := b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
Seq: 5,
ReplayAll: true,
})
assert.Error(t, err)
assert.Contains(t, err.Error(), "cannot combine --replay-all with --seq")
}
func TestTelemetryStream_ReplayAllSetsReplayParam(t *testing.T) {
fakeBrowsers := &FakeBrowsersService{GetFunc: func(ctx context.Context, id string, query kernel.BrowserGetParams, opts ...option.RequestOption) (*kernel.BrowserGetResponse, error) {
return &kernel.BrowserGetResponse{SessionID: id}, nil
}}
fakeTelemetry := &FakeBrowserTelemetryService{}
b := BrowsersCmd{browsers: fakeBrowsers, telemetry: fakeTelemetry}
err := b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
Seq: -1,
ReplayAll: true,
})
assert.NoError(t, err)
assert.Equal(t, "all", fakeTelemetry.LastQuery.Replay.Or(""))
assert.False(t, fakeTelemetry.LastQuery.LastEventID.Valid(), "Last-Event-ID must not be set with --replay-all")
}
func TestTelemetryStream_SeqSetsLastEventID(t *testing.T) {
fakeBrowsers := &FakeBrowsersService{GetFunc: func(ctx context.Context, id string, query kernel.BrowserGetParams, opts ...option.RequestOption) (*kernel.BrowserGetResponse, error) {
return &kernel.BrowserGetResponse{SessionID: id}, nil
}}
fakeTelemetry := &FakeBrowserTelemetryService{}
b := BrowsersCmd{browsers: fakeBrowsers, telemetry: fakeTelemetry}
err := b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
Seq: 5,
})
assert.NoError(t, err)
assert.Equal(t, "5", fakeTelemetry.LastQuery.LastEventID.Or(""))
assert.False(t, fakeTelemetry.LastQuery.Replay.Valid(), "replay must not be set with --seq")
}
func TestTelemetryStream_UnsupportedOutputErrors(t *testing.T) {
b := BrowsersCmd{browsers: &FakeBrowsersService{}, telemetry: &FakeBrowserTelemetryService{}}
err := b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
Output: "yaml",
Seq: -1,
})
assert.Error(t, err)
assert.Contains(t, err.Error(), "unsupported --output value")
}
func TestTelemetryStream_UnknownCategoryErrors(t *testing.T) {
b := BrowsersCmd{browsers: &FakeBrowsersService{}, telemetry: &FakeBrowserTelemetryService{}}
err := b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
Categories: []string{"netowrk"},
Seq: -1,
})
assert.Error(t, err)
assert.Contains(t, err.Error(), "invalid --categories value")
}
func TestTelemetryStream_SystemCategoryAccepted(t *testing.T) {
setupStdoutCapture(t)
fake := &FakeBrowsersService{GetFunc: func(ctx context.Context, id string, query kernel.BrowserGetParams, opts ...option.RequestOption) (*kernel.BrowserGetResponse, error) {
return &kernel.BrowserGetResponse{SessionID: id}, nil
}}
b := BrowsersCmd{browsers: fake, telemetry: &FakeBrowserTelemetryService{}}
err := b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
Categories: []string{"system"},
Seq: -1,
})
assert.NoError(t, err)
}
func TestTelemetryStream_EventsFlow(t *testing.T) {
setupStdoutCapture(t)
event := kernel.BrowserTelemetryStreamResponse{}
if err := json.Unmarshal([]byte(`{"event":{"type":"network_response","ts":1000000}}`), &event); err != nil {
t.Fatalf("unmarshal: %v", err)
}
fakeBrowsers := &FakeBrowsersService{GetFunc: func(ctx context.Context, id string, query kernel.BrowserGetParams, opts ...option.RequestOption) (*kernel.BrowserGetResponse, error) {
return &kernel.BrowserGetResponse{SessionID: id}, nil
}}
fakeTelemetry := &FakeBrowserTelemetryService{StreamFunc: func() *ssestream.Stream[kernel.BrowserTelemetryStreamResponse] {
return makeStream([]kernel.BrowserTelemetryStreamResponse{event})
}}
b := BrowsersCmd{browsers: fakeBrowsers, telemetry: fakeTelemetry}
err := b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
Seq: -1,
})
assert.NoError(t, err)
assert.Contains(t, outBuf.String(), "network_response")
}
func TestTelemetryStream_EventsFlow_JSON(t *testing.T) {
event := kernel.BrowserTelemetryStreamResponse{}
if err := json.Unmarshal([]byte(`{"event":{"type":"network_response","ts":1000000}}`), &event); err != nil {
t.Fatalf("unmarshal: %v", err)
}
fakeBrowsers := &FakeBrowsersService{GetFunc: func(ctx context.Context, id string, query kernel.BrowserGetParams, opts ...option.RequestOption) (*kernel.BrowserGetResponse, error) {
return &kernel.BrowserGetResponse{SessionID: id}, nil
}}
fakeTelemetry := &FakeBrowserTelemetryService{StreamFunc: func() *ssestream.Stream[kernel.BrowserTelemetryStreamResponse] {
return makeStream([]kernel.BrowserTelemetryStreamResponse{event})
}}
b := BrowsersCmd{browsers: fakeBrowsers, telemetry: fakeTelemetry}
var err error
out := captureStdout(t, func() {
err = b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
Output: "json",
Seq: -1,
})
})
assert.NoError(t, err)
assert.Contains(t, out, "network_response")
}
func TestTelemetryStream_FiltersDropNonMatchingEvents(t *testing.T) {
setupStdoutCapture(t)
consoleEvent := kernel.BrowserTelemetryStreamResponse{}
if err := json.Unmarshal([]byte(`{"event":{"type":"console_log","category":"console","ts":1000000}}`), &consoleEvent); err != nil {
t.Fatalf("unmarshal: %v", err)
}
networkEvent := kernel.BrowserTelemetryStreamResponse{}
if err := json.Unmarshal([]byte(`{"event":{"type":"network_response","category":"network","ts":2000000}}`), &networkEvent); err != nil {
t.Fatalf("unmarshal: %v", err)
}
fakeBrowsers := &FakeBrowsersService{GetFunc: func(ctx context.Context, id string, query kernel.BrowserGetParams, opts ...option.RequestOption) (*kernel.BrowserGetResponse, error) {
return &kernel.BrowserGetResponse{SessionID: id}, nil
}}
fakeTelemetry := &FakeBrowserTelemetryService{StreamFunc: func() *ssestream.Stream[kernel.BrowserTelemetryStreamResponse] {
return makeStream([]kernel.BrowserTelemetryStreamResponse{consoleEvent, networkEvent})
}}
b := BrowsersCmd{browsers: fakeBrowsers, telemetry: fakeTelemetry}
err := b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
Categories: []string{"network"},
Seq: -1,
})
assert.NoError(t, err)
assert.Contains(t, outBuf.String(), "network_response")
assert.NotContains(t, outBuf.String(), "console_log")
}
func TestTelemetryStream_TypesFilterDropsNonMatching(t *testing.T) {
setupStdoutCapture(t)
req := kernel.BrowserTelemetryStreamResponse{}
if err := json.Unmarshal([]byte(`{"event":{"type":"network_request","category":"network","ts":1000000}}`), &req); err != nil {
t.Fatalf("unmarshal: %v", err)
}
resp := kernel.BrowserTelemetryStreamResponse{}
if err := json.Unmarshal([]byte(`{"event":{"type":"network_response","category":"network","ts":2000000}}`), &resp); err != nil {
t.Fatalf("unmarshal: %v", err)
}
fakeBrowsers := &FakeBrowsersService{GetFunc: func(ctx context.Context, id string, query kernel.BrowserGetParams, opts ...option.RequestOption) (*kernel.BrowserGetResponse, error) {
return &kernel.BrowserGetResponse{SessionID: id}, nil
}}
fakeTelemetry := &FakeBrowserTelemetryService{StreamFunc: func() *ssestream.Stream[kernel.BrowserTelemetryStreamResponse] {
return makeStream([]kernel.BrowserTelemetryStreamResponse{req, resp})
}}
b := BrowsersCmd{browsers: fakeBrowsers, telemetry: fakeTelemetry}
err := b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
Types: []string{"network_response"},
Seq: -1,
})
assert.NoError(t, err)
assert.Contains(t, outBuf.String(), "network_response")
assert.NotContains(t, outBuf.String(), "network_request")
}
func TestTelemetryStream_SeqZeroErrors(t *testing.T) {
b := BrowsersCmd{browsers: &FakeBrowsersService{}, telemetry: &FakeBrowserTelemetryService{}}
err := b.TelemetryStream(context.Background(), BrowsersTelemetryStreamInput{
Identifier: "session123",
Seq: 0,
})
assert.Error(t, err)
assert.Contains(t, err.Error(), "invalid --seq value 0")
assert.Contains(t, err.Error(), "must be >= 1")
}
func makeEvent(t *testing.T, raw string) kernel.BrowserTelemetryEventUnion {
t.Helper()
var ev kernel.BrowserTelemetryEventUnion
if err := json.Unmarshal([]byte(raw), &ev); err != nil {
t.Fatalf("makeEvent: %v", err)
}
return ev
}
func TestShouldEmit(t *testing.T) {
cases := []struct {
name string
raw string
categories []string
types []string
want bool
}{
{"no filters passes", `{"type":"network_response","category":"network","ts":0}`, nil, nil, true},
{"matching category passes", `{"type":"network_response","category":"network","ts":0}`, []string{"network"}, nil, true},
{"non-matching category drops", `{"type":"console_log","category":"console","ts":0}`, []string{"network"}, nil, false},
{"monitor category matches monitor_disconnected", `{"type":"monitor_disconnected","category":"monitor","ts":0}`, []string{"monitor"}, nil, true},
{"connection category matches cdp_connect", `{"type":"cdp_connect","category":"connection","ts":0}`, []string{"connection"}, nil, true},
{"matching type passes", `{"type":"console_log","category":"console","ts":0}`, nil, []string{"console_log"}, true},
{"non-matching type drops", `{"type":"network_response","category":"network","ts":0}`, nil, []string{"console_log"}, false},
{"both filters pass when both match", `{"type":"network_response","category":"network","ts":0}`, []string{"network"}, []string{"network_response"}, true},
{"both filters drop when type misses", `{"type":"network_response","category":"network","ts":0}`, []string{"network"}, []string{"console_log"}, false},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
ev := makeEvent(t, tc.raw)
assert.Equal(t, tc.want, shouldEmit(ev.Category, ev.Type, tc.categories, tc.types))
})
}
}
func TestParseTelemetryCategories_OptInList(t *testing.T) {
p, err := parseTelemetryCategories("network,control,captcha")
assert.NoError(t, err)
// Listed categories are enabled.
for _, c := range []kernel.BrowserTelemetryCategoryConfigParam{p.Network, p.Control, p.Captcha} {
assert.True(t, c.Enabled.Valid())
assert.True(t, c.Enabled.Value)
}
// Unlisted categories are omitted (opt-in: the instance treats them as off).
assert.False(t, p.Console.Enabled.Valid())
assert.False(t, p.Page.Enabled.Valid())
assert.False(t, p.Screenshot.Enabled.Valid())
}
func TestParseTelemetryCategories_InvalidCategory(t *testing.T) {
_, err := parseTelemetryCategories("foo")
assert.Error(t, err)
assert.Contains(t, err.Error(), "unknown category")
}
func TestParseTelemetryCategories_WhitespaceTolerance(t *testing.T) {
p, err := parseTelemetryCategories(" network , page ")
assert.NoError(t, err)
assert.True(t, p.Network.Enabled.Valid())
assert.True(t, p.Network.Enabled.Value)
assert.True(t, p.Page.Enabled.Valid())
assert.True(t, p.Page.Enabled.Value)
}
// TestBuildTelemetryParam_WireEncoding locks in the three wire shapes the API
// expects: "all" sets Enabled=true without Browser (default set), "off" sets
// Enabled=false without Browser, and an opt-in list sets only Browser with the
// listed categories enabled (Enabled unset).
func TestBuildTelemetryParam_WireEncoding(t *testing.T) {
t.Run("all", func(t *testing.T) {
p, err := buildNewTelemetryParam("all")
assert.NoError(t, err)
assert.True(t, p.Enabled.Valid())
assert.True(t, p.Enabled.Value)
assert.False(t, p.Browser.Network.Enabled.Valid())
})
t.Run("off", func(t *testing.T) {
p, err := buildNewTelemetryParam("off")
assert.NoError(t, err)
assert.True(t, p.Enabled.Valid())
assert.False(t, p.Enabled.Value)
assert.False(t, p.Browser.Network.Enabled.Valid())
})
t.Run("opt-in list sets only Browser", func(t *testing.T) {
p, err := buildNewTelemetryParam("network,control")
assert.NoError(t, err)
assert.False(t, p.Enabled.Valid(), "Enabled must be unset for an opt-in selection")
assert.True(t, p.Browser.Network.Enabled.Valid())
assert.True(t, p.Browser.Network.Enabled.Value)
assert.True(t, p.Browser.Control.Enabled.Valid())
assert.True(t, p.Browser.Control.Enabled.Value)
})
}
func TestTelemetryEnabledCategories(t *testing.T) {
var cfg kernel.BrowserTelemetryConfig
raw := `{"browser":{"control":{"enabled":true},"system":{"enabled":true},"network":{"enabled":false}}}`
if err := json.Unmarshal([]byte(raw), &cfg); err != nil {
t.Fatalf("unmarshal: %v", err)
}
assert.Equal(t, []string{"control", "system"}, telemetryEnabledCategories(cfg))
}