Merge pull request #34 from Linq2GraphQL/add-support-for-nullable

Add support for nullable
Linq2GraphQL · Sep 4, 2024 · 5b9c97f · 5b9c97f
2 parents 11d776d + 601567f
commit 5b9c97f
Show file tree

Hide file tree

Showing 13 changed files with 136 additions and 72 deletions.
diff --git a/docs/Linq2GraphQL.Docs/Components/GenerateClient.razor b/docs/Linq2GraphQL.Docs/Components/GenerateClient.razor
@@ -4,56 +4,67 @@
 
 <Dimmer Active=isLoading>
 
-<ItemSelect  Items="demoOptions" @bind-SelectedValue="options" SelectedTextExpression="e=>e.ClientName">
-    <ListTemplate>
-        @context.ClientName
-    </ListTemplate>
-</ItemSelect>
-
-<Card class="mt-3">
-    <CardBody>
-        <DataGrid>
-            <DataGridItem Title="Name">
-                <InputText class="form-control" @bind-Value="options.ClientName" />
-            </DataGridItem>
-            <DataGridItem Title="Namespace">
-                <InputText class="form-control" @bind-Value="options.Namespace" />
-            </DataGridItem>
-            <DataGridItem Title="Include subscriptions">
-                <Checkbox Switch @bind-Value="options.IncludeSubscriptions" />
-             </DataGridItem>
-         </DataGrid>
-
-         <div class="mt-3" />
-         <Tabs>
-             <Tab Title="Url">
-                 <DataGrid>
-                     <DataGridItem Title="Url">
-                         <InputText class="form-control" @bind-Value="options.Url" />
-                     </DataGridItem>
-                     <DataGridItem Title="Token">
-                         <InputText class="form-control" @bind-Value="options.Token" />
-                     </DataGridItem>
-                 </DataGrid>
-
-
-                 <Button class="mt-3" BackgroundColor="TablerColor.Primary" OnClick="GenerateClientAsync">Generate</Button>
-
-             </Tab>
-
-             <Tab Title="Schema">
-
-                 <div class="mb-2">Run this <Icon class="icon" IconType="Icons.Copy" OnClick="CopyIntrospection" /> query and paste the result below.</div>
-
-                 <InputTextArea class="form-control" @bind-Value="options.Schema" rows="20" />
-
-                 <Button class="mt-3" BackgroundColor="TablerColor.Primary" OnClick="GenerateClientJson">Generate</Button>
-             </Tab>
-
-         </Tabs>
-
-
-     </CardBody>
- </Card>
-
- </Dimmer>
+    <ItemSelect Items="demoOptions" @bind-SelectedValue="options" SelectedTextExpression="e=>e.ClientName">
+        <ListTemplate>
+            @context.ClientName
+        </ListTemplate>
+    </ItemSelect>
+
+    <Card class="mt-3">
+        <CardBody>
+            <DataGrid>
+                <DataGridItem Title="Name">
+                    <InputText class="form-control" @bind-Value="options.ClientName" />
+                </DataGridItem>
+                <DataGridItem Title="Namespace">
+                    <InputText class="form-control" @bind-Value="options.Namespace" />
+                </DataGridItem>
+
+                <DataGridItem Title="Enum Strategy">
+                    <ItemSelect Items="EnumHelper.GetList<EnumGeneratorStrategy>()" @bind-SelectedValue="options.EnumGeneratorStrategy" />
+                </DataGridItem>
+
+                <DataGridItem Title="Include subscriptions">
+                    <Checkbox Switch @bind-Value="options.IncludeSubscriptions" />
+                </DataGridItem>
+
+                <DataGridItem Title="Nullable client">
+                    <Checkbox Switch @bind-Value="options.Nullable" />
+                </DataGridItem>
+
+
+            </DataGrid>
+
+            <div class="mt-3" />
+            <Tabs>
+                <Tab Title="Url">
+                    <DataGrid>
+                        <DataGridItem Title="Url">
+                            <InputText class="form-control" @bind-Value="options.Url" />
+                        </DataGridItem>
+                        <DataGridItem Title="Token">
+                            <InputText class="form-control" @bind-Value="options.Token" />
+                        </DataGridItem>
+                    </DataGrid>
+
+
+                    <Button class="mt-3" BackgroundColor="TablerColor.Primary" OnClick="GenerateClientAsync">Generate</Button>
+
+                </Tab>
+
+                <Tab Title="Schema">
+
+                    <div class="mb-2">Run this <Icon class="icon" IconType="Icons.Copy" OnClick="CopyIntrospection" /> query and paste the result below.</div>
+
+                    <InputTextArea class="form-control" @bind-Value="options.Schema" rows="20" />
+
+                    <Button class="mt-3" BackgroundColor="TablerColor.Primary" OnClick="GenerateClientJson">Generate</Button>
+                </Tab>
+
+            </Tabs>
+
+
+        </CardBody>
+    </Card>
+
+</Dimmer>
diff --git a/docs/Linq2GraphQL.Docs/Components/GenerateClient.razor.cs b/docs/Linq2GraphQL.Docs/Components/GenerateClient.razor.cs
@@ -86,7 +86,7 @@ private async Task GenerateClientJson()
             try
             {
                 isLoading = true;
-                var generator = new Generator.ClientGenerator(options.Namespace, options.ClientName, options.IncludeSubscriptions, EnumGeneratorStrategy.FailIfMissing);
+                var generator = new Generator.ClientGenerator(options.Namespace, options.ClientName, options.IncludeSubscriptions, EnumGeneratorStrategy.FailIfMissing, options.Nullable);
                 var entries = generator.Generate(options.Schema);
                 await SaveEntriesAsync(entries);
             }
