Background jobs #5259
Merged
Background jobs #5259
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
When running a main method, if the user inputs ctrl+c then the `run` task will exit but the main method is not interrupted so it continues running even once sbt has returned to the shell. If the main method is a webserver, this prevents run from ever starting again on a fixed port. To fix this, we can modify the waitForTry method to stop the job if an exception is thrown (ctrl+c leads to an interrupted exception being thrown by waitFor). I rework the BackgroundJobService so that the default implementation of waitForTry is now usable and no longer needs to be overridden. The side effect of this change is that waitFor may now throw an exception. Within sbt, waitFor was only used in one place and I reworked it to use waitForTry instead. This could theoretically break a downstream user who relied on waitFor not throwing an exception but I suspect that there aren't many users of this api, if any at all.
When a user calls sbt exit and there is an active background job, sbt may not exit cleanly. This was primarily because the background job service shutdown method depended on the StandardMain.executionContext which was closed before the background job service was shutdown. This was fixable by reordering the resource closing in StandardMain.runManaged.
Rather than putting the background job temporary files in whatever java.io.tmpdir points to, this commit moves the files into a subdirectory of target in the project root directory. To make the directory configurable via settings, I had to move the declaration of the bgJobService setting later in the project initialization process. I don't think this should matter because background jobs shouldn't be created until after the project has loaded all of its settings..
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.
This PR makes a number of miscellaneous improvements to the background job service including:
runprovided the main method handles interrupts)$PROJECT_BASE_DIR/target/bg-jobs).