uv_resolver/

flat_index.rs

use std::collections::BTreeMap;

use rustc_hash::FxHashMap;
use tracing::instrument;

use uv_cache::Cache;
use uv_client::{
    FlatIndexClient, FlatIndexEntries, FlatIndexEntry, FlatIndexError, RegistryClient,
};
use uv_configuration::BuildOptions;
use uv_distribution_filename::{DistFilename, SourceDistFilename, WheelFilename};
use uv_distribution_types::{
    File, Index, IndexEntryFilename, IndexLocations, IndexUrl, MinimumLibcVersion,
    RegistryBuiltWheel, RegistrySourceDist,
};
use uv_normalize::PackageName;
use uv_pep440::Version;
use uv_platform_tags::{IncompatibleTag, TagCompatibility, Tags};
use uv_preview::PreviewFeature;
use uv_pypi_types::HashDigest;
use uv_types::HashStrategy;

use crate::prioritized_distribution::{
    HashComparison, IncompatibleSource, IncompatibleWheel, PrioritizedDist, RegistryVariantsJson,
    SourceDistCompatibility, WheelCompatibility,
};

/// Unfiltered entries from `--find-links`, indexed by [`PackageName`].
#[derive(Debug, Clone, Default)]
pub struct FlatIndex {
    /// Entries are ranked using each resolver's platform and hash policies when requested.
    index: FxHashMap<PackageName, Vec<FlatIndexEntry>>,
    /// Whether any `--find-links` entries could not be resolved due to a lack of network
    /// connectivity.
    offline: bool,
}

impl FlatIndex {
    /// Load the `--find-links` entries from the configured indexes.
    pub async fn load(
        client: &RegistryClient,
        cache: &Cache,
        index_locations: &IndexLocations,
    ) -> Result<Self, FlatIndexError> {
        let client = FlatIndexClient::new(client.cached_client(), client.connectivity(), cache);
        let entries = client
            .fetch_all(index_locations.flat_indexes().map(Index::url))
            .await?;
        Ok(Self::from_entries(entries))
    }

    /// Collect all files from a `--find-links` target into a [`FlatIndex`].
    #[instrument(skip_all)]
    fn from_entries(entries: FlatIndexEntries) -> Self {
        let mut index = FxHashMap::<PackageName, Vec<FlatIndexEntry>>::default();
        let (entries, offline) = entries.into_parts();

        for entry in entries {
            index
                .entry(entry.filename().name().clone())
                .or_default()
                .push(entry);
        }

        Self { index, offline }
    }

    /// Get the unfiltered entries for the given package name.
    pub(crate) fn get(&self, package_name: &PackageName) -> Option<&[FlatIndexEntry]> {
        self.index.get(package_name).map(Vec::as_slice)
    }

    /// Whether any `--find-links` entries could not be resolved due to a lack of network
    /// connectivity.
    pub(crate) fn offline(&self) -> bool {
        self.offline
    }
}

/// A set of [`PrioritizedDist`] from a `--find-links` entry for a single package, indexed
/// by [`Version`].
#[derive(Debug, Clone, Default)]
pub struct FlatDistributions(BTreeMap<Version, PrioritizedDist>);

impl FlatDistributions {
    /// Rank the entries for a package using the resolver's platform and hash policies.
    #[instrument(skip_all)]
    pub(crate) fn from_entries(
        entries: impl IntoIterator<Item = FlatIndexEntry>,
        tags: Option<&Tags>,
        hasher: &HashStrategy,
        build_options: &BuildOptions,
        minimum_libc_version: Option<MinimumLibcVersion>,
    ) -> Self {
        let mut distributions = Self::default();
        for entry in entries {
            let (filename, file, index) = entry.into_parts();
            match filename {
                IndexEntryFilename::DistFilename(filename) => distributions.add_file(
                    file,
                    filename,
                    tags,
                    hasher,
                    build_options,
                    index,
                    minimum_libc_version,
                ),
                IndexEntryFilename::VariantJson(filename) => {
                    distributions
                        .0
                        .entry(filename.version.clone())
                        .or_default()
                        .insert_variants_json(RegistryVariantsJson {
                            filename,
                            file,
                            index,
                        });
                }
            }
        }
        // Metadata alone does not make a package version installable.
        distributions.0.retain(|_, dist| !dist.is_empty());
        distributions
    }

    /// Returns an [`Iterator`] over the distributions.
    pub(crate) fn iter(&self) -> impl Iterator<Item = (&Version, &PrioritizedDist)> {
        self.0.iter()
    }