@@ -107,7 +107,7 @@ private async Task GenerateClientAsync()
             try
             {
                 isLoading = true;
-                var generator = new ClientGenerator(options.Namespace, options.ClientName, options.IncludeSubscriptions, EnumGeneratorStrategy.FailIfMissing);
+                var generator = new ClientGenerator(options.Namespace, options.ClientName, options.IncludeSubscriptions, options.EnumGeneratorStrategy, options.Nullable);
                 var entries = await generator.GenerateAsync(new Uri(options.Url), options.Token);
                 await SaveEntriesAsync(entries);
             }
@@ -128,10 +128,12 @@ public class GenerateOptions
         public string Namespace { get; set; }
         public string ClientName { get; set; }
         public bool IncludeSubscriptions { get; set; }
-
+        public bool Nullable { get; set; }
         public string Url { get; set; }
         public string Token { get; set; }
 
+        public EnumGeneratorStrategy EnumGeneratorStrategy { get; set; }
+
         public string Schema { get; set; }
     }
 }
diff --git a/src/Linq2GraphQL.Generator/ClientGenerator.cs b/src/Linq2GraphQL.Generator/ClientGenerator.cs
@@ -15,15 +15,17 @@ public class ClientGenerator
         private readonly string clientName;
         private readonly bool includeSubscriptions;
         private readonly EnumGeneratorStrategy enumGeneratorStrategy;
+        private readonly bool nullable;
         private readonly List<FileEntry> entries = new();
 
         public ClientGenerator(string namespaceName, string clientName, bool includeSubscriptions,
-            EnumGeneratorStrategy enumGeneratorStrategy)
+            EnumGeneratorStrategy enumGeneratorStrategy, bool nullable)
         {
             this.namespaceName = namespaceName;
             this.clientName = clientName;
             this.includeSubscriptions = includeSubscriptions;
             this.enumGeneratorStrategy = enumGeneratorStrategy;
+            this.nullable = nullable;
         }
 
         private void AddFile(string directory, string fileName, string content)
