uv_resolver/lock/export/

metadata.rs

use std::collections::{BTreeMap, VecDeque};
use std::fmt::Display;
use std::path::Path;

use uv_distribution_filename::WheelFilename;
use uv_distribution_types::{Name, Requirement, RequiresPython, ResolvedDist, UrlString};
use uv_fs::PortablePathBuf;
use uv_normalize::{ExtraName, GroupName, PackageName};
use uv_pep440::Version;
use uv_pep508::MarkerTree;
use uv_pypi_types::{ConflictItem, ConflictKind, ConflictSet, Conflicts, ModuleName};
use uv_workspace::Workspace;

use crate::lock::{
    Dependency, DirectSource, Package, PackageId, RegistrySource, Source, SourceDist,
    SourceDistMetadata, Wheel, WheelWireSource, ZstdWheel,
};
use crate::{Lock, LockError};

#[derive(Debug, thiserror::Error)]
enum MetadataErrorKind {
    #[error(transparent)]
    Serialize(#[from] serde_json::error::Error),
    #[error(transparent)]
    Lock(#[from] LockError),
}

#[derive(Debug)]
pub struct MetadataError {
    kind: Box<MetadataErrorKind>,
}

impl std::error::Error for MetadataError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        self.kind.source()
    }
}

impl std::fmt::Display for MetadataError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.kind)?;
        Ok(())
    }
}

impl<E> From<E> for MetadataError
where
    MetadataErrorKind: From<E>,
{
    fn from(err: E) -> Self {
        Self {
            kind: Box::new(MetadataErrorKind::from(err)),
        }
    }
}

/// The full `uv workspace metadata` JSON object
#[derive(Debug, serde::Serialize)]
pub struct Metadata {
    /// Format information
    schema: SchemaReport,
    /// Absolute path to the workspace root
    ///
    /// Ideally absolute paths to things that are found in subdirs of this should have exactly
    /// this as a prefix so it can be stripped to get relative paths if one wants.
    workspace_root: PortablePathBuf,
    /// Information about the synchronized environment, when `--sync` was used.
    #[serde(skip_serializing_if = "Option::is_none", default)]
    environment: Option<MetadataEnvironment>,
    /// Information about the script root, when metadata was requested for a script.
    #[serde(skip_serializing_if = "Option::is_none", default)]
    script: Option<MetadataScript>,
    /// Information about the workspace root, when metadata was requested for a workspace.
    #[serde(skip_serializing_if = "Option::is_none", default)]
    workspace: Option<MetadataWorkspace>,
    /// The version of python required by the workspace
    ///
    /// Every `marker` we emit implicitly assumes this constraint to keep things clean
    requires_python: RequiresPython,
    /// Info about conflicting packages
    conflicts: MetadataConflicts,
    /// A mapping from importable module names to the package nodes that provide them
    #[serde(skip_serializing_if = "BTreeMap::is_empty", default)]
    module_owners: BTreeMap<ModuleName, Vec<MetadataModuleOwner>>,
    /// An index of which nodes are workspace members
    ///
    /// These entries are often what you should use as the entry-points into the `resolve` graph.
    #[serde(skip_serializing_if = "Vec::is_empty", default)]
    members: Vec<MetadataWorkspaceMember>,
    /// The dependency graph
    #[serde(skip_serializing_if = "BTreeMap::is_empty", default)]
    resolution: BTreeMap<MetadataNodeIdFlat, MetadataNode>,
}

/// The schema version for the metadata report.
#[derive(serde::Serialize, Debug, Default)]
#[serde(rename_all = "snake_case")]
enum SchemaVersion {
    /// An unstable, experimental schema.
    #[default]
    Preview,
}

/// The schema metadata for the metadata report.
#[derive(serde::Serialize, Debug, Default)]
struct SchemaReport {
    /// The version of the schema.
    version: SchemaVersion,
}

/// Information about the environment synchronized for the workspace.
#[derive(Debug, serde::Serialize)]
struct MetadataEnvironment {
    /// Absolute path to the environment root.
    root: PortablePathBuf,
}

/// The script entry-point.
#[derive(Debug, serde::Serialize)]
struct MetadataScript {
    /// Absolute path to the script.
    path: PortablePathBuf,
    /// Key for the script's node in the `resolution` graph.
    id: MetadataNodeIdFlat,
}

/// The workspace entry-point.
#[derive(Debug, serde::Serialize)]
struct MetadataWorkspace {
    /// Absolute path to the workspace root.
    path: PortablePathBuf,
    /// Key for the workspace's node in the `resolution` graph.
    id: MetadataNodeIdFlat,
}

/// Info for looking up workspace members, most information is stored in the node behind `id`
#[derive(Debug, serde::Serialize)]
struct MetadataWorkspaceMember {
    /// Package name
    name: PackageName,
    /// Absolute path to the member
    path: PortablePathBuf,
    /// Key for the package's node in the `resolve` graph
    id: MetadataNodeIdFlat,
}

/// An installed distribution that provides an importable module.
#[derive(Debug, serde::Serialize)]
struct MetadataModuleOwner {
    /// Key for the package node in the `resolution` graph.
    package_id: MetadataNodeIdFlat,
}

