Added schema-settings refinements (#8511)

Author: michaelstaib

src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/Command/ExportCommand.cs

@@ -19,9 +19,7 @@ internal sealed class ExportCommand : Command
     /// </summary>
     public ExportCommand() : base("export")
     {
-        Description =
-            "Export the graphql schema. If no output (--output) is specified the schema will be "
-            + "printed to the console.";
+        Description = "Export the graphql schema to a schema file";
 
         AddOption(Opt<OutputOption>.Instance);
         AddOption(Opt<SchemaNameOption>.Instance);
@@ -60,20 +58,13 @@ private static async Task ExecuteAsync(
         }
 
         var executor = await provider.GetExecutorAsync(schemaName, cancellationToken);
+        output ??= new FileInfo(System.IO.Path.Combine(Environment.CurrentDirectory, "schema.graphqls"));
+        var result = await SchemaFileExporter.Export(output.FullName, executor, cancellationToken);
 
-        if (output is not null)
-        {
-            var result = await SchemaFileExporter.Export(output.FullName, executor, cancellationToken);
-            // ReSharper disable LocalizableElement
-            console.WriteLine("Exported Files:");
-            console.WriteLine($"- {result.SchemaFileName}");
-            console.WriteLine($"- {result.SettingsFileName}");
-            // ReSharper restore LocalizableElement
-        }
-        else
-        {
-            var sdl = executor.Schema.ToString();
-            console.WriteLine(sdl);
-        }
+        // ReSharper disable LocalizableElement
+        console.WriteLine("Exported Files:");
+        console.WriteLine($"- {result.SchemaFileName}");
+        console.WriteLine($"- {result.SettingsFileName}");
+        // ReSharper restore LocalizableElement
     }
 }

src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/Command/PrintCommand.cs

@@ -0,0 +1,60 @@
+using System.CommandLine;
+using System.Text;
+using System.Text.Json;
+using System.Text.Json.Nodes;
+using HotChocolate.Execution;
+using HotChocolate.Execution.Internal;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+
+namespace HotChocolate.AspNetCore.CommandLine;
+
+/// <summary>
+/// The print command can be used to print the schema to the console output
+/// </summary>
+internal sealed class PrintCommand : Command
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ExportCommand"/> class.
+    /// </summary>
+    public PrintCommand() : base("print")
+    {
+        Description = "Prints the graphql schema to the console output";
+
+        AddOption(Opt<SchemaNameOption>.Instance);
+
+        this.SetHandler(
+            ExecuteAsync,
+            Bind.FromServiceProvider<IConsole>(),
+            Bind.FromServiceProvider<IHost>(),
+            Opt<SchemaNameOption>.Instance,
+            Bind.FromServiceProvider<CancellationToken>());
+    }
+
+    private static async Task ExecuteAsync(
+        IConsole console,
+        IHost host,
+        string? schemaName,
+        CancellationToken cancellationToken)
+    {
+        var provider = host.Services.GetRequiredService<IRequestExecutorProvider>();
+
+        if (schemaName is null)
+        {
+            var schemaNames = provider.SchemaNames;
+
+            if (schemaNames.IsEmpty)
+            {
+                console.WriteLine("No schemas registered.");
+                return;
+            }
+
+            schemaName = schemaNames.Contains(ISchemaDefinition.DefaultName)
+                ? ISchemaDefinition.DefaultName
+                : schemaNames[0];
+        }
+
+        var executor = await provider.GetExecutorAsync(schemaName, cancellationToken);
+        console.WriteLine(executor.Schema.ToString());
+    }
+}

src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/Command/SchemaCommand.cs

@@ -15,6 +15,7 @@ public SchemaCommand() : base("schema")
         Description = "Schema management commands.";
 
         AddCommand(new ExportCommand());
+        AddCommand(new PrintCommand());
         AddCommand(new ListCommand());
     }
 }

src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreServiceCollectionExtensions.Warmup.cs

@@ -37,6 +37,21 @@ public static IRequestExecutorBuilder InitializeOnStartup(
         return builder;
     }
 
+    /// <summary>
+    /// Adds the current GraphQL configuration to the warmup background service.
+    /// </summary>
+    /// <param name="builder">
+    /// The <see cref="IRequestExecutorBuilder"/>.
+    /// </param>
+    /// <param name="options">
+    /// The <see cref="RequestExecutorInitializationOptions"/>.
+    /// </param>
+    /// <returns>
+    /// Returns the <see cref="IRequestExecutorBuilder"/> so that configuration can be chained.
+    /// </returns>
+    /// <exception cref="ArgumentNullException">
+    /// The <see cref="IRequestExecutorBuilder"/> is <c>null</c>.
+    /// </exception>
     public static IRequestExecutorBuilder InitializeOnStartup(
         this IRequestExecutorBuilder builder,
         RequestExecutorInitializationOptions options)
