Source generator read models

Directory.Packages.props

@@ -7,12 +7,12 @@
     <PackageVersion Include="LinqGen" Version="0.3.1" />
     <PackageVersion Include="Nerdbank.FullDuplexStream" Version="1.1.12" />
     <PackageVersion Include="Nerdbank.Streams" Version="2.11.74" />
-    <PackageVersion Include="NexusMods.MnemonicDB" Version="0.9.29" />
-    <PackageVersion Include="NexusMods.MnemonicDB.Abstractions" Version="0.9.29" />
-    <PackageVersion Include="NexusMods.MnemonicDB.Storage" Version="0.9.29" />
-    <PackageVersion Include="NexusMods.Paths" Version="0.9.4" />
+    <PackageVersion Include="NexusMods.MnemonicDB" Version="0.9.52" />
+    <PackageVersion Include="NexusMods.MnemonicDB.Abstractions" Version="0.9.52" />
+    <PackageVersion Include="NexusMods.MnemonicDB.Storage" Version="0.9.52" />
+    <PackageVersion Include="NexusMods.Paths" Version="0.9.5" />
     <PackageVersion Include="NexusMods.Hashing.xxHash64" Version="2.0.1" />
-    <PackageVersion Include="NexusMods.Paths.TestingHelpers" Version="0.9.4" />
+    <PackageVersion Include="NexusMods.Paths.TestingHelpers" Version="0.9.5" />
     <PackageVersion Include="NexusMods.Archives.Nx" Version="0.4.0" />
     <PackageVersion Include="NexusMods.Telemetry.OpenTelemetry" Version="1.0.0" />
     <PackageVersion Include="FomodInstaller.Interface" Version="1.2.0" />
@@ -113,6 +113,7 @@
     <PackageVersion Include="Humanizer" Version="2.14.1" />
     <PackageVersion Include="ini-parser-netstandard" Version="2.5.2" />
     <PackageVersion Include="Mutagen.Bethesda.Skyrim" Version="0.44.0" />
+    <PackageVersion Include="NexusMods.MnemonicDB.SourceGenerator" Version="0.9.52" />
     <PackageVersion Include="NLog.Extensions.Logging" Version="5.3.11" />
     <PackageVersion Include="OneOf" Version="3.0.271" />
     <PackageVersion Include="ReactiveUI.Fody" Version="19.5.41" />

benchmarks/NexusMods.Benchmarks/Benchmarks/Loadouts/Harness/ABenchmarkDatamodel.cs

@@ -27,7 +27,7 @@ public class ABenchmarkDatamodel(IServiceProvider provider) : ADataModelTest<ABe
 
     public new IGame Game => base.Game;
     public new GameInstallation Install => base.Install;
-    public new Loadout.Model BaseLoadout => base.BaseLoadout;
+    public new Loadout.ReadOnly BaseLoadout => base.BaseLoadout;
 
     public static ABenchmarkDatamodel WithMod(IServiceProvider provider, string modName, IEnumerable<string> files)
     {

benchmarks/NexusMods.Benchmarks/Benchmarks/Loadouts/Harness/ASynchronizerBenchmark.cs

@@ -31,7 +31,7 @@ protected void Init(string baseModName, string fileList)
         if (_defaultSynchronizer == null)
             throw new Exception($"Can't cast synchronizer to {typeof(DefaultSynchronizer)}. Did the test StubbedGame code change?");
 
-        _installation = _datamodel.BaseLoadout.Installation;
+        _installation = _datamodel.BaseLoadout.InstallationInstance;
         _diskStateRegistry = _serviceProvider.GetRequiredService<IDiskStateRegistry>();
     }
 

benchmarks/NexusMods.Benchmarks/Benchmarks/Loadouts/IngestOnly/BackupNewFiles.cs

@@ -2,6 +2,7 @@
 using NexusMods.Abstractions.DiskState;
 using NexusMods.Abstractions.GameLocators;
 using NexusMods.Abstractions.Games.DTO;
+using NexusMods.Abstractions.Loadouts.Files;
 using NexusMods.Benchmarks.Benchmarks.Loadouts.Harness;
 using NexusMods.Benchmarks.Interfaces;
 using NexusMods.Hashing.xxHash64;

src/Abstractions/NexusMods.Abstractions.DiskState/HashCacheEntry.cs

@@ -1,16 +1,13 @@
 using NexusMods.Abstractions.MnemonicDB.Attributes;
-using NexusMods.Hashing.xxHash64;
-using NexusMods.MnemonicDB.Abstractions;
 using NexusMods.MnemonicDB.Abstractions.Attributes;
 using NexusMods.MnemonicDB.Abstractions.Models;
-using NexusMods.Paths;
 
 namespace NexusMods.Abstractions.DiskState;
 
 /// <summary>
 /// Attributes for each entry in the HashCache
 /// </summary>
