telemetry.rs

  1mod event_coalescer;
  2
  3use crate::{ChannelId, TelemetrySettings};
  4use chrono::{DateTime, Utc};
  5use clock::SystemClock;
  6use collections::{HashMap, HashSet};
  7use futures::Future;
  8use gpui::{AppContext, BackgroundExecutor, Task};
  9use http::{self, HttpClient, HttpClientWithUrl, Method};
 10use once_cell::sync::Lazy;
 11use parking_lot::Mutex;
 12use release_channel::ReleaseChannel;
 13use settings::{Settings, SettingsStore};
 14use sha2::{Digest, Sha256};
 15use std::io::Write;
 16use std::{env, mem, path::PathBuf, sync::Arc, time::Duration};
 17use sysinfo::{CpuRefreshKind, Pid, ProcessRefreshKind, RefreshKind, System};
 18use telemetry_events::{
 19    ActionEvent, AppEvent, AssistantEvent, AssistantKind, CallEvent, CpuEvent, EditEvent,
 20    EditorEvent, Event, EventRequestBody, EventWrapper, ExtensionEvent, InlineCompletionEvent,
 21    MemoryEvent, SettingEvent,
 22};
 23use tempfile::NamedTempFile;
 24#[cfg(not(debug_assertions))]
 25use util::ResultExt;
 26use util::TryFutureExt;
 27use worktree::{UpdatedEntriesSet, WorktreeId};
 28
 29use self::event_coalescer::EventCoalescer;
 30
 31pub struct Telemetry {
 32    clock: Arc<dyn SystemClock>,
 33    http_client: Arc<HttpClientWithUrl>,
 34    executor: BackgroundExecutor,
 35    state: Arc<Mutex<TelemetryState>>,
 36}
 37
 38struct TelemetryState {
 39    settings: TelemetrySettings,
 40    metrics_id: Option<Arc<str>>,      // Per logged-in user
 41    installation_id: Option<Arc<str>>, // Per app installation (different for dev, nightly, preview, and stable)
 42    session_id: Option<String>,        // Per app launch
 43    release_channel: Option<&'static str>,
 44    architecture: &'static str,
 45    events_queue: Vec<EventWrapper>,
 46    flush_events_task: Option<Task<()>>,
 47    log_file: Option<NamedTempFile>,
 48    is_staff: Option<bool>,
 49    first_event_date_time: Option<DateTime<Utc>>,
 50    event_coalescer: EventCoalescer,
 51    max_queue_size: usize,
 52    worktree_id_map: WorktreeIdMap,
 53
 54    os_name: String,
 55    app_version: String,
 56    os_version: Option<String>,
 57}
 58
 59#[derive(Debug)]
 60struct WorktreeIdMap(HashMap<String, ProjectCache>);
 61
 62#[derive(Debug)]
 63struct ProjectCache {
 64    name: String,
 65    worktree_ids_reported: HashSet<WorktreeId>,
 66}
 67
 68impl ProjectCache {
 69    fn new(name: String) -> Self {
 70        Self {
 71            name,
 72            worktree_ids_reported: HashSet::default(),
 73        }
 74    }
 75}
 76
 77#[cfg(debug_assertions)]
 78const MAX_QUEUE_LEN: usize = 5;
 79
 80#[cfg(not(debug_assertions))]
 81const MAX_QUEUE_LEN: usize = 50;
 82
 83#[cfg(debug_assertions)]
 84const FLUSH_INTERVAL: Duration = Duration::from_secs(1);
 85
 86#[cfg(not(debug_assertions))]
 87const FLUSH_INTERVAL: Duration = Duration::from_secs(60 * 5);
 88static ZED_CLIENT_CHECKSUM_SEED: Lazy<Option<Vec<u8>>> = Lazy::new(|| {
 89    option_env!("ZED_CLIENT_CHECKSUM_SEED")
 90        .map(|s| s.as_bytes().into())
 91        .or_else(|| {
 92            env::var("ZED_CLIENT_CHECKSUM_SEED")
 93                .ok()
 94                .map(|s| s.as_bytes().into())
 95        })
 96});
 97
 98pub fn os_name() -> String {
 99    #[cfg(target_os = "macos")]
100    {
101        "macOS".to_string()
102    }
103    #[cfg(target_os = "linux")]
104    {
105        format!("Linux {}", gpui::guess_compositor())
106    }
107
108    #[cfg(target_os = "windows")]
109    {
110        "Windows".to_string()
111    }
112}
113
114/// Note: This might do blocking IO! Only call from background threads
115pub fn os_version() -> String {
116    #[cfg(target_os = "macos")]
117    {
118        use cocoa::base::nil;
119        use cocoa::foundation::NSProcessInfo;
120
121        unsafe {
122            let process_info = cocoa::foundation::NSProcessInfo::processInfo(nil);
123            let version = process_info.operatingSystemVersion();
124            gpui::SemanticVersion::new(
125                version.majorVersion as usize,
126                version.minorVersion as usize,
127                version.patchVersion as usize,
128            )
129            .to_string()
130        }
131    }
132    #[cfg(target_os = "linux")]
133    {
134        use std::path::Path;
135
136        let content = if let Ok(file) = std::fs::read_to_string(&Path::new("/etc/os-release")) {
137            file
138        } else if let Ok(file) = std::fs::read_to_string(&Path::new("/usr/lib/os-release")) {
139            file
140        } else {
141            log::error!("Failed to load /etc/os-release, /usr/lib/os-release");
142            "".to_string()
143        };
144        let mut name = "unknown".to_string();
145        let mut version = "unknown".to_string();
146
147        for line in content.lines() {
148            if line.starts_with("ID=") {
149                name = line.trim_start_matches("ID=").trim_matches('"').to_string();
150            }
151            if line.starts_with("VERSION_ID=") {
152                version = line
153                    .trim_start_matches("VERSION_ID=")
154                    .trim_matches('"')
155                    .to_string();
156            }
157        }
158
159        format!("{} {}", name, version)
160    }
161
162    #[cfg(target_os = "windows")]
163    {
164        let mut info = unsafe { std::mem::zeroed() };
165        let status = unsafe { windows::Wdk::System::SystemServices::RtlGetVersion(&mut info) };
166        if status.is_ok() {
167            gpui::SemanticVersion::new(
168                info.dwMajorVersion as _,
169                info.dwMinorVersion as _,
170                info.dwBuildNumber as _,
171            )
172            .to_string()
173        } else {
174            "unknown".to_string()
175        }
176    }
177}
178
179impl Telemetry {
180    pub fn new(
181        clock: Arc<dyn SystemClock>,
182        client: Arc<HttpClientWithUrl>,
183        cx: &mut AppContext,
184    ) -> Arc<Self> {
185        let release_channel =
186            ReleaseChannel::try_global(cx).map(|release_channel| release_channel.display_name());
187
188        TelemetrySettings::register(cx);
189
190        let state = Arc::new(Mutex::new(TelemetryState {
191            settings: *TelemetrySettings::get_global(cx),
192            architecture: env::consts::ARCH,
193            release_channel,
194            installation_id: None,
195            metrics_id: None,
196            session_id: None,
197            events_queue: Vec::new(),
198            flush_events_task: None,
199            log_file: None,
200            is_staff: None,
201            first_event_date_time: None,
202            event_coalescer: EventCoalescer::new(clock.clone()),
203            max_queue_size: MAX_QUEUE_LEN,
204            worktree_id_map: WorktreeIdMap(HashMap::from_iter([
205                (
206                    "yarn.lock".to_string(),
207                    ProjectCache::new("yarn".to_string()),
208                ),
209                (
210                    "package.json".to_string(),
211                    ProjectCache::new("node".to_string()),
212                ),
213            ])),
214
215            os_version: None,
216            os_name: os_name(),
217            app_version: release_channel::AppVersion::global(cx).to_string(),
218        }));
219
220        #[cfg(not(debug_assertions))]
221        cx.background_executor()
222            .spawn({
223                let state = state.clone();
224                async move {
225                    if let Some(tempfile) =
226                        NamedTempFile::new_in(paths::config_dir().as_path()).log_err()
227                    {
228                        state.lock().log_file = Some(tempfile);
229                    }
230                }
231            })
232            .detach();
233
234        cx.observe_global::<SettingsStore>({
235            let state = state.clone();
236
237            move |cx| {
238                let mut state = state.lock();
239                state.settings = *TelemetrySettings::get_global(cx);
240            }
241        })
242        .detach();
243
244        // TODO: Replace all hardware stuff with nested SystemSpecs json
245        let this = Arc::new(Self {
246            clock,
247            http_client: client,
248            executor: cx.background_executor().clone(),
249            state,
250        });
251
252        // We should only ever have one instance of Telemetry, leak the subscription to keep it alive
253        // rather than store in TelemetryState, complicating spawn as subscriptions are not Send
254        std::mem::forget(cx.on_app_quit({
255            let this = this.clone();
256            move |_| this.shutdown_telemetry()
257        }));
258
259        this
260    }
261
262    #[cfg(any(test, feature = "test-support"))]
263    fn shutdown_telemetry(self: &Arc<Self>) -> impl Future<Output = ()> {
264        Task::ready(())
265    }
266
267    // Skip calling this function in tests.
268    // TestAppContext ends up calling this function on shutdown and it panics when trying to find the TelemetrySettings
269    #[cfg(not(any(test, feature = "test-support")))]
270    fn shutdown_telemetry(self: &Arc<Self>) -> impl Future<Output = ()> {
271        self.report_app_event("close".to_string());
272        // TODO: close final edit period and make sure it's sent
273        Task::ready(())
274    }
275
276    pub fn log_file_path(&self) -> Option<PathBuf> {
277        Some(self.state.lock().log_file.as_ref()?.path().to_path_buf())
278    }
279
280    pub fn start(
281        self: &Arc<Self>,
282        installation_id: Option<String>,
283        session_id: String,
284        cx: &mut AppContext,
285    ) {
286        let mut state = self.state.lock();
287        state.installation_id = installation_id.map(|id| id.into());
288        state.session_id = Some(session_id);
289        state.app_version = release_channel::AppVersion::global(cx).to_string();
290        state.os_name = os_name();
291
292        drop(state);
293
294        let this = self.clone();
295        cx.background_executor()
296            .spawn(async move {
297                let mut system = System::new_with_specifics(
298                    RefreshKind::new().with_cpu(CpuRefreshKind::everything()),
299                );
300
301                let refresh_kind = ProcessRefreshKind::new().with_cpu().with_memory();
302                let current_process = Pid::from_u32(std::process::id());
303                system.refresh_process_specifics(current_process, refresh_kind);
304
305                // Waiting some amount of time before the first query is important to get a reasonable value
306                // https://docs.rs/sysinfo/0.29.10/sysinfo/trait.ProcessExt.html#tymethod.cpu_usage
307                const DURATION_BETWEEN_SYSTEM_EVENTS: Duration = Duration::from_secs(4 * 60);
308
309                loop {
310                    smol::Timer::after(DURATION_BETWEEN_SYSTEM_EVENTS).await;
311
312                    let current_process = Pid::from_u32(std::process::id());
313                    system.refresh_process_specifics(current_process, refresh_kind);
314                    let Some(process) = system.process(current_process) else {
315                        log::error!(
316                            "Failed to find own process {current_process:?} in system process table"
317                        );
318                        // TODO: Fire an error telemetry event
319                        return;
320                    };
321
322                    this.report_memory_event(process.memory(), process.virtual_memory());
323                    this.report_cpu_event(process.cpu_usage(), system.cpus().len() as u32);
324                }
325            })
326            .detach();
327    }
328
329    pub fn set_authenticated_user_info(
330        self: &Arc<Self>,
331        metrics_id: Option<String>,
332        is_staff: bool,
333    ) {
334        let mut state = self.state.lock();
335
336        if !state.settings.metrics {
337            return;
338        }
339
340        let metrics_id: Option<Arc<str>> = metrics_id.map(|id| id.into());
341        state.metrics_id.clone_from(&metrics_id);
342        state.is_staff = Some(is_staff);
343        drop(state);
344    }
345
346    pub fn report_editor_event(
347        self: &Arc<Self>,
348        file_extension: Option<String>,
349        vim_mode: bool,
350        operation: &'static str,
351        copilot_enabled: bool,
352        copilot_enabled_for_language: bool,
353    ) {
354        let event = Event::Editor(EditorEvent {
355            file_extension,
356            vim_mode,
357            operation: operation.into(),
358            copilot_enabled,
359            copilot_enabled_for_language,
360        });
361
362        self.report_event(event)
363    }
364
365    pub fn report_inline_completion_event(
366        self: &Arc<Self>,
367        provider: String,
368        suggestion_accepted: bool,
369        file_extension: Option<String>,
370    ) {
371        let event = Event::InlineCompletion(InlineCompletionEvent {
372            provider,
373            suggestion_accepted,
374            file_extension,
375        });
376
377        self.report_event(event)
378    }
379
380    pub fn report_assistant_event(
381        self: &Arc<Self>,
382        conversation_id: Option<String>,
383        kind: AssistantKind,
384        model: String,
385        response_latency: Option<Duration>,
386        error_message: Option<String>,
387    ) {
388        let event = Event::Assistant(AssistantEvent {
389            conversation_id,
390            kind,
391            model: model.to_string(),
392            response_latency,
393            error_message,
394        });
395
396        self.report_event(event)
397    }
398
399    pub fn report_call_event(
400        self: &Arc<Self>,
401        operation: &'static str,
402        room_id: Option<u64>,
403        channel_id: Option<ChannelId>,
404    ) {
405        let event = Event::Call(CallEvent {
406            operation: operation.to_string(),
407            room_id,
408            channel_id: channel_id.map(|cid| cid.0),
409        });
410
411        self.report_event(event)
412    }
413
414    pub fn report_cpu_event(self: &Arc<Self>, usage_as_percentage: f32, core_count: u32) {
415        let event = Event::Cpu(CpuEvent {
416            usage_as_percentage,
417            core_count,
418        });
419
420        self.report_event(event)
421    }
422
423    pub fn report_memory_event(
424        self: &Arc<Self>,
425        memory_in_bytes: u64,
426        virtual_memory_in_bytes: u64,
427    ) {
428        let event = Event::Memory(MemoryEvent {
429            memory_in_bytes,
430            virtual_memory_in_bytes,
431        });
432
433        self.report_event(event)
434    }
435
436    pub fn report_app_event(self: &Arc<Self>, operation: String) -> Event {
437        let event = Event::App(AppEvent { operation });
438
439        self.report_event(event.clone());
440
441        event
442    }
443
444    pub fn report_setting_event(self: &Arc<Self>, setting: &'static str, value: String) {
445        let event = Event::Setting(SettingEvent {
446            setting: setting.to_string(),
447            value,
448        });
449
450        self.report_event(event)
451    }
452
453    pub fn report_extension_event(self: &Arc<Self>, extension_id: Arc<str>, version: Arc<str>) {
454        self.report_event(Event::Extension(ExtensionEvent {
455            extension_id,
456            version,
457        }))
458    }
459
460    pub fn log_edit_event(self: &Arc<Self>, environment: &'static str) {
461        let mut state = self.state.lock();
462        let period_data = state.event_coalescer.log_event(environment);
463        drop(state);
464
465        if let Some((start, end, environment)) = period_data {
466            let event = Event::Edit(EditEvent {
467                duration: end.timestamp_millis() - start.timestamp_millis(),
468                environment: environment.to_string(),
469            });
470
471            self.report_event(event);
472        }
473    }
474
475    pub fn report_action_event(self: &Arc<Self>, source: &'static str, action: String) {
476        let event = Event::Action(ActionEvent {
477            source: source.to_string(),
478            action,
479        });
480
481        self.report_event(event)
482    }
483
484    pub fn report_discovered_project_events(
485        self: &Arc<Self>,
486        worktree_id: WorktreeId,
487        updated_entries_set: &UpdatedEntriesSet,
488    ) {
489        let project_names: Vec<String> = {
490            let mut state = self.state.lock();
491            state
492                .worktree_id_map
493                .0
494                .iter_mut()
495                .filter_map(|(project_file_name, project_type_telemetry)| {
496                    if project_type_telemetry
497                        .worktree_ids_reported
498                        .contains(&worktree_id)
499                    {
500                        return None;
501                    }
502
503                    let project_file_found = updated_entries_set.iter().any(|(path, _, _)| {
504                        path.as_ref()
505                            .file_name()
506                            .and_then(|name| name.to_str())
507                            .map(|name_str| name_str == project_file_name)
508                            .unwrap_or(false)
509                    });
510
511                    if !project_file_found {
512                        return None;
513                    }
514
515                    project_type_telemetry
516                        .worktree_ids_reported
517                        .insert(worktree_id);
518
519                    Some(project_type_telemetry.name.clone())
520                })
521                .collect()
522        };
523
524        // Done on purpose to avoid calling `self.state.lock()` multiple times
525        for project_name in project_names {
526            self.report_app_event(format!("open {} project", project_name));
527        }
528    }
529
530    fn report_event(self: &Arc<Self>, event: Event) {
531        let mut state = self.state.lock();
532
533        if !state.settings.metrics {
534            return;
535        }
536
537        if state.flush_events_task.is_none() {
538            let this = self.clone();
539            let executor = self.executor.clone();
540            state.flush_events_task = Some(self.executor.spawn(async move {
541                executor.timer(FLUSH_INTERVAL).await;
542                this.flush_events();
543            }));
544        }
545
546        let date_time = self.clock.utc_now();
547
548        let milliseconds_since_first_event = match state.first_event_date_time {
549            Some(first_event_date_time) => {
550                date_time.timestamp_millis() - first_event_date_time.timestamp_millis()
551            }
552            None => {
553                state.first_event_date_time = Some(date_time);
554                0
555            }
556        };
557
558        let signed_in = state.metrics_id.is_some();
559        state.events_queue.push(EventWrapper {
560            signed_in,
561            milliseconds_since_first_event,
562            event,
563        });
564
565        if state.installation_id.is_some() && state.events_queue.len() >= state.max_queue_size {
566            drop(state);
567            self.flush_events();
568        }
569    }
570
571    pub fn metrics_id(self: &Arc<Self>) -> Option<Arc<str>> {
572        self.state.lock().metrics_id.clone()
573    }
574
575    pub fn installation_id(self: &Arc<Self>) -> Option<Arc<str>> {
576        self.state.lock().installation_id.clone()
577    }
578
579    pub fn is_staff(self: &Arc<Self>) -> Option<bool> {
580        self.state.lock().is_staff
581    }
582
583    pub fn flush_events(self: &Arc<Self>) {
584        let mut state = self.state.lock();
585        state.first_event_date_time = None;
586        let mut events = mem::take(&mut state.events_queue);
587        state.flush_events_task.take();
588        drop(state);
589        if events.is_empty() {
590            return;
591        }
592
593        let this = self.clone();
594        self.executor
595            .spawn(
596                async move {
597                    let mut json_bytes = Vec::new();
598
599                    if let Some(file) = &mut this.state.lock().log_file {
600                        let file = file.as_file_mut();
601                        for event in &mut events {
602                            json_bytes.clear();
603                            serde_json::to_writer(&mut json_bytes, event)?;
604                            file.write_all(&json_bytes)?;
605                            file.write_all(b"\n")?;
606                        }
607                    }
608
609                    {
610                        let state = this.state.lock();
611
612                        let request_body = EventRequestBody {
613                            installation_id: state.installation_id.as_deref().map(Into::into),
614                            metrics_id: state.metrics_id.as_deref().map(Into::into),
615                            session_id: state.session_id.clone(),
616                            is_staff: state.is_staff,
617                            app_version: state.app_version.clone(),
618                            os_name: state.os_name.clone(),
619                            os_version: state.os_version.clone(),
620                            architecture: state.architecture.to_string(),
621
622                            release_channel: state.release_channel.map(Into::into),
623                            events,
624                        };
625                        json_bytes.clear();
626                        serde_json::to_writer(&mut json_bytes, &request_body)?;
627                    }
628
629                    let checksum = calculate_json_checksum(&json_bytes).unwrap_or("".to_string());
630
631                    let request = http::Request::builder()
632                        .method(Method::POST)
633                        .uri(
634                            this.http_client
635                                .build_zed_api_url("/telemetry/events", &[])?
636                                .as_ref(),
637                        )
638                        .header("Content-Type", "text/plain")
639                        .header("x-zed-checksum", checksum)
640                        .body(json_bytes.into());
641
642                    let response = this.http_client.send(request?).await?;
643                    if response.status() != 200 {
644                        log::error!("Failed to send events: HTTP {:?}", response.status());
645                    }
646                    anyhow::Ok(())
647                }
648                .log_err(),
649            )
650            .detach();
651    }
652}
653
654#[cfg(test)]
655mod tests {
656    use super::*;
657    use chrono::TimeZone;
658    use clock::FakeSystemClock;
659    use gpui::TestAppContext;
660    use http::FakeHttpClient;
661
662    #[gpui::test]
663    fn test_telemetry_flush_on_max_queue_size(cx: &mut TestAppContext) {
664        init_test(cx);
665        let clock = Arc::new(FakeSystemClock::new(
666            Utc.with_ymd_and_hms(1990, 4, 12, 12, 0, 0).unwrap(),
667        ));
668        let http = FakeHttpClient::with_200_response();
669        let installation_id = Some("installation_id".to_string());
670        let session_id = "session_id".to_string();
671
672        cx.update(|cx| {
673            let telemetry = Telemetry::new(clock.clone(), http, cx);
674
675            telemetry.state.lock().max_queue_size = 4;
676            telemetry.start(installation_id, session_id, cx);
677
678            assert!(is_empty_state(&telemetry));
679
680            let first_date_time = clock.utc_now();
681            let operation = "test".to_string();
682
683            let event = telemetry.report_app_event(operation.clone());
684            assert_eq!(
685                event,
686                Event::App(AppEvent {
687                    operation: operation.clone(),
688                })
689            );
690            assert_eq!(telemetry.state.lock().events_queue.len(), 1);
691            assert!(telemetry.state.lock().flush_events_task.is_some());
692            assert_eq!(
693                telemetry.state.lock().first_event_date_time,
694                Some(first_date_time)
695            );
696
697            clock.advance(chrono::Duration::milliseconds(100));
698
699            let event = telemetry.report_app_event(operation.clone());
700            assert_eq!(
701                event,
702                Event::App(AppEvent {
703                    operation: operation.clone(),
704                })
705            );
706            assert_eq!(telemetry.state.lock().events_queue.len(), 2);
707            assert!(telemetry.state.lock().flush_events_task.is_some());
708            assert_eq!(
709                telemetry.state.lock().first_event_date_time,
710                Some(first_date_time)
711            );
712
713            clock.advance(chrono::Duration::milliseconds(100));
714
715            let event = telemetry.report_app_event(operation.clone());
716            assert_eq!(
717                event,
718                Event::App(AppEvent {
719                    operation: operation.clone(),
720                })
721            );
722            assert_eq!(telemetry.state.lock().events_queue.len(), 3);
723            assert!(telemetry.state.lock().flush_events_task.is_some());
724            assert_eq!(
725                telemetry.state.lock().first_event_date_time,
726                Some(first_date_time)
727            );
728
729            clock.advance(chrono::Duration::milliseconds(100));
730
731            // Adding a 4th event should cause a flush
732            let event = telemetry.report_app_event(operation.clone());
733            assert_eq!(
734                event,
735                Event::App(AppEvent {
736                    operation: operation.clone(),
737                })
738            );
739
740            assert!(is_empty_state(&telemetry));
741        });
742    }
743
744    #[gpui::test]
745    async fn test_telemetry_flush_on_flush_interval(
746        executor: BackgroundExecutor,
747        cx: &mut TestAppContext,
748    ) {
749        init_test(cx);
750        let clock = Arc::new(FakeSystemClock::new(
751            Utc.with_ymd_and_hms(1990, 4, 12, 12, 0, 0).unwrap(),
752        ));
753        let http = FakeHttpClient::with_200_response();
754        let installation_id = Some("installation_id".to_string());
755        let session_id = "session_id".to_string();
756
757        cx.update(|cx| {
758            let telemetry = Telemetry::new(clock.clone(), http, cx);
759            telemetry.state.lock().max_queue_size = 4;
760            telemetry.start(installation_id, session_id, cx);
761
762            assert!(is_empty_state(&telemetry));
763
764            let first_date_time = clock.utc_now();
765            let operation = "test".to_string();
766
767            let event = telemetry.report_app_event(operation.clone());
768            assert_eq!(
769                event,
770                Event::App(AppEvent {
771                    operation: operation.clone(),
772                })
773            );
774            assert_eq!(telemetry.state.lock().events_queue.len(), 1);
775            assert!(telemetry.state.lock().flush_events_task.is_some());
776            assert_eq!(
777                telemetry.state.lock().first_event_date_time,
778                Some(first_date_time)
779            );
780
781            let duration = Duration::from_millis(1);
782
783            // Test 1 millisecond before the flush interval limit is met
784            executor.advance_clock(FLUSH_INTERVAL - duration);
785
786            assert!(!is_empty_state(&telemetry));
787
788            // Test the exact moment the flush interval limit is met
789            executor.advance_clock(duration);
790
791            assert!(is_empty_state(&telemetry));
792        });
793    }
794
795    // TODO:
796    // Test settings
797    // Update FakeHTTPClient to keep track of the number of requests and assert on it
798
799    fn init_test(cx: &mut TestAppContext) {
800        cx.update(|cx| {
801            let settings_store = SettingsStore::test(cx);
802            cx.set_global(settings_store);
803        });
804    }
805
806    fn is_empty_state(telemetry: &Telemetry) -> bool {
807        telemetry.state.lock().events_queue.is_empty()
808            && telemetry.state.lock().flush_events_task.is_none()
809            && telemetry.state.lock().first_event_date_time.is_none()
810    }
811}
812
813pub fn calculate_json_checksum(json: &impl AsRef<[u8]>) -> Option<String> {
814    let Some(checksum_seed) = &*ZED_CLIENT_CHECKSUM_SEED else {
815        return None;
816    };
817
818    let mut summer = Sha256::new();
819    summer.update(checksum_seed);
820    summer.update(&json);
821    summer.update(checksum_seed);
822    let mut checksum = String::new();
823    for byte in summer.finalize().as_slice() {
824        use std::fmt::Write;
825        write!(&mut checksum, "{:02x}", byte).unwrap();
826    }
827
828    Some(checksum)
829}