// Copyright 2024 The Jujutsu Authors//// Licensed under the Apache License, Version 2.0 (the "License");// you may not use this file except in compliance with the License.// You may obtain a copy of the License at//// https://www.apache.org/licenses/LICENSE-2.0//// Unless required by applicable law or agreed to in writing, software// distributed under the License is distributed on an "AS IS" BASIS,// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.// See the License for the specific language governing permissions and// limitations under the License. //! Post-processing functions for [`StackedConfig`]. use std::path::Path;use std::path::PathBuf;use std::sync::Arc; use itertools::Itertools as _;use serde::Deserialize as _;use serde::de::IntoDeserializer as _;use thiserror::Error;use toml_edit::DocumentMut; use crate::config::ConfigGetError;use crate::config::ConfigLayer;use crate::config::ConfigNamePathBuf;use crate::config::ConfigSource;use crate::config::ConfigUpdateError;use crate::config::ConfigValue;use crate::config::StackedConfig;use crate::config::ToConfigNamePath; // Prefixed by "--" so these keys look unusual. It's also nice that "-" is// placed earlier than the other keys in lexicographical order.const SCOPE_CONDITION_KEY: &str = "--when";const SCOPE_TABLE_KEY: &str = "--scope"; /// Parameters to enable scoped config tables conditionally.#[derive(Clone, Debug)]pub struct ConfigResolutionContext<'a> {    /// Home directory. `~` will be substituted with this path.    pub home_dir: Option<&'a Path>,    /// Repository path, which is usually `<main_workspace_root>/.jj/repo`.    pub repo_path: Option<&'a Path>,    /// Workspace path: `<workspace_root>`.    pub workspace_path: Option<&'a Path>,    /// Space-separated subcommand. `jj file show ...` should result in `"file    /// show"`.    pub command: Option<&'a str>,    /// Hostname    pub hostname: &'a str,} /// Conditions to enable the parent table.////// - Each predicate is tested separately, and the results are intersected./// - `None` means there are no constraints. (i.e. always `true`)// TODO: introduce fileset-like DSL?// TODO: add support for fileset-like pattern prefixes? it might be a bit tricky// if path canonicalization is involved.#[derive(Clone, Debug, Default, serde::Deserialize)]#[serde(default, rename_all = "kebab-case")]struct ScopeCondition {    /// Paths to match the repository path prefix.    pub repositories: Option<Vec<PathBuf>>,    /// Paths to match the workspace path prefix.    pub workspaces: Option<Vec<PathBuf>>,    /// Commands to match. Subcommands are matched space-separated.    /// - `--when.commands = ["foo"]` -> matches "foo", "foo bar", "foo bar baz"    /// - `--when.commands = ["foo bar"]` -> matches "foo bar", "foo bar baz",    ///   NOT "foo"    pub commands: Option<Vec<String>>,    /// Platforms to match. The values are defined by `std::env::consts::FAMILY`    /// and `std::env::consts::OS`.    pub platforms: Option<Vec<String>>,    /// Hostnames to match the hostname.    pub hostnames: Option<Vec<String>>,} impl ScopeCondition {    fn from_value(        value: ConfigValue,        context: &ConfigResolutionContext,    ) -> Result<Self, toml_edit::de::Error> {        Self::deserialize(value.into_deserializer())?            .expand_paths(context)            .map_err(serde::de::Error::custom)    }     fn expand_paths(mut self, context: &ConfigResolutionContext) -> Result<Self, &'static str> {        // It might make some sense to compare paths in canonicalized form, but        // be careful to not resolve relative path patterns against cwd, which        // wouldn't be what the user would expect.        for path in self.repositories.as_mut().into_iter().flatten() {            if let Some(new_path) = expand_home(path, context.home_dir)? {                *path = new_path;            }        }        for path in self.workspaces.as_mut().into_iter().flatten() {            if let Some(new_path) = expand_home(path, context.home_dir)? {                *path = new_path;            }        }        Ok(self)    }     fn matches(&self, context: &ConfigResolutionContext) -> bool {        matches_path_prefix(self.repositories.as_deref(), context.repo_path)            && matches_path_prefix(self.workspaces.as_deref(), context.workspace_path)            && matches_platform(self.platforms.as_deref())            && matches_hostname(self.hostnames.as_deref(), context.hostname)            && matches_command(self.commands.as_deref(), context.command)    }} fn expand_home(path: &Path, home_dir: Option<&Path>) -> Result<Option<PathBuf>, &'static str> {    match path.strip_prefix("~") {        Ok(tail) => {            let home_dir = home_dir.ok_or("Cannot expand ~ (home directory is unknown)")?;            Ok(Some(home_dir.join(tail)))        }        Err(_) => Ok(None),    }} fn matches_path_prefix(candidates: Option<&[PathBuf]>, actual: Option<&Path>) -> bool {    match (candidates, actual) {        (Some(candidates), Some(actual)) => candidates.iter().any(|base| actual.starts_with(base)),        (Some(_), None) => false, // actual path not known (e.g. not in workspace)        (None, _) => true,        // no constraints    }} fn matches_platform(candidates: Option<&[String]>) -> bool {    candidates.is_none_or(|candidates| {        candidates            .iter()            .any(|value| value == std::env::consts::FAMILY || value == std::env::consts::OS)    })} fn matches_hostname(candidates: Option<&[String]>, actual: &str) -> bool {    candidates.is_none_or(|candidates| candidates.iter().any(|candidate| actual == candidate))} fn matches_command(candidates: Option<&[String]>, actual: Option<&str>) -> bool {    match (candidates, actual) {        (Some(candidates), Some(actual)) => candidates.iter().any(|candidate| {            actual                .strip_prefix(candidate)                .is_some_and(|trailing| trailing.starts_with(' ') || trailing.is_empty())        }),        (Some(_), None) => false,        (None, _) => true,    }} /// Evaluates condition for each layer and scope, flattens scoped tables./// Returns new config that only contains enabled layers and tables.pub fn resolve(    source_config: &StackedConfig,    context: &ConfigResolutionContext,) -> Result<StackedConfig, ConfigGetError> {    let mut source_layers_stack: Vec<Arc<ConfigLayer>> =        source_config.layers().iter().rev().cloned().collect();    let mut resolved_layers: Vec<Arc<ConfigLayer>> = Vec::new();    while let Some(mut source_layer) = source_layers_stack.pop() {        if !source_layer.data.contains_key(SCOPE_CONDITION_KEY)            && !source_layer.data.contains_key(SCOPE_TABLE_KEY)        {            resolved_layers.push(source_layer); // reuse original table            continue;        }         let layer_mut = Arc::make_mut(&mut source_layer);        let condition = pop_scope_condition(layer_mut, context)?;        if !condition.matches(context) {            continue;        }        let tables = pop_scope_tables(layer_mut)?;        // tables.iter() does not implement DoubleEndedIterator as of toml_edit        // 0.22.22.        let frame = source_layers_stack.len();        for table in tables {            let layer = ConfigLayer {                source: source_layer.source,                path: source_layer.path.clone(),                data: DocumentMut::from(table),            };            source_layers_stack.push(Arc::new(layer));        }        source_layers_stack[frame..].reverse();        resolved_layers.push(source_layer);    }    let mut resolved_config = StackedConfig::empty();    resolved_config.extend_layers(resolved_layers);    Ok(resolved_config)} fn pop_scope_condition(    layer: &mut ConfigLayer,    context: &ConfigResolutionContext,) -> Result<ScopeCondition, ConfigGetError> {    let Some(item) = layer.data.remove(SCOPE_CONDITION_KEY) else {        return Ok(ScopeCondition::default());    };    let value = item        .clone()        .into_value()        .expect("Item::None should not exist in table");    ScopeCondition::from_value(value, context).map_err(|err| ConfigGetError::Type {        name: SCOPE_CONDITION_KEY.to_owned(),        error: err.into(),        source_path: layer.path.clone(),    })} fn pop_scope_tables(layer: &mut ConfigLayer) -> Result<toml_edit::ArrayOfTables, ConfigGetError> {    let Some(item) = layer.data.remove(SCOPE_TABLE_KEY) else {        return Ok(toml_edit::ArrayOfTables::new());    };    item.into_array_of_tables()        .map_err(|item| ConfigGetError::Type {            name: SCOPE_TABLE_KEY.to_owned(),            error: format!("Expected an array of tables, but is {}", item.type_name()).into(),            source_path: layer.path.clone(),        })} /// Error that can occur when migrating config variables.#[derive(Debug, Error)]#[error("Migration failed")]pub struct ConfigMigrateError {    /// Source error.    #[source]    pub error: ConfigMigrateLayerError,    /// Source file path where the value is defined.    pub source_path: Option<PathBuf>,} /// Inner error of [`ConfigMigrateError`].#[derive(Debug, Error)]pub enum ConfigMigrateLayerError {    /// Cannot delete old value or set new value.    #[error(transparent)]    Update(#[from] ConfigUpdateError),    /// Old config value cannot be converted.    #[error("Invalid type or value for {name}")]    Type {        /// Dotted config name path.        name: String,        /// Source error.        #[source]        error: DynError,    },} impl ConfigMigrateLayerError {    fn with_source_path(self, source_path: Option<&Path>) -> ConfigMigrateError {        ConfigMigrateError {            error: self,            source_path: source_path.map(|path| path.to_owned()),        }    }} type DynError = Box<dyn std::error::Error + Send + Sync>; /// Rule to migrate deprecated config variables.pub struct ConfigMigrationRule {    inner: MigrationRule,} enum MigrationRule {    RenameValue {        old_name: ConfigNamePathBuf,        new_name: ConfigNamePathBuf,    },    RenameUpdateValue {        old_name: ConfigNamePathBuf,        new_name: ConfigNamePathBuf,        #[expect(clippy::type_complexity)] // type alias wouldn't help readability        new_value_fn: Box<dyn Fn(&ConfigValue) -> Result<ConfigValue, DynError>>,    },    Custom {        matches_fn: Box<dyn Fn(&ConfigLayer) -> bool>,        #[expect(clippy::type_complexity)] // type alias wouldn't help readability        apply_fn: Box<dyn Fn(&mut ConfigLayer) -> Result<String, ConfigMigrateLayerError>>,    },} impl ConfigMigrationRule {    /// Creates rule that moves value from `old_name` to `new_name`.    pub fn rename_value(old_name: impl ToConfigNamePath, new_name: impl ToConfigNamePath) -> Self {        let inner = MigrationRule::RenameValue {            old_name: old_name.into_name_path().into(),            new_name: new_name.into_name_path().into(),        };        Self { inner }    }     /// Creates rule that moves value from `old_name` to `new_name`, and updates    /// the value.    ///    /// If `new_value_fn(&old_value)` returned an error, the whole migration    /// process would fail.    pub fn rename_update_value(        old_name: impl ToConfigNamePath,        new_name: impl ToConfigNamePath,        new_value_fn: impl Fn(&ConfigValue) -> Result<ConfigValue, DynError> + 'static,    ) -> Self {        let inner = MigrationRule::RenameUpdateValue {            old_name: old_name.into_name_path().into(),            new_name: new_name.into_name_path().into(),            new_value_fn: Box::new(new_value_fn),        };        Self { inner }    }     // TODO: update value, etc.     /// Creates rule that updates config layer by `apply_fn`. `match_fn` should    /// return true if the layer contains items to be updated.    pub fn custom(        matches_fn: impl Fn(&ConfigLayer) -> bool + 'static,        apply_fn: impl Fn(&mut ConfigLayer) -> Result<String, ConfigMigrateLayerError> + 'static,    ) -> Self {        let inner = MigrationRule::Custom {            matches_fn: Box::new(matches_fn),            apply_fn: Box::new(apply_fn),        };        Self { inner }    }     /// Returns true if `layer` contains an item to be migrated.    fn matches(&self, layer: &ConfigLayer) -> bool {        match &self.inner {            MigrationRule::RenameValue { old_name, .. }            | MigrationRule::RenameUpdateValue { old_name, .. } => {                matches!(layer.look_up_item(old_name), Ok(Some(_)))            }            MigrationRule::Custom { matches_fn, .. } => matches_fn(layer),        }    }     /// Migrates `layer` item. Returns a description of the applied migration.    fn apply(&self, layer: &mut ConfigLayer) -> Result<String, ConfigMigrateLayerError> {        match &self.inner {            MigrationRule::RenameValue { old_name, new_name } => {                rename_value(layer, old_name, new_name)            }            MigrationRule::RenameUpdateValue {                old_name,                new_name,                new_value_fn,            } => rename_update_value(layer, old_name, new_name, new_value_fn),            MigrationRule::Custom { apply_fn, .. } => apply_fn(layer),        }    }} fn rename_value(    layer: &mut ConfigLayer,    old_name: &ConfigNamePathBuf,    new_name: &ConfigNamePathBuf,) -> Result<String, ConfigMigrateLayerError> {    let value = layer.delete_value(old_name)?.expect("tested by matches()");    if matches!(layer.look_up_item(new_name), Ok(Some(_))) {        return Ok(format!("{old_name} is deleted (superseded by {new_name})"));    }    layer.set_value(new_name, value)?;    Ok(format!("{old_name} is renamed to {new_name}"))} fn rename_update_value(    layer: &mut ConfigLayer,    old_name: &ConfigNamePathBuf,    new_name: &ConfigNamePathBuf,    new_value_fn: impl FnOnce(&ConfigValue) -> Result<ConfigValue, DynError>,) -> Result<String, ConfigMigrateLayerError> {    let old_value = layer.delete_value(old_name)?.expect("tested by matches()");    if matches!(layer.look_up_item(new_name), Ok(Some(_))) {        return Ok(format!("{old_name} is deleted (superseded by {new_name})"));    }    let new_value = new_value_fn(&old_value).map_err(|error| ConfigMigrateLayerError::Type {        name: old_name.to_string(),        error,    })?;    layer.set_value(new_name, new_value.clone())?;    Ok(format!("{old_name} is updated to {new_name} = {new_value}"))} /// Applies migration `rules` to `config`. Returns descriptions of the applied/// migrations.pub fn migrate(    config: &mut StackedConfig,    rules: &[ConfigMigrationRule],) -> Result<Vec<(ConfigSource, String)>, ConfigMigrateError> {    let mut descriptions = Vec::new();    for layer in config.layers_mut() {        migrate_layer(layer, rules, &mut descriptions)            .map_err(|err| err.with_source_path(layer.path.as_deref()))?;    }    Ok(descriptions)} fn migrate_layer(    layer: &mut Arc<ConfigLayer>,    rules: &[ConfigMigrationRule],    descriptions: &mut Vec<(ConfigSource, String)>,) -> Result<(), ConfigMigrateLayerError> {    let rules_to_apply = rules        .iter()        .filter(|rule| rule.matches(layer))        .collect_vec();    if rules_to_apply.is_empty() {        return Ok(());    }    let layer_mut = Arc::make_mut(layer);    for rule in rules_to_apply {        let desc = rule.apply(layer_mut)?;        descriptions.push((layer_mut.source, desc));    }    Ok(())} #[cfg(test)]mod tests {    use assert_matches::assert_matches;    use indoc::indoc;     use super::*;     #[test]    fn test_expand_home() {        let home_dir = Some(Path::new("/home/dir"));        assert_eq!(            expand_home("~".as_ref(), home_dir).unwrap(),            Some(PathBuf::from("/home/dir"))        );        assert_eq!(expand_home("~foo".as_ref(), home_dir).unwrap(), None);        assert_eq!(expand_home("/foo/~".as_ref(), home_dir).unwrap(), None);        assert_eq!(            expand_home("~/foo".as_ref(), home_dir).unwrap(),            Some(PathBuf::from("/home/dir/foo"))        );        assert!(expand_home("~/foo".as_ref(), None).is_err());    }     #[test]    fn test_condition_default() {        let condition = ScopeCondition::default();         let context = ConfigResolutionContext {            home_dir: None,            repo_path: None,            workspace_path: None,            command: None,            hostname: "",        };        assert!(condition.matches(&context));        let context = ConfigResolutionContext {            home_dir: None,            repo_path: Some(Path::new("/foo")),            workspace_path: None,            command: None,            hostname: "",        };        assert!(condition.matches(&context));    }     #[test]    fn test_condition_repo_path() {        let condition = ScopeCondition {            repositories: Some(["/foo", "/bar"].map(PathBuf::from).into()),            workspaces: None,            commands: None,            platforms: None,            hostnames: None,        };         let context = ConfigResolutionContext {            home_dir: None,            repo_path: None,            workspace_path: None,            command: None,            hostname: "",        };        assert!(!condition.matches(&context));        let context = ConfigResolutionContext {            home_dir: None,            repo_path: Some(Path::new("/foo")),            workspace_path: None,            command: None,            hostname: "",        };        assert!(condition.matches(&context));

Lines 1–500 of 1298. Load more