docs: shell_jobs_list status lags shell_job_complete wake-up events - #142
Open
chrispatil wants to merge 1 commit into
Open
docs: shell_jobs_list status lags shell_job_complete wake-up events#142chrispatil wants to merge 1 commit into
chrispatil wants to merge 1 commit into
Conversation
…st/wake-up event lag Repeated wrong 'final straggler' predictions traced to treating shell_jobs_list's exited_ok/status field as authoritative for 'have all async jobs finished notifying me yet.' The two are decoupled: a job can show as done in shell_jobs_list a turn or more before its shell_job_complete wake-up event actually lands. Documents the correct check (track distinct job_ids seen via wake-up events vs. jobs launched) as a 7th Key Gotcha. Doc-only change, no code touched. Addresses tkellogg#47.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
Closes interest-tracking issue #47 (internal tracker, not a GitHub issue).
Repeated wrong "final straggler" predictions when wrapping up a batch of
async jobs launched via the long-running-jobs pattern, traced to treating
shell_jobs_list'sexited_ok/statusfield as authoritative for "have Ibeen notified about every finished job yet." The two are decoupled -- a job
can show as done in
shell_jobs_lista turn or more before itsshell_job_completewake-up event actually lands.Fix
Doc-only: adds a 7th "Key Gotcha" to the (builtin, read-only)
long-running-jobsskill, explaining the decoupling and recommendingtracking distinct job_ids actually woken up for via
shell_job_completeevents, rather than trusting a
shell_jobs_listsnapshot, before declaringa batch fully complete.
Testing
No code touched, N/A for the test suite. Content proofread against the
existing gotcha style/tone in the same file. No dependency on the other PRs
in this batch -- safe to merge independently, any time.