-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[JenkinsQueueJobV2] Fix job hang out after unexpected response from J…
…enkins (#13034) Fix: * Fixed situation when the job hang out after unexpected response from Jenkins * Fixed "About this task" link Code refactor: * Resolved all tslint warnings * JobState enum and checkStateTransitions function was exported into a separate module and refactored. * Documentation for job states was rewritten on JSdocs Unit tests: * Added test with the longest test scenario of the state transitions * Added test for checking that transition rules are defined for all job states
- Loading branch information
1 parent
07db48a
commit b3a36e9
Showing
9 changed files
with
206 additions
and
75 deletions.
There are no files selected for viewing
2 changes: 1 addition & 1 deletion
2
Tasks/JenkinsQueueJobV2/Strings/resources.resjson/en-US/resources.resjson
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 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 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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /** | ||
| * @enum {number} JobState | ||
| * @readonly | ||
| * @description Enum for job states | ||
| */ | ||
| export enum JobState { | ||
| /** The job is yet to begin */ | ||
| New, | ||
|
|
||
| /** The job is being located */ | ||
| Locating, | ||
|
|
||
| /** The job is running and its console output is streaming */ | ||
| Streaming, | ||
|
|
||
| /** The job has run and is "finishing" */ | ||
| Finishing, | ||
|
|
||
| /** The job has run and is done */ | ||
| Done, | ||
|
|
||
| /** The job is considered complete because it has been joined to the execution of another matching job execution */ | ||
| Joined, | ||
|
|
||
| /** The job was queued and will not be tracked for completion (as specified by the "Capture..." task setting) */ | ||
| Queued, | ||
|
|
||
| /** The job was cut from execution by the pipeline */ | ||
| Cut, | ||
|
|
||
| /** The job has run and its results are being downloaded (occurs when the TFS Plugin for Jenkins is installed) */ | ||
| Downloading, | ||
|
|
||
| /** The job has run and while "finishing" Jenkins provided unexpected answer via an HTTP request */ | ||
| Killed, | ||
| } | ||
|
|
||
| /** | ||
| * @function checkStateTransitions | ||
| * @description Check validation of transition between states | ||
| * @param {JobState} currentState - current job state | ||
| * @param {JobState} newState - future job state | ||
| * @throws {Error} When there was no transition rule for the current state | ||
| * | ||
| * @example | ||
| * Jobs transition between states as follows: | ||
| * BEGINNING STATE: New | ||
| * New → Locating, Streaming, Joined, Cut | ||
| * Locating → Streaming, Joined, Cut | ||
| * Streaming → Finishing | ||
| * Finishing → Downloading, Queued, Done, Killed | ||
| * Downloading → Done | ||
| * TERMINAL STATES: Done, Queued, Joined, Cut, Killed | ||
| */ | ||
| export function checkStateTransitions (currentState: JobState, newState: JobState): boolean { | ||
| let isValidTransition: boolean = false; | ||
| let possibleStates: Array<JobState> = []; | ||
|
|
||
| switch (currentState) { | ||
| case (JobState.New): { | ||
| possibleStates = [JobState.Locating, JobState.Streaming, JobState.Joined, JobState.Cut]; | ||
| break; | ||
| } | ||
|
|
||
| case (JobState.Locating): { | ||
| possibleStates = [JobState.Streaming, JobState.Joined, JobState.Cut]; | ||
| break; | ||
| } | ||
|
|
||
| case (JobState.Streaming): { | ||
| possibleStates = [JobState.Finishing]; | ||
| break; | ||
| } | ||
|
|
||
| case (JobState.Finishing): { | ||
| possibleStates = [JobState.Downloading, JobState.Queued, JobState.Done, JobState.Killed]; | ||
| break; | ||
| } | ||
|
|
||
| case (JobState.Downloading): { | ||
| possibleStates = [JobState.Done]; | ||
| break; | ||
| } | ||
|
|
||
| case (JobState.Done): | ||
| case (JobState.Joined): | ||
| case (JobState.Queued): | ||
| case (JobState.Cut): | ||
| case (JobState.Killed): { | ||
| break; | ||
| } | ||
|
|
||
| default: { | ||
| throw new Error(`No transition rules defined for the ${currentState} state!`); | ||
| } | ||
| } | ||
|
|
||
| if (possibleStates.length > 0) { | ||
| isValidTransition = (possibleStates.indexOf(newState) !== -1); | ||
| } | ||
|
|
||
| return isValidTransition; | ||
| } |
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 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
Oops, something went wrong.