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