More code cleanup

benchmarks/NexusMods.EventSourcing.Benchmarks/AppHost.cs

@@ -2,6 +2,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using NexusMods.EventSourcing.DatomStore;
+using NexusMods.EventSourcing.TestModel;
 using NexusMods.Paths;
 
 namespace NexusMods.EventSourcing.Benchmarks;

benchmarks/NexusMods.EventSourcing.Benchmarks/Benchmarks/ReadTests.cs

@@ -83,7 +83,7 @@ public ulong ReadFiles()
         {
             sum += itm.Index;
         }
-        return (ulong)sum;
+        return sum;
     }
 
 }

benchmarks/NexusMods.EventSourcing.Benchmarks/Benchmarks/WriteTests.cs

@@ -1,6 +1,10 @@
-using BenchmarkDotNet.Attributes;
+using System.Collections.Generic;
+using System.Linq;
+using BenchmarkDotNet.Attributes;
+using FluentAssertions;
 using Microsoft.Extensions.DependencyInjection;
 using NexusMods.EventSourcing.Abstractions;
+using NexusMods.EventSourcing.TestModel.Model;
 
 namespace NexusMods.EventSourcing.Benchmarks.Benchmarks;
 
@@ -22,17 +26,29 @@ public WriteTests()
     [Benchmark]
     public void AddFiles()
     {
-        /*
         var tx = _connection.BeginTransaction();
+        var ids = new List<EntityId>();
         for (var i = 0; i < Count; i++)
         {
-            var id = Ids.MakeId(Ids.Partition.Entity, (ulong)i);
-            File.Hash.Assert(tx.TempId(), (ulong)i, tx);
-            File.Path.Assert(tx.TempId(), $"C:\\test_{i}.txt", tx);
-            File.Index.Assert(tx.TempId(), (ulong)i, tx);
+            var file = new File(tx)
+            {
+                Hash = (ulong)i,
+                Path = $"C:\\test_{i}.txt",
+                Index = (ulong)i
+            };
+            ids.Add(file.Id);
+        }
+        var result = tx.Commit();
+
+        ids = ids.Select(id => result[id]).ToList();
+
+        var db = _connection.Db;
+        foreach (var id in ids)
+        {
+            var loaded = db.Get<File>(id);
+
+            loaded.Should().NotBeNull("the entity should be in the database");
         }
-        tx.Commit();
-        */
     }
 
 }

qodana.yaml

@@ -7,3 +7,4 @@ profile:
   name: qodana.recommended
 exclude:
   - name: ClassNeverInstantiated.Global
+  - name: UnusedAutoPropertyAccessor.Global

src/NexusMods.EventSourcing.Abstractions/Datom.cs

@@ -2,6 +2,9 @@
 
 namespace NexusMods.EventSourcing.Abstractions;
 
+/// <summary>
+/// Represents a single fact in the database. Consists of an entity, attribute, value, and transaction id.
+/// </summary>
 public interface IDatom
 {
     /// <summary>
@@ -34,19 +37,44 @@ public interface IDatom
     void Remap(Func<EntityId, EntityId> remapFn);
 }
 
+/// <summary>
+/// A datom that includes a transaction id
+/// </summary>
 public interface IDatomWithTx : IDatom
 {
+    /// <summary>
+    /// The transaction id of the datom
+    /// </summary>
     TxId Tx { get; }
 }
 
