Fix nullability of generated fields (#1724)

pekkah · Jan 15, 2024 · f397fa8 · f397fa8
1 parent 69eb84b
commit f397fa8
Show file tree

Hide file tree

Showing 38 changed files with 541 additions and 42 deletions.
diff --git a/benchmarks/GraphQL.Benchmarks/GraphQL.Benchmarks.csproj b/benchmarks/GraphQL.Benchmarks/GraphQL.Benchmarks.csproj
@@ -17,7 +17,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="BenchmarkDotNet" Version="0.13.11" />
+    <PackageReference Include="BenchmarkDotNet" Version="0.13.12" />
     <PackageReference Include="GraphQL-Parser" Version="9.3.1" />
   </ItemGroup>
 

diff --git a/src/GraphQL.Server.SourceGenerators/GraphQL.Server.SourceGenerators.csproj b/src/GraphQL.Server.SourceGenerators/GraphQL.Server.SourceGenerators.csproj
@@ -10,10 +10,11 @@
         <NoWarn>NU5100</NoWarn>
         <IncludeSymbols>false</IncludeSymbols>
         <IncludeBuildOutput>false</IncludeBuildOutput>
+        <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Polyfill" Version="1.34.0">
+        <PackageReference Include="Polyfill" Version="2.1.0">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
@@ -22,7 +23,7 @@
     <ItemGroup>
         <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0" PrivateAssets="all" />
         <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" PrivateAssets="all" />
-        <PackageReference Include="System.Text.Json" Version="8.0.0" PrivateAssets="all" GeneratePathProperty="true" />
+        <PackageReference Include="System.Text.Json" Version="8.0.1" PrivateAssets="all" GeneratePathProperty="true" />
     </ItemGroup>
 
     <ItemGroup>

diff --git a/src/GraphQL.Server.SourceGenerators/InputTypeDefinition.cs b/src/GraphQL.Server.SourceGenerators/InputTypeDefinition.cs
@@ -6,11 +6,7 @@ namespace Tanka.GraphQL.Server.SourceGenerators;
 
 public class InputTypeDefinition: TypeDefinition, IEquatable<InputTypeDefinition>
 {
-    public string? Namespace { get; init; }
-
-    public string TargetType { get; init; }
-
-    public List<ObjectPropertyDefinition> Properties { get; set; } = new List<ObjectPropertyDefinition>();
+    public List<ObjectPropertyDefinition> Properties { get; set; } = new();
 
     public ParentClass? ParentClass { get; set; }
 

diff --git a/src/GraphQL.Server.SourceGenerators/InputTypeEmitter.cs b/src/GraphQL.Server.SourceGenerators/InputTypeEmitter.cs
@@ -30,6 +30,7 @@ public static class {{name}}InputTypeExtensions
                 return builder;
             }
         }
