Ensure Fusion by default has a single client config. (#6370)

Author: michaelstaib

.build/Build.Environment.cs

@@ -32,4 +32,5 @@ partial class Build
     AbsolutePath EmptyAzf12Proj => RootDirectory / "templates" / "v12" / "function" / "HotChocolate.Template.AzureFunctions.csproj";
     AbsolutePath EmptyAzfUp12Proj => RootDirectory / "templates" / "v12" / "function-isolated" / "HotChocolate.Template.AzureFunctions.Isolated.csproj";
     AbsolutePath Gateway13Proj => RootDirectory / "templates" / "v12" / "gateway" / "HotChocolate.Template.Gateway.csproj";
+    AbsolutePath GatewayManaged13Proj => RootDirectory / "templates" / "v12" / "gateway-bcp" / "HotChocolate.Template.Gateway.csproj";
 }

src/HotChocolate/Fusion/src/Abstractions/FusionGraphPackage.cs

@@ -5,6 +5,7 @@
 using System.Text.Json;
 using HotChocolate.Fusion.Composition;
 using HotChocolate.Language;
+using HotChocolate.Language.Utilities;
 using static HotChocolate.Fusion.FusionAbstractionResources;
 using static HotChocolate.Fusion.FusionGraphPackageConstants;
 using static HotChocolate.Language.Utf8GraphQLParser;