@@ -58,6 +60,9 @@ public async Task<List<FileEntry>> GenerateAsync(Uri uri, string authToken = nul
         public List<FileEntry> Generate(string schemaJson)
         {
             entries.Clear();
+
+            GeneratorSettings.Current = new GeneratorSettings { Nullable = this.nullable };
+
             var rootSchema = JsonSerializer.Deserialize<RootSchema>(schemaJson,
                 new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase });
 

diff --git a/src/Linq2GraphQL.Generator/GeneratorSettings.cs b/src/Linq2GraphQL.Generator/GeneratorSettings.cs
@@ -0,0 +1,17 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Linq2GraphQL.Generator
+{
+    public class GeneratorSettings
+    {
+        public static GeneratorSettings Current { get; set; }
+
+        public bool Nullable { get; set; }
+    }
+
+
+}
diff --git a/src/Linq2GraphQL.Generator/GraphQLSchema/RootSchema.cs b/src/Linq2GraphQL.Generator/GraphQLSchema/RootSchema.cs
@@ -261,15 +261,25 @@ public class TypeInfo
     public bool IsNoneNull { get; set; }
     public bool IsList { get; set; }
 
-    private bool csharpNullQuestion =>
-        !IsNoneNull && (Kind == TypeKind.Enum || (CSharpType != null && CSharpTypeName != "string"));
+
+    private bool CSharpNullQuestion()
+    {
+        if (GeneratorSettings.Current.Nullable)
+        {
+            return !IsNoneNull;
+        }
+        else
+        {
+            return !IsNoneNull && (Kind == TypeKind.Enum || (CSharpType != null && CSharpTypeName != "string"));
+        }
 
+    }
 
     public string CSharpTypeNameFull
     {
         get
         {
-            var result = CSharpTypeName + (csharpNullQuestion ? "?" : "");
+            var result = CSharpTypeName + (CSharpNullQuestion() ? "?" : "");
 
             if (IsList)
             {

diff --git a/src/Linq2GraphQL.Generator/Program.cs b/src/Linq2GraphQL.Generator/Program.cs
@@ -21,6 +21,8 @@ private static async Task Main(string[] args)
         var includeSubscriptions = new Option<bool>(new[] { "--subscriptions", "-s" }, "Include subscriptions");
         var enumStrategy = new Option<string>(new[] { "--enum-strategy", "-es" }, "Enum strategy");
 
+        var nullable = new Option<bool>(new[] { "--nullable", "-nu" }, "Nullable client");
+
         var rootCommand = new RootCommand("Generate GraphQL client")
         {
             uriArgument,
@@ -29,7 +31,8 @@ private static async Task Main(string[] args)
             clientName,
             authToken,
             includeSubscriptions,
-            enumStrategy
+            enumStrategy,
+            nullable
         };
 
         rootCommand.SetHandler(async context =>
@@ -42,9 +45,10 @@ private static async Task Main(string[] args)
                 var authTokenValue = result.GetValueForOption(authToken);
                 var includeSubscriptionsValue = result.GetValueForOption(includeSubscriptions);
                 var enumStrategyValue = result.GetValueForOption(enumStrategy);
+                var nullableValue = result.GetValueForOption(nullable);
 
                 await GenerateClientAsync(uriValue, outputFolderValue, namespaceValue, clientNameValue,
-                    includeSubscriptionsValue, authTokenValue, enumStrategyValue);
+                    includeSubscriptionsValue, authTokenValue, enumStrategyValue, nullableValue);
             }
         );
 
@@ -54,13 +58,13 @@ await GenerateClientAsync(uriValue, outputFolderValue, namespaceValue, clientNam
     }
 
     private static async Task GenerateClientAsync(Uri uri, string outputFolder, string namespaceName, string name,
-        bool includeSubscriptions, string authToken, string enumStrategy)
+        bool includeSubscriptions, string authToken, string enumStrategy, bool nullable)
     {
         var enumStrat = enumStrategy != null && enumStrategy.Equals("AddUnknownOption", StringComparison.InvariantCultureIgnoreCase)
             ? EnumGeneratorStrategy.AddUnknownOption
             : EnumGeneratorStrategy.FailIfMissing;
 
-        var generator = new ClientGenerator(namespaceName, name, includeSubscriptions, enumStrat);
+        var generator = new ClientGenerator(namespaceName, name, includeSubscriptions, enumStrat, nullable);
         var entries = await generator.GenerateAsync(uri, authToken);
 
         var outputPath = Path.GetFullPath(outputFolder, Environment.CurrentDirectory);

diff --git a/src/Linq2GraphQL.Generator/Properties/launchSettings.json b/src/Linq2GraphQL.Generator/Properties/launchSettings.json
@@ -2,7 +2,7 @@
   "profiles": {
     "Linq2GraphQL.Generator": {
       "commandName": "Project",
-      "commandLineArgs": "https://localhost:7184/graphql/ -c=\"SampleClient\" -n=\"Linq2GraphQL.TestClient\" -o=\"C:\\Code\\Linq2GraphQL\\test\\Linq2GraphQL.TestClient\\Generated\" -s=true -es=\"AddUnknownOption\""
+      "commandLineArgs": "https://localhost:50741/graphql/ -c=\"SampleNullableClient\" -n=\"Linq2GraphQL.TestClientNullable\" -o=\"C:\\temp\\Linq2GraphQL\\Linq2GraphQL.TestClientNullable\\Generated\" -s=true -nu=true"
     }
   }
 }
diff --git a/test/Linq2GraphQL.TestClientNullable/Generated/Client/QueryMethods.cs b/test/Linq2GraphQL.TestClientNullable/Generated/Client/QueryMethods.cs
@@ -22,13 +22,13 @@ public GraphQuery<List<Customer>> CustomerList()
         return new GraphQuery<List<Customer>>(client,  "customerList", OperationType.Query, arguments); 
     }
 
