feat: Add ToEntityTable() and ToAuditableEntityTable() extension methods

Author: artem-dudarev

src/VirtoCommerce.Platform.Data/Extensions/ModelBuilderExtensions.cs

@@ -0,0 +1,28 @@
+using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Metadata.Builders;
+using VirtoCommerce.Platform.Core.Common;
+using static VirtoCommerce.Platform.Data.Infrastructure.DbContextBase;
+
+namespace VirtoCommerce.Platform.Data.Extensions;
+
+public static class ModelBuilderExtensions
+{
+    public static EntityTypeBuilder<TEntity> ToAuditableEntityTable<TEntity>(this EntityTypeBuilder<TEntity> entityTypeBuilder, string name)
+        where TEntity : AuditableEntity
+    {
+        entityTypeBuilder.ToEntityTable(name);
+        entityTypeBuilder.Property(x => x.CreatedBy).HasMaxLength(UserNameLength);
+        entityTypeBuilder.Property(x => x.ModifiedBy).HasMaxLength(UserNameLength);
+
+        return entityTypeBuilder;
+    }
+
+    public static EntityTypeBuilder<TEntity> ToEntityTable<TEntity>(this EntityTypeBuilder<TEntity> entityTypeBuilder, string name)
+        where TEntity : Entity
+    {
+        entityTypeBuilder.ToTable(name).HasKey(x => x.Id);
+        entityTypeBuilder.Property(x => x.Id).HasMaxLength(IdLength).ValueGeneratedOnAdd();
+
+        return entityTypeBuilder;
+    }
+}

src/VirtoCommerce.Platform.Data/Infrastructure/DbContextBase.cs