@@ -23,6 +24,13 @@ namespace HotChocolate.Fusion;
 /// </summary>
 public sealed class FusionGraphPackage : IDisposable, IAsyncDisposable
 {
+    private static readonly SyntaxSerializerOptions _syntaxSerializerOptions =
+        new()
+        {
+            Indented = true, 
+            MaxDirectivesPerLine = 0
+        };
+
     private readonly Package _package;
 
     private FusionGraphPackage(Package package)
@@ -205,7 +213,7 @@ public Task<JsonDocument> GetFusionGraphSettingsAsync(
         var part = _package.GetPart(relationship.TargetUri);
         return ReadJsonPartAsync(part, cancellationToken);
     }
-    
+
     public Task SetFusionGraphSettingsAsync(
         JsonDocument document,
         CancellationToken cancellationToken = default)
@@ -467,7 +475,7 @@ private async Task WriteSchemaPartAsync(
         var part = _package.CreatePart(uri, SchemaMediaType);
 
         await using var stream = part.GetStream(FileMode.Create);
-        var sourceText = Encoding.UTF8.GetBytes(document.ToString(true));
+        var sourceText = Encoding.UTF8.GetBytes(document.ToString(_syntaxSerializerOptions));
         await stream.WriteAsync(sourceText, ct);
 
         _package.CreateRelationship(part.Uri, TargetMode.Internal, relKind, relId);
@@ -493,7 +501,7 @@ private async Task WriteJsonPartAsync(
         var uri = PackUriHelper.CreatePartUri(new Uri(fileName, UriKind.Relative));
         var part = _package.CreatePart(uri, JsonMediaType);
 
-        var options = new JsonWriterOptions { Indented = true, MaxDepth = 16 }; 
+        var options = new JsonWriterOptions { Indented = true, MaxDepth = 16 };
         await using var stream = part.GetStream(FileMode.Create);
         await using var writer = new Utf8JsonWriter(stream, options);
         document.WriteTo(writer);
@@ -514,7 +522,7 @@ private async Task<SubgraphConfiguration> ReadSubgraphConfigurationAsync(
         return new SubgraphConfiguration(
             config.Name,
             schema.ToString(true),
-            extensions.Select(t => t.ToString(true)).ToArray(),
+            extensions.Select(t => t.ToString(_syntaxSerializerOptions)).ToArray(),
             config.Clients);
     }
 
@@ -595,7 +603,7 @@ private async Task WriteSubgraphSchemaPartAsync(
         var part = _package.CreatePart(uri, SchemaMediaType);
 
         await using var stream = part.GetStream(FileMode.Create);
-        var sourceText = Encoding.UTF8.GetBytes(document.ToString(true));
+        var sourceText = Encoding.UTF8.GetBytes(document.ToString(_syntaxSerializerOptions));
         await stream.WriteAsync(sourceText, ct);
 
         root.CreateRelationship(part.Uri, TargetMode.Internal, SchemaKind, SchemaId);
@@ -615,7 +623,7 @@ private async Task WriteSubgraphExtensionPartsAsync(
             var part = _package.CreatePart(uri, SchemaMediaType);
 
             await using var stream = part.GetStream(FileMode.Create);
-            var sourceText = Encoding.UTF8.GetBytes(extension.ToString(true));
+            var sourceText = Encoding.UTF8.GetBytes(extension.ToString(_syntaxSerializerOptions));
             await stream.WriteAsync(sourceText, ct);
 
             root.CreateRelationship(part.Uri, TargetMode.Internal, ExtensionKind);

src/HotChocolate/Fusion/src/CommandLine/Commands/ComposeCommand.cs

@@ -207,6 +207,11 @@ private static FusionFeatureCollection CreateFeatures(
     {
         var features = new List<IFusionFeature>();
 
+        features.Add(new TransportFeature
+        {
+            DefaultClientName = settings.Transport.DefaultClientName
+        });
+
         if (settings.NodeField.Enabled)
         {
             features.Add(FusionFeatures.NodeField);
@@ -266,6 +271,7 @@ private class PackageSettings
         private Feature? _reEncodeIds;
         private Feature? _nodeField;
         private TagDirective? _tagDirective;
+        private Transport? _transport;
 
         [JsonPropertyName("fusionTypePrefix")]
         [JsonPropertyOrder(10)]
@@ -275,6 +281,12 @@ private class PackageSettings
         [JsonPropertyOrder(11)]
         public bool FusionTypeSelf { get; set; }
 
+        public Transport Transport
+        {
+            get => _transport ??= new();
+            set => _transport = value;
+        }
+
         [JsonPropertyName("nodeField")]
         [JsonPropertyOrder(12)]
         public Feature NodeField
@@ -323,4 +335,11 @@ public string[] Exclude
             set => _exclude = value;
         }
     }
+
+    public sealed class Transport
+    {
+        [JsonPropertyName("defaultClientName")]
+        [JsonPropertyOrder(10)]
+        public string? DefaultClientName { get; set; } = "Fusion";
+    }
 }

src/HotChocolate/Fusion/src/CommandLine/Helpers/PackageHelper.cs

@@ -5,6 +5,7 @@
 using System.Text.Json;
 using HotChocolate.Fusion.Composition;
 using HotChocolate.Language;
+using HotChocolate.Language.Utilities;
 using static System.IO.Packaging.PackUriHelper;
 using static System.IO.Path;
 using static System.UriKind;
@@ -18,6 +19,13 @@ internal static class PackageHelper
     private const string _schemaExtensionKind = "urn:graphql:schema-extensions";
     private const string _subgraphConfigKind = "urn:hotchocolate:fusion:subgraph-config";
     private const string _subgraphConfigId = "subgraph-config";
+    
+    private static readonly SyntaxSerializerOptions _serializerOptions =
+        new()
+        {
+            Indented = true, 
+            MaxDirectivesPerLine = 0
+        };
 
     public static async Task CreateSubgraphPackageAsync(
         string packageFile,
@@ -98,8 +106,8 @@ public static async Task<SubgraphConfiguration> ReadSubgraphPackageAsync(
 
         return new SubgraphConfiguration(
             subgraphConfig.Name,
-            schema.ToString(true),
-            extensions.Select(t => t.ToString(true)).ToArray(),
+            schema.ToString(_serializerOptions),
+            extensions.Select(t => t.ToString(_serializerOptions)).ToArray(),
             subgraphConfig.Clients);
     }
 
@@ -281,7 +289,7 @@ private static async Task AddSchemaToPackageAsync(
 
         await using var stream = part.GetStream(FileMode.Create);
         await using var writer = new StreamWriter(stream, Encoding.UTF8);
-        await writer.WriteAsync(schema.ToString(true));
+        await writer.WriteAsync(schema.ToString(_serializerOptions));
 
         package.CreateRelationship(part.Uri, TargetMode.Internal, _schemaKind, _schemaId);
     }
@@ -311,7 +319,7 @@ private static async Task AddSchemaExtensionsToPackage(
 
             await using var stream = part.GetStream(FileMode.Create);
             await using var writer = new StreamWriter(stream, Encoding.UTF8);
-            await writer.WriteAsync(extension.ToString(true));
+            await writer.WriteAsync(extension.ToString(_serializerOptions));
 
             package.CreateRelationship(part.Uri, TargetMode.Internal, _schemaExtensionKind);
         }

src/HotChocolate/Fusion/src/Composition/Features/FusionFeatureCollectionExtensions.cs

@@ -45,4 +45,19 @@ public static IReadOnlySet<string> GetExcludedTags(this FusionFeatureCollection
         => features.TryGetFeature<TagDirectiveFeature>(out var feature)
             ? feature.Excluded
             : _empty;
+    
+    /// <summary>
+    /// Gets the default client configuration name that shall be used for
+    /// transport clients if no client name was specified.
+    /// </summary>
+    /// <param name="features">
+    /// The feature collection.
+    /// </param>
+    /// <returns>
+    /// The default client configuration name.
+    /// </returns>
+    public static string? GetDefaultClientName(this FusionFeatureCollection features)
+        => features.TryGetFeature<TransportFeature>(out var feature)
+            ? feature.DefaultClientName
+            : null;
 }

src/HotChocolate/Fusion/src/Composition/Features/TransportFeature.cs

@@ -0,0 +1,13 @@
+namespace HotChocolate.Fusion.Composition.Features;
+
+/// <summary>
+/// Specifies transport defaults for the fusion graph.
+/// </summary>
+public sealed class TransportFeature : IFusionFeature
+{
+    /// <summary>
+    /// Gets or sets the default client name that is used
+    /// when no explicit client name was specified for a subgraph.
+    /// </summary>
+    public string? DefaultClientName { get; set; } = "Fusion";
+}

src/HotChocolate/Fusion/src/Composition/FusionTypes.cs

@@ -310,11 +310,17 @@ private DirectiveType RegisterNodeDirectiveType(string name, ScalarType typeName
         return directiveType;
     }
 
-    public Directive CreateHttpDirective(string subgraphName, Uri baseAddress)
-        => new Directive(
-            HttpClient,
-            new Argument(SubgraphArg, subgraphName),
-            new Argument(BaseAddressArg, baseAddress.ToString()));
+    public Directive CreateHttpDirective(string subgraphName, string? clientName, Uri baseAddress)
+        =>  clientName is null 
+            ? new Directive(
+                HttpClient,
+                new Argument(SubgraphArg, subgraphName),
+                new Argument(BaseAddressArg, baseAddress.ToString()))
+            : new Directive(
+                HttpClient,
+                new Argument(SubgraphArg, subgraphName),
+                new Argument(ClientNameArg, clientName),
+                new Argument(BaseAddressArg, baseAddress.ToString()));
 
     private DirectiveType RegisterHttpDirectiveType(
         string name,
@@ -324,17 +330,24 @@ private DirectiveType RegisterHttpDirectiveType(
         var directiveType = new DirectiveType(name);
         directiveType.Locations = DirectiveLocation.FieldDefinition;
         directiveType.Arguments.Add(new InputField(SubgraphArg, new NonNullType(typeName)));
+        directiveType.Arguments.Add(new InputField(ClientNameArg, typeName));
         directiveType.Arguments.Add(new InputField(BaseAddressArg, uri));
         directiveType.ContextData.Add(WellKnownContextData.IsFusionType, true);
         _fusionGraph.DirectiveTypes.Add(directiveType);
         return directiveType;
     }
 
-    public Directive CreateWebSocketDirective(string subgraphName, Uri baseAddress)
-        => new Directive(
-            WebSocketClient,
-            new Argument(SubgraphArg, subgraphName),
-            new Argument(BaseAddressArg, baseAddress.ToString()));
+    public Directive CreateWebSocketDirective(string subgraphName, string? clientName, Uri baseAddress)
+        =>  clientName is null 
+            ? new Directive(
+                WebSocketClient,
+                new Argument(SubgraphArg, subgraphName),
+                new Argument(BaseAddressArg, baseAddress.ToString()))
+            : new Directive(
+                WebSocketClient,
+                new Argument(SubgraphArg, subgraphName),
+                new Argument(ClientNameArg, clientName),
+                new Argument(BaseAddressArg, baseAddress.ToString()));
 
     private DirectiveType RegisterWebSocketDirectiveType(
         string name,
@@ -344,6 +357,7 @@ private DirectiveType RegisterWebSocketDirectiveType(
         var directiveType = new DirectiveType(name);
         directiveType.Locations = DirectiveLocation.FieldDefinition;
         directiveType.Arguments.Add(new InputField(SubgraphArg, new NonNullType(typeName)));
+        directiveType.Arguments.Add(new InputField(ClientNameArg, typeName));
         directiveType.Arguments.Add(new InputField(BaseAddressArg, uri));
         directiveType.ContextData.Add(WellKnownContextData.IsFusionType, true);
         _fusionGraph.DirectiveTypes.Add(directiveType);
@@ -383,4 +397,4 @@ private DirectiveType RegisterFusionDirectiveType(
 
         return directiveType;
     }
-}
+}

src/HotChocolate/Fusion/src/Composition/Pipeline/RegisterClientsMiddleware.cs

@@ -1,3 +1,5 @@
+using HotChocolate.Fusion.Composition.Features;
+
 namespace HotChocolate.Fusion.Composition.Pipeline;
 
 /// <summary>
@@ -8,6 +10,8 @@ internal sealed class RegisterClientsMiddleware : IMergeMiddleware
     /// <inheritdoc />
     public async ValueTask InvokeAsync(CompositionContext context, MergeDelegate next)
     {
+        var defaultClientName = context.Features.GetDefaultClientName();
+        
         foreach (var configuration in context.Configurations)
         {
             foreach (var client in configuration.Clients)
@@ -18,13 +22,15 @@ public async ValueTask InvokeAsync(CompositionContext context, MergeDelegate nex
                         context.FusionGraph.Directives.Add(
                             context.FusionTypes.CreateHttpDirective(
                                 configuration.Name,
+                                httpClient.ClientName ?? defaultClientName,
                                 httpClient.BaseAddress));
                         break;
 
                     case WebSocketClientConfiguration webSocketClient:
                         context.FusionGraph.Directives.Add(
                             context.FusionTypes.CreateWebSocketDirective(
                                 configuration.Name,
+                                webSocketClient.ClientName ?? defaultClientName,
                                 webSocketClient.BaseAddress));
                         break;
 

src/HotChocolate/Fusion/src/Core/Metadata/FusionGraphConfigurationReader.cs

@@ -2,6 +2,7 @@
 using HotChocolate.Language.Visitors;
 using HotChocolate.Types.Introspection;
 using HotChocolate.Utilities;
+using Microsoft.Extensions.DependencyInjection;
 using static HotChocolate.Fusion.FusionDirectiveArgumentNames;
 using static HotChocolate.Fusion.FusionResources;
 using static HotChocolate.Fusion.ThrowHelper;

src/HotChocolate/Fusion/test/CommandLine.Tests/__snapshots__/ComposeCommandTests.Compose_Fusion_Graph.snap

@@ -45,7 +45,7 @@ scalar DateTime
 
 Fusion Graph Document
 ---------------
-schema @fusion(version: 1) @httpClient(subgraph: "Accounts", baseAddress: "http:\/\/localhost:5000\/graphql") @webSocketClient(subgraph: "Accounts", baseAddress: "ws:\/\/localhost:5000\/graphql") {
+schema @fusion(version: 1) @httpClient(subgraph: "Accounts", clientName: "Fusion", baseAddress: "http:\/\/localhost:5000\/graphql") @webSocketClient(subgraph: "Accounts", clientName: "Fusion", baseAddress: "ws:\/\/localhost:5000\/graphql") {
   query: Query
   mutation: Mutation
 }
@@ -94,7 +94,7 @@ Accounts Subgraph Configuration
   "Name": "Accounts",
   "Schema": "schema {\n  query: Query\n  mutation: Mutation\n}\n\n\"The node interface is implemented by entities that have a global unique identifier.\"\ninterface Node {\n  id: ID!\n}\n\ntype Query {\n  \"Fetches an object given its ID.\"\n  node(\"ID of the object.\" id: ID!): Node\n  \"Lookup nodes by a list of IDs.\"\n  nodes(\"The list of node IDs.\" ids: [ID!]!): [Node]!\n  users: [User!]!\n  userById(id: ID!): User\n  usersById(ids: [ID!]!): [User!]!\n}\n\ntype Mutation {\n  addUser(input: AddUserInput!): AddUserPayload!\n}\n\ntype User implements Node {\n  id: ID!\n  name: String!\n  birthdate: Date!\n  username: String!\n}\n\n\"The `DateTime` scalar represents an ISO-8601 compliant date time type.\"\nscalar DateTime\n\n\"The `Date` scalar represents an ISO-8601 compliant date type.\"\nscalar Date\n\ninput AddUserInput {\n  name: String!\n  username: String!\n  birthdate: DateTime!\n}\n\ntype AddUserPayload {\n  user: User\n}",
   "Extensions": [
-    "extend type Query {\n  userById(id: ID! @is(field: \"id\")): User!\n  usersById(ids: [ID!]! @is(field: \"id\")): [User!]!\n}"
+    "extend type Query {\n  userById(id: ID!\n    @is(field: \"id\")): User!\n  usersById(ids: [ID!]!\n    @is(field: \"id\")): [User!]!\n}"
   ],
   "Clients": [
     {