add cancellation test on save to cache

Speckle.Sdk.Testing/Framework/DummySqLiteSendManager.cs

@@ -10,7 +10,7 @@ public class DummySqLiteSendManager : ISqLiteJsonCacheManager
 
   public void UpdateObject(string id, string json) => throw new NotImplementedException();
 
-  public void SaveObjects(IEnumerable<(string id, string json)> items) => throw new NotImplementedException();
+  public virtual void SaveObjects(IEnumerable<(string id, string json)> items) => throw new NotImplementedException();
 
   public bool HasObject(string objectId) => throw new NotImplementedException();
 

src/Speckle.Sdk.Dependencies/Collections.cs

@@ -6,7 +6,9 @@ public static class Collections
 {
   public static IReadOnlyCollection<T> Freeze<T>(this IEnumerable<T> source) => source.ToFrozenSet();
 
-  public static IReadOnlyDictionary<TKey, TValue> Freeze<TKey, TValue>(this IEnumerable<KeyValuePair<TKey, TValue>> source)
+  public static IReadOnlyDictionary<TKey, TValue> Freeze<TKey, TValue>(
+    this IEnumerable<KeyValuePair<TKey, TValue>> source
+  )
     where TKey : notnull => source.ToFrozenDictionary();
 }
 

src/Speckle.Sdk/Serialisation/V2/Send/BaseSerializer.cs

@@ -6,20 +6,20 @@
 using Speckle.Sdk.SQLite;
 using Closures = System.Collections.Generic.Dictionary<Speckle.Sdk.Serialisation.Id, int>;
 
-
 namespace Speckle.Sdk.Serialisation.V2.Send;
 
 [GenerateAutoInterface]
 public class BaseSerializer(
   ISqLiteJsonCacheManager sqLiteJsonCacheManager,
-  IObjectSerializerFactory objectSerializerFactory) : IBaseSerializer
+  IObjectSerializerFactory objectSerializerFactory
+) : IBaseSerializer
 {
   private readonly Pool<List<(Id, Json, Closures)>> _pool = Pools.CreateListPool<(Id, Json, Closures)>();
 
   private readonly ConcurrentDictionary<Id, ObjectReference> _objectReferences = new();
- 
+
   public IReadOnlyDictionary<Id, ObjectReference> ObjectReferences => _objectReferences;
-  
+
   //leave this sync
   public IEnumerable<BaseItem> Serialise(
     Base obj,
@@ -49,22 +49,19 @@ CancellationToken cancellationToken
       }
 
       var (id, json, closures) = items.First();
-      yield return CheckCache(id, json, closures,skipCacheRead);
+      yield return CheckCache(id, json, closures, skipCacheRead);
       foreach (var (cid, cJson, cClosures) in items.Skip(1))
       {
-        yield return CheckCache(cid, cJson, cClosures,skipCacheRead);
+        yield return CheckCache(cid, cJson, cClosures, skipCacheRead);
       }
     }
     finally
     {
       _pool.Return(items);
     }
   }
-
-
-  private BaseItem CheckCache(Id id, Json json, Dictionary<Id, int> closures,
-
-    bool skipCacheRead)
+
+  private BaseItem CheckCache(Id id, Json json, Dictionary<Id, int> closures, bool skipCacheRead)
   {
     if (!skipCacheRead)
     {

src/Speckle.Sdk/Serialisation/V2/Send/SerializeProcess.cs

@@ -91,6 +91,7 @@ public async Task<SerializeProcessResults> Serialize(Base root)
     DoneTraversing();
     await Task.WhenAll(findTotalObjectsTask, channelTask).ConfigureAwait(true);
     await DoneSaving().ConfigureAwait(true);
+    cancellationToken.ThrowIfCancellationRequested();
     return new(root.id.NotNull(), baseSerializer.ObjectReferences.Freeze());
   }
 
@@ -162,8 +163,6 @@ private async Task<Dictionary<Id, NodeInfo>> Traverse(Base obj, CancellationToke
     return currentClosures;
   }
 
-
-
   public override async Task SendToServer(Batch<BaseItem> batch, CancellationToken cancellationToken)
   {
     try

tests/Speckle.Sdk.Serialization.Testing/Program.cs

@@ -43,12 +43,13 @@
 
 var factory = new SerializeProcessFactory(
   new BaseChildFinder(new BasePropertyGatherer()),
-   new ObjectDeserializerFactory(),
+  new ObjectDeserializerFactory(),
   serviceProvider.GetRequiredService<ISqLiteJsonCacheManagerFactory>(),
   serviceProvider.GetRequiredService<IServerObjectManagerFactory>(),
   new BaseSerializer(
-    serviceProvider.GetRequiredService<ISqLiteJsonCacheManager>(),new ObjectSerializerFactory(new BasePropertyGatherer())),
-
+    serviceProvider.GetRequiredService<ISqLiteJsonCacheManager>(),
+    new ObjectSerializerFactory(new BasePropertyGatherer())
+  ),
   new NullLoggerFactory()
 );
 var process = factory.CreateDeserializeProcess(new Uri(url), streamId, token, progress, default, new(skipCacheReceive));

tests/Speckle.Sdk.Serialization.Tests/CancellationTests.Cancellation_Save_Sqlite.verified.json

@@ -1 +1,5 @@
-
+{
+  "Type": "System.OperationCanceledException",
+  "Message": "The operation was canceled.",
+  "Source": "System.Private.CoreLib"
+}

tests/Speckle.Sdk.Serialization.Tests/CancellationTests.cs

@@ -1,4 +1,4 @@
-using Microsoft.Extensions.Logging.Abstractions;
+using Microsoft.Extensions.Logging.Abstractions;
 using Speckle.Objects.Geometry;
 using Speckle.Sdk.Host;
 using Speckle.Sdk.Models;
@@ -7,9 +7,13 @@
 
 namespace Speckle.Sdk.Serialization.Tests;
 
-public class CancellationSqLiteSendManager : DummySqLiteSendManager
+public class CancellationSqLiteSendManager(CancellationTokenSource cancellationTokenSource) : DummySqLiteSendManager
 {
-
+  public override void SaveObjects(IEnumerable<(string id, string json)> items)
+  {
+    cancellationTokenSource.Cancel();
+    cancellationTokenSource.Token.ThrowIfCancellationRequested();
+  }
 }
 
 public class CancellationTests
@@ -19,51 +23,49 @@ public CancellationTests()
     TypeLoader.Reset();
     TypeLoader.Initialize(typeof(Base).Assembly, typeof(DetachedTests).Assembly, typeof(Polyline).Assembly);
   }