@@ -72,4 +87,36 @@ public static IRequestExecutorBuilder InitializeOnStartup(
 
         return InitializeOnStartup(builder, warmup, options.KeepWarm);
     }
+
+    /// <summary>
+    /// Exports the GraphQL schema to a file on startup or when the schema changes.
+    /// </summary>
+    /// <param name="builder">
+    /// The <see cref="IRequestExecutorBuilder"/>.
+    /// </param>
+    /// <param name="schemaFileName">
+    /// The file name of the schema file.
+    /// </param>
+    /// <returns>
+    /// Returns the <see cref="IRequestExecutorBuilder"/> so that configuration can be chained.
+    /// </returns>
+    /// <exception cref="ArgumentNullException">
+    /// The <see cref="IRequestExecutorBuilder"/> is <c>null</c>.
+    /// </exception>
+    public static IRequestExecutorBuilder ExportSchemaOnStartup(
+        this IRequestExecutorBuilder builder,
+        string? schemaFileName = null)
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+
+        return InitializeOnStartup(builder, new RequestExecutorInitializationOptions
+        {
+            KeepWarm = true,
+            WriteSchemaFile = new SchemaFileInitializationOptions
+            {
+                Enable = true,
+                FileName = schemaFileName
+            }
+        });
+    }
 }

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

@@ -26,6 +26,21 @@ public async Task App_Should_OutputCorrectHelpTest_When_HelpIsRequested()
         console.Out.ToString().MatchSnapshot();
     }
 
+    [Fact]
+    public async Task App_Should_OutputCorrectHelpTest_When_Print_HelpIsRequested()
+    {
+        // arrange
+        var host = new Mock<IHost>().Object;
+        var console = new TestConsole();
+        var app = new App(host).Build();
+
+        // act
+        await app.InvokeAsync("schema print -h", console);
+
+        // assert
+        console.Out.ToString().MatchSnapshot();
+    }
+
     [Fact]
     public async Task App_Should_PrintSchema_When_OutputNotSpecified()
     {
@@ -44,7 +59,7 @@ public async Task App_Should_PrintSchema_When_OutputNotSpecified()
         var app = new App(host).Build();
 
         // act
-        await app.InvokeAsync("schema export", console);
+        await app.InvokeAsync("schema print", console);
 
         // assert
         console.Out.ToString().MatchSnapshot();
@@ -96,7 +111,7 @@ public async Task App_Should_WriteNamedSchemaToOutput_When_SchemaNameIsSpecified
         var app = new App(host).Build();
 
         // act
-        await app.InvokeAsync("schema export --schema-name Foo", console);
+        await app.InvokeAsync("schema print --schema-name Foo", console);
 
         // assert
         console.Out.ToString().MatchSnapshot();

src/HotChocolate/AspNetCore/test/AspNetCore.CommandLine.Tests/__snapshots__/SchemaCommandTests.App_Should_OutputCorrectHelpTest_When_HelpIsRequested.snap

@@ -8,6 +8,7 @@ Options:
   -?, -h, --help  Show help and usage information
 
 Commands:
-  export  Export the graphql schema. If no output (--output) is specified the schema will be printed to the console.
+  export  Export the graphql schema to a schema file
+  print   Prints the graphql schema to the console output
   list    List all registered GraphQL schemas.
 

src/HotChocolate/AspNetCore/test/AspNetCore.CommandLine.Tests/__snapshots__/SchemaExportCommandTests.App_Should_OutputCorrectHelpTest_When_HelpIsRequested.snap

@@ -1,5 +1,5 @@
 Description:
-  Export the graphql schema. If no output (--output) is specified the schema will be printed to the console.
+  Export the graphql schema to a schema file
 
 Usage:
   graphql schema export [options]

src/HotChocolate/AspNetCore/test/AspNetCore.CommandLine.Tests/__snapshots__/SchemaExportCommandTests.App_Should_OutputCorrectHelpTest_When_Print_HelpIsRequested.snap

@@ -0,0 +1,11 @@
+Description:
+  Prints the graphql schema to the console output
+
+Usage:
+  graphql schema print [options]
+
+Options:
+  --schema-name <schema-name>  The name of the schema that should be exported. If no schema name is specified the default schema will be exported.
+  -?, -h, --help               Show help and usage information
+
+

src/HotChocolate/AspNetCore/test/AspNetCore.CommandLine.Tests/__snapshots__/SchemaExportCommandTests.App_Should_WriteSchemaToFile_When_OutputOptionIsSpecified.md

@@ -0,0 +1,27 @@
+# App_Should_WriteSchemaToFile_When_OutputOptionIsSpecified
+
+## Schema
+
+```graphql
+schema {
+  query: Query
+}
+
+type Query {
+  foo: String
+}
+```
+
+## Settings
+
+```json
+{
+  "name": "_Default",
+  "transports": {
+    "http": {
+      "url": "http://localhost:5000/graphql"
+    }
+  }
+}
+```
+