tools/external_crates/crates_io_util/src/lib.rs

// Copyright (C) 2024 The Android Open Source Project
//
// 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
//
//      http://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.

//! Crate for fetching and interacting with crates.io data. Built on top
//! of crates_index, with Android-specific helpers for dealing with features,
//! dependencies, etc.

use std::{collections::BTreeMap, io};

use crates_index::Dependency;
use semver::VersionReq;

mod android_target;
pub use android_target::AndroidTarget;

mod dependency_diff;
pub use dependency_diff::DependencyDiffer;

mod feature;
pub use feature::{FeatureRef, FeaturesAndOptionalDeps};

mod feature_diff;
pub use feature_diff::{FeatureDiff, FeatureDiffer};

mod feature_resolver;
pub use feature_resolver::FeatureResolver;

mod index;
pub use index::CratesIoIndex;

type DepSet<'a> = BTreeMap<&'a str, &'a Dependency>;

/// Trait for parsing version requirement strings of dependencies.
pub trait ParsedVersionReq {
    /// Parses a version requirement, returning an error if unsuccessful.
    fn parsed_version_req(&self) -> Result<VersionReq, semver::Error>;
}

impl ParsedVersionReq for Dependency {
    fn parsed_version_req(&self) -> Result<VersionReq, semver::Error> {
        VersionReq::parse(self.requirement())
    }
}

/// Error types for the 'crates_io_util' crate.
#[derive(thiserror::Error, Debug)]
pub enum Error {
    /// Crate not found in crates.io
    #[error("Crate {0} not found in crates.io")]
    CrateNotFound(String),
    /// Feature not found for crate
    #[error("Feature {0} not found for crate {1}")]
    FeatureNotFound(String, String),
    /// Dependency not found for crate
    #[error("Dependency {0} not found for crate {1}")]
    DepNotFound(String, String),
    /// Failed to get HTTP headers
    #[error("Failed to get HTTP headers")]
    HttpHeader,
    /// Error fetching HTTP data
    #[cfg(feature = "ureq")]
    #[error(transparent)]
    HttpFetch(#[from] ureq::Error),
    /// Propagated crates_index::Error
    #[error(transparent)]
    CratesIndex(#[from] crates_index::Error),
    /// Propagated crates_index::http::Error
    #[error(transparent)]
    CratesIndexHttp(#[from] crates_index::http::Error),
    /// Propagated io::Error
    #[error(transparent)]
    IoError(#[from] io::Error),
    /// Error running cargo
    #[error(transparent)]
    CargoError(#[from] success_or_error::Error),
}