Merge pull request #388 from specklesystems/dev

Main to dev (no squash)

.config/dotnet-tools.json

@@ -3,18 +3,11 @@
   "isRoot": true,
   "tools": {
     "csharpier": {
-      "version": "1.0.2",
+      "version": "1.1.2",
       "commands": [
         "csharpier"
       ],
       "rollForward": false
-    },
-    "gitversion.tool": {
-      "version": "6.1.0",
-      "commands": [
-        "dotnet-gitversion"
-      ],
-      "rollForward": false
     }
   }
 }

.github/workflows/pr.yml

@@ -8,12 +8,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
+      uses: actions/checkout@v5
 
     - name: Setup .NET
-      uses: actions/setup-dotnet@v4
+      uses: actions/setup-dotnet@v5
       with:
         dotnet-version: 8.x.x
         
@@ -21,9 +19,25 @@ jobs:
       with:
         path: ~/.nuget/packages
         key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
-
+        
+    - id: set-version
+      name: Set version to output
+      run: |
+        SEMVER="3.0.99.${{ github.run_number }}"
+        FILE_VERSION=$(echo "$SEMVER" | sed -E 's/^([0-9]+\.[0-9]+\.[0-9]+).*/\1/')
+        FILE_VERSION="$FILE_VERSION.${{ github.run_number }}"
+        
+        echo "semver=$SEMVER" >> "$GITHUB_OUTPUT"
+        echo "fileVersion=$FILE_VERSION" >> "$GITHUB_OUTPUT"
+        
+        echo $SEMVER
+        echo $FILE_VERSION
+        
     - name: 🔫 Build All
       run: ./build.sh
+      env:
+        SEMVER: ${{ steps.set-version.outputs.SEMVER }}
+        FILE_VERSION: ${{ steps.set-version.outputs.FILE_VERSION }}
       
     - name: Upload coverage reports to Codecov with GitHub Action
       uses: codecov/codecov-action@v5

.github/workflows/release.yml

@@ -2,7 +2,6 @@ name: .NET Build and Publish
 
 on:
   push:
-    branches: ["main", "dev"] 
     tags: ["3.*"]
 
 jobs:
@@ -10,23 +9,41 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
+        uses: actions/checkout@v5
+        
       - name: Setup .NET
-        uses: actions/setup-dotnet@v4
+        uses: actions/setup-dotnet@v5
         with:
           dotnet-version: 8.x.x
-          
+
       - uses: actions/cache@v4
         with:
           path: ~/.nuget/packages
           key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