-public static class HashCacheEntry
+public partial class HashCacheEntry : IModelDefinition
 {
     private const string Namespace = "NexusMods.Abstractions.DiskState.HashCacheEntry";
 
@@ -33,45 +30,4 @@ public static class HashCacheEntry
     /// The size of the file
     /// </summary>
     public static readonly SizeAttribute Size = new(Namespace, nameof(Size)) { NoHistory = true };
-
-
-    public class Model(ITransaction tx) : Entity(tx, (byte)IdPartitions.HashCache)
-    {
-        /// <summary>
-        /// The xxHash64 of the name
-        /// </summary>
-        public Hash NameHash
-        {
-            get => HashCacheEntry.NameHash.Get(this);
-            set => HashCacheEntry.NameHash.Add(this, value);
-        }
-
-        /// <summary>
-        /// The xxHash64 hash of the file
-        /// </summary>
-        public Hash Hash
-        {
-            get => HashCacheEntry.Hash.Get(this);
-            set => HashCacheEntry.Hash.Add(this, value);
-        }
-
-        /// <summary>
-        /// Last time the file was modified
-        /// </summary>
-        public DateTime LastModified
-        {
-            get => HashCacheEntry.LastModified.Get(this);
-            set => HashCacheEntry.LastModified.Add(this, value);
-        }
-
-        /// <summary>
-        /// The size of the file
-        /// </summary>
-        public Size Size
-        {
-            get => HashCacheEntry.Size.Get(this);
-            set => HashCacheEntry.Size.Add(this, value);
-        }
-    }
-
 }

src/Abstractions/NexusMods.Abstractions.DiskState/IFileHashCache.cs

@@ -20,7 +20,7 @@ public interface IFileHashCache
     ///     you should call <see cref="IFileHashCache.IndexFileAsync" />; which will update the underlying
     ///     cached item.
     /// </remarks>
-    bool TryGetCached(AbsolutePath path, out HashCacheEntry.Model entry);
+    bool TryGetCached(AbsolutePath path, out HashCacheEntry.ReadOnly entry);
 
     /// <summary>
     ///     Asynchronously indexes the folder specified by <paramref name="path" />; putting it in the cache.

src/Abstractions/NexusMods.Abstractions.DiskState/NexusMods.Abstractions.DiskState.csproj

@@ -5,6 +5,7 @@
     <ItemGroup>
       <ProjectReference Include="..\NexusMods.Abstractions.GameLocators\NexusMods.Abstractions.GameLocators.csproj" />
       <ProjectReference Include="..\NexusMods.Abstractions.Loadouts\NexusMods.Abstractions.Loadouts.csproj" />
+      <PackageReference Include="NexusMods.MnemonicDB.SourceGenerator" PrivateAssets="all" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />        
     </ItemGroup>
 
     <ItemGroup>

src/Abstractions/NexusMods.Abstractions.FileStore/Downloads/DownloadAnalysis.cs

@@ -4,6 +4,7 @@
 using NexusMods.Hashing.xxHash64;
 using NexusMods.MnemonicDB.Abstractions;
 using NexusMods.MnemonicDB.Abstractions.Attributes;
+using NexusMods.MnemonicDB.Abstractions.BuiltInEntities;
 using NexusMods.MnemonicDB.Abstractions.IndexSegments;
 using NexusMods.MnemonicDB.Abstractions.Models;
 using NexusMods.MnemonicDB.Storage;
@@ -15,7 +16,7 @@ namespace NexusMods.Abstractions.FileStore.Downloads;
 /// <summary>
 /// Attributes for the analysis data for a downloaded file
 /// </summary>
