Removed GraphQlClient used for EditingHandler, added GraphQLClient with customisable HeaderCollection instead

Author: robearlam

src/Sitecore.AspNetCore.SDK.GraphQL/Request/GraphQLHttpRequestWithHeaders.cs

@@ -0,0 +1,36 @@
+using GraphQL.Client.Abstractions;
+using GraphQL.Client.Http;
+
+namespace Sitecore.AspNetCore.SDK.GraphQL.Request
+{
+    /// <summary>
+    /// GraphQLHttpRequestWithHeaders is a class that extends GraphQLHttpRequest. It is designed to handle GraphQL HTTP
+    /// requests with additional header support.
+    /// </summary>
+    public class GraphQLHttpRequestWithHeaders : GraphQLHttpRequest
+    {
+        /// <summary>
+        /// Gets or sets a dictionary that stores key-value pairs of headers, where both keys and values are strings. It allows for
+        /// easy access and manipulation of header information.
+        /// </summary>
+        public Dictionary<string, string> Headers { get; set; } = [];
+
+        /// <summary>
+        /// Converts the current instance into an HTTP request message for GraphQL operations.
+        /// </summary>
+        /// <param name="options">Specifies configuration options for the GraphQL HTTP client.</param>
+        /// <param name="serializer">Defines the method for serializing GraphQL requests and responses.</param>
+        /// <returns>Returns an HTTP request message with the necessary headers for the GraphQL operation.</returns>
+        public override HttpRequestMessage ToHttpRequestMessage(GraphQLHttpClientOptions options, IGraphQLJsonSerializer serializer)
+        {
+            HttpRequestMessage request = base.ToHttpRequestMessage(options, serializer);
+
+            foreach (string headerKey in Headers.Keys)
+            {
+                request.Headers.Add(headerKey, Headers[headerKey]);
+            }
+
+            return request;
+        }
+    }
+}

src/Sitecore.AspNetCore.SDK.Pages/Extensions/PagesAppConfigurationExtensions.cs

@@ -1,4 +1,5 @@
-using Microsoft.AspNetCore.Builder;
+using GraphQL.Client.Abstractions;
+using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
@@ -7,7 +8,6 @@
 using Sitecore.AspNetCore.SDK.LayoutService.Client.Request;
 using Sitecore.AspNetCore.SDK.LayoutService.Client.Serialization;
 using Sitecore.AspNetCore.SDK.Pages.Configuration;
-using Sitecore.AspNetCore.SDK.Pages.GraphQL;
 using Sitecore.AspNetCore.SDK.Pages.Middleware;
 using Sitecore.AspNetCore.SDK.Pages.Request.Handlers.GraphQL;
 using Sitecore.AspNetCore.SDK.Pages.Services;
@@ -75,7 +75,6 @@ public static ISitecoreRenderingEngineBuilder WithSitecorePages(this ISitecoreRe
         }
 
         services.AddSingleton<PagesMarkerService>();
-        services.AddSingleton<IGraphQLClientFactory>(new GraphQLClientFactory(contextId));
         services.AddSingleton<IDictionaryService, DictionaryService>();
 
         if (options != null)
