// Copyright 2018-2025 the Deno authors. MIT license. use std::collections::HashMap; use std::fs; use std::path::Path; use anyhow::Context; use anyhow::Result; use base64::prelude::BASE64_STANDARD; use base64::Engine; use flate2::write::GzEncoder; use flate2::Compression; use once_cell::sync::Lazy; use parking_lot::Mutex; use tar::Builder; use crate::tests_path; use crate::PathRef; pub const DENOTEST_SCOPE_NAME: &str = "@denotest"; pub const DENOTEST2_SCOPE_NAME: &str = "@denotest2"; pub const DENOTEST3_SCOPE_NAME: &str = "@denotest3"; pub static PUBLIC_TEST_NPM_REGISTRY: Lazy = Lazy::new(|| { TestNpmRegistry::new( NpmRegistryKind::Public, &format!( "http://localhost:{}", crate::servers::PUBLIC_NPM_REGISTRY_PORT ), "npm", ) }); pub static PRIVATE_TEST_NPM_REGISTRY_1: Lazy = Lazy::new(|| { TestNpmRegistry::new( NpmRegistryKind::Private, &format!( "http://localhost:{}", crate::servers::PRIVATE_NPM_REGISTRY_1_PORT ), "npm-private", ) }); pub static PRIVATE_TEST_NPM_REGISTRY_2: Lazy = Lazy::new(|| { TestNpmRegistry::new( NpmRegistryKind::Private, &format!( "http://localhost:{}", crate::servers::PRIVATE_NPM_REGISTRY_2_PORT ), "npm-private2", ) }); pub static PRIVATE_TEST_NPM_REGISTRY_3: Lazy = Lazy::new(|| { TestNpmRegistry::new( NpmRegistryKind::Private, &format!( "http://localhost:{}", crate::servers::PRIVATE_NPM_REGISTRY_3_PORT ), "npm-private3", ) }); pub enum NpmRegistryKind { Public, Private, } struct CustomNpmPackage { pub registry_file: String, pub tarballs: HashMap>, } /// Creates tarballs and a registry json file for npm packages /// in the `tests/registry/npm/@denotest` directory. pub struct TestNpmRegistry { #[allow(unused)] kind: NpmRegistryKind, // Eg. http://localhost:4544/ hostname: String, /// Path in the tests/registry folder (Eg. npm) local_path: String, cache: Mutex>, } impl TestNpmRegistry { pub fn new(kind: NpmRegistryKind, hostname: &str, local_path: &str) -> Self { let hostname = hostname.strip_suffix('/').unwrap_or(hostname).to_string(); Self { hostname, local_path: local_path.to_string(), kind, cache: Default::default(), } } pub fn root_dir(&self) -> PathRef { tests_path().join("registry").join(&self.local_path) } pub fn tarball_bytes( &self, name: &str, version: &str, ) -> Result>> { Ok( self .get_package_property(name, |p| p.tarballs.get(version).cloned())? .flatten(), ) } pub fn registry_file(&self, name: &str) -> Result>> { self.get_package_property(name, |p| p.registry_file.as_bytes().to_vec()) } pub fn package_url(&self, package_name: &str) -> String { let scheme = if self.hostname.starts_with("http://") { "" } else { "http://" }; format!("{}{}/{}/", scheme, self.hostname, package_name) } fn get_package_property( &self, package_name: &str, func: impl FnOnce(&CustomNpmPackage) -> TResult, ) -> Result> { // it's ok if multiple threads race here as they will do the same work twice if !self.cache.lock().contains_key(package_name) { match get_npm_package(&self.hostname, &self.local_path, package_name)? { Some(package) => { self.cache.lock().insert(package_name.to_string(), package); } None => return Ok(None), } } Ok(self.cache.lock().get(package_name).map(func)) } pub fn get_test_scope_and_package_name_with_path_from_uri_path<'s>( &self, uri_path: &'s str, ) -> Option<(&'s str, &'s str)> { let prefix1 = format!("/{}/", DENOTEST_SCOPE_NAME); let prefix2 = format!("/{}%2f", DENOTEST_SCOPE_NAME); let maybe_package_name_with_path = uri_path .strip_prefix(&prefix1) .or_else(|| uri_path.strip_prefix(&prefix2)); if let Some(package_name_with_path) = maybe_package_name_with_path { return Some((DENOTEST_SCOPE_NAME, package_name_with_path)); } let prefix1 = format!("/{}/", DENOTEST2_SCOPE_NAME); let prefix2 = format!("/{}%2f", DENOTEST2_SCOPE_NAME); let maybe_package_name_with_path = uri_path .strip_prefix(&prefix1) .or_else(|| uri_path.strip_prefix(&prefix2)); if let Some(package_name_with_path) = maybe_package_name_with_path { return Some((DENOTEST2_SCOPE_NAME, package_name_with_path)); } let prefix1 = format!("/{}/", DENOTEST3_SCOPE_NAME); let prefix2 = format!("/{}%2f", DENOTEST3_SCOPE_NAME); let maybe_package_name_with_path = uri_path .strip_prefix(&prefix1) .or_else(|| uri_path.strip_prefix(&prefix2)); if let Some(package_name_with_path) = maybe_package_name_with_path { return Some((DENOTEST3_SCOPE_NAME, package_name_with_path)); } None } } // NOTE: extracted out partially from the `tar` crate, all credits to the original authors fn append_dir_all( builder: &mut tar::Builder, path: &Path, src_path: &Path, ) -> Result<()> { builder.follow_symlinks(true); let mode = tar::HeaderMode::Deterministic; builder.mode(mode); let mut stack = vec![(src_path.to_path_buf(), true, false)]; let mut entries = Vec::new(); while let Some((src, is_dir, is_symlink)) = stack.pop() { let dest = path.join(src.strip_prefix(src_path).unwrap()); // In case of a symlink pointing to a directory, is_dir is false, but src.is_dir() will return true if is_dir || (is_symlink && src.is_dir()) { for entry in fs::read_dir(&src)? { let entry = entry?; let file_type = entry.file_type()?; stack.push((entry.path(), file_type.is_dir(), file_type.is_symlink())); } if dest != Path::new("") { entries.push((src, dest)); } } else { entries.push((src, dest)); } } entries.sort_by(|(_, a), (_, b)| a.cmp(b)); for (src, dest) in entries { let mut header = tar::Header::new_gnu(); let metadata = src.metadata().with_context(|| { format!("trying to get metadata for {}", src.display()) })?; header.set_metadata_in_mode(&metadata, mode); // this is what `tar` sets the mtime to on unix in deterministic mode, on windows it uses a different // value, which causes the tarball to have a different hash on windows. force it to be the same // to ensure the same output on all platforms header.set_mtime(1153704088); let data = if src.is_file() { Box::new( fs::File::open(&src) .with_context(|| format!("trying to open file {}", src.display()))?, ) as Box } else { Box::new(std::io::empty()) as Box }; builder .append_data(&mut header, dest, data) .with_context(|| "appending data")?; } Ok(()) } fn get_npm_package( registry_hostname: &str, local_path: &str, package_name: &str, ) -> Result> { let registry_hostname = if package_name == "@denotest/tarballs-privateserver2" { "http://localhost:4262" } else { registry_hostname }; let package_folder = tests_path() .join("registry") .join(local_path) .join(package_name); if !package_folder.exists() { return Ok(None); } // read all the package's versions let mut tarballs = HashMap::new(); let mut versions = serde_json::Map::new(); let mut latest_version = semver::Version::parse("0.0.0").unwrap(); let mut dist_tags = serde_json::Map::new(); for entry in fs::read_dir(&package_folder)? { let entry = entry?; let file_type = entry.file_type()?; if !file_type.is_dir() { continue; } let version = entry.file_name().to_string_lossy().to_string(); let version_folder = package_folder.join(&version); // create the tarball let mut tarball_bytes = Vec::new(); { let mut encoder = GzEncoder::new(&mut tarball_bytes, Compression::default()); { let mut builder = Builder::new(&mut encoder); append_dir_all( &mut builder, Path::new("package"), version_folder.as_path(), ) .with_context(|| { format!("Error adding tarball for directory {}", version_folder,) })?; builder.finish()?; } encoder.finish()?; } // get tarball hash let tarball_checksum = get_tarball_checksum(&tarball_bytes); // create the registry file JSON for this version let mut dist = serde_json::Map::new(); dist.insert( "integrity".to_string(), format!("sha512-{tarball_checksum}").into(), ); dist.insert("shasum".to_string(), "dummy-value".into()); dist.insert( "tarball".to_string(), format!("{registry_hostname}/{package_name}/{version}.tgz").into(), ); tarballs.insert(version.clone(), tarball_bytes); let package_json_path = version_folder.join("package.json"); let package_json_bytes = fs::read(&package_json_path).with_context(|| { format!("Error reading package.json at {}", package_json_path) })?; let package_json_text = String::from_utf8_lossy(&package_json_bytes); let mut version_info: serde_json::Map = serde_json::from_str(&package_json_text)?; version_info.insert("dist".to_string(), dist.into()); if let Some(maybe_optional_deps) = version_info.get("optionalDependencies") { if let Some(optional_deps) = maybe_optional_deps.as_object() { if let Some(maybe_deps) = version_info.get("dependencies") { if let Some(deps) = maybe_deps.as_object() { let mut cloned_deps = deps.to_owned(); for (key, value) in optional_deps { cloned_deps.insert(key.to_string(), value.to_owned()); } version_info.insert( "dependencies".to_string(), serde_json::to_value(cloned_deps).unwrap(), ); } } else { version_info.insert( "dependencies".to_string(), serde_json::to_value(optional_deps).unwrap(), ); } } } if let Some(publish_config) = version_info.get("publishConfig") { if let Some(tag) = publish_config.get("tag") { if let Some(tag) = tag.as_str() { dist_tags.insert(tag.to_string(), version.clone().into()); } } } versions.insert(version.clone(), version_info.into()); let version = semver::Version::parse(&version)?; if version.cmp(&latest_version).is_gt() { latest_version = version; } } if !dist_tags.contains_key("latest") { dist_tags.insert("latest".to_string(), latest_version.to_string().into()); } // create the registry file for this package let mut registry_file = serde_json::Map::new(); registry_file.insert("name".to_string(), package_name.to_string().into()); registry_file.insert("versions".to_string(), versions.into()); registry_file.insert("dist-tags".to_string(), dist_tags.into()); Ok(Some(CustomNpmPackage { registry_file: serde_json::to_string(®istry_file).unwrap(), tarballs, })) } fn get_tarball_checksum(bytes: &[u8]) -> String { use sha2::Digest; let mut hasher = sha2::Sha512::new(); hasher.update(bytes); BASE64_STANDARD.encode(hasher.finalize()) }