-public static class DownloadAnalysis
+public partial class DownloadAnalysis : IModelDefinition
 {
     private const string Namespace = "NexusMods.Abstractions.FileStore.Downloads.DownloadAnalysis";
     /// <summary>
@@ -46,82 +47,30 @@ public static class DownloadAnalysis
     /// for example "the_awesome_mod_v1.0.zip"
     /// </summary>
     public static readonly StringAttribute SuggestedName = new(Namespace, nameof(SuggestedName));
-
-
-    public class Model(ITransaction tx) : Entity(tx)
-    {
-
-        /// <summary>
-        /// The hash of the downloaded archive from which this download is sourced from.
-        /// </summary>
-        public Hash Hash
-        {
-            get => DownloadAnalysis.Hash.Get(this);
-            set => DownloadAnalysis.Hash.Add(this, value);
-        } 
-
-        /// <summary>
-        /// Size of the downloaded archive from which this download is sourced from.
-        /// </summary>
-        public Size Size
-        {
-            get => DownloadAnalysis.Size.Get(this);
-            set => DownloadAnalysis.Size.Add(this, value);
-        }
-
-
-        /// <summary>
-        /// The number of entries in the download
-        /// </summary>
-        public ulong Count
-        {
-            get => NumberOfEntries.Get(this);
-            set => NumberOfEntries.Add(this, value);
-        }
 
-        /// <summary>
-        /// The human-readable, friendly name for this download
-        /// </summary>
-        public string SuggestedName
-        {
-            get => DownloadAnalysis.SuggestedName.Get(this, "<Unknown>");
-            set => DownloadAnalysis.SuggestedName.Add(this, value);
-        }
+    /// <summary>
+    /// The contents of the download
+    /// </summary>
+    public static readonly BackReferenceAttribute<DownloadContentEntry> Contents = new(DownloadContentEntry.DownloadAnalysis);
 
-        /// <summary>
-        /// The contents of the download
-        /// </summary>
-        public Entities<EntityIds, DownloadContentEntry.Model> Contents
-            => GetReverse<DownloadContentEntry.Model>(DownloadContentEntry.DownloadAnalysis);
-
-
+
+    public partial struct ReadOnly
+    {
         /// <summary>
         /// Get a file tree of the download's contents
         /// </summary>
         public ModFileTreeNode GetFileTree(IFileStore? fs = null)
         {
             return TreeCreator.Create(Contents, fs);
         }
-
-        /// <summary>
-        /// The timestamp of the creation of this <see cref="DownloadAnalysis"/> entity
-        /// Download start time or first manual installation time
-        /// </summary>
-        public DateTime GetCreatedAt()
-        {
-            // Get the lowest transaction id, then get the timestamp of that transaction
-            var t = this.Select(d => d.T).Min();
-            var txEntity = Db.Get<Entity>(EntityId.From(t.Value));
-            return BuiltInAttributes.TxTimestanp.Get(txEntity);
-        }
     }
 }
 
 
 /// <summary>
 /// A single entry in the download analysis, this is a file that is contained in the download
 /// </summary>
-public static class DownloadContentEntry
+public partial class DownloadContentEntry : IModelDefinition
 {
     private const string Namespace = "NexusMods.Abstractions.FileStore.Downloads.DownloadContentEntry";
 
@@ -143,46 +92,13 @@ public static class DownloadContentEntry
     /// <summary>
     /// The DownloadAnalysis that this entry is a part of
     /// </summary>
-    public static readonly ReferenceAttribute DownloadAnalysis = new(Namespace, nameof(DownloadAnalysis));
-
-    public class Model(ITransaction tx) : Entity(tx, (byte)IdPartitions.DownloadAnalysis), TreeCreator.ITreeCreatorNode
+    public static readonly ReferenceAttribute<DownloadAnalysis> DownloadAnalysis = new(Namespace, nameof(DownloadAnalysis));
+
+    /// <inheritdoc />
+    public partial struct ReadOnly : TreeCreator.ITreeCreatorNode
     {
 
-        /// <summary>
-        /// Hash of the file
-        /// </summary>
-        public Hash Hash
-        {
-            get => DownloadContentEntry.Hash.Get(this);
-            set => DownloadContentEntry.Hash.Add(this, value);
-        } 
-
-        /// <summary>
-        /// Size of the file
-        /// </summary>
-        public Size Size
-        {
-            get => DownloadContentEntry.Size.Get(this);
-            set => DownloadContentEntry.Size.Add(this, value);
-        }
-
-        /// <summary>
-        /// Path of the file
-        /// </summary>
-        public RelativePath Path
-        {
-            get => DownloadContentEntry.Path.Get(this);
-            set => DownloadContentEntry.Path.Add(this, value);
-        }
-
-        public DownloadId DownloadAnalysisId
-        {
-            get => DownloadId.From(DownloadAnalysis.Get(this));
-            set => DownloadAnalysis.Add(this, value.Value);
-        }
-
     }
-
 }
 
 /// <summary>

src/Abstractions/NexusMods.Abstractions.FileStore/IFileOriginRegistry.cs

@@ -49,19 +49,20 @@ public ValueTask<DownloadId> RegisterDownload(AbsolutePath path, string modName,
     /// Indexes an already extracted download, returns a download id that can be used to retrieve the download later.
     /// </summary>
     public ValueTask<DownloadId> RegisterFolder(AbsolutePath path, MetadataFn metaDataFn, string modName, CancellationToken token = default);
-
+    
     /// <summary>
     /// Get the analysis of a download
     /// </summary>
-    public DownloadAnalysis.Model Get(DownloadId id);
+    public DownloadAnalysis.ReadOnly Get(DownloadId id);
 
     /// <summary>
     /// Get the analysis of all downloads
     /// </summary>
-    public IEnumerable<DownloadAnalysis.Model> GetAll();
+    public IEnumerable<DownloadAnalysis.ReadOnly> GetAll();
 
     /// <summary>
     /// Finds all downloads that have the given hash
     /// </summary>
-    public IEnumerable<DownloadAnalysis.Model> GetBy(Hash hash);
+    public IEnumerable<DownloadAnalysis.ReadOnly> GetBy(Hash hash);
+
 }

src/Abstractions/NexusMods.Abstractions.FileStore/NexusMods.Abstractions.FileStore.csproj

@@ -8,6 +8,7 @@
       <ProjectReference Include="..\NexusMods.Abstractions.Serialization\NexusMods.Abstractions.Serialization.csproj" />
       <PackageReference Include="NexusMods.MnemonicDB.Storage" />
       <PackageReference Include="TransparentValueObjects" PrivateAssets="all" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
+        <PackageReference Include="NexusMods.MnemonicDB.SourceGenerator" PrivateAssets="all" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
     </ItemGroup>
     <ItemGroup>
       <PackageReference Include="NexusMods.Paths" />

src/Abstractions/NexusMods.Abstractions.Games.Diagnostics/Emitters/ILoadoutDiagnosticEmitter.cs

@@ -16,5 +16,5 @@ public interface ILoadoutDiagnosticEmitter : IDiagnosticEmitter
     /// <summary>
     /// Diagnoses a loadout and creates instances of <see cref="Diagnostic"/>.
     /// </summary>
-    IAsyncEnumerable<Diagnostic> Diagnose(Loadout.Model loadout, CancellationToken cancellationToken);
+    IAsyncEnumerable<Diagnostic> Diagnose(Loadout.ReadOnly loadout, CancellationToken cancellationToken);
 }

