Avoid exiting in streaming workunit reporter session #8945
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
asherf
reviewed
Jan 10, 2020
| @@ -257,7 +257,9 @@ def _maybe_handle_help(self): | |||
| if self._options.help_request: | |||
| help_printer = HelpPrinter(self._options) | |||
| result = help_printer.print_help() | |||
| self._exiter(result) | |||
| return result | |||
| else: | |||
There was a problem hiding this comment.
I don't think we need else: return None it is implicit.
I think what we actually need to return a is a the boolean value of self._options.help_request and not result.
asherf
reviewed
Jan 10, 2020
| def _finish_run(self): | ||
| try: | ||
| self._update_stats() | ||
| run_tracker_result = self._run_tracker.end() |
There was a problem hiding this comment.
for simplicity we should just do return self._run_tracker.end()
and return PANTS_SUCCEEDED_EXIT_CODE (when we catch an error).
it is less code and more pythonic.
gshuflin
force-pushed
the
fix_maybe_help
branch
from
f37555e
to
14bbf0a
Compare
Eric-Arellano
approved these changes
Jan 13, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Problem
We were previously calling
_maybe_handle_helpwithin thewithcontext provided by the streaming workunit handler._maybe_handle_helpchecks to see if the user is trying to invoke./pants goalsand if so prints top-level goal help and calls_exiter, which callssys.exit. This means that we were exiting the program within thewith-context when the user ran./pants goals, which meant that thewith-context wasn't doing its job of shutting down the thread that polled for workunit information. So, if the user ran./pants goalsthe program wouldn't cleanly exit but the workunit polling thread would stick around looping forever.Solution
Have
_maybe_handle_helpreturn a signal value rather than directly calling the exit function, and check for that signal value outside thewith-context to determine if we even need to enter it. Also refactor some of the code that was in thewith-context to make debugging a bit easier in the future.