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 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
// SPDX-License-Identifier: MPL-2.0
//! Build a report as clear as possible as to why
//! dependency solving failed.
use std::fmt;
use std::ops::Deref;
use std::sync::Arc;
use crate::package::Package;
use crate::term::Term;
use crate::type_aliases::Map;
use crate::version_set::VersionSet;
/// Reporter trait.
pub trait Reporter<P: Package, VS: VersionSet> {
/// Output type of the report.
type Output;
/// Generate a report from the derivation tree
/// describing the resolution failure using the default formatter.
fn report(derivation_tree: &DerivationTree<P, VS>) -> Self::Output;
/// Generate a report from the derivation tree
/// describing the resolution failure using a custom formatter.
fn report_with_formatter(
derivation_tree: &DerivationTree<P, VS>,
formatter: &impl ReportFormatter<P, VS, Output = Self::Output>,
) -> Self::Output;
}
/// Derivation tree resulting in the impossibility
/// to solve the dependencies of our root package.
#[derive(Debug, Clone)]
pub enum DerivationTree<P: Package, VS: VersionSet> {
/// External incompatibility.
External(External<P, VS>),
/// Incompatibility derived from two others.
Derived(Derived<P, VS>),
}
/// Incompatibilities that are not derived from others,
/// they have their own reason.
#[derive(Debug, Clone)]
pub enum External<P: Package, VS: VersionSet> {
/// Initial incompatibility aiming at picking the root package for the first decision.
NotRoot(P, VS::V),
/// There are no versions in the given set for this package.
NoVersions(P, VS),
/// Dependencies of the package are unavailable for versions in that set.
UnavailableDependencies(P, VS),
/// Incompatibility coming from the dependencies of a given package.
FromDependencyOf(P, VS, P, VS),
}
/// Incompatibility derived from two others.
#[derive(Debug, Clone)]
pub struct Derived<P: Package, VS: VersionSet> {
/// Terms of the incompatibility.
pub terms: Map<P, Term<VS>>,
/// Indicate if that incompatibility is present multiple times
/// in the derivation tree.
/// If that is the case, it has a unique id, provided in that option.
/// Then, we may want to only explain it once,
/// and refer to the explanation for the other times.
pub shared_id: Option<usize>,
/// First cause.
pub cause1: Arc<DerivationTree<P, VS>>,
/// Second cause.
pub cause2: Arc<DerivationTree<P, VS>>,
}
impl<P: Package, VS: VersionSet> DerivationTree<P, VS> {
/// Merge the [NoVersions](External::NoVersions) external incompatibilities
/// with the other one they are matched with
/// in a derived incompatibility.
/// This cleans up quite nicely the generated report.
/// You might want to do this if you know that the
/// [DependencyProvider](crate::solver::DependencyProvider)
/// was not run in some kind of offline mode that may not
/// have access to all versions existing.
pub fn collapse_no_versions(&mut self) {
match self {
DerivationTree::External(_) => {}
DerivationTree::Derived(derived) => {
match (
Arc::make_mut(&mut derived.cause1),
Arc::make_mut(&mut derived.cause2),
) {
(DerivationTree::External(External::NoVersions(p, r)), ref mut cause2) => {
cause2.collapse_no_versions();
*self = cause2
.clone()
.merge_no_versions(p.to_owned(), r.to_owned())
.unwrap_or_else(|| self.to_owned());
}
(ref mut cause1, DerivationTree::External(External::NoVersions(p, r))) => {
cause1.collapse_no_versions();
*self = cause1
.clone()
.merge_no_versions(p.to_owned(), r.to_owned())
.unwrap_or_else(|| self.to_owned());
}
_ => {
Arc::make_mut(&mut derived.cause1).collapse_no_versions();
Arc::make_mut(&mut derived.cause2).collapse_no_versions();
}
}
}
}
}
fn merge_no_versions(self, package: P, set: VS) -> Option<Self> {
match self {
// TODO: take care of the Derived case.
// Once done, we can remove the Option.
DerivationTree::Derived(_) => Some(self),
DerivationTree::External(External::NotRoot(_, _)) => {
panic!("How did we end up with a NoVersions merged with a NotRoot?")
}
DerivationTree::External(External::NoVersions(_, r)) => Some(DerivationTree::External(
External::NoVersions(package, set.union(&r)),
)),
DerivationTree::External(External::UnavailableDependencies(_, r)) => Some(
DerivationTree::External(External::UnavailableDependencies(package, set.union(&r))),
),
DerivationTree::External(External::FromDependencyOf(p1, r1, p2, r2)) => {
if p1 == package {
Some(DerivationTree::External(External::FromDependencyOf(
p1,
r1.union(&set),
p2,
r2,
)))
} else {
Some(DerivationTree::External(External::FromDependencyOf(
p1,
r1,
p2,
r2.union(&set),
)))
}
}
}
}
}
impl<P: Package, VS: VersionSet> fmt::Display for External<P, VS> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::NotRoot(package, version) => {
write!(f, "we are solving dependencies of {} {}", package, version)
}
Self::NoVersions(package, set) => {
if set == &VS::full() {
write!(f, "there is no available version for {}", package)
} else {
write!(f, "there is no version of {} in {}", package, set)
}
}
Self::UnavailableDependencies(package, set) => {
if set == &VS::full() {
write!(f, "dependencies of {} are unavailable", package)
} else {
write!(
f,
"dependencies of {} at version {} are unavailable",
package, set
)
}
}
Self::FromDependencyOf(p, set_p, dep, set_dep) => {
if set_p == &VS::full() && set_dep == &VS::full() {
write!(f, "{} depends on {}", p, dep)
} else if set_p == &VS::full() {
write!(f, "{} depends on {} {}", p, dep, set_dep)
} else if set_dep == &VS::full() {
write!(f, "{} {} depends on {}", p, set_p, dep)
} else {
write!(f, "{} {} depends on {} {}", p, set_p, dep, set_dep)
}
}
}
}
}
/// Trait for formatting outputs in the reporter.
pub trait ReportFormatter<P: Package, VS: VersionSet> {
/// Output type of the report.
type Output;
/// Format an [External] incompatibility.
fn format_external(&self, external: &External<P, VS>) -> Self::Output;
/// Format terms of an incompatibility.
fn format_terms(&self, terms: &Map<P, Term<VS>>) -> Self::Output;
}
/// Default formatter for the default reporter.
#[derive(Default, Debug)]
pub struct DefaultStringReportFormatter;
impl<P: Package, VS: VersionSet> ReportFormatter<P, VS> for DefaultStringReportFormatter {
type Output = String;
fn format_external(&self, external: &External<P, VS>) -> String {
external.to_string()
}
fn format_terms(&self, terms: &Map<P, Term<VS>>) -> Self::Output {
let terms_vec: Vec<_> = terms.iter().collect();
match terms_vec.as_slice() {
[] => "version solving failed".into(),
// TODO: special case when that unique package is root.
[(package, Term::Positive(range))] => format!("{} {} is forbidden", package, range),
[(package, Term::Negative(range))] => format!("{} {} is mandatory", package, range),
[(p1, Term::Positive(r1)), (p2, Term::Negative(r2))] => {
self.format_external(&External::FromDependencyOf(p1, r1.clone(), p2, r2.clone()))
}
[(p1, Term::Negative(r1)), (p2, Term::Positive(r2))] => {
self.format_external(&External::FromDependencyOf(p2, r2.clone(), p1, r1.clone()))
}
slice => {
let str_terms: Vec<_> = slice.iter().map(|(p, t)| format!("{} {}", p, t)).collect();
str_terms.join(", ") + " are incompatible"
}
}
}
}
/// Default reporter able to generate an explanation as a [String].
pub struct DefaultStringReporter {
/// Number of explanations already with a line reference.
ref_count: usize,
/// Shared nodes that have already been marked with a line reference.
/// The incompatibility ids are the keys, and the line references are the values.
shared_with_ref: Map<usize, usize>,
/// Accumulated lines of the report already generated.
lines: Vec<String>,
}
impl DefaultStringReporter {
/// Initialize the reporter.
fn new() -> Self {
Self {
ref_count: 0,
shared_with_ref: Map::default(),
lines: Vec::new(),
}
}
fn build_recursive<P: Package, VS: VersionSet, F: ReportFormatter<P, VS, Output = String>>(
&mut self,
derived: &Derived<P, VS>,
formatter: &F,
) {
self.build_recursive_helper(derived, formatter);
if let Some(id) = derived.shared_id {
#[allow(clippy::map_entry)] // `add_line_ref` not compatible with proposed fix.
if !self.shared_with_ref.contains_key(&id) {
self.add_line_ref();
self.shared_with_ref.insert(id, self.ref_count);
}
};
}
fn build_recursive_helper<
P: Package,
VS: VersionSet,
F: ReportFormatter<P, VS, Output = String>,
>(
&mut self,
current: &Derived<P, VS>,
formatter: &F,
) {
match (current.cause1.deref(), current.cause2.deref()) {
(DerivationTree::External(external1), DerivationTree::External(external2)) => {
// Simplest case, we just combine two external incompatibilities.
self.lines.push(Self::explain_both_external(
external1,
external2,
¤t.terms,
formatter,
));
}
(DerivationTree::Derived(derived), DerivationTree::External(external)) => {
// One cause is derived, so we explain this first
// then we add the one-line external part
// and finally conclude with the current incompatibility.
self.report_one_each(derived, external, ¤t.terms, formatter);
}
(DerivationTree::External(external), DerivationTree::Derived(derived)) => {
self.report_one_each(derived, external, ¤t.terms, formatter);
}
(DerivationTree::Derived(derived1), DerivationTree::Derived(derived2)) => {
// This is the most complex case since both causes are also derived.
match (
self.line_ref_of(derived1.shared_id),
self.line_ref_of(derived2.shared_id),
) {
// If both causes already have been referenced (shared_id),
// the explanation simply uses those references.
(Some(ref1), Some(ref2)) => self.lines.push(Self::explain_both_ref(
ref1,
derived1,
ref2,
derived2,
¤t.terms,
formatter,
)),
// Otherwise, if one only has a line number reference,
// we recursively call the one without reference and then
// add the one with reference to conclude.
(Some(ref1), None) => {
self.build_recursive(derived2, formatter);
self.lines.push(Self::and_explain_ref(
ref1,
derived1,
¤t.terms,
formatter,
));
}
(None, Some(ref2)) => {
self.build_recursive(derived1, formatter);
self.lines.push(Self::and_explain_ref(
ref2,
derived2,
¤t.terms,
formatter,
));
}
// Finally, if no line reference exists yet,
// we call recursively the first one and then,
// - if this was a shared node, it will get a line ref
// and we can simply recall this with the current node.
// - otherwise, we add a line reference to it,
// recursively call on the second node,
// and finally conclude.
(None, None) => {
self.build_recursive(derived1, formatter);
if derived1.shared_id.is_some() {
self.lines.push("".into());
self.build_recursive(current, formatter);
} else {
self.add_line_ref();
let ref1 = self.ref_count;
self.lines.push("".into());
self.build_recursive(derived2, formatter);
self.lines.push(Self::and_explain_ref(
ref1,
derived1,
¤t.terms,
formatter,
));
}
}
}
}
}
}
/// Report a derived and an external incompatibility.
///
/// The result will depend on the fact that the derived incompatibility
/// has already been explained or not.
fn report_one_each<P: Package, VS: VersionSet, F: ReportFormatter<P, VS, Output = String>>(
&mut self,
derived: &Derived<P, VS>,
external: &External<P, VS>,
current_terms: &Map<P, Term<VS>>,
formatter: &F,
) {
match self.line_ref_of(derived.shared_id) {
Some(ref_id) => self.lines.push(Self::explain_ref_and_external(
ref_id,
derived,
external,
current_terms,
formatter,
)),
None => self.report_recurse_one_each(derived, external, current_terms, formatter),
}
}
/// Report one derived (without a line ref yet) and one external.
fn report_recurse_one_each<
P: Package,
VS: VersionSet,
F: ReportFormatter<P, VS, Output = String>,
>(
&mut self,
derived: &Derived<P, VS>,
external: &External<P, VS>,
current_terms: &Map<P, Term<VS>>,
formatter: &F,
) {
match (derived.cause1.deref(), derived.cause2.deref()) {
// If the derived cause has itself one external prior cause,
// we can chain the external explanations.
(DerivationTree::Derived(prior_derived), DerivationTree::External(prior_external)) => {
self.build_recursive(prior_derived, formatter);
self.lines.push(Self::and_explain_prior_and_external(
prior_external,
external,
current_terms,
formatter,
));
}
// If the derived cause has itself one external prior cause,
// we can chain the external explanations.
(DerivationTree::External(prior_external), DerivationTree::Derived(prior_derived)) => {
self.build_recursive(prior_derived, formatter);
self.lines.push(Self::and_explain_prior_and_external(
prior_external,
external,
current_terms,
formatter,
));
}
_ => {
self.build_recursive(derived, formatter);
self.lines.push(Self::and_explain_external(
external,
current_terms,
formatter,
));
}
}
}
// String explanations #####################################################
/// Simplest case, we just combine two external incompatibilities.
fn explain_both_external<
P: Package,
VS: VersionSet,
F: ReportFormatter<P, VS, Output = String>,
>(
external1: &External<P, VS>,
external2: &External<P, VS>,
current_terms: &Map<P, Term<VS>>,
formatter: &F,
) -> String {
// TODO: order should be chosen to make it more logical.
format!(
"Because {} and {}, {}.",
formatter.format_external(external1),
formatter.format_external(external2),
formatter.format_terms(current_terms)
)
}
/// Both causes have already been explained so we use their refs.
fn explain_both_ref<P: Package, VS: VersionSet, F: ReportFormatter<P, VS, Output = String>>(
ref_id1: usize,
derived1: &Derived<P, VS>,
ref_id2: usize,
derived2: &Derived<P, VS>,
current_terms: &Map<P, Term<VS>>,
formatter: &F,
) -> String {
// TODO: order should be chosen to make it more logical.
format!(
"Because {} ({}) and {} ({}), {}.",
formatter.format_terms(&derived1.terms),
ref_id1,
formatter.format_terms(&derived2.terms),
ref_id2,
formatter.format_terms(current_terms)
)
}
/// One cause is derived (already explained so one-line),
/// the other is a one-line external cause,
/// and finally we conclude with the current incompatibility.
fn explain_ref_and_external<
P: Package,
VS: VersionSet,
F: ReportFormatter<P, VS, Output = String>,
>(
ref_id: usize,
derived: &Derived<P, VS>,
external: &External<P, VS>,
current_terms: &Map<P, Term<VS>>,
formatter: &F,
) -> String {
// TODO: order should be chosen to make it more logical.
format!(
"Because {} ({}) and {}, {}.",
formatter.format_terms(&derived.terms),
ref_id,
formatter.format_external(external),
formatter.format_terms(current_terms)
)
}
/// Add an external cause to the chain of explanations.
fn and_explain_external<
P: Package,
VS: VersionSet,
F: ReportFormatter<P, VS, Output = String>,
>(
external: &External<P, VS>,
current_terms: &Map<P, Term<VS>>,
formatter: &F,
) -> String {
format!(
"And because {}, {}.",
formatter.format_external(external),
formatter.format_terms(current_terms)
)
}
/// Add an already explained incompat to the chain of explanations.
fn and_explain_ref<P: Package, VS: VersionSet, F: ReportFormatter<P, VS, Output = String>>(
ref_id: usize,
derived: &Derived<P, VS>,
current_terms: &Map<P, Term<VS>>,
formatter: &F,
) -> String {
format!(
"And because {} ({}), {}.",
formatter.format_terms(&derived.terms),
ref_id,
formatter.format_terms(current_terms)
)
}
/// Add an already explained incompat to the chain of explanations.
fn and_explain_prior_and_external<
P: Package,
VS: VersionSet,
F: ReportFormatter<P, VS, Output = String>,
>(
prior_external: &External<P, VS>,
external: &External<P, VS>,
current_terms: &Map<P, Term<VS>>,
formatter: &F,
) -> String {
format!(
"And because {} and {}, {}.",
formatter.format_external(prior_external),
formatter.format_external(external),
formatter.format_terms(current_terms)
)
}
// Helper functions ########################################################
fn add_line_ref(&mut self) {
let new_count = self.ref_count + 1;
self.ref_count = new_count;
if let Some(line) = self.lines.last_mut() {
*line = format!("{} ({})", line, new_count);
}
}
fn line_ref_of(&self, shared_id: Option<usize>) -> Option<usize> {
shared_id.and_then(|id| self.shared_with_ref.get(&id).cloned())
}
}
impl<P: Package, VS: VersionSet> Reporter<P, VS> for DefaultStringReporter {
type Output = String;
fn report(derivation_tree: &DerivationTree<P, VS>) -> Self::Output {
let formatter = DefaultStringReportFormatter;
match derivation_tree {
DerivationTree::External(external) => formatter.format_external(external),
DerivationTree::Derived(derived) => {
let mut reporter = Self::new();
reporter.build_recursive(derived, &formatter);
reporter.lines.join("\n")
}
}
}
fn report_with_formatter(
derivation_tree: &DerivationTree<P, VS>,
formatter: &impl ReportFormatter<P, VS, Output = Self::Output>,
) -> Self::Output {
match derivation_tree {
DerivationTree::External(external) => formatter.format_external(external),
DerivationTree::Derived(derived) => {
let mut reporter = Self::new();
reporter.build_recursive(derived, formatter);
reporter.lines.join("\n")
}
}
}
}