ExtendedBaseAudit

vicosanz · Nov 7, 2023 · e2e16a3 · e2e16a3
1 parent ddd52b2
commit e2e16a3
Show file tree

Hide file tree

Showing 8 changed files with 221 additions and 17 deletions.
diff --git a/Infoware.EntityFrameworkCore.AuditEntity/Extensions/DbContextExtensions.cs b/Infoware.EntityFrameworkCore.AuditEntity/Extensions/DbContextExtensions.cs
@@ -8,21 +8,21 @@ namespace Infoware.EntityFrameworkCore.AuditEntity.Extensions
 {
     public static class DbContextExtensions
     {
-        internal static Task<IBaseAudit?> FactoryBase(Type source)
+        internal static Task<IBaseAudit?> FactoryBaseAsync(Type source)
         {
             return Task.FromResult(Activator.CreateInstance(source) as IBaseAudit);
         }
 
         public static Task<int> SaveWithAuditsAsync(this DbContext context, ILogJsonSerializer logJsonSerializer, 
             Func<CancellationToken, Task<int>> baseSaveChangesAsync, CancellationToken cancellationToken = default)
         {
-            return SaveWithAuditsAsync(context, logJsonSerializer, FactoryBase, baseSaveChangesAsync, cancellationToken);
+            return SaveWithAuditsAsync(context, logJsonSerializer, FactoryBaseAsync, baseSaveChangesAsync, cancellationToken);
         }
 
         public static async Task<int> SaveWithAuditsAsync<T>(this DbContext context, ILogJsonSerializer logJsonSerializer,
             Func<Type, Task<T?>> factoryAudit, Func<CancellationToken, Task<int>> baseSaveChangesAsync, CancellationToken cancellationToken = default) where T : IBaseAudit
         {
-            var operationsUpdatesDeletes = context.ChangeTracker.Entries()
+            var operationsUpdatesDeletes = await context.ChangeTracker.Entries()
                 .Where(e => e.State == EntityState.Modified || e.State == EntityState.Deleted)
                 .AddEntriesAsync(logJsonSerializer, factoryAudit);
 
@@ -31,40 +31,45 @@ public static class DbContextExtensions
 
             var result = await baseSaveChangesAsync(cancellationToken);
 
-            var operationsAdds = entriesAdded.AddEntriesAsync(logJsonSerializer, factoryAudit, EntityState.Added);
+            var operationsAdds = await entriesAdded.AddEntriesAsync(logJsonSerializer, factoryAudit, EntityState.Added);
             context.AddRange(operationsUpdatesDeletes);
             context.AddRange(operationsAdds);
 
             await baseSaveChangesAsync(cancellationToken);
             return result;
         }
 
+        internal static IBaseAudit? FactoryBase(Type source)
+        {
+            return Activator.CreateInstance(source) as IBaseAudit;
+        }
+
         public static int SaveWithAudits(this DbContext context, ILogJsonSerializer logJsonSerializer, Func<int> baseSaveChanges)
         {
             return SaveWithAudits(context, logJsonSerializer, FactoryBase, baseSaveChanges);
         }
 
         public static int SaveWithAudits<T>(this DbContext context, ILogJsonSerializer logJsonSerializer, 
-            Func<Type, Task<T?>> factoryAudit, Func<int> baseSaveChanges) where T : IBaseAudit
+            Func<Type, T?> factoryAudit, Func<int> baseSaveChanges) where T : IBaseAudit
         {
             var operationsUpdatesDeletes = context.ChangeTracker.Entries()
                 .Where(e => e.State == EntityState.Modified || e.State == EntityState.Deleted)
-                .AddEntriesAsync(logJsonSerializer, factoryAudit);
+                .AddEntries(logJsonSerializer, factoryAudit);
 
             var entriesAdded = context.ChangeTracker.Entries()
                 .Where(e => e.State == EntityState.Added).ToList();
 
             var result = baseSaveChanges();
 
-            var operationsAdds = entriesAdded.AddEntriesAsync(logJsonSerializer, factoryAudit, EntityState.Added);
+            var operationsAdds = entriesAdded.AddEntries(logJsonSerializer, factoryAudit, EntityState.Added);
             context.AddRange(operationsUpdatesDeletes);
             context.AddRange(operationsAdds);
 
             baseSaveChanges();
             return result;
         }
 
-        internal static async Task<List<IBaseAudit>> AddEntriesAsync<T>(this IEnumerable<EntityEntry> entries, ILogJsonSerializer logJsonSerializer, 
+        internal static async Task<List<IBaseAudit>> AddEntriesAsync<T>(this IEnumerable<EntityEntry> entries, ILogJsonSerializer logJsonSerializer,
             Func<Type, Task<T?>> factoryAudit, EntityState? overrideState = null) where T : IBaseAudit
         {
             var result = new List<IBaseAudit>();
@@ -88,7 +93,52 @@ public static int SaveWithAudits(this DbContext context, ILogJsonSerializer logJ
                     if (null != prop && prop.CanWrite)
                     {
                         prop.SetValue(objResult, keyValue, null);
-                    }                    
+                    }
+
+                    switch (overrideState ?? entry.State)
+                    {
+                        case EntityState.Added:
+                            WriteHistoryAddedState(objResult, entry, logJsonSerializer);
+                            break;
+                        case EntityState.Modified:
+                            WriteHistoryModifiedState(objResult, entry, logJsonSerializer);
+                            break;
+                        case EntityState.Deleted:
+                            WriteHistoryDeletedState(objResult, entry, logJsonSerializer);
+                            break;
+                    }
+
+                    result.Add(objResult);
+                }
+            }
+            return result;
+        }
+
+        internal static List<IBaseAudit> AddEntries<T>(this IEnumerable<EntityEntry> entries, ILogJsonSerializer logJsonSerializer,
+            Func<Type, T?> factoryAudit, EntityState? overrideState = null) where T : IBaseAudit
+        {
+            var result = new List<IBaseAudit>();
+            if (entries == null) return result;
+
+            foreach (var entry in entries)
+            {
+                var auditableEntityType = entry.Entity.GetType().GetInterfaces()
+                    .FirstOrDefault(i => i.IsGenericType && i.GetGenericTypeDefinition() == typeof(IAuditable<>));
+                if (auditableEntityType != null)
+                {
+                    var keyName = entry.Metadata.FindPrimaryKey()!.Properties[0]!;
+                    var keyValue = entry.Property(keyName.Name).CurrentValue;
+
+                    Type entityAuditType = auditableEntityType.GenericTypeArguments.First();
+
+                    IBaseAudit? objResult = factoryAudit(entityAuditType);
+                    objResult!.Operation = entry.State.ToString();
+
+                    PropertyInfo? prop = entityAuditType.GetProperty("TableId", BindingFlags.Public | BindingFlags.Instance);
+                    if (null != prop && prop.CanWrite)
+                    {
+                        prop.SetValue(objResult, keyValue, null);
+                    }
 
                     switch (overrideState ?? entry.State)
                     {

diff --git a/Infoware.EntityFrameworkCore.AuditEntity/Infoware.EntityFrameworkCore.AuditEntity.csproj b/Infoware.EntityFrameworkCore.AuditEntity/Infoware.EntityFrameworkCore.AuditEntity.csproj
@@ -9,7 +9,7 @@
     <Description>Create an individual AuditEntity for selected tables to register changes</Description>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <RepositoryUrl>https://github.com/vicosanz/Infoware.EntityFrameworkCore.AuditEntity</RepositoryUrl>
-    <Version>1.0.1</Version>
+    <Version>1.0.2</Version>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/WebApplication1/BlogContext.cs b/WebApplication1/BlogContext.cs
@@ -1,6 +1,7 @@
 using Infoware.EntityFrameworkCore.AuditEntity;
 using Infoware.EntityFrameworkCore.AuditEntity.Extensions;
 using Infoware.SensitiveDataLogger.JsonSerializer;
+using Infoware.SRI.DocumentosElectronicos.Context.Models;
 using Microsoft.EntityFrameworkCore;
 using Test.Models;
 
@@ -32,15 +33,15 @@ public override int SaveChanges()
         public override async Task<int> SaveChangesAsync(CancellationToken cancellationToken = default)
         {
             return await this.SaveWithAuditsAsync(_logJsonSerializer,
-                FactoryBase, 
+                (Type source) => {
+                    var result = (IExtendedBaseAudit?) Activator.CreateInstance(source);
+                    result!.UserId = "User1";
+                    result!.UserName = "Username";
+                    return Task.FromResult((IExtendedBaseAudit?)result);
+                },  
                 (cancellationToken) => base.SaveChangesAsync(cancellationToken),
                 cancellationToken);
         }
 
-        internal static Task<IBaseAudit?> FactoryBase(Type source)
-        {
-            var result = (IBaseAudit?)Activator.CreateInstance(source);
-            return Task.FromResult(result);
-        }
     }
 }
diff --git a/WebApplication1/Migrations/20231107040916_ExtendedBaseAudit.Designer.cs b/WebApplication1/Migrations/20231107040916_ExtendedBaseAudit.Designer.cs
diff --git a/WebApplication1/Migrations/20231107040916_ExtendedBaseAudit.cs b/WebApplication1/Migrations/20231107040916_ExtendedBaseAudit.cs
@@ -0,0 +1,37 @@
+using Microsoft.EntityFrameworkCore.Migrations;
+
+#nullable disable
+
+namespace WebApplication1.Migrations
+{
+    public partial class ExtendedBaseAudit : Migration
+    {
+        protected override void Up(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.AddColumn<string>(
+                name: "UserId",
+                table: "BlogAudits",
+                type: "nvarchar(max)",
+                nullable: false,
+                defaultValue: "");
+
+            migrationBuilder.AddColumn<string>(
+                name: "UserName",
+                table: "BlogAudits",
+                type: "nvarchar(max)",
+                nullable: false,
+                defaultValue: "");
+        }
+
+        protected override void Down(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.DropColumn(
+                name: "UserId",
+                table: "BlogAudits");
+
+            migrationBuilder.DropColumn(
+                name: "UserName",
+                table: "BlogAudits");
+        }
+    }
+}
diff --git a/WebApplication1/Migrations/BlogContextModelSnapshot.cs b/WebApplication1/Migrations/BlogContextModelSnapshot.cs
@@ -61,6 +61,14 @@ protected override void BuildModel(ModelBuilder modelBuilder)
                     b.Property<long>("TableId")
                         .HasColumnType("bigint");
 
+                    b.Property<string>("UserId")
+                        .IsRequired()
+                        .HasColumnType("nvarchar(max)");
+
+                    b.Property<string>("UserName")
+                        .IsRequired()
+                        .HasColumnType("nvarchar(max)");
+
                     b.HasKey("Id");
 
                     b.ToTable("BlogAudits");

diff --git a/WebApplication1/Models/BlogAudit.cs b/WebApplication1/Models/BlogAudit.cs
@@ -1,8 +1,9 @@
 using Infoware.EntityFrameworkCore.AuditEntity;
+using Infoware.SRI.DocumentosElectronicos.Context.Models;
 
 namespace Test.Models
 {
-    public class BlogAudit : BaseAudit<Blog, long>
+    public class BlogAudit : ExtendedBaseAudit<Blog, long>
     {
     }
 }
diff --git a/WebApplication1/Models/ExtendedBaseAudit.cs b/WebApplication1/Models/ExtendedBaseAudit.cs
@@ -0,0 +1,26 @@
+using Infoware.EntityFrameworkCore.AuditEntity;
+using System;
+using System.Collections.Generic;
+using System.ComponentModel.DataAnnotations;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Infoware.SRI.DocumentosElectronicos.Context.Models
+{
+    public class ExtendedBaseAudit<TEntity, TUniqueId> : BaseAudit<TEntity, TUniqueId>, IExtendedBaseAudit where TEntity : IAuditable
+    {
+        [Required]
+        public string UserId { get; set; } = null!;
+
+        [Required]
+        public string UserName { get; set; } = null!;
+    }
+
+    public interface IExtendedBaseAudit : IBaseAudit
+    {
+        public string UserId { get; set; } 
+
+        public string UserName { get; set; } 
+    }
+}