| 1 | package telemetry |
| 2 | |
| 3 | import ( |
| 4 | "context" |
| 5 | "encoding/json" |
| 6 | "errors" |
| 7 | "io" |
| 8 | "net/http" |
| 9 | "os" |
| 10 | "path/filepath" |
| 11 | "strings" |
| 12 | "sync" |
| 13 | "testing" |
| 14 | "time" |
| 15 | ) |
| 16 | |
| 17 | type roundTripFunc func(*http.Request) (*http.Response, error) |
| 18 | |
| 19 | func (f roundTripFunc) RoundTrip(req *http.Request) (*http.Response, error) { return f(req) } |
| 20 | |
| 21 | func telemetryResponse(status int) *http.Response { |
| 22 | return &http.Response{ |
| 23 | StatusCode: status, |
| 24 | Body: io.NopCloser(strings.NewReader("")), |
| 25 | Header: make(http.Header), |
| 26 | } |
| 27 | } |
| 28 | |
| 29 | func testClient(home string, transport http.RoundTripper) *Client { |
| 30 | return &Client{ |
| 31 | home: home, |
| 32 | version: "v1.20.0", |
| 33 | installID: strings.Repeat("a", 32), |
| 34 | http: &http.Client{Transport: transport}, |
| 35 | } |
| 36 | } |
| 37 | |
| 38 | func TestInstallIDRepairsMalformedOwnedFile(t *testing.T) { |
| 39 | home := t.TempDir() |
| 40 | path := filepath.Join(home, "cli-telemetry-install-id") |
| 41 | if err := os.WriteFile(path, []byte("truncated\n"), 0o600); err != nil { |
| 42 | t.Fatal(err) |
| 43 | } |
| 44 | |
| 45 | id, err := installID(home) |
| 46 | if err != nil { |
| 47 | t.Fatalf("installID: %v", err) |
| 48 | } |
| 49 | if !validInstallID(id) { |
| 50 | t.Fatalf("repaired install id = %q", id) |
| 51 | } |
| 52 | b, err := os.ReadFile(path) |
| 53 | if err != nil { |
| 54 | t.Fatal(err) |
| 55 | } |
| 56 | if got := strings.TrimSpace(string(b)); got != id { |
| 57 | t.Fatalf("persisted install id = %q, want %q", got, id) |
| 58 | } |
| 59 | } |
| 60 | |
| 61 | func TestDailyPingSendsOnceWithCLISurface(t *testing.T) { |
| 62 | home := t.TempDir() |
| 63 | var mu sync.Mutex |
| 64 | var payloads []pingPayload |
| 65 | client := testClient(home, roundTripFunc(func(req *http.Request) (*http.Response, error) { |
| 66 | if req.URL.String() != endpoint+"/ping" { |
| 67 | t.Fatalf("request URL = %q", req.URL) |
| 68 | } |
| 69 | var payload pingPayload |
| 70 | if err := json.NewDecoder(req.Body).Decode(&payload); err != nil { |
| 71 | t.Fatal(err) |
| 72 | } |
| 73 | mu.Lock() |
| 74 | payloads = append(payloads, payload) |
| 75 | mu.Unlock() |
| 76 | return telemetryResponse(http.StatusAccepted), nil |
| 77 | })) |
| 78 | |
| 79 | if err := client.sendDailyPing(context.Background()); err != nil { |
| 80 | t.Fatal(err) |
| 81 | } |
| 82 | if err := client.sendDailyPing(context.Background()); err != nil { |
| 83 | t.Fatal(err) |
| 84 | } |
| 85 | mu.Lock() |
| 86 | defer mu.Unlock() |
| 87 | if len(payloads) != 1 { |
| 88 | t.Fatalf("ping requests = %d, want 1", len(payloads)) |
| 89 | } |
| 90 | if payloads[0].Surface != "cli" || payloads[0].InstallID != client.installID { |
| 91 | t.Fatalf("ping payload = %+v", payloads[0]) |
| 92 | } |
| 93 | } |
| 94 | |
| 95 | func TestFailedDailyPingRemovesClaimAndRetries(t *testing.T) { |
| 96 | home := t.TempDir() |
| 97 | calls := 0 |
| 98 | client := testClient(home, roundTripFunc(func(*http.Request) (*http.Response, error) { |
| 99 | calls++ |
| 100 | if calls == 1 { |
| 101 | return nil, errors.New("offline") |
| 102 | } |
| 103 | return telemetryResponse(http.StatusAccepted), nil |
| 104 | })) |
| 105 | |
| 106 | if err := client.sendDailyPing(context.Background()); err == nil { |
| 107 | t.Fatal("first ping unexpectedly succeeded") |
| 108 | } |
| 109 | claim := filepath.Join(home, "cli-telemetry-ping-"+time.Now().UTC().Format("2006-01-02")) |
| 110 | if _, err := os.Stat(claim); !errors.Is(err, os.ErrNotExist) { |
| 111 | t.Fatalf("failed ping claim remains: %v", err) |
| 112 | } |
| 113 | if err := client.sendDailyPing(context.Background()); err != nil { |
| 114 | t.Fatalf("retry ping: %v", err) |
| 115 | } |
| 116 | if calls != 2 { |
| 117 | t.Fatalf("ping calls = %d, want 2", calls) |
| 118 | } |
| 119 | } |
| 120 | |
| 121 | func TestFlushPendingAggregatesAndDeletesOnlyAfterSuccess(t *testing.T) { |
| 122 | home := t.TempDir() |
| 123 | for _, counters := range [][]Counter{ |
| 124 | {{Signal: "turns", Bucket: "count", Count: 2}}, |
| 125 | {{Signal: "turns", Bucket: "count", Count: 3}, {Signal: "cli_exit", Bucket: "success", Count: 1}}, |
| 126 | } { |
| 127 | if err := appendPending(home, pendingPayload{Version: "v1.20.0", OS: "android", Counters: counters}); err != nil { |
| 128 | t.Fatal(err) |
| 129 | } |
| 130 | } |
| 131 | requests := 0 |
| 132 | var client *Client |
| 133 | client = testClient(home, roundTripFunc(func(req *http.Request) (*http.Response, error) { |
| 134 | requests++ |
| 135 | var payload metricsPayload |
| 136 | if err := json.NewDecoder(req.Body).Decode(&payload); err != nil { |
| 137 | t.Fatal(err) |
| 138 | } |
| 139 | if payload.Surface != "cli" || payload.OS != "android" || payload.InstallID != client.installID { |
| 140 | t.Fatalf("metrics payload = %+v", payload) |
| 141 | } |
| 142 | got := map[string]int{} |
| 143 | for _, counter := range payload.Counters { |
| 144 | got[counter.Signal+"/"+counter.Bucket] = counter.Count |
| 145 | } |
| 146 | if got["turns/count"] != 5 || got["cli_exit/success"] != 1 { |
| 147 | t.Fatalf("aggregated counters = %#v", got) |
| 148 | } |
| 149 | return telemetryResponse(http.StatusAccepted), nil |
| 150 | })) |
| 151 | |
| 152 | if err := client.flushPending(context.Background()); err != nil { |
| 153 | t.Fatal(err) |
| 154 | } |
| 155 | if requests != 1 { |
| 156 | t.Fatalf("metrics requests = %d, want 1", requests) |
| 157 | } |
| 158 | entries, err := os.ReadDir(filepath.Join(home, pendingDirName)) |
| 159 | if err != nil || len(entries) != 0 { |
| 160 | t.Fatalf("pending entries after success = %d, err = %v", len(entries), err) |
| 161 | } |
| 162 | } |
| 163 | |
| 164 | func TestFailedFlushRestoresClaimsForRetry(t *testing.T) { |
| 165 | home := t.TempDir() |
| 166 | if err := appendPending(home, pendingPayload{ |
| 167 | Version: "v1.20.0", OS: "linux", Counters: []Counter{{Signal: "turns", Bucket: "count", Count: 1}}, |
| 168 | }); err != nil { |
| 169 | t.Fatal(err) |
| 170 | } |
| 171 | calls := 0 |
| 172 | client := testClient(home, roundTripFunc(func(*http.Request) (*http.Response, error) { |
| 173 | calls++ |
| 174 | if calls == 1 { |
| 175 | return telemetryResponse(http.StatusServiceUnavailable), nil |
| 176 | } |
| 177 | return telemetryResponse(http.StatusAccepted), nil |
| 178 | })) |
| 179 | |
| 180 | if err := client.flushPending(context.Background()); err == nil { |
| 181 | t.Fatal("first flush unexpectedly succeeded") |
| 182 | } |
| 183 | entries, err := os.ReadDir(filepath.Join(home, pendingDirName)) |
| 184 | if err != nil || len(entries) != 1 || !strings.HasSuffix(entries[0].Name(), ".json") { |
| 185 | t.Fatalf("failed flush entries = %v, err = %v", entries, err) |
| 186 | } |
| 187 | if err := client.flushPending(context.Background()); err != nil { |
| 188 | t.Fatalf("retry flush: %v", err) |
| 189 | } |
| 190 | entries, err = os.ReadDir(filepath.Join(home, pendingDirName)) |
| 191 | if err != nil || len(entries) != 0 { |
| 192 | t.Fatalf("pending entries after retry = %d, err = %v", len(entries), err) |
| 193 | } |
| 194 | } |
| 195 | |
| 196 | func TestPendingClaimsAreExclusiveAcrossFlushers(t *testing.T) { |
| 197 | home := t.TempDir() |
| 198 | if err := appendPending(home, pendingPayload{ |
| 199 | Version: "v1.20.0", OS: "linux", Counters: []Counter{{Signal: "turns", Bucket: "count", Count: 1}}, |
| 200 | }); err != nil { |
| 201 | t.Fatal(err) |
| 202 | } |
| 203 | dir := filepath.Join(home, pendingDirName) |
| 204 | first, err := claimPendingFiles(dir, time.Now()) |
| 205 | if err != nil { |
| 206 | t.Fatal(err) |
| 207 | } |
| 208 | second, err := claimPendingFiles(dir, time.Now()) |
| 209 | if err != nil { |
| 210 | t.Fatal(err) |
| 211 | } |
| 212 | if len(first) != 1 || len(second) != 0 { |
| 213 | t.Fatalf("claims: first=%v second=%v", first, second) |
| 214 | } |
| 215 | } |
| 216 | |
| 217 | func TestPendingValidationAcceptsAndroid(t *testing.T) { |
| 218 | if !validPendingPayload(pendingPayload{ |
| 219 | Version: "v1.20.0", OS: "android", Counters: []Counter{{Signal: "turns", Bucket: "count", Count: 1}}, |
| 220 | }) { |
| 221 | t.Fatal("Android CLI payload was rejected") |
| 222 | } |
| 223 | } |
| 224 | |
| 225 | func TestPendingQueueCountsActiveAndRecoversStaleClaims(t *testing.T) { |
| 226 | dir := filepath.Join(t.TempDir(), pendingDirName) |
| 227 | if err := os.MkdirAll(dir, 0o700); err != nil { |
| 228 | t.Fatal(err) |
| 229 | } |
| 230 | for i := 0; i < maxPending; i++ { |
| 231 | path := filepath.Join(dir, strings.Repeat("a", 16)+"-"+time.Unix(int64(i), 0).Format("150405")+".json.uploading") |
| 232 | if err := os.WriteFile(path, []byte("{}"), 0o600); err != nil { |
| 233 | t.Fatal(err) |
| 234 | } |
| 235 | } |
| 236 | if err := appendPending(filepath.Dir(dir), pendingPayload{ |
| 237 | Version: "v1.20.0", OS: "linux", Counters: []Counter{{Signal: "turns", Bucket: "count", Count: 1}}, |
| 238 | }); err != nil { |
| 239 | t.Fatal(err) |
| 240 | } |
| 241 | entries, err := os.ReadDir(dir) |
| 242 | if err != nil || len(entries) != maxPending { |
| 243 | t.Fatalf("bounded queue entries = %d, err = %v", len(entries), err) |
| 244 | } |
| 245 | |
| 246 | staleDir := filepath.Join(t.TempDir(), pendingDirName) |
| 247 | if err := os.MkdirAll(staleDir, 0o700); err != nil { |
| 248 | t.Fatal(err) |
| 249 | } |
| 250 | staleClaim := filepath.Join(staleDir, "sample.json.uploading") |
| 251 | if err := os.WriteFile(staleClaim, []byte("{}"), 0o600); err != nil { |
| 252 | t.Fatal(err) |
| 253 | } |
| 254 | stale := time.Now().Add(-3 * time.Minute) |
| 255 | if err := os.Chtimes(staleClaim, stale, stale); err != nil { |
| 256 | t.Fatal(err) |
| 257 | } |
| 258 | if !prunePending(staleDir, time.Now()) { |
| 259 | t.Fatal("stale claim recovery did not make a queue slot") |
| 260 | } |
| 261 | if _, err := os.Stat(strings.TrimSuffix(staleClaim, ".uploading")); err != nil { |
| 262 | t.Fatalf("stale claim was not recovered: %v", err) |
| 263 | } |
| 264 | } |
| 265 |