bug: Fix EF wrapper MySQL option handling for plugins and user variables (#272)

Author: kenrickyap

AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector/AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector.csproj

@@ -6,6 +6,10 @@
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
+  <ItemGroup>
+    <InternalsVisibleTo Include="AwsWrapperDataProvider.EntityFrameworkCore.Tests" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.EntityFrameworkCore" Version="9.0.14" />
     <PackageReference Include="Microsoft.EntityFrameworkCore.Relational" Version="9.0.14" />

AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector/AwsWrapperDbContextOptionsBuilderExtensions.cs

@@ -1,4 +1,4 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License").
 // You may not use this file except in compliance with the License.
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-using AwsWrapperDataProvider.EntityFrameworkCore.MySQL;
+using AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector;
 using Microsoft.EntityFrameworkCore.Diagnostics;
 using Microsoft.EntityFrameworkCore.Infrastructure;
 

AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector/AwsWrapperOptionsExtension.cs

@@ -18,7 +18,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 
-namespace AwsWrapperDataProvider.EntityFrameworkCore.MySQL;
+namespace AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector;
 
 public class AwsWrapperOptionsExtension : IDbContextOptionsExtension
 {

AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector/AwsWrapperRelationalConnection.cs

@@ -1,4 +1,4 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License").
 // You may not use this file except in compliance with the License.
@@ -13,13 +13,15 @@
 // limitations under the License.
 
 using System.Data.Common;
+using AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector.RelationalConnectionDialects;
 using Microsoft.EntityFrameworkCore.Storage;
 
-namespace AwsWrapperDataProvider.EntityFrameworkCore.MySQL;
+namespace AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector;
 
 public class AwsWrapperRelationalConnection : RelationalConnection, IAwsWrapperRelationalConnection
 {
     private readonly string wrapperConnectionString;
+    private readonly IRelationalConnectionDialect relationalConnectionDialect;
 
     public AwsWrapperRelationalConnection(
         RelationalConnectionDependencies dependencies, IRelationalConnection targetRelationalConnection) : base(dependencies)
@@ -30,13 +32,19 @@ public AwsWrapperRelationalConnection(
             .OfType<AwsWrapperOptionsExtension>()
             .FirstOrDefault();
 
-        this.wrapperConnectionString = extension?.WrapperConnectionString ?? throw new InvalidOperationException("AwsWrapperOptionsExtension not found.");
+        if (extension is null)
+        {
+            throw new InvalidOperationException("AwsWrapperOptionsExtension not found.");
+        }
+
+        this.relationalConnectionDialect = RelationalConnectionDialectProvider.GetDialect(extension.WrappedExtension);
+        this.wrapperConnectionString = this.relationalConnectionDialect.NormalizeConnectionString(extension.WrapperConnectionString);
     }
 
     public IRelationalConnection? TargetRelationalConnection { get; set; }
 
     protected override DbConnection CreateDbConnection()
     {
-        return new AwsWrapperConnection(typeof(MySqlConnector.MySqlConnection), this.wrapperConnectionString!);
+        return new AwsWrapperConnection(this.relationalConnectionDialect.UnderlyingConnectionType, this.wrapperConnectionString);
     }
 }

AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector/IAwsWrapperRelationalConnection.cs

@@ -14,7 +14,7 @@
 
 using Microsoft.EntityFrameworkCore.Storage;
 
-namespace AwsWrapperDataProvider.EntityFrameworkCore.MySQL;
+namespace AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector;
 
 public interface IAwsWrapperRelationalConnection : IRelationalConnection
 {

AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector/README.md

@@ -21,6 +21,21 @@ services.AddDbContext<MyDbContext>(options =>
         wrappedOptions => wrappedOptions.UseMySql(connectionString)));
 ```
 
+## Custom Provider Registration
+
+The wrapper automatically detects supported EF Core MySQL providers (e.g. Pomelo) by matching the assembly name prefix of the wrapped options extension. If you are using an unsupported or custom EF Core MySQL provider, you can register it manually using `RelationalConnectionDialectProvider.RegisterDialect`:
+
+```csharp
+using AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector.RelationalConnectionDialects;
+
+// Register a custom dialect before configuring the DbContext.
+RelationalConnectionDialectProvider.RegisterDialect(
+    "MyCustom.EntityFrameworkCore.MySql",
+    MyCustomRelationalConnectionDialect.Instance);
+```
+
+The first argument is the assembly name prefix that the provider's options extension belongs to. The second argument is an implementation of `IRelationalConnectionDialect` that specifies the underlying connection type and any connection string normalization.
+
 ## Example
 
 See the [MySqlEntityFrameworkExample](../docs/examples/MySqlEntityFrameworkExample/) project for a complete working demonstration.

AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector/RelationalConnectionDialects/EfMySqlAssemblyPrefixes.cs

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License").
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector.RelationalConnectionDialects;
+
+public static class EfMySqlAssemblyPrefixes
+{
+    public static string Pomelo = "Pomelo.EntityFrameworkCore.MySql";
+}

AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector/RelationalConnectionDialects/IRelationalConnectionDialect.cs

@@ -0,0 +1,33 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License").
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector.RelationalConnectionDialects;
+
+/// <summary>
+/// Per–EF-MySQL-provider rules for the wrapper relational connection (underlying ADO.NET type and wrapper connection-string normalization).
+/// </summary>
+public interface IRelationalConnectionDialect
+{
+    /// <summary>
+    /// Gets the target connection type passed to <see cref="AwsWrapperDataProvider.AwsWrapperConnection"/>.
+    /// </summary>
+    Type UnderlyingConnectionType { get; }
+
+    /// <summary>
+    /// Normalizes the user-supplied wrapper connection string before opening the wrapper connection.
+    /// </summary>
+    /// <param name="wrapperConnectionString">Connection string including wrapper keys (e.g. <c>Plugins=</c>).</param>
+    /// <returns>Connection string to store on the opened <see cref="AwsWrapperDataProvider.AwsWrapperConnection"/>.</returns>
+    string NormalizeConnectionString(string wrapperConnectionString);
+}

AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector/RelationalConnectionDialects/PomeloEfMySqlRelationalConnectionDialect.cs

@@ -0,0 +1,55 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License").
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System.Data.Common;
+using System.Reflection;
+using MySqlConnector;
+
+namespace AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector.RelationalConnectionDialects;
+
+/// <summary>
+/// Pomelo <c>EntityFrameworkCore.MySql</c>: targets <see cref="MySqlConnection"/>. Normalization invokes Pomelo's internal
+/// mandatory connection-string options when present; otherwise applies the same MySqlConnector defaults manually.
+/// </summary>
+internal sealed class PomeloEfMySqlRelationalConnectionDialect : IRelationalConnectionDialect
+{
+    internal static readonly PomeloEfMySqlRelationalConnectionDialect Instance = new();
+
+    private PomeloEfMySqlRelationalConnectionDialect()
+    {
+    }
+
+    /// <inheritdoc />
+    public Type UnderlyingConnectionType => typeof(MySqlConnection);
+
+    /// <inheritdoc />
+    public string NormalizeConnectionString(string wrapperConnectionString)
+    {
+        var cs = wrapperConnectionString;
+        ApplyManualMySqlConnectorMandatoryDefaults(ref cs);
+        return cs;
+    }
+
+    private static void ApplyManualMySqlConnectorMandatoryDefaults(ref string connectionString)
+    {
+        var builder = new DbConnectionStringBuilder
+        {
+            ConnectionString = connectionString,
+        };
+
+        builder["AllowUserVariables"] = true;
+        builder["UseAffectedRows"] = false;
+        connectionString = builder.ConnectionString;
+    }
+}

AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector/RelationalConnectionDialects/RelationalConnectionDialectProvider.cs

@@ -0,0 +1,69 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License").
+// You may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using Microsoft.EntityFrameworkCore.Infrastructure;
+
+namespace AwsWrapperDataProvider.EntityFrameworkCore.MySqlConnector.RelationalConnectionDialects;
+
+/// <summary>
+/// Selects <see cref="IRelationalConnectionDialect"/> for the configured EF Core MySQL provider.
+/// </summary>
+public static class RelationalConnectionDialectProvider
+{
+    private static readonly Dictionary<string, IRelationalConnectionDialect> DialectsByAssemblyPrefix = new()
+    {
+        { EfMySqlAssemblyPrefixes.Pomelo, PomeloEfMySqlRelationalConnectionDialect.Instance },
+    };
+
+    /// <summary>
+    /// Returns the dialect for the EF MySQL provider that registered <paramref name="wrappedExtension"/>.
+    /// </summary>
+    /// <param name="wrappedExtension">The wrapped options extension (e.g. from <c>UseMySql</c>).</param>
+    /// <returns>The dialect instance.</returns>
+    /// <exception cref="InvalidOperationException">Thrown when no supported provider is detected.</exception>
+    public static IRelationalConnectionDialect GetDialect(IDbContextOptionsExtension? wrappedExtension)
+    {
+        if (wrappedExtension is not null)
+        {
+            var assemblyName = wrappedExtension.GetType().Assembly.GetName().Name ?? string.Empty;
+            foreach (var (prefix, dialect) in DialectsByAssemblyPrefix)
+            {
+                if (assemblyName.StartsWith(prefix, StringComparison.Ordinal))
+                {
+                    return dialect;
+                }
+            }
+        }
+
+        throw new InvalidOperationException(BuildUnsupportedRelationalConnectionMessage(wrappedExtension));
+    }
+
+    public static void RegisterDialect(string assemblyPrefix, IRelationalConnectionDialect dialect)
+    {
+        DialectsByAssemblyPrefix[assemblyPrefix] = dialect;
+    }
+
+    private static string BuildUnsupportedRelationalConnectionMessage(
+        IDbContextOptionsExtension? wrappedExtension)
+    {
+        var extensionDetail = wrappedExtension is null
+            ? "none (wrapped extension was null)"
+            : $"{wrappedExtension.GetType().FullName} (Assembly={wrappedExtension.GetType().Assembly.GetName().Name})";
+
+        return
+            "The relational connection from the wrapped Entity Framework Core provider is not supported for AWS Advanced .NET Data Provider MySQL integration. " +
+            $"Wrapped extension: {extensionDetail}. " +
+            "Supported provider: Pomelo.EntityFrameworkCore.MySql.";
+    }
+}