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