guppy/graph/feature/query.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 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
// Copyright (c) The cargo-guppy Contributors
// SPDX-License-Identifier: MIT OR Apache-2.0
use crate::{
debug_ignore::DebugIgnore,
graph::{
feature::{
ConditionalLink, FeatureGraph, FeatureId, FeatureLabel, FeatureMetadata, FeatureSet,
},
query_core::QueryParams,
DependencyDirection, FeatureGraphSpec, FeatureIx, PackageIx, PackageMetadata,
},
sorted_set::SortedSet,
Error, PackageId,
};
use itertools::Itertools;
use petgraph::graph::NodeIndex;
use std::collections::HashSet;
/// Trait representing whether a feature within a package should be selected.
///
/// This is conceptually similar to passing `--features` or other similar command-line options to
/// Cargo.
///
/// Most uses will involve using one of the predefined filters: `all_filter`, `default_filter`, or
/// `none_filter`. A customized filter can be provided either through `filter_fn` or by implementing
/// this trait.
pub trait FeatureFilter<'g> {
/// Returns true if this feature ID should be selected in the graph.
///
/// Returning false does not prevent this feature ID from being included if it's reachable
/// through other means.
///
/// In general, `accept` should return true if `feature_id.is_base()` is true.
///
/// The feature ID is guaranteed to be in this graph, so it is OK to panic if it isn't found.
fn accept(&mut self, graph: &FeatureGraph<'g>, feature_id: FeatureId<'g>) -> bool;
}
impl<'g, 'a, T> FeatureFilter<'g> for &'a mut T
where
T: FeatureFilter<'g>,
{
fn accept(&mut self, graph: &FeatureGraph<'g>, feature_id: FeatureId<'g>) -> bool {
(**self).accept(graph, feature_id)
}
}
impl<'g, 'a> FeatureFilter<'g> for Box<dyn FeatureFilter<'g> + 'a> {
fn accept(&mut self, graph: &FeatureGraph<'g>, feature_id: FeatureId<'g>) -> bool {
(**self).accept(graph, feature_id)
}
}
impl<'g, 'a> FeatureFilter<'g> for &'a mut dyn FeatureFilter<'g> {
fn accept(&mut self, graph: &FeatureGraph<'g>, feature_id: FeatureId<'g>) -> bool {
(**self).accept(graph, feature_id)
}
}
/// A `FeatureFilter` which calls the function that's passed in.
#[derive(Clone, Debug)]
pub struct FeatureFilterFn<F>(F);
impl<'g, F> FeatureFilterFn<F>
where
F: FnMut(&FeatureGraph<'g>, FeatureId<'g>) -> bool,
{
/// Returns a new instance of this wrapper.
pub fn new(f: F) -> Self {
FeatureFilterFn(f)
}
}
impl<'g, F> FeatureFilter<'g> for FeatureFilterFn<F>
where
F: FnMut(&FeatureGraph<'g>, FeatureId<'g>) -> bool,
{
fn accept(&mut self, graph: &FeatureGraph<'g>, feature_id: FeatureId<'g>) -> bool {
(self.0)(graph, feature_id)
}
}
/// Describes one of the standard sets of features recognized by Cargo: none, all or default.
///
/// `StandardFeatures` implements `FeatureFilter<'g>`, so it can be passed in as a feature filter
/// wherever necessary.
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialOrd, PartialEq)]
pub enum StandardFeatures {
/// No features. Equivalent to a build with `--no-default-features`.
None,
/// Default features. Equivalent to a standard `cargo build`.
Default,
/// All features. Equivalent to `cargo build --all-features`.
All,
}
impl StandardFeatures {
/// A list of all the possible values of `StandardFeatures`.
pub const VALUES: &'static [Self; 3] = &[
StandardFeatures::None,
StandardFeatures::Default,
StandardFeatures::All,
];
}
impl<'g> FeatureFilter<'g> for StandardFeatures {
fn accept(&mut self, graph: &FeatureGraph<'g>, feature_id: FeatureId<'g>) -> bool {
match self {
StandardFeatures::None => {
// The only feature ID that should be accepted is the base one.
feature_id.is_base()
}
StandardFeatures::Default => {
// XXX it kinda sucks that we already know about the exact feature ixs but need to go
// through the feature ID over here. Might be worth reorganizing the code to not do that.
graph
.is_default_feature(feature_id)
.expect("feature IDs should be valid")
}
StandardFeatures::All => true,
}
}
}
/// Returns a `FeatureFilter` that selects everything from the base filter, plus these additional
/// feature names -- regardless of what package they are in.
///
/// This is equivalent to a build with `--features`, and is typically meant to be used with one
/// package.
///
/// For filtering by feature IDs, use `feature_id_filter`.
pub fn named_feature_filter<'g: 'a, 'a>(
base: impl FeatureFilter<'g> + 'a,
features: impl IntoIterator<Item = &'a str>,
) -> impl FeatureFilter<'g> + 'a {
let mut base = base;
let features: HashSet<_> = features.into_iter().collect();
FeatureFilterFn::new(move |feature_graph, feature_id| {
if base.accept(feature_graph, feature_id) {
return true;
}
match feature_id.label() {
FeatureLabel::Named(feature) => features.contains(feature),
_ => {
// This is the base feature. Assume that it has already been selected by the base
// filter.
false
}
}
})
}
/// Returns a `FeatureFilter` that selects everything from the base filter, plus some additional
/// feature IDs.
///
/// This is a more advanced version of `feature_filter`.
pub fn feature_id_filter<'g: 'a, 'a>(
base: impl FeatureFilter<'g> + 'a,
feature_ids: impl IntoIterator<Item = impl Into<FeatureId<'a>>>,
) -> impl FeatureFilter<'g> + 'a {
let mut base = base;
let feature_ids: HashSet<_> = feature_ids
.into_iter()
.map(|feature_id| feature_id.into())
.collect();
FeatureFilterFn::new(move |feature_graph, feature_id| {
base.accept(feature_graph, feature_id) || feature_ids.contains(&feature_id)
})
}
/// A query over a feature graph.
///
/// A `FeatureQuery` is the entry point for Cargo resolution, and also provides iterators over
/// feature IDs and links. This struct is constructed through the `query_` methods on
/// `FeatureGraph`, or through `PackageQuery::to_feature_query`.
#[derive(Clone, Debug)]
pub struct FeatureQuery<'g> {
pub(super) graph: DebugIgnore<FeatureGraph<'g>>,
pub(in crate::graph) params: QueryParams<FeatureGraphSpec>,
}
assert_covariant!(FeatureQuery);
/// ## Queries
///
/// The methods in this section create queries over subsets of this feature graph. Use the methods
/// here to analyze transitive dependencies.
impl<'g> FeatureGraph<'g> {
/// Creates a new query over the entire workspace.
///
/// `query_workspace` will select all workspace packages (subject to the provided filter) and
/// their transitive dependencies.
pub fn query_workspace(&self, filter: impl FeatureFilter<'g>) -> FeatureQuery<'g> {
self.package_graph
.query_workspace()
.to_feature_query(filter)
}
/// Creates a new query that returns transitive dependencies of the given feature IDs in the
/// specified direction.
///
/// Returns an error if any feature IDs are unknown.
pub fn query_directed<'a>(
&self,
feature_ids: impl IntoIterator<Item = impl Into<FeatureId<'a>>>,
dep_direction: DependencyDirection,
) -> Result<FeatureQuery<'g>, Error> {
match dep_direction {
DependencyDirection::Forward => self.query_forward(feature_ids),
DependencyDirection::Reverse => self.query_reverse(feature_ids),
}
}
/// Creates a new query that returns transitive dependencies of the given feature IDs.
///
/// Returns an error if any feature IDs are unknown.
pub fn query_forward<'a>(
&self,
feature_ids: impl IntoIterator<Item = impl Into<FeatureId<'a>>>,
) -> Result<FeatureQuery<'g>, Error> {
let feature_ids = feature_ids.into_iter().map(|feature_id| feature_id.into());
Ok(FeatureQuery {
graph: DebugIgnore(*self),
params: QueryParams::Forward(self.feature_ixs(feature_ids)?),
})
}
/// Creates a new query that returns transitive reverse dependencies of the given feature IDs.
///
/// Returns an error if any feature IDs are unknown.
pub fn query_reverse<'a>(
&self,
feature_ids: impl IntoIterator<Item = impl Into<FeatureId<'a>>>,
) -> Result<FeatureQuery<'g>, Error> {
let feature_ids = feature_ids.into_iter().map(|feature_id| feature_id.into());
Ok(FeatureQuery {
graph: DebugIgnore(*self),
params: QueryParams::Reverse(self.feature_ixs(feature_ids)?),
})
}
pub(in crate::graph) fn query_from_parts(
&self,
feature_ixs: SortedSet<NodeIndex<FeatureIx>>,
direction: DependencyDirection,
) -> FeatureQuery<'g> {
let params = match direction {
DependencyDirection::Forward => QueryParams::Forward(feature_ixs),
DependencyDirection::Reverse => QueryParams::Reverse(feature_ixs),
};
FeatureQuery {
graph: DebugIgnore(*self),
params,
}
}
}
impl<'g> FeatureQuery<'g> {
/// Returns the feature graph the query is going to be executed on.
pub fn graph(&self) -> &FeatureGraph<'g> {
&self.graph
}
/// Returns the direction the query is happening in.
pub fn direction(&self) -> DependencyDirection {
self.params.direction()
}
/// Returns the list of initial features specified in the query.
///
/// The order of features is unspecified.
pub fn initials<'a>(
&'a self,
) -> impl Iterator<Item = FeatureMetadata<'g>> + ExactSizeIterator + 'a {
let graph = self.graph;
self.params
.initials()
.iter()
.map(move |feature_ix| graph.metadata_for_ix(*feature_ix))
}
/// Returns the list of initial packages specified in the query.
///
/// The order of packages is unspecified.
pub fn initial_packages<'a>(&'a self) -> impl Iterator<Item = PackageMetadata<'g>> + 'a {
// feature ixs are stored in sorted order by package ix, so dedup() is fine.
self.initials().map(|feature| feature.package()).dedup()
}
/// Returns true if the query starts from the given package.
///
/// Returns an error if the package ID is unknown.
pub fn starts_from_package(&self, package_id: &PackageId) -> Result<bool, Error> {
let package_ix = self.graph.package_graph.package_ix(package_id)?;
Ok(self.starts_from_package_ix(package_ix))
}
/// Returns true if the query starts from the given feature ID.
///
/// Returns an error if this feature ID is unknown.
pub fn starts_from<'a>(&self, feature_id: impl Into<FeatureId<'a>>) -> Result<bool, Error> {
Ok(self
.params
.has_initial(self.graph.feature_ix(feature_id.into())?))
}
/// Resolves this query into a set of known feature IDs.
///
/// This is the entry point for iterators.
pub fn resolve(self) -> FeatureSet<'g> {
FeatureSet::new(self)
}
/// Resolves this query into a set of known feature IDs, using the provided resolver to
/// determine which links are followed.
pub fn resolve_with(self, resolver: impl FeatureResolver<'g>) -> FeatureSet<'g> {
FeatureSet::with_resolver(self, resolver)
}
/// Resolves this query into a set of known feature IDs, using the provided resolver function to
/// determine which links are followed.
pub fn resolve_with_fn(
self,
resolver_fn: impl FnMut(&FeatureQuery<'g>, ConditionalLink<'g>) -> bool,
) -> FeatureSet<'g> {
self.resolve_with(ResolverFn(resolver_fn))
}
// ---
// Helper methods
// ---
pub(in crate::graph) fn starts_from_package_ix(
&self,
package_ix: NodeIndex<PackageIx>,
) -> bool {
self.graph
.feature_ixs_for_package_ix(package_ix)
.any(|feature_ix| self.params.has_initial(feature_ix))
}
}
/// Represents whether a particular link within a feature graph should be followed during a
/// resolve operation.
pub trait FeatureResolver<'g> {
/// Returns true if this conditional link should be followed during a resolve operation.
fn accept(&mut self, query: &FeatureQuery<'g>, link: ConditionalLink<'g>) -> bool;
}
impl<'g, 'a, T> FeatureResolver<'g> for &'a mut T
where
T: FeatureResolver<'g>,
{
fn accept(&mut self, query: &FeatureQuery<'g>, link: ConditionalLink<'g>) -> bool {
(**self).accept(query, link)
}
}
impl<'g, 'a> FeatureResolver<'g> for Box<dyn FeatureResolver<'g> + 'a> {
fn accept(&mut self, query: &FeatureQuery<'g>, link: ConditionalLink<'g>) -> bool {
(**self).accept(query, link)
}
}
impl<'g, 'a> FeatureResolver<'g> for &'a mut dyn FeatureResolver<'g> {
fn accept(&mut self, query: &FeatureQuery<'g>, link: ConditionalLink<'g>) -> bool {
(**self).accept(query, link)
}
}
#[derive(Clone, Debug)]
struct ResolverFn<F>(pub F);
impl<'g, F> FeatureResolver<'g> for ResolverFn<F>
where
F: FnMut(&FeatureQuery<'g>, ConditionalLink<'g>) -> bool,
{
fn accept(&mut self, query: &FeatureQuery<'g>, link: ConditionalLink<'g>) -> bool {
(self.0)(query, link)
}
}