feat: support JSON data type in MySQL (#257)

* feat: support JSON data type in MySQL

* fix: added more JSON overrides and a way to debug example codegen

* fix: added JSON support in batch mysql

* fix: docs and linting

* fix: add TODO

* fix: re-add make target

* fix: revert Dapper DefaultTypeMap line

* fix: revert ConfigureSqlMapper line

Author: SockworkOrange

CodeGenerator/CodeGenerator.cs

@@ -7,6 +7,7 @@
 using System.IO;
 using System.Linq;
 using System.Text;
+using System.Text.Json;
 using System.Threading.Tasks;
 using Enum = Plugin.Enum;
 
@@ -172,7 +173,11 @@ public Task<GenerateResponse> Generate(GenerateRequest generateRequest)
         if (Options.DebugRequest)
             return Task.FromResult(new GenerateResponse
             {
-                Files = { RequestToFile(generateRequest) }
+                Files =
+                {
+                    RequestToJsonFile(generateRequest),
+                    RequestToProtobufFile(generateRequest)
+                }
             });
 
         var fileQueries = GetFileQueries();
@@ -201,10 +206,25 @@ string QueryFilenameToClassName(string filenameWithExtension)
         }
     }
 
-    private static Plugin.File RequestToFile(GenerateRequest request)
+    private static ByteString GetOptionsWithoutDebugRequest(GenerateRequest request)
+    {
+        var text = Encoding.UTF8.GetString(request.PluginOptions.ToByteArray());
+        var rawOptions = JsonSerializer.Deserialize<RawOptions>(text) ?? throw new InvalidOperationException();
+        var newOptions = rawOptions with { DebugRequest = false };
+        return ByteString.CopyFromUtf8(JsonSerializer.Serialize(request));
+    }
+
+
+    private static Plugin.File RequestToJsonFile(GenerateRequest request)
     {
         var formatter = new JsonFormatter(JsonFormatter.Settings.Default.WithIndentation());
-        request.PluginOptions = ByteString.CopyFrom("{}", Encoding.UTF8); // TODO this resets all of the options - should reset only DebugRequest option
+        request.PluginOptions = GetOptionsWithoutDebugRequest(request);
         return new Plugin.File { Name = "request.json", Contents = ByteString.CopyFromUtf8(formatter.Format(request)) };
     }
+
+    private static Plugin.File RequestToProtobufFile(GenerateRequest request)
+    {
+        request.PluginOptions = GetOptionsWithoutDebugRequest(request);
+        return new Plugin.File { Name = "request.message", Contents = request.ToByteString() };
+    }
 }

CodeGenerator/Generators/CsprojGen.cs

