refactor(general): avoid async method inside forEach (WIP)
#6264
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
This comment was marked as off-topic.
This comment was marked as off-topic.
Hweinstock
changed the title
forEachforEach
hayemaxi
reviewed
Dec 18, 2024
| { code: 'list.forEach(async (a) => await Promise.resolve(a * a))', errors: [errMsg] }, | ||
| { code: 'list.forEach(async (a: any) => console.log(x))', errors: [errMsg] }, | ||
| { code: 'list.forEach((a) => a.forEach(async (b) => a * b))', errors: [errMsg] }, | ||
| { code: 'list.forEach(async function () {})', errors: [errMsg] }, |
Contributor
There was a problem hiding this comment.
what about
const fn = async (item) => {}
list.forEach(fn)
Contributor
Author
There was a problem hiding this comment.
See recent commits, also added a few more edge cases.
Hweinstock
changed the title
forEachforEach (WIP)
justinmk3
reviewed
Dec 18, 2024
| 'aws-toolkits/no-console-log': 'error', | ||
| 'aws-toolkits/no-json-stringify-in-log': 'error', | ||
| 'aws-toolkits/no-printf-mismatch': 'error', | ||
| 'aws-toolkits/no-async-in-foreach': 'error', |
Contributor
There was a problem hiding this comment.
should we just ban forEach? it is kind of pointless.
Contributor
Author
There was a problem hiding this comment.
Yea, I think banning it out right has a few advantages. Additionally, determining if a function is async is definitely non-trivial. This work is moved to #6281
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Problem
usage of an async function inside a
forEach, which is almost always not desired.forEachwill not await the results leading to race conditions and inconsistent orderings.Solution
feature/xbranches will not be squash-merged at release time.License: I confirm that my contribution is made under the terms of the Apache 2.0 license.