Adds AutoHistory for logging DB changes automatically (#1389)

* add autohistory nuget package and configure it properly

* add user id to autohistory

* use the proper autohistory package

* exclude all entities from autohistory for now

* enable autohistory for game and gameversion

* add autohistory migration

Author: Masterjun3

NuGet.Config

@@ -3,5 +3,6 @@
   <packageSources>
     <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
     <add key="Pomelo" value="https://www.myget.org/F/pomelo/api/v3/index.json" />
+    <add key="Custom Packages" value="custompackages" />
   </packageSources>
 </configuration>

TASVideos.Core/Services/SignInManager.cs

@@ -6,7 +6,6 @@
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
-using TASVideos.Core.Extensions;
 using TASVideos.Data;
 using TASVideos.Data.Entity;
 

TASVideos.Data/ApplicationDbContext.cs

@@ -27,6 +27,8 @@ public ApplicationDbContext(DbContextOptions<ApplicationDbContext> options, IHtt
 		_httpContext = httpContextAccessor;
 	}
 
+	public DbSet<AutoHistory> AutoHistory { get; set; } = null!;
+
 	public DbSet<RolePermission> RolePermission { get; set; } = null!;
 	public DbSet<WikiPage> WikiPages { get; set; } = null!;
 	public DbSet<WikiPageReferral> WikiReferrals { get; set; } = null!;
@@ -94,16 +96,65 @@ public override int SaveChanges(bool acceptAllChangesOnSuccess)
 		PerformTrackingUpdates();
 
 		ChangeTracker.AutoDetectChangesEnabled = false;
+
+		// remember added entries,
+		// before EF Core is assigning valid Ids (it does on save changes,
+		// when ids equal zero) and setting their state to
+		// Unchanged (it does on every save changes)
+		var addedEntities = ChangeTracker
+								.Entries()
+								.Where(e => e.State == EntityState.Added)
+								.ToArray();
+
+		this.EnsureAutoHistory(() => new CustomAutoHistory()
+		{
+			UserId = _httpContext?.HttpContext?.User.GetUserId() ?? -1
+		});
 		var result = base.SaveChanges(acceptAllChangesOnSuccess);
+
+		// after "SaveChanges" added enties now have gotten valid ids (if it was necessary)
+		// and the history for them can be ensured and be saved with another "SaveChanges"
+		this.EnsureAddedHistory(
+			() => new CustomAutoHistory()
+		{
+			UserId = _httpContext?.HttpContext?.User.GetUserId() ?? -1
+		}, addedEntities);
+		result += base.SaveChanges(acceptAllChangesOnSuccess);
+
 		ChangeTracker.AutoDetectChangesEnabled = true;
 
 		return result;
 	}
 
-	public override Task<int> SaveChangesAsync(CancellationToken cancellationToken = default)
+	public override async Task<int> SaveChangesAsync(CancellationToken cancellationToken = default)
 	{
 		PerformTrackingUpdates();
-		return base.SaveChangesAsync(cancellationToken);
+
+		// remember added entries,
+		// before EF Core is assigning valid Ids (it does on save changes,
+		// when ids equal zero) and setting their state to
+		// Unchanged (it does on every save changes)
+		var addedEntities = ChangeTracker
+								.Entries()
+								.Where(e => e.State == EntityState.Added)
+								.ToArray();
+
+		this.EnsureAutoHistory(() => new CustomAutoHistory()
+		{
+			UserId = _httpContext?.HttpContext?.User.GetUserId() ?? -1
+		});
+		var result = await base.SaveChangesAsync(cancellationToken);
+
+		// after "SaveChanges" added enties now have gotten valid ids (if it was necessary)
+		// and the history for them can be ensured and be saved with another "SaveChanges"
+		this.EnsureAddedHistory(
+			() => new CustomAutoHistory()
+		{
+			UserId = _httpContext?.HttpContext?.User.GetUserId() ?? -1
+		}, addedEntities);
+		result += await base.SaveChangesAsync(CancellationToken.None);
+
+		return result;
 	}
 
 	/// <summary>
@@ -421,6 +472,11 @@ protected override void OnModelCreating(ModelBuilder builder)
 		{
 			entity.HasIndex(e => e.FileExtension).IsUnique();
 		});
+
+		builder.EnableAutoHistory<CustomAutoHistory>(o =>
+		{
+			o.LimitChangedLength = false;
+		});
 	}
 
 	private void PerformTrackingUpdates()

TASVideos.Data/CustomAutoHistory.cs

@@ -0,0 +1,8 @@
+using Microsoft.EntityFrameworkCore;
+
+namespace TASVideos.Data;
+
+internal class CustomAutoHistory : AutoHistory
+{
+	public int UserId { get; set; }
+}

TASVideos.Data/Entity/Awards/Award.cs

@@ -1,11 +1,14 @@
-namespace TASVideos.Data.Entity.Awards;
+using Microsoft.EntityFrameworkCore;
+
+namespace TASVideos.Data.Entity.Awards;
 
 public enum AwardType
 {
 	User = 1,
 	Movie
 }
 
+[ExcludeFromHistory]
 public class Award
 {
 	public int Id { get; set; }

TASVideos.Data/Entity/Awards/PublicationAward.cs

@@ -1,5 +1,8 @@
-namespace TASVideos.Data.Entity.Awards;
+using Microsoft.EntityFrameworkCore;
 
+namespace TASVideos.Data.Entity.Awards;
+
+[ExcludeFromHistory]
 public class PublicationAward
 {
 	public int Id { get; set; }

TASVideos.Data/Entity/Awards/UserAward.cs

@@ -1,5 +1,8 @@
-namespace TASVideos.Data.Entity.Awards;
+using Microsoft.EntityFrameworkCore;
 
+namespace TASVideos.Data.Entity.Awards;
+
+[ExcludeFromHistory]
 public class UserAward
 {
 	public int Id { get; set; }

TASVideos.Data/Entity/BaseEntity.cs

@@ -1,4 +1,6 @@
-namespace TASVideos.Data.Entity;
+using Microsoft.EntityFrameworkCore;
+
+namespace TASVideos.Data.Entity;
 
 public interface ITrackable
 {
@@ -11,10 +13,14 @@ public interface ITrackable
 
 public class BaseEntity : ITrackable
 {
+	[ExcludeFromHistory]
 	public DateTime CreateTimestamp { get; set; }
+	[ExcludeFromHistory]
 	public string? CreateUserName { get; set; }
 
+	[ExcludeFromHistory]
 	public DateTime LastUpdateTimestamp { get; set; }
+	[ExcludeFromHistory]
 	public string? LastUpdateUserName { get; set; }
 }
 

TASVideos.Data/Entity/DeprecatedMovieFormat.cs

@@ -1,5 +1,8 @@
-namespace TASVideos.Data.Entity;
+using Microsoft.EntityFrameworkCore;
 
+namespace TASVideos.Data.Entity;
+
+[ExcludeFromHistory]
 public class DeprecatedMovieFormat : BaseEntity
 {
 	public int Id { get; set; }

TASVideos.Data/Entity/Flag.cs

@@ -1,5 +1,8 @@
-namespace TASVideos.Data.Entity;
+using Microsoft.EntityFrameworkCore;
 
+namespace TASVideos.Data.Entity;
+
+[ExcludeFromHistory]
 public class Flag : BaseEntity
 {
 	public int Id { get; set; }