/// A node in the dependency graph.
///
/// There are 5 kinds of nodes:
///
/// * scripts:  `script+/workspace/script.py`
/// * packages: `mypackage==1.0.0@registry+https://pypi.org/simple`
/// * extras:   `mypackage[myextra]==1.0.0@registry+https://pypi.org/simple`
/// * groups:   `mypackage:mygroup==1.0.0@registry+https://pypi.org/simple`
/// * build:    `mypackage(build)==1.0.0@registry+https://pypi.org/simple`
///
/// -----------
///
/// A package like this:
///
/// ```toml
/// [project]
/// name = "mypackage"
/// version = 1.0.0
///
/// dependencies = ["httpx"]
///
/// [project.optional-dependencies]
/// cli = ["rich"]
///
/// [dependency-groups]
/// dev = ["typing-extensions"]
///
/// [build-system]
/// requires = ["hatchling"]
/// ```
///
/// will get 4 nodes with the following edges (Version and Source omitted here for brevity):
///
/// * `mypackage`
///   * `httpx`
/// * `mypackage(build)`
///   * `hatchling`
/// * `mypackage[cli]`
///   * `mypackage`
///   * `rich`
/// * `mypackage:dev`
///   * `typing-extensions`
///
/// Note that `mypackage[cli]` has a dependency edge on `mypackage` while `mypackage:dev` does not.
/// This is because `mypackage[cli]` is fundamentally an augmentation of `mypackage` while `mypackage:dev`
/// is just a list of packages that happens to be defined by `mypackage`'s pyproject.toml.
#[derive(Debug, Clone, serde::Serialize)]
struct MetadataNode {
    /// A unique id for this node that will be used to refer to it
    #[serde(flatten)]
    id: MetadataNodeId,
    /// Dependencies of this node (the edges of The Graph)
    dependencies: Vec<MetadataDependency>,
    /// Extras
    #[serde(skip_serializing_if = "Vec::is_empty", default)]
    optional_dependencies: Vec<MetadataExtra>,
    /// Groups
    #[serde(skip_serializing_if = "Vec::is_empty", default)]
    dependency_groups: Vec<MetadataGroup>,
    /// Info about building the package
    #[serde(skip_serializing_if = "Option::is_none", default)]
    build_system: Option<MetadataBuildSystem>,
    /// The source distribution found
    #[serde(skip_serializing_if = "Option::is_none", default)]
    sdist: Option<MetadataSourceDist>,
    /// Wheels we found
    #[serde(skip_serializing_if = "Vec::is_empty", default)]
    wheels: Vec<MetadataWheel>,
}

impl MetadataNode {
    fn new(id: MetadataNodeId) -> Self {
        Self {
            id,
            dependencies: Vec::new(),
            dependency_groups: Vec::new(),
            optional_dependencies: Vec::new(),
            wheels: Vec::new(),
            build_system: None,
            sdist: None,
        }
    }

    fn from_package_id(
        workspace_root: &PortablePathBuf,
        id: &PackageId,
        kind: MetadataNodeKind,
    ) -> Self {
        Self::new(MetadataNodeId::from_package_id(workspace_root, id, kind))
    }

    fn from_script(path: PortablePathBuf, dependencies: Vec<MetadataDependency>) -> Self {
        let mut node = Self::new(MetadataNodeId::Script(MetadataScriptNodeId {
            kind: MetadataScriptNodeKind::Script,
            path,
        }));
        node.dependencies = dependencies;
        node
    }

    fn from_workspace(path: PortablePathBuf, dependency_groups: Vec<MetadataGroup>) -> Self {
        let mut node = Self::new(MetadataNodeId::Workspace(MetadataWorkspaceNodeId {
            kind: MetadataWorkspaceNodeKind::Workspace,
            path,
        }));
        node.dependency_groups = dependency_groups;
        node
    }

    fn from_workspace_group(
        path: PortablePathBuf,
        group: GroupName,
        dependencies: Vec<MetadataDependency>,
    ) -> Self {
        let mut node = Self::new(MetadataNodeId::WorkspaceGroup(
            MetadataWorkspaceGroupNodeId {
                kind: MetadataWorkspaceGroupNodeKind::Group(group),
                path,
            },
        ));
        node.dependencies = dependencies;
        node
    }

    fn add_dependency(
        &mut self,
        workspace_root: &PortablePathBuf,
        dependency: &Dependency,
        parent_reachability: MarkerTree,
    ) {
        let mut marker = dependency.simplified_marker.as_simplified_marker_tree();
        marker.and(parent_reachability);
        let marker = marker.try_to_string();
        let extras = dependency.extra();
        if extras.is_empty() {
            let id = MetadataNodeId::from_package_id(
                workspace_root,
                &dependency.package_id,
                MetadataNodeKind::Package,
            );
            self.dependencies.push(MetadataDependency {
                id: id.to_flat(),
                marker,
            });
            return;
        }
        for extra in extras {
            let id = MetadataNodeId::from_package_id(
                workspace_root,
                &dependency.package_id,
                MetadataNodeKind::Extra(extra.clone()),
            );
            self.dependencies.push(MetadataDependency {
                id: id.to_flat(),
                marker: marker.clone(),
            });
        }
    }
}

#[derive(Debug, Clone, serde::Serialize)]
#[serde(rename_all = "snake_case")]
enum MetadataWorkspaceNodeKind {
    Workspace,
}

