avoid redundant async in AsyncAPI (#7800)

SimonCropp · web-flow · commit e9d9201d463b · 2025-09-02T12:49:46.000+02:00
* avoid redundant async in AsyncAPI

* .

* .
diff --git a/samples/asyncapi/custom-message-types/Core_9/AsyncAPI.Feature/ApiDocumentGenerator.cs b/samples/asyncapi/custom-message-types/Core_9/AsyncAPI.Feature/ApiDocumentGenerator.cs
@@ -11,7 +11,7 @@ namespace AsyncAPI.Feature;
 
 public class ApiDocumentGenerator(IServiceProvider serviceProvider) : IAsyncApiDocumentGenerator
 {
-    public async Task<IEnumerable<IAsyncApiDocument>> GenerateAsync(IEnumerable<Type> markupTypes, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)
+    public Task<IEnumerable<IAsyncApiDocument>> GenerateAsync(IEnumerable<Type> markupTypes, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)
     {
         ArgumentNullException.ThrowIfNull(options);
 
@@ -21,14 +21,14 @@ public async Task<IEnumerable<IAsyncApiDocument>> GenerateAsync(IEnumerable<Type
         var document = serviceProvider.GetRequiredService<IV3AsyncApiDocumentBuilder>();
         options.V3BuilderSetup?.Invoke(document);
 
-        await GenerateChannels(document, options, cancellationToken);
+        GenerateChannels(document, options);
 
         documents.Add(document.Build());
 
-        return documents;
+        return Task.FromResult<IEnumerable<IAsyncApiDocument>>(documents);
     }
 
-    async Task GenerateChannels(IV3AsyncApiDocumentBuilder document, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)
+    void GenerateChannels(IV3AsyncApiDocumentBuilder document, AsyncApiDocumentGenerationOptions options)
     {
         ArgumentNullException.ThrowIfNull(document);
         ArgumentNullException.ThrowIfNull(options);
@@ -47,13 +47,13 @@ async Task GenerateChannels(IV3AsyncApiDocumentBuilder document, AsyncApiDocumen
                     .WithAddress(typeCache.EndpointName)
                     .WithDescription(actualType.FullName);
             });
-            await GenerateV3OperationForAsync(document, channelName, channelBuilder, actualType, publishedType, options, cancellationToken);
+            GenerateV3OperationFor(document, channelName, channelBuilder, actualType, publishedType, options);
         }
 
         //NOTE this is where more channels and operations can be defined, for example subscribed to events, sent/received commands and messages
     }
 
-    Task GenerateV3OperationForAsync(IV3AsyncApiDocumentBuilder document, string channelName, IV3ChannelDefinitionBuilder channel, Type actualType, Type producedType, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)
+    static void GenerateV3OperationFor(IV3AsyncApiDocumentBuilder document, string channelName, IV3ChannelDefinitionBuilder channel, Type actualType, Type producedType, AsyncApiDocumentGenerationOptions options)
     {
         ArgumentNullException.ThrowIfNull(document);
         ArgumentException.ThrowIfNullOrWhiteSpace(channelName);
@@ -83,6 +83,5 @@ Task GenerateV3OperationForAsync(IV3AsyncApiDocumentBuilder document, string cha
                 .WithChannel($"#/channels/{channelName}")
                 .WithMessage(messageChannelReference);
         });
-        return Task.CompletedTask;
     }
 }
diff --git a/samples/asyncapi/simple/Core_9/AsyncAPI.Feature/ApiDocumentGenerator.cs b/samples/asyncapi/simple/Core_9/AsyncAPI.Feature/ApiDocumentGenerator.cs
@@ -9,7 +9,7 @@
 
 class ApiDocumentGenerator(IServiceProvider serviceProvider) : IAsyncApiDocumentGenerator
 {
-    public async Task<IEnumerable<IAsyncApiDocument>> GenerateAsync(IEnumerable<Type> markupTypes, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)
+    public Task<IEnumerable<IAsyncApiDocument>> GenerateAsync(IEnumerable<Type> markupTypes, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)
     {
         ArgumentNullException.ThrowIfNull(options);
 
@@ -19,14 +19,14 @@ public async Task<IEnumerable<IAsyncApiDocument>> GenerateAsync(IEnumerable<Type
         var document = serviceProvider.GetRequiredService<IV3AsyncApiDocumentBuilder>();
         options.V3BuilderSetup?.Invoke(document);
 
-        await GenerateChannels(document, options, cancellationToken);
+        GenerateChannels(document, options);
 
         documents.Add(document.Build());
 
-        return documents;
+        return Task.FromResult<IEnumerable<IAsyncApiDocument>>(documents);
     }
 
-    async Task GenerateChannels(IV3AsyncApiDocumentBuilder document, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)
+    void GenerateChannels(IV3AsyncApiDocumentBuilder document, AsyncApiDocumentGenerationOptions options)
     {
         ArgumentNullException.ThrowIfNull(document);
         ArgumentNullException.ThrowIfNull(options);
@@ -46,20 +46,19 @@ async Task GenerateChannels(IV3AsyncApiDocumentBuilder document, AsyncApiDocumen
                     .WithAddress(typeCache.EndpointName)
                     .WithDescription(publishedEvent.FullName);
             });
-            await GenerateV3OperationForAsync(
+            GenerateV3OperationFor(
                 document,
                 channelName,
                 channelBuilder,
                 publishedEvent,
-                options,
-                cancellationToken);
+                options);
         }
         #endregion
 
         //NOTE this is where more channels and operations can be defined, for example subscribed to events, sent/received commands and messages
     }
 
