refactor: reduce cwd lookups and enforce canonicalize_path (#32250)

1. Enforces using `resolve_cwd`, which is more efficient and reduces.
2. Uses `canonicalize_path` instead of `.canonicalize()` because it
strips the unc path on Windows without us having to remember to do that.

Author: dsherret

cli/args/flags.rs

@@ -67,6 +67,7 @@ use serde::Deserialize;
 use serde::Serialize;
 
 use super::flags_net;
+use crate::util::env::resolve_cwd;
 use crate::util::fs::canonicalize_path;
 
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
@@ -1415,7 +1416,7 @@ impl Flags {
         exclude: excluded_paths,
         ..
       })) => {
-        let cwd = std::env::current_dir()?;
+        let cwd = resolve_cwd(self.initial_cwd.as_deref())?;
         PathOrPatternSet::from_exclude_relative_path_or_patterns(
           &cwd,
           excluded_paths,
@@ -6145,7 +6146,8 @@ fn completions_parse(
         unsafe {
           std::env::set_var("COMPLETE", &shell);
         }
-        handle_shell_completion_with_args(std::env::args_os().take(1))?;
+        let cwd = resolve_cwd(None)?;
+        handle_shell_completion_with_args(std::env::args_os().take(1), &cwd)?;
         Ok(())
       }),
     ));
@@ -7024,8 +7026,8 @@ fn task_parse(
   Ok(())
 }
 
-pub fn handle_shell_completion() -> Result<(), AnyError> {
-  handle_shell_completion_with_args(std::env::args_os())
+pub fn handle_shell_completion(cwd: &Path) -> Result<(), AnyError> {
+  handle_shell_completion_with_args(std::env::args_os(), cwd)
 }
 
 struct ZshCompleterUnsorted;
@@ -7112,6 +7114,7 @@ compdef _clap_dynamic_completer_NAME BIN"#
 
 fn handle_shell_completion_with_args(
   args: impl IntoIterator<Item = OsString>,
+  cwd: &Path,
 ) -> Result<(), AnyError> {
   let args = args.into_iter().collect::<Vec<_>>();
   let app = clap_root();
@@ -7124,7 +7127,7 @@ fn handle_shell_completion_with_args(
       &clap_complete::env::Powershell,
       &ZshCompleterUnsorted,
     ]))
-    .try_complete(args, Some(&std::env::current_dir()?))?;
+    .try_complete(args, Some(cwd))?;
 
   // we should only run this function when we're doing completions
   assert!(ran_completion);
