VCST-1752: Fix performance degradation on SQL Server (#2834)

artem-dudarev · web-flow · commit e5df65b81ab9 · 2024-09-12T17:49:32.000+02:00
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -17,6 +17,7 @@
 
   <PropertyGroup>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <WarningsNotAsErrors>NU5048</WarningsNotAsErrors>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(MSBuildProjectName.Contains(Tests))' == false">
diff --git a/src/VirtoCommerce.Platform.Data.MySql/DbContextOptionsBuilderExtensions.cs b/src/VirtoCommerce.Platform.Data.MySql/DbContextOptionsBuilderExtensions.cs
diff --git a/src/VirtoCommerce.Platform.Data.MySql/Extensions/DbContextOptionsBuilderExtensions.cs b/src/VirtoCommerce.Platform.Data.MySql/Extensions/DbContextOptionsBuilderExtensions.cs
@@ -0,0 +1,27 @@
+using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Infrastructure;
+using Microsoft.Extensions.Configuration;
+
+namespace VirtoCommerce.Platform.Data.MySql.Extensions;
+
+public static class DbContextOptionsBuilderExtensions
+{
+    /// <summary>
+    /// Configures the context to use MySql.
+    /// </summary>
+    public static DbContextOptionsBuilder UseMySqlDatabase(
+        this DbContextOptionsBuilder optionsBuilder,
+        string? connectionString,
+        Type migrationsAssemblyMarkerType,
+        IConfiguration configuration,
+        Action<MySqlDbContextOptionsBuilder, IConfiguration>? mySqlOptionsAction = null)
+    {
+        return optionsBuilder.UseMySql(connectionString,
+            ServerVersion.AutoDetect(connectionString),
+            mySqlDbContextOptionsBuilder =>
+            {
+                mySqlDbContextOptionsBuilder.MigrationsAssembly(migrationsAssemblyMarkerType.Assembly.GetName().Name);
+                mySqlOptionsAction?.Invoke(mySqlDbContextOptionsBuilder, configuration);
+            });
+    }
+}
diff --git a/src/VirtoCommerce.Platform.Data.MySql/MySqlDataAssemblyMarker.cs b/src/VirtoCommerce.Platform.Data.MySql/MySqlDataAssemblyMarker.cs
@@ -0,0 +1,5 @@
+namespace VirtoCommerce.Platform.Data.MySql;
+
+public class MySqlDataAssemblyMarker
+{
+}
diff --git a/src/VirtoCommerce.Platform.Data.MySql/MySqlDbContextFactory.cs b/src/VirtoCommerce.Platform.Data.MySql/MySqlDbContextFactory.cs
@@ -1,8 +1,3 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.Design;
 using VirtoCommerce.Platform.Data.Repositories;
@@ -23,7 +18,7 @@ PlatformDbContext IDesignTimeDbContextFactory<PlatformDbContext>.CreateDbContext
                 connectionString,
                 ResolveServerVersion(serverVersion, connectionString),
                 db => db
-                    .MigrationsAssembly(typeof(MySqlDbContextFactory).Assembly.GetName().Name));
+                    .MigrationsAssembly(typeof(MySqlDataAssemblyMarker).Assembly.GetName().Name));
 
             return new PlatformDbContext(builder.Options);
         }
@@ -38,7 +33,7 @@ SecurityDbContext IDesignTimeDbContextFactory<SecurityDbContext>.CreateDbContext
                 connectionString,
                 ResolveServerVersion(serverVersion, connectionString),
                 db => db
-                    .MigrationsAssembly(typeof(MySqlDbContextFactory).Assembly.GetName().Name));
+                    .MigrationsAssembly(typeof(MySqlDataAssemblyMarker).Assembly.GetName().Name));
 
             builder.UseOpenIddict();
 
