telemetry.rs

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