-    public GraphQuery<Customer> CustomerNullable()
+    public GraphQuery<Customer?> CustomerNullable()
     {
 	    var arguments = new List<ArgumentValue>
         {
         };
 
-        return new GraphQuery<Customer>(client,  "customerNullable", OperationType.Query, arguments); 
+        return new GraphQuery<Customer?>(client,  "customerNullable", OperationType.Query, arguments); 
     }
 
     }
diff --git a/test/Linq2GraphQL.TestClientNullable/Generated/Input/InputFactory.cs b/test/Linq2GraphQL.TestClientNullable/Generated/Input/InputFactory.cs
@@ -0,0 +1,12 @@
+using System;
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+using Linq2GraphQL.Client;
+
+namespace Linq2GraphQL.TestClientNullable;
+
+//public static class IF
+//{
+//}
+
+
diff --git a/test/Linq2GraphQL.TestClientNullable/Generated/Types/Customer.cs b/test/Linq2GraphQL.TestClientNullable/Generated/Types/Customer.cs
@@ -21,6 +21,6 @@ public partial class Customer : GraphQLTypeBase
 	public List<Order> Orders { get; set; }  
 
     [JsonPropertyName("address")]
-	public Address Address { get; set; }  
+	public Address? Address { get; set; }  
 
 }
diff --git a/test/Linq2GraphQL.TestClientNullable/Generated/Types/Order.cs b/test/Linq2GraphQL.TestClientNullable/Generated/Types/Order.cs
@@ -45,12 +45,15 @@ public partial class Order : GraphQLTypeBase
 	public Customer Customer { get; set; }  
 
     [JsonPropertyName("address")]
-	public Address Address { get; set; }  
+	public Address? Address { get; set; }  
 
     [JsonPropertyName("orderDate")]
 	public DateTimeOffset OrderDate { get; set; }  
 
     [JsonPropertyName("lines")]
 	public List<OrderLine> Lines { get; set; }  
 
+    [JsonPropertyName("entryTime")]
+	public TimeSpan? EntryTime { get; set; }  
+
 }
diff --git a/test/Linq2GraphQL.TestClientNullable/Generated/Types/OrderLine.cs b/test/Linq2GraphQL.TestClientNullable/Generated/Types/OrderLine.cs
@@ -15,12 +15,12 @@ public partial class OrderLine : GraphQLTypeBase
 	public Order Order { get; set; }  
 
     [JsonPropertyName("item")]
-	public Item Item { get; set; }  
+	public Item? Item { get; set; }  
 
     [JsonPropertyName("price")]
 	public decimal Price { get; set; }  
 
     [JsonPropertyName("quantity")]
-	public float Quantity { get; set; }  
+	public double Quantity { get; set; }  
 
 }
diff --git a/test/Linq2GraphQL.TestClientNullable/Linq2GraphQL.TestClientNullable.csproj b/test/Linq2GraphQL.TestClientNullable/Linq2GraphQL.TestClientNullable.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
-    <Nullable>disable</Nullable>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>