#[derive(Debug, Clone, serde::Serialize)]
#[serde(rename_all = "snake_case")]
enum MetadataWorkspaceGroupNodeKind {
    Group(GroupName),
}
#[derive(Debug, Clone, serde::Serialize)]
#[serde(rename_all = "snake_case")]
enum MetadataScriptNodeKind {
    Script,
}

fn root_dependencies<'lock>(
    workspace_root: &PortablePathBuf,
    lock: &'lock Lock,
    requirements: impl IntoIterator<Item = &'lock Requirement>,
) -> Vec<MetadataDependency> {
    let mut dependencies = Vec::new();

    // Root requirements retain names, extras, and markers rather than resolved package IDs. Match
    // them to the locked packages using the same name and fork-marker logic as lock export.
    for requirement in requirements {
        for package in lock
            .packages()
            .iter()
            .filter(|package| package.name() == &requirement.name)
        {
            let Some(marker) = lock.root_requirement_marker(requirement, package) else {
                continue;
            };

            let marker = marker.try_to_string();
            let mut has_extra_node = false;
            for extra in requirement
                .extras
                .iter()
                .filter(|extra| package.optional_dependencies.contains_key(*extra))
            {
                let id = MetadataNodeId::from_package_id(
                    workspace_root,
                    &package.id,
                    MetadataNodeKind::Extra(extra.clone()),
                );
                dependencies.push(MetadataDependency {
                    id: id.to_flat(),
                    marker: marker.clone(),
                });
                has_extra_node = true;
            }

            if !has_extra_node {
                let id = MetadataNodeId::from_package_id(
                    workspace_root,
                    &package.id,
                    MetadataNodeKind::Package,
                );
                dependencies.push(MetadataDependency {
                    id: id.to_flat(),
                    marker,
                });
            }
        }
    }

    dependencies
}

/// Determine the standalone reachability marker for every package-derived metadata node.
///
/// Dependency markers in the lock are simplified under the conditions required to reach their
/// parent. Metadata consumers evaluate each edge marker independently, so restore those conditions
/// by propagating markers from the metadata graph's entry points.
fn metadata_reachability(
    workspace_root: &PortablePathBuf,
    workspace: Option<&Workspace>,
    lock: &Lock,
) -> BTreeMap<MetadataNodeIdFlat, MarkerTree> {
    let mut reachability = BTreeMap::new();
    let mut queue = VecDeque::new();
    let always = MarkerTree::TRUE;

    if let Some(workspace) = workspace {
        for package in lock
            .packages()
            .iter()
            .filter(|package| workspace.packages().contains_key(package.name()))
        {
            add_metadata_reachability(
                workspace_root,
                &mut reachability,
                &mut queue,
                package,
                MetadataNodeKind::Package,
                always,
            );
            for extra in package.optional_dependencies.keys() {
                add_metadata_reachability(
                    workspace_root,
                    &mut reachability,
                    &mut queue,
                    package,
                    MetadataNodeKind::Extra(extra.clone()),
                    always,
                );
            }
            for group in package.dependency_groups.keys() {
                add_metadata_reachability(
                    workspace_root,
                    &mut reachability,
                    &mut queue,
                    package,
                    MetadataNodeKind::Group(group.clone()),
                    always,
                );
            }
        }
    }

    for requirement in lock
        .requirements()
        .iter()
        .chain(lock.dependency_groups().values().flatten())
    {
        for package in lock
            .packages()
            .iter()
            .filter(|package| package.name() == &requirement.name)
        {
            let Some(marker) = lock.root_requirement_marker(requirement, package) else {
                continue;
            };
            let mut has_extra_node = false;
            for extra in requirement
                .extras
                .iter()
                .filter(|extra| package.optional_dependencies.contains_key(*extra))
            {
                add_metadata_reachability(
                    workspace_root,
                    &mut reachability,
                    &mut queue,
                    package,
                    MetadataNodeKind::Extra(extra.clone()),
                    marker,
                );
                has_extra_node = true;
            }
            if !has_extra_node {
                add_metadata_reachability(
                    workspace_root,
                    &mut reachability,
                    &mut queue,
                    package,
                    MetadataNodeKind::Package,
                    marker,
                );
            }
        }
    }

    while let Some((package, kind)) = queue.pop_front() {
        let id =
            MetadataNodeId::from_package_id(workspace_root, &package.id, kind.clone()).to_flat();
        let Some(parent_reachability) = reachability.get(&id).copied() else {
            continue;
        };

        if matches!(kind, MetadataNodeKind::Extra(_)) {
            add_metadata_reachability(
                workspace_root,
                &mut reachability,
                &mut queue,
                package,
                MetadataNodeKind::Package,
                parent_reachability,
            );
        }

        let dependencies: &[Dependency] = match &kind {
            MetadataNodeKind::Package => package.dependencies.as_slice(),
            MetadataNodeKind::Extra(extra) => package
                .optional_dependencies
                .get(extra)
                .map_or(&[], Vec::as_slice),
            MetadataNodeKind::Group(group) => package
                .dependency_groups
                .get(group)
                .map_or(&[], Vec::as_slice),
            MetadataNodeKind::Build => &[],
        };
        for dependency in dependencies {
            let mut dependency_reachability =
                dependency.simplified_marker.as_simplified_marker_tree();
            dependency_reachability.and(parent_reachability);
            let dependency_package = lock.find_by_id(&dependency.package_id);
            if dependency.extra.is_empty() {
                add_metadata_reachability(
                    workspace_root,
                    &mut reachability,
                    &mut queue,
                    dependency_package,
                    MetadataNodeKind::Package,
                    dependency_reachability,
                );
            } else {
                for extra in &dependency.extra {
                    add_metadata_reachability(
                        workspace_root,
                        &mut reachability,
                        &mut queue,
                        dependency_package,
                        MetadataNodeKind::Extra(extra.clone()),
                        dependency_reachability,
                    );
                }
            }
        }
    }

    reachability
}