+        
         """;
 
     public SourceProductionContext Context { get; }
@@ -69,6 +70,7 @@ private string BuildTypeSdl(InputTypeDefinition definition)
             {
                 var fieldName = JsonNamingPolicy.CamelCase.ConvertName(field.Name);
                 var fieldType = field.ClosestMatchingGraphQLTypeName;
+
                 builder.AppendLine($"{fieldName}: {fieldType}");
             }
         }

diff --git a/src/GraphQL.Server.SourceGenerators/InputTypeParser.cs b/src/GraphQL.Server.SourceGenerators/InputTypeParser.cs
@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.Linq;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
@@ -54,13 +55,25 @@ private  List<ObjectPropertyDefinition> ParseMembers(ClassDeclarationSyntax clas
         return properties;
     }
 
+
+
     private string GetClosestMatchingGraphQLTypeName(TypeSyntax typeSyntax)
     {
-        var typeSymbol = Context.SemanticModel.GetTypeInfo(typeSyntax).Type;
+        TypeInfo typeInfo = Context.SemanticModel.GetTypeInfo(typeSyntax);
+
+        var typeSymbol = typeInfo.Type;
 
         if (typeSymbol is null)
             return typeSyntax.ToString();
 
-        return TypeHelper.GetGraphQLTypeName(typeSymbol);
+        var typeName = TypeHelper.GetGraphQLTypeName(typeSymbol);
+
+        // dirty hack until we have a better way to handle this
+        if (typeSyntax is NullableTypeSyntax && typeName.AsSpan().EndsWith("!"))
+        {
+            return typeName.AsSpan().Slice(0, typeName.Length - 1).ToString();
+        }
+
+        return typeName;
     }
 }
diff --git a/src/GraphQL.Server.SourceGenerators/ObjectControllerDefinition.cs b/src/GraphQL.Server.SourceGenerators/ObjectControllerDefinition.cs
@@ -6,10 +6,6 @@ namespace Tanka.GraphQL.Server.SourceGenerators;
 
 public class ObjectControllerDefinition: TypeDefinition, IEquatable<ObjectControllerDefinition>
 {
-    public string? Namespace { get; init; }
-
-    public string TargetType { get; init; }
-
     public List<ObjectPropertyDefinition> Properties { get; set; } = new List<ObjectPropertyDefinition>();
 
     public List<ObjectMethodDefinition>  Methods { get; set;  } = new List<ObjectMethodDefinition>();
@@ -18,7 +14,7 @@ public class ObjectControllerDefinition: TypeDefinition, IEquatable<ObjectContro
 
     public bool IsStatic { get; init; }
 
-    public IReadOnlyList<string> Usings { get; init; }
+    public IReadOnlyList<string> Usings { get; init; } = [];
 
     public virtual bool Equals(ObjectControllerDefinition? other)
     {

diff --git a/src/GraphQL.Server.SourceGenerators/ObjectTypeParser.cs b/src/GraphQL.Server.SourceGenerators/ObjectTypeParser.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
+using System;
 
 namespace Tanka.GraphQL.Server.SourceGenerators
 {
@@ -94,7 +95,15 @@ private static string GetClosestMatchingGraphQLTypeName(SemanticModel model, Typ
             if (typeSymbol is null)
                 return typeSyntax.ToString();
 
-            return TypeHelper.GetGraphQLTypeName(typeSymbol);
+            var typeName = TypeHelper.GetGraphQLTypeName(typeSymbol);
+
+            // dirty hack until we have a better way to handle this
+            if (typeSyntax is NullableTypeSyntax && typeName.AsSpan().EndsWith("!"))
+            {
+                return typeName.AsSpan().Slice(0, typeName.Length - 1).ToString();
+            }
+
+            return typeName;
         }
     }
 }
diff --git a/src/GraphQL.Server.SourceGenerators/TypeHelper.cs b/src/GraphQL.Server.SourceGenerators/TypeHelper.cs
@@ -10,6 +10,11 @@ namespace Tanka.GraphQL.Server.SourceGenerators;
 
 public class TypeHelper
 {
+    public static string GetGraphQLTypeName(TypeSyntax typeSyntax)
+    {
+        return null;
+    }
+
     public static string GetGraphQLTypeName(ITypeSymbol typeSymbol)
     {
         // Handle arrays
@@ -18,10 +23,24 @@ public static string GetGraphQLTypeName(ITypeSymbol typeSymbol)
             return $"[{GetGraphQLTypeName(arrayTypeSymbol.ElementType)}]";
         }
 
-        // Handle IEnumerable<T>
-        if (typeSymbol is INamedTypeSymbol { IsGenericType: true, ConstructedFrom.Name: "IEnumerable" } namedType)
+        if (typeSymbol is not { SpecialType: SpecialType.System_String })
         {
-            return $"[{GetGraphQLTypeName(namedType.TypeArguments[0])}]";
+            var ienumerableT = typeSymbol
+                .AllInterfaces
+                .FirstOrDefault(i =>
+                    i.OriginalDefinition.SpecialType == SpecialType.System_Collections_Generic_IEnumerable_T);
+
+            if (ienumerableT is not null)
+            {
+                var innerType = ienumerableT.TypeArguments[0];
+                return $"[{GetGraphQLTypeName(innerType)}]";
+            }
+
+            // Handle IEnumerable<T>
+            if (typeSymbol is INamedTypeSymbol { IsGenericType: true, ConstructedFrom.Name: "IEnumerable" } namedType)
+            {
+                return $"[{GetGraphQLTypeName(namedType.TypeArguments[0])}]";
+            }
         }
 
         bool isNullable = IsNullable(typeSymbol, out typeSymbol);
@@ -74,6 +93,7 @@ public static string GetGraphQLTypeName(ITypeSymbol typeSymbol)
 
     public static bool IsNullable(ITypeSymbol typeSymbol, out ITypeSymbol innerType)
     {
+
         if (typeSymbol is INamedTypeSymbol
             {
                 OriginalDefinition.SpecialType: SpecialType.System_Nullable_T
@@ -82,7 +102,7 @@ public static bool IsNullable(ITypeSymbol typeSymbol, out ITypeSymbol innerType)
             innerType = namedTypeSymbol.TypeArguments[0];
             return true;
         }
-
+        
         innerType = typeSymbol;
         return typeSymbol.NullableAnnotation == NullableAnnotation.Annotated;
     }
@@ -412,4 +432,6 @@ public static IReadOnlyList<string> GetUsings(ClassDeclarationSyntax classDeclar
             .Select(u => u.ToString())
             .ToList();
     }
+
+
 }
diff --git a/src/GraphQL.Server/GraphQL.Server.csproj b/src/GraphQL.Server/GraphQL.Server.csproj
@@ -16,7 +16,7 @@
 
 	<ItemGroup>
 		<FrameworkReference Include="Microsoft.AspNetCore.App" />
-		<PackageReference Include="Microsoft.Extensions.Options" Version="8.0.0" />
+		<PackageReference Include="Microsoft.Extensions.Options" Version="8.0.1" />
 		<PackageReference Include="System.IO.Pipelines" Version="8.0.0" />
 		<PackageReference Include="System.Net.WebSockets" Version="4.3.0" />
 	</ItemGroup>

diff --git a/src/GraphQL/GraphQL.csproj b/src/GraphQL/GraphQL.csproj
@@ -11,8 +11,8 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Microsoft.Extensions.Features" Version="8.0.0" />
+		<PackageReference Include="Microsoft.Extensions.Features" Version="8.0.1" />
 		<PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
-		<PackageReference Include="System.Text.Json" Version="8.0.0" />
+		<PackageReference Include="System.Text.Json" Version="8.0.1" />
 	</ItemGroup>
 </Project>
diff --git a/...raphQL.Extensions.ApolloFederation.Tests/GraphQL.Extensions.ApolloFederation.Tests.csproj b/...raphQL.Extensions.ApolloFederation.Tests/GraphQL.Extensions.ApolloFederation.Tests.csproj
@@ -7,7 +7,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
-    <PackageReference Include="xunit" Version="2.6.4" />
+    <PackageReference Include="xunit" Version="2.6.5" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

diff --git a/tests/GraphQL.Extensions.Experimental.Tests/GraphQL.Extensions.Experimental.Tests.csproj b/tests/GraphQL.Extensions.Experimental.Tests/GraphQL.Extensions.Experimental.Tests.csproj
@@ -10,9 +10,9 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0" />
-    <PackageReference Include="xunit" Version="2.4.2" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+    <PackageReference Include="xunit" Version="2.6.5" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>

diff --git a/tests/GraphQL.Extensions.Tracing.Tests/GraphQL.Extensions.Tracing.Tests.csproj b/tests/GraphQL.Extensions.Tracing.Tests/GraphQL.Extensions.Tracing.Tests.csproj
@@ -10,7 +10,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
-    <PackageReference Include="xunit" Version="2.6.4" />
+    <PackageReference Include="xunit" Version="2.6.5" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>

diff --git a/tests/GraphQL.Language.Tests/GraphQL.Language.Tests.csproj b/tests/GraphQL.Language.Tests/GraphQL.Language.Tests.csproj
@@ -18,7 +18,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
     <PackageReference Include="NSubstitute" Version="5.1.0" />
-    <PackageReference Include="xunit" Version="2.6.4" />
+    <PackageReference Include="xunit" Version="2.6.5" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

diff --git a/tests/GraphQL.Server.SourceGenerators.Tests/GraphQL.Server.SourceGenerators.Tests.csproj b/tests/GraphQL.Server.SourceGenerators.Tests/GraphQL.Server.SourceGenerators.Tests.csproj
@@ -10,7 +10,7 @@
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
-		<PackageReference Include="xunit" Version="2.6.4" />
+		<PackageReference Include="xunit" Version="2.6.5" />
 		<PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 			<PrivateAssets>all</PrivateAssets>
@@ -19,7 +19,7 @@
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 			<PrivateAssets>all</PrivateAssets>
 		</PackageReference>
-		<PackageReference Include="Verify.XUnit" Version="22.7.1" />
+		<PackageReference Include="Verify.XUnit" Version="22.11.5" />
 		<PackageReference Include="Verify.SourceGenerators" Version="2.2.0" />
 		<PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" PrivateAssets="all" />
 		<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0" PrivateAssets="all" />

diff --git a/tests/GraphQL.Server.SourceGenerators.Tests/InputTypeFacts.cs b/tests/GraphQL.Server.SourceGenerators.Tests/InputTypeFacts.cs
@@ -20,4 +20,56 @@ public class InputMessage
         return TestHelper<ObjectTypeGenerator>.Verify(source);
     }
 
+    [Fact]
+    public Task Generate_InputType_with_nullable_string()
+    {
+        var source = """
+                     using Tanka.GraphQL.Server;
+
+                     [InputType]
+                     public class InputMessage
+                     {
+                        public string? Content { get; set; }
+                     }
+                     """;
+
+        return TestHelper<ObjectTypeGenerator>.Verify(source);
+    }
+
+    [Fact]
+    public Task Generate_InputType_with_nullable_int()
+    {
+        var source = """
+                     using Tanka.GraphQL.Server;
+
+                     [InputType]
+                     public class InputMessage
+                     {
+                        public int? Content { get; set; }
+                     }
+                     """;
+
+        return TestHelper<ObjectTypeGenerator>.Verify(source);
+    }
+
+    [Fact]
+    public Task Generate_InputType_with_listof_nullable_class()
+    {
+        var source = """
+                     using Tanka.GraphQL.Server;
+                     using System.Collections.Generic;
+                     
+                     [InputType]
+                     public class InputMessage
+                     {
+                        public List<Person?> Content { get; set; }
+                     }
+                     
+                     public class Person 
+                     {
+                     }
+                     """;
+
+        return TestHelper<ObjectTypeGenerator>.Verify(source);
+    }
 }
diff --git a/...ors.Tests/Snapshots/InputTypeFacts.Generate_InputType#InputMessageInputType.g.verified.cs b/...ors.Tests/Snapshots/InputTypeFacts.Generate_InputType#InputMessageInputType.g.verified.cs
@@ -28,3 +28,4 @@ input InputMessage
         return builder;
     }
 }
+
diff --git a/...te_InputType_with_listof_nullable_class#Global.SourceGeneratedTypesExtensions.verified.cs b/...te_InputType_with_listof_nullable_class#Global.SourceGeneratedTypesExtensions.verified.cs
@@ -0,0 +1,17 @@
+//HintName: Global.SourceGeneratedTypesExtensions.cs
+using System;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Options;
+using Tanka.GraphQL.Server;
+using Tanka.GraphQL.Executable;
+using Tanka.GraphQL.ValueResolution;
+using Tanka.GraphQL.Fields;
+
+public static class GlobalSourceGeneratedTypesExtensions
+{
+    public static SourceGeneratedTypesBuilder AddGlobalTypes(this SourceGeneratedTypesBuilder builder)
+    {
+        builder.AddInputMessageInputType();
+        return builder;
+    }
+}
diff --git a/...peFacts.Generate_InputType_with_listof_nullable_class#InputMessageInputType.g.verified.cs b/...peFacts.Generate_InputType_with_listof_nullable_class#InputMessageInputType.g.verified.cs
@@ -0,0 +1,30 @@
+//HintName: InputMessageInputType.g.cs
+using System;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Options;
+using Tanka.GraphQL.Server;
+using Tanka.GraphQL.Executable;
+using Tanka.GraphQL.ValueResolution;
+using Tanka.GraphQL.Fields;
+
+
+
+public static class InputMessageInputTypeExtensions
+{
+    public static SourceGeneratedTypesBuilder AddInputMessageInputType(
+        this SourceGeneratedTypesBuilder builder)
+    {
+        builder.Builder.Configure(options => options.Builder.Add(
+                """
+                input InputMessage
+                {
+                    content: [Person]
+                }
+                """
+                )
+            );
+
+        return builder;
+    }
+}
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -28,3 +28,4 @@ input InputMessage
		return builder;
		}
		}