@@ -7,11 +7,13 @@ namespace SqlcGenCsharp.Generators;
 
 internal class CsprojGen(string outputDirectory, string projectName, string namespaceName, Options options)
 {
+    // TODO this logic needs to be moved to the Drivers project
     private const string DefaultDapperVersion = "2.1.66";
     private const string DefaultNpgsqlVersion = "8.0.6";
     private const string DefaultMysqlConnectorVersion = "2.4.0";
     private const string DefaultSqliteVersion = "9.0.0";
     private const string DefaultCsvHelperVersion = "33.0.1";
+    private const string DefaultSystemTextJsonVersion = "9.0.6";
 
     public File GenerateFile()
     {
@@ -48,18 +50,28 @@ string GetPackageReferences()
         {
             var optionalDapperPackageReference = options.UseDapper
                 ? Environment.NewLine + $"""        <PackageReference Include="Dapper" Version="{GetDapperVersion(options)}"/>"""
-                : "";
-            var optionalCsvHelper = options.DriverName == DriverName.MySqlConnector
+                : string.Empty;
+            var optionalCsvHelper = options.DriverName is DriverName.MySqlConnector
                 ? Environment.NewLine + $"""        <PackageReference Include="CsvHelper" Version="{DefaultCsvHelperVersion}"/>"""
-                : "";
+                : string.Empty;
+            var optionalSystemTextJson = IsSystemTextJsonNeeded()
+                ? Environment.NewLine + $"""        <PackageReference Include="System.Text.Json" Version="{DefaultSystemTextJsonVersion}"/>"""
+                : string.Empty;
             return $"""
                 <ItemGroup>
-                    <PackageReference Include="{options.DriverName.ToName()}" Version="{GetDriverVersion(options)}"/>{optionalDapperPackageReference}{optionalCsvHelper}
+                    <PackageReference Include="{options.DriverName.ToName()}" Version="{GetDriverVersion(options)}"/>{optionalDapperPackageReference}{optionalCsvHelper}{optionalSystemTextJson}
                 </ItemGroup>
             """;
         }
     }
 
+    private bool IsSystemTextJsonNeeded()
+    {
+        if (options.DotnetFramework.IsDotnetCore())
+            return false;
+        return options.DriverName is DriverName.MySqlConnector or DriverName.Npgsql;
+    }
+
     private static string GetDriverVersion(Options options)
     {
         if (string.IsNullOrEmpty(options.OverrideDriverVersion))

CodeGenerator/Generators/ModelsGen.cs

@@ -23,14 +23,15 @@ public File GenerateFile(
         Dictionary<string, Dictionary<string, Table>> tables,
         Dictionary<string, Dictionary<string, Enum>> enums)
     {
-        var usingDirectives = dbDriver.GetUsingDirectivesForModels();
+        var usingDirectives = dbDriver
+            .GetUsingDirectivesForModels()
+            .Select(x => UsingDirective(ParseName(x)))
+            .ToArray();
         var dataclassModels = GenerateDataClasses(tables);
         var enumModels = GenerateEnums(enums);
+        var models = dataclassModels.Concat(enumModels).ToArray();
 
-        var root = RootGen.CompilationRootGen(
-            IdentifierName(namespaceName),
-            usingDirectives,
-            dataclassModels.Concat(enumModels).ToArray());
+        var root = RootGen.CompilationRootGen(IdentifierName(namespaceName), usingDirectives, models);
         root = root.AddCommentOnTop(Consts.AutoGeneratedComment);
 
         return new File

CodeGenerator/Generators/QueriesGen.cs

@@ -49,7 +49,10 @@ private static CompilationUnitSyntax AddResharperDisables(CompilationUnitSyntax
     private (UsingDirectiveSyntax[], MemberDeclarationSyntax) GenerateClass(IEnumerable<Query> queries,
         string className)
     {
-        var usingDirectives = dbDriver.GetUsingDirectivesForQueries();
+        var usingDirectives = dbDriver
+            .GetUsingDirectivesForQueries()
+            .Select(x => UsingDirective(ParseName(x)))
+            .ToArray();
         var classMembers = queries.SelectMany(GetMembersForSingleQuery);
         return (usingDirectives, GetClassDeclaration(className, classMembers));
     }

CodeGenerator/Generators/UtilsGen.cs

@@ -1,5 +1,6 @@
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 using SqlcGenCsharp.Drivers;
+using System.Linq;
 using static Microsoft.CodeAnalysis.CSharp.SyntaxFactory;
 using File = Plugin.File;
 
@@ -19,8 +20,12 @@ internal class UtilsGen(DbDriver dbDriver, string namespaceName)
         if (classImpl == null)
             return null;
 
+        var usingDirectives = dbDriver
+            .GetUsingDirectivesForUtils()
+            .Select(x => UsingDirective(ParseName(x)))
+            .ToArray();
         var root = RootGen.CompilationRootGen(
-            IdentifierName(NamespaceName), dbDriver.GetUsingDirectivesForUtils(), [classImpl]);
+            IdentifierName(NamespaceName), usingDirectives, [classImpl]);
         root = root.AddCommentOnTop(Consts.AutoGeneratedComment);
 
         return new File

CodegenTests/test-requests/DefaultSchemaEnum/request.json

@@ -101,5 +101,5 @@
     }
   ],
   "sqlc_version": "v1.27.0",
-  "plugin_options": "e30="
+  "plugin_options": "eyJTZXR0aW5ncyI6eyJWZXJzaW9uIjoiMiIsIkVuZ2luZSI6Im15c3FsIiwiU2NoZW1hIjpbIkNvZGVnZW5UZXN0cy90ZXN0LXJlcXVlc3RzL0RlZmF1bHRTY2hlbWFFbnVtL3NjaGVtYS5zcWwiXSwiUXVlcmllcyI6WyJDb2RlZ2VuVGVzdHMvdGVzdC1yZXF1ZXN0cy9EZWZhdWx0U2NoZW1hRW51bS9xdWVyeS5zcWwiXSwiQ29kZWdlbiI6eyJPdXQiOiIuL0NvZGVnZW5UZXN0cy90ZXN0LXJlcXVlc3RzL0RlZmF1bHRTY2hlbWFFbnVtIiwiUGx1Z2luIjoiY3NoYXJwIiwiT3B0aW9ucyI6WzEyMywzNCwxMDAsMTAxLDk4LDExNywxMDMsODIsMTAxLDExMywxMTcsMTAxLDExNSwxMTYsMzQsNTgsMTE2LDExNCwxMTcsMTAxLDEyNV0sIkVudiI6W10sIlByb2Nlc3MiOnsiQ21kIjoiLi9kaXN0L0xvY2FsUnVubmVyIn0sIldhc20iOm51bGx9fSwiQ2F0YWxvZyI6eyJDb21tZW50IjoiIiwiRGVmYXVsdFNjaGVtYSI6InB1YmxpYyIsIk5hbWUiOiIiLCJTY2hlbWFzIjpbeyJDb21tZW50IjoiIiwiTmFtZSI6InB1YmxpYyIsIlRhYmxlcyI6W3siUmVsIjp7IkNhdGFsb2ciOiIiLCJTY2hlbWEiOiIiLCJOYW1lIjoiZHVtbXlfdGFibGUifSwiQ29sdW1ucyI6W3siTmFtZSI6ImR1bW15X2NvbHVtbiIsIk5vdE51bGwiOmZhbHNlLCJJc0FycmF5IjpmYWxzZSwiQ29tbWVudCI6IiIsIkxlbmd0aCI6MSwiSXNOYW1lZFBhcmFtIjpmYWxzZSwiSXNGdW5jQ2FsbCI6ZmFsc2UsIlNjb3BlIjoiIiwiVGFibGUiOnsiQ2F0YWxvZyI6IiIsIlNjaGVtYSI6IiIsIk5hbWUiOiJkdW1teV90YWJsZSJ9LCJUYWJsZUFsaWFzIjoiIiwiVHlwZSI6eyJDYXRhbG9nIjoiIiwiU2NoZW1hIjoiIiwiTmFtZSI6ImR1bW15X3RhYmxlX2R1bW15X2NvbHVtbiJ9LCJJc1NxbGNTbGljZSI6ZmFsc2UsIkVtYmVkVGFibGUiOm51bGwsIk9yaWdpbmFsTmFtZSI6IiIsIlVuc2lnbmVkIjpmYWxzZSwiQXJyYXlEaW1zIjowfV0sIkNvbW1lbnQiOiIifV0sIkVudW1zIjpbeyJOYW1lIjoiZHVtbXlfdGFibGVfZHVtbXlfY29sdW1uIiwiVmFscyI6WyJ4IiwieSJdLCJDb21tZW50IjoiIn1dLCJDb21wb3NpdGVUeXBlcyI6W119XX0sIlF1ZXJpZXMiOlt7IlRleHQiOiJTRUxFQ1QgZHVtbXlfY29sdW1uIEZST00gZHVtbXlfdGFibGUgTElNSVQgMSIsIk5hbWUiOiJUZXN0T25lIiwiQ21kIjoiOm9uZSIsIkNvbHVtbnMiOlt7Ik5hbWUiOiJkdW1teV9jb2x1bW4iLCJOb3ROdWxsIjpmYWxzZSwiSXNBcnJheSI6ZmFsc2UsIkNvbW1lbnQiOiIiLCJMZW5ndGgiOjEsIklzTmFtZWRQYXJhbSI6ZmFsc2UsIklzRnVuY0NhbGwiOmZhbHNlLCJTY29wZSI6IiIsIlRhYmxlIjp7IkNhdGFsb2ciOiIiLCJTY2hlbWEiOiIiLCJOYW1lIjoiZHVtbXlfdGFibGUifSwiVGFibGVBbGlhcyI6IiIsIlR5cGUiOnsiQ2F0YWxvZyI6IiIsIlNjaGVtYSI6IiIsIk5hbWUiOiJkdW1teV90YWJsZV9kdW1teV9jb2x1bW4ifSwiSXNTcWxjU2xpY2UiOmZhbHNlLCJFbWJlZFRhYmxlIjpudWxsLCJPcmlnaW5hbE5hbWUiOiJkdW1teV9jb2x1bW4iLCJVbnNpZ25lZCI6ZmFsc2UsIkFycmF5RGltcyI6MH1dLCJQYXJhbXMiOltdLCJDb21tZW50cyI6W10sIkZpbGVuYW1lIjoicXVlcnkuc3FsIiwiSW5zZXJ0SW50b1RhYmxlIjpudWxsfSx7IlRleHQiOiJJTlNFUlQgSU5UTyBkdW1teV90YWJsZSAoZHVtbXlfY29sdW1uKSBWQUxVRVMgKD8pIiwiTmFtZSI6IlRlc3RJbnNlcnQiLCJDbWQiOiI6ZXhlYyIsIkNvbHVtbnMiOltdLCJQYXJhbXMiOlt7Ik51bWJlciI6MSwiQ29sdW1uIjp7Ik5hbWUiOiJkdW1teV9jb2x1bW4iLCJOb3ROdWxsIjpmYWxzZSwiSXNBcnJheSI6ZmFsc2UsIkNvbW1lbnQiOiIiLCJMZW5ndGgiOjEsIklzTmFtZWRQYXJhbSI6ZmFsc2UsIklzRnVuY0NhbGwiOmZhbHNlLCJTY29wZSI6IiIsIlRhYmxlIjp7IkNhdGFsb2ciOiIiLCJTY2hlbWEiOiJwdWJsaWMiLCJOYW1lIjoiZHVtbXlfdGFibGUifSwiVGFibGVBbGlhcyI6IiIsIlR5cGUiOnsiQ2F0YWxvZyI6IiIsIlNjaGVtYSI6IiIsIk5hbWUiOiJkdW1teV90YWJsZV9kdW1teV9jb2x1bW4ifSwiSXNTcWxjU2xpY2UiOmZhbHNlLCJFbWJlZFRhYmxlIjpudWxsLCJPcmlnaW5hbE5hbWUiOiJkdW1teV9jb2x1bW4iLCJVbnNpZ25lZCI6ZmFsc2UsIkFycmF5RGltcyI6MH19XSwiQ29tbWVudHMiOltdLCJGaWxlbmFtZSI6InF1ZXJ5LnNxbCIsIkluc2VydEludG9UYWJsZSI6eyJDYXRhbG9nIjoiIiwiU2NoZW1hIjoiIiwiTmFtZSI6ImR1bW15X3RhYmxlIn19XSwiU3FsY1ZlcnNpb24iOiJ2MS4yNy4wIiwiUGx1Z2luT3B0aW9ucyI6WzEyMywzNCwxMDAsMTAxLDk4LDExNywxMDMsODIsMTAxLDExMywxMTcsMTAxLDExNSwxMTYsMzQsNTgsMTE2LDExNCwxMTcsMTAxLDEyNV0sIkdsb2JhbE9wdGlvbnMiOltdfQ=="
 }