+
   [Fact]
-   public async Task Cancellation_Serialize()
+  public async Task Cancellation_Serialize()
   {
     var testClass = new TestClass() { RegularProperty = "Hello" };
-  
+
     using var cancellationSource = new CancellationTokenSource();
     using var serializeProcess = new SerializeProcess(
       null,
       new DummySqLiteSendManager(),
       new DummyServerObjectManager(),
-      new BaseChildFinder(new BasePropertyGatherer()),   new BaseSerializer(
-
-        new DummySqLiteSendManager(),new ObjectSerializerFactory(new BasePropertyGatherer())),
-
+      new BaseChildFinder(new BasePropertyGatherer()),
+      new BaseSerializer(new DummySqLiteSendManager(), new ObjectSerializerFactory(new BasePropertyGatherer())),
       new NullLoggerFactory(),
       cancellationSource.Token,
       new SerializeProcessOptions(true, true, false, true)
     );
     await cancellationSource.CancelAsync();
-    var ex = await Assert.ThrowsAsync<OperationCanceledException>(async () => await serializeProcess.Serialize(testClass));
+    var ex = await Assert.ThrowsAsync<OperationCanceledException>(
+      async () => await serializeProcess.Serialize(testClass)
+    );
     await Verify(ex);
-
   }
-   
+
   [Fact]
   public async Task Cancellation_Save_Sqlite()
   {
     var testClass = new TestClass() { RegularProperty = "Hello" };
-  
+
     using var cancellationSource = new CancellationTokenSource();
     using var serializeProcess = new SerializeProcess(
       null,
-      new CancellationSqLiteSendManager(),
+      new CancellationSqLiteSendManager(cancellationSource),
       new DummyServerObjectManager(),
-      new BaseChildFinder(new BasePropertyGatherer()),   new BaseSerializer(
-
-        new DummySqLiteSendManager(),new ObjectSerializerFactory(new BasePropertyGatherer())),
-
+      new BaseChildFinder(new BasePropertyGatherer()),
+      new BaseSerializer(new DummySqLiteSendManager(), new ObjectSerializerFactory(new BasePropertyGatherer())),
       new NullLoggerFactory(),
       cancellationSource.Token,
-      new SerializeProcessOptions(true, true, false, true)
+      new SerializeProcessOptions(true, false, false, true)
+    );
+    var ex = await Assert.ThrowsAsync<OperationCanceledException>(
+      async () => await serializeProcess.Serialize(testClass)
     );
-    await cancellationSource.CancelAsync();
-    var ex = await Assert.ThrowsAsync<OperationCanceledException>(async () => await serializeProcess.Serialize(testClass));
     await Verify(ex);
-
   }
 }

tests/Speckle.Sdk.Serialization.Tests/DetachedTests.cs

@@ -36,9 +36,8 @@ public async Task CanSerialize_New_Detached()
       null,
       new DummySendCacheManager(objects),
       new DummyServerObjectManager(),
-      new BaseChildFinder(new BasePropertyGatherer()),    new BaseSerializer(
-        new DummySendCacheManager(objects),new ObjectSerializerFactory(new BasePropertyGatherer())),
-
+      new BaseChildFinder(new BasePropertyGatherer()),
+      new BaseSerializer(new DummySendCacheManager(objects), new ObjectSerializerFactory(new BasePropertyGatherer())),
       new NullLoggerFactory(),
       default,
       new SerializeProcessOptions(false, false, true, true)
