[node-core-library] iterator weighting isn't fully respected by Async#forEachAsync
#4688
Conversation
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
aramissennyeydd
requested review from
iclanton,
octogonz,
apostolisms,
D4N14L and
dmichon-msft
as code owners
iclanton
approved these changes
May 10, 2024
common/changes/@microsoft/rush/sennyeya-weighted-operation-reentry_2024-05-08-23-55.json
Outdated
Show resolved
Hide resolved
...anges/@rushstack/node-core-library/sennyeya-weighted-operation-reentry_2024-05-08-23-55.json
Outdated
Show resolved
Hide resolved
…ntry_2024-05-08-23-55.json
…operation-reentry_2024-05-08-23-55.json
octogonz
changed the title
Async#forEachAsyncAsync#forEachAsync
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.
Summary
Followup to #4672. This PR fixes 2 bugs that I found while trying to integrate this with our CI,
Before
After
(a,b,c all have operation weight 10)
Details
The existing
AsyncQueueManagerrequires theforEachAsyncimplementation to be reentrant and to have multiple waiting iterators. Moving to a weighted operation model requires theforEachAsyncto lock when pulling off an item from the iterator as we don't know the operation weight until after we pop the item. To correct this difference, I updatedAsyncQueueManagerto explicitly reassign operations when marking the operation as complete or after handling a remote executing operation.This may affect performance, but the critical zone that is now being locked should not affect performance. As seen in the graphs above, this does change the
REMOTE_EXECUTINGbehavior a bit.How it was tested
I tested this using the cobuilds build-tests sandbox repo and a bunch of console logs. I changed the operation weights to equal the
-pparameter which caused sequential timelines.I would appreciate additional testing/validation to make sure I'm on the right track 🙏
Impacted documentation