Return exit code from RunWithGraphQLCommands (#8772)

Author: tobias-tengler

src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/WebApplicationExtensions.cs

@@ -19,7 +19,7 @@ public static class HostBuilderExtensions
     /// </example>
     /// <param name="builder">The IHostBuilder instance</param>
     /// <param name="args">Command line arguments to be passed to the host </param>
-    public static async Task RunWithGraphQLCommandsAsync(
+    public static async Task<int> RunWithGraphQLCommandsAsync(
         this IHostBuilder builder,
         string[] args)
         => await builder.Build().RunWithGraphQLCommandsAsync(args);
@@ -35,7 +35,7 @@ public static async Task RunWithGraphQLCommandsAsync(
     /// </example>
     /// <param name="builder">The IHostBuilder instance</param>
     /// <param name="args">Command line arguments to be passed to the host </param>
-    public static void RunWithGraphQLCommands(
+    public static int RunWithGraphQLCommands(
         this IHostBuilder builder,
         string[] args)
         => builder.Build().RunWithGraphQLCommands(args);
@@ -57,13 +57,11 @@ public static async Task<int> RunWithGraphQLCommandsAsync(
     {
         if (args.IsGraphQLCommand())
         {
-            await new App(host).Build().InvokeAsync(args);
-        }
-        else
-        {
-            await host.RunAsync();
+            return await new App(host).Build().InvokeAsync(args);
         }
 
+        await host.RunAsync();
+
         return 0;
     }
 
@@ -78,18 +76,18 @@ public static async Task<int> RunWithGraphQLCommandsAsync(
     /// </example>
     /// <param name="host">The IHost instance</param>
     /// <param name="args">Command line arguments to be passed to the host </param>
-    public static void RunWithGraphQLCommands(
+    public static int RunWithGraphQLCommands(
         this IHost host,
         string[] args)
     {
         if (args.IsGraphQLCommand())
         {
-            new App(host).Build().Invoke(args);
-        }
-        else
-        {
-            host.Run();
+            return new App(host).Build().Invoke(args);
         }
+
+        host.Run();
+
+        return 0;
     }
 
     /// <summary>

src/HotChocolate/AspNetCore/test/AspNetCore.CommandLine.Tests/SchemaExportCommandTests.cs

@@ -117,6 +117,28 @@ public async Task App_Should_WriteNamedSchemaToOutput_When_SchemaNameIsSpecified
         console.Out.ToString().MatchSnapshot();
     }
 
+    [Fact]
+    public async Task App_Should_Return_ExitCode_1_If_Schema_Is_Invalid()
+    {
+        // arrange
+        var services = new ServiceCollection();
+        // We're intentionally no specifying any fields here to create an invalid schema.
+        services.AddGraphQL().AddQueryType();
+
+        var hostMock = new Mock<IHost>();
+        hostMock
+            .Setup(x => x.Services)
+            .Returns(services.BuildServiceProvider());
+
+        var host = hostMock.Object;
+
+        // act
+        var exitCode = await host.RunWithGraphQLCommandsAsync(["schema", "print"]);
+
+        // assert
+        Assert.Equal(1, exitCode);
+    }
+
     public string CreateSchemaFileName()
     {
         var tempFile = System.IO.Path.GetTempFileName();

website/src/docs/hotchocolate/v16/migrating/migrate-from-15-to-16.md

@@ -144,3 +144,18 @@ In addition, the default output for such errors has been standardized: earlier,
 # Deprecations
 
 Things that will continue to function this release, but we encourage you to move away from.
+
+# Noteworthy changes
+
+## RunWithGraphQLCommandsAsync returns exit code
+
+`RunWithGraphQLCommandsAsync` and `RunWithGraphQLCommands` now return exit codes (`Task<int>` and `int` respectively, instead of `Task` and `void`).
+
+We recommend updating your `Program.cs` to return this exit code. This ensures that command failures signal an error to shell scripts, CI/CD pipelines, and other tools:
+
+```diff
+var app = builder.Build();
+
+- await app.RunWithGraphQLCommandsAsync(args);
++ return await app.RunWithGraphQLCommandsAsync(args);
+```