Add tests for send caching (#660)

Author: adamhathcock

Sdk/Speckle.Connectors.Common.Tests/Caching/NullSendConversionCacheTests.cs

@@ -0,0 +1,46 @@
+using FluentAssertions;
+using NUnit.Framework;
+using Speckle.Connectors.Common.Caching;
+using Speckle.Sdk.Models;
+using Speckle.Sdk.Serialisation;
+
+namespace Speckle.Connectors.Common.Tests.Caching;
+
+public class NullSendConversionCacheTests
+{
+  [Test]
+  public void Store()
+  {
+    var cache = new NullSendConversionCache();
+    var projectId = "projectId";
+    var id = new Id("id");
+    var objectReference = new ObjectReference() { referencedId = "referencedId" };
+    var convertedReferences = new Dictionary<Id, ObjectReference>() { { id, objectReference } };
+
+    cache.StoreSendResult(projectId, convertedReferences);
+
+    cache.TryGetValue(projectId, id.Value, out ObjectReference? _).Should().BeFalse();
+
+    cache.ClearCache();
+
+    cache.TryGetValue(projectId, id.Value, out _).Should().BeFalse();
+  }
+
+  [Test]
+  public void Evict()
+  {
+    var cache = new NullSendConversionCache();
+    var projectId = "projectId";
+    var id = new Id("id");
+    var objectReference = new ObjectReference() { referencedId = "referencedId" };
+    var convertedReferences = new Dictionary<Id, ObjectReference>() { { id, objectReference } };
+
+    cache.StoreSendResult(projectId, convertedReferences);
+
+    cache.TryGetValue(projectId, id.Value, out ObjectReference? _).Should().BeFalse();
+
+    cache.EvictObjects([id.Value]);
+
+    cache.TryGetValue(projectId, id.Value, out _).Should().BeFalse();
+  }
+}

Sdk/Speckle.Connectors.Common.Tests/Caching/SendConversionCacheTests.cs

@@ -0,0 +1,50 @@
+using FluentAssertions;
+using NUnit.Framework;
+using Speckle.Connectors.Common.Caching;
+using Speckle.Sdk.Models;
+using Speckle.Sdk.Serialisation;
+
+namespace Speckle.Connectors.Common.Tests.Caching;
+
+public class SendConversionCacheTests
+{
+  [Test]
+  public void Store()
+  {
+    var cache = new SendConversionCache();
+    var projectId = "projectId";
+    var id = new Id("id");
+    var objectReference = new ObjectReference() { referencedId = "referencedId" };
+    var convertedReferences = new Dictionary<Id, ObjectReference>() { { id, objectReference } };
+
+    cache.StoreSendResult(projectId, convertedReferences);
+    cache.Cache.Count.Should().Be(1);
+
+    cache.TryGetValue(projectId, id.Value, out ObjectReference? reference).Should().BeTrue();
+    reference.Should().Be(objectReference);
+
+    cache.ClearCache();
+    cache.Cache.Count.Should().Be(0);
+
+    cache.TryGetValue(projectId, id.Value, out _).Should().BeFalse();
+  }
+
+  [Test]
+  public void Evict()
+  {
+    var cache = new SendConversionCache();
+    var projectId = "projectId";
+    var id = new Id("id");
+    var objectReference = new ObjectReference() { referencedId = "referencedId" };
+    var convertedReferences = new Dictionary<Id, ObjectReference>() { { id, objectReference } };
+
+    cache.StoreSendResult(projectId, convertedReferences);
+    cache.Cache.Count.Should().Be(1);
+
+    cache.TryGetValue(projectId, id.Value, out ObjectReference? reference).Should().BeTrue();
+    reference.Should().Be(objectReference);
+
+    cache.EvictObjects([id.Value]);
+    cache.Cache.Count.Should().Be(0);
+  }
+}

Sdk/Speckle.Connectors.Common/Assembly.cs

@@ -0,0 +1,3 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("Speckle.Connectors.Common.Tests")]

Sdk/Speckle.Connectors.Common/Caching/ISendConversionCache.cs

@@ -20,7 +20,7 @@ public interface ISendConversionCache
   /// <para><b>Failure to do so correctly will result in cache poisoning and incorrect version creation (stale objects).</b></para>
   /// </summary>
   /// <param name="objectIds"></param>
-  public void EvictObjects(IEnumerable<string> objectIds);
-  public void ClearCache();
+  void EvictObjects(IEnumerable<string> objectIds);
+  void ClearCache();
   bool TryGetValue(string projectId, string applicationId, [NotNullWhen(true)] out ObjectReference? objectReference);
 }

Sdk/Speckle.Connectors.Common/Caching/SendConversionCache.cs

@@ -7,9 +7,7 @@ namespace Speckle.Connectors.Common.Caching;
 ///<inheritdoc/>
 public class SendConversionCache : ISendConversionCache
 {
-  public SendConversionCache() { }
-
-  private Dictionary<(string applicationId, string projectId), ObjectReference> Cache { get; set; } = new(); // NOTE: as this dude's accessed from potentially more operations at the same time, it might be safer to bless him as a concurrent dictionary.
+  internal Dictionary<(string applicationId, string projectId), ObjectReference> Cache { get; set; } = new(); // NOTE: as this dude's accessed from potentially more operations at the same time, it might be safer to bless him as a concurrent dictionary.
 
   public void StoreSendResult(string projectId, IReadOnlyDictionary<Id, ObjectReference> convertedReferences)
   {