fn add_metadata_reachability<'lock>(
    workspace_root: &PortablePathBuf,
    reachability: &mut BTreeMap<MetadataNodeIdFlat, MarkerTree>,
    queue: &mut VecDeque<(&'lock Package, MetadataNodeKind)>,
    package: &'lock Package,
    kind: MetadataNodeKind,
    marker: MarkerTree,
) {
    let id = MetadataNodeId::from_package_id(workspace_root, &package.id, kind.clone()).to_flat();
    let changed = if let Some(existing) = reachability.get_mut(&id) {
        let previous = *existing;
        existing.or(marker);
        *existing != previous
    } else {
        reachability.insert(id, marker);
        true
    };
    if changed {
        queue.push_back((package, kind));
    }
}

/// The unique key for every node in the graph.
#[derive(Debug, Clone, serde::Serialize)]
#[serde(untagged)]
enum MetadataNodeId {
    Package(MetadataPackageNodeId),
    Script(MetadataScriptNodeId),
    Workspace(MetadataWorkspaceNodeId),
    WorkspaceGroup(MetadataWorkspaceGroupNodeId),
}

/// The unique key for a package-derived node.
///
/// (It's not entirely clear to me that two nodes can differ only by `source` but it doesn't hurt.)
#[derive(Debug, Clone, serde::Serialize)]
struct MetadataPackageNodeId {
    /// The name of the package
    name: PackageName,
    /// The version of the package, if any could be found (source trees may have no version)
    #[serde(skip_serializing_if = "Option::is_none", default)]
    version: Option<Version>,
    /// The source of the package (directory, registry, URL...)
    source: MetadataSource,
    /// What kind of node is this?
    kind: MetadataNodeKind,
}

/// The unique key for a script node.
#[derive(Debug, Clone, serde::Serialize)]
struct MetadataScriptNodeId {
    kind: MetadataScriptNodeKind,
    /// Absolute path to the script.
    path: PortablePathBuf,
}

/// The unique key for a workspace node.
#[derive(Debug, Clone, serde::Serialize)]
struct MetadataWorkspaceNodeId {
    kind: MetadataWorkspaceNodeKind,
    /// Absolute path to the workspace root.
    path: PortablePathBuf,
}

/// The unique key for a dependency group defined on the workspace root.
#[derive(Debug, Clone, serde::Serialize)]
struct MetadataWorkspaceGroupNodeId {
    kind: MetadataWorkspaceGroupNodeKind,
    /// Absolute path to the workspace root.
    path: PortablePathBuf,
}

/// This is intended to be an opaque unique id for referring to a node
///
/// It's human readable for convenience but parsing it or relying on it is inadvisable.
type MetadataNodeIdFlat = String;

impl MetadataNodeId {
    fn from_package_id(
        workspace_root: &PortablePathBuf,
        id: &PackageId,
        kind: MetadataNodeKind,
    ) -> Self {
        let name = id.name.clone();
        let version = id.version.clone();
        let source = MetadataSource::from_source(workspace_root, id.source.clone());

        Self::Package(MetadataPackageNodeId {
            name,
            version,
            source,
            kind,
        })
    }

    fn as_package(&self) -> Option<&MetadataPackageNodeId> {
        match self {
            Self::Package(package) => Some(package),
            Self::Script(_) | Self::Workspace(_) | Self::WorkspaceGroup(_) => None,
        }
    }

    fn to_flat(&self) -> MetadataNodeIdFlat {
        self.to_string()
    }
}

impl Display for MetadataNodeId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Package(package) => match &package.version {
                Some(version) => write!(
                    f,
                    "{}{}=={version}@{}",
                    package.name, package.kind, package.source
                ),
                None => write!(f, "{}{}@{}", package.name, package.kind, package.source),
            },
            Self::Script(script) => write!(f, "script+{}", script.path),
            Self::Workspace(workspace) => write!(f, "workspace+{}", workspace.path),
            Self::WorkspaceGroup(group) => {
                let MetadataWorkspaceGroupNodeKind::Group(name) = &group.kind;
                write!(f, "workspace+{}:{name}", group.path)
            }
        }
    }
}

#[derive(Debug, Clone, serde::Serialize)]
struct MetadataDependency {
    id: MetadataNodeIdFlat,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    marker: Option<MetadataMarker>,
}

type MetadataMarker = String;

