GraphQL 4

src/OrchardCore.Build/Dependencies.props

@@ -17,7 +17,10 @@
     <PackageManagement Include="Castle.Core" Version="4.4.1" />
     <PackageManagement Include="Irony.Core" Version="1.0.7" />
     <PackageManagement Include="Fluid.Core" Version="2.2.14" />
-    <PackageManagement Include="GraphQL" Version="2.4.0" />
+    <PackageManagement Include="GraphQL" Version="4.6.1" />
+    <PackageManagement Include="GraphQL.DataLoader" Version="4.6.1" />
+    <PackageManagement Include="GraphQL.MicrosoftDI" Version="4.6.1" />
+    <PackageManagement Include="GraphQL.NewtonsoftJson" Version="4.6.1" />
     <PackageManagement Include="Jint" Version="3.0.0-beta-2037" />
     <PackageManagement Include="HtmlSanitizer" Version="7.1.475" />
     <PackageManagement Include="Lucene.Net" Version="4.8.0-beta00015" />

src/OrchardCore.Modules/OrchardCore.Apis.GraphQL/Extensions/DocumentWriterExtensions.cs

@@ -0,0 +1,39 @@
+using System;
+using System.Net;
+using System.Net.Mime;
+using System.Threading.Tasks;
+using GraphQL;
+using Microsoft.AspNetCore.Http;
+
+namespace OrchardCore.Apis.GraphQL
+{
+    internal static class DocumentWriterExtensions
+    {
+        public static async Task WriteErrorAsync(this IDocumentWriter documentWriter, HttpContext context, string message, Exception e = null)
+        {
+            if (message == null)
+            {
+                throw new ArgumentNullException(nameof(message));
+            }
+
+            var errorResult = new ExecutionResult
+            {
+                Errors = new ExecutionErrors()
+            };
+
+            if (e == null)
+            {
+                errorResult.Errors.Add(new ExecutionError(message));
+            }
+            else
+            {
+                errorResult.Errors.Add(new ExecutionError(message, e));
+            }
+
+            context.Response.StatusCode = (int)HttpStatusCode.BadRequest;
+            context.Response.ContentType = MediaTypeNames.Application.Json;
+
+            await documentWriter.WriteAsync(context.Response.Body, errorResult);
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.Apis.GraphQL/GraphQLMiddleware.cs

@@ -2,10 +2,13 @@
 using System.IO;
 using System.Linq;
 using System.Net;
+using System.Net.Mime;
 using System.Text;
+using System.Threading;
 using System.Threading.Tasks;
 using GraphQL;
 using GraphQL.Execution;
+using GraphQL.NewtonsoftJson;
 using GraphQL.Validation;
 using GraphQL.Validation.Complexity;
 using Microsoft.AspNetCore.Authentication;
@@ -25,7 +28,6 @@ public class GraphQLMiddleware
         private readonly RequestDelegate _next;
         private readonly GraphQLSettings _settings;
         private readonly IDocumentExecuter _executer;
-
         internal static readonly Encoding _utf8Encoding = new UTF8Encoding(false);
         private readonly static MediaType _jsonMediaType = new MediaType("application/json");
         private readonly static MediaType _graphQlMediaType = new MediaType("application/graphql");
@@ -40,7 +42,7 @@ public GraphQLMiddleware(
             _executer = executer;
         }
 
-        public async Task Invoke(HttpContext context, IAuthorizationService authorizationService, IAuthenticationService authenticationService, ISchemaFactory schemaService)
+        public async Task Invoke(HttpContext context, IAuthorizationService authorizationService, IAuthenticationService authenticationService, ISchemaFactory schemaService, IDocumentWriter documentWriter)
         {
             if (!IsGraphQLRequest(context))
             {
@@ -59,7 +61,7 @@ public async Task Invoke(HttpContext context, IAuthorizationService authorizatio
 
                 if (authorized)
                 {
-                    await ExecuteAsync(context, schemaService);
+                    await ExecuteAsync(context, schemaService, documentWriter);
                 }
                 else
                 {
@@ -73,85 +75,54 @@ private bool IsGraphQLRequest(HttpContext context)
             return context.Request.Path.StartsWithNormalizedSegments(_settings.Path, StringComparison.OrdinalIgnoreCase);
         }
 
-        private async Task ExecuteAsync(HttpContext context, ISchemaFactory schemaService)
+        private async Task ExecuteAsync(HttpContext context, ISchemaFactory schemaService, IDocumentWriter documentWriter)
         {
-            var schema = await schemaService.GetSchemaAsync();
-
             GraphQLRequest request = null;
 
             // c.f. https://graphql.org/learn/serving-over-http/#post-request
 
-            if (HttpMethods.IsPost(context.Request.Method))
+            try
             {
-                if (string.IsNullOrEmpty(context.Request.ContentType))
+                if (HttpMethods.IsPost(context.Request.Method))
                 {
-                    await WriteErrorAsync(context, "Missing content-type");
-                    return;
-                }
-
-                var mediaType = new MediaType(context.Request.ContentType);
+                    var mediaType = new MediaType(context.Request.ContentType);
 
-                try
-                {
-                    if (mediaType.IsSubsetOf(_jsonMediaType))
+                    if (mediaType.IsSubsetOf(_jsonMediaType) || mediaType.IsSubsetOf(_graphQlMediaType))
                     {
-                        using (var sr = new StreamReader(context.Request.Body))
-                        {
-                            // Asynchronous read is mandatory.
-                            var json = await sr.ReadToEndAsync();
-                            request = JObject.Parse(json).ToObject<GraphQLRequest>();
-                        }
-                    }
-                    else if (mediaType.IsSubsetOf(_graphQlMediaType))
-                    {
-                        request = new GraphQLRequest();
-
-                        using (var sr = new StreamReader(context.Request.Body))
-                        {
-                            request.Query = await sr.ReadToEndAsync();
-                        }
-                    }
-                    else if (context.Request.Query.ContainsKey("query"))
-                    {
-                        request = new GraphQLRequest
-                        {
-                            Query = context.Request.Query["query"]
-                        };
+                        using var sr = new StreamReader(context.Request.Body);
 
-                        if (context.Request.Query.ContainsKey("variables"))
+                        if (mediaType.IsSubsetOf(_graphQlMediaType))
                         {
-                            request.Variables = JObject.Parse(context.Request.Query["variables"]);
+                            request = new GraphQLRequest
+                            {
+                                Query = await sr.ReadToEndAsync()
+                            };
                         }
-
-                        if (context.Request.Query.ContainsKey("operationName"))
+                        else
                         {
-                            request.OperationName = context.Request.Query["operationName"];
+                            var json = await sr.ReadToEndAsync();
+                            request = JObject.Parse(json).ToObject<GraphQLRequest>();
                         }
                     }
                     else
                     {
-                        await WriteErrorAsync(context, "The request needs a valid content-type or a query argument");
-                        return;
+                        request = CreateRequestFromQueryString(context);
                     }
                 }
-                catch (Exception e)
+                else if (HttpMethods.IsGet(context.Request.Method))
                 {
-                    await WriteErrorAsync(context, "An error occurred while processing the GraphQL query", e);
-                    return;
-                }
-            }
-            else if (HttpMethods.IsGet(context.Request.Method))
-            {
-                if (!context.Request.Query.ContainsKey("query"))
-                {
-                    await WriteErrorAsync(context, "The 'query' query string parameter is missing");
-                    return;
+                    request = CreateRequestFromQueryString(context, true);
                 }
 
-                request = new GraphQLRequest
+                if (request == null)
                 {
-                    Query = context.Request.Query["query"]
-                };
+                    throw new InvalidOperationException("Unable to create a graphqlrequest from this request");
+                }
+            }
+            catch (Exception e)
+            {
+                await documentWriter.WriteErrorAsync(context, "An error occurred while processing the GraphQL query", e);
+                return;
             }
 
             var queryToExecute = request.Query;
@@ -167,6 +138,7 @@ private async Task ExecuteAsync(HttpContext context, ISchemaFactory schemaServic
                 queryToExecute = queries[request.NamedQuery];
             }
 
+            var schema = await schemaService.GetSchemaAsync();
             var dataLoaderDocumentListener = context.RequestServices.GetRequiredService<IDocumentExecutionListener>();
 
             var result = await _executer.ExecuteAsync(_ =>
@@ -176,8 +148,7 @@ private async Task ExecuteAsync(HttpContext context, ISchemaFactory schemaServic
                 _.OperationName = request.OperationName;
                 _.Inputs = request.Variables.ToInputs();
                 _.UserContext = _settings.BuildUserContext?.Invoke(context);
-                _.ExposeExceptions = _settings.ExposeExceptions;
-                _.ValidationRules = DocumentValidator.CoreRules()
+                _.ValidationRules = DocumentValidator.CoreRules
                                     .Concat(context.RequestServices.GetServices<IValidationRule>());
                 _.ComplexityConfiguration = new ComplexityConfiguration
                 {
@@ -186,48 +157,61 @@ private async Task ExecuteAsync(HttpContext context, ISchemaFactory schemaServic
                     FieldImpact = _settings.FieldImpact
                 };
                 _.Listeners.Add(dataLoaderDocumentListener);
+                _.RequestServices = context.RequestServices;
             });
 
             context.Response.StatusCode = (int)(result.Errors == null || result.Errors.Count == 0
                 ? HttpStatusCode.OK
-                : result.Errors.Any(x => x.Code == RequiresPermissionValidationRule.ErrorCode)
+                : result.Errors.Any(x => x is ValidationError ve && ve.Number == RequiresPermissionValidationRule.ErrorCode)
                     ? HttpStatusCode.Unauthorized
                     : HttpStatusCode.BadRequest);
 
-            context.Response.ContentType = "application/json";
+            context.Response.ContentType = MediaTypeNames.Application.Json;
 
-            // Asynchronous write to the response body is mandatory.
-            var encodedBytes = _utf8Encoding.GetBytes(JObject.FromObject(result).ToString());
-            await context.Response.Body.WriteAsync(encodedBytes, 0, encodedBytes.Length);
+            await WriteAsync(context.Response.Body, result, documentWriter);
         }
 
-        private async Task WriteErrorAsync(HttpContext context, string message, Exception e = null)
+        private async Task WriteAsync<T>(Stream stream2, T value, IDocumentWriter documentWriter, CancellationToken cancellationToken = default)
         {
-            if (message == null)
+            // needs to be always async, otherwise __schema request is not working, direct write into response does not work as serialize is using sync method inside
+            cancellationToken.ThrowIfCancellationRequested();
+
+            using (MemoryStream stream = new MemoryStream())
             {
-                throw new ArgumentNullException(nameof(message));
+                await documentWriter.WriteAsync(stream, value);
+                stream.Seek(0, SeekOrigin.Begin);
+                await stream.CopyToAsync(stream2, cancellationToken);
             }
+        }
 
-            var errorResult = new ExecutionResult
+        private static GraphQLRequest CreateRequestFromQueryString(HttpContext context, bool validateQueryKey = false)
+        {
+            if (!context.Request.Query.ContainsKey("query"))
+            {
+                if (validateQueryKey)
+                {
+                    throw new InvalidOperationException("The 'query' query string parameter is missing");
+                }
+
+                return null;
+            }
+
+            var request = new GraphQLRequest
             {
-                Errors = new ExecutionErrors()
+                Query = context.Request.Query["query"]
             };
 
-            if (e == null)
+            if (context.Request.Query.ContainsKey("variables"))
             {
-                errorResult.Errors.Add(new ExecutionError(message));
+                request.Variables = JObject.Parse(context.Request.Query["variables"]);
             }
-            else
+
+            if (context.Request.Query.ContainsKey("operationName"))
             {
-                errorResult.Errors.Add(new ExecutionError(message, e));
+                request.OperationName = context.Request.Query["operationName"];
             }
 
-            context.Response.StatusCode = (int)HttpStatusCode.BadRequest;
-            context.Response.ContentType = "application/json";
-
-            // Asynchronous write to the response body is mandatory.
-            var encodedBytes = _utf8Encoding.GetBytes(JObject.FromObject(errorResult).ToString());
-            await context.Response.Body.WriteAsync(encodedBytes, 0, encodedBytes.Length);
+            return request;
         }
     }
 }

src/OrchardCore.Modules/OrchardCore.Apis.GraphQL/OrchardCore.Apis.GraphQL.csproj

@@ -14,6 +14,12 @@
     <FrameworkReference Include="Microsoft.AspNetCore.App" />
   </ItemGroup>
 
+  <ItemGroup>
+    <PackageReference Include="GraphQL.DataLoader" />
+    <PackageReference Include="GraphQL.MicrosoftDI" />
+    <PackageReference Include="GraphQL.NewtonsoftJson" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="YesSql.Abstractions" />
   </ItemGroup>

src/OrchardCore.Modules/OrchardCore.Apis.GraphQL/OrchardFieldNameConverter.cs

@@ -1,28 +1,37 @@
 using System;
+using GraphQL;
 using GraphQL.Conversion;
+using GraphQL.Types;
 
 namespace OrchardCore.Apis.GraphQL
 {
-    public class OrchardFieldNameConverter : IFieldNameConverter
+    public class OrchardFieldNameConverter : INameConverter
     {
-        private readonly IFieldNameConverter _defaultConverter = new CamelCaseFieldNameConverter();
+        private readonly INameConverter _defaultConverter = new CamelCaseNameConverter();
 
-        public string NameFor(string field, Type parentType)
+        // todo: custom argument name?
+        public string NameForArgument(string argumentName, IComplexGraphType parentGraphType, FieldType field)
         {
-            var attributes = parentType?.GetCustomAttributes(typeof(GraphQLFieldNameAttribute), true);
+            return _defaultConverter.NameForArgument(argumentName, parentGraphType, field);
+        }
+
+        // TODO: check functionality
+        public string NameForField(string fieldName, IComplexGraphType parentGraphType)
+        {
+            var attributes = parentGraphType?.GetType().GetCustomAttributes(typeof(GraphQLFieldNameAttribute), true);
 
             if (attributes != null)
             {
                 foreach (GraphQLFieldNameAttribute attribute in attributes)
                 {
-                    if (attribute.Field == field)
+                    if (attribute.Field == fieldName)
                     {
                         return attribute.Mapped;
                     }
                 }
             }
 
-            return _defaultConverter.NameFor(field, parentType);
+            return _defaultConverter.NameForField(fieldName, parentGraphType);
         }
     }
 }