use crate::http::HttpClient; use db::kvp::KEY_VALUE_STORE; use gpui::{ executor::Background, serde_json::{self, value::Map, Value}, AppContext, Task, }; use isahc::Request; use lazy_static::lazy_static; use parking_lot::Mutex; use serde::Serialize; use serde_json::json; use std::{ io::Write, mem, path::PathBuf, sync::Arc, time::{Duration, SystemTime, UNIX_EPOCH}, }; use tempfile::NamedTempFile; use util::{channel::ReleaseChannel, post_inc, ResultExt, TryFutureExt}; use uuid::Uuid; pub struct Telemetry { http_client: Arc, executor: Arc, state: Mutex, } #[derive(Default)] struct TelemetryState { metrics_id: Option>, device_id: Option>, app_version: Option>, release_channel: Option<&'static str>, os_version: Option>, os_name: &'static str, queue: Vec, next_event_id: usize, flush_task: Option>, log_file: Option, } const MIXPANEL_EVENTS_URL: &'static str = "https://api.mixpanel.com/track"; const MIXPANEL_ENGAGE_URL: &'static str = "https://api.mixpanel.com/engage#profile-set"; lazy_static! { static ref MIXPANEL_TOKEN: Option = std::env::var("ZED_MIXPANEL_TOKEN") .ok() .or_else(|| option_env!("ZED_MIXPANEL_TOKEN").map(|key| key.to_string())); } #[derive(Serialize, Debug)] struct MixpanelEvent { event: String, properties: MixpanelEventProperties, } #[derive(Serialize, Debug)] struct MixpanelEventProperties { // Mixpanel required fields #[serde(skip_serializing_if = "str::is_empty")] token: &'static str, time: u128, distinct_id: Option>, #[serde(rename = "$insert_id")] insert_id: usize, // Custom fields #[serde(skip_serializing_if = "Option::is_none", flatten)] event_properties: Option>, #[serde(rename = "OS Name")] os_name: &'static str, #[serde(rename = "OS Version")] os_version: Option>, #[serde(rename = "Release Channel")] release_channel: Option<&'static str>, #[serde(rename = "App Version")] app_version: Option>, #[serde(rename = "Signed In")] signed_in: bool, } #[derive(Serialize)] struct MixpanelEngageRequest { #[serde(rename = "$token")] token: &'static str, #[serde(rename = "$distinct_id")] distinct_id: Arc, #[serde(rename = "$set")] set: Value, } #[cfg(debug_assertions)] const MAX_QUEUE_LEN: usize = 1; #[cfg(not(debug_assertions))] const MAX_QUEUE_LEN: usize = 10; #[cfg(debug_assertions)] const DEBOUNCE_INTERVAL: Duration = Duration::from_secs(1); #[cfg(not(debug_assertions))] const DEBOUNCE_INTERVAL: Duration = Duration::from_secs(30); impl Telemetry { pub fn new(client: Arc, cx: &AppContext) -> Arc { let platform = cx.platform(); let release_channel = if cx.has_global::() { Some(cx.global::().display_name()) } else { None }; let this = Arc::new(Self { http_client: client, executor: cx.background().clone(), state: Mutex::new(TelemetryState { os_version: platform.os_version().ok().map(|v| v.to_string().into()), os_name: platform.os_name().into(), app_version: platform.app_version().ok().map(|v| v.to_string().into()), release_channel, device_id: None, metrics_id: None, queue: Default::default(), flush_task: Default::default(), next_event_id: 0, log_file: None, }), }); if MIXPANEL_TOKEN.is_some() { this.executor .spawn({ let this = this.clone(); async move { if let Some(tempfile) = NamedTempFile::new().log_err() { this.state.lock().log_file = Some(tempfile); } } }) .detach(); } this } pub fn log_file_path(&self) -> Option { Some(self.state.lock().log_file.as_ref()?.path().to_path_buf()) } pub fn start(self: &Arc) { let this = self.clone(); self.executor .spawn( async move { let device_id = if let Ok(Some(device_id)) = KEY_VALUE_STORE.read_kvp("device_id") { device_id } else { let device_id = Uuid::new_v4().to_string(); KEY_VALUE_STORE .write_kvp("device_id".to_string(), device_id.clone()) .await?; device_id }; let device_id: Arc = device_id.into(); let mut state = this.state.lock(); state.device_id = Some(device_id.clone()); for event in &mut state.queue { event .properties .distinct_id .get_or_insert_with(|| device_id.clone()); } if !state.queue.is_empty() { drop(state); this.flush(); } anyhow::Ok(()) } .log_err(), ) .detach(); } pub fn set_authenticated_user_info( self: &Arc, metrics_id: Option, is_staff: bool, ) { let this = self.clone(); let mut state = self.state.lock(); let device_id = state.device_id.clone(); let metrics_id: Option> = metrics_id.map(|id| id.into()); state.metrics_id = metrics_id.clone(); drop(state); if let Some((token, device_id)) = MIXPANEL_TOKEN.as_ref().zip(device_id) { self.executor .spawn( async move { let json_bytes = serde_json::to_vec(&[MixpanelEngageRequest { token, distinct_id: device_id, set: json!({ "Staff": is_staff, "ID": metrics_id, "App": true }), }])?; let request = Request::post(MIXPANEL_ENGAGE_URL) .header("Content-Type", "application/json") .body(json_bytes.into())?; this.http_client.send(request).await?; Ok(()) } .log_err(), ) .detach(); } } pub fn report_event(self: &Arc, kind: &str, properties: Value) { let mut state = self.state.lock(); let event = MixpanelEvent { event: kind.to_string(), properties: MixpanelEventProperties { token: "", time: SystemTime::now() .duration_since(UNIX_EPOCH) .unwrap() .as_millis(), distinct_id: state.device_id.clone(), insert_id: post_inc(&mut state.next_event_id), event_properties: if let Value::Object(properties) = properties { Some(properties) } else { None }, os_name: state.os_name, os_version: state.os_version.clone(), release_channel: state.release_channel, app_version: state.app_version.clone(), signed_in: state.metrics_id.is_some(), }, }; state.queue.push(event); if state.device_id.is_some() { if state.queue.len() >= MAX_QUEUE_LEN { drop(state); self.flush(); } else { let this = self.clone(); let executor = self.executor.clone(); state.flush_task = Some(self.executor.spawn(async move { executor.timer(DEBOUNCE_INTERVAL).await; this.flush(); })); } } } pub fn metrics_id(self: &Arc) -> Option> { self.state.lock().metrics_id.clone() } fn flush(self: &Arc) { let mut state = self.state.lock(); let mut events = mem::take(&mut state.queue); state.flush_task.take(); drop(state); if let Some(token) = MIXPANEL_TOKEN.as_ref() { let this = self.clone(); self.executor .spawn( async move { let mut json_bytes = Vec::new(); if let Some(file) = &mut this.state.lock().log_file { let file = file.as_file_mut(); for event in &mut events { json_bytes.clear(); serde_json::to_writer(&mut json_bytes, event)?; file.write_all(&json_bytes)?; file.write(b"\n")?; event.properties.token = token; } } json_bytes.clear(); serde_json::to_writer(&mut json_bytes, &events)?; let request = Request::post(MIXPANEL_EVENTS_URL) .header("Content-Type", "application/json") .body(json_bytes.into())?; this.http_client.send(request).await?; Ok(()) } .log_err(), ) .detach(); } } }