/// The kind a node can have in the dependency graph
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, serde::Serialize)]
#[serde(rename_all = "snake_case")]
enum MetadataNodeKind {
    /// The node is the package itself
    /// its edges are `project.dependencies`
    Package,
    /// The node is for building the package's sdist into a wheel
    /// its edges are `build-system.requires`
    #[expect(dead_code)]
    Build,
    /// The node is for an extra defined on the package
    /// its edges are `project.optional-dependencies.myextra`
    Extra(ExtraName),
    /// The node is for a dependency-group defined on the package
    /// its edges are `dependency-groups.mygroup`
    Group(GroupName),
}

impl Display for MetadataNodeKind {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            // Don't apply any special decoration, this is the default
            Self::Package => Ok(()),
            Self::Build => f.write_str("(build)"),
            Self::Extra(extra_name) => write!(f, "[{extra_name}]"),
            Self::Group(group_name) => write!(f, ":{group_name}"),
        }
    }
}

#[derive(Clone, Debug, serde::Serialize)]
#[serde(untagged, rename_all = "snake_case")]
enum MetadataSource {
    Registry {
        registry: MetadataRegistrySource,
    },
    Git {
        git: UrlString,
    },
    Direct {
        url: UrlString,
        subdirectory: Option<PortablePathBuf>,
    },
    Path {
        path: PortablePathBuf,
    },
    Directory {
        directory: PortablePathBuf,
    },
    Editable {
        editable: PortablePathBuf,
    },
    Virtual {
        r#virtual: PortablePathBuf,
    },
}

impl Display for MetadataSource {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            Self::Registry {
                registry: MetadataRegistrySource::Url(url),
            }
            | Self::Git { git: url }
            | Self::Direct { url, .. } => {
                write!(f, "{}+{}", self.name(), url)
            }
            Self::Registry {
                registry: MetadataRegistrySource::Path(path),
            }
            | Self::Path { path }
            | Self::Directory { directory: path }
            | Self::Editable { editable: path }
            | Self::Virtual { r#virtual: path } => {
                write!(f, "{}+{}", self.name(), path)
            }
        }
    }
}

impl MetadataSource {
    fn name(&self) -> &str {
        match self {
            Self::Registry { .. } => "registry",
            Self::Git { .. } => "git",
            Self::Direct { .. } => "direct",
            Self::Path { .. } => "path",
            Self::Directory { .. } => "directory",
            Self::Editable { .. } => "editable",
            Self::Virtual { .. } => "virtual",
        }
    }
}

impl MetadataSource {
    fn from_source(workspace_root: &PortablePathBuf, source: Source) -> Self {
        match source {
            Source::Registry(source) => match source {
                RegistrySource::Url(url) => Self::Registry {
                    registry: MetadataRegistrySource::Url(url),
                },
                RegistrySource::Path(path) => Self::Registry {
                    registry: MetadataRegistrySource::Path(normalize_workspace_relative_path(
                        workspace_root,
                        &path,
                    )),
                },
            },
            Source::Git(url, _) => Self::Git { git: url },
            Source::Direct(url, DirectSource { subdirectory }) => Self::Direct {
                url,
                subdirectory: subdirectory
                    .map(|path| normalize_workspace_relative_path(workspace_root, &path)),
            },
            Source::Path(path) => Self::Path {
                path: normalize_workspace_relative_path(workspace_root, &path),
            },
            Source::Directory(path) => Self::Directory {
                directory: normalize_workspace_relative_path(workspace_root, &path),
            },
            Source::Editable(path) => Self::Editable {
                editable: normalize_workspace_relative_path(workspace_root, &path),
            },
            Source::Virtual(path) => Self::Virtual {
                r#virtual: normalize_workspace_relative_path(workspace_root, &path),
            },
        }
    }
}

fn normalize_workspace_relative_path(
    workspace_root: &PortablePathBuf,
    maybe_rel: &std::path::Path,
) -> PortablePathBuf {
    if maybe_rel.is_absolute() {
        PortablePathBuf::from(maybe_rel)
    } else {
        PortablePathBuf::from(workspace_root.as_ref().join(maybe_rel).as_path())
    }
}

#[derive(Clone, Debug, serde::Serialize)]
#[serde(rename_all = "snake_case")]
enum MetadataRegistrySource {
    /// Ex) `https://pypi.org/simple`
    Url(UrlString),
    /// Ex) `/path/to/local/index`
    Path(PortablePathBuf),
}

#[derive(Clone, Debug, serde::Serialize)]
#[serde(untagged, rename_all = "snake_case")]
enum MetadataSourceDist {
    Url {
        url: UrlString,
        #[serde(flatten)]
        metadata: MetadataSourceDistMetadata,
    },
    Path {
        path: PortablePathBuf,
        #[serde(flatten)]
        metadata: MetadataSourceDistMetadata,
    },
    Metadata {
        #[serde(flatten)]
        metadata: MetadataSourceDistMetadata,
    },
}

impl MetadataSourceDist {
    fn from_sdist(workspace_root: &PortablePathBuf, sdist: &SourceDist) -> Self {
        match sdist {
            SourceDist::Url { url, metadata } => Self::Url {
                url: url.clone(),
                metadata: MetadataSourceDistMetadata::from_sdist(metadata),
            },
            SourceDist::Path { path, metadata } => Self::Path {
                path: normalize_workspace_relative_path(workspace_root, path),
                metadata: MetadataSourceDistMetadata::from_sdist(metadata),
            },
            SourceDist::Metadata { metadata } => Self::Metadata {
                metadata: MetadataSourceDistMetadata::from_sdist(metadata),
            },
        }
    }
}

