Merge branch 'main' into test/issue-500

Author: karthiknadig

crates/pet-core/src/telemetry/mod.rs

@@ -5,12 +5,14 @@ use inaccurate_python_info::InaccuratePythonEnvironmentInfo;
 use missing_conda_info::MissingCondaEnvironments;
 use missing_poetry_info::MissingPoetryEnvironments;
 use refresh_performance::RefreshPerformance;
+use refresh_progress::RefreshProgress;
 use serde::{Deserialize, Serialize};
 
 pub mod inaccurate_python_info;
 pub mod missing_conda_info;
 pub mod missing_poetry_info;
 pub mod refresh_performance;
+pub mod refresh_progress;
 
 pub type NumberOfCustomSearchPaths = u32;
 
@@ -38,6 +40,8 @@ pub enum TelemetryEvent {
     MissingPoetryEnvironments(MissingPoetryEnvironments),
     /// Telemetry with metrics for finding all environments as a result of refresh.
     RefreshPerformance(RefreshPerformance),
+    /// Progress through a refresh operation, including per-locator timing.
+    RefreshProgress(RefreshProgress),
 }
 
 pub fn get_telemetry_event_name(event: &TelemetryEvent) -> &'static str {
@@ -57,5 +61,6 @@ pub fn get_telemetry_event_name(event: &TelemetryEvent) -> &'static str {
         TelemetryEvent::MissingCondaEnvironments(_) => "MissingCondaEnvironments",
         TelemetryEvent::MissingPoetryEnvironments(_) => "MissingPoetryEnvironments",
         TelemetryEvent::RefreshPerformance(_) => "RefreshPerformance",
+        TelemetryEvent::RefreshProgress(_) => "RefreshProgress",
     }
 }

crates/pet-core/src/telemetry/refresh_progress.rs

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub enum RefreshProgressPhase {
+    Locators,
+    Path,
+    GlobalVirtualEnvs,
+    Workspaces,
+}
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub enum RefreshProgressStatus {
+    Started,
+    Completed,
+}
+
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct RefreshProgress {
+    pub refresh_id: u64,
+    pub phase: RefreshProgressPhase,
+    pub status: RefreshProgressStatus,
+    pub elapsed_ms: u128,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub phase_elapsed_ms: Option<u128>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub locator_name: Option<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub locator_elapsed_ms: Option<u128>,
+}

crates/pet-reporter/src/jsonrpc.rs

@@ -173,6 +173,43 @@ mod tests {
         assert_eq!(value["data"]["refreshPerformance"]["total"], json!(10));
     }
 
+    #[test]
+    fn refresh_progress_serializes_privacy_safe_fields() {
+        use pet_core::telemetry::refresh_progress::{
+            RefreshProgress, RefreshProgressPhase, RefreshProgressStatus,
+        };
+
+        let event = TelemetryEvent::RefreshProgress(RefreshProgress {
+            refresh_id: 42,
+            phase: RefreshProgressPhase::Locators,
+            status: RefreshProgressStatus::Completed,
+            elapsed_ms: 15,
+            phase_elapsed_ms: None,
+            locator_name: Some("Conda".to_string()),
+            locator_elapsed_ms: Some(10),
+        });
+        let payload = TelemetryData {
+            event: get_telemetry_event_name(&event).to_string(),
+            data: event,
+        };
+
+        assert_eq!(
+            serde_json::to_value(payload).unwrap(),
+            json!({
+                "event": "RefreshProgress",
+                "data": {
+                    "refreshProgress": {
+                        "refreshId": 42,
+                        "phase": "locators",
+                        "status": "completed",
+                        "elapsedMs": 15,
+                        "locatorName": "Conda",
+                        "locatorElapsedMs": 10
+                    }
+                }
+            })
+        );
+    }
     #[test]
     fn log_payload_uses_camel_case_fields_and_level_renames() {
         let payload = Log {