@@ -9,7 +9,19 @@ namespace VirtoCommerce.Platform.Data.Infrastructure
     /// </summary>
     public class DbContextBase : DbContextWithTriggers
     {
-        public const int IdLength = 128;
+        public const int CultureNameLength = Length16;
+        public const int IdLength = Length128;
+        public const int UrlLength = Length2048;
+        public const int UserNameLength = Length64;
+
+        public const int Length16 = 16;
+        public const int Length32 = 32;
+        public const int Length64 = 64;
+        public const int Length128 = 128;
+        public const int Length256 = 256;
+        public const int Length512 = 512;
+        public const int Length1024 = 1024;
+        public const int Length2048 = 2048;
 
         public DbContextBase()
         {

src/VirtoCommerce.Platform.Data/Model/OperationLogEntity.cs

@@ -19,7 +19,7 @@ public class OperationLogEntity : AuditableEntity
         public string OperationType { get; set; }
 
 
-        [StringLength(1024)]
+        [StringLength(2048)]
         public string Detail { get; set; }
 
         public virtual OperationLog ToModel(OperationLog operation)

src/VirtoCommerce.Platform.Data/Repositories/PlatformDbContext.cs

@@ -1,5 +1,6 @@
 using System;
 using Microsoft.EntityFrameworkCore;
+using VirtoCommerce.Platform.Data.Extensions;
 using VirtoCommerce.Platform.Data.Infrastructure;
 using VirtoCommerce.Platform.Data.Localizations;
 using VirtoCommerce.Platform.Data.Model;
@@ -8,10 +9,13 @@ namespace VirtoCommerce.Platform.Data.Repositories
 {
     public class PlatformDbContext : DbContextBase
     {
-        [Obsolete("Use IdLength", DiagnosticId = "VC0009", UrlFormat = "https://docs.virtocommerce.org/products/products-virto3-versions")]
+        [Obsolete("Use Length128 or IdLength", DiagnosticId = "VC0009", UrlFormat = "https://docs.virtocommerce.org/products/products-virto3-versions")]
         protected const int _idLength128 = 128;
 
+        [Obsolete("Use Length64 or UserNameLength", DiagnosticId = "VC0010", UrlFormat = "https://docs.virtocommerce.org/products/products-virto3-versions")]
         protected const int _idLength64 = 64;
+
+        [Obsolete("Use Length2048", DiagnosticId = "VC0010", UrlFormat = "https://docs.virtocommerce.org/products/products-virto3-versions")]
         protected const int _idLength2048 = 2048;
 
         public PlatformDbContext(DbContextOptions<PlatformDbContext> options)
@@ -29,108 +33,81 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
             base.OnModelCreating(modelBuilder);
 
             #region Change logging
-            modelBuilder.Entity<OperationLogEntity>().ToTable("PlatformOperationLog").HasKey(x => x.Id);
-            modelBuilder.Entity<OperationLogEntity>().Property(x => x.Id).HasMaxLength(IdLength).ValueGeneratedOnAdd();
-            modelBuilder.Entity<OperationLogEntity>().Property(x => x.CreatedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<OperationLogEntity>().Property(x => x.ModifiedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<OperationLogEntity>().Property(x => x.Detail).HasMaxLength(_idLength2048);
-            modelBuilder.Entity<OperationLogEntity>().HasIndex(x => new { x.ObjectType, x.ObjectId })
+            modelBuilder.Entity<OperationLogEntity>().ToAuditableEntityTable("PlatformOperationLog");
+            modelBuilder.Entity<OperationLogEntity>()
+                        .HasIndex(x => new { x.ObjectType, x.ObjectId })
                         .IsUnique(false)
                         .HasDatabaseName("IX_OperationLog_ObjectType_ObjectId");
             #endregion
 
             #region Settings
-            modelBuilder.Entity<SettingEntity>().ToTable("PlatformSetting").HasKey(x => x.Id);
-            modelBuilder.Entity<SettingEntity>().Property(x => x.Id).HasMaxLength(IdLength).ValueGeneratedOnAdd();
-            modelBuilder.Entity<SettingEntity>().Property(x => x.CreatedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<SettingEntity>().Property(x => x.ModifiedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<SettingEntity>().HasIndex(x => new { x.ObjectType, x.ObjectId })
+            modelBuilder.Entity<SettingEntity>().ToAuditableEntityTable("PlatformSetting");
+            modelBuilder.Entity<SettingEntity>()
+                        .HasIndex(x => new { x.ObjectType, x.ObjectId })
                         .IsUnique(false)
                         .HasDatabaseName("IX_ObjectType_ObjectId");
 
-            modelBuilder.Entity<SettingValueEntity>().ToTable("PlatformSettingValue").HasKey(x => x.Id);
-            modelBuilder.Entity<SettingValueEntity>().Property(x => x.Id).HasMaxLength(IdLength).ValueGeneratedOnAdd();
-            modelBuilder.Entity<SettingValueEntity>().Property(x => x.CreatedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<SettingValueEntity>().Property(x => x.ModifiedBy).HasMaxLength(_idLength64);
-
-            modelBuilder.Entity<SettingValueEntity>().HasOne(x => x.Setting)
+            modelBuilder.Entity<SettingValueEntity>().ToAuditableEntityTable("PlatformSettingValue");
+            modelBuilder.Entity<SettingValueEntity>().Property(x => x.DecimalValue).HasColumnType("decimal(18,5)");
+            modelBuilder.Entity<SettingValueEntity>()
+                        .HasOne(x => x.Setting)
                         .WithMany(x => x.SettingValues)
                         .HasForeignKey(x => x.SettingId)
                         .OnDelete(DeleteBehavior.Cascade)
                         .IsRequired();
-
-            modelBuilder.Entity<SettingValueEntity>()
-                .Property(x => x.DecimalValue)
-                .HasColumnType("decimal(18,5)");
-
             #endregion
 
             #region Localization
-            modelBuilder.Entity<LocalizedItemEntity>().ToTable("PlatformLocalizedItem").HasKey(x => x.Id);
-            modelBuilder.Entity<LocalizedItemEntity>().Property(x => x.Id).HasMaxLength(IdLength).ValueGeneratedOnAdd();
-            modelBuilder.Entity<LocalizedItemEntity>().Property(x => x.CreatedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<LocalizedItemEntity>().Property(x => x.ModifiedBy).HasMaxLength(_idLength64);
+            modelBuilder.Entity<LocalizedItemEntity>().ToAuditableEntityTable("PlatformLocalizedItem");
             modelBuilder.Entity<LocalizedItemEntity>()
-                .HasIndex(x => new { x.Name, x.Alias })
-                .IsUnique(false)
-                .HasDatabaseName("IX_PlatformLocalizedItem_Name_Alias");
+                        .HasIndex(x => new { x.Name, x.Alias })
+                        .IsUnique(false)
+                        .HasDatabaseName("IX_PlatformLocalizedItem_Name_Alias");
             #endregion
 
             #region Dynamic Properties
-
-            modelBuilder.Entity<DynamicPropertyEntity>().ToTable("PlatformDynamicProperty").HasKey(x => x.Id);
-            modelBuilder.Entity<DynamicPropertyEntity>().Property(x => x.Id).HasMaxLength(IdLength).ValueGeneratedOnAdd();
-            modelBuilder.Entity<DynamicPropertyEntity>().Property(x => x.CreatedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<DynamicPropertyEntity>().Property(x => x.ModifiedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<DynamicPropertyEntity>().HasIndex(x => new { x.ObjectType, x.Name })
+            modelBuilder.Entity<DynamicPropertyEntity>().ToAuditableEntityTable("PlatformDynamicProperty");
+            modelBuilder.Entity<DynamicPropertyEntity>()
+                        .HasIndex(x => new { x.ObjectType, x.Name })
                         .HasDatabaseName("IX_PlatformDynamicProperty_ObjectType_Name")
-                        .IsUnique(true);
+                        .IsUnique();
 
-            modelBuilder.Entity<DynamicPropertyNameEntity>().ToTable("PlatformDynamicPropertyName").HasKey(x => x.Id);
-            modelBuilder.Entity<DynamicPropertyNameEntity>().Property(x => x.Id).HasMaxLength(IdLength).ValueGeneratedOnAdd();
-            modelBuilder.Entity<DynamicPropertyNameEntity>().Property(x => x.CreatedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<DynamicPropertyNameEntity>().Property(x => x.ModifiedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<DynamicPropertyNameEntity>().HasOne(x => x.Property)
+            modelBuilder.Entity<DynamicPropertyNameEntity>().ToAuditableEntityTable("PlatformDynamicPropertyName");
+            modelBuilder.Entity<DynamicPropertyNameEntity>()
+                        .HasOne(x => x.Property)
                         .WithMany(x => x.DisplayNames)
                         .HasForeignKey(x => x.PropertyId)
                         .OnDelete(DeleteBehavior.Cascade);
             modelBuilder.Entity<DynamicPropertyNameEntity>()
                         .HasIndex(x => new { x.PropertyId, x.Locale, x.Name })
                         .HasDatabaseName("IX_PlatformDynamicPropertyName_PropertyId_Locale_Name")
-                        .IsUnique(true);
+                        .IsUnique();
 
-            modelBuilder.Entity<DynamicPropertyDictionaryItemEntity>().ToTable("PlatformDynamicPropertyDictionaryItem").HasKey(x => x.Id);
-            modelBuilder.Entity<DynamicPropertyDictionaryItemEntity>().Property(x => x.Id).HasMaxLength(IdLength).ValueGeneratedOnAdd();
-            modelBuilder.Entity<DynamicPropertyDictionaryItemEntity>().Property(x => x.CreatedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<DynamicPropertyDictionaryItemEntity>().Property(x => x.ModifiedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<DynamicPropertyDictionaryItemEntity>().HasOne(x => x.Property)
+            modelBuilder.Entity<DynamicPropertyDictionaryItemEntity>().ToAuditableEntityTable("PlatformDynamicPropertyDictionaryItem");
+            modelBuilder.Entity<DynamicPropertyDictionaryItemEntity>()
+                        .HasOne(x => x.Property)
                         .WithMany(x => x.DictionaryItems)
                         .HasForeignKey(x => x.PropertyId)
                         .OnDelete(DeleteBehavior.Cascade);
             modelBuilder.Entity<DynamicPropertyDictionaryItemEntity>()
                         .HasIndex(x => new { x.PropertyId, x.Name })
                         .HasDatabaseName("IX_PlatformDynamicPropertyDictionaryItem_PropertyId_Name")
-                        .IsUnique(true);
+                        .IsUnique();
 
-            modelBuilder.Entity<DynamicPropertyDictionaryItemNameEntity>().ToTable("PlatformDynamicPropertyDictionaryItemName").HasKey(x => x.Id);
-            modelBuilder.Entity<DynamicPropertyDictionaryItemNameEntity>().Property(x => x.Id).HasMaxLength(IdLength).ValueGeneratedOnAdd();
-            modelBuilder.Entity<DynamicPropertyDictionaryItemNameEntity>().Property(x => x.CreatedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<DynamicPropertyDictionaryItemNameEntity>().Property(x => x.ModifiedBy).HasMaxLength(_idLength64);
-            modelBuilder.Entity<DynamicPropertyDictionaryItemNameEntity>().HasOne(x => x.DictionaryItem)
+            modelBuilder.Entity<DynamicPropertyDictionaryItemNameEntity>().ToAuditableEntityTable("PlatformDynamicPropertyDictionaryItemName");
+            modelBuilder.Entity<DynamicPropertyDictionaryItemNameEntity>()
+                        .HasOne(x => x.DictionaryItem)
                         .WithMany(x => x.DisplayNames)
                         .HasForeignKey(x => x.DictionaryItemId)
                         .OnDelete(DeleteBehavior.Cascade);
             modelBuilder.Entity<DynamicPropertyDictionaryItemNameEntity>()
                         .HasIndex(x => new { x.DictionaryItemId, x.Locale, x.Name })
                         .HasDatabaseName("IX_PlatformDynamicPropertyDictionaryItemName_DictionaryItemId_Locale_Name")
-                        .IsUnique(true);
-
+                        .IsUnique();
             #endregion
 
             #region Raw license
-            modelBuilder.Entity<RawLicenseEntity>().ToTable("RawLicense").HasKey(x => x.Id);
-            modelBuilder.Entity<RawLicenseEntity>().Property(x => x.Id).HasMaxLength(IdLength).ValueGeneratedOnAdd();
-            modelBuilder.Entity<RawLicenseEntity>().Property(x => x.Data);
+            modelBuilder.Entity<RawLicenseEntity>().ToEntityTable("RawLicense");
             #endregion
         }
     }