+          
+      - id: set-version
+        name: Set version to output
+        run: |
+          TAG=${{ github.ref_name }}
+          if [[ "${{ github.ref }}" != refs/tags/* ]]; then
+            TAG="3.0.99.${{ github.run_number }}"
+          fi
+          SEMVER="${TAG}"
+          FILE_VERSION=$(echo "$TAG" | sed -E 's/^([0-9]+\.[0-9]+\.[0-9]+).*/\1/')
+          FILE_VERSION="$FILE_VERSION.${{ github.run_number }}"
+
+          echo "semver=$SEMVER" >> "$GITHUB_OUTPUT"
+          echo "fileVersion=$FILE_VERSION" >> "$GITHUB_OUTPUT"
+
+          echo $SEMVER
+          echo $FILE_VERSION
               
       - name: 🔫 Build and Pack
         run: ./build.sh pack
-        
+        env:
+          SEMVER: ${{ steps.set-version.outputs.SEMVER }}
+          FILE_VERSION: ${{ steps.set-version.outputs.FILE_VERSION }}
+          
       - name: Upload coverage reports to Codecov with GitHub Action
         uses: codecov/codecov-action@v5
         with:

GitVersion.yml

@@ -1,6 +0,0 @@
-workflow: GitFlow/v1
-next-version: 3.0.0
-branches:
-  main:
-    prevent-increment:
-      when-current-commit-tagged: true

README.md

@@ -9,9 +9,12 @@ Speckle | Sharp | SDK
 ### .NET SDK, Tests, and Objects
 
 [![codecov](https://codecov.io/gh/specklesystems/speckle-sharp-sdk/branch/dev/graph/badge.svg?token=TTM5OGr38m)](https://codecov.io/gh/specklesystems/speckle-sharp-sdk)
+<a href="https://www.nuget.org/packages/Speckle.Sdk/"><img alt="NuGet Version" src="https://img.shields.io/nuget/v/Speckle.Sdk?label=Speckle.Sdk"></a>
+<a href="https://www.nuget.org/packages/Speckle.Objects/"><img alt="NuGet Version" src="https://img.shields.io/nuget/v/Speckle.Sdk?label=Speckle.Objects"></a>
+<a href="https://www.nuget.org/packages/Speckle.Automate.Sdk/"><img alt="NuGet Version" src="https://img.shields.io/nuget/v/Speckle.Sdk?label=Speckle.Automate.Sdk"></a>
 
 > [!WARNING]
-> This is an early beta release, not meant for use in production! We're working to stabilise the 3.0 API, and until then there will be breaking changes. You have been warned!
+> Releases Speckle.Sdk and Speckle.Objects are reliable for production use, but the APIs may not be wholly stable, and there may be breaking changes between releases, with little documentation.
 
 # Repo structure
 
@@ -28,11 +31,13 @@ This repo is the home of our next-generation Speckle .NET SDK. It uses .NET Stan
 
 ### Other repos
 
-Make sure to also check and ⭐️ these other Speckle next generation repositories:
+Make sure to also check and ⭐️ these other  repositories:
 
-- [`speckle-sharp-connectors`](https://github.com/specklesystems/speckle-sharp-connectors): our csharp repo of next gen connectors
-- [`speckle-sketchup`](https://github.com/specklesystems/speckle-sketchup): Sketchup connector
-- [`speckle-powerbi`](https://github.com/specklesystems/speckle-powerbi): PowerBi connector
+- [`speckle-sharp-connectors`](https://github.com/specklesystems/speckle-sharp-connectors): our csharp repo of next gen connectors.
+- [`speckle-server`](https://github.com/specklesystems/speckle-server): the speckle server.
+- [`speckle-sketchup`](https://github.com/specklesystems/speckle-blender): Blender connector.
+- [`speckle-sketchup`](https://github.com/specklesystems/speckle-sketchup): Sketchup connector.
+- [`speckle-powerbi`](https://github.com/specklesystems/speckle-powerbi): PowerBi connector.
 - and more [connectors & tooling](https://github.com/specklesystems/)!
 
 ## Documentation
@@ -45,18 +50,24 @@ Comprehensive developer and user documentation can be found in our:
 
 ### Building
 
-Make sure you clone this repository together with its submodules: `git clone https://github.com/specklesystems/speckle-sharp-sdk.git -recursive`.
-Afterwards, just restore all the NuGet packages and hit Build!
+Ensure you're using a [8.0.4xx](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) .NET SDK. 
+After cloning this repository, just restore all the NuGet packages and hit Build!
 
 ### Developing
 
-This project is evolving fast, to better understand how to use Core we suggest checking out the Unit and Integration tests. Running the integration tests locally requires a local server running on your computer.
+It is highly recommended you use
+ - Either Jetbrains Rider or Visual Studio 2022
+ - Ensure your IDE is set to use [the correct .NET SDK version](https://github.com/specklesystems/speckle-sharp-sdk/blob/main/global.json) (newer major versions may work, but may incorrectly run analysers we haven't configured)
+ - You should install the cshapier plugin ([Rider](https://plugins.jetbrains.com/plugin/18243-csharpier), [VS](https://marketplace.visualstudio.com/items?itemName=csharpier.CSharpier)) and configure it to run on save
 
-We'll be also adding [preliminary documentation on our forum](https://discourse.speckle.works/c/speckle-insider/10).
+Docs are a bit patchy [https://docs.speckle.systems/developers/looking-for-developer-docs](https://docs.speckle.systems/developers/looking-for-developer-docs)
 
 ### Tests
 
-There are two test projects, one for unit tests and one for integration tests. The latter needs a server running locally in order to run.
+There are several test projects. It is a requirement that all tests pass for PRs to be merged.
+The Integration test projects require a local server to be running.
+
+You must have docker installed. Then you can run `docker compose up --wait` from the root of the repo to start the required containers.
 
 ## Contributing
 

Speckle.Sdk.sln

@@ -23,7 +23,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "config", "config", "{DA2AED
 		Directory.Packages.props = Directory.Packages.props
 		global.json = global.json
 		README.md = README.md
-		GitVersion.yml = GitVersion.yml
 		docker-compose.yml = docker-compose.yml
 		CodeMetricsConfig.txt = CodeMetricsConfig.txt
 		Directory.Build.Targets = Directory.Build.Targets

Speckle.Sdk.slnx

@@ -11,7 +11,6 @@
     <File Path="Directory.Build.Targets" />
     <File Path="Directory.Packages.props" />
     <File Path="docker-compose.yml" />
-    <File Path="GitVersion.yml" />
     <File Path="global.json" />
     <File Path="README.md" />
     <File Path=".github\copilot-instructions.md" />
@@ -43,4 +42,4 @@
     <Project Path="tests/Speckle.Sdk.Serialization.Tests/Speckle.Sdk.Serialization.Tests.csproj" />
     <Project Path="tests/Speckle.Sdk.Tests.Unit/Speckle.Sdk.Tests.Unit.csproj" />
   </Folder>
-</Solution>
+</Solution>

build/Program.cs

@@ -1,4 +1,3 @@
-using System.Text.Json;
 using GlobExpressions;
 using static Bullseye.Targets;
 using static SimpleExec.Command;
@@ -16,14 +15,13 @@ const string CLEAN_LOCKS = "clean-locks";
 const string PERF = "perf";
 const string DEEP_CLEAN = "deep-clean";
 
-static async Task<(string, string)> GetVersions()
+static (string semver, string fileVerison) GetVersions()
 {
-  var (output, _) = await ReadAsync("dotnet", "dotnet-gitversion /output json").ConfigureAwait(false);
-  output = output.Trim();
-  var jDoc = JsonDocument.Parse(output);
-  var version = jDoc.RootElement.GetProperty("FullSemVer").GetString() ?? "3.0.0-localBuild";
-  var fileVersion = jDoc.RootElement.GetProperty("AssemblySemFileVer").GetString() ?? "3.0.0.0";
-  return (version, fileVersion);
+  string semver =
+    Environment.GetEnvironmentVariable("SEMVER") ?? throw new ArgumentException("Expected SEMVER env var");
+  string fileVersion =
+    Environment.GetEnvironmentVariable("FILE_VERSION") ?? throw new ArgumentException("Expected FILE_VERSION env var");
+  return (semver, fileVersion);
 }
 
 Target(
@@ -77,7 +75,7 @@ Target(
   dependsOn: [RESTORE],
   async () =>
   {
-    var (version, fileVersion) = await GetVersions().ConfigureAwait(false);
+    var (version, fileVersion) = GetVersions();
     Console.WriteLine($"Version: {version} & {fileVersion}");
     await RunAsync(
         "dotnet",
@@ -174,7 +172,7 @@ Target(
   async () =>
   {
     {
-      var (version, fileVersion) = await GetVersions().ConfigureAwait(false);
+      var (version, fileVersion) = GetVersions();
       Console.WriteLine($"Version: {version} & {fileVersion}");
       await RunAsync("dotnet", $"pack Speckle.Sdk.sln -c Release -o output --no-build -p:Version={version}")
         .ConfigureAwait(false);

src/Speckle.Sdk/Api/Blob/BlobApi.cs

@@ -265,7 +265,6 @@ public sealed class BlobApi : IBlobApi
   [AutoInterfaceIgnore]
   public void Dispose()
   {
-    _activityFactory.Dispose();
     _authedClient.Dispose();
     _unauthedClient.Dispose();
   }

src/Speckle.Sdk/Api/GraphQL/Models/ServerInfo.cs

@@ -19,6 +19,9 @@ public sealed class ServerInfo
   [Obsolete("Don't use")]
   public bool frontend2 { get; set; } = true;
 
+  /// <summary>
+  /// The URL that should be used to talk with the server
+  /// </summary>
   /// <remarks>
   /// This field is not returned from the GQL API,
   /// it should be populated after construction.

src/Speckle.Sdk/Credentials/Account.cs

@@ -59,15 +59,20 @@ public class Account : IEquatable<Account>
 
   #region public methods
 
+
+  /// <remarks>The logic is aligned with <c>distinct_id</c> mixpanel property</remarks>
+  /// <exception cref="ArgumentNullException">Thrown if <see name="userInfo.email"/> was <see langword="null"/></exception>
   public string GetHashedEmail()
   {
-    string email = userInfo?.email ?? "unknown";
+    string email = userInfo.email.NotNull();
     return "@" + Md5.GetString(email).ToUpperInvariant();
   }
 
+  /// <remarks>The logic is aligned with <c>server</c> mixpanel property</remarks>
+  /// <exception cref="ArgumentNullException">Thrown if <see name="serverInfo.url"/> was <see langword="null"/></exception>
   public string GetHashedServer()
   {
-    string url = serverInfo?.url ?? AccountManager.DEFAULT_SERVER_URL;
+    string url = serverInfo.url.NotNull();
     return Md5.GetString(CleanURL(url)).ToUpperInvariant();
   }
 
@@ -97,6 +102,8 @@ public class Account : IEquatable<Account>
 
   #endregion
 
+  internal const string LOCAL_IDENTIFIER_DEPRECATION_MESSAGE = "Local identifiers no longer nesseary";
+
   /// <summary>
   /// Retrieves the local identifier for the current user.
   /// </summary>
@@ -121,5 +128,6 @@ public class Account : IEquatable<Account>
   ///     https://speckle.xyz?id=123
   ///   </code>
   /// </example>
+  [Obsolete(LOCAL_IDENTIFIER_DEPRECATION_MESSAGE)]
   internal Uri GetLocalIdentifier() => new($"{serverInfo.url}?id={userInfo.id}");
 }

src/Speckle.Sdk/Credentials/AccountManager.cs

@@ -419,6 +419,7 @@ public sealed class AccountManager(
   /// <remarks>
   /// <inheritdoc cref="Account.GetLocalIdentifier"/>
   /// </remarks>
+  [Obsolete(Account.LOCAL_IDENTIFIER_DEPRECATION_MESSAGE)]
   public Uri? GetLocalIdentifierForAccount(Account account)
   {
     var identifier = account.GetLocalIdentifier();
@@ -440,6 +441,7 @@ public sealed class AccountManager(
   /// </summary>
   /// <param name="localIdentifier">The local identifier of the account.</param>
   /// <returns>The account that matches the local identifier, or null if no match is found.</returns>
+  [Obsolete(Account.LOCAL_IDENTIFIER_DEPRECATION_MESSAGE)]
   public Account? GetAccountForLocalIdentifier(Uri localIdentifier)
   {
     var searchResult = GetAccounts()

src/Speckle.Sdk/Models/Base.cs

@@ -169,8 +169,7 @@ public class Base : DynamicBase, ISpeckleObject
 
         return count;
       }
-      case IEnumerable e
-      and not string:
+      case IEnumerable e and not string:
       {
         foreach (var arrValue in e)
         {

src/Speckle.Sdk/Models/GraphTraversal/GraphTraversal.cs

@@ -109,9 +109,9 @@ public abstract class GraphTraversal<T>
         break;
       case IList list:
       {
-        foreach (object? obj in list)
+        for (int i = list.Count - 1; i >= 0; i--)
         {
-          TraverseMemberToStack(stack, obj, memberName, parent);
+          TraverseMemberToStack(stack, list[i], memberName, parent);
         }
 
         break;

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

@@ -21,12 +21,7 @@ public class BaseSerializer(
   public IReadOnlyDictionary<Id, ObjectReference> ObjectReferences => _objectReferences;
 
   //leave this sync
-  public IEnumerable<BaseItem> Serialise(
-    Base obj,
-    IReadOnlyDictionary<Id, NodeInfo> childInfo,
-    bool skipCacheRead,
-    CancellationToken cancellationToken
-  )
+  public IEnumerable<BaseItem> Serialise(Base obj, bool skipCacheRead, CancellationToken cancellationToken)
   {
     if (!skipCacheRead && obj.id != null)
     {
@@ -38,7 +33,7 @@ public class BaseSerializer(
       }
     }
 
-    using var serializer2 = objectSerializerFactory.Create(childInfo, cancellationToken);
+    using var serializer2 = objectSerializerFactory.Create(cancellationToken);
     var items = _pool.Get();
     try
     {

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

@@ -20,10 +20,10 @@ public sealed class ObjectSaver(
   ISqLiteJsonCacheManager sqLiteJsonCacheManager,
   IServerObjectManager serverObjectManager,
   ILogger<ObjectSaver> logger,
-  CancellationToken cancellationToken,
+  SerializeProcessOptions options,
+  CancellationToken cancellationToken
 #pragma warning disable CS9107
 #pragma warning disable CA2254
-  SerializeProcessOptions? options = null
 ) : ChannelSaver<BaseItem>, IObjectSaver
 #pragma warning restore CA2254
 #pragma warning restore CS9107
@@ -100,9 +100,9 @@ public sealed class ObjectSaver(
     {
       if (!_options.SkipCacheWrite && batch.Count != 0)
       {
-        sqLiteJsonCacheManager.SaveObjects(batch.Select(x => (x.Id.Value, x.Json.Value)));
         Interlocked.Add(ref _cached, batch.Count);
         progress?.Report(new(ProgressEvent.CachedToLocal, _cached, _objectsSerialized));
+        sqLiteJsonCacheManager.SaveObjects(batch.Select(x => (x.Id.Value, x.Json.Value)));
       }
     }
     catch (OperationCanceledException)

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

@@ -26,8 +26,6 @@ public sealed class ObjectSerializer : IObjectSerializer
 {
   private HashSet<object> _parentObjects = new();
 
-  private readonly IReadOnlyDictionary<Id, NodeInfo> _childCache;
-
   private readonly IBasePropertyGatherer _propertyGatherer;
   private readonly CancellationToken _cancellationToken;
 
@@ -52,7 +50,6 @@ public sealed class ObjectSerializer : IObjectSerializer
   /// <param name="cancellationToken"></param>
   public ObjectSerializer(
     IBasePropertyGatherer propertyGatherer,
-    IReadOnlyDictionary<Id, NodeInfo> childCache,
     Pool<List<(Id, Json, Closures)>> chunksPool,
     Pool<List<DataChunk>> chunks2Pool,
     Pool<List<object?>> chunks3Pool,
@@ -60,7 +57,6 @@ public sealed class ObjectSerializer : IObjectSerializer
   )
   {
     _propertyGatherer = propertyGatherer;
-    _childCache = childCache;
     _chunksPool = chunksPool;
     _chunks2Pool = chunks2Pool;
     _chunks3Pool = chunks3Pool;
@@ -299,28 +295,14 @@ public sealed class ObjectSerializer : IObjectSerializer
 
   private (Id, Json)? SerializeDetachedBase(Base baseObj, Closures closures)
   {
-    Closures childClosures;
-    Id id;
-    Json json;
-    //avoid multiple serialization to get closures
-    if (baseObj.id != null && _childCache.TryGetValue(new(baseObj.id), out var info))
-    {
-      id = new Id(baseObj.id);
-      childClosures = info.GetClosures(_cancellationToken);
-      json = info.Json;
-      closures.IncrementClosures(childClosures);
-    }
-    else
-    {
-      childClosures = [];
-      var sb = Pools.StringBuilders.Get();
-      using var writer = new StringWriter(sb);
-      using var jsonWriter = SpeckleObjectSerializerPool.Instance.GetJsonTextWriter(writer);
-      id = SerializeBaseWithClosures(baseObj, jsonWriter, childClosures, true);
-      closures.IncrementClosures(childClosures);
-      json = new Json(writer.ToString());
-      Pools.StringBuilders.Return(sb);
-    }
+    Closures childClosures = [];
+    var sb = Pools.StringBuilders.Get();
+    using var writer = new StringWriter(sb);
+    using var jsonWriter = SpeckleObjectSerializerPool.Instance.GetJsonTextWriter(writer);
+    var id = SerializeBaseWithClosures(baseObj, jsonWriter, childClosures, true);
+    var json = new Json(writer.ToString());
+    Pools.StringBuilders.Return(sb);
+    closures.IncrementClosures(childClosures);
     var json2 = ReferenceGenerator.CreateReference(id);
     closures.MergeClosure(id);
     // add to obj refs to return

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

@@ -12,6 +12,6 @@ public class ObjectSerializerFactory(IBasePropertyGatherer propertyGatherer) : I
   private readonly Pool<List<DataChunk>> _chunk2Pool = Pools.CreateListPool<DataChunk>();
   private readonly Pool<List<object?>> _chunk3Pool = Pools.CreateListPool<object?>();
 
-  public IObjectSerializer Create(IReadOnlyDictionary<Id, NodeInfo> baseCache, CancellationToken cancellationToken) =>
-    new ObjectSerializer(propertyGatherer, baseCache, _chunkPool, _chunk2Pool, _chunk3Pool, cancellationToken);
+  public IObjectSerializer Create(CancellationToken cancellationToken) =>
+    new ObjectSerializer(propertyGatherer, _chunkPool, _chunk2Pool, _chunk3Pool, cancellationToken);
 }

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

@@ -1,4 +1,3 @@
-using System.Collections.Concurrent;
 using System.Diagnostics.CodeAnalysis;
 using Microsoft.Extensions.Logging;
 using Speckle.InterfaceGenerator;
@@ -37,8 +36,8 @@ public sealed class SerializeProcess(
   IBaseChildFinder baseChildFinder,
   IBaseSerializer baseSerializer,
   ILoggerFactory loggerFactory,
-  CancellationToken cancellationToken,
-  SerializeProcessOptions? options = null
+  SerializeProcessOptions options,
+  CancellationToken cancellationToken
 ) : ISerializeProcess
 {
   private static readonly Dictionary<Id, NodeInfo> EMPTY_CLOSURES = new();
@@ -64,13 +63,8 @@ public sealed class SerializeProcess(
     ThreadPriority.BelowNormal,
     Environment.ProcessorCount * 2
   );
-  private readonly SerializeProcessOptions _options = options ?? new();
 
   private readonly Pool<Dictionary<Id, NodeInfo>> _currentClosurePool = Pools.CreateDictionaryPool<Id, NodeInfo>();
-  private readonly Pool<ConcurrentDictionary<Id, NodeInfo>> _childClosurePool = Pools.CreateConcurrentDictionaryPool<
-    Id,
-    NodeInfo
-  >();
 
   private readonly Pool<List<Task<Dictionary<Id, NodeInfo>>>> _taskResultPool = Pools.CreateListPool<
     Task<Dictionary<Id, NodeInfo>>
@@ -113,13 +107,13 @@ public sealed class SerializeProcess(
     try
     {
       var channelTask = objectSaver.Start(
-        options?.MaxParallelism,
-        options?.MaxHttpSendBatchSize,
-        options?.MaxCacheBatchSize,
+        options.MaxParallelism,
+        options.MaxHttpSendBatchSize,
+        options.MaxCacheBatchSize,
         _processSource.Token
       );
       var findTotalObjectsTask = Task.CompletedTask;
-      if (!_options.SkipFindTotalObjects)
+      if (!options.SkipFindTotalObjects)
       {
         ThrowIfFailed();
         findTotalObjectsTask = Task.Factory.StartNew(
@@ -225,7 +219,6 @@ public sealed class SerializeProcess(
         return EMPTY_CLOSURES;
       }
 
-      var childClosures = _childClosurePool.Get();
       foreach (var childClosure in taskClosures)
       {
         if (IsCancelled())
@@ -234,7 +227,6 @@ public sealed class SerializeProcess(
         }
         foreach (var kvp in childClosure)
         {
-          childClosures[kvp.Key] = kvp.Value;
           if (IsCancelled())
           {
             return EMPTY_CLOSURES;
@@ -249,7 +241,7 @@ public sealed class SerializeProcess(
         return EMPTY_CLOSURES;
       }
 
-      var items = baseSerializer.Serialise(obj, childClosures, _options.SkipCacheRead, _processSource.Token);
+      var items = baseSerializer.Serialise(obj, options.SkipCacheRead, _processSource.Token);
 
       if (IsCancelled())
       {
@@ -257,32 +249,26 @@ public sealed class SerializeProcess(
       }
 
       var currentClosures = _currentClosurePool.Get();
-      try
+
+      Interlocked.Increment(ref _objectCount);
+      progress?.Report(new(ProgressEvent.FromCacheOrSerialized, _objectCount, Math.Max(_objectCount, _objectsFound)));
+      foreach (var item in items)
       {
-        Interlocked.Increment(ref _objectCount);
-        progress?.Report(new(ProgressEvent.FromCacheOrSerialized, _objectCount, Math.Max(_objectCount, _objectsFound)));
-        foreach (var item in items)
+        if (IsCancelled())
         {
-          if (IsCancelled())
-          {
-            return EMPTY_CLOSURES;
-          }
-
-          if (item.NeedsStorage)
-          {
-            Interlocked.Increment(ref _objectsSerialized);
-            await objectSaver.SaveAsync(item).ConfigureAwait(false);
-          }
-
-          if (!currentClosures.ContainsKey(item.Id))
-          {
-            currentClosures.Add(item.Id, new NodeInfo(item.Json, item.Closures));
-          }
+          return EMPTY_CLOSURES;
+        }
+
+        if (item.NeedsStorage)
+        {
+          Interlocked.Increment(ref _objectsSerialized);
+          await objectSaver.SaveAsync(item).ConfigureAwait(false);
+        }
+
+        if (!currentClosures.ContainsKey(item.Id))
+        {
+          currentClosures.Add(item.Id, new NodeInfo(item.Json, item.Closures));
         }
-      }
-      finally
-      {
-        _childClosurePool.Return(childClosures);
       }
 
       return currentClosures;

src/Speckle.Sdk/Serialisation/V2/SerializeProcessFactory.cs

@@ -44,13 +44,14 @@ public class SerializeProcessFactory(
         sqLiteJsonCacheManager,
         serverObjectManager,
         loggerFactory.CreateLogger<ObjectSaver>(),
+        options ?? new SerializeProcessOptions(),
         cancellationToken
       ),
       baseChildFinder,
       new BaseSerializer(sqLiteJsonCacheManager, objectSerializerFactory),
       loggerFactory,
-      cancellationToken,
-      options
+      options ?? new SerializeProcessOptions(),
+      cancellationToken
     );
 
   public ISerializeProcess CreateSerializeProcess(

src/Speckle.Sdk/Transports/ServerUtils/ProgressStream.cs

@@ -20,7 +20,7 @@ internal sealed class ProgressStream(
   {
     int n = _stream.Read(buffer, offset, count);
     _position += n;
-    progress?.Report(new(ProgressEvent.DownloadBytes, _position, streamLength));
+    progress?.Report(new(ProgressEvent.DownloadBytes, n, streamLength));
     return n;
   }
 
@@ -28,7 +28,7 @@ internal sealed class ProgressStream(
   {
     _stream.Write(buffer, offset, count);
     _position += count;
-    progress?.Report(new(ProgressEvent.UploadBytes, _position, streamLength));
+    progress?.Report(new(ProgressEvent.UploadBytes, count, streamLength));
   }
 
   public override bool CanRead => true;

tests/Speckle.Objects.Tests.Unit/Serialization/ObjectsSerializationTest.cs

@@ -18,10 +18,7 @@ public sealed class ObjectsSerializationTest
 
   private static IReadOnlyList<(Id, Json, Dictionary<Id, int>)> Serialize(Base data)
   {
-    using var serializer = new ObjectSerializerFactory(new BasePropertyGatherer()).Create(
-      new Dictionary<Id, NodeInfo>(),
-      default
-    );
+    using var serializer = new ObjectSerializerFactory(new BasePropertyGatherer()).Create(default);
     return serializer.Serialize(data).ToList();
   }
 

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

@@ -41,7 +41,7 @@ public class DataObjectTests
       new DummyServerObjectManager(),
       null,
       default,
-      new SerializeProcessOptions(true, true, false, true)
+      new SerializeProcessOptions(false, false, true, true)
     );
     await serializeProcess.Serialize(x);
     await VerifyJson(json.Single().Value.Value).UseParameters(type);

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

@@ -41,7 +41,7 @@ public class DetachedTests
       objects,
       null,
       default,
-      new SerializeProcessOptions(false, false, true, true)
+      new SerializeProcessOptions(true, true, false, true)
     );
     await serializeProcess.Serialize(@base);
 
@@ -123,7 +123,7 @@ public class DetachedTests
       objects,
       null,
       default,
-      new SerializeProcessOptions(false, false, true, true) { MaxParallelism = 1, MaxHttpSendBatchSize = 1 }
+      new SerializeProcessOptions(true, true, false, true) { MaxParallelism = 1, MaxHttpSendBatchSize = 1 }
     );
     var results = await serializeProcess.Serialize(@base);
 
@@ -150,7 +150,7 @@ public class DetachedTests
       objects,
       null,
       default,
-      new SerializeProcessOptions(false, false, true, true) { MaxParallelism = 1, MaxHttpSendBatchSize = 1 }
+      new SerializeProcessOptions(true, true, false, true) { MaxParallelism = 1, MaxHttpSendBatchSize = 1 }
     );
     var results = await serializeProcess.Serialize(@base);
 
@@ -172,7 +172,7 @@ public class DetachedTests
       objects,
       null,
       default,
-      new SerializeProcessOptions(false, false, true, true) { MaxParallelism = 1, MaxHttpSendBatchSize = 1 }
+      new SerializeProcessOptions(true, true, false, true) { MaxParallelism = 1, MaxHttpSendBatchSize = 1 }
     );
     var results = await serializeProcess.Serialize(@base);
 
@@ -239,7 +239,7 @@ public class DetachedTests
       objects,
       null,
       default,
-      new SerializeProcessOptions(false, false, true, true)
+      new SerializeProcessOptions(true, true, false, true)
     );
 
     var results = await serializeProcess.Serialize(@base);
@@ -272,7 +272,7 @@ public class DetachedTests
       objects,
       null,
       default,
-      new SerializeProcessOptions(false, false, true, true)
+      new SerializeProcessOptions(true, true, false, true)
     );
     var results = await serializeProcess.Serialize(@base);
     await VerifyJsonDictionary(objects);

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

@@ -203,7 +203,7 @@ public class ExceptionTests
   public void Test_SpeckleSerializerException()
   {
     var factory = new ObjectSerializerFactory(new BasePropertyGatherer());
-    var serializer = factory.Create(new Dictionary<Id, NodeInfo>(), default);
+    var serializer = factory.Create(default);
     Assert.Throws<SpeckleSerializeException>(() =>
     {
       var _ = serializer.Serialize(new BadBase()).ToList();

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

@@ -3,7 +3,6 @@ using Speckle.Objects.Primitive;
 using Speckle.Sdk.Host;
 using Speckle.Sdk.Models;
 using Speckle.Sdk.Models.Extensions;
-using Speckle.Sdk.Serialisation;
 using Speckle.Sdk.Serialisation.V2.Send;
 
 namespace Speckle.Sdk.Serialization.Tests;
@@ -20,10 +19,7 @@ public class ExternalIdTests
   public async Task ExternalIdTest_Detached()
   {
     var p = new Polyline() { units = "cm", value = [1, 2] };
-    using var serializer = new ObjectSerializerFactory(new BasePropertyGatherer()).Create(
-      new Dictionary<Id, NodeInfo>(),
-      default
-    );
+    using var serializer = new ObjectSerializerFactory(new BasePropertyGatherer()).Create(default);
     var objects = serializer.Serialize(p).ToDictionary(x => x.Item1, x => x.Item2);
 
     await VerifyJsonDictionary(objects);
@@ -45,10 +41,7 @@ public class ExternalIdTests
       knots = [],
       weights = [],
     };
-    using var serializer = new ObjectSerializerFactory(new BasePropertyGatherer()).Create(
-      new Dictionary<Id, NodeInfo>(),
-      default
-    );
+    using var serializer = new ObjectSerializerFactory(new BasePropertyGatherer()).Create(default);
     var objects = serializer.Serialize(curve).ToDictionary(x => x.Item1, x => x.Item2);
 
     await VerifyJsonDictionary(objects);
@@ -71,10 +64,7 @@ public class ExternalIdTests
       weights = [],
     };
     var polycurve = new Polycurve() { segments = [curve], units = "cm" };
-    using var serializer = new ObjectSerializerFactory(new BasePropertyGatherer()).Create(
-      new Dictionary<Id, NodeInfo>(),
-      default
-    );
+    using var serializer = new ObjectSerializerFactory(new BasePropertyGatherer()).Create(default);
     var objects = serializer.Serialize(polycurve).ToDictionary(x => x.Item1, x => x.Item2);
 
     await VerifyJsonDictionary(objects);
@@ -99,10 +89,7 @@ public class ExternalIdTests
     var polycurve = new Polycurve() { segments = [curve], units = "cm" };
     var @base = new Base();
     @base.SetDetachedProp("profile", polycurve);
-    using var serializer = new ObjectSerializerFactory(new BasePropertyGatherer()).Create(
-      new Dictionary<Id, NodeInfo>(),
-      default
-    );
+    using var serializer = new ObjectSerializerFactory(new BasePropertyGatherer()).Create(default);
     var objects = serializer.Serialize(@base).ToDictionary(x => x.Item1, x => x.Item2);
     await VerifyJsonDictionary(objects);
   }

tests/Speckle.Sdk.Tests.Unit/Serialisation/PrimitiveTestFixture.cs

@@ -39,7 +39,7 @@ public abstract class PrimitiveTestFixture
     }.Select(x => new object[] { x });
 
   public static Half[] Float16TestCases { get; } =
-    [default, Half.Epsilon, Half.MaxValue, Half.MinValue, Half.PositiveInfinity, Half.NegativeInfinity, Half.NaN];
+  [default, Half.Epsilon, Half.MaxValue, Half.MinValue, Half.PositiveInfinity, Half.NegativeInfinity, Half.NaN];
 
   public static float[] FloatIntegralTestCases { get; } = [0, 1, int.MaxValue, int.MinValue];
 

tests/Speckle.Sdk.Tests.Unit/Serialisation/SerializeProcessRecordExceptionTests.cs

@@ -31,6 +31,7 @@ public class SerializeProcessRecordExceptionTests : MoqTest
       baseChildFinderMock.Object,
       baseSerializerMock.Object,
       loggerFactoryMock.Object,
+      new(),
       cts.Token
     );
     var ex = new Exception("Test error");
@@ -67,6 +68,7 @@ public class SerializeProcessRecordExceptionTests : MoqTest
       baseChildFinderMock.Object,
       baseSerializerMock.Object,
       loggerFactoryMock.Object,
+      new(),
       cts.Token
     );
     var ex = new OperationCanceledException();
@@ -98,6 +100,7 @@ public class SerializeProcessRecordExceptionTests : MoqTest
       baseChildFinderMock.Object,
       baseSerializerMock.Object,
       loggerFactoryMock.Object,
+      new(),
       cts.Token
     );
     var ex = new AggregateException(new OperationCanceledException());