foundry_config/providers/remappings.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
use crate::{foundry_toml_dirs, remappings_from_env_var, remappings_from_newline, Config};
use figment::{
value::{Dict, Map},
Error, Figment, Metadata, Profile, Provider,
};
use foundry_compilers::artifacts::remappings::{RelativeRemapping, Remapping};
use std::{
borrow::Cow,
collections::{btree_map::Entry, BTreeMap, HashSet},
fs,
path::{Path, PathBuf},
};
/// Wrapper types over a `Vec<Remapping>` that only appends unique remappings.
#[derive(Clone, Debug, Default)]
pub struct Remappings {
/// Remappings.
remappings: Vec<Remapping>,
/// Source, test and script configured project dirs.
/// Remappings of these dirs from libs are ignored.
project_paths: Vec<Remapping>,
}
impl Remappings {
/// Create a new `Remappings` wrapper with an empty vector.
pub fn new() -> Self {
Self { remappings: Vec::new(), project_paths: Vec::new() }
}
/// Create a new `Remappings` wrapper with a vector of remappings.
pub fn new_with_remappings(remappings: Vec<Remapping>) -> Self {
Self { remappings, project_paths: Vec::new() }
}
/// Extract project paths that cannot be remapped by dependencies.
pub fn with_figment(mut self, figment: &Figment) -> Self {
let mut add_project_remapping = |path: &str| {
if let Ok(path) = figment.find_value(path) {
if let Some(path) = path.into_string() {
let remapping = Remapping {
context: None,
name: format!("{path}/"),
path: format!("{path}/"),
};
self.project_paths.push(remapping);
}
}
};
add_project_remapping("src");
add_project_remapping("test");
add_project_remapping("script");
self
}
/// Filters the remappings vector by name and context.
fn filter_key(r: &Remapping) -> String {
match &r.context {
Some(str) => str.clone() + &r.name.clone(),
None => r.name.clone(),
}
}
/// Consumes the wrapper and returns the inner remappings vector.
pub fn into_inner(self) -> Vec<Remapping> {
let mut seen = HashSet::new();
let remappings =
self.remappings.iter().filter(|r| seen.insert(Self::filter_key(r))).cloned().collect();
remappings
}
/// Push an element to the remappings vector, but only if it's not already present.
pub fn push(&mut self, remapping: Remapping) {
if self.remappings.iter().any(|existing| {
// What we're doing here is filtering for ambiguous paths. For example, if we have
// @prb/math/=node_modules/@prb/math/src/ as existing, and
// @prb/=node_modules/@prb/ as the one being checked,
// we want to keep the already existing one, which is the first one. This way we avoid
// having to deal with ambiguous paths which is unwanted when autodetecting remappings.
existing.name.starts_with(&remapping.name) && existing.context == remapping.context
}) {
return;
};
// Ignore remappings of root project src, test or script dir.
// See <https://github.com/foundry-rs/foundry/issues/3440>.
if self
.project_paths
.iter()
.any(|project_path| remapping.name.eq_ignore_ascii_case(&project_path.name))
{
return;
};
self.remappings.push(remapping);
}
/// Extend the remappings vector, leaving out the remappings that are already present.
pub fn extend(&mut self, remappings: Vec<Remapping>) {
for remapping in remappings {
self.push(remapping);
}
}
}
/// A figment provider that checks if the remappings were previously set and if they're unset looks
/// up the fs via
/// - `DAPP_REMAPPINGS` || `FOUNDRY_REMAPPINGS` env var
/// - `<root>/remappings.txt` file
/// - `Remapping::find_many`.
pub struct RemappingsProvider<'a> {
/// Whether to auto detect remappings from the `lib_paths`
pub auto_detect_remappings: bool,
/// The lib/dependency directories to scan for remappings
pub lib_paths: Cow<'a, Vec<PathBuf>>,
/// the root path used to turn an absolute `Remapping`, as we're getting it from
/// `Remapping::find_many` into a relative one.
pub root: &'a Path,
/// This contains either:
/// - previously set remappings
/// - a `MissingField` error, which means previous provider didn't set the "remappings" field
/// - other error, like formatting
pub remappings: Result<Vec<Remapping>, Error>,
}
impl RemappingsProvider<'_> {
/// Find and parse remappings for the projects
///
/// **Order**
///
/// Remappings are built in this order (last item takes precedence)
/// - Autogenerated remappings
/// - toml remappings
/// - `remappings.txt`
/// - Environment variables
/// - CLI parameters
fn get_remappings(&self, remappings: Vec<Remapping>) -> Result<Vec<Remapping>, Error> {
trace!("get all remappings from {:?}", self.root);
/// prioritizes remappings that are closer: shorter `path`
/// - ("a", "1/2") over ("a", "1/2/3")
///
/// grouped by remapping context
fn insert_closest(
mappings: &mut BTreeMap<Option<String>, BTreeMap<String, PathBuf>>,
context: Option<String>,
key: String,
path: PathBuf,
) {
let context_mappings = mappings.entry(context).or_default();
match context_mappings.entry(key) {
Entry::Occupied(mut e) => {
if e.get().components().count() > path.components().count() {
e.insert(path);
}
}
Entry::Vacant(e) => {
e.insert(path);
}
}
}
// Let's first just extend the remappings with the ones that were passed in,
// without any filtering.
let mut user_remappings = Vec::new();
// check env vars
if let Some(env_remappings) = remappings_from_env_var("DAPP_REMAPPINGS")
.or_else(|| remappings_from_env_var("FOUNDRY_REMAPPINGS"))
{
user_remappings
.extend(env_remappings.map_err::<Error, _>(|err| err.to_string().into())?);
}
// check remappings.txt file
let remappings_file = self.root.join("remappings.txt");
if remappings_file.is_file() {
let content = fs::read_to_string(remappings_file).map_err(|err| err.to_string())?;
let remappings_from_file: Result<Vec<_>, _> =
remappings_from_newline(&content).collect();
user_remappings
.extend(remappings_from_file.map_err::<Error, _>(|err| err.to_string().into())?);
}
user_remappings.extend(remappings);
// Let's now use the wrapper to conditionally extend the remappings with the autodetected
// ones. We want to avoid duplicates, and the wrapper will handle this for us.
let mut all_remappings = Remappings::new_with_remappings(user_remappings);
// scan all library dirs and autodetect remappings
// TODO: if a lib specifies contexts for remappings manually, we need to figure out how to
// resolve that
if self.auto_detect_remappings {
let mut lib_remappings = BTreeMap::new();
// find all remappings of from libs that use a foundry.toml
for r in self.lib_foundry_toml_remappings() {
insert_closest(&mut lib_remappings, r.context, r.name, r.path.into());
}
// use auto detection for all libs
for r in self
.lib_paths
.iter()
.map(|lib| self.root.join(lib))
.inspect(|lib| trace!(?lib, "find all remappings"))
.flat_map(|lib| Remapping::find_many(&lib))
{
// this is an additional safety check for weird auto-detected remappings
if ["lib/", "src/", "contracts/"].contains(&r.name.as_str()) {
trace!(target: "forge", "- skipping the remapping");
continue
}
insert_closest(&mut lib_remappings, r.context, r.name, r.path.into());
}
all_remappings.extend(
lib_remappings
.into_iter()
.flat_map(|(context, remappings)| {
remappings.into_iter().map(move |(name, path)| Remapping {
context: context.clone(),
name,
path: path.to_string_lossy().into(),
})
})
.collect(),
);
}
Ok(all_remappings.into_inner())
}
/// Returns all remappings declared in foundry.toml files of libraries
fn lib_foundry_toml_remappings(&self) -> impl Iterator<Item = Remapping> + '_ {
self.lib_paths
.iter()
.map(|p| if p.is_absolute() { self.root.join("lib") } else { self.root.join(p) })
.flat_map(foundry_toml_dirs)
.inspect(|lib| {
trace!("find all remappings of nested foundry.toml lib: {:?}", lib);
})
.flat_map(|lib: PathBuf| {
// load config, of the nested lib if it exists
let config = Config::load_with_root(&lib).sanitized();
// if the configured _src_ directory is set to something that
// [Remapping::find_many()] doesn't classify as a src directory (src, contracts,
// lib), then we need to manually add a remapping here
let mut src_remapping = None;
if ![Path::new("src"), Path::new("contracts"), Path::new("lib")]
.contains(&config.src.as_path())
{
if let Some(name) = lib.file_name().and_then(|s| s.to_str()) {
let mut r = Remapping {
context: None,
name: format!("{name}/"),
path: format!("{}", lib.join(&config.src).display()),
};
if !r.path.ends_with('/') {
r.path.push('/')
}
src_remapping = Some(r);
}
}
// Eventually, we could set context for remappings at this location,
// taking into account the OS platform. We'll need to be able to handle nested
// contexts depending on dependencies for this to work.
// For now, we just leave the default context (none).
let mut remappings =
config.remappings.into_iter().map(Remapping::from).collect::<Vec<Remapping>>();
if let Some(r) = src_remapping {
remappings.push(r);
}
remappings
})
}
}
impl Provider for RemappingsProvider<'_> {
fn metadata(&self) -> Metadata {
Metadata::named("Remapping Provider")
}
fn data(&self) -> Result<Map<Profile, Dict>, Error> {
let remappings = match &self.remappings {
Ok(remappings) => self.get_remappings(remappings.clone()),
Err(err) => {
if let figment::error::Kind::MissingField(_) = err.kind {
self.get_remappings(vec![])
} else {
return Err(err.clone())
}
}
}?;
// turn the absolute remapping into a relative one by stripping the `root`
let remappings = remappings
.into_iter()
.map(|r| RelativeRemapping::new(r, self.root).to_string())
.collect::<Vec<_>>();
Ok(Map::from([(
Config::selected_profile(),
Dict::from([("remappings".to_string(), figment::value::Value::from(remappings))]),
)]))
}
fn profile(&self) -> Option<Profile> {
Some(Config::selected_profile())
}
}