+
+/// <summary>
+/// An assertion datom, most datoms are assertions, so these are called out in a specific class
+/// here to save memory
+/// </summary>
+/// <param name="e"></param>
+/// <param name="v"></param>
+/// <typeparam name="TAttr"></typeparam>
+/// <typeparam name="TVal"></typeparam>
 public class AssertDatom<TAttr, TVal>(ulong e, TVal v) : IDatom
     where TAttr : IAttribute<TVal>
 {
+    /// <inheritdoc />
     public ulong Entity => e;
 
+    /// <summary>
+    /// The value of the datom
+    /// </summary>
     public TVal V => v;
+
+    /// <inheritdoc />
     public Type Attribute => typeof(TAttr);
+
+    /// <inheritdoc />
     public Type ValueType => typeof(TVal);
+
+    /// <inheritdoc />
     public void Emit<TSink>(ref TSink sink) where TSink : IDatomSink
     {
         sink.Datom<TAttr, TVal>(e, v, true);
@@ -77,14 +105,12 @@ public class AssertDatomWithTx<TAttr, TVal> : AssertDatom<TAttr, TVal>, IDatomWi
     /// <summary>
     /// Default Constructor
     /// </summary>
-    /// <param name="e"></param>
-    /// <param name="v"></param>
-    /// <param name="tx"></param>
     public AssertDatomWithTx(ulong e, TVal v, TxId tx) : base(e, v)
     {
         Tx = tx;
     }
 
+    /// <inheritdoc />
     public override string ToString()
     {
         return $"(assert! {Entity}, {Attribute.Namespace}/{Attribute.Name}, {V}, {Tx})";

src/NexusMods.EventSourcing.Abstractions/IDatomSink.cs

@@ -1,7 +1,15 @@
 namespace NexusMods.EventSourcing.Abstractions;
 
+/// <summary>
+/// A sink is a typed interface that accepts the parts of a datom as values. It is generic and strongly typed
+/// so that most of the data is transferred via the stack and does not require boxing. Think of all of this
+/// something like IEnumerable, but as a pushed base interface instead of a pulled one.
+/// </summary>
 public interface IDatomSink
 {
+    /// <summary>
+    /// Inject a datom into the sink.
+    /// </summary>
     public void Datom<TAttr, TVal>(ulong e, TVal v, bool isAssert)
     where TAttr : IAttribute<TVal>;
 }

src/NexusMods.EventSourcing.Abstractions/IDatomStore.cs

@@ -37,10 +37,6 @@ public interface IDatomStore : IDisposable
     /// Gets the attributeId for the given attribute. And returns an expression that reads the attribute
     /// value from the expression valueSpan.
     /// </summary>
-    /// <param name="valueSpan"></param>
-    /// <param name="attributeId"></param>
-    /// <typeparam name="TAttribute"></typeparam>
-    /// <returns></returns>
     Expression GetValueReadExpression(Type attribute, Expression valueSpan, out ulong attributeId);
 
     /// <summary>

src/NexusMods.EventSourcing.Abstractions/IEntityIterator.cs

@@ -1,5 +1,4 @@
 using System;
-using NexusMods.EventSourcing.Abstractions.Models;
 
 namespace NexusMods.EventSourcing.Abstractions;
 

src/NexusMods.EventSourcing.Abstractions/Ids.cs

@@ -71,7 +71,7 @@ public static Partition GetPartition(ulong id)
             1 => Partition.Tx,
             2 => Partition.Entity,
             3 => Partition.Tmp,
-            > 3 => Partition.Unknown,
+            _ => Partition.Unknown,
         };
     }
 

src/NexusMods.EventSourcing.Abstractions/Symbol.cs

@@ -21,7 +21,7 @@ private Symbol(string nsAndName)
         Namespace = nsAndName[..splitOn];
     }
 
-    private static readonly ConcurrentDictionary<string, Symbol> _internedSymbols = new();
+    private static readonly ConcurrentDictionary<string, Symbol> InternedSymbols = new();
 
     /// <summary>
     /// Construct a new symbol, or return an existing one that matches the given name
@@ -30,11 +30,11 @@ private Symbol(string nsAndName)
     /// <returns></returns>
     public static Symbol Intern(string nsAndName)
     {
-        if (_internedSymbols.TryGetValue(nsAndName, out var symbol))
+        if (InternedSymbols.TryGetValue(nsAndName, out var symbol))
             return symbol;
 
         symbol = new Symbol(nsAndName);
-        return !_internedSymbols.TryAdd(nsAndName, symbol) ? _internedSymbols[nsAndName] : symbol;
+        return !InternedSymbols.TryAdd(nsAndName, symbol) ? InternedSymbols[nsAndName] : symbol;
     }
 
     /// <summary>

src/NexusMods.EventSourcing.DatomStore/AttributeRegistry.cs