#[derive(Clone, Debug, serde::Serialize)]
#[serde(rename_all = "snake_case")]
struct MetadataSourceDistMetadata {
    /// A hash of the source distribution.
    #[serde(skip_serializing_if = "BTreeMap::is_empty", default)]
    hashes: BTreeMap<HashAlgorithm, Hash>,
    /// The size of the source distribution in bytes.
    ///
    /// This is only present for source distributions that come from registries.
    #[serde(skip_serializing_if = "Option::is_none", default)]
    size: Option<u64>,
    /// The upload time of the source distribution.
    #[serde(skip_serializing_if = "Option::is_none", default)]
    upload_time: Option<jiff::Timestamp>,
}

/// The name of a hash algorithm ("sha256", "blake2b", "md5", etc)
type HashAlgorithm = String;
/// A hex encoded digest of the file
type Hash = String;

/// Oh you wanted a hash map? No this is the hashes map, a sorted map of hashes!
///
/// We prefer matching PEP 691 (JSON-based Simple API for Python) here for future-proofing
/// and convenience of consumption.
fn hashes_map(hash: &crate::lock::Hash) -> BTreeMap<HashAlgorithm, Hash> {
    Some((hash.0.algorithm.to_string(), hash.0.digest.to_string()))
        .into_iter()
        .collect()
}

impl MetadataSourceDistMetadata {
    fn from_sdist(sdist: &SourceDistMetadata) -> Self {
        Self {
            hashes: sdist.hash.as_ref().map(hashes_map).unwrap_or_default(),
            size: sdist.size,
            upload_time: sdist.upload_time,
        }
    }
}
#[derive(Clone, Debug, serde::Serialize)]
struct MetadataWheel {
    /// A URL or file path (via `file://`) where the wheel that was locked
    /// against was found. The location does not need to exist in the future,
    /// so this should be treated as only a hint to where to look and/or
    /// recording where the wheel file originally came from.
    #[serde(flatten)]
    source: Option<MetadataWheelWireSource>,
    /// A hash of the built distribution.
    ///
    /// This is only present for wheels that come from registries and direct
    /// URLs. Wheels from git or path dependencies do not have hashes
    /// associated with them.
    #[serde(skip_serializing_if = "BTreeMap::is_empty", default)]
    hashes: BTreeMap<HashAlgorithm, Hash>,
    /// The size of the built distribution in bytes.
    ///
    /// This is only present for wheels that come from registries.
    #[serde(skip_serializing_if = "Option::is_none", default)]
    size: Option<u64>,
    /// The upload time of the built distribution.
    ///
    /// This is only present for wheels that come from registries.
    #[serde(skip_serializing_if = "Option::is_none", default)]
    upload_time: Option<jiff::Timestamp>,
    /// The filename of the wheel.
    ///
    /// This isn't part of the wire format since it's redundant with the
    /// URL. But we do use it for various things, and thus compute it at
    /// deserialization time. Not being able to extract a wheel filename from a
    /// wheel URL is thus a deserialization error.
    filename: WheelFilename,
    /// The zstandard-compressed wheel metadata, if any.
    #[serde(skip_serializing_if = "Option::is_none", default)]
    zstd: Option<MetadataZstdWheel>,
}

impl MetadataWheel {
    fn from_wheel(workspace_root: &PortablePathBuf, wheel: &Wheel) -> Self {
        Self {
            source: MetadataWheelWireSource::from_wheel(workspace_root, &wheel.url),
            hashes: wheel.hash.as_ref().map(hashes_map).unwrap_or_default(),
            size: wheel.size,
            upload_time: wheel.upload_time,
            filename: wheel.filename.clone(),
            zstd: wheel.zstd.as_ref().map(MetadataZstdWheel::from_wheel),
        }
    }
}

#[derive(Clone, Debug, serde::Serialize)]
#[serde(untagged, rename_all = "snake_case")]
enum MetadataWheelWireSource {
    Url { url: UrlString },
    Path { path: PortablePathBuf },
}

impl MetadataWheelWireSource {
    fn from_wheel(workspace_root: &PortablePathBuf, wheel: &WheelWireSource) -> Option<Self> {
        match wheel {
            WheelWireSource::Url { url } => Some(Self::Url { url: url.clone() }),
            WheelWireSource::Path { path } => Some(Self::Path {
                path: normalize_workspace_relative_path(workspace_root, path),
            }),
            // We guarantee this as a separate field so it's redundant
            WheelWireSource::Filename { .. } => None,
        }
    }
}

#[derive(Clone, Debug, serde::Serialize)]
struct MetadataZstdWheel {
    #[serde(skip_serializing_if = "BTreeMap::is_empty", default)]
    hashes: BTreeMap<HashAlgorithm, Hash>,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    size: Option<u64>,
}

impl MetadataZstdWheel {
    fn from_wheel(wheel: &ZstdWheel) -> Self {
        Self {
            hashes: wheel.hash.as_ref().map(hashes_map).unwrap_or_default(),
            size: wheel.size,
        }
    }
}

#[derive(Clone, Debug, serde::Serialize)]
struct MetadataExtra {
    name: ExtraName,
    id: MetadataNodeIdFlat,
}

