Refactor cabal-install solver config log output #10854
+347
−174
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,34 +27,51 @@ import Distribution.Solver.Modular.ConfiguredConversion | |
| ( convCP ) | ||
| import qualified Distribution.Solver.Modular.ConflictSet as CS | ||
| import Distribution.Solver.Modular.Dependency | ||
| ( Var(..), | ||
| showVar, | ||
| ConflictMap, | ||
| ConflictSet, | ||
| showConflictSet, | ||
| RevDepMap ) | ||
| import Distribution.Solver.Modular.Flag ( SN(SN), FN(FN) ) | ||
| import Distribution.Solver.Modular.Index ( Index ) | ||
| import Distribution.Solver.Modular.IndexConversion | ||
| ( convPIs ) | ||
| import Distribution.Solver.Modular.Log | ||
| ( SolverFailure(..), displayLogMessages ) | ||
| import Distribution.Solver.Modular.Package | ||
| ( PN ) | ||
| import Distribution.Solver.Modular.RetryLog | ||
| ( RetryLog, | ||
| toProgress, | ||
| fromProgress, | ||
| retry, | ||
| failWith, | ||
| continueWith ) | ||
| import Distribution.Solver.Modular.Solver | ||
| ( SolverConfig(..), PruneAfterFirstSuccess(..), solve ) | ||
| import Distribution.Solver.Types.DependencyResolver | ||
| ( DependencyResolver ) | ||
| import Distribution.Solver.Types.LabeledPackageConstraint | ||
| ( LabeledPackageConstraint, unlabelPackageConstraint ) | ||
| import Distribution.Solver.Types.PackageConstraint | ||
| ( PackageConstraint(..), scopeToPackageName ) | ||
| import Distribution.Solver.Types.PackagePath ( QPN ) | ||
| import Distribution.Solver.Types.PackagePreferences | ||
| ( PackagePreferences ) | ||
| import Distribution.Solver.Types.PkgConfigDb | ||
| ( PkgConfigDb ) | ||
| import Distribution.Solver.Types.Progress | ||
| ( Progress(..), foldProgress, SummarizedMessage(ErrorMsg) ) | ||
| import Distribution.Solver.Types.Variable ( Variable(..) ) | ||
| import Distribution.System | ||
| ( Platform(..) ) | ||
| import Distribution.Simple.Setup | ||
| ( BooleanFlag(..) ) | ||
| import Distribution.Simple.Utils | ||
| ( ordNubBy ) | ||
| import Distribution.Verbosity ( normal, verbose ) | ||
| import Distribution.Solver.Modular.Message ( renderSummarizedMessage ) | ||
|
|
||
| -- | Ties the two worlds together: classic cabal-install vs. the modular | ||
| -- solver. Performs the necessary translations before and after. | ||
|
|
@@ -120,25 +137,25 @@ solve' :: SolverConfig | |
| -> (PN -> PackagePreferences) | ||
| -> Map PN [LabeledPackageConstraint] | ||
| -> Set PN | ||
| -> Progress SummarizedMessage String (Assignment, RevDepMap) | ||
| solve' sc cinfo idx pkgConfigDB pprefs gcs pns = | ||
| toProgress $ retry (runSolver printFullLog sc) createErrorMsg | ||
| where | ||
| runSolver :: Bool -> SolverConfig | ||
| -> RetryLog SummarizedMessage SolverFailure (Assignment, RevDepMap) | ||
| runSolver keepLog sc' = | ||
| displayLogMessages keepLog $ | ||
| solve sc' cinfo idx pkgConfigDB pprefs gcs pns | ||
|
|
||
| createErrorMsg :: SolverFailure | ||
| -> RetryLog SummarizedMessage String (Assignment, RevDepMap) | ||
| createErrorMsg failure@(ExhaustiveSearch cs _cm) = | ||
| if asBool $ minimizeConflictSet sc | ||
| then continueWith (mkErrorMsg ("Found no solution after exhaustively searching the " | ||
| ++ "dependency tree. Rerunning the dependency solver " | ||
| ++ "to minimize the conflict set ({" | ||
| ++ showConflictSet cs ++ "}).")) $ | ||
| retry (tryToMinimizeConflictSet (runSolver printFullLog) sc cs _cm) $ | ||
| \case | ||
| ExhaustiveSearch cs' cm' -> | ||
| fromProgress $ Fail $ | ||
|
|
@@ -151,13 +168,13 @@ solve' sc cinfo idx pkgConfigDB pprefs gcs pns = | |
| ++ "Original error message:\n" | ||
| ++ rerunSolverForErrorMsg cs | ||
| ++ finalErrorMsg sc failure | ||
| else | ||
| fromProgress $ Fail $ rerunSolverForErrorMsg cs ++ finalErrorMsg sc failure | ||
| createErrorMsg failure@BackjumpLimitReached = | ||
| continueWith | ||
| (mkErrorMsg ("Backjump limit reached. Rerunning dependency solver to generate " | ||
| ++ "a final conflict set for the search tree containing the " | ||
| ++ "first backjump.")) $ | ||
| retry (runSolver printFullLog sc { pruneAfterFirstSuccess = PruneAfterFirstSuccess True }) $ | ||
| \case | ||
| ExhaustiveSearch cs _ -> | ||
|
|
@@ -181,13 +198,16 @@ solve' sc cinfo idx pkgConfigDB pprefs gcs pns = | |
| -- original goal order. | ||
| goalOrder' = preferGoalsFromConflictSet cs <> fromMaybe mempty (goalOrder sc) | ||
|
|
||
| in unlines ("Could not resolve dependencies:" : map renderSummarizedMessage (messages (toProgress (runSolver True sc')))) | ||
|
|
||
| printFullLog = solverVerbosity sc >= verbose | ||
|
|
||
| messages :: Progress step fail done -> [step] | ||
| messages = foldProgress (:) (const []) (const []) | ||
|
|
||
| mkErrorMsg :: String -> SummarizedMessage | ||
| mkErrorMsg msg = ErrorMsg msg | ||
|
|
||
| -- | Try to remove variables from the given conflict set to create a minimal | ||
| -- conflict set. | ||
| -- | ||
|
|
@@ -219,13 +239,13 @@ solve' sc cinfo idx pkgConfigDB pprefs gcs pns = | |
| -- solver to add new unnecessary variables to the conflict set. This function | ||
| -- discards the result from any run that adds new variables to the conflict | ||
| -- set, but the end result may not be completely minimized. | ||
| tryToMinimizeConflictSet :: forall a . (SolverConfig -> RetryLog SummarizedMessage SolverFailure a) | ||
| -> SolverConfig | ||
| -> ConflictSet | ||
| -> ConflictMap | ||
| -> RetryLog SummarizedMessage SolverFailure a | ||
| tryToMinimizeConflictSet runSolver sc cs cm = | ||
| foldl (\r v -> retryMap mkErrorMsg $ retryNoSolution (retryMap renderSummarizedMessage r) $ tryToRemoveOneVar v) | ||
|
There was a problem hiding this comment. From #9159: Why does this line convert the |
||
| (fromProgress $ Fail $ ExhaustiveSearch cs cm) | ||
| (CS.toList cs) | ||
| where | ||
|
|
@@ -258,7 +278,7 @@ tryToMinimizeConflictSet runSolver sc cs cm = | |
| | otherwise = | ||
| continueWith ("Trying to remove variable " ++ varStr ++ " from the " | ||
| ++ "conflict set.") $ | ||
| retry (retryMap renderSummarizedMessage $ runSolver sc') $ \case | ||
|
There was a problem hiding this comment. From #9159: Why does this line call |
||
| err@(ExhaustiveSearch cs' _) | ||
| | CS.toSet cs' `isSubsetOf` CS.toSet smallestKnownCS -> | ||
| let msg = if not $ CS.member v cs' | ||
|
|
@@ -297,6 +317,9 @@ tryToMinimizeConflictSet runSolver sc cs cm = | |
| ExhaustiveSearch cs' cm' -> f cs' cm' | ||
| BackjumpLimitReached -> fromProgress (Fail BackjumpLimitReached) | ||
|
|
||
| retryMap :: (t -> step) -> RetryLog t fail done -> RetryLog step fail done | ||
| retryMap f l = fromProgress $ (\p -> foldProgress (\x xs -> Step (f x) xs) Fail Done p) $ toProgress l | ||
|
Comment on lines
+320
to
+321
There was a problem hiding this comment. From #9159: I think that it would be better to avoid creating a helper function that hides calls to |
||
|
|
||
| -- | Goal ordering that chooses goals contained in the conflict set before | ||
| -- other goals. | ||
| preferGoalsFromConflictSet :: ConflictSet | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From #9159: Why was
cmrenamed?