diff options
| author | nsfisis <nsfisis@gmail.com> | 2026-06-22 23:42:25 +0900 |
|---|---|---|
| committer | nsfisis <nsfisis@gmail.com> | 2026-06-22 23:42:25 +0900 |
| commit | aa4e9ff27b974343beeccdd14e07e13f0e261599 (patch) | |
| tree | 2bfbb272440b898c1c505b461651be6cc3e1cda3 | |
| parent | 5ab5f3b316798c1411ce8e6a7f5b091fda93589c (diff) | |
| download | php-shirabe-aa4e9ff27b974343beeccdd14e07e13f0e261599.tar.gz php-shirabe-aa4e9ff27b974343beeccdd14e07e13f0e261599.tar.zst php-shirabe-aa4e9ff27b974343beeccdd14e07e13f0e261599.zip | |
feat(solver): surface SolverProblemsException via two-layer Result
solve() previously dropped the SolverProblemsException and returned a
placeholder anyhow error, because its Rc<RefCell<Rule>> payload is not
Send+Sync and cannot ride anyhow::Error. Return
anyhow::Result<Result<LockTransaction, SolverProblemsException>> instead,
keeping fatal errors on the outer Result and the recoverable exception on
the inner one.
This lets the three Installer callsites port their PHP catch handlers
faithfully (pretty-string output, GithubActionError emit, getCode-based
exit codes) and lets solver_test.rs assert getProblems/getCode/
getPrettyString. The four ported assertion tests stay ignored: their
pretty-string path still reaches unimplemented todo!()s downstream.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
| -rw-r--r-- | crates/shirabe/src/dependency_resolver/solver.rs | 18 | ||||
| -rw-r--r-- | crates/shirabe/src/installer.rs | 91 | ||||
| -rw-r--r-- | crates/shirabe/tests/dependency_resolver/solver_test.rs | 286 |
3 files changed, 350 insertions, 45 deletions
diff --git a/crates/shirabe/src/dependency_resolver/solver.rs b/crates/shirabe/src/dependency_resolver/solver.rs index 52c4580..cd00757 100644 --- a/crates/shirabe/src/dependency_resolver/solver.rs +++ b/crates/shirabe/src/dependency_resolver/solver.rs @@ -230,7 +230,7 @@ impl Solver { &mut self, request: &Request, platform_requirement_filter: Option<Rc<dyn PlatformRequirementFilterInterface>>, - ) -> anyhow::Result<LockTransaction> { + ) -> anyhow::Result<Result<LockTransaction, SolverProblemsException>> { let platform_requirement_filter = platform_requirement_filter .unwrap_or_else(|| PlatformRequirementFilterFactory::ignore_nothing()); @@ -272,27 +272,25 @@ impl Solver { ); if !self.problems.is_empty() { - // TODO(phase-c): SolverProblemsException stores `Rc<RefCell<Rule>>` which is not - // `Send + Sync`, so it cannot satisfy `anyhow::Error`'s bounds. Returning a - // placeholder error preserves control flow until the solver error path is reworked to - // a dedicated (non-anyhow) error type or the exception drops its dyn Rule payload. - let _ = SolverProblemsException::new( + // SolverProblemsException stores `Rc<RefCell<Rule>>` which is not `Send + Sync`, so it + // cannot satisfy `anyhow::Error`'s bounds. It is the recoverable exception PHP callers + // `catch`, so it rides the inner `Result` while fatal errors stay on the outer one. + return Ok(Err(SolverProblemsException::new( std::mem::take(&mut self.problems), std::mem::take(&mut self.learned_pool), - ); - return Err(anyhow::anyhow!("solver problems")); + ))); } // LockTransaction stores PackageInterfaceHandle maps; widen the request's BasePackageHandle // maps into them. let present_map = request.get_present_map(false)?.into_iter().collect(); let unlockable_map = request.get_fixed_packages_map().into_iter().collect(); - Ok(LockTransaction::new( + Ok(Ok(LockTransaction::new( &self.pool.borrow(), present_map, unlockable_map, &self.decisions, - )) + ))) } /// Makes a decision and propagates it to all rules. diff --git a/crates/shirabe/src/installer.rs b/crates/shirabe/src/installer.rs index 8149b05..d1e839d 100644 --- a/crates/shirabe/src/installer.rs +++ b/crates/shirabe/src/installer.rs @@ -680,7 +680,7 @@ impl Installer { match solver .as_mut() .unwrap() - .solve(&request, Some(self.platform_requirement_filter.clone())) + .solve(&request, Some(self.platform_requirement_filter.clone()))? { Ok(t) => { lock_transaction = t; @@ -688,11 +688,34 @@ impl Installer { solver = None; } Err(e) => { - // TODO(phase-c): SolverProblemsException contains dyn Rule which isn't Send+Sync - // so anyhow::Error::downcast_ref can't extract it. Skipping detection until the - // solver error path moves off anyhow (see solver.rs). - let _ = (&repository_set, &request, &pool); - return Err(e); + let err = + "Your requirements could not be resolved to an installable set of packages."; + let pretty_problem = e.get_pretty_string( + &repository_set, + &request, + &mut pool.borrow_mut(), + self.io.is_verbose(), + false, + )?; + + self.io.write_error3( + &format!("<error>{}</error>", err), + true, + io_interface::QUIET, + ); + self.io.write_error(&pretty_problem); + if !self.dev_mode { + self.io.write_error3( + "<warning>Running update with --no-dev does not mean require-dev is ignored, it just means the packages will not be installed. If dev requirements are blocking the update you have to resolve those problems.</warning>", + true, + io_interface::QUIET, + ); + } + + let mut ghe = GithubActionError::new(self.io.clone()); + ghe.emit(&format!("{}\n{}", err, pretty_problem), None, None); + + return Ok(std::cmp::max(Self::ERROR_GENERIC_FAILURE, e.get_code())); } } let _ = solver; @@ -967,16 +990,39 @@ impl Installer { match solver .as_mut() .unwrap() - .solve(&request, Some(self.platform_requirement_filter.clone())) + .solve(&request, Some(self.platform_requirement_filter.clone()))? { Ok(t) => { non_dev_lock_transaction = t; solver = None; } Err(e) => { - // TODO(phase-c): SolverProblemsException can't be downcast (dyn Rule not Send+Sync); see solver.rs - let _ = (&repository_set, &request, &pool); - return Err(e); + let err = "Unable to find a compatible set of packages based on your non-dev requirements alone."; + let pretty_problem = e.get_pretty_string( + &repository_set, + &request, + &mut pool.borrow_mut(), + self.io.is_verbose(), + true, + )?; + + self.io.write_error3( + &format!("<error>{}</error>", err), + true, + io_interface::QUIET, + ); + self.io.write_error( + "Your requirements can be resolved successfully when require-dev packages are present.", + ); + self.io.write_error( + "You may need to move packages from require-dev or some of their dependencies to require.", + ); + self.io.write_error(&pretty_problem); + + let mut ghe = GithubActionError::new(self.io.clone()); + ghe.emit(&format!("{}\n{}", err, pretty_problem), None, None); + + return Ok(e.get_code()); } } let _ = solver; @@ -1111,7 +1157,7 @@ impl Installer { match solver .as_mut() .unwrap() - .solve(&request, Some(self.platform_requirement_filter.clone())) + .solve(&request, Some(self.platform_requirement_filter.clone()))? { Ok(lock_transaction) => { solver = None; @@ -1128,9 +1174,26 @@ impl Installer { } } Err(e) => { - // TODO(phase-c): SolverProblemsException can't be downcast (dyn Rule not Send+Sync); see solver.rs - let _ = (&repository_set, &request, &pool); - return Err(e); + let err = "Your lock file does not contain a compatible set of packages. Please run composer update."; + let pretty_problem = e.get_pretty_string( + &repository_set, + &request, + &mut pool.borrow_mut(), + self.io.is_verbose(), + false, + )?; + + self.io.write_error3( + &format!("<error>{}</error>", err), + true, + io_interface::QUIET, + ); + self.io.write_error(&pretty_problem); + + let mut ghe = GithubActionError::new(self.io.clone()); + ghe.emit(&format!("{}\n{}", err, pretty_problem), None, None); + + return Ok(std::cmp::max(Self::ERROR_GENERIC_FAILURE, e.get_code())); } } let _ = solver; diff --git a/crates/shirabe/tests/dependency_resolver/solver_test.rs b/crates/shirabe/tests/dependency_resolver/solver_test.rs index c729fea..c9c4d26 100644 --- a/crates/shirabe/tests/dependency_resolver/solver_test.rs +++ b/crates/shirabe/tests/dependency_resolver/solver_test.rs @@ -6,7 +6,9 @@ use std::rc::Rc; use indexmap::IndexMap; use shirabe::dependency_resolver::PolicyInterface; use shirabe::dependency_resolver::default_policy::DefaultPolicy; +use shirabe::dependency_resolver::pool::Pool; use shirabe::dependency_resolver::request::Request; +use shirabe::dependency_resolver::solver_problems_exception::SolverProblemsException; use shirabe::io::io_interface::IOInterface; use shirabe::io::null_io::NullIO; use shirabe::package::Link; @@ -130,7 +132,7 @@ fn check_solver_result_repo_set( let mut solver = shirabe::dependency_resolver::solver::Solver::new(policy, Rc::new(RefCell::new(pool)), io); - let transaction = solver.solve(&request, None).unwrap(); + let transaction = solver.solve(&request, None).unwrap().unwrap(); // Build readable (unique-name) and identity (ptr) representations of the result and // the expectation, mirroring the dual assertEquals in the PHP helper. @@ -184,25 +186,54 @@ fn check_solver_result_repo_set( /// ref: SolverTest::createSolver + solve, returning the error for expectException-only tests. fn solve_expecting_error( + repo_set: RepositorySet, + repo: ArrayRepository, + repo_locked: LockArrayRepositoryHandle, + request: Request, +) { + solve_expecting_problems(repo_set, repo, repo_locked, request); +} + +/// The SolverProblemsException plus the context needed to render its pretty string in assertions. +struct SolveError { + exception: SolverProblemsException, + repo_set: RepositorySet, + request: Request, + pool: Rc<RefCell<Pool>>, +} + +/// ref: SolverTest::createSolver + solve, returning the caught SolverProblemsException. +fn solve_expecting_problems( mut repo_set: RepositorySet, repo: ArrayRepository, repo_locked: LockArrayRepositoryHandle, mut request: Request, -) { +) -> SolveError { repo_set .add_repository(RepositoryInterfaceHandle::new(repo)) .unwrap(); repo_set.add_repository(repo_locked.into()).unwrap(); let io: Rc<RefCell<dyn IOInterface>> = Rc::new(RefCell::new(NullIO::new())); - let pool = repo_set - .create_pool(&mut request, io.clone(), None, None, vec![], None, None) - .unwrap(); + let pool = Rc::new(RefCell::new( + repo_set + .create_pool(&mut request, io.clone(), None, None, vec![], None, None) + .unwrap(), + )); let policy: Rc<dyn PolicyInterface> = Rc::new(DefaultPolicy::new(false, false, None)); - let mut solver = - shirabe::dependency_resolver::solver::Solver::new(policy, Rc::new(RefCell::new(pool)), io); + let mut solver = shirabe::dependency_resolver::solver::Solver::new(policy, pool.clone(), io); - assert!(solver.solve(&request, None).is_err()); + let exception = match solver.solve(&request, None).unwrap() { + Ok(_) => panic!("Unsolvable conflict did not result in exception."), + Err(e) => e, + }; + + SolveError { + exception, + repo_set, + request, + pool, + } } #[ignore] @@ -246,11 +277,45 @@ fn test_solver_remove_if_not_requested() { ); } -#[ignore = "asserts SolverProblemsException details (getProblems/getCode/getPrettyString) which solve() discards"] +#[ignore = "get_pretty_string path reaches an unimplemented todo!() (in_array non-strict in php-shim)"] #[test] fn test_install_non_existing_package_fails() { - let _fixtures = set_up(); - todo!() + let fixtures = set_up(); + fixtures.repo.add_package(get_package("A", "1.0")).unwrap(); + + let mut request = fixtures.request; + request + .require_name("B", Some(get_version_constraint("==", "1"))) + .unwrap(); + + let SolveError { + exception, + repo_set, + request, + pool, + } = solve_expecting_problems( + fixtures.repo_set, + fixtures.repo, + fixtures.repo_locked, + request, + ); + + let problems = exception.get_problems(); + assert_eq!(problems.len(), 1); + assert_eq!(exception.get_code(), 2); + assert_eq!( + problems[0] + .get_pretty_string( + &repo_set, + &request, + &mut pool.borrow_mut(), + false, + &IndexMap::new(), + &Vec::new(), + ) + .unwrap(), + "\n - Root composer.json requires b, it could not be found in any version, there may be a typo in the package name." + ); } #[ignore] @@ -1856,25 +1921,204 @@ fn test_issue265() { ); } -#[ignore = "asserts SolverProblemsException details (getProblems/getPrettyString) which solve() discards"] +#[ignore = "get_pretty_string path reaches an unimplemented todo!() (in_array non-strict in php-shim)"] #[test] fn test_conflict_result_empty() { - let _fixtures = set_up(); - todo!() + let fixtures = set_up(); + let package_a = get_package("A", "1.0"); + fixtures.repo.add_package(package_a.clone()).unwrap(); + let package_b = get_package("B", "1.0"); + fixtures.repo.add_package(package_b.clone()).unwrap(); + package_a + .as_complete_package() + .unwrap() + .__set_conflicts(IndexMap::from([( + "b".to_string(), + link( + "A", + "B", + get_version_constraint(">=", "1.0"), + Link::TYPE_CONFLICT, + ), + )])); + + let mut request = fixtures.request; + request + .require_name( + "A", + Some(MatchAllConstraint::new(Some("*".to_string())).into()), + ) + .unwrap(); + request + .require_name( + "B", + Some(MatchAllConstraint::new(Some("*".to_string())).into()), + ) + .unwrap(); + + let SolveError { + exception, + repo_set, + request, + pool, + } = solve_expecting_problems( + fixtures.repo_set, + fixtures.repo, + fixtures.repo_locked, + request, + ); + + assert_eq!(exception.get_problems().len(), 1); + + let msg = "\n Problem 1\n - Root composer.json requires a * -> satisfiable by A[1.0].\n - Root composer.json requires b * -> satisfiable by B[1.0].\n - A 1.0 conflicts with B 1.0.\n"; + assert_eq!( + exception + .get_pretty_string(&repo_set, &request, &mut pool.borrow_mut(), false, false) + .unwrap(), + msg + ); } -#[ignore = "asserts SolverProblemsException details (getProblems/getPrettyString) which solve() discards"] +#[ignore = "get_pretty_string path reaches an unimplemented todo!() (in_array non-strict in php-shim)"] #[test] fn test_unsatisfiable_requires() { - let _fixtures = set_up(); - todo!() + let fixtures = set_up(); + let package_a = get_package("A", "1.0"); + fixtures.repo.add_package(package_a.clone()).unwrap(); + let package_b = get_package("B", "1.0"); + fixtures.repo.add_package(package_b.clone()).unwrap(); + + package_a + .as_complete_package() + .unwrap() + .__set_requires(IndexMap::from([( + "b".to_string(), + link( + "A", + "B", + get_version_constraint(">=", "2.0"), + Link::TYPE_REQUIRE, + ), + )])); + + let mut request = fixtures.request; + request.require_name("A", None).unwrap(); + + let SolveError { + exception, + repo_set, + request, + pool, + } = solve_expecting_problems( + fixtures.repo_set, + fixtures.repo, + fixtures.repo_locked, + request, + ); + + assert_eq!(exception.get_problems().len(), 1); + + let msg = "\n Problem 1\n - Root composer.json requires a * -> satisfiable by A[1.0].\n - A 1.0 requires b >= 2.0 -> found B[1.0] but it does not match the constraint.\n"; + assert_eq!( + exception + .get_pretty_string(&repo_set, &request, &mut pool.borrow_mut(), false, false) + .unwrap(), + msg + ); } -#[ignore = "asserts SolverProblemsException details (getProblems/getPrettyString) which solve() discards"] +#[ignore = "get_pretty_string path reaches an unimplemented todo!() (Intervals::is_subset_of)"] #[test] fn test_require_mismatch_exception() { - let _fixtures = set_up(); - todo!() + let fixtures = set_up(); + let package_a = get_package("A", "1.0"); + fixtures.repo.add_package(package_a.clone()).unwrap(); + let package_b = get_package("B", "1.0"); + fixtures.repo.add_package(package_b.clone()).unwrap(); + fixtures.repo.add_package(get_package("B", "0.9")).unwrap(); + let package_c = get_package("C", "1.0"); + fixtures.repo.add_package(package_c.clone()).unwrap(); + let package_d = get_package("D", "1.0"); + fixtures.repo.add_package(package_d.clone()).unwrap(); + + package_a + .as_complete_package() + .unwrap() + .__set_requires(IndexMap::from([( + "b".to_string(), + link( + "A", + "B", + get_version_constraint(">=", "1.0"), + Link::TYPE_REQUIRE, + ), + )])); + package_b + .as_complete_package() + .unwrap() + .__set_requires(IndexMap::from([( + "c".to_string(), + link( + "B", + "C", + get_version_constraint(">=", "1.0"), + Link::TYPE_REQUIRE, + ), + )])); + package_c + .as_complete_package() + .unwrap() + .__set_requires(IndexMap::from([( + "d".to_string(), + link( + "C", + "D", + get_version_constraint(">=", "1.0"), + Link::TYPE_REQUIRE, + ), + )])); + package_d + .as_complete_package() + .unwrap() + .__set_requires(IndexMap::from([( + "b".to_string(), + link( + "D", + "B", + get_version_constraint("<", "1.0"), + Link::TYPE_REQUIRE, + ), + )])); + + let mut request = fixtures.request; + request + .require_name( + "A", + Some(MatchAllConstraint::new(Some("*".to_string())).into()), + ) + .unwrap(); + + let SolveError { + exception, + repo_set, + request, + pool, + } = solve_expecting_problems( + fixtures.repo_set, + fixtures.repo, + fixtures.repo_locked, + request, + ); + + assert_eq!(exception.get_problems().len(), 1); + + let msg = "\n Problem 1\n - Root composer.json requires a * -> satisfiable by A[1.0].\n - A 1.0 requires b >= 1.0 -> satisfiable by B[1.0].\n - B 1.0 requires c >= 1.0 -> satisfiable by C[1.0].\n - C 1.0 requires d >= 1.0 -> satisfiable by D[1.0].\n - D 1.0 requires b < 1.0 -> satisfiable by B[0.9].\n - You can only install one version of a package, so only one of these can be installed: B[0.9, 1.0].\n"; + assert_eq!( + exception + .get_pretty_string(&repo_set, &request, &mut pool.borrow_mut(), false, false) + .unwrap(), + msg + ); } #[ignore] @@ -2296,7 +2540,7 @@ fn test_learn_positive_literal() { // check correct setup for assertion later assert!(!solver.test_flag_learned_positive_literal); - let transaction = solver.solve(&request, None).unwrap(); + let transaction = solver.solve(&request, None).unwrap().unwrap(); let expected = vec