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