Capture total times by each locator (#50)

DonJayamanne · web-flow · commit 1443fc4590bb · 2024-06-25T12:16:41.000+10:00
Helps us with a breakdown
```
Breakdown by each locator:
--------------------------
VirtualEnvWrapper    : 697.167µs
MacXCode             : 538.458µs
Venv                 : 699.5µs
MacCmdLineTools      : 194.643458ms
VirtualEnv           : 665.459µs
MacPythonOrg         : 32.387083ms
Homebrew             : 81.388042ms
PyEnv                : 141.412542ms
Conda                : 250.8985ms
Poetry               : 948.042µs
PipEnv               : 625ns

Breakdown for finding Environments:
-----------------------------------
Using locators       : 251.063625ms
PATH Variable        : 214.762458ms
Global virtual envs  : 81.220291ms
Custom search paths  : 1.252041ms

Managers:
---------
Conda                : 6
Poetry               : 1
Pyenv                : 1

Environments (50):
------------------
Conda                : 27
Homebrew             : 4
MacCommandLineTools  : 1
MacPythonOrg         : 1
MacXCode             : 1
Pipenv               : 1
Pyenv                : 9
PyenvVirtualEnv      : 3
Venv                 : 1
VirtualEnvWrapper    : 2
```
diff --git a/crates/pet-conda/src/lib.rs b/crates/pet-conda/src/lib.rs
@@ -146,6 +146,9 @@ impl Conda {
 }
 
 impl Locator for Conda {
+    fn get_name(&self) -> &'static str {
+        "Conda"
+    }
     fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {
         vec![PythonEnvironmentCategory::Conda]
     }
diff --git a/crates/pet-core/src/lib.rs b/crates/pet-core/src/lib.rs
@@ -34,6 +34,8 @@ pub struct Configuration {
 }
 
 pub trait Locator: Send + Sync {
+    /// Returns the name of the locator.
+    fn get_name(&self) -> &'static str;
     fn configure(&self, _config: &Configuration) {
         //
     }
diff --git a/crates/pet-homebrew/src/lib.rs b/crates/pet-homebrew/src/lib.rs
@@ -98,6 +98,9 @@ fn from(env: &PythonEnv) -> Option<PythonEnvironment> {
 }
 
 impl Locator for Homebrew {
+    fn get_name(&self) -> &'static str {
+        "Homebrew"
+    }
     fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {
         vec![PythonEnvironmentCategory::Homebrew]
     }
diff --git a/crates/pet-linux-global-python/src/lib.rs b/crates/pet-linux-global-python/src/lib.rs
@@ -26,6 +26,9 @@ impl Default for LinuxGlobalPython {
     }
 }
 impl Locator for LinuxGlobalPython {
+    fn get_name(&self) -> &'static str {
+        "LinuxGlobalPython"
+    }
     fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {
         vec![PythonEnvironmentCategory::LinuxGlobal]
     }
diff --git a/crates/pet-mac-commandlinetools/src/lib.rs b/crates/pet-mac-commandlinetools/src/lib.rs
@@ -28,6 +28,9 @@ impl Default for MacCmdLineTools {
     }
 }
 impl Locator for MacCmdLineTools {
+    fn get_name(&self) -> &'static str {
+        "MacCmdLineTools"
+    }
     fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {
         vec![PythonEnvironmentCategory::MacCommandLineTools]
     }
diff --git a/crates/pet-mac-python-org/src/lib.rs b/crates/pet-mac-python-org/src/lib.rs
@@ -27,6 +27,9 @@ impl Default for MacPythonOrg {
     }
 }
 impl Locator for MacPythonOrg {
+    fn get_name(&self) -> &'static str {
+        "MacPythonOrg"
+    }
     fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {
         vec![PythonEnvironmentCategory::MacPythonOrg]
     }
