Rm "async" anywhere from IAsyncEnumerable & methods returning it #905
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
JeffAshton
reviewed
Aug 3, 2023
tests/D2L.CodeStyle.Analyzers.Test/Async/Generator/AsyncToSyncMethodTransformerTests.cs
Show resolved
Hide resolved
JeffAshton
reviewed
Aug 3, 2023
src/D2L.CodeStyle.Analyzers/Async/Generator/AsyncToSyncMethodTransformer.cs
Outdated
Show resolved
Hide resolved
JeffAshton
reviewed
Aug 3, 2023
src/D2L.CodeStyle.Analyzers/Async/Generator/AsyncToSyncMethodTransformer.cs
Outdated
Show resolved
Hide resolved
JeffAshton
reviewed
Aug 4, 2023
src/D2L.CodeStyle.Analyzers/Async/Generator/AsyncToSyncMethodTransformer.cs
Outdated
Show resolved
Hide resolved
JeffAshton
reviewed
Aug 4, 2023
tests/D2L.CodeStyle.Analyzers.Test/Async/Generator/AsyncToSyncMethodTransformerTests.cs
Outdated
Show resolved
Hide resolved
Co-authored-by: Jeff Ashton <[email protected]>
…Brightspace/D2L.CodeStyle into anacoda/handle-iasyncenumerable
j3parker
reviewed
Aug 9, 2023
src/D2L.CodeStyle.Analyzers/Async/Generator/AsyncToSyncMethodTransformer.cs
Outdated
Show resolved
Hide resolved
j3parker
reviewed
Aug 9, 2023
| @@ -73,6 +75,13 @@ AttributeSyntax attribute | |||
| ); | |||
|
|
|||
| private SyntaxToken RemoveAsyncSuffix( SyntaxToken ident, bool optional = false ) { | |||
| if( m_removeAsyncAnywhere && ident.ValueText.Contains( "Async" ) ) { | |||
There was a problem hiding this comment.
I don't think so, because there are cases where a function may return IAsyncEnumerable and not end in Async and we want the sync generator to transform it without a diagnostic
j3parker
reviewed
Aug 9, 2023
src/D2L.CodeStyle.Analyzers/Async/Generator/AsyncToSyncMethodTransformer.cs
Show resolved
Hide resolved
j3parker
reviewed
Aug 9, 2023
src/D2L.CodeStyle.Analyzers/Async/Generator/AsyncToSyncMethodTransformer.cs
Outdated
Show resolved
Hide resolved
j3parker
approved these changes
Aug 9, 2023
AnaCoda
changed the title
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.
TA177961
Motivation is that the sync generator currently can't convert IAsyncEnumerable and most related functions because the Async keyword isn't at the end, for example here:
https://github.com/Brightspace/lms/blob/c4f2338b4d7f6b582b8c56ac959fd953f0846ec3/lp/framework/core/D2L.LP/LP/Security/OAuth2/AccessTokens/Keys/MsSqlKeyDataProvider.cs#L63
In general, there is no clear naming convention for methods that return IAsyncEnumerable except for adding the keyword async somewhere: https://stackoverflow.com/questions/59439281/is-there-a-definitive-naming-convention-for-methods-returning-iasyncenumerable/59452285#59452285
So for converting these we will change all variables/return types defined IAsyncEnumerable to IEnumerable, as well as removing "async" from any method that returns an IAsyncEnumerable.
I also had to make new test methods for this because we needed another method in the class that returns an IAsyncEnumerable