-    Task GenerateV3OperationForAsync(IV3AsyncApiDocumentBuilder document, string channelName, IV3ChannelDefinitionBuilder channel, Type eventType, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)
+    static void GenerateV3OperationFor(IV3AsyncApiDocumentBuilder document, string channelName, IV3ChannelDefinitionBuilder channel, Type eventType, AsyncApiDocumentGenerationOptions options)
     {
         ArgumentNullException.ThrowIfNull(document);
         ArgumentException.ThrowIfNullOrWhiteSpace(channelName);
@@ -88,6 +87,5 @@ Task GenerateV3OperationForAsync(IV3AsyncApiDocumentBuilder document, string cha
                 .WithChannel($"#/channels/{channelName}")
                 .WithMessage(messageChannelReference);
         });
-        return Task.CompletedTask;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ namespace AsyncAPI.Feature;`
`11`	`11`
`12`	`12`	`public class ApiDocumentGenerator(IServiceProvider serviceProvider) : IAsyncApiDocumentGenerator`
`13`	`13`	`{`
`14`		`- public async Task<IEnumerable<IAsyncApiDocument>> GenerateAsync(IEnumerable<Type> markupTypes, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)`
	`14`	`+ public Task<IEnumerable<IAsyncApiDocument>> GenerateAsync(IEnumerable<Type> markupTypes, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)`
`15`	`15`	`{`
`16`	`16`	`ArgumentNullException.ThrowIfNull(options);`
`17`	`17`
`@@ -21,14 +21,14 @@ public async Task<IEnumerable<IAsyncApiDocument>> GenerateAsync(IEnumerable<Type`
`21`	`21`	`var document = serviceProvider.GetRequiredService<IV3AsyncApiDocumentBuilder>();`
`22`	`22`	`options.V3BuilderSetup?.Invoke(document);`
`23`	`23`
`24`		`- await GenerateChannels(document, options, cancellationToken);`
	`24`	`+ GenerateChannels(document, options);`
`25`	`25`
`26`	`26`	`documents.Add(document.Build());`
`27`	`27`
`28`		`- return documents;`
	`28`	`+ return Task.FromResult<IEnumerable<IAsyncApiDocument>>(documents);`
`29`	`29`	`}`
`30`	`30`
`31`		`- async Task GenerateChannels(IV3AsyncApiDocumentBuilder document, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)`
	`31`	`+ void GenerateChannels(IV3AsyncApiDocumentBuilder document, AsyncApiDocumentGenerationOptions options)`
`32`	`32`	`{`
`33`	`33`	`ArgumentNullException.ThrowIfNull(document);`
`34`	`34`	`ArgumentNullException.ThrowIfNull(options);`
`@@ -47,13 +47,13 @@ async Task GenerateChannels(IV3AsyncApiDocumentBuilder document, AsyncApiDocumen`
`47`	`47`	`.WithAddress(typeCache.EndpointName)`
`48`	`48`	`.WithDescription(actualType.FullName);`
`49`	`49`	`});`
`50`		`- await GenerateV3OperationForAsync(document, channelName, channelBuilder, actualType, publishedType, options, cancellationToken);`
	`50`	`+ GenerateV3OperationFor(document, channelName, channelBuilder, actualType, publishedType, options);`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`//NOTE this is where more channels and operations can be defined, for example subscribed to events, sent/received commands and messages`
`54`	`54`	`}`
`55`	`55`
`56`		`- Task GenerateV3OperationForAsync(IV3AsyncApiDocumentBuilder document, string channelName, IV3ChannelDefinitionBuilder channel, Type actualType, Type producedType, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)`
	`56`	`+ static void GenerateV3OperationFor(IV3AsyncApiDocumentBuilder document, string channelName, IV3ChannelDefinitionBuilder channel, Type actualType, Type producedType, AsyncApiDocumentGenerationOptions options)`
`57`	`57`	`{`
`58`	`58`	`ArgumentNullException.ThrowIfNull(document);`
`59`	`59`	`ArgumentException.ThrowIfNullOrWhiteSpace(channelName);`
`@@ -83,6 +83,5 @@ Task GenerateV3OperationForAsync(IV3AsyncApiDocumentBuilder document, string cha`
`83`	`83`	`.WithChannel($"#/channels/{channelName}")`
`84`	`84`	`.WithMessage(messageChannelReference);`
`85`	`85`	`});`
`86`		`- return Task.CompletedTask;`
`87`	`86`	`}`
`88`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`class ApiDocumentGenerator(IServiceProvider serviceProvider) : IAsyncApiDocumentGenerator`
`11`	`11`	`{`
`12`		`- public async Task<IEnumerable<IAsyncApiDocument>> GenerateAsync(IEnumerable<Type> markupTypes, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)`
	`12`	`+ public Task<IEnumerable<IAsyncApiDocument>> GenerateAsync(IEnumerable<Type> markupTypes, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)`
`13`	`13`	`{`
`14`	`14`	`ArgumentNullException.ThrowIfNull(options);`
`15`	`15`
`@@ -19,14 +19,14 @@ public async Task<IEnumerable<IAsyncApiDocument>> GenerateAsync(IEnumerable<Type`
`19`	`19`	`var document = serviceProvider.GetRequiredService<IV3AsyncApiDocumentBuilder>();`
`20`	`20`	`options.V3BuilderSetup?.Invoke(document);`
`21`	`21`
`22`		`- await GenerateChannels(document, options, cancellationToken);`
	`22`	`+ GenerateChannels(document, options);`
`23`	`23`
`24`	`24`	`documents.Add(document.Build());`
`25`	`25`
`26`		`- return documents;`
	`26`	`+ return Task.FromResult<IEnumerable<IAsyncApiDocument>>(documents);`
`27`	`27`	`}`
`28`	`28`
`29`		`- async Task GenerateChannels(IV3AsyncApiDocumentBuilder document, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)`
	`29`	`+ void GenerateChannels(IV3AsyncApiDocumentBuilder document, AsyncApiDocumentGenerationOptions options)`
`30`	`30`	`{`
`31`	`31`	`ArgumentNullException.ThrowIfNull(document);`
`32`	`32`	`ArgumentNullException.ThrowIfNull(options);`
`@@ -46,20 +46,19 @@ async Task GenerateChannels(IV3AsyncApiDocumentBuilder document, AsyncApiDocumen`
`46`	`46`	`.WithAddress(typeCache.EndpointName)`
`47`	`47`	`.WithDescription(publishedEvent.FullName);`
`48`	`48`	`});`
`49`		`- await GenerateV3OperationForAsync(`
	`49`	`+ GenerateV3OperationFor(`
`50`	`50`	`document,`
`51`	`51`	`channelName,`
`52`	`52`	`channelBuilder,`
`53`	`53`	`publishedEvent,`
`54`		`- options,`
`55`		`- cancellationToken);`
	`54`	`+ options);`
`56`	`55`	`}`
`57`	`56`	`#endregion`
`58`	`57`
`59`	`58`	`//NOTE this is where more channels and operations can be defined, for example subscribed to events, sent/received commands and messages`
`60`	`59`	`}`
`61`	`60`
`62`		`- Task GenerateV3OperationForAsync(IV3AsyncApiDocumentBuilder document, string channelName, IV3ChannelDefinitionBuilder channel, Type eventType, AsyncApiDocumentGenerationOptions options, CancellationToken cancellationToken = default)`
	`61`	`+ static void GenerateV3OperationFor(IV3AsyncApiDocumentBuilder document, string channelName, IV3ChannelDefinitionBuilder channel, Type eventType, AsyncApiDocumentGenerationOptions options)`
`63`	`62`	`{`
`64`	`63`	`ArgumentNullException.ThrowIfNull(document);`
`65`	`64`	`ArgumentException.ThrowIfNullOrWhiteSpace(channelName);`
`@@ -88,6 +87,5 @@ Task GenerateV3OperationForAsync(IV3AsyncApiDocumentBuilder document, string cha`
`88`	`87`	`.WithChannel($"#/channels/{channelName}")`
`89`	`88`	`.WithMessage(messageChannelReference);`
`90`	`89`	`});`
`91`		`- return Task.CompletedTask;`
`92`	`90`	`}`
`93`	`91`	`}`