diff --git a/crates/pet-mac-xcode/src/lib.rs b/crates/pet-mac-xcode/src/lib.rs
@@ -25,6 +25,9 @@ impl Default for MacXCode {
     }
 }
 impl Locator for MacXCode {
+    fn get_name(&self) -> &'static str {
+        "MacXCode"
+    }
     fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {
         vec![PythonEnvironmentCategory::MacCommandLineTools]
     }
diff --git a/crates/pet-pipenv/src/lib.rs b/crates/pet-pipenv/src/lib.rs
@@ -71,6 +71,9 @@ impl PipEnv {
     }
 }
 impl Locator for PipEnv {
+    fn get_name(&self) -> &'static str {
+        "PipEnv"
+    }
     fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {
         vec![PythonEnvironmentCategory::Pipenv]
     }
diff --git a/crates/pet-poetry/src/lib.rs b/crates/pet-poetry/src/lib.rs
@@ -134,6 +134,9 @@ impl Poetry {
 }
 
 impl Locator for Poetry {
+    fn get_name(&self) -> &'static str {
+        "Poetry"
+    }
     fn configure(&self, config: &Configuration) {
         if let Some(search_paths) = &config.search_paths {
             if !search_paths.is_empty() {
diff --git a/crates/pet-pyenv/src/lib.rs b/crates/pet-pyenv/src/lib.rs
@@ -48,6 +48,9 @@ impl PyEnv {
 }
 
 impl Locator for PyEnv {
+    fn get_name(&self) -> &'static str {
+        "PyEnv"
+    }
     fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {
         vec![
             PythonEnvironmentCategory::Pyenv,
diff --git a/crates/pet-venv/src/lib.rs b/crates/pet-venv/src/lib.rs
@@ -33,6 +33,9 @@ impl Default for Venv {
     }
 }
 impl Locator for Venv {
+    fn get_name(&self) -> &'static str {
+        "Venv"
+    }
     fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {
         vec![PythonEnvironmentCategory::Venv]
     }
diff --git a/crates/pet-virtualenv/src/lib.rs b/crates/pet-virtualenv/src/lib.rs
@@ -71,6 +71,9 @@ impl Default for VirtualEnv {
 }
 
 impl Locator for VirtualEnv {
+    fn get_name(&self) -> &'static str {
+        "VirtualEnv"
+    }
     fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {
         vec![PythonEnvironmentCategory::VirtualEnv]
     }
diff --git a/crates/pet-virtualenvwrapper/src/lib.rs b/crates/pet-virtualenvwrapper/src/lib.rs
@@ -29,6 +29,9 @@ impl VirtualEnvWrapper {
 }
 
 impl Locator for VirtualEnvWrapper {
+    fn get_name(&self) -> &'static str {
+        "VirtualEnvWrapper"
+    }
     fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {
         vec![PythonEnvironmentCategory::VirtualEnvWrapper]
     }
diff --git a/crates/pet-windows-registry/src/lib.rs b/crates/pet-windows-registry/src/lib.rs
@@ -62,6 +62,9 @@ impl WindowsRegistry {
 }
 
 impl Locator for WindowsRegistry {
+    fn get_name(&self) -> &'static str {
+        "WindowsRegistry"
+    }
     fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {
         vec![PythonEnvironmentCategory::WindowsRegistry]
     }
diff --git a/crates/pet-windows-store/src/lib.rs b/crates/pet-windows-store/src/lib.rs
@@ -61,6 +61,9 @@ impl WindowsStore {
 }
 
 impl Locator for WindowsStore {
+    fn get_name(&self) -> &'static str {
+        "WindowsStore"
+    }
     fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {
         vec![PythonEnvironmentCategory::WindowsStore]
     }
diff --git a/crates/pet/src/find.rs b/crates/pet/src/find.rs
@@ -14,26 +14,38 @@ use pet_python_utils::env::PythonEnv;
 use pet_python_utils::executable::{
     find_executable, find_executables, should_search_for_environments_in_path,
 };
+use std::collections::HashMap;
 use std::fs;
 use std::path::PathBuf;
+use std::sync::Mutex;
 use std::time::Duration;
 use std::{sync::Arc, thread};
 
 use crate::locators::identify_python_environment_using_locators;
 
 pub struct Summary {
-    pub search_time: Duration,
+    pub time: Duration,
+    pub find_locators_times: HashMap<&'static str, Duration>,
+    pub find_locators_time: Duration,
+    pub find_path_time: Duration,
+    pub find_global_virtual_envs_time: Duration,
+    pub find_search_paths_time: Duration,
 }
 
 pub fn find_and_report_envs(
     reporter: &dyn Reporter,
     configuration: Configuration,
     locators: &Arc<Vec<Arc<dyn Locator>>>,
     conda_locator: Arc<dyn CondaLocator>,
-) -> Summary {
-    let mut summary = Summary {
-        search_time: Duration::from_secs(0),
-    };
+) -> Arc<Mutex<Summary>> {
+    let summary = Arc::new(Mutex::new(Summary {
+        time: Duration::from_secs(0),
+        find_locators_times: HashMap::new(),
+        find_locators_time: Duration::from_secs(0),
+        find_path_time: Duration::from_secs(0),
+        find_global_virtual_envs_time: Duration::from_secs(0),
+        find_search_paths_time: Duration::from_secs(0),
+    }));
     info!("Started Refreshing Environments");
     let start = std::time::Instant::now();
 
@@ -45,12 +57,23 @@ pub fn find_and_report_envs(
         // 1. Find using known global locators.
         s.spawn(|| {
             // Find in all the finders
+            let start = std::time::Instant::now();
             thread::scope(|s| {
                 for locator in locators.iter() {
                     let locator = locator.clone();
-                    s.spawn(move || locator.find(reporter));
+                    let summary = summary.clone();
+                    s.spawn(move || {
+                        let start = std::time::Instant::now();
+                        locator.find(reporter);
+                        summary
+                            .lock()
+                            .unwrap()
+                            .find_locators_times
+                            .insert(locator.get_name(), start.elapsed());
+                    });
                 }
             });
+            summary.lock().unwrap().find_locators_time = start.elapsed();
 
             // By now all conda envs have been found
             // Spawn conda  in a separate thread.
@@ -72,24 +95,26 @@ pub fn find_and_report_envs(
         });
         // Step 2: Search in PATH variable
         s.spawn(|| {
+            let start = std::time::Instant::now();
             let environment = EnvironmentApi::new();
             let search_paths: Vec<PathBuf> = get_search_paths_from_env_variables(&environment);
 
             trace!(
                 "Searching for environments in global folders: {:?}",
                 search_paths
             );
-
             find_python_environments(
                 search_paths,
                 reporter,
                 locators,
                 false,
                 Some(PythonEnvironmentCategory::GlobalPaths),
-            )
+            );
+            summary.lock().unwrap().find_path_time = start.elapsed();
         });
         // Step 3: Search in some global locations for virtual envs.
         s.spawn(|| {
+            let start = std::time::Instant::now();
             let environment = EnvironmentApi::new();
             let search_paths: Vec<PathBuf> = [
                 list_global_virtual_envs_paths(
@@ -105,7 +130,8 @@ pub fn find_and_report_envs(
                 search_paths
             );
 
-            find_python_environments(search_paths, reporter, locators, false, None)
+            find_python_environments(search_paths, reporter, locators, false, None);
+            summary.lock().unwrap().find_global_virtual_envs_time = start.elapsed();
         });
         // Step 4: Find in workspace folders too.
         // This can be merged with step 2 as well, as we're only look for environments
@@ -122,16 +148,18 @@ pub fn find_and_report_envs(
                 "Searching for environments in custom folders: {:?}",
                 search_paths
             );
+            let start = std::time::Instant::now();
             find_python_environments_in_workspace_folders_recursive(
                 search_paths,
                 reporter,
                 locators,
                 0,
                 1,
             );
+            summary.lock().unwrap().find_search_paths_time = start.elapsed();
         });
     });
-    summary.search_time = start.elapsed();
+    summary.lock().unwrap().time = start.elapsed();
 
     summary
 }
diff --git a/crates/pet/src/jsonrpc.rs b/crates/pet/src/jsonrpc.rs
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-use log::{error, trace};
+use log::{error, info, trace};
 use pet::resolve::resolve_environment;
 use pet_conda::Conda;
 use pet_core::{
@@ -68,13 +68,13 @@ pub struct RequestOptions {
 
 #[derive(Debug, Clone, Deserialize, Serialize)]
 pub struct RefreshResult {
-    duration: Option<u128>,
+    duration: u128,
 }
 
 impl RefreshResult {
-    pub fn new(duration: Result<Duration, SystemTimeError>) -> RefreshResult {
+    pub fn new(duration: Duration) -> RefreshResult {
         RefreshResult {
-            duration: duration.ok().map(|d| d.as_millis()),
+            duration: duration.as_millis(),
         }
     }
 }
@@ -90,14 +90,30 @@ pub fn handle_refresh(context: Arc<Context>, id: u32, params: Value) {
             for locator in context.locators.iter() {
                 locator.configure(&config);
             }
-            let now = SystemTime::now();
-            find_and_report_envs(
+            let summary = find_and_report_envs(
                 context.reporter.as_ref(),
                 config,
                 &context.locators,
                 context.conda_locator.clone(),
             );
-            send_reply(id, Some(RefreshResult::new(now.elapsed())));
+            let summary = summary.lock().unwrap();
+            for locator in summary.find_locators_times.iter() {
+                info!("Locator {} took {:?}", locator.0, locator.1);
+            }
+            info!(
+                "Environments found using locators in {:?}",
+                summary.find_locators_time
+            );
+            info!("Environments in PATH found in {:?}", summary.find_path_time);
+            info!(
+                "Environments in global virtual env paths found in {:?}",
+                summary.find_global_virtual_envs_time
+            );
+            info!(
+                "Environments in custom search paths found in {:?}",
+                summary.find_search_paths_time
+            );
+            send_reply(id, Some(RefreshResult::new(summary.time)));
         }
         Err(e) => {
             send_reply(id, None::<u128>);
diff --git a/crates/pet/src/lib.rs b/crates/pet/src/lib.rs
@@ -34,9 +34,34 @@ pub fn find_and_report_envs_stdio(print_list: bool, print_summary: bool, verbose
         locator.configure(&config);
     }
 
-    find_and_report_envs(&reporter, config, &locators, conda_locator);
+    let summary = find_and_report_envs(&reporter, config, &locators, conda_locator);
 
     if print_summary {
+        let summary = summary.lock().unwrap();
+        println!();
+        println!("Breakdown by each locator:");
+        println!("--------------------------");
+        for locator in summary.find_locators_times.iter() {
+            println!("{:<20} : {:?}", locator.0, locator.1);
+        }
+        println!();
+
+        println!("Breakdown for finding Environments:");
+        println!("-----------------------------------");
+        println!(
+            "{:<20} : {:?}",
+            "Using locators", summary.find_locators_time
+        );
+        println!("{:<20} : {:?}", "PATH Variable", summary.find_path_time);
+        println!(
+            "{:<20} : {:?}",
+            "Global virtual envs", summary.find_global_virtual_envs_time
+        );
+        println!(
+            "{:<20} : {:?}",
+            "Custom search paths", summary.find_search_paths_time
+        );
+        println!();
         let summary = stdio_reporter.get_summary();
         if !summary.managers.is_empty() {
             println!("Managers:");

Original file line number	Diff line number	Diff line change
`@@ -146,6 +146,9 @@ impl Conda {`
`146`	`146`	`}`
`147`	`147`
`148`	`148`	`impl Locator for Conda {`
	`149`	`+ fn get_name(&self) -> &'static str {`
	`150`	`+ "Conda"`
	`151`	`+ }`
`149`	`152`	`fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {`
`150`	`153`	`vec![PythonEnvironmentCategory::Conda]`
`151`	`154`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,8 @@ pub struct Configuration {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`pub trait Locator: Send + Sync {`
	`37`	`+ /// Returns the name of the locator.`
	`38`	`+ fn get_name(&self) -> &'static str;`
`37`	`39`	`fn configure(&self, _config: &Configuration) {`
`38`	`40`	`//`
`39`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -98,6 +98,9 @@ fn from(env: &PythonEnv) -> Option<PythonEnvironment> {`
`98`	`98`	`}`
`99`	`99`
`100`	`100`	`impl Locator for Homebrew {`
	`101`	`+ fn get_name(&self) -> &'static str {`
	`102`	`+ "Homebrew"`
	`103`	`+ }`
`101`	`104`	`fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {`
`102`	`105`	`vec![PythonEnvironmentCategory::Homebrew]`
`103`	`106`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,9 @@ impl Default for LinuxGlobalPython {`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`	`impl Locator for LinuxGlobalPython {`
	`29`	`+ fn get_name(&self) -> &'static str {`
	`30`	`+ "LinuxGlobalPython"`
	`31`	`+ }`
`29`	`32`	`fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {`
`30`	`33`	`vec![PythonEnvironmentCategory::LinuxGlobal]`
`31`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,9 @@ impl Default for MacCmdLineTools {`
`28`	`28`	`}`
`29`	`29`	`}`
`30`	`30`	`impl Locator for MacCmdLineTools {`
	`31`	`+ fn get_name(&self) -> &'static str {`
	`32`	`+ "MacCmdLineTools"`
	`33`	`+ }`
`31`	`34`	`fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {`
`32`	`35`	`vec![PythonEnvironmentCategory::MacCommandLineTools]`
`33`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,9 @@ impl Default for MacPythonOrg {`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`	`impl Locator for MacPythonOrg {`
	`30`	`+ fn get_name(&self) -> &'static str {`
	`31`	`+ "MacPythonOrg"`
	`32`	`+ }`
`30`	`33`	`fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {`
`31`	`34`	`vec![PythonEnvironmentCategory::MacPythonOrg]`
`32`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,9 @@ impl Default for MacXCode {`
`25`	`25`	`}`
`26`	`26`	`}`
`27`	`27`	`impl Locator for MacXCode {`
	`28`	`+ fn get_name(&self) -> &'static str {`
	`29`	`+ "MacXCode"`
	`30`	`+ }`
`28`	`31`	`fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {`
`29`	`32`	`vec![PythonEnvironmentCategory::MacCommandLineTools]`
`30`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,9 @@ impl PipEnv {`
`71`	`71`	`}`
`72`	`72`	`}`
`73`	`73`	`impl Locator for PipEnv {`
	`74`	`+ fn get_name(&self) -> &'static str {`
	`75`	`+ "PipEnv"`
	`76`	`+ }`
`74`	`77`	`fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {`
`75`	`78`	`vec![PythonEnvironmentCategory::Pipenv]`
`76`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -134,6 +134,9 @@ impl Poetry {`
`134`	`134`	`}`
`135`	`135`
`136`	`136`	`impl Locator for Poetry {`
	`137`	`+ fn get_name(&self) -> &'static str {`
	`138`	`+ "Poetry"`
	`139`	`+ }`
`137`	`140`	`fn configure(&self, config: &Configuration) {`
`138`	`141`	`if let Some(search_paths) = &config.search_paths {`
`139`	`142`	`if !search_paths.is_empty() {`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,9 @@ impl PyEnv {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`impl Locator for PyEnv {`
	`51`	`+ fn get_name(&self) -> &'static str {`
	`52`	`+ "PyEnv"`
	`53`	`+ }`
`51`	`54`	`fn supported_categories(&self) -> Vec<PythonEnvironmentCategory> {`
`52`	`55`	`vec![`
`53`	`56`	`PythonEnvironmentCategory::Pyenv,`