    /// Add the given [`File`] to the [`FlatDistributions`] for the given package.
    fn add_file(
        &mut self,
        file: File,
        filename: DistFilename,
        tags: Option<&Tags>,
        hasher: &HashStrategy,
        build_options: &BuildOptions,
        index: IndexUrl,
        minimum_libc_version: Option<MinimumLibcVersion>,
    ) {
        // No `requires-python` here: for source distributions, we don't have that information;
        // for wheels, we read it lazily only when selected.
        match filename {
            DistFilename::WheelFilename(filename) => {
                let version = filename.version.clone();

                let compatibility = Self::wheel_compatibility(
                    &filename,
                    file.hashes.as_slice(),
                    tags,
                    hasher,
                    build_options,
                );
                let dist = RegistryBuiltWheel {
                    filename,
                    file: Box::new(file),
                    index,
                    size_is_authoritative: false,
                };
                self.0.entry(version).or_default().insert_built(
                    dist,
                    vec![],
                    compatibility,
                    minimum_libc_version,
                );
            }
            DistFilename::SourceDistFilename(filename) => {
                let compatibility = Self::source_dist_compatibility(
                    &filename,
                    file.hashes.as_slice(),
                    hasher,
                    build_options,
                );
                let dist = RegistrySourceDist {
                    name: filename.name.clone(),
                    version: filename.version.clone(),
                    ext: filename.extension,
                    file: Box::new(file),
                    index,
                    wheels: vec![],
                    size_is_authoritative: false,
                };
                self.0.entry(filename.version).or_default().insert_source(
                    dist,
                    vec![],
                    compatibility,
                );
            }
        }
    }

    fn source_dist_compatibility(
        filename: &SourceDistFilename,
        hashes: &[HashDigest],
        hasher: &HashStrategy,
        build_options: &BuildOptions,
    ) -> SourceDistCompatibility {
        // Check if source distributions are allowed for this package.
        if build_options.no_build_package(&filename.name) {
            return SourceDistCompatibility::Incompatible(IncompatibleSource::NoBuild);
        }

        // Check if the filename is PEP 625-compliant.
        // TODO: Strengthen this check more; right now we allow `.zip`
        // (which is not compliant) and we don't strictly
        // enforce the formatting rules for the name or version.
        if !filename.extension.is_pep625_compliant() {
            return SourceDistCompatibility::Incompatible(IncompatibleSource::NotPep625Filename);
        }

        // Check if hashes line up
        let hash_policy = hasher.archive_policy_for_package(&filename.name, &filename.version);
        let hash = if hash_policy.requires_validation() {
            if hashes.is_empty() {
                HashComparison::Missing
            } else if hash_policy.matches(hashes) {
                HashComparison::Matched
            } else {
                HashComparison::Mismatched
            }
        } else {
            HashComparison::Matched
        };

        SourceDistCompatibility::Compatible(hash)
    }

    fn wheel_compatibility(
        filename: &WheelFilename,
        hashes: &[HashDigest],
        tags: Option<&Tags>,
        hasher: &HashStrategy,
        build_options: &BuildOptions,
    ) -> WheelCompatibility {
        if filename.variant().is_some() && !uv_preview::is_enabled(PreviewFeature::WheelVariants) {
            return WheelCompatibility::Incompatible(IncompatibleWheel::Tag(
                IncompatibleTag::Variant,
            ));
        }
        // Check if binaries are allowed for this package.
        if build_options.no_binary_package(&filename.name) {
            return WheelCompatibility::Incompatible(IncompatibleWheel::NoBinary);
        }

        // Determine a compatibility for the wheel based on tags.
        let priority = match tags {
            Some(tags) => match filename.tag_compatibility(tags) {
                TagCompatibility::Incompatible(tag) => {
                    return WheelCompatibility::Incompatible(IncompatibleWheel::Tag(tag));
                }
                TagCompatibility::Compatible(priority) => Some(priority),
            },
            None => None,
        };

        // Check if hashes line up.
        let hash_policy = hasher.archive_policy_for_package(&filename.name, &filename.version);
        let hash = if hash_policy.requires_validation() {
            if hashes.is_empty() {
                HashComparison::Missing
            } else if hash_policy.matches(hashes) {
                HashComparison::Matched
            } else {
                HashComparison::Mismatched
            }
        } else {
            HashComparison::Matched
        };

        WheelCompatibility::from_tag_priority(filename, hash, priority)
    }
}

impl IntoIterator for FlatDistributions {
    type Item = (Version, PrioritizedDist);
    type IntoIter = std::collections::btree_map::IntoIter<Version, PrioritizedDist>;

    fn into_iter(self) -> Self::IntoIter {
        self.0.into_iter()
    }
}

impl From<FlatDistributions> for BTreeMap<Version, PrioritizedDist> {
    fn from(distributions: FlatDistributions) -> Self {
        distributions.0
    }
}

impl From<BTreeMap<Version, PrioritizedDist>> for FlatDistributions {
    fn from(distributions: BTreeMap<Version, PrioritizedDist>) -> Self {
        Self(distributions)
    }
}