@@ -122,9 +121,8 @@ public async Task CanSerialize_New_Detached2()
       null,
       new DummySendCacheManager(objects),
       new DummyServerObjectManager(),
-      new BaseChildFinder(new BasePropertyGatherer()),    new BaseSerializer(
-        new DummySendCacheManager(objects),new ObjectSerializerFactory(new BasePropertyGatherer())),
-
+      new BaseChildFinder(new BasePropertyGatherer()),
+      new BaseSerializer(new DummySendCacheManager(objects), new ObjectSerializerFactory(new BasePropertyGatherer())),
       new NullLoggerFactory(),
       default,
       new SerializeProcessOptions(false, false, true, true)
@@ -193,9 +191,8 @@ public async Task CanSerialize_New_Detached_With_DataChunks()
       null,
       new DummySendCacheManager(objects),
       new DummyServerObjectManager(),
-      new BaseChildFinder(new BasePropertyGatherer()),    new BaseSerializer(
-        new DummySendCacheManager(objects),new ObjectSerializerFactory(new BasePropertyGatherer())),
-
+      new BaseChildFinder(new BasePropertyGatherer()),
+      new BaseSerializer(new DummySendCacheManager(objects), new ObjectSerializerFactory(new BasePropertyGatherer())),
       new NullLoggerFactory(),
       default,
       new SerializeProcessOptions(false, false, true, true)
@@ -229,9 +226,8 @@ public async Task CanSerialize_New_Detached_With_DataChunks2()
       null,
       new DummySendCacheManager(objects),
       new DummyServerObjectManager(),
-      new BaseChildFinder(new BasePropertyGatherer()),    new BaseSerializer(
-        new DummySendCacheManager(objects),new ObjectSerializerFactory(new BasePropertyGatherer())),
-
+      new BaseChildFinder(new BasePropertyGatherer()),
+      new BaseSerializer(new DummySendCacheManager(objects), new ObjectSerializerFactory(new BasePropertyGatherer())),
       new NullLoggerFactory(),
       default,
       new SerializeProcessOptions(false, false, true, true)

tests/Speckle.Sdk.Serialization.Tests/ExceptionTests.cs

@@ -29,8 +29,7 @@ public async Task Test_Exceptions_Upload()
       new DummySendCacheManager(objects),
       new ExceptionServerObjectManager(),
       new BaseChildFinder(new BasePropertyGatherer()),
-      new BaseSerializer(
-        new DummySendCacheManager(objects),new ObjectSerializerFactory(new BasePropertyGatherer())),
+      new BaseSerializer(new DummySendCacheManager(objects), new ObjectSerializerFactory(new BasePropertyGatherer())),
       new NullLoggerFactory(),
       default,
       new SerializeProcessOptions(false, false, false, true)
@@ -50,9 +49,8 @@ public async Task Test_Exceptions_Cache()
       null,
       new ExceptionSendCacheManager(),
       new DummyServerObjectManager(),
-      new BaseChildFinder(new BasePropertyGatherer()),   new BaseSerializer(
-        new ExceptionSendCacheManager(),new ObjectSerializerFactory(new BasePropertyGatherer())),
-
+      new BaseChildFinder(new BasePropertyGatherer()),
+      new BaseSerializer(new ExceptionSendCacheManager(), new ObjectSerializerFactory(new BasePropertyGatherer())),
       new NullLoggerFactory(),
       default,
       new SerializeProcessOptions(false, false, false, true)

tests/Speckle.Sdk.Serialization.Tests/ExplicitInterfaceTests.cs

@@ -24,10 +24,7 @@ public async Task Test_Json()
       new DummySendCacheManager(objects),
       new DummyServerObjectManager(),
       new BaseChildFinder(new BasePropertyGatherer()),
-      new BaseSerializer(
-
-        new DummySendCacheManager(objects),new ObjectSerializerFactory(new BasePropertyGatherer())),
-
+      new BaseSerializer(new DummySendCacheManager(objects), new ObjectSerializerFactory(new BasePropertyGatherer())),
       new NullLoggerFactory(),
       default,
       new SerializeProcessOptions(false, false, true, true)

tests/Speckle.Sdk.Serialization.Tests/SerializationTests.cs

@@ -224,10 +224,8 @@ public async Task Roundtrip_Test_New(string fileName, string rootId, int oldCoun
       null,
       new DummySqLiteSendManager(),
       new DummySendServerObjectManager(newIdToJson),
-      new BaseChildFinder(new BasePropertyGatherer()),   new BaseSerializer(
-
-        new DummySqLiteSendManager(),new ObjectSerializerFactory(new BasePropertyGatherer())),
-
+      new BaseChildFinder(new BasePropertyGatherer()),
+      new BaseSerializer(new DummySqLiteSendManager(), new ObjectSerializerFactory(new BasePropertyGatherer())),
       new NullLoggerFactory(),
       default,
       new SerializeProcessOptions(true, true, false, true)