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