#[derive(Clone, Debug, serde::Serialize)]
struct MetadataGroup {
    name: GroupName,
    id: MetadataNodeIdFlat,
}

#[derive(Clone, Debug, serde::Serialize)]
struct MetadataBuildSystem {
    /// The `build-backend` specified in the pyproject.toml
    build_backend: String,
    id: MetadataNodeIdFlat,
}

/// Conflicts
#[derive(Clone, Debug, serde::Serialize)]
struct MetadataConflicts {
    sets: Vec<MetadataConflictSet>,
}

impl MetadataConflicts {
    fn from_conflicts(
        members: &[MetadataWorkspaceMember],
        resolve: &BTreeMap<MetadataNodeIdFlat, MetadataNode>,
        conflicts: &Conflicts,
    ) -> Self {
        Self {
            sets: conflicts
                .iter()
                .map(|set| MetadataConflictSet::from_conflicts(members, resolve, set))
                .collect(),
        }
    }
}

#[derive(Clone, Debug, serde::Serialize)]
struct MetadataConflictSet {
    items: Vec<MetadataConflictItem>,
}

impl MetadataConflictSet {
    fn from_conflicts(
        members: &[MetadataWorkspaceMember],
        resolve: &BTreeMap<MetadataNodeIdFlat, MetadataNode>,
        set: &ConflictSet,
    ) -> Self {
        Self {
            items: set
                .iter()
                .map(|item| MetadataConflictItem::from_conflicts(members, resolve, item))
                .collect(),
        }
    }
}

#[derive(Clone, Debug, serde::Serialize)]
struct MetadataConflictItem {
    /// These should always be names of packages referred to in [`Metadata::members`]
    package: PackageName,
    kind: MetadataConflictKind,
    /// This should never be None (should be a validation error way earlier in uv)
    /// ...but I'd rather not error if wrong.
    id: Option<MetadataNodeIdFlat>,
}

impl MetadataConflictItem {
    fn from_conflicts(
        members: &[MetadataWorkspaceMember],
        resolve: &BTreeMap<MetadataNodeIdFlat, MetadataNode>,
        item: &ConflictItem,
    ) -> Self {
        let kind = MetadataConflictKind::from_conflicts(item.kind());
        let id = members
            .iter()
            .find(|member| &member.name == item.package())
            .and_then(|member| {
                let package_id = resolve.get(&member.id)?.id.as_package()?;
                let id = MetadataNodeId::Package(MetadataPackageNodeId {
                    kind: kind.to_node_kind(),
                    ..package_id.clone()
                });
                Some(id.to_flat())
            });
        Self {
            package: item.package().clone(),
            kind,
            id,
        }
    }
}

#[derive(Clone, Debug, serde::Serialize)]
enum MetadataConflictKind {
    Group(GroupName),
    Extra(ExtraName),
    Project,
}

impl MetadataConflictKind {
    fn from_conflicts(item: &ConflictKind) -> Self {
        match item {
            ConflictKind::Extra(name) => Self::Extra(name.clone()),
            ConflictKind::Group(name) => Self::Group(name.clone()),
            ConflictKind::Project => Self::Project,
        }
    }

    fn to_node_kind(&self) -> MetadataNodeKind {
        match self {
            Self::Group(name) => MetadataNodeKind::Group(name.clone()),
            Self::Extra(name) => MetadataNodeKind::Extra(name.clone()),
            Self::Project => MetadataNodeKind::Package,
        }
    }
}

impl Metadata {
    /// Construct [`Metadata`] for a workspace from a uv lockfile.
    pub fn from_lock(workspace: &Workspace, lock: &Lock) -> Result<Self, MetadataError> {
        Ok(Self::from_lock_target(
            workspace.install_path(),
            Some(workspace),
            None,
            lock,
        ))
    }

    /// Construct [`Metadata`] for a script from a uv lockfile.
    pub fn from_script(script_path: &Path, lock: &Lock) -> Result<Self, MetadataError> {
        let workspace_root = script_path.parent().unwrap_or_else(|| Path::new(""));
        Ok(Self::from_lock_target(
            workspace_root,
            None,
            Some(script_path),
            lock,
        ))
    }