diff --git a/src/VirtoCommerce.Platform.Data.PostgreSql/DbContextOptionsBuilderExtensions.cs b/src/VirtoCommerce.Platform.Data.PostgreSql/DbContextOptionsBuilderExtensions.cs
diff --git a/src/VirtoCommerce.Platform.Data.PostgreSql/Extensions/DbContextOptionsBuilderExtensions.cs b/src/VirtoCommerce.Platform.Data.PostgreSql/Extensions/DbContextOptionsBuilderExtensions.cs
@@ -0,0 +1,26 @@
+using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.Configuration;
+using Npgsql.EntityFrameworkCore.PostgreSQL.Infrastructure;
+
+namespace VirtoCommerce.Platform.Data.PostgreSql.Extensions;
+
+public static class DbContextOptionsBuilderExtensions
+{
+    /// <summary>
+    /// Configures the context to use PostgreSql.
+    /// </summary>
+    public static DbContextOptionsBuilder UsePostgreSqlDatabase(
+        this DbContextOptionsBuilder optionsBuilder,
+        string? connectionString,
+        Type migrationsAssemblyMarkerType,
+        IConfiguration configuration,
+        Action<NpgsqlDbContextOptionsBuilder, IConfiguration>? npgsqlOptionsAction = null)
+    {
+        return optionsBuilder.UseNpgsql(connectionString,
+            npgsqlDbContextOptionsBuilder =>
+            {
+                npgsqlDbContextOptionsBuilder.MigrationsAssembly(migrationsAssemblyMarkerType.Assembly.GetName().Name);
+                npgsqlOptionsAction?.Invoke(npgsqlDbContextOptionsBuilder, configuration);
+            });
+    }
+}
diff --git a/src/VirtoCommerce.Platform.Data.PostgreSql/PostgreSqlDataAssemblyMarker.cs b/src/VirtoCommerce.Platform.Data.PostgreSql/PostgreSqlDataAssemblyMarker.cs
@@ -0,0 +1,5 @@
+namespace VirtoCommerce.Platform.Data.PostgreSql;
+
+public class PostgreSqlDataAssemblyMarker
+{
+}
diff --git a/src/VirtoCommerce.Platform.Data.PostgreSql/PostgreSqlDbContextFactory.cs b/src/VirtoCommerce.Platform.Data.PostgreSql/PostgreSqlDbContextFactory.cs
@@ -1,8 +1,3 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.Design;
 using VirtoCommerce.Platform.Data.Repositories;
@@ -20,7 +15,7 @@ PlatformDbContext IDesignTimeDbContextFactory<PlatformDbContext>.CreateDbContext
 
             builder.UseNpgsql(
                 connectionString,
-                db => db.MigrationsAssembly(typeof(PostgreSqlDbContextFactory).Assembly.GetName().Name));
+                db => db.MigrationsAssembly(typeof(PostgreSqlDataAssemblyMarker).Assembly.GetName().Name));
 
             return new PlatformDbContext(builder.Options);
         }
@@ -32,7 +27,7 @@ SecurityDbContext IDesignTimeDbContextFactory<SecurityDbContext>.CreateDbContext
 
             builder.UseNpgsql(
                 connectionString,
-                db => db.MigrationsAssembly(typeof(PostgreSqlDbContextFactory).Assembly.GetName().Name));
+                db => db.MigrationsAssembly(typeof(PostgreSqlDataAssemblyMarker).Assembly.GetName().Name));
 
             builder.UseOpenIddict();
 
diff --git a/src/VirtoCommerce.Platform.Data.SqlServer/DbContextOptionsBuilderExtensions.cs b/src/VirtoCommerce.Platform.Data.SqlServer/DbContextOptionsBuilderExtensions.cs
diff --git a/src/VirtoCommerce.Platform.Data.SqlServer/Extensions/DbContextOptionsBuilderExtensions.cs b/src/VirtoCommerce.Platform.Data.SqlServer/Extensions/DbContextOptionsBuilderExtensions.cs
@@ -0,0 +1,32 @@
+using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Infrastructure;
+using Microsoft.Extensions.Configuration;
+
+namespace VirtoCommerce.Platform.Data.SqlServer.Extensions;
+
+public static class DbContextOptionsBuilderExtensions
+{
+    /// <summary>
+    /// Configures the context to use SqlServer.
+    /// </summary>
+    public static DbContextOptionsBuilder UseSqlServerDatabase(
+        this DbContextOptionsBuilder optionsBuilder,
+        string? connectionString,
+        Type migrationsAssemblyMarkerType,
+        IConfiguration configuration,
+        Action<SqlServerDbContextOptionsBuilder, IConfiguration>? sqlServerOptionsAction = null)
+    {
+        return optionsBuilder.UseSqlServer(connectionString,
+            sqlServerOptionsBuilder =>
+            {
+                var compatibilityLevel = configuration.GetValue<int?>("SqlServer:CompatibilityLevel", null);
+                if (compatibilityLevel != null)
+                {
+                    sqlServerOptionsBuilder.UseCompatibilityLevel(compatibilityLevel.Value);
+                }
+
+                sqlServerOptionsBuilder.MigrationsAssembly(migrationsAssemblyMarkerType.Assembly.GetName().Name);
+                sqlServerOptionsAction?.Invoke(sqlServerOptionsBuilder, configuration);
+            });
+    }
+}
diff --git a/src/VirtoCommerce.Platform.Data.SqlServer/SqlServerDataAssemblyMarker.cs b/src/VirtoCommerce.Platform.Data.SqlServer/SqlServerDataAssemblyMarker.cs
@@ -0,0 +1,5 @@
+namespace VirtoCommerce.Platform.Data.SqlServer;
+
+public class SqlServerDataAssemblyMarker
+{
+}
diff --git a/src/VirtoCommerce.Platform.Data.SqlServer/SqlServerDbContextFactory.cs b/src/VirtoCommerce.Platform.Data.SqlServer/SqlServerDbContextFactory.cs
@@ -15,7 +15,7 @@ PlatformDbContext IDesignTimeDbContextFactory<PlatformDbContext>.CreateDbContext
 
             builder.UseSqlServer(
                 connectionString,
-                db => db.MigrationsAssembly(typeof(SqlServerDbContextFactory).Assembly.GetName().Name));
+                db => db.MigrationsAssembly(typeof(SqlServerDataAssemblyMarker).Assembly.GetName().Name));
 
             return new PlatformDbContext(builder.Options);
         }
