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_client::{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, ReplEvent, 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                    "pnpm-lock.yaml".to_string(),
207                    ProjectCache::new("pnpm".to_string()),
208                ),
209                (
210                    "yarn.lock".to_string(),
211                    ProjectCache::new("yarn".to_string()),
212                ),
213                (
214                    "package.json".to_string(),
215                    ProjectCache::new("node".to_string()),
216                ),
217            ])),
218
219            os_version: None,
220            os_name: os_name(),
221            app_version: release_channel::AppVersion::global(cx).to_string(),
222        }));
223
224        #[cfg(not(debug_assertions))]
225        cx.background_executor()
226            .spawn({
227                let state = state.clone();
228                async move {
229                    if let Some(tempfile) =
230                        NamedTempFile::new_in(paths::logs_dir().as_path()).log_err()
231                    {
232                        state.lock().log_file = Some(tempfile);
233                    }
234                }
235            })
236            .detach();
237
238        cx.observe_global::<SettingsStore>({
239            let state = state.clone();
240
241            move |cx| {
242                let mut state = state.lock();
243                state.settings = *TelemetrySettings::get_global(cx);
244            }
245        })
246        .detach();
247
248        // TODO: Replace all hardware stuff with nested SystemSpecs json
249        let this = Arc::new(Self {
250            clock,
251            http_client: client,
252            executor: cx.background_executor().clone(),
253            state,
254        });
255
256        // We should only ever have one instance of Telemetry, leak the subscription to keep it alive
257        // rather than store in TelemetryState, complicating spawn as subscriptions are not Send
258        std::mem::forget(cx.on_app_quit({
259            let this = this.clone();
260            move |_| this.shutdown_telemetry()
261        }));
262
263        this
264    }
265
266    #[cfg(any(test, feature = "test-support"))]
267    fn shutdown_telemetry(self: &Arc<Self>) -> impl Future<Output = ()> {
268        Task::ready(())
269    }
270
271    // Skip calling this function in tests.
272    // TestAppContext ends up calling this function on shutdown and it panics when trying to find the TelemetrySettings
273    #[cfg(not(any(test, feature = "test-support")))]
274    fn shutdown_telemetry(self: &Arc<Self>) -> impl Future<Output = ()> {
275        self.report_app_event("close".to_string());
276        // TODO: close final edit period and make sure it's sent
277        Task::ready(())
278    }
279
280    pub fn log_file_path(&self) -> Option<PathBuf> {
281        Some(self.state.lock().log_file.as_ref()?.path().to_path_buf())
282    }
283
284    pub fn start(
285        self: &Arc<Self>,
286        installation_id: Option<String>,
287        session_id: String,
288        cx: &mut AppContext,
289    ) {
290        let mut state = self.state.lock();
291        state.installation_id = installation_id.map(|id| id.into());
292        state.session_id = Some(session_id);
293        state.app_version = release_channel::AppVersion::global(cx).to_string();
294        state.os_name = os_name();
295
296        drop(state);
297
298        let this = self.clone();
299        cx.background_executor()
300            .spawn(async move {
301                let mut system = System::new_with_specifics(
302                    RefreshKind::new().with_cpu(CpuRefreshKind::everything()),
303                );
304
305                let refresh_kind = ProcessRefreshKind::new().with_cpu().with_memory();
306                let current_process = Pid::from_u32(std::process::id());
307                system.refresh_process_specifics(current_process, refresh_kind);
308
309                // Waiting some amount of time before the first query is important to get a reasonable value
310                // https://docs.rs/sysinfo/0.29.10/sysinfo/trait.ProcessExt.html#tymethod.cpu_usage
311                const DURATION_BETWEEN_SYSTEM_EVENTS: Duration = Duration::from_secs(4 * 60);
312
313                loop {
314                    smol::Timer::after(DURATION_BETWEEN_SYSTEM_EVENTS).await;
315
316                    let current_process = Pid::from_u32(std::process::id());
317                    system.refresh_process_specifics(current_process, refresh_kind);
318                    let Some(process) = system.process(current_process) else {
319                        log::error!(
320                            "Failed to find own process {current_process:?} in system process table"
321                        );
322                        // TODO: Fire an error telemetry event
323                        return;
324                    };
325
326                    this.report_memory_event(process.memory(), process.virtual_memory());
327                    this.report_cpu_event(process.cpu_usage(), system.cpus().len() as u32);
328                }
329            })
330            .detach();
331    }
332
333    pub fn set_authenticated_user_info(
334        self: &Arc<Self>,
335        metrics_id: Option<String>,
336        is_staff: bool,
337    ) {
338        let mut state = self.state.lock();
339
340        if !state.settings.metrics {
341            return;
342        }
343
344        let metrics_id: Option<Arc<str>> = metrics_id.map(|id| id.into());
345        state.metrics_id.clone_from(&metrics_id);
346        state.is_staff = Some(is_staff);
347        drop(state);
348    }
349
350    pub fn report_editor_event(
351        self: &Arc<Self>,
352        file_extension: Option<String>,
353        vim_mode: bool,
354        operation: &'static str,
355        copilot_enabled: bool,
356        copilot_enabled_for_language: bool,
357    ) {
358        let event = Event::Editor(EditorEvent {
359            file_extension,
360            vim_mode,
361            operation: operation.into(),
362            copilot_enabled,
363            copilot_enabled_for_language,
364        });
365
366        self.report_event(event)
367    }
368
369    pub fn report_inline_completion_event(
370        self: &Arc<Self>,
371        provider: String,
372        suggestion_accepted: bool,
373        file_extension: Option<String>,
374    ) {
375        let event = Event::InlineCompletion(InlineCompletionEvent {
376            provider,
377            suggestion_accepted,
378            file_extension,
379        });
380
381        self.report_event(event)
382    }
383
384    pub fn report_assistant_event(
385        self: &Arc<Self>,
386        conversation_id: Option<String>,
387        kind: AssistantKind,
388        model: String,
389        response_latency: Option<Duration>,
390        error_message: Option<String>,
391    ) {
392        let event = Event::Assistant(AssistantEvent {
393            conversation_id,
394            kind,
395            model: model.to_string(),
396            response_latency,
397            error_message,
398        });
399
400        self.report_event(event)
401    }
402
403    pub fn report_call_event(
404        self: &Arc<Self>,
405        operation: &'static str,
406        room_id: Option<u64>,
407        channel_id: Option<ChannelId>,
408    ) {
409        let event = Event::Call(CallEvent {
410            operation: operation.to_string(),
411            room_id,
412            channel_id: channel_id.map(|cid| cid.0),
413        });
414
415        self.report_event(event)
416    }
417
418    pub fn report_cpu_event(self: &Arc<Self>, usage_as_percentage: f32, core_count: u32) {
419        let event = Event::Cpu(CpuEvent {
420            usage_as_percentage,
421            core_count,
422        });
423
424        self.report_event(event)
425    }
426
427    pub fn report_memory_event(
428        self: &Arc<Self>,
429        memory_in_bytes: u64,
430        virtual_memory_in_bytes: u64,
431    ) {
432        let event = Event::Memory(MemoryEvent {
433            memory_in_bytes,
434            virtual_memory_in_bytes,
435        });
436
437        self.report_event(event)
438    }
439
440    pub fn report_app_event(self: &Arc<Self>, operation: String) -> Event {
441        let event = Event::App(AppEvent { operation });
442
443        self.report_event(event.clone());
444
445        event
446    }
447
448    pub fn report_setting_event(self: &Arc<Self>, setting: &'static str, value: String) {
449        let event = Event::Setting(SettingEvent {
450            setting: setting.to_string(),
451            value,
452        });
453
454        self.report_event(event)
455    }
456
457    pub fn report_extension_event(self: &Arc<Self>, extension_id: Arc<str>, version: Arc<str>) {
458        self.report_event(Event::Extension(ExtensionEvent {
459            extension_id,
460            version,
461        }))
462    }
463
464    pub fn log_edit_event(self: &Arc<Self>, environment: &'static str) {
465        let mut state = self.state.lock();
466        let period_data = state.event_coalescer.log_event(environment);
467        drop(state);
468
469        if let Some((start, end, environment)) = period_data {
470            let event = Event::Edit(EditEvent {
471                duration: end.timestamp_millis() - start.timestamp_millis(),
472                environment: environment.to_string(),
473            });
474
475            self.report_event(event);
476        }
477    }
478
479    pub fn report_action_event(self: &Arc<Self>, source: &'static str, action: String) {
480        let event = Event::Action(ActionEvent {
481            source: source.to_string(),
482            action,
483        });
484
485        self.report_event(event)
486    }
487
488    pub fn report_discovered_project_events(
489        self: &Arc<Self>,
490        worktree_id: WorktreeId,
491        updated_entries_set: &UpdatedEntriesSet,
492    ) {
493        let project_names: Vec<String> = {
494            let mut state = self.state.lock();
495            state
496                .worktree_id_map
497                .0
498                .iter_mut()
499                .filter_map(|(project_file_name, project_type_telemetry)| {
500                    if project_type_telemetry
501                        .worktree_ids_reported
502                        .contains(&worktree_id)
503                    {
504                        return None;
505                    }
506
507                    let project_file_found = updated_entries_set.iter().any(|(path, _, _)| {
508                        path.as_ref()
509                            .file_name()
510                            .and_then(|name| name.to_str())
511                            .map(|name_str| name_str == project_file_name)
512                            .unwrap_or(false)
513                    });
514
515                    if !project_file_found {
516                        return None;
517                    }
518
519                    project_type_telemetry
520                        .worktree_ids_reported
521                        .insert(worktree_id);
522
523                    Some(project_type_telemetry.name.clone())
524                })
525                .collect()
526        };
527
528        // Done on purpose to avoid calling `self.state.lock()` multiple times
529        for project_name in project_names {
530            self.report_app_event(format!("open {} project", project_name));
531        }
532    }
533
534    pub fn report_repl_event(
535        self: &Arc<Self>,
536        kernel_language: String,
537        kernel_status: String,
538        repl_session_id: String,
539    ) {
540        let event = Event::Repl(ReplEvent {
541            kernel_language,
542            kernel_status,
543            repl_session_id,
544        });
545
546        self.report_event(event)
547    }
548
549    fn report_event(self: &Arc<Self>, event: Event) {
550        let mut state = self.state.lock();
551
552        if !state.settings.metrics {
553            return;
554        }
555
556        if state.flush_events_task.is_none() {
557            let this = self.clone();
558            let executor = self.executor.clone();
559            state.flush_events_task = Some(self.executor.spawn(async move {
560                executor.timer(FLUSH_INTERVAL).await;
561                this.flush_events();
562            }));
563        }
564
565        let date_time = self.clock.utc_now();
566
567        let milliseconds_since_first_event = match state.first_event_date_time {
568            Some(first_event_date_time) => {
569                date_time.timestamp_millis() - first_event_date_time.timestamp_millis()
570            }
571            None => {
572                state.first_event_date_time = Some(date_time);
573                0
574            }
575        };
576
577        let signed_in = state.metrics_id.is_some();
578        state.events_queue.push(EventWrapper {
579            signed_in,
580            milliseconds_since_first_event,
581            event,
582        });
583
584        if state.installation_id.is_some() && state.events_queue.len() >= state.max_queue_size {
585            drop(state);
586            self.flush_events();
587        }
588    }
589
590    pub fn metrics_id(self: &Arc<Self>) -> Option<Arc<str>> {
591        self.state.lock().metrics_id.clone()
592    }
593
594    pub fn installation_id(self: &Arc<Self>) -> Option<Arc<str>> {
595        self.state.lock().installation_id.clone()
596    }
597
598    pub fn is_staff(self: &Arc<Self>) -> Option<bool> {
599        self.state.lock().is_staff
600    }
601
602    pub fn flush_events(self: &Arc<Self>) {
603        let mut state = self.state.lock();
604        state.first_event_date_time = None;
605        let mut events = mem::take(&mut state.events_queue);
606        state.flush_events_task.take();
607        drop(state);
608        if events.is_empty() {
609            return;
610        }
611
612        let this = self.clone();
613        self.executor
614            .spawn(
615                async move {
616                    let mut json_bytes = Vec::new();
617
618                    if let Some(file) = &mut this.state.lock().log_file {
619                        let file = file.as_file_mut();
620                        for event in &mut events {
621                            json_bytes.clear();
622                            serde_json::to_writer(&mut json_bytes, event)?;
623                            file.write_all(&json_bytes)?;
624                            file.write_all(b"\n")?;
625                        }
626                    }
627
628                    {
629                        let state = this.state.lock();
630
631                        let request_body = EventRequestBody {
632                            installation_id: state.installation_id.as_deref().map(Into::into),
633                            metrics_id: state.metrics_id.as_deref().map(Into::into),
634                            session_id: state.session_id.clone(),
635                            is_staff: state.is_staff,
636                            app_version: state.app_version.clone(),
637                            os_name: state.os_name.clone(),
638                            os_version: state.os_version.clone(),
639                            architecture: state.architecture.to_string(),
640
641                            release_channel: state.release_channel.map(Into::into),
642                            events,
643                        };
644                        json_bytes.clear();
645                        serde_json::to_writer(&mut json_bytes, &request_body)?;
646                    }
647
648                    let checksum = calculate_json_checksum(&json_bytes).unwrap_or("".to_string());
649
650                    let request = http_client::Request::builder()
651                        .method(Method::POST)
652                        .uri(
653                            this.http_client
654                                .build_zed_api_url("/telemetry/events", &[])?
655                                .as_ref(),
656                        )
657                        .header("Content-Type", "text/plain")
658                        .header("x-zed-checksum", checksum)
659                        .body(json_bytes.into());
660
661                    let response = this.http_client.send(request?).await?;
662                    if response.status() != 200 {
663                        log::error!("Failed to send events: HTTP {:?}", response.status());
664                    }
665                    anyhow::Ok(())
666                }
667                .log_err(),
668            )
669            .detach();
670    }
671}
672
673pub fn calculate_json_checksum(json: &impl AsRef<[u8]>) -> Option<String> {
674    let Some(checksum_seed) = &*ZED_CLIENT_CHECKSUM_SEED else {
675        return None;
676    };
677
678    let mut summer = Sha256::new();
679    summer.update(checksum_seed);
680    summer.update(json);
681    summer.update(checksum_seed);
682    let mut checksum = String::new();
683    for byte in summer.finalize().as_slice() {
684        use std::fmt::Write;
685        write!(&mut checksum, "{:02x}", byte).unwrap();
686    }
687
688    Some(checksum)
689}
690
691#[cfg(test)]
692mod tests {
693    use super::*;
694    use chrono::TimeZone;
695    use clock::FakeSystemClock;
696    use gpui::TestAppContext;
697    use http_client::FakeHttpClient;
698
699    #[gpui::test]
700    fn test_telemetry_flush_on_max_queue_size(cx: &mut TestAppContext) {
701        init_test(cx);
702        let clock = Arc::new(FakeSystemClock::new(
703            Utc.with_ymd_and_hms(1990, 4, 12, 12, 0, 0).unwrap(),
704        ));
705        let http = FakeHttpClient::with_200_response();
706        let installation_id = Some("installation_id".to_string());
707        let session_id = "session_id".to_string();
708
709        cx.update(|cx| {
710            let telemetry = Telemetry::new(clock.clone(), http, cx);
711
712            telemetry.state.lock().max_queue_size = 4;
713            telemetry.start(installation_id, session_id, cx);
714
715            assert!(is_empty_state(&telemetry));
716
717            let first_date_time = clock.utc_now();
718            let operation = "test".to_string();
719
720            let event = telemetry.report_app_event(operation.clone());
721            assert_eq!(
722                event,
723                Event::App(AppEvent {
724                    operation: operation.clone(),
725                })
726            );
727            assert_eq!(telemetry.state.lock().events_queue.len(), 1);
728            assert!(telemetry.state.lock().flush_events_task.is_some());
729            assert_eq!(
730                telemetry.state.lock().first_event_date_time,
731                Some(first_date_time)
732            );
733
734            clock.advance(chrono::Duration::milliseconds(100));
735
736            let event = telemetry.report_app_event(operation.clone());
737            assert_eq!(
738                event,
739                Event::App(AppEvent {
740                    operation: operation.clone(),
741                })
742            );
743            assert_eq!(telemetry.state.lock().events_queue.len(), 2);
744            assert!(telemetry.state.lock().flush_events_task.is_some());
745            assert_eq!(
746                telemetry.state.lock().first_event_date_time,
747                Some(first_date_time)
748            );
749
750            clock.advance(chrono::Duration::milliseconds(100));
751
752            let event = telemetry.report_app_event(operation.clone());
753            assert_eq!(
754                event,
755                Event::App(AppEvent {
756                    operation: operation.clone(),
757                })
758            );
759            assert_eq!(telemetry.state.lock().events_queue.len(), 3);
760            assert!(telemetry.state.lock().flush_events_task.is_some());
761            assert_eq!(
762                telemetry.state.lock().first_event_date_time,
763                Some(first_date_time)
764            );
765
766            clock.advance(chrono::Duration::milliseconds(100));
767
768            // Adding a 4th event should cause a flush
769            let event = telemetry.report_app_event(operation.clone());
770            assert_eq!(
771                event,
772                Event::App(AppEvent {
773                    operation: operation.clone(),
774                })
775            );
776
777            assert!(is_empty_state(&telemetry));
778        });
779    }
780
781    #[gpui::test]
782    async fn test_telemetry_flush_on_flush_interval(
783        executor: BackgroundExecutor,
784        cx: &mut TestAppContext,
785    ) {
786        init_test(cx);
787        let clock = Arc::new(FakeSystemClock::new(
788            Utc.with_ymd_and_hms(1990, 4, 12, 12, 0, 0).unwrap(),
789        ));
790        let http = FakeHttpClient::with_200_response();
791        let installation_id = Some("installation_id".to_string());
792        let session_id = "session_id".to_string();
793
794        cx.update(|cx| {
795            let telemetry = Telemetry::new(clock.clone(), http, cx);
796            telemetry.state.lock().max_queue_size = 4;
797            telemetry.start(installation_id, session_id, cx);
798
799            assert!(is_empty_state(&telemetry));
800
801            let first_date_time = clock.utc_now();
802            let operation = "test".to_string();
803
804            let event = telemetry.report_app_event(operation.clone());
805            assert_eq!(
806                event,
807                Event::App(AppEvent {
808                    operation: operation.clone(),
809                })
810            );
811            assert_eq!(telemetry.state.lock().events_queue.len(), 1);
812            assert!(telemetry.state.lock().flush_events_task.is_some());
813            assert_eq!(
814                telemetry.state.lock().first_event_date_time,
815                Some(first_date_time)
816            );
817
818            let duration = Duration::from_millis(1);
819
820            // Test 1 millisecond before the flush interval limit is met
821            executor.advance_clock(FLUSH_INTERVAL - duration);
822
823            assert!(!is_empty_state(&telemetry));
824
825            // Test the exact moment the flush interval limit is met
826            executor.advance_clock(duration);
827
828            assert!(is_empty_state(&telemetry));
829        });
830    }
831
832    // TODO:
833    // Test settings
834    // Update FakeHTTPClient to keep track of the number of requests and assert on it
835
836    fn init_test(cx: &mut TestAppContext) {
837        cx.update(|cx| {
838            let settings_store = SettingsStore::test(cx);
839            cx.set_global(settings_store);
840        });
841    }
842
843    fn is_empty_state(telemetry: &Telemetry) -> bool {
844        telemetry.state.lock().events_queue.is_empty()
845            && telemetry.state.lock().flush_events_task.is_none()
846            && telemetry.state.lock().first_event_date_time.is_none()
847    }
848}