🐛 fix: eliminate zombie jobs #96
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 commit moves the hard-coded network chains endpoint into a `chainEndpoint` constant for better visibility and configurability.
Added a Manuscript State Detector which can be instanciated in the ListJobs() function for sake of identifying manuscript state with accuracy and finality. The state machine executes a series of elaborate looks at container status and flink logs to update to one of five states: RUNNING, INITIALIZING, FAILED, STOPPED, and UNKNOWN (rare). This is the grounds for more advanced manuscript detection from the CLI.
This commit adds new logic to jobs_manuscipt that allows for the detection of manuscripts by using `manuscript_state.go`
Recognizing that there is a lot of complicated logic in the state detector, I added comments explaining its general operation throughout.
Within the DetectState method, manuscripts previously defaulted to initializing state, despite surviving all previous checks. Now, if a manuscript survives all checks it will display as `RUNNING` in the jobs list.
This adds as an additional state check - the checkGraphQLEndpoint function which hits the local endpoint to determine healthiness and ensure it is live before returning RUNNING. If it is determined not to be live, but survive all other checks, the manuscript will return INITIALIZING status.
This commit adds additional status indicators to the long help text of the list command.
This commit adds an alias, `ls` to the list command.
|
P.S. It may be time to bump the version number ;) @Liquidwe |
This commit adds additional guard rails to fix broken functionality of `init` command that was affecting the jobs list. Previously, a person could init and partially overwrite an existing manuscript. Now, extensive checks are in place to prevent that from happening: manuscript is looked for in the directory of the manuscript path, the manuscript is already running, the manuscript is in the config file.
This commit adds new functionality to manuscript-cli list. It now accepts a directory as an argument. If no directory is specified it looks in the default directory for users. It also shows STOPPED jobs by looking at the manuscript yamls in the subdirectories of the specified directory and showing ALL manuscripts. This makes it more informative and usable.
|
Before merging, please verify this is not causing #97 |
|
thx @KagemniKarimu A very excellent repair proposal, I will submit some of the recent repairs to v1.1.1 |
Liquidwe
approved these changes
Dec 16, 2024
9 tasks
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.
Checklist:
Important
Please review the checklist below before submitting your pull request.
Description
This PR is intended to deal with the several issues that exist with the CLI's
listcommand andListJobslogic. Dead jobs would show as being alive and vice versa. While it does not solve all of the surrounding issues, and could have more informative messages , it provides an initial technical framework for improving manuscript state detection:The major changes are as follows:
pkg/manuscript_state.golistto use the Manuscript State Machine to determine Manuscript statelisthelp documentationlsalias tolistcommandlistcommand - you can now search other directories besides the default one for manuscripts mimicking unixlscommand. This was initially added for debugging purposes but proved quite useful.Fixes #61
R.I.P. Zombie Jobs 🧟
Type of Change