fix: Stop and finalize build on exec termination #332
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
This property is a function and not a getter. Without invoking it as a function, it's value is always truthy.
When the process was terminated, all of the signal handlers were triggered causing multiple logs to be outputted. Skipping stopping the agent once another event has stopped it causes subsequent events to skip straight to exiting, and never finalizes builds. Exiting is tracked so that if it is already being handled, there is no need to handle exiting again.
The previous test tested that PERCY_ENABLED _did not_ work. That is, it tested that a warning was still thrown even though it was disabled. That test has been corrected to assert that _nothing_ is thrown when disabled.
Robdel12
approved these changes
Aug 22, 2019
| @@ -22,7 +22,7 @@ export default class PercyCommand extends Command { | |||
| } | |||
|
|
|||
| async run() { | |||
| if (this.percyEnabled && !this.percyTokenPresent()) { | |||
| if (this.percyEnabled() && !this.percyTokenPresent()) { | |||
wwilsman
changed the title
wwilsman
changed the title
wwilsman
force-pushed
the
ww/exec-cleanup
branch
from
c883d25 to
7715f6b
Compare
djones
pushed a commit
that referenced
this pull request
Aug 22, 2019
## [0.10.1](v0.10.0...v0.10.1) (2019-08-22) ### Bug Fixes * Stop and finalize build on exec termination ([#332](#332)) ([2fd90b9](2fd90b9))
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.
Purpose
When running
percy execwith a command that causes the process to hang, terminating the process causes builds to get stuck in a receiving state due to the build never finalizing.Approach
Add signal handlers for
SIGHUP,SIGINT, andSIGTERMto stop and finalize the build.Multiple signals are sometimes sent and cause the stop method to get called multiple times. This didn't seem to effect finalizing builds, but caused noisy output in the terminal. An instance property,
exiting, is used to bail out of the stop method when it has already been called. This also prevents secondary events from exiting before the first event has finalized the build.Other changes
I also corrected a check for
percyEnabledwhich treated the property as a getter when it is actually a method. Fixing this also highlighted a test which actually tested the incorrect behavior. This test was updated to reflect the desired behavior, which is to not warn about a missing token when Percy is disabled.