@@ -12560,12 +12563,12 @@ mod tests {
   #[test]
   fn test_config_path_args() {
     let flags = flags_from_vec(svec!["deno", "run", "foo.js"]).unwrap();
-    let cwd = std::env::current_dir().unwrap();
+    let cwd = resolve_cwd(None).unwrap().into_owned();
 
     assert_eq!(flags.config_path_args(&cwd), Some(vec![cwd.clone()]));
 
     let flags = flags_from_vec(svec!["deno", "run", "sub_dir/foo.js"]).unwrap();
-    let cwd = std::env::current_dir().unwrap();
+    let cwd = resolve_cwd(None).unwrap().into_owned();
     assert_eq!(
       flags.config_path_args(&cwd),
       Some(vec![cwd.join("sub_dir").clone()])

cli/args/mod.rs

@@ -1785,13 +1785,14 @@ mod test {
   use pretty_assertions::assert_eq;
 
   use super::*;
+  use crate::util::env::resolve_cwd;
 
   #[test]
   fn resolve_import_map_flags_take_precedence() {
     let config_text = r#"{
       "importMap": "import_map.json"
     }"#;
-    let cwd = &std::env::current_dir().unwrap();
+    let cwd = &resolve_cwd(None).unwrap();
     let config_specifier = Url::parse("file:///deno/deno.jsonc").unwrap();
     let config_file = ConfigFile::new(config_text, config_specifier).unwrap();
     let actual = resolve_import_map_specifier(
@@ -1859,7 +1860,7 @@ mod test {
 
   #[test]
   fn test_flags_to_permission_options() {
-    let base_dir = std::env::current_dir().unwrap().join("sub");
+    let base_dir = resolve_cwd(None).unwrap().join("sub");
     {
       let flags = PermissionFlags::default();
       let config = PermissionsObjectWithBase {

cli/build.rs

@@ -135,6 +135,7 @@ fn compress_decls(out_dir: &Path) {
 }
 
 fn process_node_types(out_dir: &Path) {
+  #[allow(clippy::disallowed_methods)] // build script
   let root_dir = Path::new(".").canonicalize().unwrap();
   let dts_dir = root_dir.join("tsc").join("dts");
   let node_dir = dts_dir.join("node");
@@ -201,6 +202,7 @@ fn process_node_types(out_dir: &Path) {
 }
 
 fn compress_source(out_dir: &Path, file: &str) {
+  #[allow(clippy::disallowed_methods)] // build script
   let path = Path::new(file)
     .canonicalize()
     .unwrap_or_else(|_| panic!("expected file \"{file}\" to exist"));

cli/clippy.toml

@@ -1,5 +1,8 @@
 disallowed-methods = [
   { path = "reqwest::Client::new", reason = "create an HttpClient via an HttpClientProvider instead" },
+  { path = "std::fs::canonicalize", reason = "use crate::util::fs::canonicalize_path instead" },
+  { path = "std::path::Path::canonicalize", reason = "use crate::util::fs::canonicalize_path instead" },
+  { path = "std::env::current_dir", reason = "use crate::util::env::resolve_cwd instead and prefer passing it the initial_cwd" },
   { path = "std::process::exit", reason = "use deno_runtime::exit instead" },
   { path = "clap::Arg::env", reason = "ensure environment variables are resolved after loading the .env file instead" },
   { path = "tokio::signal::ctrl_c", reason = "use deno_signals crate instead" },

cli/factory.rs

@@ -1150,7 +1150,6 @@ impl CliFactory {
       self.npm_installer_if_managed().await?.cloned(),
       npm_resolver.clone(),
       self.text_only_progress_bar().clone(),
-      self.sys(),
       self.create_cli_main_worker_options()?,
       self.root_permissions_container()?.clone(),
     ))
@@ -1228,7 +1227,7 @@ impl CliFactory {
       create_hmr_runner,
       maybe_coverage_dir,
       default_npm_caching_strategy: cli_options.default_npm_caching_strategy(),
-      maybe_initial_cwd: Some(Arc::new(initial_cwd)),
+      initial_cwd: Arc::new(initial_cwd),
     })
   }
 

cli/lib.rs

@@ -55,11 +55,13 @@ use deno_runtime::tokio_util::create_and_run_current_thread_with_maybe_metrics;
 use deno_telemetry::OtelConfig;
 use deno_terminal::colors;
 use factory::CliFactory;
+use util::fs::canonicalize_path;
 
 const MODULE_NOT_FOUND: &str = "Module not found";
 const UNSUPPORTED_SCHEME: &str = "Unsupported scheme";
 
 use self::util::draw_thread::DrawThread;
+use self::util::env::resolve_cwd;
 use crate::args::CompletionsFlags;
 use crate::args::DenoSubcommand;
 use crate::args::Flags;
@@ -193,9 +195,9 @@ async fn run_subcommand(
     DenoSubcommand::Fmt(fmt_flags) => spawn_subcommand(async move {
       tools::fmt::format(Arc::new(flags), fmt_flags).await
     }),
-    DenoSubcommand::Init(init_flags) => {
-      spawn_subcommand(async { tools::init::init_project(init_flags).await })
-    }
+    DenoSubcommand::Init(init_flags) => spawn_subcommand(async {
+      tools::init::init_project(flags, init_flags).await
+    }),
     DenoSubcommand::Info(info_flags) => spawn_subcommand(async {
       tools::info::info(Arc::new(flags), info_flags).await
     }),
@@ -416,7 +418,7 @@ async fn run_subcommand(
           unsafe {
             env::set_var(
               "DENO_COVERAGE_DIR",
-              PathBuf::from(coverage_dir).canonicalize()?,
+              canonicalize_path(&PathBuf::from(coverage_dir))?,
             )
           };
         }
@@ -659,15 +661,17 @@ pub fn main() {
       (None, None, None);
 
     let args = waited_args.unwrap_or(args);
-    let initial_cwd = waited_cwd.map(Some).unwrap_or_else(|| {
-      match std::env::current_dir().with_context(|| "Failed getting cwd.") {
-        Ok(cwd) => Some(cwd),
-        Err(err) => {
-          log::error!("Failed getting cwd: {err}");
-          None
-        }
-      }
-    });
+    #[allow(clippy::disallowed_methods)] // ok because initialization of cwd
+    let initial_cwd =
+      waited_cwd
+        .map(Some)
+        .unwrap_or_else(|| match std::env::current_dir() {
+          Ok(cwd) => Some(cwd),
+          Err(err) => {
+            log::error!("Failed getting cwd: {err}");
+            None
+          }
+        });
 
     // NOTE(lucacasonato): due to new PKU feature introduced in V8 11.6 we need to
     // initialize the V8 platform on a parent thread of all threads that will spawn
@@ -706,7 +710,8 @@ async fn resolve_flags_and_init(
   // this env var is used by clap to enable dynamic completions, it's set by the shell when
   // executing deno to get dynamic completions.
   if std::env::var("COMPLETE").is_ok() {
-    crate::args::handle_shell_completion()?;
+    let cwd = resolve_cwd(initial_cwd.as_deref())?;
+    crate::args::handle_shell_completion(&cwd)?;
     deno_runtime::exit(0);
   }
 

cli/lsp/completions.rs

@@ -38,6 +38,7 @@ use super::tsc;
 use crate::jsr::JsrFetchResolver;
 use crate::lsp::registries::DocumentationCompletionItemData;
 use crate::lsp::tsgo;
+use crate::util::env::resolve_cwd;
 use crate::util::path::is_importable_ext;
 use crate::util::path::relative_specifier;
 
@@ -434,7 +435,7 @@ fn get_local_completions(
     .ok()?;
   let resolved_parent_path = url_to_file_path(&resolved_parent).ok()?;
   if resolved_parent_path.is_dir() {
-    let cwd = std::env::current_dir().ok()?;
+    let cwd = resolve_cwd(None).ok()?;
     let entries = std::fs::read_dir(resolved_parent_path).ok()?;
     let items = entries
       .filter_map(|de| {

cli/lsp/config.rs

@@ -70,6 +70,7 @@ use crate::http_util::HttpClientProvider;
 use crate::lsp::logging::lsp_warn;
 use crate::npm::CliNpmCacheHttpClient;
 use crate::sys::CliSys;
+use crate::util::fs::canonicalize_path;
 use crate::util::fs::canonicalize_path_maybe_not_exists;
 use crate::util::progress_bar::ProgressBar;
 use crate::util::progress_bar::ProgressBarStyle;
@@ -1845,7 +1846,7 @@ impl ConfigTree {
     let pkg_json_cache = PackageJsonMemCache::default();
     let workspace_cache = WorkspaceMemCache::default();
     let mut scopes = BTreeMap::new();
-    let fs_root_url = std::fs::canonicalize("/")
+    let fs_root_url = canonicalize_path(Path::new("/"))
       .ok()
       .and_then(|p| Url::from_directory_path(p).ok())
       .unwrap_or_else(|| Url::parse("file:///").unwrap());

cli/lsp/language_server.rs

@@ -118,6 +118,7 @@ use crate::tools::fmt::format_file;
 use crate::tools::fmt::format_parsed_source;
 use crate::tools::upgrade::check_for_upgrades_for_lsp;
 use crate::tools::upgrade::upgrade_check_enabled;
+use crate::util::env::resolve_cwd;
 use crate::util::fs::remove_dir_all_if_exists;
 use crate::util::path::to_percent_decoded_str;
 use crate::util::sync::AsyncFlag;
@@ -584,9 +585,7 @@ impl Inner {
       cache.deno_dir(),
       &http_client_provider,
     ));
-    let initial_cwd = std::env::current_dir().unwrap_or_else(|_| {
-      panic!("Could not resolve current working directory")
-    });
+    let initial_cwd = resolve_cwd(None).unwrap().into_owned();
 
     Self {
       ambient_modules_regex_cache: Default::default(),
@@ -3987,7 +3986,7 @@ struct PrepareCacheResult {
 impl Inner {
   async fn initialized(&mut self) -> Vec<Registration> {
     let mut registrations = Vec::with_capacity(2);
-    init_log_file(self.config.log_file());
+    init_log_file(self.config.log_file(), &self.initial_cwd);
     self.update_debug_flag();
     self.update_global_cache().await;
     self.refresh_workspace_files();

cli/lsp/logging.rs

@@ -53,12 +53,11 @@ impl LogFile {
   }
 }
 
-pub fn init_log_file(enabled: bool) {
+pub fn init_log_file(enabled: bool, cwd: &Path) {
   let prepare_path = || {
     if !enabled {
       return None;
     }
-    let cwd = std::env::current_dir().ok()?;
     let now = SystemTime::now();
     let now: DateTime<Utc> = now.into();
     let now = now.to_rfc3339().replace(':', "_");