src/Abstractions/NexusMods.Abstractions.Games.Diagnostics/References/IDataReference.cs

@@ -23,12 +23,12 @@ public interface IDataReference
     /// Resolves the data at <see cref="TxId"/> to an <see cref="Entity"/>.
     /// </summary>
     /// <returns><c>null</c> if the value doesn't exist in the data store.</returns>
-    Entity? ResolveData(IServiceProvider serviceProvider, TxId dataStore);
+    IReadOnlyModel? ResolveData(IServiceProvider serviceProvider, TxId dataStore);
 
     /// <summary>
     /// Converts the data from <see cref="ResolveData"/> to a string representation.
     /// </summary>
-    string ToStringRepresentation(Entity data);
+    string ToStringRepresentation(IReadOnlyModel data);
 }
 
 /// <summary>
@@ -37,19 +37,19 @@ public interface IDataReference
 /// <seealso cref="IDataReference"/>
 [PublicAPI]
 public interface IDataReference<out TDataId, TData> : IDataReference
-    where TData : Entity
+    where TData : IReadOnlyModel
 {
     /// <summary>
     /// Gets the ID of the referenced data.
     /// </summary>
     TDataId DataId { get; }
 
     /// <inheritdoc/>
-    Entity? IDataReference.ResolveData(IServiceProvider serviceProvider, TxId dataStore) 
+    IReadOnlyModel? IDataReference.ResolveData(IServiceProvider serviceProvider, TxId dataStore) 
         => ResolveData(serviceProvider, dataStore);
 
     /// <inheritdoc/>
-    string IDataReference.ToStringRepresentation(Entity data)
+    string IDataReference.ToStringRepresentation(IReadOnlyModel data)
     {
         if (data is not TData actualData)
             throw new ArgumentException($"Argument is not of type '{typeof(TData)}' but '{data.GetType()}'", nameof(data));

src/Abstractions/NexusMods.Abstractions.Games.Diagnostics/References/LoadoutReference.cs

@@ -9,7 +9,7 @@ namespace NexusMods.Abstractions.Diagnostics.References;
 /// A reference to a <see cref="Loadout"/>.
 /// </summary>
 [PublicAPI]
-public record LoadoutReference : IDataReference<LoadoutId, Loadout.Model>
+public record LoadoutReference : IDataReference<LoadoutId, Loadout.ReadOnly>
 {
     /// <inheritdoc/>
     public required TxId TxId { get; init; }
@@ -18,12 +18,12 @@ public record LoadoutReference : IDataReference<LoadoutId, Loadout.Model>
     public required LoadoutId DataId { get; init; }
 
     /// <inheritdoc/>
-    public Loadout.Model? ResolveData(IServiceProvider serviceProvider, IConnection dataStore)
+    public Loadout.ReadOnly ResolveData(IServiceProvider serviceProvider, IConnection dataStore)
     {
         var db = dataStore.AsOf(TxId);
-        return db.Get<Loadout.Model>(DataId.Value);
+        return Loadout.Load(db, DataId.Value);
     }
 
     /// <inheritdoc/>
-    public string ToStringRepresentation(Loadout.Model data) => data.Name;
+    public string ToStringRepresentation(Loadout.ReadOnly data) => data.Name;
 }