    fn from_lock_target(
        workspace_root: &Path,
        workspace: Option<&Workspace>,
        script_path: Option<&Path>,
        lock: &Lock,
    ) -> Self {
        let mut resolve = BTreeMap::new();
        let mut members = Vec::new();
        let workspace_root = PortablePathBuf::from(workspace_root);
        let reachability = metadata_reachability(&workspace_root, workspace, lock);

        for lock_package in lock.packages() {
            let mut meta_package = MetadataNode::from_package_id(
                &workspace_root,
                &lock_package.id,
                MetadataNodeKind::Package,
            );
            let package_reachability = reachability
                .get(&meta_package.id.to_flat())
                .copied()
                .unwrap_or(MarkerTree::FALSE);

            // Direct dependencies go on the package node
            for dependency in &lock_package.dependencies {
                meta_package.add_dependency(&workspace_root, dependency, package_reachability);
            }

            // Extras get their own nodes
            for (extra, dependencies) in &lock_package.optional_dependencies {
                let mut meta_extra = MetadataNode::from_package_id(
                    &workspace_root,
                    &lock_package.id,
                    MetadataNodeKind::Extra(extra.clone()),
                );
                let extra_reachability = reachability
                    .get(&meta_extra.id.to_flat())
                    .copied()
                    .unwrap_or(MarkerTree::FALSE);
                // Extras always depend on the base package
                meta_extra.dependencies.push(MetadataDependency {
                    id: meta_package.id.to_flat(),
                    marker: None,
                });
                for dependency in dependencies {
                    meta_extra.add_dependency(&workspace_root, dependency, extra_reachability);
                }

                meta_package.optional_dependencies.push(MetadataExtra {
                    name: extra.clone(),
                    id: meta_extra.id.to_flat(),
                });

                resolve.insert(meta_extra.id.to_flat(), meta_extra);
            }

            // Groups get their own nodes
            for (group, dependencies) in &lock_package.dependency_groups {
                let mut meta_group = MetadataNode::from_package_id(
                    &workspace_root,
                    &lock_package.id,
                    MetadataNodeKind::Group(group.clone()),
                );
                let group_reachability = reachability
                    .get(&meta_group.id.to_flat())
                    .copied()
                    .unwrap_or(MarkerTree::FALSE);
                // Groups *do not* depend on the base package, so don't add that
                for dependency in dependencies {
                    meta_group.add_dependency(&workspace_root, dependency, group_reachability);
                }

                meta_package.dependency_groups.push(MetadataGroup {
                    name: group.clone(),
                    id: meta_group.id.to_flat(),
                });

                resolve.insert(meta_group.id.to_flat(), meta_group);
            }

            // Register this package if it appears to be a workspace member
            if let Some(workspace_package) =
                workspace.and_then(|workspace| workspace.packages().get(lock_package.name()))
            {
                let member = MetadataWorkspaceMember {
                    name: lock_package.name().clone(),
                    path: normalize_workspace_relative_path(
                        &workspace_root,
                        workspace_package.root().as_path(),
                    ),
                    id: meta_package.id.to_flat(),
                };
                members.push(member);
            }

            // Record sdist/wheel information
            if let Some(sdist) = &lock_package.sdist {
                meta_package.sdist = Some(MetadataSourceDist::from_sdist(&workspace_root, sdist));
            }

            for wheel in &lock_package.wheels {
                meta_package
                    .wheels
                    .push(MetadataWheel::from_wheel(&workspace_root, wheel));
            }

            resolve.insert(meta_package.id.to_flat(), meta_package);
        }

        let script = script_path.map(|path| {
            let path = PortablePathBuf::from(path);
            let node = MetadataNode::from_script(
                path.clone(),
                root_dependencies(&workspace_root, lock, lock.requirements()),
            );
            let id = node.id.to_flat();
            resolve.insert(id.clone(), node);
            MetadataScript { path, id }
        });

        let workspace_metadata = workspace.map(|_| {
            let mut dependency_groups = Vec::new();
            for (group, requirements) in lock.dependency_groups() {
                let node = MetadataNode::from_workspace_group(
                    workspace_root.clone(),
                    group.clone(),
                    root_dependencies(&workspace_root, lock, requirements),
                );
                let id = node.id.to_flat();
                resolve.insert(id.clone(), node);
                dependency_groups.push(MetadataGroup {
                    name: group.clone(),
                    id,
                });
            }

            let node = MetadataNode::from_workspace(workspace_root.clone(), dependency_groups);
            let id = node.id.to_flat();
            resolve.insert(id.clone(), node);
            MetadataWorkspace {
                path: workspace_root.clone(),
                id,
            }
        });
        let conflicts = MetadataConflicts::from_conflicts(&members, &resolve, &lock.conflicts);

        Self {
            schema: SchemaReport {
                version: SchemaVersion::Preview,
            },
            conflicts,
            environment: None,
            script,
            workspace: workspace_metadata,
            module_owners: BTreeMap::new(),
            workspace_root,
            requires_python: lock.requires_python.clone(),
            members,
            resolution: resolve,
        }
    }

    pub fn package_node_id(
        workspace_root: &PortablePathBuf,
        dist: &ResolvedDist,
    ) -> Result<String, MetadataError> {
        let source = Source::from_resolved_dist(dist, workspace_root.as_ref())?;
        Ok(MetadataNodeId::Package(MetadataPackageNodeId {
            name: dist.name().clone(),
            version: dist.version().cloned(),
            source: MetadataSource::from_source(workspace_root, source),
            kind: MetadataNodeKind::Package,
        })
        .to_flat())
    }

    #[must_use]
    pub fn with_environment_root(mut self, environment_root: &Path) -> Self {
        self.environment = Some(MetadataEnvironment {
            root: PortablePathBuf::from(environment_root),
        });
        self
    }

    #[must_use]
    pub fn with_module_owners(mut self, module_owners: BTreeMap<ModuleName, Vec<String>>) -> Self {
        self.module_owners = module_owners
            .into_iter()
            .filter_map(|(module, owners)| {
                let owners = owners
                    .into_iter()
                    .filter(|package_id| self.resolution.contains_key(package_id))
                    .map(|package_id| MetadataModuleOwner { package_id })
                    .collect::<Vec<_>>();
                (!owners.is_empty()).then_some((module, owners))
            })
            .collect();
        self
    }

    pub fn to_json(&self) -> Result<String, MetadataError> {
        Ok(serde_json::to_string_pretty(self)?)
    }
}