Adds --stop-on-block/--stop option to solver #1016
Merged
Conversation
This file contains 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
dcookspi
added
enhancement
dcookspi
changed the title
rydrman
reviewed
May 4, 2024
crates/spk-solve/src/io.rs
Outdated
| @@ -1089,16 +1124,21 @@ impl DecisionFormatter { | |||
| self.send_sentry_warning_message( | |||
| &runtime.solver, | |||
| solve_time, | |||
| if mesg.contains("by user") { | |||
| if mesg.contains("by user") || mesg.contains("--stop-on-block") { | |||
There was a problem hiding this comment.
is it possible to replace this magic string with a constant? Like maybe save the message string from above as a const and then refer to it here so that it doesn't break if we change the message in the future?
There was a problem hiding this comment.
I've added constants for this check and used them in the messages.
dcookspi
force-pushed
the
adding-stop-on-block
branch
from
506cd85 to
c801d80
Compare
This stops the solver when it first reaches a BLOCKED state and would step back. This is useful when working out missing dependencies, e.g. when porting a package between OSes or python versions. Signed-off-by: David Gilligan-Cook <dcook@imageworks.com>
This pauses the solver when a BLOCKED state is reached (a step-back change). The solver will start up again when the user hits Enter. Signed-off-by: David Gilligan-Cook <dcook@imageworks.com>
dcookspi
force-pushed
the
adding-stop-on-block
branch
from
c801d80 to
b068cb0
Compare
rydrman
approved these changes
Jun 4, 2024
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
This adds
--stop-on-block/--stopoption to solver. This option stops the solver completely when it reaches the firstBLOCKEDstate (step-back).This turned out to be useful when working out missing dependencies, e.g. when porting a package between OSes or python versions, or otherwise dealing with lots of dependencies changing. While debugging solves that entered solver hell, I found myself running and interrupting the solve over and over. I would scroll back up the output to the first BLOCKED line and use that to work out what request to change, or what other package needed to be converted or built and published. Having the solver stop when it hit BLOCKED streamlined the process for me.
For example:
It can be combined with all the usual verbosity and report settings to show more context around the point that it BLOCKED. By default, using
--stop-on-blockdoes not print the solver report that interrupting the solver with Ctrl-C or a timeout does, but you can use-tto see the report as well.