Add default type mappings for remaining complex types to support comp…

…iled models in EF Core 8.
lauxjpn · Feb 12, 2024 · ee1058b · ee1058b
1 parent 9559ca1
commit ee1058b
Show file tree

Hide file tree

Showing 10 changed files with 215 additions and 7 deletions.
diff --git a/src/EFCore.MySql.Json.Microsoft/Query/Internal/MySqlJsonMicrosoftDomTranslator.cs b/src/EFCore.MySql.Json.Microsoft/Query/Internal/MySqlJsonMicrosoftDomTranslator.cs
@@ -186,7 +186,7 @@ private SqlExpression ApplyPathLocationTypeMapping(SqlExpression expression)
                 sqlConstantExpression.TypeMapping is MySqlStringTypeMapping stringTypeMapping &&
                 !stringTypeMapping.IsUnquoted)
             {
-                pathLocation = sqlConstantExpression.ApplyTypeMapping(stringTypeMapping.Clone(true));
+                pathLocation = sqlConstantExpression.ApplyTypeMapping(stringTypeMapping.Clone(unquoted: true));
             }
 
             return pathLocation;

diff --git a/src/EFCore.MySql.Json.Microsoft/Storage/Internal/MySqlJsonMicrosoftTypeMapping.cs b/src/EFCore.MySql.Json.Microsoft/Storage/Internal/MySqlJsonMicrosoftTypeMapping.cs
@@ -15,6 +15,8 @@ namespace Pomelo.EntityFrameworkCore.MySql.Json.Microsoft.Storage.Internal
 {
     public class MySqlJsonMicrosoftTypeMapping<T> : MySqlJsonTypeMapping<T>
     {
+        public static new MySqlJsonMicrosoftTypeMapping<T> Default { get; } = new("json", null, null, false, true);
+
         // Called via reflection.
         // ReSharper disable once UnusedMember.Global
         public MySqlJsonMicrosoftTypeMapping(
@@ -48,6 +50,13 @@ protected MySqlJsonMicrosoftTypeMapping(
         protected override RelationalTypeMapping Clone(RelationalTypeMappingParameters parameters)
             => new MySqlJsonMicrosoftTypeMapping<T>(parameters, MySqlDbType, NoBackslashEscapes, ReplaceLineBreaksWithCharFunction);
 
+        protected override RelationalTypeMapping Clone(bool? noBackslashEscapes = null, bool? replaceLineBreaksWithCharFunction = null)
+            => new MySqlJsonMicrosoftTypeMapping<T>(
+                Parameters,
+                MySqlDbType,
+                noBackslashEscapes ?? NoBackslashEscapes,
+                replaceLineBreaksWithCharFunction ?? ReplaceLineBreaksWithCharFunction);
+
         public override Expression GenerateCodeLiteral(object value)
             => value switch
             {

diff --git a/src/EFCore.MySql.Json.Newtonsoft/Query/Internal/MySqlJsonNewtonsoftDomTranslator.cs b/src/EFCore.MySql.Json.Newtonsoft/Query/Internal/MySqlJsonNewtonsoftDomTranslator.cs
@@ -182,7 +182,7 @@ private SqlExpression ApplyPathLocationTypeMapping(SqlExpression expression)
                 sqlConstantExpression.TypeMapping is MySqlStringTypeMapping stringTypeMapping &&
                 !stringTypeMapping.IsUnquoted)
             {
-                pathLocation = sqlConstantExpression.ApplyTypeMapping(stringTypeMapping.Clone(true));
+                pathLocation = sqlConstantExpression.ApplyTypeMapping(stringTypeMapping.Clone(unquoted: true));
             }
 
             return pathLocation;

diff --git a/src/EFCore.MySql.Json.Newtonsoft/Storage/Internal/MySqlJsonNewtonsoftTypeMapping.cs b/src/EFCore.MySql.Json.Newtonsoft/Storage/Internal/MySqlJsonNewtonsoftTypeMapping.cs
@@ -16,6 +16,8 @@ namespace Pomelo.EntityFrameworkCore.MySql.Json.Newtonsoft.Storage.Internal
 {
     public class MySqlJsonNewtonsoftTypeMapping<T> : MySqlJsonTypeMapping<T>
     {
+        public static new MySqlJsonNewtonsoftTypeMapping<T> Default { get; } = new("json", null, null, false, true);
+
         // Called via reflection.
         // ReSharper disable once UnusedMember.Global
         public MySqlJsonNewtonsoftTypeMapping(
@@ -45,6 +47,13 @@ protected MySqlJsonNewtonsoftTypeMapping(
         protected override RelationalTypeMapping Clone(RelationalTypeMappingParameters parameters)
             => new MySqlJsonNewtonsoftTypeMapping<T>(parameters, MySqlDbType, NoBackslashEscapes, ReplaceLineBreaksWithCharFunction);
 
+        protected override RelationalTypeMapping Clone(bool? noBackslashEscapes = null, bool? replaceLineBreaksWithCharFunction = null)
+            => new MySqlJsonNewtonsoftTypeMapping<T>(
+                Parameters,
+                MySqlDbType,
+                noBackslashEscapes ?? NoBackslashEscapes,
+                replaceLineBreaksWithCharFunction ?? ReplaceLineBreaksWithCharFunction);
+
         public override Expression GenerateCodeLiteral(object value)
             => value switch
             {

diff --git a/src/EFCore.MySql/Design/Internal/MySqlCSharpRuntimeAnnotationCodeGenerator.cs b/src/EFCore.MySql/Design/Internal/MySqlCSharpRuntimeAnnotationCodeGenerator.cs
@@ -0,0 +1,38 @@
+// Copyright (c) Pomelo Foundation. All rights reserved.
+// Licensed under the MIT. See LICENSE in the project root for license information.
+
+using Microsoft.EntityFrameworkCore.ChangeTracking;
+using Microsoft.EntityFrameworkCore.Design.Internal;
+using Microsoft.EntityFrameworkCore.Storage;
+using Pomelo.EntityFrameworkCore.MySql.Storage.Internal;
+
+namespace Pomelo.EntityFrameworkCore.MySql.Design.Internal;
+
+public class MySqlCSharpRuntimeAnnotationCodeGenerator : RelationalCSharpRuntimeAnnotationCodeGenerator
+{
+    public MySqlCSharpRuntimeAnnotationCodeGenerator(
+        CSharpRuntimeAnnotationCodeGeneratorDependencies dependencies,
+        RelationalCSharpRuntimeAnnotationCodeGeneratorDependencies relationalDependencies)
+        : base(dependencies, relationalDependencies)
+    {
+    }
+
+    public override bool Create(
+        CoreTypeMapping typeMapping,
+        CSharpRuntimeAnnotationCodeGeneratorParameters parameters,
+        ValueComparer valueComparer = null,
+        ValueComparer keyValueComparer = null,
+        ValueComparer providerValueComparer = null)
+    {
+        var result = base.Create(typeMapping, parameters, valueComparer, keyValueComparer, providerValueComparer);
+
+        if (typeMapping is IMySqlCSharpRuntimeAnnotationTypeMappingCodeGenerator extension)
+        {
+            extension.Create(
+                CreateDefaultTypeMapping(typeMapping, parameters),
+                parameters);
+        }
+
+        return result;
+    }
+}
diff --git a/src/EFCore.MySql/Design/Internal/MySqlDesignTimeServices.cs b/src/EFCore.MySql/Design/Internal/MySqlDesignTimeServices.cs
@@ -3,6 +3,7 @@
 
 using Pomelo.EntityFrameworkCore.MySql.Scaffolding.Internal;
 using Microsoft.EntityFrameworkCore.Design;
+using Microsoft.EntityFrameworkCore.Design.Internal;
 using Microsoft.EntityFrameworkCore.Scaffolding;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -14,6 +15,7 @@ public virtual void ConfigureDesignTimeServices(IServiceCollection serviceCollec
         {
             serviceCollection.AddEntityFrameworkMySql();
             new EntityFrameworkRelationalDesignServicesBuilder(serviceCollection)
+                .TryAdd<ICSharpRuntimeAnnotationCodeGenerator, MySqlCSharpRuntimeAnnotationCodeGenerator>()
                 .TryAdd<IAnnotationCodeGenerator, MySqlAnnotationCodeGenerator>()
                 .TryAdd<IDatabaseModelFactory, MySqlDatabaseModelFactory>()
                 .TryAdd<IProviderConfigurationCodeGenerator, MySqlCodeGenerator>()

diff --git a/src/EFCore.MySql/Query/ExpressionTranslators/Internal/MySqlJsonPocoTranslator.cs b/src/EFCore.MySql/Query/ExpressionTranslators/Internal/MySqlJsonPocoTranslator.cs
@@ -27,7 +27,7 @@ public MySqlJsonPocoTranslator(
         {
             _typeMappingSource = typeMappingSource;
             _sqlExpressionFactory = sqlExpressionFactory;
-            _unquotedStringTypeMapping = ((MySqlStringTypeMapping)_typeMappingSource.FindMapping(typeof(string))).Clone(true);
+            _unquotedStringTypeMapping = ((MySqlStringTypeMapping)_typeMappingSource.FindMapping(typeof(string))).Clone(unquoted: true);
             _intTypeMapping = _typeMappingSource.FindMapping(typeof(int));
         }
 

diff --git a/src/EFCore.MySql/Storage/Internal/IMySqlCSharpRuntimeAnnotationTypeMappingCodeGenerator.cs b/src/EFCore.MySql/Storage/Internal/IMySqlCSharpRuntimeAnnotationTypeMappingCodeGenerator.cs
@@ -0,0 +1,14 @@
+// Copyright (c) Pomelo Foundation. All rights reserved.
+// Licensed under the MIT. See LICENSE in the project root for license information.
+
+using Microsoft.EntityFrameworkCore.Design.Internal;
+using Microsoft.EntityFrameworkCore.Storage;
+
+namespace Pomelo.EntityFrameworkCore.MySql.Storage.Internal;
+
+public interface IMySqlCSharpRuntimeAnnotationTypeMappingCodeGenerator
+{
+    void Create(
+        CoreTypeMapping defaultTypeMapping,
+        CSharpRuntimeAnnotationCodeGeneratorParameters parameters);
+}
diff --git a/src/EFCore.MySql/Storage/Internal/MySqlJsonTypeMapping.cs b/src/EFCore.MySql/Storage/Internal/MySqlJsonTypeMapping.cs
@@ -2,10 +2,13 @@
 // Licensed under the MIT. See LICENSE in the project root for license information.
 
 using System;
+using System.Collections.Generic;
 using System.Data.Common;
+using System.Linq;
 using JetBrains.Annotations;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.ChangeTracking;
+using Microsoft.EntityFrameworkCore.Design.Internal;
 using Microsoft.EntityFrameworkCore.Storage;
 using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
 using MySqlConnector;
@@ -14,6 +17,8 @@ namespace Pomelo.EntityFrameworkCore.MySql.Storage.Internal
 {
     public class MySqlJsonTypeMapping<T> : MySqlJsonTypeMapping
     {
+        public static new MySqlJsonTypeMapping<T> Default { get; } = new("json", null, null, false, true);
+
         public MySqlJsonTypeMapping(
             [NotNull] string storeType,
             [CanBeNull] ValueConverter valueConverter,
@@ -41,9 +46,16 @@ protected MySqlJsonTypeMapping(
 
         protected override RelationalTypeMapping Clone(RelationalTypeMappingParameters parameters)
             => new MySqlJsonTypeMapping<T>(parameters, MySqlDbType, NoBackslashEscapes, ReplaceLineBreaksWithCharFunction);
+
+        protected override RelationalTypeMapping Clone(bool? noBackslashEscapes = null, bool? replaceLineBreaksWithCharFunction = null)
+            => new MySqlJsonTypeMapping<T>(
+                Parameters,
+                MySqlDbType,
+                noBackslashEscapes ?? NoBackslashEscapes,
+                replaceLineBreaksWithCharFunction ?? ReplaceLineBreaksWithCharFunction);
     }
 
-    public abstract class MySqlJsonTypeMapping : MySqlStringTypeMapping
+    public abstract class MySqlJsonTypeMapping : MySqlStringTypeMapping, IMySqlCSharpRuntimeAnnotationTypeMappingCodeGenerator
     {
         public MySqlJsonTypeMapping(
             [NotNull] string storeType,
@@ -87,6 +99,13 @@ protected MySqlJsonTypeMapping(
         {
         }
 
+        /// <summary>
+        /// Supports compiled models via IMySqlCSharpRuntimeAnnotationTypeMappingCodeGenerator.Create.
+        /// </summary>
+        protected abstract RelationalTypeMapping Clone(
+            bool? noBackslashEscapes = null,
+            bool? replaceLineBreaksWithCharFunction = null);
+
         protected override void ConfigureParameter(DbParameter parameter)
         {
             base.ConfigureParameter(parameter);
@@ -98,5 +117,52 @@ protected override void ConfigureParameter(DbParameter parameter)
                 parameter.Value = (string)mySqlJsonString;
             }
         }
+
+        void IMySqlCSharpRuntimeAnnotationTypeMappingCodeGenerator.Create(
+            CoreTypeMapping defaultTypeMapping,
+            CSharpRuntimeAnnotationCodeGeneratorParameters parameters)
+        {
+            if (defaultTypeMapping is not MySqlStringTypeMapping mysqlDefaultTypeMapping)
+            {
+                return;
+            }
+
+            var cloneParameters = new List<string>();
+
+            if (NoBackslashEscapes != mysqlDefaultTypeMapping.NoBackslashEscapes)
+            {
+                cloneParameters.Add($"noBackslashEscapes: {NoBackslashEscapes}");
+            }
+
+            if (ReplaceLineBreaksWithCharFunction != mysqlDefaultTypeMapping.ReplaceLineBreaksWithCharFunction)
+            {
+                cloneParameters.Add($"replaceLineBreaksWithCharFunction: {ReplaceLineBreaksWithCharFunction}");
+            }
+
+            if (cloneParameters.Any())
+            {
+                var mainBuilder = parameters.MainBuilder;
+
+                mainBuilder.AppendLine(";");
+
+                mainBuilder
+                    .Append($"{parameters.TargetName}.TypeMapping = (({GetType().Name}){parameters.TargetName}.TypeMapping).Clone(")
+                    .IncrementIndent();
+
+                for (var i = 0; i < cloneParameters.Count; i++)
+                {
+                    if (i > 0)
+                    {
+                        mainBuilder.AppendLine(",");
+                    }
+
+                    mainBuilder.Append(cloneParameters[i]);
+                }
+
+                mainBuilder
+                    .AppendLine(")")
+                    .DecrementIndent();
+            }
+        }
     }
 }
diff --git a/src/EFCore.MySql/Storage/Internal/MySqlStringTypeMapping.cs b/src/EFCore.MySql/Storage/Internal/MySqlStringTypeMapping.cs
@@ -2,8 +2,11 @@
 // Licensed under the MIT. See LICENSE in the project root for license information.
 
 using System;
+using System.Collections.Generic;
 using System.Data.Common;
+using System.Linq;
 using JetBrains.Annotations;
+using Microsoft.EntityFrameworkCore.Design.Internal;
 using Microsoft.EntityFrameworkCore.Storage;
 using Microsoft.EntityFrameworkCore.Storage.Json;
 using Microsoft.EntityFrameworkCore.Utilities;
@@ -15,7 +18,7 @@ namespace Pomelo.EntityFrameworkCore.MySql.Storage.Internal
     ///     This API supports the Entity Framework Core infrastructure and is not intended to be used
     ///     directly from your code. This API may change or be removed in future releases.
     /// </summary>
-    public class MySqlStringTypeMapping : MySqlTypeMapping
+    public class MySqlStringTypeMapping : MySqlTypeMapping, IMySqlCSharpRuntimeAnnotationTypeMappingCodeGenerator
     {
         public static MySqlStringTypeMapping Default { get; } = new("varchar", StoreTypePostfix.Size);
 
@@ -103,8 +106,18 @@ private static int CalculateSize(bool unicode, int? size)
         protected override RelationalTypeMapping Clone(RelationalTypeMappingParameters parameters)
             => new MySqlStringTypeMapping(parameters, MySqlDbType, NoBackslashEscapes, ReplaceLineBreaksWithCharFunction, IsUnquoted, ForceToString);
 
-        public virtual RelationalTypeMapping Clone(bool? unquoted = null, bool? forceToString = null)
-            => new MySqlStringTypeMapping(Parameters, MySqlDbType, NoBackslashEscapes, ReplaceLineBreaksWithCharFunction, unquoted ?? IsUnquoted, forceToString ?? ForceToString);
+        public virtual RelationalTypeMapping Clone(
+            bool? unquoted = null,
+            bool? forceToString = null,
+            bool? noBackslashEscapes = null,
+            bool? replaceLineBreaksWithCharFunction = null)
+            => new MySqlStringTypeMapping(
+                Parameters,
+                MySqlDbType,
+                noBackslashEscapes ?? NoBackslashEscapes,
+                replaceLineBreaksWithCharFunction ?? ReplaceLineBreaksWithCharFunction,
+                unquoted ?? IsUnquoted,
+                forceToString ?? ForceToString);
 
         /// <summary>
         ///     This API supports the Entity Framework Core infrastructure and is not intended to be used
@@ -189,5 +202,62 @@ public static string EscapeBackslashes(string literal, bool escapeBackslashes)
                 ? literal.Replace(@"\", @"\\")
                 : literal;
         }
+
+        void IMySqlCSharpRuntimeAnnotationTypeMappingCodeGenerator.Create(
+            CoreTypeMapping defaultTypeMapping,
+            CSharpRuntimeAnnotationCodeGeneratorParameters parameters)
+        {
+            if (defaultTypeMapping is not MySqlStringTypeMapping mysqlDefaultTypeMapping)
+            {
+                return;
+            }
+
+            var cloneParameters = new List<string>();
+
+            if (IsUnquoted != mysqlDefaultTypeMapping.IsUnquoted)
+            {
+                cloneParameters.Add($"unquoted: {IsUnquoted}");
+            }
+
+            if (ForceToString != mysqlDefaultTypeMapping.ForceToString)
+            {
+                cloneParameters.Add($"forceToString: {ForceToString}");
+            }
+
+            if (NoBackslashEscapes != mysqlDefaultTypeMapping.NoBackslashEscapes)
+            {
+                cloneParameters.Add($"noBackslashEscapes: {NoBackslashEscapes}");
+            }
+
+            if (ReplaceLineBreaksWithCharFunction != mysqlDefaultTypeMapping.ReplaceLineBreaksWithCharFunction)
+            {
+                cloneParameters.Add($"replaceLineBreaksWithCharFunction: {ReplaceLineBreaksWithCharFunction}");
+            }
+
+            if (cloneParameters.Any())
+            {
+                var mainBuilder = parameters.MainBuilder;
+
+                mainBuilder.AppendLine(";");
+
+                mainBuilder
+                    .Append($"{parameters.TargetName}.TypeMapping = (({GetType().Name}){parameters.TargetName}.TypeMapping).Clone(")
+                    .IncrementIndent();
+
+                for (var i = 0; i < cloneParameters.Count; i++)
+                {
+                    if (i > 0)
+                    {
+                        mainBuilder.AppendLine(",");
+                    }
+
+                    mainBuilder.Append(cloneParameters[i]);
+                }
+
+                mainBuilder
+                    .AppendLine(")")
+                    .DecrementIndent();
+            }
+        }
     }
 }