Added Source Schema Settings to Hot Chocolate Core (#8510)

michaelstaib · web-flow · commit b6f951f84937 · 2025-08-08T15:03:39.000+02:00
diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/Command/ExportCommand.cs b/src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/Command/ExportCommand.cs
@@ -1,7 +1,9 @@
 using System.CommandLine;
 using System.Text;
+using System.Text.Json;
+using System.Text.Json.Nodes;
 using HotChocolate.Execution;
-using HotChocolate.Execution.Configuration;
+using HotChocolate.Execution.Internal;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 
@@ -46,31 +48,31 @@ private static async Task ExecuteAsync(
         {
             var schemaNames = provider.SchemaNames;
 
-            if(schemaNames.IsEmpty)
+            if (schemaNames.IsEmpty)
             {
                 console.WriteLine("No schemas registered.");
                 return;
             }
 
             schemaName = schemaNames.Contains(ISchemaDefinition.DefaultName)
                 ? ISchemaDefinition.DefaultName
-                : schemaNames[1];
+                : schemaNames[0];
         }
 
         var executor = await provider.GetExecutorAsync(schemaName, cancellationToken);
 
-        var sdl = executor.Schema.ToString();
-
         if (output is not null)
         {
-            await File.WriteAllTextAsync(
-                output.FullName,
-                sdl,
-                new UTF8Encoding(encoderShouldEmitUTF8Identifier: false, throwOnInvalidBytes: true),
-                cancellationToken);
+            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);
         }
     }
diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore.Pipeline/Extensions/EndpointRouteBuilderExtensions.cs b/src/HotChocolate/AspNetCore/src/AspNetCore.Pipeline/Extensions/EndpointRouteBuilderExtensions.cs
@@ -74,6 +74,8 @@ public static GraphQLEndpointConventionBuilder MapGraphQL(
     {
         ArgumentNullException.ThrowIfNull(endpointRouteBuilder);
 
+        TryResolveSchemaName(endpointRouteBuilder.ServiceProvider, ref schemaName);
+
         path = path.ToString().TrimEnd('/');
         var schemaNameOrDefault = schemaName ?? ISchemaDefinition.DefaultName;
         var pattern = Parse(path + "/{**slug}");
@@ -189,6 +191,8 @@ public static GraphQLHttpEndpointConventionBuilder MapGraphQLHttp(
         ArgumentNullException.ThrowIfNull(endpointRouteBuilder);
         ArgumentNullException.ThrowIfNull(pattern);
 
+        TryResolveSchemaName(endpointRouteBuilder.ServiceProvider, ref schemaName);
+
         var requestPipeline = endpointRouteBuilder.CreateApplicationBuilder();
         var schemaNameOrDefault = schemaName ?? ISchemaDefinition.DefaultName;
 
@@ -266,6 +270,8 @@ public static WebSocketEndpointConventionBuilder MapGraphQLWebSocket(
         ArgumentNullException.ThrowIfNull(endpointRouteBuilder);
         ArgumentNullException.ThrowIfNull(pattern);
 
+        TryResolveSchemaName(endpointRouteBuilder.ServiceProvider, ref schemaName);
+
         var requestPipeline = endpointRouteBuilder.CreateApplicationBuilder();
         var schemaNameOrDefault = schemaName ?? ISchemaDefinition.DefaultName;
 
@@ -342,6 +348,8 @@ public static IEndpointConventionBuilder MapGraphQLSchema(
         ArgumentNullException.ThrowIfNull(endpointRouteBuilder);
         ArgumentNullException.ThrowIfNull(pattern);
 
+        TryResolveSchemaName(endpointRouteBuilder.ServiceProvider, ref schemaName);
+
         var requestPipeline = endpointRouteBuilder.CreateApplicationBuilder();
         var schemaNameOrDefault = schemaName ?? ISchemaDefinition.DefaultName;
 
@@ -483,6 +491,8 @@ public static IEndpointConventionBuilder MapGraphQLPersistedOperations(
         ArgumentNullException.ThrowIfNull(endpointRouteBuilder);
         ArgumentNullException.ThrowIfNull(path);
 
+        TryResolveSchemaName(endpointRouteBuilder.ServiceProvider, ref schemaName);
+
         schemaName ??= ISchemaDefinition.DefaultName;
         var group = endpointRouteBuilder.MapGroup(path);
         group.MapPersistedOperationMiddleware(endpointRouteBuilder.ServiceProvider, schemaName, requireOperationName);
@@ -572,6 +582,16 @@ public static WebSocketEndpointConventionBuilder WithOptions(
         GraphQLSocketOptions socketOptions) =>
         builder.WithMetadata(new GraphQLServerOptions { Sockets = socketOptions });
 
+    private static void TryResolveSchemaName(IServiceProvider services, ref string? schemaName)
+    {
+        if (schemaName is null
+            && services.GetService<IRequestExecutorProvider>() is { } provider
+            && provider.SchemaNames.Length == 1)
+        {
+            schemaName = provider.SchemaNames[0];
+        }
+    }
+
     internal static NitroAppOptions ToNitroAppOptions(this GraphQLToolOptions options)
         => new()
         {
diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreServiceCollectionExtensions.Warmup.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/Extensions/HotChocolateAspNetCoreServiceCollectionExtensions.Warmup.cs
@@ -1,5 +1,6 @@
 using HotChocolate.AspNetCore.Warmup;
 using HotChocolate.Execution.Configuration;
+using HotChocolate.Execution.Internal;
 
 // ReSharper disable once CheckNamespace
 namespace Microsoft.Extensions.DependencyInjection;
@@ -26,7 +27,6 @@ public static partial class HotChocolateAspNetCoreServiceCollectionExtensions
     /// </exception>
     public static IRequestExecutorBuilder InitializeOnStartup(
         this IRequestExecutorBuilder builder,
-
         Func<IRequestExecutor, CancellationToken, Task>? warmup = null,
         bool keepWarm = false)
     {
@@ -36,4 +36,40 @@ public static IRequestExecutorBuilder InitializeOnStartup(
         builder.Services.AddSingleton(new WarmupSchemaTask(builder.Name, keepWarm, warmup));
         return builder;
     }
+
+    public static IRequestExecutorBuilder InitializeOnStartup(
+        this IRequestExecutorBuilder builder,
+        RequestExecutorInitializationOptions options)
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+
+        Func<IRequestExecutor, CancellationToken, Task>? warmup;
+
+        if (options.WriteSchemaFile.Enable)
+        {
+            var schemaFileName =
+                options.WriteSchemaFile.FileName
+                    ?? System.IO.Path.Combine(Environment.CurrentDirectory, "schema.graphqls");
+
+            if (options.Warmup is null)
+            {
+                warmup = async (executor, cancellationToken)
+                    => await SchemaFileExporter.Export(schemaFileName, executor, cancellationToken);
+            }
+            else
+            {
+                warmup = async (executor, cancellationToken) =>
+                {
+                    await SchemaFileExporter.Export(schemaFileName, executor, cancellationToken);
+                    await options.Warmup(executor, cancellationToken);
+                };
+            }
+        }
+        else
+        {
+            warmup = options.Warmup;
+        }
+
+        return InitializeOnStartup(builder, warmup, options.KeepWarm);
+    }
 }
diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/Warmup/RequestExecutorInitializationOptions.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/Warmup/RequestExecutorInitializationOptions.cs
@@ -0,0 +1,23 @@
+namespace Microsoft.Extensions.DependencyInjection;
+
+/// <summary>
+/// Represents the initialization options for a request executor.
+/// </summary>
+public struct RequestExecutorInitializationOptions
+{
+    /// <summary>
+    /// Gets or sets the warmup task that shall be executed on a new executor.
+    /// </summary>
+    public Func<IRequestExecutor, CancellationToken, Task>? Warmup { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether the warmup task shall be executed after eviction and
+    /// keep executor in-memory.
+    /// </summary>
+    public bool KeepWarm { get; set; }
+
+    /// <summary>
+    /// Gets or sets the schema file initialization options.
+    /// </summary>
+    public SchemaFileInitializationOptions WriteSchemaFile { get; set; }
+}
diff --git a/src/HotChocolate/AspNetCore/src/AspNetCore/Warmup/SchemaFileInitializationOptions.cs b/src/HotChocolate/AspNetCore/src/AspNetCore/Warmup/SchemaFileInitializationOptions.cs
@@ -0,0 +1,19 @@
+namespace Microsoft.Extensions.DependencyInjection;
+
+/// <summary>
+/// Represents the schema file initialization options.
+/// </summary>
+public struct SchemaFileInitializationOptions
+{
+    /// <summary>
+    /// Gets or sets a value indicating whether a schema file shall be written
+    /// to the file system every time the executor is initialized.
+    /// </summary>
+    public bool Enable { get; set; }
+
+    /// <summary>
+    /// Gets or sets the name of the schema file.
+    /// The default value is <c>"schema.graphqls"</c>.
+    /// </summary>
+    public string? FileName { get; set; }
+}
diff --git a/src/HotChocolate/AspNetCore/test/AspNetCore.CommandLine.Tests/SchemaExportCommandTests.cs b/src/HotChocolate/AspNetCore/test/AspNetCore.CommandLine.Tests/SchemaExportCommandTests.cs
@@ -7,8 +7,10 @@
 
 namespace HotChocolate.AspNetCore.CommandLine;
 
-public class SchemaExportCommandTests
+public class SchemaExportCommandTests : IDisposable
 {
+    private readonly List<string> _files = [];
+
     [Fact]
     public async Task App_Should_OutputCorrectHelpTest_When_HelpIsRequested()
     {
@@ -52,6 +54,7 @@ public async Task App_Should_PrintSchema_When_OutputNotSpecified()
     public async Task App_Should_WriteSchemaToFile_When_OutputOptionIsSpecified()
     {
         // arrange
+        var snapshot = new Snapshot();
         var services = new ServiceCollection();
         services.AddGraphQL()
             .AddQueryType(x => x.Name("Query").Field("foo").Resolve("bar"));
@@ -64,13 +67,15 @@ public async Task App_Should_WriteSchemaToFile_When_OutputOptionIsSpecified()
         var host = hostMock.Object;
         var console = new TestConsole();
         var app = new App(host).Build();
-        var tempFile = System.IO.Path.GetTempFileName();
+        var tempFile = CreateSchemaFileName();
 
         // act
         await app.InvokeAsync($"schema export --output {tempFile}", console);
 
         // assert
-        (await File.ReadAllTextAsync(tempFile)).MatchSnapshot();
+        snapshot.Add(await File.ReadAllTextAsync(tempFile + ".graphqls"), "Schema", markdownLanguage: "graphql");
+        snapshot.Add(await File.ReadAllTextAsync(tempFile + "-settings.json"), "Settings", markdownLanguage: "json");
+        await snapshot.MatchMarkdownAsync();
     }
 
     [Fact]
@@ -96,4 +101,35 @@ public async Task App_Should_WriteNamedSchemaToOutput_When_SchemaNameIsSpecified
         // assert
         console.Out.ToString().MatchSnapshot();
     }
+
+    public string CreateSchemaFileName()
+    {
+        var tempFile = System.IO.Path.GetTempFileName();
+        var schemaFile = tempFile + ".graphqls";
+        var settingsFile = tempFile + "-settings.json";
+        _files.Add(tempFile);
+        _files.Add(schemaFile);
+        _files.Add(settingsFile);
+        return tempFile;
+    }
+
+    public void Dispose()
+    {
+        foreach (var file in _files)
+        {
+            if (File.Exists(file))
+            {
+                try
+                {
+                    File.Delete(file);
+                }
+                catch
+                {
+                    // ignore
+                }
+            }
+        }
+
+        _files.Clear();
+    }
 }
diff --git a/src/HotChocolate/AspNetCore/test/AspNetCore.CommandLine.Tests/SchemaListCommandTests.cs b/src/HotChocolate/AspNetCore/test/AspNetCore.CommandLine.Tests/SchemaListCommandTests.cs
@@ -1,6 +1,6 @@
-using HotChocolate.Types;
 using System.CommandLine.IO;
 using System.CommandLine.Parsing;
+using HotChocolate.Types;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Moq;
@@ -14,7 +14,36 @@ public async Task App_Should_List_All_SchemaNames()
     {
         // arrange
         var services = new ServiceCollection();
-        services.AddGraphQL()
+        services
+            .AddGraphQL()
+            .AddQueryType(x => x.Name("Query").Field("foo").Resolve("bar"));
+
+        var hostMock = new Mock<IHost>();
+        hostMock
+            .Setup(x => x.Services)
+            .Returns(services.BuildServiceProvider());
+
+        var host = hostMock.Object;
+        var console = new TestConsole();
+        var app = new App(host).Build();
+
+        // act
+        await app.InvokeAsync("schema list", console);
+
+        // assert
+        console.Out.ToString().MatchSnapshot();
+    }
+
+    [Fact]
+    public async Task App_Should_List_All_SchemaNames_2()
+    {
+        // arrange
+        var services = new ServiceCollection();
+        services
+            .AddGraphQL("schema1")
+            .AddQueryType(x => x.Name("Query").Field("foo").Resolve("bar"))
+            .Services
+            .AddGraphQL("schema2")
             .AddQueryType(x => x.Name("Query").Field("foo").Resolve("bar"));
 
         var hostMock = new Mock<IHost>();
diff --git a/src/HotChocolate/AspNetCore/test/AspNetCore.CommandLine.Tests/__snapshots__/SchemaExportCommandTests.App_Should_WriteSchemaToFile_When_OutputOptionIsSpecified.snap b/src/HotChocolate/AspNetCore/test/AspNetCore.CommandLine.Tests/__snapshots__/SchemaExportCommandTests.App_Should_WriteSchemaToFile_When_OutputOptionIsSpecified.snap
diff --git a/src/HotChocolate/AspNetCore/test/AspNetCore.CommandLine.Tests/__snapshots__/SchemaListCommandTests.App_Should_List_All_SchemaNames_2.snap b/src/HotChocolate/AspNetCore/test/AspNetCore.CommandLine.Tests/__snapshots__/SchemaListCommandTests.App_Should_List_All_SchemaNames_2.snap
@@ -0,0 +1,2 @@
+schema1
+schema2
diff --git a/src/HotChocolate/Core/src/Execution/HotChocolate.Execution.csproj b/src/HotChocolate/Core/src/Execution/HotChocolate.Execution.csproj
@@ -13,6 +13,7 @@
   <ItemGroup>
     <InternalsVisibleTo Include="DynamicProxyGenAssembly2" />
     <InternalsVisibleTo Include="HotChocolate.AspNetCore" />
+    <InternalsVisibleTo Include="HotChocolate.AspNetCore.CommandLine" />
     <InternalsVisibleTo Include="HotChocolate.AspNetCore.Tests" />
     <InternalsVisibleTo Include="HotChocolate.AspNetCore.Tests.Utilities" />
     <InternalsVisibleTo Include="HotChocolate.Caching" />
diff --git a/src/HotChocolate/Core/src/Execution/Internal/SchemaFileExporter.cs b/src/HotChocolate/Core/src/Execution/Internal/SchemaFileExporter.cs
diff --git a/src/HotChocolate/Fusion-vnext/src/Fusion.Execution/Execution/Nodes/OperationExecutionNode.cs b/src/HotChocolate/Fusion-vnext/src/Fusion.Execution/Execution/Nodes/OperationExecutionNode.cs
diff --git a/src/HotChocolate/Fusion-vnext/src/Fusion.Utilities/Rewriters/MergeSelectionSetRewriter.cs b/src/HotChocolate/Fusion-vnext/src/Fusion.Utilities/Rewriters/MergeSelectionSetRewriter.cs

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`using System.CommandLine;`
`2`	`2`	`using System.Text;`
	`3`	`+using System.Text.Json;`
	`4`	`+using System.Text.Json.Nodes;`
`3`	`5`	`using HotChocolate.Execution;`
`4`		`-using HotChocolate.Execution.Configuration;`
	`6`	`+using HotChocolate.Execution.Internal;`
`5`	`7`	`using Microsoft.Extensions.DependencyInjection;`
`6`	`8`	`using Microsoft.Extensions.Hosting;`
`7`	`9`
`@@ -46,31 +48,31 @@ private static async Task ExecuteAsync(`
`46`	`48`	`{`
`47`	`49`	`var schemaNames = provider.SchemaNames;`
`48`	`50`
`49`		`- if(schemaNames.IsEmpty)`
	`51`	`+ if (schemaNames.IsEmpty)`
`50`	`52`	`{`
`51`	`53`	`console.WriteLine("No schemas registered.");`
`52`	`54`	`return;`
`53`	`55`	`}`
`54`	`56`
`55`	`57`	`schemaName = schemaNames.Contains(ISchemaDefinition.DefaultName)`
`56`	`58`	`? ISchemaDefinition.DefaultName`
`57`		`- : schemaNames[1];`
	`59`	`+ : schemaNames[0];`
`58`	`60`	`}`
`59`	`61`
`60`	`62`	`var executor = await provider.GetExecutorAsync(schemaName, cancellationToken);`
`61`	`63`
`62`		`- var sdl = executor.Schema.ToString();`
`63`		`-`
`64`	`64`	`if (output is not null)`
`65`	`65`	`{`
`66`		`- await File.WriteAllTextAsync(`
`67`		`- output.FullName,`
`68`		`- sdl,`
`69`		`- new UTF8Encoding(encoderShouldEmitUTF8Identifier: false, throwOnInvalidBytes: true),`
`70`		`- cancellationToken);`
	`66`	`+ var result = await SchemaFileExporter.Export(output.FullName, executor, cancellationToken);`
	`67`	`+ // ReSharper disable LocalizableElement`
	`68`	`+ console.WriteLine("Exported Files:");`
	`69`	`+ console.WriteLine($"- {result.SchemaFileName}");`
	`70`	`+ console.WriteLine($"- {result.SettingsFileName}");`
	`71`	`+ // ReSharper restore LocalizableElement`
`71`	`72`	`}`
`72`	`73`	`else`
`73`	`74`	`{`
	`75`	`+ var sdl = executor.Schema.ToString();`
`74`	`76`	`console.WriteLine(sdl);`
`75`	`77`	`}`
`76`	`78`	`}`