@@ -26,12 +26,15 @@ public class AttributeRegistry
     /// </summary>
     public AttributeRegistry(IEnumerable<IValueSerializer> valueSerializers, IEnumerable<IAttribute> attributes)
     {
-        _valueSerializersByNativeType = valueSerializers.ToDictionary(x => x.NativeType);
-        _valueSerializersByUniqueId = valueSerializers.ToDictionary(x => x.UniqueId);
-        _attributesById = attributes.ToDictionary(x => x.Id);
-        _attributesByType = attributes.ToDictionary(x => x.GetType());
+        var serializers = valueSerializers.ToArray();
+        _valueSerializersByNativeType = serializers.ToDictionary(x => x.NativeType);
+        _valueSerializersByUniqueId = serializers.ToDictionary(x => x.UniqueId);
 
-        foreach (var attr in attributes)
+        var attributeArray = attributes.ToArray();
+        _attributesById = attributeArray.ToDictionary(x => x.Id);
+        _attributesByType = attributeArray.ToDictionary(x => x.GetType());
+
+        foreach (var attr in attributeArray)
         {
             attr.SetSerializer(_valueSerializersByNativeType[attr.ValueType]);
         }

src/NexusMods.EventSourcing.DatomStore/BuiltInAttributes.cs

@@ -1,5 +1,4 @@
 using System;
-using Microsoft.Extensions.DependencyInjection;
 using NexusMods.EventSourcing.Abstractions;
 using NexusMods.EventSourcing.DatomStore.BuiltInSerializers;
 

src/NexusMods.EventSourcing.DatomStore/Indexes/AETVIndex.cs

@@ -26,15 +26,13 @@ public static unsafe int Compare(AIndexDefinition<AETVIndex> idx, KeyHeader* a,
     public struct AEVTByAIterator<TAttr> : IIterator
         where TAttr : IAttribute
     {
-        private readonly AETVIndex _idx;
         private KeyHeader _key;
         private readonly Iterator _iterator;
         private readonly ulong _attrId;
         private readonly AttributeRegistry _registry;
 
         public AEVTByAIterator(ulong txId, AttributeRegistry registry, AETVIndex idx)
         {
-            _idx = idx;
             _registry = registry;
             _iterator = idx.Db.NewIterator(idx.ColumnFamilyHandle);
             _attrId = registry.GetAttributeId<TAttr>();

src/NexusMods.EventSourcing.DatomStore/Indexes/EATVIndex.cs

@@ -55,7 +55,7 @@ public bool MaxId(Ids.Partition partition, out ulong o)
         return false;
     }
 
-    public unsafe struct EATVIterator : IEntityIterator, IDisposable
+    public unsafe struct EATVIterator : IEntityIterator
     {
         private readonly KeyHeader* _key;
         private KeyHeader* _current;

src/NexusMods.EventSourcing.DatomStore/PooledMemoryBufferWriter.cs

@@ -4,7 +4,7 @@
 using System.Runtime.CompilerServices;
 using Reloaded.Memory.Extensions;
 
-namespace NexusMods.EventSourcing;
+namespace NexusMods.EventSourcing.DatomStore;
 
 /// <summary>
 /// A IBufferWriter that uses pooled memory to reduce allocations.

src/NexusMods.EventSourcing.DatomStore/RocksDBDatomStore.cs

@@ -7,15 +7,13 @@
 using NexusMods.EventSourcing.Abstractions;
 using NexusMods.EventSourcing.DatomStore.Indexes;
 using RocksDbSharp;
+// ReSharper disable InconsistentNaming
 
 namespace NexusMods.EventSourcing.DatomStore;
 
 public class RocksDBDatomStore : IDatomStore
 {
     private readonly object _lock = new();
-    private readonly ILogger<RocksDBDatomStore> _logger;
-    private readonly DatomStoreSettings _settings;
-    private readonly DbOptions _options;
     private readonly RocksDb _db;
     private readonly PooledMemoryBufferWriter _pooledWriter;
     private readonly AttributeRegistry _registry;
@@ -26,17 +24,14 @@ public class RocksDBDatomStore : IDatomStore
 
     public RocksDBDatomStore(ILogger<RocksDBDatomStore> logger, AttributeRegistry registry, DatomStoreSettings settings)
     {
-        _settings = settings;
-        _logger = logger;
-
         _registry = registry;
         _registry.Populate(BuiltInAttributes.Initial);
 
-        _options = new DbOptions()
+        var options = new DbOptions()
             .SetCreateIfMissing()
             .SetCompression(Compression.Zstd);
 
-        _db = RocksDb.Open(_options, _settings.Path.ToString(), new ColumnFamilies());
+        _db = RocksDb.Open(options, settings.Path.ToString(), new ColumnFamilies());
 
         _eatvIndex = new EATVIndex(_registry);
         _eatvIndex.Init(_db);

src/NexusMods.EventSourcing.DatomStore/Services.cs

@@ -12,9 +12,6 @@ public static class Services
     /// <summary>
     /// Registers the event sourcing services with the service collection.
     /// </summary>
-    /// <param name="services"></param>
-    /// <typeparam name="TAttribute"></typeparam>
-    /// <returns></returns>
     public static IServiceCollection AddDatomStore(this IServiceCollection services)
     {
         services

src/NexusMods.EventSourcing/CommitResult.cs

@@ -4,7 +4,7 @@
 namespace NexusMods.EventSourcing;
 
 /// <inheritdoc />
-public class CommitResult(TxId newTxId, IDictionary<ulong, ulong> remaps, Connection connection, IDatom[] datoms) : ICommitResult
+public class CommitResult(TxId newTxId, IDictionary<ulong, ulong> remaps, IDatom[] datoms) : ICommitResult
 {
     /// <inheritdoc />
     public EntityId this[EntityId id] =>

src/NexusMods.EventSourcing/Connection.cs

@@ -133,7 +133,7 @@ EntityId RemapFn(EntityId input)
             }
             var newTx = _store.Transact(newDatoms);
             TxId = newTx;
-            var result = new CommitResult(newTx, remaps, this, datomsArray);
+            var result = new CommitResult(newTx, remaps, datomsArray);
             _updates.OnNext(result);
             return result;
         }

src/NexusMods.EventSourcing/ModelReflector.cs

@@ -43,8 +43,6 @@ public void Add(TTransaction tx, IReadModel model)
     /// <summary>
     /// Reflects over
     /// </summary>
-    /// <typeparam name="TReadModel"></typeparam>
-    /// <returns></returns>
     private EmitterFn<IReadModel> CreateEmitter(Type readModel)
     {
         var properties = GetModelProperties(readModel);

src/NexusMods.EventSourcing/Services.cs

@@ -11,9 +11,6 @@ public static class Services
     /// <summary>
     /// Registers the event sourcing services with the service collection.
     /// </summary>
-    /// <param name="services"></param>
-    /// <typeparam name="TAttribute"></typeparam>
-    /// <returns></returns>
     public static IServiceCollection AddEventSourcing(this IServiceCollection services)
     {
         services.AddSingleton<IConnection, Connection>();

src/NexusMods.EventSourcing/Transaction.cs

@@ -5,7 +5,8 @@
 
 namespace NexusMods.EventSourcing;
 
-public class Transaction(Connection connection) : ITransaction
+/// <inheritdoc />
+internal class Transaction(Connection connection) : ITransaction
 {
     private ulong _tempId = Ids.MinId(Ids.Partition.Tmp) + 1;
     private readonly ConcurrentBag<IDatom> _datoms = new();

tests/NexusMods.EventSourcing.DatomStore.Tests/ADatomStoreTest.cs

@@ -8,7 +8,6 @@ namespace NexusMods.EventSourcing.DatomStore.Tests;
 public abstract class ADatomStoreTest : IDisposable
 {
     private readonly AbsolutePath _tmpPath;
-    private readonly AttributeRegistry _registry;
     protected readonly RocksDBDatomStore Store;
     protected readonly Connection Connection;
 
@@ -19,8 +18,8 @@ protected ADatomStoreTest(IEnumerable<IValueSerializer> valueSerializers, IEnume
         {
             Path = _tmpPath,
         };
-        _registry = new AttributeRegistry(valueSerializers, attributes);
-        Store = new RocksDBDatomStore(new NullLogger<RocksDBDatomStore>(), _registry, dbSettings);
+        var registry = new AttributeRegistry(valueSerializers, attributes);
+        Store = new RocksDBDatomStore(new NullLogger<RocksDBDatomStore>(), registry, dbSettings);
         Connection = new Connection(Store, attributes, valueSerializers);
     }
 

tests/NexusMods.EventSourcing.DatomStore.Tests/Startup.cs

@@ -1,4 +1,5 @@
 using Microsoft.Extensions.DependencyInjection;
+using NexusMods.EventSourcing.TestModel;
 
 namespace NexusMods.EventSourcing.DatomStore.Tests;