Add IgnoreEntityAddedDefaultValue

Add IgnoreEntityAddedDefaultValue

Author: JonathanMagnan

src/shared/Z.EF.Plus.Audit.Shared/Audit/AuditEntityAdded.cs

@@ -16,6 +16,7 @@
 using System.Linq;
 
 #elif EFCORE
+using System;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.ChangeTracking;
 
@@ -56,8 +57,9 @@ public static void AuditEntityAdded(AuditEntry auditEntry, ObjectStateEntry obje
             {
                 var name = record.GetName(i);
                 var value = record.GetValue(i);
+	            var type = record.GetFieldType(i);
 
-                if (auditEntry.Parent.Configuration.UseNullForDBNullValue && value == DBNull.Value)
+				if (auditEntry.Parent.Configuration.UseNullForDBNullValue && value == DBNull.Value)
                 {
                     value = null;
                 }
@@ -74,14 +76,26 @@ public static void AuditEntityAdded(AuditEntry auditEntry, ObjectStateEntry obje
                         auditEntry.Parent.Configuration.AuditEntryPropertyFactory(new AuditEntryPropertyArgs(auditEntry, objectStateEntry, string.Concat(prefix, name), null, value)) :
                         new AuditEntryProperty();
 
-                    auditEntryProperty.Build(auditEntry, string.Concat(prefix, name), null, value);
+	                if (auditEntry.Parent.CurrentOrDefaultConfiguration.IgnoreEntityAddedDefaultValue && type != typeof(object) && value != null)
+	                {
+		                var checkDefaultValue = DefaultValue(type);
+						if (checkDefaultValue != null && checkDefaultValue.Equals(value))
+		                {
+			                value = null;
+		                } 
+					}
+
+					auditEntryProperty.Build(auditEntry, string.Concat(prefix, name), null, value);
                     auditEntry.Properties.Add(auditEntryProperty);
                 }
             }
         }
+
+
+
 #elif EFCORE
-    /// <summary>Audit entity added.</summary>
-    /// <param name="objectStateEntry">The object state entry.</param>
+        /// <summary>Audit entity added.</summary>
+        /// <param name="objectStateEntry">The object state entry.</param>
         public static void AuditEntityAdded(AuditEntry entry, EntityEntry objectStateEntry)
         {
             foreach (var propertyEntry in objectStateEntry.Metadata.GetProperties())
@@ -92,13 +106,33 @@ public static void AuditEntityAdded(AuditEntry entry, EntityEntry objectStateEnt
                 {
                     var auditEntryProperty = entry.Parent.Configuration.AuditEntryPropertyFactory != null ?
                         entry.Parent.Configuration.AuditEntryPropertyFactory(new AuditEntryPropertyArgs(entry, objectStateEntry, propertyEntry.Name, null, property.CurrentValue)) :
-                        new AuditEntryProperty();
+                        new AuditEntryProperty(); 
+
+	                var value = property.CurrentValue;
 
-                    auditEntryProperty.Build(entry, propertyEntry.Name, null, property.CurrentValue);
+					if (entry.Parent.CurrentOrDefaultConfiguration.IgnoreEntityAddedDefaultValue && property.Metadata.FieldInfo != null &&  property.Metadata.FieldInfo.FieldType != typeof(object) && property.CurrentValue != null)
+	                {
+		                var checkDefaultValue = DefaultValue(property.Metadata.FieldInfo.FieldType);
+		                if (checkDefaultValue != null && checkDefaultValue.Equals(property.CurrentValue))
+		                {
+			                value = null;
+		                }
+	                } 
+
+					auditEntryProperty.Build(entry, propertyEntry.Name, null, value);
                     entry.Properties.Add(auditEntryProperty);
                 }
             }
         }
 #endif
-    }
+
+	    // https://stackoverflow.com/questions/2490244/default-value-of-a-type-at-runtime
+	    internal static object DefaultValue(Type type)
+	    {
+		    if (type.IsValueType)
+			    return Activator.CreateInstance(type);
+
+		    return null;
+	    }
+	}
 }

src/shared/Z.EF.Plus.Audit.Shared/AuditConfiguration.cs

@@ -49,11 +49,11 @@ public AuditConfiguration()
         }
 
         internal Func<Type, string> EntityNameFactory { get; set; } 
-        internal Func<Type, string, string> PropertyNameFactory { get; set; } 
+        internal Func<Type, string, string> PropertyNameFactory { get; set; }
 
-        /// <summary>Gets or sets the audit entry factory.</summary>
-        /// <value>The audit entry factory.</value>
-        public Func<AuditEntryFactoryArgs, AuditEntry> AuditEntryFactory { get; set; }
+	    /// <summary>Gets or sets the audit entry factory.</summary>
+		/// <value>The audit entry factory.</value>
+		public Func<AuditEntryFactoryArgs, AuditEntry> AuditEntryFactory { get; set; }
 
         /// <summary>Gets or sets the audit entry property factory.</summary>
         /// <value>The audit entry property factory.</value>
@@ -95,9 +95,13 @@ public AuditConfiguration()
         /// <value>true if ignore entity soft deleted, false if not.</value>
         public bool IgnoreEntitySoftDeleted { get; set; }
 
-        /// <summary>Gets or sets a value indicating whether the association with Added state are audited.</summary>
-        /// <value>true if association with Added state are audited, false if not.</value>
-        public bool IgnoreRelationshipAdded { get; set; }
+        /// <summary>Gets or sets if default value should be considered as null.</summary>
+        /// <value>true if default value should be considered as null.</value>
+        public bool IgnoreEntityAddedDefaultValue { get; set; }
+
+		/// <summary>Gets or sets a value indicating whether the association with Added state are audited.</summary>
+		/// <value>true if association with Added state are audited, false if not.</value>
+		public bool IgnoreRelationshipAdded { get; set; }
 
         /// <summary>Gets or sets a value indicating whether the association with Deleted state are audited.</summary>
         /// <value>true if association with Deleted state are audited, false if not.</value>
@@ -156,6 +160,7 @@ public AuditConfiguration Clone()
                 IgnoreEntityAdded = IgnoreEntityAdded,
                 IgnoreEntityModified = IgnoreEntityModified,
                 IgnoreEntityDeleted = IgnoreEntityDeleted,
+				IgnoreEntityAddedDefaultValue = IgnoreEntityAddedDefaultValue,
                 IgnoreEntitySoftAdded = IgnoreEntitySoftAdded,
                 IgnoreEntitySoftDeleted = IgnoreEntitySoftDeleted,
                 IgnorePropertyUnchanged = IgnorePropertyUnchanged,