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 semver::Version::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 let state = Arc::new(Mutex::new(TelemetryState {
183 settings: *TelemetrySettings::get_global(cx),
184 architecture: env::consts::ARCH,
185 release_channel,
186 system_id: None,
187 installation_id: None,
188 session_id: None,
189 metrics_id: None,
190 events_queue: Vec::new(),
191 flush_events_task: None,
192 log_file: None,
193 is_staff: None,
194 first_event_date_time: None,
195 event_coalescer: EventCoalescer::new(clock.clone()),
196 max_queue_size: MAX_QUEUE_LEN,
197 worktrees_with_project_type_events_sent: HashSet::new(),
198
199 os_version: None,
200 os_name: os_name(),
201 app_version: release_channel::AppVersion::global(cx).to_string(),
202 }));
203 Self::log_file_path();
204
205 cx.background_spawn({
206 let state = state.clone();
207 let os_version = os_version();
208 state.lock().os_version = Some(os_version);
209 async move {
210 if let Some(tempfile) = File::create(Self::log_file_path()).ok() {
211 state.lock().log_file = Some(tempfile);
212 }
213 }
214 })
215 .detach();
216
217 cx.observe_global::<SettingsStore>({
218 let state = state.clone();
219
220 move |cx| {
221 let mut state = state.lock();
222 state.settings = *TelemetrySettings::get_global(cx);
223 }
224 })
225 .detach();
226
227 let this = Arc::new(Self {
228 clock,
229 http_client: client,
230 executor: cx.background_executor().clone(),
231 state,
232 });
233
234 let (tx, mut rx) = mpsc::unbounded();
235 ::telemetry::init(tx);
236
237 cx.background_spawn({
238 let this = Arc::downgrade(&this);
239 async move {
240 while let Some(event) = rx.next().await {
241 let Some(state) = this.upgrade() else { break };
242 state.report_event(Event::Flexible(event))
243 }
244 }
245 })
246 .detach();
247
248 // We should only ever have one instance of Telemetry, leak the subscription to keep it alive
249 // rather than store in TelemetryState, complicating spawn as subscriptions are not Send
250 std::mem::forget(cx.on_app_quit({
251 let this = this.clone();
252 move |_| this.shutdown_telemetry()
253 }));
254
255 this
256 }
257
258 #[cfg(any(test, feature = "test-support"))]
259 fn shutdown_telemetry(self: &Arc<Self>) -> impl Future<Output = ()> + use<> {
260 Task::ready(())
261 }
262
263 // Skip calling this function in tests.
264 // TestAppContext ends up calling this function on shutdown and it panics when trying to find the TelemetrySettings
265 #[cfg(not(any(test, feature = "test-support")))]
266 fn shutdown_telemetry(self: &Arc<Self>) -> impl Future<Output = ()> + use<> {
267 telemetry::event!("App Closed");
268 // TODO: close final edit period and make sure it's sent
269 Task::ready(())
270 }
271
272 pub fn log_file_path() -> PathBuf {
273 paths::logs_dir().join("telemetry.log")
274 }
275
276 pub fn has_checksum_seed(&self) -> bool {
277 ZED_CLIENT_CHECKSUM_SEED.is_some()
278 }
279
280 pub fn start(
281 self: &Arc<Self>,
282 system_id: Option<String>,
283 installation_id: Option<String>,
284 session_id: String,
285 cx: &App,
286 ) {
287 let mut state = self.state.lock();
288 state.system_id = system_id.map(|id| id.into());
289 state.installation_id = installation_id.map(|id| id.into());
290 state.session_id = Some(session_id);
291 state.app_version = release_channel::AppVersion::global(cx).to_string();
292 state.os_name = os_name();
293 }
294
295 pub fn metrics_enabled(self: &Arc<Self>) -> bool {
296 self.state.lock().settings.metrics
297 }
298
299 pub fn diagnostics_enabled(self: &Arc<Self>) -> bool {
300 self.state.lock().settings.diagnostics
301 }
302
303 pub fn set_authenticated_user_info(
304 self: &Arc<Self>,
305 metrics_id: Option<String>,
306 is_staff: bool,
307 ) {
308 let mut state = self.state.lock();
309
310 if !state.settings.metrics {
311 return;
312 }
313
314 let metrics_id: Option<Arc<str>> = metrics_id.map(|id| id.into());
315 state.metrics_id.clone_from(&metrics_id);
316 state.is_staff = Some(is_staff);
317 drop(state);
318 }
319
320 pub fn report_assistant_event(self: &Arc<Self>, event: AssistantEventData) {
321 let event_type = match event.phase {
322 AssistantPhase::Response => "Assistant Responded",
323 AssistantPhase::Invoked => "Assistant Invoked",
324 AssistantPhase::Accepted => "Assistant Response Accepted",
325 AssistantPhase::Rejected => "Assistant Response Rejected",
326 };
327
328 telemetry::event!(
329 event_type,
330 conversation_id = event.conversation_id,
331 kind = event.kind,
332 phase = event.phase,
333 message_id = event.message_id,
334 model = event.model,
335 model_provider = event.model_provider,
336 response_latency = event.response_latency,
337 error_message = event.error_message,
338 language_name = event.language_name,
339 );
340 }
341
342 pub fn log_edit_event(self: &Arc<Self>, environment: &'static str, is_via_ssh: bool) {
343 static LAST_EVENT_TIME: Mutex<Option<Instant>> = Mutex::new(None);
344
345 let mut state = self.state.lock();
346 let period_data = state.event_coalescer.log_event(environment);
347 drop(state);
348
349 if let Some(mut last_event) = LAST_EVENT_TIME.try_lock() {
350 let current_time = std::time::Instant::now();
351 let last_time = last_event.get_or_insert(current_time);
352
353 if current_time.duration_since(*last_time) > Duration::from_secs(60 * 10) {
354 *last_time = current_time;
355 } else {
356 return;
357 }
358
359 if let Some((start, end, environment)) = period_data {
360 let duration = end
361 .saturating_duration_since(start)
362 .min(Duration::from_secs(60 * 60 * 24))
363 .as_millis() as i64;
364
365 telemetry::event!(
366 "Editor Edited",
367 duration = duration,
368 environment = environment,
369 is_via_ssh = is_via_ssh
370 );
371 }
372 }
373 }
374
375 pub fn report_discovered_project_type_events(
376 self: &Arc<Self>,
377 worktree_id: WorktreeId,
378 updated_entries_set: &UpdatedEntriesSet,
379 ) {
380 let Some(project_types) = self.detect_project_types(worktree_id, updated_entries_set)
381 else {
382 return;
383 };
384
385 for project_type in project_types {
386 telemetry::event!("Project Opened", project_type = project_type);
387 }
388 }
389
390 fn detect_project_types(
391 self: &Arc<Self>,
392 worktree_id: WorktreeId,
393 updated_entries_set: &UpdatedEntriesSet,
394 ) -> Option<Vec<String>> {
395 let mut state = self.state.lock();
396
397 if state
398 .worktrees_with_project_type_events_sent
399 .contains(&worktree_id)
400 {
401 return None;
402 }
403
404 let mut project_types: HashSet<&str> = HashSet::new();
405
406 for (path, _, _) in updated_entries_set.iter() {
407 let Some(file_name) = path.file_name() else {
408 continue;
409 };
410
411 let project_type = if file_name == "pnpm-lock.yaml" {
412 Some("pnpm")
413 } else if file_name == "yarn.lock" {
414 Some("yarn")
415 } else if file_name == "package.json" {
416 Some("node")
417 } else if DOTNET_PROJECT_FILES_REGEX.is_match(file_name) {
418 Some("dotnet")
419 } else {
420 None
421 };
422
423 if let Some(project_type) = project_type {
424 project_types.insert(project_type);
425 };
426 }
427
428 if !project_types.is_empty() {
429 state
430 .worktrees_with_project_type_events_sent
431 .insert(worktree_id);
432 }
433
434 let mut project_types: Vec<_> = project_types.into_iter().map(String::from).collect();
435 project_types.sort();
436 Some(project_types)
437 }
438
439 fn report_event(self: &Arc<Self>, mut event: Event) {
440 let mut state = self.state.lock();
441 // RUST_LOG=telemetry=trace to debug telemetry events
442 log::trace!(target: "telemetry", "{:?}", event);
443
444 if !state.settings.metrics {
445 return;
446 }
447
448 match &mut event {
449 Event::Flexible(event) => event
450 .event_properties
451 .insert("event_source".into(), "zed".into()),
452 };
453
454 if state.flush_events_task.is_none() {
455 let this = self.clone();
456 state.flush_events_task = Some(self.executor.spawn(async move {
457 this.executor.timer(FLUSH_INTERVAL).await;
458 this.flush_events().detach();
459 }));
460 }
461
462 let date_time = self.clock.utc_now();
463
464 let milliseconds_since_first_event = match state.first_event_date_time {
465 Some(first_event_date_time) => date_time
466 .saturating_duration_since(first_event_date_time)
467 .min(Duration::from_secs(60 * 60 * 24))
468 .as_millis() as i64,
469 None => {
470 state.first_event_date_time = Some(date_time);
471 0
472 }
473 };
474
475 let signed_in = state.metrics_id.is_some();
476 state.events_queue.push(EventWrapper {
477 signed_in,
478 milliseconds_since_first_event,
479 event,
480 });
481
482 if state.installation_id.is_some() && state.events_queue.len() >= state.max_queue_size {
483 drop(state);
484 self.flush_events().detach();
485 }
486 }
487
488 pub fn metrics_id(self: &Arc<Self>) -> Option<Arc<str>> {
489 self.state.lock().metrics_id.clone()
490 }
491
492 pub fn system_id(self: &Arc<Self>) -> Option<Arc<str>> {
493 self.state.lock().system_id.clone()
494 }
495
496 pub fn installation_id(self: &Arc<Self>) -> Option<Arc<str>> {
497 self.state.lock().installation_id.clone()
498 }
499
500 pub fn is_staff(self: &Arc<Self>) -> Option<bool> {
501 self.state.lock().is_staff
502 }
503
504 fn build_request(
505 self: &Arc<Self>,
506 // We take in the JSON bytes buffer so we can reuse the existing allocation.
507 mut json_bytes: Vec<u8>,
508 event_request: &EventRequestBody,
509 ) -> Result<Request<AsyncBody>> {
510 json_bytes.clear();
511 serde_json::to_writer(&mut json_bytes, event_request)?;
512
513 let checksum = calculate_json_checksum(&json_bytes).unwrap_or_default();
514
515 Ok(Request::builder()
516 .method(Method::POST)
517 .uri(
518 self.http_client
519 .build_zed_api_url("/telemetry/events", &[])?
520 .as_ref(),
521 )
522 .header("Content-Type", "application/json")
523 .header("x-zed-checksum", checksum)
524 .body(json_bytes.into())?)
525 }
526
527 pub fn flush_events(self: &Arc<Self>) -> Task<()> {
528 let mut state = self.state.lock();
529 state.first_event_date_time = None;
530 let events = mem::take(&mut state.events_queue);
531 state.flush_events_task.take();
532 drop(state);
533 if events.is_empty() {
534 return Task::ready(());
535 }
536
537 let this = self.clone();
538 self.executor.spawn(
539 async move {
540 let mut json_bytes = Vec::new();
541
542 if let Some(file) = &mut this.state.lock().log_file {
543 for event in &events {
544 json_bytes.clear();
545 serde_json::to_writer(&mut json_bytes, event)?;
546 file.write_all(&json_bytes)?;
547 file.write_all(b"\n")?;
548 }
549 }
550
551 let request_body = {
552 let state = this.state.lock();
553
554 EventRequestBody {
555 system_id: state.system_id.as_deref().map(Into::into),
556 installation_id: state.installation_id.as_deref().map(Into::into),
557 session_id: state.session_id.clone(),
558 metrics_id: state.metrics_id.as_deref().map(Into::into),
559 is_staff: state.is_staff,
560 app_version: state.app_version.clone(),
561 os_name: state.os_name.clone(),
562 os_version: state.os_version.clone(),
563 architecture: state.architecture.to_string(),
564
565 release_channel: state.release_channel.map(Into::into),
566 events,
567 }
568 };
569
570 let request = this.build_request(json_bytes, &request_body)?;
571 let response = this.http_client.send(request).await?;
572 if response.status() != 200 {
573 log::error!("Failed to send events: HTTP {:?}", response.status());
574 }
575 anyhow::Ok(())
576 }
577 .log_err()
578 .map(|_| ()),
579 )
580 }
581}
582
583pub fn calculate_json_checksum(json: &impl AsRef<[u8]>) -> Option<String> {
584 let Some(checksum_seed) = &*ZED_CLIENT_CHECKSUM_SEED else {
585 return None;
586 };
587
588 let mut summer = Sha256::new();
589 summer.update(checksum_seed);
590 summer.update(json);
591 summer.update(checksum_seed);
592 let mut checksum = String::new();
593 for byte in summer.finalize().as_slice() {
594 use std::fmt::Write;
595 write!(&mut checksum, "{:02x}", byte).unwrap();
596 }
597
598 Some(checksum)
599}
600
601#[cfg(test)]
602mod tests {
603 use super::*;
604 use clock::FakeSystemClock;
605 use gpui::TestAppContext;
606 use http_client::FakeHttpClient;
607 use std::collections::HashMap;
608 use telemetry_events::FlexibleEvent;
609 use util::rel_path::RelPath;
610 use worktree::{PathChange, ProjectEntryId, WorktreeId};
611
612 #[gpui::test]
613 fn test_telemetry_flush_on_max_queue_size(cx: &mut TestAppContext) {
614 init_test(cx);
615 let clock = Arc::new(FakeSystemClock::new());
616 let http = FakeHttpClient::with_200_response();
617 let system_id = Some("system_id".to_string());
618 let installation_id = Some("installation_id".to_string());
619 let session_id = "session_id".to_string();
620
621 cx.update(|cx| {
622 let telemetry = Telemetry::new(clock.clone(), http, cx);
623
624 telemetry.state.lock().max_queue_size = 4;
625 telemetry.start(system_id, installation_id, session_id, cx);
626
627 assert!(is_empty_state(&telemetry));
628
629 let first_date_time = clock.utc_now();
630 let event_properties = HashMap::from_iter([(
631 "test_key".to_string(),
632 serde_json::Value::String("test_value".to_string()),
633 )]);
634
635 let event = FlexibleEvent {
636 event_type: "test".to_string(),
637 event_properties,
638 };
639
640 telemetry.report_event(Event::Flexible(event.clone()));
641 assert_eq!(telemetry.state.lock().events_queue.len(), 1);
642 assert!(telemetry.state.lock().flush_events_task.is_some());
643 assert_eq!(
644 telemetry.state.lock().first_event_date_time,
645 Some(first_date_time)
646 );
647
648 clock.advance(Duration::from_millis(100));
649
650 telemetry.report_event(Event::Flexible(event.clone()));
651 assert_eq!(telemetry.state.lock().events_queue.len(), 2);
652 assert!(telemetry.state.lock().flush_events_task.is_some());
653 assert_eq!(
654 telemetry.state.lock().first_event_date_time,
655 Some(first_date_time)
656 );
657
658 clock.advance(Duration::from_millis(100));
659
660 telemetry.report_event(Event::Flexible(event.clone()));
661 assert_eq!(telemetry.state.lock().events_queue.len(), 3);
662 assert!(telemetry.state.lock().flush_events_task.is_some());
663 assert_eq!(
664 telemetry.state.lock().first_event_date_time,
665 Some(first_date_time)
666 );
667
668 clock.advance(Duration::from_millis(100));
669
670 // Adding a 4th event should cause a flush
671 telemetry.report_event(Event::Flexible(event));
672 assert!(is_empty_state(&telemetry));
673 });
674 }
675
676 #[gpui::test]
677 async fn test_telemetry_flush_on_flush_interval(
678 executor: BackgroundExecutor,
679 cx: &mut TestAppContext,
680 ) {
681 init_test(cx);
682 let clock = Arc::new(FakeSystemClock::new());
683 let http = FakeHttpClient::with_200_response();
684 let system_id = Some("system_id".to_string());
685 let installation_id = Some("installation_id".to_string());
686 let session_id = "session_id".to_string();
687
688 cx.update(|cx| {
689 let telemetry = Telemetry::new(clock.clone(), http, cx);
690 telemetry.state.lock().max_queue_size = 4;
691 telemetry.start(system_id, installation_id, session_id, cx);
692
693 assert!(is_empty_state(&telemetry));
694 let first_date_time = clock.utc_now();
695
696 let event_properties = HashMap::from_iter([(
697 "test_key".to_string(),
698 serde_json::Value::String("test_value".to_string()),
699 )]);
700
701 let event = FlexibleEvent {
702 event_type: "test".to_string(),
703 event_properties,
704 };
705
706 telemetry.report_event(Event::Flexible(event));
707 assert_eq!(telemetry.state.lock().events_queue.len(), 1);
708 assert!(telemetry.state.lock().flush_events_task.is_some());
709 assert_eq!(
710 telemetry.state.lock().first_event_date_time,
711 Some(first_date_time)
712 );
713
714 let duration = Duration::from_millis(1);
715
716 // Test 1 millisecond before the flush interval limit is met
717 executor.advance_clock(FLUSH_INTERVAL - duration);
718
719 assert!(!is_empty_state(&telemetry));
720
721 // Test the exact moment the flush interval limit is met
722 executor.advance_clock(duration);
723
724 assert!(is_empty_state(&telemetry));
725 });
726 }
727
728 #[gpui::test]
729 fn test_project_discovery_does_not_double_report(cx: &mut gpui::TestAppContext) {
730 init_test(cx);
731
732 let clock = Arc::new(FakeSystemClock::new());
733 let http = FakeHttpClient::with_200_response();
734 let telemetry = cx.update(|cx| Telemetry::new(clock.clone(), http, cx));
735 let worktree_id = 1;
736
737 // Scan of empty worktree finds nothing
738 test_project_discovery_helper(telemetry.clone(), vec![], Some(vec![]), worktree_id);
739
740 // Files added, second scan of worktree 1 finds project type
741 test_project_discovery_helper(
742 telemetry.clone(),
743 vec!["package.json"],
744 Some(vec!["node"]),
745 worktree_id,
746 );
747
748 // Third scan of worktree does not double report, as we already reported
749 test_project_discovery_helper(telemetry, vec!["package.json"], None, worktree_id);
750 }
751
752 #[gpui::test]
753 fn test_pnpm_project_discovery(cx: &mut gpui::TestAppContext) {
754 init_test(cx);
755
756 let clock = Arc::new(FakeSystemClock::new());
757 let http = FakeHttpClient::with_200_response();
758 let telemetry = cx.update(|cx| Telemetry::new(clock.clone(), http, cx));
759
760 test_project_discovery_helper(
761 telemetry,
762 vec!["package.json", "pnpm-lock.yaml"],
763 Some(vec!["node", "pnpm"]),
764 1,
765 );
766 }
767
768 #[gpui::test]
769 fn test_yarn_project_discovery(cx: &mut gpui::TestAppContext) {
770 init_test(cx);
771
772 let clock = Arc::new(FakeSystemClock::new());
773 let http = FakeHttpClient::with_200_response();
774 let telemetry = cx.update(|cx| Telemetry::new(clock.clone(), http, cx));
775
776 test_project_discovery_helper(
777 telemetry,
778 vec!["package.json", "yarn.lock"],
779 Some(vec!["node", "yarn"]),
780 1,
781 );
782 }
783
784 #[gpui::test]
785 fn test_dotnet_project_discovery(cx: &mut gpui::TestAppContext) {
786 init_test(cx);
787
788 let clock = Arc::new(FakeSystemClock::new());
789 let http = FakeHttpClient::with_200_response();
790 let telemetry = cx.update(|cx| Telemetry::new(clock.clone(), http, cx));
791
792 // Using different worktrees, as production code blocks from reporting a
793 // project type for the same worktree multiple times
794
795 test_project_discovery_helper(
796 telemetry.clone(),
797 vec!["global.json"],
798 Some(vec!["dotnet"]),
799 1,
800 );
801 test_project_discovery_helper(
802 telemetry.clone(),
803 vec!["Directory.Build.props"],
804 Some(vec!["dotnet"]),
805 2,
806 );
807 test_project_discovery_helper(
808 telemetry.clone(),
809 vec!["file.csproj"],
810 Some(vec!["dotnet"]),
811 3,
812 );
813 test_project_discovery_helper(
814 telemetry.clone(),
815 vec!["file.fsproj"],
816 Some(vec!["dotnet"]),
817 4,
818 );
819 test_project_discovery_helper(
820 telemetry.clone(),
821 vec!["file.vbproj"],
822 Some(vec!["dotnet"]),
823 5,
824 );
825 test_project_discovery_helper(telemetry.clone(), vec!["file.sln"], Some(vec!["dotnet"]), 6);
826
827 // Each worktree should only send a single project type event, even when
828 // encountering multiple files associated with that project type
829 test_project_discovery_helper(
830 telemetry,
831 vec!["global.json", "Directory.Build.props"],
832 Some(vec!["dotnet"]),
833 7,
834 );
835 }
836
837 // TODO:
838 // Test settings
839 // Update FakeHTTPClient to keep track of the number of requests and assert on it
840
841 fn init_test(cx: &mut TestAppContext) {
842 cx.update(|cx| {
843 let settings_store = SettingsStore::test(cx);
844 cx.set_global(settings_store);
845 });
846 }
847
848 fn is_empty_state(telemetry: &Telemetry) -> bool {
849 telemetry.state.lock().events_queue.is_empty()
850 && telemetry.state.lock().flush_events_task.is_none()
851 && telemetry.state.lock().first_event_date_time.is_none()
852 }
853
854 fn test_project_discovery_helper(
855 telemetry: Arc<Telemetry>,
856 file_paths: Vec<&str>,
857 expected_project_types: Option<Vec<&str>>,
858 worktree_id_num: usize,
859 ) {
860 let worktree_id = WorktreeId::from_usize(worktree_id_num);
861 let entries: Vec<_> = file_paths
862 .into_iter()
863 .enumerate()
864 .filter_map(|(i, path)| {
865 Some((
866 Arc::from(RelPath::unix(path).ok()?),
867 ProjectEntryId::from_proto(i as u64 + 1),
868 PathChange::Added,
869 ))
870 })
871 .collect();
872 let updated_entries: UpdatedEntriesSet = Arc::from(entries.as_slice());
873
874 let detected_project_types = telemetry.detect_project_types(worktree_id, &updated_entries);
875
876 let expected_project_types =
877 expected_project_types.map(|types| types.iter().map(|&t| t.to_string()).collect());
878
879 assert_eq!(detected_project_types, expected_project_types);
880 }
881}