@@ -27,7 +27,7 @@ SecurityDbContext IDesignTimeDbContextFactory<SecurityDbContext>.CreateDbContext
 
             builder.UseSqlServer(
                 connectionString,
-                db => db.MigrationsAssembly(typeof(SqlServerDbContextFactory).Assembly.GetName().Name));
+                db => db.MigrationsAssembly(typeof(SqlServerDataAssemblyMarker).Assembly.GetName().Name));
 
             builder.UseOpenIddict();
 
diff --git a/src/VirtoCommerce.Platform.Web/Startup.cs b/src/VirtoCommerce.Platform.Web/Startup.cs
@@ -46,11 +46,14 @@
 using VirtoCommerce.Platform.Core.Settings;
 using VirtoCommerce.Platform.Data.Extensions;
 using VirtoCommerce.Platform.Data.MySql;
+using VirtoCommerce.Platform.Data.MySql.Extensions;
 using VirtoCommerce.Platform.Data.MySql.HealthCheck;
 using VirtoCommerce.Platform.Data.PostgreSql;
+using VirtoCommerce.Platform.Data.PostgreSql.Extensions;
 using VirtoCommerce.Platform.Data.PostgreSql.HealthCheck;
 using VirtoCommerce.Platform.Data.Repositories;
 using VirtoCommerce.Platform.Data.SqlServer;
+using VirtoCommerce.Platform.Data.SqlServer.Extensions;
 using VirtoCommerce.Platform.Data.SqlServer.HealthCheck;
 using VirtoCommerce.Platform.DistributedLock;
 using VirtoCommerce.Platform.Hangfire.Extensions;
@@ -133,19 +136,18 @@ public void ConfigureServices(IServiceCollection services)
 
             services.AddDbContext<PlatformDbContext>((provider, options) =>
             {
-                var databaseProvider = Configuration.GetValue("DatabaseProvider", "SqlServer");
                 var connectionString = Configuration.GetConnectionString("VirtoCommerce");
 
                 switch (databaseProvider)
                 {
                     case "MySql":
-                        options.UseMySqlDatabase(connectionString);
+                        options.UseMySqlDatabase(connectionString, typeof(MySqlDataAssemblyMarker), Configuration);
                         break;
                     case "PostgreSql":
-                        options.UsePostgreSqlDatabase(connectionString);
+                        options.UsePostgreSqlDatabase(connectionString, typeof(PostgreSqlDataAssemblyMarker), Configuration);
                         break;
                     default:
-                        options.UseSqlServerDatabase(connectionString);
+                        options.UseSqlServerDatabase(connectionString, typeof(SqlServerDataAssemblyMarker), Configuration);
                         break;
                 }
             });
@@ -203,13 +205,13 @@ public void ConfigureServices(IServiceCollection services)
                 switch (databaseProvider)
                 {
                     case "MySql":
-                        options.UseMySqlDatabase(connectionString);
+                        options.UseMySqlDatabase(connectionString, typeof(MySqlDataAssemblyMarker), Configuration);
                         break;
                     case "PostgreSql":
-                        options.UsePostgreSqlDatabase(connectionString);
+                        options.UsePostgreSqlDatabase(connectionString, typeof(PostgreSqlDataAssemblyMarker), Configuration);
                         break;
                     default:
-                        options.UseSqlServerDatabase(connectionString);
+                        options.UseSqlServerDatabase(connectionString, typeof(SqlServerDataAssemblyMarker), Configuration);
                         break;
                 }
 
diff --git a/src/VirtoCommerce.Platform.Web/appsettings.json b/src/VirtoCommerce.Platform.Web/appsettings.json
@@ -5,6 +5,11 @@
     "VirtoCommerce": "Data Source=(local);Initial Catalog=VirtoCommerce3.net8;Persist Security Info=True;User ID=virto;Password=virto;Connect Timeout=30;TrustServerCertificate=True;"
     //"RedisConnectionString": "127.0.0.1:6379,ssl=False"
   },
+  "SqlServer": {
+    // Set compatibility level to 120 (SQL Server 2014) to prevent the use of OPENJSON, which has poor performance.
+    // https://github.com/dotnet/efcore/issues/32394
+    // "CompatibilityLevel": 120
+  },
   "Serilog": {
     "Using": [
       "Serilog.Sinks.Console",
