1mod event_coalescer;
2
3use crate::TelemetrySettings;
4use anyhow::Result;
5use clock::SystemClock;
6use futures::channel::mpsc;
7use futures::{Future, FutureExt, StreamExt};
8use gpui::{App, AppContext as _, BackgroundExecutor, Task};
9use http_client::{self, AsyncBody, HttpClient, HttpClientWithUrl, Method, Request};
10use parking_lot::Mutex;
11use regex::Regex;
12use release_channel::ReleaseChannel;
13use settings::{Settings, SettingsStore};
14use sha2::{Digest, Sha256};
15use std::collections::HashSet;
16use std::fs::File;
17use std::io::Write;
18use std::sync::LazyLock;
19use std::time::Instant;
20use std::{env, mem, path::PathBuf, sync::Arc, time::Duration};
21use telemetry_events::{AssistantEventData, AssistantPhase, Event, EventRequestBody, EventWrapper};
22use util::TryFutureExt;
23use worktree::{UpdatedEntriesSet, WorktreeId};
24
25use self::event_coalescer::EventCoalescer;
26
27pub struct Telemetry {
28 clock: Arc<dyn SystemClock>,
29 http_client: Arc<HttpClientWithUrl>,
30 executor: BackgroundExecutor,
31 state: Arc<Mutex<TelemetryState>>,
32}
33
34struct TelemetryState {
35 settings: TelemetrySettings,
36 system_id: Option<Arc<str>>, // Per system
37 installation_id: Option<Arc<str>>, // Per app installation (different for dev, nightly, preview, and stable)
38 session_id: Option<String>, // Per app launch
39 metrics_id: Option<Arc<str>>, // Per logged-in user
40 release_channel: Option<&'static str>,
41 architecture: &'static str,
42 events_queue: Vec<EventWrapper>,
43 flush_events_task: Option<Task<()>>,
44 log_file: Option<File>,
45 is_staff: Option<bool>,
46 first_event_date_time: Option<Instant>,
47 event_coalescer: EventCoalescer,
48 max_queue_size: usize,
49 worktrees_with_project_type_events_sent: HashSet<WorktreeId>,
50
51 os_name: String,
52 app_version: String,
53 os_version: Option<String>,
54}
55
56#[cfg(debug_assertions)]
57const MAX_QUEUE_LEN: usize = 5;
58
59#[cfg(not(debug_assertions))]
60const MAX_QUEUE_LEN: usize = 50;
61
62#[cfg(debug_assertions)]
63const FLUSH_INTERVAL: Duration = Duration::from_secs(1);
64
65#[cfg(not(debug_assertions))]
66const FLUSH_INTERVAL: Duration = Duration::from_secs(60 * 5);
67static ZED_CLIENT_CHECKSUM_SEED: LazyLock<Option<Vec<u8>>> = LazyLock::new(|| {
68 option_env!("ZED_CLIENT_CHECKSUM_SEED")
69 .map(|s| s.as_bytes().into())
70 .or_else(|| {
71 env::var("ZED_CLIENT_CHECKSUM_SEED")
72 .ok()
73 .map(|s| s.as_bytes().into())
74 })
75});
76
77pub static MINIDUMP_ENDPOINT: LazyLock<Option<String>> = LazyLock::new(|| {
78 option_env!("ZED_MINIDUMP_ENDPOINT")
79 .map(str::to_string)
80 .or_else(|| env::var("ZED_MINIDUMP_ENDPOINT").ok())
81});
82
83static DOTNET_PROJECT_FILES_REGEX: LazyLock<Regex> = LazyLock::new(|| {
84 Regex::new(r"^(global\.json|Directory\.Build\.props|.*\.(csproj|fsproj|vbproj|sln))$").unwrap()
85});
86
87#[cfg(target_os = "macos")]
88static MACOS_VERSION_REGEX: LazyLock<Regex> =
89 LazyLock::new(|| Regex::new(r"(\s*\(Build [^)]*[0-9]\))").unwrap());
90
91pub fn os_name() -> String {
92 #[cfg(target_os = "macos")]
93 {
94 "macOS".to_string()
95 }
96 #[cfg(target_os = "linux")]
97 {
98 format!("Linux {}", gpui::guess_compositor())
99 }
100 #[cfg(target_os = "freebsd")]
101 {
102 format!("FreeBSD {}", gpui::guess_compositor())
103 }
104
105 #[cfg(target_os = "windows")]
106 {
107 "Windows".to_string()
108 }
109}
110
111/// Note: This might do blocking IO! Only call from background threads
112pub fn os_version() -> String {
113 #[cfg(target_os = "macos")]
114 {
115 use objc2_foundation::NSProcessInfo;
116 let process_info = NSProcessInfo::processInfo();
117 let version_nsstring = unsafe { process_info.operatingSystemVersionString() };
118 // "Version 15.6.1 (Build 24G90)" -> "15.6.1 (Build 24G90)"
119 let version_string = version_nsstring.to_string().replace("Version ", "");
120 // "15.6.1 (Build 24G90)" -> "15.6.1"
121 // "26.0.0 (Build 25A5349a)" -> unchanged (Beta or Rapid Security Response; ends with letter)
122 MACOS_VERSION_REGEX
123 .replace_all(&version_string, "")
124 .to_string()
125 }
126 #[cfg(any(target_os = "linux", target_os = "freebsd"))]
127 {
128 use std::path::Path;
129
130 let content = if let Ok(file) = std::fs::read_to_string(&Path::new("/etc/os-release")) {
131 file
132 } else if let Ok(file) = std::fs::read_to_string(&Path::new("/usr/lib/os-release")) {
133 file
134 } else if let Ok(file) = std::fs::read_to_string(&Path::new("/var/run/os-release")) {
135 file
136 } else {
137 log::error!(
138 "Failed to load /etc/os-release, /usr/lib/os-release, or /var/run/os-release"
139 );
140 "".to_string()
141 };
142 let mut name = "unknown";
143 let mut version = "unknown";
144
145 for line in content.lines() {
146 match line.split_once('=') {
147 Some(("ID", val)) => name = val.trim_matches('"'),
148 Some(("VERSION_ID", val)) => version = val.trim_matches('"'),
149 _ => {}
150 }
151 }
152
153 format!("{} {}", name, version)
154 }
155
156 #[cfg(target_os = "windows")]
157 {
158 let mut info = unsafe { std::mem::zeroed() };
159 let status = unsafe { windows::Wdk::System::SystemServices::RtlGetVersion(&mut info) };
160 if status.is_ok() {
161 gpui::SemanticVersion::new(
162 info.dwMajorVersion as _,
163 info.dwMinorVersion as _,
164 info.dwBuildNumber as _,
165 )
166 .to_string()
167 } else {
168 "unknown".to_string()
169 }
170 }
171}
172
173impl Telemetry {
174 pub fn new(
175 clock: Arc<dyn SystemClock>,
176 client: Arc<HttpClientWithUrl>,
177 cx: &mut App,
178 ) -> Arc<Self> {
179 let release_channel =
180 ReleaseChannel::try_global(cx).map(|release_channel| release_channel.display_name());
181
182 TelemetrySettings::register(cx);
183
184 let state = Arc::new(Mutex::new(TelemetryState {
185 settings: *TelemetrySettings::get_global(cx),
186 architecture: env::consts::ARCH,
187 release_channel,
188 system_id: None,
189 installation_id: None,
190 session_id: None,
191 metrics_id: None,
192 events_queue: Vec::new(),
193 flush_events_task: None,
194 log_file: None,
195 is_staff: None,
196 first_event_date_time: None,
197 event_coalescer: EventCoalescer::new(clock.clone()),
198 max_queue_size: MAX_QUEUE_LEN,
199 worktrees_with_project_type_events_sent: HashSet::new(),
200
201 os_version: None,
202 os_name: os_name(),
203 app_version: release_channel::AppVersion::global(cx).to_string(),
204 }));
205 Self::log_file_path();
206
207 cx.background_spawn({
208 let state = state.clone();
209 let os_version = os_version();
210 state.lock().os_version = Some(os_version);
211 async move {
212 if let Some(tempfile) = File::create(Self::log_file_path()).ok() {
213 state.lock().log_file = Some(tempfile);
214 }
215 }
216 })
217 .detach();
218
219 cx.observe_global::<SettingsStore>({
220 let state = state.clone();
221
222 move |cx| {
223 let mut state = state.lock();
224 state.settings = *TelemetrySettings::get_global(cx);
225 }
226 })
227 .detach();
228
229 let this = Arc::new(Self {
230 clock,
231 http_client: client,
232 executor: cx.background_executor().clone(),
233 state,
234 });
235
236 let (tx, mut rx) = mpsc::unbounded();
237 ::telemetry::init(tx);
238
239 cx.background_spawn({
240 let this = Arc::downgrade(&this);
241 async move {
242 while let Some(event) = rx.next().await {
243 let Some(state) = this.upgrade() else { break };
244 state.report_event(Event::Flexible(event))
245 }
246 }
247 })
248 .detach();
249
250 // We should only ever have one instance of Telemetry, leak the subscription to keep it alive
251 // rather than store in TelemetryState, complicating spawn as subscriptions are not Send
252 std::mem::forget(cx.on_app_quit({
253 let this = this.clone();
254 move |_| this.shutdown_telemetry()
255 }));
256
257 this
258 }
259
260 #[cfg(any(test, feature = "test-support"))]
261 fn shutdown_telemetry(self: &Arc<Self>) -> impl Future<Output = ()> + use<> {
262 Task::ready(())
263 }
264
265 // Skip calling this function in tests.
266 // TestAppContext ends up calling this function on shutdown and it panics when trying to find the TelemetrySettings
267 #[cfg(not(any(test, feature = "test-support")))]
268 fn shutdown_telemetry(self: &Arc<Self>) -> impl Future<Output = ()> + use<> {
269 telemetry::event!("App Closed");
270 // TODO: close final edit period and make sure it's sent
271 Task::ready(())
272 }
273
274 pub fn log_file_path() -> PathBuf {
275 paths::logs_dir().join("telemetry.log")
276 }
277
278 pub fn has_checksum_seed(&self) -> bool {
279 ZED_CLIENT_CHECKSUM_SEED.is_some()
280 }
281
282 pub fn start(
283 self: &Arc<Self>,
284 system_id: Option<String>,
285 installation_id: Option<String>,
286 session_id: String,
287 cx: &App,
288 ) {
289 let mut state = self.state.lock();
290 state.system_id = system_id.map(|id| id.into());
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
297 pub fn metrics_enabled(self: &Arc<Self>) -> bool {
298 let state = self.state.lock();
299 let enabled = state.settings.metrics;
300 drop(state);
301 enabled
302 }
303
304 pub fn set_authenticated_user_info(
305 self: &Arc<Self>,
306 metrics_id: Option<String>,
307 is_staff: bool,
308 ) {
309 let mut state = self.state.lock();
310
311 if !state.settings.metrics {
312 return;
313 }
314
315 let metrics_id: Option<Arc<str>> = metrics_id.map(|id| id.into());
316 state.metrics_id.clone_from(&metrics_id);
317 state.is_staff = Some(is_staff);
318 drop(state);
319 }
320
321 pub fn report_assistant_event(self: &Arc<Self>, event: AssistantEventData) {
322 let event_type = match event.phase {
323 AssistantPhase::Response => "Assistant Responded",
324 AssistantPhase::Invoked => "Assistant Invoked",
325 AssistantPhase::Accepted => "Assistant Response Accepted",
326 AssistantPhase::Rejected => "Assistant Response Rejected",
327 };
328
329 telemetry::event!(
330 event_type,
331 conversation_id = event.conversation_id,
332 kind = event.kind,
333 phase = event.phase,
334 message_id = event.message_id,
335 model = event.model,
336 model_provider = event.model_provider,
337 response_latency = event.response_latency,
338 error_message = event.error_message,
339 language_name = event.language_name,
340 );
341 }
342
343 pub fn log_edit_event(self: &Arc<Self>, environment: &'static str, is_via_ssh: bool) {
344 static LAST_EVENT_TIME: Mutex<Option<Instant>> = Mutex::new(None);
345
346 let mut state = self.state.lock();
347 let period_data = state.event_coalescer.log_event(environment);
348 drop(state);
349
350 if let Some(mut last_event) = LAST_EVENT_TIME.try_lock() {
351 let current_time = std::time::Instant::now();
352 let last_time = last_event.get_or_insert(current_time);
353
354 if current_time.duration_since(*last_time) > Duration::from_secs(60 * 10) {
355 *last_time = current_time;
356 } else {
357 return;
358 }
359
360 if let Some((start, end, environment)) = period_data {
361 let duration = end
362 .saturating_duration_since(start)
363 .min(Duration::from_secs(60 * 60 * 24))
364 .as_millis() as i64;
365
366 telemetry::event!(
367 "Editor Edited",
368 duration = duration,
369 environment = environment,
370 is_via_ssh = is_via_ssh
371 );
372 }
373 }
374 }
375
376 pub fn report_discovered_project_type_events(
377 self: &Arc<Self>,
378 worktree_id: WorktreeId,
379 updated_entries_set: &UpdatedEntriesSet,
380 ) {
381 let Some(project_types) = self.detect_project_types(worktree_id, updated_entries_set)
382 else {
383 return;
384 };
385
386 for project_type in project_types {
387 telemetry::event!("Project Opened", project_type = project_type);
388 }
389 }
390
391 fn detect_project_types(
392 self: &Arc<Self>,
393 worktree_id: WorktreeId,
394 updated_entries_set: &UpdatedEntriesSet,
395 ) -> Option<Vec<String>> {
396 let mut state = self.state.lock();
397
398 if state
399 .worktrees_with_project_type_events_sent
400 .contains(&worktree_id)
401 {
402 return None;
403 }
404
405 let mut project_types: HashSet<&str> = HashSet::new();
406
407 for (path, _, _) in updated_entries_set.iter() {
408 let Some(file_name) = path.file_name().and_then(|f| f.to_str()) else {
409 continue;
410 };
411
412 let project_type = if file_name == "pnpm-lock.yaml" {
413 Some("pnpm")
414 } else if file_name == "yarn.lock" {
415 Some("yarn")
416 } else if file_name == "package.json" {
417 Some("node")
418 } else if DOTNET_PROJECT_FILES_REGEX.is_match(file_name) {
419 Some("dotnet")
420 } else {
421 None
422 };
423
424 if let Some(project_type) = project_type {
425 project_types.insert(project_type);
426 };
427 }
428
429 if !project_types.is_empty() {
430 state
431 .worktrees_with_project_type_events_sent
432 .insert(worktree_id);
433 }
434
435 let mut project_types: Vec<_> = project_types.into_iter().map(String::from).collect();
436 project_types.sort();
437 Some(project_types)
438 }
439
440 fn report_event(self: &Arc<Self>, event: Event) {
441 let mut state = self.state.lock();
442 // RUST_LOG=telemetry=trace to debug telemetry events
443 log::trace!(target: "telemetry", "{:?}", event);
444
445 if !state.settings.metrics {
446 return;
447 }
448
449 if state.flush_events_task.is_none() {
450 let this = self.clone();
451 state.flush_events_task = Some(self.executor.spawn(async move {
452 this.executor.timer(FLUSH_INTERVAL).await;
453 this.flush_events().detach();
454 }));
455 }
456
457 let date_time = self.clock.utc_now();
458
459 let milliseconds_since_first_event = match state.first_event_date_time {
460 Some(first_event_date_time) => date_time
461 .saturating_duration_since(first_event_date_time)
462 .min(Duration::from_secs(60 * 60 * 24))
463 .as_millis() as i64,
464 None => {
465 state.first_event_date_time = Some(date_time);
466 0
467 }
468 };
469
470 let signed_in = state.metrics_id.is_some();
471 state.events_queue.push(EventWrapper {
472 signed_in,
473 milliseconds_since_first_event,
474 event,
475 });
476
477 if state.installation_id.is_some() && state.events_queue.len() >= state.max_queue_size {
478 drop(state);
479 self.flush_events().detach();
480 }
481 }
482
483 pub fn metrics_id(self: &Arc<Self>) -> Option<Arc<str>> {
484 self.state.lock().metrics_id.clone()
485 }
486
487 pub fn system_id(self: &Arc<Self>) -> Option<Arc<str>> {
488 self.state.lock().system_id.clone()
489 }
490
491 pub fn installation_id(self: &Arc<Self>) -> Option<Arc<str>> {
492 self.state.lock().installation_id.clone()
493 }
494
495 pub fn is_staff(self: &Arc<Self>) -> Option<bool> {
496 self.state.lock().is_staff
497 }
498
499 fn build_request(
500 self: &Arc<Self>,
501 // We take in the JSON bytes buffer so we can reuse the existing allocation.
502 mut json_bytes: Vec<u8>,
503 event_request: &EventRequestBody,
504 ) -> Result<Request<AsyncBody>> {
505 json_bytes.clear();
506 serde_json::to_writer(&mut json_bytes, event_request)?;
507
508 let checksum = calculate_json_checksum(&json_bytes).unwrap_or_default();
509
510 Ok(Request::builder()
511 .method(Method::POST)
512 .uri(
513 self.http_client
514 .build_zed_api_url("/telemetry/events", &[])?
515 .as_ref(),
516 )
517 .header("Content-Type", "application/json")
518 .header("x-zed-checksum", checksum)
519 .body(json_bytes.into())?)
520 }
521
522 pub fn flush_events(self: &Arc<Self>) -> Task<()> {
523 let mut state = self.state.lock();
524 state.first_event_date_time = None;
525 let events = mem::take(&mut state.events_queue);
526 state.flush_events_task.take();
527 drop(state);
528 if events.is_empty() {
529 return Task::ready(());
530 }
531
532 let this = self.clone();
533 self.executor.spawn(
534 async move {
535 let mut json_bytes = Vec::new();
536
537 if let Some(file) = &mut this.state.lock().log_file {
538 for event in &events {
539 json_bytes.clear();
540 serde_json::to_writer(&mut json_bytes, event)?;
541 file.write_all(&json_bytes)?;
542 file.write_all(b"\n")?;
543 }
544 }
545
546 let request_body = {
547 let state = this.state.lock();
548
549 EventRequestBody {
550 system_id: state.system_id.as_deref().map(Into::into),
551 installation_id: state.installation_id.as_deref().map(Into::into),
552 session_id: state.session_id.clone(),
553 metrics_id: state.metrics_id.as_deref().map(Into::into),
554 is_staff: state.is_staff,
555 app_version: state.app_version.clone(),
556 os_name: state.os_name.clone(),
557 os_version: state.os_version.clone(),
558 architecture: state.architecture.to_string(),
559
560 release_channel: state.release_channel.map(Into::into),
561 events,
562 }
563 };
564
565 let request = this.build_request(json_bytes, &request_body)?;
566 let response = this.http_client.send(request).await?;
567 if response.status() != 200 {
568 log::error!("Failed to send events: HTTP {:?}", response.status());
569 }
570 anyhow::Ok(())
571 }
572 .log_err()
573 .map(|_| ()),
574 )
575 }
576}
577
578pub fn calculate_json_checksum(json: &impl AsRef<[u8]>) -> Option<String> {
579 let Some(checksum_seed) = &*ZED_CLIENT_CHECKSUM_SEED else {
580 return None;
581 };
582
583 let mut summer = Sha256::new();
584 summer.update(checksum_seed);
585 summer.update(json);
586 summer.update(checksum_seed);
587 let mut checksum = String::new();
588 for byte in summer.finalize().as_slice() {
589 use std::fmt::Write;
590 write!(&mut checksum, "{:02x}", byte).unwrap();
591 }
592
593 Some(checksum)
594}
595
596#[cfg(test)]
597mod tests {
598 use super::*;
599 use clock::FakeSystemClock;
600 use gpui::TestAppContext;
601 use http_client::FakeHttpClient;
602 use std::collections::HashMap;
603 use telemetry_events::FlexibleEvent;
604 use worktree::{PathChange, ProjectEntryId, WorktreeId};
605
606 #[gpui::test]
607 fn test_telemetry_flush_on_max_queue_size(cx: &mut TestAppContext) {
608 init_test(cx);
609 let clock = Arc::new(FakeSystemClock::new());
610 let http = FakeHttpClient::with_200_response();
611 let system_id = Some("system_id".to_string());
612 let installation_id = Some("installation_id".to_string());
613 let session_id = "session_id".to_string();
614
615 cx.update(|cx| {
616 let telemetry = Telemetry::new(clock.clone(), http, cx);
617
618 telemetry.state.lock().max_queue_size = 4;
619 telemetry.start(system_id, installation_id, session_id, cx);
620
621 assert!(is_empty_state(&telemetry));
622
623 let first_date_time = clock.utc_now();
624 let event_properties = HashMap::from_iter([(
625 "test_key".to_string(),
626 serde_json::Value::String("test_value".to_string()),
627 )]);
628
629 let event = FlexibleEvent {
630 event_type: "test".to_string(),
631 event_properties,
632 };
633
634 telemetry.report_event(Event::Flexible(event.clone()));
635 assert_eq!(telemetry.state.lock().events_queue.len(), 1);
636 assert!(telemetry.state.lock().flush_events_task.is_some());
637 assert_eq!(
638 telemetry.state.lock().first_event_date_time,
639 Some(first_date_time)
640 );
641
642 clock.advance(Duration::from_millis(100));
643
644 telemetry.report_event(Event::Flexible(event.clone()));
645 assert_eq!(telemetry.state.lock().events_queue.len(), 2);
646 assert!(telemetry.state.lock().flush_events_task.is_some());
647 assert_eq!(
648 telemetry.state.lock().first_event_date_time,
649 Some(first_date_time)
650 );
651
652 clock.advance(Duration::from_millis(100));
653
654 telemetry.report_event(Event::Flexible(event.clone()));
655 assert_eq!(telemetry.state.lock().events_queue.len(), 3);
656 assert!(telemetry.state.lock().flush_events_task.is_some());
657 assert_eq!(
658 telemetry.state.lock().first_event_date_time,
659 Some(first_date_time)
660 );
661
662 clock.advance(Duration::from_millis(100));
663
664 // Adding a 4th event should cause a flush
665 telemetry.report_event(Event::Flexible(event));
666 assert!(is_empty_state(&telemetry));
667 });
668 }
669
670 #[gpui::test]
671 async fn test_telemetry_flush_on_flush_interval(
672 executor: BackgroundExecutor,
673 cx: &mut TestAppContext,
674 ) {
675 init_test(cx);
676 let clock = Arc::new(FakeSystemClock::new());
677 let http = FakeHttpClient::with_200_response();
678 let system_id = Some("system_id".to_string());
679 let installation_id = Some("installation_id".to_string());
680 let session_id = "session_id".to_string();
681
682 cx.update(|cx| {
683 let telemetry = Telemetry::new(clock.clone(), http, cx);
684 telemetry.state.lock().max_queue_size = 4;
685 telemetry.start(system_id, installation_id, session_id, cx);
686
687 assert!(is_empty_state(&telemetry));
688 let first_date_time = clock.utc_now();
689
690 let event_properties = HashMap::from_iter([(
691 "test_key".to_string(),
692 serde_json::Value::String("test_value".to_string()),
693 )]);
694
695 let event = FlexibleEvent {
696 event_type: "test".to_string(),
697 event_properties,
698 };
699
700 telemetry.report_event(Event::Flexible(event));
701 assert_eq!(telemetry.state.lock().events_queue.len(), 1);
702 assert!(telemetry.state.lock().flush_events_task.is_some());
703 assert_eq!(
704 telemetry.state.lock().first_event_date_time,
705 Some(first_date_time)
706 );
707
708 let duration = Duration::from_millis(1);
709
710 // Test 1 millisecond before the flush interval limit is met
711 executor.advance_clock(FLUSH_INTERVAL - duration);
712
713 assert!(!is_empty_state(&telemetry));
714
715 // Test the exact moment the flush interval limit is met
716 executor.advance_clock(duration);
717
718 assert!(is_empty_state(&telemetry));
719 });
720 }
721
722 #[gpui::test]
723 fn test_project_discovery_does_not_double_report(cx: &mut gpui::TestAppContext) {
724 init_test(cx);
725
726 let clock = Arc::new(FakeSystemClock::new());
727 let http = FakeHttpClient::with_200_response();
728 let telemetry = cx.update(|cx| Telemetry::new(clock.clone(), http, cx));
729 let worktree_id = 1;
730
731 // Scan of empty worktree finds nothing
732 test_project_discovery_helper(telemetry.clone(), vec![], Some(vec![]), worktree_id);
733
734 // Files added, second scan of worktree 1 finds project type
735 test_project_discovery_helper(
736 telemetry.clone(),
737 vec!["package.json"],
738 Some(vec!["node"]),
739 worktree_id,
740 );
741
742 // Third scan of worktree does not double report, as we already reported
743 test_project_discovery_helper(telemetry, vec!["package.json"], None, worktree_id);
744 }
745
746 #[gpui::test]
747 fn test_pnpm_project_discovery(cx: &mut gpui::TestAppContext) {
748 init_test(cx);
749
750 let clock = Arc::new(FakeSystemClock::new());
751 let http = FakeHttpClient::with_200_response();
752 let telemetry = cx.update(|cx| Telemetry::new(clock.clone(), http, cx));
753
754 test_project_discovery_helper(
755 telemetry,
756 vec!["package.json", "pnpm-lock.yaml"],
757 Some(vec!["node", "pnpm"]),
758 1,
759 );
760 }
761
762 #[gpui::test]
763 fn test_yarn_project_discovery(cx: &mut gpui::TestAppContext) {
764 init_test(cx);
765
766 let clock = Arc::new(FakeSystemClock::new());
767 let http = FakeHttpClient::with_200_response();
768 let telemetry = cx.update(|cx| Telemetry::new(clock.clone(), http, cx));
769
770 test_project_discovery_helper(
771 telemetry,
772 vec!["package.json", "yarn.lock"],
773 Some(vec!["node", "yarn"]),
774 1,
775 );
776 }
777
778 #[gpui::test]
779 fn test_dotnet_project_discovery(cx: &mut gpui::TestAppContext) {
780 init_test(cx);
781
782 let clock = Arc::new(FakeSystemClock::new());
783 let http = FakeHttpClient::with_200_response();
784 let telemetry = cx.update(|cx| Telemetry::new(clock.clone(), http, cx));
785
786 // Using different worktrees, as production code blocks from reporting a
787 // project type for the same worktree multiple times
788
789 test_project_discovery_helper(
790 telemetry.clone(),
791 vec!["global.json"],
792 Some(vec!["dotnet"]),
793 1,
794 );
795 test_project_discovery_helper(
796 telemetry.clone(),
797 vec!["Directory.Build.props"],
798 Some(vec!["dotnet"]),
799 2,
800 );
801 test_project_discovery_helper(
802 telemetry.clone(),
803 vec!["file.csproj"],
804 Some(vec!["dotnet"]),
805 3,
806 );
807 test_project_discovery_helper(
808 telemetry.clone(),
809 vec!["file.fsproj"],
810 Some(vec!["dotnet"]),
811 4,
812 );
813 test_project_discovery_helper(
814 telemetry.clone(),
815 vec!["file.vbproj"],
816 Some(vec!["dotnet"]),
817 5,
818 );
819 test_project_discovery_helper(telemetry.clone(), vec!["file.sln"], Some(vec!["dotnet"]), 6);
820
821 // Each worktree should only send a single project type event, even when
822 // encountering multiple files associated with that project type
823 test_project_discovery_helper(
824 telemetry,
825 vec!["global.json", "Directory.Build.props"],
826 Some(vec!["dotnet"]),
827 7,
828 );
829 }
830
831 // TODO:
832 // Test settings
833 // Update FakeHTTPClient to keep track of the number of requests and assert on it
834
835 fn init_test(cx: &mut TestAppContext) {
836 cx.update(|cx| {
837 let settings_store = SettingsStore::test(cx);
838 cx.set_global(settings_store);
839 });
840 }
841
842 fn is_empty_state(telemetry: &Telemetry) -> bool {
843 telemetry.state.lock().events_queue.is_empty()
844 && telemetry.state.lock().flush_events_task.is_none()
845 && telemetry.state.lock().first_event_date_time.is_none()
846 }
847
848 fn test_project_discovery_helper(
849 telemetry: Arc<Telemetry>,
850 file_paths: Vec<&str>,
851 expected_project_types: Option<Vec<&str>>,
852 worktree_id_num: usize,
853 ) {
854 let worktree_id = WorktreeId::from_usize(worktree_id_num);
855 let entries: Vec<_> = file_paths
856 .into_iter()
857 .enumerate()
858 .map(|(i, path)| {
859 (
860 Arc::from(std::path::Path::new(path)),
861 ProjectEntryId::from_proto(i as u64 + 1),
862 PathChange::Added,
863 )
864 })
865 .collect();
866 let updated_entries: UpdatedEntriesSet = Arc::from(entries.as_slice());
867
868 let detected_project_types = telemetry.detect_project_types(worktree_id, &updated_entries);
869
870 let expected_project_types =
871 expected_project_types.map(|types| types.iter().map(|&t| t.to_string()).collect());
872
873 assert_eq!(detected_project_types, expected_project_types);
874 }
875}