@@ -114,7 +113,7 @@ public static ISitecoreLayoutClientBuilder AddSitecorePagesHandler(
         builder.AddHandler(name, sp
             => ActivatorUtilities.CreateInstance<GraphQLEditingServiceHandler>(
                 sp,
-                sp.GetRequiredService<IGraphQLClientFactory>(),
+                sp.GetRequiredService<IGraphQLClient>(),
                 sp.GetRequiredService<ISitecoreLayoutSerializer>(),
                 sp.GetRequiredService<ILogger<GraphQLEditingServiceHandler>>()));
 

src/Sitecore.AspNetCore.SDK.Pages/GraphQL/GraphQLClientFactory.cs

@@ -2,6 +2,7 @@
 using GraphQL;
 using GraphQL.Client.Abstractions;
 using Microsoft.Extensions.Logging;
+using Sitecore.AspNetCore.SDK.GraphQL.Request;
 using Sitecore.AspNetCore.SDK.LayoutService.Client.Exceptions;
 using Sitecore.AspNetCore.SDK.LayoutService.Client.Interfaces;
 using Sitecore.AspNetCore.SDK.LayoutService.Client.Request;
@@ -10,7 +11,6 @@
 using Sitecore.AspNetCore.SDK.LayoutService.Client.Response.Model;
 using Sitecore.AspNetCore.SDK.LayoutService.Client.Serialization;
 using Sitecore.AspNetCore.SDK.LayoutService.Client.Serialization.Fields;
-using Sitecore.AspNetCore.SDK.Pages.GraphQL;
 using Sitecore.AspNetCore.SDK.Pages.Properties;
 using Sitecore.AspNetCore.SDK.Pages.Services;
 
@@ -20,17 +20,17 @@ namespace Sitecore.AspNetCore.SDK.Pages.Request.Handlers.GraphQL;
 /// <summary>
 /// Initializes a new instance of the <see cref="GraphQLEditingServiceHandler"/> class.
 /// </summary>
+/// <param name="client">The GraphQL Client used for requests</param>
 /// <param name="logger">The <see cref="ILogger"/> to use for logging.</param>
 /// <param name="dictionaryService">DictionaryService used to return all dictionary items for a Sitecore site.</param>
-/// <param name="clientFactory">The GraphQlClientFactory used to generate instances of the GraphQl client.</param>
 /// <param name="serializer">The serializer to handle response data.</param>
-public partial class GraphQLEditingServiceHandler(IGraphQLClientFactory clientFactory,
+public partial class GraphQLEditingServiceHandler(IGraphQLClient client,
     ISitecoreLayoutSerializer serializer,
     ILogger<GraphQLEditingServiceHandler> logger,
     IDictionaryService dictionaryService)
     : ILayoutRequestHandler
 {
-    private readonly IGraphQLClientFactory clientFactory = clientFactory ?? throw new ArgumentNullException(nameof(clientFactory));
+    private readonly IGraphQLClient client = client ?? throw new ArgumentNullException(nameof(client));
     private readonly ISitecoreLayoutSerializer serializer = serializer ?? throw new ArgumentNullException(nameof(serializer));
     private readonly ILogger<GraphQLEditingServiceHandler> logger = logger ?? throw new ArgumentNullException(nameof(logger));
     private readonly IDictionaryService dictionaryService = dictionaryService ?? throw new ArgumentNullException(nameof(dictionaryService));
@@ -267,7 +267,7 @@ private static string GetRequestArgValue(SitecoreLayoutRequest request, string a
         return headers[argName].FirstOrDefault() ?? string.Empty;
     }
 
-    private static GraphQLRequest BuildEditingLayoutRequest(SitecoreLayoutRequest request, string requestLanguage)
+    private static GraphQLHttpRequestWithHeaders BuildEditingLayoutRequest(SitecoreLayoutRequest request, string requestLanguage)
     {
         return new()
         {
@@ -288,14 +288,19 @@ query EditingQuery(
                 itemId = GetRequestArgValue(request, "sc_itemid"),
                 language = requestLanguage,
                 version = GetRequestArgValue(request, "sc_version")
+            },
+            Headers = new Dictionary<string, string>
+            {
+                { "sc_layoutKind", GetRequestArgValue(request, "sc_layoutKind") },
+                { "sc_editmode", (GetRequestArgValue(request, "mode") == "edit").ToString() }
             }
         };
     }
 
     private async Task<SitecoreLayoutResponseContent?> HandleEditingLayoutRequest(SitecoreLayoutRequest request, string requestLanguage, List<SitecoreLayoutServiceClientException> errors)
     {
-        IGraphQLClient client = clientFactory.GenerateClient(GetRequestArgValue(request, "sc_layoutKind"), GetRequestArgValue(request, "mode") == "edit");
         GraphQLResponse<EditingLayoutQueryResponse> response = await client.SendQueryAsync<EditingLayoutQueryResponse>(BuildEditingLayoutRequest(request, requestLanguage)).ConfigureAwait(false);
+
         if (response?.Data == null)
         {
             throw new Exception(Resources.Exception_UableToProcessEditingResponse);

src/Sitecore.AspNetCore.SDK.Pages/GraphQL/IGraphQLClientFactory.cs

@@ -0,0 +1,44 @@
+using System.Diagnostics.CodeAnalysis;
+using AutoFixture;
+using FluentAssertions;
+using GraphQL.Client.Abstractions;
+using GraphQL.Client.Http;
+using NSubstitute;
+using Sitecore.AspNetCore.SDK.AutoFixture.Attributes;
+using Sitecore.AspNetCore.SDK.GraphQL.Request;
+using Xunit;
+
+namespace Sitecore.AspNetCore.SDK.GraphQL.Tests.Request;
+
+public class GraphQLHttpRequestWithHeadersFixture
+{
+    [ExcludeFromCodeCoverage]
+    public static Action<IFixture> AutoSetup => f =>
+    {
+        GraphQLHttpClientOptions options = Substitute.For<GraphQLHttpClientOptions> ();
+        f.Inject(options);
+
+        IGraphQLJsonSerializer serializer = Substitute.For<IGraphQLJsonSerializer>();
+        f.Inject(serializer);
+    };
+
+    [Theory]
+    [AutoNSubstituteData]
+    public void ToHttpRequestMessage_HeadersAreAddedToReturnedMessage(GraphQLHttpRequestWithHeaders sut, GraphQLHttpClientOptions options, IGraphQLJsonSerializer serializer)
+    {
+        // Arrange
+        sut.Headers = new Dictionary<string, string>
+        {
+            { "key1", "value1" },
+            { "key2", "value2" }
+        };
+
+        // Act
+        HttpRequestMessage result = sut.ToHttpRequestMessage(options, serializer);
+
+        // Assert
+        result.Should().NotBeNull();
+        result.Headers.GetValues("key1").Should().Contain("value1");
+        result.Headers.GetValues("key2").Should().Contain("value2");
+    }
+}